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 bool hourglass_shown_p
;
821 /* If non-null, an asynchronous timer that, when it expires, displays
822 an hourglass cursor on all frames. */
823 struct atimer
*hourglass_atimer
;
825 #endif /* HAVE_WINDOW_SYSTEM */
827 /* Name of the face used to display glyphless characters. */
828 static Lisp_Object Qglyphless_char
;
830 /* Symbol for the purpose of Vglyphless_char_display. */
831 static Lisp_Object Qglyphless_char_display
;
833 /* Method symbols for Vglyphless_char_display. */
834 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
836 /* Default number of seconds to wait before displaying an hourglass
838 #define DEFAULT_HOURGLASS_DELAY 1
840 #ifdef HAVE_WINDOW_SYSTEM
842 /* Default pixel width of `thin-space' display method. */
843 #define THIN_SPACE_WIDTH 1
845 #endif /* HAVE_WINDOW_SYSTEM */
847 /* Function prototypes. */
849 static void setup_for_ellipsis (struct it
*, int);
850 static void set_iterator_to_next (struct it
*, int);
851 static void mark_window_display_accurate_1 (struct window
*, int);
852 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
853 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
854 static int row_for_charpos_p (struct glyph_row
*, ptrdiff_t);
855 static int cursor_row_p (struct glyph_row
*);
856 static int redisplay_mode_lines (Lisp_Object
, bool);
857 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
859 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
861 static void handle_line_prefix (struct it
*);
863 static void pint2str (char *, int, ptrdiff_t);
864 static void pint2hrstr (char *, int, ptrdiff_t);
865 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
867 static int text_outside_line_unchanged_p (struct window
*,
868 ptrdiff_t, ptrdiff_t);
869 static void store_mode_line_noprop_char (char);
870 static int store_mode_line_noprop (const char *, int, int);
871 static void handle_stop (struct it
*);
872 static void handle_stop_backwards (struct it
*, ptrdiff_t);
873 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
874 static void ensure_echo_area_buffers (void);
875 static void unwind_with_echo_area_buffer (Lisp_Object
);
876 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
877 static int with_echo_area_buffer (struct window
*, int,
878 int (*) (ptrdiff_t, Lisp_Object
),
879 ptrdiff_t, Lisp_Object
);
880 static void clear_garbaged_frames (void);
881 static int current_message_1 (ptrdiff_t, Lisp_Object
);
882 static int truncate_message_1 (ptrdiff_t, Lisp_Object
);
883 static void set_message (Lisp_Object
);
884 static int set_message_1 (ptrdiff_t, Lisp_Object
);
885 static int display_echo_area (struct window
*);
886 static int display_echo_area_1 (ptrdiff_t, Lisp_Object
);
887 static int resize_mini_window_1 (ptrdiff_t, Lisp_Object
);
888 static void unwind_redisplay (void);
889 static int string_char_and_length (const unsigned char *, int *);
890 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
892 static int compute_window_start_on_continuation_line (struct window
*);
893 static void insert_left_trunc_glyphs (struct it
*);
894 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
896 static void extend_face_to_end_of_line (struct it
*);
897 static int append_space_for_newline (struct it
*, int);
898 static int cursor_row_fully_visible_p (struct window
*, int, int);
899 static int try_scrolling (Lisp_Object
, int, ptrdiff_t, ptrdiff_t, int, int);
900 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
901 static int trailing_whitespace_p (ptrdiff_t);
902 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
903 static void push_it (struct it
*, struct text_pos
*);
904 static void iterate_out_of_display_property (struct it
*);
905 static void pop_it (struct it
*);
906 static void sync_frame_with_window_matrix_rows (struct window
*);
907 static void redisplay_internal (void);
908 static int echo_area_display (int);
909 static void redisplay_windows (Lisp_Object
);
910 static void redisplay_window (Lisp_Object
, bool);
911 static Lisp_Object
redisplay_window_error (Lisp_Object
);
912 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
913 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
914 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
915 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
917 static int update_menu_bar (struct frame
*, int, int);
918 static int try_window_reusing_current_matrix (struct window
*);
919 static int try_window_id (struct window
*);
920 static int display_line (struct it
*);
921 static int display_mode_lines (struct window
*);
922 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
923 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
924 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
925 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
926 static void display_menu_bar (struct window
*);
927 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
929 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
930 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
931 static void compute_line_metrics (struct it
*);
932 static void run_redisplay_end_trigger_hook (struct it
*);
933 static int get_overlay_strings (struct it
*, ptrdiff_t);
934 static int get_overlay_strings_1 (struct it
*, ptrdiff_t, int);
935 static void next_overlay_string (struct it
*);
936 static void reseat (struct it
*, struct text_pos
, int);
937 static void reseat_1 (struct it
*, struct text_pos
, int);
938 static void back_to_previous_visible_line_start (struct it
*);
939 static void reseat_at_next_visible_line_start (struct it
*, int);
940 static int next_element_from_ellipsis (struct it
*);
941 static int next_element_from_display_vector (struct it
*);
942 static int next_element_from_string (struct it
*);
943 static int next_element_from_c_string (struct it
*);
944 static int next_element_from_buffer (struct it
*);
945 static int next_element_from_composition (struct it
*);
946 static int next_element_from_image (struct it
*);
947 static int next_element_from_stretch (struct it
*);
948 static void load_overlay_strings (struct it
*, ptrdiff_t);
949 static int init_from_display_pos (struct it
*, struct window
*,
950 struct display_pos
*);
951 static void reseat_to_string (struct it
*, const char *,
952 Lisp_Object
, ptrdiff_t, ptrdiff_t, int, int);
953 static int get_next_display_element (struct it
*);
954 static enum move_it_result
955 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
956 enum move_operation_enum
);
957 static void get_visually_first_element (struct it
*);
958 static void init_to_row_start (struct it
*, struct window
*,
960 static int init_to_row_end (struct it
*, struct window
*,
962 static void back_to_previous_line_start (struct it
*);
963 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
964 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
965 Lisp_Object
, ptrdiff_t);
966 static struct text_pos
string_pos (ptrdiff_t, Lisp_Object
);
967 static struct text_pos
c_string_pos (ptrdiff_t, const char *, bool);
968 static ptrdiff_t number_of_chars (const char *, bool);
969 static void compute_stop_pos (struct it
*);
970 static void compute_string_pos (struct text_pos
*, struct text_pos
,
972 static int face_before_or_after_it_pos (struct it
*, int);
973 static ptrdiff_t next_overlay_change (ptrdiff_t);
974 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
975 Lisp_Object
, struct text_pos
*, ptrdiff_t, int);
976 static int handle_single_display_spec (struct it
*, Lisp_Object
,
977 Lisp_Object
, Lisp_Object
,
978 struct text_pos
*, ptrdiff_t, int, int);
979 static int underlying_face_id (struct it
*);
980 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
983 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
984 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
986 #ifdef HAVE_WINDOW_SYSTEM
988 static void x_consider_frame_title (Lisp_Object
);
989 static void update_tool_bar (struct frame
*, int);
990 static int redisplay_tool_bar (struct frame
*);
991 static void x_draw_bottom_divider (struct window
*w
);
992 static void notice_overwritten_cursor (struct window
*,
995 static void append_stretch_glyph (struct it
*, Lisp_Object
,
999 #endif /* HAVE_WINDOW_SYSTEM */
1001 static void produce_special_glyphs (struct it
*, enum display_element_type
);
1002 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
1003 static bool coords_in_mouse_face_p (struct window
*, int, int);
1007 /***********************************************************************
1008 Window display dimensions
1009 ***********************************************************************/
1011 /* Return the bottom boundary y-position for text lines in window W.
1012 This is the first y position at which a line cannot start.
1013 It is relative to the top of the window.
1015 This is the height of W minus the height of a mode line, if any. */
1018 window_text_bottom_y (struct window
*w
)
1020 int height
= WINDOW_PIXEL_HEIGHT (w
);
1022 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
1024 if (WINDOW_WANTS_MODELINE_P (w
))
1025 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1030 /* Return the pixel width of display area AREA of window W.
1031 ANY_AREA means return the total width of W, not including
1032 fringes to the left and right of the window. */
1035 window_box_width (struct window
*w
, enum glyph_row_area area
)
1037 int width
= w
->pixel_width
;
1039 if (!w
->pseudo_window_p
)
1041 width
-= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
1042 width
-= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
1044 if (area
== TEXT_AREA
)
1045 width
-= (WINDOW_MARGINS_WIDTH (w
)
1046 + WINDOW_FRINGES_WIDTH (w
));
1047 else if (area
== LEFT_MARGIN_AREA
)
1048 width
= WINDOW_LEFT_MARGIN_WIDTH (w
);
1049 else if (area
== RIGHT_MARGIN_AREA
)
1050 width
= WINDOW_RIGHT_MARGIN_WIDTH (w
);
1053 /* With wide margins, fringes, etc. we might end up with a negative
1054 width, correct that here. */
1055 return max (0, width
);
1059 /* Return the pixel height of the display area of window W, not
1060 including mode lines of W, if any. */
1063 window_box_height (struct window
*w
)
1065 struct frame
*f
= XFRAME (w
->frame
);
1066 int height
= WINDOW_PIXEL_HEIGHT (w
);
1068 eassert (height
>= 0);
1070 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
1072 /* Note: the code below that determines the mode-line/header-line
1073 height is essentially the same as that contained in the macro
1074 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1075 the appropriate glyph row has its `mode_line_p' flag set,
1076 and if it doesn't, uses estimate_mode_line_height instead. */
1078 if (WINDOW_WANTS_MODELINE_P (w
))
1080 struct glyph_row
*ml_row
1081 = (w
->current_matrix
&& w
->current_matrix
->rows
1082 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1084 if (ml_row
&& ml_row
->mode_line_p
)
1085 height
-= ml_row
->height
;
1087 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1090 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1092 struct glyph_row
*hl_row
1093 = (w
->current_matrix
&& w
->current_matrix
->rows
1094 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1096 if (hl_row
&& hl_row
->mode_line_p
)
1097 height
-= hl_row
->height
;
1099 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1102 /* With a very small font and a mode-line that's taller than
1103 default, we might end up with a negative height. */
1104 return max (0, height
);
1107 /* Return the window-relative coordinate of the left edge of display
1108 area AREA of window W. ANY_AREA means return the left edge of the
1109 whole window, to the right of the left fringe of W. */
1112 window_box_left_offset (struct window
*w
, enum glyph_row_area area
)
1116 if (w
->pseudo_window_p
)
1119 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1121 if (area
== TEXT_AREA
)
1122 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1123 + window_box_width (w
, LEFT_MARGIN_AREA
));
1124 else if (area
== RIGHT_MARGIN_AREA
)
1125 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1126 + window_box_width (w
, LEFT_MARGIN_AREA
)
1127 + window_box_width (w
, TEXT_AREA
)
1128 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1130 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1131 else if (area
== LEFT_MARGIN_AREA
1132 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1133 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1135 /* Don't return more than the window's pixel width. */
1136 return min (x
, w
->pixel_width
);
1140 /* Return the window-relative coordinate of the right edge of display
1141 area AREA of window W. ANY_AREA means return the right edge of the
1142 whole window, to the left of the right fringe of W. */
1145 window_box_right_offset (struct window
*w
, enum glyph_row_area area
)
1147 /* Don't return more than the window's pixel width. */
1148 return min (window_box_left_offset (w
, area
) + window_box_width (w
, area
),
1152 /* Return the frame-relative coordinate of the left edge of display
1153 area AREA of window W. ANY_AREA means return the left edge of the
1154 whole window, to the right of the left fringe of W. */
1157 window_box_left (struct window
*w
, enum glyph_row_area area
)
1159 struct frame
*f
= XFRAME (w
->frame
);
1162 if (w
->pseudo_window_p
)
1163 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1165 x
= (WINDOW_LEFT_EDGE_X (w
)
1166 + window_box_left_offset (w
, area
));
1172 /* Return the frame-relative coordinate of the right edge of display
1173 area AREA of window W. ANY_AREA means return the right edge of the
1174 whole window, to the left of the right fringe of W. */
1177 window_box_right (struct window
*w
, enum glyph_row_area area
)
1179 return window_box_left (w
, area
) + window_box_width (w
, area
);
1182 /* Get the bounding box of the display area AREA of window W, without
1183 mode lines, in frame-relative coordinates. ANY_AREA means the
1184 whole window, not including the left and right fringes of
1185 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1186 coordinates of the upper-left corner of the box. Return in
1187 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1190 window_box (struct window
*w
, enum glyph_row_area area
, int *box_x
,
1191 int *box_y
, int *box_width
, int *box_height
)
1194 *box_width
= window_box_width (w
, area
);
1196 *box_height
= window_box_height (w
);
1198 *box_x
= window_box_left (w
, area
);
1201 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1202 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1203 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1207 #ifdef HAVE_WINDOW_SYSTEM
1209 /* Get the bounding box of the display area AREA of window W, without
1210 mode lines and both fringes of the window. Return in *TOP_LEFT_X
1211 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1212 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1213 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1217 window_box_edges (struct window
*w
, int *top_left_x
, int *top_left_y
,
1218 int *bottom_right_x
, int *bottom_right_y
)
1220 window_box (w
, ANY_AREA
, top_left_x
, top_left_y
,
1221 bottom_right_x
, bottom_right_y
);
1222 *bottom_right_x
+= *top_left_x
;
1223 *bottom_right_y
+= *top_left_y
;
1226 #endif /* HAVE_WINDOW_SYSTEM */
1228 /***********************************************************************
1230 ***********************************************************************/
1232 /* Return the bottom y-position of the line the iterator IT is in.
1233 This can modify IT's settings. */
1236 line_bottom_y (struct it
*it
)
1238 int line_height
= it
->max_ascent
+ it
->max_descent
;
1239 int line_top_y
= it
->current_y
;
1241 if (line_height
== 0)
1244 line_height
= last_height
;
1245 else if (IT_CHARPOS (*it
) < ZV
)
1247 move_it_by_lines (it
, 1);
1248 line_height
= (it
->max_ascent
|| it
->max_descent
1249 ? it
->max_ascent
+ it
->max_descent
1254 struct glyph_row
*row
= it
->glyph_row
;
1256 /* Use the default character height. */
1257 it
->glyph_row
= NULL
;
1258 it
->what
= IT_CHARACTER
;
1261 PRODUCE_GLYPHS (it
);
1262 line_height
= it
->ascent
+ it
->descent
;
1263 it
->glyph_row
= row
;
1267 return line_top_y
+ line_height
;
1270 DEFUN ("line-pixel-height", Fline_pixel_height
,
1271 Sline_pixel_height
, 0, 0, 0,
1272 doc
: /* Return height in pixels of text line in the selected window.
1274 Value is the height in pixels of the line at point. */)
1279 struct window
*w
= XWINDOW (selected_window
);
1280 struct buffer
*old_buffer
= NULL
;
1283 if (XBUFFER (w
->contents
) != current_buffer
)
1285 old_buffer
= current_buffer
;
1286 set_buffer_internal_1 (XBUFFER (w
->contents
));
1288 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
1289 start_display (&it
, w
, pt
);
1290 it
.vpos
= it
.current_y
= 0;
1292 result
= make_number (line_bottom_y (&it
));
1294 set_buffer_internal_1 (old_buffer
);
1299 /* Return the default pixel height of text lines in window W. The
1300 value is the canonical height of the W frame's default font, plus
1301 any extra space required by the line-spacing variable or frame
1304 Implementation note: this ignores any line-spacing text properties
1305 put on the newline characters. This is because those properties
1306 only affect the _screen_ line ending in the newline (i.e., in a
1307 continued line, only the last screen line will be affected), which
1308 means only a small number of lines in a buffer can ever use this
1309 feature. Since this function is used to compute the default pixel
1310 equivalent of text lines in a window, we can safely ignore those
1311 few lines. For the same reasons, we ignore the line-height
1314 default_line_pixel_height (struct window
*w
)
1316 struct frame
*f
= WINDOW_XFRAME (w
);
1317 int height
= FRAME_LINE_HEIGHT (f
);
1319 if (!FRAME_INITIAL_P (f
) && BUFFERP (w
->contents
))
1321 struct buffer
*b
= XBUFFER (w
->contents
);
1322 Lisp_Object val
= BVAR (b
, extra_line_spacing
);
1325 val
= BVAR (&buffer_defaults
, extra_line_spacing
);
1328 if (RANGED_INTEGERP (0, val
, INT_MAX
))
1329 height
+= XFASTINT (val
);
1330 else if (FLOATP (val
))
1332 int addon
= XFLOAT_DATA (val
) * height
+ 0.5;
1339 height
+= f
->extra_line_spacing
;
1345 /* Subroutine of pos_visible_p below. Extracts a display string, if
1346 any, from the display spec given as its argument. */
1348 string_from_display_spec (Lisp_Object spec
)
1352 while (CONSP (spec
))
1354 if (STRINGP (XCAR (spec
)))
1359 else if (VECTORP (spec
))
1363 for (i
= 0; i
< ASIZE (spec
); i
++)
1365 if (STRINGP (AREF (spec
, i
)))
1366 return AREF (spec
, i
);
1375 /* Limit insanely large values of W->hscroll on frame F to the largest
1376 value that will still prevent first_visible_x and last_visible_x of
1377 'struct it' from overflowing an int. */
1379 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1381 ptrdiff_t window_hscroll
= w
->hscroll
;
1382 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1383 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1385 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1386 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1388 return window_hscroll
;
1391 /* Return 1 if position CHARPOS is visible in window W.
1392 CHARPOS < 0 means return info about WINDOW_END position.
1393 If visible, set *X and *Y to pixel coordinates of top left corner.
1394 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1395 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1398 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1399 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1402 void *itdata
= bidi_shelve_cache ();
1403 struct text_pos top
;
1405 struct buffer
*old_buffer
= NULL
;
1407 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1410 if (XBUFFER (w
->contents
) != current_buffer
)
1412 old_buffer
= current_buffer
;
1413 set_buffer_internal_1 (XBUFFER (w
->contents
));
1416 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1417 /* Scrolling a minibuffer window via scroll bar when the echo area
1418 shows long text sometimes resets the minibuffer contents behind
1420 if (CHARPOS (top
) > ZV
)
1421 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1423 /* Compute exact mode line heights. */
1424 if (WINDOW_WANTS_MODELINE_P (w
))
1426 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1427 BVAR (current_buffer
, mode_line_format
));
1429 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1430 w
->header_line_height
1431 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1432 BVAR (current_buffer
, header_line_format
));
1434 start_display (&it
, w
, top
);
1435 move_it_to (&it
, charpos
, -1, it
.last_visible_y
- 1, -1,
1436 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1439 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
!= -1)
1440 && IT_CHARPOS (it
) >= charpos
)
1441 /* When scanning backwards under bidi iteration, move_it_to
1442 stops at or _before_ CHARPOS, because it stops at or to
1443 the _right_ of the character at CHARPOS. */
1444 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1445 && IT_CHARPOS (it
) <= charpos
)))
1447 /* We have reached CHARPOS, or passed it. How the call to
1448 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1449 or covered by a display property, move_it_to stops at the end
1450 of the invisible text, to the right of CHARPOS. (ii) If
1451 CHARPOS is in a display vector, move_it_to stops on its last
1453 int top_x
= it
.current_x
;
1454 int top_y
= it
.current_y
;
1455 /* Calling line_bottom_y may change it.method, it.position, etc. */
1456 enum it_method it_method
= it
.method
;
1457 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1458 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1460 if (top_y
< window_top_y
)
1461 visible_p
= bottom_y
> window_top_y
;
1462 else if (top_y
< it
.last_visible_y
)
1464 if (bottom_y
>= it
.last_visible_y
1465 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1466 && IT_CHARPOS (it
) < charpos
)
1468 /* When the last line of the window is scanned backwards
1469 under bidi iteration, we could be duped into thinking
1470 that we have passed CHARPOS, when in fact move_it_to
1471 simply stopped short of CHARPOS because it reached
1472 last_visible_y. To see if that's what happened, we call
1473 move_it_to again with a slightly larger vertical limit,
1474 and see if it actually moved vertically; if it did, we
1475 didn't really reach CHARPOS, which is beyond window end. */
1476 struct it save_it
= it
;
1477 /* Why 10? because we don't know how many canonical lines
1478 will the height of the next line(s) be. So we guess. */
1479 int ten_more_lines
= 10 * default_line_pixel_height (w
);
1481 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1482 MOVE_TO_POS
| MOVE_TO_Y
);
1483 if (it
.current_y
> top_y
)
1490 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1492 /* We stopped on the last glyph of a display vector.
1493 Try and recompute. Hack alert! */
1494 if (charpos
< 2 || top
.charpos
>= charpos
)
1495 top_x
= it
.glyph_row
->x
;
1498 struct it it2
, it2_prev
;
1499 /* The idea is to get to the previous buffer
1500 position, consume the character there, and use
1501 the pixel coordinates we get after that. But if
1502 the previous buffer position is also displayed
1503 from a display vector, we need to consume all of
1504 the glyphs from that display vector. */
1505 start_display (&it2
, w
, top
);
1506 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1507 /* If we didn't get to CHARPOS - 1, there's some
1508 replacing display property at that position, and
1509 we stopped after it. That is exactly the place
1510 whose coordinates we want. */
1511 if (IT_CHARPOS (it2
) != charpos
- 1)
1515 /* Iterate until we get out of the display
1516 vector that displays the character at
1519 get_next_display_element (&it2
);
1520 PRODUCE_GLYPHS (&it2
);
1522 set_iterator_to_next (&it2
, 1);
1523 } while (it2
.method
== GET_FROM_DISPLAY_VECTOR
1524 && IT_CHARPOS (it2
) < charpos
);
1526 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev
)
1527 || it2_prev
.current_x
> it2_prev
.last_visible_x
)
1528 top_x
= it
.glyph_row
->x
;
1531 top_x
= it2_prev
.current_x
;
1532 top_y
= it2_prev
.current_y
;
1536 else if (IT_CHARPOS (it
) != charpos
)
1538 Lisp_Object cpos
= make_number (charpos
);
1539 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1540 Lisp_Object string
= string_from_display_spec (spec
);
1541 struct text_pos tpos
;
1542 int replacing_spec_p
;
1543 bool newline_in_string
1545 && memchr (SDATA (string
), '\n', SBYTES (string
)));
1547 SET_TEXT_POS (tpos
, charpos
, CHAR_TO_BYTE (charpos
));
1550 && handle_display_spec (NULL
, spec
, Qnil
, Qnil
, &tpos
,
1551 charpos
, FRAME_WINDOW_P (it
.f
)));
1552 /* The tricky code below is needed because there's a
1553 discrepancy between move_it_to and how we set cursor
1554 when PT is at the beginning of a portion of text
1555 covered by a display property or an overlay with a
1556 display property, or the display line ends in a
1557 newline from a display string. move_it_to will stop
1558 _after_ such display strings, whereas
1559 set_cursor_from_row conspires with cursor_row_p to
1560 place the cursor on the first glyph produced from the
1563 /* We have overshoot PT because it is covered by a
1564 display property that replaces the text it covers.
1565 If the string includes embedded newlines, we are also
1566 in the wrong display line. Backtrack to the correct
1567 line, where the display property begins. */
1568 if (replacing_spec_p
)
1570 Lisp_Object startpos
, endpos
;
1571 EMACS_INT start
, end
;
1575 /* Find the first and the last buffer positions
1576 covered by the display string. */
1578 Fnext_single_char_property_change (cpos
, Qdisplay
,
1581 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1583 start
= XFASTINT (startpos
);
1584 end
= XFASTINT (endpos
);
1585 /* Move to the last buffer position before the
1586 display property. */
1587 start_display (&it3
, w
, top
);
1588 if (start
> CHARPOS (top
))
1589 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1590 /* Move forward one more line if the position before
1591 the display string is a newline or if it is the
1592 rightmost character on a line that is
1593 continued or word-wrapped. */
1594 if (it3
.method
== GET_FROM_BUFFER
1596 || FETCH_BYTE (IT_BYTEPOS (it3
)) == '\n'))
1597 move_it_by_lines (&it3
, 1);
1598 else if (move_it_in_display_line_to (&it3
, -1,
1602 == MOVE_LINE_CONTINUED
)
1604 move_it_by_lines (&it3
, 1);
1605 /* When we are under word-wrap, the #$@%!
1606 move_it_by_lines moves 2 lines, so we need to
1608 if (it3
.line_wrap
== WORD_WRAP
)
1609 move_it_by_lines (&it3
, -1);
1612 /* Record the vertical coordinate of the display
1613 line where we wound up. */
1614 top_y
= it3
.current_y
;
1617 /* When characters are reordered for display,
1618 the character displayed to the left of the
1619 display string could be _after_ the display
1620 property in the logical order. Use the
1621 smallest vertical position of these two. */
1622 start_display (&it3
, w
, top
);
1623 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1624 if (it3
.current_y
< top_y
)
1625 top_y
= it3
.current_y
;
1627 /* Move from the top of the window to the beginning
1628 of the display line where the display string
1630 start_display (&it3
, w
, top
);
1631 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1632 /* If it3_moved stays zero after the 'while' loop
1633 below, that means we already were at a newline
1634 before the loop (e.g., the display string begins
1635 with a newline), so we don't need to (and cannot)
1636 inspect the glyphs of it3.glyph_row, because
1637 PRODUCE_GLYPHS will not produce anything for a
1638 newline, and thus it3.glyph_row stays at its
1639 stale content it got at top of the window. */
1641 /* Finally, advance the iterator until we hit the
1642 first display element whose character position is
1643 CHARPOS, or until the first newline from the
1644 display string, which signals the end of the
1646 while (get_next_display_element (&it3
))
1648 PRODUCE_GLYPHS (&it3
);
1649 if (IT_CHARPOS (it3
) == charpos
1650 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1653 set_iterator_to_next (&it3
, 0);
1655 top_x
= it3
.current_x
- it3
.pixel_width
;
1656 /* Normally, we would exit the above loop because we
1657 found the display element whose character
1658 position is CHARPOS. For the contingency that we
1659 didn't, and stopped at the first newline from the
1660 display string, move back over the glyphs
1661 produced from the string, until we find the
1662 rightmost glyph not from the string. */
1664 && newline_in_string
1665 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1667 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1668 + it3
.glyph_row
->used
[TEXT_AREA
];
1670 while (EQ ((g
- 1)->object
, string
))
1673 top_x
-= g
->pixel_width
;
1675 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1676 + it3
.glyph_row
->used
[TEXT_AREA
]);
1682 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1683 *rtop
= max (0, window_top_y
- top_y
);
1684 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1685 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1686 - max (top_y
, window_top_y
)));
1692 /* Either we were asked to provide info about WINDOW_END, or
1693 CHARPOS is in the partially visible glyph row at end of
1696 void *it2data
= NULL
;
1698 SAVE_IT (it2
, it
, it2data
);
1699 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1700 move_it_by_lines (&it
, 1);
1701 if (charpos
< IT_CHARPOS (it
)
1702 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1705 RESTORE_IT (&it2
, &it2
, it2data
);
1706 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1708 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1709 *rtop
= max (0, -it2
.current_y
);
1710 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1711 - it
.last_visible_y
));
1712 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1714 - max (it2
.current_y
,
1715 WINDOW_HEADER_LINE_HEIGHT (w
))));
1719 bidi_unshelve_cache (it2data
, 1);
1721 bidi_unshelve_cache (itdata
, 0);
1724 set_buffer_internal_1 (old_buffer
);
1726 if (visible_p
&& w
->hscroll
> 0)
1728 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1729 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1732 /* Debugging code. */
1734 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1735 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1737 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1744 /* Return the next character from STR. Return in *LEN the length of
1745 the character. This is like STRING_CHAR_AND_LENGTH but never
1746 returns an invalid character. If we find one, we return a `?', but
1747 with the length of the invalid character. */
1750 string_char_and_length (const unsigned char *str
, int *len
)
1754 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1755 if (!CHAR_VALID_P (c
))
1756 /* We may not change the length here because other places in Emacs
1757 don't use this function, i.e. they silently accept invalid
1766 /* Given a position POS containing a valid character and byte position
1767 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1769 static struct text_pos
1770 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1772 eassert (STRINGP (string
) && nchars
>= 0);
1774 if (STRING_MULTIBYTE (string
))
1776 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1781 string_char_and_length (p
, &len
);
1784 BYTEPOS (pos
) += len
;
1788 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1794 /* Value is the text position, i.e. character and byte position,
1795 for character position CHARPOS in STRING. */
1797 static struct text_pos
1798 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1800 struct text_pos pos
;
1801 eassert (STRINGP (string
));
1802 eassert (charpos
>= 0);
1803 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1808 /* Value is a text position, i.e. character and byte position, for
1809 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1810 means recognize multibyte characters. */
1812 static struct text_pos
1813 c_string_pos (ptrdiff_t charpos
, const char *s
, bool multibyte_p
)
1815 struct text_pos pos
;
1817 eassert (s
!= NULL
);
1818 eassert (charpos
>= 0);
1824 SET_TEXT_POS (pos
, 0, 0);
1827 string_char_and_length ((const unsigned char *) s
, &len
);
1830 BYTEPOS (pos
) += len
;
1834 SET_TEXT_POS (pos
, charpos
, charpos
);
1840 /* Value is the number of characters in C string S. MULTIBYTE_P
1841 non-zero means recognize multibyte characters. */
1844 number_of_chars (const char *s
, bool multibyte_p
)
1850 ptrdiff_t rest
= strlen (s
);
1852 const unsigned char *p
= (const unsigned char *) s
;
1854 for (nchars
= 0; rest
> 0; ++nchars
)
1856 string_char_and_length (p
, &len
);
1857 rest
-= len
, p
+= len
;
1861 nchars
= strlen (s
);
1867 /* Compute byte position NEWPOS->bytepos corresponding to
1868 NEWPOS->charpos. POS is a known position in string STRING.
1869 NEWPOS->charpos must be >= POS.charpos. */
1872 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1874 eassert (STRINGP (string
));
1875 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1877 if (STRING_MULTIBYTE (string
))
1878 *newpos
= string_pos_nchars_ahead (pos
, string
,
1879 CHARPOS (*newpos
) - CHARPOS (pos
));
1881 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1885 Return an estimation of the pixel height of mode or header lines on
1886 frame F. FACE_ID specifies what line's height to estimate. */
1889 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1891 #ifdef HAVE_WINDOW_SYSTEM
1892 if (FRAME_WINDOW_P (f
))
1894 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1896 /* This function is called so early when Emacs starts that the face
1897 cache and mode line face are not yet initialized. */
1898 if (FRAME_FACE_CACHE (f
))
1900 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1904 height
= FONT_HEIGHT (face
->font
);
1905 if (face
->box_line_width
> 0)
1906 height
+= 2 * face
->box_line_width
;
1917 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1918 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1919 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1920 not force the value into range. */
1923 pixel_to_glyph_coords (struct frame
*f
, register int pix_x
, register int pix_y
,
1924 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1927 #ifdef HAVE_WINDOW_SYSTEM
1928 if (FRAME_WINDOW_P (f
))
1930 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1931 even for negative values. */
1933 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1935 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1937 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1938 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1941 STORE_NATIVE_RECT (*bounds
,
1942 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1943 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1944 FRAME_COLUMN_WIDTH (f
) - 1,
1945 FRAME_LINE_HEIGHT (f
) - 1);
1947 /* PXW: Should we clip pixels before converting to columns/lines? */
1952 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1953 pix_x
= FRAME_TOTAL_COLS (f
);
1957 else if (pix_y
> FRAME_LINES (f
))
1958 pix_y
= FRAME_LINES (f
);
1968 /* Find the glyph under window-relative coordinates X/Y in window W.
1969 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1970 strings. Return in *HPOS and *VPOS the row and column number of
1971 the glyph found. Return in *AREA the glyph area containing X.
1972 Value is a pointer to the glyph found or null if X/Y is not on
1973 text, or we can't tell because W's current matrix is not up to
1976 static struct glyph
*
1977 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1978 int *dx
, int *dy
, int *area
)
1980 struct glyph
*glyph
, *end
;
1981 struct glyph_row
*row
= NULL
;
1984 /* Find row containing Y. Give up if some row is not enabled. */
1985 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1987 row
= MATRIX_ROW (w
->current_matrix
, i
);
1988 if (!row
->enabled_p
)
1990 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1997 /* Give up if Y is not in the window. */
1998 if (i
== w
->current_matrix
->nrows
)
2001 /* Get the glyph area containing X. */
2002 if (w
->pseudo_window_p
)
2009 if (x
< window_box_left_offset (w
, TEXT_AREA
))
2011 *area
= LEFT_MARGIN_AREA
;
2012 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
2014 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
2017 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
2021 *area
= RIGHT_MARGIN_AREA
;
2022 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
2026 /* Find glyph containing X. */
2027 glyph
= row
->glyphs
[*area
];
2028 end
= glyph
+ row
->used
[*area
];
2030 while (glyph
< end
&& x
>= glyph
->pixel_width
)
2032 x
-= glyph
->pixel_width
;
2042 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
2045 *hpos
= glyph
- row
->glyphs
[*area
];
2049 /* Convert frame-relative x/y to coordinates relative to window W.
2050 Takes pseudo-windows into account. */
2053 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
2055 if (w
->pseudo_window_p
)
2057 /* A pseudo-window is always full-width, and starts at the
2058 left edge of the frame, plus a frame border. */
2059 struct frame
*f
= XFRAME (w
->frame
);
2060 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
2061 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
2065 *x
-= WINDOW_LEFT_EDGE_X (w
);
2066 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
2070 #ifdef HAVE_WINDOW_SYSTEM
2073 Return in RECTS[] at most N clipping rectangles for glyph string S.
2074 Return the number of stored rectangles. */
2077 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
2084 if (s
->row
->full_width_p
)
2086 /* Draw full-width. X coordinates are relative to S->w->left_col. */
2087 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
2088 if (s
->row
->mode_line_p
)
2089 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
) - WINDOW_RIGHT_DIVIDER_WIDTH (s
->w
);
2091 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
);
2093 /* Unless displaying a mode or menu bar line, which are always
2094 fully visible, clip to the visible part of the row. */
2095 if (s
->w
->pseudo_window_p
)
2096 r
.height
= s
->row
->visible_height
;
2098 r
.height
= s
->height
;
2102 /* This is a text line that may be partially visible. */
2103 r
.x
= window_box_left (s
->w
, s
->area
);
2104 r
.width
= window_box_width (s
->w
, s
->area
);
2105 r
.height
= s
->row
->visible_height
;
2109 if (r
.x
< s
->clip_head
->x
)
2111 if (r
.width
>= s
->clip_head
->x
- r
.x
)
2112 r
.width
-= s
->clip_head
->x
- r
.x
;
2115 r
.x
= s
->clip_head
->x
;
2118 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
2120 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
2121 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
2126 /* If S draws overlapping rows, it's sufficient to use the top and
2127 bottom of the window for clipping because this glyph string
2128 intentionally draws over other lines. */
2129 if (s
->for_overlaps
)
2131 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2132 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2134 /* Alas, the above simple strategy does not work for the
2135 environments with anti-aliased text: if the same text is
2136 drawn onto the same place multiple times, it gets thicker.
2137 If the overlap we are processing is for the erased cursor, we
2138 take the intersection with the rectangle of the cursor. */
2139 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2141 XRectangle rc
, r_save
= r
;
2143 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2144 rc
.y
= s
->w
->phys_cursor
.y
;
2145 rc
.width
= s
->w
->phys_cursor_width
;
2146 rc
.height
= s
->w
->phys_cursor_height
;
2148 x_intersect_rectangles (&r_save
, &rc
, &r
);
2153 /* Don't use S->y for clipping because it doesn't take partially
2154 visible lines into account. For example, it can be negative for
2155 partially visible lines at the top of a window. */
2156 if (!s
->row
->full_width_p
2157 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2158 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2160 r
.y
= max (0, s
->row
->y
);
2163 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2165 /* If drawing the cursor, don't let glyph draw outside its
2166 advertised boundaries. Cleartype does this under some circumstances. */
2167 if (s
->hl
== DRAW_CURSOR
)
2169 struct glyph
*glyph
= s
->first_glyph
;
2174 r
.width
-= s
->x
- r
.x
;
2177 r
.width
= min (r
.width
, glyph
->pixel_width
);
2179 /* If r.y is below window bottom, ensure that we still see a cursor. */
2180 height
= min (glyph
->ascent
+ glyph
->descent
,
2181 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2182 max_y
= window_text_bottom_y (s
->w
) - height
;
2183 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2184 if (s
->ybase
- glyph
->ascent
> max_y
)
2191 /* Don't draw cursor glyph taller than our actual glyph. */
2192 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2193 if (height
< r
.height
)
2195 max_y
= r
.y
+ r
.height
;
2196 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2197 r
.height
= min (max_y
- r
.y
, height
);
2204 XRectangle r_save
= r
;
2206 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2210 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2211 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2213 #ifdef CONVERT_FROM_XRECT
2214 CONVERT_FROM_XRECT (r
, *rects
);
2222 /* If we are processing overlapping and allowed to return
2223 multiple clipping rectangles, we exclude the row of the glyph
2224 string from the clipping rectangle. This is to avoid drawing
2225 the same text on the environment with anti-aliasing. */
2226 #ifdef CONVERT_FROM_XRECT
2229 XRectangle
*rs
= rects
;
2231 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2233 if (s
->for_overlaps
& OVERLAPS_PRED
)
2236 if (r
.y
+ r
.height
> row_y
)
2239 rs
[i
].height
= row_y
- r
.y
;
2245 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2248 if (r
.y
< row_y
+ s
->row
->visible_height
)
2250 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2252 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2253 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2262 #ifdef CONVERT_FROM_XRECT
2263 for (i
= 0; i
< n
; i
++)
2264 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2271 Return in *NR the clipping rectangle for glyph string S. */
2274 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2276 get_glyph_string_clip_rects (s
, nr
, 1);
2281 Return the position and height of the phys cursor in window W.
2282 Set w->phys_cursor_width to width of phys cursor.
2286 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2287 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2289 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2290 int x
, y
, wd
, h
, h0
, y0
;
2292 /* Compute the width of the rectangle to draw. If on a stretch
2293 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2294 rectangle as wide as the glyph, but use a canonical character
2296 wd
= glyph
->pixel_width
- 1;
2297 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2301 x
= w
->phys_cursor
.x
;
2308 if (glyph
->type
== STRETCH_GLYPH
2309 && !x_stretch_cursor_p
)
2310 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2311 w
->phys_cursor_width
= wd
;
2313 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2315 /* If y is below window bottom, ensure that we still see a cursor. */
2316 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2318 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2319 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2321 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2324 h
= max (h
- (y0
- y
) + 1, h0
);
2329 y0
= window_text_bottom_y (w
) - h0
;
2337 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2338 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2343 * Remember which glyph the mouse is over.
2347 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2351 struct glyph_row
*r
, *gr
, *end_row
;
2352 enum window_part part
;
2353 enum glyph_row_area area
;
2354 int x
, y
, width
, height
;
2356 /* Try to determine frame pixel position and size of the glyph under
2357 frame pixel coordinates X/Y on frame F. */
2359 if (window_resize_pixelwise
)
2364 else if (!f
->glyphs_initialized_p
2365 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2368 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2369 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2373 w
= XWINDOW (window
);
2374 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2375 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2377 x
= window_relative_x_coord (w
, part
, gx
);
2378 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2380 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2381 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2383 if (w
->pseudo_window_p
)
2386 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2392 case ON_LEFT_MARGIN
:
2393 area
= LEFT_MARGIN_AREA
;
2396 case ON_RIGHT_MARGIN
:
2397 area
= RIGHT_MARGIN_AREA
;
2400 case ON_HEADER_LINE
:
2402 gr
= (part
== ON_HEADER_LINE
2403 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2404 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2407 goto text_glyph_row_found
;
2414 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2415 if (r
->y
+ r
->height
> y
)
2421 text_glyph_row_found
:
2424 struct glyph
*g
= gr
->glyphs
[area
];
2425 struct glyph
*end
= g
+ gr
->used
[area
];
2427 height
= gr
->height
;
2428 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2429 if (gx
+ g
->pixel_width
> x
)
2434 if (g
->type
== IMAGE_GLYPH
)
2436 /* Don't remember when mouse is over image, as
2437 image may have hot-spots. */
2438 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2441 width
= g
->pixel_width
;
2445 /* Use nominal char spacing at end of line. */
2447 gx
+= (x
/ width
) * width
;
2450 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2452 gx
+= window_box_left_offset (w
, area
);
2453 /* Don't expand over the modeline to make sure the vertical
2454 drag cursor is shown early enough. */
2455 height
= min (height
,
2456 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2461 /* Use nominal line height at end of window. */
2462 gx
= (x
/ width
) * width
;
2464 gy
+= (y
/ height
) * height
;
2465 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2466 /* See comment above. */
2467 height
= min (height
,
2468 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2472 case ON_LEFT_FRINGE
:
2473 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2474 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2475 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2476 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2479 case ON_RIGHT_FRINGE
:
2480 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2481 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2482 : window_box_right_offset (w
, TEXT_AREA
));
2483 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0
2484 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
2485 && !WINDOW_RIGHTMOST_P (w
))
2486 if (gx
< WINDOW_PIXEL_WIDTH (w
) - width
)
2487 /* Make sure the vertical border can get her own glyph to the
2488 right of the one we build here. */
2489 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
) - width
;
2491 width
= WINDOW_PIXEL_WIDTH (w
) - gx
;
2493 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2497 case ON_VERTICAL_BORDER
:
2498 gx
= WINDOW_PIXEL_WIDTH (w
) - width
;
2502 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2504 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2505 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2506 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2508 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2512 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2513 if (r
->y
+ r
->height
> y
)
2520 height
= gr
->height
;
2523 /* Use nominal line height at end of window. */
2525 gy
+= (y
/ height
) * height
;
2529 case ON_RIGHT_DIVIDER
:
2530 gx
= WINDOW_PIXEL_WIDTH (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2531 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2533 /* The bottom divider prevails. */
2534 height
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2537 case ON_BOTTOM_DIVIDER
:
2539 width
= WINDOW_PIXEL_WIDTH (w
);
2540 gy
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2541 height
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2547 /* If there is no glyph under the mouse, then we divide the screen
2548 into a grid of the smallest glyph in the frame, and use that
2551 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2552 round down even for negative values. */
2558 gx
= (gx
/ width
) * width
;
2559 gy
= (gy
/ height
) * height
;
2565 gx
+= WINDOW_LEFT_EDGE_X (w
);
2566 gy
+= WINDOW_TOP_EDGE_Y (w
);
2569 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2571 /* Visible feedback for debugging. */
2574 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2575 f
->output_data
.x
->normal_gc
,
2576 gx
, gy
, width
, height
);
2582 #endif /* HAVE_WINDOW_SYSTEM */
2585 adjust_window_ends (struct window
*w
, struct glyph_row
*row
, bool current
)
2588 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
2589 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
2591 = MATRIX_ROW_VPOS (row
, current
? w
->current_matrix
: w
->desired_matrix
);
2594 /***********************************************************************
2595 Lisp form evaluation
2596 ***********************************************************************/
2598 /* Error handler for safe_eval and safe_call. */
2601 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2603 add_to_log ("Error during redisplay: %S signaled %S",
2604 Flist (nargs
, args
), arg
);
2608 /* Call function FUNC with the rest of NARGS - 1 arguments
2609 following. Return the result, or nil if something went
2610 wrong. Prevent redisplay during the evaluation. */
2613 safe__call (bool inhibit_quit
, ptrdiff_t nargs
, Lisp_Object func
, va_list ap
)
2617 if (inhibit_eval_during_redisplay
)
2622 ptrdiff_t count
= SPECPDL_INDEX ();
2623 struct gcpro gcpro1
;
2624 Lisp_Object
*args
= alloca (nargs
* word_size
);
2627 for (i
= 1; i
< nargs
; i
++)
2628 args
[i
] = va_arg (ap
, Lisp_Object
);
2631 gcpro1
.nvars
= nargs
;
2632 specbind (Qinhibit_redisplay
, Qt
);
2634 specbind (Qinhibit_quit
, Qt
);
2635 /* Use Qt to ensure debugger does not run,
2636 so there is no possibility of wanting to redisplay. */
2637 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2640 val
= unbind_to (count
, val
);
2647 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2652 va_start (ap
, func
);
2653 retval
= safe__call (false, nargs
, func
, ap
);
2658 /* Call function FN with one argument ARG.
2659 Return the result, or nil if something went wrong. */
2662 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2664 return safe_call (2, fn
, arg
);
2668 safe__call1 (bool inhibit_quit
, Lisp_Object fn
, ...)
2674 retval
= safe__call (inhibit_quit
, 2, fn
, ap
);
2679 static Lisp_Object Qeval
;
2682 safe_eval (Lisp_Object sexpr
)
2684 return safe__call1 (false, Qeval
, sexpr
);
2688 safe__eval (bool inhibit_quit
, Lisp_Object sexpr
)
2690 return safe__call1 (inhibit_quit
, Qeval
, sexpr
);
2693 /* Call function FN with two arguments ARG1 and ARG2.
2694 Return the result, or nil if something went wrong. */
2697 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2699 return safe_call (3, fn
, arg1
, arg2
);
2704 /***********************************************************************
2706 ***********************************************************************/
2710 /* Define CHECK_IT to perform sanity checks on iterators.
2711 This is for debugging. It is too slow to do unconditionally. */
2714 check_it (struct it
*it
)
2716 if (it
->method
== GET_FROM_STRING
)
2718 eassert (STRINGP (it
->string
));
2719 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2723 eassert (IT_STRING_CHARPOS (*it
) < 0);
2724 if (it
->method
== GET_FROM_BUFFER
)
2726 /* Check that character and byte positions agree. */
2727 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2732 eassert (it
->current
.dpvec_index
>= 0);
2734 eassert (it
->current
.dpvec_index
< 0);
2737 #define CHECK_IT(IT) check_it ((IT))
2741 #define CHECK_IT(IT) (void) 0
2746 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2748 /* Check that the window end of window W is what we expect it
2749 to be---the last row in the current matrix displaying text. */
2752 check_window_end (struct window
*w
)
2754 if (!MINI_WINDOW_P (w
) && w
->window_end_valid
)
2756 struct glyph_row
*row
;
2757 eassert ((row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
),
2759 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2760 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2764 #define CHECK_WINDOW_END(W) check_window_end ((W))
2768 #define CHECK_WINDOW_END(W) (void) 0
2770 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
2772 /***********************************************************************
2773 Iterator initialization
2774 ***********************************************************************/
2776 /* Initialize IT for displaying current_buffer in window W, starting
2777 at character position CHARPOS. CHARPOS < 0 means that no buffer
2778 position is specified which is useful when the iterator is assigned
2779 a position later. BYTEPOS is the byte position corresponding to
2782 If ROW is not null, calls to produce_glyphs with IT as parameter
2783 will produce glyphs in that row.
2785 BASE_FACE_ID is the id of a base face to use. It must be one of
2786 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2787 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2788 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2790 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2791 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2792 will be initialized to use the corresponding mode line glyph row of
2793 the desired matrix of W. */
2796 init_iterator (struct it
*it
, struct window
*w
,
2797 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2798 struct glyph_row
*row
, enum face_id base_face_id
)
2800 enum face_id remapped_base_face_id
= base_face_id
;
2802 /* Some precondition checks. */
2803 eassert (w
!= NULL
&& it
!= NULL
);
2804 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2807 /* If face attributes have been changed since the last redisplay,
2808 free realized faces now because they depend on face definitions
2809 that might have changed. Don't free faces while there might be
2810 desired matrices pending which reference these faces. */
2811 if (face_change_count
&& !inhibit_free_realized_faces
)
2813 face_change_count
= 0;
2814 free_all_realized_faces (Qnil
);
2817 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2818 if (! NILP (Vface_remapping_alist
))
2819 remapped_base_face_id
2820 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2822 /* Use one of the mode line rows of W's desired matrix if
2826 if (base_face_id
== MODE_LINE_FACE_ID
2827 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2828 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2829 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2830 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2834 memset (it
, 0, sizeof *it
);
2835 it
->current
.overlay_string_index
= -1;
2836 it
->current
.dpvec_index
= -1;
2837 it
->base_face_id
= remapped_base_face_id
;
2839 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2840 it
->paragraph_embedding
= L2R
;
2841 it
->bidi_it
.string
.lstring
= Qnil
;
2842 it
->bidi_it
.string
.s
= NULL
;
2843 it
->bidi_it
.string
.bufpos
= 0;
2846 /* The window in which we iterate over current_buffer: */
2847 XSETWINDOW (it
->window
, w
);
2849 it
->f
= XFRAME (w
->frame
);
2853 /* Extra space between lines (on window systems only). */
2854 if (base_face_id
== DEFAULT_FACE_ID
2855 && FRAME_WINDOW_P (it
->f
))
2857 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2858 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2859 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2860 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2861 * FRAME_LINE_HEIGHT (it
->f
));
2862 else if (it
->f
->extra_line_spacing
> 0)
2863 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2864 it
->max_extra_line_spacing
= 0;
2867 /* If realized faces have been removed, e.g. because of face
2868 attribute changes of named faces, recompute them. When running
2869 in batch mode, the face cache of the initial frame is null. If
2870 we happen to get called, make a dummy face cache. */
2871 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2872 init_frame_faces (it
->f
);
2873 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2874 recompute_basic_faces (it
->f
);
2876 /* Current value of the `slice', `space-width', and 'height' properties. */
2877 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2878 it
->space_width
= Qnil
;
2879 it
->font_height
= Qnil
;
2880 it
->override_ascent
= -1;
2882 /* Are control characters displayed as `^C'? */
2883 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2885 /* -1 means everything between a CR and the following line end
2886 is invisible. >0 means lines indented more than this value are
2888 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2890 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2892 : (!NILP (BVAR (current_buffer
, selective_display
))
2894 it
->selective_display_ellipsis_p
2895 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2897 /* Display table to use. */
2898 it
->dp
= window_display_table (w
);
2900 /* Are multibyte characters enabled in current_buffer? */
2901 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2903 /* Get the position at which the redisplay_end_trigger hook should
2904 be run, if it is to be run at all. */
2905 if (MARKERP (w
->redisplay_end_trigger
)
2906 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2907 it
->redisplay_end_trigger_charpos
2908 = marker_position (w
->redisplay_end_trigger
);
2909 else if (INTEGERP (w
->redisplay_end_trigger
))
2910 it
->redisplay_end_trigger_charpos
2911 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2914 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2916 /* Are lines in the display truncated? */
2917 if (base_face_id
!= DEFAULT_FACE_ID
2919 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2920 && ((!NILP (Vtruncate_partial_width_windows
)
2921 && !INTEGERP (Vtruncate_partial_width_windows
))
2922 || (INTEGERP (Vtruncate_partial_width_windows
)
2923 /* PXW: Shall we do something about this? */
2924 && (WINDOW_TOTAL_COLS (it
->w
)
2925 < XINT (Vtruncate_partial_width_windows
))))))
2926 it
->line_wrap
= TRUNCATE
;
2927 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2928 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2929 ? WINDOW_WRAP
: WORD_WRAP
;
2931 it
->line_wrap
= TRUNCATE
;
2933 /* Get dimensions of truncation and continuation glyphs. These are
2934 displayed as fringe bitmaps under X, but we need them for such
2935 frames when the fringes are turned off. But leave the dimensions
2936 zero for tooltip frames, as these glyphs look ugly there and also
2937 sabotage calculations of tooltip dimensions in x-show-tip. */
2938 #ifdef HAVE_WINDOW_SYSTEM
2939 if (!(FRAME_WINDOW_P (it
->f
)
2940 && FRAMEP (tip_frame
)
2941 && it
->f
== XFRAME (tip_frame
)))
2944 if (it
->line_wrap
== TRUNCATE
)
2946 /* We will need the truncation glyph. */
2947 eassert (it
->glyph_row
== NULL
);
2948 produce_special_glyphs (it
, IT_TRUNCATION
);
2949 it
->truncation_pixel_width
= it
->pixel_width
;
2953 /* We will need the continuation glyph. */
2954 eassert (it
->glyph_row
== NULL
);
2955 produce_special_glyphs (it
, IT_CONTINUATION
);
2956 it
->continuation_pixel_width
= it
->pixel_width
;
2960 /* Reset these values to zero because the produce_special_glyphs
2961 above has changed them. */
2962 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2963 it
->phys_ascent
= it
->phys_descent
= 0;
2965 /* Set this after getting the dimensions of truncation and
2966 continuation glyphs, so that we don't produce glyphs when calling
2967 produce_special_glyphs, above. */
2968 it
->glyph_row
= row
;
2969 it
->area
= TEXT_AREA
;
2971 /* Forget any previous info about this row being reversed. */
2973 it
->glyph_row
->reversed_p
= 0;
2975 /* Get the dimensions of the display area. The display area
2976 consists of the visible window area plus a horizontally scrolled
2977 part to the left of the window. All x-values are relative to the
2978 start of this total display area. */
2979 if (base_face_id
!= DEFAULT_FACE_ID
)
2981 /* Mode lines, menu bar in terminal frames. */
2982 it
->first_visible_x
= 0;
2983 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2988 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2989 it
->last_visible_x
= (it
->first_visible_x
2990 + window_box_width (w
, TEXT_AREA
));
2992 /* If we truncate lines, leave room for the truncation glyph(s) at
2993 the right margin. Otherwise, leave room for the continuation
2994 glyph(s). Done only if the window has no fringes. Since we
2995 don't know at this point whether there will be any R2L lines in
2996 the window, we reserve space for truncation/continuation glyphs
2997 even if only one of the fringes is absent. */
2998 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
2999 || (it
->bidi_p
&& WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
3001 if (it
->line_wrap
== TRUNCATE
)
3002 it
->last_visible_x
-= it
->truncation_pixel_width
;
3004 it
->last_visible_x
-= it
->continuation_pixel_width
;
3007 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
3008 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
3011 /* Leave room for a border glyph. */
3012 if (!FRAME_WINDOW_P (it
->f
)
3013 && !WINDOW_RIGHTMOST_P (it
->w
))
3014 it
->last_visible_x
-= 1;
3016 it
->last_visible_y
= window_text_bottom_y (w
);
3018 /* For mode lines and alike, arrange for the first glyph having a
3019 left box line if the face specifies a box. */
3020 if (base_face_id
!= DEFAULT_FACE_ID
)
3024 it
->face_id
= remapped_base_face_id
;
3026 /* If we have a boxed mode line, make the first character appear
3027 with a left box line. */
3028 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
3029 if (face
&& face
->box
!= FACE_NO_BOX
)
3030 it
->start_of_box_run_p
= true;
3033 /* If a buffer position was specified, set the iterator there,
3034 getting overlays and face properties from that position. */
3035 if (charpos
>= BUF_BEG (current_buffer
))
3037 it
->end_charpos
= ZV
;
3038 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
3039 IT_CHARPOS (*it
) = charpos
;
3040 IT_BYTEPOS (*it
) = bytepos
;
3042 /* We will rely on `reseat' to set this up properly, via
3043 handle_face_prop. */
3044 it
->face_id
= it
->base_face_id
;
3046 it
->start
= it
->current
;
3047 /* Do we need to reorder bidirectional text? Not if this is a
3048 unibyte buffer: by definition, none of the single-byte
3049 characters are strong R2L, so no reordering is needed. And
3050 bidi.c doesn't support unibyte buffers anyway. Also, don't
3051 reorder while we are loading loadup.el, since the tables of
3052 character properties needed for reordering are not yet
3056 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
3059 /* If we are to reorder bidirectional text, init the bidi
3063 /* Note the paragraph direction that this buffer wants to
3065 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
3067 it
->paragraph_embedding
= L2R
;
3068 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
3070 it
->paragraph_embedding
= R2L
;
3072 it
->paragraph_embedding
= NEUTRAL_DIR
;
3073 bidi_unshelve_cache (NULL
, 0);
3074 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
3078 /* Compute faces etc. */
3079 reseat (it
, it
->current
.pos
, 1);
3086 /* Initialize IT for the display of window W with window start POS. */
3089 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
3091 struct glyph_row
*row
;
3092 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
3094 row
= w
->desired_matrix
->rows
+ first_vpos
;
3095 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
3096 it
->first_vpos
= first_vpos
;
3098 /* Don't reseat to previous visible line start if current start
3099 position is in a string or image. */
3100 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
3102 int start_at_line_beg_p
;
3103 int first_y
= it
->current_y
;
3105 /* If window start is not at a line start, skip forward to POS to
3106 get the correct continuation lines width. */
3107 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
3108 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
3109 if (!start_at_line_beg_p
)
3113 reseat_at_previous_visible_line_start (it
);
3114 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
3116 new_x
= it
->current_x
+ it
->pixel_width
;
3118 /* If lines are continued, this line may end in the middle
3119 of a multi-glyph character (e.g. a control character
3120 displayed as \003, or in the middle of an overlay
3121 string). In this case move_it_to above will not have
3122 taken us to the start of the continuation line but to the
3123 end of the continued line. */
3124 if (it
->current_x
> 0
3125 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
3126 && (/* And glyph doesn't fit on the line. */
3127 new_x
> it
->last_visible_x
3128 /* Or it fits exactly and we're on a window
3130 || (new_x
== it
->last_visible_x
3131 && FRAME_WINDOW_P (it
->f
)
3132 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
3133 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
3134 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
3136 if ((it
->current
.dpvec_index
>= 0
3137 || it
->current
.overlay_string_index
>= 0)
3138 /* If we are on a newline from a display vector or
3139 overlay string, then we are already at the end of
3140 a screen line; no need to go to the next line in
3141 that case, as this line is not really continued.
3142 (If we do go to the next line, C-e will not DTRT.) */
3145 set_iterator_to_next (it
, 1);
3146 move_it_in_display_line_to (it
, -1, -1, 0);
3149 it
->continuation_lines_width
+= it
->current_x
;
3151 /* If the character at POS is displayed via a display
3152 vector, move_it_to above stops at the final glyph of
3153 IT->dpvec. To make the caller redisplay that character
3154 again (a.k.a. start at POS), we need to reset the
3155 dpvec_index to the beginning of IT->dpvec. */
3156 else if (it
->current
.dpvec_index
>= 0)
3157 it
->current
.dpvec_index
= 0;
3159 /* We're starting a new display line, not affected by the
3160 height of the continued line, so clear the appropriate
3161 fields in the iterator structure. */
3162 it
->max_ascent
= it
->max_descent
= 0;
3163 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3165 it
->current_y
= first_y
;
3167 it
->current_x
= it
->hpos
= 0;
3173 /* Return 1 if POS is a position in ellipses displayed for invisible
3174 text. W is the window we display, for text property lookup. */
3177 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3179 Lisp_Object prop
, window
;
3181 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3183 /* If POS specifies a position in a display vector, this might
3184 be for an ellipsis displayed for invisible text. We won't
3185 get the iterator set up for delivering that ellipsis unless
3186 we make sure that it gets aware of the invisible text. */
3187 if (pos
->dpvec_index
>= 0
3188 && pos
->overlay_string_index
< 0
3189 && CHARPOS (pos
->string_pos
) < 0
3191 && (XSETWINDOW (window
, w
),
3192 prop
= Fget_char_property (make_number (charpos
),
3193 Qinvisible
, window
),
3194 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
3196 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3198 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3205 /* Initialize IT for stepping through current_buffer in window W,
3206 starting at position POS that includes overlay string and display
3207 vector/ control character translation position information. Value
3208 is zero if there are overlay strings with newlines at POS. */
3211 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3213 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3214 int i
, overlay_strings_with_newlines
= 0;
3216 /* If POS specifies a position in a display vector, this might
3217 be for an ellipsis displayed for invisible text. We won't
3218 get the iterator set up for delivering that ellipsis unless
3219 we make sure that it gets aware of the invisible text. */
3220 if (in_ellipses_for_invisible_text_p (pos
, w
))
3226 /* Keep in mind: the call to reseat in init_iterator skips invisible
3227 text, so we might end up at a position different from POS. This
3228 is only a problem when POS is a row start after a newline and an
3229 overlay starts there with an after-string, and the overlay has an
3230 invisible property. Since we don't skip invisible text in
3231 display_line and elsewhere immediately after consuming the
3232 newline before the row start, such a POS will not be in a string,
3233 but the call to init_iterator below will move us to the
3235 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3237 /* This only scans the current chunk -- it should scan all chunks.
3238 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3239 to 16 in 22.1 to make this a lesser problem. */
3240 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3242 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3243 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3245 while (s
< e
&& *s
!= '\n')
3250 overlay_strings_with_newlines
= 1;
3255 /* If position is within an overlay string, set up IT to the right
3257 if (pos
->overlay_string_index
>= 0)
3261 /* If the first overlay string happens to have a `display'
3262 property for an image, the iterator will be set up for that
3263 image, and we have to undo that setup first before we can
3264 correct the overlay string index. */
3265 if (it
->method
== GET_FROM_IMAGE
)
3268 /* We already have the first chunk of overlay strings in
3269 IT->overlay_strings. Load more until the one for
3270 pos->overlay_string_index is in IT->overlay_strings. */
3271 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3273 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3274 it
->current
.overlay_string_index
= 0;
3277 load_overlay_strings (it
, 0);
3278 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3282 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3283 relative_index
= (it
->current
.overlay_string_index
3284 % OVERLAY_STRING_CHUNK_SIZE
);
3285 it
->string
= it
->overlay_strings
[relative_index
];
3286 eassert (STRINGP (it
->string
));
3287 it
->current
.string_pos
= pos
->string_pos
;
3288 it
->method
= GET_FROM_STRING
;
3289 it
->end_charpos
= SCHARS (it
->string
);
3290 /* Set up the bidi iterator for this overlay string. */
3293 it
->bidi_it
.string
.lstring
= it
->string
;
3294 it
->bidi_it
.string
.s
= NULL
;
3295 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3296 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3297 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3298 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3299 it
->bidi_it
.w
= it
->w
;
3300 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3301 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3303 /* Synchronize the state of the bidi iterator with
3304 pos->string_pos. For any string position other than
3305 zero, this will be done automagically when we resume
3306 iteration over the string and get_visually_first_element
3307 is called. But if string_pos is zero, and the string is
3308 to be reordered for display, we need to resync manually,
3309 since it could be that the iteration state recorded in
3310 pos ended at string_pos of 0 moving backwards in string. */
3311 if (CHARPOS (pos
->string_pos
) == 0)
3313 get_visually_first_element (it
);
3314 if (IT_STRING_CHARPOS (*it
) != 0)
3317 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3318 bidi_move_to_visually_next (&it
->bidi_it
);
3319 } while (it
->bidi_it
.charpos
!= 0);
3321 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3322 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3326 if (CHARPOS (pos
->string_pos
) >= 0)
3328 /* Recorded position is not in an overlay string, but in another
3329 string. This can only be a string from a `display' property.
3330 IT should already be filled with that string. */
3331 it
->current
.string_pos
= pos
->string_pos
;
3332 eassert (STRINGP (it
->string
));
3334 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3335 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3338 /* Restore position in display vector translations, control
3339 character translations or ellipses. */
3340 if (pos
->dpvec_index
>= 0)
3342 if (it
->dpvec
== NULL
)
3343 get_next_display_element (it
);
3344 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3345 it
->current
.dpvec_index
= pos
->dpvec_index
;
3349 return !overlay_strings_with_newlines
;
3353 /* Initialize IT for stepping through current_buffer in window W
3354 starting at ROW->start. */
3357 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3359 init_from_display_pos (it
, w
, &row
->start
);
3360 it
->start
= row
->start
;
3361 it
->continuation_lines_width
= row
->continuation_lines_width
;
3366 /* Initialize IT for stepping through current_buffer in window W
3367 starting in the line following ROW, i.e. starting at ROW->end.
3368 Value is zero if there are overlay strings with newlines at ROW's
3372 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3376 if (init_from_display_pos (it
, w
, &row
->end
))
3378 if (row
->continued_p
)
3379 it
->continuation_lines_width
3380 = row
->continuation_lines_width
+ row
->pixel_width
;
3391 /***********************************************************************
3393 ***********************************************************************/
3395 /* Called when IT reaches IT->stop_charpos. Handle text property and
3396 overlay changes. Set IT->stop_charpos to the next position where
3400 handle_stop (struct it
*it
)
3402 enum prop_handled handled
;
3403 int handle_overlay_change_p
;
3407 it
->current
.dpvec_index
= -1;
3408 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3409 it
->ignore_overlay_strings_at_pos_p
= 0;
3412 /* Use face of preceding text for ellipsis (if invisible) */
3413 if (it
->selective_display_ellipsis_p
)
3414 it
->saved_face_id
= it
->face_id
;
3418 handled
= HANDLED_NORMALLY
;
3420 /* Call text property handlers. */
3421 for (p
= it_props
; p
->handler
; ++p
)
3423 handled
= p
->handler (it
);
3425 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3427 else if (handled
== HANDLED_RETURN
)
3429 /* We still want to show before and after strings from
3430 overlays even if the actual buffer text is replaced. */
3431 if (!handle_overlay_change_p
3433 /* Don't call get_overlay_strings_1 if we already
3434 have overlay strings loaded, because doing so
3435 will load them again and push the iterator state
3436 onto the stack one more time, which is not
3437 expected by the rest of the code that processes
3439 || (it
->current
.overlay_string_index
< 0
3440 ? !get_overlay_strings_1 (it
, 0, 0)
3444 setup_for_ellipsis (it
, 0);
3445 /* When handling a display spec, we might load an
3446 empty string. In that case, discard it here. We
3447 used to discard it in handle_single_display_spec,
3448 but that causes get_overlay_strings_1, above, to
3449 ignore overlay strings that we must check. */
3450 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3454 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3458 it
->ignore_overlay_strings_at_pos_p
= true;
3459 it
->string_from_display_prop_p
= 0;
3460 it
->from_disp_prop_p
= 0;
3461 handle_overlay_change_p
= 0;
3463 handled
= HANDLED_RECOMPUTE_PROPS
;
3466 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3467 handle_overlay_change_p
= 0;
3470 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3472 /* Don't check for overlay strings below when set to deliver
3473 characters from a display vector. */
3474 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3475 handle_overlay_change_p
= 0;
3477 /* Handle overlay changes.
3478 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3479 if it finds overlays. */
3480 if (handle_overlay_change_p
)
3481 handled
= handle_overlay_change (it
);
3486 setup_for_ellipsis (it
, 0);
3490 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3492 /* Determine where to stop next. */
3493 if (handled
== HANDLED_NORMALLY
)
3494 compute_stop_pos (it
);
3498 /* Compute IT->stop_charpos from text property and overlay change
3499 information for IT's current position. */
3502 compute_stop_pos (struct it
*it
)
3504 register INTERVAL iv
, next_iv
;
3505 Lisp_Object object
, limit
, position
;
3506 ptrdiff_t charpos
, bytepos
;
3508 if (STRINGP (it
->string
))
3510 /* Strings are usually short, so don't limit the search for
3512 it
->stop_charpos
= it
->end_charpos
;
3513 object
= it
->string
;
3515 charpos
= IT_STRING_CHARPOS (*it
);
3516 bytepos
= IT_STRING_BYTEPOS (*it
);
3522 /* If end_charpos is out of range for some reason, such as a
3523 misbehaving display function, rationalize it (Bug#5984). */
3524 if (it
->end_charpos
> ZV
)
3525 it
->end_charpos
= ZV
;
3526 it
->stop_charpos
= it
->end_charpos
;
3528 /* If next overlay change is in front of the current stop pos
3529 (which is IT->end_charpos), stop there. Note: value of
3530 next_overlay_change is point-max if no overlay change
3532 charpos
= IT_CHARPOS (*it
);
3533 bytepos
= IT_BYTEPOS (*it
);
3534 pos
= next_overlay_change (charpos
);
3535 if (pos
< it
->stop_charpos
)
3536 it
->stop_charpos
= pos
;
3538 /* Set up variables for computing the stop position from text
3539 property changes. */
3540 XSETBUFFER (object
, current_buffer
);
3541 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3544 /* Get the interval containing IT's position. Value is a null
3545 interval if there isn't such an interval. */
3546 position
= make_number (charpos
);
3547 iv
= validate_interval_range (object
, &position
, &position
, 0);
3550 Lisp_Object values_here
[LAST_PROP_IDX
];
3553 /* Get properties here. */
3554 for (p
= it_props
; p
->handler
; ++p
)
3555 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3557 /* Look for an interval following iv that has different
3559 for (next_iv
= next_interval (iv
);
3562 || XFASTINT (limit
) > next_iv
->position
));
3563 next_iv
= next_interval (next_iv
))
3565 for (p
= it_props
; p
->handler
; ++p
)
3567 Lisp_Object new_value
;
3569 new_value
= textget (next_iv
->plist
, *p
->name
);
3570 if (!EQ (values_here
[p
->idx
], new_value
))
3580 if (INTEGERP (limit
)
3581 && next_iv
->position
>= XFASTINT (limit
))
3582 /* No text property change up to limit. */
3583 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3585 /* Text properties change in next_iv. */
3586 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3590 if (it
->cmp_it
.id
< 0)
3592 ptrdiff_t stoppos
= it
->end_charpos
;
3594 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3596 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3597 stoppos
, it
->string
);
3600 eassert (STRINGP (it
->string
)
3601 || (it
->stop_charpos
>= BEGV
3602 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3606 /* Return the position of the next overlay change after POS in
3607 current_buffer. Value is point-max if no overlay change
3608 follows. This is like `next-overlay-change' but doesn't use
3612 next_overlay_change (ptrdiff_t pos
)
3614 ptrdiff_t i
, noverlays
;
3616 Lisp_Object
*overlays
;
3618 /* Get all overlays at the given position. */
3619 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3621 /* If any of these overlays ends before endpos,
3622 use its ending point instead. */
3623 for (i
= 0; i
< noverlays
; ++i
)
3628 oend
= OVERLAY_END (overlays
[i
]);
3629 oendpos
= OVERLAY_POSITION (oend
);
3630 endpos
= min (endpos
, oendpos
);
3636 /* How many characters forward to search for a display property or
3637 display string. Searching too far forward makes the bidi display
3638 sluggish, especially in small windows. */
3639 #define MAX_DISP_SCAN 250
3641 /* Return the character position of a display string at or after
3642 position specified by POSITION. If no display string exists at or
3643 after POSITION, return ZV. A display string is either an overlay
3644 with `display' property whose value is a string, or a `display'
3645 text property whose value is a string. STRING is data about the
3646 string to iterate; if STRING->lstring is nil, we are iterating a
3647 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3648 on a GUI frame. DISP_PROP is set to zero if we searched
3649 MAX_DISP_SCAN characters forward without finding any display
3650 strings, non-zero otherwise. It is set to 2 if the display string
3651 uses any kind of `(space ...)' spec that will produce a stretch of
3652 white space in the text area. */
3654 compute_display_string_pos (struct text_pos
*position
,
3655 struct bidi_string_data
*string
,
3657 int frame_window_p
, int *disp_prop
)
3659 /* OBJECT = nil means current buffer. */
3660 Lisp_Object object
, object1
;
3661 Lisp_Object pos
, spec
, limpos
;
3662 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3663 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3664 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3665 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3667 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3668 struct text_pos tpos
;
3671 if (string
&& STRINGP (string
->lstring
))
3672 object1
= object
= string
->lstring
;
3673 else if (w
&& !string_p
)
3675 XSETWINDOW (object
, w
);
3679 object1
= object
= Qnil
;
3684 /* We don't support display properties whose values are strings
3685 that have display string properties. */
3686 || string
->from_disp_str
3687 /* C strings cannot have display properties. */
3688 || (string
->s
&& !STRINGP (object
)))
3694 /* If the character at CHARPOS is where the display string begins,
3696 pos
= make_number (charpos
);
3697 if (STRINGP (object
))
3698 bufpos
= string
->bufpos
;
3702 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3704 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3707 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3715 /* Look forward for the first character with a `display' property
3716 that will replace the underlying text when displayed. */
3717 limpos
= make_number (lim
);
3719 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3720 CHARPOS (tpos
) = XFASTINT (pos
);
3721 if (CHARPOS (tpos
) >= lim
)
3726 if (STRINGP (object
))
3727 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3729 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3730 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3731 if (!STRINGP (object
))
3732 bufpos
= CHARPOS (tpos
);
3733 } while (NILP (spec
)
3734 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3735 bufpos
, frame_window_p
)));
3739 return CHARPOS (tpos
);
3742 /* Return the character position of the end of the display string that
3743 started at CHARPOS. If there's no display string at CHARPOS,
3744 return -1. A display string is either an overlay with `display'
3745 property whose value is a string or a `display' text property whose
3746 value is a string. */
3748 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3750 /* OBJECT = nil means current buffer. */
3751 Lisp_Object object
=
3752 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3753 Lisp_Object pos
= make_number (charpos
);
3755 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3757 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3760 /* It could happen that the display property or overlay was removed
3761 since we found it in compute_display_string_pos above. One way
3762 this can happen is if JIT font-lock was called (through
3763 handle_fontified_prop), and jit-lock-functions remove text
3764 properties or overlays from the portion of buffer that includes
3765 CHARPOS. Muse mode is known to do that, for example. In this
3766 case, we return -1 to the caller, to signal that no display
3767 string is actually present at CHARPOS. See bidi_fetch_char for
3768 how this is handled.
3770 An alternative would be to never look for display properties past
3771 it->stop_charpos. But neither compute_display_string_pos nor
3772 bidi_fetch_char that calls it know or care where the next
3774 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3777 /* Look forward for the first character where the `display' property
3779 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3781 return XFASTINT (pos
);
3786 /***********************************************************************
3788 ***********************************************************************/
3790 /* Handle changes in the `fontified' property of the current buffer by
3791 calling hook functions from Qfontification_functions to fontify
3794 static enum prop_handled
3795 handle_fontified_prop (struct it
*it
)
3797 Lisp_Object prop
, pos
;
3798 enum prop_handled handled
= HANDLED_NORMALLY
;
3800 if (!NILP (Vmemory_full
))
3803 /* Get the value of the `fontified' property at IT's current buffer
3804 position. (The `fontified' property doesn't have a special
3805 meaning in strings.) If the value is nil, call functions from
3806 Qfontification_functions. */
3807 if (!STRINGP (it
->string
)
3809 && !NILP (Vfontification_functions
)
3810 && !NILP (Vrun_hooks
)
3811 && (pos
= make_number (IT_CHARPOS (*it
)),
3812 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3813 /* Ignore the special cased nil value always present at EOB since
3814 no amount of fontifying will be able to change it. */
3815 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3817 ptrdiff_t count
= SPECPDL_INDEX ();
3819 struct buffer
*obuf
= current_buffer
;
3820 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3821 bool old_clip_changed
= current_buffer
->clip_changed
;
3823 val
= Vfontification_functions
;
3824 specbind (Qfontification_functions
, Qnil
);
3826 eassert (it
->end_charpos
== ZV
);
3828 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3829 safe_call1 (val
, pos
);
3832 Lisp_Object fns
, fn
;
3833 struct gcpro gcpro1
, gcpro2
;
3838 for (; CONSP (val
); val
= XCDR (val
))
3844 /* A value of t indicates this hook has a local
3845 binding; it means to run the global binding too.
3846 In a global value, t should not occur. If it
3847 does, we must ignore it to avoid an endless
3849 for (fns
= Fdefault_value (Qfontification_functions
);
3855 safe_call1 (fn
, pos
);
3859 safe_call1 (fn
, pos
);
3865 unbind_to (count
, Qnil
);
3867 /* Fontification functions routinely call `save-restriction'.
3868 Normally, this tags clip_changed, which can confuse redisplay
3869 (see discussion in Bug#6671). Since we don't perform any
3870 special handling of fontification changes in the case where
3871 `save-restriction' isn't called, there's no point doing so in
3872 this case either. So, if the buffer's restrictions are
3873 actually left unchanged, reset clip_changed. */
3874 if (obuf
== current_buffer
)
3876 if (begv
== BEGV
&& zv
== ZV
)
3877 current_buffer
->clip_changed
= old_clip_changed
;
3879 /* There isn't much we can reasonably do to protect against
3880 misbehaving fontification, but here's a fig leaf. */
3881 else if (BUFFER_LIVE_P (obuf
))
3882 set_buffer_internal_1 (obuf
);
3884 /* The fontification code may have added/removed text.
3885 It could do even a lot worse, but let's at least protect against
3886 the most obvious case where only the text past `pos' gets changed',
3887 as is/was done in grep.el where some escapes sequences are turned
3888 into face properties (bug#7876). */
3889 it
->end_charpos
= ZV
;
3891 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3892 something. This avoids an endless loop if they failed to
3893 fontify the text for which reason ever. */
3894 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3895 handled
= HANDLED_RECOMPUTE_PROPS
;
3903 /***********************************************************************
3905 ***********************************************************************/
3907 /* Set up iterator IT from face properties at its current position.
3908 Called from handle_stop. */
3910 static enum prop_handled
3911 handle_face_prop (struct it
*it
)
3914 ptrdiff_t next_stop
;
3916 if (!STRINGP (it
->string
))
3919 = face_at_buffer_position (it
->w
,
3923 + TEXT_PROP_DISTANCE_LIMIT
),
3924 0, it
->base_face_id
);
3926 /* Is this a start of a run of characters with box face?
3927 Caveat: this can be called for a freshly initialized
3928 iterator; face_id is -1 in this case. We know that the new
3929 face will not change until limit, i.e. if the new face has a
3930 box, all characters up to limit will have one. But, as
3931 usual, we don't know whether limit is really the end. */
3932 if (new_face_id
!= it
->face_id
)
3934 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3935 /* If it->face_id is -1, old_face below will be NULL, see
3936 the definition of FACE_FROM_ID. This will happen if this
3937 is the initial call that gets the face. */
3938 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3940 /* If the value of face_id of the iterator is -1, we have to
3941 look in front of IT's position and see whether there is a
3942 face there that's different from new_face_id. */
3943 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3945 int prev_face_id
= face_before_it_pos (it
);
3947 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3950 /* If the new face has a box, but the old face does not,
3951 this is the start of a run of characters with box face,
3952 i.e. this character has a shadow on the left side. */
3953 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3954 && (old_face
== NULL
|| !old_face
->box
));
3955 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3963 Lisp_Object from_overlay
3964 = (it
->current
.overlay_string_index
>= 0
3965 ? it
->string_overlays
[it
->current
.overlay_string_index
3966 % OVERLAY_STRING_CHUNK_SIZE
]
3969 /* See if we got to this string directly or indirectly from
3970 an overlay property. That includes the before-string or
3971 after-string of an overlay, strings in display properties
3972 provided by an overlay, their text properties, etc.
3974 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3975 if (! NILP (from_overlay
))
3976 for (i
= it
->sp
- 1; i
>= 0; i
--)
3978 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3980 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3981 % OVERLAY_STRING_CHUNK_SIZE
];
3982 else if (! NILP (it
->stack
[i
].from_overlay
))
3983 from_overlay
= it
->stack
[i
].from_overlay
;
3985 if (!NILP (from_overlay
))
3989 if (! NILP (from_overlay
))
3991 bufpos
= IT_CHARPOS (*it
);
3992 /* For a string from an overlay, the base face depends
3993 only on text properties and ignores overlays. */
3995 = face_for_overlay_string (it
->w
,
3999 + TEXT_PROP_DISTANCE_LIMIT
),
4007 /* For strings from a `display' property, use the face at
4008 IT's current buffer position as the base face to merge
4009 with, so that overlay strings appear in the same face as
4010 surrounding text, unless they specify their own faces.
4011 For strings from wrap-prefix and line-prefix properties,
4012 use the default face, possibly remapped via
4013 Vface_remapping_alist. */
4014 /* Note that the fact that we use the face at _buffer_
4015 position means that a 'display' property on an overlay
4016 string will not inherit the face of that overlay string,
4017 but will instead revert to the face of buffer text
4018 covered by the overlay. This is visible, e.g., when the
4019 overlay specifies a box face, but neither the buffer nor
4020 the display string do. This sounds like a design bug,
4021 but Emacs always did that since v21.1, so changing that
4022 might be a big deal. */
4023 base_face_id
= it
->string_from_prefix_prop_p
4024 ? (!NILP (Vface_remapping_alist
)
4025 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
4027 : underlying_face_id (it
);
4030 new_face_id
= face_at_string_position (it
->w
,
4032 IT_STRING_CHARPOS (*it
),
4037 /* Is this a start of a run of characters with box? Caveat:
4038 this can be called for a freshly allocated iterator; face_id
4039 is -1 is this case. We know that the new face will not
4040 change until the next check pos, i.e. if the new face has a
4041 box, all characters up to that position will have a
4042 box. But, as usual, we don't know whether that position
4043 is really the end. */
4044 if (new_face_id
!= it
->face_id
)
4046 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
4047 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4049 /* If new face has a box but old face hasn't, this is the
4050 start of a run of characters with box, i.e. it has a
4051 shadow on the left side. */
4052 it
->start_of_box_run_p
4053 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
4054 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4058 it
->face_id
= new_face_id
;
4059 return HANDLED_NORMALLY
;
4063 /* Return the ID of the face ``underlying'' IT's current position,
4064 which is in a string. If the iterator is associated with a
4065 buffer, return the face at IT's current buffer position.
4066 Otherwise, use the iterator's base_face_id. */
4069 underlying_face_id (struct it
*it
)
4071 int face_id
= it
->base_face_id
, i
;
4073 eassert (STRINGP (it
->string
));
4075 for (i
= it
->sp
- 1; i
>= 0; --i
)
4076 if (NILP (it
->stack
[i
].string
))
4077 face_id
= it
->stack
[i
].face_id
;
4083 /* Compute the face one character before or after the current position
4084 of IT, in the visual order. BEFORE_P non-zero means get the face
4085 in front (to the left in L2R paragraphs, to the right in R2L
4086 paragraphs) of IT's screen position. Value is the ID of the face. */
4089 face_before_or_after_it_pos (struct it
*it
, int before_p
)
4092 ptrdiff_t next_check_charpos
;
4094 void *it_copy_data
= NULL
;
4096 eassert (it
->s
== NULL
);
4098 if (STRINGP (it
->string
))
4100 ptrdiff_t bufpos
, charpos
;
4103 /* No face change past the end of the string (for the case
4104 we are padding with spaces). No face change before the
4106 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4107 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4112 /* Set charpos to the position before or after IT's current
4113 position, in the logical order, which in the non-bidi
4114 case is the same as the visual order. */
4116 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4117 else if (it
->what
== IT_COMPOSITION
)
4118 /* For composition, we must check the character after the
4120 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4122 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4128 /* With bidi iteration, the character before the current
4129 in the visual order cannot be found by simple
4130 iteration, because "reverse" reordering is not
4131 supported. Instead, we need to use the move_it_*
4132 family of functions. */
4133 /* Ignore face changes before the first visible
4134 character on this display line. */
4135 if (it
->current_x
<= it
->first_visible_x
)
4137 SAVE_IT (it_copy
, *it
, it_copy_data
);
4138 /* Implementation note: Since move_it_in_display_line
4139 works in the iterator geometry, and thinks the first
4140 character is always the leftmost, even in R2L lines,
4141 we don't need to distinguish between the R2L and L2R
4143 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
4144 it_copy
.current_x
- 1, MOVE_TO_X
);
4145 charpos
= IT_STRING_CHARPOS (it_copy
);
4146 RESTORE_IT (it
, it
, it_copy_data
);
4150 /* Set charpos to the string position of the character
4151 that comes after IT's current position in the visual
4153 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4157 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4159 charpos
= it_copy
.bidi_it
.charpos
;
4162 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4164 if (it
->current
.overlay_string_index
>= 0)
4165 bufpos
= IT_CHARPOS (*it
);
4169 base_face_id
= underlying_face_id (it
);
4171 /* Get the face for ASCII, or unibyte. */
4172 face_id
= face_at_string_position (it
->w
,
4176 &next_check_charpos
,
4179 /* Correct the face for charsets different from ASCII. Do it
4180 for the multibyte case only. The face returned above is
4181 suitable for unibyte text if IT->string is unibyte. */
4182 if (STRING_MULTIBYTE (it
->string
))
4184 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4185 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4187 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4189 c
= string_char_and_length (p
, &len
);
4190 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4195 struct text_pos pos
;
4197 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4198 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4201 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4202 pos
= it
->current
.pos
;
4207 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4210 if (it
->what
== IT_COMPOSITION
)
4212 /* For composition, we must check the position after
4214 pos
.charpos
+= it
->cmp_it
.nchars
;
4215 pos
.bytepos
+= it
->len
;
4218 INC_TEXT_POS (pos
, it
->multibyte_p
);
4225 /* With bidi iteration, the character before the current
4226 in the visual order cannot be found by simple
4227 iteration, because "reverse" reordering is not
4228 supported. Instead, we need to use the move_it_*
4229 family of functions. */
4230 /* Ignore face changes before the first visible
4231 character on this display line. */
4232 if (it
->current_x
<= it
->first_visible_x
)
4234 SAVE_IT (it_copy
, *it
, it_copy_data
);
4235 /* Implementation note: Since move_it_in_display_line
4236 works in the iterator geometry, and thinks the first
4237 character is always the leftmost, even in R2L lines,
4238 we don't need to distinguish between the R2L and L2R
4240 move_it_in_display_line (&it_copy
, ZV
,
4241 it_copy
.current_x
- 1, MOVE_TO_X
);
4242 pos
= it_copy
.current
.pos
;
4243 RESTORE_IT (it
, it
, it_copy_data
);
4247 /* Set charpos to the buffer position of the character
4248 that comes after IT's current position in the visual
4250 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4254 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4257 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4260 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4262 /* Determine face for CHARSET_ASCII, or unibyte. */
4263 face_id
= face_at_buffer_position (it
->w
,
4265 &next_check_charpos
,
4268 /* Correct the face for charsets different from ASCII. Do it
4269 for the multibyte case only. The face returned above is
4270 suitable for unibyte text if current_buffer is unibyte. */
4271 if (it
->multibyte_p
)
4273 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4274 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4275 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4284 /***********************************************************************
4286 ***********************************************************************/
4288 /* Set up iterator IT from invisible properties at its current
4289 position. Called from handle_stop. */
4291 static enum prop_handled
4292 handle_invisible_prop (struct it
*it
)
4294 enum prop_handled handled
= HANDLED_NORMALLY
;
4298 if (STRINGP (it
->string
))
4300 Lisp_Object end_charpos
, limit
, charpos
;
4302 /* Get the value of the invisible text property at the
4303 current position. Value will be nil if there is no such
4305 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4306 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4307 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4309 if (invis_p
&& IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4311 /* Record whether we have to display an ellipsis for the
4313 int display_ellipsis_p
= (invis_p
== 2);
4314 ptrdiff_t len
, endpos
;
4316 handled
= HANDLED_RECOMPUTE_PROPS
;
4318 /* Get the position at which the next visible text can be
4319 found in IT->string, if any. */
4320 endpos
= len
= SCHARS (it
->string
);
4321 XSETINT (limit
, len
);
4324 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4326 if (INTEGERP (end_charpos
))
4328 endpos
= XFASTINT (end_charpos
);
4329 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4330 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4332 display_ellipsis_p
= true;
4335 while (invis_p
&& endpos
< len
);
4337 if (display_ellipsis_p
)
4338 it
->ellipsis_p
= true;
4342 /* Text at END_CHARPOS is visible. Move IT there. */
4343 struct text_pos old
;
4346 old
= it
->current
.string_pos
;
4347 oldpos
= CHARPOS (old
);
4350 if (it
->bidi_it
.first_elt
4351 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4352 bidi_paragraph_init (it
->paragraph_embedding
,
4354 /* Bidi-iterate out of the invisible text. */
4357 bidi_move_to_visually_next (&it
->bidi_it
);
4359 while (oldpos
<= it
->bidi_it
.charpos
4360 && it
->bidi_it
.charpos
< endpos
);
4362 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4363 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4364 if (IT_CHARPOS (*it
) >= endpos
)
4365 it
->prev_stop
= endpos
;
4369 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4370 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4375 /* The rest of the string is invisible. If this is an
4376 overlay string, proceed with the next overlay string
4377 or whatever comes and return a character from there. */
4378 if (it
->current
.overlay_string_index
>= 0
4379 && !display_ellipsis_p
)
4381 next_overlay_string (it
);
4382 /* Don't check for overlay strings when we just
4383 finished processing them. */
4384 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4388 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4389 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4396 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4397 Lisp_Object pos
, overlay
;
4399 /* First of all, is there invisible text at this position? */
4400 tem
= start_charpos
= IT_CHARPOS (*it
);
4401 pos
= make_number (tem
);
4402 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4404 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4406 /* If we are on invisible text, skip over it. */
4407 if (invis_p
&& start_charpos
< it
->end_charpos
)
4409 /* Record whether we have to display an ellipsis for the
4411 int display_ellipsis_p
= invis_p
== 2;
4413 handled
= HANDLED_RECOMPUTE_PROPS
;
4415 /* Loop skipping over invisible text. The loop is left at
4416 ZV or with IT on the first char being visible again. */
4419 /* Try to skip some invisible text. Return value is the
4420 position reached which can be equal to where we start
4421 if there is nothing invisible there. This skips both
4422 over invisible text properties and overlays with
4423 invisible property. */
4424 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4426 /* If we skipped nothing at all we weren't at invisible
4427 text in the first place. If everything to the end of
4428 the buffer was skipped, end the loop. */
4429 if (newpos
== tem
|| newpos
>= ZV
)
4433 /* We skipped some characters but not necessarily
4434 all there are. Check if we ended up on visible
4435 text. Fget_char_property returns the property of
4436 the char before the given position, i.e. if we
4437 get invis_p = 0, this means that the char at
4438 newpos is visible. */
4439 pos
= make_number (newpos
);
4440 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4441 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4444 /* If we ended up on invisible text, proceed to
4445 skip starting with next_stop. */
4449 /* If there are adjacent invisible texts, don't lose the
4450 second one's ellipsis. */
4452 display_ellipsis_p
= true;
4456 /* The position newpos is now either ZV or on visible text. */
4459 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4461 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4463 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4465 /* If the invisible text ends on a newline or on a
4466 character after a newline, we can avoid the costly,
4467 character by character, bidi iteration to NEWPOS, and
4468 instead simply reseat the iterator there. That's
4469 because all bidi reordering information is tossed at
4470 the newline. This is a big win for modes that hide
4471 complete lines, like Outline, Org, etc. */
4472 if (on_newline
|| after_newline
)
4474 struct text_pos tpos
;
4475 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4477 SET_TEXT_POS (tpos
, newpos
, bpos
);
4478 reseat_1 (it
, tpos
, 0);
4479 /* If we reseat on a newline/ZV, we need to prep the
4480 bidi iterator for advancing to the next character
4481 after the newline/EOB, keeping the current paragraph
4482 direction (so that PRODUCE_GLYPHS does TRT wrt
4483 prepending/appending glyphs to a glyph row). */
4486 it
->bidi_it
.first_elt
= 0;
4487 it
->bidi_it
.paragraph_dir
= pdir
;
4488 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4489 it
->bidi_it
.nchars
= 1;
4490 it
->bidi_it
.ch_len
= 1;
4493 else /* Must use the slow method. */
4495 /* With bidi iteration, the region of invisible text
4496 could start and/or end in the middle of a
4497 non-base embedding level. Therefore, we need to
4498 skip invisible text using the bidi iterator,
4499 starting at IT's current position, until we find
4500 ourselves outside of the invisible text.
4501 Skipping invisible text _after_ bidi iteration
4502 avoids affecting the visual order of the
4503 displayed text when invisible properties are
4504 added or removed. */
4505 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4507 /* If we were `reseat'ed to a new paragraph,
4508 determine the paragraph base direction. We
4509 need to do it now because
4510 next_element_from_buffer may not have a
4511 chance to do it, if we are going to skip any
4512 text at the beginning, which resets the
4514 bidi_paragraph_init (it
->paragraph_embedding
,
4519 bidi_move_to_visually_next (&it
->bidi_it
);
4521 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4522 && it
->bidi_it
.charpos
< newpos
);
4523 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4524 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4525 /* If we overstepped NEWPOS, record its position in
4526 the iterator, so that we skip invisible text if
4527 later the bidi iteration lands us in the
4528 invisible region again. */
4529 if (IT_CHARPOS (*it
) >= newpos
)
4530 it
->prev_stop
= newpos
;
4535 IT_CHARPOS (*it
) = newpos
;
4536 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4539 /* If there are before-strings at the start of invisible
4540 text, and the text is invisible because of a text
4541 property, arrange to show before-strings because 20.x did
4542 it that way. (If the text is invisible because of an
4543 overlay property instead of a text property, this is
4544 already handled in the overlay code.) */
4546 && get_overlay_strings (it
, it
->stop_charpos
))
4548 handled
= HANDLED_RECOMPUTE_PROPS
;
4549 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4551 else if (display_ellipsis_p
)
4553 /* Make sure that the glyphs of the ellipsis will get
4554 correct `charpos' values. If we would not update
4555 it->position here, the glyphs would belong to the
4556 last visible character _before_ the invisible
4557 text, which confuses `set_cursor_from_row'.
4559 We use the last invisible position instead of the
4560 first because this way the cursor is always drawn on
4561 the first "." of the ellipsis, whenever PT is inside
4562 the invisible text. Otherwise the cursor would be
4563 placed _after_ the ellipsis when the point is after the
4564 first invisible character. */
4565 if (!STRINGP (it
->object
))
4567 it
->position
.charpos
= newpos
- 1;
4568 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4570 it
->ellipsis_p
= true;
4571 /* Let the ellipsis display before
4572 considering any properties of the following char.
4573 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4574 handled
= HANDLED_RETURN
;
4583 /* Make iterator IT return `...' next.
4584 Replaces LEN characters from buffer. */
4587 setup_for_ellipsis (struct it
*it
, int len
)
4589 /* Use the display table definition for `...'. Invalid glyphs
4590 will be handled by the method returning elements from dpvec. */
4591 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4593 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4594 it
->dpvec
= v
->contents
;
4595 it
->dpend
= v
->contents
+ v
->header
.size
;
4599 /* Default `...'. */
4600 it
->dpvec
= default_invis_vector
;
4601 it
->dpend
= default_invis_vector
+ 3;
4604 it
->dpvec_char_len
= len
;
4605 it
->current
.dpvec_index
= 0;
4606 it
->dpvec_face_id
= -1;
4608 /* Remember the current face id in case glyphs specify faces.
4609 IT's face is restored in set_iterator_to_next.
4610 saved_face_id was set to preceding char's face in handle_stop. */
4611 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4612 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4614 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4615 it
->ellipsis_p
= true;
4620 /***********************************************************************
4622 ***********************************************************************/
4624 /* Set up iterator IT from `display' property at its current position.
4625 Called from handle_stop.
4626 We return HANDLED_RETURN if some part of the display property
4627 overrides the display of the buffer text itself.
4628 Otherwise we return HANDLED_NORMALLY. */
4630 static enum prop_handled
4631 handle_display_prop (struct it
*it
)
4633 Lisp_Object propval
, object
, overlay
;
4634 struct text_pos
*position
;
4636 /* Nonzero if some property replaces the display of the text itself. */
4637 int display_replaced_p
= 0;
4639 if (STRINGP (it
->string
))
4641 object
= it
->string
;
4642 position
= &it
->current
.string_pos
;
4643 bufpos
= CHARPOS (it
->current
.pos
);
4647 XSETWINDOW (object
, it
->w
);
4648 position
= &it
->current
.pos
;
4649 bufpos
= CHARPOS (*position
);
4652 /* Reset those iterator values set from display property values. */
4653 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4654 it
->space_width
= Qnil
;
4655 it
->font_height
= Qnil
;
4658 /* We don't support recursive `display' properties, i.e. string
4659 values that have a string `display' property, that have a string
4660 `display' property etc. */
4661 if (!it
->string_from_display_prop_p
)
4662 it
->area
= TEXT_AREA
;
4664 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4665 Qdisplay
, object
, &overlay
);
4667 return HANDLED_NORMALLY
;
4668 /* Now OVERLAY is the overlay that gave us this property, or nil
4669 if it was a text property. */
4671 if (!STRINGP (it
->string
))
4672 object
= it
->w
->contents
;
4674 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4676 FRAME_WINDOW_P (it
->f
));
4678 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4681 /* Subroutine of handle_display_prop. Returns non-zero if the display
4682 specification in SPEC is a replacing specification, i.e. it would
4683 replace the text covered by `display' property with something else,
4684 such as an image or a display string. If SPEC includes any kind or
4685 `(space ...) specification, the value is 2; this is used by
4686 compute_display_string_pos, which see.
4688 See handle_single_display_spec for documentation of arguments.
4689 frame_window_p is non-zero if the window being redisplayed is on a
4690 GUI frame; this argument is used only if IT is NULL, see below.
4692 IT can be NULL, if this is called by the bidi reordering code
4693 through compute_display_string_pos, which see. In that case, this
4694 function only examines SPEC, but does not otherwise "handle" it, in
4695 the sense that it doesn't set up members of IT from the display
4698 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4699 Lisp_Object overlay
, struct text_pos
*position
,
4700 ptrdiff_t bufpos
, int frame_window_p
)
4702 int replacing_p
= 0;
4706 /* Simple specifications. */
4707 && !EQ (XCAR (spec
), Qimage
)
4708 && !EQ (XCAR (spec
), Qspace
)
4709 && !EQ (XCAR (spec
), Qwhen
)
4710 && !EQ (XCAR (spec
), Qslice
)
4711 && !EQ (XCAR (spec
), Qspace_width
)
4712 && !EQ (XCAR (spec
), Qheight
)
4713 && !EQ (XCAR (spec
), Qraise
)
4714 /* Marginal area specifications. */
4715 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4716 && !EQ (XCAR (spec
), Qleft_fringe
)
4717 && !EQ (XCAR (spec
), Qright_fringe
)
4718 && !NILP (XCAR (spec
)))
4720 for (; CONSP (spec
); spec
= XCDR (spec
))
4722 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4723 overlay
, position
, bufpos
,
4724 replacing_p
, frame_window_p
)))
4727 /* If some text in a string is replaced, `position' no
4728 longer points to the position of `object'. */
4729 if (!it
|| STRINGP (object
))
4734 else if (VECTORP (spec
))
4737 for (i
= 0; i
< ASIZE (spec
); ++i
)
4738 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4739 overlay
, position
, bufpos
,
4740 replacing_p
, frame_window_p
)))
4743 /* If some text in a string is replaced, `position' no
4744 longer points to the position of `object'. */
4745 if (!it
|| STRINGP (object
))
4751 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4752 position
, bufpos
, 0,
4760 /* Value is the position of the end of the `display' property starting
4761 at START_POS in OBJECT. */
4763 static struct text_pos
4764 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4767 struct text_pos end_pos
;
4769 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4770 Qdisplay
, object
, Qnil
);
4771 CHARPOS (end_pos
) = XFASTINT (end
);
4772 if (STRINGP (object
))
4773 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4775 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4781 /* Set up IT from a single `display' property specification SPEC. OBJECT
4782 is the object in which the `display' property was found. *POSITION
4783 is the position in OBJECT at which the `display' property was found.
4784 BUFPOS is the buffer position of OBJECT (different from POSITION if
4785 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4786 previously saw a display specification which already replaced text
4787 display with something else, for example an image; we ignore such
4788 properties after the first one has been processed.
4790 OVERLAY is the overlay this `display' property came from,
4791 or nil if it was a text property.
4793 If SPEC is a `space' or `image' specification, and in some other
4794 cases too, set *POSITION to the position where the `display'
4797 If IT is NULL, only examine the property specification in SPEC, but
4798 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4799 is intended to be displayed in a window on a GUI frame.
4801 Value is non-zero if something was found which replaces the display
4802 of buffer or string text. */
4805 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4806 Lisp_Object overlay
, struct text_pos
*position
,
4807 ptrdiff_t bufpos
, int display_replaced_p
,
4811 Lisp_Object location
, value
;
4812 struct text_pos start_pos
= *position
;
4815 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4816 If the result is non-nil, use VALUE instead of SPEC. */
4818 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4827 if (!NILP (form
) && !EQ (form
, Qt
))
4829 ptrdiff_t count
= SPECPDL_INDEX ();
4830 struct gcpro gcpro1
;
4832 /* Bind `object' to the object having the `display' property, a
4833 buffer or string. Bind `position' to the position in the
4834 object where the property was found, and `buffer-position'
4835 to the current position in the buffer. */
4838 XSETBUFFER (object
, current_buffer
);
4839 specbind (Qobject
, object
);
4840 specbind (Qposition
, make_number (CHARPOS (*position
)));
4841 specbind (Qbuffer_position
, make_number (bufpos
));
4843 form
= safe_eval (form
);
4845 unbind_to (count
, Qnil
);
4851 /* Handle `(height HEIGHT)' specifications. */
4853 && EQ (XCAR (spec
), Qheight
)
4854 && CONSP (XCDR (spec
)))
4858 if (!FRAME_WINDOW_P (it
->f
))
4861 it
->font_height
= XCAR (XCDR (spec
));
4862 if (!NILP (it
->font_height
))
4864 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4865 int new_height
= -1;
4867 if (CONSP (it
->font_height
)
4868 && (EQ (XCAR (it
->font_height
), Qplus
)
4869 || EQ (XCAR (it
->font_height
), Qminus
))
4870 && CONSP (XCDR (it
->font_height
))
4871 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4873 /* `(+ N)' or `(- N)' where N is an integer. */
4874 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4875 if (EQ (XCAR (it
->font_height
), Qplus
))
4877 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4879 else if (FUNCTIONP (it
->font_height
))
4881 /* Call function with current height as argument.
4882 Value is the new height. */
4884 height
= safe_call1 (it
->font_height
,
4885 face
->lface
[LFACE_HEIGHT_INDEX
]);
4886 if (NUMBERP (height
))
4887 new_height
= XFLOATINT (height
);
4889 else if (NUMBERP (it
->font_height
))
4891 /* Value is a multiple of the canonical char height. */
4894 f
= FACE_FROM_ID (it
->f
,
4895 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4896 new_height
= (XFLOATINT (it
->font_height
)
4897 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4901 /* Evaluate IT->font_height with `height' bound to the
4902 current specified height to get the new height. */
4903 ptrdiff_t count
= SPECPDL_INDEX ();
4905 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4906 value
= safe_eval (it
->font_height
);
4907 unbind_to (count
, Qnil
);
4909 if (NUMBERP (value
))
4910 new_height
= XFLOATINT (value
);
4914 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4921 /* Handle `(space-width WIDTH)'. */
4923 && EQ (XCAR (spec
), Qspace_width
)
4924 && CONSP (XCDR (spec
)))
4928 if (!FRAME_WINDOW_P (it
->f
))
4931 value
= XCAR (XCDR (spec
));
4932 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4933 it
->space_width
= value
;
4939 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4941 && EQ (XCAR (spec
), Qslice
))
4947 if (!FRAME_WINDOW_P (it
->f
))
4950 if (tem
= XCDR (spec
), CONSP (tem
))
4952 it
->slice
.x
= XCAR (tem
);
4953 if (tem
= XCDR (tem
), CONSP (tem
))
4955 it
->slice
.y
= XCAR (tem
);
4956 if (tem
= XCDR (tem
), CONSP (tem
))
4958 it
->slice
.width
= XCAR (tem
);
4959 if (tem
= XCDR (tem
), CONSP (tem
))
4960 it
->slice
.height
= XCAR (tem
);
4969 /* Handle `(raise FACTOR)'. */
4971 && EQ (XCAR (spec
), Qraise
)
4972 && CONSP (XCDR (spec
)))
4976 if (!FRAME_WINDOW_P (it
->f
))
4979 #ifdef HAVE_WINDOW_SYSTEM
4980 value
= XCAR (XCDR (spec
));
4981 if (NUMBERP (value
))
4983 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4984 it
->voffset
= - (XFLOATINT (value
)
4985 * (FONT_HEIGHT (face
->font
)));
4987 #endif /* HAVE_WINDOW_SYSTEM */
4993 /* Don't handle the other kinds of display specifications
4994 inside a string that we got from a `display' property. */
4995 if (it
&& it
->string_from_display_prop_p
)
4998 /* Characters having this form of property are not displayed, so
4999 we have to find the end of the property. */
5002 start_pos
= *position
;
5003 *position
= display_prop_end (it
, object
, start_pos
);
5007 /* Stop the scan at that end position--we assume that all
5008 text properties change there. */
5010 it
->stop_charpos
= position
->charpos
;
5012 /* Handle `(left-fringe BITMAP [FACE])'
5013 and `(right-fringe BITMAP [FACE])'. */
5015 && (EQ (XCAR (spec
), Qleft_fringe
)
5016 || EQ (XCAR (spec
), Qright_fringe
))
5017 && CONSP (XCDR (spec
)))
5023 if (!FRAME_WINDOW_P (it
->f
))
5024 /* If we return here, POSITION has been advanced
5025 across the text with this property. */
5027 /* Synchronize the bidi iterator with POSITION. This is
5028 needed because we are not going to push the iterator
5029 on behalf of this display property, so there will be
5030 no pop_it call to do this synchronization for us. */
5033 it
->position
= *position
;
5034 iterate_out_of_display_property (it
);
5035 *position
= it
->position
;
5040 else if (!frame_window_p
)
5043 #ifdef HAVE_WINDOW_SYSTEM
5044 value
= XCAR (XCDR (spec
));
5045 if (!SYMBOLP (value
)
5046 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
5047 /* If we return here, POSITION has been advanced
5048 across the text with this property. */
5050 if (it
&& it
->bidi_p
)
5052 it
->position
= *position
;
5053 iterate_out_of_display_property (it
);
5054 *position
= it
->position
;
5061 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
5063 if (CONSP (XCDR (XCDR (spec
))))
5065 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5066 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5072 /* Save current settings of IT so that we can restore them
5073 when we are finished with the glyph property value. */
5074 push_it (it
, position
);
5076 it
->area
= TEXT_AREA
;
5077 it
->what
= IT_IMAGE
;
5078 it
->image_id
= -1; /* no image */
5079 it
->position
= start_pos
;
5080 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5081 it
->method
= GET_FROM_IMAGE
;
5082 it
->from_overlay
= Qnil
;
5083 it
->face_id
= face_id
;
5084 it
->from_disp_prop_p
= true;
5086 /* Say that we haven't consumed the characters with
5087 `display' property yet. The call to pop_it in
5088 set_iterator_to_next will clean this up. */
5089 *position
= start_pos
;
5091 if (EQ (XCAR (spec
), Qleft_fringe
))
5093 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5094 it
->left_user_fringe_face_id
= face_id
;
5098 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5099 it
->right_user_fringe_face_id
= face_id
;
5102 #endif /* HAVE_WINDOW_SYSTEM */
5106 /* Prepare to handle `((margin left-margin) ...)',
5107 `((margin right-margin) ...)' and `((margin nil) ...)'
5108 prefixes for display specifications. */
5109 location
= Qunbound
;
5110 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5114 value
= XCDR (spec
);
5116 value
= XCAR (value
);
5119 if (EQ (XCAR (tem
), Qmargin
)
5120 && (tem
= XCDR (tem
),
5121 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5123 || EQ (tem
, Qleft_margin
)
5124 || EQ (tem
, Qright_margin
))))
5128 if (EQ (location
, Qunbound
))
5134 /* After this point, VALUE is the property after any
5135 margin prefix has been stripped. It must be a string,
5136 an image specification, or `(space ...)'.
5138 LOCATION specifies where to display: `left-margin',
5139 `right-margin' or nil. */
5141 valid_p
= (STRINGP (value
)
5142 #ifdef HAVE_WINDOW_SYSTEM
5143 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5144 && valid_image_p (value
))
5145 #endif /* not HAVE_WINDOW_SYSTEM */
5146 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
5148 if (valid_p
&& !display_replaced_p
)
5154 /* Callers need to know whether the display spec is any kind
5155 of `(space ...)' spec that is about to affect text-area
5157 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5162 /* Save current settings of IT so that we can restore them
5163 when we are finished with the glyph property value. */
5164 push_it (it
, position
);
5165 it
->from_overlay
= overlay
;
5166 it
->from_disp_prop_p
= true;
5168 if (NILP (location
))
5169 it
->area
= TEXT_AREA
;
5170 else if (EQ (location
, Qleft_margin
))
5171 it
->area
= LEFT_MARGIN_AREA
;
5173 it
->area
= RIGHT_MARGIN_AREA
;
5175 if (STRINGP (value
))
5178 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5179 it
->current
.overlay_string_index
= -1;
5180 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5181 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5182 it
->method
= GET_FROM_STRING
;
5183 it
->stop_charpos
= 0;
5185 it
->base_level_stop
= 0;
5186 it
->string_from_display_prop_p
= true;
5187 /* Say that we haven't consumed the characters with
5188 `display' property yet. The call to pop_it in
5189 set_iterator_to_next will clean this up. */
5190 if (BUFFERP (object
))
5191 *position
= start_pos
;
5193 /* Force paragraph direction to be that of the parent
5194 object. If the parent object's paragraph direction is
5195 not yet determined, default to L2R. */
5196 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5197 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5199 it
->paragraph_embedding
= L2R
;
5201 /* Set up the bidi iterator for this display string. */
5204 it
->bidi_it
.string
.lstring
= it
->string
;
5205 it
->bidi_it
.string
.s
= NULL
;
5206 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5207 it
->bidi_it
.string
.bufpos
= bufpos
;
5208 it
->bidi_it
.string
.from_disp_str
= 1;
5209 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5210 it
->bidi_it
.w
= it
->w
;
5211 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5214 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5216 it
->method
= GET_FROM_STRETCH
;
5218 *position
= it
->position
= start_pos
;
5219 retval
= 1 + (it
->area
== TEXT_AREA
);
5221 #ifdef HAVE_WINDOW_SYSTEM
5224 it
->what
= IT_IMAGE
;
5225 it
->image_id
= lookup_image (it
->f
, value
);
5226 it
->position
= start_pos
;
5227 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5228 it
->method
= GET_FROM_IMAGE
;
5230 /* Say that we haven't consumed the characters with
5231 `display' property yet. The call to pop_it in
5232 set_iterator_to_next will clean this up. */
5233 *position
= start_pos
;
5235 #endif /* HAVE_WINDOW_SYSTEM */
5240 /* Invalid property or property not supported. Restore
5241 POSITION to what it was before. */
5242 *position
= start_pos
;
5246 /* Check if PROP is a display property value whose text should be
5247 treated as intangible. OVERLAY is the overlay from which PROP
5248 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5249 specify the buffer position covered by PROP. */
5252 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5253 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5255 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5256 struct text_pos position
;
5258 SET_TEXT_POS (position
, charpos
, bytepos
);
5259 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5260 &position
, charpos
, frame_window_p
);
5264 /* Return 1 if PROP is a display sub-property value containing STRING.
5266 Implementation note: this and the following function are really
5267 special cases of handle_display_spec and
5268 handle_single_display_spec, and should ideally use the same code.
5269 Until they do, these two pairs must be consistent and must be
5270 modified in sync. */
5273 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5275 if (EQ (string
, prop
))
5278 /* Skip over `when FORM'. */
5279 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5284 /* Actually, the condition following `when' should be eval'ed,
5285 like handle_single_display_spec does, and we should return
5286 zero if it evaluates to nil. However, this function is
5287 called only when the buffer was already displayed and some
5288 glyph in the glyph matrix was found to come from a display
5289 string. Therefore, the condition was already evaluated, and
5290 the result was non-nil, otherwise the display string wouldn't
5291 have been displayed and we would have never been called for
5292 this property. Thus, we can skip the evaluation and assume
5293 its result is non-nil. */
5298 /* Skip over `margin LOCATION'. */
5299 if (EQ (XCAR (prop
), Qmargin
))
5310 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5314 /* Return 1 if STRING appears in the `display' property PROP. */
5317 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5320 && !EQ (XCAR (prop
), Qwhen
)
5321 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5323 /* A list of sub-properties. */
5324 while (CONSP (prop
))
5326 if (single_display_spec_string_p (XCAR (prop
), string
))
5331 else if (VECTORP (prop
))
5333 /* A vector of sub-properties. */
5335 for (i
= 0; i
< ASIZE (prop
); ++i
)
5336 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5340 return single_display_spec_string_p (prop
, string
);
5345 /* Look for STRING in overlays and text properties in the current
5346 buffer, between character positions FROM and TO (excluding TO).
5347 BACK_P non-zero means look back (in this case, TO is supposed to be
5349 Value is the first character position where STRING was found, or
5350 zero if it wasn't found before hitting TO.
5352 This function may only use code that doesn't eval because it is
5353 called asynchronously from note_mouse_highlight. */
5356 string_buffer_position_lim (Lisp_Object string
,
5357 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5359 Lisp_Object limit
, prop
, pos
;
5362 pos
= make_number (max (from
, BEGV
));
5364 if (!back_p
) /* looking forward */
5366 limit
= make_number (min (to
, ZV
));
5367 while (!found
&& !EQ (pos
, limit
))
5369 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5370 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5373 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5377 else /* looking back */
5379 limit
= make_number (max (to
, BEGV
));
5380 while (!found
&& !EQ (pos
, limit
))
5382 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5383 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5386 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5391 return found
? XINT (pos
) : 0;
5394 /* Determine which buffer position in current buffer STRING comes from.
5395 AROUND_CHARPOS is an approximate position where it could come from.
5396 Value is the buffer position or 0 if it couldn't be determined.
5398 This function is necessary because we don't record buffer positions
5399 in glyphs generated from strings (to keep struct glyph small).
5400 This function may only use code that doesn't eval because it is
5401 called asynchronously from note_mouse_highlight. */
5404 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5406 const int MAX_DISTANCE
= 1000;
5407 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5408 around_charpos
+ MAX_DISTANCE
,
5412 found
= string_buffer_position_lim (string
, around_charpos
,
5413 around_charpos
- MAX_DISTANCE
, 1);
5419 /***********************************************************************
5420 `composition' property
5421 ***********************************************************************/
5423 /* Set up iterator IT from `composition' property at its current
5424 position. Called from handle_stop. */
5426 static enum prop_handled
5427 handle_composition_prop (struct it
*it
)
5429 Lisp_Object prop
, string
;
5430 ptrdiff_t pos
, pos_byte
, start
, end
;
5432 if (STRINGP (it
->string
))
5436 pos
= IT_STRING_CHARPOS (*it
);
5437 pos_byte
= IT_STRING_BYTEPOS (*it
);
5438 string
= it
->string
;
5439 s
= SDATA (string
) + pos_byte
;
5440 it
->c
= STRING_CHAR (s
);
5444 pos
= IT_CHARPOS (*it
);
5445 pos_byte
= IT_BYTEPOS (*it
);
5447 it
->c
= FETCH_CHAR (pos_byte
);
5450 /* If there's a valid composition and point is not inside of the
5451 composition (in the case that the composition is from the current
5452 buffer), draw a glyph composed from the composition components. */
5453 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5454 && composition_valid_p (start
, end
, prop
)
5455 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5458 /* As we can't handle this situation (perhaps font-lock added
5459 a new composition), we just return here hoping that next
5460 redisplay will detect this composition much earlier. */
5461 return HANDLED_NORMALLY
;
5464 if (STRINGP (it
->string
))
5465 pos_byte
= string_char_to_byte (it
->string
, start
);
5467 pos_byte
= CHAR_TO_BYTE (start
);
5469 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5472 if (it
->cmp_it
.id
>= 0)
5475 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5476 it
->cmp_it
.nglyphs
= -1;
5480 return HANDLED_NORMALLY
;
5485 /***********************************************************************
5487 ***********************************************************************/
5489 /* The following structure is used to record overlay strings for
5490 later sorting in load_overlay_strings. */
5492 struct overlay_entry
5494 Lisp_Object overlay
;
5501 /* Set up iterator IT from overlay strings at its current position.
5502 Called from handle_stop. */
5504 static enum prop_handled
5505 handle_overlay_change (struct it
*it
)
5507 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5508 return HANDLED_RECOMPUTE_PROPS
;
5510 return HANDLED_NORMALLY
;
5514 /* Set up the next overlay string for delivery by IT, if there is an
5515 overlay string to deliver. Called by set_iterator_to_next when the
5516 end of the current overlay string is reached. If there are more
5517 overlay strings to display, IT->string and
5518 IT->current.overlay_string_index are set appropriately here.
5519 Otherwise IT->string is set to nil. */
5522 next_overlay_string (struct it
*it
)
5524 ++it
->current
.overlay_string_index
;
5525 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5527 /* No more overlay strings. Restore IT's settings to what
5528 they were before overlay strings were processed, and
5529 continue to deliver from current_buffer. */
5531 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5534 || (NILP (it
->string
)
5535 && it
->method
== GET_FROM_BUFFER
5536 && it
->stop_charpos
>= BEGV
5537 && it
->stop_charpos
<= it
->end_charpos
));
5538 it
->current
.overlay_string_index
= -1;
5539 it
->n_overlay_strings
= 0;
5540 it
->overlay_strings_charpos
= -1;
5541 /* If there's an empty display string on the stack, pop the
5542 stack, to resync the bidi iterator with IT's position. Such
5543 empty strings are pushed onto the stack in
5544 get_overlay_strings_1. */
5545 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5548 /* If we're at the end of the buffer, record that we have
5549 processed the overlay strings there already, so that
5550 next_element_from_buffer doesn't try it again. */
5551 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5552 it
->overlay_strings_at_end_processed_p
= true;
5556 /* There are more overlay strings to process. If
5557 IT->current.overlay_string_index has advanced to a position
5558 where we must load IT->overlay_strings with more strings, do
5559 it. We must load at the IT->overlay_strings_charpos where
5560 IT->n_overlay_strings was originally computed; when invisible
5561 text is present, this might not be IT_CHARPOS (Bug#7016). */
5562 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5564 if (it
->current
.overlay_string_index
&& i
== 0)
5565 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5567 /* Initialize IT to deliver display elements from the overlay
5569 it
->string
= it
->overlay_strings
[i
];
5570 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5571 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5572 it
->method
= GET_FROM_STRING
;
5573 it
->stop_charpos
= 0;
5574 it
->end_charpos
= SCHARS (it
->string
);
5575 if (it
->cmp_it
.stop_pos
>= 0)
5576 it
->cmp_it
.stop_pos
= 0;
5578 it
->base_level_stop
= 0;
5580 /* Set up the bidi iterator for this overlay string. */
5583 it
->bidi_it
.string
.lstring
= it
->string
;
5584 it
->bidi_it
.string
.s
= NULL
;
5585 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5586 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5587 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5588 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5589 it
->bidi_it
.w
= it
->w
;
5590 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5598 /* Compare two overlay_entry structures E1 and E2. Used as a
5599 comparison function for qsort in load_overlay_strings. Overlay
5600 strings for the same position are sorted so that
5602 1. All after-strings come in front of before-strings, except
5603 when they come from the same overlay.
5605 2. Within after-strings, strings are sorted so that overlay strings
5606 from overlays with higher priorities come first.
5608 2. Within before-strings, strings are sorted so that overlay
5609 strings from overlays with higher priorities come last.
5611 Value is analogous to strcmp. */
5615 compare_overlay_entries (const void *e1
, const void *e2
)
5617 struct overlay_entry
const *entry1
= e1
;
5618 struct overlay_entry
const *entry2
= e2
;
5621 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5623 /* Let after-strings appear in front of before-strings if
5624 they come from different overlays. */
5625 if (EQ (entry1
->overlay
, entry2
->overlay
))
5626 result
= entry1
->after_string_p
? 1 : -1;
5628 result
= entry1
->after_string_p
? -1 : 1;
5630 else if (entry1
->priority
!= entry2
->priority
)
5632 if (entry1
->after_string_p
)
5633 /* After-strings sorted in order of decreasing priority. */
5634 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5636 /* Before-strings sorted in order of increasing priority. */
5637 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5646 /* Load the vector IT->overlay_strings with overlay strings from IT's
5647 current buffer position, or from CHARPOS if that is > 0. Set
5648 IT->n_overlays to the total number of overlay strings found.
5650 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5651 a time. On entry into load_overlay_strings,
5652 IT->current.overlay_string_index gives the number of overlay
5653 strings that have already been loaded by previous calls to this
5656 IT->add_overlay_start contains an additional overlay start
5657 position to consider for taking overlay strings from, if non-zero.
5658 This position comes into play when the overlay has an `invisible'
5659 property, and both before and after-strings. When we've skipped to
5660 the end of the overlay, because of its `invisible' property, we
5661 nevertheless want its before-string to appear.
5662 IT->add_overlay_start will contain the overlay start position
5665 Overlay strings are sorted so that after-string strings come in
5666 front of before-string strings. Within before and after-strings,
5667 strings are sorted by overlay priority. See also function
5668 compare_overlay_entries. */
5671 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5673 Lisp_Object overlay
, window
, str
, invisible
;
5674 struct Lisp_Overlay
*ov
;
5675 ptrdiff_t start
, end
;
5676 ptrdiff_t size
= 20;
5677 ptrdiff_t n
= 0, i
, j
;
5679 struct overlay_entry
*entries
= alloca (size
* sizeof *entries
);
5683 charpos
= IT_CHARPOS (*it
);
5685 /* Append the overlay string STRING of overlay OVERLAY to vector
5686 `entries' which has size `size' and currently contains `n'
5687 elements. AFTER_P non-zero means STRING is an after-string of
5689 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5692 Lisp_Object priority; \
5696 struct overlay_entry *old = entries; \
5697 SAFE_NALLOCA (entries, 2, size); \
5698 memcpy (entries, old, size * sizeof *entries); \
5702 entries[n].string = (STRING); \
5703 entries[n].overlay = (OVERLAY); \
5704 priority = Foverlay_get ((OVERLAY), Qpriority); \
5705 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5706 entries[n].after_string_p = (AFTER_P); \
5711 /* Process overlay before the overlay center. */
5712 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5714 XSETMISC (overlay
, ov
);
5715 eassert (OVERLAYP (overlay
));
5716 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5717 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5722 /* Skip this overlay if it doesn't start or end at IT's current
5724 if (end
!= charpos
&& start
!= charpos
)
5727 /* Skip this overlay if it doesn't apply to IT->w. */
5728 window
= Foverlay_get (overlay
, Qwindow
);
5729 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5732 /* If the text ``under'' the overlay is invisible, both before-
5733 and after-strings from this overlay are visible; start and
5734 end position are indistinguishable. */
5735 invisible
= Foverlay_get (overlay
, Qinvisible
);
5736 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5738 /* If overlay has a non-empty before-string, record it. */
5739 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5740 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5742 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5744 /* If overlay has a non-empty after-string, record it. */
5745 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5746 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5748 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5751 /* Process overlays after the overlay center. */
5752 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5754 XSETMISC (overlay
, ov
);
5755 eassert (OVERLAYP (overlay
));
5756 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5757 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5759 if (start
> charpos
)
5762 /* Skip this overlay if it doesn't start or end at IT's current
5764 if (end
!= charpos
&& start
!= charpos
)
5767 /* Skip this overlay if it doesn't apply to IT->w. */
5768 window
= Foverlay_get (overlay
, Qwindow
);
5769 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5772 /* If the text ``under'' the overlay is invisible, it has a zero
5773 dimension, and both before- and after-strings apply. */
5774 invisible
= Foverlay_get (overlay
, Qinvisible
);
5775 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5777 /* If overlay has a non-empty before-string, record it. */
5778 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5779 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5781 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5783 /* If overlay has a non-empty after-string, record it. */
5784 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5785 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5787 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5790 #undef RECORD_OVERLAY_STRING
5794 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5796 /* Record number of overlay strings, and where we computed it. */
5797 it
->n_overlay_strings
= n
;
5798 it
->overlay_strings_charpos
= charpos
;
5800 /* IT->current.overlay_string_index is the number of overlay strings
5801 that have already been consumed by IT. Copy some of the
5802 remaining overlay strings to IT->overlay_strings. */
5804 j
= it
->current
.overlay_string_index
;
5805 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5807 it
->overlay_strings
[i
] = entries
[j
].string
;
5808 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5816 /* Get the first chunk of overlay strings at IT's current buffer
5817 position, or at CHARPOS if that is > 0. Value is non-zero if at
5818 least one overlay string was found. */
5821 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5823 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5824 process. This fills IT->overlay_strings with strings, and sets
5825 IT->n_overlay_strings to the total number of strings to process.
5826 IT->pos.overlay_string_index has to be set temporarily to zero
5827 because load_overlay_strings needs this; it must be set to -1
5828 when no overlay strings are found because a zero value would
5829 indicate a position in the first overlay string. */
5830 it
->current
.overlay_string_index
= 0;
5831 load_overlay_strings (it
, charpos
);
5833 /* If we found overlay strings, set up IT to deliver display
5834 elements from the first one. Otherwise set up IT to deliver
5835 from current_buffer. */
5836 if (it
->n_overlay_strings
)
5838 /* Make sure we know settings in current_buffer, so that we can
5839 restore meaningful values when we're done with the overlay
5842 compute_stop_pos (it
);
5843 eassert (it
->face_id
>= 0);
5845 /* Save IT's settings. They are restored after all overlay
5846 strings have been processed. */
5847 eassert (!compute_stop_p
|| it
->sp
== 0);
5849 /* When called from handle_stop, there might be an empty display
5850 string loaded. In that case, don't bother saving it. But
5851 don't use this optimization with the bidi iterator, since we
5852 need the corresponding pop_it call to resync the bidi
5853 iterator's position with IT's position, after we are done
5854 with the overlay strings. (The corresponding call to pop_it
5855 in case of an empty display string is in
5856 next_overlay_string.) */
5858 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5861 /* Set up IT to deliver display elements from the first overlay
5863 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5864 it
->string
= it
->overlay_strings
[0];
5865 it
->from_overlay
= Qnil
;
5866 it
->stop_charpos
= 0;
5867 eassert (STRINGP (it
->string
));
5868 it
->end_charpos
= SCHARS (it
->string
);
5870 it
->base_level_stop
= 0;
5871 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5872 it
->method
= GET_FROM_STRING
;
5873 it
->from_disp_prop_p
= 0;
5875 /* Force paragraph direction to be that of the parent
5877 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5878 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5880 it
->paragraph_embedding
= L2R
;
5882 /* Set up the bidi iterator for this overlay string. */
5885 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5887 it
->bidi_it
.string
.lstring
= it
->string
;
5888 it
->bidi_it
.string
.s
= NULL
;
5889 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5890 it
->bidi_it
.string
.bufpos
= pos
;
5891 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5892 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5893 it
->bidi_it
.w
= it
->w
;
5894 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5899 it
->current
.overlay_string_index
= -1;
5904 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5907 it
->method
= GET_FROM_BUFFER
;
5909 (void) get_overlay_strings_1 (it
, charpos
, 1);
5913 /* Value is non-zero if we found at least one overlay string. */
5914 return STRINGP (it
->string
);
5919 /***********************************************************************
5920 Saving and restoring state
5921 ***********************************************************************/
5923 /* Save current settings of IT on IT->stack. Called, for example,
5924 before setting up IT for an overlay string, to be able to restore
5925 IT's settings to what they were after the overlay string has been
5926 processed. If POSITION is non-NULL, it is the position to save on
5927 the stack instead of IT->position. */
5930 push_it (struct it
*it
, struct text_pos
*position
)
5932 struct iterator_stack_entry
*p
;
5934 eassert (it
->sp
< IT_STACK_SIZE
);
5935 p
= it
->stack
+ it
->sp
;
5937 p
->stop_charpos
= it
->stop_charpos
;
5938 p
->prev_stop
= it
->prev_stop
;
5939 p
->base_level_stop
= it
->base_level_stop
;
5940 p
->cmp_it
= it
->cmp_it
;
5941 eassert (it
->face_id
>= 0);
5942 p
->face_id
= it
->face_id
;
5943 p
->string
= it
->string
;
5944 p
->method
= it
->method
;
5945 p
->from_overlay
= it
->from_overlay
;
5948 case GET_FROM_IMAGE
:
5949 p
->u
.image
.object
= it
->object
;
5950 p
->u
.image
.image_id
= it
->image_id
;
5951 p
->u
.image
.slice
= it
->slice
;
5953 case GET_FROM_STRETCH
:
5954 p
->u
.stretch
.object
= it
->object
;
5957 p
->position
= position
? *position
: it
->position
;
5958 p
->current
= it
->current
;
5959 p
->end_charpos
= it
->end_charpos
;
5960 p
->string_nchars
= it
->string_nchars
;
5962 p
->multibyte_p
= it
->multibyte_p
;
5963 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5964 p
->space_width
= it
->space_width
;
5965 p
->font_height
= it
->font_height
;
5966 p
->voffset
= it
->voffset
;
5967 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5968 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5969 p
->display_ellipsis_p
= 0;
5970 p
->line_wrap
= it
->line_wrap
;
5971 p
->bidi_p
= it
->bidi_p
;
5972 p
->paragraph_embedding
= it
->paragraph_embedding
;
5973 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5976 /* Save the state of the bidi iterator as well. */
5978 bidi_push_it (&it
->bidi_it
);
5982 iterate_out_of_display_property (struct it
*it
)
5984 int buffer_p
= !STRINGP (it
->string
);
5985 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5986 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
5988 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5990 /* Maybe initialize paragraph direction. If we are at the beginning
5991 of a new paragraph, next_element_from_buffer may not have a
5992 chance to do that. */
5993 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5994 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5995 /* prev_stop can be zero, so check against BEGV as well. */
5996 while (it
->bidi_it
.charpos
>= bob
5997 && it
->prev_stop
<= it
->bidi_it
.charpos
5998 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5999 && it
->bidi_it
.charpos
< eob
)
6000 bidi_move_to_visually_next (&it
->bidi_it
);
6001 /* Record the stop_pos we just crossed, for when we cross it
6003 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
6004 it
->prev_stop
= CHARPOS (it
->position
);
6005 /* If we ended up not where pop_it put us, resync IT's
6006 positional members with the bidi iterator. */
6007 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
6008 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
6010 it
->current
.pos
= it
->position
;
6012 it
->current
.string_pos
= it
->position
;
6015 /* Restore IT's settings from IT->stack. Called, for example, when no
6016 more overlay strings must be processed, and we return to delivering
6017 display elements from a buffer, or when the end of a string from a
6018 `display' property is reached and we return to delivering display
6019 elements from an overlay string, or from a buffer. */
6022 pop_it (struct it
*it
)
6024 struct iterator_stack_entry
*p
;
6025 int from_display_prop
= it
->from_disp_prop_p
;
6027 eassert (it
->sp
> 0);
6029 p
= it
->stack
+ it
->sp
;
6030 it
->stop_charpos
= p
->stop_charpos
;
6031 it
->prev_stop
= p
->prev_stop
;
6032 it
->base_level_stop
= p
->base_level_stop
;
6033 it
->cmp_it
= p
->cmp_it
;
6034 it
->face_id
= p
->face_id
;
6035 it
->current
= p
->current
;
6036 it
->position
= p
->position
;
6037 it
->string
= p
->string
;
6038 it
->from_overlay
= p
->from_overlay
;
6039 if (NILP (it
->string
))
6040 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6041 it
->method
= p
->method
;
6044 case GET_FROM_IMAGE
:
6045 it
->image_id
= p
->u
.image
.image_id
;
6046 it
->object
= p
->u
.image
.object
;
6047 it
->slice
= p
->u
.image
.slice
;
6049 case GET_FROM_STRETCH
:
6050 it
->object
= p
->u
.stretch
.object
;
6052 case GET_FROM_BUFFER
:
6053 it
->object
= it
->w
->contents
;
6055 case GET_FROM_STRING
:
6057 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6059 /* Restore the face_box_p flag, since it could have been
6060 overwritten by the face of the object that we just finished
6063 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6064 it
->object
= it
->string
;
6067 case GET_FROM_DISPLAY_VECTOR
:
6069 it
->method
= GET_FROM_C_STRING
;
6070 else if (STRINGP (it
->string
))
6071 it
->method
= GET_FROM_STRING
;
6074 it
->method
= GET_FROM_BUFFER
;
6075 it
->object
= it
->w
->contents
;
6078 it
->end_charpos
= p
->end_charpos
;
6079 it
->string_nchars
= p
->string_nchars
;
6081 it
->multibyte_p
= p
->multibyte_p
;
6082 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6083 it
->space_width
= p
->space_width
;
6084 it
->font_height
= p
->font_height
;
6085 it
->voffset
= p
->voffset
;
6086 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6087 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6088 it
->line_wrap
= p
->line_wrap
;
6089 it
->bidi_p
= p
->bidi_p
;
6090 it
->paragraph_embedding
= p
->paragraph_embedding
;
6091 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6094 bidi_pop_it (&it
->bidi_it
);
6095 /* Bidi-iterate until we get out of the portion of text, if any,
6096 covered by a `display' text property or by an overlay with
6097 `display' property. (We cannot just jump there, because the
6098 internal coherency of the bidi iterator state can not be
6099 preserved across such jumps.) We also must determine the
6100 paragraph base direction if the overlay we just processed is
6101 at the beginning of a new paragraph. */
6102 if (from_display_prop
6103 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6104 iterate_out_of_display_property (it
);
6106 eassert ((BUFFERP (it
->object
)
6107 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6108 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6109 || (STRINGP (it
->object
)
6110 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6111 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6112 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6118 /***********************************************************************
6120 ***********************************************************************/
6122 /* Set IT's current position to the previous line start. */
6125 back_to_previous_line_start (struct it
*it
)
6127 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6130 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6134 /* Move IT to the next line start.
6136 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
6137 we skipped over part of the text (as opposed to moving the iterator
6138 continuously over the text). Otherwise, don't change the value
6141 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6142 iterator on the newline, if it was found.
6144 Newlines may come from buffer text, overlay strings, or strings
6145 displayed via the `display' property. That's the reason we can't
6146 simply use find_newline_no_quit.
6148 Note that this function may not skip over invisible text that is so
6149 because of text properties and immediately follows a newline. If
6150 it would, function reseat_at_next_visible_line_start, when called
6151 from set_iterator_to_next, would effectively make invisible
6152 characters following a newline part of the wrong glyph row, which
6153 leads to wrong cursor motion. */
6156 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
6157 struct bidi_it
*bidi_it_prev
)
6159 ptrdiff_t old_selective
;
6160 int newline_found_p
, n
;
6161 const int MAX_NEWLINE_DISTANCE
= 500;
6163 /* If already on a newline, just consume it to avoid unintended
6164 skipping over invisible text below. */
6165 if (it
->what
== IT_CHARACTER
6167 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6169 if (it
->bidi_p
&& bidi_it_prev
)
6170 *bidi_it_prev
= it
->bidi_it
;
6171 set_iterator_to_next (it
, 0);
6176 /* Don't handle selective display in the following. It's (a)
6177 unnecessary because it's done by the caller, and (b) leads to an
6178 infinite recursion because next_element_from_ellipsis indirectly
6179 calls this function. */
6180 old_selective
= it
->selective
;
6183 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6184 from buffer text. */
6185 for (n
= newline_found_p
= 0;
6186 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6187 n
+= STRINGP (it
->string
) ? 0 : 1)
6189 if (!get_next_display_element (it
))
6191 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6192 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6193 *bidi_it_prev
= it
->bidi_it
;
6194 set_iterator_to_next (it
, 0);
6197 /* If we didn't find a newline near enough, see if we can use a
6199 if (!newline_found_p
)
6201 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6202 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6206 eassert (!STRINGP (it
->string
));
6208 /* If there isn't any `display' property in sight, and no
6209 overlays, we can just use the position of the newline in
6211 if (it
->stop_charpos
>= limit
6212 || ((pos
= Fnext_single_property_change (make_number (start
),
6214 make_number (limit
)),
6216 && next_overlay_change (start
) == ZV
))
6220 IT_CHARPOS (*it
) = limit
;
6221 IT_BYTEPOS (*it
) = bytepos
;
6225 struct bidi_it bprev
;
6227 /* Help bidi.c avoid expensive searches for display
6228 properties and overlays, by telling it that there are
6229 none up to `limit'. */
6230 if (it
->bidi_it
.disp_pos
< limit
)
6232 it
->bidi_it
.disp_pos
= limit
;
6233 it
->bidi_it
.disp_prop
= 0;
6236 bprev
= it
->bidi_it
;
6237 bidi_move_to_visually_next (&it
->bidi_it
);
6238 } while (it
->bidi_it
.charpos
!= limit
);
6239 IT_CHARPOS (*it
) = limit
;
6240 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6242 *bidi_it_prev
= bprev
;
6244 *skipped_p
= newline_found_p
= true;
6248 while (get_next_display_element (it
)
6249 && !newline_found_p
)
6251 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6252 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6253 *bidi_it_prev
= it
->bidi_it
;
6254 set_iterator_to_next (it
, 0);
6259 it
->selective
= old_selective
;
6260 return newline_found_p
;
6264 /* Set IT's current position to the previous visible line start. Skip
6265 invisible text that is so either due to text properties or due to
6266 selective display. Caution: this does not change IT->current_x and
6270 back_to_previous_visible_line_start (struct it
*it
)
6272 while (IT_CHARPOS (*it
) > BEGV
)
6274 back_to_previous_line_start (it
);
6276 if (IT_CHARPOS (*it
) <= BEGV
)
6279 /* If selective > 0, then lines indented more than its value are
6281 if (it
->selective
> 0
6282 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6286 /* Check the newline before point for invisibility. */
6289 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6290 Qinvisible
, it
->window
);
6291 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6295 if (IT_CHARPOS (*it
) <= BEGV
)
6300 void *it2data
= NULL
;
6303 Lisp_Object val
, overlay
;
6305 SAVE_IT (it2
, *it
, it2data
);
6307 /* If newline is part of a composition, continue from start of composition */
6308 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6309 && beg
< IT_CHARPOS (*it
))
6312 /* If newline is replaced by a display property, find start of overlay
6313 or interval and continue search from that point. */
6314 pos
= --IT_CHARPOS (it2
);
6317 bidi_unshelve_cache (NULL
, 0);
6318 it2
.string_from_display_prop_p
= 0;
6319 it2
.from_disp_prop_p
= 0;
6320 if (handle_display_prop (&it2
) == HANDLED_RETURN
6321 && !NILP (val
= get_char_property_and_overlay
6322 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6323 && (OVERLAYP (overlay
)
6324 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6325 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6327 RESTORE_IT (it
, it
, it2data
);
6331 /* Newline is not replaced by anything -- so we are done. */
6332 RESTORE_IT (it
, it
, it2data
);
6338 IT_CHARPOS (*it
) = beg
;
6339 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6343 it
->continuation_lines_width
= 0;
6345 eassert (IT_CHARPOS (*it
) >= BEGV
);
6346 eassert (IT_CHARPOS (*it
) == BEGV
6347 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6352 /* Reseat iterator IT at the previous visible line start. Skip
6353 invisible text that is so either due to text properties or due to
6354 selective display. At the end, update IT's overlay information,
6355 face information etc. */
6358 reseat_at_previous_visible_line_start (struct it
*it
)
6360 back_to_previous_visible_line_start (it
);
6361 reseat (it
, it
->current
.pos
, 1);
6366 /* Reseat iterator IT on the next visible line start in the current
6367 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6368 preceding the line start. Skip over invisible text that is so
6369 because of selective display. Compute faces, overlays etc at the
6370 new position. Note that this function does not skip over text that
6371 is invisible because of text properties. */
6374 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6376 int newline_found_p
, skipped_p
= 0;
6377 struct bidi_it bidi_it_prev
;
6379 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6381 /* Skip over lines that are invisible because they are indented
6382 more than the value of IT->selective. */
6383 if (it
->selective
> 0)
6384 while (IT_CHARPOS (*it
) < ZV
6385 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6388 eassert (IT_BYTEPOS (*it
) == BEGV
6389 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6391 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6394 /* Position on the newline if that's what's requested. */
6395 if (on_newline_p
&& newline_found_p
)
6397 if (STRINGP (it
->string
))
6399 if (IT_STRING_CHARPOS (*it
) > 0)
6403 --IT_STRING_CHARPOS (*it
);
6404 --IT_STRING_BYTEPOS (*it
);
6408 /* We need to restore the bidi iterator to the state
6409 it had on the newline, and resync the IT's
6410 position with that. */
6411 it
->bidi_it
= bidi_it_prev
;
6412 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6413 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6417 else if (IT_CHARPOS (*it
) > BEGV
)
6426 /* We need to restore the bidi iterator to the state it
6427 had on the newline and resync IT with that. */
6428 it
->bidi_it
= bidi_it_prev
;
6429 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6430 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6432 reseat (it
, it
->current
.pos
, 0);
6436 reseat (it
, it
->current
.pos
, 0);
6443 /***********************************************************************
6444 Changing an iterator's position
6445 ***********************************************************************/
6447 /* Change IT's current position to POS in current_buffer. If FORCE_P
6448 is non-zero, always check for text properties at the new position.
6449 Otherwise, text properties are only looked up if POS >=
6450 IT->check_charpos of a property. */
6453 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6455 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6457 reseat_1 (it
, pos
, 0);
6459 /* Determine where to check text properties. Avoid doing it
6460 where possible because text property lookup is very expensive. */
6462 || CHARPOS (pos
) > it
->stop_charpos
6463 || CHARPOS (pos
) < original_pos
)
6467 /* For bidi iteration, we need to prime prev_stop and
6468 base_level_stop with our best estimations. */
6469 /* Implementation note: Of course, POS is not necessarily a
6470 stop position, so assigning prev_pos to it is a lie; we
6471 should have called compute_stop_backwards. However, if
6472 the current buffer does not include any R2L characters,
6473 that call would be a waste of cycles, because the
6474 iterator will never move back, and thus never cross this
6475 "fake" stop position. So we delay that backward search
6476 until the time we really need it, in next_element_from_buffer. */
6477 if (CHARPOS (pos
) != it
->prev_stop
)
6478 it
->prev_stop
= CHARPOS (pos
);
6479 if (CHARPOS (pos
) < it
->base_level_stop
)
6480 it
->base_level_stop
= 0; /* meaning it's unknown */
6486 it
->prev_stop
= it
->base_level_stop
= 0;
6495 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6496 IT->stop_pos to POS, also. */
6499 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6501 /* Don't call this function when scanning a C string. */
6502 eassert (it
->s
== NULL
);
6504 /* POS must be a reasonable value. */
6505 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6507 it
->current
.pos
= it
->position
= pos
;
6508 it
->end_charpos
= ZV
;
6510 it
->current
.dpvec_index
= -1;
6511 it
->current
.overlay_string_index
= -1;
6512 IT_STRING_CHARPOS (*it
) = -1;
6513 IT_STRING_BYTEPOS (*it
) = -1;
6515 it
->method
= GET_FROM_BUFFER
;
6516 it
->object
= it
->w
->contents
;
6517 it
->area
= TEXT_AREA
;
6518 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6520 it
->string_from_display_prop_p
= 0;
6521 it
->string_from_prefix_prop_p
= 0;
6523 it
->from_disp_prop_p
= 0;
6524 it
->face_before_selective_p
= 0;
6527 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6529 bidi_unshelve_cache (NULL
, 0);
6530 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6531 it
->bidi_it
.string
.s
= NULL
;
6532 it
->bidi_it
.string
.lstring
= Qnil
;
6533 it
->bidi_it
.string
.bufpos
= 0;
6534 it
->bidi_it
.string
.from_disp_str
= 0;
6535 it
->bidi_it
.string
.unibyte
= 0;
6536 it
->bidi_it
.w
= it
->w
;
6541 it
->stop_charpos
= CHARPOS (pos
);
6542 it
->base_level_stop
= CHARPOS (pos
);
6544 /* This make the information stored in it->cmp_it invalidate. */
6549 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6550 If S is non-null, it is a C string to iterate over. Otherwise,
6551 STRING gives a Lisp string to iterate over.
6553 If PRECISION > 0, don't return more then PRECISION number of
6554 characters from the string.
6556 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6557 characters have been returned. FIELD_WIDTH < 0 means an infinite
6560 MULTIBYTE = 0 means disable processing of multibyte characters,
6561 MULTIBYTE > 0 means enable it,
6562 MULTIBYTE < 0 means use IT->multibyte_p.
6564 IT must be initialized via a prior call to init_iterator before
6565 calling this function. */
6568 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6569 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6572 /* No text property checks performed by default, but see below. */
6573 it
->stop_charpos
= -1;
6575 /* Set iterator position and end position. */
6576 memset (&it
->current
, 0, sizeof it
->current
);
6577 it
->current
.overlay_string_index
= -1;
6578 it
->current
.dpvec_index
= -1;
6579 eassert (charpos
>= 0);
6581 /* If STRING is specified, use its multibyteness, otherwise use the
6582 setting of MULTIBYTE, if specified. */
6584 it
->multibyte_p
= multibyte
> 0;
6586 /* Bidirectional reordering of strings is controlled by the default
6587 value of bidi-display-reordering. Don't try to reorder while
6588 loading loadup.el, as the necessary character property tables are
6589 not yet available. */
6592 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6596 eassert (STRINGP (string
));
6597 it
->string
= string
;
6599 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6600 it
->method
= GET_FROM_STRING
;
6601 it
->current
.string_pos
= string_pos (charpos
, string
);
6605 it
->bidi_it
.string
.lstring
= string
;
6606 it
->bidi_it
.string
.s
= NULL
;
6607 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6608 it
->bidi_it
.string
.bufpos
= 0;
6609 it
->bidi_it
.string
.from_disp_str
= 0;
6610 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6611 it
->bidi_it
.w
= it
->w
;
6612 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6613 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6618 it
->s
= (const unsigned char *) s
;
6621 /* Note that we use IT->current.pos, not it->current.string_pos,
6622 for displaying C strings. */
6623 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6624 if (it
->multibyte_p
)
6626 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6627 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6631 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6632 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6637 it
->bidi_it
.string
.lstring
= Qnil
;
6638 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6639 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6640 it
->bidi_it
.string
.bufpos
= 0;
6641 it
->bidi_it
.string
.from_disp_str
= 0;
6642 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6643 it
->bidi_it
.w
= it
->w
;
6644 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6647 it
->method
= GET_FROM_C_STRING
;
6650 /* PRECISION > 0 means don't return more than PRECISION characters
6652 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6654 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6656 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6659 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6660 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6661 FIELD_WIDTH < 0 means infinite field width. This is useful for
6662 padding with `-' at the end of a mode line. */
6663 if (field_width
< 0)
6664 field_width
= INFINITY
;
6665 /* Implementation note: We deliberately don't enlarge
6666 it->bidi_it.string.schars here to fit it->end_charpos, because
6667 the bidi iterator cannot produce characters out of thin air. */
6668 if (field_width
> it
->end_charpos
- charpos
)
6669 it
->end_charpos
= charpos
+ field_width
;
6671 /* Use the standard display table for displaying strings. */
6672 if (DISP_TABLE_P (Vstandard_display_table
))
6673 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6675 it
->stop_charpos
= charpos
;
6676 it
->prev_stop
= charpos
;
6677 it
->base_level_stop
= 0;
6680 it
->bidi_it
.first_elt
= 1;
6681 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6682 it
->bidi_it
.disp_pos
= -1;
6684 if (s
== NULL
&& it
->multibyte_p
)
6686 ptrdiff_t endpos
= SCHARS (it
->string
);
6687 if (endpos
> it
->end_charpos
)
6688 endpos
= it
->end_charpos
;
6689 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6697 /***********************************************************************
6699 ***********************************************************************/
6701 /* Map enum it_method value to corresponding next_element_from_* function. */
6703 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6705 next_element_from_buffer
,
6706 next_element_from_display_vector
,
6707 next_element_from_string
,
6708 next_element_from_c_string
,
6709 next_element_from_image
,
6710 next_element_from_stretch
6713 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6716 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6717 (possibly with the following characters). */
6719 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6720 ((IT)->cmp_it.id >= 0 \
6721 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6722 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6723 END_CHARPOS, (IT)->w, \
6724 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6728 /* Lookup the char-table Vglyphless_char_display for character C (-1
6729 if we want information for no-font case), and return the display
6730 method symbol. By side-effect, update it->what and
6731 it->glyphless_method. This function is called from
6732 get_next_display_element for each character element, and from
6733 x_produce_glyphs when no suitable font was found. */
6736 lookup_glyphless_char_display (int c
, struct it
*it
)
6738 Lisp_Object glyphless_method
= Qnil
;
6740 if (CHAR_TABLE_P (Vglyphless_char_display
)
6741 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6745 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6746 if (CONSP (glyphless_method
))
6747 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6748 ? XCAR (glyphless_method
)
6749 : XCDR (glyphless_method
);
6752 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6756 if (NILP (glyphless_method
))
6759 /* The default is to display the character by a proper font. */
6761 /* The default for the no-font case is to display an empty box. */
6762 glyphless_method
= Qempty_box
;
6764 if (EQ (glyphless_method
, Qzero_width
))
6767 return glyphless_method
;
6768 /* This method can't be used for the no-font case. */
6769 glyphless_method
= Qempty_box
;
6771 if (EQ (glyphless_method
, Qthin_space
))
6772 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6773 else if (EQ (glyphless_method
, Qempty_box
))
6774 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6775 else if (EQ (glyphless_method
, Qhex_code
))
6776 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6777 else if (STRINGP (glyphless_method
))
6778 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6781 /* Invalid value. We use the default method. */
6782 glyphless_method
= Qnil
;
6785 it
->what
= IT_GLYPHLESS
;
6786 return glyphless_method
;
6789 /* Merge escape glyph face and cache the result. */
6791 static struct frame
*last_escape_glyph_frame
= NULL
;
6792 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6793 static int last_escape_glyph_merged_face_id
= 0;
6796 merge_escape_glyph_face (struct it
*it
)
6800 if (it
->f
== last_escape_glyph_frame
6801 && it
->face_id
== last_escape_glyph_face_id
)
6802 face_id
= last_escape_glyph_merged_face_id
;
6805 /* Merge the `escape-glyph' face into the current face. */
6806 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6807 last_escape_glyph_frame
= it
->f
;
6808 last_escape_glyph_face_id
= it
->face_id
;
6809 last_escape_glyph_merged_face_id
= face_id
;
6814 /* Likewise for glyphless glyph face. */
6816 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6817 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6818 static int last_glyphless_glyph_merged_face_id
= 0;
6821 merge_glyphless_glyph_face (struct it
*it
)
6825 if (it
->f
== last_glyphless_glyph_frame
6826 && it
->face_id
== last_glyphless_glyph_face_id
)
6827 face_id
= last_glyphless_glyph_merged_face_id
;
6830 /* Merge the `glyphless-char' face into the current face. */
6831 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6832 last_glyphless_glyph_frame
= it
->f
;
6833 last_glyphless_glyph_face_id
= it
->face_id
;
6834 last_glyphless_glyph_merged_face_id
= face_id
;
6839 /* Load IT's display element fields with information about the next
6840 display element from the current position of IT. Value is zero if
6841 end of buffer (or C string) is reached. */
6844 get_next_display_element (struct it
*it
)
6846 /* Non-zero means that we found a display element. Zero means that
6847 we hit the end of what we iterate over. Performance note: the
6848 function pointer `method' used here turns out to be faster than
6849 using a sequence of if-statements. */
6853 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6855 if (it
->what
== IT_CHARACTER
)
6857 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6858 and only if (a) the resolved directionality of that character
6860 /* FIXME: Do we need an exception for characters from display
6862 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6863 it
->c
= bidi_mirror_char (it
->c
);
6864 /* Map via display table or translate control characters.
6865 IT->c, IT->len etc. have been set to the next character by
6866 the function call above. If we have a display table, and it
6867 contains an entry for IT->c, translate it. Don't do this if
6868 IT->c itself comes from a display table, otherwise we could
6869 end up in an infinite recursion. (An alternative could be to
6870 count the recursion depth of this function and signal an
6871 error when a certain maximum depth is reached.) Is it worth
6873 if (success_p
&& it
->dpvec
== NULL
)
6876 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6877 int nonascii_space_p
= 0;
6878 int nonascii_hyphen_p
= 0;
6879 int c
= it
->c
; /* This is the character to display. */
6881 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6883 eassert (SINGLE_BYTE_CHAR_P (c
));
6884 if (unibyte_display_via_language_environment
)
6886 c
= DECODE_CHAR (unibyte
, c
);
6888 c
= BYTE8_TO_CHAR (it
->c
);
6891 c
= BYTE8_TO_CHAR (it
->c
);
6895 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6898 struct Lisp_Vector
*v
= XVECTOR (dv
);
6900 /* Return the first character from the display table
6901 entry, if not empty. If empty, don't display the
6902 current character. */
6905 it
->dpvec_char_len
= it
->len
;
6906 it
->dpvec
= v
->contents
;
6907 it
->dpend
= v
->contents
+ v
->header
.size
;
6908 it
->current
.dpvec_index
= 0;
6909 it
->dpvec_face_id
= -1;
6910 it
->saved_face_id
= it
->face_id
;
6911 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6916 set_iterator_to_next (it
, 0);
6921 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6923 if (it
->what
== IT_GLYPHLESS
)
6925 /* Don't display this character. */
6926 set_iterator_to_next (it
, 0);
6930 /* If `nobreak-char-display' is non-nil, we display
6931 non-ASCII spaces and hyphens specially. */
6932 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6935 nonascii_space_p
= true;
6936 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6937 nonascii_hyphen_p
= true;
6940 /* Translate control characters into `\003' or `^C' form.
6941 Control characters coming from a display table entry are
6942 currently not translated because we use IT->dpvec to hold
6943 the translation. This could easily be changed but I
6944 don't believe that it is worth doing.
6946 The characters handled by `nobreak-char-display' must be
6949 Non-printable characters and raw-byte characters are also
6950 translated to octal form. */
6951 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
6952 ? (it
->area
!= TEXT_AREA
6953 /* In mode line, treat \n, \t like other crl chars. */
6956 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6957 || (c
!= '\n' && c
!= '\t'))
6959 || nonascii_hyphen_p
6961 || ! CHAR_PRINTABLE_P (c
))))
6963 /* C is a control character, non-ASCII space/hyphen,
6964 raw-byte, or a non-printable character which must be
6965 displayed either as '\003' or as `^C' where the '\\'
6966 and '^' can be defined in the display table. Fill
6967 IT->ctl_chars with glyphs for what we have to
6968 display. Then, set IT->dpvec to these glyphs. */
6975 /* Handle control characters with ^. */
6977 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6981 g
= '^'; /* default glyph for Control */
6982 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6984 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6986 g
= GLYPH_CODE_CHAR (gc
);
6987 lface_id
= GLYPH_CODE_FACE (gc
);
6991 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
6992 : merge_escape_glyph_face (it
));
6994 XSETINT (it
->ctl_chars
[0], g
);
6995 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6997 goto display_control
;
7000 /* Handle non-ascii space in the mode where it only gets
7003 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7005 /* Merge `nobreak-space' into the current face. */
7006 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7008 XSETINT (it
->ctl_chars
[0], ' ');
7010 goto display_control
;
7013 /* Handle sequences that start with the "escape glyph". */
7015 /* the default escape glyph is \. */
7016 escape_glyph
= '\\';
7019 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7021 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7022 lface_id
= GLYPH_CODE_FACE (gc
);
7026 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7027 : merge_escape_glyph_face (it
));
7029 /* Draw non-ASCII hyphen with just highlighting: */
7031 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7033 XSETINT (it
->ctl_chars
[0], '-');
7035 goto display_control
;
7038 /* Draw non-ASCII space/hyphen with escape glyph: */
7040 if (nonascii_space_p
|| nonascii_hyphen_p
)
7042 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7043 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7045 goto display_control
;
7052 if (CHAR_BYTE8_P (c
))
7053 /* Display \200 instead of \17777600. */
7054 c
= CHAR_TO_BYTE8 (c
);
7055 len
= sprintf (str
, "%03o", c
);
7057 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7058 for (i
= 0; i
< len
; i
++)
7059 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7064 /* Set up IT->dpvec and return first character from it. */
7065 it
->dpvec_char_len
= it
->len
;
7066 it
->dpvec
= it
->ctl_chars
;
7067 it
->dpend
= it
->dpvec
+ ctl_len
;
7068 it
->current
.dpvec_index
= 0;
7069 it
->dpvec_face_id
= face_id
;
7070 it
->saved_face_id
= it
->face_id
;
7071 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7075 it
->char_to_display
= c
;
7079 it
->char_to_display
= it
->c
;
7083 #ifdef HAVE_WINDOW_SYSTEM
7084 /* Adjust face id for a multibyte character. There are no multibyte
7085 character in unibyte text. */
7086 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7089 && FRAME_WINDOW_P (it
->f
))
7091 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7093 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7095 /* Automatic composition with glyph-string. */
7096 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7098 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7102 ptrdiff_t pos
= (it
->s
? -1
7103 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7104 : IT_CHARPOS (*it
));
7107 if (it
->what
== IT_CHARACTER
)
7108 c
= it
->char_to_display
;
7111 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7115 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7116 /* TAB in a composition means display glyphs with
7117 padding space on the left or right. */
7118 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7121 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7124 #endif /* HAVE_WINDOW_SYSTEM */
7127 /* Is this character the last one of a run of characters with
7128 box? If yes, set IT->end_of_box_run_p to 1. */
7132 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7134 int face_id
= underlying_face_id (it
);
7135 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7139 if (face
->box
== FACE_NO_BOX
)
7141 /* If the box comes from face properties in a
7142 display string, check faces in that string. */
7143 int string_face_id
= face_after_it_pos (it
);
7144 it
->end_of_box_run_p
7145 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7148 /* Otherwise, the box comes from the underlying face.
7149 If this is the last string character displayed, check
7150 the next buffer location. */
7151 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7152 /* n_overlay_strings is unreliable unless
7153 overlay_string_index is non-negative. */
7154 && ((it
->current
.overlay_string_index
>= 0
7155 && (it
->current
.overlay_string_index
7156 == it
->n_overlay_strings
- 1))
7157 /* A string from display property. */
7158 || it
->from_disp_prop_p
))
7162 struct text_pos pos
= it
->current
.pos
;
7164 /* For a string from a display property, the next
7165 buffer position is stored in the 'position'
7166 member of the iteration stack slot below the
7167 current one, see handle_single_display_spec. By
7168 contrast, it->current.pos was is not yet updated
7169 to point to that buffer position; that will
7170 happen in pop_it, after we finish displaying the
7171 current string. Note that we already checked
7172 above that it->sp is positive, so subtracting one
7174 if (it
->from_disp_prop_p
)
7175 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7177 INC_TEXT_POS (pos
, it
->multibyte_p
);
7179 if (CHARPOS (pos
) >= ZV
)
7180 it
->end_of_box_run_p
= true;
7183 next_face_id
= face_at_buffer_position
7184 (it
->w
, CHARPOS (pos
), &ignore
,
7185 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, 0, -1);
7186 it
->end_of_box_run_p
7187 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7193 /* next_element_from_display_vector sets this flag according to
7194 faces of the display vector glyphs, see there. */
7195 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7197 int face_id
= face_after_it_pos (it
);
7198 it
->end_of_box_run_p
7199 = (face_id
!= it
->face_id
7200 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7203 /* If we reached the end of the object we've been iterating (e.g., a
7204 display string or an overlay string), and there's something on
7205 IT->stack, proceed with what's on the stack. It doesn't make
7206 sense to return zero if there's unprocessed stuff on the stack,
7207 because otherwise that stuff will never be displayed. */
7208 if (!success_p
&& it
->sp
> 0)
7210 set_iterator_to_next (it
, 0);
7211 success_p
= get_next_display_element (it
);
7214 /* Value is 0 if end of buffer or string reached. */
7219 /* Move IT to the next display element.
7221 RESEAT_P non-zero means if called on a newline in buffer text,
7222 skip to the next visible line start.
7224 Functions get_next_display_element and set_iterator_to_next are
7225 separate because I find this arrangement easier to handle than a
7226 get_next_display_element function that also increments IT's
7227 position. The way it is we can first look at an iterator's current
7228 display element, decide whether it fits on a line, and if it does,
7229 increment the iterator position. The other way around we probably
7230 would either need a flag indicating whether the iterator has to be
7231 incremented the next time, or we would have to implement a
7232 decrement position function which would not be easy to write. */
7235 set_iterator_to_next (struct it
*it
, int reseat_p
)
7237 /* Reset flags indicating start and end of a sequence of characters
7238 with box. Reset them at the start of this function because
7239 moving the iterator to a new position might set them. */
7240 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
7244 case GET_FROM_BUFFER
:
7245 /* The current display element of IT is a character from
7246 current_buffer. Advance in the buffer, and maybe skip over
7247 invisible lines that are so because of selective display. */
7248 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7249 reseat_at_next_visible_line_start (it
, 0);
7250 else if (it
->cmp_it
.id
>= 0)
7252 /* We are currently getting glyphs from a composition. */
7257 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7258 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7259 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7261 it
->cmp_it
.from
= it
->cmp_it
.to
;
7266 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7268 it
->end_charpos
, Qnil
);
7271 else if (! it
->cmp_it
.reversed_p
)
7273 /* Composition created while scanning forward. */
7274 /* Update IT's char/byte positions to point to the first
7275 character of the next grapheme cluster, or to the
7276 character visually after the current composition. */
7277 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7278 bidi_move_to_visually_next (&it
->bidi_it
);
7279 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7280 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7282 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7284 /* Proceed to the next grapheme cluster. */
7285 it
->cmp_it
.from
= it
->cmp_it
.to
;
7289 /* No more grapheme clusters in this composition.
7290 Find the next stop position. */
7291 ptrdiff_t stop
= it
->end_charpos
;
7292 if (it
->bidi_it
.scan_dir
< 0)
7293 /* Now we are scanning backward and don't know
7296 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7297 IT_BYTEPOS (*it
), stop
, Qnil
);
7302 /* Composition created while scanning backward. */
7303 /* Update IT's char/byte positions to point to the last
7304 character of the previous grapheme cluster, or the
7305 character visually after the current composition. */
7306 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7307 bidi_move_to_visually_next (&it
->bidi_it
);
7308 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7309 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7310 if (it
->cmp_it
.from
> 0)
7312 /* Proceed to the previous grapheme cluster. */
7313 it
->cmp_it
.to
= it
->cmp_it
.from
;
7317 /* No more grapheme clusters in this composition.
7318 Find the next stop position. */
7319 ptrdiff_t stop
= it
->end_charpos
;
7320 if (it
->bidi_it
.scan_dir
< 0)
7321 /* Now we are scanning backward and don't know
7324 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7325 IT_BYTEPOS (*it
), stop
, Qnil
);
7331 eassert (it
->len
!= 0);
7335 IT_BYTEPOS (*it
) += it
->len
;
7336 IT_CHARPOS (*it
) += 1;
7340 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7341 /* If this is a new paragraph, determine its base
7342 direction (a.k.a. its base embedding level). */
7343 if (it
->bidi_it
.new_paragraph
)
7344 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7345 bidi_move_to_visually_next (&it
->bidi_it
);
7346 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7347 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7348 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7350 /* As the scan direction was changed, we must
7351 re-compute the stop position for composition. */
7352 ptrdiff_t stop
= it
->end_charpos
;
7353 if (it
->bidi_it
.scan_dir
< 0)
7355 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7356 IT_BYTEPOS (*it
), stop
, Qnil
);
7359 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7363 case GET_FROM_C_STRING
:
7364 /* Current display element of IT is from a C string. */
7366 /* If the string position is beyond string's end, it means
7367 next_element_from_c_string is padding the string with
7368 blanks, in which case we bypass the bidi iterator,
7369 because it cannot deal with such virtual characters. */
7370 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7372 IT_BYTEPOS (*it
) += it
->len
;
7373 IT_CHARPOS (*it
) += 1;
7377 bidi_move_to_visually_next (&it
->bidi_it
);
7378 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7379 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7383 case GET_FROM_DISPLAY_VECTOR
:
7384 /* Current display element of IT is from a display table entry.
7385 Advance in the display table definition. Reset it to null if
7386 end reached, and continue with characters from buffers/
7388 ++it
->current
.dpvec_index
;
7390 /* Restore face of the iterator to what they were before the
7391 display vector entry (these entries may contain faces). */
7392 it
->face_id
= it
->saved_face_id
;
7394 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7396 int recheck_faces
= it
->ellipsis_p
;
7399 it
->method
= GET_FROM_C_STRING
;
7400 else if (STRINGP (it
->string
))
7401 it
->method
= GET_FROM_STRING
;
7404 it
->method
= GET_FROM_BUFFER
;
7405 it
->object
= it
->w
->contents
;
7409 it
->current
.dpvec_index
= -1;
7411 /* Skip over characters which were displayed via IT->dpvec. */
7412 if (it
->dpvec_char_len
< 0)
7413 reseat_at_next_visible_line_start (it
, 1);
7414 else if (it
->dpvec_char_len
> 0)
7416 if (it
->method
== GET_FROM_STRING
7417 && it
->current
.overlay_string_index
>= 0
7418 && it
->n_overlay_strings
> 0)
7419 it
->ignore_overlay_strings_at_pos_p
= true;
7420 it
->len
= it
->dpvec_char_len
;
7421 set_iterator_to_next (it
, reseat_p
);
7424 /* Maybe recheck faces after display vector. */
7426 it
->stop_charpos
= IT_CHARPOS (*it
);
7430 case GET_FROM_STRING
:
7431 /* Current display element is a character from a Lisp string. */
7432 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7433 /* Don't advance past string end. These conditions are true
7434 when set_iterator_to_next is called at the end of
7435 get_next_display_element, in which case the Lisp string is
7436 already exhausted, and all we want is pop the iterator
7438 if (it
->current
.overlay_string_index
>= 0)
7440 /* This is an overlay string, so there's no padding with
7441 spaces, and the number of characters in the string is
7442 where the string ends. */
7443 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7444 goto consider_string_end
;
7448 /* Not an overlay string. There could be padding, so test
7449 against it->end_charpos. */
7450 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7451 goto consider_string_end
;
7453 if (it
->cmp_it
.id
>= 0)
7459 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7460 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7461 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7462 it
->cmp_it
.from
= it
->cmp_it
.to
;
7466 composition_compute_stop_pos (&it
->cmp_it
,
7467 IT_STRING_CHARPOS (*it
),
7468 IT_STRING_BYTEPOS (*it
),
7469 it
->end_charpos
, it
->string
);
7472 else if (! it
->cmp_it
.reversed_p
)
7474 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7475 bidi_move_to_visually_next (&it
->bidi_it
);
7476 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7477 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7479 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7480 it
->cmp_it
.from
= it
->cmp_it
.to
;
7483 ptrdiff_t stop
= it
->end_charpos
;
7484 if (it
->bidi_it
.scan_dir
< 0)
7486 composition_compute_stop_pos (&it
->cmp_it
,
7487 IT_STRING_CHARPOS (*it
),
7488 IT_STRING_BYTEPOS (*it
), stop
,
7494 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7495 bidi_move_to_visually_next (&it
->bidi_it
);
7496 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7497 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7498 if (it
->cmp_it
.from
> 0)
7499 it
->cmp_it
.to
= it
->cmp_it
.from
;
7502 ptrdiff_t stop
= it
->end_charpos
;
7503 if (it
->bidi_it
.scan_dir
< 0)
7505 composition_compute_stop_pos (&it
->cmp_it
,
7506 IT_STRING_CHARPOS (*it
),
7507 IT_STRING_BYTEPOS (*it
), stop
,
7515 /* If the string position is beyond string's end, it
7516 means next_element_from_string is padding the string
7517 with blanks, in which case we bypass the bidi
7518 iterator, because it cannot deal with such virtual
7520 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7522 IT_STRING_BYTEPOS (*it
) += it
->len
;
7523 IT_STRING_CHARPOS (*it
) += 1;
7527 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7529 bidi_move_to_visually_next (&it
->bidi_it
);
7530 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7531 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7532 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7534 ptrdiff_t stop
= it
->end_charpos
;
7536 if (it
->bidi_it
.scan_dir
< 0)
7538 composition_compute_stop_pos (&it
->cmp_it
,
7539 IT_STRING_CHARPOS (*it
),
7540 IT_STRING_BYTEPOS (*it
), stop
,
7546 consider_string_end
:
7548 if (it
->current
.overlay_string_index
>= 0)
7550 /* IT->string is an overlay string. Advance to the
7551 next, if there is one. */
7552 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7555 next_overlay_string (it
);
7557 setup_for_ellipsis (it
, 0);
7562 /* IT->string is not an overlay string. If we reached
7563 its end, and there is something on IT->stack, proceed
7564 with what is on the stack. This can be either another
7565 string, this time an overlay string, or a buffer. */
7566 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7570 if (it
->method
== GET_FROM_STRING
)
7571 goto consider_string_end
;
7576 case GET_FROM_IMAGE
:
7577 case GET_FROM_STRETCH
:
7578 /* The position etc with which we have to proceed are on
7579 the stack. The position may be at the end of a string,
7580 if the `display' property takes up the whole string. */
7581 eassert (it
->sp
> 0);
7583 if (it
->method
== GET_FROM_STRING
)
7584 goto consider_string_end
;
7588 /* There are no other methods defined, so this should be a bug. */
7592 eassert (it
->method
!= GET_FROM_STRING
7593 || (STRINGP (it
->string
)
7594 && IT_STRING_CHARPOS (*it
) >= 0));
7597 /* Load IT's display element fields with information about the next
7598 display element which comes from a display table entry or from the
7599 result of translating a control character to one of the forms `^C'
7602 IT->dpvec holds the glyphs to return as characters.
7603 IT->saved_face_id holds the face id before the display vector--it
7604 is restored into IT->face_id in set_iterator_to_next. */
7607 next_element_from_display_vector (struct it
*it
)
7610 int prev_face_id
= it
->face_id
;
7614 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7616 it
->face_id
= it
->saved_face_id
;
7618 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7619 That seemed totally bogus - so I changed it... */
7620 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7622 if (GLYPH_CODE_P (gc
))
7624 struct face
*this_face
, *prev_face
, *next_face
;
7626 it
->c
= GLYPH_CODE_CHAR (gc
);
7627 it
->len
= CHAR_BYTES (it
->c
);
7629 /* The entry may contain a face id to use. Such a face id is
7630 the id of a Lisp face, not a realized face. A face id of
7631 zero means no face is specified. */
7632 if (it
->dpvec_face_id
>= 0)
7633 it
->face_id
= it
->dpvec_face_id
;
7636 int lface_id
= GLYPH_CODE_FACE (gc
);
7638 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7642 /* Glyphs in the display vector could have the box face, so we
7643 need to set the related flags in the iterator, as
7645 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7646 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7648 /* Is this character the first character of a box-face run? */
7649 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7651 || prev_face
->box
== FACE_NO_BOX
));
7653 /* For the last character of the box-face run, we need to look
7654 either at the next glyph from the display vector, or at the
7655 face we saw before the display vector. */
7656 next_face_id
= it
->saved_face_id
;
7657 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7659 if (it
->dpvec_face_id
>= 0)
7660 next_face_id
= it
->dpvec_face_id
;
7664 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7667 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7671 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7672 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7674 || next_face
->box
== FACE_NO_BOX
));
7675 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7678 /* Display table entry is invalid. Return a space. */
7679 it
->c
= ' ', it
->len
= 1;
7681 /* Don't change position and object of the iterator here. They are
7682 still the values of the character that had this display table
7683 entry or was translated, and that's what we want. */
7684 it
->what
= IT_CHARACTER
;
7688 /* Get the first element of string/buffer in the visual order, after
7689 being reseated to a new position in a string or a buffer. */
7691 get_visually_first_element (struct it
*it
)
7693 int string_p
= STRINGP (it
->string
) || it
->s
;
7694 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7695 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7697 if (STRINGP (it
->string
))
7699 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7700 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7704 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7705 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7708 if (it
->bidi_it
.charpos
== eob
)
7710 /* Nothing to do, but reset the FIRST_ELT flag, like
7711 bidi_paragraph_init does, because we are not going to
7713 it
->bidi_it
.first_elt
= 0;
7715 else if (it
->bidi_it
.charpos
== bob
7717 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7718 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7720 /* If we are at the beginning of a line/string, we can produce
7721 the next element right away. */
7722 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7723 bidi_move_to_visually_next (&it
->bidi_it
);
7727 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7729 /* We need to prime the bidi iterator starting at the line's or
7730 string's beginning, before we will be able to produce the
7733 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7735 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7736 IT_BYTEPOS (*it
), -1,
7737 &it
->bidi_it
.bytepos
);
7738 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7741 /* Now return to buffer/string position where we were asked
7742 to get the next display element, and produce that. */
7743 bidi_move_to_visually_next (&it
->bidi_it
);
7745 while (it
->bidi_it
.bytepos
!= orig_bytepos
7746 && it
->bidi_it
.charpos
< eob
);
7749 /* Adjust IT's position information to where we ended up. */
7750 if (STRINGP (it
->string
))
7752 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7753 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7757 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7758 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7761 if (STRINGP (it
->string
) || !it
->s
)
7763 ptrdiff_t stop
, charpos
, bytepos
;
7765 if (STRINGP (it
->string
))
7768 stop
= SCHARS (it
->string
);
7769 if (stop
> it
->end_charpos
)
7770 stop
= it
->end_charpos
;
7771 charpos
= IT_STRING_CHARPOS (*it
);
7772 bytepos
= IT_STRING_BYTEPOS (*it
);
7776 stop
= it
->end_charpos
;
7777 charpos
= IT_CHARPOS (*it
);
7778 bytepos
= IT_BYTEPOS (*it
);
7780 if (it
->bidi_it
.scan_dir
< 0)
7782 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7787 /* Load IT with the next display element from Lisp string IT->string.
7788 IT->current.string_pos is the current position within the string.
7789 If IT->current.overlay_string_index >= 0, the Lisp string is an
7793 next_element_from_string (struct it
*it
)
7795 struct text_pos position
;
7797 eassert (STRINGP (it
->string
));
7798 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7799 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7800 position
= it
->current
.string_pos
;
7802 /* With bidi reordering, the character to display might not be the
7803 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7804 that we were reseat()ed to a new string, whose paragraph
7805 direction is not known. */
7806 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7808 get_visually_first_element (it
);
7809 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7812 /* Time to check for invisible text? */
7813 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7815 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7818 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7819 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7821 /* With bidi non-linear iteration, we could find
7822 ourselves far beyond the last computed stop_charpos,
7823 with several other stop positions in between that we
7824 missed. Scan them all now, in buffer's logical
7825 order, until we find and handle the last stop_charpos
7826 that precedes our current position. */
7827 handle_stop_backwards (it
, it
->stop_charpos
);
7828 return GET_NEXT_DISPLAY_ELEMENT (it
);
7834 /* Take note of the stop position we just moved
7835 across, for when we will move back across it. */
7836 it
->prev_stop
= it
->stop_charpos
;
7837 /* If we are at base paragraph embedding level, take
7838 note of the last stop position seen at this
7840 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7841 it
->base_level_stop
= it
->stop_charpos
;
7845 /* Since a handler may have changed IT->method, we must
7847 return GET_NEXT_DISPLAY_ELEMENT (it
);
7851 /* If we are before prev_stop, we may have overstepped
7852 on our way backwards a stop_pos, and if so, we need
7853 to handle that stop_pos. */
7854 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7855 /* We can sometimes back up for reasons that have nothing
7856 to do with bidi reordering. E.g., compositions. The
7857 code below is only needed when we are above the base
7858 embedding level, so test for that explicitly. */
7859 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7861 /* If we lost track of base_level_stop, we have no better
7862 place for handle_stop_backwards to start from than string
7863 beginning. This happens, e.g., when we were reseated to
7864 the previous screenful of text by vertical-motion. */
7865 if (it
->base_level_stop
<= 0
7866 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7867 it
->base_level_stop
= 0;
7868 handle_stop_backwards (it
, it
->base_level_stop
);
7869 return GET_NEXT_DISPLAY_ELEMENT (it
);
7873 if (it
->current
.overlay_string_index
>= 0)
7875 /* Get the next character from an overlay string. In overlay
7876 strings, there is no field width or padding with spaces to
7878 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7883 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7884 IT_STRING_BYTEPOS (*it
),
7885 it
->bidi_it
.scan_dir
< 0
7887 : SCHARS (it
->string
))
7888 && next_element_from_composition (it
))
7892 else if (STRING_MULTIBYTE (it
->string
))
7894 const unsigned char *s
= (SDATA (it
->string
)
7895 + IT_STRING_BYTEPOS (*it
));
7896 it
->c
= string_char_and_length (s
, &it
->len
);
7900 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7906 /* Get the next character from a Lisp string that is not an
7907 overlay string. Such strings come from the mode line, for
7908 example. We may have to pad with spaces, or truncate the
7909 string. See also next_element_from_c_string. */
7910 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7915 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7917 /* Pad with spaces. */
7918 it
->c
= ' ', it
->len
= 1;
7919 CHARPOS (position
) = BYTEPOS (position
) = -1;
7921 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7922 IT_STRING_BYTEPOS (*it
),
7923 it
->bidi_it
.scan_dir
< 0
7925 : it
->string_nchars
)
7926 && next_element_from_composition (it
))
7930 else if (STRING_MULTIBYTE (it
->string
))
7932 const unsigned char *s
= (SDATA (it
->string
)
7933 + IT_STRING_BYTEPOS (*it
));
7934 it
->c
= string_char_and_length (s
, &it
->len
);
7938 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7943 /* Record what we have and where it came from. */
7944 it
->what
= IT_CHARACTER
;
7945 it
->object
= it
->string
;
7946 it
->position
= position
;
7951 /* Load IT with next display element from C string IT->s.
7952 IT->string_nchars is the maximum number of characters to return
7953 from the string. IT->end_charpos may be greater than
7954 IT->string_nchars when this function is called, in which case we
7955 may have to return padding spaces. Value is zero if end of string
7956 reached, including padding spaces. */
7959 next_element_from_c_string (struct it
*it
)
7961 bool success_p
= true;
7964 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7965 it
->what
= IT_CHARACTER
;
7966 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7969 /* With bidi reordering, the character to display might not be the
7970 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7971 we were reseated to a new string, whose paragraph direction is
7973 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7974 get_visually_first_element (it
);
7976 /* IT's position can be greater than IT->string_nchars in case a
7977 field width or precision has been specified when the iterator was
7979 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7981 /* End of the game. */
7985 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7987 /* Pad with spaces. */
7988 it
->c
= ' ', it
->len
= 1;
7989 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7991 else if (it
->multibyte_p
)
7992 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7994 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
8000 /* Set up IT to return characters from an ellipsis, if appropriate.
8001 The definition of the ellipsis glyphs may come from a display table
8002 entry. This function fills IT with the first glyph from the
8003 ellipsis if an ellipsis is to be displayed. */
8006 next_element_from_ellipsis (struct it
*it
)
8008 if (it
->selective_display_ellipsis_p
)
8009 setup_for_ellipsis (it
, it
->len
);
8012 /* The face at the current position may be different from the
8013 face we find after the invisible text. Remember what it
8014 was in IT->saved_face_id, and signal that it's there by
8015 setting face_before_selective_p. */
8016 it
->saved_face_id
= it
->face_id
;
8017 it
->method
= GET_FROM_BUFFER
;
8018 it
->object
= it
->w
->contents
;
8019 reseat_at_next_visible_line_start (it
, 1);
8020 it
->face_before_selective_p
= true;
8023 return GET_NEXT_DISPLAY_ELEMENT (it
);
8027 /* Deliver an image display element. The iterator IT is already
8028 filled with image information (done in handle_display_prop). Value
8033 next_element_from_image (struct it
*it
)
8035 it
->what
= IT_IMAGE
;
8036 it
->ignore_overlay_strings_at_pos_p
= 0;
8041 /* Fill iterator IT with next display element from a stretch glyph
8042 property. IT->object is the value of the text property. Value is
8046 next_element_from_stretch (struct it
*it
)
8048 it
->what
= IT_STRETCH
;
8052 /* Scan backwards from IT's current position until we find a stop
8053 position, or until BEGV. This is called when we find ourself
8054 before both the last known prev_stop and base_level_stop while
8055 reordering bidirectional text. */
8058 compute_stop_pos_backwards (struct it
*it
)
8060 const int SCAN_BACK_LIMIT
= 1000;
8061 struct text_pos pos
;
8062 struct display_pos save_current
= it
->current
;
8063 struct text_pos save_position
= it
->position
;
8064 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8065 ptrdiff_t where_we_are
= charpos
;
8066 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8067 ptrdiff_t save_end_pos
= it
->end_charpos
;
8069 eassert (NILP (it
->string
) && !it
->s
);
8070 eassert (it
->bidi_p
);
8074 it
->end_charpos
= min (charpos
+ 1, ZV
);
8075 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8076 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8077 reseat_1 (it
, pos
, 0);
8078 compute_stop_pos (it
);
8079 /* We must advance forward, right? */
8080 if (it
->stop_charpos
<= charpos
)
8083 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8085 if (it
->stop_charpos
<= where_we_are
)
8086 it
->prev_stop
= it
->stop_charpos
;
8088 it
->prev_stop
= BEGV
;
8090 it
->current
= save_current
;
8091 it
->position
= save_position
;
8092 it
->stop_charpos
= save_stop_pos
;
8093 it
->end_charpos
= save_end_pos
;
8096 /* Scan forward from CHARPOS in the current buffer/string, until we
8097 find a stop position > current IT's position. Then handle the stop
8098 position before that. This is called when we bump into a stop
8099 position while reordering bidirectional text. CHARPOS should be
8100 the last previously processed stop_pos (or BEGV/0, if none were
8101 processed yet) whose position is less that IT's current
8105 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8107 int bufp
= !STRINGP (it
->string
);
8108 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8109 struct display_pos save_current
= it
->current
;
8110 struct text_pos save_position
= it
->position
;
8111 struct text_pos pos1
;
8112 ptrdiff_t next_stop
;
8114 /* Scan in strict logical order. */
8115 eassert (it
->bidi_p
);
8119 it
->prev_stop
= charpos
;
8122 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8123 reseat_1 (it
, pos1
, 0);
8126 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8127 compute_stop_pos (it
);
8128 /* We must advance forward, right? */
8129 if (it
->stop_charpos
<= it
->prev_stop
)
8131 charpos
= it
->stop_charpos
;
8133 while (charpos
<= where_we_are
);
8136 it
->current
= save_current
;
8137 it
->position
= save_position
;
8138 next_stop
= it
->stop_charpos
;
8139 it
->stop_charpos
= it
->prev_stop
;
8141 it
->stop_charpos
= next_stop
;
8144 /* Load IT with the next display element from current_buffer. Value
8145 is zero if end of buffer reached. IT->stop_charpos is the next
8146 position at which to stop and check for text properties or buffer
8150 next_element_from_buffer (struct it
*it
)
8152 bool success_p
= true;
8154 eassert (IT_CHARPOS (*it
) >= BEGV
);
8155 eassert (NILP (it
->string
) && !it
->s
);
8156 eassert (!it
->bidi_p
8157 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8158 && it
->bidi_it
.string
.s
== NULL
));
8160 /* With bidi reordering, the character to display might not be the
8161 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8162 we were reseat()ed to a new buffer position, which is potentially
8163 a different paragraph. */
8164 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8166 get_visually_first_element (it
);
8167 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8170 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8172 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8174 int overlay_strings_follow_p
;
8176 /* End of the game, except when overlay strings follow that
8177 haven't been returned yet. */
8178 if (it
->overlay_strings_at_end_processed_p
)
8179 overlay_strings_follow_p
= 0;
8182 it
->overlay_strings_at_end_processed_p
= true;
8183 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8186 if (overlay_strings_follow_p
)
8187 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8191 it
->position
= it
->current
.pos
;
8195 else if (!(!it
->bidi_p
8196 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8197 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8199 /* With bidi non-linear iteration, we could find ourselves
8200 far beyond the last computed stop_charpos, with several
8201 other stop positions in between that we missed. Scan
8202 them all now, in buffer's logical order, until we find
8203 and handle the last stop_charpos that precedes our
8204 current position. */
8205 handle_stop_backwards (it
, it
->stop_charpos
);
8206 return GET_NEXT_DISPLAY_ELEMENT (it
);
8212 /* Take note of the stop position we just moved across,
8213 for when we will move back across it. */
8214 it
->prev_stop
= it
->stop_charpos
;
8215 /* If we are at base paragraph embedding level, take
8216 note of the last stop position seen at this
8218 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8219 it
->base_level_stop
= it
->stop_charpos
;
8222 return GET_NEXT_DISPLAY_ELEMENT (it
);
8226 /* If we are before prev_stop, we may have overstepped on
8227 our way backwards a stop_pos, and if so, we need to
8228 handle that stop_pos. */
8229 && IT_CHARPOS (*it
) < it
->prev_stop
8230 /* We can sometimes back up for reasons that have nothing
8231 to do with bidi reordering. E.g., compositions. The
8232 code below is only needed when we are above the base
8233 embedding level, so test for that explicitly. */
8234 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8236 if (it
->base_level_stop
<= 0
8237 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8239 /* If we lost track of base_level_stop, we need to find
8240 prev_stop by looking backwards. This happens, e.g., when
8241 we were reseated to the previous screenful of text by
8243 it
->base_level_stop
= BEGV
;
8244 compute_stop_pos_backwards (it
);
8245 handle_stop_backwards (it
, it
->prev_stop
);
8248 handle_stop_backwards (it
, it
->base_level_stop
);
8249 return GET_NEXT_DISPLAY_ELEMENT (it
);
8253 /* No face changes, overlays etc. in sight, so just return a
8254 character from current_buffer. */
8258 /* Maybe run the redisplay end trigger hook. Performance note:
8259 This doesn't seem to cost measurable time. */
8260 if (it
->redisplay_end_trigger_charpos
8262 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8263 run_redisplay_end_trigger_hook (it
);
8265 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8266 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8268 && next_element_from_composition (it
))
8273 /* Get the next character, maybe multibyte. */
8274 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8275 if (it
->multibyte_p
&& !ASCII_CHAR_P (*p
))
8276 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8278 it
->c
= *p
, it
->len
= 1;
8280 /* Record what we have and where it came from. */
8281 it
->what
= IT_CHARACTER
;
8282 it
->object
= it
->w
->contents
;
8283 it
->position
= it
->current
.pos
;
8285 /* Normally we return the character found above, except when we
8286 really want to return an ellipsis for selective display. */
8291 /* A value of selective > 0 means hide lines indented more
8292 than that number of columns. */
8293 if (it
->selective
> 0
8294 && IT_CHARPOS (*it
) + 1 < ZV
8295 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8296 IT_BYTEPOS (*it
) + 1,
8299 success_p
= next_element_from_ellipsis (it
);
8300 it
->dpvec_char_len
= -1;
8303 else if (it
->c
== '\r' && it
->selective
== -1)
8305 /* A value of selective == -1 means that everything from the
8306 CR to the end of the line is invisible, with maybe an
8307 ellipsis displayed for it. */
8308 success_p
= next_element_from_ellipsis (it
);
8309 it
->dpvec_char_len
= -1;
8314 /* Value is zero if end of buffer reached. */
8315 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8320 /* Run the redisplay end trigger hook for IT. */
8323 run_redisplay_end_trigger_hook (struct it
*it
)
8325 Lisp_Object args
[3];
8327 /* IT->glyph_row should be non-null, i.e. we should be actually
8328 displaying something, or otherwise we should not run the hook. */
8329 eassert (it
->glyph_row
);
8331 /* Set up hook arguments. */
8332 args
[0] = Qredisplay_end_trigger_functions
;
8333 args
[1] = it
->window
;
8334 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8335 it
->redisplay_end_trigger_charpos
= 0;
8337 /* Since we are *trying* to run these functions, don't try to run
8338 them again, even if they get an error. */
8339 wset_redisplay_end_trigger (it
->w
, Qnil
);
8340 Frun_hook_with_args (3, args
);
8342 /* Notice if it changed the face of the character we are on. */
8343 handle_face_prop (it
);
8347 /* Deliver a composition display element. Unlike the other
8348 next_element_from_XXX, this function is not registered in the array
8349 get_next_element[]. It is called from next_element_from_buffer and
8350 next_element_from_string when necessary. */
8353 next_element_from_composition (struct it
*it
)
8355 it
->what
= IT_COMPOSITION
;
8356 it
->len
= it
->cmp_it
.nbytes
;
8357 if (STRINGP (it
->string
))
8361 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8362 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8365 it
->position
= it
->current
.string_pos
;
8366 it
->object
= it
->string
;
8367 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8368 IT_STRING_BYTEPOS (*it
), it
->string
);
8374 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8375 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8378 if (it
->bidi_it
.new_paragraph
)
8379 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8380 /* Resync the bidi iterator with IT's new position.
8381 FIXME: this doesn't support bidirectional text. */
8382 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8383 bidi_move_to_visually_next (&it
->bidi_it
);
8387 it
->position
= it
->current
.pos
;
8388 it
->object
= it
->w
->contents
;
8389 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8390 IT_BYTEPOS (*it
), Qnil
);
8397 /***********************************************************************
8398 Moving an iterator without producing glyphs
8399 ***********************************************************************/
8401 /* Check if iterator is at a position corresponding to a valid buffer
8402 position after some move_it_ call. */
8404 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8405 ((it)->method == GET_FROM_STRING \
8406 ? IT_STRING_CHARPOS (*it) == 0 \
8410 /* Move iterator IT to a specified buffer or X position within one
8411 line on the display without producing glyphs.
8413 OP should be a bit mask including some or all of these bits:
8414 MOVE_TO_X: Stop upon reaching x-position TO_X.
8415 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8416 Regardless of OP's value, stop upon reaching the end of the display line.
8418 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8419 This means, in particular, that TO_X includes window's horizontal
8422 The return value has several possible values that
8423 say what condition caused the scan to stop:
8425 MOVE_POS_MATCH_OR_ZV
8426 - when TO_POS or ZV was reached.
8429 -when TO_X was reached before TO_POS or ZV were reached.
8432 - when we reached the end of the display area and the line must
8436 - when we reached the end of the display area and the line is
8440 - when we stopped at a line end, i.e. a newline or a CR and selective
8443 static enum move_it_result
8444 move_it_in_display_line_to (struct it
*it
,
8445 ptrdiff_t to_charpos
, int to_x
,
8446 enum move_operation_enum op
)
8448 enum move_it_result result
= MOVE_UNDEFINED
;
8449 struct glyph_row
*saved_glyph_row
;
8450 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8451 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8452 void *ppos_data
= NULL
;
8454 enum it_method prev_method
= it
->method
;
8455 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8456 int saw_smaller_pos
= prev_pos
< to_charpos
;
8458 /* Don't produce glyphs in produce_glyphs. */
8459 saved_glyph_row
= it
->glyph_row
;
8460 it
->glyph_row
= NULL
;
8462 /* Use wrap_it to save a copy of IT wherever a word wrap could
8463 occur. Use atpos_it to save a copy of IT at the desired buffer
8464 position, if found, so that we can scan ahead and check if the
8465 word later overshoots the window edge. Use atx_it similarly, for
8471 /* Use ppos_it under bidi reordering to save a copy of IT for the
8472 initial position. We restore that position in IT when we have
8473 scanned the entire display line without finding a match for
8474 TO_CHARPOS and all the character positions are greater than
8475 TO_CHARPOS. We then restart the scan from the initial position,
8476 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8477 the closest to TO_CHARPOS. */
8480 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8482 SAVE_IT (ppos_it
, *it
, ppos_data
);
8483 closest_pos
= IT_CHARPOS (*it
);
8489 #define BUFFER_POS_REACHED_P() \
8490 ((op & MOVE_TO_POS) != 0 \
8491 && BUFFERP (it->object) \
8492 && (IT_CHARPOS (*it) == to_charpos \
8494 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8495 && IT_CHARPOS (*it) > to_charpos) \
8496 || (it->what == IT_COMPOSITION \
8497 && ((IT_CHARPOS (*it) > to_charpos \
8498 && to_charpos >= it->cmp_it.charpos) \
8499 || (IT_CHARPOS (*it) < to_charpos \
8500 && to_charpos <= it->cmp_it.charpos)))) \
8501 && (it->method == GET_FROM_BUFFER \
8502 || (it->method == GET_FROM_DISPLAY_VECTOR \
8503 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8505 /* If there's a line-/wrap-prefix, handle it. */
8506 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8507 && it
->current_y
< it
->last_visible_y
)
8508 handle_line_prefix (it
);
8510 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8511 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8515 int x
, i
, ascent
= 0, descent
= 0;
8517 /* Utility macro to reset an iterator with x, ascent, and descent. */
8518 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8519 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8520 (IT)->max_descent = descent)
8522 /* Stop if we move beyond TO_CHARPOS (after an image or a
8523 display string or stretch glyph). */
8524 if ((op
& MOVE_TO_POS
) != 0
8525 && BUFFERP (it
->object
)
8526 && it
->method
== GET_FROM_BUFFER
8528 /* When the iterator is at base embedding level, we
8529 are guaranteed that characters are delivered for
8530 display in strictly increasing order of their
8531 buffer positions. */
8532 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8533 && IT_CHARPOS (*it
) > to_charpos
)
8535 && (prev_method
== GET_FROM_IMAGE
8536 || prev_method
== GET_FROM_STRETCH
8537 || prev_method
== GET_FROM_STRING
)
8538 /* Passed TO_CHARPOS from left to right. */
8539 && ((prev_pos
< to_charpos
8540 && IT_CHARPOS (*it
) > to_charpos
)
8541 /* Passed TO_CHARPOS from right to left. */
8542 || (prev_pos
> to_charpos
8543 && IT_CHARPOS (*it
) < to_charpos
)))))
8545 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8547 result
= MOVE_POS_MATCH_OR_ZV
;
8550 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8551 /* If wrap_it is valid, the current position might be in a
8552 word that is wrapped. So, save the iterator in
8553 atpos_it and continue to see if wrapping happens. */
8554 SAVE_IT (atpos_it
, *it
, atpos_data
);
8557 /* Stop when ZV reached.
8558 We used to stop here when TO_CHARPOS reached as well, but that is
8559 too soon if this glyph does not fit on this line. So we handle it
8560 explicitly below. */
8561 if (!get_next_display_element (it
))
8563 result
= MOVE_POS_MATCH_OR_ZV
;
8567 if (it
->line_wrap
== TRUNCATE
)
8569 if (BUFFER_POS_REACHED_P ())
8571 result
= MOVE_POS_MATCH_OR_ZV
;
8577 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8579 if (IT_DISPLAYING_WHITESPACE (it
))
8583 /* We have reached a glyph that follows one or more
8584 whitespace characters. If the position is
8585 already found, we are done. */
8586 if (atpos_it
.sp
>= 0)
8588 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8589 result
= MOVE_POS_MATCH_OR_ZV
;
8594 RESTORE_IT (it
, &atx_it
, atx_data
);
8595 result
= MOVE_X_REACHED
;
8598 /* Otherwise, we can wrap here. */
8599 SAVE_IT (wrap_it
, *it
, wrap_data
);
8605 /* Remember the line height for the current line, in case
8606 the next element doesn't fit on the line. */
8607 ascent
= it
->max_ascent
;
8608 descent
= it
->max_descent
;
8610 /* The call to produce_glyphs will get the metrics of the
8611 display element IT is loaded with. Record the x-position
8612 before this display element, in case it doesn't fit on the
8616 PRODUCE_GLYPHS (it
);
8618 if (it
->area
!= TEXT_AREA
)
8620 prev_method
= it
->method
;
8621 if (it
->method
== GET_FROM_BUFFER
)
8622 prev_pos
= IT_CHARPOS (*it
);
8623 set_iterator_to_next (it
, 1);
8624 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8625 SET_TEXT_POS (this_line_min_pos
,
8626 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8628 && (op
& MOVE_TO_POS
)
8629 && IT_CHARPOS (*it
) > to_charpos
8630 && IT_CHARPOS (*it
) < closest_pos
)
8631 closest_pos
= IT_CHARPOS (*it
);
8635 /* The number of glyphs we get back in IT->nglyphs will normally
8636 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8637 character on a terminal frame, or (iii) a line end. For the
8638 second case, IT->nglyphs - 1 padding glyphs will be present.
8639 (On X frames, there is only one glyph produced for a
8640 composite character.)
8642 The behavior implemented below means, for continuation lines,
8643 that as many spaces of a TAB as fit on the current line are
8644 displayed there. For terminal frames, as many glyphs of a
8645 multi-glyph character are displayed in the current line, too.
8646 This is what the old redisplay code did, and we keep it that
8647 way. Under X, the whole shape of a complex character must
8648 fit on the line or it will be completely displayed in the
8651 Note that both for tabs and padding glyphs, all glyphs have
8655 /* More than one glyph or glyph doesn't fit on line. All
8656 glyphs have the same width. */
8657 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8659 int x_before_this_char
= x
;
8660 int hpos_before_this_char
= it
->hpos
;
8662 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8664 new_x
= x
+ single_glyph_width
;
8666 /* We want to leave anything reaching TO_X to the caller. */
8667 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8669 if (BUFFER_POS_REACHED_P ())
8671 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8672 goto buffer_pos_reached
;
8673 if (atpos_it
.sp
< 0)
8675 SAVE_IT (atpos_it
, *it
, atpos_data
);
8676 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8681 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8684 result
= MOVE_X_REACHED
;
8689 SAVE_IT (atx_it
, *it
, atx_data
);
8690 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8695 if (/* Lines are continued. */
8696 it
->line_wrap
!= TRUNCATE
8697 && (/* And glyph doesn't fit on the line. */
8698 new_x
> it
->last_visible_x
8699 /* Or it fits exactly and we're on a window
8701 || (new_x
== it
->last_visible_x
8702 && FRAME_WINDOW_P (it
->f
)
8703 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8704 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8705 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8707 if (/* IT->hpos == 0 means the very first glyph
8708 doesn't fit on the line, e.g. a wide image. */
8710 || (new_x
== it
->last_visible_x
8711 && FRAME_WINDOW_P (it
->f
)
8712 /* When word-wrap is ON and we have a valid
8713 wrap point, we don't allow the last glyph
8714 to "just barely fit" on the line. */
8715 && (it
->line_wrap
!= WORD_WRAP
8716 || wrap_it
.sp
< 0)))
8719 it
->current_x
= new_x
;
8721 /* The character's last glyph just barely fits
8723 if (i
== it
->nglyphs
- 1)
8725 /* If this is the destination position,
8726 return a position *before* it in this row,
8727 now that we know it fits in this row. */
8728 if (BUFFER_POS_REACHED_P ())
8730 if (it
->line_wrap
!= WORD_WRAP
8733 it
->hpos
= hpos_before_this_char
;
8734 it
->current_x
= x_before_this_char
;
8735 result
= MOVE_POS_MATCH_OR_ZV
;
8738 if (it
->line_wrap
== WORD_WRAP
8741 SAVE_IT (atpos_it
, *it
, atpos_data
);
8742 atpos_it
.current_x
= x_before_this_char
;
8743 atpos_it
.hpos
= hpos_before_this_char
;
8747 prev_method
= it
->method
;
8748 if (it
->method
== GET_FROM_BUFFER
)
8749 prev_pos
= IT_CHARPOS (*it
);
8750 set_iterator_to_next (it
, 1);
8751 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8752 SET_TEXT_POS (this_line_min_pos
,
8753 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8754 /* On graphical terminals, newlines may
8755 "overflow" into the fringe if
8756 overflow-newline-into-fringe is non-nil.
8757 On text terminals, and on graphical
8758 terminals with no right margin, newlines
8759 may overflow into the last glyph on the
8761 if (!FRAME_WINDOW_P (it
->f
)
8763 && it
->bidi_it
.paragraph_dir
== R2L
)
8764 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8765 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8766 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8768 if (!get_next_display_element (it
))
8770 result
= MOVE_POS_MATCH_OR_ZV
;
8773 if (BUFFER_POS_REACHED_P ())
8775 if (ITERATOR_AT_END_OF_LINE_P (it
))
8776 result
= MOVE_POS_MATCH_OR_ZV
;
8778 result
= MOVE_LINE_CONTINUED
;
8781 if (ITERATOR_AT_END_OF_LINE_P (it
)
8782 && (it
->line_wrap
!= WORD_WRAP
8785 result
= MOVE_NEWLINE_OR_CR
;
8792 IT_RESET_X_ASCENT_DESCENT (it
);
8794 if (wrap_it
.sp
>= 0)
8796 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8801 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8803 result
= MOVE_LINE_CONTINUED
;
8807 if (BUFFER_POS_REACHED_P ())
8809 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8810 goto buffer_pos_reached
;
8811 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8813 SAVE_IT (atpos_it
, *it
, atpos_data
);
8814 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8818 if (new_x
> it
->first_visible_x
)
8820 /* Glyph is visible. Increment number of glyphs that
8821 would be displayed. */
8826 if (result
!= MOVE_UNDEFINED
)
8829 else if (BUFFER_POS_REACHED_P ())
8832 IT_RESET_X_ASCENT_DESCENT (it
);
8833 result
= MOVE_POS_MATCH_OR_ZV
;
8836 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8838 /* Stop when TO_X specified and reached. This check is
8839 necessary here because of lines consisting of a line end,
8840 only. The line end will not produce any glyphs and we
8841 would never get MOVE_X_REACHED. */
8842 eassert (it
->nglyphs
== 0);
8843 result
= MOVE_X_REACHED
;
8847 /* Is this a line end? If yes, we're done. */
8848 if (ITERATOR_AT_END_OF_LINE_P (it
))
8850 /* If we are past TO_CHARPOS, but never saw any character
8851 positions smaller than TO_CHARPOS, return
8852 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8854 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8856 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8858 if (closest_pos
< ZV
)
8860 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8861 /* Don't recurse if closest_pos is equal to
8862 to_charpos, since we have just tried that. */
8863 if (closest_pos
!= to_charpos
)
8864 move_it_in_display_line_to (it
, closest_pos
, -1,
8866 result
= MOVE_POS_MATCH_OR_ZV
;
8869 goto buffer_pos_reached
;
8871 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8872 && IT_CHARPOS (*it
) > to_charpos
)
8873 goto buffer_pos_reached
;
8875 result
= MOVE_NEWLINE_OR_CR
;
8878 result
= MOVE_NEWLINE_OR_CR
;
8882 prev_method
= it
->method
;
8883 if (it
->method
== GET_FROM_BUFFER
)
8884 prev_pos
= IT_CHARPOS (*it
);
8885 /* The current display element has been consumed. Advance
8887 set_iterator_to_next (it
, 1);
8888 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8889 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8890 if (IT_CHARPOS (*it
) < to_charpos
)
8891 saw_smaller_pos
= 1;
8893 && (op
& MOVE_TO_POS
)
8894 && IT_CHARPOS (*it
) >= to_charpos
8895 && IT_CHARPOS (*it
) < closest_pos
)
8896 closest_pos
= IT_CHARPOS (*it
);
8898 /* Stop if lines are truncated and IT's current x-position is
8899 past the right edge of the window now. */
8900 if (it
->line_wrap
== TRUNCATE
8901 && it
->current_x
>= it
->last_visible_x
)
8903 if (!FRAME_WINDOW_P (it
->f
)
8904 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8905 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8906 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8907 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8911 if ((at_eob_p
= !get_next_display_element (it
))
8912 || BUFFER_POS_REACHED_P ()
8913 /* If we are past TO_CHARPOS, but never saw any
8914 character positions smaller than TO_CHARPOS,
8915 return MOVE_POS_MATCH_OR_ZV, like the
8916 unidirectional display did. */
8917 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8919 && IT_CHARPOS (*it
) > to_charpos
))
8922 && !BUFFER_POS_REACHED_P ()
8923 && !at_eob_p
&& closest_pos
< ZV
)
8925 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8926 if (closest_pos
!= to_charpos
)
8927 move_it_in_display_line_to (it
, closest_pos
, -1,
8930 result
= MOVE_POS_MATCH_OR_ZV
;
8933 if (ITERATOR_AT_END_OF_LINE_P (it
))
8935 result
= MOVE_NEWLINE_OR_CR
;
8939 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8941 && IT_CHARPOS (*it
) > to_charpos
)
8943 if (closest_pos
< ZV
)
8945 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8946 if (closest_pos
!= to_charpos
)
8947 move_it_in_display_line_to (it
, closest_pos
, -1,
8950 result
= MOVE_POS_MATCH_OR_ZV
;
8953 result
= MOVE_LINE_TRUNCATED
;
8956 #undef IT_RESET_X_ASCENT_DESCENT
8959 #undef BUFFER_POS_REACHED_P
8961 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8962 restore the saved iterator. */
8963 if (atpos_it
.sp
>= 0)
8964 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8965 else if (atx_it
.sp
>= 0)
8966 RESTORE_IT (it
, &atx_it
, atx_data
);
8971 bidi_unshelve_cache (atpos_data
, 1);
8973 bidi_unshelve_cache (atx_data
, 1);
8975 bidi_unshelve_cache (wrap_data
, 1);
8977 bidi_unshelve_cache (ppos_data
, 1);
8979 /* Restore the iterator settings altered at the beginning of this
8981 it
->glyph_row
= saved_glyph_row
;
8985 /* For external use. */
8987 move_it_in_display_line (struct it
*it
,
8988 ptrdiff_t to_charpos
, int to_x
,
8989 enum move_operation_enum op
)
8991 if (it
->line_wrap
== WORD_WRAP
8992 && (op
& MOVE_TO_X
))
8995 void *save_data
= NULL
;
8998 SAVE_IT (save_it
, *it
, save_data
);
8999 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9000 /* When word-wrap is on, TO_X may lie past the end
9001 of a wrapped line. Then it->current is the
9002 character on the next line, so backtrack to the
9003 space before the wrap point. */
9004 if (skip
== MOVE_LINE_CONTINUED
)
9006 int prev_x
= max (it
->current_x
- 1, 0);
9007 RESTORE_IT (it
, &save_it
, save_data
);
9008 move_it_in_display_line_to
9009 (it
, -1, prev_x
, MOVE_TO_X
);
9012 bidi_unshelve_cache (save_data
, 1);
9015 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9019 /* Move IT forward until it satisfies one or more of the criteria in
9020 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9022 OP is a bit-mask that specifies where to stop, and in particular,
9023 which of those four position arguments makes a difference. See the
9024 description of enum move_operation_enum.
9026 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9027 screen line, this function will set IT to the next position that is
9028 displayed to the right of TO_CHARPOS on the screen.
9030 Return the maximum pixel length of any line scanned but never more
9031 than it.last_visible_x. */
9034 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9036 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9037 int line_height
, line_start_x
= 0, reached
= 0;
9038 int max_current_x
= 0;
9039 void *backup_data
= NULL
;
9043 if (op
& MOVE_TO_VPOS
)
9045 /* If no TO_CHARPOS and no TO_X specified, stop at the
9046 start of the line TO_VPOS. */
9047 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9049 if (it
->vpos
== to_vpos
)
9055 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9059 /* TO_VPOS >= 0 means stop at TO_X in the line at
9060 TO_VPOS, or at TO_POS, whichever comes first. */
9061 if (it
->vpos
== to_vpos
)
9067 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9069 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9074 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9076 /* We have reached TO_X but not in the line we want. */
9077 skip
= move_it_in_display_line_to (it
, to_charpos
,
9079 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9087 else if (op
& MOVE_TO_Y
)
9089 struct it it_backup
;
9091 if (it
->line_wrap
== WORD_WRAP
)
9092 SAVE_IT (it_backup
, *it
, backup_data
);
9094 /* TO_Y specified means stop at TO_X in the line containing
9095 TO_Y---or at TO_CHARPOS if this is reached first. The
9096 problem is that we can't really tell whether the line
9097 contains TO_Y before we have completely scanned it, and
9098 this may skip past TO_X. What we do is to first scan to
9101 If TO_X is not specified, use a TO_X of zero. The reason
9102 is to make the outcome of this function more predictable.
9103 If we didn't use TO_X == 0, we would stop at the end of
9104 the line which is probably not what a caller would expect
9106 skip
= move_it_in_display_line_to
9107 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9108 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9110 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9111 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9113 else if (skip
== MOVE_X_REACHED
)
9115 /* If TO_X was reached, we want to know whether TO_Y is
9116 in the line. We know this is the case if the already
9117 scanned glyphs make the line tall enough. Otherwise,
9118 we must check by scanning the rest of the line. */
9119 line_height
= it
->max_ascent
+ it
->max_descent
;
9120 if (to_y
>= it
->current_y
9121 && to_y
< it
->current_y
+ line_height
)
9126 SAVE_IT (it_backup
, *it
, backup_data
);
9127 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9128 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9130 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9131 line_height
= it
->max_ascent
+ it
->max_descent
;
9132 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9134 if (to_y
>= it
->current_y
9135 && to_y
< it
->current_y
+ line_height
)
9137 /* If TO_Y is in this line and TO_X was reached
9138 above, we scanned too far. We have to restore
9139 IT's settings to the ones before skipping. But
9140 keep the more accurate values of max_ascent and
9141 max_descent we've found while skipping the rest
9142 of the line, for the sake of callers, such as
9143 pos_visible_p, that need to know the line
9145 int max_ascent
= it
->max_ascent
;
9146 int max_descent
= it
->max_descent
;
9148 RESTORE_IT (it
, &it_backup
, backup_data
);
9149 it
->max_ascent
= max_ascent
;
9150 it
->max_descent
= max_descent
;
9156 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9162 /* Check whether TO_Y is in this line. */
9163 line_height
= it
->max_ascent
+ it
->max_descent
;
9164 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9166 if (to_y
>= it
->current_y
9167 && to_y
< it
->current_y
+ line_height
)
9169 if (to_y
> it
->current_y
)
9170 max_current_x
= max (it
->current_x
, max_current_x
);
9172 /* When word-wrap is on, TO_X may lie past the end
9173 of a wrapped line. Then it->current is the
9174 character on the next line, so backtrack to the
9175 space before the wrap point. */
9176 if (skip
== MOVE_LINE_CONTINUED
9177 && it
->line_wrap
== WORD_WRAP
)
9179 int prev_x
= max (it
->current_x
- 1, 0);
9180 RESTORE_IT (it
, &it_backup
, backup_data
);
9181 skip
= move_it_in_display_line_to
9182 (it
, -1, prev_x
, MOVE_TO_X
);
9191 max_current_x
= max (it
->current_x
, max_current_x
);
9195 else if (BUFFERP (it
->object
)
9196 && (it
->method
== GET_FROM_BUFFER
9197 || it
->method
== GET_FROM_STRETCH
)
9198 && IT_CHARPOS (*it
) >= to_charpos
9199 /* Under bidi iteration, a call to set_iterator_to_next
9200 can scan far beyond to_charpos if the initial
9201 portion of the next line needs to be reordered. In
9202 that case, give move_it_in_display_line_to another
9205 && it
->bidi_it
.scan_dir
== -1))
9206 skip
= MOVE_POS_MATCH_OR_ZV
;
9208 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9212 case MOVE_POS_MATCH_OR_ZV
:
9213 max_current_x
= max (it
->current_x
, max_current_x
);
9217 case MOVE_NEWLINE_OR_CR
:
9218 max_current_x
= max (it
->current_x
, max_current_x
);
9219 set_iterator_to_next (it
, 1);
9220 it
->continuation_lines_width
= 0;
9223 case MOVE_LINE_TRUNCATED
:
9224 max_current_x
= it
->last_visible_x
;
9225 it
->continuation_lines_width
= 0;
9226 reseat_at_next_visible_line_start (it
, 0);
9227 if ((op
& MOVE_TO_POS
) != 0
9228 && IT_CHARPOS (*it
) > to_charpos
)
9235 case MOVE_LINE_CONTINUED
:
9236 max_current_x
= it
->last_visible_x
;
9237 /* For continued lines ending in a tab, some of the glyphs
9238 associated with the tab are displayed on the current
9239 line. Since it->current_x does not include these glyphs,
9240 we use it->last_visible_x instead. */
9243 it
->continuation_lines_width
+= it
->last_visible_x
;
9244 /* When moving by vpos, ensure that the iterator really
9245 advances to the next line (bug#847, bug#969). Fixme:
9246 do we need to do this in other circumstances? */
9247 if (it
->current_x
!= it
->last_visible_x
9248 && (op
& MOVE_TO_VPOS
)
9249 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9251 line_start_x
= it
->current_x
+ it
->pixel_width
9252 - it
->last_visible_x
;
9253 if (FRAME_WINDOW_P (it
->f
))
9255 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9256 struct font
*face_font
= face
->font
;
9258 /* When display_line produces a continued line
9259 that ends in a TAB, it skips a tab stop that
9260 is closer than the font's space character
9261 width (see x_produce_glyphs where it produces
9262 the stretch glyph which represents a TAB).
9263 We need to reproduce the same logic here. */
9264 eassert (face_font
);
9267 if (line_start_x
< face_font
->space_width
)
9269 += it
->tab_width
* face_font
->space_width
;
9272 set_iterator_to_next (it
, 0);
9276 it
->continuation_lines_width
+= it
->current_x
;
9283 /* Reset/increment for the next run. */
9284 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9285 it
->current_x
= line_start_x
;
9288 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9290 last_height
= it
->max_ascent
+ it
->max_descent
;
9291 it
->max_ascent
= it
->max_descent
= 0;
9296 /* On text terminals, we may stop at the end of a line in the middle
9297 of a multi-character glyph. If the glyph itself is continued,
9298 i.e. it is actually displayed on the next line, don't treat this
9299 stopping point as valid; move to the next line instead (unless
9300 that brings us offscreen). */
9301 if (!FRAME_WINDOW_P (it
->f
)
9303 && IT_CHARPOS (*it
) == to_charpos
9304 && it
->what
== IT_CHARACTER
9306 && it
->line_wrap
== WINDOW_WRAP
9307 && it
->current_x
== it
->last_visible_x
- 1
9310 && it
->vpos
< it
->w
->window_end_vpos
)
9312 it
->continuation_lines_width
+= it
->current_x
;
9313 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9314 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9316 last_height
= it
->max_ascent
+ it
->max_descent
;
9320 bidi_unshelve_cache (backup_data
, 1);
9322 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9324 return max_current_x
;
9328 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9330 If DY > 0, move IT backward at least that many pixels. DY = 0
9331 means move IT backward to the preceding line start or BEGV. This
9332 function may move over more than DY pixels if IT->current_y - DY
9333 ends up in the middle of a line; in this case IT->current_y will be
9334 set to the top of the line moved to. */
9337 move_it_vertically_backward (struct it
*it
, int dy
)
9341 void *it2data
= NULL
, *it3data
= NULL
;
9342 ptrdiff_t start_pos
;
9344 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9345 ptrdiff_t pos_limit
;
9350 start_pos
= IT_CHARPOS (*it
);
9352 /* Estimate how many newlines we must move back. */
9353 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9354 if (it
->line_wrap
== TRUNCATE
)
9357 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9359 /* Set the iterator's position that many lines back. But don't go
9360 back more than NLINES full screen lines -- this wins a day with
9361 buffers which have very long lines. */
9362 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9363 back_to_previous_visible_line_start (it
);
9365 /* Reseat the iterator here. When moving backward, we don't want
9366 reseat to skip forward over invisible text, set up the iterator
9367 to deliver from overlay strings at the new position etc. So,
9368 use reseat_1 here. */
9369 reseat_1 (it
, it
->current
.pos
, 1);
9371 /* We are now surely at a line start. */
9372 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9373 reordering is in effect. */
9374 it
->continuation_lines_width
= 0;
9376 /* Move forward and see what y-distance we moved. First move to the
9377 start of the next line so that we get its height. We need this
9378 height to be able to tell whether we reached the specified
9380 SAVE_IT (it2
, *it
, it2data
);
9381 it2
.max_ascent
= it2
.max_descent
= 0;
9384 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9385 MOVE_TO_POS
| MOVE_TO_VPOS
);
9387 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9388 /* If we are in a display string which starts at START_POS,
9389 and that display string includes a newline, and we are
9390 right after that newline (i.e. at the beginning of a
9391 display line), exit the loop, because otherwise we will
9392 infloop, since move_it_to will see that it is already at
9393 START_POS and will not move. */
9394 || (it2
.method
== GET_FROM_STRING
9395 && IT_CHARPOS (it2
) == start_pos
9396 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9397 eassert (IT_CHARPOS (*it
) >= BEGV
);
9398 SAVE_IT (it3
, it2
, it3data
);
9400 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9401 eassert (IT_CHARPOS (*it
) >= BEGV
);
9402 /* H is the actual vertical distance from the position in *IT
9403 and the starting position. */
9404 h
= it2
.current_y
- it
->current_y
;
9405 /* NLINES is the distance in number of lines. */
9406 nlines
= it2
.vpos
- it
->vpos
;
9408 /* Correct IT's y and vpos position
9409 so that they are relative to the starting point. */
9415 /* DY == 0 means move to the start of the screen line. The
9416 value of nlines is > 0 if continuation lines were involved,
9417 or if the original IT position was at start of a line. */
9418 RESTORE_IT (it
, it
, it2data
);
9420 move_it_by_lines (it
, nlines
);
9421 /* The above code moves us to some position NLINES down,
9422 usually to its first glyph (leftmost in an L2R line), but
9423 that's not necessarily the start of the line, under bidi
9424 reordering. We want to get to the character position
9425 that is immediately after the newline of the previous
9428 && !it
->continuation_lines_width
9429 && !STRINGP (it
->string
)
9430 && IT_CHARPOS (*it
) > BEGV
9431 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9433 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9436 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9437 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9439 bidi_unshelve_cache (it3data
, 1);
9443 /* The y-position we try to reach, relative to *IT.
9444 Note that H has been subtracted in front of the if-statement. */
9445 int target_y
= it
->current_y
+ h
- dy
;
9446 int y0
= it3
.current_y
;
9450 RESTORE_IT (&it3
, &it3
, it3data
);
9451 y1
= line_bottom_y (&it3
);
9452 line_height
= y1
- y0
;
9453 RESTORE_IT (it
, it
, it2data
);
9454 /* If we did not reach target_y, try to move further backward if
9455 we can. If we moved too far backward, try to move forward. */
9456 if (target_y
< it
->current_y
9457 /* This is heuristic. In a window that's 3 lines high, with
9458 a line height of 13 pixels each, recentering with point
9459 on the bottom line will try to move -39/2 = 19 pixels
9460 backward. Try to avoid moving into the first line. */
9461 && (it
->current_y
- target_y
9462 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9463 && IT_CHARPOS (*it
) > BEGV
)
9465 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9466 target_y
- it
->current_y
));
9467 dy
= it
->current_y
- target_y
;
9468 goto move_further_back
;
9470 else if (target_y
>= it
->current_y
+ line_height
9471 && IT_CHARPOS (*it
) < ZV
)
9473 /* Should move forward by at least one line, maybe more.
9475 Note: Calling move_it_by_lines can be expensive on
9476 terminal frames, where compute_motion is used (via
9477 vmotion) to do the job, when there are very long lines
9478 and truncate-lines is nil. That's the reason for
9479 treating terminal frames specially here. */
9481 if (!FRAME_WINDOW_P (it
->f
))
9482 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9487 move_it_by_lines (it
, 1);
9489 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9496 /* Move IT by a specified amount of pixel lines DY. DY negative means
9497 move backwards. DY = 0 means move to start of screen line. At the
9498 end, IT will be on the start of a screen line. */
9501 move_it_vertically (struct it
*it
, int dy
)
9504 move_it_vertically_backward (it
, -dy
);
9507 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9508 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9509 MOVE_TO_POS
| MOVE_TO_Y
);
9510 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9512 /* If buffer ends in ZV without a newline, move to the start of
9513 the line to satisfy the post-condition. */
9514 if (IT_CHARPOS (*it
) == ZV
9516 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9517 move_it_by_lines (it
, 0);
9522 /* Move iterator IT past the end of the text line it is in. */
9525 move_it_past_eol (struct it
*it
)
9527 enum move_it_result rc
;
9529 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9530 if (rc
== MOVE_NEWLINE_OR_CR
)
9531 set_iterator_to_next (it
, 0);
9535 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9536 negative means move up. DVPOS == 0 means move to the start of the
9539 Optimization idea: If we would know that IT->f doesn't use
9540 a face with proportional font, we could be faster for
9541 truncate-lines nil. */
9544 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9547 /* The commented-out optimization uses vmotion on terminals. This
9548 gives bad results, because elements like it->what, on which
9549 callers such as pos_visible_p rely, aren't updated. */
9550 /* struct position pos;
9551 if (!FRAME_WINDOW_P (it->f))
9553 struct text_pos textpos;
9555 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9556 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9557 reseat (it, textpos, 1);
9558 it->vpos += pos.vpos;
9559 it->current_y += pos.vpos;
9565 /* DVPOS == 0 means move to the start of the screen line. */
9566 move_it_vertically_backward (it
, 0);
9567 /* Let next call to line_bottom_y calculate real line height. */
9572 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9573 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9575 /* Only move to the next buffer position if we ended up in a
9576 string from display property, not in an overlay string
9577 (before-string or after-string). That is because the
9578 latter don't conceal the underlying buffer position, so
9579 we can ask to move the iterator to the exact position we
9580 are interested in. Note that, even if we are already at
9581 IT_CHARPOS (*it), the call below is not a no-op, as it
9582 will detect that we are at the end of the string, pop the
9583 iterator, and compute it->current_x and it->hpos
9585 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9586 -1, -1, -1, MOVE_TO_POS
);
9592 void *it2data
= NULL
;
9593 ptrdiff_t start_charpos
, i
;
9595 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9596 bool hit_pos_limit
= false;
9597 ptrdiff_t pos_limit
;
9599 /* Start at the beginning of the screen line containing IT's
9600 position. This may actually move vertically backwards,
9601 in case of overlays, so adjust dvpos accordingly. */
9603 move_it_vertically_backward (it
, 0);
9606 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9607 screen lines, and reseat the iterator there. */
9608 start_charpos
= IT_CHARPOS (*it
);
9609 if (it
->line_wrap
== TRUNCATE
)
9612 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9614 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9615 back_to_previous_visible_line_start (it
);
9616 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9617 hit_pos_limit
= true;
9618 reseat (it
, it
->current
.pos
, 1);
9620 /* Move further back if we end up in a string or an image. */
9621 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9623 /* First try to move to start of display line. */
9625 move_it_vertically_backward (it
, 0);
9627 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9629 /* If start of line is still in string or image,
9630 move further back. */
9631 back_to_previous_visible_line_start (it
);
9632 reseat (it
, it
->current
.pos
, 1);
9636 it
->current_x
= it
->hpos
= 0;
9638 /* Above call may have moved too far if continuation lines
9639 are involved. Scan forward and see if it did. */
9640 SAVE_IT (it2
, *it
, it2data
);
9641 it2
.vpos
= it2
.current_y
= 0;
9642 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9643 it
->vpos
-= it2
.vpos
;
9644 it
->current_y
-= it2
.current_y
;
9645 it
->current_x
= it
->hpos
= 0;
9647 /* If we moved too far back, move IT some lines forward. */
9648 if (it2
.vpos
> -dvpos
)
9650 int delta
= it2
.vpos
+ dvpos
;
9652 RESTORE_IT (&it2
, &it2
, it2data
);
9653 SAVE_IT (it2
, *it
, it2data
);
9654 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9655 /* Move back again if we got too far ahead. */
9656 if (IT_CHARPOS (*it
) >= start_charpos
)
9657 RESTORE_IT (it
, &it2
, it2data
);
9659 bidi_unshelve_cache (it2data
, 1);
9661 else if (hit_pos_limit
&& pos_limit
> BEGV
9662 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9664 /* If we hit the limit, but still didn't make it far enough
9665 back, that means there's a display string with a newline
9666 covering a large chunk of text, and that caused
9667 back_to_previous_visible_line_start try to go too far.
9668 Punish those who commit such atrocities by going back
9669 until we've reached DVPOS, after lifting the limit, which
9670 could make it slow for very long lines. "If it hurts,
9673 RESTORE_IT (it
, it
, it2data
);
9674 for (i
= -dvpos
; i
> 0; --i
)
9676 back_to_previous_visible_line_start (it
);
9681 RESTORE_IT (it
, it
, it2data
);
9685 /* Return true if IT points into the middle of a display vector. */
9688 in_display_vector_p (struct it
*it
)
9690 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9691 && it
->current
.dpvec_index
> 0
9692 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9695 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9696 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9697 WINDOW must be a live window and defaults to the selected one. The
9698 return value is a cons of the maximum pixel-width of any text line and
9699 the maximum pixel-height of all text lines.
9701 The optional argument FROM, if non-nil, specifies the first text
9702 position and defaults to the minimum accessible position of the buffer.
9703 If FROM is t, use the minimum accessible position that is not a newline
9704 character. TO, if non-nil, specifies the last text position and
9705 defaults to the maximum accessible position of the buffer. If TO is t,
9706 use the maximum accessible position that is not a newline character.
9708 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9709 width that can be returned. X-LIMIT nil or omitted, means to use the
9710 pixel-width of WINDOW's body; use this if you do not intend to change
9711 the width of WINDOW. Use the maximum width WINDOW may assume if you
9712 intend to change WINDOW's width. In any case, text whose x-coordinate
9713 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9714 can take some time, it's always a good idea to make this argument as
9715 small as possible; in particular, if the buffer contains long lines that
9716 shall be truncated anyway.
9718 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9719 height that can be returned. Text lines whose y-coordinate is beyond
9720 Y-LIMIT are ignored. Since calculating the text height of a large
9721 buffer can take some time, it makes sense to specify this argument if
9722 the size of the buffer is unknown.
9724 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9725 include the height of the mode- or header-line of WINDOW in the return
9726 value. If it is either the symbol `mode-line' or `header-line', include
9727 only the height of that line, if present, in the return value. If t,
9728 include the height of both, if present, in the return value. */)
9729 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
, Lisp_Object y_limit
,
9730 Lisp_Object mode_and_header_line
)
9732 struct window
*w
= decode_live_window (window
);
9736 struct buffer
*old_buffer
= NULL
;
9737 ptrdiff_t start
, end
, pos
;
9738 struct text_pos startp
;
9739 void *itdata
= NULL
;
9740 int c
, max_y
= -1, x
= 0, y
= 0;
9746 if (b
!= current_buffer
)
9748 old_buffer
= current_buffer
;
9749 set_buffer_internal (b
);
9754 else if (EQ (from
, Qt
))
9757 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9758 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9760 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9765 CHECK_NUMBER_COERCE_MARKER (from
);
9766 start
= min (max (XINT (from
), BEGV
), ZV
);
9771 else if (EQ (to
, Qt
))
9774 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9775 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9777 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9782 CHECK_NUMBER_COERCE_MARKER (to
);
9783 end
= max (start
, min (XINT (to
), ZV
));
9786 if (!NILP (y_limit
))
9788 CHECK_NUMBER (y_limit
);
9789 max_y
= min (XINT (y_limit
), INT_MAX
);
9792 itdata
= bidi_shelve_cache ();
9793 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9794 start_display (&it
, w
, startp
);
9797 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9800 CHECK_NUMBER (x_limit
);
9801 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9802 /* Actually, we never want move_it_to stop at to_x. But to make
9803 sure that move_it_in_display_line_to always moves far enough,
9804 we set it to INT_MAX and specify MOVE_TO_X. */
9805 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9806 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9809 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9811 if (!EQ (mode_and_header_line
, Qheader_line
)
9812 && !EQ (mode_and_header_line
, Qt
))
9813 /* Do not count the header-line which was counted automatically by
9815 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9817 if (EQ (mode_and_header_line
, Qmode_line
)
9818 || EQ (mode_and_header_line
, Qt
))
9819 /* Do count the mode-line which is not included automatically by
9821 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9823 bidi_unshelve_cache (itdata
, 0);
9826 set_buffer_internal (old_buffer
);
9828 return Fcons (make_number (x
), make_number (y
));
9831 /***********************************************************************
9833 ***********************************************************************/
9836 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9840 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9842 Lisp_Object args
[3];
9843 Lisp_Object msg
, fmt
;
9846 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9850 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9852 args
[0] = fmt
= build_string (format
);
9855 msg
= Fformat (3, args
);
9857 len
= SBYTES (msg
) + 1;
9858 buffer
= SAFE_ALLOCA (len
);
9859 memcpy (buffer
, SDATA (msg
), len
);
9861 message_dolog (buffer
, len
- 1, 1, 0);
9868 /* Output a newline in the *Messages* buffer if "needs" one. */
9871 message_log_maybe_newline (void)
9873 if (message_log_need_newline
)
9874 message_dolog ("", 0, 1, 0);
9878 /* Add a string M of length NBYTES to the message log, optionally
9879 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9880 true, means interpret the contents of M as multibyte. This
9881 function calls low-level routines in order to bypass text property
9882 hooks, etc. which might not be safe to run.
9884 This may GC (insert may run before/after change hooks),
9885 so the buffer M must NOT point to a Lisp string. */
9888 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9890 const unsigned char *msg
= (const unsigned char *) m
;
9892 if (!NILP (Vmemory_full
))
9895 if (!NILP (Vmessage_log_max
))
9897 struct buffer
*oldbuf
;
9898 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9899 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9900 ptrdiff_t point_at_end
= 0;
9901 ptrdiff_t zv_at_end
= 0;
9902 Lisp_Object old_deactivate_mark
;
9903 struct gcpro gcpro1
;
9905 old_deactivate_mark
= Vdeactivate_mark
;
9906 oldbuf
= current_buffer
;
9908 /* Ensure the Messages buffer exists, and switch to it.
9909 If we created it, set the major-mode. */
9912 if (NILP (Fget_buffer (Vmessages_buffer_name
))) newbuffer
= 1;
9914 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9917 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9918 call0 (intern ("messages-buffer-mode"));
9921 bset_undo_list (current_buffer
, Qt
);
9922 bset_cache_long_scans (current_buffer
, Qnil
);
9924 oldpoint
= message_dolog_marker1
;
9925 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9926 oldbegv
= message_dolog_marker2
;
9927 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
9928 oldzv
= message_dolog_marker3
;
9929 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
9930 GCPRO1 (old_deactivate_mark
);
9938 BEGV_BYTE
= BEG_BYTE
;
9941 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9943 /* Insert the string--maybe converting multibyte to single byte
9944 or vice versa, so that all the text fits the buffer. */
9946 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9952 /* Convert a multibyte string to single-byte
9953 for the *Message* buffer. */
9954 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9956 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9957 work
[0] = CHAR_TO_BYTE8 (c
);
9958 insert_1_both (work
, 1, 1, 1, 0, 0);
9961 else if (! multibyte
9962 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9966 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9967 /* Convert a single-byte string to multibyte
9968 for the *Message* buffer. */
9969 for (i
= 0; i
< nbytes
; i
++)
9972 MAKE_CHAR_MULTIBYTE (c
);
9973 char_bytes
= CHAR_STRING (c
, str
);
9974 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9978 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
, 1, 0, 0);
9982 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9985 insert_1_both ("\n", 1, 1, 1, 0, 0);
9987 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9989 this_bol_byte
= PT_BYTE
;
9991 /* See if this line duplicates the previous one.
9992 If so, combine duplicates. */
9995 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9997 prev_bol_byte
= PT_BYTE
;
9999 dups
= message_log_check_duplicate (prev_bol_byte
,
10003 del_range_both (prev_bol
, prev_bol_byte
,
10004 this_bol
, this_bol_byte
, 0);
10007 char dupstr
[sizeof " [ times]"
10008 + INT_STRLEN_BOUND (printmax_t
)];
10010 /* If you change this format, don't forget to also
10011 change message_log_check_duplicate. */
10012 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10013 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10014 insert_1_both (dupstr
, duplen
, duplen
, 1, 0, 1);
10019 /* If we have more than the desired maximum number of lines
10020 in the *Messages* buffer now, delete the oldest ones.
10021 This is safe because we don't have undo in this buffer. */
10023 if (NATNUMP (Vmessage_log_max
))
10025 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10026 -XFASTINT (Vmessage_log_max
) - 1, 0);
10027 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
10030 BEGV
= marker_position (oldbegv
);
10031 BEGV_BYTE
= marker_byte_position (oldbegv
);
10040 ZV
= marker_position (oldzv
);
10041 ZV_BYTE
= marker_byte_position (oldzv
);
10045 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10047 /* We can't do Fgoto_char (oldpoint) because it will run some
10049 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10050 marker_byte_position (oldpoint
));
10053 unchain_marker (XMARKER (oldpoint
));
10054 unchain_marker (XMARKER (oldbegv
));
10055 unchain_marker (XMARKER (oldzv
));
10057 /* We called insert_1_both above with its 5th argument (PREPARE)
10058 zero, which prevents insert_1_both from calling
10059 prepare_to_modify_buffer, which in turns prevents us from
10060 incrementing windows_or_buffers_changed even if *Messages* is
10061 shown in some window. So we must manually set
10062 windows_or_buffers_changed here to make up for that. */
10063 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10064 bset_redisplay (current_buffer
);
10066 set_buffer_internal (oldbuf
);
10068 message_log_need_newline
= !nlflag
;
10069 Vdeactivate_mark
= old_deactivate_mark
;
10074 /* We are at the end of the buffer after just having inserted a newline.
10075 (Note: We depend on the fact we won't be crossing the gap.)
10076 Check to see if the most recent message looks a lot like the previous one.
10077 Return 0 if different, 1 if the new one should just replace it, or a
10078 value N > 1 if we should also append " [N times]". */
10081 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10084 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10086 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10087 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10089 for (i
= 0; i
< len
; i
++)
10091 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10093 if (p1
[i
] != p2
[i
])
10099 if (*p1
++ == ' ' && *p1
++ == '[')
10102 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10103 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10110 /* Display an echo area message M with a specified length of NBYTES
10111 bytes. The string may include null characters. If M is not a
10112 string, clear out any existing message, and let the mini-buffer
10115 This function cancels echoing. */
10118 message3 (Lisp_Object m
)
10120 struct gcpro gcpro1
;
10123 clear_message (true, true);
10126 /* First flush out any partial line written with print. */
10127 message_log_maybe_newline ();
10130 ptrdiff_t nbytes
= SBYTES (m
);
10131 bool multibyte
= STRING_MULTIBYTE (m
);
10133 char *buffer
= SAFE_ALLOCA (nbytes
);
10134 memcpy (buffer
, SDATA (m
), nbytes
);
10135 message_dolog (buffer
, nbytes
, 1, multibyte
);
10138 message3_nolog (m
);
10144 /* The non-logging version of message3.
10145 This does not cancel echoing, because it is used for echoing.
10146 Perhaps we need to make a separate function for echoing
10147 and make this cancel echoing. */
10150 message3_nolog (Lisp_Object m
)
10152 struct frame
*sf
= SELECTED_FRAME ();
10154 if (FRAME_INITIAL_P (sf
))
10156 if (noninteractive_need_newline
)
10157 putc ('\n', stderr
);
10158 noninteractive_need_newline
= 0;
10161 Lisp_Object s
= ENCODE_SYSTEM (m
);
10163 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10165 if (cursor_in_echo_area
== 0)
10166 fprintf (stderr
, "\n");
10169 /* Error messages get reported properly by cmd_error, so this must be just an
10170 informative message; if the frame hasn't really been initialized yet, just
10172 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10174 /* Get the frame containing the mini-buffer
10175 that the selected frame is using. */
10176 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10177 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10178 struct frame
*f
= XFRAME (frame
);
10180 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10181 Fmake_frame_visible (frame
);
10183 if (STRINGP (m
) && SCHARS (m
) > 0)
10186 if (minibuffer_auto_raise
)
10187 Fraise_frame (frame
);
10188 /* Assume we are not echoing.
10189 (If we are, echo_now will override this.) */
10190 echo_message_buffer
= Qnil
;
10193 clear_message (true, true);
10195 do_pending_window_change (0);
10196 echo_area_display (1);
10197 do_pending_window_change (0);
10198 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10199 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10204 /* Display a null-terminated echo area message M. If M is 0, clear
10205 out any existing message, and let the mini-buffer text show through.
10207 The buffer M must continue to exist until after the echo area gets
10208 cleared or some other message gets displayed there. Do not pass
10209 text that is stored in a Lisp string. Do not pass text in a buffer
10210 that was alloca'd. */
10213 message1 (const char *m
)
10215 message3 (m
? build_unibyte_string (m
) : Qnil
);
10219 /* The non-logging counterpart of message1. */
10222 message1_nolog (const char *m
)
10224 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10227 /* Display a message M which contains a single %s
10228 which gets replaced with STRING. */
10231 message_with_string (const char *m
, Lisp_Object string
, int log
)
10233 CHECK_STRING (string
);
10235 if (noninteractive
)
10239 /* ENCODE_SYSTEM below can GC and/or relocate the
10240 Lisp data, so make sure we don't use it here. */
10241 eassert (relocatable_string_data_p (m
) != 1);
10243 if (noninteractive_need_newline
)
10244 putc ('\n', stderr
);
10245 noninteractive_need_newline
= 0;
10246 fprintf (stderr
, m
, SDATA (ENCODE_SYSTEM (string
)));
10247 if (!cursor_in_echo_area
)
10248 fprintf (stderr
, "\n");
10252 else if (INTERACTIVE
)
10254 /* The frame whose minibuffer we're going to display the message on.
10255 It may be larger than the selected frame, so we need
10256 to use its buffer, not the selected frame's buffer. */
10257 Lisp_Object mini_window
;
10258 struct frame
*f
, *sf
= SELECTED_FRAME ();
10260 /* Get the frame containing the minibuffer
10261 that the selected frame is using. */
10262 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10263 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10265 /* Error messages get reported properly by cmd_error, so this must be
10266 just an informative message; if the frame hasn't really been
10267 initialized yet, just toss it. */
10268 if (f
->glyphs_initialized_p
)
10270 Lisp_Object args
[2], msg
;
10271 struct gcpro gcpro1
, gcpro2
;
10273 args
[0] = build_string (m
);
10274 args
[1] = msg
= string
;
10275 GCPRO2 (args
[0], msg
);
10278 msg
= Fformat (2, args
);
10283 message3_nolog (msg
);
10287 /* Print should start at the beginning of the message
10288 buffer next time. */
10289 message_buf_print
= 0;
10295 /* Dump an informative message to the minibuf. If M is 0, clear out
10296 any existing message, and let the mini-buffer text show through. */
10299 vmessage (const char *m
, va_list ap
)
10301 if (noninteractive
)
10305 if (noninteractive_need_newline
)
10306 putc ('\n', stderr
);
10307 noninteractive_need_newline
= 0;
10308 vfprintf (stderr
, m
, ap
);
10309 if (cursor_in_echo_area
== 0)
10310 fprintf (stderr
, "\n");
10314 else if (INTERACTIVE
)
10316 /* The frame whose mini-buffer we're going to display the message
10317 on. It may be larger than the selected frame, so we need to
10318 use its buffer, not the selected frame's buffer. */
10319 Lisp_Object mini_window
;
10320 struct frame
*f
, *sf
= SELECTED_FRAME ();
10322 /* Get the frame containing the mini-buffer
10323 that the selected frame is using. */
10324 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10325 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10327 /* Error messages get reported properly by cmd_error, so this must be
10328 just an informative message; if the frame hasn't really been
10329 initialized yet, just toss it. */
10330 if (f
->glyphs_initialized_p
)
10335 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10336 char *message_buf
= alloca (maxsize
+ 1);
10338 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10340 message3 (make_string (message_buf
, len
));
10345 /* Print should start at the beginning of the message
10346 buffer next time. */
10347 message_buf_print
= 0;
10353 message (const char *m
, ...)
10363 /* The non-logging version of message. */
10366 message_nolog (const char *m
, ...)
10368 Lisp_Object old_log_max
;
10371 old_log_max
= Vmessage_log_max
;
10372 Vmessage_log_max
= Qnil
;
10374 Vmessage_log_max
= old_log_max
;
10380 /* Display the current message in the current mini-buffer. This is
10381 only called from error handlers in process.c, and is not time
10385 update_echo_area (void)
10387 if (!NILP (echo_area_buffer
[0]))
10389 Lisp_Object string
;
10390 string
= Fcurrent_message ();
10396 /* Make sure echo area buffers in `echo_buffers' are live.
10397 If they aren't, make new ones. */
10400 ensure_echo_area_buffers (void)
10404 for (i
= 0; i
< 2; ++i
)
10405 if (!BUFFERP (echo_buffer
[i
])
10406 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10409 Lisp_Object old_buffer
;
10412 old_buffer
= echo_buffer
[i
];
10413 echo_buffer
[i
] = Fget_buffer_create
10414 (make_formatted_string (name
, " *Echo Area %d*", i
));
10415 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10416 /* to force word wrap in echo area -
10417 it was decided to postpone this*/
10418 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10420 for (j
= 0; j
< 2; ++j
)
10421 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10422 echo_area_buffer
[j
] = echo_buffer
[i
];
10427 /* Call FN with args A1..A2 with either the current or last displayed
10428 echo_area_buffer as current buffer.
10430 WHICH zero means use the current message buffer
10431 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10432 from echo_buffer[] and clear it.
10434 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10435 suitable buffer from echo_buffer[] and clear it.
10437 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10438 that the current message becomes the last displayed one, make
10439 choose a suitable buffer for echo_area_buffer[0], and clear it.
10441 Value is what FN returns. */
10444 with_echo_area_buffer (struct window
*w
, int which
,
10445 int (*fn
) (ptrdiff_t, Lisp_Object
),
10446 ptrdiff_t a1
, Lisp_Object a2
)
10448 Lisp_Object buffer
;
10449 int this_one
, the_other
, clear_buffer_p
, rc
;
10450 ptrdiff_t count
= SPECPDL_INDEX ();
10452 /* If buffers aren't live, make new ones. */
10453 ensure_echo_area_buffers ();
10455 clear_buffer_p
= 0;
10458 this_one
= 0, the_other
= 1;
10459 else if (which
> 0)
10460 this_one
= 1, the_other
= 0;
10463 this_one
= 0, the_other
= 1;
10464 clear_buffer_p
= true;
10466 /* We need a fresh one in case the current echo buffer equals
10467 the one containing the last displayed echo area message. */
10468 if (!NILP (echo_area_buffer
[this_one
])
10469 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10470 echo_area_buffer
[this_one
] = Qnil
;
10473 /* Choose a suitable buffer from echo_buffer[] is we don't
10475 if (NILP (echo_area_buffer
[this_one
]))
10477 echo_area_buffer
[this_one
]
10478 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10479 ? echo_buffer
[the_other
]
10480 : echo_buffer
[this_one
]);
10481 clear_buffer_p
= true;
10484 buffer
= echo_area_buffer
[this_one
];
10486 /* Don't get confused by reusing the buffer used for echoing
10487 for a different purpose. */
10488 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10491 record_unwind_protect (unwind_with_echo_area_buffer
,
10492 with_echo_area_buffer_unwind_data (w
));
10494 /* Make the echo area buffer current. Note that for display
10495 purposes, it is not necessary that the displayed window's buffer
10496 == current_buffer, except for text property lookup. So, let's
10497 only set that buffer temporarily here without doing a full
10498 Fset_window_buffer. We must also change w->pointm, though,
10499 because otherwise an assertions in unshow_buffer fails, and Emacs
10501 set_buffer_internal_1 (XBUFFER (buffer
));
10504 wset_buffer (w
, buffer
);
10505 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10508 bset_undo_list (current_buffer
, Qt
);
10509 bset_read_only (current_buffer
, Qnil
);
10510 specbind (Qinhibit_read_only
, Qt
);
10511 specbind (Qinhibit_modification_hooks
, Qt
);
10513 if (clear_buffer_p
&& Z
> BEG
)
10514 del_range (BEG
, Z
);
10516 eassert (BEGV
>= BEG
);
10517 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10521 eassert (BEGV
>= BEG
);
10522 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10524 unbind_to (count
, Qnil
);
10529 /* Save state that should be preserved around the call to the function
10530 FN called in with_echo_area_buffer. */
10533 with_echo_area_buffer_unwind_data (struct window
*w
)
10536 Lisp_Object vector
, tmp
;
10538 /* Reduce consing by keeping one vector in
10539 Vwith_echo_area_save_vector. */
10540 vector
= Vwith_echo_area_save_vector
;
10541 Vwith_echo_area_save_vector
= Qnil
;
10544 vector
= Fmake_vector (make_number (9), Qnil
);
10546 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10547 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10548 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10552 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10553 ASET (vector
, i
, w
->contents
); ++i
;
10554 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10555 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10556 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10557 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10562 for (; i
< end
; ++i
)
10563 ASET (vector
, i
, Qnil
);
10566 eassert (i
== ASIZE (vector
));
10571 /* Restore global state from VECTOR which was created by
10572 with_echo_area_buffer_unwind_data. */
10575 unwind_with_echo_area_buffer (Lisp_Object vector
)
10577 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10578 Vdeactivate_mark
= AREF (vector
, 1);
10579 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10581 if (WINDOWP (AREF (vector
, 3)))
10584 Lisp_Object buffer
;
10586 w
= XWINDOW (AREF (vector
, 3));
10587 buffer
= AREF (vector
, 4);
10589 wset_buffer (w
, buffer
);
10590 set_marker_both (w
->pointm
, buffer
,
10591 XFASTINT (AREF (vector
, 5)),
10592 XFASTINT (AREF (vector
, 6)));
10593 set_marker_both (w
->start
, buffer
,
10594 XFASTINT (AREF (vector
, 7)),
10595 XFASTINT (AREF (vector
, 8)));
10598 Vwith_echo_area_save_vector
= vector
;
10602 /* Set up the echo area for use by print functions. MULTIBYTE_P
10603 non-zero means we will print multibyte. */
10606 setup_echo_area_for_printing (int multibyte_p
)
10608 /* If we can't find an echo area any more, exit. */
10609 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10610 Fkill_emacs (Qnil
);
10612 ensure_echo_area_buffers ();
10614 if (!message_buf_print
)
10616 /* A message has been output since the last time we printed.
10617 Choose a fresh echo area buffer. */
10618 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10619 echo_area_buffer
[0] = echo_buffer
[1];
10621 echo_area_buffer
[0] = echo_buffer
[0];
10623 /* Switch to that buffer and clear it. */
10624 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10625 bset_truncate_lines (current_buffer
, Qnil
);
10629 ptrdiff_t count
= SPECPDL_INDEX ();
10630 specbind (Qinhibit_read_only
, Qt
);
10631 /* Note that undo recording is always disabled. */
10632 del_range (BEG
, Z
);
10633 unbind_to (count
, Qnil
);
10635 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10637 /* Set up the buffer for the multibyteness we need. */
10639 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10640 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10642 /* Raise the frame containing the echo area. */
10643 if (minibuffer_auto_raise
)
10645 struct frame
*sf
= SELECTED_FRAME ();
10646 Lisp_Object mini_window
;
10647 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10648 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10651 message_log_maybe_newline ();
10652 message_buf_print
= 1;
10656 if (NILP (echo_area_buffer
[0]))
10658 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10659 echo_area_buffer
[0] = echo_buffer
[1];
10661 echo_area_buffer
[0] = echo_buffer
[0];
10664 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10666 /* Someone switched buffers between print requests. */
10667 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10668 bset_truncate_lines (current_buffer
, Qnil
);
10674 /* Display an echo area message in window W. Value is non-zero if W's
10675 height is changed. If display_last_displayed_message_p is
10676 non-zero, display the message that was last displayed, otherwise
10677 display the current message. */
10680 display_echo_area (struct window
*w
)
10682 int i
, no_message_p
, window_height_changed_p
;
10684 /* Temporarily disable garbage collections while displaying the echo
10685 area. This is done because a GC can print a message itself.
10686 That message would modify the echo area buffer's contents while a
10687 redisplay of the buffer is going on, and seriously confuse
10689 ptrdiff_t count
= inhibit_garbage_collection ();
10691 /* If there is no message, we must call display_echo_area_1
10692 nevertheless because it resizes the window. But we will have to
10693 reset the echo_area_buffer in question to nil at the end because
10694 with_echo_area_buffer will sets it to an empty buffer. */
10695 i
= display_last_displayed_message_p
? 1 : 0;
10696 no_message_p
= NILP (echo_area_buffer
[i
]);
10698 window_height_changed_p
10699 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10700 display_echo_area_1
,
10701 (intptr_t) w
, Qnil
);
10704 echo_area_buffer
[i
] = Qnil
;
10706 unbind_to (count
, Qnil
);
10707 return window_height_changed_p
;
10711 /* Helper for display_echo_area. Display the current buffer which
10712 contains the current echo area message in window W, a mini-window,
10713 a pointer to which is passed in A1. A2..A4 are currently not used.
10714 Change the height of W so that all of the message is displayed.
10715 Value is non-zero if height of W was changed. */
10718 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10721 struct window
*w
= (struct window
*) i1
;
10722 Lisp_Object window
;
10723 struct text_pos start
;
10724 int window_height_changed_p
= 0;
10726 /* Do this before displaying, so that we have a large enough glyph
10727 matrix for the display. If we can't get enough space for the
10728 whole text, display the last N lines. That works by setting w->start. */
10729 window_height_changed_p
= resize_mini_window (w
, 0);
10731 /* Use the starting position chosen by resize_mini_window. */
10732 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10735 clear_glyph_matrix (w
->desired_matrix
);
10736 XSETWINDOW (window
, w
);
10737 try_window (window
, start
, 0);
10739 return window_height_changed_p
;
10743 /* Resize the echo area window to exactly the size needed for the
10744 currently displayed message, if there is one. If a mini-buffer
10745 is active, don't shrink it. */
10748 resize_echo_area_exactly (void)
10750 if (BUFFERP (echo_area_buffer
[0])
10751 && WINDOWP (echo_area_window
))
10753 struct window
*w
= XWINDOW (echo_area_window
);
10754 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10755 int resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10756 (intptr_t) w
, resize_exactly
);
10759 windows_or_buffers_changed
= 42;
10760 update_mode_lines
= 30;
10761 redisplay_internal ();
10767 /* Callback function for with_echo_area_buffer, when used from
10768 resize_echo_area_exactly. A1 contains a pointer to the window to
10769 resize, EXACTLY non-nil means resize the mini-window exactly to the
10770 size of the text displayed. A3 and A4 are not used. Value is what
10771 resize_mini_window returns. */
10774 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10777 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10781 /* Resize mini-window W to fit the size of its contents. EXACT_P
10782 means size the window exactly to the size needed. Otherwise, it's
10783 only enlarged until W's buffer is empty.
10785 Set W->start to the right place to begin display. If the whole
10786 contents fit, start at the beginning. Otherwise, start so as
10787 to make the end of the contents appear. This is particularly
10788 important for y-or-n-p, but seems desirable generally.
10790 Value is non-zero if the window height has been changed. */
10793 resize_mini_window (struct window
*w
, int exact_p
)
10795 struct frame
*f
= XFRAME (w
->frame
);
10796 int window_height_changed_p
= 0;
10798 eassert (MINI_WINDOW_P (w
));
10800 /* By default, start display at the beginning. */
10801 set_marker_both (w
->start
, w
->contents
,
10802 BUF_BEGV (XBUFFER (w
->contents
)),
10803 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10805 /* Don't resize windows while redisplaying a window; it would
10806 confuse redisplay functions when the size of the window they are
10807 displaying changes from under them. Such a resizing can happen,
10808 for instance, when which-func prints a long message while
10809 we are running fontification-functions. We're running these
10810 functions with safe_call which binds inhibit-redisplay to t. */
10811 if (!NILP (Vinhibit_redisplay
))
10814 /* Nil means don't try to resize. */
10815 if (NILP (Vresize_mini_windows
)
10816 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10819 if (!FRAME_MINIBUF_ONLY_P (f
))
10822 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10823 + WINDOW_PIXEL_HEIGHT (w
));
10824 int unit
= FRAME_LINE_HEIGHT (f
);
10825 int height
, max_height
;
10826 struct text_pos start
;
10827 struct buffer
*old_current_buffer
= NULL
;
10829 if (current_buffer
!= XBUFFER (w
->contents
))
10831 old_current_buffer
= current_buffer
;
10832 set_buffer_internal (XBUFFER (w
->contents
));
10835 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10837 /* Compute the max. number of lines specified by the user. */
10838 if (FLOATP (Vmax_mini_window_height
))
10839 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10840 else if (INTEGERP (Vmax_mini_window_height
))
10841 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10843 max_height
= total_height
/ 4;
10845 /* Correct that max. height if it's bogus. */
10846 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10848 /* Find out the height of the text in the window. */
10849 if (it
.line_wrap
== TRUNCATE
)
10854 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10855 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10856 height
= it
.current_y
+ last_height
;
10858 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10859 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10862 /* Compute a suitable window start. */
10863 if (height
> max_height
)
10865 height
= (max_height
/ unit
) * unit
;
10866 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10867 move_it_vertically_backward (&it
, height
- unit
);
10868 start
= it
.current
.pos
;
10871 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10872 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10874 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10876 /* Let it grow only, until we display an empty message, in which
10877 case the window shrinks again. */
10878 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10880 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10882 FRAME_WINDOWS_FROZEN (f
) = 1;
10883 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10884 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10886 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10887 && (exact_p
|| BEGV
== ZV
))
10889 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10891 FRAME_WINDOWS_FROZEN (f
) = 0;
10892 shrink_mini_window (w
, 1);
10893 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10898 /* Always resize to exact size needed. */
10899 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10901 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10903 FRAME_WINDOWS_FROZEN (f
) = 1;
10904 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10905 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10907 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10909 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10911 FRAME_WINDOWS_FROZEN (f
) = 0;
10912 shrink_mini_window (w
, 1);
10916 FRAME_WINDOWS_FROZEN (f
) = 1;
10917 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10920 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10924 if (old_current_buffer
)
10925 set_buffer_internal (old_current_buffer
);
10928 return window_height_changed_p
;
10932 /* Value is the current message, a string, or nil if there is no
10933 current message. */
10936 current_message (void)
10940 if (!BUFFERP (echo_area_buffer
[0]))
10944 with_echo_area_buffer (0, 0, current_message_1
,
10945 (intptr_t) &msg
, Qnil
);
10947 echo_area_buffer
[0] = Qnil
;
10955 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
10958 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10961 *msg
= make_buffer_string (BEG
, Z
, 1);
10968 /* Push the current message on Vmessage_stack for later restoration
10969 by restore_message. Value is non-zero if the current message isn't
10970 empty. This is a relatively infrequent operation, so it's not
10971 worth optimizing. */
10974 push_message (void)
10976 Lisp_Object msg
= current_message ();
10977 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10978 return STRINGP (msg
);
10982 /* Restore message display from the top of Vmessage_stack. */
10985 restore_message (void)
10987 eassert (CONSP (Vmessage_stack
));
10988 message3_nolog (XCAR (Vmessage_stack
));
10992 /* Handler for unwind-protect calling pop_message. */
10995 pop_message_unwind (void)
10997 /* Pop the top-most entry off Vmessage_stack. */
10998 eassert (CONSP (Vmessage_stack
));
10999 Vmessage_stack
= XCDR (Vmessage_stack
);
11003 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11004 exits. If the stack is not empty, we have a missing pop_message
11008 check_message_stack (void)
11010 if (!NILP (Vmessage_stack
))
11015 /* Truncate to NCHARS what will be displayed in the echo area the next
11016 time we display it---but don't redisplay it now. */
11019 truncate_echo_area (ptrdiff_t nchars
)
11022 echo_area_buffer
[0] = Qnil
;
11023 else if (!noninteractive
11025 && !NILP (echo_area_buffer
[0]))
11027 struct frame
*sf
= SELECTED_FRAME ();
11028 /* Error messages get reported properly by cmd_error, so this must be
11029 just an informative message; if the frame hasn't really been
11030 initialized yet, just toss it. */
11031 if (sf
->glyphs_initialized_p
)
11032 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11037 /* Helper function for truncate_echo_area. Truncate the current
11038 message to at most NCHARS characters. */
11041 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11043 if (BEG
+ nchars
< Z
)
11044 del_range (BEG
+ nchars
, Z
);
11046 echo_area_buffer
[0] = Qnil
;
11050 /* Set the current message to STRING. */
11053 set_message (Lisp_Object string
)
11055 eassert (STRINGP (string
));
11057 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11059 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11060 message_buf_print
= 0;
11061 help_echo_showing_p
= 0;
11063 if (STRINGP (Vdebug_on_message
)
11064 && STRINGP (string
)
11065 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11066 call_debugger (list2 (Qerror
, string
));
11070 /* Helper function for set_message. First argument is ignored and second
11071 argument has the same meaning as for set_message.
11072 This function is called with the echo area buffer being current. */
11075 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11077 eassert (STRINGP (string
));
11079 /* Change multibyteness of the echo buffer appropriately. */
11080 if (message_enable_multibyte
11081 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11082 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11084 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11085 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11086 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11088 /* Insert new message at BEG. */
11089 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11091 /* This function takes care of single/multibyte conversion.
11092 We just have to ensure that the echo area buffer has the right
11093 setting of enable_multibyte_characters. */
11094 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), 1);
11100 /* Clear messages. CURRENT_P non-zero means clear the current
11101 message. LAST_DISPLAYED_P non-zero means clear the message
11105 clear_message (bool current_p
, bool last_displayed_p
)
11109 echo_area_buffer
[0] = Qnil
;
11110 message_cleared_p
= true;
11113 if (last_displayed_p
)
11114 echo_area_buffer
[1] = Qnil
;
11116 message_buf_print
= 0;
11119 /* Clear garbaged frames.
11121 This function is used where the old redisplay called
11122 redraw_garbaged_frames which in turn called redraw_frame which in
11123 turn called clear_frame. The call to clear_frame was a source of
11124 flickering. I believe a clear_frame is not necessary. It should
11125 suffice in the new redisplay to invalidate all current matrices,
11126 and ensure a complete redisplay of all windows. */
11129 clear_garbaged_frames (void)
11131 if (frame_garbaged
)
11133 Lisp_Object tail
, frame
;
11135 FOR_EACH_FRAME (tail
, frame
)
11137 struct frame
*f
= XFRAME (frame
);
11139 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11144 clear_current_matrices (f
);
11145 fset_redisplay (f
);
11146 f
->garbaged
= false;
11147 f
->resized_p
= false;
11151 frame_garbaged
= false;
11156 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
11157 is non-zero update selected_frame. Value is non-zero if the
11158 mini-windows height has been changed. */
11161 echo_area_display (int update_frame_p
)
11163 Lisp_Object mini_window
;
11166 int window_height_changed_p
= 0;
11167 struct frame
*sf
= SELECTED_FRAME ();
11169 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11170 w
= XWINDOW (mini_window
);
11171 f
= XFRAME (WINDOW_FRAME (w
));
11173 /* Don't display if frame is invisible or not yet initialized. */
11174 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11177 #ifdef HAVE_WINDOW_SYSTEM
11178 /* When Emacs starts, selected_frame may be the initial terminal
11179 frame. If we let this through, a message would be displayed on
11181 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11183 #endif /* HAVE_WINDOW_SYSTEM */
11185 /* Redraw garbaged frames. */
11186 clear_garbaged_frames ();
11188 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11190 echo_area_window
= mini_window
;
11191 window_height_changed_p
= display_echo_area (w
);
11192 w
->must_be_updated_p
= true;
11194 /* Update the display, unless called from redisplay_internal.
11195 Also don't update the screen during redisplay itself. The
11196 update will happen at the end of redisplay, and an update
11197 here could cause confusion. */
11198 if (update_frame_p
&& !redisplaying_p
)
11202 /* If the display update has been interrupted by pending
11203 input, update mode lines in the frame. Due to the
11204 pending input, it might have been that redisplay hasn't
11205 been called, so that mode lines above the echo area are
11206 garbaged. This looks odd, so we prevent it here. */
11207 if (!display_completed
)
11208 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11210 if (window_height_changed_p
11211 /* Don't do this if Emacs is shutting down. Redisplay
11212 needs to run hooks. */
11213 && !NILP (Vrun_hooks
))
11215 /* Must update other windows. Likewise as in other
11216 cases, don't let this update be interrupted by
11218 ptrdiff_t count
= SPECPDL_INDEX ();
11219 specbind (Qredisplay_dont_pause
, Qt
);
11220 windows_or_buffers_changed
= 44;
11221 redisplay_internal ();
11222 unbind_to (count
, Qnil
);
11224 else if (FRAME_WINDOW_P (f
) && n
== 0)
11226 /* Window configuration is the same as before.
11227 Can do with a display update of the echo area,
11228 unless we displayed some mode lines. */
11229 update_single_window (w
, 1);
11233 update_frame (f
, 1, 1);
11235 /* If cursor is in the echo area, make sure that the next
11236 redisplay displays the minibuffer, so that the cursor will
11237 be replaced with what the minibuffer wants. */
11238 if (cursor_in_echo_area
)
11239 wset_redisplay (XWINDOW (mini_window
));
11242 else if (!EQ (mini_window
, selected_window
))
11243 wset_redisplay (XWINDOW (mini_window
));
11245 /* Last displayed message is now the current message. */
11246 echo_area_buffer
[1] = echo_area_buffer
[0];
11247 /* Inform read_char that we're not echoing. */
11248 echo_message_buffer
= Qnil
;
11250 /* Prevent redisplay optimization in redisplay_internal by resetting
11251 this_line_start_pos. This is done because the mini-buffer now
11252 displays the message instead of its buffer text. */
11253 if (EQ (mini_window
, selected_window
))
11254 CHARPOS (this_line_start_pos
) = 0;
11256 return window_height_changed_p
;
11259 /* Nonzero if W's buffer was changed but not saved. */
11262 window_buffer_changed (struct window
*w
)
11264 struct buffer
*b
= XBUFFER (w
->contents
);
11266 eassert (BUFFER_LIVE_P (b
));
11268 return (((BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
));
11271 /* Nonzero if W has %c in its mode line and mode line should be updated. */
11274 mode_line_update_needed (struct window
*w
)
11276 return (w
->column_number_displayed
!= -1
11277 && !(PT
== w
->last_point
&& !window_outdated (w
))
11278 && (w
->column_number_displayed
!= current_column ()));
11281 /* Nonzero if window start of W is frozen and may not be changed during
11285 window_frozen_p (struct window
*w
)
11287 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11289 Lisp_Object window
;
11291 XSETWINDOW (window
, w
);
11292 if (MINI_WINDOW_P (w
))
11294 else if (EQ (window
, selected_window
))
11296 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11297 && EQ (window
, Vminibuf_scroll_window
))
11298 /* This special window can't be frozen too. */
11306 /***********************************************************************
11307 Mode Lines and Frame Titles
11308 ***********************************************************************/
11310 /* A buffer for constructing non-propertized mode-line strings and
11311 frame titles in it; allocated from the heap in init_xdisp and
11312 resized as needed in store_mode_line_noprop_char. */
11314 static char *mode_line_noprop_buf
;
11316 /* The buffer's end, and a current output position in it. */
11318 static char *mode_line_noprop_buf_end
;
11319 static char *mode_line_noprop_ptr
;
11321 #define MODE_LINE_NOPROP_LEN(start) \
11322 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11325 MODE_LINE_DISPLAY
= 0,
11329 } mode_line_target
;
11331 /* Alist that caches the results of :propertize.
11332 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11333 static Lisp_Object mode_line_proptrans_alist
;
11335 /* List of strings making up the mode-line. */
11336 static Lisp_Object mode_line_string_list
;
11338 /* Base face property when building propertized mode line string. */
11339 static Lisp_Object mode_line_string_face
;
11340 static Lisp_Object mode_line_string_face_prop
;
11343 /* Unwind data for mode line strings */
11345 static Lisp_Object Vmode_line_unwind_vector
;
11348 format_mode_line_unwind_data (struct frame
*target_frame
,
11349 struct buffer
*obuf
,
11351 int save_proptrans
)
11353 Lisp_Object vector
, tmp
;
11355 /* Reduce consing by keeping one vector in
11356 Vwith_echo_area_save_vector. */
11357 vector
= Vmode_line_unwind_vector
;
11358 Vmode_line_unwind_vector
= Qnil
;
11361 vector
= Fmake_vector (make_number (10), Qnil
);
11363 ASET (vector
, 0, make_number (mode_line_target
));
11364 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11365 ASET (vector
, 2, mode_line_string_list
);
11366 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11367 ASET (vector
, 4, mode_line_string_face
);
11368 ASET (vector
, 5, mode_line_string_face_prop
);
11371 XSETBUFFER (tmp
, obuf
);
11374 ASET (vector
, 6, tmp
);
11375 ASET (vector
, 7, owin
);
11378 /* Similarly to `with-selected-window', if the operation selects
11379 a window on another frame, we must restore that frame's
11380 selected window, and (for a tty) the top-frame. */
11381 ASET (vector
, 8, target_frame
->selected_window
);
11382 if (FRAME_TERMCAP_P (target_frame
))
11383 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11390 unwind_format_mode_line (Lisp_Object vector
)
11392 Lisp_Object old_window
= AREF (vector
, 7);
11393 Lisp_Object target_frame_window
= AREF (vector
, 8);
11394 Lisp_Object old_top_frame
= AREF (vector
, 9);
11396 mode_line_target
= XINT (AREF (vector
, 0));
11397 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11398 mode_line_string_list
= AREF (vector
, 2);
11399 if (! EQ (AREF (vector
, 3), Qt
))
11400 mode_line_proptrans_alist
= AREF (vector
, 3);
11401 mode_line_string_face
= AREF (vector
, 4);
11402 mode_line_string_face_prop
= AREF (vector
, 5);
11404 /* Select window before buffer, since it may change the buffer. */
11405 if (!NILP (old_window
))
11407 /* If the operation that we are unwinding had selected a window
11408 on a different frame, reset its frame-selected-window. For a
11409 text terminal, reset its top-frame if necessary. */
11410 if (!NILP (target_frame_window
))
11413 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11415 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11416 Fselect_window (target_frame_window
, Qt
);
11418 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11419 Fselect_frame (old_top_frame
, Qt
);
11422 Fselect_window (old_window
, Qt
);
11425 if (!NILP (AREF (vector
, 6)))
11427 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11428 ASET (vector
, 6, Qnil
);
11431 Vmode_line_unwind_vector
= vector
;
11435 /* Store a single character C for the frame title in mode_line_noprop_buf.
11436 Re-allocate mode_line_noprop_buf if necessary. */
11439 store_mode_line_noprop_char (char c
)
11441 /* If output position has reached the end of the allocated buffer,
11442 increase the buffer's size. */
11443 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11445 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11446 ptrdiff_t size
= len
;
11447 mode_line_noprop_buf
=
11448 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11449 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11450 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11453 *mode_line_noprop_ptr
++ = c
;
11457 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11458 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11459 characters that yield more columns than PRECISION; PRECISION <= 0
11460 means copy the whole string. Pad with spaces until FIELD_WIDTH
11461 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11462 pad. Called from display_mode_element when it is used to build a
11466 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11468 const unsigned char *str
= (const unsigned char *) string
;
11470 ptrdiff_t dummy
, nbytes
;
11472 /* Copy at most PRECISION chars from STR. */
11473 nbytes
= strlen (string
);
11474 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11476 store_mode_line_noprop_char (*str
++);
11478 /* Fill up with spaces until FIELD_WIDTH reached. */
11479 while (field_width
> 0
11480 && n
< field_width
)
11482 store_mode_line_noprop_char (' ');
11489 /***********************************************************************
11491 ***********************************************************************/
11493 #ifdef HAVE_WINDOW_SYSTEM
11495 /* Set the title of FRAME, if it has changed. The title format is
11496 Vicon_title_format if FRAME is iconified, otherwise it is
11497 frame_title_format. */
11500 x_consider_frame_title (Lisp_Object frame
)
11502 struct frame
*f
= XFRAME (frame
);
11504 if (FRAME_WINDOW_P (f
)
11505 || FRAME_MINIBUF_ONLY_P (f
)
11506 || f
->explicit_name
)
11508 /* Do we have more than one visible frame on this X display? */
11509 Lisp_Object tail
, other_frame
, fmt
;
11510 ptrdiff_t title_start
;
11514 ptrdiff_t count
= SPECPDL_INDEX ();
11516 FOR_EACH_FRAME (tail
, other_frame
)
11518 struct frame
*tf
= XFRAME (other_frame
);
11521 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11522 && !FRAME_MINIBUF_ONLY_P (tf
)
11523 && !EQ (other_frame
, tip_frame
)
11524 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11528 /* Set global variable indicating that multiple frames exist. */
11529 multiple_frames
= CONSP (tail
);
11531 /* Switch to the buffer of selected window of the frame. Set up
11532 mode_line_target so that display_mode_element will output into
11533 mode_line_noprop_buf; then display the title. */
11534 record_unwind_protect (unwind_format_mode_line
,
11535 format_mode_line_unwind_data
11536 (f
, current_buffer
, selected_window
, 0));
11538 Fselect_window (f
->selected_window
, Qt
);
11539 set_buffer_internal_1
11540 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11541 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11543 mode_line_target
= MODE_LINE_TITLE
;
11544 title_start
= MODE_LINE_NOPROP_LEN (0);
11545 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11546 NULL
, DEFAULT_FACE_ID
);
11547 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11548 len
= MODE_LINE_NOPROP_LEN (title_start
);
11549 title
= mode_line_noprop_buf
+ title_start
;
11550 unbind_to (count
, Qnil
);
11552 /* Set the title only if it's changed. This avoids consing in
11553 the common case where it hasn't. (If it turns out that we've
11554 already wasted too much time by walking through the list with
11555 display_mode_element, then we might need to optimize at a
11556 higher level than this.) */
11557 if (! STRINGP (f
->name
)
11558 || SBYTES (f
->name
) != len
11559 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11560 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11564 #endif /* not HAVE_WINDOW_SYSTEM */
11567 /***********************************************************************
11569 ***********************************************************************/
11571 /* Non-zero if we will not redisplay all visible windows. */
11572 #define REDISPLAY_SOME_P() \
11573 ((windows_or_buffers_changed == 0 \
11574 || windows_or_buffers_changed == REDISPLAY_SOME) \
11575 && (update_mode_lines == 0 \
11576 || update_mode_lines == REDISPLAY_SOME))
11578 /* Prepare for redisplay by updating menu-bar item lists when
11579 appropriate. This can call eval. */
11582 prepare_menu_bars (void)
11584 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11585 bool some_windows
= REDISPLAY_SOME_P ();
11586 struct gcpro gcpro1
, gcpro2
;
11587 Lisp_Object tooltip_frame
;
11589 #ifdef HAVE_WINDOW_SYSTEM
11590 tooltip_frame
= tip_frame
;
11592 tooltip_frame
= Qnil
;
11595 if (FUNCTIONP (Vpre_redisplay_function
))
11597 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11598 if (all_windows
&& some_windows
)
11600 Lisp_Object ws
= window_list ();
11601 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11603 Lisp_Object
this = XCAR (ws
);
11604 struct window
*w
= XWINDOW (this);
11606 || XFRAME (w
->frame
)->redisplay
11607 || XBUFFER (w
->contents
)->text
->redisplay
)
11609 windows
= Fcons (this, windows
);
11613 safe__call1 (true, Vpre_redisplay_function
, windows
);
11616 /* Update all frame titles based on their buffer names, etc. We do
11617 this before the menu bars so that the buffer-menu will show the
11618 up-to-date frame titles. */
11619 #ifdef HAVE_WINDOW_SYSTEM
11622 Lisp_Object tail
, frame
;
11624 FOR_EACH_FRAME (tail
, frame
)
11626 struct frame
*f
= XFRAME (frame
);
11627 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11631 && !XBUFFER (w
->contents
)->text
->redisplay
)
11634 if (!EQ (frame
, tooltip_frame
)
11635 && (FRAME_ICONIFIED_P (f
)
11636 || FRAME_VISIBLE_P (f
) == 1
11637 /* Exclude TTY frames that are obscured because they
11638 are not the top frame on their console. This is
11639 because x_consider_frame_title actually switches
11640 to the frame, which for TTY frames means it is
11641 marked as garbaged, and will be completely
11642 redrawn on the next redisplay cycle. This causes
11643 TTY frames to be completely redrawn, when there
11644 are more than one of them, even though nothing
11645 should be changed on display. */
11646 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11647 x_consider_frame_title (frame
);
11650 #endif /* HAVE_WINDOW_SYSTEM */
11652 /* Update the menu bar item lists, if appropriate. This has to be
11653 done before any actual redisplay or generation of display lines. */
11657 Lisp_Object tail
, frame
;
11658 ptrdiff_t count
= SPECPDL_INDEX ();
11659 /* 1 means that update_menu_bar has run its hooks
11660 so any further calls to update_menu_bar shouldn't do so again. */
11661 int menu_bar_hooks_run
= 0;
11663 record_unwind_save_match_data ();
11665 FOR_EACH_FRAME (tail
, frame
)
11667 struct frame
*f
= XFRAME (frame
);
11668 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11670 /* Ignore tooltip frame. */
11671 if (EQ (frame
, tooltip_frame
))
11677 && !XBUFFER (w
->contents
)->text
->redisplay
)
11680 /* If a window on this frame changed size, report that to
11681 the user and clear the size-change flag. */
11682 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11684 Lisp_Object functions
;
11686 /* Clear flag first in case we get an error below. */
11687 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11688 functions
= Vwindow_size_change_functions
;
11689 GCPRO2 (tail
, functions
);
11691 while (CONSP (functions
))
11693 if (!EQ (XCAR (functions
), Qt
))
11694 call1 (XCAR (functions
), frame
);
11695 functions
= XCDR (functions
);
11701 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11702 #ifdef HAVE_WINDOW_SYSTEM
11703 update_tool_bar (f
, 0);
11706 if (windows_or_buffers_changed
11709 (f
, Fbuffer_modified_p (XWINDOW (f
->selected_window
)->contents
));
11714 unbind_to (count
, Qnil
);
11718 struct frame
*sf
= SELECTED_FRAME ();
11719 update_menu_bar (sf
, 1, 0);
11720 #ifdef HAVE_WINDOW_SYSTEM
11721 update_tool_bar (sf
, 1);
11727 /* Update the menu bar item list for frame F. This has to be done
11728 before we start to fill in any display lines, because it can call
11731 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11733 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11734 already ran the menu bar hooks for this redisplay, so there
11735 is no need to run them again. The return value is the
11736 updated value of this flag, to pass to the next call. */
11739 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11741 Lisp_Object window
;
11742 register struct window
*w
;
11744 /* If called recursively during a menu update, do nothing. This can
11745 happen when, for instance, an activate-menubar-hook causes a
11747 if (inhibit_menubar_update
)
11750 window
= FRAME_SELECTED_WINDOW (f
);
11751 w
= XWINDOW (window
);
11753 if (FRAME_WINDOW_P (f
)
11755 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11756 || defined (HAVE_NS) || defined (USE_GTK)
11757 FRAME_EXTERNAL_MENU_BAR (f
)
11759 FRAME_MENU_BAR_LINES (f
) > 0
11761 : FRAME_MENU_BAR_LINES (f
) > 0)
11763 /* If the user has switched buffers or windows, we need to
11764 recompute to reflect the new bindings. But we'll
11765 recompute when update_mode_lines is set too; that means
11766 that people can use force-mode-line-update to request
11767 that the menu bar be recomputed. The adverse effect on
11768 the rest of the redisplay algorithm is about the same as
11769 windows_or_buffers_changed anyway. */
11770 if (windows_or_buffers_changed
11771 /* This used to test w->update_mode_line, but we believe
11772 there is no need to recompute the menu in that case. */
11773 || update_mode_lines
11774 || window_buffer_changed (w
))
11776 struct buffer
*prev
= current_buffer
;
11777 ptrdiff_t count
= SPECPDL_INDEX ();
11779 specbind (Qinhibit_menubar_update
, Qt
);
11781 set_buffer_internal_1 (XBUFFER (w
->contents
));
11782 if (save_match_data
)
11783 record_unwind_save_match_data ();
11784 if (NILP (Voverriding_local_map_menu_flag
))
11786 specbind (Qoverriding_terminal_local_map
, Qnil
);
11787 specbind (Qoverriding_local_map
, Qnil
);
11792 /* Run the Lucid hook. */
11793 safe_run_hooks (Qactivate_menubar_hook
);
11795 /* If it has changed current-menubar from previous value,
11796 really recompute the menu-bar from the value. */
11797 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11798 call0 (Qrecompute_lucid_menubar
);
11800 safe_run_hooks (Qmenu_bar_update_hook
);
11805 XSETFRAME (Vmenu_updating_frame
, f
);
11806 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11808 /* Redisplay the menu bar in case we changed it. */
11809 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11810 || defined (HAVE_NS) || defined (USE_GTK)
11811 if (FRAME_WINDOW_P (f
))
11813 #if defined (HAVE_NS)
11814 /* All frames on Mac OS share the same menubar. So only
11815 the selected frame should be allowed to set it. */
11816 if (f
== SELECTED_FRAME ())
11818 set_frame_menubar (f
, 0, 0);
11821 /* On a terminal screen, the menu bar is an ordinary screen
11822 line, and this makes it get updated. */
11823 w
->update_mode_line
= 1;
11824 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11825 /* In the non-toolkit version, the menu bar is an ordinary screen
11826 line, and this makes it get updated. */
11827 w
->update_mode_line
= 1;
11828 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11830 unbind_to (count
, Qnil
);
11831 set_buffer_internal_1 (prev
);
11838 /***********************************************************************
11840 ***********************************************************************/
11842 #ifdef HAVE_WINDOW_SYSTEM
11844 /* Select `frame' temporarily without running all the code in
11846 FIXME: Maybe do_switch_frame should be trimmed down similarly
11847 when `norecord' is set. */
11849 fast_set_selected_frame (Lisp_Object frame
)
11851 if (!EQ (selected_frame
, frame
))
11853 selected_frame
= frame
;
11854 selected_window
= XFRAME (frame
)->selected_window
;
11858 /* Update the tool-bar item list for frame F. This has to be done
11859 before we start to fill in any display lines. Called from
11860 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11861 and restore it here. */
11864 update_tool_bar (struct frame
*f
, int save_match_data
)
11866 #if defined (USE_GTK) || defined (HAVE_NS)
11867 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11869 int do_update
= (WINDOWP (f
->tool_bar_window
)
11870 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0);
11875 Lisp_Object window
;
11878 window
= FRAME_SELECTED_WINDOW (f
);
11879 w
= XWINDOW (window
);
11881 /* If the user has switched buffers or windows, we need to
11882 recompute to reflect the new bindings. But we'll
11883 recompute when update_mode_lines is set too; that means
11884 that people can use force-mode-line-update to request
11885 that the menu bar be recomputed. The adverse effect on
11886 the rest of the redisplay algorithm is about the same as
11887 windows_or_buffers_changed anyway. */
11888 if (windows_or_buffers_changed
11889 || w
->update_mode_line
11890 || update_mode_lines
11891 || window_buffer_changed (w
))
11893 struct buffer
*prev
= current_buffer
;
11894 ptrdiff_t count
= SPECPDL_INDEX ();
11895 Lisp_Object frame
, new_tool_bar
;
11896 int new_n_tool_bar
;
11897 struct gcpro gcpro1
;
11899 /* Set current_buffer to the buffer of the selected
11900 window of the frame, so that we get the right local
11902 set_buffer_internal_1 (XBUFFER (w
->contents
));
11904 /* Save match data, if we must. */
11905 if (save_match_data
)
11906 record_unwind_save_match_data ();
11908 /* Make sure that we don't accidentally use bogus keymaps. */
11909 if (NILP (Voverriding_local_map_menu_flag
))
11911 specbind (Qoverriding_terminal_local_map
, Qnil
);
11912 specbind (Qoverriding_local_map
, Qnil
);
11915 GCPRO1 (new_tool_bar
);
11917 /* We must temporarily set the selected frame to this frame
11918 before calling tool_bar_items, because the calculation of
11919 the tool-bar keymap uses the selected frame (see
11920 `tool-bar-make-keymap' in tool-bar.el). */
11921 eassert (EQ (selected_window
,
11922 /* Since we only explicitly preserve selected_frame,
11923 check that selected_window would be redundant. */
11924 XFRAME (selected_frame
)->selected_window
));
11925 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11926 XSETFRAME (frame
, f
);
11927 fast_set_selected_frame (frame
);
11929 /* Build desired tool-bar items from keymaps. */
11931 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11934 /* Redisplay the tool-bar if we changed it. */
11935 if (new_n_tool_bar
!= f
->n_tool_bar_items
11936 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11938 /* Redisplay that happens asynchronously due to an expose event
11939 may access f->tool_bar_items. Make sure we update both
11940 variables within BLOCK_INPUT so no such event interrupts. */
11942 fset_tool_bar_items (f
, new_tool_bar
);
11943 f
->n_tool_bar_items
= new_n_tool_bar
;
11944 w
->update_mode_line
= 1;
11950 unbind_to (count
, Qnil
);
11951 set_buffer_internal_1 (prev
);
11956 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
11958 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11959 F's desired tool-bar contents. F->tool_bar_items must have
11960 been set up previously by calling prepare_menu_bars. */
11963 build_desired_tool_bar_string (struct frame
*f
)
11965 int i
, size
, size_needed
;
11966 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11967 Lisp_Object image
, plist
, props
;
11969 image
= plist
= props
= Qnil
;
11970 GCPRO3 (image
, plist
, props
);
11972 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11973 Otherwise, make a new string. */
11975 /* The size of the string we might be able to reuse. */
11976 size
= (STRINGP (f
->desired_tool_bar_string
)
11977 ? SCHARS (f
->desired_tool_bar_string
)
11980 /* We need one space in the string for each image. */
11981 size_needed
= f
->n_tool_bar_items
;
11983 /* Reuse f->desired_tool_bar_string, if possible. */
11984 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11985 fset_desired_tool_bar_string
11986 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11989 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11990 Fremove_text_properties (make_number (0), make_number (size
),
11991 props
, f
->desired_tool_bar_string
);
11994 /* Put a `display' property on the string for the images to display,
11995 put a `menu_item' property on tool-bar items with a value that
11996 is the index of the item in F's tool-bar item vector. */
11997 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11999 #define PROP(IDX) \
12000 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12002 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
12003 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
12004 int hmargin
, vmargin
, relief
, idx
, end
;
12006 /* If image is a vector, choose the image according to the
12008 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
12009 if (VECTORP (image
))
12013 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12014 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12017 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12018 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12020 eassert (ASIZE (image
) >= idx
);
12021 image
= AREF (image
, idx
);
12026 /* Ignore invalid image specifications. */
12027 if (!valid_image_p (image
))
12030 /* Display the tool-bar button pressed, or depressed. */
12031 plist
= Fcopy_sequence (XCDR (image
));
12033 /* Compute margin and relief to draw. */
12034 relief
= (tool_bar_button_relief
>= 0
12035 ? tool_bar_button_relief
12036 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12037 hmargin
= vmargin
= relief
;
12039 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12040 INT_MAX
- max (hmargin
, vmargin
)))
12042 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12043 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12045 else if (CONSP (Vtool_bar_button_margin
))
12047 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12048 INT_MAX
- hmargin
))
12049 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12051 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12052 INT_MAX
- vmargin
))
12053 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12056 if (auto_raise_tool_bar_buttons_p
)
12058 /* Add a `:relief' property to the image spec if the item is
12062 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12069 /* If image is selected, display it pressed, i.e. with a
12070 negative relief. If it's not selected, display it with a
12072 plist
= Fplist_put (plist
, QCrelief
,
12074 ? make_number (-relief
)
12075 : make_number (relief
)));
12080 /* Put a margin around the image. */
12081 if (hmargin
|| vmargin
)
12083 if (hmargin
== vmargin
)
12084 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12086 plist
= Fplist_put (plist
, QCmargin
,
12087 Fcons (make_number (hmargin
),
12088 make_number (vmargin
)));
12091 /* If button is not enabled, and we don't have special images
12092 for the disabled state, make the image appear disabled by
12093 applying an appropriate algorithm to it. */
12094 if (!enabled_p
&& idx
< 0)
12095 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12097 /* Put a `display' text property on the string for the image to
12098 display. Put a `menu-item' property on the string that gives
12099 the start of this item's properties in the tool-bar items
12101 image
= Fcons (Qimage
, plist
);
12102 props
= list4 (Qdisplay
, image
,
12103 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12105 /* Let the last image hide all remaining spaces in the tool bar
12106 string. The string can be longer than needed when we reuse a
12107 previous string. */
12108 if (i
+ 1 == f
->n_tool_bar_items
)
12109 end
= SCHARS (f
->desired_tool_bar_string
);
12112 Fadd_text_properties (make_number (i
), make_number (end
),
12113 props
, f
->desired_tool_bar_string
);
12121 /* Display one line of the tool-bar of frame IT->f.
12123 HEIGHT specifies the desired height of the tool-bar line.
12124 If the actual height of the glyph row is less than HEIGHT, the
12125 row's height is increased to HEIGHT, and the icons are centered
12126 vertically in the new height.
12128 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12129 count a final empty row in case the tool-bar width exactly matches
12134 display_tool_bar_line (struct it
*it
, int height
)
12136 struct glyph_row
*row
= it
->glyph_row
;
12137 int max_x
= it
->last_visible_x
;
12138 struct glyph
*last
;
12140 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12141 clear_glyph_row (row
);
12142 row
->enabled_p
= true;
12143 row
->y
= it
->current_y
;
12145 /* Note that this isn't made use of if the face hasn't a box,
12146 so there's no need to check the face here. */
12147 it
->start_of_box_run_p
= 1;
12149 while (it
->current_x
< max_x
)
12151 int x
, n_glyphs_before
, i
, nglyphs
;
12152 struct it it_before
;
12154 /* Get the next display element. */
12155 if (!get_next_display_element (it
))
12157 /* Don't count empty row if we are counting needed tool-bar lines. */
12158 if (height
< 0 && !it
->hpos
)
12163 /* Produce glyphs. */
12164 n_glyphs_before
= row
->used
[TEXT_AREA
];
12167 PRODUCE_GLYPHS (it
);
12169 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12171 x
= it_before
.current_x
;
12172 while (i
< nglyphs
)
12174 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12176 if (x
+ glyph
->pixel_width
> max_x
)
12178 /* Glyph doesn't fit on line. Backtrack. */
12179 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12181 /* If this is the only glyph on this line, it will never fit on the
12182 tool-bar, so skip it. But ensure there is at least one glyph,
12183 so we don't accidentally disable the tool-bar. */
12184 if (n_glyphs_before
== 0
12185 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12191 x
+= glyph
->pixel_width
;
12195 /* Stop at line end. */
12196 if (ITERATOR_AT_END_OF_LINE_P (it
))
12199 set_iterator_to_next (it
, 1);
12204 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12206 /* Use default face for the border below the tool bar.
12208 FIXME: When auto-resize-tool-bars is grow-only, there is
12209 no additional border below the possibly empty tool-bar lines.
12210 So to make the extra empty lines look "normal", we have to
12211 use the tool-bar face for the border too. */
12212 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12213 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12214 it
->face_id
= DEFAULT_FACE_ID
;
12216 extend_face_to_end_of_line (it
);
12217 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12218 last
->right_box_line_p
= 1;
12219 if (last
== row
->glyphs
[TEXT_AREA
])
12220 last
->left_box_line_p
= 1;
12222 /* Make line the desired height and center it vertically. */
12223 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12225 /* Don't add more than one line height. */
12226 height
%= FRAME_LINE_HEIGHT (it
->f
);
12227 it
->max_ascent
+= height
/ 2;
12228 it
->max_descent
+= (height
+ 1) / 2;
12231 compute_line_metrics (it
);
12233 /* If line is empty, make it occupy the rest of the tool-bar. */
12234 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12236 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12237 row
->visible_height
= row
->height
;
12238 row
->ascent
= row
->phys_ascent
= 0;
12239 row
->extra_line_spacing
= 0;
12242 row
->full_width_p
= 1;
12243 row
->continued_p
= 0;
12244 row
->truncated_on_left_p
= 0;
12245 row
->truncated_on_right_p
= 0;
12247 it
->current_x
= it
->hpos
= 0;
12248 it
->current_y
+= row
->height
;
12254 /* Max tool-bar height. Basically, this is what makes all other windows
12255 disappear when the frame gets too small. Rethink this! */
12257 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
12258 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
12260 /* Value is the number of pixels needed to make all tool-bar items of
12261 frame F visible. The actual number of glyph rows needed is
12262 returned in *N_ROWS if non-NULL. */
12265 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12267 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12269 /* tool_bar_height is called from redisplay_tool_bar after building
12270 the desired matrix, so use (unused) mode-line row as temporary row to
12271 avoid destroying the first tool-bar row. */
12272 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12274 /* Initialize an iterator for iteration over
12275 F->desired_tool_bar_string in the tool-bar window of frame F. */
12276 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12277 it
.first_visible_x
= 0;
12278 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12279 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12280 it
.paragraph_embedding
= L2R
;
12282 while (!ITERATOR_AT_END_P (&it
))
12284 clear_glyph_row (temp_row
);
12285 it
.glyph_row
= temp_row
;
12286 display_tool_bar_line (&it
, -1);
12288 clear_glyph_row (temp_row
);
12290 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12292 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12295 return it
.current_y
;
12297 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12300 #endif /* !USE_GTK && !HAVE_NS */
12302 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12304 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12305 If FRAME is nil or omitted, use the selected frame. Optional argument
12306 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12307 (Lisp_Object frame
, Lisp_Object pixelwise
)
12311 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12312 struct frame
*f
= decode_any_frame (frame
);
12314 if (WINDOWP (f
->tool_bar_window
)
12315 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12317 update_tool_bar (f
, 1);
12318 if (f
->n_tool_bar_items
)
12320 build_desired_tool_bar_string (f
);
12321 height
= tool_bar_height (f
, NULL
, NILP (pixelwise
) ? 0 : 1);
12326 return make_number (height
);
12330 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
12331 height should be changed. */
12334 redisplay_tool_bar (struct frame
*f
)
12336 #if defined (USE_GTK) || defined (HAVE_NS)
12338 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12339 update_frame_tool_bar (f
);
12342 #else /* !USE_GTK && !HAVE_NS */
12346 struct glyph_row
*row
;
12348 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12349 do anything. This means you must start with tool-bar-lines
12350 non-zero to get the auto-sizing effect. Or in other words, you
12351 can turn off tool-bars by specifying tool-bar-lines zero. */
12352 if (!WINDOWP (f
->tool_bar_window
)
12353 || (w
= XWINDOW (f
->tool_bar_window
),
12354 WINDOW_PIXEL_HEIGHT (w
) == 0))
12357 /* Set up an iterator for the tool-bar window. */
12358 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12359 it
.first_visible_x
= 0;
12360 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12361 row
= it
.glyph_row
;
12363 /* Build a string that represents the contents of the tool-bar. */
12364 build_desired_tool_bar_string (f
);
12365 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12366 /* FIXME: This should be controlled by a user option. But it
12367 doesn't make sense to have an R2L tool bar if the menu bar cannot
12368 be drawn also R2L, and making the menu bar R2L is tricky due
12369 toolkit-specific code that implements it. If an R2L tool bar is
12370 ever supported, display_tool_bar_line should also be augmented to
12371 call unproduce_glyphs like display_line and display_string
12373 it
.paragraph_embedding
= L2R
;
12375 if (f
->n_tool_bar_rows
== 0)
12377 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, 1);
12379 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12382 int new_lines
= ((new_height
+ FRAME_LINE_HEIGHT (f
) - 1)
12383 / FRAME_LINE_HEIGHT (f
));
12385 XSETFRAME (frame
, f
);
12386 Fmodify_frame_parameters (frame
,
12387 list1 (Fcons (Qtool_bar_lines
,
12388 make_number (new_lines
))));
12389 /* Always do that now. */
12390 clear_glyph_matrix (w
->desired_matrix
);
12391 f
->fonts_changed
= 1;
12396 /* Display as many lines as needed to display all tool-bar items. */
12398 if (f
->n_tool_bar_rows
> 0)
12400 int border
, rows
, height
, extra
;
12402 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12403 border
= XINT (Vtool_bar_border
);
12404 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12405 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12406 else if (EQ (Vtool_bar_border
, Qborder_width
))
12407 border
= f
->border_width
;
12413 rows
= f
->n_tool_bar_rows
;
12414 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12415 extra
= it
.last_visible_y
- border
- height
* rows
;
12417 while (it
.current_y
< it
.last_visible_y
)
12420 if (extra
> 0 && rows
-- > 0)
12422 h
= (extra
+ rows
- 1) / rows
;
12425 display_tool_bar_line (&it
, height
+ h
);
12430 while (it
.current_y
< it
.last_visible_y
)
12431 display_tool_bar_line (&it
, 0);
12434 /* It doesn't make much sense to try scrolling in the tool-bar
12435 window, so don't do it. */
12436 w
->desired_matrix
->no_scrolling_p
= 1;
12437 w
->must_be_updated_p
= 1;
12439 if (!NILP (Vauto_resize_tool_bars
))
12441 /* Do we really allow the toolbar to occupy the whole frame? */
12442 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
12443 int change_height_p
= 0;
12445 /* If we couldn't display everything, change the tool-bar's
12446 height if there is room for more. */
12447 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
12448 && it
.current_y
< max_tool_bar_height
)
12449 change_height_p
= 1;
12451 /* We subtract 1 because display_tool_bar_line advances the
12452 glyph_row pointer before returning to its caller. We want to
12453 examine the last glyph row produced by
12454 display_tool_bar_line. */
12455 row
= it
.glyph_row
- 1;
12457 /* If there are blank lines at the end, except for a partially
12458 visible blank line at the end that is smaller than
12459 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12460 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12461 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12462 change_height_p
= 1;
12464 /* If row displays tool-bar items, but is partially visible,
12465 change the tool-bar's height. */
12466 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12467 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
12468 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
12469 change_height_p
= 1;
12471 /* Resize windows as needed by changing the `tool-bar-lines'
12472 frame parameter. */
12473 if (change_height_p
)
12477 int new_height
= tool_bar_height (f
, &nrows
, 1);
12479 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12480 && !f
->minimize_tool_bar_window_p
)
12481 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12482 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12483 f
->minimize_tool_bar_window_p
= 0;
12485 if (change_height_p
)
12487 /* Current size of the tool-bar window in canonical line
12489 int old_lines
= WINDOW_TOTAL_LINES (w
);
12490 /* Required size of the tool-bar window in canonical
12492 int new_lines
= ((new_height
+ FRAME_LINE_HEIGHT (f
) - 1)
12493 / FRAME_LINE_HEIGHT (f
));
12494 /* Maximum size of the tool-bar window in canonical line
12495 units that this frame can allow. */
12497 WINDOW_TOTAL_LINES (XWINDOW (FRAME_ROOT_WINDOW (f
))) - 1;
12499 /* Don't try to change the tool-bar window size and set
12500 the fonts_changed flag unless really necessary. That
12501 flag causes redisplay to give up and retry
12502 redisplaying the frame from scratch, so setting it
12503 unnecessarily can lead to nasty redisplay loops. */
12504 if (new_lines
<= max_lines
12505 && eabs (new_lines
- old_lines
) >= 1)
12507 XSETFRAME (frame
, f
);
12508 Fmodify_frame_parameters (frame
,
12509 list1 (Fcons (Qtool_bar_lines
,
12510 make_number (new_lines
))));
12511 clear_glyph_matrix (w
->desired_matrix
);
12512 f
->n_tool_bar_rows
= nrows
;
12513 f
->fonts_changed
= 1;
12520 f
->minimize_tool_bar_window_p
= 0;
12523 #endif /* USE_GTK || HAVE_NS */
12526 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12528 /* Get information about the tool-bar item which is displayed in GLYPH
12529 on frame F. Return in *PROP_IDX the index where tool-bar item
12530 properties start in F->tool_bar_items. Value is zero if
12531 GLYPH doesn't display a tool-bar item. */
12534 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12540 /* This function can be called asynchronously, which means we must
12541 exclude any possibility that Fget_text_property signals an
12543 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12544 charpos
= max (0, charpos
);
12546 /* Get the text property `menu-item' at pos. The value of that
12547 property is the start index of this item's properties in
12548 F->tool_bar_items. */
12549 prop
= Fget_text_property (make_number (charpos
),
12550 Qmenu_item
, f
->current_tool_bar_string
);
12551 if (INTEGERP (prop
))
12553 *prop_idx
= XINT (prop
);
12563 /* Get information about the tool-bar item at position X/Y on frame F.
12564 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12565 the current matrix of the tool-bar window of F, or NULL if not
12566 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12567 item in F->tool_bar_items. Value is
12569 -1 if X/Y is not on a tool-bar item
12570 0 if X/Y is on the same item that was highlighted before.
12574 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12575 int *hpos
, int *vpos
, int *prop_idx
)
12577 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12578 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12581 /* Find the glyph under X/Y. */
12582 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12583 if (*glyph
== NULL
)
12586 /* Get the start of this tool-bar item's properties in
12587 f->tool_bar_items. */
12588 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12591 /* Is mouse on the highlighted item? */
12592 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12593 && *vpos
>= hlinfo
->mouse_face_beg_row
12594 && *vpos
<= hlinfo
->mouse_face_end_row
12595 && (*vpos
> hlinfo
->mouse_face_beg_row
12596 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12597 && (*vpos
< hlinfo
->mouse_face_end_row
12598 || *hpos
< hlinfo
->mouse_face_end_col
12599 || hlinfo
->mouse_face_past_end
))
12607 Handle mouse button event on the tool-bar of frame F, at
12608 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12609 0 for button release. MODIFIERS is event modifiers for button
12613 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12616 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12617 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12618 int hpos
, vpos
, prop_idx
;
12619 struct glyph
*glyph
;
12620 Lisp_Object enabled_p
;
12623 /* If not on the highlighted tool-bar item, and mouse-highlight is
12624 non-nil, return. This is so we generate the tool-bar button
12625 click only when the mouse button is released on the same item as
12626 where it was pressed. However, when mouse-highlight is disabled,
12627 generate the click when the button is released regardless of the
12628 highlight, since tool-bar items are not highlighted in that
12630 frame_to_window_pixel_xy (w
, &x
, &y
);
12631 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12633 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12636 /* When mouse-highlight is off, generate the click for the item
12637 where the button was pressed, disregarding where it was
12639 if (NILP (Vmouse_highlight
) && !down_p
)
12640 prop_idx
= f
->last_tool_bar_item
;
12642 /* If item is disabled, do nothing. */
12643 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12644 if (NILP (enabled_p
))
12649 /* Show item in pressed state. */
12650 if (!NILP (Vmouse_highlight
))
12651 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12652 f
->last_tool_bar_item
= prop_idx
;
12656 Lisp_Object key
, frame
;
12657 struct input_event event
;
12658 EVENT_INIT (event
);
12660 /* Show item in released state. */
12661 if (!NILP (Vmouse_highlight
))
12662 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12664 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12666 XSETFRAME (frame
, f
);
12667 event
.kind
= TOOL_BAR_EVENT
;
12668 event
.frame_or_window
= frame
;
12670 kbd_buffer_store_event (&event
);
12672 event
.kind
= TOOL_BAR_EVENT
;
12673 event
.frame_or_window
= frame
;
12675 event
.modifiers
= modifiers
;
12676 kbd_buffer_store_event (&event
);
12677 f
->last_tool_bar_item
= -1;
12682 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12683 tool-bar window-relative coordinates X/Y. Called from
12684 note_mouse_highlight. */
12687 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12689 Lisp_Object window
= f
->tool_bar_window
;
12690 struct window
*w
= XWINDOW (window
);
12691 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12692 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12694 struct glyph
*glyph
;
12695 struct glyph_row
*row
;
12697 Lisp_Object enabled_p
;
12699 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12700 int mouse_down_p
, rc
;
12702 /* Function note_mouse_highlight is called with negative X/Y
12703 values when mouse moves outside of the frame. */
12704 if (x
<= 0 || y
<= 0)
12706 clear_mouse_face (hlinfo
);
12710 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12713 /* Not on tool-bar item. */
12714 clear_mouse_face (hlinfo
);
12718 /* On same tool-bar item as before. */
12719 goto set_help_echo
;
12721 clear_mouse_face (hlinfo
);
12723 /* Mouse is down, but on different tool-bar item? */
12724 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12725 && f
== dpyinfo
->last_mouse_frame
);
12727 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12730 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12732 /* If tool-bar item is not enabled, don't highlight it. */
12733 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12734 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12736 /* Compute the x-position of the glyph. In front and past the
12737 image is a space. We include this in the highlighted area. */
12738 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12739 for (i
= x
= 0; i
< hpos
; ++i
)
12740 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12742 /* Record this as the current active region. */
12743 hlinfo
->mouse_face_beg_col
= hpos
;
12744 hlinfo
->mouse_face_beg_row
= vpos
;
12745 hlinfo
->mouse_face_beg_x
= x
;
12746 hlinfo
->mouse_face_past_end
= 0;
12748 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12749 hlinfo
->mouse_face_end_row
= vpos
;
12750 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12751 hlinfo
->mouse_face_window
= window
;
12752 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12754 /* Display it as active. */
12755 show_mouse_face (hlinfo
, draw
);
12760 /* Set help_echo_string to a help string to display for this tool-bar item.
12761 XTread_socket does the rest. */
12762 help_echo_object
= help_echo_window
= Qnil
;
12763 help_echo_pos
= -1;
12764 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12765 if (NILP (help_echo_string
))
12766 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12769 #endif /* !USE_GTK && !HAVE_NS */
12771 #endif /* HAVE_WINDOW_SYSTEM */
12775 /************************************************************************
12776 Horizontal scrolling
12777 ************************************************************************/
12779 static int hscroll_window_tree (Lisp_Object
);
12780 static int hscroll_windows (Lisp_Object
);
12782 /* For all leaf windows in the window tree rooted at WINDOW, set their
12783 hscroll value so that PT is (i) visible in the window, and (ii) so
12784 that it is not within a certain margin at the window's left and
12785 right border. Value is non-zero if any window's hscroll has been
12789 hscroll_window_tree (Lisp_Object window
)
12791 int hscrolled_p
= 0;
12792 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12793 int hscroll_step_abs
= 0;
12794 double hscroll_step_rel
= 0;
12796 if (hscroll_relative_p
)
12798 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12799 if (hscroll_step_rel
< 0)
12801 hscroll_relative_p
= 0;
12802 hscroll_step_abs
= 0;
12805 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12807 hscroll_step_abs
= XINT (Vhscroll_step
);
12808 if (hscroll_step_abs
< 0)
12809 hscroll_step_abs
= 0;
12812 hscroll_step_abs
= 0;
12814 while (WINDOWP (window
))
12816 struct window
*w
= XWINDOW (window
);
12818 if (WINDOWP (w
->contents
))
12819 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12820 else if (w
->cursor
.vpos
>= 0)
12823 int text_area_width
;
12824 struct glyph_row
*cursor_row
;
12825 struct glyph_row
*bottom_row
;
12828 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12829 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12830 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12832 cursor_row
= bottom_row
- 1;
12834 if (!cursor_row
->enabled_p
)
12836 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12837 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12838 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12840 cursor_row
= bottom_row
- 1;
12842 row_r2l_p
= cursor_row
->reversed_p
;
12844 text_area_width
= window_box_width (w
, TEXT_AREA
);
12846 /* Scroll when cursor is inside this scroll margin. */
12847 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12849 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12850 /* For left-to-right rows, hscroll when cursor is either
12851 (i) inside the right hscroll margin, or (ii) if it is
12852 inside the left margin and the window is already
12856 && w
->cursor
.x
<= h_margin
)
12857 || (cursor_row
->enabled_p
12858 && cursor_row
->truncated_on_right_p
12859 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12860 /* For right-to-left rows, the logic is similar,
12861 except that rules for scrolling to left and right
12862 are reversed. E.g., if cursor.x <= h_margin, we
12863 need to hscroll "to the right" unconditionally,
12864 and that will scroll the screen to the left so as
12865 to reveal the next portion of the row. */
12867 && ((cursor_row
->enabled_p
12868 /* FIXME: It is confusing to set the
12869 truncated_on_right_p flag when R2L rows
12870 are actually truncated on the left. */
12871 && cursor_row
->truncated_on_right_p
12872 && w
->cursor
.x
<= h_margin
)
12874 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12878 struct buffer
*saved_current_buffer
;
12882 /* Find point in a display of infinite width. */
12883 saved_current_buffer
= current_buffer
;
12884 current_buffer
= XBUFFER (w
->contents
);
12886 if (w
== XWINDOW (selected_window
))
12889 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12891 /* Move iterator to pt starting at cursor_row->start in
12892 a line with infinite width. */
12893 init_to_row_start (&it
, w
, cursor_row
);
12894 it
.last_visible_x
= INFINITY
;
12895 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12896 current_buffer
= saved_current_buffer
;
12898 /* Position cursor in window. */
12899 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12900 hscroll
= max (0, (it
.current_x
12901 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12902 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12903 : (text_area_width
/ 2))))
12904 / FRAME_COLUMN_WIDTH (it
.f
);
12905 else if ((!row_r2l_p
12906 && w
->cursor
.x
>= text_area_width
- h_margin
)
12907 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12909 if (hscroll_relative_p
)
12910 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12913 wanted_x
= text_area_width
12914 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12917 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12921 if (hscroll_relative_p
)
12922 wanted_x
= text_area_width
* hscroll_step_rel
12925 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12928 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12930 hscroll
= max (hscroll
, w
->min_hscroll
);
12932 /* Don't prevent redisplay optimizations if hscroll
12933 hasn't changed, as it will unnecessarily slow down
12935 if (w
->hscroll
!= hscroll
)
12937 XBUFFER (w
->contents
)->prevent_redisplay_optimizations_p
= 1;
12938 w
->hscroll
= hscroll
;
12947 /* Value is non-zero if hscroll of any leaf window has been changed. */
12948 return hscrolled_p
;
12952 /* Set hscroll so that cursor is visible and not inside horizontal
12953 scroll margins for all windows in the tree rooted at WINDOW. See
12954 also hscroll_window_tree above. Value is non-zero if any window's
12955 hscroll has been changed. If it has, desired matrices on the frame
12956 of WINDOW are cleared. */
12959 hscroll_windows (Lisp_Object window
)
12961 int hscrolled_p
= hscroll_window_tree (window
);
12963 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12964 return hscrolled_p
;
12969 /************************************************************************
12971 ************************************************************************/
12973 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12974 to a non-zero value. This is sometimes handy to have in a debugger
12979 /* First and last unchanged row for try_window_id. */
12981 static int debug_first_unchanged_at_end_vpos
;
12982 static int debug_last_unchanged_at_beg_vpos
;
12984 /* Delta vpos and y. */
12986 static int debug_dvpos
, debug_dy
;
12988 /* Delta in characters and bytes for try_window_id. */
12990 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12992 /* Values of window_end_pos and window_end_vpos at the end of
12995 static ptrdiff_t debug_end_vpos
;
12997 /* Append a string to W->desired_matrix->method. FMT is a printf
12998 format string. If trace_redisplay_p is true also printf the
12999 resulting string to stderr. */
13001 static void debug_method_add (struct window
*, char const *, ...)
13002 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13005 debug_method_add (struct window
*w
, char const *fmt
, ...)
13008 char *method
= w
->desired_matrix
->method
;
13009 int len
= strlen (method
);
13010 int size
= sizeof w
->desired_matrix
->method
;
13011 int remaining
= size
- len
- 1;
13014 if (len
&& remaining
)
13017 --remaining
, ++len
;
13020 va_start (ap
, fmt
);
13021 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13024 if (trace_redisplay_p
)
13025 fprintf (stderr
, "%p (%s): %s\n",
13027 ((BUFFERP (w
->contents
)
13028 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13029 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13034 #endif /* GLYPH_DEBUG */
13037 /* Value is non-zero if all changes in window W, which displays
13038 current_buffer, are in the text between START and END. START is a
13039 buffer position, END is given as a distance from Z. Used in
13040 redisplay_internal for display optimization. */
13043 text_outside_line_unchanged_p (struct window
*w
,
13044 ptrdiff_t start
, ptrdiff_t end
)
13046 int unchanged_p
= 1;
13048 /* If text or overlays have changed, see where. */
13049 if (window_outdated (w
))
13051 /* Gap in the line? */
13052 if (GPT
< start
|| Z
- GPT
< end
)
13055 /* Changes start in front of the line, or end after it? */
13057 && (BEG_UNCHANGED
< start
- 1
13058 || END_UNCHANGED
< end
))
13061 /* If selective display, can't optimize if changes start at the
13062 beginning of the line. */
13064 && INTEGERP (BVAR (current_buffer
, selective_display
))
13065 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13066 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13069 /* If there are overlays at the start or end of the line, these
13070 may have overlay strings with newlines in them. A change at
13071 START, for instance, may actually concern the display of such
13072 overlay strings as well, and they are displayed on different
13073 lines. So, quickly rule out this case. (For the future, it
13074 might be desirable to implement something more telling than
13075 just BEG/END_UNCHANGED.) */
13078 if (BEG
+ BEG_UNCHANGED
== start
13079 && overlay_touches_p (start
))
13081 if (END_UNCHANGED
== end
13082 && overlay_touches_p (Z
- end
))
13086 /* Under bidi reordering, adding or deleting a character in the
13087 beginning of a paragraph, before the first strong directional
13088 character, can change the base direction of the paragraph (unless
13089 the buffer specifies a fixed paragraph direction), which will
13090 require to redisplay the whole paragraph. It might be worthwhile
13091 to find the paragraph limits and widen the range of redisplayed
13092 lines to that, but for now just give up this optimization. */
13093 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13094 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13098 return unchanged_p
;
13102 /* Do a frame update, taking possible shortcuts into account. This is
13103 the main external entry point for redisplay.
13105 If the last redisplay displayed an echo area message and that message
13106 is no longer requested, we clear the echo area or bring back the
13107 mini-buffer if that is in use. */
13112 redisplay_internal ();
13117 overlay_arrow_string_or_property (Lisp_Object var
)
13121 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13124 return Voverlay_arrow_string
;
13127 /* Return 1 if there are any overlay-arrows in current_buffer. */
13129 overlay_arrow_in_current_buffer_p (void)
13133 for (vlist
= Voverlay_arrow_variable_list
;
13135 vlist
= XCDR (vlist
))
13137 Lisp_Object var
= XCAR (vlist
);
13140 if (!SYMBOLP (var
))
13142 val
= find_symbol_value (var
);
13144 && current_buffer
== XMARKER (val
)->buffer
)
13151 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
13155 overlay_arrows_changed_p (void)
13159 for (vlist
= Voverlay_arrow_variable_list
;
13161 vlist
= XCDR (vlist
))
13163 Lisp_Object var
= XCAR (vlist
);
13164 Lisp_Object val
, pstr
;
13166 if (!SYMBOLP (var
))
13168 val
= find_symbol_value (var
);
13169 if (!MARKERP (val
))
13171 if (! EQ (COERCE_MARKER (val
),
13172 Fget (var
, Qlast_arrow_position
))
13173 || ! (pstr
= overlay_arrow_string_or_property (var
),
13174 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13180 /* Mark overlay arrows to be updated on next redisplay. */
13183 update_overlay_arrows (int up_to_date
)
13187 for (vlist
= Voverlay_arrow_variable_list
;
13189 vlist
= XCDR (vlist
))
13191 Lisp_Object var
= XCAR (vlist
);
13193 if (!SYMBOLP (var
))
13196 if (up_to_date
> 0)
13198 Lisp_Object val
= find_symbol_value (var
);
13199 Fput (var
, Qlast_arrow_position
,
13200 COERCE_MARKER (val
));
13201 Fput (var
, Qlast_arrow_string
,
13202 overlay_arrow_string_or_property (var
));
13204 else if (up_to_date
< 0
13205 || !NILP (Fget (var
, Qlast_arrow_position
)))
13207 Fput (var
, Qlast_arrow_position
, Qt
);
13208 Fput (var
, Qlast_arrow_string
, Qt
);
13214 /* Return overlay arrow string to display at row.
13215 Return integer (bitmap number) for arrow bitmap in left fringe.
13216 Return nil if no overlay arrow. */
13219 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13223 for (vlist
= Voverlay_arrow_variable_list
;
13225 vlist
= XCDR (vlist
))
13227 Lisp_Object var
= XCAR (vlist
);
13230 if (!SYMBOLP (var
))
13233 val
= find_symbol_value (var
);
13236 && current_buffer
== XMARKER (val
)->buffer
13237 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13239 if (FRAME_WINDOW_P (it
->f
)
13240 /* FIXME: if ROW->reversed_p is set, this should test
13241 the right fringe, not the left one. */
13242 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13244 #ifdef HAVE_WINDOW_SYSTEM
13245 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13248 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
13249 return make_number (fringe_bitmap
);
13252 return make_number (-1); /* Use default arrow bitmap. */
13254 return overlay_arrow_string_or_property (var
);
13261 /* Return 1 if point moved out of or into a composition. Otherwise
13262 return 0. PREV_BUF and PREV_PT are the last point buffer and
13263 position. BUF and PT are the current point buffer and position. */
13266 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13267 struct buffer
*buf
, ptrdiff_t pt
)
13269 ptrdiff_t start
, end
;
13271 Lisp_Object buffer
;
13273 XSETBUFFER (buffer
, buf
);
13274 /* Check a composition at the last point if point moved within the
13276 if (prev_buf
== buf
)
13279 /* Point didn't move. */
13282 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13283 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13284 && composition_valid_p (start
, end
, prop
)
13285 && start
< prev_pt
&& end
> prev_pt
)
13286 /* The last point was within the composition. Return 1 iff
13287 point moved out of the composition. */
13288 return (pt
<= start
|| pt
>= end
);
13291 /* Check a composition at the current point. */
13292 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13293 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13294 && composition_valid_p (start
, end
, prop
)
13295 && start
< pt
&& end
> pt
);
13298 /* Reconsider the clip changes of buffer which is displayed in W. */
13301 reconsider_clip_changes (struct window
*w
)
13303 struct buffer
*b
= XBUFFER (w
->contents
);
13305 if (b
->clip_changed
13306 && w
->window_end_valid
13307 && w
->current_matrix
->buffer
== b
13308 && w
->current_matrix
->zv
== BUF_ZV (b
)
13309 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13310 b
->clip_changed
= 0;
13312 /* If display wasn't paused, and W is not a tool bar window, see if
13313 point has been moved into or out of a composition. In that case,
13314 we set b->clip_changed to 1 to force updating the screen. If
13315 b->clip_changed has already been set to 1, we can skip this
13317 if (!b
->clip_changed
&& w
->window_end_valid
)
13319 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13320 ? PT
: marker_position (w
->pointm
));
13322 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13323 && check_point_in_composition (w
->current_matrix
->buffer
,
13324 w
->last_point
, b
, pt
))
13325 b
->clip_changed
= 1;
13330 propagate_buffer_redisplay (void)
13331 { /* Resetting b->text->redisplay is problematic!
13332 We can't just reset it in the case that some window that displays
13333 it has not been redisplayed; and such a window can stay
13334 unredisplayed for a long time if it's currently invisible.
13335 But we do want to reset it at the end of redisplay otherwise
13336 its displayed windows will keep being redisplayed over and over
13338 So we copy all b->text->redisplay flags up to their windows here,
13339 such that mark_window_display_accurate can safely reset
13340 b->text->redisplay. */
13341 Lisp_Object ws
= window_list ();
13342 for (; CONSP (ws
); ws
= XCDR (ws
))
13344 struct window
*thisw
= XWINDOW (XCAR (ws
));
13345 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13346 if (thisb
->text
->redisplay
)
13347 thisw
->redisplay
= true;
13351 #define STOP_POLLING \
13352 do { if (! polling_stopped_here) stop_polling (); \
13353 polling_stopped_here = 1; } while (0)
13355 #define RESUME_POLLING \
13356 do { if (polling_stopped_here) start_polling (); \
13357 polling_stopped_here = 0; } while (0)
13360 /* Perhaps in the future avoid recentering windows if it
13361 is not necessary; currently that causes some problems. */
13364 redisplay_internal (void)
13366 struct window
*w
= XWINDOW (selected_window
);
13370 bool must_finish
= 0, match_p
;
13371 struct text_pos tlbufpos
, tlendpos
;
13372 int number_of_visible_frames
;
13375 int polling_stopped_here
= 0;
13376 Lisp_Object tail
, frame
;
13378 /* True means redisplay has to consider all windows on all
13379 frames. False, only selected_window is considered. */
13380 bool consider_all_windows_p
;
13382 /* True means redisplay has to redisplay the miniwindow. */
13383 bool update_miniwindow_p
= false;
13385 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13387 /* No redisplay if running in batch mode or frame is not yet fully
13388 initialized, or redisplay is explicitly turned off by setting
13389 Vinhibit_redisplay. */
13390 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13391 || !NILP (Vinhibit_redisplay
))
13394 /* Don't examine these until after testing Vinhibit_redisplay.
13395 When Emacs is shutting down, perhaps because its connection to
13396 X has dropped, we should not look at them at all. */
13397 fr
= XFRAME (w
->frame
);
13398 sf
= SELECTED_FRAME ();
13400 if (!fr
->glyphs_initialized_p
)
13403 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13404 if (popup_activated ())
13408 /* I don't think this happens but let's be paranoid. */
13409 if (redisplaying_p
)
13412 /* Record a function that clears redisplaying_p
13413 when we leave this function. */
13414 count
= SPECPDL_INDEX ();
13415 record_unwind_protect_void (unwind_redisplay
);
13416 redisplaying_p
= 1;
13417 specbind (Qinhibit_free_realized_faces
, Qnil
);
13419 /* Record this function, so it appears on the profiler's backtraces. */
13420 record_in_backtrace (Qredisplay_internal
, &Qnil
, 0);
13422 FOR_EACH_FRAME (tail
, frame
)
13423 XFRAME (frame
)->already_hscrolled_p
= 0;
13426 /* Remember the currently selected window. */
13430 last_escape_glyph_frame
= NULL
;
13431 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13432 last_glyphless_glyph_frame
= NULL
;
13433 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13435 /* If face_change_count is non-zero, init_iterator will free all
13436 realized faces, which includes the faces referenced from current
13437 matrices. So, we can't reuse current matrices in this case. */
13438 if (face_change_count
)
13439 windows_or_buffers_changed
= 47;
13441 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13442 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13444 /* Since frames on a single ASCII terminal share the same
13445 display area, displaying a different frame means redisplay
13446 the whole thing. */
13447 SET_FRAME_GARBAGED (sf
);
13449 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13451 FRAME_TTY (sf
)->previous_frame
= sf
;
13454 /* Set the visible flags for all frames. Do this before checking for
13455 resized or garbaged frames; they want to know if their frames are
13456 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13457 number_of_visible_frames
= 0;
13459 FOR_EACH_FRAME (tail
, frame
)
13461 struct frame
*f
= XFRAME (frame
);
13463 if (FRAME_VISIBLE_P (f
))
13465 ++number_of_visible_frames
;
13466 /* Adjust matrices for visible frames only. */
13467 if (f
->fonts_changed
)
13469 adjust_frame_glyphs (f
);
13470 f
->fonts_changed
= 0;
13472 /* If cursor type has been changed on the frame
13473 other than selected, consider all frames. */
13474 if (f
!= sf
&& f
->cursor_type_changed
)
13475 update_mode_lines
= 31;
13477 clear_desired_matrices (f
);
13480 /* Notice any pending interrupt request to change frame size. */
13481 do_pending_window_change (1);
13483 /* do_pending_window_change could change the selected_window due to
13484 frame resizing which makes the selected window too small. */
13485 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13488 /* Clear frames marked as garbaged. */
13489 clear_garbaged_frames ();
13491 /* Build menubar and tool-bar items. */
13492 if (NILP (Vmemory_full
))
13493 prepare_menu_bars ();
13495 reconsider_clip_changes (w
);
13497 /* In most cases selected window displays current buffer. */
13498 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13501 /* Detect case that we need to write or remove a star in the mode line. */
13502 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13503 w
->update_mode_line
= 1;
13505 if (mode_line_update_needed (w
))
13506 w
->update_mode_line
= 1;
13509 /* Normally the message* functions will have already displayed and
13510 updated the echo area, but the frame may have been trashed, or
13511 the update may have been preempted, so display the echo area
13512 again here. Checking message_cleared_p captures the case that
13513 the echo area should be cleared. */
13514 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13515 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13516 || (message_cleared_p
13517 && minibuf_level
== 0
13518 /* If the mini-window is currently selected, this means the
13519 echo-area doesn't show through. */
13520 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13522 int window_height_changed_p
= echo_area_display (0);
13524 if (message_cleared_p
)
13525 update_miniwindow_p
= true;
13529 /* If we don't display the current message, don't clear the
13530 message_cleared_p flag, because, if we did, we wouldn't clear
13531 the echo area in the next redisplay which doesn't preserve
13533 if (!display_last_displayed_message_p
)
13534 message_cleared_p
= 0;
13536 if (window_height_changed_p
)
13538 windows_or_buffers_changed
= 50;
13540 /* If window configuration was changed, frames may have been
13541 marked garbaged. Clear them or we will experience
13542 surprises wrt scrolling. */
13543 clear_garbaged_frames ();
13546 else if (EQ (selected_window
, minibuf_window
)
13547 && (current_buffer
->clip_changed
|| window_outdated (w
))
13548 && resize_mini_window (w
, 0))
13550 /* Resized active mini-window to fit the size of what it is
13551 showing if its contents might have changed. */
13554 /* If window configuration was changed, frames may have been
13555 marked garbaged. Clear them or we will experience
13556 surprises wrt scrolling. */
13557 clear_garbaged_frames ();
13560 if (windows_or_buffers_changed
&& !update_mode_lines
)
13561 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13562 only the windows's contents needs to be refreshed, or whether the
13563 mode-lines also need a refresh. */
13564 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13565 ? REDISPLAY_SOME
: 32);
13567 /* If specs for an arrow have changed, do thorough redisplay
13568 to ensure we remove any arrow that should no longer exist. */
13569 if (overlay_arrows_changed_p ())
13570 /* Apparently, this is the only case where we update other windows,
13571 without updating other mode-lines. */
13572 windows_or_buffers_changed
= 49;
13574 consider_all_windows_p
= (update_mode_lines
13575 || windows_or_buffers_changed
);
13577 #define AINC(a,i) \
13578 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13579 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13581 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13582 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13584 /* Optimize the case that only the line containing the cursor in the
13585 selected window has changed. Variables starting with this_ are
13586 set in display_line and record information about the line
13587 containing the cursor. */
13588 tlbufpos
= this_line_start_pos
;
13589 tlendpos
= this_line_end_pos
;
13590 if (!consider_all_windows_p
13591 && CHARPOS (tlbufpos
) > 0
13592 && !w
->update_mode_line
13593 && !current_buffer
->clip_changed
13594 && !current_buffer
->prevent_redisplay_optimizations_p
13595 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13596 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13597 && !XFRAME (w
->frame
)->cursor_type_changed
13598 /* Make sure recorded data applies to current buffer, etc. */
13599 && this_line_buffer
== current_buffer
13602 && !w
->optional_new_start
13603 /* Point must be on the line that we have info recorded about. */
13604 && PT
>= CHARPOS (tlbufpos
)
13605 && PT
<= Z
- CHARPOS (tlendpos
)
13606 /* All text outside that line, including its final newline,
13607 must be unchanged. */
13608 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13609 CHARPOS (tlendpos
)))
13611 if (CHARPOS (tlbufpos
) > BEGV
13612 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13613 && (CHARPOS (tlbufpos
) == ZV
13614 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13615 /* Former continuation line has disappeared by becoming empty. */
13617 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13619 /* We have to handle the case of continuation around a
13620 wide-column character (see the comment in indent.c around
13623 For instance, in the following case:
13625 -------- Insert --------
13626 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13627 J_I_ ==> J_I_ `^^' are cursors.
13631 As we have to redraw the line above, we cannot use this
13635 int line_height_before
= this_line_pixel_height
;
13637 /* Note that start_display will handle the case that the
13638 line starting at tlbufpos is a continuation line. */
13639 start_display (&it
, w
, tlbufpos
);
13641 /* Implementation note: It this still necessary? */
13642 if (it
.current_x
!= this_line_start_x
)
13645 TRACE ((stderr
, "trying display optimization 1\n"));
13646 w
->cursor
.vpos
= -1;
13647 overlay_arrow_seen
= 0;
13648 it
.vpos
= this_line_vpos
;
13649 it
.current_y
= this_line_y
;
13650 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13651 display_line (&it
);
13653 /* If line contains point, is not continued,
13654 and ends at same distance from eob as before, we win. */
13655 if (w
->cursor
.vpos
>= 0
13656 /* Line is not continued, otherwise this_line_start_pos
13657 would have been set to 0 in display_line. */
13658 && CHARPOS (this_line_start_pos
)
13659 /* Line ends as before. */
13660 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13661 /* Line has same height as before. Otherwise other lines
13662 would have to be shifted up or down. */
13663 && this_line_pixel_height
== line_height_before
)
13665 /* If this is not the window's last line, we must adjust
13666 the charstarts of the lines below. */
13667 if (it
.current_y
< it
.last_visible_y
)
13669 struct glyph_row
*row
13670 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13671 ptrdiff_t delta
, delta_bytes
;
13673 /* We used to distinguish between two cases here,
13674 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13675 when the line ends in a newline or the end of the
13676 buffer's accessible portion. But both cases did
13677 the same, so they were collapsed. */
13679 - CHARPOS (tlendpos
)
13680 - MATRIX_ROW_START_CHARPOS (row
));
13681 delta_bytes
= (Z_BYTE
13682 - BYTEPOS (tlendpos
)
13683 - MATRIX_ROW_START_BYTEPOS (row
));
13685 increment_matrix_positions (w
->current_matrix
,
13686 this_line_vpos
+ 1,
13687 w
->current_matrix
->nrows
,
13688 delta
, delta_bytes
);
13691 /* If this row displays text now but previously didn't,
13692 or vice versa, w->window_end_vpos may have to be
13694 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13696 if (w
->window_end_vpos
< this_line_vpos
)
13697 w
->window_end_vpos
= this_line_vpos
;
13699 else if (w
->window_end_vpos
== this_line_vpos
13700 && this_line_vpos
> 0)
13701 w
->window_end_vpos
= this_line_vpos
- 1;
13702 w
->window_end_valid
= 0;
13704 /* Update hint: No need to try to scroll in update_window. */
13705 w
->desired_matrix
->no_scrolling_p
= 1;
13708 *w
->desired_matrix
->method
= 0;
13709 debug_method_add (w
, "optimization 1");
13711 #ifdef HAVE_WINDOW_SYSTEM
13712 update_window_fringes (w
, 0);
13719 else if (/* Cursor position hasn't changed. */
13720 PT
== w
->last_point
13721 /* Make sure the cursor was last displayed
13722 in this window. Otherwise we have to reposition it. */
13724 /* PXW: Must be converted to pixels, probably. */
13725 && 0 <= w
->cursor
.vpos
13726 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13730 do_pending_window_change (1);
13731 /* If selected_window changed, redisplay again. */
13732 if (WINDOWP (selected_window
)
13733 && (w
= XWINDOW (selected_window
)) != sw
)
13736 /* We used to always goto end_of_redisplay here, but this
13737 isn't enough if we have a blinking cursor. */
13738 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13739 goto end_of_redisplay
;
13743 /* If highlighting the region, or if the cursor is in the echo area,
13744 then we can't just move the cursor. */
13745 else if (NILP (Vshow_trailing_whitespace
)
13746 && !cursor_in_echo_area
)
13749 struct glyph_row
*row
;
13751 /* Skip from tlbufpos to PT and see where it is. Note that
13752 PT may be in invisible text. If so, we will end at the
13753 next visible position. */
13754 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13755 NULL
, DEFAULT_FACE_ID
);
13756 it
.current_x
= this_line_start_x
;
13757 it
.current_y
= this_line_y
;
13758 it
.vpos
= this_line_vpos
;
13760 /* The call to move_it_to stops in front of PT, but
13761 moves over before-strings. */
13762 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13764 if (it
.vpos
== this_line_vpos
13765 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13768 eassert (this_line_vpos
== it
.vpos
);
13769 eassert (this_line_y
== it
.current_y
);
13770 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13772 *w
->desired_matrix
->method
= 0;
13773 debug_method_add (w
, "optimization 3");
13782 /* Text changed drastically or point moved off of line. */
13783 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13786 CHARPOS (this_line_start_pos
) = 0;
13787 ++clear_face_cache_count
;
13788 #ifdef HAVE_WINDOW_SYSTEM
13789 ++clear_image_cache_count
;
13792 /* Build desired matrices, and update the display. If
13793 consider_all_windows_p is non-zero, do it for all windows on all
13794 frames. Otherwise do it for selected_window, only. */
13796 if (consider_all_windows_p
)
13798 FOR_EACH_FRAME (tail
, frame
)
13799 XFRAME (frame
)->updated_p
= 0;
13801 propagate_buffer_redisplay ();
13803 FOR_EACH_FRAME (tail
, frame
)
13805 struct frame
*f
= XFRAME (frame
);
13807 /* We don't have to do anything for unselected terminal
13809 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13810 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13815 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13818 /* Only GC scrollbars when we redisplay the whole frame. */
13819 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13820 /* Mark all the scroll bars to be removed; we'll redeem
13821 the ones we want when we redisplay their windows. */
13822 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13823 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13825 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13826 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13827 /* Remember that the invisible frames need to be redisplayed next
13828 time they're visible. */
13829 else if (!REDISPLAY_SOME_P ())
13830 f
->redisplay
= true;
13832 /* The X error handler may have deleted that frame. */
13833 if (!FRAME_LIVE_P (f
))
13836 /* Any scroll bars which redisplay_windows should have
13837 nuked should now go away. */
13838 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13839 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13841 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13843 /* If fonts changed on visible frame, display again. */
13844 if (f
->fonts_changed
)
13846 adjust_frame_glyphs (f
);
13847 f
->fonts_changed
= 0;
13851 /* See if we have to hscroll. */
13852 if (!f
->already_hscrolled_p
)
13854 f
->already_hscrolled_p
= 1;
13855 if (hscroll_windows (f
->root_window
))
13859 /* Prevent various kinds of signals during display
13860 update. stdio is not robust about handling
13861 signals, which can cause an apparent I/O error. */
13862 if (interrupt_input
)
13863 unrequest_sigio ();
13866 pending
|= update_frame (f
, 0, 0);
13867 f
->cursor_type_changed
= 0;
13873 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13877 /* Do the mark_window_display_accurate after all windows have
13878 been redisplayed because this call resets flags in buffers
13879 which are needed for proper redisplay. */
13880 FOR_EACH_FRAME (tail
, frame
)
13882 struct frame
*f
= XFRAME (frame
);
13885 f
->redisplay
= false;
13886 mark_window_display_accurate (f
->root_window
, 1);
13887 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13888 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13893 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13895 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13896 struct frame
*mini_frame
;
13898 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13899 /* Use list_of_error, not Qerror, so that
13900 we catch only errors and don't run the debugger. */
13901 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13903 redisplay_window_error
);
13904 if (update_miniwindow_p
)
13905 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13907 redisplay_window_error
);
13909 /* Compare desired and current matrices, perform output. */
13912 /* If fonts changed, display again. */
13913 if (sf
->fonts_changed
)
13916 /* Prevent various kinds of signals during display update.
13917 stdio is not robust about handling signals,
13918 which can cause an apparent I/O error. */
13919 if (interrupt_input
)
13920 unrequest_sigio ();
13923 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13925 if (hscroll_windows (selected_window
))
13928 XWINDOW (selected_window
)->must_be_updated_p
= true;
13929 pending
= update_frame (sf
, 0, 0);
13930 sf
->cursor_type_changed
= 0;
13933 /* We may have called echo_area_display at the top of this
13934 function. If the echo area is on another frame, that may
13935 have put text on a frame other than the selected one, so the
13936 above call to update_frame would not have caught it. Catch
13938 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13939 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13941 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13943 XWINDOW (mini_window
)->must_be_updated_p
= true;
13944 pending
|= update_frame (mini_frame
, 0, 0);
13945 mini_frame
->cursor_type_changed
= 0;
13946 if (!pending
&& hscroll_windows (mini_window
))
13951 /* If display was paused because of pending input, make sure we do a
13952 thorough update the next time. */
13955 /* Prevent the optimization at the beginning of
13956 redisplay_internal that tries a single-line update of the
13957 line containing the cursor in the selected window. */
13958 CHARPOS (this_line_start_pos
) = 0;
13960 /* Let the overlay arrow be updated the next time. */
13961 update_overlay_arrows (0);
13963 /* If we pause after scrolling, some rows in the current
13964 matrices of some windows are not valid. */
13965 if (!WINDOW_FULL_WIDTH_P (w
)
13966 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13967 update_mode_lines
= 36;
13971 if (!consider_all_windows_p
)
13973 /* This has already been done above if
13974 consider_all_windows_p is set. */
13975 if (XBUFFER (w
->contents
)->text
->redisplay
13976 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
13977 /* This can happen if b->text->redisplay was set during
13979 propagate_buffer_redisplay ();
13980 mark_window_display_accurate_1 (w
, 1);
13982 /* Say overlay arrows are up to date. */
13983 update_overlay_arrows (1);
13985 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13986 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13989 update_mode_lines
= 0;
13990 windows_or_buffers_changed
= 0;
13993 /* Start SIGIO interrupts coming again. Having them off during the
13994 code above makes it less likely one will discard output, but not
13995 impossible, since there might be stuff in the system buffer here.
13996 But it is much hairier to try to do anything about that. */
13997 if (interrupt_input
)
14001 /* If a frame has become visible which was not before, redisplay
14002 again, so that we display it. Expose events for such a frame
14003 (which it gets when becoming visible) don't call the parts of
14004 redisplay constructing glyphs, so simply exposing a frame won't
14005 display anything in this case. So, we have to display these
14006 frames here explicitly. */
14011 FOR_EACH_FRAME (tail
, frame
)
14013 if (XFRAME (frame
)->visible
)
14017 if (new_count
!= number_of_visible_frames
)
14018 windows_or_buffers_changed
= 52;
14021 /* Change frame size now if a change is pending. */
14022 do_pending_window_change (1);
14024 /* If we just did a pending size change, or have additional
14025 visible frames, or selected_window changed, redisplay again. */
14026 if ((windows_or_buffers_changed
&& !pending
)
14027 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14030 /* Clear the face and image caches.
14032 We used to do this only if consider_all_windows_p. But the cache
14033 needs to be cleared if a timer creates images in the current
14034 buffer (e.g. the test case in Bug#6230). */
14036 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14038 clear_face_cache (0);
14039 clear_face_cache_count
= 0;
14042 #ifdef HAVE_WINDOW_SYSTEM
14043 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14045 clear_image_caches (Qnil
);
14046 clear_image_cache_count
= 0;
14048 #endif /* HAVE_WINDOW_SYSTEM */
14051 if (interrupt_input
&& interrupts_deferred
)
14054 unbind_to (count
, Qnil
);
14059 /* Redisplay, but leave alone any recent echo area message unless
14060 another message has been requested in its place.
14062 This is useful in situations where you need to redisplay but no
14063 user action has occurred, making it inappropriate for the message
14064 area to be cleared. See tracking_off and
14065 wait_reading_process_output for examples of these situations.
14067 FROM_WHERE is an integer saying from where this function was
14068 called. This is useful for debugging. */
14071 redisplay_preserve_echo_area (int from_where
)
14073 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14075 if (!NILP (echo_area_buffer
[1]))
14077 /* We have a previously displayed message, but no current
14078 message. Redisplay the previous message. */
14079 display_last_displayed_message_p
= 1;
14080 redisplay_internal ();
14081 display_last_displayed_message_p
= 0;
14084 redisplay_internal ();
14086 flush_frame (SELECTED_FRAME ());
14090 /* Function registered with record_unwind_protect in redisplay_internal. */
14093 unwind_redisplay (void)
14095 redisplaying_p
= 0;
14099 /* Mark the display of leaf window W as accurate or inaccurate.
14100 If ACCURATE_P is non-zero mark display of W as accurate. If
14101 ACCURATE_P is zero, arrange for W to be redisplayed the next
14102 time redisplay_internal is called. */
14105 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
14107 struct buffer
*b
= XBUFFER (w
->contents
);
14109 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14110 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14111 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14115 b
->clip_changed
= false;
14116 b
->prevent_redisplay_optimizations_p
= false;
14117 eassert (buffer_window_count (b
) > 0);
14118 /* Resetting b->text->redisplay is problematic!
14119 In order to make it safer to do it here, redisplay_internal must
14120 have copied all b->text->redisplay to their respective windows. */
14121 b
->text
->redisplay
= false;
14123 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14124 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14125 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14126 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14128 w
->current_matrix
->buffer
= b
;
14129 w
->current_matrix
->begv
= BUF_BEGV (b
);
14130 w
->current_matrix
->zv
= BUF_ZV (b
);
14132 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14133 w
->last_cursor_off_p
= w
->cursor_off_p
;
14135 if (w
== XWINDOW (selected_window
))
14136 w
->last_point
= BUF_PT (b
);
14138 w
->last_point
= marker_position (w
->pointm
);
14140 w
->window_end_valid
= true;
14141 w
->update_mode_line
= false;
14144 w
->redisplay
= !accurate_p
;
14148 /* Mark the display of windows in the window tree rooted at WINDOW as
14149 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
14150 windows as accurate. If ACCURATE_P is zero, arrange for windows to
14151 be redisplayed the next time redisplay_internal is called. */
14154 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
14158 for (; !NILP (window
); window
= w
->next
)
14160 w
= XWINDOW (window
);
14161 if (WINDOWP (w
->contents
))
14162 mark_window_display_accurate (w
->contents
, accurate_p
);
14164 mark_window_display_accurate_1 (w
, accurate_p
);
14168 update_overlay_arrows (1);
14170 /* Force a thorough redisplay the next time by setting
14171 last_arrow_position and last_arrow_string to t, which is
14172 unequal to any useful value of Voverlay_arrow_... */
14173 update_overlay_arrows (-1);
14177 /* Return value in display table DP (Lisp_Char_Table *) for character
14178 C. Since a display table doesn't have any parent, we don't have to
14179 follow parent. Do not call this function directly but use the
14180 macro DISP_CHAR_VECTOR. */
14183 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14187 if (ASCII_CHAR_P (c
))
14190 if (SUB_CHAR_TABLE_P (val
))
14191 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14197 XSETCHAR_TABLE (table
, dp
);
14198 val
= char_table_ref (table
, c
);
14207 /***********************************************************************
14209 ***********************************************************************/
14211 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14214 redisplay_windows (Lisp_Object window
)
14216 while (!NILP (window
))
14218 struct window
*w
= XWINDOW (window
);
14220 if (WINDOWP (w
->contents
))
14221 redisplay_windows (w
->contents
);
14222 else if (BUFFERP (w
->contents
))
14224 displayed_buffer
= XBUFFER (w
->contents
);
14225 /* Use list_of_error, not Qerror, so that
14226 we catch only errors and don't run the debugger. */
14227 internal_condition_case_1 (redisplay_window_0
, window
,
14229 redisplay_window_error
);
14237 redisplay_window_error (Lisp_Object ignore
)
14239 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14244 redisplay_window_0 (Lisp_Object window
)
14246 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14247 redisplay_window (window
, false);
14252 redisplay_window_1 (Lisp_Object window
)
14254 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14255 redisplay_window (window
, true);
14260 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14261 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14262 which positions recorded in ROW differ from current buffer
14265 Return 0 if cursor is not on this row, 1 otherwise. */
14268 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14269 struct glyph_matrix
*matrix
,
14270 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14273 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14274 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14275 struct glyph
*cursor
= NULL
;
14276 /* The last known character position in row. */
14277 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14279 ptrdiff_t pt_old
= PT
- delta
;
14280 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14281 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14282 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14283 /* A glyph beyond the edge of TEXT_AREA which we should never
14285 struct glyph
*glyphs_end
= end
;
14286 /* Non-zero means we've found a match for cursor position, but that
14287 glyph has the avoid_cursor_p flag set. */
14288 int match_with_avoid_cursor
= 0;
14289 /* Non-zero means we've seen at least one glyph that came from a
14291 int string_seen
= 0;
14292 /* Largest and smallest buffer positions seen so far during scan of
14294 ptrdiff_t bpos_max
= pos_before
;
14295 ptrdiff_t bpos_min
= pos_after
;
14296 /* Last buffer position covered by an overlay string with an integer
14297 `cursor' property. */
14298 ptrdiff_t bpos_covered
= 0;
14299 /* Non-zero means the display string on which to display the cursor
14300 comes from a text property, not from an overlay. */
14301 int string_from_text_prop
= 0;
14303 /* Don't even try doing anything if called for a mode-line or
14304 header-line row, since the rest of the code isn't prepared to
14305 deal with such calamities. */
14306 eassert (!row
->mode_line_p
);
14307 if (row
->mode_line_p
)
14310 /* Skip over glyphs not having an object at the start and the end of
14311 the row. These are special glyphs like truncation marks on
14312 terminal frames. */
14313 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14315 if (!row
->reversed_p
)
14318 && INTEGERP (glyph
->object
)
14319 && glyph
->charpos
< 0)
14321 x
+= glyph
->pixel_width
;
14325 && INTEGERP ((end
- 1)->object
)
14326 /* CHARPOS is zero for blanks and stretch glyphs
14327 inserted by extend_face_to_end_of_line. */
14328 && (end
- 1)->charpos
<= 0)
14330 glyph_before
= glyph
- 1;
14337 /* If the glyph row is reversed, we need to process it from back
14338 to front, so swap the edge pointers. */
14339 glyphs_end
= end
= glyph
- 1;
14340 glyph
+= row
->used
[TEXT_AREA
] - 1;
14342 while (glyph
> end
+ 1
14343 && INTEGERP (glyph
->object
)
14344 && glyph
->charpos
< 0)
14347 x
-= glyph
->pixel_width
;
14349 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
14351 /* By default, in reversed rows we put the cursor on the
14352 rightmost (first in the reading order) glyph. */
14353 for (g
= end
+ 1; g
< glyph
; g
++)
14354 x
+= g
->pixel_width
;
14356 && INTEGERP ((end
+ 1)->object
)
14357 && (end
+ 1)->charpos
<= 0)
14359 glyph_before
= glyph
+ 1;
14363 else if (row
->reversed_p
)
14365 /* In R2L rows that don't display text, put the cursor on the
14366 rightmost glyph. Case in point: an empty last line that is
14367 part of an R2L paragraph. */
14369 /* Avoid placing the cursor on the last glyph of the row, where
14370 on terminal frames we hold the vertical border between
14371 adjacent windows. */
14372 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14373 && !WINDOW_RIGHTMOST_P (w
)
14374 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14376 x
= -1; /* will be computed below, at label compute_x */
14379 /* Step 1: Try to find the glyph whose character position
14380 corresponds to point. If that's not possible, find 2 glyphs
14381 whose character positions are the closest to point, one before
14382 point, the other after it. */
14383 if (!row
->reversed_p
)
14384 while (/* not marched to end of glyph row */
14386 /* glyph was not inserted by redisplay for internal purposes */
14387 && !INTEGERP (glyph
->object
))
14389 if (BUFFERP (glyph
->object
))
14391 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14393 if (glyph
->charpos
> bpos_max
)
14394 bpos_max
= glyph
->charpos
;
14395 if (glyph
->charpos
< bpos_min
)
14396 bpos_min
= glyph
->charpos
;
14397 if (!glyph
->avoid_cursor_p
)
14399 /* If we hit point, we've found the glyph on which to
14400 display the cursor. */
14403 match_with_avoid_cursor
= 0;
14406 /* See if we've found a better approximation to
14407 POS_BEFORE or to POS_AFTER. */
14408 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14410 pos_before
= glyph
->charpos
;
14411 glyph_before
= glyph
;
14413 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14415 pos_after
= glyph
->charpos
;
14416 glyph_after
= glyph
;
14419 else if (dpos
== 0)
14420 match_with_avoid_cursor
= 1;
14422 else if (STRINGP (glyph
->object
))
14424 Lisp_Object chprop
;
14425 ptrdiff_t glyph_pos
= glyph
->charpos
;
14427 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14429 if (!NILP (chprop
))
14431 /* If the string came from a `display' text property,
14432 look up the buffer position of that property and
14433 use that position to update bpos_max, as if we
14434 actually saw such a position in one of the row's
14435 glyphs. This helps with supporting integer values
14436 of `cursor' property on the display string in
14437 situations where most or all of the row's buffer
14438 text is completely covered by display properties,
14439 so that no glyph with valid buffer positions is
14440 ever seen in the row. */
14441 ptrdiff_t prop_pos
=
14442 string_buffer_position_lim (glyph
->object
, pos_before
,
14445 if (prop_pos
>= pos_before
)
14446 bpos_max
= prop_pos
;
14448 if (INTEGERP (chprop
))
14450 bpos_covered
= bpos_max
+ XINT (chprop
);
14451 /* If the `cursor' property covers buffer positions up
14452 to and including point, we should display cursor on
14453 this glyph. Note that, if a `cursor' property on one
14454 of the string's characters has an integer value, we
14455 will break out of the loop below _before_ we get to
14456 the position match above. IOW, integer values of
14457 the `cursor' property override the "exact match for
14458 point" strategy of positioning the cursor. */
14459 /* Implementation note: bpos_max == pt_old when, e.g.,
14460 we are in an empty line, where bpos_max is set to
14461 MATRIX_ROW_START_CHARPOS, see above. */
14462 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14471 x
+= glyph
->pixel_width
;
14474 else if (glyph
> end
) /* row is reversed */
14475 while (!INTEGERP (glyph
->object
))
14477 if (BUFFERP (glyph
->object
))
14479 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14481 if (glyph
->charpos
> bpos_max
)
14482 bpos_max
= glyph
->charpos
;
14483 if (glyph
->charpos
< bpos_min
)
14484 bpos_min
= glyph
->charpos
;
14485 if (!glyph
->avoid_cursor_p
)
14489 match_with_avoid_cursor
= 0;
14492 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14494 pos_before
= glyph
->charpos
;
14495 glyph_before
= glyph
;
14497 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14499 pos_after
= glyph
->charpos
;
14500 glyph_after
= glyph
;
14503 else if (dpos
== 0)
14504 match_with_avoid_cursor
= 1;
14506 else if (STRINGP (glyph
->object
))
14508 Lisp_Object chprop
;
14509 ptrdiff_t glyph_pos
= glyph
->charpos
;
14511 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14513 if (!NILP (chprop
))
14515 ptrdiff_t prop_pos
=
14516 string_buffer_position_lim (glyph
->object
, pos_before
,
14519 if (prop_pos
>= pos_before
)
14520 bpos_max
= prop_pos
;
14522 if (INTEGERP (chprop
))
14524 bpos_covered
= bpos_max
+ XINT (chprop
);
14525 /* If the `cursor' property covers buffer positions up
14526 to and including point, we should display cursor on
14528 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14537 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14539 x
--; /* can't use any pixel_width */
14542 x
-= glyph
->pixel_width
;
14545 /* Step 2: If we didn't find an exact match for point, we need to
14546 look for a proper place to put the cursor among glyphs between
14547 GLYPH_BEFORE and GLYPH_AFTER. */
14548 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14549 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14550 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14552 /* An empty line has a single glyph whose OBJECT is zero and
14553 whose CHARPOS is the position of a newline on that line.
14554 Note that on a TTY, there are more glyphs after that, which
14555 were produced by extend_face_to_end_of_line, but their
14556 CHARPOS is zero or negative. */
14558 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14559 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0
14560 /* On a TTY, continued and truncated rows also have a glyph at
14561 their end whose OBJECT is zero and whose CHARPOS is
14562 positive (the continuation and truncation glyphs), but such
14563 rows are obviously not "empty". */
14564 && !(row
->continued_p
|| row
->truncated_on_right_p
);
14566 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14568 ptrdiff_t ellipsis_pos
;
14570 /* Scan back over the ellipsis glyphs. */
14571 if (!row
->reversed_p
)
14573 ellipsis_pos
= (glyph
- 1)->charpos
;
14574 while (glyph
> row
->glyphs
[TEXT_AREA
]
14575 && (glyph
- 1)->charpos
== ellipsis_pos
)
14576 glyph
--, x
-= glyph
->pixel_width
;
14577 /* That loop always goes one position too far, including
14578 the glyph before the ellipsis. So scan forward over
14580 x
+= glyph
->pixel_width
;
14583 else /* row is reversed */
14585 ellipsis_pos
= (glyph
+ 1)->charpos
;
14586 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14587 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14588 glyph
++, x
+= glyph
->pixel_width
;
14589 x
-= glyph
->pixel_width
;
14593 else if (match_with_avoid_cursor
)
14595 cursor
= glyph_after
;
14598 else if (string_seen
)
14600 int incr
= row
->reversed_p
? -1 : +1;
14602 /* Need to find the glyph that came out of a string which is
14603 present at point. That glyph is somewhere between
14604 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14605 positioned between POS_BEFORE and POS_AFTER in the
14607 struct glyph
*start
, *stop
;
14608 ptrdiff_t pos
= pos_before
;
14612 /* If the row ends in a newline from a display string,
14613 reordering could have moved the glyphs belonging to the
14614 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14615 in this case we extend the search to the last glyph in
14616 the row that was not inserted by redisplay. */
14617 if (row
->ends_in_newline_from_string_p
)
14620 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14623 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14624 correspond to POS_BEFORE and POS_AFTER, respectively. We
14625 need START and STOP in the order that corresponds to the
14626 row's direction as given by its reversed_p flag. If the
14627 directionality of characters between POS_BEFORE and
14628 POS_AFTER is the opposite of the row's base direction,
14629 these characters will have been reordered for display,
14630 and we need to reverse START and STOP. */
14631 if (!row
->reversed_p
)
14633 start
= min (glyph_before
, glyph_after
);
14634 stop
= max (glyph_before
, glyph_after
);
14638 start
= max (glyph_before
, glyph_after
);
14639 stop
= min (glyph_before
, glyph_after
);
14641 for (glyph
= start
+ incr
;
14642 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14645 /* Any glyphs that come from the buffer are here because
14646 of bidi reordering. Skip them, and only pay
14647 attention to glyphs that came from some string. */
14648 if (STRINGP (glyph
->object
))
14652 /* If the display property covers the newline, we
14653 need to search for it one position farther. */
14654 ptrdiff_t lim
= pos_after
14655 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14657 string_from_text_prop
= 0;
14658 str
= glyph
->object
;
14659 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14660 if (tem
== 0 /* from overlay */
14663 /* If the string from which this glyph came is
14664 found in the buffer at point, or at position
14665 that is closer to point than pos_after, then
14666 we've found the glyph we've been looking for.
14667 If it comes from an overlay (tem == 0), and
14668 it has the `cursor' property on one of its
14669 glyphs, record that glyph as a candidate for
14670 displaying the cursor. (As in the
14671 unidirectional version, we will display the
14672 cursor on the last candidate we find.) */
14675 || (tem
- pt_old
> 0 && tem
< pos_after
))
14677 /* The glyphs from this string could have
14678 been reordered. Find the one with the
14679 smallest string position. Or there could
14680 be a character in the string with the
14681 `cursor' property, which means display
14682 cursor on that character's glyph. */
14683 ptrdiff_t strpos
= glyph
->charpos
;
14688 string_from_text_prop
= 1;
14691 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14692 && EQ (glyph
->object
, str
);
14696 ptrdiff_t gpos
= glyph
->charpos
;
14698 cprop
= Fget_char_property (make_number (gpos
),
14706 if (tem
&& glyph
->charpos
< strpos
)
14708 strpos
= glyph
->charpos
;
14714 || (tem
- pt_old
> 0 && tem
< pos_after
))
14718 pos
= tem
+ 1; /* don't find previous instances */
14720 /* This string is not what we want; skip all of the
14721 glyphs that came from it. */
14722 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14723 && EQ (glyph
->object
, str
))
14730 /* If we reached the end of the line, and END was from a string,
14731 the cursor is not on this line. */
14733 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14734 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14735 && STRINGP (end
->object
)
14736 && row
->continued_p
)
14739 /* A truncated row may not include PT among its character positions.
14740 Setting the cursor inside the scroll margin will trigger
14741 recalculation of hscroll in hscroll_window_tree. But if a
14742 display string covers point, defer to the string-handling
14743 code below to figure this out. */
14744 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14746 cursor
= glyph_before
;
14749 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14750 /* Zero-width characters produce no glyphs. */
14752 && (row
->reversed_p
14753 ? glyph_after
> glyphs_end
14754 : glyph_after
< glyphs_end
)))
14756 cursor
= glyph_after
;
14762 if (cursor
!= NULL
)
14764 else if (glyph
== glyphs_end
14765 && pos_before
== pos_after
14766 && STRINGP ((row
->reversed_p
14767 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14768 : row
->glyphs
[TEXT_AREA
])->object
))
14770 /* If all the glyphs of this row came from strings, put the
14771 cursor on the first glyph of the row. This avoids having the
14772 cursor outside of the text area in this very rare and hard
14776 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14777 : row
->glyphs
[TEXT_AREA
];
14783 /* Need to compute x that corresponds to GLYPH. */
14784 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14786 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14788 x
+= g
->pixel_width
;
14792 /* ROW could be part of a continued line, which, under bidi
14793 reordering, might have other rows whose start and end charpos
14794 occlude point. Only set w->cursor if we found a better
14795 approximation to the cursor position than we have from previously
14796 examined candidate rows belonging to the same continued line. */
14797 if (/* We already have a candidate row. */
14798 w
->cursor
.vpos
>= 0
14799 /* That candidate is not the row we are processing. */
14800 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14801 /* Make sure cursor.vpos specifies a row whose start and end
14802 charpos occlude point, and it is valid candidate for being a
14803 cursor-row. This is because some callers of this function
14804 leave cursor.vpos at the row where the cursor was displayed
14805 during the last redisplay cycle. */
14806 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14807 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14808 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14811 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14813 /* Don't consider glyphs that are outside TEXT_AREA. */
14814 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14816 /* Keep the candidate whose buffer position is the closest to
14817 point or has the `cursor' property. */
14818 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14819 w
->cursor
.hpos
>= 0
14820 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14821 && ((BUFFERP (g1
->object
)
14822 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14823 || (BUFFERP (glyph
->object
)
14824 && eabs (g1
->charpos
- pt_old
)
14825 < eabs (glyph
->charpos
- pt_old
))))
14826 /* Previous candidate is a glyph from a string that has
14827 a non-nil `cursor' property. */
14828 || (STRINGP (g1
->object
)
14829 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14830 Qcursor
, g1
->object
))
14831 /* Previous candidate is from the same display
14832 string as this one, and the display string
14833 came from a text property. */
14834 || (EQ (g1
->object
, glyph
->object
)
14835 && string_from_text_prop
)
14836 /* this candidate is from newline and its
14837 position is not an exact match */
14838 || (INTEGERP (glyph
->object
)
14839 && glyph
->charpos
!= pt_old
)))))
14841 /* If this candidate gives an exact match, use that. */
14842 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14843 /* If this candidate is a glyph created for the
14844 terminating newline of a line, and point is on that
14845 newline, it wins because it's an exact match. */
14846 || (!row
->continued_p
14847 && INTEGERP (glyph
->object
)
14848 && glyph
->charpos
== 0
14849 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14850 /* Otherwise, keep the candidate that comes from a row
14851 spanning less buffer positions. This may win when one or
14852 both candidate positions are on glyphs that came from
14853 display strings, for which we cannot compare buffer
14855 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14856 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14857 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14860 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14862 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14863 w
->cursor
.y
= row
->y
+ dy
;
14865 if (w
== XWINDOW (selected_window
))
14867 if (!row
->continued_p
14868 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14871 this_line_buffer
= XBUFFER (w
->contents
);
14873 CHARPOS (this_line_start_pos
)
14874 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14875 BYTEPOS (this_line_start_pos
)
14876 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14878 CHARPOS (this_line_end_pos
)
14879 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14880 BYTEPOS (this_line_end_pos
)
14881 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14883 this_line_y
= w
->cursor
.y
;
14884 this_line_pixel_height
= row
->height
;
14885 this_line_vpos
= w
->cursor
.vpos
;
14886 this_line_start_x
= row
->x
;
14889 CHARPOS (this_line_start_pos
) = 0;
14896 /* Run window scroll functions, if any, for WINDOW with new window
14897 start STARTP. Sets the window start of WINDOW to that position.
14899 We assume that the window's buffer is really current. */
14901 static struct text_pos
14902 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14904 struct window
*w
= XWINDOW (window
);
14905 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14907 eassert (current_buffer
== XBUFFER (w
->contents
));
14909 if (!NILP (Vwindow_scroll_functions
))
14911 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14912 make_number (CHARPOS (startp
)));
14913 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14914 /* In case the hook functions switch buffers. */
14915 set_buffer_internal (XBUFFER (w
->contents
));
14922 /* Make sure the line containing the cursor is fully visible.
14923 A value of 1 means there is nothing to be done.
14924 (Either the line is fully visible, or it cannot be made so,
14925 or we cannot tell.)
14927 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14928 is higher than window.
14930 A value of 0 means the caller should do scrolling
14931 as if point had gone off the screen. */
14934 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14936 struct glyph_matrix
*matrix
;
14937 struct glyph_row
*row
;
14940 if (!make_cursor_line_fully_visible_p
)
14943 /* It's not always possible to find the cursor, e.g, when a window
14944 is full of overlay strings. Don't do anything in that case. */
14945 if (w
->cursor
.vpos
< 0)
14948 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14949 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14951 /* If the cursor row is not partially visible, there's nothing to do. */
14952 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14955 /* If the row the cursor is in is taller than the window's height,
14956 it's not clear what to do, so do nothing. */
14957 window_height
= window_box_height (w
);
14958 if (row
->height
>= window_height
)
14960 if (!force_p
|| MINI_WINDOW_P (w
)
14961 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14968 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14969 non-zero means only WINDOW is redisplayed in redisplay_internal.
14970 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14971 in redisplay_window to bring a partially visible line into view in
14972 the case that only the cursor has moved.
14974 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14975 last screen line's vertical height extends past the end of the screen.
14979 1 if scrolling succeeded
14981 0 if scrolling didn't find point.
14983 -1 if new fonts have been loaded so that we must interrupt
14984 redisplay, adjust glyph matrices, and try again. */
14990 SCROLLING_NEED_LARGER_MATRICES
14993 /* If scroll-conservatively is more than this, never recenter.
14995 If you change this, don't forget to update the doc string of
14996 `scroll-conservatively' and the Emacs manual. */
14997 #define SCROLL_LIMIT 100
15000 try_scrolling (Lisp_Object window
, int just_this_one_p
,
15001 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15002 int temp_scroll_step
, int last_line_misfit
)
15004 struct window
*w
= XWINDOW (window
);
15005 struct frame
*f
= XFRAME (w
->frame
);
15006 struct text_pos pos
, startp
;
15008 int this_scroll_margin
, scroll_max
, rc
, height
;
15009 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
15010 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
15011 Lisp_Object aggressive
;
15012 /* We will never try scrolling more than this number of lines. */
15013 int scroll_limit
= SCROLL_LIMIT
;
15014 int frame_line_height
= default_line_pixel_height (w
);
15015 int window_total_lines
15016 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15019 debug_method_add (w
, "try_scrolling");
15022 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15024 /* Compute scroll margin height in pixels. We scroll when point is
15025 within this distance from the top or bottom of the window. */
15026 if (scroll_margin
> 0)
15027 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15028 * frame_line_height
;
15030 this_scroll_margin
= 0;
15032 /* Force arg_scroll_conservatively to have a reasonable value, to
15033 avoid scrolling too far away with slow move_it_* functions. Note
15034 that the user can supply scroll-conservatively equal to
15035 `most-positive-fixnum', which can be larger than INT_MAX. */
15036 if (arg_scroll_conservatively
> scroll_limit
)
15038 arg_scroll_conservatively
= scroll_limit
+ 1;
15039 scroll_max
= scroll_limit
* frame_line_height
;
15041 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15042 /* Compute how much we should try to scroll maximally to bring
15043 point into view. */
15044 scroll_max
= (max (scroll_step
,
15045 max (arg_scroll_conservatively
, temp_scroll_step
))
15046 * frame_line_height
);
15047 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15048 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15049 /* We're trying to scroll because of aggressive scrolling but no
15050 scroll_step is set. Choose an arbitrary one. */
15051 scroll_max
= 10 * frame_line_height
;
15057 /* Decide whether to scroll down. */
15058 if (PT
> CHARPOS (startp
))
15060 int scroll_margin_y
;
15062 /* Compute the pixel ypos of the scroll margin, then move IT to
15063 either that ypos or PT, whichever comes first. */
15064 start_display (&it
, w
, startp
);
15065 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15066 - frame_line_height
* extra_scroll_margin_lines
;
15067 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15068 (MOVE_TO_POS
| MOVE_TO_Y
));
15070 if (PT
> CHARPOS (it
.current
.pos
))
15072 int y0
= line_bottom_y (&it
);
15073 /* Compute how many pixels below window bottom to stop searching
15074 for PT. This avoids costly search for PT that is far away if
15075 the user limited scrolling by a small number of lines, but
15076 always finds PT if scroll_conservatively is set to a large
15077 number, such as most-positive-fixnum. */
15078 int slack
= max (scroll_max
, 10 * frame_line_height
);
15079 int y_to_move
= it
.last_visible_y
+ slack
;
15081 /* Compute the distance from the scroll margin to PT or to
15082 the scroll limit, whichever comes first. This should
15083 include the height of the cursor line, to make that line
15085 move_it_to (&it
, PT
, -1, y_to_move
,
15086 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15087 dy
= line_bottom_y (&it
) - y0
;
15089 if (dy
> scroll_max
)
15090 return SCROLLING_FAILED
;
15099 /* Point is in or below the bottom scroll margin, so move the
15100 window start down. If scrolling conservatively, move it just
15101 enough down to make point visible. If scroll_step is set,
15102 move it down by scroll_step. */
15103 if (arg_scroll_conservatively
)
15105 = min (max (dy
, frame_line_height
),
15106 frame_line_height
* arg_scroll_conservatively
);
15107 else if (scroll_step
|| temp_scroll_step
)
15108 amount_to_scroll
= scroll_max
;
15111 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15112 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15113 if (NUMBERP (aggressive
))
15115 double float_amount
= XFLOATINT (aggressive
) * height
;
15116 int aggressive_scroll
= float_amount
;
15117 if (aggressive_scroll
== 0 && float_amount
> 0)
15118 aggressive_scroll
= 1;
15119 /* Don't let point enter the scroll margin near top of
15120 the window. This could happen if the value of
15121 scroll_up_aggressively is too large and there are
15122 non-zero margins, because scroll_up_aggressively
15123 means put point that fraction of window height
15124 _from_the_bottom_margin_. */
15125 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15126 aggressive_scroll
= height
- 2*this_scroll_margin
;
15127 amount_to_scroll
= dy
+ aggressive_scroll
;
15131 if (amount_to_scroll
<= 0)
15132 return SCROLLING_FAILED
;
15134 start_display (&it
, w
, startp
);
15135 if (arg_scroll_conservatively
<= scroll_limit
)
15136 move_it_vertically (&it
, amount_to_scroll
);
15139 /* Extra precision for users who set scroll-conservatively
15140 to a large number: make sure the amount we scroll
15141 the window start is never less than amount_to_scroll,
15142 which was computed as distance from window bottom to
15143 point. This matters when lines at window top and lines
15144 below window bottom have different height. */
15146 void *it1data
= NULL
;
15147 /* We use a temporary it1 because line_bottom_y can modify
15148 its argument, if it moves one line down; see there. */
15151 SAVE_IT (it1
, it
, it1data
);
15152 start_y
= line_bottom_y (&it1
);
15154 RESTORE_IT (&it
, &it
, it1data
);
15155 move_it_by_lines (&it
, 1);
15156 SAVE_IT (it1
, it
, it1data
);
15157 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15160 /* If STARTP is unchanged, move it down another screen line. */
15161 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
15162 move_it_by_lines (&it
, 1);
15163 startp
= it
.current
.pos
;
15167 struct text_pos scroll_margin_pos
= startp
;
15170 /* See if point is inside the scroll margin at the top of the
15172 if (this_scroll_margin
)
15176 start_display (&it
, w
, startp
);
15177 y_start
= it
.current_y
;
15178 move_it_vertically (&it
, this_scroll_margin
);
15179 scroll_margin_pos
= it
.current
.pos
;
15180 /* If we didn't move enough before hitting ZV, request
15181 additional amount of scroll, to move point out of the
15183 if (IT_CHARPOS (it
) == ZV
15184 && it
.current_y
- y_start
< this_scroll_margin
)
15185 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15188 if (PT
< CHARPOS (scroll_margin_pos
))
15190 /* Point is in the scroll margin at the top of the window or
15191 above what is displayed in the window. */
15194 /* Compute the vertical distance from PT to the scroll
15195 margin position. Move as far as scroll_max allows, or
15196 one screenful, or 10 screen lines, whichever is largest.
15197 Give up if distance is greater than scroll_max or if we
15198 didn't reach the scroll margin position. */
15199 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15200 start_display (&it
, w
, pos
);
15202 y_to_move
= max (it
.last_visible_y
,
15203 max (scroll_max
, 10 * frame_line_height
));
15204 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15206 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15207 dy
= it
.current_y
- y0
;
15208 if (dy
> scroll_max
15209 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15210 return SCROLLING_FAILED
;
15212 /* Additional scroll for when ZV was too close to point. */
15215 /* Compute new window start. */
15216 start_display (&it
, w
, startp
);
15218 if (arg_scroll_conservatively
)
15219 amount_to_scroll
= max (dy
, frame_line_height
*
15220 max (scroll_step
, temp_scroll_step
));
15221 else if (scroll_step
|| temp_scroll_step
)
15222 amount_to_scroll
= scroll_max
;
15225 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15226 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15227 if (NUMBERP (aggressive
))
15229 double float_amount
= XFLOATINT (aggressive
) * height
;
15230 int aggressive_scroll
= float_amount
;
15231 if (aggressive_scroll
== 0 && float_amount
> 0)
15232 aggressive_scroll
= 1;
15233 /* Don't let point enter the scroll margin near
15234 bottom of the window, if the value of
15235 scroll_down_aggressively happens to be too
15237 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15238 aggressive_scroll
= height
- 2*this_scroll_margin
;
15239 amount_to_scroll
= dy
+ aggressive_scroll
;
15243 if (amount_to_scroll
<= 0)
15244 return SCROLLING_FAILED
;
15246 move_it_vertically_backward (&it
, amount_to_scroll
);
15247 startp
= it
.current
.pos
;
15251 /* Run window scroll functions. */
15252 startp
= run_window_scroll_functions (window
, startp
);
15254 /* Display the window. Give up if new fonts are loaded, or if point
15256 if (!try_window (window
, startp
, 0))
15257 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15258 else if (w
->cursor
.vpos
< 0)
15260 clear_glyph_matrix (w
->desired_matrix
);
15261 rc
= SCROLLING_FAILED
;
15265 /* Maybe forget recorded base line for line number display. */
15266 if (!just_this_one_p
15267 || current_buffer
->clip_changed
15268 || BEG_UNCHANGED
< CHARPOS (startp
))
15269 w
->base_line_number
= 0;
15271 /* If cursor ends up on a partially visible line,
15272 treat that as being off the bottom of the screen. */
15273 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
15274 /* It's possible that the cursor is on the first line of the
15275 buffer, which is partially obscured due to a vscroll
15276 (Bug#7537). In that case, avoid looping forever. */
15277 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15279 clear_glyph_matrix (w
->desired_matrix
);
15280 ++extra_scroll_margin_lines
;
15283 rc
= SCROLLING_SUCCESS
;
15290 /* Compute a suitable window start for window W if display of W starts
15291 on a continuation line. Value is non-zero if a new window start
15294 The new window start will be computed, based on W's width, starting
15295 from the start of the continued line. It is the start of the
15296 screen line with the minimum distance from the old start W->start. */
15299 compute_window_start_on_continuation_line (struct window
*w
)
15301 struct text_pos pos
, start_pos
;
15302 int window_start_changed_p
= 0;
15304 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15306 /* If window start is on a continuation line... Window start may be
15307 < BEGV in case there's invisible text at the start of the
15308 buffer (M-x rmail, for example). */
15309 if (CHARPOS (start_pos
) > BEGV
15310 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15313 struct glyph_row
*row
;
15315 /* Handle the case that the window start is out of range. */
15316 if (CHARPOS (start_pos
) < BEGV
)
15317 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15318 else if (CHARPOS (start_pos
) > ZV
)
15319 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15321 /* Find the start of the continued line. This should be fast
15322 because find_newline is fast (newline cache). */
15323 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
15324 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15325 row
, DEFAULT_FACE_ID
);
15326 reseat_at_previous_visible_line_start (&it
);
15328 /* If the line start is "too far" away from the window start,
15329 say it takes too much time to compute a new window start. */
15330 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15331 /* PXW: Do we need upper bounds here? */
15332 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15334 int min_distance
, distance
;
15336 /* Move forward by display lines to find the new window
15337 start. If window width was enlarged, the new start can
15338 be expected to be > the old start. If window width was
15339 decreased, the new window start will be < the old start.
15340 So, we're looking for the display line start with the
15341 minimum distance from the old window start. */
15342 pos
= it
.current
.pos
;
15343 min_distance
= INFINITY
;
15344 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15345 distance
< min_distance
)
15347 min_distance
= distance
;
15348 pos
= it
.current
.pos
;
15349 if (it
.line_wrap
== WORD_WRAP
)
15351 /* Under WORD_WRAP, move_it_by_lines is likely to
15352 overshoot and stop not at the first, but the
15353 second character from the left margin. So in
15354 that case, we need a more tight control on the X
15355 coordinate of the iterator than move_it_by_lines
15356 promises in its contract. The method is to first
15357 go to the last (rightmost) visible character of a
15358 line, then move to the leftmost character on the
15359 next line in a separate call. */
15360 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15361 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15362 move_it_to (&it
, ZV
, 0,
15363 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15364 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15367 move_it_by_lines (&it
, 1);
15370 /* Set the window start there. */
15371 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15372 window_start_changed_p
= 1;
15376 return window_start_changed_p
;
15380 /* Try cursor movement in case text has not changed in window WINDOW,
15381 with window start STARTP. Value is
15383 CURSOR_MOVEMENT_SUCCESS if successful
15385 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15387 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15388 display. *SCROLL_STEP is set to 1, under certain circumstances, if
15389 we want to scroll as if scroll-step were set to 1. See the code.
15391 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15392 which case we have to abort this redisplay, and adjust matrices
15397 CURSOR_MOVEMENT_SUCCESS
,
15398 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15399 CURSOR_MOVEMENT_MUST_SCROLL
,
15400 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15404 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
15406 struct window
*w
= XWINDOW (window
);
15407 struct frame
*f
= XFRAME (w
->frame
);
15408 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15411 if (inhibit_try_cursor_movement
)
15415 /* Previously, there was a check for Lisp integer in the
15416 if-statement below. Now, this field is converted to
15417 ptrdiff_t, thus zero means invalid position in a buffer. */
15418 eassert (w
->last_point
> 0);
15419 /* Likewise there was a check whether window_end_vpos is nil or larger
15420 than the window. Now window_end_vpos is int and so never nil, but
15421 let's leave eassert to check whether it fits in the window. */
15422 eassert (w
->window_end_vpos
< w
->current_matrix
->nrows
);
15424 /* Handle case where text has not changed, only point, and it has
15425 not moved off the frame. */
15426 if (/* Point may be in this window. */
15427 PT
>= CHARPOS (startp
)
15428 /* Selective display hasn't changed. */
15429 && !current_buffer
->clip_changed
15430 /* Function force-mode-line-update is used to force a thorough
15431 redisplay. It sets either windows_or_buffers_changed or
15432 update_mode_lines. So don't take a shortcut here for these
15434 && !update_mode_lines
15435 && !windows_or_buffers_changed
15436 && !f
->cursor_type_changed
15437 && NILP (Vshow_trailing_whitespace
)
15438 /* This code is not used for mini-buffer for the sake of the case
15439 of redisplaying to replace an echo area message; since in
15440 that case the mini-buffer contents per se are usually
15441 unchanged. This code is of no real use in the mini-buffer
15442 since the handling of this_line_start_pos, etc., in redisplay
15443 handles the same cases. */
15444 && !EQ (window
, minibuf_window
)
15445 && (FRAME_WINDOW_P (f
)
15446 || !overlay_arrow_in_current_buffer_p ()))
15448 int this_scroll_margin
, top_scroll_margin
;
15449 struct glyph_row
*row
= NULL
;
15450 int frame_line_height
= default_line_pixel_height (w
);
15451 int window_total_lines
15452 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15455 debug_method_add (w
, "cursor movement");
15458 /* Scroll if point within this distance from the top or bottom
15459 of the window. This is a pixel value. */
15460 if (scroll_margin
> 0)
15462 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15463 this_scroll_margin
*= frame_line_height
;
15466 this_scroll_margin
= 0;
15468 top_scroll_margin
= this_scroll_margin
;
15469 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15470 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15472 /* Start with the row the cursor was displayed during the last
15473 not paused redisplay. Give up if that row is not valid. */
15474 if (w
->last_cursor_vpos
< 0
15475 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15476 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15479 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15480 if (row
->mode_line_p
)
15482 if (!row
->enabled_p
)
15483 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15486 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15488 int scroll_p
= 0, must_scroll
= 0;
15489 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15491 if (PT
> w
->last_point
)
15493 /* Point has moved forward. */
15494 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15495 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15497 eassert (row
->enabled_p
);
15501 /* If the end position of a row equals the start
15502 position of the next row, and PT is at that position,
15503 we would rather display cursor in the next line. */
15504 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15505 && MATRIX_ROW_END_CHARPOS (row
) == PT
15506 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15507 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15508 && !cursor_row_p (row
))
15511 /* If within the scroll margin, scroll. Note that
15512 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15513 the next line would be drawn, and that
15514 this_scroll_margin can be zero. */
15515 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15516 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15517 /* Line is completely visible last line in window
15518 and PT is to be set in the next line. */
15519 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15520 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15521 && !row
->ends_at_zv_p
15522 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15525 else if (PT
< w
->last_point
)
15527 /* Cursor has to be moved backward. Note that PT >=
15528 CHARPOS (startp) because of the outer if-statement. */
15529 while (!row
->mode_line_p
15530 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15531 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15532 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15533 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15534 row
> w
->current_matrix
->rows
15535 && (row
-1)->ends_in_newline_from_string_p
))))
15536 && (row
->y
> top_scroll_margin
15537 || CHARPOS (startp
) == BEGV
))
15539 eassert (row
->enabled_p
);
15543 /* Consider the following case: Window starts at BEGV,
15544 there is invisible, intangible text at BEGV, so that
15545 display starts at some point START > BEGV. It can
15546 happen that we are called with PT somewhere between
15547 BEGV and START. Try to handle that case. */
15548 if (row
< w
->current_matrix
->rows
15549 || row
->mode_line_p
)
15551 row
= w
->current_matrix
->rows
;
15552 if (row
->mode_line_p
)
15556 /* Due to newlines in overlay strings, we may have to
15557 skip forward over overlay strings. */
15558 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15559 && MATRIX_ROW_END_CHARPOS (row
) == PT
15560 && !cursor_row_p (row
))
15563 /* If within the scroll margin, scroll. */
15564 if (row
->y
< top_scroll_margin
15565 && CHARPOS (startp
) != BEGV
)
15570 /* Cursor did not move. So don't scroll even if cursor line
15571 is partially visible, as it was so before. */
15572 rc
= CURSOR_MOVEMENT_SUCCESS
;
15575 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15576 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15578 /* if PT is not in the glyph row, give up. */
15579 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15582 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15583 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15585 struct glyph_row
*row1
;
15587 /* If rows are bidi-reordered and point moved, back up
15588 until we find a row that does not belong to a
15589 continuation line. This is because we must consider
15590 all rows of a continued line as candidates for the
15591 new cursor positioning, since row start and end
15592 positions change non-linearly with vertical position
15594 /* FIXME: Revisit this when glyph ``spilling'' in
15595 continuation lines' rows is implemented for
15596 bidi-reordered rows. */
15597 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15598 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15601 /* If we hit the beginning of the displayed portion
15602 without finding the first row of a continued
15606 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15609 eassert (row
->enabled_p
);
15614 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15615 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15616 /* Make sure this isn't a header line by any chance, since
15617 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15618 && !row
->mode_line_p
15619 && make_cursor_line_fully_visible_p
)
15621 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15622 && !row
->ends_at_zv_p
15623 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15624 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15625 else if (row
->height
> window_box_height (w
))
15627 /* If we end up in a partially visible line, let's
15628 make it fully visible, except when it's taller
15629 than the window, in which case we can't do much
15632 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15636 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15637 if (!cursor_row_fully_visible_p (w
, 0, 1))
15638 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15640 rc
= CURSOR_MOVEMENT_SUCCESS
;
15644 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15645 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15646 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15648 /* With bidi-reordered rows, there could be more than
15649 one candidate row whose start and end positions
15650 occlude point. We need to let set_cursor_from_row
15651 find the best candidate. */
15652 /* FIXME: Revisit this when glyph ``spilling'' in
15653 continuation lines' rows is implemented for
15654 bidi-reordered rows. */
15659 int at_zv_p
= 0, exact_match_p
= 0;
15661 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15662 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15663 && cursor_row_p (row
))
15664 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15666 /* As soon as we've found the exact match for point,
15667 or the first suitable row whose ends_at_zv_p flag
15668 is set, we are done. */
15671 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15672 w
->cursor
.vpos
)->ends_at_zv_p
;
15674 && w
->cursor
.hpos
>= 0
15675 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15678 struct glyph_row
*candidate
=
15679 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15681 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15682 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15685 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15686 || (INTEGERP (g
->object
)
15687 && (g
->charpos
== PT
15688 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15690 if (at_zv_p
|| exact_match_p
)
15692 rc
= CURSOR_MOVEMENT_SUCCESS
;
15696 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15700 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15701 || row
->continued_p
)
15702 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15703 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15704 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15705 /* If we didn't find any candidate rows, or exited the
15706 loop before all the candidates were examined, signal
15707 to the caller that this method failed. */
15708 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15710 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15711 && !row
->continued_p
))
15712 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15714 rc
= CURSOR_MOVEMENT_SUCCESS
;
15720 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15722 rc
= CURSOR_MOVEMENT_SUCCESS
;
15727 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15728 && MATRIX_ROW_START_CHARPOS (row
) == PT
15729 && cursor_row_p (row
));
15738 set_vertical_scroll_bar (struct window
*w
)
15740 ptrdiff_t start
, end
, whole
;
15742 /* Calculate the start and end positions for the current window.
15743 At some point, it would be nice to choose between scrollbars
15744 which reflect the whole buffer size, with special markers
15745 indicating narrowing, and scrollbars which reflect only the
15748 Note that mini-buffers sometimes aren't displaying any text. */
15749 if (!MINI_WINDOW_P (w
)
15750 || (w
== XWINDOW (minibuf_window
)
15751 && NILP (echo_area_buffer
[0])))
15753 struct buffer
*buf
= XBUFFER (w
->contents
);
15754 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15755 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15756 /* I don't think this is guaranteed to be right. For the
15757 moment, we'll pretend it is. */
15758 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15762 if (whole
< (end
- start
))
15763 whole
= end
- start
;
15766 start
= end
= whole
= 0;
15768 /* Indicate what this scroll bar ought to be displaying now. */
15769 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15770 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15771 (w
, end
- start
, whole
, start
);
15775 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15776 selected_window is redisplayed.
15778 We can return without actually redisplaying the window if fonts has been
15779 changed on window's frame. In that case, redisplay_internal will retry.
15781 As one of the important parts of redisplaying a window, we need to
15782 decide whether the previous window-start position (stored in the
15783 window's w->start marker position) is still valid, and if it isn't,
15784 recompute it. Some details about that:
15786 . The previous window-start could be in a continuation line, in
15787 which case we need to recompute it when the window width
15788 changes. See compute_window_start_on_continuation_line and its
15791 . The text that changed since last redisplay could include the
15792 previous window-start position. In that case, we try to salvage
15793 what we can from the current glyph matrix by calling
15794 try_scrolling, which see.
15796 . Some Emacs command could force us to use a specific window-start
15797 position by setting the window's force_start flag, or gently
15798 propose doing that by setting the window's optional_new_start
15799 flag. In these cases, we try using the specified start point if
15800 that succeeds (i.e. the window desired matrix is successfully
15801 recomputed, and point location is within the window). In case
15802 of optional_new_start, we first check if the specified start
15803 position is feasible, i.e. if it will allow point to be
15804 displayed in the window. If using the specified start point
15805 fails, e.g., if new fonts are needed to be loaded, we abort the
15806 redisplay cycle and leave it up to the next cycle to figure out
15809 . Note that the window's force_start flag is sometimes set by
15810 redisplay itself, when it decides that the previous window start
15811 point is fine and should be kept. Search for "goto force_start"
15812 below to see the details. Like the values of window-start
15813 specified outside of redisplay, these internally-deduced values
15814 are tested for feasibility, and ignored if found to be
15817 . Note that the function try_window, used to completely redisplay
15818 a window, accepts the window's start point as its argument.
15819 This is used several times in the redisplay code to control
15820 where the window start will be, according to user options such
15821 as scroll-conservatively, and also to ensure the screen line
15822 showing point will be fully (as opposed to partially) visible on
15826 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15828 struct window
*w
= XWINDOW (window
);
15829 struct frame
*f
= XFRAME (w
->frame
);
15830 struct buffer
*buffer
= XBUFFER (w
->contents
);
15831 struct buffer
*old
= current_buffer
;
15832 struct text_pos lpoint
, opoint
, startp
;
15833 int update_mode_line
;
15836 /* Record it now because it's overwritten. */
15837 bool current_matrix_up_to_date_p
= false;
15838 bool used_current_matrix_p
= false;
15839 /* This is less strict than current_matrix_up_to_date_p.
15840 It indicates that the buffer contents and narrowing are unchanged. */
15841 bool buffer_unchanged_p
= false;
15842 int temp_scroll_step
= 0;
15843 ptrdiff_t count
= SPECPDL_INDEX ();
15845 int centering_position
= -1;
15846 int last_line_misfit
= 0;
15847 ptrdiff_t beg_unchanged
, end_unchanged
;
15848 int frame_line_height
;
15850 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15854 *w
->desired_matrix
->method
= 0;
15857 if (!just_this_one_p
15858 && REDISPLAY_SOME_P ()
15861 && !buffer
->text
->redisplay
15862 && BUF_PT (buffer
) == w
->last_point
)
15865 /* Make sure that both W's markers are valid. */
15866 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15867 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15869 /* We come here again if we need to run window-text-change-functions
15872 reconsider_clip_changes (w
);
15873 frame_line_height
= default_line_pixel_height (w
);
15875 /* Has the mode line to be updated? */
15876 update_mode_line
= (w
->update_mode_line
15877 || update_mode_lines
15878 || buffer
->clip_changed
15879 || buffer
->prevent_redisplay_optimizations_p
);
15881 if (!just_this_one_p
)
15882 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15883 cleverly elsewhere. */
15884 w
->must_be_updated_p
= true;
15886 if (MINI_WINDOW_P (w
))
15888 if (w
== XWINDOW (echo_area_window
)
15889 && !NILP (echo_area_buffer
[0]))
15891 if (update_mode_line
)
15892 /* We may have to update a tty frame's menu bar or a
15893 tool-bar. Example `M-x C-h C-h C-g'. */
15894 goto finish_menu_bars
;
15896 /* We've already displayed the echo area glyphs in this window. */
15897 goto finish_scroll_bars
;
15899 else if ((w
!= XWINDOW (minibuf_window
)
15900 || minibuf_level
== 0)
15901 /* When buffer is nonempty, redisplay window normally. */
15902 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
15903 /* Quail displays non-mini buffers in minibuffer window.
15904 In that case, redisplay the window normally. */
15905 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
15907 /* W is a mini-buffer window, but it's not active, so clear
15909 int yb
= window_text_bottom_y (w
);
15910 struct glyph_row
*row
;
15913 for (y
= 0, row
= w
->desired_matrix
->rows
;
15915 y
+= row
->height
, ++row
)
15916 blank_row (w
, row
, y
);
15917 goto finish_scroll_bars
;
15920 clear_glyph_matrix (w
->desired_matrix
);
15923 /* Otherwise set up data on this window; select its buffer and point
15925 /* Really select the buffer, for the sake of buffer-local
15927 set_buffer_internal_1 (XBUFFER (w
->contents
));
15929 current_matrix_up_to_date_p
15930 = (w
->window_end_valid
15931 && !current_buffer
->clip_changed
15932 && !current_buffer
->prevent_redisplay_optimizations_p
15933 && !window_outdated (w
));
15935 /* Run the window-text-change-functions
15936 if it is possible that the text on the screen has changed
15937 (either due to modification of the text, or any other reason). */
15938 if (!current_matrix_up_to_date_p
15939 && !NILP (Vwindow_text_change_functions
))
15941 safe_run_hooks (Qwindow_text_change_functions
);
15945 beg_unchanged
= BEG_UNCHANGED
;
15946 end_unchanged
= END_UNCHANGED
;
15948 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15950 specbind (Qinhibit_point_motion_hooks
, Qt
);
15953 = (w
->window_end_valid
15954 && !current_buffer
->clip_changed
15955 && !window_outdated (w
));
15957 /* When windows_or_buffers_changed is non-zero, we can't rely
15958 on the window end being valid, so set it to zero there. */
15959 if (windows_or_buffers_changed
)
15961 /* If window starts on a continuation line, maybe adjust the
15962 window start in case the window's width changed. */
15963 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15964 compute_window_start_on_continuation_line (w
);
15966 w
->window_end_valid
= false;
15967 /* If so, we also can't rely on current matrix
15968 and should not fool try_cursor_movement below. */
15969 current_matrix_up_to_date_p
= false;
15972 /* Some sanity checks. */
15973 CHECK_WINDOW_END (w
);
15974 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15976 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15979 if (mode_line_update_needed (w
))
15980 update_mode_line
= 1;
15982 /* Point refers normally to the selected window. For any other
15983 window, set up appropriate value. */
15984 if (!EQ (window
, selected_window
))
15986 ptrdiff_t new_pt
= marker_position (w
->pointm
);
15987 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
15991 new_pt_byte
= BEGV_BYTE
;
15992 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15994 else if (new_pt
> (ZV
- 1))
15997 new_pt_byte
= ZV_BYTE
;
15998 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16001 /* We don't use SET_PT so that the point-motion hooks don't run. */
16002 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16005 /* If any of the character widths specified in the display table
16006 have changed, invalidate the width run cache. It's true that
16007 this may be a bit late to catch such changes, but the rest of
16008 redisplay goes (non-fatally) haywire when the display table is
16009 changed, so why should we worry about doing any better? */
16010 if (current_buffer
->width_run_cache
16011 || (current_buffer
->base_buffer
16012 && current_buffer
->base_buffer
->width_run_cache
))
16014 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16016 if (! disptab_matches_widthtab
16017 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16019 struct buffer
*buf
= current_buffer
;
16021 if (buf
->base_buffer
)
16022 buf
= buf
->base_buffer
;
16023 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16024 recompute_width_table (current_buffer
, disptab
);
16028 /* If window-start is screwed up, choose a new one. */
16029 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16032 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16034 /* If someone specified a new starting point but did not insist,
16035 check whether it can be used. */
16036 if (w
->optional_new_start
16037 && CHARPOS (startp
) >= BEGV
16038 && CHARPOS (startp
) <= ZV
)
16040 w
->optional_new_start
= 0;
16041 start_display (&it
, w
, startp
);
16042 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16043 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16044 if (IT_CHARPOS (it
) == PT
)
16045 w
->force_start
= 1;
16046 /* IT may overshoot PT if text at PT is invisible. */
16047 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
16048 w
->force_start
= 1;
16053 /* Handle case where place to start displaying has been specified,
16054 unless the specified location is outside the accessible range. */
16055 if (w
->force_start
|| window_frozen_p (w
))
16057 /* We set this later on if we have to adjust point. */
16060 w
->force_start
= 0;
16062 w
->window_end_valid
= 0;
16064 /* Forget any recorded base line for line number display. */
16065 if (!buffer_unchanged_p
)
16066 w
->base_line_number
= 0;
16068 /* Redisplay the mode line. Select the buffer properly for that.
16069 Also, run the hook window-scroll-functions
16070 because we have scrolled. */
16071 /* Note, we do this after clearing force_start because
16072 if there's an error, it is better to forget about force_start
16073 than to get into an infinite loop calling the hook functions
16074 and having them get more errors. */
16075 if (!update_mode_line
16076 || ! NILP (Vwindow_scroll_functions
))
16078 update_mode_line
= 1;
16079 w
->update_mode_line
= 1;
16080 startp
= run_window_scroll_functions (window
, startp
);
16083 if (CHARPOS (startp
) < BEGV
)
16084 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16085 else if (CHARPOS (startp
) > ZV
)
16086 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16088 /* Redisplay, then check if cursor has been set during the
16089 redisplay. Give up if new fonts were loaded. */
16090 /* We used to issue a CHECK_MARGINS argument to try_window here,
16091 but this causes scrolling to fail when point begins inside
16092 the scroll margin (bug#148) -- cyd */
16093 if (!try_window (window
, startp
, 0))
16095 w
->force_start
= 1;
16096 clear_glyph_matrix (w
->desired_matrix
);
16097 goto need_larger_matrices
;
16100 if (w
->cursor
.vpos
< 0 && !window_frozen_p (w
))
16102 /* If point does not appear, try to move point so it does
16103 appear. The desired matrix has been built above, so we
16104 can use it here. */
16105 new_vpos
= window_box_height (w
) / 2;
16108 if (!cursor_row_fully_visible_p (w
, 0, 0))
16110 /* Point does appear, but on a line partly visible at end of window.
16111 Move it back to a fully-visible line. */
16112 new_vpos
= window_box_height (w
);
16113 /* But if window_box_height suggests a Y coordinate that is
16114 not less than we already have, that line will clearly not
16115 be fully visible, so give up and scroll the display.
16116 This can happen when the default face uses a font whose
16117 dimensions are different from the frame's default
16119 if (new_vpos
>= w
->cursor
.y
)
16121 w
->cursor
.vpos
= -1;
16122 clear_glyph_matrix (w
->desired_matrix
);
16123 goto try_to_scroll
;
16126 else if (w
->cursor
.vpos
>= 0)
16128 /* Some people insist on not letting point enter the scroll
16129 margin, even though this part handles windows that didn't
16131 int window_total_lines
16132 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16133 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16134 int pixel_margin
= margin
* frame_line_height
;
16135 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16137 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16138 below, which finds the row to move point to, advances by
16139 the Y coordinate of the _next_ row, see the definition of
16140 MATRIX_ROW_BOTTOM_Y. */
16141 if (w
->cursor
.vpos
< margin
+ header_line
)
16143 w
->cursor
.vpos
= -1;
16144 clear_glyph_matrix (w
->desired_matrix
);
16145 goto try_to_scroll
;
16149 int window_height
= window_box_height (w
);
16152 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16153 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16155 w
->cursor
.vpos
= -1;
16156 clear_glyph_matrix (w
->desired_matrix
);
16157 goto try_to_scroll
;
16162 /* If we need to move point for either of the above reasons,
16163 now actually do it. */
16166 struct glyph_row
*row
;
16168 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16169 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16172 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16173 MATRIX_ROW_START_BYTEPOS (row
));
16175 if (w
!= XWINDOW (selected_window
))
16176 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16177 else if (current_buffer
== old
)
16178 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16180 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16182 /* If we are highlighting the region, then we just changed
16183 the region, so redisplay to show it. */
16184 /* FIXME: We need to (re)run pre-redisplay-function! */
16185 /* if (markpos_of_region () >= 0)
16187 clear_glyph_matrix (w->desired_matrix);
16188 if (!try_window (window, startp, 0))
16189 goto need_larger_matrices;
16195 debug_method_add (w
, "forced window start");
16200 /* Handle case where text has not changed, only point, and it has
16201 not moved off the frame, and we are not retrying after hscroll.
16202 (current_matrix_up_to_date_p is nonzero when retrying.) */
16203 if (current_matrix_up_to_date_p
16204 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16205 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16209 case CURSOR_MOVEMENT_SUCCESS
:
16210 used_current_matrix_p
= 1;
16213 case CURSOR_MOVEMENT_MUST_SCROLL
:
16214 goto try_to_scroll
;
16220 /* If current starting point was originally the beginning of a line
16221 but no longer is, find a new starting point. */
16222 else if (w
->start_at_line_beg
16223 && !(CHARPOS (startp
) <= BEGV
16224 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16227 debug_method_add (w
, "recenter 1");
16232 /* Try scrolling with try_window_id. Value is > 0 if update has
16233 been done, it is -1 if we know that the same window start will
16234 not work. It is 0 if unsuccessful for some other reason. */
16235 else if ((tem
= try_window_id (w
)) != 0)
16238 debug_method_add (w
, "try_window_id %d", tem
);
16241 if (f
->fonts_changed
)
16242 goto need_larger_matrices
;
16246 /* Otherwise try_window_id has returned -1 which means that we
16247 don't want the alternative below this comment to execute. */
16249 else if (CHARPOS (startp
) >= BEGV
16250 && CHARPOS (startp
) <= ZV
16251 && PT
>= CHARPOS (startp
)
16252 && (CHARPOS (startp
) < ZV
16253 /* Avoid starting at end of buffer. */
16254 || CHARPOS (startp
) == BEGV
16255 || !window_outdated (w
)))
16257 int d1
, d2
, d3
, d4
, d5
, d6
;
16259 /* If first window line is a continuation line, and window start
16260 is inside the modified region, but the first change is before
16261 current window start, we must select a new window start.
16263 However, if this is the result of a down-mouse event (e.g. by
16264 extending the mouse-drag-overlay), we don't want to select a
16265 new window start, since that would change the position under
16266 the mouse, resulting in an unwanted mouse-movement rather
16267 than a simple mouse-click. */
16268 if (!w
->start_at_line_beg
16269 && NILP (do_mouse_tracking
)
16270 && CHARPOS (startp
) > BEGV
16271 && CHARPOS (startp
) > BEG
+ beg_unchanged
16272 && CHARPOS (startp
) <= Z
- end_unchanged
16273 /* Even if w->start_at_line_beg is nil, a new window may
16274 start at a line_beg, since that's how set_buffer_window
16275 sets it. So, we need to check the return value of
16276 compute_window_start_on_continuation_line. (See also
16278 && XMARKER (w
->start
)->buffer
== current_buffer
16279 && compute_window_start_on_continuation_line (w
)
16280 /* It doesn't make sense to force the window start like we
16281 do at label force_start if it is already known that point
16282 will not be visible in the resulting window, because
16283 doing so will move point from its correct position
16284 instead of scrolling the window to bring point into view.
16286 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
16288 w
->force_start
= 1;
16289 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16294 debug_method_add (w
, "same window start");
16297 /* Try to redisplay starting at same place as before.
16298 If point has not moved off frame, accept the results. */
16299 if (!current_matrix_up_to_date_p
16300 /* Don't use try_window_reusing_current_matrix in this case
16301 because a window scroll function can have changed the
16303 || !NILP (Vwindow_scroll_functions
)
16304 || MINI_WINDOW_P (w
)
16305 || !(used_current_matrix_p
16306 = try_window_reusing_current_matrix (w
)))
16308 IF_DEBUG (debug_method_add (w
, "1"));
16309 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16310 /* -1 means we need to scroll.
16311 0 means we need new matrices, but fonts_changed
16312 is set in that case, so we will detect it below. */
16313 goto try_to_scroll
;
16316 if (f
->fonts_changed
)
16317 goto need_larger_matrices
;
16319 if (w
->cursor
.vpos
>= 0)
16321 if (!just_this_one_p
16322 || current_buffer
->clip_changed
16323 || BEG_UNCHANGED
< CHARPOS (startp
))
16324 /* Forget any recorded base line for line number display. */
16325 w
->base_line_number
= 0;
16327 if (!cursor_row_fully_visible_p (w
, 1, 0))
16329 clear_glyph_matrix (w
->desired_matrix
);
16330 last_line_misfit
= 1;
16332 /* Drop through and scroll. */
16337 clear_glyph_matrix (w
->desired_matrix
);
16342 /* Redisplay the mode line. Select the buffer properly for that. */
16343 if (!update_mode_line
)
16345 update_mode_line
= 1;
16346 w
->update_mode_line
= 1;
16349 /* Try to scroll by specified few lines. */
16350 if ((scroll_conservatively
16351 || emacs_scroll_step
16352 || temp_scroll_step
16353 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16354 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16355 && CHARPOS (startp
) >= BEGV
16356 && CHARPOS (startp
) <= ZV
)
16358 /* The function returns -1 if new fonts were loaded, 1 if
16359 successful, 0 if not successful. */
16360 int ss
= try_scrolling (window
, just_this_one_p
,
16361 scroll_conservatively
,
16363 temp_scroll_step
, last_line_misfit
);
16366 case SCROLLING_SUCCESS
:
16369 case SCROLLING_NEED_LARGER_MATRICES
:
16370 goto need_larger_matrices
;
16372 case SCROLLING_FAILED
:
16380 /* Finally, just choose a place to start which positions point
16381 according to user preferences. */
16386 debug_method_add (w
, "recenter");
16389 /* Forget any previously recorded base line for line number display. */
16390 if (!buffer_unchanged_p
)
16391 w
->base_line_number
= 0;
16393 /* Determine the window start relative to point. */
16394 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16395 it
.current_y
= it
.last_visible_y
;
16396 if (centering_position
< 0)
16398 int window_total_lines
16399 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16402 ? min (scroll_margin
, window_total_lines
/ 4)
16404 ptrdiff_t margin_pos
= CHARPOS (startp
);
16405 Lisp_Object aggressive
;
16408 /* If there is a scroll margin at the top of the window, find
16409 its character position. */
16411 /* Cannot call start_display if startp is not in the
16412 accessible region of the buffer. This can happen when we
16413 have just switched to a different buffer and/or changed
16414 its restriction. In that case, startp is initialized to
16415 the character position 1 (BEGV) because we did not yet
16416 have chance to display the buffer even once. */
16417 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16420 void *it1data
= NULL
;
16422 SAVE_IT (it1
, it
, it1data
);
16423 start_display (&it1
, w
, startp
);
16424 move_it_vertically (&it1
, margin
* frame_line_height
);
16425 margin_pos
= IT_CHARPOS (it1
);
16426 RESTORE_IT (&it
, &it
, it1data
);
16428 scrolling_up
= PT
> margin_pos
;
16431 ? BVAR (current_buffer
, scroll_up_aggressively
)
16432 : BVAR (current_buffer
, scroll_down_aggressively
);
16434 if (!MINI_WINDOW_P (w
)
16435 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16439 /* Setting scroll-conservatively overrides
16440 scroll-*-aggressively. */
16441 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16443 double float_amount
= XFLOATINT (aggressive
);
16445 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16446 if (pt_offset
== 0 && float_amount
> 0)
16448 if (pt_offset
&& margin
> 0)
16451 /* Compute how much to move the window start backward from
16452 point so that point will be displayed where the user
16456 centering_position
= it
.last_visible_y
;
16458 centering_position
-= pt_offset
;
16459 centering_position
-=
16460 frame_line_height
* (1 + margin
+ (last_line_misfit
!= 0))
16461 + WINDOW_HEADER_LINE_HEIGHT (w
);
16462 /* Don't let point enter the scroll margin near top of
16464 if (centering_position
< margin
* frame_line_height
)
16465 centering_position
= margin
* frame_line_height
;
16468 centering_position
= margin
* frame_line_height
+ pt_offset
;
16471 /* Set the window start half the height of the window backward
16473 centering_position
= window_box_height (w
) / 2;
16475 move_it_vertically_backward (&it
, centering_position
);
16477 eassert (IT_CHARPOS (it
) >= BEGV
);
16479 /* The function move_it_vertically_backward may move over more
16480 than the specified y-distance. If it->w is small, e.g. a
16481 mini-buffer window, we may end up in front of the window's
16482 display area. Start displaying at the start of the line
16483 containing PT in this case. */
16484 if (it
.current_y
<= 0)
16486 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16487 move_it_vertically_backward (&it
, 0);
16491 it
.current_x
= it
.hpos
= 0;
16493 /* Set the window start position here explicitly, to avoid an
16494 infinite loop in case the functions in window-scroll-functions
16496 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16498 /* Run scroll hooks. */
16499 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16501 /* Redisplay the window. */
16502 if (!current_matrix_up_to_date_p
16503 || windows_or_buffers_changed
16504 || f
->cursor_type_changed
16505 /* Don't use try_window_reusing_current_matrix in this case
16506 because it can have changed the buffer. */
16507 || !NILP (Vwindow_scroll_functions
)
16508 || !just_this_one_p
16509 || MINI_WINDOW_P (w
)
16510 || !(used_current_matrix_p
16511 = try_window_reusing_current_matrix (w
)))
16512 try_window (window
, startp
, 0);
16514 /* If new fonts have been loaded (due to fontsets), give up. We
16515 have to start a new redisplay since we need to re-adjust glyph
16517 if (f
->fonts_changed
)
16518 goto need_larger_matrices
;
16520 /* If cursor did not appear assume that the middle of the window is
16521 in the first line of the window. Do it again with the next line.
16522 (Imagine a window of height 100, displaying two lines of height
16523 60. Moving back 50 from it->last_visible_y will end in the first
16525 if (w
->cursor
.vpos
< 0)
16527 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16529 clear_glyph_matrix (w
->desired_matrix
);
16530 move_it_by_lines (&it
, 1);
16531 try_window (window
, it
.current
.pos
, 0);
16533 else if (PT
< IT_CHARPOS (it
))
16535 clear_glyph_matrix (w
->desired_matrix
);
16536 move_it_by_lines (&it
, -1);
16537 try_window (window
, it
.current
.pos
, 0);
16541 /* Not much we can do about it. */
16545 /* Consider the following case: Window starts at BEGV, there is
16546 invisible, intangible text at BEGV, so that display starts at
16547 some point START > BEGV. It can happen that we are called with
16548 PT somewhere between BEGV and START. Try to handle that case,
16549 and similar ones. */
16550 if (w
->cursor
.vpos
< 0)
16552 /* First, try locating the proper glyph row for PT. */
16553 struct glyph_row
*row
=
16554 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16556 /* Sometimes point is at the beginning of invisible text that is
16557 before the 1st character displayed in the row. In that case,
16558 row_containing_pos fails to find the row, because no glyphs
16559 with appropriate buffer positions are present in the row.
16560 Therefore, we next try to find the row which shows the 1st
16561 position after the invisible text. */
16565 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16568 if (TEXT_PROP_MEANS_INVISIBLE (val
))
16571 Lisp_Object invis_end
=
16572 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16575 if (NATNUMP (invis_end
))
16576 alt_pos
= XFASTINT (invis_end
);
16579 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16583 /* Finally, fall back on the first row of the window after the
16584 header line (if any). This is slightly better than not
16585 displaying the cursor at all. */
16588 row
= w
->current_matrix
->rows
;
16589 if (row
->mode_line_p
)
16592 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16595 if (!cursor_row_fully_visible_p (w
, 0, 0))
16597 /* If vscroll is enabled, disable it and try again. */
16601 clear_glyph_matrix (w
->desired_matrix
);
16605 /* Users who set scroll-conservatively to a large number want
16606 point just above/below the scroll margin. If we ended up
16607 with point's row partially visible, move the window start to
16608 make that row fully visible and out of the margin. */
16609 if (scroll_conservatively
> SCROLL_LIMIT
)
16611 int window_total_lines
16612 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16615 ? min (scroll_margin
, window_total_lines
/ 4)
16617 int move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16619 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16620 clear_glyph_matrix (w
->desired_matrix
);
16621 if (1 == try_window (window
, it
.current
.pos
,
16622 TRY_WINDOW_CHECK_MARGINS
))
16626 /* If centering point failed to make the whole line visible,
16627 put point at the top instead. That has to make the whole line
16628 visible, if it can be done. */
16629 if (centering_position
== 0)
16632 clear_glyph_matrix (w
->desired_matrix
);
16633 centering_position
= 0;
16639 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16640 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16641 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16643 /* Display the mode line, if we must. */
16644 if ((update_mode_line
16645 /* If window not full width, must redo its mode line
16646 if (a) the window to its side is being redone and
16647 (b) we do a frame-based redisplay. This is a consequence
16648 of how inverted lines are drawn in frame-based redisplay. */
16649 || (!just_this_one_p
16650 && !FRAME_WINDOW_P (f
)
16651 && !WINDOW_FULL_WIDTH_P (w
))
16652 /* Line number to display. */
16653 || w
->base_line_pos
> 0
16654 /* Column number is displayed and different from the one displayed. */
16655 || (w
->column_number_displayed
!= -1
16656 && (w
->column_number_displayed
!= current_column ())))
16657 /* This means that the window has a mode line. */
16658 && (WINDOW_WANTS_MODELINE_P (w
)
16659 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16662 display_mode_lines (w
);
16664 /* If mode line height has changed, arrange for a thorough
16665 immediate redisplay using the correct mode line height. */
16666 if (WINDOW_WANTS_MODELINE_P (w
)
16667 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16669 f
->fonts_changed
= 1;
16670 w
->mode_line_height
= -1;
16671 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16672 = DESIRED_MODE_LINE_HEIGHT (w
);
16675 /* If header line height has changed, arrange for a thorough
16676 immediate redisplay using the correct header line height. */
16677 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16678 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16680 f
->fonts_changed
= 1;
16681 w
->header_line_height
= -1;
16682 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16683 = DESIRED_HEADER_LINE_HEIGHT (w
);
16686 if (f
->fonts_changed
)
16687 goto need_larger_matrices
;
16690 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16692 w
->base_line_pos
= 0;
16693 w
->base_line_number
= 0;
16698 /* When we reach a frame's selected window, redo the frame's menu bar. */
16699 if (update_mode_line
16700 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16702 int redisplay_menu_p
= 0;
16704 if (FRAME_WINDOW_P (f
))
16706 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16707 || defined (HAVE_NS) || defined (USE_GTK)
16708 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16710 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16714 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16716 if (redisplay_menu_p
)
16717 display_menu_bar (w
);
16719 #ifdef HAVE_WINDOW_SYSTEM
16720 if (FRAME_WINDOW_P (f
))
16722 #if defined (USE_GTK) || defined (HAVE_NS)
16723 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16724 redisplay_tool_bar (f
);
16726 if (WINDOWP (f
->tool_bar_window
)
16727 && (FRAME_TOOL_BAR_HEIGHT (f
) > 0
16728 || !NILP (Vauto_resize_tool_bars
))
16729 && redisplay_tool_bar (f
))
16730 ignore_mouse_drag_p
= 1;
16736 #ifdef HAVE_WINDOW_SYSTEM
16737 if (FRAME_WINDOW_P (f
)
16738 && update_window_fringes (w
, (just_this_one_p
16739 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16740 || w
->pseudo_window_p
)))
16744 if (draw_window_fringes (w
, 1))
16746 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16747 x_draw_right_divider (w
);
16749 x_draw_vertical_border (w
);
16755 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16756 x_draw_bottom_divider (w
);
16757 #endif /* HAVE_WINDOW_SYSTEM */
16759 /* We go to this label, with fonts_changed set, if it is
16760 necessary to try again using larger glyph matrices.
16761 We have to redeem the scroll bar even in this case,
16762 because the loop in redisplay_internal expects that. */
16763 need_larger_matrices
:
16765 finish_scroll_bars
:
16767 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16769 /* Set the thumb's position and size. */
16770 set_vertical_scroll_bar (w
);
16772 /* Note that we actually used the scroll bar attached to this
16773 window, so it shouldn't be deleted at the end of redisplay. */
16774 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16775 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16778 /* Restore current_buffer and value of point in it. The window
16779 update may have changed the buffer, so first make sure `opoint'
16780 is still valid (Bug#6177). */
16781 if (CHARPOS (opoint
) < BEGV
)
16782 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16783 else if (CHARPOS (opoint
) > ZV
)
16784 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16786 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16788 set_buffer_internal_1 (old
);
16789 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16790 shorter. This can be caused by log truncation in *Messages*. */
16791 if (CHARPOS (lpoint
) <= ZV
)
16792 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16794 unbind_to (count
, Qnil
);
16798 /* Build the complete desired matrix of WINDOW with a window start
16799 buffer position POS.
16801 Value is 1 if successful. It is zero if fonts were loaded during
16802 redisplay which makes re-adjusting glyph matrices necessary, and -1
16803 if point would appear in the scroll margins.
16804 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16805 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16809 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16811 struct window
*w
= XWINDOW (window
);
16813 struct glyph_row
*last_text_row
= NULL
;
16814 struct frame
*f
= XFRAME (w
->frame
);
16815 int frame_line_height
= default_line_pixel_height (w
);
16817 /* Make POS the new window start. */
16818 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16820 /* Mark cursor position as unknown. No overlay arrow seen. */
16821 w
->cursor
.vpos
= -1;
16822 overlay_arrow_seen
= 0;
16824 /* Initialize iterator and info to start at POS. */
16825 start_display (&it
, w
, pos
);
16827 /* Display all lines of W. */
16828 while (it
.current_y
< it
.last_visible_y
)
16830 if (display_line (&it
))
16831 last_text_row
= it
.glyph_row
- 1;
16832 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16836 /* Don't let the cursor end in the scroll margins. */
16837 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16838 && !MINI_WINDOW_P (w
))
16840 int this_scroll_margin
;
16841 int window_total_lines
16842 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16844 if (scroll_margin
> 0)
16846 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16847 this_scroll_margin
*= frame_line_height
;
16850 this_scroll_margin
= 0;
16852 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16853 && w
->cursor
.y
< this_scroll_margin
16854 && CHARPOS (pos
) > BEGV
16855 && IT_CHARPOS (it
) < ZV
)
16856 /* rms: considering make_cursor_line_fully_visible_p here
16857 seems to give wrong results. We don't want to recenter
16858 when the last line is partly visible, we want to allow
16859 that case to be handled in the usual way. */
16860 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16862 w
->cursor
.vpos
= -1;
16863 clear_glyph_matrix (w
->desired_matrix
);
16868 /* If bottom moved off end of frame, change mode line percentage. */
16869 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
16870 w
->update_mode_line
= 1;
16872 /* Set window_end_pos to the offset of the last character displayed
16873 on the window from the end of current_buffer. Set
16874 window_end_vpos to its row number. */
16877 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16878 adjust_window_ends (w
, last_text_row
, 0);
16880 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
16881 w
->window_end_vpos
)));
16885 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16886 w
->window_end_pos
= Z
- ZV
;
16887 w
->window_end_vpos
= 0;
16890 /* But that is not valid info until redisplay finishes. */
16891 w
->window_end_valid
= 0;
16897 /************************************************************************
16898 Window redisplay reusing current matrix when buffer has not changed
16899 ************************************************************************/
16901 /* Try redisplay of window W showing an unchanged buffer with a
16902 different window start than the last time it was displayed by
16903 reusing its current matrix. Value is non-zero if successful.
16904 W->start is the new window start. */
16907 try_window_reusing_current_matrix (struct window
*w
)
16909 struct frame
*f
= XFRAME (w
->frame
);
16910 struct glyph_row
*bottom_row
;
16913 struct text_pos start
, new_start
;
16914 int nrows_scrolled
, i
;
16915 struct glyph_row
*last_text_row
;
16916 struct glyph_row
*last_reused_text_row
;
16917 struct glyph_row
*start_row
;
16918 int start_vpos
, min_y
, max_y
;
16921 if (inhibit_try_window_reusing
)
16925 if (/* This function doesn't handle terminal frames. */
16926 !FRAME_WINDOW_P (f
)
16927 /* Don't try to reuse the display if windows have been split
16929 || windows_or_buffers_changed
16930 || f
->cursor_type_changed
)
16933 /* Can't do this if showing trailing whitespace. */
16934 if (!NILP (Vshow_trailing_whitespace
))
16937 /* If top-line visibility has changed, give up. */
16938 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16939 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16942 /* Give up if old or new display is scrolled vertically. We could
16943 make this function handle this, but right now it doesn't. */
16944 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16945 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16948 /* The variable new_start now holds the new window start. The old
16949 start `start' can be determined from the current matrix. */
16950 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16951 start
= start_row
->minpos
;
16952 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16954 /* Clear the desired matrix for the display below. */
16955 clear_glyph_matrix (w
->desired_matrix
);
16957 if (CHARPOS (new_start
) <= CHARPOS (start
))
16959 /* Don't use this method if the display starts with an ellipsis
16960 displayed for invisible text. It's not easy to handle that case
16961 below, and it's certainly not worth the effort since this is
16962 not a frequent case. */
16963 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16966 IF_DEBUG (debug_method_add (w
, "twu1"));
16968 /* Display up to a row that can be reused. The variable
16969 last_text_row is set to the last row displayed that displays
16970 text. Note that it.vpos == 0 if or if not there is a
16971 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16972 start_display (&it
, w
, new_start
);
16973 w
->cursor
.vpos
= -1;
16974 last_text_row
= last_reused_text_row
= NULL
;
16976 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
16978 /* If we have reached into the characters in the START row,
16979 that means the line boundaries have changed. So we
16980 can't start copying with the row START. Maybe it will
16981 work to start copying with the following row. */
16982 while (IT_CHARPOS (it
) > CHARPOS (start
))
16984 /* Advance to the next row as the "start". */
16986 start
= start_row
->minpos
;
16987 /* If there are no more rows to try, or just one, give up. */
16988 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16989 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16990 || CHARPOS (start
) == ZV
)
16992 clear_glyph_matrix (w
->desired_matrix
);
16996 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16998 /* If we have reached alignment, we can copy the rest of the
17000 if (IT_CHARPOS (it
) == CHARPOS (start
)
17001 /* Don't accept "alignment" inside a display vector,
17002 since start_row could have started in the middle of
17003 that same display vector (thus their character
17004 positions match), and we have no way of telling if
17005 that is the case. */
17006 && it
.current
.dpvec_index
< 0)
17009 if (display_line (&it
))
17010 last_text_row
= it
.glyph_row
- 1;
17014 /* A value of current_y < last_visible_y means that we stopped
17015 at the previous window start, which in turn means that we
17016 have at least one reusable row. */
17017 if (it
.current_y
< it
.last_visible_y
)
17019 struct glyph_row
*row
;
17021 /* IT.vpos always starts from 0; it counts text lines. */
17022 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17024 /* Find PT if not already found in the lines displayed. */
17025 if (w
->cursor
.vpos
< 0)
17027 int dy
= it
.current_y
- start_row
->y
;
17029 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17030 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17032 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17033 dy
, nrows_scrolled
);
17036 clear_glyph_matrix (w
->desired_matrix
);
17041 /* Scroll the display. Do it before the current matrix is
17042 changed. The problem here is that update has not yet
17043 run, i.e. part of the current matrix is not up to date.
17044 scroll_run_hook will clear the cursor, and use the
17045 current matrix to get the height of the row the cursor is
17047 run
.current_y
= start_row
->y
;
17048 run
.desired_y
= it
.current_y
;
17049 run
.height
= it
.last_visible_y
- it
.current_y
;
17051 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17054 FRAME_RIF (f
)->update_window_begin_hook (w
);
17055 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17056 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17057 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17061 /* Shift current matrix down by nrows_scrolled lines. */
17062 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17063 rotate_matrix (w
->current_matrix
,
17065 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17068 /* Disable lines that must be updated. */
17069 for (i
= 0; i
< nrows_scrolled
; ++i
)
17070 (start_row
+ i
)->enabled_p
= false;
17072 /* Re-compute Y positions. */
17073 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17074 max_y
= it
.last_visible_y
;
17075 for (row
= start_row
+ nrows_scrolled
;
17079 row
->y
= it
.current_y
;
17080 row
->visible_height
= row
->height
;
17082 if (row
->y
< min_y
)
17083 row
->visible_height
-= min_y
- row
->y
;
17084 if (row
->y
+ row
->height
> max_y
)
17085 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17086 if (row
->fringe_bitmap_periodic_p
)
17087 row
->redraw_fringe_bitmaps_p
= 1;
17089 it
.current_y
+= row
->height
;
17091 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17092 last_reused_text_row
= row
;
17093 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17097 /* Disable lines in the current matrix which are now
17098 below the window. */
17099 for (++row
; row
< bottom_row
; ++row
)
17100 row
->enabled_p
= row
->mode_line_p
= 0;
17103 /* Update window_end_pos etc.; last_reused_text_row is the last
17104 reused row from the current matrix containing text, if any.
17105 The value of last_text_row is the last displayed line
17106 containing text. */
17107 if (last_reused_text_row
)
17108 adjust_window_ends (w
, last_reused_text_row
, 1);
17109 else if (last_text_row
)
17110 adjust_window_ends (w
, last_text_row
, 0);
17113 /* This window must be completely empty. */
17114 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17115 w
->window_end_pos
= Z
- ZV
;
17116 w
->window_end_vpos
= 0;
17118 w
->window_end_valid
= 0;
17120 /* Update hint: don't try scrolling again in update_window. */
17121 w
->desired_matrix
->no_scrolling_p
= 1;
17124 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17128 else if (CHARPOS (new_start
) > CHARPOS (start
))
17130 struct glyph_row
*pt_row
, *row
;
17131 struct glyph_row
*first_reusable_row
;
17132 struct glyph_row
*first_row_to_display
;
17134 int yb
= window_text_bottom_y (w
);
17136 /* Find the row starting at new_start, if there is one. Don't
17137 reuse a partially visible line at the end. */
17138 first_reusable_row
= start_row
;
17139 while (first_reusable_row
->enabled_p
17140 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17141 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17142 < CHARPOS (new_start
)))
17143 ++first_reusable_row
;
17145 /* Give up if there is no row to reuse. */
17146 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17147 || !first_reusable_row
->enabled_p
17148 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17149 != CHARPOS (new_start
)))
17152 /* We can reuse fully visible rows beginning with
17153 first_reusable_row to the end of the window. Set
17154 first_row_to_display to the first row that cannot be reused.
17155 Set pt_row to the row containing point, if there is any. */
17157 for (first_row_to_display
= first_reusable_row
;
17158 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17159 ++first_row_to_display
)
17161 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17162 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17163 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17164 && first_row_to_display
->ends_at_zv_p
17165 && pt_row
== NULL
)))
17166 pt_row
= first_row_to_display
;
17169 /* Start displaying at the start of first_row_to_display. */
17170 eassert (first_row_to_display
->y
< yb
);
17171 init_to_row_start (&it
, w
, first_row_to_display
);
17173 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17175 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17177 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17178 + WINDOW_HEADER_LINE_HEIGHT (w
));
17180 /* Display lines beginning with first_row_to_display in the
17181 desired matrix. Set last_text_row to the last row displayed
17182 that displays text. */
17183 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17184 if (pt_row
== NULL
)
17185 w
->cursor
.vpos
= -1;
17186 last_text_row
= NULL
;
17187 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17188 if (display_line (&it
))
17189 last_text_row
= it
.glyph_row
- 1;
17191 /* If point is in a reused row, adjust y and vpos of the cursor
17195 w
->cursor
.vpos
-= nrows_scrolled
;
17196 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17199 /* Give up if point isn't in a row displayed or reused. (This
17200 also handles the case where w->cursor.vpos < nrows_scrolled
17201 after the calls to display_line, which can happen with scroll
17202 margins. See bug#1295.) */
17203 if (w
->cursor
.vpos
< 0)
17205 clear_glyph_matrix (w
->desired_matrix
);
17209 /* Scroll the display. */
17210 run
.current_y
= first_reusable_row
->y
;
17211 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17212 run
.height
= it
.last_visible_y
- run
.current_y
;
17213 dy
= run
.current_y
- run
.desired_y
;
17218 FRAME_RIF (f
)->update_window_begin_hook (w
);
17219 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17220 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17221 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17225 /* Adjust Y positions of reused rows. */
17226 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17227 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17228 max_y
= it
.last_visible_y
;
17229 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17232 row
->visible_height
= row
->height
;
17233 if (row
->y
< min_y
)
17234 row
->visible_height
-= min_y
- row
->y
;
17235 if (row
->y
+ row
->height
> max_y
)
17236 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17237 if (row
->fringe_bitmap_periodic_p
)
17238 row
->redraw_fringe_bitmaps_p
= 1;
17241 /* Scroll the current matrix. */
17242 eassert (nrows_scrolled
> 0);
17243 rotate_matrix (w
->current_matrix
,
17245 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17248 /* Disable rows not reused. */
17249 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17250 row
->enabled_p
= false;
17252 /* Point may have moved to a different line, so we cannot assume that
17253 the previous cursor position is valid; locate the correct row. */
17256 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17258 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17259 && !row
->ends_at_zv_p
;
17263 w
->cursor
.y
= row
->y
;
17265 if (row
< bottom_row
)
17267 /* Can't simply scan the row for point with
17268 bidi-reordered glyph rows. Let set_cursor_from_row
17269 figure out where to put the cursor, and if it fails,
17271 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17273 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17276 clear_glyph_matrix (w
->desired_matrix
);
17282 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17283 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17286 && (!BUFFERP (glyph
->object
)
17287 || glyph
->charpos
< PT
);
17291 w
->cursor
.x
+= glyph
->pixel_width
;
17297 /* Adjust window end. A null value of last_text_row means that
17298 the window end is in reused rows which in turn means that
17299 only its vpos can have changed. */
17301 adjust_window_ends (w
, last_text_row
, 0);
17303 w
->window_end_vpos
-= nrows_scrolled
;
17305 w
->window_end_valid
= 0;
17306 w
->desired_matrix
->no_scrolling_p
= 1;
17309 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17319 /************************************************************************
17320 Window redisplay reusing current matrix when buffer has changed
17321 ************************************************************************/
17323 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17324 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17325 ptrdiff_t *, ptrdiff_t *);
17326 static struct glyph_row
*
17327 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17328 struct glyph_row
*);
17331 /* Return the last row in MATRIX displaying text. If row START is
17332 non-null, start searching with that row. IT gives the dimensions
17333 of the display. Value is null if matrix is empty; otherwise it is
17334 a pointer to the row found. */
17336 static struct glyph_row
*
17337 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17338 struct glyph_row
*start
)
17340 struct glyph_row
*row
, *row_found
;
17342 /* Set row_found to the last row in IT->w's current matrix
17343 displaying text. The loop looks funny but think of partially
17346 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17347 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17349 eassert (row
->enabled_p
);
17351 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17360 /* Return the last row in the current matrix of W that is not affected
17361 by changes at the start of current_buffer that occurred since W's
17362 current matrix was built. Value is null if no such row exists.
17364 BEG_UNCHANGED us the number of characters unchanged at the start of
17365 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17366 first changed character in current_buffer. Characters at positions <
17367 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17368 when the current matrix was built. */
17370 static struct glyph_row
*
17371 find_last_unchanged_at_beg_row (struct window
*w
)
17373 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17374 struct glyph_row
*row
;
17375 struct glyph_row
*row_found
= NULL
;
17376 int yb
= window_text_bottom_y (w
);
17378 /* Find the last row displaying unchanged text. */
17379 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17380 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17381 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17384 if (/* If row ends before first_changed_pos, it is unchanged,
17385 except in some case. */
17386 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17387 /* When row ends in ZV and we write at ZV it is not
17389 && !row
->ends_at_zv_p
17390 /* When first_changed_pos is the end of a continued line,
17391 row is not unchanged because it may be no longer
17393 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17394 && (row
->continued_p
17395 || row
->exact_window_width_line_p
))
17396 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17397 needs to be recomputed, so don't consider this row as
17398 unchanged. This happens when the last line was
17399 bidi-reordered and was killed immediately before this
17400 redisplay cycle. In that case, ROW->end stores the
17401 buffer position of the first visual-order character of
17402 the killed text, which is now beyond ZV. */
17403 && CHARPOS (row
->end
.pos
) <= ZV
)
17406 /* Stop if last visible row. */
17407 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17415 /* Find the first glyph row in the current matrix of W that is not
17416 affected by changes at the end of current_buffer since the
17417 time W's current matrix was built.
17419 Return in *DELTA the number of chars by which buffer positions in
17420 unchanged text at the end of current_buffer must be adjusted.
17422 Return in *DELTA_BYTES the corresponding number of bytes.
17424 Value is null if no such row exists, i.e. all rows are affected by
17427 static struct glyph_row
*
17428 find_first_unchanged_at_end_row (struct window
*w
,
17429 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17431 struct glyph_row
*row
;
17432 struct glyph_row
*row_found
= NULL
;
17434 *delta
= *delta_bytes
= 0;
17436 /* Display must not have been paused, otherwise the current matrix
17437 is not up to date. */
17438 eassert (w
->window_end_valid
);
17440 /* A value of window_end_pos >= END_UNCHANGED means that the window
17441 end is in the range of changed text. If so, there is no
17442 unchanged row at the end of W's current matrix. */
17443 if (w
->window_end_pos
>= END_UNCHANGED
)
17446 /* Set row to the last row in W's current matrix displaying text. */
17447 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17449 /* If matrix is entirely empty, no unchanged row exists. */
17450 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17452 /* The value of row is the last glyph row in the matrix having a
17453 meaningful buffer position in it. The end position of row
17454 corresponds to window_end_pos. This allows us to translate
17455 buffer positions in the current matrix to current buffer
17456 positions for characters not in changed text. */
17458 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17459 ptrdiff_t Z_BYTE_old
=
17460 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17461 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17462 struct glyph_row
*first_text_row
17463 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17465 *delta
= Z
- Z_old
;
17466 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17468 /* Set last_unchanged_pos to the buffer position of the last
17469 character in the buffer that has not been changed. Z is the
17470 index + 1 of the last character in current_buffer, i.e. by
17471 subtracting END_UNCHANGED we get the index of the last
17472 unchanged character, and we have to add BEG to get its buffer
17474 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17475 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17477 /* Search backward from ROW for a row displaying a line that
17478 starts at a minimum position >= last_unchanged_pos_old. */
17479 for (; row
> first_text_row
; --row
)
17481 /* This used to abort, but it can happen.
17482 It is ok to just stop the search instead here. KFS. */
17483 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17486 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17491 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17497 /* Make sure that glyph rows in the current matrix of window W
17498 reference the same glyph memory as corresponding rows in the
17499 frame's frame matrix. This function is called after scrolling W's
17500 current matrix on a terminal frame in try_window_id and
17501 try_window_reusing_current_matrix. */
17504 sync_frame_with_window_matrix_rows (struct window
*w
)
17506 struct frame
*f
= XFRAME (w
->frame
);
17507 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17509 /* Preconditions: W must be a leaf window and full-width. Its frame
17510 must have a frame matrix. */
17511 eassert (BUFFERP (w
->contents
));
17512 eassert (WINDOW_FULL_WIDTH_P (w
));
17513 eassert (!FRAME_WINDOW_P (f
));
17515 /* If W is a full-width window, glyph pointers in W's current matrix
17516 have, by definition, to be the same as glyph pointers in the
17517 corresponding frame matrix. Note that frame matrices have no
17518 marginal areas (see build_frame_matrix). */
17519 window_row
= w
->current_matrix
->rows
;
17520 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17521 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17522 while (window_row
< window_row_end
)
17524 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17525 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17527 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17528 frame_row
->glyphs
[TEXT_AREA
] = start
;
17529 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17530 frame_row
->glyphs
[LAST_AREA
] = end
;
17532 /* Disable frame rows whose corresponding window rows have
17533 been disabled in try_window_id. */
17534 if (!window_row
->enabled_p
)
17535 frame_row
->enabled_p
= false;
17537 ++window_row
, ++frame_row
;
17542 /* Find the glyph row in window W containing CHARPOS. Consider all
17543 rows between START and END (not inclusive). END null means search
17544 all rows to the end of the display area of W. Value is the row
17545 containing CHARPOS or null. */
17548 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17549 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17551 struct glyph_row
*row
= start
;
17552 struct glyph_row
*best_row
= NULL
;
17553 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17556 /* If we happen to start on a header-line, skip that. */
17557 if (row
->mode_line_p
)
17560 if ((end
&& row
>= end
) || !row
->enabled_p
)
17563 last_y
= window_text_bottom_y (w
) - dy
;
17567 /* Give up if we have gone too far. */
17568 if (end
&& row
>= end
)
17570 /* This formerly returned if they were equal.
17571 I think that both quantities are of a "last plus one" type;
17572 if so, when they are equal, the row is within the screen. -- rms. */
17573 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17576 /* If it is in this row, return this row. */
17577 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17578 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17579 /* The end position of a row equals the start
17580 position of the next row. If CHARPOS is there, we
17581 would rather consider it displayed in the next
17582 line, except when this line ends in ZV. */
17583 && !row_for_charpos_p (row
, charpos
)))
17584 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17588 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17589 || (!best_row
&& !row
->continued_p
))
17591 /* In bidi-reordered rows, there could be several rows whose
17592 edges surround CHARPOS, all of these rows belonging to
17593 the same continued line. We need to find the row which
17594 fits CHARPOS the best. */
17595 for (g
= row
->glyphs
[TEXT_AREA
];
17596 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17599 if (!STRINGP (g
->object
))
17601 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17603 mindif
= eabs (g
->charpos
- charpos
);
17605 /* Exact match always wins. */
17612 else if (best_row
&& !row
->continued_p
)
17619 /* Try to redisplay window W by reusing its existing display. W's
17620 current matrix must be up to date when this function is called,
17621 i.e. window_end_valid must be nonzero.
17625 >= 1 if successful, i.e. display has been updated
17627 1 means the changes were in front of a newline that precedes
17628 the window start, and the whole current matrix was reused
17629 2 means the changes were after the last position displayed
17630 in the window, and the whole current matrix was reused
17631 3 means portions of the current matrix were reused, while
17632 some of the screen lines were redrawn
17633 -1 if redisplay with same window start is known not to succeed
17634 0 if otherwise unsuccessful
17636 The following steps are performed:
17638 1. Find the last row in the current matrix of W that is not
17639 affected by changes at the start of current_buffer. If no such row
17642 2. Find the first row in W's current matrix that is not affected by
17643 changes at the end of current_buffer. Maybe there is no such row.
17645 3. Display lines beginning with the row + 1 found in step 1 to the
17646 row found in step 2 or, if step 2 didn't find a row, to the end of
17649 4. If cursor is not known to appear on the window, give up.
17651 5. If display stopped at the row found in step 2, scroll the
17652 display and current matrix as needed.
17654 6. Maybe display some lines at the end of W, if we must. This can
17655 happen under various circumstances, like a partially visible line
17656 becoming fully visible, or because newly displayed lines are displayed
17657 in smaller font sizes.
17659 7. Update W's window end information. */
17662 try_window_id (struct window
*w
)
17664 struct frame
*f
= XFRAME (w
->frame
);
17665 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17666 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17667 struct glyph_row
*last_unchanged_at_beg_row
;
17668 struct glyph_row
*first_unchanged_at_end_row
;
17669 struct glyph_row
*row
;
17670 struct glyph_row
*bottom_row
;
17673 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17675 struct text_pos start_pos
;
17677 int first_unchanged_at_end_vpos
= 0;
17678 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17679 struct text_pos start
;
17680 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17683 if (inhibit_try_window_id
)
17687 /* This is handy for debugging. */
17689 #define GIVE_UP(X) \
17691 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17695 #define GIVE_UP(X) return 0
17698 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17700 /* Don't use this for mini-windows because these can show
17701 messages and mini-buffers, and we don't handle that here. */
17702 if (MINI_WINDOW_P (w
))
17705 /* This flag is used to prevent redisplay optimizations. */
17706 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17709 /* This function's optimizations cannot be used if overlays have
17710 changed in the buffer displayed by the window, so give up if they
17712 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17715 /* Verify that narrowing has not changed.
17716 Also verify that we were not told to prevent redisplay optimizations.
17717 It would be nice to further
17718 reduce the number of cases where this prevents try_window_id. */
17719 if (current_buffer
->clip_changed
17720 || current_buffer
->prevent_redisplay_optimizations_p
)
17723 /* Window must either use window-based redisplay or be full width. */
17724 if (!FRAME_WINDOW_P (f
)
17725 && (!FRAME_LINE_INS_DEL_OK (f
)
17726 || !WINDOW_FULL_WIDTH_P (w
)))
17729 /* Give up if point is known NOT to appear in W. */
17730 if (PT
< CHARPOS (start
))
17733 /* Another way to prevent redisplay optimizations. */
17734 if (w
->last_modified
== 0)
17737 /* Verify that window is not hscrolled. */
17738 if (w
->hscroll
!= 0)
17741 /* Verify that display wasn't paused. */
17742 if (!w
->window_end_valid
)
17745 /* Likewise if highlighting trailing whitespace. */
17746 if (!NILP (Vshow_trailing_whitespace
))
17749 /* Can't use this if overlay arrow position and/or string have
17751 if (overlay_arrows_changed_p ())
17754 /* When word-wrap is on, adding a space to the first word of a
17755 wrapped line can change the wrap position, altering the line
17756 above it. It might be worthwhile to handle this more
17757 intelligently, but for now just redisplay from scratch. */
17758 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17761 /* Under bidi reordering, adding or deleting a character in the
17762 beginning of a paragraph, before the first strong directional
17763 character, can change the base direction of the paragraph (unless
17764 the buffer specifies a fixed paragraph direction), which will
17765 require to redisplay the whole paragraph. It might be worthwhile
17766 to find the paragraph limits and widen the range of redisplayed
17767 lines to that, but for now just give up this optimization and
17768 redisplay from scratch. */
17769 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17770 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17773 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17774 only if buffer has really changed. The reason is that the gap is
17775 initially at Z for freshly visited files. The code below would
17776 set end_unchanged to 0 in that case. */
17777 if (MODIFF
> SAVE_MODIFF
17778 /* This seems to happen sometimes after saving a buffer. */
17779 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17781 if (GPT
- BEG
< BEG_UNCHANGED
)
17782 BEG_UNCHANGED
= GPT
- BEG
;
17783 if (Z
- GPT
< END_UNCHANGED
)
17784 END_UNCHANGED
= Z
- GPT
;
17787 /* The position of the first and last character that has been changed. */
17788 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17789 last_changed_charpos
= Z
- END_UNCHANGED
;
17791 /* If window starts after a line end, and the last change is in
17792 front of that newline, then changes don't affect the display.
17793 This case happens with stealth-fontification. Note that although
17794 the display is unchanged, glyph positions in the matrix have to
17795 be adjusted, of course. */
17796 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17797 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17798 && ((last_changed_charpos
< CHARPOS (start
)
17799 && CHARPOS (start
) == BEGV
)
17800 || (last_changed_charpos
< CHARPOS (start
) - 1
17801 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17803 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17804 struct glyph_row
*r0
;
17806 /* Compute how many chars/bytes have been added to or removed
17807 from the buffer. */
17808 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17809 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17810 Z_delta
= Z
- Z_old
;
17811 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17813 /* Give up if PT is not in the window. Note that it already has
17814 been checked at the start of try_window_id that PT is not in
17815 front of the window start. */
17816 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17819 /* If window start is unchanged, we can reuse the whole matrix
17820 as is, after adjusting glyph positions. No need to compute
17821 the window end again, since its offset from Z hasn't changed. */
17822 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17823 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17824 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17825 /* PT must not be in a partially visible line. */
17826 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17827 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17829 /* Adjust positions in the glyph matrix. */
17830 if (Z_delta
|| Z_delta_bytes
)
17832 struct glyph_row
*r1
17833 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17834 increment_matrix_positions (w
->current_matrix
,
17835 MATRIX_ROW_VPOS (r0
, current_matrix
),
17836 MATRIX_ROW_VPOS (r1
, current_matrix
),
17837 Z_delta
, Z_delta_bytes
);
17840 /* Set the cursor. */
17841 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17843 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17848 /* Handle the case that changes are all below what is displayed in
17849 the window, and that PT is in the window. This shortcut cannot
17850 be taken if ZV is visible in the window, and text has been added
17851 there that is visible in the window. */
17852 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17853 /* ZV is not visible in the window, or there are no
17854 changes at ZV, actually. */
17855 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17856 || first_changed_charpos
== last_changed_charpos
))
17858 struct glyph_row
*r0
;
17860 /* Give up if PT is not in the window. Note that it already has
17861 been checked at the start of try_window_id that PT is not in
17862 front of the window start. */
17863 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17866 /* If window start is unchanged, we can reuse the whole matrix
17867 as is, without changing glyph positions since no text has
17868 been added/removed in front of the window end. */
17869 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17870 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17871 /* PT must not be in a partially visible line. */
17872 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17873 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17875 /* We have to compute the window end anew since text
17876 could have been added/removed after it. */
17877 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
17878 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17880 /* Set the cursor. */
17881 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17883 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17888 /* Give up if window start is in the changed area.
17890 The condition used to read
17892 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17894 but why that was tested escapes me at the moment. */
17895 if (CHARPOS (start
) >= first_changed_charpos
17896 && CHARPOS (start
) <= last_changed_charpos
)
17899 /* Check that window start agrees with the start of the first glyph
17900 row in its current matrix. Check this after we know the window
17901 start is not in changed text, otherwise positions would not be
17903 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17904 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17907 /* Give up if the window ends in strings. Overlay strings
17908 at the end are difficult to handle, so don't try. */
17909 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
17910 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17913 /* Compute the position at which we have to start displaying new
17914 lines. Some of the lines at the top of the window might be
17915 reusable because they are not displaying changed text. Find the
17916 last row in W's current matrix not affected by changes at the
17917 start of current_buffer. Value is null if changes start in the
17918 first line of window. */
17919 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17920 if (last_unchanged_at_beg_row
)
17922 /* Avoid starting to display in the middle of a character, a TAB
17923 for instance. This is easier than to set up the iterator
17924 exactly, and it's not a frequent case, so the additional
17925 effort wouldn't really pay off. */
17926 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17927 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17928 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17929 --last_unchanged_at_beg_row
;
17931 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17934 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17936 start_pos
= it
.current
.pos
;
17938 /* Start displaying new lines in the desired matrix at the same
17939 vpos we would use in the current matrix, i.e. below
17940 last_unchanged_at_beg_row. */
17941 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17943 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17944 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17946 eassert (it
.hpos
== 0 && it
.current_x
== 0);
17950 /* There are no reusable lines at the start of the window.
17951 Start displaying in the first text line. */
17952 start_display (&it
, w
, start
);
17953 it
.vpos
= it
.first_vpos
;
17954 start_pos
= it
.current
.pos
;
17957 /* Find the first row that is not affected by changes at the end of
17958 the buffer. Value will be null if there is no unchanged row, in
17959 which case we must redisplay to the end of the window. delta
17960 will be set to the value by which buffer positions beginning with
17961 first_unchanged_at_end_row have to be adjusted due to text
17963 first_unchanged_at_end_row
17964 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17965 IF_DEBUG (debug_delta
= delta
);
17966 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17968 /* Set stop_pos to the buffer position up to which we will have to
17969 display new lines. If first_unchanged_at_end_row != NULL, this
17970 is the buffer position of the start of the line displayed in that
17971 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17972 that we don't stop at a buffer position. */
17974 if (first_unchanged_at_end_row
)
17976 eassert (last_unchanged_at_beg_row
== NULL
17977 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17979 /* If this is a continuation line, move forward to the next one
17980 that isn't. Changes in lines above affect this line.
17981 Caution: this may move first_unchanged_at_end_row to a row
17982 not displaying text. */
17983 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17984 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17985 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17986 < it
.last_visible_y
))
17987 ++first_unchanged_at_end_row
;
17989 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17990 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17991 >= it
.last_visible_y
))
17992 first_unchanged_at_end_row
= NULL
;
17995 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17997 first_unchanged_at_end_vpos
17998 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17999 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18002 else if (last_unchanged_at_beg_row
== NULL
)
18008 /* Either there is no unchanged row at the end, or the one we have
18009 now displays text. This is a necessary condition for the window
18010 end pos calculation at the end of this function. */
18011 eassert (first_unchanged_at_end_row
== NULL
18012 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18014 debug_last_unchanged_at_beg_vpos
18015 = (last_unchanged_at_beg_row
18016 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18018 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18020 #endif /* GLYPH_DEBUG */
18023 /* Display new lines. Set last_text_row to the last new line
18024 displayed which has text on it, i.e. might end up as being the
18025 line where the window_end_vpos is. */
18026 w
->cursor
.vpos
= -1;
18027 last_text_row
= NULL
;
18028 overlay_arrow_seen
= 0;
18029 while (it
.current_y
< it
.last_visible_y
18030 && !f
->fonts_changed
18031 && (first_unchanged_at_end_row
== NULL
18032 || IT_CHARPOS (it
) < stop_pos
))
18034 if (display_line (&it
))
18035 last_text_row
= it
.glyph_row
- 1;
18038 if (f
->fonts_changed
)
18042 /* Compute differences in buffer positions, y-positions etc. for
18043 lines reused at the bottom of the window. Compute what we can
18045 if (first_unchanged_at_end_row
18046 /* No lines reused because we displayed everything up to the
18047 bottom of the window. */
18048 && it
.current_y
< it
.last_visible_y
)
18051 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18053 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18054 run
.current_y
= first_unchanged_at_end_row
->y
;
18055 run
.desired_y
= run
.current_y
+ dy
;
18056 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18060 delta
= delta_bytes
= dvpos
= dy
18061 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18062 first_unchanged_at_end_row
= NULL
;
18064 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18067 /* Find the cursor if not already found. We have to decide whether
18068 PT will appear on this window (it sometimes doesn't, but this is
18069 not a very frequent case.) This decision has to be made before
18070 the current matrix is altered. A value of cursor.vpos < 0 means
18071 that PT is either in one of the lines beginning at
18072 first_unchanged_at_end_row or below the window. Don't care for
18073 lines that might be displayed later at the window end; as
18074 mentioned, this is not a frequent case. */
18075 if (w
->cursor
.vpos
< 0)
18077 /* Cursor in unchanged rows at the top? */
18078 if (PT
< CHARPOS (start_pos
)
18079 && last_unchanged_at_beg_row
)
18081 row
= row_containing_pos (w
, PT
,
18082 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18083 last_unchanged_at_beg_row
+ 1, 0);
18085 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18088 /* Start from first_unchanged_at_end_row looking for PT. */
18089 else if (first_unchanged_at_end_row
)
18091 row
= row_containing_pos (w
, PT
- delta
,
18092 first_unchanged_at_end_row
, NULL
, 0);
18094 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18095 delta_bytes
, dy
, dvpos
);
18098 /* Give up if cursor was not found. */
18099 if (w
->cursor
.vpos
< 0)
18101 clear_glyph_matrix (w
->desired_matrix
);
18106 /* Don't let the cursor end in the scroll margins. */
18108 int this_scroll_margin
, cursor_height
;
18109 int frame_line_height
= default_line_pixel_height (w
);
18110 int window_total_lines
18111 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18113 this_scroll_margin
=
18114 max (0, min (scroll_margin
, window_total_lines
/ 4));
18115 this_scroll_margin
*= frame_line_height
;
18116 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18118 if ((w
->cursor
.y
< this_scroll_margin
18119 && CHARPOS (start
) > BEGV
)
18120 /* Old redisplay didn't take scroll margin into account at the bottom,
18121 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18122 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18123 ? cursor_height
+ this_scroll_margin
18124 : 1)) > it
.last_visible_y
)
18126 w
->cursor
.vpos
= -1;
18127 clear_glyph_matrix (w
->desired_matrix
);
18132 /* Scroll the display. Do it before changing the current matrix so
18133 that xterm.c doesn't get confused about where the cursor glyph is
18135 if (dy
&& run
.height
)
18139 if (FRAME_WINDOW_P (f
))
18141 FRAME_RIF (f
)->update_window_begin_hook (w
);
18142 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18143 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18144 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
18148 /* Terminal frame. In this case, dvpos gives the number of
18149 lines to scroll by; dvpos < 0 means scroll up. */
18151 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18152 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18153 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18154 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
18155 + window_internal_height (w
));
18157 #if defined (HAVE_GPM) || defined (MSDOS)
18158 x_clear_window_mouse_face (w
);
18160 /* Perform the operation on the screen. */
18163 /* Scroll last_unchanged_at_beg_row to the end of the
18164 window down dvpos lines. */
18165 set_terminal_window (f
, end
);
18167 /* On dumb terminals delete dvpos lines at the end
18168 before inserting dvpos empty lines. */
18169 if (!FRAME_SCROLL_REGION_OK (f
))
18170 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18172 /* Insert dvpos empty lines in front of
18173 last_unchanged_at_beg_row. */
18174 ins_del_lines (f
, from
, dvpos
);
18176 else if (dvpos
< 0)
18178 /* Scroll up last_unchanged_at_beg_vpos to the end of
18179 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18180 set_terminal_window (f
, end
);
18182 /* Delete dvpos lines in front of
18183 last_unchanged_at_beg_vpos. ins_del_lines will set
18184 the cursor to the given vpos and emit |dvpos| delete
18186 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18188 /* On a dumb terminal insert dvpos empty lines at the
18190 if (!FRAME_SCROLL_REGION_OK (f
))
18191 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18194 set_terminal_window (f
, 0);
18200 /* Shift reused rows of the current matrix to the right position.
18201 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18203 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18204 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18207 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18208 bottom_vpos
, dvpos
);
18209 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18212 else if (dvpos
> 0)
18214 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18215 bottom_vpos
, dvpos
);
18216 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18217 first_unchanged_at_end_vpos
+ dvpos
);
18220 /* For frame-based redisplay, make sure that current frame and window
18221 matrix are in sync with respect to glyph memory. */
18222 if (!FRAME_WINDOW_P (f
))
18223 sync_frame_with_window_matrix_rows (w
);
18225 /* Adjust buffer positions in reused rows. */
18226 if (delta
|| delta_bytes
)
18227 increment_matrix_positions (current_matrix
,
18228 first_unchanged_at_end_vpos
+ dvpos
,
18229 bottom_vpos
, delta
, delta_bytes
);
18231 /* Adjust Y positions. */
18233 shift_glyph_matrix (w
, current_matrix
,
18234 first_unchanged_at_end_vpos
+ dvpos
,
18237 if (first_unchanged_at_end_row
)
18239 first_unchanged_at_end_row
+= dvpos
;
18240 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18241 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18242 first_unchanged_at_end_row
= NULL
;
18245 /* If scrolling up, there may be some lines to display at the end of
18247 last_text_row_at_end
= NULL
;
18250 /* Scrolling up can leave for example a partially visible line
18251 at the end of the window to be redisplayed. */
18252 /* Set last_row to the glyph row in the current matrix where the
18253 window end line is found. It has been moved up or down in
18254 the matrix by dvpos. */
18255 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18256 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18258 /* If last_row is the window end line, it should display text. */
18259 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18261 /* If window end line was partially visible before, begin
18262 displaying at that line. Otherwise begin displaying with the
18263 line following it. */
18264 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18266 init_to_row_start (&it
, w
, last_row
);
18267 it
.vpos
= last_vpos
;
18268 it
.current_y
= last_row
->y
;
18272 init_to_row_end (&it
, w
, last_row
);
18273 it
.vpos
= 1 + last_vpos
;
18274 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18278 /* We may start in a continuation line. If so, we have to
18279 get the right continuation_lines_width and current_x. */
18280 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18281 it
.hpos
= it
.current_x
= 0;
18283 /* Display the rest of the lines at the window end. */
18284 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18285 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18287 /* Is it always sure that the display agrees with lines in
18288 the current matrix? I don't think so, so we mark rows
18289 displayed invalid in the current matrix by setting their
18290 enabled_p flag to zero. */
18291 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18292 if (display_line (&it
))
18293 last_text_row_at_end
= it
.glyph_row
- 1;
18297 /* Update window_end_pos and window_end_vpos. */
18298 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18300 /* Window end line if one of the preserved rows from the current
18301 matrix. Set row to the last row displaying text in current
18302 matrix starting at first_unchanged_at_end_row, after
18304 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18305 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18306 first_unchanged_at_end_row
);
18307 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18308 adjust_window_ends (w
, row
, 1);
18309 eassert (w
->window_end_bytepos
>= 0);
18310 IF_DEBUG (debug_method_add (w
, "A"));
18312 else if (last_text_row_at_end
)
18314 adjust_window_ends (w
, last_text_row_at_end
, 0);
18315 eassert (w
->window_end_bytepos
>= 0);
18316 IF_DEBUG (debug_method_add (w
, "B"));
18318 else if (last_text_row
)
18320 /* We have displayed either to the end of the window or at the
18321 end of the window, i.e. the last row with text is to be found
18322 in the desired matrix. */
18323 adjust_window_ends (w
, last_text_row
, 0);
18324 eassert (w
->window_end_bytepos
>= 0);
18326 else if (first_unchanged_at_end_row
== NULL
18327 && last_text_row
== NULL
18328 && last_text_row_at_end
== NULL
)
18330 /* Displayed to end of window, but no line containing text was
18331 displayed. Lines were deleted at the end of the window. */
18332 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
18333 int vpos
= w
->window_end_vpos
;
18334 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18335 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18338 row
== NULL
&& vpos
>= first_vpos
;
18339 --vpos
, --current_row
, --desired_row
)
18341 if (desired_row
->enabled_p
)
18343 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18346 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18350 eassert (row
!= NULL
);
18351 w
->window_end_vpos
= vpos
+ 1;
18352 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18353 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18354 eassert (w
->window_end_bytepos
>= 0);
18355 IF_DEBUG (debug_method_add (w
, "C"));
18360 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18361 debug_end_vpos
= w
->window_end_vpos
));
18363 /* Record that display has not been completed. */
18364 w
->window_end_valid
= 0;
18365 w
->desired_matrix
->no_scrolling_p
= 1;
18373 /***********************************************************************
18374 More debugging support
18375 ***********************************************************************/
18379 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18380 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18381 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18384 /* Dump the contents of glyph matrix MATRIX on stderr.
18386 GLYPHS 0 means don't show glyph contents.
18387 GLYPHS 1 means show glyphs in short form
18388 GLYPHS > 1 means show glyphs in long form. */
18391 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18394 for (i
= 0; i
< matrix
->nrows
; ++i
)
18395 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18399 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18400 the glyph row and area where the glyph comes from. */
18403 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18405 if (glyph
->type
== CHAR_GLYPH
18406 || glyph
->type
== GLYPHLESS_GLYPH
)
18409 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18410 glyph
- row
->glyphs
[TEXT_AREA
],
18411 (glyph
->type
== CHAR_GLYPH
18415 (BUFFERP (glyph
->object
)
18417 : (STRINGP (glyph
->object
)
18419 : (INTEGERP (glyph
->object
)
18422 glyph
->pixel_width
,
18424 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18428 glyph
->left_box_line_p
,
18429 glyph
->right_box_line_p
);
18431 else if (glyph
->type
== STRETCH_GLYPH
)
18434 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18435 glyph
- row
->glyphs
[TEXT_AREA
],
18438 (BUFFERP (glyph
->object
)
18440 : (STRINGP (glyph
->object
)
18442 : (INTEGERP (glyph
->object
)
18445 glyph
->pixel_width
,
18449 glyph
->left_box_line_p
,
18450 glyph
->right_box_line_p
);
18452 else if (glyph
->type
== IMAGE_GLYPH
)
18455 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18456 glyph
- row
->glyphs
[TEXT_AREA
],
18459 (BUFFERP (glyph
->object
)
18461 : (STRINGP (glyph
->object
)
18463 : (INTEGERP (glyph
->object
)
18466 glyph
->pixel_width
,
18470 glyph
->left_box_line_p
,
18471 glyph
->right_box_line_p
);
18473 else if (glyph
->type
== COMPOSITE_GLYPH
)
18476 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18477 glyph
- row
->glyphs
[TEXT_AREA
],
18480 (BUFFERP (glyph
->object
)
18482 : (STRINGP (glyph
->object
)
18484 : (INTEGERP (glyph
->object
)
18487 glyph
->pixel_width
,
18489 if (glyph
->u
.cmp
.automatic
)
18492 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18493 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18495 glyph
->left_box_line_p
,
18496 glyph
->right_box_line_p
);
18501 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18502 GLYPHS 0 means don't show glyph contents.
18503 GLYPHS 1 means show glyphs in short form
18504 GLYPHS > 1 means show glyphs in long form. */
18507 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18511 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18512 fprintf (stderr
, "==============================================================================\n");
18514 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18515 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18517 MATRIX_ROW_START_CHARPOS (row
),
18518 MATRIX_ROW_END_CHARPOS (row
),
18519 row
->used
[TEXT_AREA
],
18520 row
->contains_overlapping_glyphs_p
,
18522 row
->truncated_on_left_p
,
18523 row
->truncated_on_right_p
,
18525 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18526 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18529 row
->ends_in_middle_of_char_p
,
18530 row
->starts_in_middle_of_char_p
,
18536 row
->visible_height
,
18539 /* The next 3 lines should align to "Start" in the header. */
18540 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18541 row
->end
.overlay_string_index
,
18542 row
->continuation_lines_width
);
18543 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18544 CHARPOS (row
->start
.string_pos
),
18545 CHARPOS (row
->end
.string_pos
));
18546 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18547 row
->end
.dpvec_index
);
18554 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18556 struct glyph
*glyph
= row
->glyphs
[area
];
18557 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18559 /* Glyph for a line end in text. */
18560 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18563 if (glyph
< glyph_end
)
18564 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18566 for (; glyph
< glyph_end
; ++glyph
)
18567 dump_glyph (row
, glyph
, area
);
18570 else if (glyphs
== 1)
18574 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18576 char *s
= alloca (row
->used
[area
] + 4);
18579 for (i
= 0; i
< row
->used
[area
]; ++i
)
18581 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18582 if (i
== row
->used
[area
] - 1
18583 && area
== TEXT_AREA
18584 && INTEGERP (glyph
->object
)
18585 && glyph
->type
== CHAR_GLYPH
18586 && glyph
->u
.ch
== ' ')
18588 strcpy (&s
[i
], "[\\n]");
18591 else if (glyph
->type
== CHAR_GLYPH
18592 && glyph
->u
.ch
< 0x80
18593 && glyph
->u
.ch
>= ' ')
18594 s
[i
] = glyph
->u
.ch
;
18600 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18606 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18607 Sdump_glyph_matrix
, 0, 1, "p",
18608 doc
: /* Dump the current matrix of the selected window to stderr.
18609 Shows contents of glyph row structures. With non-nil
18610 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18611 glyphs in short form, otherwise show glyphs in long form. */)
18612 (Lisp_Object glyphs
)
18614 struct window
*w
= XWINDOW (selected_window
);
18615 struct buffer
*buffer
= XBUFFER (w
->contents
);
18617 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18618 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18619 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18620 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18621 fprintf (stderr
, "=============================================\n");
18622 dump_glyph_matrix (w
->current_matrix
,
18623 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18628 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18629 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
18632 struct frame
*f
= XFRAME (selected_frame
);
18633 dump_glyph_matrix (f
->current_matrix
, 1);
18638 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18639 doc
: /* Dump glyph row ROW to stderr.
18640 GLYPH 0 means don't dump glyphs.
18641 GLYPH 1 means dump glyphs in short form.
18642 GLYPH > 1 or omitted means dump glyphs in long form. */)
18643 (Lisp_Object row
, Lisp_Object glyphs
)
18645 struct glyph_matrix
*matrix
;
18648 CHECK_NUMBER (row
);
18649 matrix
= XWINDOW (selected_window
)->current_matrix
;
18651 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18652 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18654 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18659 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18660 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18661 GLYPH 0 means don't dump glyphs.
18662 GLYPH 1 means dump glyphs in short form.
18663 GLYPH > 1 or omitted means dump glyphs in long form.
18665 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18667 (Lisp_Object row
, Lisp_Object glyphs
)
18669 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18670 struct frame
*sf
= SELECTED_FRAME ();
18671 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18674 CHECK_NUMBER (row
);
18676 if (vpos
>= 0 && vpos
< m
->nrows
)
18677 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18678 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18684 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18685 doc
: /* Toggle tracing of redisplay.
18686 With ARG, turn tracing on if and only if ARG is positive. */)
18690 trace_redisplay_p
= !trace_redisplay_p
;
18693 arg
= Fprefix_numeric_value (arg
);
18694 trace_redisplay_p
= XINT (arg
) > 0;
18701 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18702 doc
: /* Like `format', but print result to stderr.
18703 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18704 (ptrdiff_t nargs
, Lisp_Object
*args
)
18706 Lisp_Object s
= Fformat (nargs
, args
);
18707 fprintf (stderr
, "%s", SDATA (s
));
18711 #endif /* GLYPH_DEBUG */
18715 /***********************************************************************
18716 Building Desired Matrix Rows
18717 ***********************************************************************/
18719 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18720 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18722 static struct glyph_row
*
18723 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18725 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18726 struct buffer
*buffer
= XBUFFER (w
->contents
);
18727 struct buffer
*old
= current_buffer
;
18728 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18729 int arrow_len
= SCHARS (overlay_arrow_string
);
18730 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18731 const unsigned char *p
;
18734 int n_glyphs_before
;
18736 set_buffer_temp (buffer
);
18737 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18738 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18739 SET_TEXT_POS (it
.position
, 0, 0);
18741 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18743 while (p
< arrow_end
)
18745 Lisp_Object face
, ilisp
;
18747 /* Get the next character. */
18749 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18752 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18753 if (! ASCII_CHAR_P (it
.c
))
18754 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18758 /* Get its face. */
18759 ilisp
= make_number (p
- arrow_string
);
18760 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18761 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18763 /* Compute its width, get its glyphs. */
18764 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18765 SET_TEXT_POS (it
.position
, -1, -1);
18766 PRODUCE_GLYPHS (&it
);
18768 /* If this character doesn't fit any more in the line, we have
18769 to remove some glyphs. */
18770 if (it
.current_x
> it
.last_visible_x
)
18772 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18777 set_buffer_temp (old
);
18778 return it
.glyph_row
;
18782 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18783 glyphs to insert is determined by produce_special_glyphs. */
18786 insert_left_trunc_glyphs (struct it
*it
)
18788 struct it truncate_it
;
18789 struct glyph
*from
, *end
, *to
, *toend
;
18791 eassert (!FRAME_WINDOW_P (it
->f
)
18792 || (!it
->glyph_row
->reversed_p
18793 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18794 || (it
->glyph_row
->reversed_p
18795 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18797 /* Get the truncation glyphs. */
18799 truncate_it
.current_x
= 0;
18800 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18801 truncate_it
.glyph_row
= &scratch_glyph_row
;
18802 truncate_it
.area
= TEXT_AREA
;
18803 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18804 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18805 truncate_it
.object
= make_number (0);
18806 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18808 /* Overwrite glyphs from IT with truncation glyphs. */
18809 if (!it
->glyph_row
->reversed_p
)
18811 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18813 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18814 end
= from
+ tused
;
18815 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18816 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18817 if (FRAME_WINDOW_P (it
->f
))
18819 /* On GUI frames, when variable-size fonts are displayed,
18820 the truncation glyphs may need more pixels than the row's
18821 glyphs they overwrite. We overwrite more glyphs to free
18822 enough screen real estate, and enlarge the stretch glyph
18823 on the right (see display_line), if there is one, to
18824 preserve the screen position of the truncation glyphs on
18827 struct glyph
*g
= to
;
18830 /* The first glyph could be partially visible, in which case
18831 it->glyph_row->x will be negative. But we want the left
18832 truncation glyphs to be aligned at the left margin of the
18833 window, so we override the x coordinate at which the row
18835 it
->glyph_row
->x
= 0;
18836 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18838 w
+= g
->pixel_width
;
18841 if (g
- to
- tused
> 0)
18843 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18844 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18846 used
= it
->glyph_row
->used
[TEXT_AREA
];
18847 if (it
->glyph_row
->truncated_on_right_p
18848 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18849 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18852 int extra
= w
- it
->truncation_pixel_width
;
18854 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18861 /* There may be padding glyphs left over. Overwrite them too. */
18862 if (!FRAME_WINDOW_P (it
->f
))
18864 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18866 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18873 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18877 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18879 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18880 that back to front. */
18881 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18882 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18883 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18884 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18885 if (FRAME_WINDOW_P (it
->f
))
18888 struct glyph
*g
= to
;
18890 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
18892 w
+= g
->pixel_width
;
18895 if (to
- g
- tused
> 0)
18897 if (it
->glyph_row
->truncated_on_right_p
18898 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
18899 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
18901 int extra
= w
- it
->truncation_pixel_width
;
18903 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
18907 while (from
>= end
&& to
>= toend
)
18909 if (!FRAME_WINDOW_P (it
->f
))
18911 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18914 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18915 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18916 while (from
>= end
&& to
>= toend
)
18922 /* Need to free some room before prepending additional
18924 int move_by
= from
- end
+ 1;
18925 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18926 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18928 for ( ; g
>= g0
; g
--)
18930 while (from
>= end
)
18932 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18937 /* Compute the hash code for ROW. */
18939 row_hash (struct glyph_row
*row
)
18942 unsigned hashval
= 0;
18944 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18945 for (k
= 0; k
< row
->used
[area
]; ++k
)
18946 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18947 + row
->glyphs
[area
][k
].u
.val
18948 + row
->glyphs
[area
][k
].face_id
18949 + row
->glyphs
[area
][k
].padding_p
18950 + (row
->glyphs
[area
][k
].type
<< 2));
18955 /* Compute the pixel height and width of IT->glyph_row.
18957 Most of the time, ascent and height of a display line will be equal
18958 to the max_ascent and max_height values of the display iterator
18959 structure. This is not the case if
18961 1. We hit ZV without displaying anything. In this case, max_ascent
18962 and max_height will be zero.
18964 2. We have some glyphs that don't contribute to the line height.
18965 (The glyph row flag contributes_to_line_height_p is for future
18966 pixmap extensions).
18968 The first case is easily covered by using default values because in
18969 these cases, the line height does not really matter, except that it
18970 must not be zero. */
18973 compute_line_metrics (struct it
*it
)
18975 struct glyph_row
*row
= it
->glyph_row
;
18977 if (FRAME_WINDOW_P (it
->f
))
18979 int i
, min_y
, max_y
;
18981 /* The line may consist of one space only, that was added to
18982 place the cursor on it. If so, the row's height hasn't been
18984 if (row
->height
== 0)
18986 if (it
->max_ascent
+ it
->max_descent
== 0)
18987 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18988 row
->ascent
= it
->max_ascent
;
18989 row
->height
= it
->max_ascent
+ it
->max_descent
;
18990 row
->phys_ascent
= it
->max_phys_ascent
;
18991 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18992 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18995 /* Compute the width of this line. */
18996 row
->pixel_width
= row
->x
;
18997 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18998 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19000 eassert (row
->pixel_width
>= 0);
19001 eassert (row
->ascent
>= 0 && row
->height
> 0);
19003 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19004 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19006 /* If first line's physical ascent is larger than its logical
19007 ascent, use the physical ascent, and make the row taller.
19008 This makes accented characters fully visible. */
19009 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19010 && row
->phys_ascent
> row
->ascent
)
19012 row
->height
+= row
->phys_ascent
- row
->ascent
;
19013 row
->ascent
= row
->phys_ascent
;
19016 /* Compute how much of the line is visible. */
19017 row
->visible_height
= row
->height
;
19019 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19020 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19022 if (row
->y
< min_y
)
19023 row
->visible_height
-= min_y
- row
->y
;
19024 if (row
->y
+ row
->height
> max_y
)
19025 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19029 row
->pixel_width
= row
->used
[TEXT_AREA
];
19030 if (row
->continued_p
)
19031 row
->pixel_width
-= it
->continuation_pixel_width
;
19032 else if (row
->truncated_on_right_p
)
19033 row
->pixel_width
-= it
->truncation_pixel_width
;
19034 row
->ascent
= row
->phys_ascent
= 0;
19035 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19036 row
->extra_line_spacing
= 0;
19039 /* Compute a hash code for this row. */
19040 row
->hash
= row_hash (row
);
19042 it
->max_ascent
= it
->max_descent
= 0;
19043 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19047 /* Append one space to the glyph row of iterator IT if doing a
19048 window-based redisplay. The space has the same face as
19049 IT->face_id. Value is non-zero if a space was added.
19051 This function is called to make sure that there is always one glyph
19052 at the end of a glyph row that the cursor can be set on under
19053 window-systems. (If there weren't such a glyph we would not know
19054 how wide and tall a box cursor should be displayed).
19056 At the same time this space let's a nicely handle clearing to the
19057 end of the line if the row ends in italic text. */
19060 append_space_for_newline (struct it
*it
, int default_face_p
)
19062 if (FRAME_WINDOW_P (it
->f
))
19064 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19066 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19067 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19069 /* Save some values that must not be changed.
19070 Must save IT->c and IT->len because otherwise
19071 ITERATOR_AT_END_P wouldn't work anymore after
19072 append_space_for_newline has been called. */
19073 enum display_element_type saved_what
= it
->what
;
19074 int saved_c
= it
->c
, saved_len
= it
->len
;
19075 int saved_char_to_display
= it
->char_to_display
;
19076 int saved_x
= it
->current_x
;
19077 int saved_face_id
= it
->face_id
;
19078 int saved_box_end
= it
->end_of_box_run_p
;
19079 struct text_pos saved_pos
;
19080 Lisp_Object saved_object
;
19083 saved_object
= it
->object
;
19084 saved_pos
= it
->position
;
19086 it
->what
= IT_CHARACTER
;
19087 memset (&it
->position
, 0, sizeof it
->position
);
19088 it
->object
= make_number (0);
19089 it
->c
= it
->char_to_display
= ' ';
19092 /* If the default face was remapped, be sure to use the
19093 remapped face for the appended newline. */
19094 if (default_face_p
)
19095 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19096 else if (it
->face_before_selective_p
)
19097 it
->face_id
= it
->saved_face_id
;
19098 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19099 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19100 /* In R2L rows, we will prepend a stretch glyph that will
19101 have the end_of_box_run_p flag set for it, so there's no
19102 need for the appended newline glyph to have that flag
19104 if (it
->glyph_row
->reversed_p
19105 /* But if the appended newline glyph goes all the way to
19106 the end of the row, there will be no stretch glyph,
19107 so leave the box flag set. */
19108 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19109 it
->end_of_box_run_p
= 0;
19111 PRODUCE_GLYPHS (it
);
19113 it
->override_ascent
= -1;
19114 it
->constrain_row_ascent_descent_p
= 0;
19115 it
->current_x
= saved_x
;
19116 it
->object
= saved_object
;
19117 it
->position
= saved_pos
;
19118 it
->what
= saved_what
;
19119 it
->face_id
= saved_face_id
;
19120 it
->len
= saved_len
;
19122 it
->char_to_display
= saved_char_to_display
;
19123 it
->end_of_box_run_p
= saved_box_end
;
19132 /* Extend the face of the last glyph in the text area of IT->glyph_row
19133 to the end of the display line. Called from display_line. If the
19134 glyph row is empty, add a space glyph to it so that we know the
19135 face to draw. Set the glyph row flag fill_line_p. If the glyph
19136 row is R2L, prepend a stretch glyph to cover the empty space to the
19137 left of the leftmost glyph. */
19140 extend_face_to_end_of_line (struct it
*it
)
19142 struct face
*face
, *default_face
;
19143 struct frame
*f
= it
->f
;
19145 /* If line is already filled, do nothing. Non window-system frames
19146 get a grace of one more ``pixel'' because their characters are
19147 1-``pixel'' wide, so they hit the equality too early. This grace
19148 is needed only for R2L rows that are not continued, to produce
19149 one extra blank where we could display the cursor. */
19150 if ((it
->current_x
>= it
->last_visible_x
19151 + (!FRAME_WINDOW_P (f
)
19152 && it
->glyph_row
->reversed_p
19153 && !it
->glyph_row
->continued_p
))
19154 /* If the window has display margins, we will need to extend
19155 their face even if the text area is filled. */
19156 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19157 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19160 /* The default face, possibly remapped. */
19161 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19163 /* Face extension extends the background and box of IT->face_id
19164 to the end of the line. If the background equals the background
19165 of the frame, we don't have to do anything. */
19166 if (it
->face_before_selective_p
)
19167 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19169 face
= FACE_FROM_ID (f
, it
->face_id
);
19171 if (FRAME_WINDOW_P (f
)
19172 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19173 && face
->box
== FACE_NO_BOX
19174 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19175 #ifdef HAVE_WINDOW_SYSTEM
19178 && !it
->glyph_row
->reversed_p
)
19181 /* Set the glyph row flag indicating that the face of the last glyph
19182 in the text area has to be drawn to the end of the text area. */
19183 it
->glyph_row
->fill_line_p
= 1;
19185 /* If current character of IT is not ASCII, make sure we have the
19186 ASCII face. This will be automatically undone the next time
19187 get_next_display_element returns a multibyte character. Note
19188 that the character will always be single byte in unibyte
19190 if (!ASCII_CHAR_P (it
->c
))
19192 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19195 if (FRAME_WINDOW_P (f
))
19197 /* If the row is empty, add a space with the current face of IT,
19198 so that we know which face to draw. */
19199 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19201 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19202 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19203 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19205 /* Mode line and the header line don't have margins, and
19206 likewise the frame's tool-bar window, if there is any. */
19207 if (!(it
->glyph_row
->mode_line_p
19208 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19209 || (WINDOWP (f
->tool_bar_window
)
19210 && it
->w
== XWINDOW (f
->tool_bar_window
))
19214 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19215 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19217 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19218 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19220 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19222 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19223 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19225 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19226 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19228 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19231 #ifdef HAVE_WINDOW_SYSTEM
19232 if (it
->glyph_row
->reversed_p
)
19234 /* Prepend a stretch glyph to the row, such that the
19235 rightmost glyph will be drawn flushed all the way to the
19236 right margin of the window. The stretch glyph that will
19237 occupy the empty space, if any, to the left of the
19239 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19240 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19241 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19243 int row_width
, stretch_ascent
, stretch_width
;
19244 struct text_pos saved_pos
;
19245 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
19247 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19248 row_width
+= g
->pixel_width
;
19249 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
19250 if (stretch_width
> 0)
19253 (((it
->ascent
+ it
->descent
)
19254 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19255 saved_pos
= it
->position
;
19256 memset (&it
->position
, 0, sizeof it
->position
);
19257 saved_avoid_cursor
= it
->avoid_cursor_p
;
19258 it
->avoid_cursor_p
= 1;
19259 saved_face_id
= it
->face_id
;
19260 saved_box_start
= it
->start_of_box_run_p
;
19261 /* The last row's stretch glyph should get the default
19262 face, to avoid painting the rest of the window with
19263 the region face, if the region ends at ZV. */
19264 if (it
->glyph_row
->ends_at_zv_p
)
19265 it
->face_id
= default_face
->id
;
19267 it
->face_id
= face
->id
;
19268 it
->start_of_box_run_p
= 0;
19269 append_stretch_glyph (it
, make_number (0), stretch_width
,
19270 it
->ascent
+ it
->descent
, stretch_ascent
);
19271 it
->position
= saved_pos
;
19272 it
->avoid_cursor_p
= saved_avoid_cursor
;
19273 it
->face_id
= saved_face_id
;
19274 it
->start_of_box_run_p
= saved_box_start
;
19277 #endif /* HAVE_WINDOW_SYSTEM */
19281 /* Save some values that must not be changed. */
19282 int saved_x
= it
->current_x
;
19283 struct text_pos saved_pos
;
19284 Lisp_Object saved_object
;
19285 enum display_element_type saved_what
= it
->what
;
19286 int saved_face_id
= it
->face_id
;
19288 saved_object
= it
->object
;
19289 saved_pos
= it
->position
;
19291 it
->what
= IT_CHARACTER
;
19292 memset (&it
->position
, 0, sizeof it
->position
);
19293 it
->object
= make_number (0);
19294 it
->c
= it
->char_to_display
= ' ';
19297 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19298 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19299 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19300 && !it
->glyph_row
->mode_line_p
19301 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19303 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19304 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19306 for (it
->current_x
= 0; g
< e
; g
++)
19307 it
->current_x
+= g
->pixel_width
;
19309 it
->area
= LEFT_MARGIN_AREA
;
19310 it
->face_id
= default_face
->id
;
19311 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19312 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19314 PRODUCE_GLYPHS (it
);
19315 /* term.c:produce_glyphs advances it->current_x only for
19317 it
->current_x
+= it
->pixel_width
;
19320 it
->current_x
= saved_x
;
19321 it
->area
= TEXT_AREA
;
19324 /* The last row's blank glyphs should get the default face, to
19325 avoid painting the rest of the window with the region face,
19326 if the region ends at ZV. */
19327 if (it
->glyph_row
->ends_at_zv_p
)
19328 it
->face_id
= default_face
->id
;
19330 it
->face_id
= face
->id
;
19331 PRODUCE_GLYPHS (it
);
19333 while (it
->current_x
<= it
->last_visible_x
)
19334 PRODUCE_GLYPHS (it
);
19336 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19337 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19338 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19339 && !it
->glyph_row
->mode_line_p
19340 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19342 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19343 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19345 for ( ; g
< e
; g
++)
19346 it
->current_x
+= g
->pixel_width
;
19348 it
->area
= RIGHT_MARGIN_AREA
;
19349 it
->face_id
= default_face
->id
;
19350 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19351 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19353 PRODUCE_GLYPHS (it
);
19354 it
->current_x
+= it
->pixel_width
;
19357 it
->area
= TEXT_AREA
;
19360 /* Don't count these blanks really. It would let us insert a left
19361 truncation glyph below and make us set the cursor on them, maybe. */
19362 it
->current_x
= saved_x
;
19363 it
->object
= saved_object
;
19364 it
->position
= saved_pos
;
19365 it
->what
= saved_what
;
19366 it
->face_id
= saved_face_id
;
19371 /* Value is non-zero if text starting at CHARPOS in current_buffer is
19372 trailing whitespace. */
19375 trailing_whitespace_p (ptrdiff_t charpos
)
19377 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19380 while (bytepos
< ZV_BYTE
19381 && (c
= FETCH_CHAR (bytepos
),
19382 c
== ' ' || c
== '\t'))
19385 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19387 if (bytepos
!= PT_BYTE
)
19394 /* Highlight trailing whitespace, if any, in ROW. */
19397 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19399 int used
= row
->used
[TEXT_AREA
];
19403 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19404 struct glyph
*glyph
= start
+ used
- 1;
19406 if (row
->reversed_p
)
19408 /* Right-to-left rows need to be processed in the opposite
19409 direction, so swap the edge pointers. */
19411 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19414 /* Skip over glyphs inserted to display the cursor at the
19415 end of a line, for extending the face of the last glyph
19416 to the end of the line on terminals, and for truncation
19417 and continuation glyphs. */
19418 if (!row
->reversed_p
)
19420 while (glyph
>= start
19421 && glyph
->type
== CHAR_GLYPH
19422 && INTEGERP (glyph
->object
))
19427 while (glyph
<= start
19428 && glyph
->type
== CHAR_GLYPH
19429 && INTEGERP (glyph
->object
))
19433 /* If last glyph is a space or stretch, and it's trailing
19434 whitespace, set the face of all trailing whitespace glyphs in
19435 IT->glyph_row to `trailing-whitespace'. */
19436 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19437 && BUFFERP (glyph
->object
)
19438 && (glyph
->type
== STRETCH_GLYPH
19439 || (glyph
->type
== CHAR_GLYPH
19440 && glyph
->u
.ch
== ' '))
19441 && trailing_whitespace_p (glyph
->charpos
))
19443 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
19447 if (!row
->reversed_p
)
19449 while (glyph
>= start
19450 && BUFFERP (glyph
->object
)
19451 && (glyph
->type
== STRETCH_GLYPH
19452 || (glyph
->type
== CHAR_GLYPH
19453 && glyph
->u
.ch
== ' ')))
19454 (glyph
--)->face_id
= face_id
;
19458 while (glyph
<= start
19459 && BUFFERP (glyph
->object
)
19460 && (glyph
->type
== STRETCH_GLYPH
19461 || (glyph
->type
== CHAR_GLYPH
19462 && glyph
->u
.ch
== ' ')))
19463 (glyph
++)->face_id
= face_id
;
19470 /* Value is non-zero if glyph row ROW should be
19471 considered to hold the buffer position CHARPOS. */
19474 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19478 if (charpos
== CHARPOS (row
->end
.pos
)
19479 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19481 /* Suppose the row ends on a string.
19482 Unless the row is continued, that means it ends on a newline
19483 in the string. If it's anything other than a display string
19484 (e.g., a before-string from an overlay), we don't want the
19485 cursor there. (This heuristic seems to give the optimal
19486 behavior for the various types of multi-line strings.)
19487 One exception: if the string has `cursor' property on one of
19488 its characters, we _do_ want the cursor there. */
19489 if (CHARPOS (row
->end
.string_pos
) >= 0)
19491 if (row
->continued_p
)
19495 /* Check for `display' property. */
19496 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19497 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19498 struct glyph
*glyph
;
19501 for (glyph
= end
; glyph
>= beg
; --glyph
)
19502 if (STRINGP (glyph
->object
))
19505 = Fget_char_property (make_number (charpos
),
19509 && display_prop_string_p (prop
, glyph
->object
));
19510 /* If there's a `cursor' property on one of the
19511 string's characters, this row is a cursor row,
19512 even though this is not a display string. */
19515 Lisp_Object s
= glyph
->object
;
19517 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19519 ptrdiff_t gpos
= glyph
->charpos
;
19521 if (!NILP (Fget_char_property (make_number (gpos
),
19533 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19535 /* If the row ends in middle of a real character,
19536 and the line is continued, we want the cursor here.
19537 That's because CHARPOS (ROW->end.pos) would equal
19538 PT if PT is before the character. */
19539 if (!row
->ends_in_ellipsis_p
)
19540 result
= row
->continued_p
;
19542 /* If the row ends in an ellipsis, then
19543 CHARPOS (ROW->end.pos) will equal point after the
19544 invisible text. We want that position to be displayed
19545 after the ellipsis. */
19548 /* If the row ends at ZV, display the cursor at the end of that
19549 row instead of at the start of the row below. */
19550 else if (row
->ends_at_zv_p
)
19559 /* Value is non-zero if glyph row ROW should be
19560 used to hold the cursor. */
19563 cursor_row_p (struct glyph_row
*row
)
19565 return row_for_charpos_p (row
, PT
);
19570 /* Push the property PROP so that it will be rendered at the current
19571 position in IT. Return 1 if PROP was successfully pushed, 0
19572 otherwise. Called from handle_line_prefix to handle the
19573 `line-prefix' and `wrap-prefix' properties. */
19576 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19578 struct text_pos pos
=
19579 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19581 eassert (it
->method
== GET_FROM_BUFFER
19582 || it
->method
== GET_FROM_DISPLAY_VECTOR
19583 || it
->method
== GET_FROM_STRING
);
19585 /* We need to save the current buffer/string position, so it will be
19586 restored by pop_it, because iterate_out_of_display_property
19587 depends on that being set correctly, but some situations leave
19588 it->position not yet set when this function is called. */
19589 push_it (it
, &pos
);
19591 if (STRINGP (prop
))
19593 if (SCHARS (prop
) == 0)
19600 it
->string_from_prefix_prop_p
= 1;
19601 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19602 it
->current
.overlay_string_index
= -1;
19603 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19604 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19605 it
->method
= GET_FROM_STRING
;
19606 it
->stop_charpos
= 0;
19608 it
->base_level_stop
= 0;
19610 /* Force paragraph direction to be that of the parent
19612 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19613 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19615 it
->paragraph_embedding
= L2R
;
19617 /* Set up the bidi iterator for this display string. */
19620 it
->bidi_it
.string
.lstring
= it
->string
;
19621 it
->bidi_it
.string
.s
= NULL
;
19622 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19623 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19624 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19625 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19626 it
->bidi_it
.w
= it
->w
;
19627 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19630 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19632 it
->method
= GET_FROM_STRETCH
;
19635 #ifdef HAVE_WINDOW_SYSTEM
19636 else if (IMAGEP (prop
))
19638 it
->what
= IT_IMAGE
;
19639 it
->image_id
= lookup_image (it
->f
, prop
);
19640 it
->method
= GET_FROM_IMAGE
;
19642 #endif /* HAVE_WINDOW_SYSTEM */
19645 pop_it (it
); /* bogus display property, give up */
19652 /* Return the character-property PROP at the current position in IT. */
19655 get_it_property (struct it
*it
, Lisp_Object prop
)
19657 Lisp_Object position
, object
= it
->object
;
19659 if (STRINGP (object
))
19660 position
= make_number (IT_STRING_CHARPOS (*it
));
19661 else if (BUFFERP (object
))
19663 position
= make_number (IT_CHARPOS (*it
));
19664 object
= it
->window
;
19669 return Fget_char_property (position
, prop
, object
);
19672 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19675 handle_line_prefix (struct it
*it
)
19677 Lisp_Object prefix
;
19679 if (it
->continuation_lines_width
> 0)
19681 prefix
= get_it_property (it
, Qwrap_prefix
);
19683 prefix
= Vwrap_prefix
;
19687 prefix
= get_it_property (it
, Qline_prefix
);
19689 prefix
= Vline_prefix
;
19691 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19693 /* If the prefix is wider than the window, and we try to wrap
19694 it, it would acquire its own wrap prefix, and so on till the
19695 iterator stack overflows. So, don't wrap the prefix. */
19696 it
->line_wrap
= TRUNCATE
;
19697 it
->avoid_cursor_p
= 1;
19703 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19704 only for R2L lines from display_line and display_string, when they
19705 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19706 the line/string needs to be continued on the next glyph row. */
19708 unproduce_glyphs (struct it
*it
, int n
)
19710 struct glyph
*glyph
, *end
;
19712 eassert (it
->glyph_row
);
19713 eassert (it
->glyph_row
->reversed_p
);
19714 eassert (it
->area
== TEXT_AREA
);
19715 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19717 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19718 n
= it
->glyph_row
->used
[TEXT_AREA
];
19719 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19720 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19721 for ( ; glyph
< end
; glyph
++)
19722 glyph
[-n
] = *glyph
;
19725 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19726 and ROW->maxpos. */
19728 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19729 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19730 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19732 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19733 lines' rows is implemented for bidi-reordered rows. */
19735 /* ROW->minpos is the value of min_pos, the minimal buffer position
19736 we have in ROW, or ROW->start.pos if that is smaller. */
19737 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19738 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19740 /* We didn't find buffer positions smaller than ROW->start, or
19741 didn't find _any_ valid buffer positions in any of the glyphs,
19742 so we must trust the iterator's computed positions. */
19743 row
->minpos
= row
->start
.pos
;
19746 max_pos
= CHARPOS (it
->current
.pos
);
19747 max_bpos
= BYTEPOS (it
->current
.pos
);
19750 /* Here are the various use-cases for ending the row, and the
19751 corresponding values for ROW->maxpos:
19753 Line ends in a newline from buffer eol_pos + 1
19754 Line is continued from buffer max_pos + 1
19755 Line is truncated on right it->current.pos
19756 Line ends in a newline from string max_pos + 1(*)
19757 (*) + 1 only when line ends in a forward scan
19758 Line is continued from string max_pos
19759 Line is continued from display vector max_pos
19760 Line is entirely from a string min_pos == max_pos
19761 Line is entirely from a display vector min_pos == max_pos
19762 Line that ends at ZV ZV
19764 If you discover other use-cases, please add them here as
19766 if (row
->ends_at_zv_p
)
19767 row
->maxpos
= it
->current
.pos
;
19768 else if (row
->used
[TEXT_AREA
])
19770 int seen_this_string
= 0;
19771 struct glyph_row
*r1
= row
- 1;
19773 /* Did we see the same display string on the previous row? */
19774 if (STRINGP (it
->object
)
19775 /* this is not the first row */
19776 && row
> it
->w
->desired_matrix
->rows
19777 /* previous row is not the header line */
19778 && !r1
->mode_line_p
19779 /* previous row also ends in a newline from a string */
19780 && r1
->ends_in_newline_from_string_p
)
19782 struct glyph
*start
, *end
;
19784 /* Search for the last glyph of the previous row that came
19785 from buffer or string. Depending on whether the row is
19786 L2R or R2L, we need to process it front to back or the
19787 other way round. */
19788 if (!r1
->reversed_p
)
19790 start
= r1
->glyphs
[TEXT_AREA
];
19791 end
= start
+ r1
->used
[TEXT_AREA
];
19792 /* Glyphs inserted by redisplay have an integer (zero)
19793 as their object. */
19795 && INTEGERP ((end
- 1)->object
)
19796 && (end
- 1)->charpos
<= 0)
19800 if (EQ ((end
- 1)->object
, it
->object
))
19801 seen_this_string
= 1;
19804 /* If all the glyphs of the previous row were inserted
19805 by redisplay, it means the previous row was
19806 produced from a single newline, which is only
19807 possible if that newline came from the same string
19808 as the one which produced this ROW. */
19809 seen_this_string
= 1;
19813 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19814 start
= end
+ r1
->used
[TEXT_AREA
];
19816 && INTEGERP ((end
+ 1)->object
)
19817 && (end
+ 1)->charpos
<= 0)
19821 if (EQ ((end
+ 1)->object
, it
->object
))
19822 seen_this_string
= 1;
19825 seen_this_string
= 1;
19828 /* Take note of each display string that covers a newline only
19829 once, the first time we see it. This is for when a display
19830 string includes more than one newline in it. */
19831 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
19833 /* If we were scanning the buffer forward when we displayed
19834 the string, we want to account for at least one buffer
19835 position that belongs to this row (position covered by
19836 the display string), so that cursor positioning will
19837 consider this row as a candidate when point is at the end
19838 of the visual line represented by this row. This is not
19839 required when scanning back, because max_pos will already
19840 have a much larger value. */
19841 if (CHARPOS (row
->end
.pos
) > max_pos
)
19842 INC_BOTH (max_pos
, max_bpos
);
19843 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19845 else if (CHARPOS (it
->eol_pos
) > 0)
19846 SET_TEXT_POS (row
->maxpos
,
19847 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
19848 else if (row
->continued_p
)
19850 /* If max_pos is different from IT's current position, it
19851 means IT->method does not belong to the display element
19852 at max_pos. However, it also means that the display
19853 element at max_pos was displayed in its entirety on this
19854 line, which is equivalent to saying that the next line
19855 starts at the next buffer position. */
19856 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
19857 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19860 INC_BOTH (max_pos
, max_bpos
);
19861 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19864 else if (row
->truncated_on_right_p
)
19865 /* display_line already called reseat_at_next_visible_line_start,
19866 which puts the iterator at the beginning of the next line, in
19867 the logical order. */
19868 row
->maxpos
= it
->current
.pos
;
19869 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
19870 /* A line that is entirely from a string/image/stretch... */
19871 row
->maxpos
= row
->minpos
;
19876 row
->maxpos
= it
->current
.pos
;
19879 /* Construct the glyph row IT->glyph_row in the desired matrix of
19880 IT->w from text at the current position of IT. See dispextern.h
19881 for an overview of struct it. Value is non-zero if
19882 IT->glyph_row displays text, as opposed to a line displaying ZV
19886 display_line (struct it
*it
)
19888 struct glyph_row
*row
= it
->glyph_row
;
19889 Lisp_Object overlay_arrow_string
;
19891 void *wrap_data
= NULL
;
19892 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
19893 int wrap_row_used
= -1;
19894 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
19895 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
19896 int wrap_row_extra_line_spacing
IF_LINT (= 0);
19897 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
19898 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
19900 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
19901 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
19903 /* We always start displaying at hpos zero even if hscrolled. */
19904 eassert (it
->hpos
== 0 && it
->current_x
== 0);
19906 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
19907 >= it
->w
->desired_matrix
->nrows
)
19909 it
->w
->nrows_scale_factor
++;
19910 it
->f
->fonts_changed
= 1;
19914 /* Clear the result glyph row and enable it. */
19915 prepare_desired_row (it
->w
, row
, false);
19917 row
->y
= it
->current_y
;
19918 row
->start
= it
->start
;
19919 row
->continuation_lines_width
= it
->continuation_lines_width
;
19920 row
->displays_text_p
= 1;
19921 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
19922 it
->starts_in_middle_of_char_p
= 0;
19924 /* Arrange the overlays nicely for our purposes. Usually, we call
19925 display_line on only one line at a time, in which case this
19926 can't really hurt too much, or we call it on lines which appear
19927 one after another in the buffer, in which case all calls to
19928 recenter_overlay_lists but the first will be pretty cheap. */
19929 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
19931 /* Move over display elements that are not visible because we are
19932 hscrolled. This may stop at an x-position < IT->first_visible_x
19933 if the first glyph is partially visible or if we hit a line end. */
19934 if (it
->current_x
< it
->first_visible_x
)
19936 enum move_it_result move_result
;
19938 this_line_min_pos
= row
->start
.pos
;
19939 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
19940 MOVE_TO_POS
| MOVE_TO_X
);
19941 /* If we are under a large hscroll, move_it_in_display_line_to
19942 could hit the end of the line without reaching
19943 it->first_visible_x. Pretend that we did reach it. This is
19944 especially important on a TTY, where we will call
19945 extend_face_to_end_of_line, which needs to know how many
19946 blank glyphs to produce. */
19947 if (it
->current_x
< it
->first_visible_x
19948 && (move_result
== MOVE_NEWLINE_OR_CR
19949 || move_result
== MOVE_POS_MATCH_OR_ZV
))
19950 it
->current_x
= it
->first_visible_x
;
19952 /* Record the smallest positions seen while we moved over
19953 display elements that are not visible. This is needed by
19954 redisplay_internal for optimizing the case where the cursor
19955 stays inside the same line. The rest of this function only
19956 considers positions that are actually displayed, so
19957 RECORD_MAX_MIN_POS will not otherwise record positions that
19958 are hscrolled to the left of the left edge of the window. */
19959 min_pos
= CHARPOS (this_line_min_pos
);
19960 min_bpos
= BYTEPOS (this_line_min_pos
);
19964 /* We only do this when not calling `move_it_in_display_line_to'
19965 above, because move_it_in_display_line_to calls
19966 handle_line_prefix itself. */
19967 handle_line_prefix (it
);
19970 /* Get the initial row height. This is either the height of the
19971 text hscrolled, if there is any, or zero. */
19972 row
->ascent
= it
->max_ascent
;
19973 row
->height
= it
->max_ascent
+ it
->max_descent
;
19974 row
->phys_ascent
= it
->max_phys_ascent
;
19975 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19976 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19978 /* Utility macro to record max and min buffer positions seen until now. */
19979 #define RECORD_MAX_MIN_POS(IT) \
19982 int composition_p = !STRINGP ((IT)->string) \
19983 && ((IT)->what == IT_COMPOSITION); \
19984 ptrdiff_t current_pos = \
19985 composition_p ? (IT)->cmp_it.charpos \
19986 : IT_CHARPOS (*(IT)); \
19987 ptrdiff_t current_bpos = \
19988 composition_p ? CHAR_TO_BYTE (current_pos) \
19989 : IT_BYTEPOS (*(IT)); \
19990 if (current_pos < min_pos) \
19992 min_pos = current_pos; \
19993 min_bpos = current_bpos; \
19995 if (IT_CHARPOS (*it) > max_pos) \
19997 max_pos = IT_CHARPOS (*it); \
19998 max_bpos = IT_BYTEPOS (*it); \
20003 /* Loop generating characters. The loop is left with IT on the next
20004 character to display. */
20007 int n_glyphs_before
, hpos_before
, x_before
;
20009 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20011 /* Retrieve the next thing to display. Value is zero if end of
20013 if (!get_next_display_element (it
))
20015 /* Maybe add a space at the end of this line that is used to
20016 display the cursor there under X. Set the charpos of the
20017 first glyph of blank lines not corresponding to any text
20019 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20020 row
->exact_window_width_line_p
= 1;
20021 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
20022 || row
->used
[TEXT_AREA
] == 0)
20024 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20025 row
->displays_text_p
= 0;
20027 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20028 && (!MINI_WINDOW_P (it
->w
)
20029 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20030 row
->indicate_empty_line_p
= 1;
20033 it
->continuation_lines_width
= 0;
20034 row
->ends_at_zv_p
= 1;
20035 /* A row that displays right-to-left text must always have
20036 its last face extended all the way to the end of line,
20037 even if this row ends in ZV, because we still write to
20038 the screen left to right. We also need to extend the
20039 last face if the default face is remapped to some
20040 different face, otherwise the functions that clear
20041 portions of the screen will clear with the default face's
20042 background color. */
20043 if (row
->reversed_p
20044 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20045 extend_face_to_end_of_line (it
);
20049 /* Now, get the metrics of what we want to display. This also
20050 generates glyphs in `row' (which is IT->glyph_row). */
20051 n_glyphs_before
= row
->used
[TEXT_AREA
];
20054 /* Remember the line height so far in case the next element doesn't
20055 fit on the line. */
20056 if (it
->line_wrap
!= TRUNCATE
)
20058 ascent
= it
->max_ascent
;
20059 descent
= it
->max_descent
;
20060 phys_ascent
= it
->max_phys_ascent
;
20061 phys_descent
= it
->max_phys_descent
;
20063 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20065 if (IT_DISPLAYING_WHITESPACE (it
))
20069 SAVE_IT (wrap_it
, *it
, wrap_data
);
20071 wrap_row_used
= row
->used
[TEXT_AREA
];
20072 wrap_row_ascent
= row
->ascent
;
20073 wrap_row_height
= row
->height
;
20074 wrap_row_phys_ascent
= row
->phys_ascent
;
20075 wrap_row_phys_height
= row
->phys_height
;
20076 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20077 wrap_row_min_pos
= min_pos
;
20078 wrap_row_min_bpos
= min_bpos
;
20079 wrap_row_max_pos
= max_pos
;
20080 wrap_row_max_bpos
= max_bpos
;
20086 PRODUCE_GLYPHS (it
);
20088 /* If this display element was in marginal areas, continue with
20090 if (it
->area
!= TEXT_AREA
)
20092 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20093 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20094 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20095 row
->phys_height
= max (row
->phys_height
,
20096 it
->max_phys_ascent
+ it
->max_phys_descent
);
20097 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20098 it
->max_extra_line_spacing
);
20099 set_iterator_to_next (it
, 1);
20103 /* Does the display element fit on the line? If we truncate
20104 lines, we should draw past the right edge of the window. If
20105 we don't truncate, we want to stop so that we can display the
20106 continuation glyph before the right margin. If lines are
20107 continued, there are two possible strategies for characters
20108 resulting in more than 1 glyph (e.g. tabs): Display as many
20109 glyphs as possible in this line and leave the rest for the
20110 continuation line, or display the whole element in the next
20111 line. Original redisplay did the former, so we do it also. */
20112 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20113 hpos_before
= it
->hpos
;
20116 if (/* Not a newline. */
20118 /* Glyphs produced fit entirely in the line. */
20119 && it
->current_x
< it
->last_visible_x
)
20121 it
->hpos
+= nglyphs
;
20122 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20123 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20124 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20125 row
->phys_height
= max (row
->phys_height
,
20126 it
->max_phys_ascent
+ it
->max_phys_descent
);
20127 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20128 it
->max_extra_line_spacing
);
20129 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
20130 row
->x
= x
- it
->first_visible_x
;
20131 /* Record the maximum and minimum buffer positions seen so
20132 far in glyphs that will be displayed by this row. */
20134 RECORD_MAX_MIN_POS (it
);
20139 struct glyph
*glyph
;
20141 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20143 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20144 new_x
= x
+ glyph
->pixel_width
;
20146 if (/* Lines are continued. */
20147 it
->line_wrap
!= TRUNCATE
20148 && (/* Glyph doesn't fit on the line. */
20149 new_x
> it
->last_visible_x
20150 /* Or it fits exactly on a window system frame. */
20151 || (new_x
== it
->last_visible_x
20152 && FRAME_WINDOW_P (it
->f
)
20153 && (row
->reversed_p
20154 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20155 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20157 /* End of a continued line. */
20160 || (new_x
== it
->last_visible_x
20161 && FRAME_WINDOW_P (it
->f
)
20162 && (row
->reversed_p
20163 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20164 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20166 /* Current glyph is the only one on the line or
20167 fits exactly on the line. We must continue
20168 the line because we can't draw the cursor
20169 after the glyph. */
20170 row
->continued_p
= 1;
20171 it
->current_x
= new_x
;
20172 it
->continuation_lines_width
+= new_x
;
20174 if (i
== nglyphs
- 1)
20176 /* If line-wrap is on, check if a previous
20177 wrap point was found. */
20178 if (wrap_row_used
> 0
20179 /* Even if there is a previous wrap
20180 point, continue the line here as
20181 usual, if (i) the previous character
20182 was a space or tab AND (ii) the
20183 current character is not. */
20185 || IT_DISPLAYING_WHITESPACE (it
)))
20188 /* Record the maximum and minimum buffer
20189 positions seen so far in glyphs that will be
20190 displayed by this row. */
20192 RECORD_MAX_MIN_POS (it
);
20193 set_iterator_to_next (it
, 1);
20194 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20196 if (!get_next_display_element (it
))
20198 row
->exact_window_width_line_p
= 1;
20199 it
->continuation_lines_width
= 0;
20200 row
->continued_p
= 0;
20201 row
->ends_at_zv_p
= 1;
20203 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20205 row
->continued_p
= 0;
20206 row
->exact_window_width_line_p
= 1;
20210 else if (it
->bidi_p
)
20211 RECORD_MAX_MIN_POS (it
);
20212 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20213 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20214 extend_face_to_end_of_line (it
);
20216 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20217 && !FRAME_WINDOW_P (it
->f
))
20219 /* A padding glyph that doesn't fit on this line.
20220 This means the whole character doesn't fit
20222 if (row
->reversed_p
)
20223 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20224 - n_glyphs_before
);
20225 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20227 /* Fill the rest of the row with continuation
20228 glyphs like in 20.x. */
20229 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20230 < row
->glyphs
[1 + TEXT_AREA
])
20231 produce_special_glyphs (it
, IT_CONTINUATION
);
20233 row
->continued_p
= 1;
20234 it
->current_x
= x_before
;
20235 it
->continuation_lines_width
+= x_before
;
20237 /* Restore the height to what it was before the
20238 element not fitting on the line. */
20239 it
->max_ascent
= ascent
;
20240 it
->max_descent
= descent
;
20241 it
->max_phys_ascent
= phys_ascent
;
20242 it
->max_phys_descent
= phys_descent
;
20243 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20244 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20245 extend_face_to_end_of_line (it
);
20247 else if (wrap_row_used
> 0)
20250 if (row
->reversed_p
)
20251 unproduce_glyphs (it
,
20252 row
->used
[TEXT_AREA
] - wrap_row_used
);
20253 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20254 it
->continuation_lines_width
+= wrap_x
;
20255 row
->used
[TEXT_AREA
] = wrap_row_used
;
20256 row
->ascent
= wrap_row_ascent
;
20257 row
->height
= wrap_row_height
;
20258 row
->phys_ascent
= wrap_row_phys_ascent
;
20259 row
->phys_height
= wrap_row_phys_height
;
20260 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20261 min_pos
= wrap_row_min_pos
;
20262 min_bpos
= wrap_row_min_bpos
;
20263 max_pos
= wrap_row_max_pos
;
20264 max_bpos
= wrap_row_max_bpos
;
20265 row
->continued_p
= 1;
20266 row
->ends_at_zv_p
= 0;
20267 row
->exact_window_width_line_p
= 0;
20268 it
->continuation_lines_width
+= x
;
20270 /* Make sure that a non-default face is extended
20271 up to the right margin of the window. */
20272 extend_face_to_end_of_line (it
);
20274 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20276 /* A TAB that extends past the right edge of the
20277 window. This produces a single glyph on
20278 window system frames. We leave the glyph in
20279 this row and let it fill the row, but don't
20280 consume the TAB. */
20281 if ((row
->reversed_p
20282 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20283 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20284 produce_special_glyphs (it
, IT_CONTINUATION
);
20285 it
->continuation_lines_width
+= it
->last_visible_x
;
20286 row
->ends_in_middle_of_char_p
= 1;
20287 row
->continued_p
= 1;
20288 glyph
->pixel_width
= it
->last_visible_x
- x
;
20289 it
->starts_in_middle_of_char_p
= 1;
20290 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20291 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20292 extend_face_to_end_of_line (it
);
20296 /* Something other than a TAB that draws past
20297 the right edge of the window. Restore
20298 positions to values before the element. */
20299 if (row
->reversed_p
)
20300 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20301 - (n_glyphs_before
+ i
));
20302 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20304 /* Display continuation glyphs. */
20305 it
->current_x
= x_before
;
20306 it
->continuation_lines_width
+= x
;
20307 if (!FRAME_WINDOW_P (it
->f
)
20308 || (row
->reversed_p
20309 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20310 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20311 produce_special_glyphs (it
, IT_CONTINUATION
);
20312 row
->continued_p
= 1;
20314 extend_face_to_end_of_line (it
);
20316 if (nglyphs
> 1 && i
> 0)
20318 row
->ends_in_middle_of_char_p
= 1;
20319 it
->starts_in_middle_of_char_p
= 1;
20322 /* Restore the height to what it was before the
20323 element not fitting on the line. */
20324 it
->max_ascent
= ascent
;
20325 it
->max_descent
= descent
;
20326 it
->max_phys_ascent
= phys_ascent
;
20327 it
->max_phys_descent
= phys_descent
;
20332 else if (new_x
> it
->first_visible_x
)
20334 /* Increment number of glyphs actually displayed. */
20337 /* Record the maximum and minimum buffer positions
20338 seen so far in glyphs that will be displayed by
20341 RECORD_MAX_MIN_POS (it
);
20343 if (x
< it
->first_visible_x
)
20344 /* Glyph is partially visible, i.e. row starts at
20345 negative X position. */
20346 row
->x
= x
- it
->first_visible_x
;
20350 /* Glyph is completely off the left margin of the
20351 window. This should not happen because of the
20352 move_it_in_display_line at the start of this
20353 function, unless the text display area of the
20354 window is empty. */
20355 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20358 /* Even if this display element produced no glyphs at all,
20359 we want to record its position. */
20360 if (it
->bidi_p
&& nglyphs
== 0)
20361 RECORD_MAX_MIN_POS (it
);
20363 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20364 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20365 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20366 row
->phys_height
= max (row
->phys_height
,
20367 it
->max_phys_ascent
+ it
->max_phys_descent
);
20368 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20369 it
->max_extra_line_spacing
);
20371 /* End of this display line if row is continued. */
20372 if (row
->continued_p
|| row
->ends_at_zv_p
)
20377 /* Is this a line end? If yes, we're also done, after making
20378 sure that a non-default face is extended up to the right
20379 margin of the window. */
20380 if (ITERATOR_AT_END_OF_LINE_P (it
))
20382 int used_before
= row
->used
[TEXT_AREA
];
20384 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20386 /* Add a space at the end of the line that is used to
20387 display the cursor there. */
20388 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20389 append_space_for_newline (it
, 0);
20391 /* Extend the face to the end of the line. */
20392 extend_face_to_end_of_line (it
);
20394 /* Make sure we have the position. */
20395 if (used_before
== 0)
20396 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20398 /* Record the position of the newline, for use in
20400 it
->eol_pos
= it
->current
.pos
;
20402 /* Consume the line end. This skips over invisible lines. */
20403 set_iterator_to_next (it
, 1);
20404 it
->continuation_lines_width
= 0;
20408 /* Proceed with next display element. Note that this skips
20409 over lines invisible because of selective display. */
20410 set_iterator_to_next (it
, 1);
20412 /* If we truncate lines, we are done when the last displayed
20413 glyphs reach past the right margin of the window. */
20414 if (it
->line_wrap
== TRUNCATE
20415 && ((FRAME_WINDOW_P (it
->f
)
20416 /* Images are preprocessed in produce_image_glyph such
20417 that they are cropped at the right edge of the
20418 window, so an image glyph will always end exactly at
20419 last_visible_x, even if there's no right fringe. */
20420 && (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) || it
->what
== IT_IMAGE
))
20421 ? (it
->current_x
>= it
->last_visible_x
)
20422 : (it
->current_x
> it
->last_visible_x
)))
20424 /* Maybe add truncation glyphs. */
20425 if (!FRAME_WINDOW_P (it
->f
)
20426 || (row
->reversed_p
20427 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20428 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20432 if (!row
->reversed_p
)
20434 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20435 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20440 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20441 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20443 /* Remove any padding glyphs at the front of ROW, to
20444 make room for the truncation glyphs we will be
20445 adding below. The loop below always inserts at
20446 least one truncation glyph, so also remove the
20447 last glyph added to ROW. */
20448 unproduce_glyphs (it
, i
+ 1);
20449 /* Adjust i for the loop below. */
20450 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20453 /* produce_special_glyphs overwrites the last glyph, so
20454 we don't want that if we want to keep that last
20455 glyph, which means it's an image. */
20456 if (it
->current_x
> it
->last_visible_x
)
20458 it
->current_x
= x_before
;
20459 if (!FRAME_WINDOW_P (it
->f
))
20461 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20463 row
->used
[TEXT_AREA
] = i
;
20464 produce_special_glyphs (it
, IT_TRUNCATION
);
20469 row
->used
[TEXT_AREA
] = i
;
20470 produce_special_glyphs (it
, IT_TRUNCATION
);
20472 it
->hpos
= hpos_before
;
20475 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20477 /* Don't truncate if we can overflow newline into fringe. */
20478 if (!get_next_display_element (it
))
20480 it
->continuation_lines_width
= 0;
20481 row
->ends_at_zv_p
= 1;
20482 row
->exact_window_width_line_p
= 1;
20485 if (ITERATOR_AT_END_OF_LINE_P (it
))
20487 row
->exact_window_width_line_p
= 1;
20488 goto at_end_of_line
;
20490 it
->current_x
= x_before
;
20491 it
->hpos
= hpos_before
;
20494 row
->truncated_on_right_p
= 1;
20495 it
->continuation_lines_width
= 0;
20496 reseat_at_next_visible_line_start (it
, 0);
20497 if (IT_BYTEPOS (*it
) <= BEG_BYTE
)
20498 row
->ends_at_zv_p
= true;
20500 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
20506 bidi_unshelve_cache (wrap_data
, 1);
20508 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20509 at the left window margin. */
20510 if (it
->first_visible_x
20511 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20513 if (!FRAME_WINDOW_P (it
->f
)
20514 || (((row
->reversed_p
20515 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20516 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20517 /* Don't let insert_left_trunc_glyphs overwrite the
20518 first glyph of the row if it is an image. */
20519 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20520 insert_left_trunc_glyphs (it
);
20521 row
->truncated_on_left_p
= 1;
20524 /* Remember the position at which this line ends.
20526 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20527 cannot be before the call to find_row_edges below, since that is
20528 where these positions are determined. */
20529 row
->end
= it
->current
;
20532 row
->minpos
= row
->start
.pos
;
20533 row
->maxpos
= row
->end
.pos
;
20537 /* ROW->minpos and ROW->maxpos must be the smallest and
20538 `1 + the largest' buffer positions in ROW. But if ROW was
20539 bidi-reordered, these two positions can be anywhere in the
20540 row, so we must determine them now. */
20541 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20544 /* If the start of this line is the overlay arrow-position, then
20545 mark this glyph row as the one containing the overlay arrow.
20546 This is clearly a mess with variable size fonts. It would be
20547 better to let it be displayed like cursors under X. */
20548 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20549 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20550 !NILP (overlay_arrow_string
)))
20552 /* Overlay arrow in window redisplay is a fringe bitmap. */
20553 if (STRINGP (overlay_arrow_string
))
20555 struct glyph_row
*arrow_row
20556 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20557 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20558 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20559 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20560 struct glyph
*p2
, *end
;
20562 /* Copy the arrow glyphs. */
20563 while (glyph
< arrow_end
)
20566 /* Throw away padding glyphs. */
20568 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20569 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20575 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20580 eassert (INTEGERP (overlay_arrow_string
));
20581 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20583 overlay_arrow_seen
= 1;
20586 /* Highlight trailing whitespace. */
20587 if (!NILP (Vshow_trailing_whitespace
))
20588 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20590 /* Compute pixel dimensions of this line. */
20591 compute_line_metrics (it
);
20593 /* Implementation note: No changes in the glyphs of ROW or in their
20594 faces can be done past this point, because compute_line_metrics
20595 computes ROW's hash value and stores it within the glyph_row
20598 /* Record whether this row ends inside an ellipsis. */
20599 row
->ends_in_ellipsis_p
20600 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20601 && it
->ellipsis_p
);
20603 /* Save fringe bitmaps in this row. */
20604 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20605 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20606 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20607 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20609 it
->left_user_fringe_bitmap
= 0;
20610 it
->left_user_fringe_face_id
= 0;
20611 it
->right_user_fringe_bitmap
= 0;
20612 it
->right_user_fringe_face_id
= 0;
20614 /* Maybe set the cursor. */
20615 cvpos
= it
->w
->cursor
.vpos
;
20617 /* In bidi-reordered rows, keep checking for proper cursor
20618 position even if one has been found already, because buffer
20619 positions in such rows change non-linearly with ROW->VPOS,
20620 when a line is continued. One exception: when we are at ZV,
20621 display cursor on the first suitable glyph row, since all
20622 the empty rows after that also have their position set to ZV. */
20623 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20624 lines' rows is implemented for bidi-reordered rows. */
20626 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20627 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20628 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20629 && cursor_row_p (row
))
20630 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20632 /* Prepare for the next line. This line starts horizontally at (X
20633 HPOS) = (0 0). Vertical positions are incremented. As a
20634 convenience for the caller, IT->glyph_row is set to the next
20636 it
->current_x
= it
->hpos
= 0;
20637 it
->current_y
+= row
->height
;
20638 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20641 /* The next row should by default use the same value of the
20642 reversed_p flag as this one. set_iterator_to_next decides when
20643 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20644 the flag accordingly. */
20645 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20646 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20647 it
->start
= row
->end
;
20648 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20650 #undef RECORD_MAX_MIN_POS
20653 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20654 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20655 doc
: /* Return paragraph direction at point in BUFFER.
20656 Value is either `left-to-right' or `right-to-left'.
20657 If BUFFER is omitted or nil, it defaults to the current buffer.
20659 Paragraph direction determines how the text in the paragraph is displayed.
20660 In left-to-right paragraphs, text begins at the left margin of the window
20661 and the reading direction is generally left to right. In right-to-left
20662 paragraphs, text begins at the right margin and is read from right to left.
20664 See also `bidi-paragraph-direction'. */)
20665 (Lisp_Object buffer
)
20667 struct buffer
*buf
= current_buffer
;
20668 struct buffer
*old
= buf
;
20670 if (! NILP (buffer
))
20672 CHECK_BUFFER (buffer
);
20673 buf
= XBUFFER (buffer
);
20676 if (NILP (BVAR (buf
, bidi_display_reordering
))
20677 || NILP (BVAR (buf
, enable_multibyte_characters
))
20678 /* When we are loading loadup.el, the character property tables
20679 needed for bidi iteration are not yet available. */
20680 || !NILP (Vpurify_flag
))
20681 return Qleft_to_right
;
20682 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20683 return BVAR (buf
, bidi_paragraph_direction
);
20686 /* Determine the direction from buffer text. We could try to
20687 use current_matrix if it is up to date, but this seems fast
20688 enough as it is. */
20689 struct bidi_it itb
;
20690 ptrdiff_t pos
= BUF_PT (buf
);
20691 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20693 void *itb_data
= bidi_shelve_cache ();
20695 set_buffer_temp (buf
);
20696 /* bidi_paragraph_init finds the base direction of the paragraph
20697 by searching forward from paragraph start. We need the base
20698 direction of the current or _previous_ paragraph, so we need
20699 to make sure we are within that paragraph. To that end, find
20700 the previous non-empty line. */
20701 if (pos
>= ZV
&& pos
> BEGV
)
20702 DEC_BOTH (pos
, bytepos
);
20703 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20704 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20706 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20707 || c
== ' ' || c
== '\t' || c
== '\f')
20709 if (bytepos
<= BEGV_BYTE
)
20714 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20717 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20718 itb
.paragraph_dir
= NEUTRAL_DIR
;
20719 itb
.string
.s
= NULL
;
20720 itb
.string
.lstring
= Qnil
;
20721 itb
.string
.bufpos
= 0;
20722 itb
.string
.from_disp_str
= 0;
20723 itb
.string
.unibyte
= 0;
20724 /* We have no window to use here for ignoring window-specific
20725 overlays. Using NULL for window pointer will cause
20726 compute_display_string_pos to use the current buffer. */
20728 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20729 bidi_unshelve_cache (itb_data
, 0);
20730 set_buffer_temp (old
);
20731 switch (itb
.paragraph_dir
)
20734 return Qleft_to_right
;
20737 return Qright_to_left
;
20745 DEFUN ("move-point-visually", Fmove_point_visually
,
20746 Smove_point_visually
, 1, 1, 0,
20747 doc
: /* Move point in the visual order in the specified DIRECTION.
20748 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
20751 Value is the new character position of point. */)
20752 (Lisp_Object direction
)
20754 struct window
*w
= XWINDOW (selected_window
);
20755 struct buffer
*b
= XBUFFER (w
->contents
);
20756 struct glyph_row
*row
;
20758 Lisp_Object paragraph_dir
;
20760 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
20761 (!(ROW)->continued_p \
20762 && INTEGERP ((GLYPH)->object) \
20763 && (GLYPH)->type == CHAR_GLYPH \
20764 && (GLYPH)->u.ch == ' ' \
20765 && (GLYPH)->charpos >= 0 \
20766 && !(GLYPH)->avoid_cursor_p)
20768 CHECK_NUMBER (direction
);
20769 dir
= XINT (direction
);
20775 /* If current matrix is up-to-date, we can use the information
20776 recorded in the glyphs, at least as long as the goal is on the
20778 if (w
->window_end_valid
20779 && !windows_or_buffers_changed
20781 && !b
->clip_changed
20782 && !b
->prevent_redisplay_optimizations_p
20783 && !window_outdated (w
)
20784 /* We rely below on the cursor coordinates to be up to date, but
20785 we cannot trust them if some command moved point since the
20786 last complete redisplay. */
20787 && w
->last_point
== BUF_PT (b
)
20788 && w
->cursor
.vpos
>= 0
20789 && w
->cursor
.vpos
< w
->current_matrix
->nrows
20790 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
20792 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
20793 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
20794 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
20796 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
20798 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
20800 SET_PT (g
->charpos
);
20801 w
->cursor
.vpos
= -1;
20802 return make_number (PT
);
20804 else if (!INTEGERP (g
->object
) && !EQ (g
->object
, gpt
->object
))
20808 if (BUFFERP (gpt
->object
))
20811 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
20812 new_pos
+= (row
->reversed_p
? -dir
: dir
);
20814 new_pos
-= (row
->reversed_p
? -dir
: dir
);;
20816 else if (BUFFERP (g
->object
))
20817 new_pos
= g
->charpos
;
20821 w
->cursor
.vpos
= -1;
20822 return make_number (PT
);
20824 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
20826 /* Glyphs inserted at the end of a non-empty line for
20827 positioning the cursor have zero charpos, so we must
20828 deduce the value of point by other means. */
20829 if (g
->charpos
> 0)
20830 SET_PT (g
->charpos
);
20831 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
20833 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
20834 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
20837 w
->cursor
.vpos
= -1;
20838 return make_number (PT
);
20841 if (g
== e
|| INTEGERP (g
->object
))
20843 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
20844 goto simulate_display
;
20845 if (!row
->reversed_p
)
20849 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
20850 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
20851 goto simulate_display
;
20855 if (row
->reversed_p
&& !row
->continued_p
)
20857 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
20858 w
->cursor
.vpos
= -1;
20859 return make_number (PT
);
20861 g
= row
->glyphs
[TEXT_AREA
];
20862 e
= g
+ row
->used
[TEXT_AREA
];
20863 for ( ; g
< e
; g
++)
20865 if (BUFFERP (g
->object
)
20866 /* Empty lines have only one glyph, which stands
20867 for the newline, and whose charpos is the
20868 buffer position of the newline. */
20869 || ROW_GLYPH_NEWLINE_P (row
, g
)
20870 /* When the buffer ends in a newline, the line at
20871 EOB also has one glyph, but its charpos is -1. */
20872 || (row
->ends_at_zv_p
20873 && !row
->reversed_p
20874 && INTEGERP (g
->object
)
20875 && g
->type
== CHAR_GLYPH
20876 && g
->u
.ch
== ' '))
20878 if (g
->charpos
> 0)
20879 SET_PT (g
->charpos
);
20880 else if (!row
->reversed_p
20881 && row
->ends_at_zv_p
20886 w
->cursor
.vpos
= -1;
20887 return make_number (PT
);
20893 if (!row
->reversed_p
&& !row
->continued_p
)
20895 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
20896 w
->cursor
.vpos
= -1;
20897 return make_number (PT
);
20899 e
= row
->glyphs
[TEXT_AREA
];
20900 g
= e
+ row
->used
[TEXT_AREA
] - 1;
20901 for ( ; g
>= e
; g
--)
20903 if (BUFFERP (g
->object
)
20904 || (ROW_GLYPH_NEWLINE_P (row
, g
)
20906 /* Empty R2L lines on GUI frames have the buffer
20907 position of the newline stored in the stretch
20909 || g
->type
== STRETCH_GLYPH
20910 || (row
->ends_at_zv_p
20912 && INTEGERP (g
->object
)
20913 && g
->type
== CHAR_GLYPH
20914 && g
->u
.ch
== ' '))
20916 if (g
->charpos
> 0)
20917 SET_PT (g
->charpos
);
20918 else if (row
->reversed_p
20919 && row
->ends_at_zv_p
20924 w
->cursor
.vpos
= -1;
20925 return make_number (PT
);
20934 /* If we wind up here, we failed to move by using the glyphs, so we
20935 need to simulate display instead. */
20938 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
20940 paragraph_dir
= Qleft_to_right
;
20941 if (EQ (paragraph_dir
, Qright_to_left
))
20943 if (PT
<= BEGV
&& dir
< 0)
20944 xsignal0 (Qbeginning_of_buffer
);
20945 else if (PT
>= ZV
&& dir
> 0)
20946 xsignal0 (Qend_of_buffer
);
20949 struct text_pos pt
;
20951 int pt_x
, target_x
, pixel_width
, pt_vpos
;
20953 bool overshoot_expected
= false;
20954 bool target_is_eol_p
= false;
20956 /* Setup the arena. */
20957 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
20958 start_display (&it
, w
, pt
);
20960 if (it
.cmp_it
.id
< 0
20961 && it
.method
== GET_FROM_STRING
20962 && it
.area
== TEXT_AREA
20963 && it
.string_from_display_prop_p
20964 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
20965 overshoot_expected
= true;
20967 /* Find the X coordinate of point. We start from the beginning
20968 of this or previous line to make sure we are before point in
20969 the logical order (since the move_it_* functions can only
20972 reseat_at_previous_visible_line_start (&it
);
20973 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
20974 if (IT_CHARPOS (it
) != PT
)
20976 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
20977 -1, -1, -1, MOVE_TO_POS
);
20978 /* If we missed point because the character there is
20979 displayed out of a display vector that has more than one
20980 glyph, retry expecting overshoot. */
20981 if (it
.method
== GET_FROM_DISPLAY_VECTOR
20982 && it
.current
.dpvec_index
> 0
20983 && !overshoot_expected
)
20985 overshoot_expected
= true;
20988 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
20989 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
20991 pt_x
= it
.current_x
;
20993 if (dir
> 0 || overshoot_expected
)
20995 struct glyph_row
*row
= it
.glyph_row
;
20997 /* When point is at beginning of line, we don't have
20998 information about the glyph there loaded into struct
20999 it. Calling get_next_display_element fixes that. */
21001 get_next_display_element (&it
);
21002 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21003 it
.glyph_row
= NULL
;
21004 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21005 it
.glyph_row
= row
;
21006 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21007 it, lest it will become out of sync with it's buffer
21009 it
.current_x
= pt_x
;
21012 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21013 pixel_width
= it
.pixel_width
;
21014 if (overshoot_expected
&& at_eol_p
)
21016 else if (pixel_width
<= 0)
21019 /* If there's a display string (or something similar) at point,
21020 we are actually at the glyph to the left of point, so we need
21021 to correct the X coordinate. */
21022 if (overshoot_expected
)
21025 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21027 pt_x
+= pixel_width
;
21030 /* Compute target X coordinate, either to the left or to the
21031 right of point. On TTY frames, all characters have the same
21032 pixel width of 1, so we can use that. On GUI frames we don't
21033 have an easy way of getting at the pixel width of the
21034 character to the left of point, so we use a different method
21035 of getting to that place. */
21037 target_x
= pt_x
+ pixel_width
;
21039 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21041 /* Target X coordinate could be one line above or below the line
21042 of point, in which case we need to adjust the target X
21043 coordinate. Also, if moving to the left, we need to begin at
21044 the left edge of the point's screen line. */
21049 start_display (&it
, w
, pt
);
21050 reseat_at_previous_visible_line_start (&it
);
21051 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21053 move_it_by_lines (&it
, pt_vpos
);
21057 move_it_by_lines (&it
, -1);
21058 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21059 target_is_eol_p
= true;
21060 /* Under word-wrap, we don't know the x coordinate of
21061 the last character displayed on the previous line,
21062 which immediately precedes the wrap point. To find
21063 out its x coordinate, we try moving to the right
21064 margin of the window, which will stop at the wrap
21065 point, and then reset target_x to point at the
21066 character that precedes the wrap point. This is not
21067 needed on GUI frames, because (see below) there we
21068 move from the left margin one grapheme cluster at a
21069 time, and stop when we hit the wrap point. */
21070 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21072 void *it_data
= NULL
;
21075 SAVE_IT (it2
, it
, it_data
);
21076 move_it_in_display_line_to (&it
, ZV
, target_x
,
21077 MOVE_TO_POS
| MOVE_TO_X
);
21078 /* If we arrived at target_x, that _is_ the last
21079 character on the previous line. */
21080 if (it
.current_x
!= target_x
)
21081 target_x
= it
.current_x
- 1;
21082 RESTORE_IT (&it
, &it2
, it_data
);
21089 || (target_x
>= it
.last_visible_x
21090 && it
.line_wrap
!= TRUNCATE
))
21093 move_it_by_lines (&it
, 0);
21094 move_it_by_lines (&it
, 1);
21099 /* Move to the target X coordinate. */
21100 #ifdef HAVE_WINDOW_SYSTEM
21101 /* On GUI frames, as we don't know the X coordinate of the
21102 character to the left of point, moving point to the left
21103 requires walking, one grapheme cluster at a time, until we
21104 find ourself at a place immediately to the left of the
21105 character at point. */
21106 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21108 struct text_pos new_pos
;
21109 enum move_it_result rc
= MOVE_X_REACHED
;
21111 if (it
.current_x
== 0)
21112 get_next_display_element (&it
);
21113 if (it
.what
== IT_COMPOSITION
)
21115 new_pos
.charpos
= it
.cmp_it
.charpos
;
21116 new_pos
.bytepos
= -1;
21119 new_pos
= it
.current
.pos
;
21121 while (it
.current_x
+ it
.pixel_width
<= target_x
21122 && (rc
== MOVE_X_REACHED
21123 /* Under word-wrap, move_it_in_display_line_to
21124 stops at correct coordinates, but sometimes
21125 returns MOVE_POS_MATCH_OR_ZV. */
21126 || (it
.line_wrap
== WORD_WRAP
21127 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21129 int new_x
= it
.current_x
+ it
.pixel_width
;
21131 /* For composed characters, we want the position of the
21132 first character in the grapheme cluster (usually, the
21133 composition's base character), whereas it.current
21134 might give us the position of the _last_ one, e.g. if
21135 the composition is rendered in reverse due to bidi
21137 if (it
.what
== IT_COMPOSITION
)
21139 new_pos
.charpos
= it
.cmp_it
.charpos
;
21140 new_pos
.bytepos
= -1;
21143 new_pos
= it
.current
.pos
;
21144 if (new_x
== it
.current_x
)
21146 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21147 MOVE_TO_POS
| MOVE_TO_X
);
21148 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21151 /* The previous position we saw in the loop is the one we
21153 if (new_pos
.bytepos
== -1)
21154 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21155 it
.current
.pos
= new_pos
;
21159 if (it
.current_x
!= target_x
)
21160 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21162 /* When lines are truncated, the above loop will stop at the
21163 window edge. But we want to get to the end of line, even if
21164 it is beyond the window edge; automatic hscroll will then
21165 scroll the window to show point as appropriate. */
21166 if (target_is_eol_p
&& it
.line_wrap
== TRUNCATE
21167 && get_next_display_element (&it
))
21169 struct text_pos new_pos
= it
.current
.pos
;
21171 while (!ITERATOR_AT_END_OF_LINE_P (&it
))
21173 set_iterator_to_next (&it
, 0);
21174 if (it
.method
== GET_FROM_BUFFER
)
21175 new_pos
= it
.current
.pos
;
21176 if (!get_next_display_element (&it
))
21180 it
.current
.pos
= new_pos
;
21183 /* If we ended up in a display string that covers point, move to
21184 buffer position to the right in the visual order. */
21187 while (IT_CHARPOS (it
) == PT
)
21189 set_iterator_to_next (&it
, 0);
21190 if (!get_next_display_element (&it
))
21195 /* Move point to that position. */
21196 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21199 return make_number (PT
);
21201 #undef ROW_GLYPH_NEWLINE_P
21205 /***********************************************************************
21207 ***********************************************************************/
21209 /* Redisplay the menu bar in the frame for window W.
21211 The menu bar of X frames that don't have X toolkit support is
21212 displayed in a special window W->frame->menu_bar_window.
21214 The menu bar of terminal frames is treated specially as far as
21215 glyph matrices are concerned. Menu bar lines are not part of
21216 windows, so the update is done directly on the frame matrix rows
21217 for the menu bar. */
21220 display_menu_bar (struct window
*w
)
21222 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21227 /* Don't do all this for graphical frames. */
21229 if (FRAME_W32_P (f
))
21232 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21238 if (FRAME_NS_P (f
))
21240 #endif /* HAVE_NS */
21242 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21243 eassert (!FRAME_WINDOW_P (f
));
21244 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21245 it
.first_visible_x
= 0;
21246 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21247 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21248 if (FRAME_WINDOW_P (f
))
21250 /* Menu bar lines are displayed in the desired matrix of the
21251 dummy window menu_bar_window. */
21252 struct window
*menu_w
;
21253 menu_w
= XWINDOW (f
->menu_bar_window
);
21254 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21256 it
.first_visible_x
= 0;
21257 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21260 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21262 /* This is a TTY frame, i.e. character hpos/vpos are used as
21264 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21266 it
.first_visible_x
= 0;
21267 it
.last_visible_x
= FRAME_COLS (f
);
21270 /* FIXME: This should be controlled by a user option. See the
21271 comments in redisplay_tool_bar and display_mode_line about
21273 it
.paragraph_embedding
= L2R
;
21275 /* Clear all rows of the menu bar. */
21276 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21278 struct glyph_row
*row
= it
.glyph_row
+ i
;
21279 clear_glyph_row (row
);
21280 row
->enabled_p
= true;
21281 row
->full_width_p
= 1;
21284 /* Display all items of the menu bar. */
21285 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21286 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21288 Lisp_Object string
;
21290 /* Stop at nil string. */
21291 string
= AREF (items
, i
+ 1);
21295 /* Remember where item was displayed. */
21296 ASET (items
, i
+ 3, make_number (it
.hpos
));
21298 /* Display the item, pad with one space. */
21299 if (it
.current_x
< it
.last_visible_x
)
21300 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21301 SCHARS (string
) + 1, 0, 0, -1);
21304 /* Fill out the line with spaces. */
21305 if (it
.current_x
< it
.last_visible_x
)
21306 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21308 /* Compute the total height of the lines. */
21309 compute_line_metrics (&it
);
21312 /* Deep copy of a glyph row, including the glyphs. */
21314 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21316 struct glyph
*pointers
[1 + LAST_AREA
];
21317 int to_used
= to
->used
[TEXT_AREA
];
21319 /* Save glyph pointers of TO. */
21320 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21322 /* Do a structure assignment. */
21325 /* Restore original glyph pointers of TO. */
21326 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21328 /* Copy the glyphs. */
21329 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21330 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21332 /* If we filled only part of the TO row, fill the rest with
21333 space_glyph (which will display as empty space). */
21334 if (to_used
> from
->used
[TEXT_AREA
])
21335 fill_up_frame_row_with_spaces (to
, to_used
);
21338 /* Display one menu item on a TTY, by overwriting the glyphs in the
21339 frame F's desired glyph matrix with glyphs produced from the menu
21340 item text. Called from term.c to display TTY drop-down menus one
21343 ITEM_TEXT is the menu item text as a C string.
21345 FACE_ID is the face ID to be used for this menu item. FACE_ID
21346 could specify one of 3 faces: a face for an enabled item, a face
21347 for a disabled item, or a face for a selected item.
21349 X and Y are coordinates of the first glyph in the frame's desired
21350 matrix to be overwritten by the menu item. Since this is a TTY, Y
21351 is the zero-based number of the glyph row and X is the zero-based
21352 glyph number in the row, starting from left, where to start
21353 displaying the item.
21355 SUBMENU non-zero means this menu item drops down a submenu, which
21356 should be indicated by displaying a proper visual cue after the
21360 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21361 int x
, int y
, int submenu
)
21364 struct frame
*f
= SELECTED_FRAME ();
21365 struct window
*w
= XWINDOW (f
->selected_window
);
21366 int saved_used
, saved_truncated
, saved_width
, saved_reversed
;
21367 struct glyph_row
*row
;
21368 size_t item_len
= strlen (item_text
);
21370 eassert (FRAME_TERMCAP_P (f
));
21372 /* Don't write beyond the matrix's last row. This can happen for
21373 TTY screens that are not high enough to show the entire menu.
21374 (This is actually a bit of defensive programming, as
21375 tty_menu_display already limits the number of menu items to one
21376 less than the number of screen lines.) */
21377 if (y
>= f
->desired_matrix
->nrows
)
21380 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21381 it
.first_visible_x
= 0;
21382 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21383 row
= it
.glyph_row
;
21384 /* Start with the row contents from the current matrix. */
21385 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21386 saved_width
= row
->full_width_p
;
21387 row
->full_width_p
= 1;
21388 saved_reversed
= row
->reversed_p
;
21389 row
->reversed_p
= 0;
21390 row
->enabled_p
= true;
21392 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21394 eassert (x
< f
->desired_matrix
->matrix_w
);
21395 it
.current_x
= it
.hpos
= x
;
21396 it
.current_y
= it
.vpos
= y
;
21397 saved_used
= row
->used
[TEXT_AREA
];
21398 saved_truncated
= row
->truncated_on_right_p
;
21399 row
->used
[TEXT_AREA
] = x
;
21400 it
.face_id
= face_id
;
21401 it
.line_wrap
= TRUNCATE
;
21403 /* FIXME: This should be controlled by a user option. See the
21404 comments in redisplay_tool_bar and display_mode_line about this.
21405 Also, if paragraph_embedding could ever be R2L, changes will be
21406 needed to avoid shifting to the right the row characters in
21407 term.c:append_glyph. */
21408 it
.paragraph_embedding
= L2R
;
21410 /* Pad with a space on the left. */
21411 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21413 /* Display the menu item, pad with spaces to WIDTH. */
21416 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21417 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21419 /* Indicate with " >" that there's a submenu. */
21420 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21421 FRAME_COLS (f
) - 1, -1);
21424 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21425 width
, 0, FRAME_COLS (f
) - 1, -1);
21427 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21428 row
->truncated_on_right_p
= saved_truncated
;
21429 row
->hash
= row_hash (row
);
21430 row
->full_width_p
= saved_width
;
21431 row
->reversed_p
= saved_reversed
;
21434 /***********************************************************************
21436 ***********************************************************************/
21438 /* Redisplay mode lines in the window tree whose root is WINDOW. If
21439 FORCE is non-zero, redisplay mode lines unconditionally.
21440 Otherwise, redisplay only mode lines that are garbaged. Value is
21441 the number of windows whose mode lines were redisplayed. */
21444 redisplay_mode_lines (Lisp_Object window
, bool force
)
21448 while (!NILP (window
))
21450 struct window
*w
= XWINDOW (window
);
21452 if (WINDOWP (w
->contents
))
21453 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
21455 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
21456 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
21458 struct text_pos lpoint
;
21459 struct buffer
*old
= current_buffer
;
21461 /* Set the window's buffer for the mode line display. */
21462 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
21463 set_buffer_internal_1 (XBUFFER (w
->contents
));
21465 /* Point refers normally to the selected window. For any
21466 other window, set up appropriate value. */
21467 if (!EQ (window
, selected_window
))
21469 struct text_pos pt
;
21471 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
21472 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
21475 /* Display mode lines. */
21476 clear_glyph_matrix (w
->desired_matrix
);
21477 if (display_mode_lines (w
))
21480 /* Restore old settings. */
21481 set_buffer_internal_1 (old
);
21482 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
21492 /* Display the mode and/or header line of window W. Value is the
21493 sum number of mode lines and header lines displayed. */
21496 display_mode_lines (struct window
*w
)
21498 Lisp_Object old_selected_window
= selected_window
;
21499 Lisp_Object old_selected_frame
= selected_frame
;
21500 Lisp_Object new_frame
= w
->frame
;
21501 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
21504 selected_frame
= new_frame
;
21505 /* FIXME: If we were to allow the mode-line's computation changing the buffer
21506 or window's point, then we'd need select_window_1 here as well. */
21507 XSETWINDOW (selected_window
, w
);
21508 XFRAME (new_frame
)->selected_window
= selected_window
;
21510 /* These will be set while the mode line specs are processed. */
21511 line_number_displayed
= 0;
21512 w
->column_number_displayed
= -1;
21514 if (WINDOW_WANTS_MODELINE_P (w
))
21516 struct window
*sel_w
= XWINDOW (old_selected_window
);
21518 /* Select mode line face based on the real selected window. */
21519 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
21520 BVAR (current_buffer
, mode_line_format
));
21524 if (WINDOW_WANTS_HEADER_LINE_P (w
))
21526 display_mode_line (w
, HEADER_LINE_FACE_ID
,
21527 BVAR (current_buffer
, header_line_format
));
21531 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
21532 selected_frame
= old_selected_frame
;
21533 selected_window
= old_selected_window
;
21535 w
->must_be_updated_p
= true;
21540 /* Display mode or header line of window W. FACE_ID specifies which
21541 line to display; it is either MODE_LINE_FACE_ID or
21542 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
21543 display. Value is the pixel height of the mode/header line
21547 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
21551 ptrdiff_t count
= SPECPDL_INDEX ();
21553 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21554 /* Don't extend on a previously drawn mode-line.
21555 This may happen if called from pos_visible_p. */
21556 it
.glyph_row
->enabled_p
= false;
21557 prepare_desired_row (w
, it
.glyph_row
, true);
21559 it
.glyph_row
->mode_line_p
= 1;
21561 /* FIXME: This should be controlled by a user option. But
21562 supporting such an option is not trivial, since the mode line is
21563 made up of many separate strings. */
21564 it
.paragraph_embedding
= L2R
;
21566 record_unwind_protect (unwind_format_mode_line
,
21567 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
21569 mode_line_target
= MODE_LINE_DISPLAY
;
21571 /* Temporarily make frame's keyboard the current kboard so that
21572 kboard-local variables in the mode_line_format will get the right
21574 push_kboard (FRAME_KBOARD (it
.f
));
21575 record_unwind_save_match_data ();
21576 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21579 unbind_to (count
, Qnil
);
21581 /* Fill up with spaces. */
21582 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
21584 compute_line_metrics (&it
);
21585 it
.glyph_row
->full_width_p
= 1;
21586 it
.glyph_row
->continued_p
= 0;
21587 it
.glyph_row
->truncated_on_left_p
= 0;
21588 it
.glyph_row
->truncated_on_right_p
= 0;
21590 /* Make a 3D mode-line have a shadow at its right end. */
21591 face
= FACE_FROM_ID (it
.f
, face_id
);
21592 extend_face_to_end_of_line (&it
);
21593 if (face
->box
!= FACE_NO_BOX
)
21595 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
21596 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
21597 last
->right_box_line_p
= 1;
21600 return it
.glyph_row
->height
;
21603 /* Move element ELT in LIST to the front of LIST.
21604 Return the updated list. */
21607 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
21609 register Lisp_Object tail
, prev
;
21610 register Lisp_Object tem
;
21614 while (CONSP (tail
))
21620 /* Splice out the link TAIL. */
21622 list
= XCDR (tail
);
21624 Fsetcdr (prev
, XCDR (tail
));
21626 /* Now make it the first. */
21627 Fsetcdr (tail
, list
);
21632 tail
= XCDR (tail
);
21636 /* Not found--return unchanged LIST. */
21640 /* Contribute ELT to the mode line for window IT->w. How it
21641 translates into text depends on its data type.
21643 IT describes the display environment in which we display, as usual.
21645 DEPTH is the depth in recursion. It is used to prevent
21646 infinite recursion here.
21648 FIELD_WIDTH is the number of characters the display of ELT should
21649 occupy in the mode line, and PRECISION is the maximum number of
21650 characters to display from ELT's representation. See
21651 display_string for details.
21653 Returns the hpos of the end of the text generated by ELT.
21655 PROPS is a property list to add to any string we encounter.
21657 If RISKY is nonzero, remove (disregard) any properties in any string
21658 we encounter, and ignore :eval and :propertize.
21660 The global variable `mode_line_target' determines whether the
21661 output is passed to `store_mode_line_noprop',
21662 `store_mode_line_string', or `display_string'. */
21665 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
21666 Lisp_Object elt
, Lisp_Object props
, int risky
)
21668 int n
= 0, field
, prec
;
21673 elt
= build_string ("*too-deep*");
21677 switch (XTYPE (elt
))
21681 /* A string: output it and check for %-constructs within it. */
21683 ptrdiff_t offset
= 0;
21685 if (SCHARS (elt
) > 0
21686 && (!NILP (props
) || risky
))
21688 Lisp_Object oprops
, aelt
;
21689 oprops
= Ftext_properties_at (make_number (0), elt
);
21691 /* If the starting string's properties are not what
21692 we want, translate the string. Also, if the string
21693 is risky, do that anyway. */
21695 if (NILP (Fequal (props
, oprops
)) || risky
)
21697 /* If the starting string has properties,
21698 merge the specified ones onto the existing ones. */
21699 if (! NILP (oprops
) && !risky
)
21703 oprops
= Fcopy_sequence (oprops
);
21705 while (CONSP (tem
))
21707 oprops
= Fplist_put (oprops
, XCAR (tem
),
21708 XCAR (XCDR (tem
)));
21709 tem
= XCDR (XCDR (tem
));
21714 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
21715 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
21717 /* AELT is what we want. Move it to the front
21718 without consing. */
21720 mode_line_proptrans_alist
21721 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
21727 /* If AELT has the wrong props, it is useless.
21728 so get rid of it. */
21730 mode_line_proptrans_alist
21731 = Fdelq (aelt
, mode_line_proptrans_alist
);
21733 elt
= Fcopy_sequence (elt
);
21734 Fset_text_properties (make_number (0), Flength (elt
),
21736 /* Add this item to mode_line_proptrans_alist. */
21737 mode_line_proptrans_alist
21738 = Fcons (Fcons (elt
, props
),
21739 mode_line_proptrans_alist
);
21740 /* Truncate mode_line_proptrans_alist
21741 to at most 50 elements. */
21742 tem
= Fnthcdr (make_number (50),
21743 mode_line_proptrans_alist
);
21745 XSETCDR (tem
, Qnil
);
21754 prec
= precision
- n
;
21755 switch (mode_line_target
)
21757 case MODE_LINE_NOPROP
:
21758 case MODE_LINE_TITLE
:
21759 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
21761 case MODE_LINE_STRING
:
21762 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
21764 case MODE_LINE_DISPLAY
:
21765 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
21766 0, prec
, 0, STRING_MULTIBYTE (elt
));
21773 /* Handle the non-literal case. */
21775 while ((precision
<= 0 || n
< precision
)
21776 && SREF (elt
, offset
) != 0
21777 && (mode_line_target
!= MODE_LINE_DISPLAY
21778 || it
->current_x
< it
->last_visible_x
))
21780 ptrdiff_t last_offset
= offset
;
21782 /* Advance to end of string or next format specifier. */
21783 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
21786 if (offset
- 1 != last_offset
)
21788 ptrdiff_t nchars
, nbytes
;
21790 /* Output to end of string or up to '%'. Field width
21791 is length of string. Don't output more than
21792 PRECISION allows us. */
21795 prec
= c_string_width (SDATA (elt
) + last_offset
,
21796 offset
- last_offset
, precision
- n
,
21799 switch (mode_line_target
)
21801 case MODE_LINE_NOPROP
:
21802 case MODE_LINE_TITLE
:
21803 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
21805 case MODE_LINE_STRING
:
21807 ptrdiff_t bytepos
= last_offset
;
21808 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
21809 ptrdiff_t endpos
= (precision
<= 0
21810 ? string_byte_to_char (elt
, offset
)
21811 : charpos
+ nchars
);
21813 n
+= store_mode_line_string (NULL
,
21814 Fsubstring (elt
, make_number (charpos
),
21815 make_number (endpos
)),
21819 case MODE_LINE_DISPLAY
:
21821 ptrdiff_t bytepos
= last_offset
;
21822 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
21824 if (precision
<= 0)
21825 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
21826 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
21828 STRING_MULTIBYTE (elt
));
21833 else /* c == '%' */
21835 ptrdiff_t percent_position
= offset
;
21837 /* Get the specified minimum width. Zero means
21840 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
21841 field
= field
* 10 + c
- '0';
21843 /* Don't pad beyond the total padding allowed. */
21844 if (field_width
- n
> 0 && field
> field_width
- n
)
21845 field
= field_width
- n
;
21847 /* Note that either PRECISION <= 0 or N < PRECISION. */
21848 prec
= precision
- n
;
21851 n
+= display_mode_element (it
, depth
, field
, prec
,
21852 Vglobal_mode_string
, props
,
21857 ptrdiff_t bytepos
, charpos
;
21859 Lisp_Object string
;
21861 bytepos
= percent_position
;
21862 charpos
= (STRING_MULTIBYTE (elt
)
21863 ? string_byte_to_char (elt
, bytepos
)
21865 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
21866 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
21868 switch (mode_line_target
)
21870 case MODE_LINE_NOPROP
:
21871 case MODE_LINE_TITLE
:
21872 n
+= store_mode_line_noprop (spec
, field
, prec
);
21874 case MODE_LINE_STRING
:
21876 Lisp_Object tem
= build_string (spec
);
21877 props
= Ftext_properties_at (make_number (charpos
), elt
);
21878 /* Should only keep face property in props */
21879 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
21882 case MODE_LINE_DISPLAY
:
21884 int nglyphs_before
, nwritten
;
21886 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
21887 nwritten
= display_string (spec
, string
, elt
,
21892 /* Assign to the glyphs written above the
21893 string where the `%x' came from, position
21897 struct glyph
*glyph
21898 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
21902 for (i
= 0; i
< nwritten
; ++i
)
21904 glyph
[i
].object
= elt
;
21905 glyph
[i
].charpos
= charpos
;
21922 /* A symbol: process the value of the symbol recursively
21923 as if it appeared here directly. Avoid error if symbol void.
21924 Special case: if value of symbol is a string, output the string
21927 register Lisp_Object tem
;
21929 /* If the variable is not marked as risky to set
21930 then its contents are risky to use. */
21931 if (NILP (Fget (elt
, Qrisky_local_variable
)))
21934 tem
= Fboundp (elt
);
21937 tem
= Fsymbol_value (elt
);
21938 /* If value is a string, output that string literally:
21939 don't check for % within it. */
21943 if (!EQ (tem
, elt
))
21945 /* Give up right away for nil or t. */
21955 register Lisp_Object car
, tem
;
21957 /* A cons cell: five distinct cases.
21958 If first element is :eval or :propertize, do something special.
21959 If first element is a string or a cons, process all the elements
21960 and effectively concatenate them.
21961 If first element is a negative number, truncate displaying cdr to
21962 at most that many characters. If positive, pad (with spaces)
21963 to at least that many characters.
21964 If first element is a symbol, process the cadr or caddr recursively
21965 according to whether the symbol's value is non-nil or nil. */
21967 if (EQ (car
, QCeval
))
21969 /* An element of the form (:eval FORM) means evaluate FORM
21970 and use the result as mode line elements. */
21975 if (CONSP (XCDR (elt
)))
21978 spec
= safe__eval (true, XCAR (XCDR (elt
)));
21979 n
+= display_mode_element (it
, depth
, field_width
- n
,
21980 precision
- n
, spec
, props
,
21984 else if (EQ (car
, QCpropertize
))
21986 /* An element of the form (:propertize ELT PROPS...)
21987 means display ELT but applying properties PROPS. */
21992 if (CONSP (XCDR (elt
)))
21993 n
+= display_mode_element (it
, depth
, field_width
- n
,
21994 precision
- n
, XCAR (XCDR (elt
)),
21995 XCDR (XCDR (elt
)), risky
);
21997 else if (SYMBOLP (car
))
21999 tem
= Fboundp (car
);
22003 /* elt is now the cdr, and we know it is a cons cell.
22004 Use its car if CAR has a non-nil value. */
22007 tem
= Fsymbol_value (car
);
22014 /* Symbol's value is nil (or symbol is unbound)
22015 Get the cddr of the original list
22016 and if possible find the caddr and use that. */
22020 else if (!CONSP (elt
))
22025 else if (INTEGERP (car
))
22027 register int lim
= XINT (car
);
22031 /* Negative int means reduce maximum width. */
22032 if (precision
<= 0)
22035 precision
= min (precision
, -lim
);
22039 /* Padding specified. Don't let it be more than
22040 current maximum. */
22042 lim
= min (precision
, lim
);
22044 /* If that's more padding than already wanted, queue it.
22045 But don't reduce padding already specified even if
22046 that is beyond the current truncation point. */
22047 field_width
= max (lim
, field_width
);
22051 else if (STRINGP (car
) || CONSP (car
))
22053 Lisp_Object halftail
= elt
;
22057 && (precision
<= 0 || n
< precision
))
22059 n
+= display_mode_element (it
, depth
,
22060 /* Do padding only after the last
22061 element in the list. */
22062 (! CONSP (XCDR (elt
))
22065 precision
- n
, XCAR (elt
),
22069 if ((len
& 1) == 0)
22070 halftail
= XCDR (halftail
);
22071 /* Check for cycle. */
22072 if (EQ (halftail
, elt
))
22081 elt
= build_string ("*invalid*");
22085 /* Pad to FIELD_WIDTH. */
22086 if (field_width
> 0 && n
< field_width
)
22088 switch (mode_line_target
)
22090 case MODE_LINE_NOPROP
:
22091 case MODE_LINE_TITLE
:
22092 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22094 case MODE_LINE_STRING
:
22095 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
22097 case MODE_LINE_DISPLAY
:
22098 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22107 /* Store a mode-line string element in mode_line_string_list.
22109 If STRING is non-null, display that C string. Otherwise, the Lisp
22110 string LISP_STRING is displayed.
22112 FIELD_WIDTH is the minimum number of output glyphs to produce.
22113 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22114 with spaces. FIELD_WIDTH <= 0 means don't pad.
22116 PRECISION is the maximum number of characters to output from
22117 STRING. PRECISION <= 0 means don't truncate the string.
22119 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
22120 properties to the string.
22122 PROPS are the properties to add to the string.
22123 The mode_line_string_face face property is always added to the string.
22127 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
22128 int field_width
, int precision
, Lisp_Object props
)
22133 if (string
!= NULL
)
22135 len
= strlen (string
);
22136 if (precision
> 0 && len
> precision
)
22138 lisp_string
= make_string (string
, len
);
22140 props
= mode_line_string_face_prop
;
22141 else if (!NILP (mode_line_string_face
))
22143 Lisp_Object face
= Fplist_get (props
, Qface
);
22144 props
= Fcopy_sequence (props
);
22146 face
= mode_line_string_face
;
22148 face
= list2 (face
, mode_line_string_face
);
22149 props
= Fplist_put (props
, Qface
, face
);
22151 Fadd_text_properties (make_number (0), make_number (len
),
22152 props
, lisp_string
);
22156 len
= XFASTINT (Flength (lisp_string
));
22157 if (precision
> 0 && len
> precision
)
22160 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22163 if (!NILP (mode_line_string_face
))
22167 props
= Ftext_properties_at (make_number (0), lisp_string
);
22168 face
= Fplist_get (props
, Qface
);
22170 face
= mode_line_string_face
;
22172 face
= list2 (face
, mode_line_string_face
);
22173 props
= list2 (Qface
, face
);
22175 lisp_string
= Fcopy_sequence (lisp_string
);
22178 Fadd_text_properties (make_number (0), make_number (len
),
22179 props
, lisp_string
);
22184 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22188 if (field_width
> len
)
22190 field_width
-= len
;
22191 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22193 Fadd_text_properties (make_number (0), make_number (field_width
),
22194 props
, lisp_string
);
22195 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22203 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22205 doc
: /* Format a string out of a mode line format specification.
22206 First arg FORMAT specifies the mode line format (see `mode-line-format'
22207 for details) to use.
22209 By default, the format is evaluated for the currently selected window.
22211 Optional second arg FACE specifies the face property to put on all
22212 characters for which no face is specified. The value nil means the
22213 default face. The value t means whatever face the window's mode line
22214 currently uses (either `mode-line' or `mode-line-inactive',
22215 depending on whether the window is the selected window or not).
22216 An integer value means the value string has no text
22219 Optional third and fourth args WINDOW and BUFFER specify the window
22220 and buffer to use as the context for the formatting (defaults
22221 are the selected window and the WINDOW's buffer). */)
22222 (Lisp_Object format
, Lisp_Object face
,
22223 Lisp_Object window
, Lisp_Object buffer
)
22228 struct buffer
*old_buffer
= NULL
;
22230 int no_props
= INTEGERP (face
);
22231 ptrdiff_t count
= SPECPDL_INDEX ();
22233 int string_start
= 0;
22235 w
= decode_any_window (window
);
22236 XSETWINDOW (window
, w
);
22239 buffer
= w
->contents
;
22240 CHECK_BUFFER (buffer
);
22242 /* Make formatting the modeline a non-op when noninteractive, otherwise
22243 there will be problems later caused by a partially initialized frame. */
22244 if (NILP (format
) || noninteractive
)
22245 return empty_unibyte_string
;
22250 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22251 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22252 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22253 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22254 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22255 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22256 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22259 old_buffer
= current_buffer
;
22261 /* Save things including mode_line_proptrans_alist,
22262 and set that to nil so that we don't alter the outer value. */
22263 record_unwind_protect (unwind_format_mode_line
,
22264 format_mode_line_unwind_data
22265 (XFRAME (WINDOW_FRAME (w
)),
22266 old_buffer
, selected_window
, 1));
22267 mode_line_proptrans_alist
= Qnil
;
22269 Fselect_window (window
, Qt
);
22270 set_buffer_internal_1 (XBUFFER (buffer
));
22272 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22276 mode_line_target
= MODE_LINE_NOPROP
;
22277 mode_line_string_face_prop
= Qnil
;
22278 mode_line_string_list
= Qnil
;
22279 string_start
= MODE_LINE_NOPROP_LEN (0);
22283 mode_line_target
= MODE_LINE_STRING
;
22284 mode_line_string_list
= Qnil
;
22285 mode_line_string_face
= face
;
22286 mode_line_string_face_prop
22287 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22290 push_kboard (FRAME_KBOARD (it
.f
));
22291 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
22296 len
= MODE_LINE_NOPROP_LEN (string_start
);
22297 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22301 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22302 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
22303 empty_unibyte_string
);
22306 unbind_to (count
, Qnil
);
22310 /* Write a null-terminated, right justified decimal representation of
22311 the positive integer D to BUF using a minimal field width WIDTH. */
22314 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22316 register char *p
= buf
;
22324 *p
++ = d
% 10 + '0';
22329 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22340 /* Write a null-terminated, right justified decimal and "human
22341 readable" representation of the nonnegative integer D to BUF using
22342 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22344 static const char power_letter
[] =
22358 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22360 /* We aim to represent the nonnegative integer D as
22361 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22362 ptrdiff_t quotient
= d
;
22364 /* -1 means: do not use TENTHS. */
22368 /* Length of QUOTIENT.TENTHS as a string. */
22374 if (quotient
>= 1000)
22376 /* Scale to the appropriate EXPONENT. */
22379 remainder
= quotient
% 1000;
22383 while (quotient
>= 1000);
22385 /* Round to nearest and decide whether to use TENTHS or not. */
22388 tenths
= remainder
/ 100;
22389 if (remainder
% 100 >= 50)
22396 if (quotient
== 10)
22404 if (remainder
>= 500)
22406 if (quotient
< 999)
22417 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22418 if (tenths
== -1 && quotient
<= 99)
22425 p
= psuffix
= buf
+ max (width
, length
);
22427 /* Print EXPONENT. */
22428 *psuffix
++ = power_letter
[exponent
];
22431 /* Print TENTHS. */
22434 *--p
= '0' + tenths
;
22438 /* Print QUOTIENT. */
22441 int digit
= quotient
% 10;
22442 *--p
= '0' + digit
;
22444 while ((quotient
/= 10) != 0);
22446 /* Print leading spaces. */
22451 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22452 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
22453 type of CODING_SYSTEM. Return updated pointer into BUF. */
22455 static unsigned char invalid_eol_type
[] = "(*invalid*)";
22458 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
22461 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
22462 const unsigned char *eol_str
;
22464 /* The EOL conversion we are using. */
22465 Lisp_Object eoltype
;
22467 val
= CODING_SYSTEM_SPEC (coding_system
);
22470 if (!VECTORP (val
)) /* Not yet decided. */
22472 *buf
++ = multibyte
? '-' : ' ';
22474 eoltype
= eol_mnemonic_undecided
;
22475 /* Don't mention EOL conversion if it isn't decided. */
22480 Lisp_Object eolvalue
;
22482 attrs
= AREF (val
, 0);
22483 eolvalue
= AREF (val
, 2);
22486 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
22491 /* The EOL conversion that is normal on this system. */
22493 if (NILP (eolvalue
)) /* Not yet decided. */
22494 eoltype
= eol_mnemonic_undecided
;
22495 else if (VECTORP (eolvalue
)) /* Not yet decided. */
22496 eoltype
= eol_mnemonic_undecided
;
22497 else /* eolvalue is Qunix, Qdos, or Qmac. */
22498 eoltype
= (EQ (eolvalue
, Qunix
)
22499 ? eol_mnemonic_unix
22500 : (EQ (eolvalue
, Qdos
) == 1
22501 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
22507 /* Mention the EOL conversion if it is not the usual one. */
22508 if (STRINGP (eoltype
))
22510 eol_str
= SDATA (eoltype
);
22511 eol_str_len
= SBYTES (eoltype
);
22513 else if (CHARACTERP (eoltype
))
22515 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
22516 int c
= XFASTINT (eoltype
);
22517 eol_str_len
= CHAR_STRING (c
, tmp
);
22522 eol_str
= invalid_eol_type
;
22523 eol_str_len
= sizeof (invalid_eol_type
) - 1;
22525 memcpy (buf
, eol_str
, eol_str_len
);
22526 buf
+= eol_str_len
;
22532 /* Return a string for the output of a mode line %-spec for window W,
22533 generated by character C. FIELD_WIDTH > 0 means pad the string
22534 returned with spaces to that value. Return a Lisp string in
22535 *STRING if the resulting string is taken from that Lisp string.
22537 Note we operate on the current buffer for most purposes. */
22539 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
22541 static const char *
22542 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
22543 Lisp_Object
*string
)
22546 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22547 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
22548 /* We are going to use f->decode_mode_spec_buffer as the buffer to
22549 produce strings from numerical values, so limit preposterously
22550 large values of FIELD_WIDTH to avoid overrunning the buffer's
22551 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
22552 bytes plus the terminating null. */
22553 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
22554 struct buffer
*b
= current_buffer
;
22562 if (!NILP (BVAR (b
, read_only
)))
22564 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22569 /* This differs from %* only for a modified read-only buffer. */
22570 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22572 if (!NILP (BVAR (b
, read_only
)))
22577 /* This differs from %* in ignoring read-only-ness. */
22578 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22590 if (command_loop_level
> 5)
22592 p
= decode_mode_spec_buf
;
22593 for (i
= 0; i
< command_loop_level
; i
++)
22596 return decode_mode_spec_buf
;
22604 if (command_loop_level
> 5)
22606 p
= decode_mode_spec_buf
;
22607 for (i
= 0; i
< command_loop_level
; i
++)
22610 return decode_mode_spec_buf
;
22617 /* Let lots_of_dashes be a string of infinite length. */
22618 if (mode_line_target
== MODE_LINE_NOPROP
22619 || mode_line_target
== MODE_LINE_STRING
)
22621 if (field_width
<= 0
22622 || field_width
> sizeof (lots_of_dashes
))
22624 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
22625 decode_mode_spec_buf
[i
] = '-';
22626 decode_mode_spec_buf
[i
] = '\0';
22627 return decode_mode_spec_buf
;
22630 return lots_of_dashes
;
22634 obj
= BVAR (b
, name
);
22638 /* %c and %l are ignored in `frame-title-format'.
22639 (In redisplay_internal, the frame title is drawn _before_ the
22640 windows are updated, so the stuff which depends on actual
22641 window contents (such as %l) may fail to render properly, or
22642 even crash emacs.) */
22643 if (mode_line_target
== MODE_LINE_TITLE
)
22647 ptrdiff_t col
= current_column ();
22648 w
->column_number_displayed
= col
;
22649 pint2str (decode_mode_spec_buf
, width
, col
);
22650 return decode_mode_spec_buf
;
22654 #ifndef SYSTEM_MALLOC
22656 if (NILP (Vmemory_full
))
22659 return "!MEM FULL! ";
22666 /* %F displays the frame name. */
22667 if (!NILP (f
->title
))
22668 return SSDATA (f
->title
);
22669 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
22670 return SSDATA (f
->name
);
22674 obj
= BVAR (b
, filename
);
22679 ptrdiff_t size
= ZV
- BEGV
;
22680 pint2str (decode_mode_spec_buf
, width
, size
);
22681 return decode_mode_spec_buf
;
22686 ptrdiff_t size
= ZV
- BEGV
;
22687 pint2hrstr (decode_mode_spec_buf
, width
, size
);
22688 return decode_mode_spec_buf
;
22693 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
22694 ptrdiff_t topline
, nlines
, height
;
22697 /* %c and %l are ignored in `frame-title-format'. */
22698 if (mode_line_target
== MODE_LINE_TITLE
)
22701 startpos
= marker_position (w
->start
);
22702 startpos_byte
= marker_byte_position (w
->start
);
22703 height
= WINDOW_TOTAL_LINES (w
);
22705 /* If we decided that this buffer isn't suitable for line numbers,
22706 don't forget that too fast. */
22707 if (w
->base_line_pos
== -1)
22710 /* If the buffer is very big, don't waste time. */
22711 if (INTEGERP (Vline_number_display_limit
)
22712 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
22714 w
->base_line_pos
= 0;
22715 w
->base_line_number
= 0;
22719 if (w
->base_line_number
> 0
22720 && w
->base_line_pos
> 0
22721 && w
->base_line_pos
<= startpos
)
22723 line
= w
->base_line_number
;
22724 linepos
= w
->base_line_pos
;
22725 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
22730 linepos
= BUF_BEGV (b
);
22731 linepos_byte
= BUF_BEGV_BYTE (b
);
22734 /* Count lines from base line to window start position. */
22735 nlines
= display_count_lines (linepos_byte
,
22739 topline
= nlines
+ line
;
22741 /* Determine a new base line, if the old one is too close
22742 or too far away, or if we did not have one.
22743 "Too close" means it's plausible a scroll-down would
22744 go back past it. */
22745 if (startpos
== BUF_BEGV (b
))
22747 w
->base_line_number
= topline
;
22748 w
->base_line_pos
= BUF_BEGV (b
);
22750 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
22751 || linepos
== BUF_BEGV (b
))
22753 ptrdiff_t limit
= BUF_BEGV (b
);
22754 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
22755 ptrdiff_t position
;
22756 ptrdiff_t distance
=
22757 (height
* 2 + 30) * line_number_display_limit_width
;
22759 if (startpos
- distance
> limit
)
22761 limit
= startpos
- distance
;
22762 limit_byte
= CHAR_TO_BYTE (limit
);
22765 nlines
= display_count_lines (startpos_byte
,
22767 - (height
* 2 + 30),
22769 /* If we couldn't find the lines we wanted within
22770 line_number_display_limit_width chars per line,
22771 give up on line numbers for this window. */
22772 if (position
== limit_byte
&& limit
== startpos
- distance
)
22774 w
->base_line_pos
= -1;
22775 w
->base_line_number
= 0;
22779 w
->base_line_number
= topline
- nlines
;
22780 w
->base_line_pos
= BYTE_TO_CHAR (position
);
22783 /* Now count lines from the start pos to point. */
22784 nlines
= display_count_lines (startpos_byte
,
22785 PT_BYTE
, PT
, &junk
);
22787 /* Record that we did display the line number. */
22788 line_number_displayed
= 1;
22790 /* Make the string to show. */
22791 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
22792 return decode_mode_spec_buf
;
22795 char *p
= decode_mode_spec_buf
;
22796 int pad
= width
- 2;
22802 return decode_mode_spec_buf
;
22808 obj
= BVAR (b
, mode_name
);
22812 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
22818 ptrdiff_t pos
= marker_position (w
->start
);
22819 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
22821 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
22823 if (pos
<= BUF_BEGV (b
))
22828 else if (pos
<= BUF_BEGV (b
))
22832 if (total
> 1000000)
22833 /* Do it differently for a large value, to avoid overflow. */
22834 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
22836 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
22837 /* We can't normally display a 3-digit number,
22838 so get us a 2-digit number that is close. */
22841 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
22842 return decode_mode_spec_buf
;
22846 /* Display percentage of size above the bottom of the screen. */
22849 ptrdiff_t toppos
= marker_position (w
->start
);
22850 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
22851 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
22853 if (botpos
>= BUF_ZV (b
))
22855 if (toppos
<= BUF_BEGV (b
))
22862 if (total
> 1000000)
22863 /* Do it differently for a large value, to avoid overflow. */
22864 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
22866 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
22867 /* We can't normally display a 3-digit number,
22868 so get us a 2-digit number that is close. */
22871 if (toppos
<= BUF_BEGV (b
))
22872 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
22874 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
22875 return decode_mode_spec_buf
;
22880 /* status of process */
22881 obj
= Fget_buffer_process (Fcurrent_buffer ());
22883 return "no process";
22885 obj
= Fsymbol_name (Fprocess_status (obj
));
22891 ptrdiff_t count
= inhibit_garbage_collection ();
22892 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
22893 Lisp_Object val
= Qnil
;
22895 if (STRINGP (curdir
))
22896 val
= call1 (intern ("file-remote-p"), curdir
);
22898 unbind_to (count
, Qnil
);
22907 /* coding-system (not including end-of-line format) */
22909 /* coding-system (including end-of-line type) */
22911 int eol_flag
= (c
== 'Z');
22912 char *p
= decode_mode_spec_buf
;
22914 if (! FRAME_WINDOW_P (f
))
22916 /* No need to mention EOL here--the terminal never needs
22917 to do EOL conversion. */
22918 p
= decode_mode_spec_coding (CODING_ID_NAME
22919 (FRAME_KEYBOARD_CODING (f
)->id
),
22921 p
= decode_mode_spec_coding (CODING_ID_NAME
22922 (FRAME_TERMINAL_CODING (f
)->id
),
22925 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
22928 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
22929 #ifdef subprocesses
22930 obj
= Fget_buffer_process (Fcurrent_buffer ());
22931 if (PROCESSP (obj
))
22933 p
= decode_mode_spec_coding
22934 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
22935 p
= decode_mode_spec_coding
22936 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
22938 #endif /* subprocesses */
22941 return decode_mode_spec_buf
;
22948 return SSDATA (obj
);
22955 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
22956 means count lines back from START_BYTE. But don't go beyond
22957 LIMIT_BYTE. Return the number of lines thus found (always
22960 Set *BYTE_POS_PTR to the byte position where we stopped. This is
22961 either the position COUNT lines after/before START_BYTE, if we
22962 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
22966 display_count_lines (ptrdiff_t start_byte
,
22967 ptrdiff_t limit_byte
, ptrdiff_t count
,
22968 ptrdiff_t *byte_pos_ptr
)
22970 register unsigned char *cursor
;
22971 unsigned char *base
;
22973 register ptrdiff_t ceiling
;
22974 register unsigned char *ceiling_addr
;
22975 ptrdiff_t orig_count
= count
;
22977 /* If we are not in selective display mode,
22978 check only for newlines. */
22979 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
22980 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
22984 while (start_byte
< limit_byte
)
22986 ceiling
= BUFFER_CEILING_OF (start_byte
);
22987 ceiling
= min (limit_byte
- 1, ceiling
);
22988 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
22989 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
22993 if (selective_display
)
22995 while (*cursor
!= '\n' && *cursor
!= 015
22996 && ++cursor
!= ceiling_addr
)
22998 if (cursor
== ceiling_addr
)
23003 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23012 start_byte
+= cursor
- base
;
23013 *byte_pos_ptr
= start_byte
;
23017 while (cursor
< ceiling_addr
);
23019 start_byte
+= ceiling_addr
- base
;
23024 while (start_byte
> limit_byte
)
23026 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23027 ceiling
= max (limit_byte
, ceiling
);
23028 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23029 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23032 if (selective_display
)
23034 while (--cursor
>= ceiling_addr
23035 && *cursor
!= '\n' && *cursor
!= 015)
23037 if (cursor
< ceiling_addr
)
23042 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23049 start_byte
+= cursor
- base
+ 1;
23050 *byte_pos_ptr
= start_byte
;
23051 /* When scanning backwards, we should
23052 not count the newline posterior to which we stop. */
23053 return - orig_count
- 1;
23056 start_byte
+= ceiling_addr
- base
;
23060 *byte_pos_ptr
= limit_byte
;
23063 return - orig_count
+ count
;
23064 return orig_count
- count
;
23070 /***********************************************************************
23072 ***********************************************************************/
23074 /* Display a NUL-terminated string, starting with index START.
23076 If STRING is non-null, display that C string. Otherwise, the Lisp
23077 string LISP_STRING is displayed. There's a case that STRING is
23078 non-null and LISP_STRING is not nil. It means STRING is a string
23079 data of LISP_STRING. In that case, we display LISP_STRING while
23080 ignoring its text properties.
23082 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23083 FACE_STRING. Display STRING or LISP_STRING with the face at
23084 FACE_STRING_POS in FACE_STRING:
23086 Display the string in the environment given by IT, but use the
23087 standard display table, temporarily.
23089 FIELD_WIDTH is the minimum number of output glyphs to produce.
23090 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23091 with spaces. If STRING has more characters, more than FIELD_WIDTH
23092 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23094 PRECISION is the maximum number of characters to output from
23095 STRING. PRECISION < 0 means don't truncate the string.
23097 This is roughly equivalent to printf format specifiers:
23099 FIELD_WIDTH PRECISION PRINTF
23100 ----------------------------------------
23106 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23107 display them, and < 0 means obey the current buffer's value of
23108 enable_multibyte_characters.
23110 Value is the number of columns displayed. */
23113 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23114 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23115 int field_width
, int precision
, int max_x
, int multibyte
)
23117 int hpos_at_start
= it
->hpos
;
23118 int saved_face_id
= it
->face_id
;
23119 struct glyph_row
*row
= it
->glyph_row
;
23120 ptrdiff_t it_charpos
;
23122 /* Initialize the iterator IT for iteration over STRING beginning
23123 with index START. */
23124 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23125 precision
, field_width
, multibyte
);
23126 if (string
&& STRINGP (lisp_string
))
23127 /* LISP_STRING is the one returned by decode_mode_spec. We should
23128 ignore its text properties. */
23129 it
->stop_charpos
= it
->end_charpos
;
23131 /* If displaying STRING, set up the face of the iterator from
23132 FACE_STRING, if that's given. */
23133 if (STRINGP (face_string
))
23139 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23140 0, &endptr
, it
->base_face_id
, 0);
23141 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23142 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23145 /* Set max_x to the maximum allowed X position. Don't let it go
23146 beyond the right edge of the window. */
23148 max_x
= it
->last_visible_x
;
23150 max_x
= min (max_x
, it
->last_visible_x
);
23152 /* Skip over display elements that are not visible. because IT->w is
23154 if (it
->current_x
< it
->first_visible_x
)
23155 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23156 MOVE_TO_POS
| MOVE_TO_X
);
23158 row
->ascent
= it
->max_ascent
;
23159 row
->height
= it
->max_ascent
+ it
->max_descent
;
23160 row
->phys_ascent
= it
->max_phys_ascent
;
23161 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23162 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23164 if (STRINGP (it
->string
))
23165 it_charpos
= IT_STRING_CHARPOS (*it
);
23167 it_charpos
= IT_CHARPOS (*it
);
23169 /* This condition is for the case that we are called with current_x
23170 past last_visible_x. */
23171 while (it
->current_x
< max_x
)
23173 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23175 /* Get the next display element. */
23176 if (!get_next_display_element (it
))
23179 /* Produce glyphs. */
23180 x_before
= it
->current_x
;
23181 n_glyphs_before
= row
->used
[TEXT_AREA
];
23182 PRODUCE_GLYPHS (it
);
23184 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23187 while (i
< nglyphs
)
23189 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23191 if (it
->line_wrap
!= TRUNCATE
23192 && x
+ glyph
->pixel_width
> max_x
)
23194 /* End of continued line or max_x reached. */
23195 if (CHAR_GLYPH_PADDING_P (*glyph
))
23197 /* A wide character is unbreakable. */
23198 if (row
->reversed_p
)
23199 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23200 - n_glyphs_before
);
23201 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23202 it
->current_x
= x_before
;
23206 if (row
->reversed_p
)
23207 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23208 - (n_glyphs_before
+ i
));
23209 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23214 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23216 /* Glyph is at least partially visible. */
23218 if (x
< it
->first_visible_x
)
23219 row
->x
= x
- it
->first_visible_x
;
23223 /* Glyph is off the left margin of the display area.
23224 Should not happen. */
23228 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23229 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23230 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23231 row
->phys_height
= max (row
->phys_height
,
23232 it
->max_phys_ascent
+ it
->max_phys_descent
);
23233 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23234 it
->max_extra_line_spacing
);
23235 x
+= glyph
->pixel_width
;
23239 /* Stop if max_x reached. */
23243 /* Stop at line ends. */
23244 if (ITERATOR_AT_END_OF_LINE_P (it
))
23246 it
->continuation_lines_width
= 0;
23250 set_iterator_to_next (it
, 1);
23251 if (STRINGP (it
->string
))
23252 it_charpos
= IT_STRING_CHARPOS (*it
);
23254 it_charpos
= IT_CHARPOS (*it
);
23256 /* Stop if truncating at the right edge. */
23257 if (it
->line_wrap
== TRUNCATE
23258 && it
->current_x
>= it
->last_visible_x
)
23260 /* Add truncation mark, but don't do it if the line is
23261 truncated at a padding space. */
23262 if (it_charpos
< it
->string_nchars
)
23264 if (!FRAME_WINDOW_P (it
->f
))
23268 if (it
->current_x
> it
->last_visible_x
)
23270 if (!row
->reversed_p
)
23272 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23273 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23278 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23279 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23281 unproduce_glyphs (it
, ii
+ 1);
23282 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23284 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23286 row
->used
[TEXT_AREA
] = ii
;
23287 produce_special_glyphs (it
, IT_TRUNCATION
);
23290 produce_special_glyphs (it
, IT_TRUNCATION
);
23292 row
->truncated_on_right_p
= 1;
23298 /* Maybe insert a truncation at the left. */
23299 if (it
->first_visible_x
23302 if (!FRAME_WINDOW_P (it
->f
)
23303 || (row
->reversed_p
23304 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23305 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23306 insert_left_trunc_glyphs (it
);
23307 row
->truncated_on_left_p
= 1;
23310 it
->face_id
= saved_face_id
;
23312 /* Value is number of columns displayed. */
23313 return it
->hpos
- hpos_at_start
;
23318 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23319 appears as an element of LIST or as the car of an element of LIST.
23320 If PROPVAL is a list, compare each element against LIST in that
23321 way, and return 1/2 if any element of PROPVAL is found in LIST.
23322 Otherwise return 0. This function cannot quit.
23323 The return value is 2 if the text is invisible but with an ellipsis
23324 and 1 if it's invisible and without an ellipsis. */
23327 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
23329 register Lisp_Object tail
, proptail
;
23331 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23333 register Lisp_Object tem
;
23335 if (EQ (propval
, tem
))
23337 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23338 return NILP (XCDR (tem
)) ? 1 : 2;
23341 if (CONSP (propval
))
23343 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23345 Lisp_Object propelt
;
23346 propelt
= XCAR (proptail
);
23347 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23349 register Lisp_Object tem
;
23351 if (EQ (propelt
, tem
))
23353 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23354 return NILP (XCDR (tem
)) ? 1 : 2;
23362 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23363 doc
: /* Non-nil if the property makes the text invisible.
23364 POS-OR-PROP can be a marker or number, in which case it is taken to be
23365 a position in the current buffer and the value of the `invisible' property
23366 is checked; or it can be some other value, which is then presumed to be the
23367 value of the `invisible' property of the text of interest.
23368 The non-nil value returned can be t for truly invisible text or something
23369 else if the text is replaced by an ellipsis. */)
23370 (Lisp_Object pos_or_prop
)
23373 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23374 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23376 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23377 return (invis
== 0 ? Qnil
23379 : make_number (invis
));
23382 /* Calculate a width or height in pixels from a specification using
23383 the following elements:
23386 NUM - a (fractional) multiple of the default font width/height
23387 (NUM) - specifies exactly NUM pixels
23388 UNIT - a fixed number of pixels, see below.
23389 ELEMENT - size of a display element in pixels, see below.
23390 (NUM . SPEC) - equals NUM * SPEC
23391 (+ SPEC SPEC ...) - add pixel values
23392 (- SPEC SPEC ...) - subtract pixel values
23393 (- SPEC) - negate pixel value
23396 INT or FLOAT - a number constant
23397 SYMBOL - use symbol's (buffer local) variable binding.
23400 in - pixels per inch *)
23401 mm - pixels per 1/1000 meter *)
23402 cm - pixels per 1/100 meter *)
23403 width - width of current font in pixels.
23404 height - height of current font in pixels.
23406 *) using the ratio(s) defined in display-pixels-per-inch.
23410 left-fringe - left fringe width in pixels
23411 right-fringe - right fringe width in pixels
23413 left-margin - left margin width in pixels
23414 right-margin - right margin width in pixels
23416 scroll-bar - scroll-bar area width in pixels
23420 Pixels corresponding to 5 inches:
23423 Total width of non-text areas on left side of window (if scroll-bar is on left):
23424 '(space :width (+ left-fringe left-margin scroll-bar))
23426 Align to first text column (in header line):
23427 '(space :align-to 0)
23429 Align to middle of text area minus half the width of variable `my-image'
23430 containing a loaded image:
23431 '(space :align-to (0.5 . (- text my-image)))
23433 Width of left margin minus width of 1 character in the default font:
23434 '(space :width (- left-margin 1))
23436 Width of left margin minus width of 2 characters in the current font:
23437 '(space :width (- left-margin (2 . width)))
23439 Center 1 character over left-margin (in header line):
23440 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23442 Different ways to express width of left fringe plus left margin minus one pixel:
23443 '(space :width (- (+ left-fringe left-margin) (1)))
23444 '(space :width (+ left-fringe left-margin (- (1))))
23445 '(space :width (+ left-fringe left-margin (-1)))
23450 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
23451 struct font
*font
, int width_p
, int *align_to
)
23455 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
23456 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
23459 return OK_PIXELS (0);
23461 eassert (FRAME_LIVE_P (it
->f
));
23463 if (SYMBOLP (prop
))
23465 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
23467 char *unit
= SSDATA (SYMBOL_NAME (prop
));
23469 if (unit
[0] == 'i' && unit
[1] == 'n')
23471 else if (unit
[0] == 'm' && unit
[1] == 'm')
23473 else if (unit
[0] == 'c' && unit
[1] == 'm')
23479 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
23480 : FRAME_RES_Y (it
->f
));
23483 return OK_PIXELS (ppi
/ pixels
);
23488 #ifdef HAVE_WINDOW_SYSTEM
23489 if (EQ (prop
, Qheight
))
23490 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
23491 if (EQ (prop
, Qwidth
))
23492 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
23494 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
23495 return OK_PIXELS (1);
23498 if (EQ (prop
, Qtext
))
23499 return OK_PIXELS (width_p
23500 ? window_box_width (it
->w
, TEXT_AREA
)
23501 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
23503 if (align_to
&& *align_to
< 0)
23506 if (EQ (prop
, Qleft
))
23507 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
23508 if (EQ (prop
, Qright
))
23509 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
23510 if (EQ (prop
, Qcenter
))
23511 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
23512 + window_box_width (it
->w
, TEXT_AREA
) / 2);
23513 if (EQ (prop
, Qleft_fringe
))
23514 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23515 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
23516 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
23517 if (EQ (prop
, Qright_fringe
))
23518 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23519 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23520 : window_box_right_offset (it
->w
, TEXT_AREA
));
23521 if (EQ (prop
, Qleft_margin
))
23522 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
23523 if (EQ (prop
, Qright_margin
))
23524 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
23525 if (EQ (prop
, Qscroll_bar
))
23526 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
23528 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23529 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23530 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23535 if (EQ (prop
, Qleft_fringe
))
23536 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
23537 if (EQ (prop
, Qright_fringe
))
23538 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
23539 if (EQ (prop
, Qleft_margin
))
23540 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
23541 if (EQ (prop
, Qright_margin
))
23542 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
23543 if (EQ (prop
, Qscroll_bar
))
23544 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
23547 prop
= buffer_local_value (prop
, it
->w
->contents
);
23548 if (EQ (prop
, Qunbound
))
23552 if (INTEGERP (prop
) || FLOATP (prop
))
23554 int base_unit
= (width_p
23555 ? FRAME_COLUMN_WIDTH (it
->f
)
23556 : FRAME_LINE_HEIGHT (it
->f
));
23557 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
23562 Lisp_Object car
= XCAR (prop
);
23563 Lisp_Object cdr
= XCDR (prop
);
23567 #ifdef HAVE_WINDOW_SYSTEM
23568 if (FRAME_WINDOW_P (it
->f
)
23569 && valid_image_p (prop
))
23571 ptrdiff_t id
= lookup_image (it
->f
, prop
);
23572 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
23574 return OK_PIXELS (width_p
? img
->width
: img
->height
);
23577 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
23583 while (CONSP (cdr
))
23585 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
23586 font
, width_p
, align_to
))
23589 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
23594 if (EQ (car
, Qminus
))
23596 return OK_PIXELS (pixels
);
23599 car
= buffer_local_value (car
, it
->w
->contents
);
23600 if (EQ (car
, Qunbound
))
23604 if (INTEGERP (car
) || FLOATP (car
))
23607 pixels
= XFLOATINT (car
);
23609 return OK_PIXELS (pixels
);
23610 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
23611 font
, width_p
, align_to
))
23612 return OK_PIXELS (pixels
* fact
);
23623 /***********************************************************************
23625 ***********************************************************************/
23627 #ifdef HAVE_WINDOW_SYSTEM
23632 dump_glyph_string (struct glyph_string
*s
)
23634 fprintf (stderr
, "glyph string\n");
23635 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
23636 s
->x
, s
->y
, s
->width
, s
->height
);
23637 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
23638 fprintf (stderr
, " hl = %d\n", s
->hl
);
23639 fprintf (stderr
, " left overhang = %d, right = %d\n",
23640 s
->left_overhang
, s
->right_overhang
);
23641 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
23642 fprintf (stderr
, " extends to end of line = %d\n",
23643 s
->extends_to_end_of_line_p
);
23644 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
23645 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
23648 #endif /* GLYPH_DEBUG */
23650 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
23651 of XChar2b structures for S; it can't be allocated in
23652 init_glyph_string because it must be allocated via `alloca'. W
23653 is the window on which S is drawn. ROW and AREA are the glyph row
23654 and area within the row from which S is constructed. START is the
23655 index of the first glyph structure covered by S. HL is a
23656 face-override for drawing S. */
23659 #define OPTIONAL_HDC(hdc) HDC hdc,
23660 #define DECLARE_HDC(hdc) HDC hdc;
23661 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
23662 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
23665 #ifndef OPTIONAL_HDC
23666 #define OPTIONAL_HDC(hdc)
23667 #define DECLARE_HDC(hdc)
23668 #define ALLOCATE_HDC(hdc, f)
23669 #define RELEASE_HDC(hdc, f)
23673 init_glyph_string (struct glyph_string
*s
,
23675 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
23676 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
23678 memset (s
, 0, sizeof *s
);
23680 s
->f
= XFRAME (w
->frame
);
23684 s
->display
= FRAME_X_DISPLAY (s
->f
);
23685 s
->window
= FRAME_X_WINDOW (s
->f
);
23686 s
->char2b
= char2b
;
23690 s
->first_glyph
= row
->glyphs
[area
] + start
;
23691 s
->height
= row
->height
;
23692 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
23693 s
->ybase
= s
->y
+ row
->ascent
;
23697 /* Append the list of glyph strings with head H and tail T to the list
23698 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
23701 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23702 struct glyph_string
*h
, struct glyph_string
*t
)
23716 /* Prepend the list of glyph strings with head H and tail T to the
23717 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
23721 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23722 struct glyph_string
*h
, struct glyph_string
*t
)
23736 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
23737 Set *HEAD and *TAIL to the resulting list. */
23740 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
23741 struct glyph_string
*s
)
23743 s
->next
= s
->prev
= NULL
;
23744 append_glyph_string_lists (head
, tail
, s
, s
);
23748 /* Get face and two-byte form of character C in face FACE_ID on frame F.
23749 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
23750 make sure that X resources for the face returned are allocated.
23751 Value is a pointer to a realized face that is ready for display if
23752 DISPLAY_P is non-zero. */
23754 static struct face
*
23755 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
23756 XChar2b
*char2b
, int display_p
)
23758 struct face
*face
= FACE_FROM_ID (f
, face_id
);
23763 code
= face
->font
->driver
->encode_char (face
->font
, c
);
23765 if (code
== FONT_INVALID_CODE
)
23768 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23770 /* Make sure X resources of the face are allocated. */
23771 #ifdef HAVE_X_WINDOWS
23775 eassert (face
!= NULL
);
23776 prepare_face_for_display (f
, face
);
23783 /* Get face and two-byte form of character glyph GLYPH on frame F.
23784 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
23785 a pointer to a realized face that is ready for display. */
23787 static struct face
*
23788 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
23789 XChar2b
*char2b
, int *two_byte_p
)
23794 eassert (glyph
->type
== CHAR_GLYPH
);
23795 face
= FACE_FROM_ID (f
, glyph
->face_id
);
23797 /* Make sure X resources of the face are allocated. */
23798 eassert (face
!= NULL
);
23799 prepare_face_for_display (f
, face
);
23806 if (CHAR_BYTE8_P (glyph
->u
.ch
))
23807 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
23809 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
23811 if (code
== FONT_INVALID_CODE
)
23815 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23820 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
23821 Return 1 if FONT has a glyph for C, otherwise return 0. */
23824 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
23828 if (CHAR_BYTE8_P (c
))
23829 code
= CHAR_TO_BYTE8 (c
);
23831 code
= font
->driver
->encode_char (font
, c
);
23833 if (code
== FONT_INVALID_CODE
)
23835 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23840 /* Fill glyph string S with composition components specified by S->cmp.
23842 BASE_FACE is the base face of the composition.
23843 S->cmp_from is the index of the first component for S.
23845 OVERLAPS non-zero means S should draw the foreground only, and use
23846 its physical height for clipping. See also draw_glyphs.
23848 Value is the index of a component not in S. */
23851 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
23855 /* For all glyphs of this composition, starting at the offset
23856 S->cmp_from, until we reach the end of the definition or encounter a
23857 glyph that requires the different face, add it to S. */
23862 s
->for_overlaps
= overlaps
;
23865 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
23867 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
23869 /* TAB in a composition means display glyphs with padding space
23870 on the left or right. */
23873 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
23876 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
23883 s
->font
= s
->face
->font
;
23885 else if (s
->face
!= face
)
23893 if (s
->face
== NULL
)
23895 s
->face
= base_face
->ascii_face
;
23896 s
->font
= s
->face
->font
;
23899 /* All glyph strings for the same composition has the same width,
23900 i.e. the width set for the first component of the composition. */
23901 s
->width
= s
->first_glyph
->pixel_width
;
23903 /* If the specified font could not be loaded, use the frame's
23904 default font, but record the fact that we couldn't load it in
23905 the glyph string so that we can draw rectangles for the
23906 characters of the glyph string. */
23907 if (s
->font
== NULL
)
23909 s
->font_not_found_p
= 1;
23910 s
->font
= FRAME_FONT (s
->f
);
23913 /* Adjust base line for subscript/superscript text. */
23914 s
->ybase
+= s
->first_glyph
->voffset
;
23916 /* This glyph string must always be drawn with 16-bit functions. */
23923 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
23924 int start
, int end
, int overlaps
)
23926 struct glyph
*glyph
, *last
;
23927 Lisp_Object lgstring
;
23930 s
->for_overlaps
= overlaps
;
23931 glyph
= s
->row
->glyphs
[s
->area
] + start
;
23932 last
= s
->row
->glyphs
[s
->area
] + end
;
23933 s
->cmp_id
= glyph
->u
.cmp
.id
;
23934 s
->cmp_from
= glyph
->slice
.cmp
.from
;
23935 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
23936 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
23937 lgstring
= composition_gstring_from_id (s
->cmp_id
);
23938 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
23940 while (glyph
< last
23941 && glyph
->u
.cmp
.automatic
23942 && glyph
->u
.cmp
.id
== s
->cmp_id
23943 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
23944 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
23946 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
23948 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
23949 unsigned code
= LGLYPH_CODE (lglyph
);
23951 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
23953 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
23954 return glyph
- s
->row
->glyphs
[s
->area
];
23958 /* Fill glyph string S from a sequence glyphs for glyphless characters.
23959 See the comment of fill_glyph_string for arguments.
23960 Value is the index of the first glyph not in S. */
23964 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
23965 int start
, int end
, int overlaps
)
23967 struct glyph
*glyph
, *last
;
23970 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
23971 s
->for_overlaps
= overlaps
;
23972 glyph
= s
->row
->glyphs
[s
->area
] + start
;
23973 last
= s
->row
->glyphs
[s
->area
] + end
;
23974 voffset
= glyph
->voffset
;
23975 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
23976 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
23978 s
->width
= glyph
->pixel_width
;
23980 while (glyph
< last
23981 && glyph
->type
== GLYPHLESS_GLYPH
23982 && glyph
->voffset
== voffset
23983 && glyph
->face_id
== face_id
)
23986 s
->width
+= glyph
->pixel_width
;
23989 s
->ybase
+= voffset
;
23990 return glyph
- s
->row
->glyphs
[s
->area
];
23994 /* Fill glyph string S from a sequence of character glyphs.
23996 FACE_ID is the face id of the string. START is the index of the
23997 first glyph to consider, END is the index of the last + 1.
23998 OVERLAPS non-zero means S should draw the foreground only, and use
23999 its physical height for clipping. See also draw_glyphs.
24001 Value is the index of the first glyph not in S. */
24004 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24005 int start
, int end
, int overlaps
)
24007 struct glyph
*glyph
, *last
;
24009 int glyph_not_available_p
;
24011 eassert (s
->f
== XFRAME (s
->w
->frame
));
24012 eassert (s
->nchars
== 0);
24013 eassert (start
>= 0 && end
> start
);
24015 s
->for_overlaps
= overlaps
;
24016 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24017 last
= s
->row
->glyphs
[s
->area
] + end
;
24018 voffset
= glyph
->voffset
;
24019 s
->padding_p
= glyph
->padding_p
;
24020 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24022 while (glyph
< last
24023 && glyph
->type
== CHAR_GLYPH
24024 && glyph
->voffset
== voffset
24025 /* Same face id implies same font, nowadays. */
24026 && glyph
->face_id
== face_id
24027 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24031 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24032 s
->char2b
+ s
->nchars
,
24034 s
->two_byte_p
= two_byte_p
;
24036 eassert (s
->nchars
<= end
- start
);
24037 s
->width
+= glyph
->pixel_width
;
24038 if (glyph
++->padding_p
!= s
->padding_p
)
24042 s
->font
= s
->face
->font
;
24044 /* If the specified font could not be loaded, use the frame's font,
24045 but record the fact that we couldn't load it in
24046 S->font_not_found_p so that we can draw rectangles for the
24047 characters of the glyph string. */
24048 if (s
->font
== NULL
|| glyph_not_available_p
)
24050 s
->font_not_found_p
= 1;
24051 s
->font
= FRAME_FONT (s
->f
);
24054 /* Adjust base line for subscript/superscript text. */
24055 s
->ybase
+= voffset
;
24057 eassert (s
->face
&& s
->face
->gc
);
24058 return glyph
- s
->row
->glyphs
[s
->area
];
24062 /* Fill glyph string S from image glyph S->first_glyph. */
24065 fill_image_glyph_string (struct glyph_string
*s
)
24067 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24068 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24070 s
->slice
= s
->first_glyph
->slice
.img
;
24071 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24072 s
->font
= s
->face
->font
;
24073 s
->width
= s
->first_glyph
->pixel_width
;
24075 /* Adjust base line for subscript/superscript text. */
24076 s
->ybase
+= s
->first_glyph
->voffset
;
24080 /* Fill glyph string S from a sequence of stretch glyphs.
24082 START is the index of the first glyph to consider,
24083 END is the index of the last + 1.
24085 Value is the index of the first glyph not in S. */
24088 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24090 struct glyph
*glyph
, *last
;
24091 int voffset
, face_id
;
24093 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24095 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24096 last
= s
->row
->glyphs
[s
->area
] + end
;
24097 face_id
= glyph
->face_id
;
24098 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24099 s
->font
= s
->face
->font
;
24100 s
->width
= glyph
->pixel_width
;
24102 voffset
= glyph
->voffset
;
24106 && glyph
->type
== STRETCH_GLYPH
24107 && glyph
->voffset
== voffset
24108 && glyph
->face_id
== face_id
);
24110 s
->width
+= glyph
->pixel_width
;
24112 /* Adjust base line for subscript/superscript text. */
24113 s
->ybase
+= voffset
;
24115 /* The case that face->gc == 0 is handled when drawing the glyph
24116 string by calling prepare_face_for_display. */
24118 return glyph
- s
->row
->glyphs
[s
->area
];
24121 static struct font_metrics
*
24122 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24124 static struct font_metrics metrics
;
24129 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24130 if (code
== FONT_INVALID_CODE
)
24132 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24137 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24138 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24139 assumed to be zero. */
24142 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24144 *left
= *right
= 0;
24146 if (glyph
->type
== CHAR_GLYPH
)
24150 struct font_metrics
*pcm
;
24152 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
24153 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
24155 if (pcm
->rbearing
> pcm
->width
)
24156 *right
= pcm
->rbearing
- pcm
->width
;
24157 if (pcm
->lbearing
< 0)
24158 *left
= -pcm
->lbearing
;
24161 else if (glyph
->type
== COMPOSITE_GLYPH
)
24163 if (! glyph
->u
.cmp
.automatic
)
24165 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24167 if (cmp
->rbearing
> cmp
->pixel_width
)
24168 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24169 if (cmp
->lbearing
< 0)
24170 *left
= - cmp
->lbearing
;
24174 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24175 struct font_metrics metrics
;
24177 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24178 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24179 if (metrics
.rbearing
> metrics
.width
)
24180 *right
= metrics
.rbearing
- metrics
.width
;
24181 if (metrics
.lbearing
< 0)
24182 *left
= - metrics
.lbearing
;
24188 /* Return the index of the first glyph preceding glyph string S that
24189 is overwritten by S because of S's left overhang. Value is -1
24190 if no glyphs are overwritten. */
24193 left_overwritten (struct glyph_string
*s
)
24197 if (s
->left_overhang
)
24200 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24201 int first
= s
->first_glyph
- glyphs
;
24203 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24204 x
-= glyphs
[i
].pixel_width
;
24215 /* Return the index of the first glyph preceding glyph string S that
24216 is overwriting S because of its right overhang. Value is -1 if no
24217 glyph in front of S overwrites S. */
24220 left_overwriting (struct glyph_string
*s
)
24223 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24224 int first
= s
->first_glyph
- glyphs
;
24228 for (i
= first
- 1; i
>= 0; --i
)
24231 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24234 x
-= glyphs
[i
].pixel_width
;
24241 /* Return the index of the last glyph following glyph string S that is
24242 overwritten by S because of S's right overhang. Value is -1 if
24243 no such glyph is found. */
24246 right_overwritten (struct glyph_string
*s
)
24250 if (s
->right_overhang
)
24253 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24254 int first
= (s
->first_glyph
- glyphs
24255 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24256 int end
= s
->row
->used
[s
->area
];
24258 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24259 x
+= glyphs
[i
].pixel_width
;
24268 /* Return the index of the last glyph following glyph string S that
24269 overwrites S because of its left overhang. Value is negative
24270 if no such glyph is found. */
24273 right_overwriting (struct glyph_string
*s
)
24276 int end
= s
->row
->used
[s
->area
];
24277 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24278 int first
= (s
->first_glyph
- glyphs
24279 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24283 for (i
= first
; i
< end
; ++i
)
24286 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24289 x
+= glyphs
[i
].pixel_width
;
24296 /* Set background width of glyph string S. START is the index of the
24297 first glyph following S. LAST_X is the right-most x-position + 1
24298 in the drawing area. */
24301 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24303 /* If the face of this glyph string has to be drawn to the end of
24304 the drawing area, set S->extends_to_end_of_line_p. */
24306 if (start
== s
->row
->used
[s
->area
]
24307 && ((s
->row
->fill_line_p
24308 && (s
->hl
== DRAW_NORMAL_TEXT
24309 || s
->hl
== DRAW_IMAGE_RAISED
24310 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24311 || s
->hl
== DRAW_MOUSE_FACE
))
24312 s
->extends_to_end_of_line_p
= 1;
24314 /* If S extends its face to the end of the line, set its
24315 background_width to the distance to the right edge of the drawing
24317 if (s
->extends_to_end_of_line_p
)
24318 s
->background_width
= last_x
- s
->x
+ 1;
24320 s
->background_width
= s
->width
;
24324 /* Compute overhangs and x-positions for glyph string S and its
24325 predecessors, or successors. X is the starting x-position for S.
24326 BACKWARD_P non-zero means process predecessors. */
24329 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
24335 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24336 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24346 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24347 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24357 /* The following macros are only called from draw_glyphs below.
24358 They reference the following parameters of that function directly:
24359 `w', `row', `area', and `overlap_p'
24360 as well as the following local variables:
24361 `s', `f', and `hdc' (in W32) */
24364 /* On W32, silently add local `hdc' variable to argument list of
24365 init_glyph_string. */
24366 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24367 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24369 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24370 init_glyph_string (s, char2b, w, row, area, start, hl)
24373 /* Add a glyph string for a stretch glyph to the list of strings
24374 between HEAD and TAIL. START is the index of the stretch glyph in
24375 row area AREA of glyph row ROW. END is the index of the last glyph
24376 in that glyph row area. X is the current output position assigned
24377 to the new glyph string constructed. HL overrides that face of the
24378 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24379 is the right-most x-position of the drawing area. */
24381 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24382 and below -- keep them on one line. */
24383 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24386 s = alloca (sizeof *s); \
24387 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24388 START = fill_stretch_glyph_string (s, START, END); \
24389 append_glyph_string (&HEAD, &TAIL, s); \
24395 /* Add a glyph string for an image glyph to the list of strings
24396 between HEAD and TAIL. START is the index of the image glyph in
24397 row area AREA of glyph row ROW. END is the index of the last glyph
24398 in that glyph row area. X is the current output position assigned
24399 to the new glyph string constructed. HL overrides that face of the
24400 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24401 is the right-most x-position of the drawing area. */
24403 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24406 s = alloca (sizeof *s); \
24407 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24408 fill_image_glyph_string (s); \
24409 append_glyph_string (&HEAD, &TAIL, s); \
24416 /* Add a glyph string for a sequence of character glyphs to the list
24417 of strings between HEAD and TAIL. START is the index of the first
24418 glyph in row area AREA of glyph row ROW that is part of the new
24419 glyph string. END is the index of the last glyph in that glyph row
24420 area. X is the current output position assigned to the new glyph
24421 string constructed. HL overrides that face of the glyph; e.g. it
24422 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24423 right-most x-position of the drawing area. */
24425 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24431 face_id = (row)->glyphs[area][START].face_id; \
24433 s = alloca (sizeof *s); \
24434 char2b = alloca ((END - START) * sizeof *char2b); \
24435 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24436 append_glyph_string (&HEAD, &TAIL, s); \
24438 START = fill_glyph_string (s, face_id, START, END, overlaps); \
24443 /* Add a glyph string for a composite sequence to the list of strings
24444 between HEAD and TAIL. START is the index of the first glyph in
24445 row area AREA of glyph row ROW that is part of the new glyph
24446 string. END is the index of the last glyph in that glyph row area.
24447 X is the current output position assigned to the new glyph string
24448 constructed. HL overrides that face of the glyph; e.g. it is
24449 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
24450 x-position of the drawing area. */
24452 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24454 int face_id = (row)->glyphs[area][START].face_id; \
24455 struct face *base_face = FACE_FROM_ID (f, face_id); \
24456 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
24457 struct composition *cmp = composition_table[cmp_id]; \
24459 struct glyph_string *first_s = NULL; \
24462 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
24464 /* Make glyph_strings for each glyph sequence that is drawable by \
24465 the same face, and append them to HEAD/TAIL. */ \
24466 for (n = 0; n < cmp->glyph_len;) \
24468 s = alloca (sizeof *s); \
24469 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24470 append_glyph_string (&(HEAD), &(TAIL), s); \
24476 n = fill_composite_glyph_string (s, base_face, overlaps); \
24484 /* Add a glyph string for a glyph-string sequence to the list of strings
24485 between HEAD and TAIL. */
24487 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24491 Lisp_Object gstring; \
24493 face_id = (row)->glyphs[area][START].face_id; \
24494 gstring = (composition_gstring_from_id \
24495 ((row)->glyphs[area][START].u.cmp.id)); \
24496 s = alloca (sizeof *s); \
24497 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
24498 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24499 append_glyph_string (&(HEAD), &(TAIL), s); \
24501 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
24505 /* Add a glyph string for a sequence of glyphless character's glyphs
24506 to the list of strings between HEAD and TAIL. The meanings of
24507 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
24509 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24514 face_id = (row)->glyphs[area][START].face_id; \
24516 s = alloca (sizeof *s); \
24517 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24518 append_glyph_string (&HEAD, &TAIL, s); \
24520 START = fill_glyphless_glyph_string (s, face_id, START, END, \
24526 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
24527 of AREA of glyph row ROW on window W between indices START and END.
24528 HL overrides the face for drawing glyph strings, e.g. it is
24529 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
24530 x-positions of the drawing area.
24532 This is an ugly monster macro construct because we must use alloca
24533 to allocate glyph strings (because draw_glyphs can be called
24534 asynchronously). */
24536 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24539 HEAD = TAIL = NULL; \
24540 while (START < END) \
24542 struct glyph *first_glyph = (row)->glyphs[area] + START; \
24543 switch (first_glyph->type) \
24546 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
24550 case COMPOSITE_GLYPH: \
24551 if (first_glyph->u.cmp.automatic) \
24552 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
24555 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
24559 case STRETCH_GLYPH: \
24560 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
24564 case IMAGE_GLYPH: \
24565 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
24569 case GLYPHLESS_GLYPH: \
24570 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
24580 set_glyph_string_background_width (s, START, LAST_X); \
24587 /* Draw glyphs between START and END in AREA of ROW on window W,
24588 starting at x-position X. X is relative to AREA in W. HL is a
24589 face-override with the following meaning:
24591 DRAW_NORMAL_TEXT draw normally
24592 DRAW_CURSOR draw in cursor face
24593 DRAW_MOUSE_FACE draw in mouse face.
24594 DRAW_INVERSE_VIDEO draw in mode line face
24595 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
24596 DRAW_IMAGE_RAISED draw an image with a raised relief around it
24598 If OVERLAPS is non-zero, draw only the foreground of characters and
24599 clip to the physical height of ROW. Non-zero value also defines
24600 the overlapping part to be drawn:
24602 OVERLAPS_PRED overlap with preceding rows
24603 OVERLAPS_SUCC overlap with succeeding rows
24604 OVERLAPS_BOTH overlap with both preceding/succeeding rows
24605 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
24607 Value is the x-position reached, relative to AREA of W. */
24610 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
24611 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
24612 enum draw_glyphs_face hl
, int overlaps
)
24614 struct glyph_string
*head
, *tail
;
24615 struct glyph_string
*s
;
24616 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
24617 int i
, j
, x_reached
, last_x
, area_left
= 0;
24618 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24621 ALLOCATE_HDC (hdc
, f
);
24623 /* Let's rather be paranoid than getting a SEGV. */
24624 end
= min (end
, row
->used
[area
]);
24625 start
= clip_to_bounds (0, start
, end
);
24627 /* Translate X to frame coordinates. Set last_x to the right
24628 end of the drawing area. */
24629 if (row
->full_width_p
)
24631 /* X is relative to the left edge of W, without scroll bars
24633 area_left
= WINDOW_LEFT_EDGE_X (w
);
24634 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
24635 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
24639 area_left
= window_box_left (w
, area
);
24640 last_x
= area_left
+ window_box_width (w
, area
);
24644 /* Build a doubly-linked list of glyph_string structures between
24645 head and tail from what we have to draw. Note that the macro
24646 BUILD_GLYPH_STRINGS will modify its start parameter. That's
24647 the reason we use a separate variable `i'. */
24649 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
24651 x_reached
= tail
->x
+ tail
->background_width
;
24655 /* If there are any glyphs with lbearing < 0 or rbearing > width in
24656 the row, redraw some glyphs in front or following the glyph
24657 strings built above. */
24658 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
24660 struct glyph_string
*h
, *t
;
24661 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24662 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
24663 int check_mouse_face
= 0;
24666 /* If mouse highlighting is on, we may need to draw adjacent
24667 glyphs using mouse-face highlighting. */
24668 if (area
== TEXT_AREA
&& row
->mouse_face_p
24669 && hlinfo
->mouse_face_beg_row
>= 0
24670 && hlinfo
->mouse_face_end_row
>= 0)
24672 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
24674 if (row_vpos
>= hlinfo
->mouse_face_beg_row
24675 && row_vpos
<= hlinfo
->mouse_face_end_row
)
24677 check_mouse_face
= 1;
24678 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
24679 ? hlinfo
->mouse_face_beg_col
: 0;
24680 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
24681 ? hlinfo
->mouse_face_end_col
24682 : row
->used
[TEXT_AREA
];
24686 /* Compute overhangs for all glyph strings. */
24687 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
24688 for (s
= head
; s
; s
= s
->next
)
24689 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
24691 /* Prepend glyph strings for glyphs in front of the first glyph
24692 string that are overwritten because of the first glyph
24693 string's left overhang. The background of all strings
24694 prepended must be drawn because the first glyph string
24696 i
= left_overwritten (head
);
24699 enum draw_glyphs_face overlap_hl
;
24701 /* If this row contains mouse highlighting, attempt to draw
24702 the overlapped glyphs with the correct highlight. This
24703 code fails if the overlap encompasses more than one glyph
24704 and mouse-highlight spans only some of these glyphs.
24705 However, making it work perfectly involves a lot more
24706 code, and I don't know if the pathological case occurs in
24707 practice, so we'll stick to this for now. --- cyd */
24708 if (check_mouse_face
24709 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24710 overlap_hl
= DRAW_MOUSE_FACE
;
24712 overlap_hl
= DRAW_NORMAL_TEXT
;
24714 if (hl
!= overlap_hl
)
24717 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
24718 overlap_hl
, dummy_x
, last_x
);
24720 compute_overhangs_and_x (t
, head
->x
, 1);
24721 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24722 if (clip_head
== NULL
)
24726 /* Prepend glyph strings for glyphs in front of the first glyph
24727 string that overwrite that glyph string because of their
24728 right overhang. For these strings, only the foreground must
24729 be drawn, because it draws over the glyph string at `head'.
24730 The background must not be drawn because this would overwrite
24731 right overhangs of preceding glyphs for which no glyph
24733 i
= left_overwriting (head
);
24736 enum draw_glyphs_face overlap_hl
;
24738 if (check_mouse_face
24739 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24740 overlap_hl
= DRAW_MOUSE_FACE
;
24742 overlap_hl
= DRAW_NORMAL_TEXT
;
24744 if (hl
== overlap_hl
|| clip_head
== NULL
)
24746 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
24747 overlap_hl
, dummy_x
, last_x
);
24748 for (s
= h
; s
; s
= s
->next
)
24749 s
->background_filled_p
= 1;
24750 compute_overhangs_and_x (t
, head
->x
, 1);
24751 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24754 /* Append glyphs strings for glyphs following the last glyph
24755 string tail that are overwritten by tail. The background of
24756 these strings has to be drawn because tail's foreground draws
24758 i
= right_overwritten (tail
);
24761 enum draw_glyphs_face overlap_hl
;
24763 if (check_mouse_face
24764 && mouse_beg_col
< i
&& mouse_end_col
> end
)
24765 overlap_hl
= DRAW_MOUSE_FACE
;
24767 overlap_hl
= DRAW_NORMAL_TEXT
;
24769 if (hl
!= overlap_hl
)
24771 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
24772 overlap_hl
, x
, last_x
);
24773 /* Because BUILD_GLYPH_STRINGS updates the first argument,
24774 we don't have `end = i;' here. */
24775 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
24776 append_glyph_string_lists (&head
, &tail
, h
, t
);
24777 if (clip_tail
== NULL
)
24781 /* Append glyph strings for glyphs following the last glyph
24782 string tail that overwrite tail. The foreground of such
24783 glyphs has to be drawn because it writes into the background
24784 of tail. The background must not be drawn because it could
24785 paint over the foreground of following glyphs. */
24786 i
= right_overwriting (tail
);
24789 enum draw_glyphs_face overlap_hl
;
24790 if (check_mouse_face
24791 && mouse_beg_col
< i
&& mouse_end_col
> end
)
24792 overlap_hl
= DRAW_MOUSE_FACE
;
24794 overlap_hl
= DRAW_NORMAL_TEXT
;
24796 if (hl
== overlap_hl
|| clip_tail
== NULL
)
24798 i
++; /* We must include the Ith glyph. */
24799 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
24800 overlap_hl
, x
, last_x
);
24801 for (s
= h
; s
; s
= s
->next
)
24802 s
->background_filled_p
= 1;
24803 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
24804 append_glyph_string_lists (&head
, &tail
, h
, t
);
24806 if (clip_head
|| clip_tail
)
24807 for (s
= head
; s
; s
= s
->next
)
24809 s
->clip_head
= clip_head
;
24810 s
->clip_tail
= clip_tail
;
24814 /* Draw all strings. */
24815 for (s
= head
; s
; s
= s
->next
)
24816 FRAME_RIF (f
)->draw_glyph_string (s
);
24819 /* When focus a sole frame and move horizontally, this sets on_p to 0
24820 causing a failure to erase prev cursor position. */
24821 if (area
== TEXT_AREA
24822 && !row
->full_width_p
24823 /* When drawing overlapping rows, only the glyph strings'
24824 foreground is drawn, which doesn't erase a cursor
24828 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
24829 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
24830 : (tail
? tail
->x
+ tail
->background_width
: x
));
24834 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
24835 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
24839 /* Value is the x-position up to which drawn, relative to AREA of W.
24840 This doesn't include parts drawn because of overhangs. */
24841 if (row
->full_width_p
)
24842 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
24844 x_reached
-= area_left
;
24846 RELEASE_HDC (hdc
, f
);
24851 /* Expand row matrix if too narrow. Don't expand if area
24854 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
24856 if (!it->f->fonts_changed \
24857 && (it->glyph_row->glyphs[area] \
24858 < it->glyph_row->glyphs[area + 1])) \
24860 it->w->ncols_scale_factor++; \
24861 it->f->fonts_changed = 1; \
24865 /* Store one glyph for IT->char_to_display in IT->glyph_row.
24866 Called from x_produce_glyphs when IT->glyph_row is non-null. */
24869 append_glyph (struct it
*it
)
24871 struct glyph
*glyph
;
24872 enum glyph_row_area area
= it
->area
;
24874 eassert (it
->glyph_row
);
24875 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
24877 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24878 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24880 /* If the glyph row is reversed, we need to prepend the glyph
24881 rather than append it. */
24882 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24886 /* Make room for the additional glyph. */
24887 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24889 glyph
= it
->glyph_row
->glyphs
[area
];
24891 glyph
->charpos
= CHARPOS (it
->position
);
24892 glyph
->object
= it
->object
;
24893 if (it
->pixel_width
> 0)
24895 glyph
->pixel_width
= it
->pixel_width
;
24896 glyph
->padding_p
= 0;
24900 /* Assure at least 1-pixel width. Otherwise, cursor can't
24901 be displayed correctly. */
24902 glyph
->pixel_width
= 1;
24903 glyph
->padding_p
= 1;
24905 glyph
->ascent
= it
->ascent
;
24906 glyph
->descent
= it
->descent
;
24907 glyph
->voffset
= it
->voffset
;
24908 glyph
->type
= CHAR_GLYPH
;
24909 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24910 glyph
->multibyte_p
= it
->multibyte_p
;
24911 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24913 /* In R2L rows, the left and the right box edges need to be
24914 drawn in reverse direction. */
24915 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24916 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24920 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24921 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24923 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24924 || it
->phys_descent
> it
->descent
);
24925 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
24926 glyph
->face_id
= it
->face_id
;
24927 glyph
->u
.ch
= it
->char_to_display
;
24928 glyph
->slice
.img
= null_glyph_slice
;
24929 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24932 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24933 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24935 glyph
->bidi_type
= it
->bidi_it
.type
;
24939 glyph
->resolved_level
= 0;
24940 glyph
->bidi_type
= UNKNOWN_BT
;
24942 ++it
->glyph_row
->used
[area
];
24945 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24948 /* Store one glyph for the composition IT->cmp_it.id in
24949 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
24953 append_composite_glyph (struct it
*it
)
24955 struct glyph
*glyph
;
24956 enum glyph_row_area area
= it
->area
;
24958 eassert (it
->glyph_row
);
24960 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24961 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24963 /* If the glyph row is reversed, we need to prepend the glyph
24964 rather than append it. */
24965 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
24969 /* Make room for the new glyph. */
24970 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
24972 glyph
= it
->glyph_row
->glyphs
[it
->area
];
24974 glyph
->charpos
= it
->cmp_it
.charpos
;
24975 glyph
->object
= it
->object
;
24976 glyph
->pixel_width
= it
->pixel_width
;
24977 glyph
->ascent
= it
->ascent
;
24978 glyph
->descent
= it
->descent
;
24979 glyph
->voffset
= it
->voffset
;
24980 glyph
->type
= COMPOSITE_GLYPH
;
24981 if (it
->cmp_it
.ch
< 0)
24983 glyph
->u
.cmp
.automatic
= 0;
24984 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
24985 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
24989 glyph
->u
.cmp
.automatic
= 1;
24990 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
24991 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
24992 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
24994 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24995 glyph
->multibyte_p
= it
->multibyte_p
;
24996 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24998 /* In R2L rows, the left and the right box edges need to be
24999 drawn in reverse direction. */
25000 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25001 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25005 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25006 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25008 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25009 || it
->phys_descent
> it
->descent
);
25010 glyph
->padding_p
= 0;
25011 glyph
->glyph_not_available_p
= 0;
25012 glyph
->face_id
= it
->face_id
;
25013 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25016 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25017 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25019 glyph
->bidi_type
= it
->bidi_it
.type
;
25021 ++it
->glyph_row
->used
[area
];
25024 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25028 /* Change IT->ascent and IT->height according to the setting of
25032 take_vertical_position_into_account (struct it
*it
)
25036 if (it
->voffset
< 0)
25037 /* Increase the ascent so that we can display the text higher
25039 it
->ascent
-= it
->voffset
;
25041 /* Increase the descent so that we can display the text lower
25043 it
->descent
+= it
->voffset
;
25048 /* Produce glyphs/get display metrics for the image IT is loaded with.
25049 See the description of struct display_iterator in dispextern.h for
25050 an overview of struct display_iterator. */
25053 produce_image_glyph (struct it
*it
)
25057 int glyph_ascent
, crop
;
25058 struct glyph_slice slice
;
25060 eassert (it
->what
== IT_IMAGE
);
25062 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25064 /* Make sure X resources of the face is loaded. */
25065 prepare_face_for_display (it
->f
, face
);
25067 if (it
->image_id
< 0)
25069 /* Fringe bitmap. */
25070 it
->ascent
= it
->phys_ascent
= 0;
25071 it
->descent
= it
->phys_descent
= 0;
25072 it
->pixel_width
= 0;
25077 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25079 /* Make sure X resources of the image is loaded. */
25080 prepare_image_for_display (it
->f
, img
);
25082 slice
.x
= slice
.y
= 0;
25083 slice
.width
= img
->width
;
25084 slice
.height
= img
->height
;
25086 if (INTEGERP (it
->slice
.x
))
25087 slice
.x
= XINT (it
->slice
.x
);
25088 else if (FLOATP (it
->slice
.x
))
25089 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25091 if (INTEGERP (it
->slice
.y
))
25092 slice
.y
= XINT (it
->slice
.y
);
25093 else if (FLOATP (it
->slice
.y
))
25094 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25096 if (INTEGERP (it
->slice
.width
))
25097 slice
.width
= XINT (it
->slice
.width
);
25098 else if (FLOATP (it
->slice
.width
))
25099 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25101 if (INTEGERP (it
->slice
.height
))
25102 slice
.height
= XINT (it
->slice
.height
);
25103 else if (FLOATP (it
->slice
.height
))
25104 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25106 if (slice
.x
>= img
->width
)
25107 slice
.x
= img
->width
;
25108 if (slice
.y
>= img
->height
)
25109 slice
.y
= img
->height
;
25110 if (slice
.x
+ slice
.width
>= img
->width
)
25111 slice
.width
= img
->width
- slice
.x
;
25112 if (slice
.y
+ slice
.height
> img
->height
)
25113 slice
.height
= img
->height
- slice
.y
;
25115 if (slice
.width
== 0 || slice
.height
== 0)
25118 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25120 it
->descent
= slice
.height
- glyph_ascent
;
25122 it
->descent
+= img
->vmargin
;
25123 if (slice
.y
+ slice
.height
== img
->height
)
25124 it
->descent
+= img
->vmargin
;
25125 it
->phys_descent
= it
->descent
;
25127 it
->pixel_width
= slice
.width
;
25129 it
->pixel_width
+= img
->hmargin
;
25130 if (slice
.x
+ slice
.width
== img
->width
)
25131 it
->pixel_width
+= img
->hmargin
;
25133 /* It's quite possible for images to have an ascent greater than
25134 their height, so don't get confused in that case. */
25135 if (it
->descent
< 0)
25140 if (face
->box
!= FACE_NO_BOX
)
25142 if (face
->box_line_width
> 0)
25145 it
->ascent
+= face
->box_line_width
;
25146 if (slice
.y
+ slice
.height
== img
->height
)
25147 it
->descent
+= face
->box_line_width
;
25150 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25151 it
->pixel_width
+= eabs (face
->box_line_width
);
25152 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25153 it
->pixel_width
+= eabs (face
->box_line_width
);
25156 take_vertical_position_into_account (it
);
25158 /* Automatically crop wide image glyphs at right edge so we can
25159 draw the cursor on same display row. */
25160 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25161 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25163 it
->pixel_width
-= crop
;
25164 slice
.width
-= crop
;
25169 struct glyph
*glyph
;
25170 enum glyph_row_area area
= it
->area
;
25172 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25173 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25175 glyph
->charpos
= CHARPOS (it
->position
);
25176 glyph
->object
= it
->object
;
25177 glyph
->pixel_width
= it
->pixel_width
;
25178 glyph
->ascent
= glyph_ascent
;
25179 glyph
->descent
= it
->descent
;
25180 glyph
->voffset
= it
->voffset
;
25181 glyph
->type
= IMAGE_GLYPH
;
25182 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25183 glyph
->multibyte_p
= it
->multibyte_p
;
25184 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25186 /* In R2L rows, the left and the right box edges need to be
25187 drawn in reverse direction. */
25188 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25189 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25193 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25194 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25196 glyph
->overlaps_vertically_p
= 0;
25197 glyph
->padding_p
= 0;
25198 glyph
->glyph_not_available_p
= 0;
25199 glyph
->face_id
= it
->face_id
;
25200 glyph
->u
.img_id
= img
->id
;
25201 glyph
->slice
.img
= slice
;
25202 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25205 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25206 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25208 glyph
->bidi_type
= it
->bidi_it
.type
;
25210 ++it
->glyph_row
->used
[area
];
25213 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25218 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25219 of the glyph, WIDTH and HEIGHT are the width and height of the
25220 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25223 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25224 int width
, int height
, int ascent
)
25226 struct glyph
*glyph
;
25227 enum glyph_row_area area
= it
->area
;
25229 eassert (ascent
>= 0 && ascent
<= height
);
25231 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25232 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25234 /* If the glyph row is reversed, we need to prepend the glyph
25235 rather than append it. */
25236 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25240 /* Make room for the additional glyph. */
25241 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25243 glyph
= it
->glyph_row
->glyphs
[area
];
25245 glyph
->charpos
= CHARPOS (it
->position
);
25246 glyph
->object
= object
;
25247 glyph
->pixel_width
= width
;
25248 glyph
->ascent
= ascent
;
25249 glyph
->descent
= height
- ascent
;
25250 glyph
->voffset
= it
->voffset
;
25251 glyph
->type
= STRETCH_GLYPH
;
25252 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25253 glyph
->multibyte_p
= it
->multibyte_p
;
25254 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25256 /* In R2L rows, the left and the right box edges need to be
25257 drawn in reverse direction. */
25258 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25259 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25263 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25264 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25266 glyph
->overlaps_vertically_p
= 0;
25267 glyph
->padding_p
= 0;
25268 glyph
->glyph_not_available_p
= 0;
25269 glyph
->face_id
= it
->face_id
;
25270 glyph
->u
.stretch
.ascent
= ascent
;
25271 glyph
->u
.stretch
.height
= height
;
25272 glyph
->slice
.img
= null_glyph_slice
;
25273 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25276 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25277 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25279 glyph
->bidi_type
= it
->bidi_it
.type
;
25283 glyph
->resolved_level
= 0;
25284 glyph
->bidi_type
= UNKNOWN_BT
;
25286 ++it
->glyph_row
->used
[area
];
25289 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25292 #endif /* HAVE_WINDOW_SYSTEM */
25294 /* Produce a stretch glyph for iterator IT. IT->object is the value
25295 of the glyph property displayed. The value must be a list
25296 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25299 1. `:width WIDTH' specifies that the space should be WIDTH *
25300 canonical char width wide. WIDTH may be an integer or floating
25303 2. `:relative-width FACTOR' specifies that the width of the stretch
25304 should be computed from the width of the first character having the
25305 `glyph' property, and should be FACTOR times that width.
25307 3. `:align-to HPOS' specifies that the space should be wide enough
25308 to reach HPOS, a value in canonical character units.
25310 Exactly one of the above pairs must be present.
25312 4. `:height HEIGHT' specifies that the height of the stretch produced
25313 should be HEIGHT, measured in canonical character units.
25315 5. `:relative-height FACTOR' specifies that the height of the
25316 stretch should be FACTOR times the height of the characters having
25317 the glyph property.
25319 Either none or exactly one of 4 or 5 must be present.
25321 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25322 of the stretch should be used for the ascent of the stretch.
25323 ASCENT must be in the range 0 <= ASCENT <= 100. */
25326 produce_stretch_glyph (struct it
*it
)
25328 /* (space :width WIDTH :height HEIGHT ...) */
25329 Lisp_Object prop
, plist
;
25330 int width
= 0, height
= 0, align_to
= -1;
25331 int zero_width_ok_p
= 0;
25333 struct font
*font
= NULL
;
25335 #ifdef HAVE_WINDOW_SYSTEM
25337 int zero_height_ok_p
= 0;
25339 if (FRAME_WINDOW_P (it
->f
))
25341 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25342 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25343 prepare_face_for_display (it
->f
, face
);
25347 /* List should start with `space'. */
25348 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
25349 plist
= XCDR (it
->object
);
25351 /* Compute the width of the stretch. */
25352 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
25353 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
25355 /* Absolute width `:width WIDTH' specified and valid. */
25356 zero_width_ok_p
= 1;
25359 #ifdef HAVE_WINDOW_SYSTEM
25360 else if (FRAME_WINDOW_P (it
->f
)
25361 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
25363 /* Relative width `:relative-width FACTOR' specified and valid.
25364 Compute the width of the characters having the `glyph'
25367 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
25370 if (it
->multibyte_p
)
25371 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
25374 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
25375 if (! ASCII_CHAR_P (it2
.c
))
25376 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
25379 it2
.glyph_row
= NULL
;
25380 it2
.what
= IT_CHARACTER
;
25381 x_produce_glyphs (&it2
);
25382 width
= NUMVAL (prop
) * it2
.pixel_width
;
25384 #endif /* HAVE_WINDOW_SYSTEM */
25385 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
25386 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
25388 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
25389 align_to
= (align_to
< 0
25391 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
25392 else if (align_to
< 0)
25393 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
25394 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
25395 zero_width_ok_p
= 1;
25398 /* Nothing specified -> width defaults to canonical char width. */
25399 width
= FRAME_COLUMN_WIDTH (it
->f
);
25401 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
25404 #ifdef HAVE_WINDOW_SYSTEM
25405 /* Compute height. */
25406 if (FRAME_WINDOW_P (it
->f
))
25408 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
25409 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25412 zero_height_ok_p
= 1;
25414 else if (prop
= Fplist_get (plist
, QCrelative_height
),
25416 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
25418 height
= FONT_HEIGHT (font
);
25420 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
25423 /* Compute percentage of height used for ascent. If
25424 `:ascent ASCENT' is present and valid, use that. Otherwise,
25425 derive the ascent from the font in use. */
25426 if (prop
= Fplist_get (plist
, QCascent
),
25427 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
25428 ascent
= height
* NUMVAL (prop
) / 100.0;
25429 else if (!NILP (prop
)
25430 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25431 ascent
= min (max (0, (int)tem
), height
);
25433 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
25436 #endif /* HAVE_WINDOW_SYSTEM */
25439 if (width
> 0 && it
->line_wrap
!= TRUNCATE
25440 && it
->current_x
+ width
> it
->last_visible_x
)
25442 width
= it
->last_visible_x
- it
->current_x
;
25443 #ifdef HAVE_WINDOW_SYSTEM
25444 /* Subtract one more pixel from the stretch width, but only on
25445 GUI frames, since on a TTY each glyph is one "pixel" wide. */
25446 width
-= FRAME_WINDOW_P (it
->f
);
25450 if (width
> 0 && height
> 0 && it
->glyph_row
)
25452 Lisp_Object o_object
= it
->object
;
25453 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
25456 if (!STRINGP (object
))
25457 object
= it
->w
->contents
;
25458 #ifdef HAVE_WINDOW_SYSTEM
25459 if (FRAME_WINDOW_P (it
->f
))
25460 append_stretch_glyph (it
, object
, width
, height
, ascent
);
25464 it
->object
= object
;
25465 it
->char_to_display
= ' ';
25466 it
->pixel_width
= it
->len
= 1;
25468 tty_append_glyph (it
);
25469 it
->object
= o_object
;
25473 it
->pixel_width
= width
;
25474 #ifdef HAVE_WINDOW_SYSTEM
25475 if (FRAME_WINDOW_P (it
->f
))
25477 it
->ascent
= it
->phys_ascent
= ascent
;
25478 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
25479 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
25480 take_vertical_position_into_account (it
);
25484 it
->nglyphs
= width
;
25487 /* Get information about special display element WHAT in an
25488 environment described by IT. WHAT is one of IT_TRUNCATION or
25489 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
25490 non-null glyph_row member. This function ensures that fields like
25491 face_id, c, len of IT are left untouched. */
25494 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
25501 temp_it
.object
= make_number (0);
25502 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
25504 if (what
== IT_CONTINUATION
)
25506 /* Continuation glyph. For R2L lines, we mirror it by hand. */
25507 if (it
->bidi_it
.paragraph_dir
== R2L
)
25508 SET_GLYPH_FROM_CHAR (glyph
, '/');
25510 SET_GLYPH_FROM_CHAR (glyph
, '\\');
25512 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25514 /* FIXME: Should we mirror GC for R2L lines? */
25515 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25516 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25519 else if (what
== IT_TRUNCATION
)
25521 /* Truncation glyph. */
25522 SET_GLYPH_FROM_CHAR (glyph
, '$');
25524 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25526 /* FIXME: Should we mirror GC for R2L lines? */
25527 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25528 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25534 #ifdef HAVE_WINDOW_SYSTEM
25535 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
25536 is turned off, we precede the truncation/continuation glyphs by a
25537 stretch glyph whose width is computed such that these special
25538 glyphs are aligned at the window margin, even when very different
25539 fonts are used in different glyph rows. */
25540 if (FRAME_WINDOW_P (temp_it
.f
)
25541 /* init_iterator calls this with it->glyph_row == NULL, and it
25542 wants only the pixel width of the truncation/continuation
25544 && temp_it
.glyph_row
25545 /* insert_left_trunc_glyphs calls us at the beginning of the
25546 row, and it has its own calculation of the stretch glyph
25548 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
25549 && (temp_it
.glyph_row
->reversed_p
25550 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
25551 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
25553 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
25555 if (stretch_width
> 0)
25557 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
25558 struct font
*font
=
25559 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
25560 int stretch_ascent
=
25561 (((temp_it
.ascent
+ temp_it
.descent
)
25562 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
25564 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
25565 temp_it
.ascent
+ temp_it
.descent
,
25572 temp_it
.what
= IT_CHARACTER
;
25574 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
25575 temp_it
.face_id
= GLYPH_FACE (glyph
);
25576 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
25578 PRODUCE_GLYPHS (&temp_it
);
25579 it
->pixel_width
= temp_it
.pixel_width
;
25580 it
->nglyphs
= temp_it
.pixel_width
;
25583 #ifdef HAVE_WINDOW_SYSTEM
25585 /* Calculate line-height and line-spacing properties.
25586 An integer value specifies explicit pixel value.
25587 A float value specifies relative value to current face height.
25588 A cons (float . face-name) specifies relative value to
25589 height of specified face font.
25591 Returns height in pixels, or nil. */
25595 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
25596 int boff
, int override
)
25598 Lisp_Object face_name
= Qnil
;
25599 int ascent
, descent
, height
;
25601 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
25606 face_name
= XCAR (val
);
25608 if (!NUMBERP (val
))
25609 val
= make_number (1);
25610 if (NILP (face_name
))
25612 height
= it
->ascent
+ it
->descent
;
25617 if (NILP (face_name
))
25619 font
= FRAME_FONT (it
->f
);
25620 boff
= FRAME_BASELINE_OFFSET (it
->f
);
25622 else if (EQ (face_name
, Qt
))
25631 face_id
= lookup_named_face (it
->f
, face_name
, 0);
25633 return make_number (-1);
25635 face
= FACE_FROM_ID (it
->f
, face_id
);
25638 return make_number (-1);
25639 boff
= font
->baseline_offset
;
25640 if (font
->vertical_centering
)
25641 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25644 ascent
= FONT_BASE (font
) + boff
;
25645 descent
= FONT_DESCENT (font
) - boff
;
25649 it
->override_ascent
= ascent
;
25650 it
->override_descent
= descent
;
25651 it
->override_boff
= boff
;
25654 height
= ascent
+ descent
;
25658 height
= (int)(XFLOAT_DATA (val
) * height
);
25659 else if (INTEGERP (val
))
25660 height
*= XINT (val
);
25662 return make_number (height
);
25666 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
25667 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
25668 and only if this is for a character for which no font was found.
25670 If the display method (it->glyphless_method) is
25671 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
25672 length of the acronym or the hexadecimal string, UPPER_XOFF and
25673 UPPER_YOFF are pixel offsets for the upper part of the string,
25674 LOWER_XOFF and LOWER_YOFF are for the lower part.
25676 For the other display methods, LEN through LOWER_YOFF are zero. */
25679 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
25680 short upper_xoff
, short upper_yoff
,
25681 short lower_xoff
, short lower_yoff
)
25683 struct glyph
*glyph
;
25684 enum glyph_row_area area
= it
->area
;
25686 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25687 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25689 /* If the glyph row is reversed, we need to prepend the glyph
25690 rather than append it. */
25691 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25695 /* Make room for the additional glyph. */
25696 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25698 glyph
= it
->glyph_row
->glyphs
[area
];
25700 glyph
->charpos
= CHARPOS (it
->position
);
25701 glyph
->object
= it
->object
;
25702 glyph
->pixel_width
= it
->pixel_width
;
25703 glyph
->ascent
= it
->ascent
;
25704 glyph
->descent
= it
->descent
;
25705 glyph
->voffset
= it
->voffset
;
25706 glyph
->type
= GLYPHLESS_GLYPH
;
25707 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
25708 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
25709 glyph
->u
.glyphless
.len
= len
;
25710 glyph
->u
.glyphless
.ch
= it
->c
;
25711 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
25712 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
25713 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
25714 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
25715 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25716 glyph
->multibyte_p
= it
->multibyte_p
;
25717 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25719 /* In R2L rows, the left and the right box edges need to be
25720 drawn in reverse direction. */
25721 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25722 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25726 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25727 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25729 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25730 || it
->phys_descent
> it
->descent
);
25731 glyph
->padding_p
= 0;
25732 glyph
->glyph_not_available_p
= 0;
25733 glyph
->face_id
= face_id
;
25734 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25737 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25738 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25740 glyph
->bidi_type
= it
->bidi_it
.type
;
25742 ++it
->glyph_row
->used
[area
];
25745 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25749 /* Produce a glyph for a glyphless character for iterator IT.
25750 IT->glyphless_method specifies which method to use for displaying
25751 the character. See the description of enum
25752 glyphless_display_method in dispextern.h for the detail.
25754 FOR_NO_FONT is nonzero if and only if this is for a character for
25755 which no font was found. ACRONYM, if non-nil, is an acronym string
25756 for the character. */
25759 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
25764 int base_width
, base_height
, width
, height
;
25765 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
25768 /* Get the metrics of the base font. We always refer to the current
25770 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
25771 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25772 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
25773 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
25774 base_height
= it
->ascent
+ it
->descent
;
25775 base_width
= font
->average_width
;
25777 face_id
= merge_glyphless_glyph_face (it
);
25779 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
25781 it
->pixel_width
= THIN_SPACE_WIDTH
;
25783 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
25785 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
25787 width
= CHAR_WIDTH (it
->c
);
25790 else if (width
> 4)
25792 it
->pixel_width
= base_width
* width
;
25794 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
25800 unsigned int code
[6];
25802 int ascent
, descent
;
25803 struct font_metrics metrics_upper
, metrics_lower
;
25805 face
= FACE_FROM_ID (it
->f
, face_id
);
25806 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25807 prepare_face_for_display (it
->f
, face
);
25809 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
25811 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
25812 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
25813 if (CONSP (acronym
))
25814 acronym
= XCAR (acronym
);
25815 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
25819 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
25820 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
25823 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
25824 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
25825 upper_len
= (len
+ 1) / 2;
25826 font
->driver
->text_extents (font
, code
, upper_len
,
25828 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
25833 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
25834 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
25835 upper_xoff
= upper_yoff
= 2; /* the typical case */
25836 if (base_width
>= width
)
25838 /* Align the upper to the left, the lower to the right. */
25839 it
->pixel_width
= base_width
;
25840 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
25844 /* Center the shorter one. */
25845 it
->pixel_width
= width
;
25846 if (metrics_upper
.width
>= metrics_lower
.width
)
25847 lower_xoff
= (width
- metrics_lower
.width
) / 2;
25850 /* FIXME: This code doesn't look right. It formerly was
25851 missing the "lower_xoff = 0;", which couldn't have
25852 been right since it left lower_xoff uninitialized. */
25854 upper_xoff
= (width
- metrics_upper
.width
) / 2;
25858 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
25859 top, bottom, and between upper and lower strings. */
25860 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
25861 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
25862 /* Center vertically.
25863 H:base_height, D:base_descent
25864 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
25866 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
25867 descent = D - H/2 + h/2;
25868 lower_yoff = descent - 2 - ld;
25869 upper_yoff = lower_yoff - la - 1 - ud; */
25870 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
25871 descent
= it
->descent
- (base_height
- height
) / 2;
25872 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
25873 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
25874 - metrics_upper
.descent
);
25875 /* Don't make the height shorter than the base height. */
25876 if (height
> base_height
)
25878 it
->ascent
= ascent
;
25879 it
->descent
= descent
;
25883 it
->phys_ascent
= it
->ascent
;
25884 it
->phys_descent
= it
->descent
;
25886 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
25887 upper_xoff
, upper_yoff
,
25888 lower_xoff
, lower_yoff
);
25890 take_vertical_position_into_account (it
);
25895 Produce glyphs/get display metrics for the display element IT is
25896 loaded with. See the description of struct it in dispextern.h
25897 for an overview of struct it. */
25900 x_produce_glyphs (struct it
*it
)
25902 int extra_line_spacing
= it
->extra_line_spacing
;
25904 it
->glyph_not_available_p
= 0;
25906 if (it
->what
== IT_CHARACTER
)
25909 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25910 struct font
*font
= face
->font
;
25911 struct font_metrics
*pcm
= NULL
;
25912 int boff
; /* Baseline offset. */
25916 /* When no suitable font is found, display this character by
25917 the method specified in the first extra slot of
25918 Vglyphless_char_display. */
25919 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
25921 eassert (it
->what
== IT_GLYPHLESS
);
25922 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
25926 boff
= font
->baseline_offset
;
25927 if (font
->vertical_centering
)
25928 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25930 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
25936 if (it
->override_ascent
>= 0)
25938 it
->ascent
= it
->override_ascent
;
25939 it
->descent
= it
->override_descent
;
25940 boff
= it
->override_boff
;
25944 it
->ascent
= FONT_BASE (font
) + boff
;
25945 it
->descent
= FONT_DESCENT (font
) - boff
;
25948 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
25950 pcm
= get_per_char_metric (font
, &char2b
);
25951 if (pcm
->width
== 0
25952 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
25958 it
->phys_ascent
= pcm
->ascent
+ boff
;
25959 it
->phys_descent
= pcm
->descent
- boff
;
25960 it
->pixel_width
= pcm
->width
;
25964 it
->glyph_not_available_p
= 1;
25965 it
->phys_ascent
= it
->ascent
;
25966 it
->phys_descent
= it
->descent
;
25967 it
->pixel_width
= font
->space_width
;
25970 if (it
->constrain_row_ascent_descent_p
)
25972 if (it
->descent
> it
->max_descent
)
25974 it
->ascent
+= it
->descent
- it
->max_descent
;
25975 it
->descent
= it
->max_descent
;
25977 if (it
->ascent
> it
->max_ascent
)
25979 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
25980 it
->ascent
= it
->max_ascent
;
25982 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
25983 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
25984 extra_line_spacing
= 0;
25987 /* If this is a space inside a region of text with
25988 `space-width' property, change its width. */
25989 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
25991 it
->pixel_width
*= XFLOATINT (it
->space_width
);
25993 /* If face has a box, add the box thickness to the character
25994 height. If character has a box line to the left and/or
25995 right, add the box line width to the character's width. */
25996 if (face
->box
!= FACE_NO_BOX
)
25998 int thick
= face
->box_line_width
;
26002 it
->ascent
+= thick
;
26003 it
->descent
+= thick
;
26008 if (it
->start_of_box_run_p
)
26009 it
->pixel_width
+= thick
;
26010 if (it
->end_of_box_run_p
)
26011 it
->pixel_width
+= thick
;
26014 /* If face has an overline, add the height of the overline
26015 (1 pixel) and a 1 pixel margin to the character height. */
26016 if (face
->overline_p
)
26017 it
->ascent
+= overline_margin
;
26019 if (it
->constrain_row_ascent_descent_p
)
26021 if (it
->ascent
> it
->max_ascent
)
26022 it
->ascent
= it
->max_ascent
;
26023 if (it
->descent
> it
->max_descent
)
26024 it
->descent
= it
->max_descent
;
26027 take_vertical_position_into_account (it
);
26029 /* If we have to actually produce glyphs, do it. */
26034 /* Translate a space with a `space-width' property
26035 into a stretch glyph. */
26036 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26037 / FONT_HEIGHT (font
));
26038 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26039 it
->ascent
+ it
->descent
, ascent
);
26044 /* If characters with lbearing or rbearing are displayed
26045 in this line, record that fact in a flag of the
26046 glyph row. This is used to optimize X output code. */
26047 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26048 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26050 if (! stretched_p
&& it
->pixel_width
== 0)
26051 /* We assure that all visible glyphs have at least 1-pixel
26053 it
->pixel_width
= 1;
26055 else if (it
->char_to_display
== '\n')
26057 /* A newline has no width, but we need the height of the
26058 line. But if previous part of the line sets a height,
26059 don't increase that height. */
26061 Lisp_Object height
;
26062 Lisp_Object total_height
= Qnil
;
26064 it
->override_ascent
= -1;
26065 it
->pixel_width
= 0;
26068 height
= get_it_property (it
, Qline_height
);
26069 /* Split (line-height total-height) list. */
26071 && CONSP (XCDR (height
))
26072 && NILP (XCDR (XCDR (height
))))
26074 total_height
= XCAR (XCDR (height
));
26075 height
= XCAR (height
);
26077 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
26079 if (it
->override_ascent
>= 0)
26081 it
->ascent
= it
->override_ascent
;
26082 it
->descent
= it
->override_descent
;
26083 boff
= it
->override_boff
;
26087 it
->ascent
= FONT_BASE (font
) + boff
;
26088 it
->descent
= FONT_DESCENT (font
) - boff
;
26091 if (EQ (height
, Qt
))
26093 if (it
->descent
> it
->max_descent
)
26095 it
->ascent
+= it
->descent
- it
->max_descent
;
26096 it
->descent
= it
->max_descent
;
26098 if (it
->ascent
> it
->max_ascent
)
26100 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26101 it
->ascent
= it
->max_ascent
;
26103 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26104 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26105 it
->constrain_row_ascent_descent_p
= 1;
26106 extra_line_spacing
= 0;
26110 Lisp_Object spacing
;
26112 it
->phys_ascent
= it
->ascent
;
26113 it
->phys_descent
= it
->descent
;
26115 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26116 && face
->box
!= FACE_NO_BOX
26117 && face
->box_line_width
> 0)
26119 it
->ascent
+= face
->box_line_width
;
26120 it
->descent
+= face
->box_line_width
;
26123 && XINT (height
) > it
->ascent
+ it
->descent
)
26124 it
->ascent
= XINT (height
) - it
->descent
;
26126 if (!NILP (total_height
))
26127 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
26130 spacing
= get_it_property (it
, Qline_spacing
);
26131 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
26133 if (INTEGERP (spacing
))
26135 extra_line_spacing
= XINT (spacing
);
26136 if (!NILP (total_height
))
26137 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26141 else /* i.e. (it->char_to_display == '\t') */
26143 if (font
->space_width
> 0)
26145 int tab_width
= it
->tab_width
* font
->space_width
;
26146 int x
= it
->current_x
+ it
->continuation_lines_width
;
26147 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26149 /* If the distance from the current position to the next tab
26150 stop is less than a space character width, use the
26151 tab stop after that. */
26152 if (next_tab_x
- x
< font
->space_width
)
26153 next_tab_x
+= tab_width
;
26155 it
->pixel_width
= next_tab_x
- x
;
26157 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
26158 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
26162 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26163 it
->ascent
+ it
->descent
, it
->ascent
);
26168 it
->pixel_width
= 0;
26173 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26175 /* A static composition.
26177 Note: A composition is represented as one glyph in the
26178 glyph matrix. There are no padding glyphs.
26180 Important note: pixel_width, ascent, and descent are the
26181 values of what is drawn by draw_glyphs (i.e. the values of
26182 the overall glyphs composed). */
26183 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26184 int boff
; /* baseline offset */
26185 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26186 int glyph_len
= cmp
->glyph_len
;
26187 struct font
*font
= face
->font
;
26191 /* If we have not yet calculated pixel size data of glyphs of
26192 the composition for the current face font, calculate them
26193 now. Theoretically, we have to check all fonts for the
26194 glyphs, but that requires much time and memory space. So,
26195 here we check only the font of the first glyph. This may
26196 lead to incorrect display, but it's very rare, and C-l
26197 (recenter-top-bottom) can correct the display anyway. */
26198 if (! cmp
->font
|| cmp
->font
!= font
)
26200 /* Ascent and descent of the font of the first character
26201 of this composition (adjusted by baseline offset).
26202 Ascent and descent of overall glyphs should not be less
26203 than these, respectively. */
26204 int font_ascent
, font_descent
, font_height
;
26205 /* Bounding box of the overall glyphs. */
26206 int leftmost
, rightmost
, lowest
, highest
;
26207 int lbearing
, rbearing
;
26208 int i
, width
, ascent
, descent
;
26209 int left_padded
= 0, right_padded
= 0;
26210 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26212 struct font_metrics
*pcm
;
26213 int font_not_found_p
;
26216 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26217 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26219 if (glyph_len
< cmp
->glyph_len
)
26221 for (i
= 0; i
< glyph_len
; i
++)
26223 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26225 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26230 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26231 : IT_CHARPOS (*it
));
26232 /* If no suitable font is found, use the default font. */
26233 font_not_found_p
= font
== NULL
;
26234 if (font_not_found_p
)
26236 face
= face
->ascii_face
;
26239 boff
= font
->baseline_offset
;
26240 if (font
->vertical_centering
)
26241 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26242 font_ascent
= FONT_BASE (font
) + boff
;
26243 font_descent
= FONT_DESCENT (font
) - boff
;
26244 font_height
= FONT_HEIGHT (font
);
26249 if (! font_not_found_p
)
26251 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26253 pcm
= get_per_char_metric (font
, &char2b
);
26256 /* Initialize the bounding box. */
26259 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26260 ascent
= pcm
->ascent
;
26261 descent
= pcm
->descent
;
26262 lbearing
= pcm
->lbearing
;
26263 rbearing
= pcm
->rbearing
;
26267 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26268 ascent
= FONT_BASE (font
);
26269 descent
= FONT_DESCENT (font
);
26276 lowest
= - descent
+ boff
;
26277 highest
= ascent
+ boff
;
26279 if (! font_not_found_p
26280 && font
->default_ascent
26281 && CHAR_TABLE_P (Vuse_default_ascent
)
26282 && !NILP (Faref (Vuse_default_ascent
,
26283 make_number (it
->char_to_display
))))
26284 highest
= font
->default_ascent
+ boff
;
26286 /* Draw the first glyph at the normal position. It may be
26287 shifted to right later if some other glyphs are drawn
26289 cmp
->offsets
[i
* 2] = 0;
26290 cmp
->offsets
[i
* 2 + 1] = boff
;
26291 cmp
->lbearing
= lbearing
;
26292 cmp
->rbearing
= rbearing
;
26294 /* Set cmp->offsets for the remaining glyphs. */
26295 for (i
++; i
< glyph_len
; i
++)
26297 int left
, right
, btm
, top
;
26298 int ch
= COMPOSITION_GLYPH (cmp
, i
);
26300 struct face
*this_face
;
26304 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
26305 this_face
= FACE_FROM_ID (it
->f
, face_id
);
26306 font
= this_face
->font
;
26312 get_char_face_and_encoding (it
->f
, ch
, face_id
,
26314 pcm
= get_per_char_metric (font
, &char2b
);
26317 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26320 width
= pcm
->width
;
26321 ascent
= pcm
->ascent
;
26322 descent
= pcm
->descent
;
26323 lbearing
= pcm
->lbearing
;
26324 rbearing
= pcm
->rbearing
;
26325 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
26327 /* Relative composition with or without
26328 alternate chars. */
26329 left
= (leftmost
+ rightmost
- width
) / 2;
26330 btm
= - descent
+ boff
;
26331 if (font
->relative_compose
26332 && (! CHAR_TABLE_P (Vignore_relative_composition
)
26333 || NILP (Faref (Vignore_relative_composition
,
26334 make_number (ch
)))))
26337 if (- descent
>= font
->relative_compose
)
26338 /* One extra pixel between two glyphs. */
26340 else if (ascent
<= 0)
26341 /* One extra pixel between two glyphs. */
26342 btm
= lowest
- 1 - ascent
- descent
;
26347 /* A composition rule is specified by an integer
26348 value that encodes global and new reference
26349 points (GREF and NREF). GREF and NREF are
26350 specified by numbers as below:
26352 0---1---2 -- ascent
26356 9--10--11 -- center
26358 ---3---4---5--- baseline
26360 6---7---8 -- descent
26362 int rule
= COMPOSITION_RULE (cmp
, i
);
26363 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
26365 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
26366 grefx
= gref
% 3, nrefx
= nref
% 3;
26367 grefy
= gref
/ 3, nrefy
= nref
/ 3;
26369 xoff
= font_height
* (xoff
- 128) / 256;
26371 yoff
= font_height
* (yoff
- 128) / 256;
26374 + grefx
* (rightmost
- leftmost
) / 2
26375 - nrefx
* width
/ 2
26378 btm
= ((grefy
== 0 ? highest
26380 : grefy
== 2 ? lowest
26381 : (highest
+ lowest
) / 2)
26382 - (nrefy
== 0 ? ascent
+ descent
26383 : nrefy
== 1 ? descent
- boff
26385 : (ascent
+ descent
) / 2)
26389 cmp
->offsets
[i
* 2] = left
;
26390 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
26392 /* Update the bounding box of the overall glyphs. */
26395 right
= left
+ width
;
26396 if (left
< leftmost
)
26398 if (right
> rightmost
)
26401 top
= btm
+ descent
+ ascent
;
26407 if (cmp
->lbearing
> left
+ lbearing
)
26408 cmp
->lbearing
= left
+ lbearing
;
26409 if (cmp
->rbearing
< left
+ rbearing
)
26410 cmp
->rbearing
= left
+ rbearing
;
26414 /* If there are glyphs whose x-offsets are negative,
26415 shift all glyphs to the right and make all x-offsets
26419 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26420 cmp
->offsets
[i
* 2] -= leftmost
;
26421 rightmost
-= leftmost
;
26422 cmp
->lbearing
-= leftmost
;
26423 cmp
->rbearing
-= leftmost
;
26426 if (left_padded
&& cmp
->lbearing
< 0)
26428 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26429 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
26430 rightmost
-= cmp
->lbearing
;
26431 cmp
->rbearing
-= cmp
->lbearing
;
26434 if (right_padded
&& rightmost
< cmp
->rbearing
)
26436 rightmost
= cmp
->rbearing
;
26439 cmp
->pixel_width
= rightmost
;
26440 cmp
->ascent
= highest
;
26441 cmp
->descent
= - lowest
;
26442 if (cmp
->ascent
< font_ascent
)
26443 cmp
->ascent
= font_ascent
;
26444 if (cmp
->descent
< font_descent
)
26445 cmp
->descent
= font_descent
;
26449 && (cmp
->lbearing
< 0
26450 || cmp
->rbearing
> cmp
->pixel_width
))
26451 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26453 it
->pixel_width
= cmp
->pixel_width
;
26454 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
26455 it
->descent
= it
->phys_descent
= cmp
->descent
;
26456 if (face
->box
!= FACE_NO_BOX
)
26458 int thick
= face
->box_line_width
;
26462 it
->ascent
+= thick
;
26463 it
->descent
+= thick
;
26468 if (it
->start_of_box_run_p
)
26469 it
->pixel_width
+= thick
;
26470 if (it
->end_of_box_run_p
)
26471 it
->pixel_width
+= thick
;
26474 /* If face has an overline, add the height of the overline
26475 (1 pixel) and a 1 pixel margin to the character height. */
26476 if (face
->overline_p
)
26477 it
->ascent
+= overline_margin
;
26479 take_vertical_position_into_account (it
);
26480 if (it
->ascent
< 0)
26482 if (it
->descent
< 0)
26485 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
26486 append_composite_glyph (it
);
26488 else if (it
->what
== IT_COMPOSITION
)
26490 /* A dynamic (automatic) composition. */
26491 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26492 Lisp_Object gstring
;
26493 struct font_metrics metrics
;
26497 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
26499 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
26502 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
26503 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26504 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
26505 it
->descent
= it
->phys_descent
= metrics
.descent
;
26506 if (face
->box
!= FACE_NO_BOX
)
26508 int thick
= face
->box_line_width
;
26512 it
->ascent
+= thick
;
26513 it
->descent
+= thick
;
26518 if (it
->start_of_box_run_p
)
26519 it
->pixel_width
+= thick
;
26520 if (it
->end_of_box_run_p
)
26521 it
->pixel_width
+= thick
;
26523 /* If face has an overline, add the height of the overline
26524 (1 pixel) and a 1 pixel margin to the character height. */
26525 if (face
->overline_p
)
26526 it
->ascent
+= overline_margin
;
26527 take_vertical_position_into_account (it
);
26528 if (it
->ascent
< 0)
26530 if (it
->descent
< 0)
26534 append_composite_glyph (it
);
26536 else if (it
->what
== IT_GLYPHLESS
)
26537 produce_glyphless_glyph (it
, 0, Qnil
);
26538 else if (it
->what
== IT_IMAGE
)
26539 produce_image_glyph (it
);
26540 else if (it
->what
== IT_STRETCH
)
26541 produce_stretch_glyph (it
);
26544 /* Accumulate dimensions. Note: can't assume that it->descent > 0
26545 because this isn't true for images with `:ascent 100'. */
26546 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
26547 if (it
->area
== TEXT_AREA
)
26548 it
->current_x
+= it
->pixel_width
;
26550 if (extra_line_spacing
> 0)
26552 it
->descent
+= extra_line_spacing
;
26553 if (extra_line_spacing
> it
->max_extra_line_spacing
)
26554 it
->max_extra_line_spacing
= extra_line_spacing
;
26557 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
26558 it
->max_descent
= max (it
->max_descent
, it
->descent
);
26559 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
26560 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
26564 Output LEN glyphs starting at START at the nominal cursor position.
26565 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
26566 being updated, and UPDATED_AREA is the area of that row being updated. */
26569 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26570 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26572 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
26574 eassert (updated_row
);
26575 /* When the window is hscrolled, cursor hpos can legitimately be out
26576 of bounds, but we draw the cursor at the corresponding window
26577 margin in that case. */
26578 if (!updated_row
->reversed_p
&& chpos
< 0)
26580 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
26581 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
26585 /* Write glyphs. */
26587 hpos
= start
- updated_row
->glyphs
[updated_area
];
26588 x
= draw_glyphs (w
, w
->output_cursor
.x
,
26589 updated_row
, updated_area
,
26591 DRAW_NORMAL_TEXT
, 0);
26593 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
26594 if (updated_area
== TEXT_AREA
26595 && w
->phys_cursor_on_p
26596 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
26598 && chpos
< hpos
+ len
)
26599 w
->phys_cursor_on_p
= 0;
26603 /* Advance the output cursor. */
26604 w
->output_cursor
.hpos
+= len
;
26605 w
->output_cursor
.x
= x
;
26610 Insert LEN glyphs from START at the nominal cursor position. */
26613 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26614 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26617 int line_height
, shift_by_width
, shifted_region_width
;
26618 struct glyph_row
*row
;
26619 struct glyph
*glyph
;
26620 int frame_x
, frame_y
;
26623 eassert (updated_row
);
26625 f
= XFRAME (WINDOW_FRAME (w
));
26627 /* Get the height of the line we are in. */
26629 line_height
= row
->height
;
26631 /* Get the width of the glyphs to insert. */
26632 shift_by_width
= 0;
26633 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
26634 shift_by_width
+= glyph
->pixel_width
;
26636 /* Get the width of the region to shift right. */
26637 shifted_region_width
= (window_box_width (w
, updated_area
)
26638 - w
->output_cursor
.x
26642 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
26643 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
26645 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
26646 line_height
, shift_by_width
);
26648 /* Write the glyphs. */
26649 hpos
= start
- row
->glyphs
[updated_area
];
26650 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
26652 DRAW_NORMAL_TEXT
, 0);
26654 /* Advance the output cursor. */
26655 w
->output_cursor
.hpos
+= len
;
26656 w
->output_cursor
.x
+= shift_by_width
;
26662 Erase the current text line from the nominal cursor position
26663 (inclusive) to pixel column TO_X (exclusive). The idea is that
26664 everything from TO_X onward is already erased.
26666 TO_X is a pixel position relative to UPDATED_AREA of currently
26667 updated window W. TO_X == -1 means clear to the end of this area. */
26670 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
26671 enum glyph_row_area updated_area
, int to_x
)
26674 int max_x
, min_y
, max_y
;
26675 int from_x
, from_y
, to_y
;
26677 eassert (updated_row
);
26678 f
= XFRAME (w
->frame
);
26680 if (updated_row
->full_width_p
)
26681 max_x
= (WINDOW_PIXEL_WIDTH (w
)
26682 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
26684 max_x
= window_box_width (w
, updated_area
);
26685 max_y
= window_text_bottom_y (w
);
26687 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
26688 of window. For TO_X > 0, truncate to end of drawing area. */
26694 to_x
= min (to_x
, max_x
);
26696 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
26698 /* Notice if the cursor will be cleared by this operation. */
26699 if (!updated_row
->full_width_p
)
26700 notice_overwritten_cursor (w
, updated_area
,
26701 w
->output_cursor
.x
, -1,
26703 MATRIX_ROW_BOTTOM_Y (updated_row
));
26705 from_x
= w
->output_cursor
.x
;
26707 /* Translate to frame coordinates. */
26708 if (updated_row
->full_width_p
)
26710 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
26711 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
26715 int area_left
= window_box_left (w
, updated_area
);
26716 from_x
+= area_left
;
26720 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
26721 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
26722 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
26724 /* Prevent inadvertently clearing to end of the X window. */
26725 if (to_x
> from_x
&& to_y
> from_y
)
26728 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
26729 to_x
- from_x
, to_y
- from_y
);
26734 #endif /* HAVE_WINDOW_SYSTEM */
26738 /***********************************************************************
26740 ***********************************************************************/
26742 /* Value is the internal representation of the specified cursor type
26743 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
26744 of the bar cursor. */
26746 static enum text_cursor_kinds
26747 get_specified_cursor_type (Lisp_Object arg
, int *width
)
26749 enum text_cursor_kinds type
;
26754 if (EQ (arg
, Qbox
))
26755 return FILLED_BOX_CURSOR
;
26757 if (EQ (arg
, Qhollow
))
26758 return HOLLOW_BOX_CURSOR
;
26760 if (EQ (arg
, Qbar
))
26767 && EQ (XCAR (arg
), Qbar
)
26768 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
26770 *width
= XINT (XCDR (arg
));
26774 if (EQ (arg
, Qhbar
))
26777 return HBAR_CURSOR
;
26781 && EQ (XCAR (arg
), Qhbar
)
26782 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
26784 *width
= XINT (XCDR (arg
));
26785 return HBAR_CURSOR
;
26788 /* Treat anything unknown as "hollow box cursor".
26789 It was bad to signal an error; people have trouble fixing
26790 .Xdefaults with Emacs, when it has something bad in it. */
26791 type
= HOLLOW_BOX_CURSOR
;
26796 /* Set the default cursor types for specified frame. */
26798 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
26803 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
26804 FRAME_CURSOR_WIDTH (f
) = width
;
26806 /* By default, set up the blink-off state depending on the on-state. */
26808 tem
= Fassoc (arg
, Vblink_cursor_alist
);
26811 FRAME_BLINK_OFF_CURSOR (f
)
26812 = get_specified_cursor_type (XCDR (tem
), &width
);
26813 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
26816 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
26818 /* Make sure the cursor gets redrawn. */
26819 f
->cursor_type_changed
= 1;
26823 #ifdef HAVE_WINDOW_SYSTEM
26825 /* Return the cursor we want to be displayed in window W. Return
26826 width of bar/hbar cursor through WIDTH arg. Return with
26827 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
26828 (i.e. if the `system caret' should track this cursor).
26830 In a mini-buffer window, we want the cursor only to appear if we
26831 are reading input from this window. For the selected window, we
26832 want the cursor type given by the frame parameter or buffer local
26833 setting of cursor-type. If explicitly marked off, draw no cursor.
26834 In all other cases, we want a hollow box cursor. */
26836 static enum text_cursor_kinds
26837 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
26838 int *active_cursor
)
26840 struct frame
*f
= XFRAME (w
->frame
);
26841 struct buffer
*b
= XBUFFER (w
->contents
);
26842 int cursor_type
= DEFAULT_CURSOR
;
26843 Lisp_Object alt_cursor
;
26844 int non_selected
= 0;
26846 *active_cursor
= 1;
26849 if (cursor_in_echo_area
26850 && FRAME_HAS_MINIBUF_P (f
)
26851 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
26853 if (w
== XWINDOW (echo_area_window
))
26855 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
26857 *width
= FRAME_CURSOR_WIDTH (f
);
26858 return FRAME_DESIRED_CURSOR (f
);
26861 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
26864 *active_cursor
= 0;
26868 /* Detect a nonselected window or nonselected frame. */
26869 else if (w
!= XWINDOW (f
->selected_window
)
26870 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
26872 *active_cursor
= 0;
26874 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
26880 /* Never display a cursor in a window in which cursor-type is nil. */
26881 if (NILP (BVAR (b
, cursor_type
)))
26884 /* Get the normal cursor type for this window. */
26885 if (EQ (BVAR (b
, cursor_type
), Qt
))
26887 cursor_type
= FRAME_DESIRED_CURSOR (f
);
26888 *width
= FRAME_CURSOR_WIDTH (f
);
26891 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
26893 /* Use cursor-in-non-selected-windows instead
26894 for non-selected window or frame. */
26897 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
26898 if (!EQ (Qt
, alt_cursor
))
26899 return get_specified_cursor_type (alt_cursor
, width
);
26900 /* t means modify the normal cursor type. */
26901 if (cursor_type
== FILLED_BOX_CURSOR
)
26902 cursor_type
= HOLLOW_BOX_CURSOR
;
26903 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
26905 return cursor_type
;
26908 /* Use normal cursor if not blinked off. */
26909 if (!w
->cursor_off_p
)
26911 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26913 if (cursor_type
== FILLED_BOX_CURSOR
)
26915 /* Using a block cursor on large images can be very annoying.
26916 So use a hollow cursor for "large" images.
26917 If image is not transparent (no mask), also use hollow cursor. */
26918 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26919 if (img
!= NULL
&& IMAGEP (img
->spec
))
26921 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
26922 where N = size of default frame font size.
26923 This should cover most of the "tiny" icons people may use. */
26925 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
26926 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
26927 cursor_type
= HOLLOW_BOX_CURSOR
;
26930 else if (cursor_type
!= NO_CURSOR
)
26932 /* Display current only supports BOX and HOLLOW cursors for images.
26933 So for now, unconditionally use a HOLLOW cursor when cursor is
26934 not a solid box cursor. */
26935 cursor_type
= HOLLOW_BOX_CURSOR
;
26938 return cursor_type
;
26941 /* Cursor is blinked off, so determine how to "toggle" it. */
26943 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
26944 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
26945 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
26947 /* Then see if frame has specified a specific blink off cursor type. */
26948 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
26950 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
26951 return FRAME_BLINK_OFF_CURSOR (f
);
26955 /* Some people liked having a permanently visible blinking cursor,
26956 while others had very strong opinions against it. So it was
26957 decided to remove it. KFS 2003-09-03 */
26959 /* Finally perform built-in cursor blinking:
26960 filled box <-> hollow box
26961 wide [h]bar <-> narrow [h]bar
26962 narrow [h]bar <-> no cursor
26963 other type <-> no cursor */
26965 if (cursor_type
== FILLED_BOX_CURSOR
)
26966 return HOLLOW_BOX_CURSOR
;
26968 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
26971 return cursor_type
;
26979 /* Notice when the text cursor of window W has been completely
26980 overwritten by a drawing operation that outputs glyphs in AREA
26981 starting at X0 and ending at X1 in the line starting at Y0 and
26982 ending at Y1. X coordinates are area-relative. X1 < 0 means all
26983 the rest of the line after X0 has been written. Y coordinates
26984 are window-relative. */
26987 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
26988 int x0
, int x1
, int y0
, int y1
)
26990 int cx0
, cx1
, cy0
, cy1
;
26991 struct glyph_row
*row
;
26993 if (!w
->phys_cursor_on_p
)
26995 if (area
!= TEXT_AREA
)
26998 if (w
->phys_cursor
.vpos
< 0
26999 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27000 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27001 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27004 if (row
->cursor_in_fringe_p
)
27006 row
->cursor_in_fringe_p
= 0;
27007 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27008 w
->phys_cursor_on_p
= 0;
27012 cx0
= w
->phys_cursor
.x
;
27013 cx1
= cx0
+ w
->phys_cursor_width
;
27014 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27017 /* The cursor image will be completely removed from the
27018 screen if the output area intersects the cursor area in
27019 y-direction. When we draw in [y0 y1[, and some part of
27020 the cursor is at y < y0, that part must have been drawn
27021 before. When scrolling, the cursor is erased before
27022 actually scrolling, so we don't come here. When not
27023 scrolling, the rows above the old cursor row must have
27024 changed, and in this case these rows must have written
27025 over the cursor image.
27027 Likewise if part of the cursor is below y1, with the
27028 exception of the cursor being in the first blank row at
27029 the buffer and window end because update_text_area
27030 doesn't draw that row. (Except when it does, but
27031 that's handled in update_text_area.) */
27033 cy0
= w
->phys_cursor
.y
;
27034 cy1
= cy0
+ w
->phys_cursor_height
;
27035 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27038 w
->phys_cursor_on_p
= 0;
27041 #endif /* HAVE_WINDOW_SYSTEM */
27044 /************************************************************************
27046 ************************************************************************/
27048 #ifdef HAVE_WINDOW_SYSTEM
27051 Fix the display of area AREA of overlapping row ROW in window W
27052 with respect to the overlapping part OVERLAPS. */
27055 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27056 enum glyph_row_area area
, int overlaps
)
27063 for (i
= 0; i
< row
->used
[area
];)
27065 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27067 int start
= i
, start_x
= x
;
27071 x
+= row
->glyphs
[area
][i
].pixel_width
;
27074 while (i
< row
->used
[area
]
27075 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27077 draw_glyphs (w
, start_x
, row
, area
,
27079 DRAW_NORMAL_TEXT
, overlaps
);
27083 x
+= row
->glyphs
[area
][i
].pixel_width
;
27093 Draw the cursor glyph of window W in glyph row ROW. See the
27094 comment of draw_glyphs for the meaning of HL. */
27097 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27098 enum draw_glyphs_face hl
)
27100 /* If cursor hpos is out of bounds, don't draw garbage. This can
27101 happen in mini-buffer windows when switching between echo area
27102 glyphs and mini-buffer. */
27103 if ((row
->reversed_p
27104 ? (w
->phys_cursor
.hpos
>= 0)
27105 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27107 int on_p
= w
->phys_cursor_on_p
;
27109 int hpos
= w
->phys_cursor
.hpos
;
27111 /* When the window is hscrolled, cursor hpos can legitimately be
27112 out of bounds, but we draw the cursor at the corresponding
27113 window margin in that case. */
27114 if (!row
->reversed_p
&& hpos
< 0)
27116 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27117 hpos
= row
->used
[TEXT_AREA
] - 1;
27119 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27121 w
->phys_cursor_on_p
= on_p
;
27123 if (hl
== DRAW_CURSOR
)
27124 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27125 /* When we erase the cursor, and ROW is overlapped by other
27126 rows, make sure that these overlapping parts of other rows
27128 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27130 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27132 if (row
> w
->current_matrix
->rows
27133 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27134 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27135 OVERLAPS_ERASED_CURSOR
);
27137 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27138 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27139 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27140 OVERLAPS_ERASED_CURSOR
);
27146 /* Erase the image of a cursor of window W from the screen. */
27149 erase_phys_cursor (struct window
*w
)
27151 struct frame
*f
= XFRAME (w
->frame
);
27152 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27153 int hpos
= w
->phys_cursor
.hpos
;
27154 int vpos
= w
->phys_cursor
.vpos
;
27155 int mouse_face_here_p
= 0;
27156 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27157 struct glyph_row
*cursor_row
;
27158 struct glyph
*cursor_glyph
;
27159 enum draw_glyphs_face hl
;
27161 /* No cursor displayed or row invalidated => nothing to do on the
27163 if (w
->phys_cursor_type
== NO_CURSOR
)
27164 goto mark_cursor_off
;
27166 /* VPOS >= active_glyphs->nrows means that window has been resized.
27167 Don't bother to erase the cursor. */
27168 if (vpos
>= active_glyphs
->nrows
)
27169 goto mark_cursor_off
;
27171 /* If row containing cursor is marked invalid, there is nothing we
27173 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27174 if (!cursor_row
->enabled_p
)
27175 goto mark_cursor_off
;
27177 /* If line spacing is > 0, old cursor may only be partially visible in
27178 window after split-window. So adjust visible height. */
27179 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27180 window_text_bottom_y (w
) - cursor_row
->y
);
27182 /* If row is completely invisible, don't attempt to delete a cursor which
27183 isn't there. This can happen if cursor is at top of a window, and
27184 we switch to a buffer with a header line in that window. */
27185 if (cursor_row
->visible_height
<= 0)
27186 goto mark_cursor_off
;
27188 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27189 if (cursor_row
->cursor_in_fringe_p
)
27191 cursor_row
->cursor_in_fringe_p
= 0;
27192 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27193 goto mark_cursor_off
;
27196 /* This can happen when the new row is shorter than the old one.
27197 In this case, either draw_glyphs or clear_end_of_line
27198 should have cleared the cursor. Note that we wouldn't be
27199 able to erase the cursor in this case because we don't have a
27200 cursor glyph at hand. */
27201 if ((cursor_row
->reversed_p
27202 ? (w
->phys_cursor
.hpos
< 0)
27203 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27204 goto mark_cursor_off
;
27206 /* When the window is hscrolled, cursor hpos can legitimately be out
27207 of bounds, but we draw the cursor at the corresponding window
27208 margin in that case. */
27209 if (!cursor_row
->reversed_p
&& hpos
< 0)
27211 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27212 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27214 /* If the cursor is in the mouse face area, redisplay that when
27215 we clear the cursor. */
27216 if (! NILP (hlinfo
->mouse_face_window
)
27217 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27218 /* Don't redraw the cursor's spot in mouse face if it is at the
27219 end of a line (on a newline). The cursor appears there, but
27220 mouse highlighting does not. */
27221 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27222 mouse_face_here_p
= 1;
27224 /* Maybe clear the display under the cursor. */
27225 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27228 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27231 cursor_glyph
= get_phys_cursor_glyph (w
);
27232 if (cursor_glyph
== NULL
)
27233 goto mark_cursor_off
;
27235 width
= cursor_glyph
->pixel_width
;
27236 left_x
= window_box_left_offset (w
, TEXT_AREA
);
27237 x
= w
->phys_cursor
.x
;
27239 width
-= left_x
- x
;
27240 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27241 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27242 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
27245 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27248 /* Erase the cursor by redrawing the character underneath it. */
27249 if (mouse_face_here_p
)
27250 hl
= DRAW_MOUSE_FACE
;
27252 hl
= DRAW_NORMAL_TEXT
;
27253 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27256 w
->phys_cursor_on_p
= 0;
27257 w
->phys_cursor_type
= NO_CURSOR
;
27262 Display or clear cursor of window W. If ON is zero, clear the
27263 cursor. If it is non-zero, display the cursor. If ON is nonzero,
27264 where to put the cursor is specified by HPOS, VPOS, X and Y. */
27267 display_and_set_cursor (struct window
*w
, bool on
,
27268 int hpos
, int vpos
, int x
, int y
)
27270 struct frame
*f
= XFRAME (w
->frame
);
27271 int new_cursor_type
;
27272 int new_cursor_width
;
27274 struct glyph_row
*glyph_row
;
27275 struct glyph
*glyph
;
27277 /* This is pointless on invisible frames, and dangerous on garbaged
27278 windows and frames; in the latter case, the frame or window may
27279 be in the midst of changing its size, and x and y may be off the
27281 if (! FRAME_VISIBLE_P (f
)
27282 || FRAME_GARBAGED_P (f
)
27283 || vpos
>= w
->current_matrix
->nrows
27284 || hpos
>= w
->current_matrix
->matrix_w
)
27287 /* If cursor is off and we want it off, return quickly. */
27288 if (!on
&& !w
->phys_cursor_on_p
)
27291 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27292 /* If cursor row is not enabled, we don't really know where to
27293 display the cursor. */
27294 if (!glyph_row
->enabled_p
)
27296 w
->phys_cursor_on_p
= 0;
27301 if (!glyph_row
->exact_window_width_line_p
27302 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
27303 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
27305 eassert (input_blocked_p ());
27307 /* Set new_cursor_type to the cursor we want to be displayed. */
27308 new_cursor_type
= get_window_cursor_type (w
, glyph
,
27309 &new_cursor_width
, &active_cursor
);
27311 /* If cursor is currently being shown and we don't want it to be or
27312 it is in the wrong place, or the cursor type is not what we want,
27314 if (w
->phys_cursor_on_p
27316 || w
->phys_cursor
.x
!= x
27317 || w
->phys_cursor
.y
!= y
27318 || new_cursor_type
!= w
->phys_cursor_type
27319 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
27320 && new_cursor_width
!= w
->phys_cursor_width
)))
27321 erase_phys_cursor (w
);
27323 /* Don't check phys_cursor_on_p here because that flag is only set
27324 to zero in some cases where we know that the cursor has been
27325 completely erased, to avoid the extra work of erasing the cursor
27326 twice. In other words, phys_cursor_on_p can be 1 and the cursor
27327 still not be visible, or it has only been partly erased. */
27330 w
->phys_cursor_ascent
= glyph_row
->ascent
;
27331 w
->phys_cursor_height
= glyph_row
->height
;
27333 /* Set phys_cursor_.* before x_draw_.* is called because some
27334 of them may need the information. */
27335 w
->phys_cursor
.x
= x
;
27336 w
->phys_cursor
.y
= glyph_row
->y
;
27337 w
->phys_cursor
.hpos
= hpos
;
27338 w
->phys_cursor
.vpos
= vpos
;
27341 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
27342 new_cursor_type
, new_cursor_width
,
27343 on
, active_cursor
);
27347 /* Switch the display of W's cursor on or off, according to the value
27351 update_window_cursor (struct window
*w
, bool on
)
27353 /* Don't update cursor in windows whose frame is in the process
27354 of being deleted. */
27355 if (w
->current_matrix
)
27357 int hpos
= w
->phys_cursor
.hpos
;
27358 int vpos
= w
->phys_cursor
.vpos
;
27359 struct glyph_row
*row
;
27361 if (vpos
>= w
->current_matrix
->nrows
27362 || hpos
>= w
->current_matrix
->matrix_w
)
27365 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27367 /* When the window is hscrolled, cursor hpos can legitimately be
27368 out of bounds, but we draw the cursor at the corresponding
27369 window margin in that case. */
27370 if (!row
->reversed_p
&& hpos
< 0)
27372 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27373 hpos
= row
->used
[TEXT_AREA
] - 1;
27376 display_and_set_cursor (w
, on
, hpos
, vpos
,
27377 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27383 /* Call update_window_cursor with parameter ON_P on all leaf windows
27384 in the window tree rooted at W. */
27387 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
27391 if (WINDOWP (w
->contents
))
27392 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
27394 update_window_cursor (w
, on_p
);
27396 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
27402 Display the cursor on window W, or clear it, according to ON_P.
27403 Don't change the cursor's position. */
27406 x_update_cursor (struct frame
*f
, bool on_p
)
27408 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
27413 Clear the cursor of window W to background color, and mark the
27414 cursor as not shown. This is used when the text where the cursor
27415 is about to be rewritten. */
27418 x_clear_cursor (struct window
*w
)
27420 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
27421 update_window_cursor (w
, 0);
27424 #endif /* HAVE_WINDOW_SYSTEM */
27426 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
27429 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
27430 int start_hpos
, int end_hpos
,
27431 enum draw_glyphs_face draw
)
27433 #ifdef HAVE_WINDOW_SYSTEM
27434 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
27436 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
27440 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
27441 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
27445 /* Display the active region described by mouse_face_* according to DRAW. */
27448 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
27450 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
27451 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27453 if (/* If window is in the process of being destroyed, don't bother
27455 w
->current_matrix
!= NULL
27456 /* Don't update mouse highlight if hidden. */
27457 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
27458 /* Recognize when we are called to operate on rows that don't exist
27459 anymore. This can happen when a window is split. */
27460 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
27462 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
27463 struct glyph_row
*row
, *first
, *last
;
27465 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
27466 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
27468 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
27470 int start_hpos
, end_hpos
, start_x
;
27472 /* For all but the first row, the highlight starts at column 0. */
27475 /* R2L rows have BEG and END in reversed order, but the
27476 screen drawing geometry is always left to right. So
27477 we need to mirror the beginning and end of the
27478 highlighted area in R2L rows. */
27479 if (!row
->reversed_p
)
27481 start_hpos
= hlinfo
->mouse_face_beg_col
;
27482 start_x
= hlinfo
->mouse_face_beg_x
;
27484 else if (row
== last
)
27486 start_hpos
= hlinfo
->mouse_face_end_col
;
27487 start_x
= hlinfo
->mouse_face_end_x
;
27495 else if (row
->reversed_p
&& row
== last
)
27497 start_hpos
= hlinfo
->mouse_face_end_col
;
27498 start_x
= hlinfo
->mouse_face_end_x
;
27508 if (!row
->reversed_p
)
27509 end_hpos
= hlinfo
->mouse_face_end_col
;
27510 else if (row
== first
)
27511 end_hpos
= hlinfo
->mouse_face_beg_col
;
27514 end_hpos
= row
->used
[TEXT_AREA
];
27515 if (draw
== DRAW_NORMAL_TEXT
)
27516 row
->fill_line_p
= 1; /* Clear to end of line */
27519 else if (row
->reversed_p
&& row
== first
)
27520 end_hpos
= hlinfo
->mouse_face_beg_col
;
27523 end_hpos
= row
->used
[TEXT_AREA
];
27524 if (draw
== DRAW_NORMAL_TEXT
)
27525 row
->fill_line_p
= 1; /* Clear to end of line */
27528 if (end_hpos
> start_hpos
)
27530 draw_row_with_mouse_face (w
, start_x
, row
,
27531 start_hpos
, end_hpos
, draw
);
27534 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
27538 #ifdef HAVE_WINDOW_SYSTEM
27539 /* When we've written over the cursor, arrange for it to
27540 be displayed again. */
27541 if (FRAME_WINDOW_P (f
)
27542 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
27544 int hpos
= w
->phys_cursor
.hpos
;
27546 /* When the window is hscrolled, cursor hpos can legitimately be
27547 out of bounds, but we draw the cursor at the corresponding
27548 window margin in that case. */
27549 if (!row
->reversed_p
&& hpos
< 0)
27551 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27552 hpos
= row
->used
[TEXT_AREA
] - 1;
27555 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
27556 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27559 #endif /* HAVE_WINDOW_SYSTEM */
27562 #ifdef HAVE_WINDOW_SYSTEM
27563 /* Change the mouse cursor. */
27564 if (FRAME_WINDOW_P (f
))
27566 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
27567 if (draw
== DRAW_NORMAL_TEXT
27568 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
27569 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
27572 if (draw
== DRAW_MOUSE_FACE
)
27573 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
27575 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
27577 #endif /* HAVE_WINDOW_SYSTEM */
27581 Clear out the mouse-highlighted active region.
27582 Redraw it un-highlighted first. Value is non-zero if mouse
27583 face was actually drawn unhighlighted. */
27586 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
27590 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
27592 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
27596 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27597 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27598 hlinfo
->mouse_face_window
= Qnil
;
27599 hlinfo
->mouse_face_overlay
= Qnil
;
27603 /* Return true if the coordinates HPOS and VPOS on windows W are
27604 within the mouse face on that window. */
27606 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
27608 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27610 /* Quickly resolve the easy cases. */
27611 if (!(WINDOWP (hlinfo
->mouse_face_window
)
27612 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
27614 if (vpos
< hlinfo
->mouse_face_beg_row
27615 || vpos
> hlinfo
->mouse_face_end_row
)
27617 if (vpos
> hlinfo
->mouse_face_beg_row
27618 && vpos
< hlinfo
->mouse_face_end_row
)
27621 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
27623 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27625 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
27628 else if ((vpos
== hlinfo
->mouse_face_beg_row
27629 && hpos
>= hlinfo
->mouse_face_beg_col
)
27630 || (vpos
== hlinfo
->mouse_face_end_row
27631 && hpos
< hlinfo
->mouse_face_end_col
))
27636 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27638 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
27641 else if ((vpos
== hlinfo
->mouse_face_beg_row
27642 && hpos
<= hlinfo
->mouse_face_beg_col
)
27643 || (vpos
== hlinfo
->mouse_face_end_row
27644 && hpos
> hlinfo
->mouse_face_end_col
))
27652 True if physical cursor of window W is within mouse face. */
27655 cursor_in_mouse_face_p (struct window
*w
)
27657 int hpos
= w
->phys_cursor
.hpos
;
27658 int vpos
= w
->phys_cursor
.vpos
;
27659 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27661 /* When the window is hscrolled, cursor hpos can legitimately be out
27662 of bounds, but we draw the cursor at the corresponding window
27663 margin in that case. */
27664 if (!row
->reversed_p
&& hpos
< 0)
27666 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27667 hpos
= row
->used
[TEXT_AREA
] - 1;
27669 return coords_in_mouse_face_p (w
, hpos
, vpos
);
27674 /* Find the glyph rows START_ROW and END_ROW of window W that display
27675 characters between buffer positions START_CHARPOS and END_CHARPOS
27676 (excluding END_CHARPOS). DISP_STRING is a display string that
27677 covers these buffer positions. This is similar to
27678 row_containing_pos, but is more accurate when bidi reordering makes
27679 buffer positions change non-linearly with glyph rows. */
27681 rows_from_pos_range (struct window
*w
,
27682 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
27683 Lisp_Object disp_string
,
27684 struct glyph_row
**start
, struct glyph_row
**end
)
27686 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27687 int last_y
= window_text_bottom_y (w
);
27688 struct glyph_row
*row
;
27693 while (!first
->enabled_p
27694 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
27697 /* Find the START row. */
27699 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
27702 /* A row can potentially be the START row if the range of the
27703 characters it displays intersects the range
27704 [START_CHARPOS..END_CHARPOS). */
27705 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
27706 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
27707 /* See the commentary in row_containing_pos, for the
27708 explanation of the complicated way to check whether
27709 some position is beyond the end of the characters
27710 displayed by a row. */
27711 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27712 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27713 && !row
->ends_at_zv_p
27714 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
27715 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27716 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27717 && !row
->ends_at_zv_p
27718 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
27720 /* Found a candidate row. Now make sure at least one of the
27721 glyphs it displays has a charpos from the range
27722 [START_CHARPOS..END_CHARPOS).
27724 This is not obvious because bidi reordering could make
27725 buffer positions of a row be 1,2,3,102,101,100, and if we
27726 want to highlight characters in [50..60), we don't want
27727 this row, even though [50..60) does intersect [1..103),
27728 the range of character positions given by the row's start
27729 and end positions. */
27730 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
27731 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
27735 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
27736 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
27737 /* A glyph that comes from DISP_STRING is by
27738 definition to be highlighted. */
27739 || EQ (g
->object
, disp_string
))
27748 /* Find the END row. */
27750 /* If the last row is partially visible, start looking for END
27751 from that row, instead of starting from FIRST. */
27752 && !(row
->enabled_p
27753 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
27755 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
27757 struct glyph_row
*next
= row
+ 1;
27758 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
27760 if (!next
->enabled_p
27761 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
27762 /* The first row >= START whose range of displayed characters
27763 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
27764 is the row END + 1. */
27765 || (start_charpos
< next_start
27766 && end_charpos
< next_start
)
27767 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
27768 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
27769 && !next
->ends_at_zv_p
27770 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
27771 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
27772 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
27773 && !next
->ends_at_zv_p
27774 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
27781 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
27782 but none of the characters it displays are in the range, it is
27784 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
27785 struct glyph
*s
= g
;
27786 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
27790 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
27791 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
27792 /* If the buffer position of the first glyph in
27793 the row is equal to END_CHARPOS, it means
27794 the last character to be highlighted is the
27795 newline of ROW, and we must consider NEXT as
27797 || (((!next
->reversed_p
&& g
== s
)
27798 || (next
->reversed_p
&& g
== e
- 1))
27799 && (g
->charpos
== end_charpos
27800 /* Special case for when NEXT is an
27801 empty line at ZV. */
27802 || (g
->charpos
== -1
27803 && !row
->ends_at_zv_p
27804 && next_start
== end_charpos
)))))
27805 /* A glyph that comes from DISP_STRING is by
27806 definition to be highlighted. */
27807 || EQ (g
->object
, disp_string
))
27816 /* The first row that ends at ZV must be the last to be
27818 else if (next
->ends_at_zv_p
)
27827 /* This function sets the mouse_face_* elements of HLINFO, assuming
27828 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
27829 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
27830 for the overlay or run of text properties specifying the mouse
27831 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
27832 before-string and after-string that must also be highlighted.
27833 DISP_STRING, if non-nil, is a display string that may cover some
27834 or all of the highlighted text. */
27837 mouse_face_from_buffer_pos (Lisp_Object window
,
27838 Mouse_HLInfo
*hlinfo
,
27839 ptrdiff_t mouse_charpos
,
27840 ptrdiff_t start_charpos
,
27841 ptrdiff_t end_charpos
,
27842 Lisp_Object before_string
,
27843 Lisp_Object after_string
,
27844 Lisp_Object disp_string
)
27846 struct window
*w
= XWINDOW (window
);
27847 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27848 struct glyph_row
*r1
, *r2
;
27849 struct glyph
*glyph
, *end
;
27850 ptrdiff_t ignore
, pos
;
27853 eassert (NILP (disp_string
) || STRINGP (disp_string
));
27854 eassert (NILP (before_string
) || STRINGP (before_string
));
27855 eassert (NILP (after_string
) || STRINGP (after_string
));
27857 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
27858 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
27860 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
27861 /* If the before-string or display-string contains newlines,
27862 rows_from_pos_range skips to its last row. Move back. */
27863 if (!NILP (before_string
) || !NILP (disp_string
))
27865 struct glyph_row
*prev
;
27866 while ((prev
= r1
- 1, prev
>= first
)
27867 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
27868 && prev
->used
[TEXT_AREA
] > 0)
27870 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
27871 glyph
= beg
+ prev
->used
[TEXT_AREA
];
27872 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
27874 || !(EQ (glyph
->object
, before_string
)
27875 || EQ (glyph
->object
, disp_string
)))
27882 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
27883 hlinfo
->mouse_face_past_end
= 1;
27885 else if (!NILP (after_string
))
27887 /* If the after-string has newlines, advance to its last row. */
27888 struct glyph_row
*next
;
27889 struct glyph_row
*last
27890 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
27892 for (next
= r2
+ 1;
27894 && next
->used
[TEXT_AREA
] > 0
27895 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
27899 /* The rest of the display engine assumes that mouse_face_beg_row is
27900 either above mouse_face_end_row or identical to it. But with
27901 bidi-reordered continued lines, the row for START_CHARPOS could
27902 be below the row for END_CHARPOS. If so, swap the rows and store
27903 them in correct order. */
27906 struct glyph_row
*tem
= r2
;
27912 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
27913 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
27915 /* For a bidi-reordered row, the positions of BEFORE_STRING,
27916 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
27917 could be anywhere in the row and in any order. The strategy
27918 below is to find the leftmost and the rightmost glyph that
27919 belongs to either of these 3 strings, or whose position is
27920 between START_CHARPOS and END_CHARPOS, and highlight all the
27921 glyphs between those two. This may cover more than just the text
27922 between START_CHARPOS and END_CHARPOS if the range of characters
27923 strides the bidi level boundary, e.g. if the beginning is in R2L
27924 text while the end is in L2R text or vice versa. */
27925 if (!r1
->reversed_p
)
27927 /* This row is in a left to right paragraph. Scan it left to
27929 glyph
= r1
->glyphs
[TEXT_AREA
];
27930 end
= glyph
+ r1
->used
[TEXT_AREA
];
27933 /* Skip truncation glyphs at the start of the glyph row. */
27934 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
27936 && INTEGERP (glyph
->object
)
27937 && glyph
->charpos
< 0;
27939 x
+= glyph
->pixel_width
;
27941 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
27942 or DISP_STRING, and the first glyph from buffer whose
27943 position is between START_CHARPOS and END_CHARPOS. */
27945 && !INTEGERP (glyph
->object
)
27946 && !EQ (glyph
->object
, disp_string
)
27947 && !(BUFFERP (glyph
->object
)
27948 && (glyph
->charpos
>= start_charpos
27949 && glyph
->charpos
< end_charpos
));
27952 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27953 are present at buffer positions between START_CHARPOS and
27954 END_CHARPOS, or if they come from an overlay. */
27955 if (EQ (glyph
->object
, before_string
))
27957 pos
= string_buffer_position (before_string
,
27959 /* If pos == 0, it means before_string came from an
27960 overlay, not from a buffer position. */
27961 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27964 else if (EQ (glyph
->object
, after_string
))
27966 pos
= string_buffer_position (after_string
, end_charpos
);
27967 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27970 x
+= glyph
->pixel_width
;
27972 hlinfo
->mouse_face_beg_x
= x
;
27973 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
27977 /* This row is in a right to left paragraph. Scan it right to
27981 end
= r1
->glyphs
[TEXT_AREA
] - 1;
27982 glyph
= end
+ r1
->used
[TEXT_AREA
];
27984 /* Skip truncation glyphs at the start of the glyph row. */
27985 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
27987 && INTEGERP (glyph
->object
)
27988 && glyph
->charpos
< 0;
27992 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
27993 or DISP_STRING, and the first glyph from buffer whose
27994 position is between START_CHARPOS and END_CHARPOS. */
27996 && !INTEGERP (glyph
->object
)
27997 && !EQ (glyph
->object
, disp_string
)
27998 && !(BUFFERP (glyph
->object
)
27999 && (glyph
->charpos
>= start_charpos
28000 && glyph
->charpos
< end_charpos
));
28003 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28004 are present at buffer positions between START_CHARPOS and
28005 END_CHARPOS, or if they come from an overlay. */
28006 if (EQ (glyph
->object
, before_string
))
28008 pos
= string_buffer_position (before_string
, start_charpos
);
28009 /* If pos == 0, it means before_string came from an
28010 overlay, not from a buffer position. */
28011 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28014 else if (EQ (glyph
->object
, after_string
))
28016 pos
= string_buffer_position (after_string
, end_charpos
);
28017 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28022 glyph
++; /* first glyph to the right of the highlighted area */
28023 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28024 x
+= g
->pixel_width
;
28025 hlinfo
->mouse_face_beg_x
= x
;
28026 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28029 /* If the highlight ends in a different row, compute GLYPH and END
28030 for the end row. Otherwise, reuse the values computed above for
28031 the row where the highlight begins. */
28034 if (!r2
->reversed_p
)
28036 glyph
= r2
->glyphs
[TEXT_AREA
];
28037 end
= glyph
+ r2
->used
[TEXT_AREA
];
28042 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28043 glyph
= end
+ r2
->used
[TEXT_AREA
];
28047 if (!r2
->reversed_p
)
28049 /* Skip truncation and continuation glyphs near the end of the
28050 row, and also blanks and stretch glyphs inserted by
28051 extend_face_to_end_of_line. */
28053 && INTEGERP ((end
- 1)->object
))
28055 /* Scan the rest of the glyph row from the end, looking for the
28056 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28057 DISP_STRING, or whose position is between START_CHARPOS
28061 && !INTEGERP (end
->object
)
28062 && !EQ (end
->object
, disp_string
)
28063 && !(BUFFERP (end
->object
)
28064 && (end
->charpos
>= start_charpos
28065 && end
->charpos
< end_charpos
));
28068 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28069 are present at buffer positions between START_CHARPOS and
28070 END_CHARPOS, or if they come from an overlay. */
28071 if (EQ (end
->object
, before_string
))
28073 pos
= string_buffer_position (before_string
, start_charpos
);
28074 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28077 else if (EQ (end
->object
, after_string
))
28079 pos
= string_buffer_position (after_string
, end_charpos
);
28080 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28084 /* Find the X coordinate of the last glyph to be highlighted. */
28085 for (; glyph
<= end
; ++glyph
)
28086 x
+= glyph
->pixel_width
;
28088 hlinfo
->mouse_face_end_x
= x
;
28089 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28093 /* Skip truncation and continuation glyphs near the end of the
28094 row, and also blanks and stretch glyphs inserted by
28095 extend_face_to_end_of_line. */
28099 && INTEGERP (end
->object
))
28101 x
+= end
->pixel_width
;
28104 /* Scan the rest of the glyph row from the end, looking for the
28105 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28106 DISP_STRING, or whose position is between START_CHARPOS
28110 && !INTEGERP (end
->object
)
28111 && !EQ (end
->object
, disp_string
)
28112 && !(BUFFERP (end
->object
)
28113 && (end
->charpos
>= start_charpos
28114 && end
->charpos
< end_charpos
));
28117 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28118 are present at buffer positions between START_CHARPOS and
28119 END_CHARPOS, or if they come from an overlay. */
28120 if (EQ (end
->object
, before_string
))
28122 pos
= string_buffer_position (before_string
, start_charpos
);
28123 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28126 else if (EQ (end
->object
, after_string
))
28128 pos
= string_buffer_position (after_string
, end_charpos
);
28129 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28132 x
+= end
->pixel_width
;
28134 /* If we exited the above loop because we arrived at the last
28135 glyph of the row, and its buffer position is still not in
28136 range, it means the last character in range is the preceding
28137 newline. Bump the end column and x values to get past the
28140 && BUFFERP (end
->object
)
28141 && (end
->charpos
< start_charpos
28142 || end
->charpos
>= end_charpos
))
28144 x
+= end
->pixel_width
;
28147 hlinfo
->mouse_face_end_x
= x
;
28148 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28151 hlinfo
->mouse_face_window
= window
;
28152 hlinfo
->mouse_face_face_id
28153 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28155 !hlinfo
->mouse_face_hidden
, -1);
28156 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28159 /* The following function is not used anymore (replaced with
28160 mouse_face_from_string_pos), but I leave it here for the time
28161 being, in case someone would. */
28163 #if 0 /* not used */
28165 /* Find the position of the glyph for position POS in OBJECT in
28166 window W's current matrix, and return in *X, *Y the pixel
28167 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28169 RIGHT_P non-zero means return the position of the right edge of the
28170 glyph, RIGHT_P zero means return the left edge position.
28172 If no glyph for POS exists in the matrix, return the position of
28173 the glyph with the next smaller position that is in the matrix, if
28174 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
28175 exists in the matrix, return the position of the glyph with the
28176 next larger position in OBJECT.
28178 Value is non-zero if a glyph was found. */
28181 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28182 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
28184 int yb
= window_text_bottom_y (w
);
28185 struct glyph_row
*r
;
28186 struct glyph
*best_glyph
= NULL
;
28187 struct glyph_row
*best_row
= NULL
;
28190 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28191 r
->enabled_p
&& r
->y
< yb
;
28194 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28195 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28198 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28199 if (EQ (g
->object
, object
))
28201 if (g
->charpos
== pos
)
28208 else if (best_glyph
== NULL
28209 || ((eabs (g
->charpos
- pos
)
28210 < eabs (best_glyph
->charpos
- pos
))
28213 : g
->charpos
> pos
)))
28227 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28231 *x
+= best_glyph
->pixel_width
;
28236 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28239 return best_glyph
!= NULL
;
28241 #endif /* not used */
28243 /* Find the positions of the first and the last glyphs in window W's
28244 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28245 (assumed to be a string), and return in HLINFO's mouse_face_*
28246 members the pixel and column/row coordinates of those glyphs. */
28249 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28250 Lisp_Object object
,
28251 ptrdiff_t startpos
, ptrdiff_t endpos
)
28253 int yb
= window_text_bottom_y (w
);
28254 struct glyph_row
*r
;
28255 struct glyph
*g
, *e
;
28259 /* Find the glyph row with at least one position in the range
28260 [STARTPOS..ENDPOS), and the first glyph in that row whose
28261 position belongs to that range. */
28262 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28263 r
->enabled_p
&& r
->y
< yb
;
28266 if (!r
->reversed_p
)
28268 g
= r
->glyphs
[TEXT_AREA
];
28269 e
= g
+ r
->used
[TEXT_AREA
];
28270 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28271 if (EQ (g
->object
, object
)
28272 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28274 hlinfo
->mouse_face_beg_row
28275 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28276 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28277 hlinfo
->mouse_face_beg_x
= gx
;
28286 e
= r
->glyphs
[TEXT_AREA
];
28287 g
= e
+ r
->used
[TEXT_AREA
];
28288 for ( ; g
> e
; --g
)
28289 if (EQ ((g
-1)->object
, object
)
28290 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
28292 hlinfo
->mouse_face_beg_row
28293 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28294 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28295 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
28296 gx
+= g1
->pixel_width
;
28297 hlinfo
->mouse_face_beg_x
= gx
;
28309 /* Starting with the next row, look for the first row which does NOT
28310 include any glyphs whose positions are in the range. */
28311 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
28313 g
= r
->glyphs
[TEXT_AREA
];
28314 e
= g
+ r
->used
[TEXT_AREA
];
28316 for ( ; g
< e
; ++g
)
28317 if (EQ (g
->object
, object
)
28318 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28327 /* The highlighted region ends on the previous row. */
28330 /* Set the end row. */
28331 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28333 /* Compute and set the end column and the end column's horizontal
28334 pixel coordinate. */
28335 if (!r
->reversed_p
)
28337 g
= r
->glyphs
[TEXT_AREA
];
28338 e
= g
+ r
->used
[TEXT_AREA
];
28339 for ( ; e
> g
; --e
)
28340 if (EQ ((e
-1)->object
, object
)
28341 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
28343 hlinfo
->mouse_face_end_col
= e
- g
;
28345 for (gx
= r
->x
; g
< e
; ++g
)
28346 gx
+= g
->pixel_width
;
28347 hlinfo
->mouse_face_end_x
= gx
;
28351 e
= r
->glyphs
[TEXT_AREA
];
28352 g
= e
+ r
->used
[TEXT_AREA
];
28353 for (gx
= r
->x
; e
< g
; ++e
)
28355 if (EQ (e
->object
, object
)
28356 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
28358 gx
+= e
->pixel_width
;
28360 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
28361 hlinfo
->mouse_face_end_x
= gx
;
28365 #ifdef HAVE_WINDOW_SYSTEM
28367 /* See if position X, Y is within a hot-spot of an image. */
28370 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
28372 if (!CONSP (hot_spot
))
28375 if (EQ (XCAR (hot_spot
), Qrect
))
28377 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
28378 Lisp_Object rect
= XCDR (hot_spot
);
28382 if (!CONSP (XCAR (rect
)))
28384 if (!CONSP (XCDR (rect
)))
28386 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
28388 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
28390 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
28392 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
28396 else if (EQ (XCAR (hot_spot
), Qcircle
))
28398 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
28399 Lisp_Object circ
= XCDR (hot_spot
);
28400 Lisp_Object lr
, lx0
, ly0
;
28402 && CONSP (XCAR (circ
))
28403 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
28404 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
28405 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
28407 double r
= XFLOATINT (lr
);
28408 double dx
= XINT (lx0
) - x
;
28409 double dy
= XINT (ly0
) - y
;
28410 return (dx
* dx
+ dy
* dy
<= r
* r
);
28413 else if (EQ (XCAR (hot_spot
), Qpoly
))
28415 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
28416 if (VECTORP (XCDR (hot_spot
)))
28418 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
28419 Lisp_Object
*poly
= v
->contents
;
28420 ptrdiff_t n
= v
->header
.size
;
28423 Lisp_Object lx
, ly
;
28426 /* Need an even number of coordinates, and at least 3 edges. */
28427 if (n
< 6 || n
& 1)
28430 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
28431 If count is odd, we are inside polygon. Pixels on edges
28432 may or may not be included depending on actual geometry of the
28434 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
28435 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
28437 x0
= XINT (lx
), y0
= XINT (ly
);
28438 for (i
= 0; i
< n
; i
+= 2)
28440 int x1
= x0
, y1
= y0
;
28441 if ((lx
= poly
[i
], !INTEGERP (lx
))
28442 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
28444 x0
= XINT (lx
), y0
= XINT (ly
);
28446 /* Does this segment cross the X line? */
28454 if (y
> y0
&& y
> y1
)
28456 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
28466 find_hot_spot (Lisp_Object map
, int x
, int y
)
28468 while (CONSP (map
))
28470 if (CONSP (XCAR (map
))
28471 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
28479 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
28481 doc
: /* Lookup in image map MAP coordinates X and Y.
28482 An image map is an alist where each element has the format (AREA ID PLIST).
28483 An AREA is specified as either a rectangle, a circle, or a polygon:
28484 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
28485 pixel coordinates of the upper left and bottom right corners.
28486 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
28487 and the radius of the circle; r may be a float or integer.
28488 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
28489 vector describes one corner in the polygon.
28490 Returns the alist element for the first matching AREA in MAP. */)
28491 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
28499 return find_hot_spot (map
,
28500 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
28501 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
28505 /* Display frame CURSOR, optionally using shape defined by POINTER. */
28507 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
28509 /* Do not change cursor shape while dragging mouse. */
28510 if (!NILP (do_mouse_tracking
))
28513 if (!NILP (pointer
))
28515 if (EQ (pointer
, Qarrow
))
28516 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28517 else if (EQ (pointer
, Qhand
))
28518 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
28519 else if (EQ (pointer
, Qtext
))
28520 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
28521 else if (EQ (pointer
, intern ("hdrag")))
28522 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28523 else if (EQ (pointer
, intern ("nhdrag")))
28524 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
28525 #ifdef HAVE_X_WINDOWS
28526 else if (EQ (pointer
, intern ("vdrag")))
28527 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28529 else if (EQ (pointer
, intern ("hourglass")))
28530 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
28531 else if (EQ (pointer
, Qmodeline
))
28532 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
28534 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28537 if (cursor
!= No_Cursor
)
28538 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
28541 #endif /* HAVE_WINDOW_SYSTEM */
28543 /* Take proper action when mouse has moved to the mode or header line
28544 or marginal area AREA of window W, x-position X and y-position Y.
28545 X is relative to the start of the text display area of W, so the
28546 width of bitmap areas and scroll bars must be subtracted to get a
28547 position relative to the start of the mode line. */
28550 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
28551 enum window_part area
)
28553 struct window
*w
= XWINDOW (window
);
28554 struct frame
*f
= XFRAME (w
->frame
);
28555 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28556 #ifdef HAVE_WINDOW_SYSTEM
28557 Display_Info
*dpyinfo
;
28559 Cursor cursor
= No_Cursor
;
28560 Lisp_Object pointer
= Qnil
;
28561 int dx
, dy
, width
, height
;
28563 Lisp_Object string
, object
= Qnil
;
28564 Lisp_Object pos
IF_LINT (= Qnil
), help
;
28566 Lisp_Object mouse_face
;
28567 int original_x_pixel
= x
;
28568 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
28569 struct glyph_row
*row
IF_LINT (= 0);
28571 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
28576 /* Kludge alert: mode_line_string takes X/Y in pixels, but
28577 returns them in row/column units! */
28578 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
28579 &object
, &dx
, &dy
, &width
, &height
);
28581 row
= (area
== ON_MODE_LINE
28582 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
28583 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
28585 /* Find the glyph under the mouse pointer. */
28586 if (row
->mode_line_p
&& row
->enabled_p
)
28588 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
28589 end
= glyph
+ row
->used
[TEXT_AREA
];
28591 for (x0
= original_x_pixel
;
28592 glyph
< end
&& x0
>= glyph
->pixel_width
;
28594 x0
-= glyph
->pixel_width
;
28602 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
28603 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
28604 returns them in row/column units! */
28605 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
28606 &object
, &dx
, &dy
, &width
, &height
);
28611 #ifdef HAVE_WINDOW_SYSTEM
28612 if (IMAGEP (object
))
28614 Lisp_Object image_map
, hotspot
;
28615 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
28617 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
28619 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
28623 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
28624 If so, we could look for mouse-enter, mouse-leave
28625 properties in PLIST (and do something...). */
28626 hotspot
= XCDR (hotspot
);
28627 if (CONSP (hotspot
)
28628 && (plist
= XCAR (hotspot
), CONSP (plist
)))
28630 pointer
= Fplist_get (plist
, Qpointer
);
28631 if (NILP (pointer
))
28633 help
= Fplist_get (plist
, Qhelp_echo
);
28636 help_echo_string
= help
;
28637 XSETWINDOW (help_echo_window
, w
);
28638 help_echo_object
= w
->contents
;
28639 help_echo_pos
= charpos
;
28643 if (NILP (pointer
))
28644 pointer
= Fplist_get (XCDR (object
), QCpointer
);
28646 #endif /* HAVE_WINDOW_SYSTEM */
28648 if (STRINGP (string
))
28649 pos
= make_number (charpos
);
28651 /* Set the help text and mouse pointer. If the mouse is on a part
28652 of the mode line without any text (e.g. past the right edge of
28653 the mode line text), use the default help text and pointer. */
28654 if (STRINGP (string
) || area
== ON_MODE_LINE
)
28656 /* Arrange to display the help by setting the global variables
28657 help_echo_string, help_echo_object, and help_echo_pos. */
28660 if (STRINGP (string
))
28661 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
28665 help_echo_string
= help
;
28666 XSETWINDOW (help_echo_window
, w
);
28667 help_echo_object
= string
;
28668 help_echo_pos
= charpos
;
28670 else if (area
== ON_MODE_LINE
)
28672 Lisp_Object default_help
28673 = buffer_local_value (Qmode_line_default_help_echo
,
28676 if (STRINGP (default_help
))
28678 help_echo_string
= default_help
;
28679 XSETWINDOW (help_echo_window
, w
);
28680 help_echo_object
= Qnil
;
28681 help_echo_pos
= -1;
28686 #ifdef HAVE_WINDOW_SYSTEM
28687 /* Change the mouse pointer according to what is under it. */
28688 if (FRAME_WINDOW_P (f
))
28690 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
28692 || NILP (Vresize_mini_windows
));
28694 dpyinfo
= FRAME_DISPLAY_INFO (f
);
28695 if (STRINGP (string
))
28697 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28699 if (NILP (pointer
))
28700 pointer
= Fget_text_property (pos
, Qpointer
, string
);
28702 /* Change the mouse pointer according to what is under X/Y. */
28704 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
28707 map
= Fget_text_property (pos
, Qlocal_map
, string
);
28708 if (!KEYMAPP (map
))
28709 map
= Fget_text_property (pos
, Qkeymap
, string
);
28710 if (!KEYMAPP (map
) && draggable
)
28711 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
28714 else if (draggable
)
28715 /* Default mode-line pointer. */
28716 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28721 /* Change the mouse face according to what is under X/Y. */
28722 if (STRINGP (string
))
28724 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
28725 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
28726 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
28731 struct glyph
* tmp_glyph
;
28735 int total_pixel_width
;
28736 ptrdiff_t begpos
, endpos
, ignore
;
28740 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
28741 Qmouse_face
, string
, Qnil
);
28747 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
28749 endpos
= SCHARS (string
);
28753 /* Calculate the glyph position GPOS of GLYPH in the
28754 displayed string, relative to the beginning of the
28755 highlighted part of the string.
28757 Note: GPOS is different from CHARPOS. CHARPOS is the
28758 position of GLYPH in the internal string object. A mode
28759 line string format has structures which are converted to
28760 a flattened string by the Emacs Lisp interpreter. The
28761 internal string is an element of those structures. The
28762 displayed string is the flattened string. */
28763 tmp_glyph
= row_start_glyph
;
28764 while (tmp_glyph
< glyph
28765 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
28766 && begpos
<= tmp_glyph
->charpos
28767 && tmp_glyph
->charpos
< endpos
)))
28769 gpos
= glyph
- tmp_glyph
;
28771 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
28772 the highlighted part of the displayed string to which
28773 GLYPH belongs. Note: GSEQ_LENGTH is different from
28774 SCHARS (STRING), because the latter returns the length of
28775 the internal string. */
28776 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
28778 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
28779 && begpos
<= tmp_glyph
->charpos
28780 && tmp_glyph
->charpos
< endpos
));
28783 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
28785 /* Calculate the total pixel width of all the glyphs between
28786 the beginning of the highlighted area and GLYPH. */
28787 total_pixel_width
= 0;
28788 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
28789 total_pixel_width
+= tmp_glyph
->pixel_width
;
28791 /* Pre calculation of re-rendering position. Note: X is in
28792 column units here, after the call to mode_line_string or
28793 marginal_area_string. */
28795 vpos
= (area
== ON_MODE_LINE
28796 ? (w
->current_matrix
)->nrows
- 1
28799 /* If GLYPH's position is included in the region that is
28800 already drawn in mouse face, we have nothing to do. */
28801 if ( EQ (window
, hlinfo
->mouse_face_window
)
28802 && (!row
->reversed_p
28803 ? (hlinfo
->mouse_face_beg_col
<= hpos
28804 && hpos
< hlinfo
->mouse_face_end_col
)
28805 /* In R2L rows we swap BEG and END, see below. */
28806 : (hlinfo
->mouse_face_end_col
<= hpos
28807 && hpos
< hlinfo
->mouse_face_beg_col
))
28808 && hlinfo
->mouse_face_beg_row
== vpos
)
28811 if (clear_mouse_face (hlinfo
))
28812 cursor
= No_Cursor
;
28814 if (!row
->reversed_p
)
28816 hlinfo
->mouse_face_beg_col
= hpos
;
28817 hlinfo
->mouse_face_beg_x
= original_x_pixel
28818 - (total_pixel_width
+ dx
);
28819 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
28820 hlinfo
->mouse_face_end_x
= 0;
28824 /* In R2L rows, show_mouse_face expects BEG and END
28825 coordinates to be swapped. */
28826 hlinfo
->mouse_face_end_col
= hpos
;
28827 hlinfo
->mouse_face_end_x
= original_x_pixel
28828 - (total_pixel_width
+ dx
);
28829 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
28830 hlinfo
->mouse_face_beg_x
= 0;
28833 hlinfo
->mouse_face_beg_row
= vpos
;
28834 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
28835 hlinfo
->mouse_face_past_end
= 0;
28836 hlinfo
->mouse_face_window
= window
;
28838 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
28843 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28845 if (NILP (pointer
))
28848 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
28849 clear_mouse_face (hlinfo
);
28851 #ifdef HAVE_WINDOW_SYSTEM
28852 if (FRAME_WINDOW_P (f
))
28853 define_frame_cursor1 (f
, cursor
, pointer
);
28859 Take proper action when the mouse has moved to position X, Y on
28860 frame F with regards to highlighting portions of display that have
28861 mouse-face properties. Also de-highlight portions of display where
28862 the mouse was before, set the mouse pointer shape as appropriate
28863 for the mouse coordinates, and activate help echo (tooltips).
28864 X and Y can be negative or out of range. */
28867 note_mouse_highlight (struct frame
*f
, int x
, int y
)
28869 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28870 enum window_part part
= ON_NOTHING
;
28871 Lisp_Object window
;
28873 Cursor cursor
= No_Cursor
;
28874 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
28877 /* When a menu is active, don't highlight because this looks odd. */
28878 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
28879 if (popup_activated ())
28883 if (!f
->glyphs_initialized_p
28884 || f
->pointer_invisible
)
28887 hlinfo
->mouse_face_mouse_x
= x
;
28888 hlinfo
->mouse_face_mouse_y
= y
;
28889 hlinfo
->mouse_face_mouse_frame
= f
;
28891 if (hlinfo
->mouse_face_defer
)
28894 /* Which window is that in? */
28895 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
28897 /* If displaying active text in another window, clear that. */
28898 if (! EQ (window
, hlinfo
->mouse_face_window
)
28899 /* Also clear if we move out of text area in same window. */
28900 || (!NILP (hlinfo
->mouse_face_window
)
28903 && part
!= ON_MODE_LINE
28904 && part
!= ON_HEADER_LINE
))
28905 clear_mouse_face (hlinfo
);
28907 /* Not on a window -> return. */
28908 if (!WINDOWP (window
))
28911 /* Reset help_echo_string. It will get recomputed below. */
28912 help_echo_string
= Qnil
;
28914 /* Convert to window-relative pixel coordinates. */
28915 w
= XWINDOW (window
);
28916 frame_to_window_pixel_xy (w
, &x
, &y
);
28918 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
28919 /* Handle tool-bar window differently since it doesn't display a
28921 if (EQ (window
, f
->tool_bar_window
))
28923 note_tool_bar_highlight (f
, x
, y
);
28928 /* Mouse is on the mode, header line or margin? */
28929 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
28930 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
28932 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
28934 #ifdef HAVE_WINDOW_SYSTEM
28935 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
28937 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28938 /* Show non-text cursor (Bug#16647). */
28946 #ifdef HAVE_WINDOW_SYSTEM
28947 if (part
== ON_VERTICAL_BORDER
)
28949 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28950 help_echo_string
= build_string ("drag-mouse-1: resize");
28952 else if (part
== ON_RIGHT_DIVIDER
)
28954 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28955 help_echo_string
= build_string ("drag-mouse-1: resize");
28957 else if (part
== ON_BOTTOM_DIVIDER
)
28958 if (! WINDOW_BOTTOMMOST_P (w
)
28960 || NILP (Vresize_mini_windows
))
28962 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
28963 help_echo_string
= build_string ("drag-mouse-1: resize");
28966 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28967 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
28968 || part
== ON_SCROLL_BAR
)
28969 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28971 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
28974 /* Are we in a window whose display is up to date?
28975 And verify the buffer's text has not changed. */
28976 b
= XBUFFER (w
->contents
);
28977 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
28979 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
28981 struct glyph
*glyph
;
28982 Lisp_Object object
;
28983 Lisp_Object mouse_face
= Qnil
, position
;
28984 Lisp_Object
*overlay_vec
= NULL
;
28985 ptrdiff_t i
, noverlays
;
28986 struct buffer
*obuf
;
28987 ptrdiff_t obegv
, ozv
;
28990 /* Find the glyph under X/Y. */
28991 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
28993 #ifdef HAVE_WINDOW_SYSTEM
28994 /* Look for :pointer property on image. */
28995 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
28997 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
28998 if (img
!= NULL
&& IMAGEP (img
->spec
))
29000 Lisp_Object image_map
, hotspot
;
29001 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29003 && (hotspot
= find_hot_spot (image_map
,
29004 glyph
->slice
.img
.x
+ dx
,
29005 glyph
->slice
.img
.y
+ dy
),
29007 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29011 /* Could check XCAR (hotspot) to see if we enter/leave
29013 If so, we could look for mouse-enter, mouse-leave
29014 properties in PLIST (and do something...). */
29015 hotspot
= XCDR (hotspot
);
29016 if (CONSP (hotspot
)
29017 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29019 pointer
= Fplist_get (plist
, Qpointer
);
29020 if (NILP (pointer
))
29022 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29023 if (!NILP (help_echo_string
))
29025 help_echo_window
= window
;
29026 help_echo_object
= glyph
->object
;
29027 help_echo_pos
= glyph
->charpos
;
29031 if (NILP (pointer
))
29032 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29035 #endif /* HAVE_WINDOW_SYSTEM */
29037 /* Clear mouse face if X/Y not over text. */
29039 || area
!= TEXT_AREA
29040 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29041 /* Glyph's OBJECT is an integer for glyphs inserted by the
29042 display engine for its internal purposes, like truncation
29043 and continuation glyphs and blanks beyond the end of
29044 line's text on text terminals. If we are over such a
29045 glyph, we are not over any text. */
29046 || INTEGERP (glyph
->object
)
29047 /* R2L rows have a stretch glyph at their front, which
29048 stands for no text, whereas L2R rows have no glyphs at
29049 all beyond the end of text. Treat such stretch glyphs
29050 like we do with NULL glyphs in L2R rows. */
29051 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29052 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29053 && glyph
->type
== STRETCH_GLYPH
29054 && glyph
->avoid_cursor_p
))
29056 if (clear_mouse_face (hlinfo
))
29057 cursor
= No_Cursor
;
29058 #ifdef HAVE_WINDOW_SYSTEM
29059 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29061 if (area
!= TEXT_AREA
)
29062 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29064 pointer
= Vvoid_text_area_pointer
;
29070 pos
= glyph
->charpos
;
29071 object
= glyph
->object
;
29072 if (!STRINGP (object
) && !BUFFERP (object
))
29075 /* If we get an out-of-range value, return now; avoid an error. */
29076 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29079 /* Make the window's buffer temporarily current for
29080 overlays_at and compute_char_face. */
29081 obuf
= current_buffer
;
29082 current_buffer
= b
;
29088 /* Is this char mouse-active or does it have help-echo? */
29089 position
= make_number (pos
);
29091 if (BUFFERP (object
))
29093 /* Put all the overlays we want in a vector in overlay_vec. */
29094 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
29095 /* Sort overlays into increasing priority order. */
29096 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29101 if (NILP (Vmouse_highlight
))
29103 clear_mouse_face (hlinfo
);
29104 goto check_help_echo
;
29107 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29110 cursor
= No_Cursor
;
29112 /* Check mouse-face highlighting. */
29114 /* If there exists an overlay with mouse-face overlapping
29115 the one we are currently highlighting, we have to
29116 check if we enter the overlapping overlay, and then
29117 highlight only that. */
29118 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29119 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29121 /* Find the highest priority overlay with a mouse-face. */
29122 Lisp_Object overlay
= Qnil
;
29123 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29125 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29126 if (!NILP (mouse_face
))
29127 overlay
= overlay_vec
[i
];
29130 /* If we're highlighting the same overlay as before, there's
29131 no need to do that again. */
29132 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29133 goto check_help_echo
;
29134 hlinfo
->mouse_face_overlay
= overlay
;
29136 /* Clear the display of the old active region, if any. */
29137 if (clear_mouse_face (hlinfo
))
29138 cursor
= No_Cursor
;
29140 /* If no overlay applies, get a text property. */
29141 if (NILP (overlay
))
29142 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29144 /* Next, compute the bounds of the mouse highlighting and
29146 if (!NILP (mouse_face
) && STRINGP (object
))
29148 /* The mouse-highlighting comes from a display string
29149 with a mouse-face. */
29153 s
= Fprevious_single_property_change
29154 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29155 e
= Fnext_single_property_change
29156 (position
, Qmouse_face
, object
, Qnil
);
29158 s
= make_number (0);
29160 e
= make_number (SCHARS (object
));
29161 mouse_face_from_string_pos (w
, hlinfo
, object
,
29162 XINT (s
), XINT (e
));
29163 hlinfo
->mouse_face_past_end
= 0;
29164 hlinfo
->mouse_face_window
= window
;
29165 hlinfo
->mouse_face_face_id
29166 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29167 glyph
->face_id
, 1);
29168 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29169 cursor
= No_Cursor
;
29173 /* The mouse-highlighting, if any, comes from an overlay
29174 or text property in the buffer. */
29175 Lisp_Object buffer
IF_LINT (= Qnil
);
29176 Lisp_Object disp_string
IF_LINT (= Qnil
);
29178 if (STRINGP (object
))
29180 /* If we are on a display string with no mouse-face,
29181 check if the text under it has one. */
29182 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29183 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29184 pos
= string_buffer_position (object
, start
);
29187 mouse_face
= get_char_property_and_overlay
29188 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29189 buffer
= w
->contents
;
29190 disp_string
= object
;
29196 disp_string
= Qnil
;
29199 if (!NILP (mouse_face
))
29201 Lisp_Object before
, after
;
29202 Lisp_Object before_string
, after_string
;
29203 /* To correctly find the limits of mouse highlight
29204 in a bidi-reordered buffer, we must not use the
29205 optimization of limiting the search in
29206 previous-single-property-change and
29207 next-single-property-change, because
29208 rows_from_pos_range needs the real start and end
29209 positions to DTRT in this case. That's because
29210 the first row visible in a window does not
29211 necessarily display the character whose position
29212 is the smallest. */
29214 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29215 ? Fmarker_position (w
->start
)
29218 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29219 ? make_number (BUF_Z (XBUFFER (buffer
))
29220 - w
->window_end_pos
)
29223 if (NILP (overlay
))
29225 /* Handle the text property case. */
29226 before
= Fprevious_single_property_change
29227 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29228 after
= Fnext_single_property_change
29229 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29230 before_string
= after_string
= Qnil
;
29234 /* Handle the overlay case. */
29235 before
= Foverlay_start (overlay
);
29236 after
= Foverlay_end (overlay
);
29237 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29238 after_string
= Foverlay_get (overlay
, Qafter_string
);
29240 if (!STRINGP (before_string
)) before_string
= Qnil
;
29241 if (!STRINGP (after_string
)) after_string
= Qnil
;
29244 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29247 : XFASTINT (before
),
29249 ? BUF_Z (XBUFFER (buffer
))
29250 : XFASTINT (after
),
29251 before_string
, after_string
,
29253 cursor
= No_Cursor
;
29260 /* Look for a `help-echo' property. */
29261 if (NILP (help_echo_string
)) {
29262 Lisp_Object help
, overlay
;
29264 /* Check overlays first. */
29265 help
= overlay
= Qnil
;
29266 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29268 overlay
= overlay_vec
[i
];
29269 help
= Foverlay_get (overlay
, Qhelp_echo
);
29274 help_echo_string
= help
;
29275 help_echo_window
= window
;
29276 help_echo_object
= overlay
;
29277 help_echo_pos
= pos
;
29281 Lisp_Object obj
= glyph
->object
;
29282 ptrdiff_t charpos
= glyph
->charpos
;
29284 /* Try text properties. */
29287 && charpos
< SCHARS (obj
))
29289 help
= Fget_text_property (make_number (charpos
),
29293 /* If the string itself doesn't specify a help-echo,
29294 see if the buffer text ``under'' it does. */
29295 struct glyph_row
*r
29296 = MATRIX_ROW (w
->current_matrix
, vpos
);
29297 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29298 ptrdiff_t p
= string_buffer_position (obj
, start
);
29301 help
= Fget_char_property (make_number (p
),
29302 Qhelp_echo
, w
->contents
);
29311 else if (BUFFERP (obj
)
29314 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
29319 help_echo_string
= help
;
29320 help_echo_window
= window
;
29321 help_echo_object
= obj
;
29322 help_echo_pos
= charpos
;
29327 #ifdef HAVE_WINDOW_SYSTEM
29328 /* Look for a `pointer' property. */
29329 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29331 /* Check overlays first. */
29332 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
29333 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
29335 if (NILP (pointer
))
29337 Lisp_Object obj
= glyph
->object
;
29338 ptrdiff_t charpos
= glyph
->charpos
;
29340 /* Try text properties. */
29343 && charpos
< SCHARS (obj
))
29345 pointer
= Fget_text_property (make_number (charpos
),
29347 if (NILP (pointer
))
29349 /* If the string itself doesn't specify a pointer,
29350 see if the buffer text ``under'' it does. */
29351 struct glyph_row
*r
29352 = MATRIX_ROW (w
->current_matrix
, vpos
);
29353 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29354 ptrdiff_t p
= string_buffer_position (obj
, start
);
29356 pointer
= Fget_char_property (make_number (p
),
29357 Qpointer
, w
->contents
);
29360 else if (BUFFERP (obj
)
29363 pointer
= Fget_text_property (make_number (charpos
),
29367 #endif /* HAVE_WINDOW_SYSTEM */
29371 current_buffer
= obuf
;
29376 #ifdef HAVE_WINDOW_SYSTEM
29377 if (FRAME_WINDOW_P (f
))
29378 define_frame_cursor1 (f
, cursor
, pointer
);
29380 /* This is here to prevent a compiler error, about "label at end of
29381 compound statement". */
29388 Clear any mouse-face on window W. This function is part of the
29389 redisplay interface, and is called from try_window_id and similar
29390 functions to ensure the mouse-highlight is off. */
29393 x_clear_window_mouse_face (struct window
*w
)
29395 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
29396 Lisp_Object window
;
29399 XSETWINDOW (window
, w
);
29400 if (EQ (window
, hlinfo
->mouse_face_window
))
29401 clear_mouse_face (hlinfo
);
29407 Just discard the mouse face information for frame F, if any.
29408 This is used when the size of F is changed. */
29411 cancel_mouse_face (struct frame
*f
)
29413 Lisp_Object window
;
29414 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29416 window
= hlinfo
->mouse_face_window
;
29417 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
29418 reset_mouse_highlight (hlinfo
);
29423 /***********************************************************************
29425 ***********************************************************************/
29427 #ifdef HAVE_WINDOW_SYSTEM
29429 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
29430 which intersects rectangle R. R is in window-relative coordinates. */
29433 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
29434 enum glyph_row_area area
)
29436 struct glyph
*first
= row
->glyphs
[area
];
29437 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
29438 struct glyph
*last
;
29439 int first_x
, start_x
, x
;
29441 if (area
== TEXT_AREA
&& row
->fill_line_p
)
29442 /* If row extends face to end of line write the whole line. */
29443 draw_glyphs (w
, 0, row
, area
,
29444 0, row
->used
[area
],
29445 DRAW_NORMAL_TEXT
, 0);
29448 /* Set START_X to the window-relative start position for drawing glyphs of
29449 AREA. The first glyph of the text area can be partially visible.
29450 The first glyphs of other areas cannot. */
29451 start_x
= window_box_left_offset (w
, area
);
29453 if (area
== TEXT_AREA
)
29456 /* Find the first glyph that must be redrawn. */
29458 && x
+ first
->pixel_width
< r
->x
)
29460 x
+= first
->pixel_width
;
29464 /* Find the last one. */
29468 && x
< r
->x
+ r
->width
)
29470 x
+= last
->pixel_width
;
29476 draw_glyphs (w
, first_x
- start_x
, row
, area
,
29477 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
29478 DRAW_NORMAL_TEXT
, 0);
29483 /* Redraw the parts of the glyph row ROW on window W intersecting
29484 rectangle R. R is in window-relative coordinates. Value is
29485 non-zero if mouse-face was overwritten. */
29488 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
29490 eassert (row
->enabled_p
);
29492 if (row
->mode_line_p
|| w
->pseudo_window_p
)
29493 draw_glyphs (w
, 0, row
, TEXT_AREA
,
29494 0, row
->used
[TEXT_AREA
],
29495 DRAW_NORMAL_TEXT
, 0);
29498 if (row
->used
[LEFT_MARGIN_AREA
])
29499 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
29500 if (row
->used
[TEXT_AREA
])
29501 expose_area (w
, row
, r
, TEXT_AREA
);
29502 if (row
->used
[RIGHT_MARGIN_AREA
])
29503 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
29504 draw_row_fringe_bitmaps (w
, row
);
29507 return row
->mouse_face_p
;
29511 /* Redraw those parts of glyphs rows during expose event handling that
29512 overlap other rows. Redrawing of an exposed line writes over parts
29513 of lines overlapping that exposed line; this function fixes that.
29515 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
29516 row in W's current matrix that is exposed and overlaps other rows.
29517 LAST_OVERLAPPING_ROW is the last such row. */
29520 expose_overlaps (struct window
*w
,
29521 struct glyph_row
*first_overlapping_row
,
29522 struct glyph_row
*last_overlapping_row
,
29525 struct glyph_row
*row
;
29527 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
29528 if (row
->overlapping_p
)
29530 eassert (row
->enabled_p
&& !row
->mode_line_p
);
29533 if (row
->used
[LEFT_MARGIN_AREA
])
29534 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
29536 if (row
->used
[TEXT_AREA
])
29537 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
29539 if (row
->used
[RIGHT_MARGIN_AREA
])
29540 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
29546 /* Return non-zero if W's cursor intersects rectangle R. */
29549 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
29551 XRectangle cr
, result
;
29552 struct glyph
*cursor_glyph
;
29553 struct glyph_row
*row
;
29555 if (w
->phys_cursor
.vpos
>= 0
29556 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
29557 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
29559 && row
->cursor_in_fringe_p
)
29561 /* Cursor is in the fringe. */
29562 cr
.x
= window_box_right_offset (w
,
29563 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
29564 ? RIGHT_MARGIN_AREA
29567 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
29568 cr
.height
= row
->height
;
29569 return x_intersect_rectangles (&cr
, r
, &result
);
29572 cursor_glyph
= get_phys_cursor_glyph (w
);
29575 /* r is relative to W's box, but w->phys_cursor.x is relative
29576 to left edge of W's TEXT area. Adjust it. */
29577 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
29578 cr
.y
= w
->phys_cursor
.y
;
29579 cr
.width
= cursor_glyph
->pixel_width
;
29580 cr
.height
= w
->phys_cursor_height
;
29581 /* ++KFS: W32 version used W32-specific IntersectRect here, but
29582 I assume the effect is the same -- and this is portable. */
29583 return x_intersect_rectangles (&cr
, r
, &result
);
29585 /* If we don't understand the format, pretend we're not in the hot-spot. */
29591 Draw a vertical window border to the right of window W if W doesn't
29592 have vertical scroll bars. */
29595 x_draw_vertical_border (struct window
*w
)
29597 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29599 /* We could do better, if we knew what type of scroll-bar the adjacent
29600 windows (on either side) have... But we don't :-(
29601 However, I think this works ok. ++KFS 2003-04-25 */
29603 /* Redraw borders between horizontally adjacent windows. Don't
29604 do it for frames with vertical scroll bars because either the
29605 right scroll bar of a window, or the left scroll bar of its
29606 neighbor will suffice as a border. */
29607 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
29610 /* Note: It is necessary to redraw both the left and the right
29611 borders, for when only this single window W is being
29613 if (!WINDOW_RIGHTMOST_P (w
)
29614 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
29616 int x0
, x1
, y0
, y1
;
29618 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29621 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29624 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
29627 if (!WINDOW_LEFTMOST_P (w
)
29628 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
29630 int x0
, x1
, y0
, y1
;
29632 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29635 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29638 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
29643 /* Draw window dividers for window W. */
29646 x_draw_right_divider (struct window
*w
)
29648 struct frame
*f
= WINDOW_XFRAME (w
);
29650 if (w
->mini
|| w
->pseudo_window_p
)
29652 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
29654 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
29655 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29656 int y0
= WINDOW_TOP_EDGE_Y (w
);
29657 /* The bottom divider prevails. */
29658 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29660 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29665 x_draw_bottom_divider (struct window
*w
)
29667 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29669 if (w
->mini
|| w
->pseudo_window_p
)
29671 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
29673 int x0
= WINDOW_LEFT_EDGE_X (w
);
29674 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29675 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29676 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
29678 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29682 /* Redraw the part of window W intersection rectangle FR. Pixel
29683 coordinates in FR are frame-relative. Call this function with
29684 input blocked. Value is non-zero if the exposure overwrites
29688 expose_window (struct window
*w
, XRectangle
*fr
)
29690 struct frame
*f
= XFRAME (w
->frame
);
29692 int mouse_face_overwritten_p
= 0;
29694 /* If window is not yet fully initialized, do nothing. This can
29695 happen when toolkit scroll bars are used and a window is split.
29696 Reconfiguring the scroll bar will generate an expose for a newly
29698 if (w
->current_matrix
== NULL
)
29701 /* When we're currently updating the window, display and current
29702 matrix usually don't agree. Arrange for a thorough display
29704 if (w
->must_be_updated_p
)
29706 SET_FRAME_GARBAGED (f
);
29710 /* Frame-relative pixel rectangle of W. */
29711 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
29712 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
29713 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
29714 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
29716 if (x_intersect_rectangles (fr
, &wr
, &r
))
29718 int yb
= window_text_bottom_y (w
);
29719 struct glyph_row
*row
;
29720 int cursor_cleared_p
, phys_cursor_on_p
;
29721 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
29723 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
29724 r
.x
, r
.y
, r
.width
, r
.height
));
29726 /* Convert to window coordinates. */
29727 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
29728 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
29730 /* Turn off the cursor. */
29731 if (!w
->pseudo_window_p
29732 && phys_cursor_in_rect_p (w
, &r
))
29734 x_clear_cursor (w
);
29735 cursor_cleared_p
= 1;
29738 cursor_cleared_p
= 0;
29740 /* If the row containing the cursor extends face to end of line,
29741 then expose_area might overwrite the cursor outside the
29742 rectangle and thus notice_overwritten_cursor might clear
29743 w->phys_cursor_on_p. We remember the original value and
29744 check later if it is changed. */
29745 phys_cursor_on_p
= w
->phys_cursor_on_p
;
29747 /* Update lines intersecting rectangle R. */
29748 first_overlapping_row
= last_overlapping_row
= NULL
;
29749 for (row
= w
->current_matrix
->rows
;
29754 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
29756 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
29757 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
29758 || (r
.y
>= y0
&& r
.y
< y1
)
29759 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
29761 /* A header line may be overlapping, but there is no need
29762 to fix overlapping areas for them. KFS 2005-02-12 */
29763 if (row
->overlapping_p
&& !row
->mode_line_p
)
29765 if (first_overlapping_row
== NULL
)
29766 first_overlapping_row
= row
;
29767 last_overlapping_row
= row
;
29771 if (expose_line (w
, row
, &r
))
29772 mouse_face_overwritten_p
= 1;
29775 else if (row
->overlapping_p
)
29777 /* We must redraw a row overlapping the exposed area. */
29779 ? y0
+ row
->phys_height
> r
.y
29780 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
29782 if (first_overlapping_row
== NULL
)
29783 first_overlapping_row
= row
;
29784 last_overlapping_row
= row
;
29792 /* Display the mode line if there is one. */
29793 if (WINDOW_WANTS_MODELINE_P (w
)
29794 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
29796 && row
->y
< r
.y
+ r
.height
)
29798 if (expose_line (w
, row
, &r
))
29799 mouse_face_overwritten_p
= 1;
29802 if (!w
->pseudo_window_p
)
29804 /* Fix the display of overlapping rows. */
29805 if (first_overlapping_row
)
29806 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
29809 /* Draw border between windows. */
29810 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
29811 x_draw_right_divider (w
);
29813 x_draw_vertical_border (w
);
29815 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
29816 x_draw_bottom_divider (w
);
29818 /* Turn the cursor on again. */
29819 if (cursor_cleared_p
29820 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
29821 update_window_cursor (w
, 1);
29825 return mouse_face_overwritten_p
;
29830 /* Redraw (parts) of all windows in the window tree rooted at W that
29831 intersect R. R contains frame pixel coordinates. Value is
29832 non-zero if the exposure overwrites mouse-face. */
29835 expose_window_tree (struct window
*w
, XRectangle
*r
)
29837 struct frame
*f
= XFRAME (w
->frame
);
29838 int mouse_face_overwritten_p
= 0;
29840 while (w
&& !FRAME_GARBAGED_P (f
))
29842 if (WINDOWP (w
->contents
))
29843 mouse_face_overwritten_p
29844 |= expose_window_tree (XWINDOW (w
->contents
), r
);
29846 mouse_face_overwritten_p
|= expose_window (w
, r
);
29848 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
29851 return mouse_face_overwritten_p
;
29856 Redisplay an exposed area of frame F. X and Y are the upper-left
29857 corner of the exposed rectangle. W and H are width and height of
29858 the exposed area. All are pixel values. W or H zero means redraw
29859 the entire frame. */
29862 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
29865 int mouse_face_overwritten_p
= 0;
29867 TRACE ((stderr
, "expose_frame "));
29869 /* No need to redraw if frame will be redrawn soon. */
29870 if (FRAME_GARBAGED_P (f
))
29872 TRACE ((stderr
, " garbaged\n"));
29876 /* If basic faces haven't been realized yet, there is no point in
29877 trying to redraw anything. This can happen when we get an expose
29878 event while Emacs is starting, e.g. by moving another window. */
29879 if (FRAME_FACE_CACHE (f
) == NULL
29880 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
29882 TRACE ((stderr
, " no faces\n"));
29886 if (w
== 0 || h
== 0)
29889 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
29890 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
29900 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
29901 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
29903 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
29904 if (WINDOWP (f
->tool_bar_window
))
29905 mouse_face_overwritten_p
29906 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
29909 #ifdef HAVE_X_WINDOWS
29911 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
29912 if (WINDOWP (f
->menu_bar_window
))
29913 mouse_face_overwritten_p
29914 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
29915 #endif /* not USE_X_TOOLKIT and not USE_GTK */
29919 /* Some window managers support a focus-follows-mouse style with
29920 delayed raising of frames. Imagine a partially obscured frame,
29921 and moving the mouse into partially obscured mouse-face on that
29922 frame. The visible part of the mouse-face will be highlighted,
29923 then the WM raises the obscured frame. With at least one WM, KDE
29924 2.1, Emacs is not getting any event for the raising of the frame
29925 (even tried with SubstructureRedirectMask), only Expose events.
29926 These expose events will draw text normally, i.e. not
29927 highlighted. Which means we must redo the highlight here.
29928 Subsume it under ``we love X''. --gerd 2001-08-15 */
29929 /* Included in Windows version because Windows most likely does not
29930 do the right thing if any third party tool offers
29931 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
29932 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
29934 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29935 if (f
== hlinfo
->mouse_face_mouse_frame
)
29937 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
29938 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
29939 clear_mouse_face (hlinfo
);
29940 note_mouse_highlight (f
, mouse_x
, mouse_y
);
29947 Determine the intersection of two rectangles R1 and R2. Return
29948 the intersection in *RESULT. Value is non-zero if RESULT is not
29952 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
29954 XRectangle
*left
, *right
;
29955 XRectangle
*upper
, *lower
;
29956 int intersection_p
= 0;
29958 /* Rearrange so that R1 is the left-most rectangle. */
29960 left
= r1
, right
= r2
;
29962 left
= r2
, right
= r1
;
29964 /* X0 of the intersection is right.x0, if this is inside R1,
29965 otherwise there is no intersection. */
29966 if (right
->x
<= left
->x
+ left
->width
)
29968 result
->x
= right
->x
;
29970 /* The right end of the intersection is the minimum of
29971 the right ends of left and right. */
29972 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
29975 /* Same game for Y. */
29977 upper
= r1
, lower
= r2
;
29979 upper
= r2
, lower
= r1
;
29981 /* The upper end of the intersection is lower.y0, if this is inside
29982 of upper. Otherwise, there is no intersection. */
29983 if (lower
->y
<= upper
->y
+ upper
->height
)
29985 result
->y
= lower
->y
;
29987 /* The lower end of the intersection is the minimum of the lower
29988 ends of upper and lower. */
29989 result
->height
= (min (lower
->y
+ lower
->height
,
29990 upper
->y
+ upper
->height
)
29992 intersection_p
= 1;
29996 return intersection_p
;
29999 #endif /* HAVE_WINDOW_SYSTEM */
30002 /***********************************************************************
30004 ***********************************************************************/
30007 syms_of_xdisp (void)
30009 Vwith_echo_area_save_vector
= Qnil
;
30010 staticpro (&Vwith_echo_area_save_vector
);
30012 Vmessage_stack
= Qnil
;
30013 staticpro (&Vmessage_stack
);
30015 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30016 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30018 message_dolog_marker1
= Fmake_marker ();
30019 staticpro (&message_dolog_marker1
);
30020 message_dolog_marker2
= Fmake_marker ();
30021 staticpro (&message_dolog_marker2
);
30022 message_dolog_marker3
= Fmake_marker ();
30023 staticpro (&message_dolog_marker3
);
30026 defsubr (&Sdump_frame_glyph_matrix
);
30027 defsubr (&Sdump_glyph_matrix
);
30028 defsubr (&Sdump_glyph_row
);
30029 defsubr (&Sdump_tool_bar_row
);
30030 defsubr (&Strace_redisplay
);
30031 defsubr (&Strace_to_stderr
);
30033 #ifdef HAVE_WINDOW_SYSTEM
30034 defsubr (&Stool_bar_height
);
30035 defsubr (&Slookup_image_map
);
30037 defsubr (&Sline_pixel_height
);
30038 defsubr (&Sformat_mode_line
);
30039 defsubr (&Sinvisible_p
);
30040 defsubr (&Scurrent_bidi_paragraph_direction
);
30041 defsubr (&Swindow_text_pixel_size
);
30042 defsubr (&Smove_point_visually
);
30044 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30045 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30046 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30047 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30048 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30049 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30050 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30051 DEFSYM (Qeval
, "eval");
30052 DEFSYM (QCdata
, ":data");
30053 DEFSYM (Qdisplay
, "display");
30054 DEFSYM (Qspace_width
, "space-width");
30055 DEFSYM (Qraise
, "raise");
30056 DEFSYM (Qslice
, "slice");
30057 DEFSYM (Qspace
, "space");
30058 DEFSYM (Qmargin
, "margin");
30059 DEFSYM (Qpointer
, "pointer");
30060 DEFSYM (Qleft_margin
, "left-margin");
30061 DEFSYM (Qright_margin
, "right-margin");
30062 DEFSYM (Qcenter
, "center");
30063 DEFSYM (Qline_height
, "line-height");
30064 DEFSYM (QCalign_to
, ":align-to");
30065 DEFSYM (QCrelative_width
, ":relative-width");
30066 DEFSYM (QCrelative_height
, ":relative-height");
30067 DEFSYM (QCeval
, ":eval");
30068 DEFSYM (QCpropertize
, ":propertize");
30069 DEFSYM (QCfile
, ":file");
30070 DEFSYM (Qfontified
, "fontified");
30071 DEFSYM (Qfontification_functions
, "fontification-functions");
30072 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30073 DEFSYM (Qescape_glyph
, "escape-glyph");
30074 DEFSYM (Qnobreak_space
, "nobreak-space");
30075 DEFSYM (Qimage
, "image");
30076 DEFSYM (Qtext
, "text");
30077 DEFSYM (Qboth
, "both");
30078 DEFSYM (Qboth_horiz
, "both-horiz");
30079 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30080 DEFSYM (QCmap
, ":map");
30081 DEFSYM (QCpointer
, ":pointer");
30082 DEFSYM (Qrect
, "rect");
30083 DEFSYM (Qcircle
, "circle");
30084 DEFSYM (Qpoly
, "poly");
30085 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
30086 DEFSYM (Qgrow_only
, "grow-only");
30087 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30088 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30089 DEFSYM (Qposition
, "position");
30090 DEFSYM (Qbuffer_position
, "buffer-position");
30091 DEFSYM (Qobject
, "object");
30092 DEFSYM (Qbar
, "bar");
30093 DEFSYM (Qhbar
, "hbar");
30094 DEFSYM (Qbox
, "box");
30095 DEFSYM (Qhollow
, "hollow");
30096 DEFSYM (Qhand
, "hand");
30097 DEFSYM (Qarrow
, "arrow");
30098 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30100 list_of_error
= list1 (list2 (intern_c_string ("error"),
30101 intern_c_string ("void-variable")));
30102 staticpro (&list_of_error
);
30104 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30105 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30106 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30107 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30109 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30110 staticpro (&echo_buffer
[0]);
30111 staticpro (&echo_buffer
[1]);
30113 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30114 staticpro (&echo_area_buffer
[0]);
30115 staticpro (&echo_area_buffer
[1]);
30117 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30118 staticpro (&Vmessages_buffer_name
);
30120 mode_line_proptrans_alist
= Qnil
;
30121 staticpro (&mode_line_proptrans_alist
);
30122 mode_line_string_list
= Qnil
;
30123 staticpro (&mode_line_string_list
);
30124 mode_line_string_face
= Qnil
;
30125 staticpro (&mode_line_string_face
);
30126 mode_line_string_face_prop
= Qnil
;
30127 staticpro (&mode_line_string_face_prop
);
30128 Vmode_line_unwind_vector
= Qnil
;
30129 staticpro (&Vmode_line_unwind_vector
);
30131 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30133 help_echo_string
= Qnil
;
30134 staticpro (&help_echo_string
);
30135 help_echo_object
= Qnil
;
30136 staticpro (&help_echo_object
);
30137 help_echo_window
= Qnil
;
30138 staticpro (&help_echo_window
);
30139 previous_help_echo_string
= Qnil
;
30140 staticpro (&previous_help_echo_string
);
30141 help_echo_pos
= -1;
30143 DEFSYM (Qright_to_left
, "right-to-left");
30144 DEFSYM (Qleft_to_right
, "left-to-right");
30146 #ifdef HAVE_WINDOW_SYSTEM
30147 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30148 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30149 For example, if a block cursor is over a tab, it will be drawn as
30150 wide as that tab on the display. */);
30151 x_stretch_cursor_p
= 0;
30154 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30155 doc
: /* Non-nil means highlight trailing whitespace.
30156 The face used for trailing whitespace is `trailing-whitespace'. */);
30157 Vshow_trailing_whitespace
= Qnil
;
30159 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30160 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30161 If the value is t, Emacs highlights non-ASCII chars which have the
30162 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30163 or `escape-glyph' face respectively.
30165 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30166 U+2011 (non-breaking hyphen) are affected.
30168 Any other non-nil value means to display these characters as a escape
30169 glyph followed by an ordinary space or hyphen.
30171 A value of nil means no special handling of these characters. */);
30172 Vnobreak_char_display
= Qt
;
30174 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30175 doc
: /* The pointer shape to show in void text areas.
30176 A value of nil means to show the text pointer. Other options are `arrow',
30177 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
30178 Vvoid_text_area_pointer
= Qarrow
;
30180 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30181 doc
: /* Non-nil means don't actually do any redisplay.
30182 This is used for internal purposes. */);
30183 Vinhibit_redisplay
= Qnil
;
30185 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30186 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30187 Vglobal_mode_string
= Qnil
;
30189 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30190 doc
: /* Marker for where to display an arrow on top of the buffer text.
30191 This must be the beginning of a line in order to work.
30192 See also `overlay-arrow-string'. */);
30193 Voverlay_arrow_position
= Qnil
;
30195 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30196 doc
: /* String to display as an arrow in non-window frames.
30197 See also `overlay-arrow-position'. */);
30198 Voverlay_arrow_string
= build_pure_c_string ("=>");
30200 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30201 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30202 The symbols on this list are examined during redisplay to determine
30203 where to display overlay arrows. */);
30204 Voverlay_arrow_variable_list
30205 = list1 (intern_c_string ("overlay-arrow-position"));
30207 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30208 doc
: /* The number of lines to try scrolling a window by when point moves out.
30209 If that fails to bring point back on frame, point is centered instead.
30210 If this is zero, point is always centered after it moves off frame.
30211 If you want scrolling to always be a line at a time, you should set
30212 `scroll-conservatively' to a large value rather than set this to 1. */);
30214 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30215 doc
: /* Scroll up to this many lines, to bring point back on screen.
30216 If point moves off-screen, redisplay will scroll by up to
30217 `scroll-conservatively' lines in order to bring point just barely
30218 onto the screen again. If that cannot be done, then redisplay
30219 recenters point as usual.
30221 If the value is greater than 100, redisplay will never recenter point,
30222 but will always scroll just enough text to bring point into view, even
30223 if you move far away.
30225 A value of zero means always recenter point if it moves off screen. */);
30226 scroll_conservatively
= 0;
30228 DEFVAR_INT ("scroll-margin", scroll_margin
,
30229 doc
: /* Number of lines of margin at the top and bottom of a window.
30230 Recenter the window whenever point gets within this many lines
30231 of the top or bottom of the window. */);
30234 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
30235 doc
: /* Pixels per inch value for non-window system displays.
30236 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30237 Vdisplay_pixels_per_inch
= make_float (72.0);
30240 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
30243 DEFVAR_LISP ("truncate-partial-width-windows",
30244 Vtruncate_partial_width_windows
,
30245 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
30246 For an integer value, truncate lines in each window narrower than the
30247 full frame width, provided the window width is less than that integer;
30248 otherwise, respect the value of `truncate-lines'.
30250 For any other non-nil value, truncate lines in all windows that do
30251 not span the full frame width.
30253 A value of nil means to respect the value of `truncate-lines'.
30255 If `word-wrap' is enabled, you might want to reduce this. */);
30256 Vtruncate_partial_width_windows
= make_number (50);
30258 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
30259 doc
: /* Maximum buffer size for which line number should be displayed.
30260 If the buffer is bigger than this, the line number does not appear
30261 in the mode line. A value of nil means no limit. */);
30262 Vline_number_display_limit
= Qnil
;
30264 DEFVAR_INT ("line-number-display-limit-width",
30265 line_number_display_limit_width
,
30266 doc
: /* Maximum line width (in characters) for line number display.
30267 If the average length of the lines near point is bigger than this, then the
30268 line number may be omitted from the mode line. */);
30269 line_number_display_limit_width
= 200;
30271 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
30272 doc
: /* Non-nil means highlight region even in nonselected windows. */);
30273 highlight_nonselected_windows
= 0;
30275 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
30276 doc
: /* Non-nil if more than one frame is visible on this display.
30277 Minibuffer-only frames don't count, but iconified frames do.
30278 This variable is not guaranteed to be accurate except while processing
30279 `frame-title-format' and `icon-title-format'. */);
30281 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
30282 doc
: /* Template for displaying the title bar of visible frames.
30283 \(Assuming the window manager supports this feature.)
30285 This variable has the same structure as `mode-line-format', except that
30286 the %c and %l constructs are ignored. It is used only on frames for
30287 which no explicit name has been set \(see `modify-frame-parameters'). */);
30289 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
30290 doc
: /* Template for displaying the title bar of an iconified frame.
30291 \(Assuming the window manager supports this feature.)
30292 This variable has the same structure as `mode-line-format' (which see),
30293 and is used only on frames for which no explicit name has been set
30294 \(see `modify-frame-parameters'). */);
30296 = Vframe_title_format
30297 = listn (CONSTYPE_PURE
, 3,
30298 intern_c_string ("multiple-frames"),
30299 build_pure_c_string ("%b"),
30300 listn (CONSTYPE_PURE
, 4,
30301 empty_unibyte_string
,
30302 intern_c_string ("invocation-name"),
30303 build_pure_c_string ("@"),
30304 intern_c_string ("system-name")));
30306 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
30307 doc
: /* Maximum number of lines to keep in the message log buffer.
30308 If nil, disable message logging. If t, log messages but don't truncate
30309 the buffer when it becomes large. */);
30310 Vmessage_log_max
= make_number (1000);
30312 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
30313 doc
: /* Functions called before redisplay, if window sizes have changed.
30314 The value should be a list of functions that take one argument.
30315 Just before redisplay, for each frame, if any of its windows have changed
30316 size since the last redisplay, or have been split or deleted,
30317 all the functions in the list are called, with the frame as argument. */);
30318 Vwindow_size_change_functions
= Qnil
;
30320 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
30321 doc
: /* List of functions to call before redisplaying a window with scrolling.
30322 Each function is called with two arguments, the window and its new
30323 display-start position. Note that these functions are also called by
30324 `set-window-buffer'. Also note that the value of `window-end' is not
30325 valid when these functions are called.
30327 Warning: Do not use this feature to alter the way the window
30328 is scrolled. It is not designed for that, and such use probably won't
30330 Vwindow_scroll_functions
= Qnil
;
30332 DEFVAR_LISP ("window-text-change-functions",
30333 Vwindow_text_change_functions
,
30334 doc
: /* Functions to call in redisplay when text in the window might change. */);
30335 Vwindow_text_change_functions
= Qnil
;
30337 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
30338 doc
: /* Functions called when redisplay of a window reaches the end trigger.
30339 Each function is called with two arguments, the window and the end trigger value.
30340 See `set-window-redisplay-end-trigger'. */);
30341 Vredisplay_end_trigger_functions
= Qnil
;
30343 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
30344 doc
: /* Non-nil means autoselect window with mouse pointer.
30345 If nil, do not autoselect windows.
30346 A positive number means delay autoselection by that many seconds: a
30347 window is autoselected only after the mouse has remained in that
30348 window for the duration of the delay.
30349 A negative number has a similar effect, but causes windows to be
30350 autoselected only after the mouse has stopped moving. \(Because of
30351 the way Emacs compares mouse events, you will occasionally wait twice
30352 that time before the window gets selected.\)
30353 Any other value means to autoselect window instantaneously when the
30354 mouse pointer enters it.
30356 Autoselection selects the minibuffer only if it is active, and never
30357 unselects the minibuffer if it is active.
30359 When customizing this variable make sure that the actual value of
30360 `focus-follows-mouse' matches the behavior of your window manager. */);
30361 Vmouse_autoselect_window
= Qnil
;
30363 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
30364 doc
: /* Non-nil means automatically resize tool-bars.
30365 This dynamically changes the tool-bar's height to the minimum height
30366 that is needed to make all tool-bar items visible.
30367 If value is `grow-only', the tool-bar's height is only increased
30368 automatically; to decrease the tool-bar height, use \\[recenter]. */);
30369 Vauto_resize_tool_bars
= Qt
;
30371 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
30372 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
30373 auto_raise_tool_bar_buttons_p
= 1;
30375 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
30376 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
30377 make_cursor_line_fully_visible_p
= 1;
30379 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
30380 doc
: /* Border below tool-bar in pixels.
30381 If an integer, use it as the height of the border.
30382 If it is one of `internal-border-width' or `border-width', use the
30383 value of the corresponding frame parameter.
30384 Otherwise, no border is added below the tool-bar. */);
30385 Vtool_bar_border
= Qinternal_border_width
;
30387 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
30388 doc
: /* Margin around tool-bar buttons in pixels.
30389 If an integer, use that for both horizontal and vertical margins.
30390 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
30391 HORZ specifying the horizontal margin, and VERT specifying the
30392 vertical margin. */);
30393 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
30395 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
30396 doc
: /* Relief thickness of tool-bar buttons. */);
30397 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
30399 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
30400 doc
: /* Tool bar style to use.
30402 image - show images only
30403 text - show text only
30404 both - show both, text below image
30405 both-horiz - show text to the right of the image
30406 text-image-horiz - show text to the left of the image
30407 any other - use system default or image if no system default.
30409 This variable only affects the GTK+ toolkit version of Emacs. */);
30410 Vtool_bar_style
= Qnil
;
30412 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
30413 doc
: /* Maximum number of characters a label can have to be shown.
30414 The tool bar style must also show labels for this to have any effect, see
30415 `tool-bar-style'. */);
30416 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
30418 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
30419 doc
: /* List of functions to call to fontify regions of text.
30420 Each function is called with one argument POS. Functions must
30421 fontify a region starting at POS in the current buffer, and give
30422 fontified regions the property `fontified'. */);
30423 Vfontification_functions
= Qnil
;
30424 Fmake_variable_buffer_local (Qfontification_functions
);
30426 DEFVAR_BOOL ("unibyte-display-via-language-environment",
30427 unibyte_display_via_language_environment
,
30428 doc
: /* Non-nil means display unibyte text according to language environment.
30429 Specifically, this means that raw bytes in the range 160-255 decimal
30430 are displayed by converting them to the equivalent multibyte characters
30431 according to the current language environment. As a result, they are
30432 displayed according to the current fontset.
30434 Note that this variable affects only how these bytes are displayed,
30435 but does not change the fact they are interpreted as raw bytes. */);
30436 unibyte_display_via_language_environment
= 0;
30438 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
30439 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
30440 If a float, it specifies a fraction of the mini-window frame's height.
30441 If an integer, it specifies a number of lines. */);
30442 Vmax_mini_window_height
= make_float (0.25);
30444 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
30445 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
30446 A value of nil means don't automatically resize mini-windows.
30447 A value of t means resize them to fit the text displayed in them.
30448 A value of `grow-only', the default, means let mini-windows grow only;
30449 they return to their normal size when the minibuffer is closed, or the
30450 echo area becomes empty. */);
30451 Vresize_mini_windows
= Qgrow_only
;
30453 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
30454 doc
: /* Alist specifying how to blink the cursor off.
30455 Each element has the form (ON-STATE . OFF-STATE). Whenever the
30456 `cursor-type' frame-parameter or variable equals ON-STATE,
30457 comparing using `equal', Emacs uses OFF-STATE to specify
30458 how to blink it off. ON-STATE and OFF-STATE are values for
30459 the `cursor-type' frame parameter.
30461 If a frame's ON-STATE has no entry in this list,
30462 the frame's other specifications determine how to blink the cursor off. */);
30463 Vblink_cursor_alist
= Qnil
;
30465 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
30466 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
30467 If non-nil, windows are automatically scrolled horizontally to make
30468 point visible. */);
30469 automatic_hscrolling_p
= 1;
30470 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
30472 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
30473 doc
: /* How many columns away from the window edge point is allowed to get
30474 before automatic hscrolling will horizontally scroll the window. */);
30475 hscroll_margin
= 5;
30477 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
30478 doc
: /* How many columns to scroll the window when point gets too close to the edge.
30479 When point is less than `hscroll-margin' columns from the window
30480 edge, automatic hscrolling will scroll the window by the amount of columns
30481 determined by this variable. If its value is a positive integer, scroll that
30482 many columns. If it's a positive floating-point number, it specifies the
30483 fraction of the window's width to scroll. If it's nil or zero, point will be
30484 centered horizontally after the scroll. Any other value, including negative
30485 numbers, are treated as if the value were zero.
30487 Automatic hscrolling always moves point outside the scroll margin, so if
30488 point was more than scroll step columns inside the margin, the window will
30489 scroll more than the value given by the scroll step.
30491 Note that the lower bound for automatic hscrolling specified by `scroll-left'
30492 and `scroll-right' overrides this variable's effect. */);
30493 Vhscroll_step
= make_number (0);
30495 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
30496 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
30497 Bind this around calls to `message' to let it take effect. */);
30498 message_truncate_lines
= 0;
30500 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
30501 doc
: /* Normal hook run to update the menu bar definitions.
30502 Redisplay runs this hook before it redisplays the menu bar.
30503 This is used to update menus such as Buffers, whose contents depend on
30505 Vmenu_bar_update_hook
= Qnil
;
30507 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
30508 doc
: /* Frame for which we are updating a menu.
30509 The enable predicate for a menu binding should check this variable. */);
30510 Vmenu_updating_frame
= Qnil
;
30512 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
30513 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
30514 inhibit_menubar_update
= 0;
30516 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
30517 doc
: /* Prefix prepended to all continuation lines at display time.
30518 The value may be a string, an image, or a stretch-glyph; it is
30519 interpreted in the same way as the value of a `display' text property.
30521 This variable is overridden by any `wrap-prefix' text or overlay
30524 To add a prefix to non-continuation lines, use `line-prefix'. */);
30525 Vwrap_prefix
= Qnil
;
30526 DEFSYM (Qwrap_prefix
, "wrap-prefix");
30527 Fmake_variable_buffer_local (Qwrap_prefix
);
30529 DEFVAR_LISP ("line-prefix", Vline_prefix
,
30530 doc
: /* Prefix prepended to all non-continuation lines at display time.
30531 The value may be a string, an image, or a stretch-glyph; it is
30532 interpreted in the same way as the value of a `display' text property.
30534 This variable is overridden by any `line-prefix' text or overlay
30537 To add a prefix to continuation lines, use `wrap-prefix'. */);
30538 Vline_prefix
= Qnil
;
30539 DEFSYM (Qline_prefix
, "line-prefix");
30540 Fmake_variable_buffer_local (Qline_prefix
);
30542 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
30543 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
30544 inhibit_eval_during_redisplay
= 0;
30546 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
30547 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
30548 inhibit_free_realized_faces
= 0;
30551 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
30552 doc
: /* Inhibit try_window_id display optimization. */);
30553 inhibit_try_window_id
= 0;
30555 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
30556 doc
: /* Inhibit try_window_reusing display optimization. */);
30557 inhibit_try_window_reusing
= 0;
30559 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
30560 doc
: /* Inhibit try_cursor_movement display optimization. */);
30561 inhibit_try_cursor_movement
= 0;
30562 #endif /* GLYPH_DEBUG */
30564 DEFVAR_INT ("overline-margin", overline_margin
,
30565 doc
: /* Space between overline and text, in pixels.
30566 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
30567 margin to the character height. */);
30568 overline_margin
= 2;
30570 DEFVAR_INT ("underline-minimum-offset",
30571 underline_minimum_offset
,
30572 doc
: /* Minimum distance between baseline and underline.
30573 This can improve legibility of underlined text at small font sizes,
30574 particularly when using variable `x-use-underline-position-properties'
30575 with fonts that specify an UNDERLINE_POSITION relatively close to the
30576 baseline. The default value is 1. */);
30577 underline_minimum_offset
= 1;
30579 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
30580 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
30581 This feature only works when on a window system that can change
30582 cursor shapes. */);
30583 display_hourglass_p
= 1;
30585 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
30586 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
30587 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
30589 #ifdef HAVE_WINDOW_SYSTEM
30590 hourglass_atimer
= NULL
;
30591 hourglass_shown_p
= 0;
30592 #endif /* HAVE_WINDOW_SYSTEM */
30594 DEFSYM (Qglyphless_char
, "glyphless-char");
30595 DEFSYM (Qhex_code
, "hex-code");
30596 DEFSYM (Qempty_box
, "empty-box");
30597 DEFSYM (Qthin_space
, "thin-space");
30598 DEFSYM (Qzero_width
, "zero-width");
30600 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
30601 doc
: /* Function run just before redisplay.
30602 It is called with one argument, which is the set of windows that are to
30603 be redisplayed. This set can be nil (meaning, only the selected window),
30604 or t (meaning all windows). */);
30605 Vpre_redisplay_function
= intern ("ignore");
30607 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
30608 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
30610 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
30611 doc
: /* Char-table defining glyphless characters.
30612 Each element, if non-nil, should be one of the following:
30613 an ASCII acronym string: display this string in a box
30614 `hex-code': display the hexadecimal code of a character in a box
30615 `empty-box': display as an empty box
30616 `thin-space': display as 1-pixel width space
30617 `zero-width': don't display
30618 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
30619 display method for graphical terminals and text terminals respectively.
30620 GRAPHICAL and TEXT should each have one of the values listed above.
30622 The char-table has one extra slot to control the display of a character for
30623 which no font is found. This slot only takes effect on graphical terminals.
30624 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
30625 `thin-space'. The default is `empty-box'.
30627 If a character has a non-nil entry in an active display table, the
30628 display table takes effect; in this case, Emacs does not consult
30629 `glyphless-char-display' at all. */);
30630 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
30631 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
30634 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
30635 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
30636 Vdebug_on_message
= Qnil
;
30638 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
30640 Vredisplay__all_windows_cause
30641 = Fmake_vector (make_number (100), make_number (0));
30643 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
30645 Vredisplay__mode_lines_cause
30646 = Fmake_vector (make_number (100), make_number (0));
30650 /* Initialize this module when Emacs starts. */
30655 CHARPOS (this_line_start_pos
) = 0;
30657 if (!noninteractive
)
30659 struct window
*m
= XWINDOW (minibuf_window
);
30660 Lisp_Object frame
= m
->frame
;
30661 struct frame
*f
= XFRAME (frame
);
30662 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
30663 struct window
*r
= XWINDOW (root
);
30666 echo_area_window
= minibuf_window
;
30668 r
->top_line
= FRAME_TOP_MARGIN (f
);
30669 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
30670 r
->total_cols
= FRAME_COLS (f
);
30671 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30672 r
->total_lines
= FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
30673 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
30675 m
->top_line
= FRAME_LINES (f
) - 1;
30676 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
30677 m
->total_cols
= FRAME_COLS (f
);
30678 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30679 m
->total_lines
= 1;
30680 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
30682 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
30683 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
30684 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
30686 /* The default ellipsis glyphs `...'. */
30687 for (i
= 0; i
< 3; ++i
)
30688 default_invis_vector
[i
] = make_number ('.');
30692 /* Allocate the buffer for frame titles.
30693 Also used for `format-mode-line'. */
30695 mode_line_noprop_buf
= xmalloc (size
);
30696 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
30697 mode_line_noprop_ptr
= mode_line_noprop_buf
;
30698 mode_line_target
= MODE_LINE_DISPLAY
;
30701 help_echo_showing_p
= 0;
30704 #ifdef HAVE_WINDOW_SYSTEM
30706 /* Platform-independent portion of hourglass implementation. */
30708 /* Cancel a currently active hourglass timer, and start a new one. */
30710 start_hourglass (void)
30712 struct timespec delay
;
30714 cancel_hourglass ();
30716 if (INTEGERP (Vhourglass_delay
)
30717 && XINT (Vhourglass_delay
) > 0)
30718 delay
= make_timespec (min (XINT (Vhourglass_delay
),
30719 TYPE_MAXIMUM (time_t)),
30721 else if (FLOATP (Vhourglass_delay
)
30722 && XFLOAT_DATA (Vhourglass_delay
) > 0)
30723 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
30725 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
30727 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
30728 show_hourglass
, NULL
);
30732 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
30735 cancel_hourglass (void)
30737 if (hourglass_atimer
)
30739 cancel_atimer (hourglass_atimer
);
30740 hourglass_atimer
= NULL
;
30743 if (hourglass_shown_p
)
30747 #endif /* HAVE_WINDOW_SYSTEM */