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_BYTE_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 set_iterator_to_next (it
, 0);
9257 it
->continuation_lines_width
+= it
->current_x
;
9264 /* Reset/increment for the next run. */
9265 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9266 it
->current_x
= line_start_x
;
9269 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9271 last_height
= it
->max_ascent
+ it
->max_descent
;
9272 it
->max_ascent
= it
->max_descent
= 0;
9277 /* On text terminals, we may stop at the end of a line in the middle
9278 of a multi-character glyph. If the glyph itself is continued,
9279 i.e. it is actually displayed on the next line, don't treat this
9280 stopping point as valid; move to the next line instead (unless
9281 that brings us offscreen). */
9282 if (!FRAME_WINDOW_P (it
->f
)
9284 && IT_CHARPOS (*it
) == to_charpos
9285 && it
->what
== IT_CHARACTER
9287 && it
->line_wrap
== WINDOW_WRAP
9288 && it
->current_x
== it
->last_visible_x
- 1
9291 && it
->vpos
< it
->w
->window_end_vpos
)
9293 it
->continuation_lines_width
+= it
->current_x
;
9294 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9295 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9297 last_height
= it
->max_ascent
+ it
->max_descent
;
9301 bidi_unshelve_cache (backup_data
, 1);
9303 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9305 return max_current_x
;
9309 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9311 If DY > 0, move IT backward at least that many pixels. DY = 0
9312 means move IT backward to the preceding line start or BEGV. This
9313 function may move over more than DY pixels if IT->current_y - DY
9314 ends up in the middle of a line; in this case IT->current_y will be
9315 set to the top of the line moved to. */
9318 move_it_vertically_backward (struct it
*it
, int dy
)
9322 void *it2data
= NULL
, *it3data
= NULL
;
9323 ptrdiff_t start_pos
;
9325 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9326 ptrdiff_t pos_limit
;
9331 start_pos
= IT_CHARPOS (*it
);
9333 /* Estimate how many newlines we must move back. */
9334 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9335 if (it
->line_wrap
== TRUNCATE
)
9338 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9340 /* Set the iterator's position that many lines back. But don't go
9341 back more than NLINES full screen lines -- this wins a day with
9342 buffers which have very long lines. */
9343 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9344 back_to_previous_visible_line_start (it
);
9346 /* Reseat the iterator here. When moving backward, we don't want
9347 reseat to skip forward over invisible text, set up the iterator
9348 to deliver from overlay strings at the new position etc. So,
9349 use reseat_1 here. */
9350 reseat_1 (it
, it
->current
.pos
, 1);
9352 /* We are now surely at a line start. */
9353 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9354 reordering is in effect. */
9355 it
->continuation_lines_width
= 0;
9357 /* Move forward and see what y-distance we moved. First move to the
9358 start of the next line so that we get its height. We need this
9359 height to be able to tell whether we reached the specified
9361 SAVE_IT (it2
, *it
, it2data
);
9362 it2
.max_ascent
= it2
.max_descent
= 0;
9365 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9366 MOVE_TO_POS
| MOVE_TO_VPOS
);
9368 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9369 /* If we are in a display string which starts at START_POS,
9370 and that display string includes a newline, and we are
9371 right after that newline (i.e. at the beginning of a
9372 display line), exit the loop, because otherwise we will
9373 infloop, since move_it_to will see that it is already at
9374 START_POS and will not move. */
9375 || (it2
.method
== GET_FROM_STRING
9376 && IT_CHARPOS (it2
) == start_pos
9377 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9378 eassert (IT_CHARPOS (*it
) >= BEGV
);
9379 SAVE_IT (it3
, it2
, it3data
);
9381 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9382 eassert (IT_CHARPOS (*it
) >= BEGV
);
9383 /* H is the actual vertical distance from the position in *IT
9384 and the starting position. */
9385 h
= it2
.current_y
- it
->current_y
;
9386 /* NLINES is the distance in number of lines. */
9387 nlines
= it2
.vpos
- it
->vpos
;
9389 /* Correct IT's y and vpos position
9390 so that they are relative to the starting point. */
9396 /* DY == 0 means move to the start of the screen line. The
9397 value of nlines is > 0 if continuation lines were involved,
9398 or if the original IT position was at start of a line. */
9399 RESTORE_IT (it
, it
, it2data
);
9401 move_it_by_lines (it
, nlines
);
9402 /* The above code moves us to some position NLINES down,
9403 usually to its first glyph (leftmost in an L2R line), but
9404 that's not necessarily the start of the line, under bidi
9405 reordering. We want to get to the character position
9406 that is immediately after the newline of the previous
9409 && !it
->continuation_lines_width
9410 && !STRINGP (it
->string
)
9411 && IT_CHARPOS (*it
) > BEGV
9412 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9414 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9417 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9418 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9420 bidi_unshelve_cache (it3data
, 1);
9424 /* The y-position we try to reach, relative to *IT.
9425 Note that H has been subtracted in front of the if-statement. */
9426 int target_y
= it
->current_y
+ h
- dy
;
9427 int y0
= it3
.current_y
;
9431 RESTORE_IT (&it3
, &it3
, it3data
);
9432 y1
= line_bottom_y (&it3
);
9433 line_height
= y1
- y0
;
9434 RESTORE_IT (it
, it
, it2data
);
9435 /* If we did not reach target_y, try to move further backward if
9436 we can. If we moved too far backward, try to move forward. */
9437 if (target_y
< it
->current_y
9438 /* This is heuristic. In a window that's 3 lines high, with
9439 a line height of 13 pixels each, recentering with point
9440 on the bottom line will try to move -39/2 = 19 pixels
9441 backward. Try to avoid moving into the first line. */
9442 && (it
->current_y
- target_y
9443 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9444 && IT_CHARPOS (*it
) > BEGV
)
9446 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9447 target_y
- it
->current_y
));
9448 dy
= it
->current_y
- target_y
;
9449 goto move_further_back
;
9451 else if (target_y
>= it
->current_y
+ line_height
9452 && IT_CHARPOS (*it
) < ZV
)
9454 /* Should move forward by at least one line, maybe more.
9456 Note: Calling move_it_by_lines can be expensive on
9457 terminal frames, where compute_motion is used (via
9458 vmotion) to do the job, when there are very long lines
9459 and truncate-lines is nil. That's the reason for
9460 treating terminal frames specially here. */
9462 if (!FRAME_WINDOW_P (it
->f
))
9463 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9468 move_it_by_lines (it
, 1);
9470 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9477 /* Move IT by a specified amount of pixel lines DY. DY negative means
9478 move backwards. DY = 0 means move to start of screen line. At the
9479 end, IT will be on the start of a screen line. */
9482 move_it_vertically (struct it
*it
, int dy
)
9485 move_it_vertically_backward (it
, -dy
);
9488 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9489 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9490 MOVE_TO_POS
| MOVE_TO_Y
);
9491 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9493 /* If buffer ends in ZV without a newline, move to the start of
9494 the line to satisfy the post-condition. */
9495 if (IT_CHARPOS (*it
) == ZV
9497 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9498 move_it_by_lines (it
, 0);
9503 /* Move iterator IT past the end of the text line it is in. */
9506 move_it_past_eol (struct it
*it
)
9508 enum move_it_result rc
;
9510 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9511 if (rc
== MOVE_NEWLINE_OR_CR
)
9512 set_iterator_to_next (it
, 0);
9516 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9517 negative means move up. DVPOS == 0 means move to the start of the
9520 Optimization idea: If we would know that IT->f doesn't use
9521 a face with proportional font, we could be faster for
9522 truncate-lines nil. */
9525 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9528 /* The commented-out optimization uses vmotion on terminals. This
9529 gives bad results, because elements like it->what, on which
9530 callers such as pos_visible_p rely, aren't updated. */
9531 /* struct position pos;
9532 if (!FRAME_WINDOW_P (it->f))
9534 struct text_pos textpos;
9536 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9537 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9538 reseat (it, textpos, 1);
9539 it->vpos += pos.vpos;
9540 it->current_y += pos.vpos;
9546 /* DVPOS == 0 means move to the start of the screen line. */
9547 move_it_vertically_backward (it
, 0);
9548 /* Let next call to line_bottom_y calculate real line height. */
9553 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9554 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9556 /* Only move to the next buffer position if we ended up in a
9557 string from display property, not in an overlay string
9558 (before-string or after-string). That is because the
9559 latter don't conceal the underlying buffer position, so
9560 we can ask to move the iterator to the exact position we
9561 are interested in. Note that, even if we are already at
9562 IT_CHARPOS (*it), the call below is not a no-op, as it
9563 will detect that we are at the end of the string, pop the
9564 iterator, and compute it->current_x and it->hpos
9566 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9567 -1, -1, -1, MOVE_TO_POS
);
9573 void *it2data
= NULL
;
9574 ptrdiff_t start_charpos
, i
;
9576 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9577 bool hit_pos_limit
= false;
9578 ptrdiff_t pos_limit
;
9580 /* Start at the beginning of the screen line containing IT's
9581 position. This may actually move vertically backwards,
9582 in case of overlays, so adjust dvpos accordingly. */
9584 move_it_vertically_backward (it
, 0);
9587 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9588 screen lines, and reseat the iterator there. */
9589 start_charpos
= IT_CHARPOS (*it
);
9590 if (it
->line_wrap
== TRUNCATE
)
9593 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9595 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9596 back_to_previous_visible_line_start (it
);
9597 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9598 hit_pos_limit
= true;
9599 reseat (it
, it
->current
.pos
, 1);
9601 /* Move further back if we end up in a string or an image. */
9602 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9604 /* First try to move to start of display line. */
9606 move_it_vertically_backward (it
, 0);
9608 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9610 /* If start of line is still in string or image,
9611 move further back. */
9612 back_to_previous_visible_line_start (it
);
9613 reseat (it
, it
->current
.pos
, 1);
9617 it
->current_x
= it
->hpos
= 0;
9619 /* Above call may have moved too far if continuation lines
9620 are involved. Scan forward and see if it did. */
9621 SAVE_IT (it2
, *it
, it2data
);
9622 it2
.vpos
= it2
.current_y
= 0;
9623 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9624 it
->vpos
-= it2
.vpos
;
9625 it
->current_y
-= it2
.current_y
;
9626 it
->current_x
= it
->hpos
= 0;
9628 /* If we moved too far back, move IT some lines forward. */
9629 if (it2
.vpos
> -dvpos
)
9631 int delta
= it2
.vpos
+ dvpos
;
9633 RESTORE_IT (&it2
, &it2
, it2data
);
9634 SAVE_IT (it2
, *it
, it2data
);
9635 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9636 /* Move back again if we got too far ahead. */
9637 if (IT_CHARPOS (*it
) >= start_charpos
)
9638 RESTORE_IT (it
, &it2
, it2data
);
9640 bidi_unshelve_cache (it2data
, 1);
9642 else if (hit_pos_limit
&& pos_limit
> BEGV
9643 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9645 /* If we hit the limit, but still didn't make it far enough
9646 back, that means there's a display string with a newline
9647 covering a large chunk of text, and that caused
9648 back_to_previous_visible_line_start try to go too far.
9649 Punish those who commit such atrocities by going back
9650 until we've reached DVPOS, after lifting the limit, which
9651 could make it slow for very long lines. "If it hurts,
9654 RESTORE_IT (it
, it
, it2data
);
9655 for (i
= -dvpos
; i
> 0; --i
)
9657 back_to_previous_visible_line_start (it
);
9662 RESTORE_IT (it
, it
, it2data
);
9666 /* Return true if IT points into the middle of a display vector. */
9669 in_display_vector_p (struct it
*it
)
9671 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9672 && it
->current
.dpvec_index
> 0
9673 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9676 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9677 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9678 WINDOW must be a live window and defaults to the selected one. The
9679 return value is a cons of the maximum pixel-width of any text line and
9680 the maximum pixel-height of all text lines.
9682 The optional argument FROM, if non-nil, specifies the first text
9683 position and defaults to the minimum accessible position of the buffer.
9684 If FROM is t, use the minimum accessible position that is not a newline
9685 character. TO, if non-nil, specifies the last text position and
9686 defaults to the maximum accessible position of the buffer. If TO is t,
9687 use the maximum accessible position that is not a newline character.
9689 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9690 width that can be returned. X-LIMIT nil or omitted, means to use the
9691 pixel-width of WINDOW's body; use this if you do not intend to change
9692 the width of WINDOW. Use the maximum width WINDOW may assume if you
9693 intend to change WINDOW's width. In any case, text whose x-coordinate
9694 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9695 can take some time, it's always a good idea to make this argument as
9696 small as possible; in particular, if the buffer contains long lines that
9697 shall be truncated anyway.
9699 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9700 height that can be returned. Text lines whose y-coordinate is beyond
9701 Y-LIMIT are ignored. Since calculating the text height of a large
9702 buffer can take some time, it makes sense to specify this argument if
9703 the size of the buffer is unknown.
9705 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9706 include the height of the mode- or header-line of WINDOW in the return
9707 value. If it is either the symbol `mode-line' or `header-line', include
9708 only the height of that line, if present, in the return value. If t,
9709 include the height of both, if present, in the return value. */)
9710 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
, Lisp_Object y_limit
,
9711 Lisp_Object mode_and_header_line
)
9713 struct window
*w
= decode_live_window (window
);
9717 struct buffer
*old_buffer
= NULL
;
9718 ptrdiff_t start
, end
, pos
;
9719 struct text_pos startp
;
9720 void *itdata
= NULL
;
9721 int c
, max_y
= -1, x
= 0, y
= 0;
9727 if (b
!= current_buffer
)
9729 old_buffer
= current_buffer
;
9730 set_buffer_internal (b
);
9735 else if (EQ (from
, Qt
))
9738 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9739 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9741 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9746 CHECK_NUMBER_COERCE_MARKER (from
);
9747 start
= min (max (XINT (from
), BEGV
), ZV
);
9752 else if (EQ (to
, Qt
))
9755 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9756 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9758 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9763 CHECK_NUMBER_COERCE_MARKER (to
);
9764 end
= max (start
, min (XINT (to
), ZV
));
9767 if (!NILP (y_limit
))
9769 CHECK_NUMBER (y_limit
);
9770 max_y
= min (XINT (y_limit
), INT_MAX
);
9773 itdata
= bidi_shelve_cache ();
9774 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9775 start_display (&it
, w
, startp
);
9778 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9781 CHECK_NUMBER (x_limit
);
9782 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9783 /* Actually, we never want move_it_to stop at to_x. But to make
9784 sure that move_it_in_display_line_to always moves far enough,
9785 we set it to INT_MAX and specify MOVE_TO_X. */
9786 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9787 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9790 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9792 if (!EQ (mode_and_header_line
, Qheader_line
)
9793 && !EQ (mode_and_header_line
, Qt
))
9794 /* Do not count the header-line which was counted automatically by
9796 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9798 if (EQ (mode_and_header_line
, Qmode_line
)
9799 || EQ (mode_and_header_line
, Qt
))
9800 /* Do count the mode-line which is not included automatically by
9802 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9804 bidi_unshelve_cache (itdata
, 0);
9807 set_buffer_internal (old_buffer
);
9809 return Fcons (make_number (x
), make_number (y
));
9812 /***********************************************************************
9814 ***********************************************************************/
9817 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9821 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9823 Lisp_Object args
[3];
9824 Lisp_Object msg
, fmt
;
9827 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9831 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9833 args
[0] = fmt
= build_string (format
);
9836 msg
= Fformat (3, args
);
9838 len
= SBYTES (msg
) + 1;
9839 buffer
= SAFE_ALLOCA (len
);
9840 memcpy (buffer
, SDATA (msg
), len
);
9842 message_dolog (buffer
, len
- 1, 1, 0);
9849 /* Output a newline in the *Messages* buffer if "needs" one. */
9852 message_log_maybe_newline (void)
9854 if (message_log_need_newline
)
9855 message_dolog ("", 0, 1, 0);
9859 /* Add a string M of length NBYTES to the message log, optionally
9860 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9861 true, means interpret the contents of M as multibyte. This
9862 function calls low-level routines in order to bypass text property
9863 hooks, etc. which might not be safe to run.
9865 This may GC (insert may run before/after change hooks),
9866 so the buffer M must NOT point to a Lisp string. */
9869 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9871 const unsigned char *msg
= (const unsigned char *) m
;
9873 if (!NILP (Vmemory_full
))
9876 if (!NILP (Vmessage_log_max
))
9878 struct buffer
*oldbuf
;
9879 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9880 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9881 ptrdiff_t point_at_end
= 0;
9882 ptrdiff_t zv_at_end
= 0;
9883 Lisp_Object old_deactivate_mark
;
9884 struct gcpro gcpro1
;
9886 old_deactivate_mark
= Vdeactivate_mark
;
9887 oldbuf
= current_buffer
;
9889 /* Ensure the Messages buffer exists, and switch to it.
9890 If we created it, set the major-mode. */
9893 if (NILP (Fget_buffer (Vmessages_buffer_name
))) newbuffer
= 1;
9895 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9898 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9899 call0 (intern ("messages-buffer-mode"));
9902 bset_undo_list (current_buffer
, Qt
);
9903 bset_cache_long_scans (current_buffer
, Qnil
);
9905 oldpoint
= message_dolog_marker1
;
9906 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9907 oldbegv
= message_dolog_marker2
;
9908 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
9909 oldzv
= message_dolog_marker3
;
9910 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
9911 GCPRO1 (old_deactivate_mark
);
9919 BEGV_BYTE
= BEG_BYTE
;
9922 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9924 /* Insert the string--maybe converting multibyte to single byte
9925 or vice versa, so that all the text fits the buffer. */
9927 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9933 /* Convert a multibyte string to single-byte
9934 for the *Message* buffer. */
9935 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9937 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9938 work
[0] = (ASCII_CHAR_P (c
)
9940 : multibyte_char_to_unibyte (c
));
9941 insert_1_both (work
, 1, 1, 1, 0, 0);
9944 else if (! multibyte
9945 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9949 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9950 /* Convert a single-byte string to multibyte
9951 for the *Message* buffer. */
9952 for (i
= 0; i
< nbytes
; i
++)
9955 MAKE_CHAR_MULTIBYTE (c
);
9956 char_bytes
= CHAR_STRING (c
, str
);
9957 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9961 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
, 1, 0, 0);
9965 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9968 insert_1_both ("\n", 1, 1, 1, 0, 0);
9970 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9972 this_bol_byte
= PT_BYTE
;
9974 /* See if this line duplicates the previous one.
9975 If so, combine duplicates. */
9978 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9980 prev_bol_byte
= PT_BYTE
;
9982 dups
= message_log_check_duplicate (prev_bol_byte
,
9986 del_range_both (prev_bol
, prev_bol_byte
,
9987 this_bol
, this_bol_byte
, 0);
9990 char dupstr
[sizeof " [ times]"
9991 + INT_STRLEN_BOUND (printmax_t
)];
9993 /* If you change this format, don't forget to also
9994 change message_log_check_duplicate. */
9995 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
9996 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9997 insert_1_both (dupstr
, duplen
, duplen
, 1, 0, 1);
10002 /* If we have more than the desired maximum number of lines
10003 in the *Messages* buffer now, delete the oldest ones.
10004 This is safe because we don't have undo in this buffer. */
10006 if (NATNUMP (Vmessage_log_max
))
10008 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10009 -XFASTINT (Vmessage_log_max
) - 1, 0);
10010 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
10013 BEGV
= marker_position (oldbegv
);
10014 BEGV_BYTE
= marker_byte_position (oldbegv
);
10023 ZV
= marker_position (oldzv
);
10024 ZV_BYTE
= marker_byte_position (oldzv
);
10028 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10030 /* We can't do Fgoto_char (oldpoint) because it will run some
10032 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10033 marker_byte_position (oldpoint
));
10036 unchain_marker (XMARKER (oldpoint
));
10037 unchain_marker (XMARKER (oldbegv
));
10038 unchain_marker (XMARKER (oldzv
));
10040 /* We called insert_1_both above with its 5th argument (PREPARE)
10041 zero, which prevents insert_1_both from calling
10042 prepare_to_modify_buffer, which in turns prevents us from
10043 incrementing windows_or_buffers_changed even if *Messages* is
10044 shown in some window. So we must manually set
10045 windows_or_buffers_changed here to make up for that. */
10046 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10047 bset_redisplay (current_buffer
);
10049 set_buffer_internal (oldbuf
);
10051 message_log_need_newline
= !nlflag
;
10052 Vdeactivate_mark
= old_deactivate_mark
;
10057 /* We are at the end of the buffer after just having inserted a newline.
10058 (Note: We depend on the fact we won't be crossing the gap.)
10059 Check to see if the most recent message looks a lot like the previous one.
10060 Return 0 if different, 1 if the new one should just replace it, or a
10061 value N > 1 if we should also append " [N times]". */
10064 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10067 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10069 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10070 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10072 for (i
= 0; i
< len
; i
++)
10074 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10076 if (p1
[i
] != p2
[i
])
10082 if (*p1
++ == ' ' && *p1
++ == '[')
10085 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10086 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10093 /* Display an echo area message M with a specified length of NBYTES
10094 bytes. The string may include null characters. If M is not a
10095 string, clear out any existing message, and let the mini-buffer
10098 This function cancels echoing. */
10101 message3 (Lisp_Object m
)
10103 struct gcpro gcpro1
;
10106 clear_message (true, true);
10109 /* First flush out any partial line written with print. */
10110 message_log_maybe_newline ();
10113 ptrdiff_t nbytes
= SBYTES (m
);
10114 bool multibyte
= STRING_MULTIBYTE (m
);
10116 char *buffer
= SAFE_ALLOCA (nbytes
);
10117 memcpy (buffer
, SDATA (m
), nbytes
);
10118 message_dolog (buffer
, nbytes
, 1, multibyte
);
10121 message3_nolog (m
);
10127 /* The non-logging version of message3.
10128 This does not cancel echoing, because it is used for echoing.
10129 Perhaps we need to make a separate function for echoing
10130 and make this cancel echoing. */
10133 message3_nolog (Lisp_Object m
)
10135 struct frame
*sf
= SELECTED_FRAME ();
10137 if (FRAME_INITIAL_P (sf
))
10139 if (noninteractive_need_newline
)
10140 putc ('\n', stderr
);
10141 noninteractive_need_newline
= 0;
10144 Lisp_Object s
= ENCODE_SYSTEM (m
);
10146 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10148 if (cursor_in_echo_area
== 0)
10149 fprintf (stderr
, "\n");
10152 /* Error messages get reported properly by cmd_error, so this must be just an
10153 informative message; if the frame hasn't really been initialized yet, just
10155 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10157 /* Get the frame containing the mini-buffer
10158 that the selected frame is using. */
10159 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10160 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10161 struct frame
*f
= XFRAME (frame
);
10163 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10164 Fmake_frame_visible (frame
);
10166 if (STRINGP (m
) && SCHARS (m
) > 0)
10169 if (minibuffer_auto_raise
)
10170 Fraise_frame (frame
);
10171 /* Assume we are not echoing.
10172 (If we are, echo_now will override this.) */
10173 echo_message_buffer
= Qnil
;
10176 clear_message (true, true);
10178 do_pending_window_change (0);
10179 echo_area_display (1);
10180 do_pending_window_change (0);
10181 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10182 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10187 /* Display a null-terminated echo area message M. If M is 0, clear
10188 out any existing message, and let the mini-buffer text show through.
10190 The buffer M must continue to exist until after the echo area gets
10191 cleared or some other message gets displayed there. Do not pass
10192 text that is stored in a Lisp string. Do not pass text in a buffer
10193 that was alloca'd. */
10196 message1 (const char *m
)
10198 message3 (m
? build_unibyte_string (m
) : Qnil
);
10202 /* The non-logging counterpart of message1. */
10205 message1_nolog (const char *m
)
10207 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10210 /* Display a message M which contains a single %s
10211 which gets replaced with STRING. */
10214 message_with_string (const char *m
, Lisp_Object string
, int log
)
10216 CHECK_STRING (string
);
10218 if (noninteractive
)
10222 /* ENCODE_SYSTEM below can GC and/or relocate the Lisp
10223 String whose data pointer might be passed to us in M. So
10224 we use a local copy. */
10225 char *fmt
= xstrdup (m
);
10227 if (noninteractive_need_newline
)
10228 putc ('\n', stderr
);
10229 noninteractive_need_newline
= 0;
10230 fprintf (stderr
, fmt
, SDATA (ENCODE_SYSTEM (string
)));
10231 if (!cursor_in_echo_area
)
10232 fprintf (stderr
, "\n");
10237 else if (INTERACTIVE
)
10239 /* The frame whose minibuffer we're going to display the message on.
10240 It may be larger than the selected frame, so we need
10241 to use its buffer, not the selected frame's buffer. */
10242 Lisp_Object mini_window
;
10243 struct frame
*f
, *sf
= SELECTED_FRAME ();
10245 /* Get the frame containing the minibuffer
10246 that the selected frame is using. */
10247 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10248 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10250 /* Error messages get reported properly by cmd_error, so this must be
10251 just an informative message; if the frame hasn't really been
10252 initialized yet, just toss it. */
10253 if (f
->glyphs_initialized_p
)
10255 Lisp_Object args
[2], msg
;
10256 struct gcpro gcpro1
, gcpro2
;
10258 args
[0] = build_string (m
);
10259 args
[1] = msg
= string
;
10260 GCPRO2 (args
[0], msg
);
10263 msg
= Fformat (2, args
);
10268 message3_nolog (msg
);
10272 /* Print should start at the beginning of the message
10273 buffer next time. */
10274 message_buf_print
= 0;
10280 /* Dump an informative message to the minibuf. If M is 0, clear out
10281 any existing message, and let the mini-buffer text show through. */
10284 vmessage (const char *m
, va_list ap
)
10286 if (noninteractive
)
10290 if (noninteractive_need_newline
)
10291 putc ('\n', stderr
);
10292 noninteractive_need_newline
= 0;
10293 vfprintf (stderr
, m
, ap
);
10294 if (cursor_in_echo_area
== 0)
10295 fprintf (stderr
, "\n");
10299 else if (INTERACTIVE
)
10301 /* The frame whose mini-buffer we're going to display the message
10302 on. It may be larger than the selected frame, so we need to
10303 use its buffer, not the selected frame's buffer. */
10304 Lisp_Object mini_window
;
10305 struct frame
*f
, *sf
= SELECTED_FRAME ();
10307 /* Get the frame containing the mini-buffer
10308 that the selected frame is using. */
10309 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10310 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10312 /* Error messages get reported properly by cmd_error, so this must be
10313 just an informative message; if the frame hasn't really been
10314 initialized yet, just toss it. */
10315 if (f
->glyphs_initialized_p
)
10320 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10321 char *message_buf
= alloca (maxsize
+ 1);
10323 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10325 message3 (make_string (message_buf
, len
));
10330 /* Print should start at the beginning of the message
10331 buffer next time. */
10332 message_buf_print
= 0;
10338 message (const char *m
, ...)
10348 /* The non-logging version of message. */
10351 message_nolog (const char *m
, ...)
10353 Lisp_Object old_log_max
;
10356 old_log_max
= Vmessage_log_max
;
10357 Vmessage_log_max
= Qnil
;
10359 Vmessage_log_max
= old_log_max
;
10365 /* Display the current message in the current mini-buffer. This is
10366 only called from error handlers in process.c, and is not time
10370 update_echo_area (void)
10372 if (!NILP (echo_area_buffer
[0]))
10374 Lisp_Object string
;
10375 string
= Fcurrent_message ();
10381 /* Make sure echo area buffers in `echo_buffers' are live.
10382 If they aren't, make new ones. */
10385 ensure_echo_area_buffers (void)
10389 for (i
= 0; i
< 2; ++i
)
10390 if (!BUFFERP (echo_buffer
[i
])
10391 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10394 Lisp_Object old_buffer
;
10397 old_buffer
= echo_buffer
[i
];
10398 echo_buffer
[i
] = Fget_buffer_create
10399 (make_formatted_string (name
, " *Echo Area %d*", i
));
10400 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10401 /* to force word wrap in echo area -
10402 it was decided to postpone this*/
10403 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10405 for (j
= 0; j
< 2; ++j
)
10406 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10407 echo_area_buffer
[j
] = echo_buffer
[i
];
10412 /* Call FN with args A1..A2 with either the current or last displayed
10413 echo_area_buffer as current buffer.
10415 WHICH zero means use the current message buffer
10416 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10417 from echo_buffer[] and clear it.
10419 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10420 suitable buffer from echo_buffer[] and clear it.
10422 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10423 that the current message becomes the last displayed one, make
10424 choose a suitable buffer for echo_area_buffer[0], and clear it.
10426 Value is what FN returns. */
10429 with_echo_area_buffer (struct window
*w
, int which
,
10430 int (*fn
) (ptrdiff_t, Lisp_Object
),
10431 ptrdiff_t a1
, Lisp_Object a2
)
10433 Lisp_Object buffer
;
10434 int this_one
, the_other
, clear_buffer_p
, rc
;
10435 ptrdiff_t count
= SPECPDL_INDEX ();
10437 /* If buffers aren't live, make new ones. */
10438 ensure_echo_area_buffers ();
10440 clear_buffer_p
= 0;
10443 this_one
= 0, the_other
= 1;
10444 else if (which
> 0)
10445 this_one
= 1, the_other
= 0;
10448 this_one
= 0, the_other
= 1;
10449 clear_buffer_p
= true;
10451 /* We need a fresh one in case the current echo buffer equals
10452 the one containing the last displayed echo area message. */
10453 if (!NILP (echo_area_buffer
[this_one
])
10454 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10455 echo_area_buffer
[this_one
] = Qnil
;
10458 /* Choose a suitable buffer from echo_buffer[] is we don't
10460 if (NILP (echo_area_buffer
[this_one
]))
10462 echo_area_buffer
[this_one
]
10463 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10464 ? echo_buffer
[the_other
]
10465 : echo_buffer
[this_one
]);
10466 clear_buffer_p
= true;
10469 buffer
= echo_area_buffer
[this_one
];
10471 /* Don't get confused by reusing the buffer used for echoing
10472 for a different purpose. */
10473 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10476 record_unwind_protect (unwind_with_echo_area_buffer
,
10477 with_echo_area_buffer_unwind_data (w
));
10479 /* Make the echo area buffer current. Note that for display
10480 purposes, it is not necessary that the displayed window's buffer
10481 == current_buffer, except for text property lookup. So, let's
10482 only set that buffer temporarily here without doing a full
10483 Fset_window_buffer. We must also change w->pointm, though,
10484 because otherwise an assertions in unshow_buffer fails, and Emacs
10486 set_buffer_internal_1 (XBUFFER (buffer
));
10489 wset_buffer (w
, buffer
);
10490 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10493 bset_undo_list (current_buffer
, Qt
);
10494 bset_read_only (current_buffer
, Qnil
);
10495 specbind (Qinhibit_read_only
, Qt
);
10496 specbind (Qinhibit_modification_hooks
, Qt
);
10498 if (clear_buffer_p
&& Z
> BEG
)
10499 del_range (BEG
, Z
);
10501 eassert (BEGV
>= BEG
);
10502 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10506 eassert (BEGV
>= BEG
);
10507 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10509 unbind_to (count
, Qnil
);
10514 /* Save state that should be preserved around the call to the function
10515 FN called in with_echo_area_buffer. */
10518 with_echo_area_buffer_unwind_data (struct window
*w
)
10521 Lisp_Object vector
, tmp
;
10523 /* Reduce consing by keeping one vector in
10524 Vwith_echo_area_save_vector. */
10525 vector
= Vwith_echo_area_save_vector
;
10526 Vwith_echo_area_save_vector
= Qnil
;
10529 vector
= Fmake_vector (make_number (9), Qnil
);
10531 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10532 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10533 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10537 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10538 ASET (vector
, i
, w
->contents
); ++i
;
10539 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10540 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10541 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10542 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10547 for (; i
< end
; ++i
)
10548 ASET (vector
, i
, Qnil
);
10551 eassert (i
== ASIZE (vector
));
10556 /* Restore global state from VECTOR which was created by
10557 with_echo_area_buffer_unwind_data. */
10560 unwind_with_echo_area_buffer (Lisp_Object vector
)
10562 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10563 Vdeactivate_mark
= AREF (vector
, 1);
10564 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10566 if (WINDOWP (AREF (vector
, 3)))
10569 Lisp_Object buffer
;
10571 w
= XWINDOW (AREF (vector
, 3));
10572 buffer
= AREF (vector
, 4);
10574 wset_buffer (w
, buffer
);
10575 set_marker_both (w
->pointm
, buffer
,
10576 XFASTINT (AREF (vector
, 5)),
10577 XFASTINT (AREF (vector
, 6)));
10578 set_marker_both (w
->start
, buffer
,
10579 XFASTINT (AREF (vector
, 7)),
10580 XFASTINT (AREF (vector
, 8)));
10583 Vwith_echo_area_save_vector
= vector
;
10587 /* Set up the echo area for use by print functions. MULTIBYTE_P
10588 non-zero means we will print multibyte. */
10591 setup_echo_area_for_printing (int multibyte_p
)
10593 /* If we can't find an echo area any more, exit. */
10594 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10595 Fkill_emacs (Qnil
);
10597 ensure_echo_area_buffers ();
10599 if (!message_buf_print
)
10601 /* A message has been output since the last time we printed.
10602 Choose a fresh echo area buffer. */
10603 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10604 echo_area_buffer
[0] = echo_buffer
[1];
10606 echo_area_buffer
[0] = echo_buffer
[0];
10608 /* Switch to that buffer and clear it. */
10609 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10610 bset_truncate_lines (current_buffer
, Qnil
);
10614 ptrdiff_t count
= SPECPDL_INDEX ();
10615 specbind (Qinhibit_read_only
, Qt
);
10616 /* Note that undo recording is always disabled. */
10617 del_range (BEG
, Z
);
10618 unbind_to (count
, Qnil
);
10620 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10622 /* Set up the buffer for the multibyteness we need. */
10624 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10625 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10627 /* Raise the frame containing the echo area. */
10628 if (minibuffer_auto_raise
)
10630 struct frame
*sf
= SELECTED_FRAME ();
10631 Lisp_Object mini_window
;
10632 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10633 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10636 message_log_maybe_newline ();
10637 message_buf_print
= 1;
10641 if (NILP (echo_area_buffer
[0]))
10643 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10644 echo_area_buffer
[0] = echo_buffer
[1];
10646 echo_area_buffer
[0] = echo_buffer
[0];
10649 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10651 /* Someone switched buffers between print requests. */
10652 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10653 bset_truncate_lines (current_buffer
, Qnil
);
10659 /* Display an echo area message in window W. Value is non-zero if W's
10660 height is changed. If display_last_displayed_message_p is
10661 non-zero, display the message that was last displayed, otherwise
10662 display the current message. */
10665 display_echo_area (struct window
*w
)
10667 int i
, no_message_p
, window_height_changed_p
;
10669 /* Temporarily disable garbage collections while displaying the echo
10670 area. This is done because a GC can print a message itself.
10671 That message would modify the echo area buffer's contents while a
10672 redisplay of the buffer is going on, and seriously confuse
10674 ptrdiff_t count
= inhibit_garbage_collection ();
10676 /* If there is no message, we must call display_echo_area_1
10677 nevertheless because it resizes the window. But we will have to
10678 reset the echo_area_buffer in question to nil at the end because
10679 with_echo_area_buffer will sets it to an empty buffer. */
10680 i
= display_last_displayed_message_p
? 1 : 0;
10681 no_message_p
= NILP (echo_area_buffer
[i
]);
10683 window_height_changed_p
10684 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10685 display_echo_area_1
,
10686 (intptr_t) w
, Qnil
);
10689 echo_area_buffer
[i
] = Qnil
;
10691 unbind_to (count
, Qnil
);
10692 return window_height_changed_p
;
10696 /* Helper for display_echo_area. Display the current buffer which
10697 contains the current echo area message in window W, a mini-window,
10698 a pointer to which is passed in A1. A2..A4 are currently not used.
10699 Change the height of W so that all of the message is displayed.
10700 Value is non-zero if height of W was changed. */
10703 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10706 struct window
*w
= (struct window
*) i1
;
10707 Lisp_Object window
;
10708 struct text_pos start
;
10709 int window_height_changed_p
= 0;
10711 /* Do this before displaying, so that we have a large enough glyph
10712 matrix for the display. If we can't get enough space for the
10713 whole text, display the last N lines. That works by setting w->start. */
10714 window_height_changed_p
= resize_mini_window (w
, 0);
10716 /* Use the starting position chosen by resize_mini_window. */
10717 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10720 clear_glyph_matrix (w
->desired_matrix
);
10721 XSETWINDOW (window
, w
);
10722 try_window (window
, start
, 0);
10724 return window_height_changed_p
;
10728 /* Resize the echo area window to exactly the size needed for the
10729 currently displayed message, if there is one. If a mini-buffer
10730 is active, don't shrink it. */
10733 resize_echo_area_exactly (void)
10735 if (BUFFERP (echo_area_buffer
[0])
10736 && WINDOWP (echo_area_window
))
10738 struct window
*w
= XWINDOW (echo_area_window
);
10739 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10740 int resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10741 (intptr_t) w
, resize_exactly
);
10744 windows_or_buffers_changed
= 42;
10745 update_mode_lines
= 30;
10746 redisplay_internal ();
10752 /* Callback function for with_echo_area_buffer, when used from
10753 resize_echo_area_exactly. A1 contains a pointer to the window to
10754 resize, EXACTLY non-nil means resize the mini-window exactly to the
10755 size of the text displayed. A3 and A4 are not used. Value is what
10756 resize_mini_window returns. */
10759 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10762 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10766 /* Resize mini-window W to fit the size of its contents. EXACT_P
10767 means size the window exactly to the size needed. Otherwise, it's
10768 only enlarged until W's buffer is empty.
10770 Set W->start to the right place to begin display. If the whole
10771 contents fit, start at the beginning. Otherwise, start so as
10772 to make the end of the contents appear. This is particularly
10773 important for y-or-n-p, but seems desirable generally.
10775 Value is non-zero if the window height has been changed. */
10778 resize_mini_window (struct window
*w
, int exact_p
)
10780 struct frame
*f
= XFRAME (w
->frame
);
10781 int window_height_changed_p
= 0;
10783 eassert (MINI_WINDOW_P (w
));
10785 /* By default, start display at the beginning. */
10786 set_marker_both (w
->start
, w
->contents
,
10787 BUF_BEGV (XBUFFER (w
->contents
)),
10788 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10790 /* Don't resize windows while redisplaying a window; it would
10791 confuse redisplay functions when the size of the window they are
10792 displaying changes from under them. Such a resizing can happen,
10793 for instance, when which-func prints a long message while
10794 we are running fontification-functions. We're running these
10795 functions with safe_call which binds inhibit-redisplay to t. */
10796 if (!NILP (Vinhibit_redisplay
))
10799 /* Nil means don't try to resize. */
10800 if (NILP (Vresize_mini_windows
)
10801 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10804 if (!FRAME_MINIBUF_ONLY_P (f
))
10807 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10808 + WINDOW_PIXEL_HEIGHT (w
));
10809 int unit
= FRAME_LINE_HEIGHT (f
);
10810 int height
, max_height
;
10811 struct text_pos start
;
10812 struct buffer
*old_current_buffer
= NULL
;
10814 if (current_buffer
!= XBUFFER (w
->contents
))
10816 old_current_buffer
= current_buffer
;
10817 set_buffer_internal (XBUFFER (w
->contents
));
10820 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10822 /* Compute the max. number of lines specified by the user. */
10823 if (FLOATP (Vmax_mini_window_height
))
10824 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10825 else if (INTEGERP (Vmax_mini_window_height
))
10826 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10828 max_height
= total_height
/ 4;
10830 /* Correct that max. height if it's bogus. */
10831 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10833 /* Find out the height of the text in the window. */
10834 if (it
.line_wrap
== TRUNCATE
)
10839 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10840 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10841 height
= it
.current_y
+ last_height
;
10843 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10844 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10847 /* Compute a suitable window start. */
10848 if (height
> max_height
)
10850 height
= (max_height
/ unit
) * unit
;
10851 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10852 move_it_vertically_backward (&it
, height
- unit
);
10853 start
= it
.current
.pos
;
10856 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10857 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10859 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10861 /* Let it grow only, until we display an empty message, in which
10862 case the window shrinks again. */
10863 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10865 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10867 FRAME_WINDOWS_FROZEN (f
) = 1;
10868 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10869 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10871 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10872 && (exact_p
|| BEGV
== ZV
))
10874 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10876 FRAME_WINDOWS_FROZEN (f
) = 0;
10877 shrink_mini_window (w
, 1);
10878 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10883 /* Always resize to exact size needed. */
10884 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10886 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10888 FRAME_WINDOWS_FROZEN (f
) = 1;
10889 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10890 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10892 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10894 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10896 FRAME_WINDOWS_FROZEN (f
) = 0;
10897 shrink_mini_window (w
, 1);
10901 FRAME_WINDOWS_FROZEN (f
) = 1;
10902 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10905 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10909 if (old_current_buffer
)
10910 set_buffer_internal (old_current_buffer
);
10913 return window_height_changed_p
;
10917 /* Value is the current message, a string, or nil if there is no
10918 current message. */
10921 current_message (void)
10925 if (!BUFFERP (echo_area_buffer
[0]))
10929 with_echo_area_buffer (0, 0, current_message_1
,
10930 (intptr_t) &msg
, Qnil
);
10932 echo_area_buffer
[0] = Qnil
;
10940 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
10943 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10946 *msg
= make_buffer_string (BEG
, Z
, 1);
10953 /* Push the current message on Vmessage_stack for later restoration
10954 by restore_message. Value is non-zero if the current message isn't
10955 empty. This is a relatively infrequent operation, so it's not
10956 worth optimizing. */
10959 push_message (void)
10961 Lisp_Object msg
= current_message ();
10962 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10963 return STRINGP (msg
);
10967 /* Restore message display from the top of Vmessage_stack. */
10970 restore_message (void)
10972 eassert (CONSP (Vmessage_stack
));
10973 message3_nolog (XCAR (Vmessage_stack
));
10977 /* Handler for unwind-protect calling pop_message. */
10980 pop_message_unwind (void)
10982 /* Pop the top-most entry off Vmessage_stack. */
10983 eassert (CONSP (Vmessage_stack
));
10984 Vmessage_stack
= XCDR (Vmessage_stack
);
10988 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10989 exits. If the stack is not empty, we have a missing pop_message
10993 check_message_stack (void)
10995 if (!NILP (Vmessage_stack
))
11000 /* Truncate to NCHARS what will be displayed in the echo area the next
11001 time we display it---but don't redisplay it now. */
11004 truncate_echo_area (ptrdiff_t nchars
)
11007 echo_area_buffer
[0] = Qnil
;
11008 else if (!noninteractive
11010 && !NILP (echo_area_buffer
[0]))
11012 struct frame
*sf
= SELECTED_FRAME ();
11013 /* Error messages get reported properly by cmd_error, so this must be
11014 just an informative message; if the frame hasn't really been
11015 initialized yet, just toss it. */
11016 if (sf
->glyphs_initialized_p
)
11017 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11022 /* Helper function for truncate_echo_area. Truncate the current
11023 message to at most NCHARS characters. */
11026 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11028 if (BEG
+ nchars
< Z
)
11029 del_range (BEG
+ nchars
, Z
);
11031 echo_area_buffer
[0] = Qnil
;
11035 /* Set the current message to STRING. */
11038 set_message (Lisp_Object string
)
11040 eassert (STRINGP (string
));
11042 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11044 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11045 message_buf_print
= 0;
11046 help_echo_showing_p
= 0;
11048 if (STRINGP (Vdebug_on_message
)
11049 && STRINGP (string
)
11050 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11051 call_debugger (list2 (Qerror
, string
));
11055 /* Helper function for set_message. First argument is ignored and second
11056 argument has the same meaning as for set_message.
11057 This function is called with the echo area buffer being current. */
11060 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11062 eassert (STRINGP (string
));
11064 /* Change multibyteness of the echo buffer appropriately. */
11065 if (message_enable_multibyte
11066 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11067 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11069 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11070 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11071 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11073 /* Insert new message at BEG. */
11074 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11076 /* This function takes care of single/multibyte conversion.
11077 We just have to ensure that the echo area buffer has the right
11078 setting of enable_multibyte_characters. */
11079 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), 1);
11085 /* Clear messages. CURRENT_P non-zero means clear the current
11086 message. LAST_DISPLAYED_P non-zero means clear the message
11090 clear_message (bool current_p
, bool last_displayed_p
)
11094 echo_area_buffer
[0] = Qnil
;
11095 message_cleared_p
= true;
11098 if (last_displayed_p
)
11099 echo_area_buffer
[1] = Qnil
;
11101 message_buf_print
= 0;
11104 /* Clear garbaged frames.
11106 This function is used where the old redisplay called
11107 redraw_garbaged_frames which in turn called redraw_frame which in
11108 turn called clear_frame. The call to clear_frame was a source of
11109 flickering. I believe a clear_frame is not necessary. It should
11110 suffice in the new redisplay to invalidate all current matrices,
11111 and ensure a complete redisplay of all windows. */
11114 clear_garbaged_frames (void)
11116 if (frame_garbaged
)
11118 Lisp_Object tail
, frame
;
11120 FOR_EACH_FRAME (tail
, frame
)
11122 struct frame
*f
= XFRAME (frame
);
11124 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11129 clear_current_matrices (f
);
11130 fset_redisplay (f
);
11131 f
->garbaged
= false;
11132 f
->resized_p
= false;
11136 frame_garbaged
= false;
11141 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
11142 is non-zero update selected_frame. Value is non-zero if the
11143 mini-windows height has been changed. */
11146 echo_area_display (int update_frame_p
)
11148 Lisp_Object mini_window
;
11151 int window_height_changed_p
= 0;
11152 struct frame
*sf
= SELECTED_FRAME ();
11154 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11155 w
= XWINDOW (mini_window
);
11156 f
= XFRAME (WINDOW_FRAME (w
));
11158 /* Don't display if frame is invisible or not yet initialized. */
11159 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11162 #ifdef HAVE_WINDOW_SYSTEM
11163 /* When Emacs starts, selected_frame may be the initial terminal
11164 frame. If we let this through, a message would be displayed on
11166 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11168 #endif /* HAVE_WINDOW_SYSTEM */
11170 /* Redraw garbaged frames. */
11171 clear_garbaged_frames ();
11173 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11175 echo_area_window
= mini_window
;
11176 window_height_changed_p
= display_echo_area (w
);
11177 w
->must_be_updated_p
= true;
11179 /* Update the display, unless called from redisplay_internal.
11180 Also don't update the screen during redisplay itself. The
11181 update will happen at the end of redisplay, and an update
11182 here could cause confusion. */
11183 if (update_frame_p
&& !redisplaying_p
)
11187 /* If the display update has been interrupted by pending
11188 input, update mode lines in the frame. Due to the
11189 pending input, it might have been that redisplay hasn't
11190 been called, so that mode lines above the echo area are
11191 garbaged. This looks odd, so we prevent it here. */
11192 if (!display_completed
)
11193 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11195 if (window_height_changed_p
11196 /* Don't do this if Emacs is shutting down. Redisplay
11197 needs to run hooks. */
11198 && !NILP (Vrun_hooks
))
11200 /* Must update other windows. Likewise as in other
11201 cases, don't let this update be interrupted by
11203 ptrdiff_t count
= SPECPDL_INDEX ();
11204 specbind (Qredisplay_dont_pause
, Qt
);
11205 windows_or_buffers_changed
= 44;
11206 redisplay_internal ();
11207 unbind_to (count
, Qnil
);
11209 else if (FRAME_WINDOW_P (f
) && n
== 0)
11211 /* Window configuration is the same as before.
11212 Can do with a display update of the echo area,
11213 unless we displayed some mode lines. */
11214 update_single_window (w
, 1);
11218 update_frame (f
, 1, 1);
11220 /* If cursor is in the echo area, make sure that the next
11221 redisplay displays the minibuffer, so that the cursor will
11222 be replaced with what the minibuffer wants. */
11223 if (cursor_in_echo_area
)
11224 wset_redisplay (XWINDOW (mini_window
));
11227 else if (!EQ (mini_window
, selected_window
))
11228 wset_redisplay (XWINDOW (mini_window
));
11230 /* Last displayed message is now the current message. */
11231 echo_area_buffer
[1] = echo_area_buffer
[0];
11232 /* Inform read_char that we're not echoing. */
11233 echo_message_buffer
= Qnil
;
11235 /* Prevent redisplay optimization in redisplay_internal by resetting
11236 this_line_start_pos. This is done because the mini-buffer now
11237 displays the message instead of its buffer text. */
11238 if (EQ (mini_window
, selected_window
))
11239 CHARPOS (this_line_start_pos
) = 0;
11241 return window_height_changed_p
;
11244 /* Nonzero if W's buffer was changed but not saved. */
11247 window_buffer_changed (struct window
*w
)
11249 struct buffer
*b
= XBUFFER (w
->contents
);
11251 eassert (BUFFER_LIVE_P (b
));
11253 return (((BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
));
11256 /* Nonzero if W has %c in its mode line and mode line should be updated. */
11259 mode_line_update_needed (struct window
*w
)
11261 return (w
->column_number_displayed
!= -1
11262 && !(PT
== w
->last_point
&& !window_outdated (w
))
11263 && (w
->column_number_displayed
!= current_column ()));
11266 /* Nonzero if window start of W is frozen and may not be changed during
11270 window_frozen_p (struct window
*w
)
11272 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11274 Lisp_Object window
;
11276 XSETWINDOW (window
, w
);
11277 if (MINI_WINDOW_P (w
))
11279 else if (EQ (window
, selected_window
))
11281 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11282 && EQ (window
, Vminibuf_scroll_window
))
11283 /* This special window can't be frozen too. */
11291 /***********************************************************************
11292 Mode Lines and Frame Titles
11293 ***********************************************************************/
11295 /* A buffer for constructing non-propertized mode-line strings and
11296 frame titles in it; allocated from the heap in init_xdisp and
11297 resized as needed in store_mode_line_noprop_char. */
11299 static char *mode_line_noprop_buf
;
11301 /* The buffer's end, and a current output position in it. */
11303 static char *mode_line_noprop_buf_end
;
11304 static char *mode_line_noprop_ptr
;
11306 #define MODE_LINE_NOPROP_LEN(start) \
11307 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11310 MODE_LINE_DISPLAY
= 0,
11314 } mode_line_target
;
11316 /* Alist that caches the results of :propertize.
11317 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11318 static Lisp_Object mode_line_proptrans_alist
;
11320 /* List of strings making up the mode-line. */
11321 static Lisp_Object mode_line_string_list
;
11323 /* Base face property when building propertized mode line string. */
11324 static Lisp_Object mode_line_string_face
;
11325 static Lisp_Object mode_line_string_face_prop
;
11328 /* Unwind data for mode line strings */
11330 static Lisp_Object Vmode_line_unwind_vector
;
11333 format_mode_line_unwind_data (struct frame
*target_frame
,
11334 struct buffer
*obuf
,
11336 int save_proptrans
)
11338 Lisp_Object vector
, tmp
;
11340 /* Reduce consing by keeping one vector in
11341 Vwith_echo_area_save_vector. */
11342 vector
= Vmode_line_unwind_vector
;
11343 Vmode_line_unwind_vector
= Qnil
;
11346 vector
= Fmake_vector (make_number (10), Qnil
);
11348 ASET (vector
, 0, make_number (mode_line_target
));
11349 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11350 ASET (vector
, 2, mode_line_string_list
);
11351 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11352 ASET (vector
, 4, mode_line_string_face
);
11353 ASET (vector
, 5, mode_line_string_face_prop
);
11356 XSETBUFFER (tmp
, obuf
);
11359 ASET (vector
, 6, tmp
);
11360 ASET (vector
, 7, owin
);
11363 /* Similarly to `with-selected-window', if the operation selects
11364 a window on another frame, we must restore that frame's
11365 selected window, and (for a tty) the top-frame. */
11366 ASET (vector
, 8, target_frame
->selected_window
);
11367 if (FRAME_TERMCAP_P (target_frame
))
11368 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11375 unwind_format_mode_line (Lisp_Object vector
)
11377 Lisp_Object old_window
= AREF (vector
, 7);
11378 Lisp_Object target_frame_window
= AREF (vector
, 8);
11379 Lisp_Object old_top_frame
= AREF (vector
, 9);
11381 mode_line_target
= XINT (AREF (vector
, 0));
11382 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11383 mode_line_string_list
= AREF (vector
, 2);
11384 if (! EQ (AREF (vector
, 3), Qt
))
11385 mode_line_proptrans_alist
= AREF (vector
, 3);
11386 mode_line_string_face
= AREF (vector
, 4);
11387 mode_line_string_face_prop
= AREF (vector
, 5);
11389 /* Select window before buffer, since it may change the buffer. */
11390 if (!NILP (old_window
))
11392 /* If the operation that we are unwinding had selected a window
11393 on a different frame, reset its frame-selected-window. For a
11394 text terminal, reset its top-frame if necessary. */
11395 if (!NILP (target_frame_window
))
11398 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11400 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11401 Fselect_window (target_frame_window
, Qt
);
11403 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11404 Fselect_frame (old_top_frame
, Qt
);
11407 Fselect_window (old_window
, Qt
);
11410 if (!NILP (AREF (vector
, 6)))
11412 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11413 ASET (vector
, 6, Qnil
);
11416 Vmode_line_unwind_vector
= vector
;
11420 /* Store a single character C for the frame title in mode_line_noprop_buf.
11421 Re-allocate mode_line_noprop_buf if necessary. */
11424 store_mode_line_noprop_char (char c
)
11426 /* If output position has reached the end of the allocated buffer,
11427 increase the buffer's size. */
11428 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11430 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11431 ptrdiff_t size
= len
;
11432 mode_line_noprop_buf
=
11433 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11434 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11435 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11438 *mode_line_noprop_ptr
++ = c
;
11442 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11443 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11444 characters that yield more columns than PRECISION; PRECISION <= 0
11445 means copy the whole string. Pad with spaces until FIELD_WIDTH
11446 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11447 pad. Called from display_mode_element when it is used to build a
11451 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11453 const unsigned char *str
= (const unsigned char *) string
;
11455 ptrdiff_t dummy
, nbytes
;
11457 /* Copy at most PRECISION chars from STR. */
11458 nbytes
= strlen (string
);
11459 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11461 store_mode_line_noprop_char (*str
++);
11463 /* Fill up with spaces until FIELD_WIDTH reached. */
11464 while (field_width
> 0
11465 && n
< field_width
)
11467 store_mode_line_noprop_char (' ');
11474 /***********************************************************************
11476 ***********************************************************************/
11478 #ifdef HAVE_WINDOW_SYSTEM
11480 /* Set the title of FRAME, if it has changed. The title format is
11481 Vicon_title_format if FRAME is iconified, otherwise it is
11482 frame_title_format. */
11485 x_consider_frame_title (Lisp_Object frame
)
11487 struct frame
*f
= XFRAME (frame
);
11489 if (FRAME_WINDOW_P (f
)
11490 || FRAME_MINIBUF_ONLY_P (f
)
11491 || f
->explicit_name
)
11493 /* Do we have more than one visible frame on this X display? */
11494 Lisp_Object tail
, other_frame
, fmt
;
11495 ptrdiff_t title_start
;
11499 ptrdiff_t count
= SPECPDL_INDEX ();
11501 FOR_EACH_FRAME (tail
, other_frame
)
11503 struct frame
*tf
= XFRAME (other_frame
);
11506 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11507 && !FRAME_MINIBUF_ONLY_P (tf
)
11508 && !EQ (other_frame
, tip_frame
)
11509 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11513 /* Set global variable indicating that multiple frames exist. */
11514 multiple_frames
= CONSP (tail
);
11516 /* Switch to the buffer of selected window of the frame. Set up
11517 mode_line_target so that display_mode_element will output into
11518 mode_line_noprop_buf; then display the title. */
11519 record_unwind_protect (unwind_format_mode_line
,
11520 format_mode_line_unwind_data
11521 (f
, current_buffer
, selected_window
, 0));
11523 Fselect_window (f
->selected_window
, Qt
);
11524 set_buffer_internal_1
11525 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11526 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11528 mode_line_target
= MODE_LINE_TITLE
;
11529 title_start
= MODE_LINE_NOPROP_LEN (0);
11530 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11531 NULL
, DEFAULT_FACE_ID
);
11532 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11533 len
= MODE_LINE_NOPROP_LEN (title_start
);
11534 title
= mode_line_noprop_buf
+ title_start
;
11535 unbind_to (count
, Qnil
);
11537 /* Set the title only if it's changed. This avoids consing in
11538 the common case where it hasn't. (If it turns out that we've
11539 already wasted too much time by walking through the list with
11540 display_mode_element, then we might need to optimize at a
11541 higher level than this.) */
11542 if (! STRINGP (f
->name
)
11543 || SBYTES (f
->name
) != len
11544 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11545 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11549 #endif /* not HAVE_WINDOW_SYSTEM */
11552 /***********************************************************************
11554 ***********************************************************************/
11556 /* Non-zero if we will not redisplay all visible windows. */
11557 #define REDISPLAY_SOME_P() \
11558 ((windows_or_buffers_changed == 0 \
11559 || windows_or_buffers_changed == REDISPLAY_SOME) \
11560 && (update_mode_lines == 0 \
11561 || update_mode_lines == REDISPLAY_SOME))
11563 /* Prepare for redisplay by updating menu-bar item lists when
11564 appropriate. This can call eval. */
11567 prepare_menu_bars (void)
11569 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11570 bool some_windows
= REDISPLAY_SOME_P ();
11571 struct gcpro gcpro1
, gcpro2
;
11572 Lisp_Object tooltip_frame
;
11574 #ifdef HAVE_WINDOW_SYSTEM
11575 tooltip_frame
= tip_frame
;
11577 tooltip_frame
= Qnil
;
11580 if (FUNCTIONP (Vpre_redisplay_function
))
11582 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11583 if (all_windows
&& some_windows
)
11585 Lisp_Object ws
= window_list ();
11586 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11588 Lisp_Object
this = XCAR (ws
);
11589 struct window
*w
= XWINDOW (this);
11591 || XFRAME (w
->frame
)->redisplay
11592 || XBUFFER (w
->contents
)->text
->redisplay
)
11594 windows
= Fcons (this, windows
);
11598 safe__call1 (true, Vpre_redisplay_function
, windows
);
11601 /* Update all frame titles based on their buffer names, etc. We do
11602 this before the menu bars so that the buffer-menu will show the
11603 up-to-date frame titles. */
11604 #ifdef HAVE_WINDOW_SYSTEM
11607 Lisp_Object tail
, frame
;
11609 FOR_EACH_FRAME (tail
, frame
)
11611 struct frame
*f
= XFRAME (frame
);
11612 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11616 && !XBUFFER (w
->contents
)->text
->redisplay
)
11619 if (!EQ (frame
, tooltip_frame
)
11620 && (FRAME_ICONIFIED_P (f
)
11621 || FRAME_VISIBLE_P (f
) == 1
11622 /* Exclude TTY frames that are obscured because they
11623 are not the top frame on their console. This is
11624 because x_consider_frame_title actually switches
11625 to the frame, which for TTY frames means it is
11626 marked as garbaged, and will be completely
11627 redrawn on the next redisplay cycle. This causes
11628 TTY frames to be completely redrawn, when there
11629 are more than one of them, even though nothing
11630 should be changed on display. */
11631 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11632 x_consider_frame_title (frame
);
11635 #endif /* HAVE_WINDOW_SYSTEM */
11637 /* Update the menu bar item lists, if appropriate. This has to be
11638 done before any actual redisplay or generation of display lines. */
11642 Lisp_Object tail
, frame
;
11643 ptrdiff_t count
= SPECPDL_INDEX ();
11644 /* 1 means that update_menu_bar has run its hooks
11645 so any further calls to update_menu_bar shouldn't do so again. */
11646 int menu_bar_hooks_run
= 0;
11648 record_unwind_save_match_data ();
11650 FOR_EACH_FRAME (tail
, frame
)
11652 struct frame
*f
= XFRAME (frame
);
11653 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11655 /* Ignore tooltip frame. */
11656 if (EQ (frame
, tooltip_frame
))
11662 && !XBUFFER (w
->contents
)->text
->redisplay
)
11665 /* If a window on this frame changed size, report that to
11666 the user and clear the size-change flag. */
11667 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11669 Lisp_Object functions
;
11671 /* Clear flag first in case we get an error below. */
11672 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11673 functions
= Vwindow_size_change_functions
;
11674 GCPRO2 (tail
, functions
);
11676 while (CONSP (functions
))
11678 if (!EQ (XCAR (functions
), Qt
))
11679 call1 (XCAR (functions
), frame
);
11680 functions
= XCDR (functions
);
11686 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11687 #ifdef HAVE_WINDOW_SYSTEM
11688 update_tool_bar (f
, 0);
11691 if (windows_or_buffers_changed
11694 (f
, Fbuffer_modified_p (XWINDOW (f
->selected_window
)->contents
));
11699 unbind_to (count
, Qnil
);
11703 struct frame
*sf
= SELECTED_FRAME ();
11704 update_menu_bar (sf
, 1, 0);
11705 #ifdef HAVE_WINDOW_SYSTEM
11706 update_tool_bar (sf
, 1);
11712 /* Update the menu bar item list for frame F. This has to be done
11713 before we start to fill in any display lines, because it can call
11716 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11718 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11719 already ran the menu bar hooks for this redisplay, so there
11720 is no need to run them again. The return value is the
11721 updated value of this flag, to pass to the next call. */
11724 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11726 Lisp_Object window
;
11727 register struct window
*w
;
11729 /* If called recursively during a menu update, do nothing. This can
11730 happen when, for instance, an activate-menubar-hook causes a
11732 if (inhibit_menubar_update
)
11735 window
= FRAME_SELECTED_WINDOW (f
);
11736 w
= XWINDOW (window
);
11738 if (FRAME_WINDOW_P (f
)
11740 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11741 || defined (HAVE_NS) || defined (USE_GTK)
11742 FRAME_EXTERNAL_MENU_BAR (f
)
11744 FRAME_MENU_BAR_LINES (f
) > 0
11746 : FRAME_MENU_BAR_LINES (f
) > 0)
11748 /* If the user has switched buffers or windows, we need to
11749 recompute to reflect the new bindings. But we'll
11750 recompute when update_mode_lines is set too; that means
11751 that people can use force-mode-line-update to request
11752 that the menu bar be recomputed. The adverse effect on
11753 the rest of the redisplay algorithm is about the same as
11754 windows_or_buffers_changed anyway. */
11755 if (windows_or_buffers_changed
11756 /* This used to test w->update_mode_line, but we believe
11757 there is no need to recompute the menu in that case. */
11758 || update_mode_lines
11759 || window_buffer_changed (w
))
11761 struct buffer
*prev
= current_buffer
;
11762 ptrdiff_t count
= SPECPDL_INDEX ();
11764 specbind (Qinhibit_menubar_update
, Qt
);
11766 set_buffer_internal_1 (XBUFFER (w
->contents
));
11767 if (save_match_data
)
11768 record_unwind_save_match_data ();
11769 if (NILP (Voverriding_local_map_menu_flag
))
11771 specbind (Qoverriding_terminal_local_map
, Qnil
);
11772 specbind (Qoverriding_local_map
, Qnil
);
11777 /* Run the Lucid hook. */
11778 safe_run_hooks (Qactivate_menubar_hook
);
11780 /* If it has changed current-menubar from previous value,
11781 really recompute the menu-bar from the value. */
11782 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11783 call0 (Qrecompute_lucid_menubar
);
11785 safe_run_hooks (Qmenu_bar_update_hook
);
11790 XSETFRAME (Vmenu_updating_frame
, f
);
11791 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11793 /* Redisplay the menu bar in case we changed it. */
11794 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11795 || defined (HAVE_NS) || defined (USE_GTK)
11796 if (FRAME_WINDOW_P (f
))
11798 #if defined (HAVE_NS)
11799 /* All frames on Mac OS share the same menubar. So only
11800 the selected frame should be allowed to set it. */
11801 if (f
== SELECTED_FRAME ())
11803 set_frame_menubar (f
, 0, 0);
11806 /* On a terminal screen, the menu bar is an ordinary screen
11807 line, and this makes it get updated. */
11808 w
->update_mode_line
= 1;
11809 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11810 /* In the non-toolkit version, the menu bar is an ordinary screen
11811 line, and this makes it get updated. */
11812 w
->update_mode_line
= 1;
11813 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11815 unbind_to (count
, Qnil
);
11816 set_buffer_internal_1 (prev
);
11823 /***********************************************************************
11825 ***********************************************************************/
11827 #ifdef HAVE_WINDOW_SYSTEM
11829 /* Tool-bar item index of the item on which a mouse button was pressed
11832 int last_tool_bar_item
;
11834 /* Select `frame' temporarily without running all the code in
11836 FIXME: Maybe do_switch_frame should be trimmed down similarly
11837 when `norecord' is set. */
11839 fast_set_selected_frame (Lisp_Object frame
)
11841 if (!EQ (selected_frame
, frame
))
11843 selected_frame
= frame
;
11844 selected_window
= XFRAME (frame
)->selected_window
;
11848 /* Update the tool-bar item list for frame F. This has to be done
11849 before we start to fill in any display lines. Called from
11850 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11851 and restore it here. */
11854 update_tool_bar (struct frame
*f
, int save_match_data
)
11856 #if defined (USE_GTK) || defined (HAVE_NS)
11857 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11859 int do_update
= (WINDOWP (f
->tool_bar_window
)
11860 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0);
11865 Lisp_Object window
;
11868 window
= FRAME_SELECTED_WINDOW (f
);
11869 w
= XWINDOW (window
);
11871 /* If the user has switched buffers or windows, we need to
11872 recompute to reflect the new bindings. But we'll
11873 recompute when update_mode_lines is set too; that means
11874 that people can use force-mode-line-update to request
11875 that the menu bar be recomputed. The adverse effect on
11876 the rest of the redisplay algorithm is about the same as
11877 windows_or_buffers_changed anyway. */
11878 if (windows_or_buffers_changed
11879 || w
->update_mode_line
11880 || update_mode_lines
11881 || window_buffer_changed (w
))
11883 struct buffer
*prev
= current_buffer
;
11884 ptrdiff_t count
= SPECPDL_INDEX ();
11885 Lisp_Object frame
, new_tool_bar
;
11886 int new_n_tool_bar
;
11887 struct gcpro gcpro1
;
11889 /* Set current_buffer to the buffer of the selected
11890 window of the frame, so that we get the right local
11892 set_buffer_internal_1 (XBUFFER (w
->contents
));
11894 /* Save match data, if we must. */
11895 if (save_match_data
)
11896 record_unwind_save_match_data ();
11898 /* Make sure that we don't accidentally use bogus keymaps. */
11899 if (NILP (Voverriding_local_map_menu_flag
))
11901 specbind (Qoverriding_terminal_local_map
, Qnil
);
11902 specbind (Qoverriding_local_map
, Qnil
);
11905 GCPRO1 (new_tool_bar
);
11907 /* We must temporarily set the selected frame to this frame
11908 before calling tool_bar_items, because the calculation of
11909 the tool-bar keymap uses the selected frame (see
11910 `tool-bar-make-keymap' in tool-bar.el). */
11911 eassert (EQ (selected_window
,
11912 /* Since we only explicitly preserve selected_frame,
11913 check that selected_window would be redundant. */
11914 XFRAME (selected_frame
)->selected_window
));
11915 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11916 XSETFRAME (frame
, f
);
11917 fast_set_selected_frame (frame
);
11919 /* Build desired tool-bar items from keymaps. */
11921 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11924 /* Redisplay the tool-bar if we changed it. */
11925 if (new_n_tool_bar
!= f
->n_tool_bar_items
11926 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11928 /* Redisplay that happens asynchronously due to an expose event
11929 may access f->tool_bar_items. Make sure we update both
11930 variables within BLOCK_INPUT so no such event interrupts. */
11932 fset_tool_bar_items (f
, new_tool_bar
);
11933 f
->n_tool_bar_items
= new_n_tool_bar
;
11934 w
->update_mode_line
= 1;
11940 unbind_to (count
, Qnil
);
11941 set_buffer_internal_1 (prev
);
11946 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
11948 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11949 F's desired tool-bar contents. F->tool_bar_items must have
11950 been set up previously by calling prepare_menu_bars. */
11953 build_desired_tool_bar_string (struct frame
*f
)
11955 int i
, size
, size_needed
;
11956 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11957 Lisp_Object image
, plist
, props
;
11959 image
= plist
= props
= Qnil
;
11960 GCPRO3 (image
, plist
, props
);
11962 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11963 Otherwise, make a new string. */
11965 /* The size of the string we might be able to reuse. */
11966 size
= (STRINGP (f
->desired_tool_bar_string
)
11967 ? SCHARS (f
->desired_tool_bar_string
)
11970 /* We need one space in the string for each image. */
11971 size_needed
= f
->n_tool_bar_items
;
11973 /* Reuse f->desired_tool_bar_string, if possible. */
11974 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11975 fset_desired_tool_bar_string
11976 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11979 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11980 Fremove_text_properties (make_number (0), make_number (size
),
11981 props
, f
->desired_tool_bar_string
);
11984 /* Put a `display' property on the string for the images to display,
11985 put a `menu_item' property on tool-bar items with a value that
11986 is the index of the item in F's tool-bar item vector. */
11987 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11989 #define PROP(IDX) \
11990 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11992 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11993 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11994 int hmargin
, vmargin
, relief
, idx
, end
;
11996 /* If image is a vector, choose the image according to the
11998 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11999 if (VECTORP (image
))
12003 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12004 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12007 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12008 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12010 eassert (ASIZE (image
) >= idx
);
12011 image
= AREF (image
, idx
);
12016 /* Ignore invalid image specifications. */
12017 if (!valid_image_p (image
))
12020 /* Display the tool-bar button pressed, or depressed. */
12021 plist
= Fcopy_sequence (XCDR (image
));
12023 /* Compute margin and relief to draw. */
12024 relief
= (tool_bar_button_relief
>= 0
12025 ? tool_bar_button_relief
12026 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12027 hmargin
= vmargin
= relief
;
12029 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12030 INT_MAX
- max (hmargin
, vmargin
)))
12032 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12033 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12035 else if (CONSP (Vtool_bar_button_margin
))
12037 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12038 INT_MAX
- hmargin
))
12039 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12041 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12042 INT_MAX
- vmargin
))
12043 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12046 if (auto_raise_tool_bar_buttons_p
)
12048 /* Add a `:relief' property to the image spec if the item is
12052 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12059 /* If image is selected, display it pressed, i.e. with a
12060 negative relief. If it's not selected, display it with a
12062 plist
= Fplist_put (plist
, QCrelief
,
12064 ? make_number (-relief
)
12065 : make_number (relief
)));
12070 /* Put a margin around the image. */
12071 if (hmargin
|| vmargin
)
12073 if (hmargin
== vmargin
)
12074 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12076 plist
= Fplist_put (plist
, QCmargin
,
12077 Fcons (make_number (hmargin
),
12078 make_number (vmargin
)));
12081 /* If button is not enabled, and we don't have special images
12082 for the disabled state, make the image appear disabled by
12083 applying an appropriate algorithm to it. */
12084 if (!enabled_p
&& idx
< 0)
12085 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12087 /* Put a `display' text property on the string for the image to
12088 display. Put a `menu-item' property on the string that gives
12089 the start of this item's properties in the tool-bar items
12091 image
= Fcons (Qimage
, plist
);
12092 props
= list4 (Qdisplay
, image
,
12093 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12095 /* Let the last image hide all remaining spaces in the tool bar
12096 string. The string can be longer than needed when we reuse a
12097 previous string. */
12098 if (i
+ 1 == f
->n_tool_bar_items
)
12099 end
= SCHARS (f
->desired_tool_bar_string
);
12102 Fadd_text_properties (make_number (i
), make_number (end
),
12103 props
, f
->desired_tool_bar_string
);
12111 /* Display one line of the tool-bar of frame IT->f.
12113 HEIGHT specifies the desired height of the tool-bar line.
12114 If the actual height of the glyph row is less than HEIGHT, the
12115 row's height is increased to HEIGHT, and the icons are centered
12116 vertically in the new height.
12118 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12119 count a final empty row in case the tool-bar width exactly matches
12124 display_tool_bar_line (struct it
*it
, int height
)
12126 struct glyph_row
*row
= it
->glyph_row
;
12127 int max_x
= it
->last_visible_x
;
12128 struct glyph
*last
;
12130 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12131 clear_glyph_row (row
);
12132 row
->enabled_p
= true;
12133 row
->y
= it
->current_y
;
12135 /* Note that this isn't made use of if the face hasn't a box,
12136 so there's no need to check the face here. */
12137 it
->start_of_box_run_p
= 1;
12139 while (it
->current_x
< max_x
)
12141 int x
, n_glyphs_before
, i
, nglyphs
;
12142 struct it it_before
;
12144 /* Get the next display element. */
12145 if (!get_next_display_element (it
))
12147 /* Don't count empty row if we are counting needed tool-bar lines. */
12148 if (height
< 0 && !it
->hpos
)
12153 /* Produce glyphs. */
12154 n_glyphs_before
= row
->used
[TEXT_AREA
];
12157 PRODUCE_GLYPHS (it
);
12159 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12161 x
= it_before
.current_x
;
12162 while (i
< nglyphs
)
12164 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12166 if (x
+ glyph
->pixel_width
> max_x
)
12168 /* Glyph doesn't fit on line. Backtrack. */
12169 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12171 /* If this is the only glyph on this line, it will never fit on the
12172 tool-bar, so skip it. But ensure there is at least one glyph,
12173 so we don't accidentally disable the tool-bar. */
12174 if (n_glyphs_before
== 0
12175 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12181 x
+= glyph
->pixel_width
;
12185 /* Stop at line end. */
12186 if (ITERATOR_AT_END_OF_LINE_P (it
))
12189 set_iterator_to_next (it
, 1);
12194 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12196 /* Use default face for the border below the tool bar.
12198 FIXME: When auto-resize-tool-bars is grow-only, there is
12199 no additional border below the possibly empty tool-bar lines.
12200 So to make the extra empty lines look "normal", we have to
12201 use the tool-bar face for the border too. */
12202 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12203 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12204 it
->face_id
= DEFAULT_FACE_ID
;
12206 extend_face_to_end_of_line (it
);
12207 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12208 last
->right_box_line_p
= 1;
12209 if (last
== row
->glyphs
[TEXT_AREA
])
12210 last
->left_box_line_p
= 1;
12212 /* Make line the desired height and center it vertically. */
12213 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12215 /* Don't add more than one line height. */
12216 height
%= FRAME_LINE_HEIGHT (it
->f
);
12217 it
->max_ascent
+= height
/ 2;
12218 it
->max_descent
+= (height
+ 1) / 2;
12221 compute_line_metrics (it
);
12223 /* If line is empty, make it occupy the rest of the tool-bar. */
12224 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12226 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12227 row
->visible_height
= row
->height
;
12228 row
->ascent
= row
->phys_ascent
= 0;
12229 row
->extra_line_spacing
= 0;
12232 row
->full_width_p
= 1;
12233 row
->continued_p
= 0;
12234 row
->truncated_on_left_p
= 0;
12235 row
->truncated_on_right_p
= 0;
12237 it
->current_x
= it
->hpos
= 0;
12238 it
->current_y
+= row
->height
;
12244 /* Max tool-bar height. Basically, this is what makes all other windows
12245 disappear when the frame gets too small. Rethink this! */
12247 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
12248 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
12250 /* Value is the number of pixels needed to make all tool-bar items of
12251 frame F visible. The actual number of glyph rows needed is
12252 returned in *N_ROWS if non-NULL. */
12255 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12257 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12259 /* tool_bar_height is called from redisplay_tool_bar after building
12260 the desired matrix, so use (unused) mode-line row as temporary row to
12261 avoid destroying the first tool-bar row. */
12262 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12264 /* Initialize an iterator for iteration over
12265 F->desired_tool_bar_string in the tool-bar window of frame F. */
12266 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12267 it
.first_visible_x
= 0;
12268 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12269 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12270 it
.paragraph_embedding
= L2R
;
12272 while (!ITERATOR_AT_END_P (&it
))
12274 clear_glyph_row (temp_row
);
12275 it
.glyph_row
= temp_row
;
12276 display_tool_bar_line (&it
, -1);
12278 clear_glyph_row (temp_row
);
12280 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12282 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12285 return it
.current_y
;
12287 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12290 #endif /* !USE_GTK && !HAVE_NS */
12292 #if defined USE_GTK || defined HAVE_NS
12293 EXFUN (Ftool_bar_height
, 2) ATTRIBUTE_CONST
;
12294 EXFUN (Ftool_bar_lines_needed
, 1) ATTRIBUTE_CONST
;
12297 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12299 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12300 If FRAME is nil or omitted, use the selected frame. Optional argument
12301 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12302 (Lisp_Object frame
, Lisp_Object pixelwise
)
12306 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12307 struct frame
*f
= decode_any_frame (frame
);
12309 if (WINDOWP (f
->tool_bar_window
)
12310 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12312 update_tool_bar (f
, 1);
12313 if (f
->n_tool_bar_items
)
12315 build_desired_tool_bar_string (f
);
12316 height
= tool_bar_height (f
, NULL
, NILP (pixelwise
) ? 0 : 1);
12321 return make_number (height
);
12325 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
12326 height should be changed. */
12329 redisplay_tool_bar (struct frame
*f
)
12331 #if defined (USE_GTK) || defined (HAVE_NS)
12333 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12334 update_frame_tool_bar (f
);
12337 #else /* !USE_GTK && !HAVE_NS */
12341 struct glyph_row
*row
;
12343 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12344 do anything. This means you must start with tool-bar-lines
12345 non-zero to get the auto-sizing effect. Or in other words, you
12346 can turn off tool-bars by specifying tool-bar-lines zero. */
12347 if (!WINDOWP (f
->tool_bar_window
)
12348 || (w
= XWINDOW (f
->tool_bar_window
),
12349 WINDOW_PIXEL_HEIGHT (w
) == 0))
12352 /* Set up an iterator for the tool-bar window. */
12353 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12354 it
.first_visible_x
= 0;
12355 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12356 row
= it
.glyph_row
;
12358 /* Build a string that represents the contents of the tool-bar. */
12359 build_desired_tool_bar_string (f
);
12360 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12361 /* FIXME: This should be controlled by a user option. But it
12362 doesn't make sense to have an R2L tool bar if the menu bar cannot
12363 be drawn also R2L, and making the menu bar R2L is tricky due
12364 toolkit-specific code that implements it. If an R2L tool bar is
12365 ever supported, display_tool_bar_line should also be augmented to
12366 call unproduce_glyphs like display_line and display_string
12368 it
.paragraph_embedding
= L2R
;
12370 if (f
->n_tool_bar_rows
== 0)
12372 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, 1);
12374 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12377 int new_lines
= ((new_height
+ FRAME_LINE_HEIGHT (f
) - 1)
12378 / FRAME_LINE_HEIGHT (f
));
12380 XSETFRAME (frame
, f
);
12381 Fmodify_frame_parameters (frame
,
12382 list1 (Fcons (Qtool_bar_lines
,
12383 make_number (new_lines
))));
12384 /* Always do that now. */
12385 clear_glyph_matrix (w
->desired_matrix
);
12386 f
->fonts_changed
= 1;
12391 /* Display as many lines as needed to display all tool-bar items. */
12393 if (f
->n_tool_bar_rows
> 0)
12395 int border
, rows
, height
, extra
;
12397 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12398 border
= XINT (Vtool_bar_border
);
12399 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12400 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12401 else if (EQ (Vtool_bar_border
, Qborder_width
))
12402 border
= f
->border_width
;
12408 rows
= f
->n_tool_bar_rows
;
12409 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12410 extra
= it
.last_visible_y
- border
- height
* rows
;
12412 while (it
.current_y
< it
.last_visible_y
)
12415 if (extra
> 0 && rows
-- > 0)
12417 h
= (extra
+ rows
- 1) / rows
;
12420 display_tool_bar_line (&it
, height
+ h
);
12425 while (it
.current_y
< it
.last_visible_y
)
12426 display_tool_bar_line (&it
, 0);
12429 /* It doesn't make much sense to try scrolling in the tool-bar
12430 window, so don't do it. */
12431 w
->desired_matrix
->no_scrolling_p
= 1;
12432 w
->must_be_updated_p
= 1;
12434 if (!NILP (Vauto_resize_tool_bars
))
12436 /* Do we really allow the toolbar to occupy the whole frame? */
12437 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
12438 int change_height_p
= 0;
12440 /* If we couldn't display everything, change the tool-bar's
12441 height if there is room for more. */
12442 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
12443 && it
.current_y
< max_tool_bar_height
)
12444 change_height_p
= 1;
12446 /* We subtract 1 because display_tool_bar_line advances the
12447 glyph_row pointer before returning to its caller. We want to
12448 examine the last glyph row produced by
12449 display_tool_bar_line. */
12450 row
= it
.glyph_row
- 1;
12452 /* If there are blank lines at the end, except for a partially
12453 visible blank line at the end that is smaller than
12454 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12455 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12456 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12457 change_height_p
= 1;
12459 /* If row displays tool-bar items, but is partially visible,
12460 change the tool-bar's height. */
12461 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12462 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
12463 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
12464 change_height_p
= 1;
12466 /* Resize windows as needed by changing the `tool-bar-lines'
12467 frame parameter. */
12468 if (change_height_p
)
12472 int new_height
= tool_bar_height (f
, &nrows
, 1);
12474 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12475 && !f
->minimize_tool_bar_window_p
)
12476 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12477 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12478 f
->minimize_tool_bar_window_p
= 0;
12480 if (change_height_p
)
12482 /* Current size of the tool-bar window in canonical line
12484 int old_lines
= WINDOW_TOTAL_LINES (w
);
12485 /* Required size of the tool-bar window in canonical
12487 int new_lines
= ((new_height
+ FRAME_LINE_HEIGHT (f
) - 1)
12488 / FRAME_LINE_HEIGHT (f
));
12489 /* Maximum size of the tool-bar window in canonical line
12490 units that this frame can allow. */
12492 WINDOW_TOTAL_LINES (XWINDOW (FRAME_ROOT_WINDOW (f
))) - 1;
12494 /* Don't try to change the tool-bar window size and set
12495 the fonts_changed flag unless really necessary. That
12496 flag causes redisplay to give up and retry
12497 redisplaying the frame from scratch, so setting it
12498 unnecessarily can lead to nasty redisplay loops. */
12499 if (new_lines
<= max_lines
12500 && eabs (new_lines
- old_lines
) >= 1)
12502 XSETFRAME (frame
, f
);
12503 Fmodify_frame_parameters (frame
,
12504 list1 (Fcons (Qtool_bar_lines
,
12505 make_number (new_lines
))));
12506 clear_glyph_matrix (w
->desired_matrix
);
12507 f
->n_tool_bar_rows
= nrows
;
12508 f
->fonts_changed
= 1;
12515 f
->minimize_tool_bar_window_p
= 0;
12518 #endif /* USE_GTK || HAVE_NS */
12521 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12523 /* Get information about the tool-bar item which is displayed in GLYPH
12524 on frame F. Return in *PROP_IDX the index where tool-bar item
12525 properties start in F->tool_bar_items. Value is zero if
12526 GLYPH doesn't display a tool-bar item. */
12529 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12535 /* This function can be called asynchronously, which means we must
12536 exclude any possibility that Fget_text_property signals an
12538 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12539 charpos
= max (0, charpos
);
12541 /* Get the text property `menu-item' at pos. The value of that
12542 property is the start index of this item's properties in
12543 F->tool_bar_items. */
12544 prop
= Fget_text_property (make_number (charpos
),
12545 Qmenu_item
, f
->current_tool_bar_string
);
12546 if (INTEGERP (prop
))
12548 *prop_idx
= XINT (prop
);
12558 /* Get information about the tool-bar item at position X/Y on frame F.
12559 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12560 the current matrix of the tool-bar window of F, or NULL if not
12561 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12562 item in F->tool_bar_items. Value is
12564 -1 if X/Y is not on a tool-bar item
12565 0 if X/Y is on the same item that was highlighted before.
12569 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12570 int *hpos
, int *vpos
, int *prop_idx
)
12572 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12573 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12576 /* Find the glyph under X/Y. */
12577 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12578 if (*glyph
== NULL
)
12581 /* Get the start of this tool-bar item's properties in
12582 f->tool_bar_items. */
12583 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12586 /* Is mouse on the highlighted item? */
12587 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12588 && *vpos
>= hlinfo
->mouse_face_beg_row
12589 && *vpos
<= hlinfo
->mouse_face_end_row
12590 && (*vpos
> hlinfo
->mouse_face_beg_row
12591 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12592 && (*vpos
< hlinfo
->mouse_face_end_row
12593 || *hpos
< hlinfo
->mouse_face_end_col
12594 || hlinfo
->mouse_face_past_end
))
12602 Handle mouse button event on the tool-bar of frame F, at
12603 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12604 0 for button release. MODIFIERS is event modifiers for button
12608 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12611 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12612 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12613 int hpos
, vpos
, prop_idx
;
12614 struct glyph
*glyph
;
12615 Lisp_Object enabled_p
;
12618 /* If not on the highlighted tool-bar item, and mouse-highlight is
12619 non-nil, return. This is so we generate the tool-bar button
12620 click only when the mouse button is released on the same item as
12621 where it was pressed. However, when mouse-highlight is disabled,
12622 generate the click when the button is released regardless of the
12623 highlight, since tool-bar items are not highlighted in that
12625 frame_to_window_pixel_xy (w
, &x
, &y
);
12626 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12628 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12631 /* When mouse-highlight is off, generate the click for the item
12632 where the button was pressed, disregarding where it was
12634 if (NILP (Vmouse_highlight
) && !down_p
)
12635 prop_idx
= last_tool_bar_item
;
12637 /* If item is disabled, do nothing. */
12638 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12639 if (NILP (enabled_p
))
12644 /* Show item in pressed state. */
12645 if (!NILP (Vmouse_highlight
))
12646 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12647 last_tool_bar_item
= prop_idx
;
12651 Lisp_Object key
, frame
;
12652 struct input_event event
;
12653 EVENT_INIT (event
);
12655 /* Show item in released state. */
12656 if (!NILP (Vmouse_highlight
))
12657 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12659 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12661 XSETFRAME (frame
, f
);
12662 event
.kind
= TOOL_BAR_EVENT
;
12663 event
.frame_or_window
= frame
;
12665 kbd_buffer_store_event (&event
);
12667 event
.kind
= TOOL_BAR_EVENT
;
12668 event
.frame_or_window
= frame
;
12670 event
.modifiers
= modifiers
;
12671 kbd_buffer_store_event (&event
);
12672 last_tool_bar_item
= -1;
12677 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12678 tool-bar window-relative coordinates X/Y. Called from
12679 note_mouse_highlight. */
12682 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12684 Lisp_Object window
= f
->tool_bar_window
;
12685 struct window
*w
= XWINDOW (window
);
12686 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12687 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12689 struct glyph
*glyph
;
12690 struct glyph_row
*row
;
12692 Lisp_Object enabled_p
;
12694 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12695 int mouse_down_p
, rc
;
12697 /* Function note_mouse_highlight is called with negative X/Y
12698 values when mouse moves outside of the frame. */
12699 if (x
<= 0 || y
<= 0)
12701 clear_mouse_face (hlinfo
);
12705 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12708 /* Not on tool-bar item. */
12709 clear_mouse_face (hlinfo
);
12713 /* On same tool-bar item as before. */
12714 goto set_help_echo
;
12716 clear_mouse_face (hlinfo
);
12718 /* Mouse is down, but on different tool-bar item? */
12719 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12720 && f
== dpyinfo
->last_mouse_frame
);
12723 && last_tool_bar_item
!= prop_idx
)
12726 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12728 /* If tool-bar item is not enabled, don't highlight it. */
12729 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12730 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12732 /* Compute the x-position of the glyph. In front and past the
12733 image is a space. We include this in the highlighted area. */
12734 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12735 for (i
= x
= 0; i
< hpos
; ++i
)
12736 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12738 /* Record this as the current active region. */
12739 hlinfo
->mouse_face_beg_col
= hpos
;
12740 hlinfo
->mouse_face_beg_row
= vpos
;
12741 hlinfo
->mouse_face_beg_x
= x
;
12742 hlinfo
->mouse_face_past_end
= 0;
12744 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12745 hlinfo
->mouse_face_end_row
= vpos
;
12746 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12747 hlinfo
->mouse_face_window
= window
;
12748 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12750 /* Display it as active. */
12751 show_mouse_face (hlinfo
, draw
);
12756 /* Set help_echo_string to a help string to display for this tool-bar item.
12757 XTread_socket does the rest. */
12758 help_echo_object
= help_echo_window
= Qnil
;
12759 help_echo_pos
= -1;
12760 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12761 if (NILP (help_echo_string
))
12762 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12765 #endif /* !USE_GTK && !HAVE_NS */
12767 #endif /* HAVE_WINDOW_SYSTEM */
12771 /************************************************************************
12772 Horizontal scrolling
12773 ************************************************************************/
12775 static int hscroll_window_tree (Lisp_Object
);
12776 static int hscroll_windows (Lisp_Object
);
12778 /* For all leaf windows in the window tree rooted at WINDOW, set their
12779 hscroll value so that PT is (i) visible in the window, and (ii) so
12780 that it is not within a certain margin at the window's left and
12781 right border. Value is non-zero if any window's hscroll has been
12785 hscroll_window_tree (Lisp_Object window
)
12787 int hscrolled_p
= 0;
12788 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12789 int hscroll_step_abs
= 0;
12790 double hscroll_step_rel
= 0;
12792 if (hscroll_relative_p
)
12794 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12795 if (hscroll_step_rel
< 0)
12797 hscroll_relative_p
= 0;
12798 hscroll_step_abs
= 0;
12801 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12803 hscroll_step_abs
= XINT (Vhscroll_step
);
12804 if (hscroll_step_abs
< 0)
12805 hscroll_step_abs
= 0;
12808 hscroll_step_abs
= 0;
12810 while (WINDOWP (window
))
12812 struct window
*w
= XWINDOW (window
);
12814 if (WINDOWP (w
->contents
))
12815 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12816 else if (w
->cursor
.vpos
>= 0)
12819 int text_area_width
;
12820 struct glyph_row
*cursor_row
;
12821 struct glyph_row
*bottom_row
;
12824 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12825 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12826 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12828 cursor_row
= bottom_row
- 1;
12830 if (!cursor_row
->enabled_p
)
12832 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12833 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12834 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12836 cursor_row
= bottom_row
- 1;
12838 row_r2l_p
= cursor_row
->reversed_p
;
12840 text_area_width
= window_box_width (w
, TEXT_AREA
);
12842 /* Scroll when cursor is inside this scroll margin. */
12843 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12845 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12846 /* For left-to-right rows, hscroll when cursor is either
12847 (i) inside the right hscroll margin, or (ii) if it is
12848 inside the left margin and the window is already
12852 && w
->cursor
.x
<= h_margin
)
12853 || (cursor_row
->enabled_p
12854 && cursor_row
->truncated_on_right_p
12855 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12856 /* For right-to-left rows, the logic is similar,
12857 except that rules for scrolling to left and right
12858 are reversed. E.g., if cursor.x <= h_margin, we
12859 need to hscroll "to the right" unconditionally,
12860 and that will scroll the screen to the left so as
12861 to reveal the next portion of the row. */
12863 && ((cursor_row
->enabled_p
12864 /* FIXME: It is confusing to set the
12865 truncated_on_right_p flag when R2L rows
12866 are actually truncated on the left. */
12867 && cursor_row
->truncated_on_right_p
12868 && w
->cursor
.x
<= h_margin
)
12870 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12874 struct buffer
*saved_current_buffer
;
12878 /* Find point in a display of infinite width. */
12879 saved_current_buffer
= current_buffer
;
12880 current_buffer
= XBUFFER (w
->contents
);
12882 if (w
== XWINDOW (selected_window
))
12885 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12887 /* Move iterator to pt starting at cursor_row->start in
12888 a line with infinite width. */
12889 init_to_row_start (&it
, w
, cursor_row
);
12890 it
.last_visible_x
= INFINITY
;
12891 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12892 current_buffer
= saved_current_buffer
;
12894 /* Position cursor in window. */
12895 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12896 hscroll
= max (0, (it
.current_x
12897 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12898 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12899 : (text_area_width
/ 2))))
12900 / FRAME_COLUMN_WIDTH (it
.f
);
12901 else if ((!row_r2l_p
12902 && w
->cursor
.x
>= text_area_width
- h_margin
)
12903 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12905 if (hscroll_relative_p
)
12906 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12909 wanted_x
= text_area_width
12910 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12913 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12917 if (hscroll_relative_p
)
12918 wanted_x
= text_area_width
* hscroll_step_rel
12921 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12924 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12926 hscroll
= max (hscroll
, w
->min_hscroll
);
12928 /* Don't prevent redisplay optimizations if hscroll
12929 hasn't changed, as it will unnecessarily slow down
12931 if (w
->hscroll
!= hscroll
)
12933 XBUFFER (w
->contents
)->prevent_redisplay_optimizations_p
= 1;
12934 w
->hscroll
= hscroll
;
12943 /* Value is non-zero if hscroll of any leaf window has been changed. */
12944 return hscrolled_p
;
12948 /* Set hscroll so that cursor is visible and not inside horizontal
12949 scroll margins for all windows in the tree rooted at WINDOW. See
12950 also hscroll_window_tree above. Value is non-zero if any window's
12951 hscroll has been changed. If it has, desired matrices on the frame
12952 of WINDOW are cleared. */
12955 hscroll_windows (Lisp_Object window
)
12957 int hscrolled_p
= hscroll_window_tree (window
);
12959 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12960 return hscrolled_p
;
12965 /************************************************************************
12967 ************************************************************************/
12969 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12970 to a non-zero value. This is sometimes handy to have in a debugger
12975 /* First and last unchanged row for try_window_id. */
12977 static int debug_first_unchanged_at_end_vpos
;
12978 static int debug_last_unchanged_at_beg_vpos
;
12980 /* Delta vpos and y. */
12982 static int debug_dvpos
, debug_dy
;
12984 /* Delta in characters and bytes for try_window_id. */
12986 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12988 /* Values of window_end_pos and window_end_vpos at the end of
12991 static ptrdiff_t debug_end_vpos
;
12993 /* Append a string to W->desired_matrix->method. FMT is a printf
12994 format string. If trace_redisplay_p is true also printf the
12995 resulting string to stderr. */
12997 static void debug_method_add (struct window
*, char const *, ...)
12998 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13001 debug_method_add (struct window
*w
, char const *fmt
, ...)
13004 char *method
= w
->desired_matrix
->method
;
13005 int len
= strlen (method
);
13006 int size
= sizeof w
->desired_matrix
->method
;
13007 int remaining
= size
- len
- 1;
13010 if (len
&& remaining
)
13013 --remaining
, ++len
;
13016 va_start (ap
, fmt
);
13017 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13020 if (trace_redisplay_p
)
13021 fprintf (stderr
, "%p (%s): %s\n",
13023 ((BUFFERP (w
->contents
)
13024 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13025 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13030 #endif /* GLYPH_DEBUG */
13033 /* Value is non-zero if all changes in window W, which displays
13034 current_buffer, are in the text between START and END. START is a
13035 buffer position, END is given as a distance from Z. Used in
13036 redisplay_internal for display optimization. */
13039 text_outside_line_unchanged_p (struct window
*w
,
13040 ptrdiff_t start
, ptrdiff_t end
)
13042 int unchanged_p
= 1;
13044 /* If text or overlays have changed, see where. */
13045 if (window_outdated (w
))
13047 /* Gap in the line? */
13048 if (GPT
< start
|| Z
- GPT
< end
)
13051 /* Changes start in front of the line, or end after it? */
13053 && (BEG_UNCHANGED
< start
- 1
13054 || END_UNCHANGED
< end
))
13057 /* If selective display, can't optimize if changes start at the
13058 beginning of the line. */
13060 && INTEGERP (BVAR (current_buffer
, selective_display
))
13061 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13062 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13065 /* If there are overlays at the start or end of the line, these
13066 may have overlay strings with newlines in them. A change at
13067 START, for instance, may actually concern the display of such
13068 overlay strings as well, and they are displayed on different
13069 lines. So, quickly rule out this case. (For the future, it
13070 might be desirable to implement something more telling than
13071 just BEG/END_UNCHANGED.) */
13074 if (BEG
+ BEG_UNCHANGED
== start
13075 && overlay_touches_p (start
))
13077 if (END_UNCHANGED
== end
13078 && overlay_touches_p (Z
- end
))
13082 /* Under bidi reordering, adding or deleting a character in the
13083 beginning of a paragraph, before the first strong directional
13084 character, can change the base direction of the paragraph (unless
13085 the buffer specifies a fixed paragraph direction), which will
13086 require to redisplay the whole paragraph. It might be worthwhile
13087 to find the paragraph limits and widen the range of redisplayed
13088 lines to that, but for now just give up this optimization. */
13089 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13090 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13094 return unchanged_p
;
13098 /* Do a frame update, taking possible shortcuts into account. This is
13099 the main external entry point for redisplay.
13101 If the last redisplay displayed an echo area message and that message
13102 is no longer requested, we clear the echo area or bring back the
13103 mini-buffer if that is in use. */
13108 redisplay_internal ();
13113 overlay_arrow_string_or_property (Lisp_Object var
)
13117 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13120 return Voverlay_arrow_string
;
13123 /* Return 1 if there are any overlay-arrows in current_buffer. */
13125 overlay_arrow_in_current_buffer_p (void)
13129 for (vlist
= Voverlay_arrow_variable_list
;
13131 vlist
= XCDR (vlist
))
13133 Lisp_Object var
= XCAR (vlist
);
13136 if (!SYMBOLP (var
))
13138 val
= find_symbol_value (var
);
13140 && current_buffer
== XMARKER (val
)->buffer
)
13147 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
13151 overlay_arrows_changed_p (void)
13155 for (vlist
= Voverlay_arrow_variable_list
;
13157 vlist
= XCDR (vlist
))
13159 Lisp_Object var
= XCAR (vlist
);
13160 Lisp_Object val
, pstr
;
13162 if (!SYMBOLP (var
))
13164 val
= find_symbol_value (var
);
13165 if (!MARKERP (val
))
13167 if (! EQ (COERCE_MARKER (val
),
13168 Fget (var
, Qlast_arrow_position
))
13169 || ! (pstr
= overlay_arrow_string_or_property (var
),
13170 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13176 /* Mark overlay arrows to be updated on next redisplay. */
13179 update_overlay_arrows (int up_to_date
)
13183 for (vlist
= Voverlay_arrow_variable_list
;
13185 vlist
= XCDR (vlist
))
13187 Lisp_Object var
= XCAR (vlist
);
13189 if (!SYMBOLP (var
))
13192 if (up_to_date
> 0)
13194 Lisp_Object val
= find_symbol_value (var
);
13195 Fput (var
, Qlast_arrow_position
,
13196 COERCE_MARKER (val
));
13197 Fput (var
, Qlast_arrow_string
,
13198 overlay_arrow_string_or_property (var
));
13200 else if (up_to_date
< 0
13201 || !NILP (Fget (var
, Qlast_arrow_position
)))
13203 Fput (var
, Qlast_arrow_position
, Qt
);
13204 Fput (var
, Qlast_arrow_string
, Qt
);
13210 /* Return overlay arrow string to display at row.
13211 Return integer (bitmap number) for arrow bitmap in left fringe.
13212 Return nil if no overlay arrow. */
13215 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13219 for (vlist
= Voverlay_arrow_variable_list
;
13221 vlist
= XCDR (vlist
))
13223 Lisp_Object var
= XCAR (vlist
);
13226 if (!SYMBOLP (var
))
13229 val
= find_symbol_value (var
);
13232 && current_buffer
== XMARKER (val
)->buffer
13233 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13235 if (FRAME_WINDOW_P (it
->f
)
13236 /* FIXME: if ROW->reversed_p is set, this should test
13237 the right fringe, not the left one. */
13238 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13240 #ifdef HAVE_WINDOW_SYSTEM
13241 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13244 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
13245 return make_number (fringe_bitmap
);
13248 return make_number (-1); /* Use default arrow bitmap. */
13250 return overlay_arrow_string_or_property (var
);
13257 /* Return 1 if point moved out of or into a composition. Otherwise
13258 return 0. PREV_BUF and PREV_PT are the last point buffer and
13259 position. BUF and PT are the current point buffer and position. */
13262 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13263 struct buffer
*buf
, ptrdiff_t pt
)
13265 ptrdiff_t start
, end
;
13267 Lisp_Object buffer
;
13269 XSETBUFFER (buffer
, buf
);
13270 /* Check a composition at the last point if point moved within the
13272 if (prev_buf
== buf
)
13275 /* Point didn't move. */
13278 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13279 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13280 && composition_valid_p (start
, end
, prop
)
13281 && start
< prev_pt
&& end
> prev_pt
)
13282 /* The last point was within the composition. Return 1 iff
13283 point moved out of the composition. */
13284 return (pt
<= start
|| pt
>= end
);
13287 /* Check a composition at the current point. */
13288 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13289 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13290 && composition_valid_p (start
, end
, prop
)
13291 && start
< pt
&& end
> pt
);
13294 /* Reconsider the clip changes of buffer which is displayed in W. */
13297 reconsider_clip_changes (struct window
*w
)
13299 struct buffer
*b
= XBUFFER (w
->contents
);
13301 if (b
->clip_changed
13302 && w
->window_end_valid
13303 && w
->current_matrix
->buffer
== b
13304 && w
->current_matrix
->zv
== BUF_ZV (b
)
13305 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13306 b
->clip_changed
= 0;
13308 /* If display wasn't paused, and W is not a tool bar window, see if
13309 point has been moved into or out of a composition. In that case,
13310 we set b->clip_changed to 1 to force updating the screen. If
13311 b->clip_changed has already been set to 1, we can skip this
13313 if (!b
->clip_changed
&& w
->window_end_valid
)
13315 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13316 ? PT
: marker_position (w
->pointm
));
13318 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13319 && check_point_in_composition (w
->current_matrix
->buffer
,
13320 w
->last_point
, b
, pt
))
13321 b
->clip_changed
= 1;
13326 propagate_buffer_redisplay (void)
13327 { /* Resetting b->text->redisplay is problematic!
13328 We can't just reset it in the case that some window that displays
13329 it has not been redisplayed; and such a window can stay
13330 unredisplayed for a long time if it's currently invisible.
13331 But we do want to reset it at the end of redisplay otherwise
13332 its displayed windows will keep being redisplayed over and over
13334 So we copy all b->text->redisplay flags up to their windows here,
13335 such that mark_window_display_accurate can safely reset
13336 b->text->redisplay. */
13337 Lisp_Object ws
= window_list ();
13338 for (; CONSP (ws
); ws
= XCDR (ws
))
13340 struct window
*thisw
= XWINDOW (XCAR (ws
));
13341 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13342 if (thisb
->text
->redisplay
)
13343 thisw
->redisplay
= true;
13347 #define STOP_POLLING \
13348 do { if (! polling_stopped_here) stop_polling (); \
13349 polling_stopped_here = 1; } while (0)
13351 #define RESUME_POLLING \
13352 do { if (polling_stopped_here) start_polling (); \
13353 polling_stopped_here = 0; } while (0)
13356 /* Perhaps in the future avoid recentering windows if it
13357 is not necessary; currently that causes some problems. */
13360 redisplay_internal (void)
13362 struct window
*w
= XWINDOW (selected_window
);
13366 bool must_finish
= 0, match_p
;
13367 struct text_pos tlbufpos
, tlendpos
;
13368 int number_of_visible_frames
;
13371 int polling_stopped_here
= 0;
13372 Lisp_Object tail
, frame
;
13374 /* True means redisplay has to consider all windows on all
13375 frames. False, only selected_window is considered. */
13376 bool consider_all_windows_p
;
13378 /* True means redisplay has to redisplay the miniwindow. */
13379 bool update_miniwindow_p
= false;
13381 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13383 /* No redisplay if running in batch mode or frame is not yet fully
13384 initialized, or redisplay is explicitly turned off by setting
13385 Vinhibit_redisplay. */
13386 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13387 || !NILP (Vinhibit_redisplay
))
13390 /* Don't examine these until after testing Vinhibit_redisplay.
13391 When Emacs is shutting down, perhaps because its connection to
13392 X has dropped, we should not look at them at all. */
13393 fr
= XFRAME (w
->frame
);
13394 sf
= SELECTED_FRAME ();
13396 if (!fr
->glyphs_initialized_p
)
13399 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13400 if (popup_activated ())
13404 /* I don't think this happens but let's be paranoid. */
13405 if (redisplaying_p
)
13408 /* Record a function that clears redisplaying_p
13409 when we leave this function. */
13410 count
= SPECPDL_INDEX ();
13411 record_unwind_protect_void (unwind_redisplay
);
13412 redisplaying_p
= 1;
13413 specbind (Qinhibit_free_realized_faces
, Qnil
);
13415 /* Record this function, so it appears on the profiler's backtraces. */
13416 record_in_backtrace (Qredisplay_internal
, &Qnil
, 0);
13418 FOR_EACH_FRAME (tail
, frame
)
13419 XFRAME (frame
)->already_hscrolled_p
= 0;
13422 /* Remember the currently selected window. */
13426 last_escape_glyph_frame
= NULL
;
13427 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13428 last_glyphless_glyph_frame
= NULL
;
13429 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13431 /* If face_change_count is non-zero, init_iterator will free all
13432 realized faces, which includes the faces referenced from current
13433 matrices. So, we can't reuse current matrices in this case. */
13434 if (face_change_count
)
13435 windows_or_buffers_changed
= 47;
13437 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13438 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13440 /* Since frames on a single ASCII terminal share the same
13441 display area, displaying a different frame means redisplay
13442 the whole thing. */
13443 SET_FRAME_GARBAGED (sf
);
13445 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13447 FRAME_TTY (sf
)->previous_frame
= sf
;
13450 /* Set the visible flags for all frames. Do this before checking for
13451 resized or garbaged frames; they want to know if their frames are
13452 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13453 number_of_visible_frames
= 0;
13455 FOR_EACH_FRAME (tail
, frame
)
13457 struct frame
*f
= XFRAME (frame
);
13459 if (FRAME_VISIBLE_P (f
))
13461 ++number_of_visible_frames
;
13462 /* Adjust matrices for visible frames only. */
13463 if (f
->fonts_changed
)
13465 adjust_frame_glyphs (f
);
13466 f
->fonts_changed
= 0;
13468 /* If cursor type has been changed on the frame
13469 other than selected, consider all frames. */
13470 if (f
!= sf
&& f
->cursor_type_changed
)
13471 update_mode_lines
= 31;
13473 clear_desired_matrices (f
);
13476 /* Notice any pending interrupt request to change frame size. */
13477 do_pending_window_change (1);
13479 /* do_pending_window_change could change the selected_window due to
13480 frame resizing which makes the selected window too small. */
13481 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13484 /* Clear frames marked as garbaged. */
13485 clear_garbaged_frames ();
13487 /* Build menubar and tool-bar items. */
13488 if (NILP (Vmemory_full
))
13489 prepare_menu_bars ();
13491 reconsider_clip_changes (w
);
13493 /* In most cases selected window displays current buffer. */
13494 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13497 /* Detect case that we need to write or remove a star in the mode line. */
13498 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13499 w
->update_mode_line
= 1;
13501 if (mode_line_update_needed (w
))
13502 w
->update_mode_line
= 1;
13505 /* Normally the message* functions will have already displayed and
13506 updated the echo area, but the frame may have been trashed, or
13507 the update may have been preempted, so display the echo area
13508 again here. Checking message_cleared_p captures the case that
13509 the echo area should be cleared. */
13510 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13511 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13512 || (message_cleared_p
13513 && minibuf_level
== 0
13514 /* If the mini-window is currently selected, this means the
13515 echo-area doesn't show through. */
13516 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13518 int window_height_changed_p
= echo_area_display (0);
13520 if (message_cleared_p
)
13521 update_miniwindow_p
= true;
13525 /* If we don't display the current message, don't clear the
13526 message_cleared_p flag, because, if we did, we wouldn't clear
13527 the echo area in the next redisplay which doesn't preserve
13529 if (!display_last_displayed_message_p
)
13530 message_cleared_p
= 0;
13532 if (window_height_changed_p
)
13534 windows_or_buffers_changed
= 50;
13536 /* If window configuration was changed, frames may have been
13537 marked garbaged. Clear them or we will experience
13538 surprises wrt scrolling. */
13539 clear_garbaged_frames ();
13542 else if (EQ (selected_window
, minibuf_window
)
13543 && (current_buffer
->clip_changed
|| window_outdated (w
))
13544 && resize_mini_window (w
, 0))
13546 /* Resized active mini-window to fit the size of what it is
13547 showing if its contents might have changed. */
13550 /* If window configuration was changed, frames may have been
13551 marked garbaged. Clear them or we will experience
13552 surprises wrt scrolling. */
13553 clear_garbaged_frames ();
13556 if (windows_or_buffers_changed
&& !update_mode_lines
)
13557 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13558 only the windows's contents needs to be refreshed, or whether the
13559 mode-lines also need a refresh. */
13560 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13561 ? REDISPLAY_SOME
: 32);
13563 /* If specs for an arrow have changed, do thorough redisplay
13564 to ensure we remove any arrow that should no longer exist. */
13565 if (overlay_arrows_changed_p ())
13566 /* Apparently, this is the only case where we update other windows,
13567 without updating other mode-lines. */
13568 windows_or_buffers_changed
= 49;
13570 consider_all_windows_p
= (update_mode_lines
13571 || windows_or_buffers_changed
);
13573 #define AINC(a,i) \
13574 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13575 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13577 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13578 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13580 /* Optimize the case that only the line containing the cursor in the
13581 selected window has changed. Variables starting with this_ are
13582 set in display_line and record information about the line
13583 containing the cursor. */
13584 tlbufpos
= this_line_start_pos
;
13585 tlendpos
= this_line_end_pos
;
13586 if (!consider_all_windows_p
13587 && CHARPOS (tlbufpos
) > 0
13588 && !w
->update_mode_line
13589 && !current_buffer
->clip_changed
13590 && !current_buffer
->prevent_redisplay_optimizations_p
13591 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13592 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13593 && !XFRAME (w
->frame
)->cursor_type_changed
13594 /* Make sure recorded data applies to current buffer, etc. */
13595 && this_line_buffer
== current_buffer
13598 && !w
->optional_new_start
13599 /* Point must be on the line that we have info recorded about. */
13600 && PT
>= CHARPOS (tlbufpos
)
13601 && PT
<= Z
- CHARPOS (tlendpos
)
13602 /* All text outside that line, including its final newline,
13603 must be unchanged. */
13604 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13605 CHARPOS (tlendpos
)))
13607 if (CHARPOS (tlbufpos
) > BEGV
13608 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13609 && (CHARPOS (tlbufpos
) == ZV
13610 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13611 /* Former continuation line has disappeared by becoming empty. */
13613 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13615 /* We have to handle the case of continuation around a
13616 wide-column character (see the comment in indent.c around
13619 For instance, in the following case:
13621 -------- Insert --------
13622 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13623 J_I_ ==> J_I_ `^^' are cursors.
13627 As we have to redraw the line above, we cannot use this
13631 int line_height_before
= this_line_pixel_height
;
13633 /* Note that start_display will handle the case that the
13634 line starting at tlbufpos is a continuation line. */
13635 start_display (&it
, w
, tlbufpos
);
13637 /* Implementation note: It this still necessary? */
13638 if (it
.current_x
!= this_line_start_x
)
13641 TRACE ((stderr
, "trying display optimization 1\n"));
13642 w
->cursor
.vpos
= -1;
13643 overlay_arrow_seen
= 0;
13644 it
.vpos
= this_line_vpos
;
13645 it
.current_y
= this_line_y
;
13646 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13647 display_line (&it
);
13649 /* If line contains point, is not continued,
13650 and ends at same distance from eob as before, we win. */
13651 if (w
->cursor
.vpos
>= 0
13652 /* Line is not continued, otherwise this_line_start_pos
13653 would have been set to 0 in display_line. */
13654 && CHARPOS (this_line_start_pos
)
13655 /* Line ends as before. */
13656 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13657 /* Line has same height as before. Otherwise other lines
13658 would have to be shifted up or down. */
13659 && this_line_pixel_height
== line_height_before
)
13661 /* If this is not the window's last line, we must adjust
13662 the charstarts of the lines below. */
13663 if (it
.current_y
< it
.last_visible_y
)
13665 struct glyph_row
*row
13666 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13667 ptrdiff_t delta
, delta_bytes
;
13669 /* We used to distinguish between two cases here,
13670 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13671 when the line ends in a newline or the end of the
13672 buffer's accessible portion. But both cases did
13673 the same, so they were collapsed. */
13675 - CHARPOS (tlendpos
)
13676 - MATRIX_ROW_START_CHARPOS (row
));
13677 delta_bytes
= (Z_BYTE
13678 - BYTEPOS (tlendpos
)
13679 - MATRIX_ROW_START_BYTEPOS (row
));
13681 increment_matrix_positions (w
->current_matrix
,
13682 this_line_vpos
+ 1,
13683 w
->current_matrix
->nrows
,
13684 delta
, delta_bytes
);
13687 /* If this row displays text now but previously didn't,
13688 or vice versa, w->window_end_vpos may have to be
13690 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13692 if (w
->window_end_vpos
< this_line_vpos
)
13693 w
->window_end_vpos
= this_line_vpos
;
13695 else if (w
->window_end_vpos
== this_line_vpos
13696 && this_line_vpos
> 0)
13697 w
->window_end_vpos
= this_line_vpos
- 1;
13698 w
->window_end_valid
= 0;
13700 /* Update hint: No need to try to scroll in update_window. */
13701 w
->desired_matrix
->no_scrolling_p
= 1;
13704 *w
->desired_matrix
->method
= 0;
13705 debug_method_add (w
, "optimization 1");
13707 #ifdef HAVE_WINDOW_SYSTEM
13708 update_window_fringes (w
, 0);
13715 else if (/* Cursor position hasn't changed. */
13716 PT
== w
->last_point
13717 /* Make sure the cursor was last displayed
13718 in this window. Otherwise we have to reposition it. */
13720 /* PXW: Must be converted to pixels, probably. */
13721 && 0 <= w
->cursor
.vpos
13722 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13726 do_pending_window_change (1);
13727 /* If selected_window changed, redisplay again. */
13728 if (WINDOWP (selected_window
)
13729 && (w
= XWINDOW (selected_window
)) != sw
)
13732 /* We used to always goto end_of_redisplay here, but this
13733 isn't enough if we have a blinking cursor. */
13734 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13735 goto end_of_redisplay
;
13739 /* If highlighting the region, or if the cursor is in the echo area,
13740 then we can't just move the cursor. */
13741 else if (NILP (Vshow_trailing_whitespace
)
13742 && !cursor_in_echo_area
)
13745 struct glyph_row
*row
;
13747 /* Skip from tlbufpos to PT and see where it is. Note that
13748 PT may be in invisible text. If so, we will end at the
13749 next visible position. */
13750 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13751 NULL
, DEFAULT_FACE_ID
);
13752 it
.current_x
= this_line_start_x
;
13753 it
.current_y
= this_line_y
;
13754 it
.vpos
= this_line_vpos
;
13756 /* The call to move_it_to stops in front of PT, but
13757 moves over before-strings. */
13758 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13760 if (it
.vpos
== this_line_vpos
13761 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13764 eassert (this_line_vpos
== it
.vpos
);
13765 eassert (this_line_y
== it
.current_y
);
13766 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13768 *w
->desired_matrix
->method
= 0;
13769 debug_method_add (w
, "optimization 3");
13778 /* Text changed drastically or point moved off of line. */
13779 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13782 CHARPOS (this_line_start_pos
) = 0;
13783 ++clear_face_cache_count
;
13784 #ifdef HAVE_WINDOW_SYSTEM
13785 ++clear_image_cache_count
;
13788 /* Build desired matrices, and update the display. If
13789 consider_all_windows_p is non-zero, do it for all windows on all
13790 frames. Otherwise do it for selected_window, only. */
13792 if (consider_all_windows_p
)
13794 FOR_EACH_FRAME (tail
, frame
)
13795 XFRAME (frame
)->updated_p
= 0;
13797 propagate_buffer_redisplay ();
13799 FOR_EACH_FRAME (tail
, frame
)
13801 struct frame
*f
= XFRAME (frame
);
13803 /* We don't have to do anything for unselected terminal
13805 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13806 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13811 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13814 /* Only GC scrollbars when we redisplay the whole frame. */
13815 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13816 /* Mark all the scroll bars to be removed; we'll redeem
13817 the ones we want when we redisplay their windows. */
13818 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13819 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13821 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13822 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13823 /* Remember that the invisible frames need to be redisplayed next
13824 time they're visible. */
13825 else if (!REDISPLAY_SOME_P ())
13826 f
->redisplay
= true;
13828 /* The X error handler may have deleted that frame. */
13829 if (!FRAME_LIVE_P (f
))
13832 /* Any scroll bars which redisplay_windows should have
13833 nuked should now go away. */
13834 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13835 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13837 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13839 /* If fonts changed on visible frame, display again. */
13840 if (f
->fonts_changed
)
13842 adjust_frame_glyphs (f
);
13843 f
->fonts_changed
= 0;
13847 /* See if we have to hscroll. */
13848 if (!f
->already_hscrolled_p
)
13850 f
->already_hscrolled_p
= 1;
13851 if (hscroll_windows (f
->root_window
))
13855 /* Prevent various kinds of signals during display
13856 update. stdio is not robust about handling
13857 signals, which can cause an apparent I/O error. */
13858 if (interrupt_input
)
13859 unrequest_sigio ();
13862 pending
|= update_frame (f
, 0, 0);
13863 f
->cursor_type_changed
= 0;
13869 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13873 /* Do the mark_window_display_accurate after all windows have
13874 been redisplayed because this call resets flags in buffers
13875 which are needed for proper redisplay. */
13876 FOR_EACH_FRAME (tail
, frame
)
13878 struct frame
*f
= XFRAME (frame
);
13881 f
->redisplay
= false;
13882 mark_window_display_accurate (f
->root_window
, 1);
13883 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13884 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13889 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13891 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13892 struct frame
*mini_frame
;
13894 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13895 /* Use list_of_error, not Qerror, so that
13896 we catch only errors and don't run the debugger. */
13897 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13899 redisplay_window_error
);
13900 if (update_miniwindow_p
)
13901 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13903 redisplay_window_error
);
13905 /* Compare desired and current matrices, perform output. */
13908 /* If fonts changed, display again. */
13909 if (sf
->fonts_changed
)
13912 /* Prevent various kinds of signals during display update.
13913 stdio is not robust about handling signals,
13914 which can cause an apparent I/O error. */
13915 if (interrupt_input
)
13916 unrequest_sigio ();
13919 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13921 if (hscroll_windows (selected_window
))
13924 XWINDOW (selected_window
)->must_be_updated_p
= true;
13925 pending
= update_frame (sf
, 0, 0);
13926 sf
->cursor_type_changed
= 0;
13929 /* We may have called echo_area_display at the top of this
13930 function. If the echo area is on another frame, that may
13931 have put text on a frame other than the selected one, so the
13932 above call to update_frame would not have caught it. Catch
13934 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13935 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13937 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13939 XWINDOW (mini_window
)->must_be_updated_p
= true;
13940 pending
|= update_frame (mini_frame
, 0, 0);
13941 mini_frame
->cursor_type_changed
= 0;
13942 if (!pending
&& hscroll_windows (mini_window
))
13947 /* If display was paused because of pending input, make sure we do a
13948 thorough update the next time. */
13951 /* Prevent the optimization at the beginning of
13952 redisplay_internal that tries a single-line update of the
13953 line containing the cursor in the selected window. */
13954 CHARPOS (this_line_start_pos
) = 0;
13956 /* Let the overlay arrow be updated the next time. */
13957 update_overlay_arrows (0);
13959 /* If we pause after scrolling, some rows in the current
13960 matrices of some windows are not valid. */
13961 if (!WINDOW_FULL_WIDTH_P (w
)
13962 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13963 update_mode_lines
= 36;
13967 if (!consider_all_windows_p
)
13969 /* This has already been done above if
13970 consider_all_windows_p is set. */
13971 if (XBUFFER (w
->contents
)->text
->redisplay
13972 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
13973 /* This can happen if b->text->redisplay was set during
13975 propagate_buffer_redisplay ();
13976 mark_window_display_accurate_1 (w
, 1);
13978 /* Say overlay arrows are up to date. */
13979 update_overlay_arrows (1);
13981 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13982 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13985 update_mode_lines
= 0;
13986 windows_or_buffers_changed
= 0;
13989 /* Start SIGIO interrupts coming again. Having them off during the
13990 code above makes it less likely one will discard output, but not
13991 impossible, since there might be stuff in the system buffer here.
13992 But it is much hairier to try to do anything about that. */
13993 if (interrupt_input
)
13997 /* If a frame has become visible which was not before, redisplay
13998 again, so that we display it. Expose events for such a frame
13999 (which it gets when becoming visible) don't call the parts of
14000 redisplay constructing glyphs, so simply exposing a frame won't
14001 display anything in this case. So, we have to display these
14002 frames here explicitly. */
14007 FOR_EACH_FRAME (tail
, frame
)
14009 if (XFRAME (frame
)->visible
)
14013 if (new_count
!= number_of_visible_frames
)
14014 windows_or_buffers_changed
= 52;
14017 /* Change frame size now if a change is pending. */
14018 do_pending_window_change (1);
14020 /* If we just did a pending size change, or have additional
14021 visible frames, or selected_window changed, redisplay again. */
14022 if ((windows_or_buffers_changed
&& !pending
)
14023 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14026 /* Clear the face and image caches.
14028 We used to do this only if consider_all_windows_p. But the cache
14029 needs to be cleared if a timer creates images in the current
14030 buffer (e.g. the test case in Bug#6230). */
14032 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14034 clear_face_cache (0);
14035 clear_face_cache_count
= 0;
14038 #ifdef HAVE_WINDOW_SYSTEM
14039 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14041 clear_image_caches (Qnil
);
14042 clear_image_cache_count
= 0;
14044 #endif /* HAVE_WINDOW_SYSTEM */
14047 if (interrupt_input
&& interrupts_deferred
)
14050 unbind_to (count
, Qnil
);
14055 /* Redisplay, but leave alone any recent echo area message unless
14056 another message has been requested in its place.
14058 This is useful in situations where you need to redisplay but no
14059 user action has occurred, making it inappropriate for the message
14060 area to be cleared. See tracking_off and
14061 wait_reading_process_output for examples of these situations.
14063 FROM_WHERE is an integer saying from where this function was
14064 called. This is useful for debugging. */
14067 redisplay_preserve_echo_area (int from_where
)
14069 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14071 if (!NILP (echo_area_buffer
[1]))
14073 /* We have a previously displayed message, but no current
14074 message. Redisplay the previous message. */
14075 display_last_displayed_message_p
= 1;
14076 redisplay_internal ();
14077 display_last_displayed_message_p
= 0;
14080 redisplay_internal ();
14082 flush_frame (SELECTED_FRAME ());
14086 /* Function registered with record_unwind_protect in redisplay_internal. */
14089 unwind_redisplay (void)
14091 redisplaying_p
= 0;
14095 /* Mark the display of leaf window W as accurate or inaccurate.
14096 If ACCURATE_P is non-zero mark display of W as accurate. If
14097 ACCURATE_P is zero, arrange for W to be redisplayed the next
14098 time redisplay_internal is called. */
14101 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
14103 struct buffer
*b
= XBUFFER (w
->contents
);
14105 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14106 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14107 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14111 b
->clip_changed
= false;
14112 b
->prevent_redisplay_optimizations_p
= false;
14113 eassert (buffer_window_count (b
) > 0);
14114 /* Resetting b->text->redisplay is problematic!
14115 In order to make it safer to do it here, redisplay_internal must
14116 have copied all b->text->redisplay to their respective windows. */
14117 b
->text
->redisplay
= false;
14119 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14120 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14121 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14122 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14124 w
->current_matrix
->buffer
= b
;
14125 w
->current_matrix
->begv
= BUF_BEGV (b
);
14126 w
->current_matrix
->zv
= BUF_ZV (b
);
14128 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14129 w
->last_cursor_off_p
= w
->cursor_off_p
;
14131 if (w
== XWINDOW (selected_window
))
14132 w
->last_point
= BUF_PT (b
);
14134 w
->last_point
= marker_position (w
->pointm
);
14136 w
->window_end_valid
= true;
14137 w
->update_mode_line
= false;
14140 w
->redisplay
= !accurate_p
;
14144 /* Mark the display of windows in the window tree rooted at WINDOW as
14145 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
14146 windows as accurate. If ACCURATE_P is zero, arrange for windows to
14147 be redisplayed the next time redisplay_internal is called. */
14150 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
14154 for (; !NILP (window
); window
= w
->next
)
14156 w
= XWINDOW (window
);
14157 if (WINDOWP (w
->contents
))
14158 mark_window_display_accurate (w
->contents
, accurate_p
);
14160 mark_window_display_accurate_1 (w
, accurate_p
);
14164 update_overlay_arrows (1);
14166 /* Force a thorough redisplay the next time by setting
14167 last_arrow_position and last_arrow_string to t, which is
14168 unequal to any useful value of Voverlay_arrow_... */
14169 update_overlay_arrows (-1);
14173 /* Return value in display table DP (Lisp_Char_Table *) for character
14174 C. Since a display table doesn't have any parent, we don't have to
14175 follow parent. Do not call this function directly but use the
14176 macro DISP_CHAR_VECTOR. */
14179 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14183 if (ASCII_CHAR_P (c
))
14186 if (SUB_CHAR_TABLE_P (val
))
14187 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14193 XSETCHAR_TABLE (table
, dp
);
14194 val
= char_table_ref (table
, c
);
14203 /***********************************************************************
14205 ***********************************************************************/
14207 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14210 redisplay_windows (Lisp_Object window
)
14212 while (!NILP (window
))
14214 struct window
*w
= XWINDOW (window
);
14216 if (WINDOWP (w
->contents
))
14217 redisplay_windows (w
->contents
);
14218 else if (BUFFERP (w
->contents
))
14220 displayed_buffer
= XBUFFER (w
->contents
);
14221 /* Use list_of_error, not Qerror, so that
14222 we catch only errors and don't run the debugger. */
14223 internal_condition_case_1 (redisplay_window_0
, window
,
14225 redisplay_window_error
);
14233 redisplay_window_error (Lisp_Object ignore
)
14235 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14240 redisplay_window_0 (Lisp_Object window
)
14242 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14243 redisplay_window (window
, false);
14248 redisplay_window_1 (Lisp_Object window
)
14250 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14251 redisplay_window (window
, true);
14256 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14257 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14258 which positions recorded in ROW differ from current buffer
14261 Return 0 if cursor is not on this row, 1 otherwise. */
14264 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14265 struct glyph_matrix
*matrix
,
14266 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14269 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14270 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14271 struct glyph
*cursor
= NULL
;
14272 /* The last known character position in row. */
14273 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14275 ptrdiff_t pt_old
= PT
- delta
;
14276 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14277 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14278 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14279 /* A glyph beyond the edge of TEXT_AREA which we should never
14281 struct glyph
*glyphs_end
= end
;
14282 /* Non-zero means we've found a match for cursor position, but that
14283 glyph has the avoid_cursor_p flag set. */
14284 int match_with_avoid_cursor
= 0;
14285 /* Non-zero means we've seen at least one glyph that came from a
14287 int string_seen
= 0;
14288 /* Largest and smallest buffer positions seen so far during scan of
14290 ptrdiff_t bpos_max
= pos_before
;
14291 ptrdiff_t bpos_min
= pos_after
;
14292 /* Last buffer position covered by an overlay string with an integer
14293 `cursor' property. */
14294 ptrdiff_t bpos_covered
= 0;
14295 /* Non-zero means the display string on which to display the cursor
14296 comes from a text property, not from an overlay. */
14297 int string_from_text_prop
= 0;
14299 /* Don't even try doing anything if called for a mode-line or
14300 header-line row, since the rest of the code isn't prepared to
14301 deal with such calamities. */
14302 eassert (!row
->mode_line_p
);
14303 if (row
->mode_line_p
)
14306 /* Skip over glyphs not having an object at the start and the end of
14307 the row. These are special glyphs like truncation marks on
14308 terminal frames. */
14309 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14311 if (!row
->reversed_p
)
14314 && INTEGERP (glyph
->object
)
14315 && glyph
->charpos
< 0)
14317 x
+= glyph
->pixel_width
;
14321 && INTEGERP ((end
- 1)->object
)
14322 /* CHARPOS is zero for blanks and stretch glyphs
14323 inserted by extend_face_to_end_of_line. */
14324 && (end
- 1)->charpos
<= 0)
14326 glyph_before
= glyph
- 1;
14333 /* If the glyph row is reversed, we need to process it from back
14334 to front, so swap the edge pointers. */
14335 glyphs_end
= end
= glyph
- 1;
14336 glyph
+= row
->used
[TEXT_AREA
] - 1;
14338 while (glyph
> end
+ 1
14339 && INTEGERP (glyph
->object
)
14340 && glyph
->charpos
< 0)
14343 x
-= glyph
->pixel_width
;
14345 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
14347 /* By default, in reversed rows we put the cursor on the
14348 rightmost (first in the reading order) glyph. */
14349 for (g
= end
+ 1; g
< glyph
; g
++)
14350 x
+= g
->pixel_width
;
14352 && INTEGERP ((end
+ 1)->object
)
14353 && (end
+ 1)->charpos
<= 0)
14355 glyph_before
= glyph
+ 1;
14359 else if (row
->reversed_p
)
14361 /* In R2L rows that don't display text, put the cursor on the
14362 rightmost glyph. Case in point: an empty last line that is
14363 part of an R2L paragraph. */
14365 /* Avoid placing the cursor on the last glyph of the row, where
14366 on terminal frames we hold the vertical border between
14367 adjacent windows. */
14368 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14369 && !WINDOW_RIGHTMOST_P (w
)
14370 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14372 x
= -1; /* will be computed below, at label compute_x */
14375 /* Step 1: Try to find the glyph whose character position
14376 corresponds to point. If that's not possible, find 2 glyphs
14377 whose character positions are the closest to point, one before
14378 point, the other after it. */
14379 if (!row
->reversed_p
)
14380 while (/* not marched to end of glyph row */
14382 /* glyph was not inserted by redisplay for internal purposes */
14383 && !INTEGERP (glyph
->object
))
14385 if (BUFFERP (glyph
->object
))
14387 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14389 if (glyph
->charpos
> bpos_max
)
14390 bpos_max
= glyph
->charpos
;
14391 if (glyph
->charpos
< bpos_min
)
14392 bpos_min
= glyph
->charpos
;
14393 if (!glyph
->avoid_cursor_p
)
14395 /* If we hit point, we've found the glyph on which to
14396 display the cursor. */
14399 match_with_avoid_cursor
= 0;
14402 /* See if we've found a better approximation to
14403 POS_BEFORE or to POS_AFTER. */
14404 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14406 pos_before
= glyph
->charpos
;
14407 glyph_before
= glyph
;
14409 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14411 pos_after
= glyph
->charpos
;
14412 glyph_after
= glyph
;
14415 else if (dpos
== 0)
14416 match_with_avoid_cursor
= 1;
14418 else if (STRINGP (glyph
->object
))
14420 Lisp_Object chprop
;
14421 ptrdiff_t glyph_pos
= glyph
->charpos
;
14423 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14425 if (!NILP (chprop
))
14427 /* If the string came from a `display' text property,
14428 look up the buffer position of that property and
14429 use that position to update bpos_max, as if we
14430 actually saw such a position in one of the row's
14431 glyphs. This helps with supporting integer values
14432 of `cursor' property on the display string in
14433 situations where most or all of the row's buffer
14434 text is completely covered by display properties,
14435 so that no glyph with valid buffer positions is
14436 ever seen in the row. */
14437 ptrdiff_t prop_pos
=
14438 string_buffer_position_lim (glyph
->object
, pos_before
,
14441 if (prop_pos
>= pos_before
)
14442 bpos_max
= prop_pos
;
14444 if (INTEGERP (chprop
))
14446 bpos_covered
= bpos_max
+ XINT (chprop
);
14447 /* If the `cursor' property covers buffer positions up
14448 to and including point, we should display cursor on
14449 this glyph. Note that, if a `cursor' property on one
14450 of the string's characters has an integer value, we
14451 will break out of the loop below _before_ we get to
14452 the position match above. IOW, integer values of
14453 the `cursor' property override the "exact match for
14454 point" strategy of positioning the cursor. */
14455 /* Implementation note: bpos_max == pt_old when, e.g.,
14456 we are in an empty line, where bpos_max is set to
14457 MATRIX_ROW_START_CHARPOS, see above. */
14458 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14467 x
+= glyph
->pixel_width
;
14470 else if (glyph
> end
) /* row is reversed */
14471 while (!INTEGERP (glyph
->object
))
14473 if (BUFFERP (glyph
->object
))
14475 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14477 if (glyph
->charpos
> bpos_max
)
14478 bpos_max
= glyph
->charpos
;
14479 if (glyph
->charpos
< bpos_min
)
14480 bpos_min
= glyph
->charpos
;
14481 if (!glyph
->avoid_cursor_p
)
14485 match_with_avoid_cursor
= 0;
14488 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14490 pos_before
= glyph
->charpos
;
14491 glyph_before
= glyph
;
14493 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14495 pos_after
= glyph
->charpos
;
14496 glyph_after
= glyph
;
14499 else if (dpos
== 0)
14500 match_with_avoid_cursor
= 1;
14502 else if (STRINGP (glyph
->object
))
14504 Lisp_Object chprop
;
14505 ptrdiff_t glyph_pos
= glyph
->charpos
;
14507 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14509 if (!NILP (chprop
))
14511 ptrdiff_t prop_pos
=
14512 string_buffer_position_lim (glyph
->object
, pos_before
,
14515 if (prop_pos
>= pos_before
)
14516 bpos_max
= prop_pos
;
14518 if (INTEGERP (chprop
))
14520 bpos_covered
= bpos_max
+ XINT (chprop
);
14521 /* If the `cursor' property covers buffer positions up
14522 to and including point, we should display cursor on
14524 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14533 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14535 x
--; /* can't use any pixel_width */
14538 x
-= glyph
->pixel_width
;
14541 /* Step 2: If we didn't find an exact match for point, we need to
14542 look for a proper place to put the cursor among glyphs between
14543 GLYPH_BEFORE and GLYPH_AFTER. */
14544 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14545 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14546 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14548 /* An empty line has a single glyph whose OBJECT is zero and
14549 whose CHARPOS is the position of a newline on that line.
14550 Note that on a TTY, there are more glyphs after that, which
14551 were produced by extend_face_to_end_of_line, but their
14552 CHARPOS is zero or negative. */
14554 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14555 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0
14556 /* On a TTY, continued and truncated rows also have a glyph at
14557 their end whose OBJECT is zero and whose CHARPOS is
14558 positive (the continuation and truncation glyphs), but such
14559 rows are obviously not "empty". */
14560 && !(row
->continued_p
|| row
->truncated_on_right_p
);
14562 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14564 ptrdiff_t ellipsis_pos
;
14566 /* Scan back over the ellipsis glyphs. */
14567 if (!row
->reversed_p
)
14569 ellipsis_pos
= (glyph
- 1)->charpos
;
14570 while (glyph
> row
->glyphs
[TEXT_AREA
]
14571 && (glyph
- 1)->charpos
== ellipsis_pos
)
14572 glyph
--, x
-= glyph
->pixel_width
;
14573 /* That loop always goes one position too far, including
14574 the glyph before the ellipsis. So scan forward over
14576 x
+= glyph
->pixel_width
;
14579 else /* row is reversed */
14581 ellipsis_pos
= (glyph
+ 1)->charpos
;
14582 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14583 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14584 glyph
++, x
+= glyph
->pixel_width
;
14585 x
-= glyph
->pixel_width
;
14589 else if (match_with_avoid_cursor
)
14591 cursor
= glyph_after
;
14594 else if (string_seen
)
14596 int incr
= row
->reversed_p
? -1 : +1;
14598 /* Need to find the glyph that came out of a string which is
14599 present at point. That glyph is somewhere between
14600 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14601 positioned between POS_BEFORE and POS_AFTER in the
14603 struct glyph
*start
, *stop
;
14604 ptrdiff_t pos
= pos_before
;
14608 /* If the row ends in a newline from a display string,
14609 reordering could have moved the glyphs belonging to the
14610 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14611 in this case we extend the search to the last glyph in
14612 the row that was not inserted by redisplay. */
14613 if (row
->ends_in_newline_from_string_p
)
14616 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14619 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14620 correspond to POS_BEFORE and POS_AFTER, respectively. We
14621 need START and STOP in the order that corresponds to the
14622 row's direction as given by its reversed_p flag. If the
14623 directionality of characters between POS_BEFORE and
14624 POS_AFTER is the opposite of the row's base direction,
14625 these characters will have been reordered for display,
14626 and we need to reverse START and STOP. */
14627 if (!row
->reversed_p
)
14629 start
= min (glyph_before
, glyph_after
);
14630 stop
= max (glyph_before
, glyph_after
);
14634 start
= max (glyph_before
, glyph_after
);
14635 stop
= min (glyph_before
, glyph_after
);
14637 for (glyph
= start
+ incr
;
14638 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14641 /* Any glyphs that come from the buffer are here because
14642 of bidi reordering. Skip them, and only pay
14643 attention to glyphs that came from some string. */
14644 if (STRINGP (glyph
->object
))
14648 /* If the display property covers the newline, we
14649 need to search for it one position farther. */
14650 ptrdiff_t lim
= pos_after
14651 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14653 string_from_text_prop
= 0;
14654 str
= glyph
->object
;
14655 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14656 if (tem
== 0 /* from overlay */
14659 /* If the string from which this glyph came is
14660 found in the buffer at point, or at position
14661 that is closer to point than pos_after, then
14662 we've found the glyph we've been looking for.
14663 If it comes from an overlay (tem == 0), and
14664 it has the `cursor' property on one of its
14665 glyphs, record that glyph as a candidate for
14666 displaying the cursor. (As in the
14667 unidirectional version, we will display the
14668 cursor on the last candidate we find.) */
14671 || (tem
- pt_old
> 0 && tem
< pos_after
))
14673 /* The glyphs from this string could have
14674 been reordered. Find the one with the
14675 smallest string position. Or there could
14676 be a character in the string with the
14677 `cursor' property, which means display
14678 cursor on that character's glyph. */
14679 ptrdiff_t strpos
= glyph
->charpos
;
14684 string_from_text_prop
= 1;
14687 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14688 && EQ (glyph
->object
, str
);
14692 ptrdiff_t gpos
= glyph
->charpos
;
14694 cprop
= Fget_char_property (make_number (gpos
),
14702 if (tem
&& glyph
->charpos
< strpos
)
14704 strpos
= glyph
->charpos
;
14710 || (tem
- pt_old
> 0 && tem
< pos_after
))
14714 pos
= tem
+ 1; /* don't find previous instances */
14716 /* This string is not what we want; skip all of the
14717 glyphs that came from it. */
14718 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14719 && EQ (glyph
->object
, str
))
14726 /* If we reached the end of the line, and END was from a string,
14727 the cursor is not on this line. */
14729 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14730 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14731 && STRINGP (end
->object
)
14732 && row
->continued_p
)
14735 /* A truncated row may not include PT among its character positions.
14736 Setting the cursor inside the scroll margin will trigger
14737 recalculation of hscroll in hscroll_window_tree. But if a
14738 display string covers point, defer to the string-handling
14739 code below to figure this out. */
14740 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14742 cursor
= glyph_before
;
14745 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14746 /* Zero-width characters produce no glyphs. */
14748 && (row
->reversed_p
14749 ? glyph_after
> glyphs_end
14750 : glyph_after
< glyphs_end
)))
14752 cursor
= glyph_after
;
14758 if (cursor
!= NULL
)
14760 else if (glyph
== glyphs_end
14761 && pos_before
== pos_after
14762 && STRINGP ((row
->reversed_p
14763 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14764 : row
->glyphs
[TEXT_AREA
])->object
))
14766 /* If all the glyphs of this row came from strings, put the
14767 cursor on the first glyph of the row. This avoids having the
14768 cursor outside of the text area in this very rare and hard
14772 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14773 : row
->glyphs
[TEXT_AREA
];
14779 /* Need to compute x that corresponds to GLYPH. */
14780 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14782 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14784 x
+= g
->pixel_width
;
14788 /* ROW could be part of a continued line, which, under bidi
14789 reordering, might have other rows whose start and end charpos
14790 occlude point. Only set w->cursor if we found a better
14791 approximation to the cursor position than we have from previously
14792 examined candidate rows belonging to the same continued line. */
14793 if (/* We already have a candidate row. */
14794 w
->cursor
.vpos
>= 0
14795 /* That candidate is not the row we are processing. */
14796 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14797 /* Make sure cursor.vpos specifies a row whose start and end
14798 charpos occlude point, and it is valid candidate for being a
14799 cursor-row. This is because some callers of this function
14800 leave cursor.vpos at the row where the cursor was displayed
14801 during the last redisplay cycle. */
14802 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14803 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14804 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14807 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14809 /* Don't consider glyphs that are outside TEXT_AREA. */
14810 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14812 /* Keep the candidate whose buffer position is the closest to
14813 point or has the `cursor' property. */
14814 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14815 w
->cursor
.hpos
>= 0
14816 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14817 && ((BUFFERP (g1
->object
)
14818 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14819 || (BUFFERP (glyph
->object
)
14820 && eabs (g1
->charpos
- pt_old
)
14821 < eabs (glyph
->charpos
- pt_old
))))
14822 /* Previous candidate is a glyph from a string that has
14823 a non-nil `cursor' property. */
14824 || (STRINGP (g1
->object
)
14825 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14826 Qcursor
, g1
->object
))
14827 /* Previous candidate is from the same display
14828 string as this one, and the display string
14829 came from a text property. */
14830 || (EQ (g1
->object
, glyph
->object
)
14831 && string_from_text_prop
)
14832 /* this candidate is from newline and its
14833 position is not an exact match */
14834 || (INTEGERP (glyph
->object
)
14835 && glyph
->charpos
!= pt_old
)))))
14837 /* If this candidate gives an exact match, use that. */
14838 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14839 /* If this candidate is a glyph created for the
14840 terminating newline of a line, and point is on that
14841 newline, it wins because it's an exact match. */
14842 || (!row
->continued_p
14843 && INTEGERP (glyph
->object
)
14844 && glyph
->charpos
== 0
14845 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14846 /* Otherwise, keep the candidate that comes from a row
14847 spanning less buffer positions. This may win when one or
14848 both candidate positions are on glyphs that came from
14849 display strings, for which we cannot compare buffer
14851 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14852 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14853 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14856 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14858 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14859 w
->cursor
.y
= row
->y
+ dy
;
14861 if (w
== XWINDOW (selected_window
))
14863 if (!row
->continued_p
14864 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14867 this_line_buffer
= XBUFFER (w
->contents
);
14869 CHARPOS (this_line_start_pos
)
14870 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14871 BYTEPOS (this_line_start_pos
)
14872 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14874 CHARPOS (this_line_end_pos
)
14875 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14876 BYTEPOS (this_line_end_pos
)
14877 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14879 this_line_y
= w
->cursor
.y
;
14880 this_line_pixel_height
= row
->height
;
14881 this_line_vpos
= w
->cursor
.vpos
;
14882 this_line_start_x
= row
->x
;
14885 CHARPOS (this_line_start_pos
) = 0;
14892 /* Run window scroll functions, if any, for WINDOW with new window
14893 start STARTP. Sets the window start of WINDOW to that position.
14895 We assume that the window's buffer is really current. */
14897 static struct text_pos
14898 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14900 struct window
*w
= XWINDOW (window
);
14901 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14903 eassert (current_buffer
== XBUFFER (w
->contents
));
14905 if (!NILP (Vwindow_scroll_functions
))
14907 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14908 make_number (CHARPOS (startp
)));
14909 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14910 /* In case the hook functions switch buffers. */
14911 set_buffer_internal (XBUFFER (w
->contents
));
14918 /* Make sure the line containing the cursor is fully visible.
14919 A value of 1 means there is nothing to be done.
14920 (Either the line is fully visible, or it cannot be made so,
14921 or we cannot tell.)
14923 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14924 is higher than window.
14926 A value of 0 means the caller should do scrolling
14927 as if point had gone off the screen. */
14930 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14932 struct glyph_matrix
*matrix
;
14933 struct glyph_row
*row
;
14936 if (!make_cursor_line_fully_visible_p
)
14939 /* It's not always possible to find the cursor, e.g, when a window
14940 is full of overlay strings. Don't do anything in that case. */
14941 if (w
->cursor
.vpos
< 0)
14944 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14945 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14947 /* If the cursor row is not partially visible, there's nothing to do. */
14948 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14951 /* If the row the cursor is in is taller than the window's height,
14952 it's not clear what to do, so do nothing. */
14953 window_height
= window_box_height (w
);
14954 if (row
->height
>= window_height
)
14956 if (!force_p
|| MINI_WINDOW_P (w
)
14957 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14964 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14965 non-zero means only WINDOW is redisplayed in redisplay_internal.
14966 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14967 in redisplay_window to bring a partially visible line into view in
14968 the case that only the cursor has moved.
14970 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14971 last screen line's vertical height extends past the end of the screen.
14975 1 if scrolling succeeded
14977 0 if scrolling didn't find point.
14979 -1 if new fonts have been loaded so that we must interrupt
14980 redisplay, adjust glyph matrices, and try again. */
14986 SCROLLING_NEED_LARGER_MATRICES
14989 /* If scroll-conservatively is more than this, never recenter.
14991 If you change this, don't forget to update the doc string of
14992 `scroll-conservatively' and the Emacs manual. */
14993 #define SCROLL_LIMIT 100
14996 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14997 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14998 int temp_scroll_step
, int last_line_misfit
)
15000 struct window
*w
= XWINDOW (window
);
15001 struct frame
*f
= XFRAME (w
->frame
);
15002 struct text_pos pos
, startp
;
15004 int this_scroll_margin
, scroll_max
, rc
, height
;
15005 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
15006 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
15007 Lisp_Object aggressive
;
15008 /* We will never try scrolling more than this number of lines. */
15009 int scroll_limit
= SCROLL_LIMIT
;
15010 int frame_line_height
= default_line_pixel_height (w
);
15011 int window_total_lines
15012 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15015 debug_method_add (w
, "try_scrolling");
15018 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15020 /* Compute scroll margin height in pixels. We scroll when point is
15021 within this distance from the top or bottom of the window. */
15022 if (scroll_margin
> 0)
15023 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15024 * frame_line_height
;
15026 this_scroll_margin
= 0;
15028 /* Force arg_scroll_conservatively to have a reasonable value, to
15029 avoid scrolling too far away with slow move_it_* functions. Note
15030 that the user can supply scroll-conservatively equal to
15031 `most-positive-fixnum', which can be larger than INT_MAX. */
15032 if (arg_scroll_conservatively
> scroll_limit
)
15034 arg_scroll_conservatively
= scroll_limit
+ 1;
15035 scroll_max
= scroll_limit
* frame_line_height
;
15037 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15038 /* Compute how much we should try to scroll maximally to bring
15039 point into view. */
15040 scroll_max
= (max (scroll_step
,
15041 max (arg_scroll_conservatively
, temp_scroll_step
))
15042 * frame_line_height
);
15043 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15044 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15045 /* We're trying to scroll because of aggressive scrolling but no
15046 scroll_step is set. Choose an arbitrary one. */
15047 scroll_max
= 10 * frame_line_height
;
15053 /* Decide whether to scroll down. */
15054 if (PT
> CHARPOS (startp
))
15056 int scroll_margin_y
;
15058 /* Compute the pixel ypos of the scroll margin, then move IT to
15059 either that ypos or PT, whichever comes first. */
15060 start_display (&it
, w
, startp
);
15061 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15062 - frame_line_height
* extra_scroll_margin_lines
;
15063 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15064 (MOVE_TO_POS
| MOVE_TO_Y
));
15066 if (PT
> CHARPOS (it
.current
.pos
))
15068 int y0
= line_bottom_y (&it
);
15069 /* Compute how many pixels below window bottom to stop searching
15070 for PT. This avoids costly search for PT that is far away if
15071 the user limited scrolling by a small number of lines, but
15072 always finds PT if scroll_conservatively is set to a large
15073 number, such as most-positive-fixnum. */
15074 int slack
= max (scroll_max
, 10 * frame_line_height
);
15075 int y_to_move
= it
.last_visible_y
+ slack
;
15077 /* Compute the distance from the scroll margin to PT or to
15078 the scroll limit, whichever comes first. This should
15079 include the height of the cursor line, to make that line
15081 move_it_to (&it
, PT
, -1, y_to_move
,
15082 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15083 dy
= line_bottom_y (&it
) - y0
;
15085 if (dy
> scroll_max
)
15086 return SCROLLING_FAILED
;
15095 /* Point is in or below the bottom scroll margin, so move the
15096 window start down. If scrolling conservatively, move it just
15097 enough down to make point visible. If scroll_step is set,
15098 move it down by scroll_step. */
15099 if (arg_scroll_conservatively
)
15101 = min (max (dy
, frame_line_height
),
15102 frame_line_height
* arg_scroll_conservatively
);
15103 else if (scroll_step
|| temp_scroll_step
)
15104 amount_to_scroll
= scroll_max
;
15107 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15108 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15109 if (NUMBERP (aggressive
))
15111 double float_amount
= XFLOATINT (aggressive
) * height
;
15112 int aggressive_scroll
= float_amount
;
15113 if (aggressive_scroll
== 0 && float_amount
> 0)
15114 aggressive_scroll
= 1;
15115 /* Don't let point enter the scroll margin near top of
15116 the window. This could happen if the value of
15117 scroll_up_aggressively is too large and there are
15118 non-zero margins, because scroll_up_aggressively
15119 means put point that fraction of window height
15120 _from_the_bottom_margin_. */
15121 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15122 aggressive_scroll
= height
- 2*this_scroll_margin
;
15123 amount_to_scroll
= dy
+ aggressive_scroll
;
15127 if (amount_to_scroll
<= 0)
15128 return SCROLLING_FAILED
;
15130 start_display (&it
, w
, startp
);
15131 if (arg_scroll_conservatively
<= scroll_limit
)
15132 move_it_vertically (&it
, amount_to_scroll
);
15135 /* Extra precision for users who set scroll-conservatively
15136 to a large number: make sure the amount we scroll
15137 the window start is never less than amount_to_scroll,
15138 which was computed as distance from window bottom to
15139 point. This matters when lines at window top and lines
15140 below window bottom have different height. */
15142 void *it1data
= NULL
;
15143 /* We use a temporary it1 because line_bottom_y can modify
15144 its argument, if it moves one line down; see there. */
15147 SAVE_IT (it1
, it
, it1data
);
15148 start_y
= line_bottom_y (&it1
);
15150 RESTORE_IT (&it
, &it
, it1data
);
15151 move_it_by_lines (&it
, 1);
15152 SAVE_IT (it1
, it
, it1data
);
15153 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15156 /* If STARTP is unchanged, move it down another screen line. */
15157 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
15158 move_it_by_lines (&it
, 1);
15159 startp
= it
.current
.pos
;
15163 struct text_pos scroll_margin_pos
= startp
;
15166 /* See if point is inside the scroll margin at the top of the
15168 if (this_scroll_margin
)
15172 start_display (&it
, w
, startp
);
15173 y_start
= it
.current_y
;
15174 move_it_vertically (&it
, this_scroll_margin
);
15175 scroll_margin_pos
= it
.current
.pos
;
15176 /* If we didn't move enough before hitting ZV, request
15177 additional amount of scroll, to move point out of the
15179 if (IT_CHARPOS (it
) == ZV
15180 && it
.current_y
- y_start
< this_scroll_margin
)
15181 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15184 if (PT
< CHARPOS (scroll_margin_pos
))
15186 /* Point is in the scroll margin at the top of the window or
15187 above what is displayed in the window. */
15190 /* Compute the vertical distance from PT to the scroll
15191 margin position. Move as far as scroll_max allows, or
15192 one screenful, or 10 screen lines, whichever is largest.
15193 Give up if distance is greater than scroll_max or if we
15194 didn't reach the scroll margin position. */
15195 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15196 start_display (&it
, w
, pos
);
15198 y_to_move
= max (it
.last_visible_y
,
15199 max (scroll_max
, 10 * frame_line_height
));
15200 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15202 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15203 dy
= it
.current_y
- y0
;
15204 if (dy
> scroll_max
15205 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15206 return SCROLLING_FAILED
;
15208 /* Additional scroll for when ZV was too close to point. */
15211 /* Compute new window start. */
15212 start_display (&it
, w
, startp
);
15214 if (arg_scroll_conservatively
)
15215 amount_to_scroll
= max (dy
, frame_line_height
*
15216 max (scroll_step
, temp_scroll_step
));
15217 else if (scroll_step
|| temp_scroll_step
)
15218 amount_to_scroll
= scroll_max
;
15221 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15222 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15223 if (NUMBERP (aggressive
))
15225 double float_amount
= XFLOATINT (aggressive
) * height
;
15226 int aggressive_scroll
= float_amount
;
15227 if (aggressive_scroll
== 0 && float_amount
> 0)
15228 aggressive_scroll
= 1;
15229 /* Don't let point enter the scroll margin near
15230 bottom of the window, if the value of
15231 scroll_down_aggressively happens to be too
15233 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15234 aggressive_scroll
= height
- 2*this_scroll_margin
;
15235 amount_to_scroll
= dy
+ aggressive_scroll
;
15239 if (amount_to_scroll
<= 0)
15240 return SCROLLING_FAILED
;
15242 move_it_vertically_backward (&it
, amount_to_scroll
);
15243 startp
= it
.current
.pos
;
15247 /* Run window scroll functions. */
15248 startp
= run_window_scroll_functions (window
, startp
);
15250 /* Display the window. Give up if new fonts are loaded, or if point
15252 if (!try_window (window
, startp
, 0))
15253 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15254 else if (w
->cursor
.vpos
< 0)
15256 clear_glyph_matrix (w
->desired_matrix
);
15257 rc
= SCROLLING_FAILED
;
15261 /* Maybe forget recorded base line for line number display. */
15262 if (!just_this_one_p
15263 || current_buffer
->clip_changed
15264 || BEG_UNCHANGED
< CHARPOS (startp
))
15265 w
->base_line_number
= 0;
15267 /* If cursor ends up on a partially visible line,
15268 treat that as being off the bottom of the screen. */
15269 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
15270 /* It's possible that the cursor is on the first line of the
15271 buffer, which is partially obscured due to a vscroll
15272 (Bug#7537). In that case, avoid looping forever. */
15273 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15275 clear_glyph_matrix (w
->desired_matrix
);
15276 ++extra_scroll_margin_lines
;
15279 rc
= SCROLLING_SUCCESS
;
15286 /* Compute a suitable window start for window W if display of W starts
15287 on a continuation line. Value is non-zero if a new window start
15290 The new window start will be computed, based on W's width, starting
15291 from the start of the continued line. It is the start of the
15292 screen line with the minimum distance from the old start W->start. */
15295 compute_window_start_on_continuation_line (struct window
*w
)
15297 struct text_pos pos
, start_pos
;
15298 int window_start_changed_p
= 0;
15300 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15302 /* If window start is on a continuation line... Window start may be
15303 < BEGV in case there's invisible text at the start of the
15304 buffer (M-x rmail, for example). */
15305 if (CHARPOS (start_pos
) > BEGV
15306 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15309 struct glyph_row
*row
;
15311 /* Handle the case that the window start is out of range. */
15312 if (CHARPOS (start_pos
) < BEGV
)
15313 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15314 else if (CHARPOS (start_pos
) > ZV
)
15315 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15317 /* Find the start of the continued line. This should be fast
15318 because find_newline is fast (newline cache). */
15319 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
15320 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15321 row
, DEFAULT_FACE_ID
);
15322 reseat_at_previous_visible_line_start (&it
);
15324 /* If the line start is "too far" away from the window start,
15325 say it takes too much time to compute a new window start. */
15326 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15327 /* PXW: Do we need upper bounds here? */
15328 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15330 int min_distance
, distance
;
15332 /* Move forward by display lines to find the new window
15333 start. If window width was enlarged, the new start can
15334 be expected to be > the old start. If window width was
15335 decreased, the new window start will be < the old start.
15336 So, we're looking for the display line start with the
15337 minimum distance from the old window start. */
15338 pos
= it
.current
.pos
;
15339 min_distance
= INFINITY
;
15340 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15341 distance
< min_distance
)
15343 min_distance
= distance
;
15344 pos
= it
.current
.pos
;
15345 if (it
.line_wrap
== WORD_WRAP
)
15347 /* Under WORD_WRAP, move_it_by_lines is likely to
15348 overshoot and stop not at the first, but the
15349 second character from the left margin. So in
15350 that case, we need a more tight control on the X
15351 coordinate of the iterator than move_it_by_lines
15352 promises in its contract. The method is to first
15353 go to the last (rightmost) visible character of a
15354 line, then move to the leftmost character on the
15355 next line in a separate call. */
15356 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15357 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15358 move_it_to (&it
, ZV
, 0,
15359 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15360 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15363 move_it_by_lines (&it
, 1);
15366 /* Set the window start there. */
15367 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15368 window_start_changed_p
= 1;
15372 return window_start_changed_p
;
15376 /* Try cursor movement in case text has not changed in window WINDOW,
15377 with window start STARTP. Value is
15379 CURSOR_MOVEMENT_SUCCESS if successful
15381 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15383 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15384 display. *SCROLL_STEP is set to 1, under certain circumstances, if
15385 we want to scroll as if scroll-step were set to 1. See the code.
15387 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15388 which case we have to abort this redisplay, and adjust matrices
15393 CURSOR_MOVEMENT_SUCCESS
,
15394 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15395 CURSOR_MOVEMENT_MUST_SCROLL
,
15396 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15400 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
15402 struct window
*w
= XWINDOW (window
);
15403 struct frame
*f
= XFRAME (w
->frame
);
15404 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15407 if (inhibit_try_cursor_movement
)
15411 /* Previously, there was a check for Lisp integer in the
15412 if-statement below. Now, this field is converted to
15413 ptrdiff_t, thus zero means invalid position in a buffer. */
15414 eassert (w
->last_point
> 0);
15415 /* Likewise there was a check whether window_end_vpos is nil or larger
15416 than the window. Now window_end_vpos is int and so never nil, but
15417 let's leave eassert to check whether it fits in the window. */
15418 eassert (w
->window_end_vpos
< w
->current_matrix
->nrows
);
15420 /* Handle case where text has not changed, only point, and it has
15421 not moved off the frame. */
15422 if (/* Point may be in this window. */
15423 PT
>= CHARPOS (startp
)
15424 /* Selective display hasn't changed. */
15425 && !current_buffer
->clip_changed
15426 /* Function force-mode-line-update is used to force a thorough
15427 redisplay. It sets either windows_or_buffers_changed or
15428 update_mode_lines. So don't take a shortcut here for these
15430 && !update_mode_lines
15431 && !windows_or_buffers_changed
15432 && !f
->cursor_type_changed
15433 && NILP (Vshow_trailing_whitespace
)
15434 /* This code is not used for mini-buffer for the sake of the case
15435 of redisplaying to replace an echo area message; since in
15436 that case the mini-buffer contents per se are usually
15437 unchanged. This code is of no real use in the mini-buffer
15438 since the handling of this_line_start_pos, etc., in redisplay
15439 handles the same cases. */
15440 && !EQ (window
, minibuf_window
)
15441 && (FRAME_WINDOW_P (f
)
15442 || !overlay_arrow_in_current_buffer_p ()))
15444 int this_scroll_margin
, top_scroll_margin
;
15445 struct glyph_row
*row
= NULL
;
15446 int frame_line_height
= default_line_pixel_height (w
);
15447 int window_total_lines
15448 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15451 debug_method_add (w
, "cursor movement");
15454 /* Scroll if point within this distance from the top or bottom
15455 of the window. This is a pixel value. */
15456 if (scroll_margin
> 0)
15458 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15459 this_scroll_margin
*= frame_line_height
;
15462 this_scroll_margin
= 0;
15464 top_scroll_margin
= this_scroll_margin
;
15465 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15466 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15468 /* Start with the row the cursor was displayed during the last
15469 not paused redisplay. Give up if that row is not valid. */
15470 if (w
->last_cursor_vpos
< 0
15471 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15472 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15475 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15476 if (row
->mode_line_p
)
15478 if (!row
->enabled_p
)
15479 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15482 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15484 int scroll_p
= 0, must_scroll
= 0;
15485 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15487 if (PT
> w
->last_point
)
15489 /* Point has moved forward. */
15490 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15491 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15493 eassert (row
->enabled_p
);
15497 /* If the end position of a row equals the start
15498 position of the next row, and PT is at that position,
15499 we would rather display cursor in the next line. */
15500 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15501 && MATRIX_ROW_END_CHARPOS (row
) == PT
15502 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15503 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15504 && !cursor_row_p (row
))
15507 /* If within the scroll margin, scroll. Note that
15508 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15509 the next line would be drawn, and that
15510 this_scroll_margin can be zero. */
15511 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15512 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15513 /* Line is completely visible last line in window
15514 and PT is to be set in the next line. */
15515 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15516 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15517 && !row
->ends_at_zv_p
15518 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15521 else if (PT
< w
->last_point
)
15523 /* Cursor has to be moved backward. Note that PT >=
15524 CHARPOS (startp) because of the outer if-statement. */
15525 while (!row
->mode_line_p
15526 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15527 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15528 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15529 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15530 row
> w
->current_matrix
->rows
15531 && (row
-1)->ends_in_newline_from_string_p
))))
15532 && (row
->y
> top_scroll_margin
15533 || CHARPOS (startp
) == BEGV
))
15535 eassert (row
->enabled_p
);
15539 /* Consider the following case: Window starts at BEGV,
15540 there is invisible, intangible text at BEGV, so that
15541 display starts at some point START > BEGV. It can
15542 happen that we are called with PT somewhere between
15543 BEGV and START. Try to handle that case. */
15544 if (row
< w
->current_matrix
->rows
15545 || row
->mode_line_p
)
15547 row
= w
->current_matrix
->rows
;
15548 if (row
->mode_line_p
)
15552 /* Due to newlines in overlay strings, we may have to
15553 skip forward over overlay strings. */
15554 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15555 && MATRIX_ROW_END_CHARPOS (row
) == PT
15556 && !cursor_row_p (row
))
15559 /* If within the scroll margin, scroll. */
15560 if (row
->y
< top_scroll_margin
15561 && CHARPOS (startp
) != BEGV
)
15566 /* Cursor did not move. So don't scroll even if cursor line
15567 is partially visible, as it was so before. */
15568 rc
= CURSOR_MOVEMENT_SUCCESS
;
15571 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15572 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15574 /* if PT is not in the glyph row, give up. */
15575 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15578 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15579 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15581 struct glyph_row
*row1
;
15583 /* If rows are bidi-reordered and point moved, back up
15584 until we find a row that does not belong to a
15585 continuation line. This is because we must consider
15586 all rows of a continued line as candidates for the
15587 new cursor positioning, since row start and end
15588 positions change non-linearly with vertical position
15590 /* FIXME: Revisit this when glyph ``spilling'' in
15591 continuation lines' rows is implemented for
15592 bidi-reordered rows. */
15593 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15594 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15597 /* If we hit the beginning of the displayed portion
15598 without finding the first row of a continued
15602 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15605 eassert (row
->enabled_p
);
15610 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15611 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15612 /* Make sure this isn't a header line by any chance, since
15613 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15614 && !row
->mode_line_p
15615 && make_cursor_line_fully_visible_p
)
15617 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15618 && !row
->ends_at_zv_p
15619 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15620 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15621 else if (row
->height
> window_box_height (w
))
15623 /* If we end up in a partially visible line, let's
15624 make it fully visible, except when it's taller
15625 than the window, in which case we can't do much
15628 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15632 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15633 if (!cursor_row_fully_visible_p (w
, 0, 1))
15634 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15636 rc
= CURSOR_MOVEMENT_SUCCESS
;
15640 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15641 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15642 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15644 /* With bidi-reordered rows, there could be more than
15645 one candidate row whose start and end positions
15646 occlude point. We need to let set_cursor_from_row
15647 find the best candidate. */
15648 /* FIXME: Revisit this when glyph ``spilling'' in
15649 continuation lines' rows is implemented for
15650 bidi-reordered rows. */
15655 int at_zv_p
= 0, exact_match_p
= 0;
15657 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15658 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15659 && cursor_row_p (row
))
15660 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15662 /* As soon as we've found the exact match for point,
15663 or the first suitable row whose ends_at_zv_p flag
15664 is set, we are done. */
15667 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15668 w
->cursor
.vpos
)->ends_at_zv_p
;
15670 && w
->cursor
.hpos
>= 0
15671 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15674 struct glyph_row
*candidate
=
15675 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15677 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15678 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15681 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15682 || (INTEGERP (g
->object
)
15683 && (g
->charpos
== PT
15684 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15686 if (at_zv_p
|| exact_match_p
)
15688 rc
= CURSOR_MOVEMENT_SUCCESS
;
15692 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15696 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15697 || row
->continued_p
)
15698 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15699 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15700 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15701 /* If we didn't find any candidate rows, or exited the
15702 loop before all the candidates were examined, signal
15703 to the caller that this method failed. */
15704 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15706 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15707 && !row
->continued_p
))
15708 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15710 rc
= CURSOR_MOVEMENT_SUCCESS
;
15716 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15718 rc
= CURSOR_MOVEMENT_SUCCESS
;
15723 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15724 && MATRIX_ROW_START_CHARPOS (row
) == PT
15725 && cursor_row_p (row
));
15733 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15737 set_vertical_scroll_bar (struct window
*w
)
15739 ptrdiff_t start
, end
, whole
;
15741 /* Calculate the start and end positions for the current window.
15742 At some point, it would be nice to choose between scrollbars
15743 which reflect the whole buffer size, with special markers
15744 indicating narrowing, and scrollbars which reflect only the
15747 Note that mini-buffers sometimes aren't displaying any text. */
15748 if (!MINI_WINDOW_P (w
)
15749 || (w
== XWINDOW (minibuf_window
)
15750 && NILP (echo_area_buffer
[0])))
15752 struct buffer
*buf
= XBUFFER (w
->contents
);
15753 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15754 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15755 /* I don't think this is guaranteed to be right. For the
15756 moment, we'll pretend it is. */
15757 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15761 if (whole
< (end
- start
))
15762 whole
= end
- start
;
15765 start
= end
= whole
= 0;
15767 /* Indicate what this scroll bar ought to be displaying now. */
15768 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15769 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15770 (w
, end
- start
, whole
, start
);
15774 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15775 selected_window is redisplayed.
15777 We can return without actually redisplaying the window if fonts has been
15778 changed on window's frame. In that case, redisplay_internal will retry.
15780 As one of the important parts of redisplaying a window, we need to
15781 decide whether the previous window-start position (stored in the
15782 window's w->start marker position) is still valid, and if it isn't,
15783 recompute it. Some details about that:
15785 . The previous window-start could be in a continuation line, in
15786 which case we need to recompute it when the window width
15787 changes. See compute_window_start_on_continuation_line and its
15790 . The text that changed since last redisplay could include the
15791 previous window-start position. In that case, we try to salvage
15792 what we can from the current glyph matrix by calling
15793 try_scrolling, which see.
15795 . Some Emacs command could force us to use a specific window-start
15796 position by setting the window's force_start flag, or gently
15797 propose doing that by setting the window's optional_new_start
15798 flag. In these cases, we try using the specified start point if
15799 that succeeds (i.e. the window desired matrix is successfully
15800 recomputed, and point location is within the window). In case
15801 of optional_new_start, we first check if the specified start
15802 position is feasible, i.e. if it will allow point to be
15803 displayed in the window. If using the specified start point
15804 fails, e.g., if new fonts are needed to be loaded, we abort the
15805 redisplay cycle and leave it up to the next cycle to figure out
15808 . Note that the window's force_start flag is sometimes set by
15809 redisplay itself, when it decides that the previous window start
15810 point is fine and should be kept. Search for "goto force_start"
15811 below to see the details. Like the values of window-start
15812 specified outside of redisplay, these internally-deduced values
15813 are tested for feasibility, and ignored if found to be
15816 . Note that the function try_window, used to completely redisplay
15817 a window, accepts the window's start point as its argument.
15818 This is used several times in the redisplay code to control
15819 where the window start will be, according to user options such
15820 as scroll-conservatively, and also to ensure the screen line
15821 showing point will be fully (as opposed to partially) visible on
15825 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15827 struct window
*w
= XWINDOW (window
);
15828 struct frame
*f
= XFRAME (w
->frame
);
15829 struct buffer
*buffer
= XBUFFER (w
->contents
);
15830 struct buffer
*old
= current_buffer
;
15831 struct text_pos lpoint
, opoint
, startp
;
15832 int update_mode_line
;
15835 /* Record it now because it's overwritten. */
15836 bool current_matrix_up_to_date_p
= false;
15837 bool used_current_matrix_p
= false;
15838 /* This is less strict than current_matrix_up_to_date_p.
15839 It indicates that the buffer contents and narrowing are unchanged. */
15840 bool buffer_unchanged_p
= false;
15841 int temp_scroll_step
= 0;
15842 ptrdiff_t count
= SPECPDL_INDEX ();
15844 int centering_position
= -1;
15845 int last_line_misfit
= 0;
15846 ptrdiff_t beg_unchanged
, end_unchanged
;
15847 int frame_line_height
;
15849 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15853 *w
->desired_matrix
->method
= 0;
15856 if (!just_this_one_p
15857 && REDISPLAY_SOME_P ()
15860 && !buffer
->text
->redisplay
15861 && BUF_PT (buffer
) == w
->last_point
)
15864 /* Make sure that both W's markers are valid. */
15865 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15866 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15868 /* We come here again if we need to run window-text-change-functions
15871 reconsider_clip_changes (w
);
15872 frame_line_height
= default_line_pixel_height (w
);
15874 /* Has the mode line to be updated? */
15875 update_mode_line
= (w
->update_mode_line
15876 || update_mode_lines
15877 || buffer
->clip_changed
15878 || buffer
->prevent_redisplay_optimizations_p
);
15880 if (!just_this_one_p
)
15881 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15882 cleverly elsewhere. */
15883 w
->must_be_updated_p
= true;
15885 if (MINI_WINDOW_P (w
))
15887 if (w
== XWINDOW (echo_area_window
)
15888 && !NILP (echo_area_buffer
[0]))
15890 if (update_mode_line
)
15891 /* We may have to update a tty frame's menu bar or a
15892 tool-bar. Example `M-x C-h C-h C-g'. */
15893 goto finish_menu_bars
;
15895 /* We've already displayed the echo area glyphs in this window. */
15896 goto finish_scroll_bars
;
15898 else if ((w
!= XWINDOW (minibuf_window
)
15899 || minibuf_level
== 0)
15900 /* When buffer is nonempty, redisplay window normally. */
15901 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
15902 /* Quail displays non-mini buffers in minibuffer window.
15903 In that case, redisplay the window normally. */
15904 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
15906 /* W is a mini-buffer window, but it's not active, so clear
15908 int yb
= window_text_bottom_y (w
);
15909 struct glyph_row
*row
;
15912 for (y
= 0, row
= w
->desired_matrix
->rows
;
15914 y
+= row
->height
, ++row
)
15915 blank_row (w
, row
, y
);
15916 goto finish_scroll_bars
;
15919 clear_glyph_matrix (w
->desired_matrix
);
15922 /* Otherwise set up data on this window; select its buffer and point
15924 /* Really select the buffer, for the sake of buffer-local
15926 set_buffer_internal_1 (XBUFFER (w
->contents
));
15928 current_matrix_up_to_date_p
15929 = (w
->window_end_valid
15930 && !current_buffer
->clip_changed
15931 && !current_buffer
->prevent_redisplay_optimizations_p
15932 && !window_outdated (w
));
15934 /* Run the window-text-change-functions
15935 if it is possible that the text on the screen has changed
15936 (either due to modification of the text, or any other reason). */
15937 if (!current_matrix_up_to_date_p
15938 && !NILP (Vwindow_text_change_functions
))
15940 safe_run_hooks (Qwindow_text_change_functions
);
15944 beg_unchanged
= BEG_UNCHANGED
;
15945 end_unchanged
= END_UNCHANGED
;
15947 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15949 specbind (Qinhibit_point_motion_hooks
, Qt
);
15952 = (w
->window_end_valid
15953 && !current_buffer
->clip_changed
15954 && !window_outdated (w
));
15956 /* When windows_or_buffers_changed is non-zero, we can't rely
15957 on the window end being valid, so set it to zero there. */
15958 if (windows_or_buffers_changed
)
15960 /* If window starts on a continuation line, maybe adjust the
15961 window start in case the window's width changed. */
15962 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15963 compute_window_start_on_continuation_line (w
);
15965 w
->window_end_valid
= false;
15966 /* If so, we also can't rely on current matrix
15967 and should not fool try_cursor_movement below. */
15968 current_matrix_up_to_date_p
= false;
15971 /* Some sanity checks. */
15972 CHECK_WINDOW_END (w
);
15973 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15975 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15978 if (mode_line_update_needed (w
))
15979 update_mode_line
= 1;
15981 /* Point refers normally to the selected window. For any other
15982 window, set up appropriate value. */
15983 if (!EQ (window
, selected_window
))
15985 ptrdiff_t new_pt
= marker_position (w
->pointm
);
15986 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
15990 new_pt_byte
= BEGV_BYTE
;
15991 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15993 else if (new_pt
> (ZV
- 1))
15996 new_pt_byte
= ZV_BYTE
;
15997 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16000 /* We don't use SET_PT so that the point-motion hooks don't run. */
16001 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16004 /* If any of the character widths specified in the display table
16005 have changed, invalidate the width run cache. It's true that
16006 this may be a bit late to catch such changes, but the rest of
16007 redisplay goes (non-fatally) haywire when the display table is
16008 changed, so why should we worry about doing any better? */
16009 if (current_buffer
->width_run_cache
16010 || (current_buffer
->base_buffer
16011 && current_buffer
->base_buffer
->width_run_cache
))
16013 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16015 if (! disptab_matches_widthtab
16016 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16018 struct buffer
*buf
= current_buffer
;
16020 if (buf
->base_buffer
)
16021 buf
= buf
->base_buffer
;
16022 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16023 recompute_width_table (current_buffer
, disptab
);
16027 /* If window-start is screwed up, choose a new one. */
16028 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16031 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16033 /* If someone specified a new starting point but did not insist,
16034 check whether it can be used. */
16035 if (w
->optional_new_start
16036 && CHARPOS (startp
) >= BEGV
16037 && CHARPOS (startp
) <= ZV
)
16039 w
->optional_new_start
= 0;
16040 start_display (&it
, w
, startp
);
16041 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16042 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16043 if (IT_CHARPOS (it
) == PT
)
16044 w
->force_start
= 1;
16045 /* IT may overshoot PT if text at PT is invisible. */
16046 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
16047 w
->force_start
= 1;
16052 /* Handle case where place to start displaying has been specified,
16053 unless the specified location is outside the accessible range. */
16054 if (w
->force_start
|| window_frozen_p (w
))
16056 /* We set this later on if we have to adjust point. */
16059 w
->force_start
= 0;
16061 w
->window_end_valid
= 0;
16063 /* Forget any recorded base line for line number display. */
16064 if (!buffer_unchanged_p
)
16065 w
->base_line_number
= 0;
16067 /* Redisplay the mode line. Select the buffer properly for that.
16068 Also, run the hook window-scroll-functions
16069 because we have scrolled. */
16070 /* Note, we do this after clearing force_start because
16071 if there's an error, it is better to forget about force_start
16072 than to get into an infinite loop calling the hook functions
16073 and having them get more errors. */
16074 if (!update_mode_line
16075 || ! NILP (Vwindow_scroll_functions
))
16077 update_mode_line
= 1;
16078 w
->update_mode_line
= 1;
16079 startp
= run_window_scroll_functions (window
, startp
);
16082 if (CHARPOS (startp
) < BEGV
)
16083 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16084 else if (CHARPOS (startp
) > ZV
)
16085 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16087 /* Redisplay, then check if cursor has been set during the
16088 redisplay. Give up if new fonts were loaded. */
16089 /* We used to issue a CHECK_MARGINS argument to try_window here,
16090 but this causes scrolling to fail when point begins inside
16091 the scroll margin (bug#148) -- cyd */
16092 if (!try_window (window
, startp
, 0))
16094 w
->force_start
= 1;
16095 clear_glyph_matrix (w
->desired_matrix
);
16096 goto need_larger_matrices
;
16099 if (w
->cursor
.vpos
< 0 && !window_frozen_p (w
))
16101 /* If point does not appear, try to move point so it does
16102 appear. The desired matrix has been built above, so we
16103 can use it here. */
16104 new_vpos
= window_box_height (w
) / 2;
16107 if (!cursor_row_fully_visible_p (w
, 0, 0))
16109 /* Point does appear, but on a line partly visible at end of window.
16110 Move it back to a fully-visible line. */
16111 new_vpos
= window_box_height (w
);
16112 /* But if window_box_height suggests a Y coordinate that is
16113 not less than we already have, that line will clearly not
16114 be fully visible, so give up and scroll the display.
16115 This can happen when the default face uses a font whose
16116 dimensions are different from the frame's default
16118 if (new_vpos
>= w
->cursor
.y
)
16120 w
->cursor
.vpos
= -1;
16121 clear_glyph_matrix (w
->desired_matrix
);
16122 goto try_to_scroll
;
16125 else if (w
->cursor
.vpos
>= 0)
16127 /* Some people insist on not letting point enter the scroll
16128 margin, even though this part handles windows that didn't
16130 int window_total_lines
16131 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16132 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16133 int pixel_margin
= margin
* frame_line_height
;
16134 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16136 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16137 below, which finds the row to move point to, advances by
16138 the Y coordinate of the _next_ row, see the definition of
16139 MATRIX_ROW_BOTTOM_Y. */
16140 if (w
->cursor
.vpos
< margin
+ header_line
)
16142 w
->cursor
.vpos
= -1;
16143 clear_glyph_matrix (w
->desired_matrix
);
16144 goto try_to_scroll
;
16148 int window_height
= window_box_height (w
);
16151 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16152 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16154 w
->cursor
.vpos
= -1;
16155 clear_glyph_matrix (w
->desired_matrix
);
16156 goto try_to_scroll
;
16161 /* If we need to move point for either of the above reasons,
16162 now actually do it. */
16165 struct glyph_row
*row
;
16167 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16168 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16171 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16172 MATRIX_ROW_START_BYTEPOS (row
));
16174 if (w
!= XWINDOW (selected_window
))
16175 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16176 else if (current_buffer
== old
)
16177 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16179 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16181 /* If we are highlighting the region, then we just changed
16182 the region, so redisplay to show it. */
16183 /* FIXME: We need to (re)run pre-redisplay-function! */
16184 /* if (markpos_of_region () >= 0)
16186 clear_glyph_matrix (w->desired_matrix);
16187 if (!try_window (window, startp, 0))
16188 goto need_larger_matrices;
16194 debug_method_add (w
, "forced window start");
16199 /* Handle case where text has not changed, only point, and it has
16200 not moved off the frame, and we are not retrying after hscroll.
16201 (current_matrix_up_to_date_p is nonzero when retrying.) */
16202 if (current_matrix_up_to_date_p
16203 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16204 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16208 case CURSOR_MOVEMENT_SUCCESS
:
16209 used_current_matrix_p
= 1;
16212 case CURSOR_MOVEMENT_MUST_SCROLL
:
16213 goto try_to_scroll
;
16219 /* If current starting point was originally the beginning of a line
16220 but no longer is, find a new starting point. */
16221 else if (w
->start_at_line_beg
16222 && !(CHARPOS (startp
) <= BEGV
16223 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16226 debug_method_add (w
, "recenter 1");
16231 /* Try scrolling with try_window_id. Value is > 0 if update has
16232 been done, it is -1 if we know that the same window start will
16233 not work. It is 0 if unsuccessful for some other reason. */
16234 else if ((tem
= try_window_id (w
)) != 0)
16237 debug_method_add (w
, "try_window_id %d", tem
);
16240 if (f
->fonts_changed
)
16241 goto need_larger_matrices
;
16245 /* Otherwise try_window_id has returned -1 which means that we
16246 don't want the alternative below this comment to execute. */
16248 else if (CHARPOS (startp
) >= BEGV
16249 && CHARPOS (startp
) <= ZV
16250 && PT
>= CHARPOS (startp
)
16251 && (CHARPOS (startp
) < ZV
16252 /* Avoid starting at end of buffer. */
16253 || CHARPOS (startp
) == BEGV
16254 || !window_outdated (w
)))
16256 int d1
, d2
, d3
, d4
, d5
, d6
;
16258 /* If first window line is a continuation line, and window start
16259 is inside the modified region, but the first change is before
16260 current window start, we must select a new window start.
16262 However, if this is the result of a down-mouse event (e.g. by
16263 extending the mouse-drag-overlay), we don't want to select a
16264 new window start, since that would change the position under
16265 the mouse, resulting in an unwanted mouse-movement rather
16266 than a simple mouse-click. */
16267 if (!w
->start_at_line_beg
16268 && NILP (do_mouse_tracking
)
16269 && CHARPOS (startp
) > BEGV
16270 && CHARPOS (startp
) > BEG
+ beg_unchanged
16271 && CHARPOS (startp
) <= Z
- end_unchanged
16272 /* Even if w->start_at_line_beg is nil, a new window may
16273 start at a line_beg, since that's how set_buffer_window
16274 sets it. So, we need to check the return value of
16275 compute_window_start_on_continuation_line. (See also
16277 && XMARKER (w
->start
)->buffer
== current_buffer
16278 && compute_window_start_on_continuation_line (w
)
16279 /* It doesn't make sense to force the window start like we
16280 do at label force_start if it is already known that point
16281 will not be visible in the resulting window, because
16282 doing so will move point from its correct position
16283 instead of scrolling the window to bring point into view.
16285 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
16287 w
->force_start
= 1;
16288 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16293 debug_method_add (w
, "same window start");
16296 /* Try to redisplay starting at same place as before.
16297 If point has not moved off frame, accept the results. */
16298 if (!current_matrix_up_to_date_p
16299 /* Don't use try_window_reusing_current_matrix in this case
16300 because a window scroll function can have changed the
16302 || !NILP (Vwindow_scroll_functions
)
16303 || MINI_WINDOW_P (w
)
16304 || !(used_current_matrix_p
16305 = try_window_reusing_current_matrix (w
)))
16307 IF_DEBUG (debug_method_add (w
, "1"));
16308 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16309 /* -1 means we need to scroll.
16310 0 means we need new matrices, but fonts_changed
16311 is set in that case, so we will detect it below. */
16312 goto try_to_scroll
;
16315 if (f
->fonts_changed
)
16316 goto need_larger_matrices
;
16318 if (w
->cursor
.vpos
>= 0)
16320 if (!just_this_one_p
16321 || current_buffer
->clip_changed
16322 || BEG_UNCHANGED
< CHARPOS (startp
))
16323 /* Forget any recorded base line for line number display. */
16324 w
->base_line_number
= 0;
16326 if (!cursor_row_fully_visible_p (w
, 1, 0))
16328 clear_glyph_matrix (w
->desired_matrix
);
16329 last_line_misfit
= 1;
16331 /* Drop through and scroll. */
16336 clear_glyph_matrix (w
->desired_matrix
);
16341 /* Redisplay the mode line. Select the buffer properly for that. */
16342 if (!update_mode_line
)
16344 update_mode_line
= 1;
16345 w
->update_mode_line
= 1;
16348 /* Try to scroll by specified few lines. */
16349 if ((scroll_conservatively
16350 || emacs_scroll_step
16351 || temp_scroll_step
16352 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16353 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16354 && CHARPOS (startp
) >= BEGV
16355 && CHARPOS (startp
) <= ZV
)
16357 /* The function returns -1 if new fonts were loaded, 1 if
16358 successful, 0 if not successful. */
16359 int ss
= try_scrolling (window
, just_this_one_p
,
16360 scroll_conservatively
,
16362 temp_scroll_step
, last_line_misfit
);
16365 case SCROLLING_SUCCESS
:
16368 case SCROLLING_NEED_LARGER_MATRICES
:
16369 goto need_larger_matrices
;
16371 case SCROLLING_FAILED
:
16379 /* Finally, just choose a place to start which positions point
16380 according to user preferences. */
16385 debug_method_add (w
, "recenter");
16388 /* Forget any previously recorded base line for line number display. */
16389 if (!buffer_unchanged_p
)
16390 w
->base_line_number
= 0;
16392 /* Determine the window start relative to point. */
16393 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16394 it
.current_y
= it
.last_visible_y
;
16395 if (centering_position
< 0)
16397 int window_total_lines
16398 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16401 ? min (scroll_margin
, window_total_lines
/ 4)
16403 ptrdiff_t margin_pos
= CHARPOS (startp
);
16404 Lisp_Object aggressive
;
16407 /* If there is a scroll margin at the top of the window, find
16408 its character position. */
16410 /* Cannot call start_display if startp is not in the
16411 accessible region of the buffer. This can happen when we
16412 have just switched to a different buffer and/or changed
16413 its restriction. In that case, startp is initialized to
16414 the character position 1 (BEGV) because we did not yet
16415 have chance to display the buffer even once. */
16416 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16419 void *it1data
= NULL
;
16421 SAVE_IT (it1
, it
, it1data
);
16422 start_display (&it1
, w
, startp
);
16423 move_it_vertically (&it1
, margin
* frame_line_height
);
16424 margin_pos
= IT_CHARPOS (it1
);
16425 RESTORE_IT (&it
, &it
, it1data
);
16427 scrolling_up
= PT
> margin_pos
;
16430 ? BVAR (current_buffer
, scroll_up_aggressively
)
16431 : BVAR (current_buffer
, scroll_down_aggressively
);
16433 if (!MINI_WINDOW_P (w
)
16434 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16438 /* Setting scroll-conservatively overrides
16439 scroll-*-aggressively. */
16440 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16442 double float_amount
= XFLOATINT (aggressive
);
16444 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16445 if (pt_offset
== 0 && float_amount
> 0)
16447 if (pt_offset
&& margin
> 0)
16450 /* Compute how much to move the window start backward from
16451 point so that point will be displayed where the user
16455 centering_position
= it
.last_visible_y
;
16457 centering_position
-= pt_offset
;
16458 centering_position
-=
16459 frame_line_height
* (1 + margin
+ (last_line_misfit
!= 0))
16460 + WINDOW_HEADER_LINE_HEIGHT (w
);
16461 /* Don't let point enter the scroll margin near top of
16463 if (centering_position
< margin
* frame_line_height
)
16464 centering_position
= margin
* frame_line_height
;
16467 centering_position
= margin
* frame_line_height
+ pt_offset
;
16470 /* Set the window start half the height of the window backward
16472 centering_position
= window_box_height (w
) / 2;
16474 move_it_vertically_backward (&it
, centering_position
);
16476 eassert (IT_CHARPOS (it
) >= BEGV
);
16478 /* The function move_it_vertically_backward may move over more
16479 than the specified y-distance. If it->w is small, e.g. a
16480 mini-buffer window, we may end up in front of the window's
16481 display area. Start displaying at the start of the line
16482 containing PT in this case. */
16483 if (it
.current_y
<= 0)
16485 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16486 move_it_vertically_backward (&it
, 0);
16490 it
.current_x
= it
.hpos
= 0;
16492 /* Set the window start position here explicitly, to avoid an
16493 infinite loop in case the functions in window-scroll-functions
16495 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16497 /* Run scroll hooks. */
16498 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16500 /* Redisplay the window. */
16501 if (!current_matrix_up_to_date_p
16502 || windows_or_buffers_changed
16503 || f
->cursor_type_changed
16504 /* Don't use try_window_reusing_current_matrix in this case
16505 because it can have changed the buffer. */
16506 || !NILP (Vwindow_scroll_functions
)
16507 || !just_this_one_p
16508 || MINI_WINDOW_P (w
)
16509 || !(used_current_matrix_p
16510 = try_window_reusing_current_matrix (w
)))
16511 try_window (window
, startp
, 0);
16513 /* If new fonts have been loaded (due to fontsets), give up. We
16514 have to start a new redisplay since we need to re-adjust glyph
16516 if (f
->fonts_changed
)
16517 goto need_larger_matrices
;
16519 /* If cursor did not appear assume that the middle of the window is
16520 in the first line of the window. Do it again with the next line.
16521 (Imagine a window of height 100, displaying two lines of height
16522 60. Moving back 50 from it->last_visible_y will end in the first
16524 if (w
->cursor
.vpos
< 0)
16526 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16528 clear_glyph_matrix (w
->desired_matrix
);
16529 move_it_by_lines (&it
, 1);
16530 try_window (window
, it
.current
.pos
, 0);
16532 else if (PT
< IT_CHARPOS (it
))
16534 clear_glyph_matrix (w
->desired_matrix
);
16535 move_it_by_lines (&it
, -1);
16536 try_window (window
, it
.current
.pos
, 0);
16540 /* Not much we can do about it. */
16544 /* Consider the following case: Window starts at BEGV, there is
16545 invisible, intangible text at BEGV, so that display starts at
16546 some point START > BEGV. It can happen that we are called with
16547 PT somewhere between BEGV and START. Try to handle that case,
16548 and similar ones. */
16549 if (w
->cursor
.vpos
< 0)
16551 /* First, try locating the proper glyph row for PT. */
16552 struct glyph_row
*row
=
16553 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16555 /* Sometimes point is at the beginning of invisible text that is
16556 before the 1st character displayed in the row. In that case,
16557 row_containing_pos fails to find the row, because no glyphs
16558 with appropriate buffer positions are present in the row.
16559 Therefore, we next try to find the row which shows the 1st
16560 position after the invisible text. */
16564 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16567 if (TEXT_PROP_MEANS_INVISIBLE (val
))
16570 Lisp_Object invis_end
=
16571 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16574 if (NATNUMP (invis_end
))
16575 alt_pos
= XFASTINT (invis_end
);
16578 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16582 /* Finally, fall back on the first row of the window after the
16583 header line (if any). This is slightly better than not
16584 displaying the cursor at all. */
16587 row
= w
->current_matrix
->rows
;
16588 if (row
->mode_line_p
)
16591 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16594 if (!cursor_row_fully_visible_p (w
, 0, 0))
16596 /* If vscroll is enabled, disable it and try again. */
16600 clear_glyph_matrix (w
->desired_matrix
);
16604 /* Users who set scroll-conservatively to a large number want
16605 point just above/below the scroll margin. If we ended up
16606 with point's row partially visible, move the window start to
16607 make that row fully visible and out of the margin. */
16608 if (scroll_conservatively
> SCROLL_LIMIT
)
16610 int window_total_lines
16611 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16614 ? min (scroll_margin
, window_total_lines
/ 4)
16616 int move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16618 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16619 clear_glyph_matrix (w
->desired_matrix
);
16620 if (1 == try_window (window
, it
.current
.pos
,
16621 TRY_WINDOW_CHECK_MARGINS
))
16625 /* If centering point failed to make the whole line visible,
16626 put point at the top instead. That has to make the whole line
16627 visible, if it can be done. */
16628 if (centering_position
== 0)
16631 clear_glyph_matrix (w
->desired_matrix
);
16632 centering_position
= 0;
16638 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16639 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16640 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16642 /* Display the mode line, if we must. */
16643 if ((update_mode_line
16644 /* If window not full width, must redo its mode line
16645 if (a) the window to its side is being redone and
16646 (b) we do a frame-based redisplay. This is a consequence
16647 of how inverted lines are drawn in frame-based redisplay. */
16648 || (!just_this_one_p
16649 && !FRAME_WINDOW_P (f
)
16650 && !WINDOW_FULL_WIDTH_P (w
))
16651 /* Line number to display. */
16652 || w
->base_line_pos
> 0
16653 /* Column number is displayed and different from the one displayed. */
16654 || (w
->column_number_displayed
!= -1
16655 && (w
->column_number_displayed
!= current_column ())))
16656 /* This means that the window has a mode line. */
16657 && (WINDOW_WANTS_MODELINE_P (w
)
16658 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16661 display_mode_lines (w
);
16663 /* If mode line height has changed, arrange for a thorough
16664 immediate redisplay using the correct mode line height. */
16665 if (WINDOW_WANTS_MODELINE_P (w
)
16666 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16668 f
->fonts_changed
= 1;
16669 w
->mode_line_height
= -1;
16670 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16671 = DESIRED_MODE_LINE_HEIGHT (w
);
16674 /* If header line height has changed, arrange for a thorough
16675 immediate redisplay using the correct header line height. */
16676 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16677 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16679 f
->fonts_changed
= 1;
16680 w
->header_line_height
= -1;
16681 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16682 = DESIRED_HEADER_LINE_HEIGHT (w
);
16685 if (f
->fonts_changed
)
16686 goto need_larger_matrices
;
16689 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16691 w
->base_line_pos
= 0;
16692 w
->base_line_number
= 0;
16697 /* When we reach a frame's selected window, redo the frame's menu bar. */
16698 if (update_mode_line
16699 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16701 int redisplay_menu_p
= 0;
16703 if (FRAME_WINDOW_P (f
))
16705 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16706 || defined (HAVE_NS) || defined (USE_GTK)
16707 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16709 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16713 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16715 if (redisplay_menu_p
)
16716 display_menu_bar (w
);
16718 #ifdef HAVE_WINDOW_SYSTEM
16719 if (FRAME_WINDOW_P (f
))
16721 #if defined (USE_GTK) || defined (HAVE_NS)
16722 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16723 redisplay_tool_bar (f
);
16725 if (WINDOWP (f
->tool_bar_window
)
16726 && (FRAME_TOOL_BAR_HEIGHT (f
) > 0
16727 || !NILP (Vauto_resize_tool_bars
))
16728 && redisplay_tool_bar (f
))
16729 ignore_mouse_drag_p
= 1;
16735 #ifdef HAVE_WINDOW_SYSTEM
16736 if (FRAME_WINDOW_P (f
)
16737 && update_window_fringes (w
, (just_this_one_p
16738 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16739 || w
->pseudo_window_p
)))
16743 if (draw_window_fringes (w
, 1))
16745 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16746 x_draw_right_divider (w
);
16748 x_draw_vertical_border (w
);
16754 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16755 x_draw_bottom_divider (w
);
16756 #endif /* HAVE_WINDOW_SYSTEM */
16758 /* We go to this label, with fonts_changed set, if it is
16759 necessary to try again using larger glyph matrices.
16760 We have to redeem the scroll bar even in this case,
16761 because the loop in redisplay_internal expects that. */
16762 need_larger_matrices
:
16764 finish_scroll_bars
:
16766 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16768 /* Set the thumb's position and size. */
16769 set_vertical_scroll_bar (w
);
16771 /* Note that we actually used the scroll bar attached to this
16772 window, so it shouldn't be deleted at the end of redisplay. */
16773 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16774 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16777 /* Restore current_buffer and value of point in it. The window
16778 update may have changed the buffer, so first make sure `opoint'
16779 is still valid (Bug#6177). */
16780 if (CHARPOS (opoint
) < BEGV
)
16781 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16782 else if (CHARPOS (opoint
) > ZV
)
16783 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16785 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16787 set_buffer_internal_1 (old
);
16788 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16789 shorter. This can be caused by log truncation in *Messages*. */
16790 if (CHARPOS (lpoint
) <= ZV
)
16791 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16793 unbind_to (count
, Qnil
);
16797 /* Build the complete desired matrix of WINDOW with a window start
16798 buffer position POS.
16800 Value is 1 if successful. It is zero if fonts were loaded during
16801 redisplay which makes re-adjusting glyph matrices necessary, and -1
16802 if point would appear in the scroll margins.
16803 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16804 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16808 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16810 struct window
*w
= XWINDOW (window
);
16812 struct glyph_row
*last_text_row
= NULL
;
16813 struct frame
*f
= XFRAME (w
->frame
);
16814 int frame_line_height
= default_line_pixel_height (w
);
16816 /* Make POS the new window start. */
16817 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16819 /* Mark cursor position as unknown. No overlay arrow seen. */
16820 w
->cursor
.vpos
= -1;
16821 overlay_arrow_seen
= 0;
16823 /* Initialize iterator and info to start at POS. */
16824 start_display (&it
, w
, pos
);
16826 /* Display all lines of W. */
16827 while (it
.current_y
< it
.last_visible_y
)
16829 if (display_line (&it
))
16830 last_text_row
= it
.glyph_row
- 1;
16831 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16835 /* Don't let the cursor end in the scroll margins. */
16836 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16837 && !MINI_WINDOW_P (w
))
16839 int this_scroll_margin
;
16840 int window_total_lines
16841 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16843 if (scroll_margin
> 0)
16845 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16846 this_scroll_margin
*= frame_line_height
;
16849 this_scroll_margin
= 0;
16851 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16852 && w
->cursor
.y
< this_scroll_margin
16853 && CHARPOS (pos
) > BEGV
16854 && IT_CHARPOS (it
) < ZV
)
16855 /* rms: considering make_cursor_line_fully_visible_p here
16856 seems to give wrong results. We don't want to recenter
16857 when the last line is partly visible, we want to allow
16858 that case to be handled in the usual way. */
16859 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16861 w
->cursor
.vpos
= -1;
16862 clear_glyph_matrix (w
->desired_matrix
);
16867 /* If bottom moved off end of frame, change mode line percentage. */
16868 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
16869 w
->update_mode_line
= 1;
16871 /* Set window_end_pos to the offset of the last character displayed
16872 on the window from the end of current_buffer. Set
16873 window_end_vpos to its row number. */
16876 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16877 adjust_window_ends (w
, last_text_row
, 0);
16879 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
16880 w
->window_end_vpos
)));
16884 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16885 w
->window_end_pos
= Z
- ZV
;
16886 w
->window_end_vpos
= 0;
16889 /* But that is not valid info until redisplay finishes. */
16890 w
->window_end_valid
= 0;
16896 /************************************************************************
16897 Window redisplay reusing current matrix when buffer has not changed
16898 ************************************************************************/
16900 /* Try redisplay of window W showing an unchanged buffer with a
16901 different window start than the last time it was displayed by
16902 reusing its current matrix. Value is non-zero if successful.
16903 W->start is the new window start. */
16906 try_window_reusing_current_matrix (struct window
*w
)
16908 struct frame
*f
= XFRAME (w
->frame
);
16909 struct glyph_row
*bottom_row
;
16912 struct text_pos start
, new_start
;
16913 int nrows_scrolled
, i
;
16914 struct glyph_row
*last_text_row
;
16915 struct glyph_row
*last_reused_text_row
;
16916 struct glyph_row
*start_row
;
16917 int start_vpos
, min_y
, max_y
;
16920 if (inhibit_try_window_reusing
)
16924 if (/* This function doesn't handle terminal frames. */
16925 !FRAME_WINDOW_P (f
)
16926 /* Don't try to reuse the display if windows have been split
16928 || windows_or_buffers_changed
16929 || f
->cursor_type_changed
)
16932 /* Can't do this if showing trailing whitespace. */
16933 if (!NILP (Vshow_trailing_whitespace
))
16936 /* If top-line visibility has changed, give up. */
16937 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16938 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16941 /* Give up if old or new display is scrolled vertically. We could
16942 make this function handle this, but right now it doesn't. */
16943 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16944 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16947 /* The variable new_start now holds the new window start. The old
16948 start `start' can be determined from the current matrix. */
16949 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16950 start
= start_row
->minpos
;
16951 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16953 /* Clear the desired matrix for the display below. */
16954 clear_glyph_matrix (w
->desired_matrix
);
16956 if (CHARPOS (new_start
) <= CHARPOS (start
))
16958 /* Don't use this method if the display starts with an ellipsis
16959 displayed for invisible text. It's not easy to handle that case
16960 below, and it's certainly not worth the effort since this is
16961 not a frequent case. */
16962 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16965 IF_DEBUG (debug_method_add (w
, "twu1"));
16967 /* Display up to a row that can be reused. The variable
16968 last_text_row is set to the last row displayed that displays
16969 text. Note that it.vpos == 0 if or if not there is a
16970 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16971 start_display (&it
, w
, new_start
);
16972 w
->cursor
.vpos
= -1;
16973 last_text_row
= last_reused_text_row
= NULL
;
16975 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
16977 /* If we have reached into the characters in the START row,
16978 that means the line boundaries have changed. So we
16979 can't start copying with the row START. Maybe it will
16980 work to start copying with the following row. */
16981 while (IT_CHARPOS (it
) > CHARPOS (start
))
16983 /* Advance to the next row as the "start". */
16985 start
= start_row
->minpos
;
16986 /* If there are no more rows to try, or just one, give up. */
16987 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16988 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16989 || CHARPOS (start
) == ZV
)
16991 clear_glyph_matrix (w
->desired_matrix
);
16995 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16997 /* If we have reached alignment, we can copy the rest of the
16999 if (IT_CHARPOS (it
) == CHARPOS (start
)
17000 /* Don't accept "alignment" inside a display vector,
17001 since start_row could have started in the middle of
17002 that same display vector (thus their character
17003 positions match), and we have no way of telling if
17004 that is the case. */
17005 && it
.current
.dpvec_index
< 0)
17008 if (display_line (&it
))
17009 last_text_row
= it
.glyph_row
- 1;
17013 /* A value of current_y < last_visible_y means that we stopped
17014 at the previous window start, which in turn means that we
17015 have at least one reusable row. */
17016 if (it
.current_y
< it
.last_visible_y
)
17018 struct glyph_row
*row
;
17020 /* IT.vpos always starts from 0; it counts text lines. */
17021 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17023 /* Find PT if not already found in the lines displayed. */
17024 if (w
->cursor
.vpos
< 0)
17026 int dy
= it
.current_y
- start_row
->y
;
17028 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17029 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17031 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17032 dy
, nrows_scrolled
);
17035 clear_glyph_matrix (w
->desired_matrix
);
17040 /* Scroll the display. Do it before the current matrix is
17041 changed. The problem here is that update has not yet
17042 run, i.e. part of the current matrix is not up to date.
17043 scroll_run_hook will clear the cursor, and use the
17044 current matrix to get the height of the row the cursor is
17046 run
.current_y
= start_row
->y
;
17047 run
.desired_y
= it
.current_y
;
17048 run
.height
= it
.last_visible_y
- it
.current_y
;
17050 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17053 FRAME_RIF (f
)->update_window_begin_hook (w
);
17054 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17055 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17056 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17060 /* Shift current matrix down by nrows_scrolled lines. */
17061 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17062 rotate_matrix (w
->current_matrix
,
17064 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17067 /* Disable lines that must be updated. */
17068 for (i
= 0; i
< nrows_scrolled
; ++i
)
17069 (start_row
+ i
)->enabled_p
= false;
17071 /* Re-compute Y positions. */
17072 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17073 max_y
= it
.last_visible_y
;
17074 for (row
= start_row
+ nrows_scrolled
;
17078 row
->y
= it
.current_y
;
17079 row
->visible_height
= row
->height
;
17081 if (row
->y
< min_y
)
17082 row
->visible_height
-= min_y
- row
->y
;
17083 if (row
->y
+ row
->height
> max_y
)
17084 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17085 if (row
->fringe_bitmap_periodic_p
)
17086 row
->redraw_fringe_bitmaps_p
= 1;
17088 it
.current_y
+= row
->height
;
17090 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17091 last_reused_text_row
= row
;
17092 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17096 /* Disable lines in the current matrix which are now
17097 below the window. */
17098 for (++row
; row
< bottom_row
; ++row
)
17099 row
->enabled_p
= row
->mode_line_p
= 0;
17102 /* Update window_end_pos etc.; last_reused_text_row is the last
17103 reused row from the current matrix containing text, if any.
17104 The value of last_text_row is the last displayed line
17105 containing text. */
17106 if (last_reused_text_row
)
17107 adjust_window_ends (w
, last_reused_text_row
, 1);
17108 else if (last_text_row
)
17109 adjust_window_ends (w
, last_text_row
, 0);
17112 /* This window must be completely empty. */
17113 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17114 w
->window_end_pos
= Z
- ZV
;
17115 w
->window_end_vpos
= 0;
17117 w
->window_end_valid
= 0;
17119 /* Update hint: don't try scrolling again in update_window. */
17120 w
->desired_matrix
->no_scrolling_p
= 1;
17123 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17127 else if (CHARPOS (new_start
) > CHARPOS (start
))
17129 struct glyph_row
*pt_row
, *row
;
17130 struct glyph_row
*first_reusable_row
;
17131 struct glyph_row
*first_row_to_display
;
17133 int yb
= window_text_bottom_y (w
);
17135 /* Find the row starting at new_start, if there is one. Don't
17136 reuse a partially visible line at the end. */
17137 first_reusable_row
= start_row
;
17138 while (first_reusable_row
->enabled_p
17139 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17140 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17141 < CHARPOS (new_start
)))
17142 ++first_reusable_row
;
17144 /* Give up if there is no row to reuse. */
17145 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17146 || !first_reusable_row
->enabled_p
17147 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17148 != CHARPOS (new_start
)))
17151 /* We can reuse fully visible rows beginning with
17152 first_reusable_row to the end of the window. Set
17153 first_row_to_display to the first row that cannot be reused.
17154 Set pt_row to the row containing point, if there is any. */
17156 for (first_row_to_display
= first_reusable_row
;
17157 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17158 ++first_row_to_display
)
17160 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17161 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17162 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17163 && first_row_to_display
->ends_at_zv_p
17164 && pt_row
== NULL
)))
17165 pt_row
= first_row_to_display
;
17168 /* Start displaying at the start of first_row_to_display. */
17169 eassert (first_row_to_display
->y
< yb
);
17170 init_to_row_start (&it
, w
, first_row_to_display
);
17172 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17174 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17176 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17177 + WINDOW_HEADER_LINE_HEIGHT (w
));
17179 /* Display lines beginning with first_row_to_display in the
17180 desired matrix. Set last_text_row to the last row displayed
17181 that displays text. */
17182 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17183 if (pt_row
== NULL
)
17184 w
->cursor
.vpos
= -1;
17185 last_text_row
= NULL
;
17186 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17187 if (display_line (&it
))
17188 last_text_row
= it
.glyph_row
- 1;
17190 /* If point is in a reused row, adjust y and vpos of the cursor
17194 w
->cursor
.vpos
-= nrows_scrolled
;
17195 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17198 /* Give up if point isn't in a row displayed or reused. (This
17199 also handles the case where w->cursor.vpos < nrows_scrolled
17200 after the calls to display_line, which can happen with scroll
17201 margins. See bug#1295.) */
17202 if (w
->cursor
.vpos
< 0)
17204 clear_glyph_matrix (w
->desired_matrix
);
17208 /* Scroll the display. */
17209 run
.current_y
= first_reusable_row
->y
;
17210 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17211 run
.height
= it
.last_visible_y
- run
.current_y
;
17212 dy
= run
.current_y
- run
.desired_y
;
17217 FRAME_RIF (f
)->update_window_begin_hook (w
);
17218 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17219 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17220 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17224 /* Adjust Y positions of reused rows. */
17225 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17226 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17227 max_y
= it
.last_visible_y
;
17228 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17231 row
->visible_height
= row
->height
;
17232 if (row
->y
< min_y
)
17233 row
->visible_height
-= min_y
- row
->y
;
17234 if (row
->y
+ row
->height
> max_y
)
17235 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17236 if (row
->fringe_bitmap_periodic_p
)
17237 row
->redraw_fringe_bitmaps_p
= 1;
17240 /* Scroll the current matrix. */
17241 eassert (nrows_scrolled
> 0);
17242 rotate_matrix (w
->current_matrix
,
17244 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17247 /* Disable rows not reused. */
17248 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17249 row
->enabled_p
= false;
17251 /* Point may have moved to a different line, so we cannot assume that
17252 the previous cursor position is valid; locate the correct row. */
17255 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17257 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17258 && !row
->ends_at_zv_p
;
17262 w
->cursor
.y
= row
->y
;
17264 if (row
< bottom_row
)
17266 /* Can't simply scan the row for point with
17267 bidi-reordered glyph rows. Let set_cursor_from_row
17268 figure out where to put the cursor, and if it fails,
17270 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17272 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17275 clear_glyph_matrix (w
->desired_matrix
);
17281 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17282 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17285 && (!BUFFERP (glyph
->object
)
17286 || glyph
->charpos
< PT
);
17290 w
->cursor
.x
+= glyph
->pixel_width
;
17296 /* Adjust window end. A null value of last_text_row means that
17297 the window end is in reused rows which in turn means that
17298 only its vpos can have changed. */
17300 adjust_window_ends (w
, last_text_row
, 0);
17302 w
->window_end_vpos
-= nrows_scrolled
;
17304 w
->window_end_valid
= 0;
17305 w
->desired_matrix
->no_scrolling_p
= 1;
17308 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17318 /************************************************************************
17319 Window redisplay reusing current matrix when buffer has changed
17320 ************************************************************************/
17322 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17323 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17324 ptrdiff_t *, ptrdiff_t *);
17325 static struct glyph_row
*
17326 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17327 struct glyph_row
*);
17330 /* Return the last row in MATRIX displaying text. If row START is
17331 non-null, start searching with that row. IT gives the dimensions
17332 of the display. Value is null if matrix is empty; otherwise it is
17333 a pointer to the row found. */
17335 static struct glyph_row
*
17336 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17337 struct glyph_row
*start
)
17339 struct glyph_row
*row
, *row_found
;
17341 /* Set row_found to the last row in IT->w's current matrix
17342 displaying text. The loop looks funny but think of partially
17345 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17346 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17348 eassert (row
->enabled_p
);
17350 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17359 /* Return the last row in the current matrix of W that is not affected
17360 by changes at the start of current_buffer that occurred since W's
17361 current matrix was built. Value is null if no such row exists.
17363 BEG_UNCHANGED us the number of characters unchanged at the start of
17364 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17365 first changed character in current_buffer. Characters at positions <
17366 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17367 when the current matrix was built. */
17369 static struct glyph_row
*
17370 find_last_unchanged_at_beg_row (struct window
*w
)
17372 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17373 struct glyph_row
*row
;
17374 struct glyph_row
*row_found
= NULL
;
17375 int yb
= window_text_bottom_y (w
);
17377 /* Find the last row displaying unchanged text. */
17378 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17379 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17380 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17383 if (/* If row ends before first_changed_pos, it is unchanged,
17384 except in some case. */
17385 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17386 /* When row ends in ZV and we write at ZV it is not
17388 && !row
->ends_at_zv_p
17389 /* When first_changed_pos is the end of a continued line,
17390 row is not unchanged because it may be no longer
17392 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17393 && (row
->continued_p
17394 || row
->exact_window_width_line_p
))
17395 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17396 needs to be recomputed, so don't consider this row as
17397 unchanged. This happens when the last line was
17398 bidi-reordered and was killed immediately before this
17399 redisplay cycle. In that case, ROW->end stores the
17400 buffer position of the first visual-order character of
17401 the killed text, which is now beyond ZV. */
17402 && CHARPOS (row
->end
.pos
) <= ZV
)
17405 /* Stop if last visible row. */
17406 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17414 /* Find the first glyph row in the current matrix of W that is not
17415 affected by changes at the end of current_buffer since the
17416 time W's current matrix was built.
17418 Return in *DELTA the number of chars by which buffer positions in
17419 unchanged text at the end of current_buffer must be adjusted.
17421 Return in *DELTA_BYTES the corresponding number of bytes.
17423 Value is null if no such row exists, i.e. all rows are affected by
17426 static struct glyph_row
*
17427 find_first_unchanged_at_end_row (struct window
*w
,
17428 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17430 struct glyph_row
*row
;
17431 struct glyph_row
*row_found
= NULL
;
17433 *delta
= *delta_bytes
= 0;
17435 /* Display must not have been paused, otherwise the current matrix
17436 is not up to date. */
17437 eassert (w
->window_end_valid
);
17439 /* A value of window_end_pos >= END_UNCHANGED means that the window
17440 end is in the range of changed text. If so, there is no
17441 unchanged row at the end of W's current matrix. */
17442 if (w
->window_end_pos
>= END_UNCHANGED
)
17445 /* Set row to the last row in W's current matrix displaying text. */
17446 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17448 /* If matrix is entirely empty, no unchanged row exists. */
17449 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17451 /* The value of row is the last glyph row in the matrix having a
17452 meaningful buffer position in it. The end position of row
17453 corresponds to window_end_pos. This allows us to translate
17454 buffer positions in the current matrix to current buffer
17455 positions for characters not in changed text. */
17457 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17458 ptrdiff_t Z_BYTE_old
=
17459 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17460 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17461 struct glyph_row
*first_text_row
17462 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17464 *delta
= Z
- Z_old
;
17465 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17467 /* Set last_unchanged_pos to the buffer position of the last
17468 character in the buffer that has not been changed. Z is the
17469 index + 1 of the last character in current_buffer, i.e. by
17470 subtracting END_UNCHANGED we get the index of the last
17471 unchanged character, and we have to add BEG to get its buffer
17473 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17474 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17476 /* Search backward from ROW for a row displaying a line that
17477 starts at a minimum position >= last_unchanged_pos_old. */
17478 for (; row
> first_text_row
; --row
)
17480 /* This used to abort, but it can happen.
17481 It is ok to just stop the search instead here. KFS. */
17482 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17485 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17490 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17496 /* Make sure that glyph rows in the current matrix of window W
17497 reference the same glyph memory as corresponding rows in the
17498 frame's frame matrix. This function is called after scrolling W's
17499 current matrix on a terminal frame in try_window_id and
17500 try_window_reusing_current_matrix. */
17503 sync_frame_with_window_matrix_rows (struct window
*w
)
17505 struct frame
*f
= XFRAME (w
->frame
);
17506 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17508 /* Preconditions: W must be a leaf window and full-width. Its frame
17509 must have a frame matrix. */
17510 eassert (BUFFERP (w
->contents
));
17511 eassert (WINDOW_FULL_WIDTH_P (w
));
17512 eassert (!FRAME_WINDOW_P (f
));
17514 /* If W is a full-width window, glyph pointers in W's current matrix
17515 have, by definition, to be the same as glyph pointers in the
17516 corresponding frame matrix. Note that frame matrices have no
17517 marginal areas (see build_frame_matrix). */
17518 window_row
= w
->current_matrix
->rows
;
17519 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17520 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17521 while (window_row
< window_row_end
)
17523 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17524 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17526 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17527 frame_row
->glyphs
[TEXT_AREA
] = start
;
17528 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17529 frame_row
->glyphs
[LAST_AREA
] = end
;
17531 /* Disable frame rows whose corresponding window rows have
17532 been disabled in try_window_id. */
17533 if (!window_row
->enabled_p
)
17534 frame_row
->enabled_p
= false;
17536 ++window_row
, ++frame_row
;
17541 /* Find the glyph row in window W containing CHARPOS. Consider all
17542 rows between START and END (not inclusive). END null means search
17543 all rows to the end of the display area of W. Value is the row
17544 containing CHARPOS or null. */
17547 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17548 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17550 struct glyph_row
*row
= start
;
17551 struct glyph_row
*best_row
= NULL
;
17552 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17555 /* If we happen to start on a header-line, skip that. */
17556 if (row
->mode_line_p
)
17559 if ((end
&& row
>= end
) || !row
->enabled_p
)
17562 last_y
= window_text_bottom_y (w
) - dy
;
17566 /* Give up if we have gone too far. */
17567 if (end
&& row
>= end
)
17569 /* This formerly returned if they were equal.
17570 I think that both quantities are of a "last plus one" type;
17571 if so, when they are equal, the row is within the screen. -- rms. */
17572 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17575 /* If it is in this row, return this row. */
17576 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17577 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17578 /* The end position of a row equals the start
17579 position of the next row. If CHARPOS is there, we
17580 would rather consider it displayed in the next
17581 line, except when this line ends in ZV. */
17582 && !row_for_charpos_p (row
, charpos
)))
17583 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17587 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17588 || (!best_row
&& !row
->continued_p
))
17590 /* In bidi-reordered rows, there could be several rows whose
17591 edges surround CHARPOS, all of these rows belonging to
17592 the same continued line. We need to find the row which
17593 fits CHARPOS the best. */
17594 for (g
= row
->glyphs
[TEXT_AREA
];
17595 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17598 if (!STRINGP (g
->object
))
17600 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17602 mindif
= eabs (g
->charpos
- charpos
);
17604 /* Exact match always wins. */
17611 else if (best_row
&& !row
->continued_p
)
17618 /* Try to redisplay window W by reusing its existing display. W's
17619 current matrix must be up to date when this function is called,
17620 i.e. window_end_valid must be nonzero.
17624 >= 1 if successful, i.e. display has been updated
17626 1 means the changes were in front of a newline that precedes
17627 the window start, and the whole current matrix was reused
17628 2 means the changes were after the last position displayed
17629 in the window, and the whole current matrix was reused
17630 3 means portions of the current matrix were reused, while
17631 some of the screen lines were redrawn
17632 -1 if redisplay with same window start is known not to succeed
17633 0 if otherwise unsuccessful
17635 The following steps are performed:
17637 1. Find the last row in the current matrix of W that is not
17638 affected by changes at the start of current_buffer. If no such row
17641 2. Find the first row in W's current matrix that is not affected by
17642 changes at the end of current_buffer. Maybe there is no such row.
17644 3. Display lines beginning with the row + 1 found in step 1 to the
17645 row found in step 2 or, if step 2 didn't find a row, to the end of
17648 4. If cursor is not known to appear on the window, give up.
17650 5. If display stopped at the row found in step 2, scroll the
17651 display and current matrix as needed.
17653 6. Maybe display some lines at the end of W, if we must. This can
17654 happen under various circumstances, like a partially visible line
17655 becoming fully visible, or because newly displayed lines are displayed
17656 in smaller font sizes.
17658 7. Update W's window end information. */
17661 try_window_id (struct window
*w
)
17663 struct frame
*f
= XFRAME (w
->frame
);
17664 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17665 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17666 struct glyph_row
*last_unchanged_at_beg_row
;
17667 struct glyph_row
*first_unchanged_at_end_row
;
17668 struct glyph_row
*row
;
17669 struct glyph_row
*bottom_row
;
17672 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17674 struct text_pos start_pos
;
17676 int first_unchanged_at_end_vpos
= 0;
17677 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17678 struct text_pos start
;
17679 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17682 if (inhibit_try_window_id
)
17686 /* This is handy for debugging. */
17688 #define GIVE_UP(X) \
17690 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17694 #define GIVE_UP(X) return 0
17697 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17699 /* Don't use this for mini-windows because these can show
17700 messages and mini-buffers, and we don't handle that here. */
17701 if (MINI_WINDOW_P (w
))
17704 /* This flag is used to prevent redisplay optimizations. */
17705 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17708 /* This function's optimizations cannot be used if overlays have
17709 changed in the buffer displayed by the window, so give up if they
17711 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17714 /* Verify that narrowing has not changed.
17715 Also verify that we were not told to prevent redisplay optimizations.
17716 It would be nice to further
17717 reduce the number of cases where this prevents try_window_id. */
17718 if (current_buffer
->clip_changed
17719 || current_buffer
->prevent_redisplay_optimizations_p
)
17722 /* Window must either use window-based redisplay or be full width. */
17723 if (!FRAME_WINDOW_P (f
)
17724 && (!FRAME_LINE_INS_DEL_OK (f
)
17725 || !WINDOW_FULL_WIDTH_P (w
)))
17728 /* Give up if point is known NOT to appear in W. */
17729 if (PT
< CHARPOS (start
))
17732 /* Another way to prevent redisplay optimizations. */
17733 if (w
->last_modified
== 0)
17736 /* Verify that window is not hscrolled. */
17737 if (w
->hscroll
!= 0)
17740 /* Verify that display wasn't paused. */
17741 if (!w
->window_end_valid
)
17744 /* Likewise if highlighting trailing whitespace. */
17745 if (!NILP (Vshow_trailing_whitespace
))
17748 /* Can't use this if overlay arrow position and/or string have
17750 if (overlay_arrows_changed_p ())
17753 /* When word-wrap is on, adding a space to the first word of a
17754 wrapped line can change the wrap position, altering the line
17755 above it. It might be worthwhile to handle this more
17756 intelligently, but for now just redisplay from scratch. */
17757 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17760 /* Under bidi reordering, adding or deleting a character in the
17761 beginning of a paragraph, before the first strong directional
17762 character, can change the base direction of the paragraph (unless
17763 the buffer specifies a fixed paragraph direction), which will
17764 require to redisplay the whole paragraph. It might be worthwhile
17765 to find the paragraph limits and widen the range of redisplayed
17766 lines to that, but for now just give up this optimization and
17767 redisplay from scratch. */
17768 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17769 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17772 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17773 only if buffer has really changed. The reason is that the gap is
17774 initially at Z for freshly visited files. The code below would
17775 set end_unchanged to 0 in that case. */
17776 if (MODIFF
> SAVE_MODIFF
17777 /* This seems to happen sometimes after saving a buffer. */
17778 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17780 if (GPT
- BEG
< BEG_UNCHANGED
)
17781 BEG_UNCHANGED
= GPT
- BEG
;
17782 if (Z
- GPT
< END_UNCHANGED
)
17783 END_UNCHANGED
= Z
- GPT
;
17786 /* The position of the first and last character that has been changed. */
17787 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17788 last_changed_charpos
= Z
- END_UNCHANGED
;
17790 /* If window starts after a line end, and the last change is in
17791 front of that newline, then changes don't affect the display.
17792 This case happens with stealth-fontification. Note that although
17793 the display is unchanged, glyph positions in the matrix have to
17794 be adjusted, of course. */
17795 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17796 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17797 && ((last_changed_charpos
< CHARPOS (start
)
17798 && CHARPOS (start
) == BEGV
)
17799 || (last_changed_charpos
< CHARPOS (start
) - 1
17800 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17802 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17803 struct glyph_row
*r0
;
17805 /* Compute how many chars/bytes have been added to or removed
17806 from the buffer. */
17807 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17808 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17809 Z_delta
= Z
- Z_old
;
17810 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17812 /* Give up if PT is not in the window. Note that it already has
17813 been checked at the start of try_window_id that PT is not in
17814 front of the window start. */
17815 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17818 /* If window start is unchanged, we can reuse the whole matrix
17819 as is, after adjusting glyph positions. No need to compute
17820 the window end again, since its offset from Z hasn't changed. */
17821 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17822 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17823 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17824 /* PT must not be in a partially visible line. */
17825 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17826 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17828 /* Adjust positions in the glyph matrix. */
17829 if (Z_delta
|| Z_delta_bytes
)
17831 struct glyph_row
*r1
17832 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17833 increment_matrix_positions (w
->current_matrix
,
17834 MATRIX_ROW_VPOS (r0
, current_matrix
),
17835 MATRIX_ROW_VPOS (r1
, current_matrix
),
17836 Z_delta
, Z_delta_bytes
);
17839 /* Set the cursor. */
17840 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17842 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17847 /* Handle the case that changes are all below what is displayed in
17848 the window, and that PT is in the window. This shortcut cannot
17849 be taken if ZV is visible in the window, and text has been added
17850 there that is visible in the window. */
17851 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17852 /* ZV is not visible in the window, or there are no
17853 changes at ZV, actually. */
17854 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17855 || first_changed_charpos
== last_changed_charpos
))
17857 struct glyph_row
*r0
;
17859 /* Give up if PT is not in the window. Note that it already has
17860 been checked at the start of try_window_id that PT is not in
17861 front of the window start. */
17862 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17865 /* If window start is unchanged, we can reuse the whole matrix
17866 as is, without changing glyph positions since no text has
17867 been added/removed in front of the window end. */
17868 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17869 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17870 /* PT must not be in a partially visible line. */
17871 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17872 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17874 /* We have to compute the window end anew since text
17875 could have been added/removed after it. */
17876 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
17877 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17879 /* Set the cursor. */
17880 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17882 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17887 /* Give up if window start is in the changed area.
17889 The condition used to read
17891 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17893 but why that was tested escapes me at the moment. */
17894 if (CHARPOS (start
) >= first_changed_charpos
17895 && CHARPOS (start
) <= last_changed_charpos
)
17898 /* Check that window start agrees with the start of the first glyph
17899 row in its current matrix. Check this after we know the window
17900 start is not in changed text, otherwise positions would not be
17902 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17903 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17906 /* Give up if the window ends in strings. Overlay strings
17907 at the end are difficult to handle, so don't try. */
17908 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
17909 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17912 /* Compute the position at which we have to start displaying new
17913 lines. Some of the lines at the top of the window might be
17914 reusable because they are not displaying changed text. Find the
17915 last row in W's current matrix not affected by changes at the
17916 start of current_buffer. Value is null if changes start in the
17917 first line of window. */
17918 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17919 if (last_unchanged_at_beg_row
)
17921 /* Avoid starting to display in the middle of a character, a TAB
17922 for instance. This is easier than to set up the iterator
17923 exactly, and it's not a frequent case, so the additional
17924 effort wouldn't really pay off. */
17925 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17926 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17927 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17928 --last_unchanged_at_beg_row
;
17930 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17933 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17935 start_pos
= it
.current
.pos
;
17937 /* Start displaying new lines in the desired matrix at the same
17938 vpos we would use in the current matrix, i.e. below
17939 last_unchanged_at_beg_row. */
17940 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17942 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17943 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17945 eassert (it
.hpos
== 0 && it
.current_x
== 0);
17949 /* There are no reusable lines at the start of the window.
17950 Start displaying in the first text line. */
17951 start_display (&it
, w
, start
);
17952 it
.vpos
= it
.first_vpos
;
17953 start_pos
= it
.current
.pos
;
17956 /* Find the first row that is not affected by changes at the end of
17957 the buffer. Value will be null if there is no unchanged row, in
17958 which case we must redisplay to the end of the window. delta
17959 will be set to the value by which buffer positions beginning with
17960 first_unchanged_at_end_row have to be adjusted due to text
17962 first_unchanged_at_end_row
17963 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17964 IF_DEBUG (debug_delta
= delta
);
17965 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17967 /* Set stop_pos to the buffer position up to which we will have to
17968 display new lines. If first_unchanged_at_end_row != NULL, this
17969 is the buffer position of the start of the line displayed in that
17970 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17971 that we don't stop at a buffer position. */
17973 if (first_unchanged_at_end_row
)
17975 eassert (last_unchanged_at_beg_row
== NULL
17976 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17978 /* If this is a continuation line, move forward to the next one
17979 that isn't. Changes in lines above affect this line.
17980 Caution: this may move first_unchanged_at_end_row to a row
17981 not displaying text. */
17982 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17983 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17984 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17985 < it
.last_visible_y
))
17986 ++first_unchanged_at_end_row
;
17988 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17989 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17990 >= it
.last_visible_y
))
17991 first_unchanged_at_end_row
= NULL
;
17994 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17996 first_unchanged_at_end_vpos
17997 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17998 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18001 else if (last_unchanged_at_beg_row
== NULL
)
18007 /* Either there is no unchanged row at the end, or the one we have
18008 now displays text. This is a necessary condition for the window
18009 end pos calculation at the end of this function. */
18010 eassert (first_unchanged_at_end_row
== NULL
18011 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18013 debug_last_unchanged_at_beg_vpos
18014 = (last_unchanged_at_beg_row
18015 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18017 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18019 #endif /* GLYPH_DEBUG */
18022 /* Display new lines. Set last_text_row to the last new line
18023 displayed which has text on it, i.e. might end up as being the
18024 line where the window_end_vpos is. */
18025 w
->cursor
.vpos
= -1;
18026 last_text_row
= NULL
;
18027 overlay_arrow_seen
= 0;
18028 while (it
.current_y
< it
.last_visible_y
18029 && !f
->fonts_changed
18030 && (first_unchanged_at_end_row
== NULL
18031 || IT_CHARPOS (it
) < stop_pos
))
18033 if (display_line (&it
))
18034 last_text_row
= it
.glyph_row
- 1;
18037 if (f
->fonts_changed
)
18041 /* Compute differences in buffer positions, y-positions etc. for
18042 lines reused at the bottom of the window. Compute what we can
18044 if (first_unchanged_at_end_row
18045 /* No lines reused because we displayed everything up to the
18046 bottom of the window. */
18047 && it
.current_y
< it
.last_visible_y
)
18050 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18052 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18053 run
.current_y
= first_unchanged_at_end_row
->y
;
18054 run
.desired_y
= run
.current_y
+ dy
;
18055 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18059 delta
= delta_bytes
= dvpos
= dy
18060 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18061 first_unchanged_at_end_row
= NULL
;
18063 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18066 /* Find the cursor if not already found. We have to decide whether
18067 PT will appear on this window (it sometimes doesn't, but this is
18068 not a very frequent case.) This decision has to be made before
18069 the current matrix is altered. A value of cursor.vpos < 0 means
18070 that PT is either in one of the lines beginning at
18071 first_unchanged_at_end_row or below the window. Don't care for
18072 lines that might be displayed later at the window end; as
18073 mentioned, this is not a frequent case. */
18074 if (w
->cursor
.vpos
< 0)
18076 /* Cursor in unchanged rows at the top? */
18077 if (PT
< CHARPOS (start_pos
)
18078 && last_unchanged_at_beg_row
)
18080 row
= row_containing_pos (w
, PT
,
18081 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18082 last_unchanged_at_beg_row
+ 1, 0);
18084 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18087 /* Start from first_unchanged_at_end_row looking for PT. */
18088 else if (first_unchanged_at_end_row
)
18090 row
= row_containing_pos (w
, PT
- delta
,
18091 first_unchanged_at_end_row
, NULL
, 0);
18093 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18094 delta_bytes
, dy
, dvpos
);
18097 /* Give up if cursor was not found. */
18098 if (w
->cursor
.vpos
< 0)
18100 clear_glyph_matrix (w
->desired_matrix
);
18105 /* Don't let the cursor end in the scroll margins. */
18107 int this_scroll_margin
, cursor_height
;
18108 int frame_line_height
= default_line_pixel_height (w
);
18109 int window_total_lines
18110 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18112 this_scroll_margin
=
18113 max (0, min (scroll_margin
, window_total_lines
/ 4));
18114 this_scroll_margin
*= frame_line_height
;
18115 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18117 if ((w
->cursor
.y
< this_scroll_margin
18118 && CHARPOS (start
) > BEGV
)
18119 /* Old redisplay didn't take scroll margin into account at the bottom,
18120 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18121 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18122 ? cursor_height
+ this_scroll_margin
18123 : 1)) > it
.last_visible_y
)
18125 w
->cursor
.vpos
= -1;
18126 clear_glyph_matrix (w
->desired_matrix
);
18131 /* Scroll the display. Do it before changing the current matrix so
18132 that xterm.c doesn't get confused about where the cursor glyph is
18134 if (dy
&& run
.height
)
18138 if (FRAME_WINDOW_P (f
))
18140 FRAME_RIF (f
)->update_window_begin_hook (w
);
18141 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18142 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18143 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
18147 /* Terminal frame. In this case, dvpos gives the number of
18148 lines to scroll by; dvpos < 0 means scroll up. */
18150 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18151 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18152 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18153 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
18154 + window_internal_height (w
));
18156 #if defined (HAVE_GPM) || defined (MSDOS)
18157 x_clear_window_mouse_face (w
);
18159 /* Perform the operation on the screen. */
18162 /* Scroll last_unchanged_at_beg_row to the end of the
18163 window down dvpos lines. */
18164 set_terminal_window (f
, end
);
18166 /* On dumb terminals delete dvpos lines at the end
18167 before inserting dvpos empty lines. */
18168 if (!FRAME_SCROLL_REGION_OK (f
))
18169 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18171 /* Insert dvpos empty lines in front of
18172 last_unchanged_at_beg_row. */
18173 ins_del_lines (f
, from
, dvpos
);
18175 else if (dvpos
< 0)
18177 /* Scroll up last_unchanged_at_beg_vpos to the end of
18178 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18179 set_terminal_window (f
, end
);
18181 /* Delete dvpos lines in front of
18182 last_unchanged_at_beg_vpos. ins_del_lines will set
18183 the cursor to the given vpos and emit |dvpos| delete
18185 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18187 /* On a dumb terminal insert dvpos empty lines at the
18189 if (!FRAME_SCROLL_REGION_OK (f
))
18190 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18193 set_terminal_window (f
, 0);
18199 /* Shift reused rows of the current matrix to the right position.
18200 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18202 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18203 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18206 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18207 bottom_vpos
, dvpos
);
18208 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18211 else if (dvpos
> 0)
18213 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18214 bottom_vpos
, dvpos
);
18215 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18216 first_unchanged_at_end_vpos
+ dvpos
);
18219 /* For frame-based redisplay, make sure that current frame and window
18220 matrix are in sync with respect to glyph memory. */
18221 if (!FRAME_WINDOW_P (f
))
18222 sync_frame_with_window_matrix_rows (w
);
18224 /* Adjust buffer positions in reused rows. */
18225 if (delta
|| delta_bytes
)
18226 increment_matrix_positions (current_matrix
,
18227 first_unchanged_at_end_vpos
+ dvpos
,
18228 bottom_vpos
, delta
, delta_bytes
);
18230 /* Adjust Y positions. */
18232 shift_glyph_matrix (w
, current_matrix
,
18233 first_unchanged_at_end_vpos
+ dvpos
,
18236 if (first_unchanged_at_end_row
)
18238 first_unchanged_at_end_row
+= dvpos
;
18239 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18240 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18241 first_unchanged_at_end_row
= NULL
;
18244 /* If scrolling up, there may be some lines to display at the end of
18246 last_text_row_at_end
= NULL
;
18249 /* Scrolling up can leave for example a partially visible line
18250 at the end of the window to be redisplayed. */
18251 /* Set last_row to the glyph row in the current matrix where the
18252 window end line is found. It has been moved up or down in
18253 the matrix by dvpos. */
18254 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18255 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18257 /* If last_row is the window end line, it should display text. */
18258 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18260 /* If window end line was partially visible before, begin
18261 displaying at that line. Otherwise begin displaying with the
18262 line following it. */
18263 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18265 init_to_row_start (&it
, w
, last_row
);
18266 it
.vpos
= last_vpos
;
18267 it
.current_y
= last_row
->y
;
18271 init_to_row_end (&it
, w
, last_row
);
18272 it
.vpos
= 1 + last_vpos
;
18273 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18277 /* We may start in a continuation line. If so, we have to
18278 get the right continuation_lines_width and current_x. */
18279 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18280 it
.hpos
= it
.current_x
= 0;
18282 /* Display the rest of the lines at the window end. */
18283 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18284 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18286 /* Is it always sure that the display agrees with lines in
18287 the current matrix? I don't think so, so we mark rows
18288 displayed invalid in the current matrix by setting their
18289 enabled_p flag to zero. */
18290 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18291 if (display_line (&it
))
18292 last_text_row_at_end
= it
.glyph_row
- 1;
18296 /* Update window_end_pos and window_end_vpos. */
18297 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18299 /* Window end line if one of the preserved rows from the current
18300 matrix. Set row to the last row displaying text in current
18301 matrix starting at first_unchanged_at_end_row, after
18303 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18304 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18305 first_unchanged_at_end_row
);
18306 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18307 adjust_window_ends (w
, row
, 1);
18308 eassert (w
->window_end_bytepos
>= 0);
18309 IF_DEBUG (debug_method_add (w
, "A"));
18311 else if (last_text_row_at_end
)
18313 adjust_window_ends (w
, last_text_row_at_end
, 0);
18314 eassert (w
->window_end_bytepos
>= 0);
18315 IF_DEBUG (debug_method_add (w
, "B"));
18317 else if (last_text_row
)
18319 /* We have displayed either to the end of the window or at the
18320 end of the window, i.e. the last row with text is to be found
18321 in the desired matrix. */
18322 adjust_window_ends (w
, last_text_row
, 0);
18323 eassert (w
->window_end_bytepos
>= 0);
18325 else if (first_unchanged_at_end_row
== NULL
18326 && last_text_row
== NULL
18327 && last_text_row_at_end
== NULL
)
18329 /* Displayed to end of window, but no line containing text was
18330 displayed. Lines were deleted at the end of the window. */
18331 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
18332 int vpos
= w
->window_end_vpos
;
18333 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18334 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18337 row
== NULL
&& vpos
>= first_vpos
;
18338 --vpos
, --current_row
, --desired_row
)
18340 if (desired_row
->enabled_p
)
18342 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18345 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18349 eassert (row
!= NULL
);
18350 w
->window_end_vpos
= vpos
+ 1;
18351 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18352 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18353 eassert (w
->window_end_bytepos
>= 0);
18354 IF_DEBUG (debug_method_add (w
, "C"));
18359 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18360 debug_end_vpos
= w
->window_end_vpos
));
18362 /* Record that display has not been completed. */
18363 w
->window_end_valid
= 0;
18364 w
->desired_matrix
->no_scrolling_p
= 1;
18372 /***********************************************************************
18373 More debugging support
18374 ***********************************************************************/
18378 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18379 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18380 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18383 /* Dump the contents of glyph matrix MATRIX on stderr.
18385 GLYPHS 0 means don't show glyph contents.
18386 GLYPHS 1 means show glyphs in short form
18387 GLYPHS > 1 means show glyphs in long form. */
18390 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18393 for (i
= 0; i
< matrix
->nrows
; ++i
)
18394 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18398 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18399 the glyph row and area where the glyph comes from. */
18402 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18404 if (glyph
->type
== CHAR_GLYPH
18405 || glyph
->type
== GLYPHLESS_GLYPH
)
18408 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18409 glyph
- row
->glyphs
[TEXT_AREA
],
18410 (glyph
->type
== CHAR_GLYPH
18414 (BUFFERP (glyph
->object
)
18416 : (STRINGP (glyph
->object
)
18418 : (INTEGERP (glyph
->object
)
18421 glyph
->pixel_width
,
18423 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18427 glyph
->left_box_line_p
,
18428 glyph
->right_box_line_p
);
18430 else if (glyph
->type
== STRETCH_GLYPH
)
18433 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18434 glyph
- row
->glyphs
[TEXT_AREA
],
18437 (BUFFERP (glyph
->object
)
18439 : (STRINGP (glyph
->object
)
18441 : (INTEGERP (glyph
->object
)
18444 glyph
->pixel_width
,
18448 glyph
->left_box_line_p
,
18449 glyph
->right_box_line_p
);
18451 else if (glyph
->type
== IMAGE_GLYPH
)
18454 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18455 glyph
- row
->glyphs
[TEXT_AREA
],
18458 (BUFFERP (glyph
->object
)
18460 : (STRINGP (glyph
->object
)
18462 : (INTEGERP (glyph
->object
)
18465 glyph
->pixel_width
,
18469 glyph
->left_box_line_p
,
18470 glyph
->right_box_line_p
);
18472 else if (glyph
->type
== COMPOSITE_GLYPH
)
18475 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18476 glyph
- row
->glyphs
[TEXT_AREA
],
18479 (BUFFERP (glyph
->object
)
18481 : (STRINGP (glyph
->object
)
18483 : (INTEGERP (glyph
->object
)
18486 glyph
->pixel_width
,
18488 if (glyph
->u
.cmp
.automatic
)
18491 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18492 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18494 glyph
->left_box_line_p
,
18495 glyph
->right_box_line_p
);
18500 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18501 GLYPHS 0 means don't show glyph contents.
18502 GLYPHS 1 means show glyphs in short form
18503 GLYPHS > 1 means show glyphs in long form. */
18506 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18510 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18511 fprintf (stderr
, "==============================================================================\n");
18513 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18514 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18516 MATRIX_ROW_START_CHARPOS (row
),
18517 MATRIX_ROW_END_CHARPOS (row
),
18518 row
->used
[TEXT_AREA
],
18519 row
->contains_overlapping_glyphs_p
,
18521 row
->truncated_on_left_p
,
18522 row
->truncated_on_right_p
,
18524 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18525 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18528 row
->ends_in_middle_of_char_p
,
18529 row
->starts_in_middle_of_char_p
,
18535 row
->visible_height
,
18538 /* The next 3 lines should align to "Start" in the header. */
18539 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18540 row
->end
.overlay_string_index
,
18541 row
->continuation_lines_width
);
18542 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18543 CHARPOS (row
->start
.string_pos
),
18544 CHARPOS (row
->end
.string_pos
));
18545 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18546 row
->end
.dpvec_index
);
18553 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18555 struct glyph
*glyph
= row
->glyphs
[area
];
18556 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18558 /* Glyph for a line end in text. */
18559 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18562 if (glyph
< glyph_end
)
18563 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18565 for (; glyph
< glyph_end
; ++glyph
)
18566 dump_glyph (row
, glyph
, area
);
18569 else if (glyphs
== 1)
18573 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18575 char *s
= alloca (row
->used
[area
] + 4);
18578 for (i
= 0; i
< row
->used
[area
]; ++i
)
18580 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18581 if (i
== row
->used
[area
] - 1
18582 && area
== TEXT_AREA
18583 && INTEGERP (glyph
->object
)
18584 && glyph
->type
== CHAR_GLYPH
18585 && glyph
->u
.ch
== ' ')
18587 strcpy (&s
[i
], "[\\n]");
18590 else if (glyph
->type
== CHAR_GLYPH
18591 && glyph
->u
.ch
< 0x80
18592 && glyph
->u
.ch
>= ' ')
18593 s
[i
] = glyph
->u
.ch
;
18599 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18605 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18606 Sdump_glyph_matrix
, 0, 1, "p",
18607 doc
: /* Dump the current matrix of the selected window to stderr.
18608 Shows contents of glyph row structures. With non-nil
18609 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18610 glyphs in short form, otherwise show glyphs in long form. */)
18611 (Lisp_Object glyphs
)
18613 struct window
*w
= XWINDOW (selected_window
);
18614 struct buffer
*buffer
= XBUFFER (w
->contents
);
18616 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18617 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18618 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18619 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18620 fprintf (stderr
, "=============================================\n");
18621 dump_glyph_matrix (w
->current_matrix
,
18622 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18627 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18628 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
18631 struct frame
*f
= XFRAME (selected_frame
);
18632 dump_glyph_matrix (f
->current_matrix
, 1);
18637 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18638 doc
: /* Dump glyph row ROW to stderr.
18639 GLYPH 0 means don't dump glyphs.
18640 GLYPH 1 means dump glyphs in short form.
18641 GLYPH > 1 or omitted means dump glyphs in long form. */)
18642 (Lisp_Object row
, Lisp_Object glyphs
)
18644 struct glyph_matrix
*matrix
;
18647 CHECK_NUMBER (row
);
18648 matrix
= XWINDOW (selected_window
)->current_matrix
;
18650 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18651 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18653 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18658 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18659 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18660 GLYPH 0 means don't dump glyphs.
18661 GLYPH 1 means dump glyphs in short form.
18662 GLYPH > 1 or omitted means dump glyphs in long form.
18664 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18666 (Lisp_Object row
, Lisp_Object glyphs
)
18668 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18669 struct frame
*sf
= SELECTED_FRAME ();
18670 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18673 CHECK_NUMBER (row
);
18675 if (vpos
>= 0 && vpos
< m
->nrows
)
18676 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18677 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18683 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18684 doc
: /* Toggle tracing of redisplay.
18685 With ARG, turn tracing on if and only if ARG is positive. */)
18689 trace_redisplay_p
= !trace_redisplay_p
;
18692 arg
= Fprefix_numeric_value (arg
);
18693 trace_redisplay_p
= XINT (arg
) > 0;
18700 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18701 doc
: /* Like `format', but print result to stderr.
18702 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18703 (ptrdiff_t nargs
, Lisp_Object
*args
)
18705 Lisp_Object s
= Fformat (nargs
, args
);
18706 fprintf (stderr
, "%s", SDATA (s
));
18710 #endif /* GLYPH_DEBUG */
18714 /***********************************************************************
18715 Building Desired Matrix Rows
18716 ***********************************************************************/
18718 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18719 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18721 static struct glyph_row
*
18722 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18724 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18725 struct buffer
*buffer
= XBUFFER (w
->contents
);
18726 struct buffer
*old
= current_buffer
;
18727 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18728 int arrow_len
= SCHARS (overlay_arrow_string
);
18729 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18730 const unsigned char *p
;
18733 int n_glyphs_before
;
18735 set_buffer_temp (buffer
);
18736 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18737 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18738 SET_TEXT_POS (it
.position
, 0, 0);
18740 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18742 while (p
< arrow_end
)
18744 Lisp_Object face
, ilisp
;
18746 /* Get the next character. */
18748 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18751 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18752 if (! ASCII_CHAR_P (it
.c
))
18753 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18757 /* Get its face. */
18758 ilisp
= make_number (p
- arrow_string
);
18759 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18760 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18762 /* Compute its width, get its glyphs. */
18763 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18764 SET_TEXT_POS (it
.position
, -1, -1);
18765 PRODUCE_GLYPHS (&it
);
18767 /* If this character doesn't fit any more in the line, we have
18768 to remove some glyphs. */
18769 if (it
.current_x
> it
.last_visible_x
)
18771 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18776 set_buffer_temp (old
);
18777 return it
.glyph_row
;
18781 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18782 glyphs to insert is determined by produce_special_glyphs. */
18785 insert_left_trunc_glyphs (struct it
*it
)
18787 struct it truncate_it
;
18788 struct glyph
*from
, *end
, *to
, *toend
;
18790 eassert (!FRAME_WINDOW_P (it
->f
)
18791 || (!it
->glyph_row
->reversed_p
18792 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18793 || (it
->glyph_row
->reversed_p
18794 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18796 /* Get the truncation glyphs. */
18798 truncate_it
.current_x
= 0;
18799 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18800 truncate_it
.glyph_row
= &scratch_glyph_row
;
18801 truncate_it
.area
= TEXT_AREA
;
18802 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18803 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18804 truncate_it
.object
= make_number (0);
18805 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18807 /* Overwrite glyphs from IT with truncation glyphs. */
18808 if (!it
->glyph_row
->reversed_p
)
18810 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18812 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18813 end
= from
+ tused
;
18814 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18815 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18816 if (FRAME_WINDOW_P (it
->f
))
18818 /* On GUI frames, when variable-size fonts are displayed,
18819 the truncation glyphs may need more pixels than the row's
18820 glyphs they overwrite. We overwrite more glyphs to free
18821 enough screen real estate, and enlarge the stretch glyph
18822 on the right (see display_line), if there is one, to
18823 preserve the screen position of the truncation glyphs on
18826 struct glyph
*g
= to
;
18829 /* The first glyph could be partially visible, in which case
18830 it->glyph_row->x will be negative. But we want the left
18831 truncation glyphs to be aligned at the left margin of the
18832 window, so we override the x coordinate at which the row
18834 it
->glyph_row
->x
= 0;
18835 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18837 w
+= g
->pixel_width
;
18840 if (g
- to
- tused
> 0)
18842 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18843 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18845 used
= it
->glyph_row
->used
[TEXT_AREA
];
18846 if (it
->glyph_row
->truncated_on_right_p
18847 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18848 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18851 int extra
= w
- it
->truncation_pixel_width
;
18853 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18860 /* There may be padding glyphs left over. Overwrite them too. */
18861 if (!FRAME_WINDOW_P (it
->f
))
18863 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18865 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18872 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18876 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18878 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18879 that back to front. */
18880 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18881 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18882 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18883 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18884 if (FRAME_WINDOW_P (it
->f
))
18887 struct glyph
*g
= to
;
18889 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
18891 w
+= g
->pixel_width
;
18894 if (to
- g
- tused
> 0)
18896 if (it
->glyph_row
->truncated_on_right_p
18897 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
18898 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
18900 int extra
= w
- it
->truncation_pixel_width
;
18902 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
18906 while (from
>= end
&& to
>= toend
)
18908 if (!FRAME_WINDOW_P (it
->f
))
18910 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18913 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18914 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18915 while (from
>= end
&& to
>= toend
)
18921 /* Need to free some room before prepending additional
18923 int move_by
= from
- end
+ 1;
18924 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18925 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18927 for ( ; g
>= g0
; g
--)
18929 while (from
>= end
)
18931 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18936 /* Compute the hash code for ROW. */
18938 row_hash (struct glyph_row
*row
)
18941 unsigned hashval
= 0;
18943 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18944 for (k
= 0; k
< row
->used
[area
]; ++k
)
18945 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18946 + row
->glyphs
[area
][k
].u
.val
18947 + row
->glyphs
[area
][k
].face_id
18948 + row
->glyphs
[area
][k
].padding_p
18949 + (row
->glyphs
[area
][k
].type
<< 2));
18954 /* Compute the pixel height and width of IT->glyph_row.
18956 Most of the time, ascent and height of a display line will be equal
18957 to the max_ascent and max_height values of the display iterator
18958 structure. This is not the case if
18960 1. We hit ZV without displaying anything. In this case, max_ascent
18961 and max_height will be zero.
18963 2. We have some glyphs that don't contribute to the line height.
18964 (The glyph row flag contributes_to_line_height_p is for future
18965 pixmap extensions).
18967 The first case is easily covered by using default values because in
18968 these cases, the line height does not really matter, except that it
18969 must not be zero. */
18972 compute_line_metrics (struct it
*it
)
18974 struct glyph_row
*row
= it
->glyph_row
;
18976 if (FRAME_WINDOW_P (it
->f
))
18978 int i
, min_y
, max_y
;
18980 /* The line may consist of one space only, that was added to
18981 place the cursor on it. If so, the row's height hasn't been
18983 if (row
->height
== 0)
18985 if (it
->max_ascent
+ it
->max_descent
== 0)
18986 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18987 row
->ascent
= it
->max_ascent
;
18988 row
->height
= it
->max_ascent
+ it
->max_descent
;
18989 row
->phys_ascent
= it
->max_phys_ascent
;
18990 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18991 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18994 /* Compute the width of this line. */
18995 row
->pixel_width
= row
->x
;
18996 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18997 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18999 eassert (row
->pixel_width
>= 0);
19000 eassert (row
->ascent
>= 0 && row
->height
> 0);
19002 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19003 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19005 /* If first line's physical ascent is larger than its logical
19006 ascent, use the physical ascent, and make the row taller.
19007 This makes accented characters fully visible. */
19008 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19009 && row
->phys_ascent
> row
->ascent
)
19011 row
->height
+= row
->phys_ascent
- row
->ascent
;
19012 row
->ascent
= row
->phys_ascent
;
19015 /* Compute how much of the line is visible. */
19016 row
->visible_height
= row
->height
;
19018 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19019 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19021 if (row
->y
< min_y
)
19022 row
->visible_height
-= min_y
- row
->y
;
19023 if (row
->y
+ row
->height
> max_y
)
19024 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19028 row
->pixel_width
= row
->used
[TEXT_AREA
];
19029 if (row
->continued_p
)
19030 row
->pixel_width
-= it
->continuation_pixel_width
;
19031 else if (row
->truncated_on_right_p
)
19032 row
->pixel_width
-= it
->truncation_pixel_width
;
19033 row
->ascent
= row
->phys_ascent
= 0;
19034 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19035 row
->extra_line_spacing
= 0;
19038 /* Compute a hash code for this row. */
19039 row
->hash
= row_hash (row
);
19041 it
->max_ascent
= it
->max_descent
= 0;
19042 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19046 /* Append one space to the glyph row of iterator IT if doing a
19047 window-based redisplay. The space has the same face as
19048 IT->face_id. Value is non-zero if a space was added.
19050 This function is called to make sure that there is always one glyph
19051 at the end of a glyph row that the cursor can be set on under
19052 window-systems. (If there weren't such a glyph we would not know
19053 how wide and tall a box cursor should be displayed).
19055 At the same time this space let's a nicely handle clearing to the
19056 end of the line if the row ends in italic text. */
19059 append_space_for_newline (struct it
*it
, int default_face_p
)
19061 if (FRAME_WINDOW_P (it
->f
))
19063 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19065 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19066 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19068 /* Save some values that must not be changed.
19069 Must save IT->c and IT->len because otherwise
19070 ITERATOR_AT_END_P wouldn't work anymore after
19071 append_space_for_newline has been called. */
19072 enum display_element_type saved_what
= it
->what
;
19073 int saved_c
= it
->c
, saved_len
= it
->len
;
19074 int saved_char_to_display
= it
->char_to_display
;
19075 int saved_x
= it
->current_x
;
19076 int saved_face_id
= it
->face_id
;
19077 int saved_box_end
= it
->end_of_box_run_p
;
19078 struct text_pos saved_pos
;
19079 Lisp_Object saved_object
;
19082 saved_object
= it
->object
;
19083 saved_pos
= it
->position
;
19085 it
->what
= IT_CHARACTER
;
19086 memset (&it
->position
, 0, sizeof it
->position
);
19087 it
->object
= make_number (0);
19088 it
->c
= it
->char_to_display
= ' ';
19091 /* If the default face was remapped, be sure to use the
19092 remapped face for the appended newline. */
19093 if (default_face_p
)
19094 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19095 else if (it
->face_before_selective_p
)
19096 it
->face_id
= it
->saved_face_id
;
19097 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19098 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19099 /* In R2L rows, we will prepend a stretch glyph that will
19100 have the end_of_box_run_p flag set for it, so there's no
19101 need for the appended newline glyph to have that flag
19103 if (it
->glyph_row
->reversed_p
19104 /* But if the appended newline glyph goes all the way to
19105 the end of the row, there will be no stretch glyph,
19106 so leave the box flag set. */
19107 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19108 it
->end_of_box_run_p
= 0;
19110 PRODUCE_GLYPHS (it
);
19112 it
->override_ascent
= -1;
19113 it
->constrain_row_ascent_descent_p
= 0;
19114 it
->current_x
= saved_x
;
19115 it
->object
= saved_object
;
19116 it
->position
= saved_pos
;
19117 it
->what
= saved_what
;
19118 it
->face_id
= saved_face_id
;
19119 it
->len
= saved_len
;
19121 it
->char_to_display
= saved_char_to_display
;
19122 it
->end_of_box_run_p
= saved_box_end
;
19131 /* Extend the face of the last glyph in the text area of IT->glyph_row
19132 to the end of the display line. Called from display_line. If the
19133 glyph row is empty, add a space glyph to it so that we know the
19134 face to draw. Set the glyph row flag fill_line_p. If the glyph
19135 row is R2L, prepend a stretch glyph to cover the empty space to the
19136 left of the leftmost glyph. */
19139 extend_face_to_end_of_line (struct it
*it
)
19141 struct face
*face
, *default_face
;
19142 struct frame
*f
= it
->f
;
19144 /* If line is already filled, do nothing. Non window-system frames
19145 get a grace of one more ``pixel'' because their characters are
19146 1-``pixel'' wide, so they hit the equality too early. This grace
19147 is needed only for R2L rows that are not continued, to produce
19148 one extra blank where we could display the cursor. */
19149 if ((it
->current_x
>= it
->last_visible_x
19150 + (!FRAME_WINDOW_P (f
)
19151 && it
->glyph_row
->reversed_p
19152 && !it
->glyph_row
->continued_p
))
19153 /* If the window has display margins, we will need to extend
19154 their face even if the text area is filled. */
19155 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19156 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19159 /* The default face, possibly remapped. */
19160 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19162 /* Face extension extends the background and box of IT->face_id
19163 to the end of the line. If the background equals the background
19164 of the frame, we don't have to do anything. */
19165 if (it
->face_before_selective_p
)
19166 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19168 face
= FACE_FROM_ID (f
, it
->face_id
);
19170 if (FRAME_WINDOW_P (f
)
19171 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19172 && face
->box
== FACE_NO_BOX
19173 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19174 #ifdef HAVE_WINDOW_SYSTEM
19177 && !it
->glyph_row
->reversed_p
)
19180 /* Set the glyph row flag indicating that the face of the last glyph
19181 in the text area has to be drawn to the end of the text area. */
19182 it
->glyph_row
->fill_line_p
= 1;
19184 /* If current character of IT is not ASCII, make sure we have the
19185 ASCII face. This will be automatically undone the next time
19186 get_next_display_element returns a multibyte character. Note
19187 that the character will always be single byte in unibyte
19189 if (!ASCII_CHAR_P (it
->c
))
19191 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19194 if (FRAME_WINDOW_P (f
))
19196 /* If the row is empty, add a space with the current face of IT,
19197 so that we know which face to draw. */
19198 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19200 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19201 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19202 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19204 /* Mode line and the header line don't have margins, and
19205 likewise the frame's tool-bar window, if there is any. */
19206 if (!(it
->glyph_row
->mode_line_p
19207 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19208 || (WINDOWP (f
->tool_bar_window
)
19209 && it
->w
== XWINDOW (f
->tool_bar_window
))
19213 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19214 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19216 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19217 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19219 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19221 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19222 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19224 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19225 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19227 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19230 #ifdef HAVE_WINDOW_SYSTEM
19231 if (it
->glyph_row
->reversed_p
)
19233 /* Prepend a stretch glyph to the row, such that the
19234 rightmost glyph will be drawn flushed all the way to the
19235 right margin of the window. The stretch glyph that will
19236 occupy the empty space, if any, to the left of the
19238 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19239 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19240 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19242 int row_width
, stretch_ascent
, stretch_width
;
19243 struct text_pos saved_pos
;
19244 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
19246 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19247 row_width
+= g
->pixel_width
;
19248 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
19249 if (stretch_width
> 0)
19252 (((it
->ascent
+ it
->descent
)
19253 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19254 saved_pos
= it
->position
;
19255 memset (&it
->position
, 0, sizeof it
->position
);
19256 saved_avoid_cursor
= it
->avoid_cursor_p
;
19257 it
->avoid_cursor_p
= 1;
19258 saved_face_id
= it
->face_id
;
19259 saved_box_start
= it
->start_of_box_run_p
;
19260 /* The last row's stretch glyph should get the default
19261 face, to avoid painting the rest of the window with
19262 the region face, if the region ends at ZV. */
19263 if (it
->glyph_row
->ends_at_zv_p
)
19264 it
->face_id
= default_face
->id
;
19266 it
->face_id
= face
->id
;
19267 it
->start_of_box_run_p
= 0;
19268 append_stretch_glyph (it
, make_number (0), stretch_width
,
19269 it
->ascent
+ it
->descent
, stretch_ascent
);
19270 it
->position
= saved_pos
;
19271 it
->avoid_cursor_p
= saved_avoid_cursor
;
19272 it
->face_id
= saved_face_id
;
19273 it
->start_of_box_run_p
= saved_box_start
;
19276 #endif /* HAVE_WINDOW_SYSTEM */
19280 /* Save some values that must not be changed. */
19281 int saved_x
= it
->current_x
;
19282 struct text_pos saved_pos
;
19283 Lisp_Object saved_object
;
19284 enum display_element_type saved_what
= it
->what
;
19285 int saved_face_id
= it
->face_id
;
19287 saved_object
= it
->object
;
19288 saved_pos
= it
->position
;
19290 it
->what
= IT_CHARACTER
;
19291 memset (&it
->position
, 0, sizeof it
->position
);
19292 it
->object
= make_number (0);
19293 it
->c
= it
->char_to_display
= ' ';
19296 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19297 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19298 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19299 && !it
->glyph_row
->mode_line_p
19300 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19302 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19303 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19305 for (it
->current_x
= 0; g
< e
; g
++)
19306 it
->current_x
+= g
->pixel_width
;
19308 it
->area
= LEFT_MARGIN_AREA
;
19309 it
->face_id
= default_face
->id
;
19310 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19311 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19313 PRODUCE_GLYPHS (it
);
19314 /* term.c:produce_glyphs advances it->current_x only for
19316 it
->current_x
+= it
->pixel_width
;
19319 it
->current_x
= saved_x
;
19320 it
->area
= TEXT_AREA
;
19323 /* The last row's blank glyphs should get the default face, to
19324 avoid painting the rest of the window with the region face,
19325 if the region ends at ZV. */
19326 if (it
->glyph_row
->ends_at_zv_p
)
19327 it
->face_id
= default_face
->id
;
19329 it
->face_id
= face
->id
;
19330 PRODUCE_GLYPHS (it
);
19332 while (it
->current_x
<= it
->last_visible_x
)
19333 PRODUCE_GLYPHS (it
);
19335 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19336 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19337 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19338 && !it
->glyph_row
->mode_line_p
19339 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19341 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19342 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19344 for ( ; g
< e
; g
++)
19345 it
->current_x
+= g
->pixel_width
;
19347 it
->area
= RIGHT_MARGIN_AREA
;
19348 it
->face_id
= default_face
->id
;
19349 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19350 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19352 PRODUCE_GLYPHS (it
);
19353 it
->current_x
+= it
->pixel_width
;
19356 it
->area
= TEXT_AREA
;
19359 /* Don't count these blanks really. It would let us insert a left
19360 truncation glyph below and make us set the cursor on them, maybe. */
19361 it
->current_x
= saved_x
;
19362 it
->object
= saved_object
;
19363 it
->position
= saved_pos
;
19364 it
->what
= saved_what
;
19365 it
->face_id
= saved_face_id
;
19370 /* Value is non-zero if text starting at CHARPOS in current_buffer is
19371 trailing whitespace. */
19374 trailing_whitespace_p (ptrdiff_t charpos
)
19376 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19379 while (bytepos
< ZV_BYTE
19380 && (c
= FETCH_CHAR (bytepos
),
19381 c
== ' ' || c
== '\t'))
19384 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19386 if (bytepos
!= PT_BYTE
)
19393 /* Highlight trailing whitespace, if any, in ROW. */
19396 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19398 int used
= row
->used
[TEXT_AREA
];
19402 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19403 struct glyph
*glyph
= start
+ used
- 1;
19405 if (row
->reversed_p
)
19407 /* Right-to-left rows need to be processed in the opposite
19408 direction, so swap the edge pointers. */
19410 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19413 /* Skip over glyphs inserted to display the cursor at the
19414 end of a line, for extending the face of the last glyph
19415 to the end of the line on terminals, and for truncation
19416 and continuation glyphs. */
19417 if (!row
->reversed_p
)
19419 while (glyph
>= start
19420 && glyph
->type
== CHAR_GLYPH
19421 && INTEGERP (glyph
->object
))
19426 while (glyph
<= start
19427 && glyph
->type
== CHAR_GLYPH
19428 && INTEGERP (glyph
->object
))
19432 /* If last glyph is a space or stretch, and it's trailing
19433 whitespace, set the face of all trailing whitespace glyphs in
19434 IT->glyph_row to `trailing-whitespace'. */
19435 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19436 && BUFFERP (glyph
->object
)
19437 && (glyph
->type
== STRETCH_GLYPH
19438 || (glyph
->type
== CHAR_GLYPH
19439 && glyph
->u
.ch
== ' '))
19440 && trailing_whitespace_p (glyph
->charpos
))
19442 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
19446 if (!row
->reversed_p
)
19448 while (glyph
>= start
19449 && BUFFERP (glyph
->object
)
19450 && (glyph
->type
== STRETCH_GLYPH
19451 || (glyph
->type
== CHAR_GLYPH
19452 && glyph
->u
.ch
== ' ')))
19453 (glyph
--)->face_id
= face_id
;
19457 while (glyph
<= start
19458 && BUFFERP (glyph
->object
)
19459 && (glyph
->type
== STRETCH_GLYPH
19460 || (glyph
->type
== CHAR_GLYPH
19461 && glyph
->u
.ch
== ' ')))
19462 (glyph
++)->face_id
= face_id
;
19469 /* Value is non-zero if glyph row ROW should be
19470 considered to hold the buffer position CHARPOS. */
19473 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19477 if (charpos
== CHARPOS (row
->end
.pos
)
19478 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19480 /* Suppose the row ends on a string.
19481 Unless the row is continued, that means it ends on a newline
19482 in the string. If it's anything other than a display string
19483 (e.g., a before-string from an overlay), we don't want the
19484 cursor there. (This heuristic seems to give the optimal
19485 behavior for the various types of multi-line strings.)
19486 One exception: if the string has `cursor' property on one of
19487 its characters, we _do_ want the cursor there. */
19488 if (CHARPOS (row
->end
.string_pos
) >= 0)
19490 if (row
->continued_p
)
19494 /* Check for `display' property. */
19495 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19496 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19497 struct glyph
*glyph
;
19500 for (glyph
= end
; glyph
>= beg
; --glyph
)
19501 if (STRINGP (glyph
->object
))
19504 = Fget_char_property (make_number (charpos
),
19508 && display_prop_string_p (prop
, glyph
->object
));
19509 /* If there's a `cursor' property on one of the
19510 string's characters, this row is a cursor row,
19511 even though this is not a display string. */
19514 Lisp_Object s
= glyph
->object
;
19516 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19518 ptrdiff_t gpos
= glyph
->charpos
;
19520 if (!NILP (Fget_char_property (make_number (gpos
),
19532 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19534 /* If the row ends in middle of a real character,
19535 and the line is continued, we want the cursor here.
19536 That's because CHARPOS (ROW->end.pos) would equal
19537 PT if PT is before the character. */
19538 if (!row
->ends_in_ellipsis_p
)
19539 result
= row
->continued_p
;
19541 /* If the row ends in an ellipsis, then
19542 CHARPOS (ROW->end.pos) will equal point after the
19543 invisible text. We want that position to be displayed
19544 after the ellipsis. */
19547 /* If the row ends at ZV, display the cursor at the end of that
19548 row instead of at the start of the row below. */
19549 else if (row
->ends_at_zv_p
)
19558 /* Value is non-zero if glyph row ROW should be
19559 used to hold the cursor. */
19562 cursor_row_p (struct glyph_row
*row
)
19564 return row_for_charpos_p (row
, PT
);
19569 /* Push the property PROP so that it will be rendered at the current
19570 position in IT. Return 1 if PROP was successfully pushed, 0
19571 otherwise. Called from handle_line_prefix to handle the
19572 `line-prefix' and `wrap-prefix' properties. */
19575 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19577 struct text_pos pos
=
19578 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19580 eassert (it
->method
== GET_FROM_BUFFER
19581 || it
->method
== GET_FROM_DISPLAY_VECTOR
19582 || it
->method
== GET_FROM_STRING
);
19584 /* We need to save the current buffer/string position, so it will be
19585 restored by pop_it, because iterate_out_of_display_property
19586 depends on that being set correctly, but some situations leave
19587 it->position not yet set when this function is called. */
19588 push_it (it
, &pos
);
19590 if (STRINGP (prop
))
19592 if (SCHARS (prop
) == 0)
19599 it
->string_from_prefix_prop_p
= 1;
19600 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19601 it
->current
.overlay_string_index
= -1;
19602 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19603 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19604 it
->method
= GET_FROM_STRING
;
19605 it
->stop_charpos
= 0;
19607 it
->base_level_stop
= 0;
19609 /* Force paragraph direction to be that of the parent
19611 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19612 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19614 it
->paragraph_embedding
= L2R
;
19616 /* Set up the bidi iterator for this display string. */
19619 it
->bidi_it
.string
.lstring
= it
->string
;
19620 it
->bidi_it
.string
.s
= NULL
;
19621 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19622 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19623 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19624 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19625 it
->bidi_it
.w
= it
->w
;
19626 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19629 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19631 it
->method
= GET_FROM_STRETCH
;
19634 #ifdef HAVE_WINDOW_SYSTEM
19635 else if (IMAGEP (prop
))
19637 it
->what
= IT_IMAGE
;
19638 it
->image_id
= lookup_image (it
->f
, prop
);
19639 it
->method
= GET_FROM_IMAGE
;
19641 #endif /* HAVE_WINDOW_SYSTEM */
19644 pop_it (it
); /* bogus display property, give up */
19651 /* Return the character-property PROP at the current position in IT. */
19654 get_it_property (struct it
*it
, Lisp_Object prop
)
19656 Lisp_Object position
, object
= it
->object
;
19658 if (STRINGP (object
))
19659 position
= make_number (IT_STRING_CHARPOS (*it
));
19660 else if (BUFFERP (object
))
19662 position
= make_number (IT_CHARPOS (*it
));
19663 object
= it
->window
;
19668 return Fget_char_property (position
, prop
, object
);
19671 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19674 handle_line_prefix (struct it
*it
)
19676 Lisp_Object prefix
;
19678 if (it
->continuation_lines_width
> 0)
19680 prefix
= get_it_property (it
, Qwrap_prefix
);
19682 prefix
= Vwrap_prefix
;
19686 prefix
= get_it_property (it
, Qline_prefix
);
19688 prefix
= Vline_prefix
;
19690 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19692 /* If the prefix is wider than the window, and we try to wrap
19693 it, it would acquire its own wrap prefix, and so on till the
19694 iterator stack overflows. So, don't wrap the prefix. */
19695 it
->line_wrap
= TRUNCATE
;
19696 it
->avoid_cursor_p
= 1;
19702 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19703 only for R2L lines from display_line and display_string, when they
19704 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19705 the line/string needs to be continued on the next glyph row. */
19707 unproduce_glyphs (struct it
*it
, int n
)
19709 struct glyph
*glyph
, *end
;
19711 eassert (it
->glyph_row
);
19712 eassert (it
->glyph_row
->reversed_p
);
19713 eassert (it
->area
== TEXT_AREA
);
19714 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19716 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19717 n
= it
->glyph_row
->used
[TEXT_AREA
];
19718 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19719 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19720 for ( ; glyph
< end
; glyph
++)
19721 glyph
[-n
] = *glyph
;
19724 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19725 and ROW->maxpos. */
19727 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19728 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19729 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19731 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19732 lines' rows is implemented for bidi-reordered rows. */
19734 /* ROW->minpos is the value of min_pos, the minimal buffer position
19735 we have in ROW, or ROW->start.pos if that is smaller. */
19736 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19737 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19739 /* We didn't find buffer positions smaller than ROW->start, or
19740 didn't find _any_ valid buffer positions in any of the glyphs,
19741 so we must trust the iterator's computed positions. */
19742 row
->minpos
= row
->start
.pos
;
19745 max_pos
= CHARPOS (it
->current
.pos
);
19746 max_bpos
= BYTEPOS (it
->current
.pos
);
19749 /* Here are the various use-cases for ending the row, and the
19750 corresponding values for ROW->maxpos:
19752 Line ends in a newline from buffer eol_pos + 1
19753 Line is continued from buffer max_pos + 1
19754 Line is truncated on right it->current.pos
19755 Line ends in a newline from string max_pos + 1(*)
19756 (*) + 1 only when line ends in a forward scan
19757 Line is continued from string max_pos
19758 Line is continued from display vector max_pos
19759 Line is entirely from a string min_pos == max_pos
19760 Line is entirely from a display vector min_pos == max_pos
19761 Line that ends at ZV ZV
19763 If you discover other use-cases, please add them here as
19765 if (row
->ends_at_zv_p
)
19766 row
->maxpos
= it
->current
.pos
;
19767 else if (row
->used
[TEXT_AREA
])
19769 int seen_this_string
= 0;
19770 struct glyph_row
*r1
= row
- 1;
19772 /* Did we see the same display string on the previous row? */
19773 if (STRINGP (it
->object
)
19774 /* this is not the first row */
19775 && row
> it
->w
->desired_matrix
->rows
19776 /* previous row is not the header line */
19777 && !r1
->mode_line_p
19778 /* previous row also ends in a newline from a string */
19779 && r1
->ends_in_newline_from_string_p
)
19781 struct glyph
*start
, *end
;
19783 /* Search for the last glyph of the previous row that came
19784 from buffer or string. Depending on whether the row is
19785 L2R or R2L, we need to process it front to back or the
19786 other way round. */
19787 if (!r1
->reversed_p
)
19789 start
= r1
->glyphs
[TEXT_AREA
];
19790 end
= start
+ r1
->used
[TEXT_AREA
];
19791 /* Glyphs inserted by redisplay have an integer (zero)
19792 as their object. */
19794 && INTEGERP ((end
- 1)->object
)
19795 && (end
- 1)->charpos
<= 0)
19799 if (EQ ((end
- 1)->object
, it
->object
))
19800 seen_this_string
= 1;
19803 /* If all the glyphs of the previous row were inserted
19804 by redisplay, it means the previous row was
19805 produced from a single newline, which is only
19806 possible if that newline came from the same string
19807 as the one which produced this ROW. */
19808 seen_this_string
= 1;
19812 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19813 start
= end
+ r1
->used
[TEXT_AREA
];
19815 && INTEGERP ((end
+ 1)->object
)
19816 && (end
+ 1)->charpos
<= 0)
19820 if (EQ ((end
+ 1)->object
, it
->object
))
19821 seen_this_string
= 1;
19824 seen_this_string
= 1;
19827 /* Take note of each display string that covers a newline only
19828 once, the first time we see it. This is for when a display
19829 string includes more than one newline in it. */
19830 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
19832 /* If we were scanning the buffer forward when we displayed
19833 the string, we want to account for at least one buffer
19834 position that belongs to this row (position covered by
19835 the display string), so that cursor positioning will
19836 consider this row as a candidate when point is at the end
19837 of the visual line represented by this row. This is not
19838 required when scanning back, because max_pos will already
19839 have a much larger value. */
19840 if (CHARPOS (row
->end
.pos
) > max_pos
)
19841 INC_BOTH (max_pos
, max_bpos
);
19842 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19844 else if (CHARPOS (it
->eol_pos
) > 0)
19845 SET_TEXT_POS (row
->maxpos
,
19846 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
19847 else if (row
->continued_p
)
19849 /* If max_pos is different from IT's current position, it
19850 means IT->method does not belong to the display element
19851 at max_pos. However, it also means that the display
19852 element at max_pos was displayed in its entirety on this
19853 line, which is equivalent to saying that the next line
19854 starts at the next buffer position. */
19855 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
19856 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19859 INC_BOTH (max_pos
, max_bpos
);
19860 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19863 else if (row
->truncated_on_right_p
)
19864 /* display_line already called reseat_at_next_visible_line_start,
19865 which puts the iterator at the beginning of the next line, in
19866 the logical order. */
19867 row
->maxpos
= it
->current
.pos
;
19868 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
19869 /* A line that is entirely from a string/image/stretch... */
19870 row
->maxpos
= row
->minpos
;
19875 row
->maxpos
= it
->current
.pos
;
19878 /* Construct the glyph row IT->glyph_row in the desired matrix of
19879 IT->w from text at the current position of IT. See dispextern.h
19880 for an overview of struct it. Value is non-zero if
19881 IT->glyph_row displays text, as opposed to a line displaying ZV
19885 display_line (struct it
*it
)
19887 struct glyph_row
*row
= it
->glyph_row
;
19888 Lisp_Object overlay_arrow_string
;
19890 void *wrap_data
= NULL
;
19891 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
19892 int wrap_row_used
= -1;
19893 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
19894 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
19895 int wrap_row_extra_line_spacing
IF_LINT (= 0);
19896 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
19897 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
19899 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
19900 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
19902 /* We always start displaying at hpos zero even if hscrolled. */
19903 eassert (it
->hpos
== 0 && it
->current_x
== 0);
19905 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
19906 >= it
->w
->desired_matrix
->nrows
)
19908 it
->w
->nrows_scale_factor
++;
19909 it
->f
->fonts_changed
= 1;
19913 /* Clear the result glyph row and enable it. */
19914 prepare_desired_row (it
->w
, row
, false);
19916 row
->y
= it
->current_y
;
19917 row
->start
= it
->start
;
19918 row
->continuation_lines_width
= it
->continuation_lines_width
;
19919 row
->displays_text_p
= 1;
19920 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
19921 it
->starts_in_middle_of_char_p
= 0;
19923 /* Arrange the overlays nicely for our purposes. Usually, we call
19924 display_line on only one line at a time, in which case this
19925 can't really hurt too much, or we call it on lines which appear
19926 one after another in the buffer, in which case all calls to
19927 recenter_overlay_lists but the first will be pretty cheap. */
19928 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
19930 /* Move over display elements that are not visible because we are
19931 hscrolled. This may stop at an x-position < IT->first_visible_x
19932 if the first glyph is partially visible or if we hit a line end. */
19933 if (it
->current_x
< it
->first_visible_x
)
19935 enum move_it_result move_result
;
19937 this_line_min_pos
= row
->start
.pos
;
19938 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
19939 MOVE_TO_POS
| MOVE_TO_X
);
19940 /* If we are under a large hscroll, move_it_in_display_line_to
19941 could hit the end of the line without reaching
19942 it->first_visible_x. Pretend that we did reach it. This is
19943 especially important on a TTY, where we will call
19944 extend_face_to_end_of_line, which needs to know how many
19945 blank glyphs to produce. */
19946 if (it
->current_x
< it
->first_visible_x
19947 && (move_result
== MOVE_NEWLINE_OR_CR
19948 || move_result
== MOVE_POS_MATCH_OR_ZV
))
19949 it
->current_x
= it
->first_visible_x
;
19951 /* Record the smallest positions seen while we moved over
19952 display elements that are not visible. This is needed by
19953 redisplay_internal for optimizing the case where the cursor
19954 stays inside the same line. The rest of this function only
19955 considers positions that are actually displayed, so
19956 RECORD_MAX_MIN_POS will not otherwise record positions that
19957 are hscrolled to the left of the left edge of the window. */
19958 min_pos
= CHARPOS (this_line_min_pos
);
19959 min_bpos
= BYTEPOS (this_line_min_pos
);
19963 /* We only do this when not calling `move_it_in_display_line_to'
19964 above, because move_it_in_display_line_to calls
19965 handle_line_prefix itself. */
19966 handle_line_prefix (it
);
19969 /* Get the initial row height. This is either the height of the
19970 text hscrolled, if there is any, or zero. */
19971 row
->ascent
= it
->max_ascent
;
19972 row
->height
= it
->max_ascent
+ it
->max_descent
;
19973 row
->phys_ascent
= it
->max_phys_ascent
;
19974 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19975 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19977 /* Utility macro to record max and min buffer positions seen until now. */
19978 #define RECORD_MAX_MIN_POS(IT) \
19981 int composition_p = !STRINGP ((IT)->string) \
19982 && ((IT)->what == IT_COMPOSITION); \
19983 ptrdiff_t current_pos = \
19984 composition_p ? (IT)->cmp_it.charpos \
19985 : IT_CHARPOS (*(IT)); \
19986 ptrdiff_t current_bpos = \
19987 composition_p ? CHAR_TO_BYTE (current_pos) \
19988 : IT_BYTEPOS (*(IT)); \
19989 if (current_pos < min_pos) \
19991 min_pos = current_pos; \
19992 min_bpos = current_bpos; \
19994 if (IT_CHARPOS (*it) > max_pos) \
19996 max_pos = IT_CHARPOS (*it); \
19997 max_bpos = IT_BYTEPOS (*it); \
20002 /* Loop generating characters. The loop is left with IT on the next
20003 character to display. */
20006 int n_glyphs_before
, hpos_before
, x_before
;
20008 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20010 /* Retrieve the next thing to display. Value is zero if end of
20012 if (!get_next_display_element (it
))
20014 /* Maybe add a space at the end of this line that is used to
20015 display the cursor there under X. Set the charpos of the
20016 first glyph of blank lines not corresponding to any text
20018 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20019 row
->exact_window_width_line_p
= 1;
20020 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
20021 || row
->used
[TEXT_AREA
] == 0)
20023 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20024 row
->displays_text_p
= 0;
20026 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20027 && (!MINI_WINDOW_P (it
->w
)
20028 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20029 row
->indicate_empty_line_p
= 1;
20032 it
->continuation_lines_width
= 0;
20033 row
->ends_at_zv_p
= 1;
20034 /* A row that displays right-to-left text must always have
20035 its last face extended all the way to the end of line,
20036 even if this row ends in ZV, because we still write to
20037 the screen left to right. We also need to extend the
20038 last face if the default face is remapped to some
20039 different face, otherwise the functions that clear
20040 portions of the screen will clear with the default face's
20041 background color. */
20042 if (row
->reversed_p
20043 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20044 extend_face_to_end_of_line (it
);
20048 /* Now, get the metrics of what we want to display. This also
20049 generates glyphs in `row' (which is IT->glyph_row). */
20050 n_glyphs_before
= row
->used
[TEXT_AREA
];
20053 /* Remember the line height so far in case the next element doesn't
20054 fit on the line. */
20055 if (it
->line_wrap
!= TRUNCATE
)
20057 ascent
= it
->max_ascent
;
20058 descent
= it
->max_descent
;
20059 phys_ascent
= it
->max_phys_ascent
;
20060 phys_descent
= it
->max_phys_descent
;
20062 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20064 if (IT_DISPLAYING_WHITESPACE (it
))
20068 SAVE_IT (wrap_it
, *it
, wrap_data
);
20070 wrap_row_used
= row
->used
[TEXT_AREA
];
20071 wrap_row_ascent
= row
->ascent
;
20072 wrap_row_height
= row
->height
;
20073 wrap_row_phys_ascent
= row
->phys_ascent
;
20074 wrap_row_phys_height
= row
->phys_height
;
20075 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20076 wrap_row_min_pos
= min_pos
;
20077 wrap_row_min_bpos
= min_bpos
;
20078 wrap_row_max_pos
= max_pos
;
20079 wrap_row_max_bpos
= max_bpos
;
20085 PRODUCE_GLYPHS (it
);
20087 /* If this display element was in marginal areas, continue with
20089 if (it
->area
!= TEXT_AREA
)
20091 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20092 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20093 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20094 row
->phys_height
= max (row
->phys_height
,
20095 it
->max_phys_ascent
+ it
->max_phys_descent
);
20096 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20097 it
->max_extra_line_spacing
);
20098 set_iterator_to_next (it
, 1);
20102 /* Does the display element fit on the line? If we truncate
20103 lines, we should draw past the right edge of the window. If
20104 we don't truncate, we want to stop so that we can display the
20105 continuation glyph before the right margin. If lines are
20106 continued, there are two possible strategies for characters
20107 resulting in more than 1 glyph (e.g. tabs): Display as many
20108 glyphs as possible in this line and leave the rest for the
20109 continuation line, or display the whole element in the next
20110 line. Original redisplay did the former, so we do it also. */
20111 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20112 hpos_before
= it
->hpos
;
20115 if (/* Not a newline. */
20117 /* Glyphs produced fit entirely in the line. */
20118 && it
->current_x
< it
->last_visible_x
)
20120 it
->hpos
+= nglyphs
;
20121 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20122 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20123 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20124 row
->phys_height
= max (row
->phys_height
,
20125 it
->max_phys_ascent
+ it
->max_phys_descent
);
20126 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20127 it
->max_extra_line_spacing
);
20128 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
20129 row
->x
= x
- it
->first_visible_x
;
20130 /* Record the maximum and minimum buffer positions seen so
20131 far in glyphs that will be displayed by this row. */
20133 RECORD_MAX_MIN_POS (it
);
20138 struct glyph
*glyph
;
20140 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20142 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20143 new_x
= x
+ glyph
->pixel_width
;
20145 if (/* Lines are continued. */
20146 it
->line_wrap
!= TRUNCATE
20147 && (/* Glyph doesn't fit on the line. */
20148 new_x
> it
->last_visible_x
20149 /* Or it fits exactly on a window system frame. */
20150 || (new_x
== it
->last_visible_x
20151 && FRAME_WINDOW_P (it
->f
)
20152 && (row
->reversed_p
20153 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20154 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20156 /* End of a continued line. */
20159 || (new_x
== it
->last_visible_x
20160 && FRAME_WINDOW_P (it
->f
)
20161 && (row
->reversed_p
20162 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20163 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20165 /* Current glyph is the only one on the line or
20166 fits exactly on the line. We must continue
20167 the line because we can't draw the cursor
20168 after the glyph. */
20169 row
->continued_p
= 1;
20170 it
->current_x
= new_x
;
20171 it
->continuation_lines_width
+= new_x
;
20173 if (i
== nglyphs
- 1)
20175 /* If line-wrap is on, check if a previous
20176 wrap point was found. */
20177 if (wrap_row_used
> 0
20178 /* Even if there is a previous wrap
20179 point, continue the line here as
20180 usual, if (i) the previous character
20181 was a space or tab AND (ii) the
20182 current character is not. */
20184 || IT_DISPLAYING_WHITESPACE (it
)))
20187 /* Record the maximum and minimum buffer
20188 positions seen so far in glyphs that will be
20189 displayed by this row. */
20191 RECORD_MAX_MIN_POS (it
);
20192 set_iterator_to_next (it
, 1);
20193 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20195 if (!get_next_display_element (it
))
20197 row
->exact_window_width_line_p
= 1;
20198 it
->continuation_lines_width
= 0;
20199 row
->continued_p
= 0;
20200 row
->ends_at_zv_p
= 1;
20202 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20204 row
->continued_p
= 0;
20205 row
->exact_window_width_line_p
= 1;
20209 else if (it
->bidi_p
)
20210 RECORD_MAX_MIN_POS (it
);
20211 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20212 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20213 extend_face_to_end_of_line (it
);
20215 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20216 && !FRAME_WINDOW_P (it
->f
))
20218 /* A padding glyph that doesn't fit on this line.
20219 This means the whole character doesn't fit
20221 if (row
->reversed_p
)
20222 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20223 - n_glyphs_before
);
20224 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20226 /* Fill the rest of the row with continuation
20227 glyphs like in 20.x. */
20228 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20229 < row
->glyphs
[1 + TEXT_AREA
])
20230 produce_special_glyphs (it
, IT_CONTINUATION
);
20232 row
->continued_p
= 1;
20233 it
->current_x
= x_before
;
20234 it
->continuation_lines_width
+= x_before
;
20236 /* Restore the height to what it was before the
20237 element not fitting on the line. */
20238 it
->max_ascent
= ascent
;
20239 it
->max_descent
= descent
;
20240 it
->max_phys_ascent
= phys_ascent
;
20241 it
->max_phys_descent
= phys_descent
;
20242 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20243 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20244 extend_face_to_end_of_line (it
);
20246 else if (wrap_row_used
> 0)
20249 if (row
->reversed_p
)
20250 unproduce_glyphs (it
,
20251 row
->used
[TEXT_AREA
] - wrap_row_used
);
20252 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20253 it
->continuation_lines_width
+= wrap_x
;
20254 row
->used
[TEXT_AREA
] = wrap_row_used
;
20255 row
->ascent
= wrap_row_ascent
;
20256 row
->height
= wrap_row_height
;
20257 row
->phys_ascent
= wrap_row_phys_ascent
;
20258 row
->phys_height
= wrap_row_phys_height
;
20259 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20260 min_pos
= wrap_row_min_pos
;
20261 min_bpos
= wrap_row_min_bpos
;
20262 max_pos
= wrap_row_max_pos
;
20263 max_bpos
= wrap_row_max_bpos
;
20264 row
->continued_p
= 1;
20265 row
->ends_at_zv_p
= 0;
20266 row
->exact_window_width_line_p
= 0;
20267 it
->continuation_lines_width
+= x
;
20269 /* Make sure that a non-default face is extended
20270 up to the right margin of the window. */
20271 extend_face_to_end_of_line (it
);
20273 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20275 /* A TAB that extends past the right edge of the
20276 window. This produces a single glyph on
20277 window system frames. We leave the glyph in
20278 this row and let it fill the row, but don't
20279 consume the TAB. */
20280 if ((row
->reversed_p
20281 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20282 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20283 produce_special_glyphs (it
, IT_CONTINUATION
);
20284 it
->continuation_lines_width
+= it
->last_visible_x
;
20285 row
->ends_in_middle_of_char_p
= 1;
20286 row
->continued_p
= 1;
20287 glyph
->pixel_width
= it
->last_visible_x
- x
;
20288 it
->starts_in_middle_of_char_p
= 1;
20289 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20290 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20291 extend_face_to_end_of_line (it
);
20295 /* Something other than a TAB that draws past
20296 the right edge of the window. Restore
20297 positions to values before the element. */
20298 if (row
->reversed_p
)
20299 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20300 - (n_glyphs_before
+ i
));
20301 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20303 /* Display continuation glyphs. */
20304 it
->current_x
= x_before
;
20305 it
->continuation_lines_width
+= x
;
20306 if (!FRAME_WINDOW_P (it
->f
)
20307 || (row
->reversed_p
20308 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20309 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20310 produce_special_glyphs (it
, IT_CONTINUATION
);
20311 row
->continued_p
= 1;
20313 extend_face_to_end_of_line (it
);
20315 if (nglyphs
> 1 && i
> 0)
20317 row
->ends_in_middle_of_char_p
= 1;
20318 it
->starts_in_middle_of_char_p
= 1;
20321 /* Restore the height to what it was before the
20322 element not fitting on the line. */
20323 it
->max_ascent
= ascent
;
20324 it
->max_descent
= descent
;
20325 it
->max_phys_ascent
= phys_ascent
;
20326 it
->max_phys_descent
= phys_descent
;
20331 else if (new_x
> it
->first_visible_x
)
20333 /* Increment number of glyphs actually displayed. */
20336 /* Record the maximum and minimum buffer positions
20337 seen so far in glyphs that will be displayed by
20340 RECORD_MAX_MIN_POS (it
);
20342 if (x
< it
->first_visible_x
)
20343 /* Glyph is partially visible, i.e. row starts at
20344 negative X position. */
20345 row
->x
= x
- it
->first_visible_x
;
20349 /* Glyph is completely off the left margin of the
20350 window. This should not happen because of the
20351 move_it_in_display_line at the start of this
20352 function, unless the text display area of the
20353 window is empty. */
20354 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20357 /* Even if this display element produced no glyphs at all,
20358 we want to record its position. */
20359 if (it
->bidi_p
&& nglyphs
== 0)
20360 RECORD_MAX_MIN_POS (it
);
20362 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20363 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20364 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20365 row
->phys_height
= max (row
->phys_height
,
20366 it
->max_phys_ascent
+ it
->max_phys_descent
);
20367 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20368 it
->max_extra_line_spacing
);
20370 /* End of this display line if row is continued. */
20371 if (row
->continued_p
|| row
->ends_at_zv_p
)
20376 /* Is this a line end? If yes, we're also done, after making
20377 sure that a non-default face is extended up to the right
20378 margin of the window. */
20379 if (ITERATOR_AT_END_OF_LINE_P (it
))
20381 int used_before
= row
->used
[TEXT_AREA
];
20383 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20385 /* Add a space at the end of the line that is used to
20386 display the cursor there. */
20387 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20388 append_space_for_newline (it
, 0);
20390 /* Extend the face to the end of the line. */
20391 extend_face_to_end_of_line (it
);
20393 /* Make sure we have the position. */
20394 if (used_before
== 0)
20395 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20397 /* Record the position of the newline, for use in
20399 it
->eol_pos
= it
->current
.pos
;
20401 /* Consume the line end. This skips over invisible lines. */
20402 set_iterator_to_next (it
, 1);
20403 it
->continuation_lines_width
= 0;
20407 /* Proceed with next display element. Note that this skips
20408 over lines invisible because of selective display. */
20409 set_iterator_to_next (it
, 1);
20411 /* If we truncate lines, we are done when the last displayed
20412 glyphs reach past the right margin of the window. */
20413 if (it
->line_wrap
== TRUNCATE
20414 && ((FRAME_WINDOW_P (it
->f
)
20415 /* Images are preprocessed in produce_image_glyph such
20416 that they are cropped at the right edge of the
20417 window, so an image glyph will always end exactly at
20418 last_visible_x, even if there's no right fringe. */
20419 && (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) || it
->what
== IT_IMAGE
))
20420 ? (it
->current_x
>= it
->last_visible_x
)
20421 : (it
->current_x
> it
->last_visible_x
)))
20423 /* Maybe add truncation glyphs. */
20424 if (!FRAME_WINDOW_P (it
->f
)
20425 || (row
->reversed_p
20426 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20427 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20431 if (!row
->reversed_p
)
20433 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20434 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20439 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20440 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20442 /* Remove any padding glyphs at the front of ROW, to
20443 make room for the truncation glyphs we will be
20444 adding below. The loop below always inserts at
20445 least one truncation glyph, so also remove the
20446 last glyph added to ROW. */
20447 unproduce_glyphs (it
, i
+ 1);
20448 /* Adjust i for the loop below. */
20449 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20452 /* produce_special_glyphs overwrites the last glyph, so
20453 we don't want that if we want to keep that last
20454 glyph, which means it's an image. */
20455 if (it
->current_x
> it
->last_visible_x
)
20457 it
->current_x
= x_before
;
20458 if (!FRAME_WINDOW_P (it
->f
))
20460 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20462 row
->used
[TEXT_AREA
] = i
;
20463 produce_special_glyphs (it
, IT_TRUNCATION
);
20468 row
->used
[TEXT_AREA
] = i
;
20469 produce_special_glyphs (it
, IT_TRUNCATION
);
20471 it
->hpos
= hpos_before
;
20474 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20476 /* Don't truncate if we can overflow newline into fringe. */
20477 if (!get_next_display_element (it
))
20479 it
->continuation_lines_width
= 0;
20480 row
->ends_at_zv_p
= 1;
20481 row
->exact_window_width_line_p
= 1;
20484 if (ITERATOR_AT_END_OF_LINE_P (it
))
20486 row
->exact_window_width_line_p
= 1;
20487 goto at_end_of_line
;
20489 it
->current_x
= x_before
;
20490 it
->hpos
= hpos_before
;
20493 row
->truncated_on_right_p
= 1;
20494 it
->continuation_lines_width
= 0;
20495 reseat_at_next_visible_line_start (it
, 0);
20496 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
20502 bidi_unshelve_cache (wrap_data
, 1);
20504 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20505 at the left window margin. */
20506 if (it
->first_visible_x
20507 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20509 if (!FRAME_WINDOW_P (it
->f
)
20510 || (((row
->reversed_p
20511 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20512 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20513 /* Don't let insert_left_trunc_glyphs overwrite the
20514 first glyph of the row if it is an image. */
20515 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20516 insert_left_trunc_glyphs (it
);
20517 row
->truncated_on_left_p
= 1;
20520 /* Remember the position at which this line ends.
20522 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20523 cannot be before the call to find_row_edges below, since that is
20524 where these positions are determined. */
20525 row
->end
= it
->current
;
20528 row
->minpos
= row
->start
.pos
;
20529 row
->maxpos
= row
->end
.pos
;
20533 /* ROW->minpos and ROW->maxpos must be the smallest and
20534 `1 + the largest' buffer positions in ROW. But if ROW was
20535 bidi-reordered, these two positions can be anywhere in the
20536 row, so we must determine them now. */
20537 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20540 /* If the start of this line is the overlay arrow-position, then
20541 mark this glyph row as the one containing the overlay arrow.
20542 This is clearly a mess with variable size fonts. It would be
20543 better to let it be displayed like cursors under X. */
20544 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20545 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20546 !NILP (overlay_arrow_string
)))
20548 /* Overlay arrow in window redisplay is a fringe bitmap. */
20549 if (STRINGP (overlay_arrow_string
))
20551 struct glyph_row
*arrow_row
20552 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20553 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20554 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20555 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20556 struct glyph
*p2
, *end
;
20558 /* Copy the arrow glyphs. */
20559 while (glyph
< arrow_end
)
20562 /* Throw away padding glyphs. */
20564 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20565 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20571 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20576 eassert (INTEGERP (overlay_arrow_string
));
20577 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20579 overlay_arrow_seen
= 1;
20582 /* Highlight trailing whitespace. */
20583 if (!NILP (Vshow_trailing_whitespace
))
20584 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20586 /* Compute pixel dimensions of this line. */
20587 compute_line_metrics (it
);
20589 /* Implementation note: No changes in the glyphs of ROW or in their
20590 faces can be done past this point, because compute_line_metrics
20591 computes ROW's hash value and stores it within the glyph_row
20594 /* Record whether this row ends inside an ellipsis. */
20595 row
->ends_in_ellipsis_p
20596 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20597 && it
->ellipsis_p
);
20599 /* Save fringe bitmaps in this row. */
20600 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20601 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20602 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20603 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20605 it
->left_user_fringe_bitmap
= 0;
20606 it
->left_user_fringe_face_id
= 0;
20607 it
->right_user_fringe_bitmap
= 0;
20608 it
->right_user_fringe_face_id
= 0;
20610 /* Maybe set the cursor. */
20611 cvpos
= it
->w
->cursor
.vpos
;
20613 /* In bidi-reordered rows, keep checking for proper cursor
20614 position even if one has been found already, because buffer
20615 positions in such rows change non-linearly with ROW->VPOS,
20616 when a line is continued. One exception: when we are at ZV,
20617 display cursor on the first suitable glyph row, since all
20618 the empty rows after that also have their position set to ZV. */
20619 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20620 lines' rows is implemented for bidi-reordered rows. */
20622 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20623 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20624 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20625 && cursor_row_p (row
))
20626 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20628 /* Prepare for the next line. This line starts horizontally at (X
20629 HPOS) = (0 0). Vertical positions are incremented. As a
20630 convenience for the caller, IT->glyph_row is set to the next
20632 it
->current_x
= it
->hpos
= 0;
20633 it
->current_y
+= row
->height
;
20634 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20637 /* The next row should by default use the same value of the
20638 reversed_p flag as this one. set_iterator_to_next decides when
20639 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20640 the flag accordingly. */
20641 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20642 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20643 it
->start
= row
->end
;
20644 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20646 #undef RECORD_MAX_MIN_POS
20649 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20650 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20651 doc
: /* Return paragraph direction at point in BUFFER.
20652 Value is either `left-to-right' or `right-to-left'.
20653 If BUFFER is omitted or nil, it defaults to the current buffer.
20655 Paragraph direction determines how the text in the paragraph is displayed.
20656 In left-to-right paragraphs, text begins at the left margin of the window
20657 and the reading direction is generally left to right. In right-to-left
20658 paragraphs, text begins at the right margin and is read from right to left.
20660 See also `bidi-paragraph-direction'. */)
20661 (Lisp_Object buffer
)
20663 struct buffer
*buf
= current_buffer
;
20664 struct buffer
*old
= buf
;
20666 if (! NILP (buffer
))
20668 CHECK_BUFFER (buffer
);
20669 buf
= XBUFFER (buffer
);
20672 if (NILP (BVAR (buf
, bidi_display_reordering
))
20673 || NILP (BVAR (buf
, enable_multibyte_characters
))
20674 /* When we are loading loadup.el, the character property tables
20675 needed for bidi iteration are not yet available. */
20676 || !NILP (Vpurify_flag
))
20677 return Qleft_to_right
;
20678 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20679 return BVAR (buf
, bidi_paragraph_direction
);
20682 /* Determine the direction from buffer text. We could try to
20683 use current_matrix if it is up to date, but this seems fast
20684 enough as it is. */
20685 struct bidi_it itb
;
20686 ptrdiff_t pos
= BUF_PT (buf
);
20687 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20689 void *itb_data
= bidi_shelve_cache ();
20691 set_buffer_temp (buf
);
20692 /* bidi_paragraph_init finds the base direction of the paragraph
20693 by searching forward from paragraph start. We need the base
20694 direction of the current or _previous_ paragraph, so we need
20695 to make sure we are within that paragraph. To that end, find
20696 the previous non-empty line. */
20697 if (pos
>= ZV
&& pos
> BEGV
)
20698 DEC_BOTH (pos
, bytepos
);
20699 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20700 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20702 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20703 || c
== ' ' || c
== '\t' || c
== '\f')
20705 if (bytepos
<= BEGV_BYTE
)
20710 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20713 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20714 itb
.paragraph_dir
= NEUTRAL_DIR
;
20715 itb
.string
.s
= NULL
;
20716 itb
.string
.lstring
= Qnil
;
20717 itb
.string
.bufpos
= 0;
20718 itb
.string
.from_disp_str
= 0;
20719 itb
.string
.unibyte
= 0;
20720 /* We have no window to use here for ignoring window-specific
20721 overlays. Using NULL for window pointer will cause
20722 compute_display_string_pos to use the current buffer. */
20724 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20725 bidi_unshelve_cache (itb_data
, 0);
20726 set_buffer_temp (old
);
20727 switch (itb
.paragraph_dir
)
20730 return Qleft_to_right
;
20733 return Qright_to_left
;
20741 DEFUN ("move-point-visually", Fmove_point_visually
,
20742 Smove_point_visually
, 1, 1, 0,
20743 doc
: /* Move point in the visual order in the specified DIRECTION.
20744 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
20747 Value is the new character position of point. */)
20748 (Lisp_Object direction
)
20750 struct window
*w
= XWINDOW (selected_window
);
20751 struct buffer
*b
= XBUFFER (w
->contents
);
20752 struct glyph_row
*row
;
20754 Lisp_Object paragraph_dir
;
20756 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
20757 (!(ROW)->continued_p \
20758 && INTEGERP ((GLYPH)->object) \
20759 && (GLYPH)->type == CHAR_GLYPH \
20760 && (GLYPH)->u.ch == ' ' \
20761 && (GLYPH)->charpos >= 0 \
20762 && !(GLYPH)->avoid_cursor_p)
20764 CHECK_NUMBER (direction
);
20765 dir
= XINT (direction
);
20771 /* If current matrix is up-to-date, we can use the information
20772 recorded in the glyphs, at least as long as the goal is on the
20774 if (w
->window_end_valid
20775 && !windows_or_buffers_changed
20777 && !b
->clip_changed
20778 && !b
->prevent_redisplay_optimizations_p
20779 && !window_outdated (w
)
20780 /* We rely below on the cursor coordinates to be up to date, but
20781 we cannot trust them if some command moved point since the
20782 last complete redisplay. */
20783 && w
->last_point
== BUF_PT (b
)
20784 && w
->cursor
.vpos
>= 0
20785 && w
->cursor
.vpos
< w
->current_matrix
->nrows
20786 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
20788 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
20789 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
20790 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
20792 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
20794 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
20796 SET_PT (g
->charpos
);
20797 w
->cursor
.vpos
= -1;
20798 return make_number (PT
);
20800 else if (!INTEGERP (g
->object
) && !EQ (g
->object
, gpt
->object
))
20804 if (BUFFERP (gpt
->object
))
20807 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
20808 new_pos
+= (row
->reversed_p
? -dir
: dir
);
20810 new_pos
-= (row
->reversed_p
? -dir
: dir
);;
20812 else if (BUFFERP (g
->object
))
20813 new_pos
= g
->charpos
;
20817 w
->cursor
.vpos
= -1;
20818 return make_number (PT
);
20820 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
20822 /* Glyphs inserted at the end of a non-empty line for
20823 positioning the cursor have zero charpos, so we must
20824 deduce the value of point by other means. */
20825 if (g
->charpos
> 0)
20826 SET_PT (g
->charpos
);
20827 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
20829 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
20830 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
20833 w
->cursor
.vpos
= -1;
20834 return make_number (PT
);
20837 if (g
== e
|| INTEGERP (g
->object
))
20839 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
20840 goto simulate_display
;
20841 if (!row
->reversed_p
)
20845 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
20846 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
20847 goto simulate_display
;
20851 if (row
->reversed_p
&& !row
->continued_p
)
20853 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
20854 w
->cursor
.vpos
= -1;
20855 return make_number (PT
);
20857 g
= row
->glyphs
[TEXT_AREA
];
20858 e
= g
+ row
->used
[TEXT_AREA
];
20859 for ( ; g
< e
; g
++)
20861 if (BUFFERP (g
->object
)
20862 /* Empty lines have only one glyph, which stands
20863 for the newline, and whose charpos is the
20864 buffer position of the newline. */
20865 || ROW_GLYPH_NEWLINE_P (row
, g
)
20866 /* When the buffer ends in a newline, the line at
20867 EOB also has one glyph, but its charpos is -1. */
20868 || (row
->ends_at_zv_p
20869 && !row
->reversed_p
20870 && INTEGERP (g
->object
)
20871 && g
->type
== CHAR_GLYPH
20872 && g
->u
.ch
== ' '))
20874 if (g
->charpos
> 0)
20875 SET_PT (g
->charpos
);
20876 else if (!row
->reversed_p
20877 && row
->ends_at_zv_p
20882 w
->cursor
.vpos
= -1;
20883 return make_number (PT
);
20889 if (!row
->reversed_p
&& !row
->continued_p
)
20891 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
20892 w
->cursor
.vpos
= -1;
20893 return make_number (PT
);
20895 e
= row
->glyphs
[TEXT_AREA
];
20896 g
= e
+ row
->used
[TEXT_AREA
] - 1;
20897 for ( ; g
>= e
; g
--)
20899 if (BUFFERP (g
->object
)
20900 || (ROW_GLYPH_NEWLINE_P (row
, g
)
20902 /* Empty R2L lines on GUI frames have the buffer
20903 position of the newline stored in the stretch
20905 || g
->type
== STRETCH_GLYPH
20906 || (row
->ends_at_zv_p
20908 && INTEGERP (g
->object
)
20909 && g
->type
== CHAR_GLYPH
20910 && g
->u
.ch
== ' '))
20912 if (g
->charpos
> 0)
20913 SET_PT (g
->charpos
);
20914 else if (row
->reversed_p
20915 && row
->ends_at_zv_p
20920 w
->cursor
.vpos
= -1;
20921 return make_number (PT
);
20930 /* If we wind up here, we failed to move by using the glyphs, so we
20931 need to simulate display instead. */
20934 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
20936 paragraph_dir
= Qleft_to_right
;
20937 if (EQ (paragraph_dir
, Qright_to_left
))
20939 if (PT
<= BEGV
&& dir
< 0)
20940 xsignal0 (Qbeginning_of_buffer
);
20941 else if (PT
>= ZV
&& dir
> 0)
20942 xsignal0 (Qend_of_buffer
);
20945 struct text_pos pt
;
20947 int pt_x
, target_x
, pixel_width
, pt_vpos
;
20949 bool overshoot_expected
= false;
20950 bool target_is_eol_p
= false;
20952 /* Setup the arena. */
20953 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
20954 start_display (&it
, w
, pt
);
20956 if (it
.cmp_it
.id
< 0
20957 && it
.method
== GET_FROM_STRING
20958 && it
.area
== TEXT_AREA
20959 && it
.string_from_display_prop_p
20960 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
20961 overshoot_expected
= true;
20963 /* Find the X coordinate of point. We start from the beginning
20964 of this or previous line to make sure we are before point in
20965 the logical order (since the move_it_* functions can only
20968 reseat_at_previous_visible_line_start (&it
);
20969 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
20970 if (IT_CHARPOS (it
) != PT
)
20972 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
20973 -1, -1, -1, MOVE_TO_POS
);
20974 /* If we missed point because the character there is
20975 displayed out of a display vector that has more than one
20976 glyph, retry expecting overshoot. */
20977 if (it
.method
== GET_FROM_DISPLAY_VECTOR
20978 && it
.current
.dpvec_index
> 0
20979 && !overshoot_expected
)
20981 overshoot_expected
= true;
20984 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
20985 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
20987 pt_x
= it
.current_x
;
20989 if (dir
> 0 || overshoot_expected
)
20991 struct glyph_row
*row
= it
.glyph_row
;
20993 /* When point is at beginning of line, we don't have
20994 information about the glyph there loaded into struct
20995 it. Calling get_next_display_element fixes that. */
20997 get_next_display_element (&it
);
20998 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
20999 it
.glyph_row
= NULL
;
21000 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21001 it
.glyph_row
= row
;
21002 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21003 it, lest it will become out of sync with it's buffer
21005 it
.current_x
= pt_x
;
21008 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21009 pixel_width
= it
.pixel_width
;
21010 if (overshoot_expected
&& at_eol_p
)
21012 else if (pixel_width
<= 0)
21015 /* If there's a display string (or something similar) at point,
21016 we are actually at the glyph to the left of point, so we need
21017 to correct the X coordinate. */
21018 if (overshoot_expected
)
21021 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21023 pt_x
+= pixel_width
;
21026 /* Compute target X coordinate, either to the left or to the
21027 right of point. On TTY frames, all characters have the same
21028 pixel width of 1, so we can use that. On GUI frames we don't
21029 have an easy way of getting at the pixel width of the
21030 character to the left of point, so we use a different method
21031 of getting to that place. */
21033 target_x
= pt_x
+ pixel_width
;
21035 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21037 /* Target X coordinate could be one line above or below the line
21038 of point, in which case we need to adjust the target X
21039 coordinate. Also, if moving to the left, we need to begin at
21040 the left edge of the point's screen line. */
21045 start_display (&it
, w
, pt
);
21046 reseat_at_previous_visible_line_start (&it
);
21047 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21049 move_it_by_lines (&it
, pt_vpos
);
21053 move_it_by_lines (&it
, -1);
21054 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21055 target_is_eol_p
= true;
21056 /* Under word-wrap, we don't know the x coordinate of
21057 the last character displayed on the previous line,
21058 which immediately precedes the wrap point. To find
21059 out its x coordinate, we try moving to the right
21060 margin of the window, which will stop at the wrap
21061 point, and then reset target_x to point at the
21062 character that precedes the wrap point. This is not
21063 needed on GUI frames, because (see below) there we
21064 move from the left margin one grapheme cluster at a
21065 time, and stop when we hit the wrap point. */
21066 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21068 void *it_data
= NULL
;
21071 SAVE_IT (it2
, it
, it_data
);
21072 move_it_in_display_line_to (&it
, ZV
, target_x
,
21073 MOVE_TO_POS
| MOVE_TO_X
);
21074 /* If we arrived at target_x, that _is_ the last
21075 character on the previous line. */
21076 if (it
.current_x
!= target_x
)
21077 target_x
= it
.current_x
- 1;
21078 RESTORE_IT (&it
, &it2
, it_data
);
21085 || (target_x
>= it
.last_visible_x
21086 && it
.line_wrap
!= TRUNCATE
))
21089 move_it_by_lines (&it
, 0);
21090 move_it_by_lines (&it
, 1);
21095 /* Move to the target X coordinate. */
21096 #ifdef HAVE_WINDOW_SYSTEM
21097 /* On GUI frames, as we don't know the X coordinate of the
21098 character to the left of point, moving point to the left
21099 requires walking, one grapheme cluster at a time, until we
21100 find ourself at a place immediately to the left of the
21101 character at point. */
21102 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21104 struct text_pos new_pos
;
21105 enum move_it_result rc
= MOVE_X_REACHED
;
21107 if (it
.current_x
== 0)
21108 get_next_display_element (&it
);
21109 if (it
.what
== IT_COMPOSITION
)
21111 new_pos
.charpos
= it
.cmp_it
.charpos
;
21112 new_pos
.bytepos
= -1;
21115 new_pos
= it
.current
.pos
;
21117 while (it
.current_x
+ it
.pixel_width
<= target_x
21118 && (rc
== MOVE_X_REACHED
21119 /* Under word-wrap, move_it_in_display_line_to
21120 stops at correct coordinates, but sometimes
21121 returns MOVE_POS_MATCH_OR_ZV. */
21122 || (it
.line_wrap
== WORD_WRAP
21123 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21125 int new_x
= it
.current_x
+ it
.pixel_width
;
21127 /* For composed characters, we want the position of the
21128 first character in the grapheme cluster (usually, the
21129 composition's base character), whereas it.current
21130 might give us the position of the _last_ one, e.g. if
21131 the composition is rendered in reverse due to bidi
21133 if (it
.what
== IT_COMPOSITION
)
21135 new_pos
.charpos
= it
.cmp_it
.charpos
;
21136 new_pos
.bytepos
= -1;
21139 new_pos
= it
.current
.pos
;
21140 if (new_x
== it
.current_x
)
21142 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21143 MOVE_TO_POS
| MOVE_TO_X
);
21144 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21147 /* The previous position we saw in the loop is the one we
21149 if (new_pos
.bytepos
== -1)
21150 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21151 it
.current
.pos
= new_pos
;
21155 if (it
.current_x
!= target_x
)
21156 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21158 /* When lines are truncated, the above loop will stop at the
21159 window edge. But we want to get to the end of line, even if
21160 it is beyond the window edge; automatic hscroll will then
21161 scroll the window to show point as appropriate. */
21162 if (target_is_eol_p
&& it
.line_wrap
== TRUNCATE
21163 && get_next_display_element (&it
))
21165 struct text_pos new_pos
= it
.current
.pos
;
21167 while (!ITERATOR_AT_END_OF_LINE_P (&it
))
21169 set_iterator_to_next (&it
, 0);
21170 if (it
.method
== GET_FROM_BUFFER
)
21171 new_pos
= it
.current
.pos
;
21172 if (!get_next_display_element (&it
))
21176 it
.current
.pos
= new_pos
;
21179 /* If we ended up in a display string that covers point, move to
21180 buffer position to the right in the visual order. */
21183 while (IT_CHARPOS (it
) == PT
)
21185 set_iterator_to_next (&it
, 0);
21186 if (!get_next_display_element (&it
))
21191 /* Move point to that position. */
21192 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21195 return make_number (PT
);
21197 #undef ROW_GLYPH_NEWLINE_P
21201 /***********************************************************************
21203 ***********************************************************************/
21205 /* Redisplay the menu bar in the frame for window W.
21207 The menu bar of X frames that don't have X toolkit support is
21208 displayed in a special window W->frame->menu_bar_window.
21210 The menu bar of terminal frames is treated specially as far as
21211 glyph matrices are concerned. Menu bar lines are not part of
21212 windows, so the update is done directly on the frame matrix rows
21213 for the menu bar. */
21216 display_menu_bar (struct window
*w
)
21218 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21223 /* Don't do all this for graphical frames. */
21225 if (FRAME_W32_P (f
))
21228 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21234 if (FRAME_NS_P (f
))
21236 #endif /* HAVE_NS */
21238 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21239 eassert (!FRAME_WINDOW_P (f
));
21240 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21241 it
.first_visible_x
= 0;
21242 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21243 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21244 if (FRAME_WINDOW_P (f
))
21246 /* Menu bar lines are displayed in the desired matrix of the
21247 dummy window menu_bar_window. */
21248 struct window
*menu_w
;
21249 menu_w
= XWINDOW (f
->menu_bar_window
);
21250 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21252 it
.first_visible_x
= 0;
21253 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21256 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21258 /* This is a TTY frame, i.e. character hpos/vpos are used as
21260 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21262 it
.first_visible_x
= 0;
21263 it
.last_visible_x
= FRAME_COLS (f
);
21266 /* FIXME: This should be controlled by a user option. See the
21267 comments in redisplay_tool_bar and display_mode_line about
21269 it
.paragraph_embedding
= L2R
;
21271 /* Clear all rows of the menu bar. */
21272 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21274 struct glyph_row
*row
= it
.glyph_row
+ i
;
21275 clear_glyph_row (row
);
21276 row
->enabled_p
= true;
21277 row
->full_width_p
= 1;
21280 /* Display all items of the menu bar. */
21281 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21282 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21284 Lisp_Object string
;
21286 /* Stop at nil string. */
21287 string
= AREF (items
, i
+ 1);
21291 /* Remember where item was displayed. */
21292 ASET (items
, i
+ 3, make_number (it
.hpos
));
21294 /* Display the item, pad with one space. */
21295 if (it
.current_x
< it
.last_visible_x
)
21296 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21297 SCHARS (string
) + 1, 0, 0, -1);
21300 /* Fill out the line with spaces. */
21301 if (it
.current_x
< it
.last_visible_x
)
21302 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21304 /* Compute the total height of the lines. */
21305 compute_line_metrics (&it
);
21308 /* Deep copy of a glyph row, including the glyphs. */
21310 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21312 struct glyph
*pointers
[1 + LAST_AREA
];
21313 int to_used
= to
->used
[TEXT_AREA
];
21315 /* Save glyph pointers of TO. */
21316 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21318 /* Do a structure assignment. */
21321 /* Restore original glyph pointers of TO. */
21322 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21324 /* Copy the glyphs. */
21325 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21326 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21328 /* If we filled only part of the TO row, fill the rest with
21329 space_glyph (which will display as empty space). */
21330 if (to_used
> from
->used
[TEXT_AREA
])
21331 fill_up_frame_row_with_spaces (to
, to_used
);
21334 /* Display one menu item on a TTY, by overwriting the glyphs in the
21335 frame F's desired glyph matrix with glyphs produced from the menu
21336 item text. Called from term.c to display TTY drop-down menus one
21339 ITEM_TEXT is the menu item text as a C string.
21341 FACE_ID is the face ID to be used for this menu item. FACE_ID
21342 could specify one of 3 faces: a face for an enabled item, a face
21343 for a disabled item, or a face for a selected item.
21345 X and Y are coordinates of the first glyph in the frame's desired
21346 matrix to be overwritten by the menu item. Since this is a TTY, Y
21347 is the zero-based number of the glyph row and X is the zero-based
21348 glyph number in the row, starting from left, where to start
21349 displaying the item.
21351 SUBMENU non-zero means this menu item drops down a submenu, which
21352 should be indicated by displaying a proper visual cue after the
21356 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21357 int x
, int y
, int submenu
)
21360 struct frame
*f
= SELECTED_FRAME ();
21361 struct window
*w
= XWINDOW (f
->selected_window
);
21362 int saved_used
, saved_truncated
, saved_width
, saved_reversed
;
21363 struct glyph_row
*row
;
21364 size_t item_len
= strlen (item_text
);
21366 eassert (FRAME_TERMCAP_P (f
));
21368 /* Don't write beyond the matrix's last row. This can happen for
21369 TTY screens that are not high enough to show the entire menu.
21370 (This is actually a bit of defensive programming, as
21371 tty_menu_display already limits the number of menu items to one
21372 less than the number of screen lines.) */
21373 if (y
>= f
->desired_matrix
->nrows
)
21376 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21377 it
.first_visible_x
= 0;
21378 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21379 row
= it
.glyph_row
;
21380 /* Start with the row contents from the current matrix. */
21381 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21382 saved_width
= row
->full_width_p
;
21383 row
->full_width_p
= 1;
21384 saved_reversed
= row
->reversed_p
;
21385 row
->reversed_p
= 0;
21386 row
->enabled_p
= true;
21388 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21390 eassert (x
< f
->desired_matrix
->matrix_w
);
21391 it
.current_x
= it
.hpos
= x
;
21392 it
.current_y
= it
.vpos
= y
;
21393 saved_used
= row
->used
[TEXT_AREA
];
21394 saved_truncated
= row
->truncated_on_right_p
;
21395 row
->used
[TEXT_AREA
] = x
;
21396 it
.face_id
= face_id
;
21397 it
.line_wrap
= TRUNCATE
;
21399 /* FIXME: This should be controlled by a user option. See the
21400 comments in redisplay_tool_bar and display_mode_line about this.
21401 Also, if paragraph_embedding could ever be R2L, changes will be
21402 needed to avoid shifting to the right the row characters in
21403 term.c:append_glyph. */
21404 it
.paragraph_embedding
= L2R
;
21406 /* Pad with a space on the left. */
21407 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21409 /* Display the menu item, pad with spaces to WIDTH. */
21412 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21413 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21415 /* Indicate with " >" that there's a submenu. */
21416 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21417 FRAME_COLS (f
) - 1, -1);
21420 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21421 width
, 0, FRAME_COLS (f
) - 1, -1);
21423 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21424 row
->truncated_on_right_p
= saved_truncated
;
21425 row
->hash
= row_hash (row
);
21426 row
->full_width_p
= saved_width
;
21427 row
->reversed_p
= saved_reversed
;
21430 /***********************************************************************
21432 ***********************************************************************/
21434 /* Redisplay mode lines in the window tree whose root is WINDOW. If
21435 FORCE is non-zero, redisplay mode lines unconditionally.
21436 Otherwise, redisplay only mode lines that are garbaged. Value is
21437 the number of windows whose mode lines were redisplayed. */
21440 redisplay_mode_lines (Lisp_Object window
, bool force
)
21444 while (!NILP (window
))
21446 struct window
*w
= XWINDOW (window
);
21448 if (WINDOWP (w
->contents
))
21449 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
21451 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
21452 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
21454 struct text_pos lpoint
;
21455 struct buffer
*old
= current_buffer
;
21457 /* Set the window's buffer for the mode line display. */
21458 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
21459 set_buffer_internal_1 (XBUFFER (w
->contents
));
21461 /* Point refers normally to the selected window. For any
21462 other window, set up appropriate value. */
21463 if (!EQ (window
, selected_window
))
21465 struct text_pos pt
;
21467 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
21468 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
21471 /* Display mode lines. */
21472 clear_glyph_matrix (w
->desired_matrix
);
21473 if (display_mode_lines (w
))
21476 /* Restore old settings. */
21477 set_buffer_internal_1 (old
);
21478 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
21488 /* Display the mode and/or header line of window W. Value is the
21489 sum number of mode lines and header lines displayed. */
21492 display_mode_lines (struct window
*w
)
21494 Lisp_Object old_selected_window
= selected_window
;
21495 Lisp_Object old_selected_frame
= selected_frame
;
21496 Lisp_Object new_frame
= w
->frame
;
21497 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
21500 selected_frame
= new_frame
;
21501 /* FIXME: If we were to allow the mode-line's computation changing the buffer
21502 or window's point, then we'd need select_window_1 here as well. */
21503 XSETWINDOW (selected_window
, w
);
21504 XFRAME (new_frame
)->selected_window
= selected_window
;
21506 /* These will be set while the mode line specs are processed. */
21507 line_number_displayed
= 0;
21508 w
->column_number_displayed
= -1;
21510 if (WINDOW_WANTS_MODELINE_P (w
))
21512 struct window
*sel_w
= XWINDOW (old_selected_window
);
21514 /* Select mode line face based on the real selected window. */
21515 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
21516 BVAR (current_buffer
, mode_line_format
));
21520 if (WINDOW_WANTS_HEADER_LINE_P (w
))
21522 display_mode_line (w
, HEADER_LINE_FACE_ID
,
21523 BVAR (current_buffer
, header_line_format
));
21527 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
21528 selected_frame
= old_selected_frame
;
21529 selected_window
= old_selected_window
;
21531 w
->must_be_updated_p
= true;
21536 /* Display mode or header line of window W. FACE_ID specifies which
21537 line to display; it is either MODE_LINE_FACE_ID or
21538 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
21539 display. Value is the pixel height of the mode/header line
21543 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
21547 ptrdiff_t count
= SPECPDL_INDEX ();
21549 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21550 /* Don't extend on a previously drawn mode-line.
21551 This may happen if called from pos_visible_p. */
21552 it
.glyph_row
->enabled_p
= false;
21553 prepare_desired_row (w
, it
.glyph_row
, true);
21555 it
.glyph_row
->mode_line_p
= 1;
21557 /* FIXME: This should be controlled by a user option. But
21558 supporting such an option is not trivial, since the mode line is
21559 made up of many separate strings. */
21560 it
.paragraph_embedding
= L2R
;
21562 record_unwind_protect (unwind_format_mode_line
,
21563 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
21565 mode_line_target
= MODE_LINE_DISPLAY
;
21567 /* Temporarily make frame's keyboard the current kboard so that
21568 kboard-local variables in the mode_line_format will get the right
21570 push_kboard (FRAME_KBOARD (it
.f
));
21571 record_unwind_save_match_data ();
21572 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21575 unbind_to (count
, Qnil
);
21577 /* Fill up with spaces. */
21578 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
21580 compute_line_metrics (&it
);
21581 it
.glyph_row
->full_width_p
= 1;
21582 it
.glyph_row
->continued_p
= 0;
21583 it
.glyph_row
->truncated_on_left_p
= 0;
21584 it
.glyph_row
->truncated_on_right_p
= 0;
21586 /* Make a 3D mode-line have a shadow at its right end. */
21587 face
= FACE_FROM_ID (it
.f
, face_id
);
21588 extend_face_to_end_of_line (&it
);
21589 if (face
->box
!= FACE_NO_BOX
)
21591 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
21592 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
21593 last
->right_box_line_p
= 1;
21596 return it
.glyph_row
->height
;
21599 /* Move element ELT in LIST to the front of LIST.
21600 Return the updated list. */
21603 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
21605 register Lisp_Object tail
, prev
;
21606 register Lisp_Object tem
;
21610 while (CONSP (tail
))
21616 /* Splice out the link TAIL. */
21618 list
= XCDR (tail
);
21620 Fsetcdr (prev
, XCDR (tail
));
21622 /* Now make it the first. */
21623 Fsetcdr (tail
, list
);
21628 tail
= XCDR (tail
);
21632 /* Not found--return unchanged LIST. */
21636 /* Contribute ELT to the mode line for window IT->w. How it
21637 translates into text depends on its data type.
21639 IT describes the display environment in which we display, as usual.
21641 DEPTH is the depth in recursion. It is used to prevent
21642 infinite recursion here.
21644 FIELD_WIDTH is the number of characters the display of ELT should
21645 occupy in the mode line, and PRECISION is the maximum number of
21646 characters to display from ELT's representation. See
21647 display_string for details.
21649 Returns the hpos of the end of the text generated by ELT.
21651 PROPS is a property list to add to any string we encounter.
21653 If RISKY is nonzero, remove (disregard) any properties in any string
21654 we encounter, and ignore :eval and :propertize.
21656 The global variable `mode_line_target' determines whether the
21657 output is passed to `store_mode_line_noprop',
21658 `store_mode_line_string', or `display_string'. */
21661 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
21662 Lisp_Object elt
, Lisp_Object props
, int risky
)
21664 int n
= 0, field
, prec
;
21669 elt
= build_string ("*too-deep*");
21673 switch (XTYPE (elt
))
21677 /* A string: output it and check for %-constructs within it. */
21679 ptrdiff_t offset
= 0;
21681 if (SCHARS (elt
) > 0
21682 && (!NILP (props
) || risky
))
21684 Lisp_Object oprops
, aelt
;
21685 oprops
= Ftext_properties_at (make_number (0), elt
);
21687 /* If the starting string's properties are not what
21688 we want, translate the string. Also, if the string
21689 is risky, do that anyway. */
21691 if (NILP (Fequal (props
, oprops
)) || risky
)
21693 /* If the starting string has properties,
21694 merge the specified ones onto the existing ones. */
21695 if (! NILP (oprops
) && !risky
)
21699 oprops
= Fcopy_sequence (oprops
);
21701 while (CONSP (tem
))
21703 oprops
= Fplist_put (oprops
, XCAR (tem
),
21704 XCAR (XCDR (tem
)));
21705 tem
= XCDR (XCDR (tem
));
21710 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
21711 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
21713 /* AELT is what we want. Move it to the front
21714 without consing. */
21716 mode_line_proptrans_alist
21717 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
21723 /* If AELT has the wrong props, it is useless.
21724 so get rid of it. */
21726 mode_line_proptrans_alist
21727 = Fdelq (aelt
, mode_line_proptrans_alist
);
21729 elt
= Fcopy_sequence (elt
);
21730 Fset_text_properties (make_number (0), Flength (elt
),
21732 /* Add this item to mode_line_proptrans_alist. */
21733 mode_line_proptrans_alist
21734 = Fcons (Fcons (elt
, props
),
21735 mode_line_proptrans_alist
);
21736 /* Truncate mode_line_proptrans_alist
21737 to at most 50 elements. */
21738 tem
= Fnthcdr (make_number (50),
21739 mode_line_proptrans_alist
);
21741 XSETCDR (tem
, Qnil
);
21750 prec
= precision
- n
;
21751 switch (mode_line_target
)
21753 case MODE_LINE_NOPROP
:
21754 case MODE_LINE_TITLE
:
21755 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
21757 case MODE_LINE_STRING
:
21758 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
21760 case MODE_LINE_DISPLAY
:
21761 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
21762 0, prec
, 0, STRING_MULTIBYTE (elt
));
21769 /* Handle the non-literal case. */
21771 while ((precision
<= 0 || n
< precision
)
21772 && SREF (elt
, offset
) != 0
21773 && (mode_line_target
!= MODE_LINE_DISPLAY
21774 || it
->current_x
< it
->last_visible_x
))
21776 ptrdiff_t last_offset
= offset
;
21778 /* Advance to end of string or next format specifier. */
21779 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
21782 if (offset
- 1 != last_offset
)
21784 ptrdiff_t nchars
, nbytes
;
21786 /* Output to end of string or up to '%'. Field width
21787 is length of string. Don't output more than
21788 PRECISION allows us. */
21791 prec
= c_string_width (SDATA (elt
) + last_offset
,
21792 offset
- last_offset
, precision
- n
,
21795 switch (mode_line_target
)
21797 case MODE_LINE_NOPROP
:
21798 case MODE_LINE_TITLE
:
21799 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
21801 case MODE_LINE_STRING
:
21803 ptrdiff_t bytepos
= last_offset
;
21804 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
21805 ptrdiff_t endpos
= (precision
<= 0
21806 ? string_byte_to_char (elt
, offset
)
21807 : charpos
+ nchars
);
21809 n
+= store_mode_line_string (NULL
,
21810 Fsubstring (elt
, make_number (charpos
),
21811 make_number (endpos
)),
21815 case MODE_LINE_DISPLAY
:
21817 ptrdiff_t bytepos
= last_offset
;
21818 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
21820 if (precision
<= 0)
21821 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
21822 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
21824 STRING_MULTIBYTE (elt
));
21829 else /* c == '%' */
21831 ptrdiff_t percent_position
= offset
;
21833 /* Get the specified minimum width. Zero means
21836 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
21837 field
= field
* 10 + c
- '0';
21839 /* Don't pad beyond the total padding allowed. */
21840 if (field_width
- n
> 0 && field
> field_width
- n
)
21841 field
= field_width
- n
;
21843 /* Note that either PRECISION <= 0 or N < PRECISION. */
21844 prec
= precision
- n
;
21847 n
+= display_mode_element (it
, depth
, field
, prec
,
21848 Vglobal_mode_string
, props
,
21853 ptrdiff_t bytepos
, charpos
;
21855 Lisp_Object string
;
21857 bytepos
= percent_position
;
21858 charpos
= (STRING_MULTIBYTE (elt
)
21859 ? string_byte_to_char (elt
, bytepos
)
21861 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
21862 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
21864 switch (mode_line_target
)
21866 case MODE_LINE_NOPROP
:
21867 case MODE_LINE_TITLE
:
21868 n
+= store_mode_line_noprop (spec
, field
, prec
);
21870 case MODE_LINE_STRING
:
21872 Lisp_Object tem
= build_string (spec
);
21873 props
= Ftext_properties_at (make_number (charpos
), elt
);
21874 /* Should only keep face property in props */
21875 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
21878 case MODE_LINE_DISPLAY
:
21880 int nglyphs_before
, nwritten
;
21882 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
21883 nwritten
= display_string (spec
, string
, elt
,
21888 /* Assign to the glyphs written above the
21889 string where the `%x' came from, position
21893 struct glyph
*glyph
21894 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
21898 for (i
= 0; i
< nwritten
; ++i
)
21900 glyph
[i
].object
= elt
;
21901 glyph
[i
].charpos
= charpos
;
21918 /* A symbol: process the value of the symbol recursively
21919 as if it appeared here directly. Avoid error if symbol void.
21920 Special case: if value of symbol is a string, output the string
21923 register Lisp_Object tem
;
21925 /* If the variable is not marked as risky to set
21926 then its contents are risky to use. */
21927 if (NILP (Fget (elt
, Qrisky_local_variable
)))
21930 tem
= Fboundp (elt
);
21933 tem
= Fsymbol_value (elt
);
21934 /* If value is a string, output that string literally:
21935 don't check for % within it. */
21939 if (!EQ (tem
, elt
))
21941 /* Give up right away for nil or t. */
21951 register Lisp_Object car
, tem
;
21953 /* A cons cell: five distinct cases.
21954 If first element is :eval or :propertize, do something special.
21955 If first element is a string or a cons, process all the elements
21956 and effectively concatenate them.
21957 If first element is a negative number, truncate displaying cdr to
21958 at most that many characters. If positive, pad (with spaces)
21959 to at least that many characters.
21960 If first element is a symbol, process the cadr or caddr recursively
21961 according to whether the symbol's value is non-nil or nil. */
21963 if (EQ (car
, QCeval
))
21965 /* An element of the form (:eval FORM) means evaluate FORM
21966 and use the result as mode line elements. */
21971 if (CONSP (XCDR (elt
)))
21974 spec
= safe__eval (true, XCAR (XCDR (elt
)));
21975 n
+= display_mode_element (it
, depth
, field_width
- n
,
21976 precision
- n
, spec
, props
,
21980 else if (EQ (car
, QCpropertize
))
21982 /* An element of the form (:propertize ELT PROPS...)
21983 means display ELT but applying properties PROPS. */
21988 if (CONSP (XCDR (elt
)))
21989 n
+= display_mode_element (it
, depth
, field_width
- n
,
21990 precision
- n
, XCAR (XCDR (elt
)),
21991 XCDR (XCDR (elt
)), risky
);
21993 else if (SYMBOLP (car
))
21995 tem
= Fboundp (car
);
21999 /* elt is now the cdr, and we know it is a cons cell.
22000 Use its car if CAR has a non-nil value. */
22003 tem
= Fsymbol_value (car
);
22010 /* Symbol's value is nil (or symbol is unbound)
22011 Get the cddr of the original list
22012 and if possible find the caddr and use that. */
22016 else if (!CONSP (elt
))
22021 else if (INTEGERP (car
))
22023 register int lim
= XINT (car
);
22027 /* Negative int means reduce maximum width. */
22028 if (precision
<= 0)
22031 precision
= min (precision
, -lim
);
22035 /* Padding specified. Don't let it be more than
22036 current maximum. */
22038 lim
= min (precision
, lim
);
22040 /* If that's more padding than already wanted, queue it.
22041 But don't reduce padding already specified even if
22042 that is beyond the current truncation point. */
22043 field_width
= max (lim
, field_width
);
22047 else if (STRINGP (car
) || CONSP (car
))
22049 Lisp_Object halftail
= elt
;
22053 && (precision
<= 0 || n
< precision
))
22055 n
+= display_mode_element (it
, depth
,
22056 /* Do padding only after the last
22057 element in the list. */
22058 (! CONSP (XCDR (elt
))
22061 precision
- n
, XCAR (elt
),
22065 if ((len
& 1) == 0)
22066 halftail
= XCDR (halftail
);
22067 /* Check for cycle. */
22068 if (EQ (halftail
, elt
))
22077 elt
= build_string ("*invalid*");
22081 /* Pad to FIELD_WIDTH. */
22082 if (field_width
> 0 && n
< field_width
)
22084 switch (mode_line_target
)
22086 case MODE_LINE_NOPROP
:
22087 case MODE_LINE_TITLE
:
22088 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22090 case MODE_LINE_STRING
:
22091 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
22093 case MODE_LINE_DISPLAY
:
22094 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22103 /* Store a mode-line string element in mode_line_string_list.
22105 If STRING is non-null, display that C string. Otherwise, the Lisp
22106 string LISP_STRING is displayed.
22108 FIELD_WIDTH is the minimum number of output glyphs to produce.
22109 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22110 with spaces. FIELD_WIDTH <= 0 means don't pad.
22112 PRECISION is the maximum number of characters to output from
22113 STRING. PRECISION <= 0 means don't truncate the string.
22115 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
22116 properties to the string.
22118 PROPS are the properties to add to the string.
22119 The mode_line_string_face face property is always added to the string.
22123 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
22124 int field_width
, int precision
, Lisp_Object props
)
22129 if (string
!= NULL
)
22131 len
= strlen (string
);
22132 if (precision
> 0 && len
> precision
)
22134 lisp_string
= make_string (string
, len
);
22136 props
= mode_line_string_face_prop
;
22137 else if (!NILP (mode_line_string_face
))
22139 Lisp_Object face
= Fplist_get (props
, Qface
);
22140 props
= Fcopy_sequence (props
);
22142 face
= mode_line_string_face
;
22144 face
= list2 (face
, mode_line_string_face
);
22145 props
= Fplist_put (props
, Qface
, face
);
22147 Fadd_text_properties (make_number (0), make_number (len
),
22148 props
, lisp_string
);
22152 len
= XFASTINT (Flength (lisp_string
));
22153 if (precision
> 0 && len
> precision
)
22156 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22159 if (!NILP (mode_line_string_face
))
22163 props
= Ftext_properties_at (make_number (0), lisp_string
);
22164 face
= Fplist_get (props
, Qface
);
22166 face
= mode_line_string_face
;
22168 face
= list2 (face
, mode_line_string_face
);
22169 props
= list2 (Qface
, face
);
22171 lisp_string
= Fcopy_sequence (lisp_string
);
22174 Fadd_text_properties (make_number (0), make_number (len
),
22175 props
, lisp_string
);
22180 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22184 if (field_width
> len
)
22186 field_width
-= len
;
22187 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22189 Fadd_text_properties (make_number (0), make_number (field_width
),
22190 props
, lisp_string
);
22191 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22199 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22201 doc
: /* Format a string out of a mode line format specification.
22202 First arg FORMAT specifies the mode line format (see `mode-line-format'
22203 for details) to use.
22205 By default, the format is evaluated for the currently selected window.
22207 Optional second arg FACE specifies the face property to put on all
22208 characters for which no face is specified. The value nil means the
22209 default face. The value t means whatever face the window's mode line
22210 currently uses (either `mode-line' or `mode-line-inactive',
22211 depending on whether the window is the selected window or not).
22212 An integer value means the value string has no text
22215 Optional third and fourth args WINDOW and BUFFER specify the window
22216 and buffer to use as the context for the formatting (defaults
22217 are the selected window and the WINDOW's buffer). */)
22218 (Lisp_Object format
, Lisp_Object face
,
22219 Lisp_Object window
, Lisp_Object buffer
)
22224 struct buffer
*old_buffer
= NULL
;
22226 int no_props
= INTEGERP (face
);
22227 ptrdiff_t count
= SPECPDL_INDEX ();
22229 int string_start
= 0;
22231 w
= decode_any_window (window
);
22232 XSETWINDOW (window
, w
);
22235 buffer
= w
->contents
;
22236 CHECK_BUFFER (buffer
);
22238 /* Make formatting the modeline a non-op when noninteractive, otherwise
22239 there will be problems later caused by a partially initialized frame. */
22240 if (NILP (format
) || noninteractive
)
22241 return empty_unibyte_string
;
22246 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22247 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22248 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22249 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22250 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22251 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22252 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22255 old_buffer
= current_buffer
;
22257 /* Save things including mode_line_proptrans_alist,
22258 and set that to nil so that we don't alter the outer value. */
22259 record_unwind_protect (unwind_format_mode_line
,
22260 format_mode_line_unwind_data
22261 (XFRAME (WINDOW_FRAME (w
)),
22262 old_buffer
, selected_window
, 1));
22263 mode_line_proptrans_alist
= Qnil
;
22265 Fselect_window (window
, Qt
);
22266 set_buffer_internal_1 (XBUFFER (buffer
));
22268 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22272 mode_line_target
= MODE_LINE_NOPROP
;
22273 mode_line_string_face_prop
= Qnil
;
22274 mode_line_string_list
= Qnil
;
22275 string_start
= MODE_LINE_NOPROP_LEN (0);
22279 mode_line_target
= MODE_LINE_STRING
;
22280 mode_line_string_list
= Qnil
;
22281 mode_line_string_face
= face
;
22282 mode_line_string_face_prop
22283 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22286 push_kboard (FRAME_KBOARD (it
.f
));
22287 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
22292 len
= MODE_LINE_NOPROP_LEN (string_start
);
22293 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22297 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22298 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
22299 empty_unibyte_string
);
22302 unbind_to (count
, Qnil
);
22306 /* Write a null-terminated, right justified decimal representation of
22307 the positive integer D to BUF using a minimal field width WIDTH. */
22310 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22312 register char *p
= buf
;
22320 *p
++ = d
% 10 + '0';
22325 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22336 /* Write a null-terminated, right justified decimal and "human
22337 readable" representation of the nonnegative integer D to BUF using
22338 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22340 static const char power_letter
[] =
22354 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22356 /* We aim to represent the nonnegative integer D as
22357 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22358 ptrdiff_t quotient
= d
;
22360 /* -1 means: do not use TENTHS. */
22364 /* Length of QUOTIENT.TENTHS as a string. */
22370 if (quotient
>= 1000)
22372 /* Scale to the appropriate EXPONENT. */
22375 remainder
= quotient
% 1000;
22379 while (quotient
>= 1000);
22381 /* Round to nearest and decide whether to use TENTHS or not. */
22384 tenths
= remainder
/ 100;
22385 if (remainder
% 100 >= 50)
22392 if (quotient
== 10)
22400 if (remainder
>= 500)
22402 if (quotient
< 999)
22413 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22414 if (tenths
== -1 && quotient
<= 99)
22421 p
= psuffix
= buf
+ max (width
, length
);
22423 /* Print EXPONENT. */
22424 *psuffix
++ = power_letter
[exponent
];
22427 /* Print TENTHS. */
22430 *--p
= '0' + tenths
;
22434 /* Print QUOTIENT. */
22437 int digit
= quotient
% 10;
22438 *--p
= '0' + digit
;
22440 while ((quotient
/= 10) != 0);
22442 /* Print leading spaces. */
22447 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22448 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
22449 type of CODING_SYSTEM. Return updated pointer into BUF. */
22451 static unsigned char invalid_eol_type
[] = "(*invalid*)";
22454 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
22457 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
22458 const unsigned char *eol_str
;
22460 /* The EOL conversion we are using. */
22461 Lisp_Object eoltype
;
22463 val
= CODING_SYSTEM_SPEC (coding_system
);
22466 if (!VECTORP (val
)) /* Not yet decided. */
22468 *buf
++ = multibyte
? '-' : ' ';
22470 eoltype
= eol_mnemonic_undecided
;
22471 /* Don't mention EOL conversion if it isn't decided. */
22476 Lisp_Object eolvalue
;
22478 attrs
= AREF (val
, 0);
22479 eolvalue
= AREF (val
, 2);
22482 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
22487 /* The EOL conversion that is normal on this system. */
22489 if (NILP (eolvalue
)) /* Not yet decided. */
22490 eoltype
= eol_mnemonic_undecided
;
22491 else if (VECTORP (eolvalue
)) /* Not yet decided. */
22492 eoltype
= eol_mnemonic_undecided
;
22493 else /* eolvalue is Qunix, Qdos, or Qmac. */
22494 eoltype
= (EQ (eolvalue
, Qunix
)
22495 ? eol_mnemonic_unix
22496 : (EQ (eolvalue
, Qdos
) == 1
22497 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
22503 /* Mention the EOL conversion if it is not the usual one. */
22504 if (STRINGP (eoltype
))
22506 eol_str
= SDATA (eoltype
);
22507 eol_str_len
= SBYTES (eoltype
);
22509 else if (CHARACTERP (eoltype
))
22511 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
22512 int c
= XFASTINT (eoltype
);
22513 eol_str_len
= CHAR_STRING (c
, tmp
);
22518 eol_str
= invalid_eol_type
;
22519 eol_str_len
= sizeof (invalid_eol_type
) - 1;
22521 memcpy (buf
, eol_str
, eol_str_len
);
22522 buf
+= eol_str_len
;
22528 /* Return a string for the output of a mode line %-spec for window W,
22529 generated by character C. FIELD_WIDTH > 0 means pad the string
22530 returned with spaces to that value. Return a Lisp string in
22531 *STRING if the resulting string is taken from that Lisp string.
22533 Note we operate on the current buffer for most purposes. */
22535 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
22537 static const char *
22538 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
22539 Lisp_Object
*string
)
22542 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22543 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
22544 /* We are going to use f->decode_mode_spec_buffer as the buffer to
22545 produce strings from numerical values, so limit preposterously
22546 large values of FIELD_WIDTH to avoid overrunning the buffer's
22547 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
22548 bytes plus the terminating null. */
22549 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
22550 struct buffer
*b
= current_buffer
;
22558 if (!NILP (BVAR (b
, read_only
)))
22560 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22565 /* This differs from %* only for a modified read-only buffer. */
22566 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22568 if (!NILP (BVAR (b
, read_only
)))
22573 /* This differs from %* in ignoring read-only-ness. */
22574 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22586 if (command_loop_level
> 5)
22588 p
= decode_mode_spec_buf
;
22589 for (i
= 0; i
< command_loop_level
; i
++)
22592 return decode_mode_spec_buf
;
22600 if (command_loop_level
> 5)
22602 p
= decode_mode_spec_buf
;
22603 for (i
= 0; i
< command_loop_level
; i
++)
22606 return decode_mode_spec_buf
;
22613 /* Let lots_of_dashes be a string of infinite length. */
22614 if (mode_line_target
== MODE_LINE_NOPROP
22615 || mode_line_target
== MODE_LINE_STRING
)
22617 if (field_width
<= 0
22618 || field_width
> sizeof (lots_of_dashes
))
22620 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
22621 decode_mode_spec_buf
[i
] = '-';
22622 decode_mode_spec_buf
[i
] = '\0';
22623 return decode_mode_spec_buf
;
22626 return lots_of_dashes
;
22630 obj
= BVAR (b
, name
);
22634 /* %c and %l are ignored in `frame-title-format'.
22635 (In redisplay_internal, the frame title is drawn _before_ the
22636 windows are updated, so the stuff which depends on actual
22637 window contents (such as %l) may fail to render properly, or
22638 even crash emacs.) */
22639 if (mode_line_target
== MODE_LINE_TITLE
)
22643 ptrdiff_t col
= current_column ();
22644 w
->column_number_displayed
= col
;
22645 pint2str (decode_mode_spec_buf
, width
, col
);
22646 return decode_mode_spec_buf
;
22650 #ifndef SYSTEM_MALLOC
22652 if (NILP (Vmemory_full
))
22655 return "!MEM FULL! ";
22662 /* %F displays the frame name. */
22663 if (!NILP (f
->title
))
22664 return SSDATA (f
->title
);
22665 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
22666 return SSDATA (f
->name
);
22670 obj
= BVAR (b
, filename
);
22675 ptrdiff_t size
= ZV
- BEGV
;
22676 pint2str (decode_mode_spec_buf
, width
, size
);
22677 return decode_mode_spec_buf
;
22682 ptrdiff_t size
= ZV
- BEGV
;
22683 pint2hrstr (decode_mode_spec_buf
, width
, size
);
22684 return decode_mode_spec_buf
;
22689 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
22690 ptrdiff_t topline
, nlines
, height
;
22693 /* %c and %l are ignored in `frame-title-format'. */
22694 if (mode_line_target
== MODE_LINE_TITLE
)
22697 startpos
= marker_position (w
->start
);
22698 startpos_byte
= marker_byte_position (w
->start
);
22699 height
= WINDOW_TOTAL_LINES (w
);
22701 /* If we decided that this buffer isn't suitable for line numbers,
22702 don't forget that too fast. */
22703 if (w
->base_line_pos
== -1)
22706 /* If the buffer is very big, don't waste time. */
22707 if (INTEGERP (Vline_number_display_limit
)
22708 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
22710 w
->base_line_pos
= 0;
22711 w
->base_line_number
= 0;
22715 if (w
->base_line_number
> 0
22716 && w
->base_line_pos
> 0
22717 && w
->base_line_pos
<= startpos
)
22719 line
= w
->base_line_number
;
22720 linepos
= w
->base_line_pos
;
22721 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
22726 linepos
= BUF_BEGV (b
);
22727 linepos_byte
= BUF_BEGV_BYTE (b
);
22730 /* Count lines from base line to window start position. */
22731 nlines
= display_count_lines (linepos_byte
,
22735 topline
= nlines
+ line
;
22737 /* Determine a new base line, if the old one is too close
22738 or too far away, or if we did not have one.
22739 "Too close" means it's plausible a scroll-down would
22740 go back past it. */
22741 if (startpos
== BUF_BEGV (b
))
22743 w
->base_line_number
= topline
;
22744 w
->base_line_pos
= BUF_BEGV (b
);
22746 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
22747 || linepos
== BUF_BEGV (b
))
22749 ptrdiff_t limit
= BUF_BEGV (b
);
22750 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
22751 ptrdiff_t position
;
22752 ptrdiff_t distance
=
22753 (height
* 2 + 30) * line_number_display_limit_width
;
22755 if (startpos
- distance
> limit
)
22757 limit
= startpos
- distance
;
22758 limit_byte
= CHAR_TO_BYTE (limit
);
22761 nlines
= display_count_lines (startpos_byte
,
22763 - (height
* 2 + 30),
22765 /* If we couldn't find the lines we wanted within
22766 line_number_display_limit_width chars per line,
22767 give up on line numbers for this window. */
22768 if (position
== limit_byte
&& limit
== startpos
- distance
)
22770 w
->base_line_pos
= -1;
22771 w
->base_line_number
= 0;
22775 w
->base_line_number
= topline
- nlines
;
22776 w
->base_line_pos
= BYTE_TO_CHAR (position
);
22779 /* Now count lines from the start pos to point. */
22780 nlines
= display_count_lines (startpos_byte
,
22781 PT_BYTE
, PT
, &junk
);
22783 /* Record that we did display the line number. */
22784 line_number_displayed
= 1;
22786 /* Make the string to show. */
22787 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
22788 return decode_mode_spec_buf
;
22791 char* p
= decode_mode_spec_buf
;
22792 int pad
= width
- 2;
22798 return decode_mode_spec_buf
;
22804 obj
= BVAR (b
, mode_name
);
22808 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
22814 ptrdiff_t pos
= marker_position (w
->start
);
22815 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
22817 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
22819 if (pos
<= BUF_BEGV (b
))
22824 else if (pos
<= BUF_BEGV (b
))
22828 if (total
> 1000000)
22829 /* Do it differently for a large value, to avoid overflow. */
22830 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
22832 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
22833 /* We can't normally display a 3-digit number,
22834 so get us a 2-digit number that is close. */
22837 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
22838 return decode_mode_spec_buf
;
22842 /* Display percentage of size above the bottom of the screen. */
22845 ptrdiff_t toppos
= marker_position (w
->start
);
22846 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
22847 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
22849 if (botpos
>= BUF_ZV (b
))
22851 if (toppos
<= BUF_BEGV (b
))
22858 if (total
> 1000000)
22859 /* Do it differently for a large value, to avoid overflow. */
22860 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
22862 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
22863 /* We can't normally display a 3-digit number,
22864 so get us a 2-digit number that is close. */
22867 if (toppos
<= BUF_BEGV (b
))
22868 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
22870 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
22871 return decode_mode_spec_buf
;
22876 /* status of process */
22877 obj
= Fget_buffer_process (Fcurrent_buffer ());
22879 return "no process";
22881 obj
= Fsymbol_name (Fprocess_status (obj
));
22887 ptrdiff_t count
= inhibit_garbage_collection ();
22888 Lisp_Object val
= call1 (intern ("file-remote-p"),
22889 BVAR (current_buffer
, directory
));
22890 unbind_to (count
, Qnil
);
22899 /* coding-system (not including end-of-line format) */
22901 /* coding-system (including end-of-line type) */
22903 int eol_flag
= (c
== 'Z');
22904 char *p
= decode_mode_spec_buf
;
22906 if (! FRAME_WINDOW_P (f
))
22908 /* No need to mention EOL here--the terminal never needs
22909 to do EOL conversion. */
22910 p
= decode_mode_spec_coding (CODING_ID_NAME
22911 (FRAME_KEYBOARD_CODING (f
)->id
),
22913 p
= decode_mode_spec_coding (CODING_ID_NAME
22914 (FRAME_TERMINAL_CODING (f
)->id
),
22917 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
22920 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
22921 #ifdef subprocesses
22922 obj
= Fget_buffer_process (Fcurrent_buffer ());
22923 if (PROCESSP (obj
))
22925 p
= decode_mode_spec_coding
22926 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
22927 p
= decode_mode_spec_coding
22928 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
22930 #endif /* subprocesses */
22933 return decode_mode_spec_buf
;
22940 return SSDATA (obj
);
22947 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
22948 means count lines back from START_BYTE. But don't go beyond
22949 LIMIT_BYTE. Return the number of lines thus found (always
22952 Set *BYTE_POS_PTR to the byte position where we stopped. This is
22953 either the position COUNT lines after/before START_BYTE, if we
22954 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
22958 display_count_lines (ptrdiff_t start_byte
,
22959 ptrdiff_t limit_byte
, ptrdiff_t count
,
22960 ptrdiff_t *byte_pos_ptr
)
22962 register unsigned char *cursor
;
22963 unsigned char *base
;
22965 register ptrdiff_t ceiling
;
22966 register unsigned char *ceiling_addr
;
22967 ptrdiff_t orig_count
= count
;
22969 /* If we are not in selective display mode,
22970 check only for newlines. */
22971 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
22972 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
22976 while (start_byte
< limit_byte
)
22978 ceiling
= BUFFER_CEILING_OF (start_byte
);
22979 ceiling
= min (limit_byte
- 1, ceiling
);
22980 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
22981 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
22985 if (selective_display
)
22987 while (*cursor
!= '\n' && *cursor
!= 015
22988 && ++cursor
!= ceiling_addr
)
22990 if (cursor
== ceiling_addr
)
22995 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23004 start_byte
+= cursor
- base
;
23005 *byte_pos_ptr
= start_byte
;
23009 while (cursor
< ceiling_addr
);
23011 start_byte
+= ceiling_addr
- base
;
23016 while (start_byte
> limit_byte
)
23018 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23019 ceiling
= max (limit_byte
, ceiling
);
23020 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23021 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23024 if (selective_display
)
23026 while (--cursor
>= ceiling_addr
23027 && *cursor
!= '\n' && *cursor
!= 015)
23029 if (cursor
< ceiling_addr
)
23034 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23041 start_byte
+= cursor
- base
+ 1;
23042 *byte_pos_ptr
= start_byte
;
23043 /* When scanning backwards, we should
23044 not count the newline posterior to which we stop. */
23045 return - orig_count
- 1;
23048 start_byte
+= ceiling_addr
- base
;
23052 *byte_pos_ptr
= limit_byte
;
23055 return - orig_count
+ count
;
23056 return orig_count
- count
;
23062 /***********************************************************************
23064 ***********************************************************************/
23066 /* Display a NUL-terminated string, starting with index START.
23068 If STRING is non-null, display that C string. Otherwise, the Lisp
23069 string LISP_STRING is displayed. There's a case that STRING is
23070 non-null and LISP_STRING is not nil. It means STRING is a string
23071 data of LISP_STRING. In that case, we display LISP_STRING while
23072 ignoring its text properties.
23074 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23075 FACE_STRING. Display STRING or LISP_STRING with the face at
23076 FACE_STRING_POS in FACE_STRING:
23078 Display the string in the environment given by IT, but use the
23079 standard display table, temporarily.
23081 FIELD_WIDTH is the minimum number of output glyphs to produce.
23082 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23083 with spaces. If STRING has more characters, more than FIELD_WIDTH
23084 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23086 PRECISION is the maximum number of characters to output from
23087 STRING. PRECISION < 0 means don't truncate the string.
23089 This is roughly equivalent to printf format specifiers:
23091 FIELD_WIDTH PRECISION PRINTF
23092 ----------------------------------------
23098 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23099 display them, and < 0 means obey the current buffer's value of
23100 enable_multibyte_characters.
23102 Value is the number of columns displayed. */
23105 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23106 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23107 int field_width
, int precision
, int max_x
, int multibyte
)
23109 int hpos_at_start
= it
->hpos
;
23110 int saved_face_id
= it
->face_id
;
23111 struct glyph_row
*row
= it
->glyph_row
;
23112 ptrdiff_t it_charpos
;
23114 /* Initialize the iterator IT for iteration over STRING beginning
23115 with index START. */
23116 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23117 precision
, field_width
, multibyte
);
23118 if (string
&& STRINGP (lisp_string
))
23119 /* LISP_STRING is the one returned by decode_mode_spec. We should
23120 ignore its text properties. */
23121 it
->stop_charpos
= it
->end_charpos
;
23123 /* If displaying STRING, set up the face of the iterator from
23124 FACE_STRING, if that's given. */
23125 if (STRINGP (face_string
))
23131 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23132 0, &endptr
, it
->base_face_id
, 0);
23133 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23134 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23137 /* Set max_x to the maximum allowed X position. Don't let it go
23138 beyond the right edge of the window. */
23140 max_x
= it
->last_visible_x
;
23142 max_x
= min (max_x
, it
->last_visible_x
);
23144 /* Skip over display elements that are not visible. because IT->w is
23146 if (it
->current_x
< it
->first_visible_x
)
23147 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23148 MOVE_TO_POS
| MOVE_TO_X
);
23150 row
->ascent
= it
->max_ascent
;
23151 row
->height
= it
->max_ascent
+ it
->max_descent
;
23152 row
->phys_ascent
= it
->max_phys_ascent
;
23153 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23154 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23156 if (STRINGP (it
->string
))
23157 it_charpos
= IT_STRING_CHARPOS (*it
);
23159 it_charpos
= IT_CHARPOS (*it
);
23161 /* This condition is for the case that we are called with current_x
23162 past last_visible_x. */
23163 while (it
->current_x
< max_x
)
23165 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23167 /* Get the next display element. */
23168 if (!get_next_display_element (it
))
23171 /* Produce glyphs. */
23172 x_before
= it
->current_x
;
23173 n_glyphs_before
= row
->used
[TEXT_AREA
];
23174 PRODUCE_GLYPHS (it
);
23176 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23179 while (i
< nglyphs
)
23181 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23183 if (it
->line_wrap
!= TRUNCATE
23184 && x
+ glyph
->pixel_width
> max_x
)
23186 /* End of continued line or max_x reached. */
23187 if (CHAR_GLYPH_PADDING_P (*glyph
))
23189 /* A wide character is unbreakable. */
23190 if (row
->reversed_p
)
23191 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23192 - n_glyphs_before
);
23193 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23194 it
->current_x
= x_before
;
23198 if (row
->reversed_p
)
23199 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23200 - (n_glyphs_before
+ i
));
23201 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23206 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23208 /* Glyph is at least partially visible. */
23210 if (x
< it
->first_visible_x
)
23211 row
->x
= x
- it
->first_visible_x
;
23215 /* Glyph is off the left margin of the display area.
23216 Should not happen. */
23220 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23221 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23222 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23223 row
->phys_height
= max (row
->phys_height
,
23224 it
->max_phys_ascent
+ it
->max_phys_descent
);
23225 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23226 it
->max_extra_line_spacing
);
23227 x
+= glyph
->pixel_width
;
23231 /* Stop if max_x reached. */
23235 /* Stop at line ends. */
23236 if (ITERATOR_AT_END_OF_LINE_P (it
))
23238 it
->continuation_lines_width
= 0;
23242 set_iterator_to_next (it
, 1);
23243 if (STRINGP (it
->string
))
23244 it_charpos
= IT_STRING_CHARPOS (*it
);
23246 it_charpos
= IT_CHARPOS (*it
);
23248 /* Stop if truncating at the right edge. */
23249 if (it
->line_wrap
== TRUNCATE
23250 && it
->current_x
>= it
->last_visible_x
)
23252 /* Add truncation mark, but don't do it if the line is
23253 truncated at a padding space. */
23254 if (it_charpos
< it
->string_nchars
)
23256 if (!FRAME_WINDOW_P (it
->f
))
23260 if (it
->current_x
> it
->last_visible_x
)
23262 if (!row
->reversed_p
)
23264 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23265 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23270 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23271 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23273 unproduce_glyphs (it
, ii
+ 1);
23274 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23276 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23278 row
->used
[TEXT_AREA
] = ii
;
23279 produce_special_glyphs (it
, IT_TRUNCATION
);
23282 produce_special_glyphs (it
, IT_TRUNCATION
);
23284 row
->truncated_on_right_p
= 1;
23290 /* Maybe insert a truncation at the left. */
23291 if (it
->first_visible_x
23294 if (!FRAME_WINDOW_P (it
->f
)
23295 || (row
->reversed_p
23296 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23297 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23298 insert_left_trunc_glyphs (it
);
23299 row
->truncated_on_left_p
= 1;
23302 it
->face_id
= saved_face_id
;
23304 /* Value is number of columns displayed. */
23305 return it
->hpos
- hpos_at_start
;
23310 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23311 appears as an element of LIST or as the car of an element of LIST.
23312 If PROPVAL is a list, compare each element against LIST in that
23313 way, and return 1/2 if any element of PROPVAL is found in LIST.
23314 Otherwise return 0. This function cannot quit.
23315 The return value is 2 if the text is invisible but with an ellipsis
23316 and 1 if it's invisible and without an ellipsis. */
23319 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
23321 register Lisp_Object tail
, proptail
;
23323 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23325 register Lisp_Object tem
;
23327 if (EQ (propval
, tem
))
23329 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23330 return NILP (XCDR (tem
)) ? 1 : 2;
23333 if (CONSP (propval
))
23335 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23337 Lisp_Object propelt
;
23338 propelt
= XCAR (proptail
);
23339 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23341 register Lisp_Object tem
;
23343 if (EQ (propelt
, tem
))
23345 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23346 return NILP (XCDR (tem
)) ? 1 : 2;
23354 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23355 doc
: /* Non-nil if the property makes the text invisible.
23356 POS-OR-PROP can be a marker or number, in which case it is taken to be
23357 a position in the current buffer and the value of the `invisible' property
23358 is checked; or it can be some other value, which is then presumed to be the
23359 value of the `invisible' property of the text of interest.
23360 The non-nil value returned can be t for truly invisible text or something
23361 else if the text is replaced by an ellipsis. */)
23362 (Lisp_Object pos_or_prop
)
23365 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23366 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23368 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23369 return (invis
== 0 ? Qnil
23371 : make_number (invis
));
23374 /* Calculate a width or height in pixels from a specification using
23375 the following elements:
23378 NUM - a (fractional) multiple of the default font width/height
23379 (NUM) - specifies exactly NUM pixels
23380 UNIT - a fixed number of pixels, see below.
23381 ELEMENT - size of a display element in pixels, see below.
23382 (NUM . SPEC) - equals NUM * SPEC
23383 (+ SPEC SPEC ...) - add pixel values
23384 (- SPEC SPEC ...) - subtract pixel values
23385 (- SPEC) - negate pixel value
23388 INT or FLOAT - a number constant
23389 SYMBOL - use symbol's (buffer local) variable binding.
23392 in - pixels per inch *)
23393 mm - pixels per 1/1000 meter *)
23394 cm - pixels per 1/100 meter *)
23395 width - width of current font in pixels.
23396 height - height of current font in pixels.
23398 *) using the ratio(s) defined in display-pixels-per-inch.
23402 left-fringe - left fringe width in pixels
23403 right-fringe - right fringe width in pixels
23405 left-margin - left margin width in pixels
23406 right-margin - right margin width in pixels
23408 scroll-bar - scroll-bar area width in pixels
23412 Pixels corresponding to 5 inches:
23415 Total width of non-text areas on left side of window (if scroll-bar is on left):
23416 '(space :width (+ left-fringe left-margin scroll-bar))
23418 Align to first text column (in header line):
23419 '(space :align-to 0)
23421 Align to middle of text area minus half the width of variable `my-image'
23422 containing a loaded image:
23423 '(space :align-to (0.5 . (- text my-image)))
23425 Width of left margin minus width of 1 character in the default font:
23426 '(space :width (- left-margin 1))
23428 Width of left margin minus width of 2 characters in the current font:
23429 '(space :width (- left-margin (2 . width)))
23431 Center 1 character over left-margin (in header line):
23432 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23434 Different ways to express width of left fringe plus left margin minus one pixel:
23435 '(space :width (- (+ left-fringe left-margin) (1)))
23436 '(space :width (+ left-fringe left-margin (- (1))))
23437 '(space :width (+ left-fringe left-margin (-1)))
23442 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
23443 struct font
*font
, int width_p
, int *align_to
)
23447 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
23448 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
23451 return OK_PIXELS (0);
23453 eassert (FRAME_LIVE_P (it
->f
));
23455 if (SYMBOLP (prop
))
23457 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
23459 char *unit
= SSDATA (SYMBOL_NAME (prop
));
23461 if (unit
[0] == 'i' && unit
[1] == 'n')
23463 else if (unit
[0] == 'm' && unit
[1] == 'm')
23465 else if (unit
[0] == 'c' && unit
[1] == 'm')
23471 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
23472 : FRAME_RES_Y (it
->f
));
23475 return OK_PIXELS (ppi
/ pixels
);
23480 #ifdef HAVE_WINDOW_SYSTEM
23481 if (EQ (prop
, Qheight
))
23482 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
23483 if (EQ (prop
, Qwidth
))
23484 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
23486 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
23487 return OK_PIXELS (1);
23490 if (EQ (prop
, Qtext
))
23491 return OK_PIXELS (width_p
23492 ? window_box_width (it
->w
, TEXT_AREA
)
23493 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
23495 if (align_to
&& *align_to
< 0)
23498 if (EQ (prop
, Qleft
))
23499 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
23500 if (EQ (prop
, Qright
))
23501 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
23502 if (EQ (prop
, Qcenter
))
23503 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
23504 + window_box_width (it
->w
, TEXT_AREA
) / 2);
23505 if (EQ (prop
, Qleft_fringe
))
23506 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23507 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
23508 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
23509 if (EQ (prop
, Qright_fringe
))
23510 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23511 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23512 : window_box_right_offset (it
->w
, TEXT_AREA
));
23513 if (EQ (prop
, Qleft_margin
))
23514 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
23515 if (EQ (prop
, Qright_margin
))
23516 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
23517 if (EQ (prop
, Qscroll_bar
))
23518 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
23520 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23521 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23522 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23527 if (EQ (prop
, Qleft_fringe
))
23528 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
23529 if (EQ (prop
, Qright_fringe
))
23530 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
23531 if (EQ (prop
, Qleft_margin
))
23532 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
23533 if (EQ (prop
, Qright_margin
))
23534 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
23535 if (EQ (prop
, Qscroll_bar
))
23536 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
23539 prop
= buffer_local_value_1 (prop
, it
->w
->contents
);
23540 if (EQ (prop
, Qunbound
))
23544 if (INTEGERP (prop
) || FLOATP (prop
))
23546 int base_unit
= (width_p
23547 ? FRAME_COLUMN_WIDTH (it
->f
)
23548 : FRAME_LINE_HEIGHT (it
->f
));
23549 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
23554 Lisp_Object car
= XCAR (prop
);
23555 Lisp_Object cdr
= XCDR (prop
);
23559 #ifdef HAVE_WINDOW_SYSTEM
23560 if (FRAME_WINDOW_P (it
->f
)
23561 && valid_image_p (prop
))
23563 ptrdiff_t id
= lookup_image (it
->f
, prop
);
23564 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
23566 return OK_PIXELS (width_p
? img
->width
: img
->height
);
23569 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
23575 while (CONSP (cdr
))
23577 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
23578 font
, width_p
, align_to
))
23581 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
23586 if (EQ (car
, Qminus
))
23588 return OK_PIXELS (pixels
);
23591 car
= buffer_local_value_1 (car
, it
->w
->contents
);
23592 if (EQ (car
, Qunbound
))
23596 if (INTEGERP (car
) || FLOATP (car
))
23599 pixels
= XFLOATINT (car
);
23601 return OK_PIXELS (pixels
);
23602 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
23603 font
, width_p
, align_to
))
23604 return OK_PIXELS (pixels
* fact
);
23615 /***********************************************************************
23617 ***********************************************************************/
23619 #ifdef HAVE_WINDOW_SYSTEM
23624 dump_glyph_string (struct glyph_string
*s
)
23626 fprintf (stderr
, "glyph string\n");
23627 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
23628 s
->x
, s
->y
, s
->width
, s
->height
);
23629 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
23630 fprintf (stderr
, " hl = %d\n", s
->hl
);
23631 fprintf (stderr
, " left overhang = %d, right = %d\n",
23632 s
->left_overhang
, s
->right_overhang
);
23633 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
23634 fprintf (stderr
, " extends to end of line = %d\n",
23635 s
->extends_to_end_of_line_p
);
23636 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
23637 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
23640 #endif /* GLYPH_DEBUG */
23642 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
23643 of XChar2b structures for S; it can't be allocated in
23644 init_glyph_string because it must be allocated via `alloca'. W
23645 is the window on which S is drawn. ROW and AREA are the glyph row
23646 and area within the row from which S is constructed. START is the
23647 index of the first glyph structure covered by S. HL is a
23648 face-override for drawing S. */
23651 #define OPTIONAL_HDC(hdc) HDC hdc,
23652 #define DECLARE_HDC(hdc) HDC hdc;
23653 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
23654 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
23657 #ifndef OPTIONAL_HDC
23658 #define OPTIONAL_HDC(hdc)
23659 #define DECLARE_HDC(hdc)
23660 #define ALLOCATE_HDC(hdc, f)
23661 #define RELEASE_HDC(hdc, f)
23665 init_glyph_string (struct glyph_string
*s
,
23667 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
23668 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
23670 memset (s
, 0, sizeof *s
);
23672 s
->f
= XFRAME (w
->frame
);
23676 s
->display
= FRAME_X_DISPLAY (s
->f
);
23677 s
->window
= FRAME_X_WINDOW (s
->f
);
23678 s
->char2b
= char2b
;
23682 s
->first_glyph
= row
->glyphs
[area
] + start
;
23683 s
->height
= row
->height
;
23684 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
23685 s
->ybase
= s
->y
+ row
->ascent
;
23689 /* Append the list of glyph strings with head H and tail T to the list
23690 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
23693 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23694 struct glyph_string
*h
, struct glyph_string
*t
)
23708 /* Prepend the list of glyph strings with head H and tail T to the
23709 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
23713 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23714 struct glyph_string
*h
, struct glyph_string
*t
)
23728 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
23729 Set *HEAD and *TAIL to the resulting list. */
23732 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
23733 struct glyph_string
*s
)
23735 s
->next
= s
->prev
= NULL
;
23736 append_glyph_string_lists (head
, tail
, s
, s
);
23740 /* Get face and two-byte form of character C in face FACE_ID on frame F.
23741 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
23742 make sure that X resources for the face returned are allocated.
23743 Value is a pointer to a realized face that is ready for display if
23744 DISPLAY_P is non-zero. */
23746 static struct face
*
23747 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
23748 XChar2b
*char2b
, int display_p
)
23750 struct face
*face
= FACE_FROM_ID (f
, face_id
);
23755 code
= face
->font
->driver
->encode_char (face
->font
, c
);
23757 if (code
== FONT_INVALID_CODE
)
23760 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23762 /* Make sure X resources of the face are allocated. */
23763 #ifdef HAVE_X_WINDOWS
23767 eassert (face
!= NULL
);
23768 PREPARE_FACE_FOR_DISPLAY (f
, face
);
23775 /* Get face and two-byte form of character glyph GLYPH on frame F.
23776 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
23777 a pointer to a realized face that is ready for display. */
23779 static struct face
*
23780 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
23781 XChar2b
*char2b
, int *two_byte_p
)
23786 eassert (glyph
->type
== CHAR_GLYPH
);
23787 face
= FACE_FROM_ID (f
, glyph
->face_id
);
23789 /* Make sure X resources of the face are allocated. */
23790 eassert (face
!= NULL
);
23791 PREPARE_FACE_FOR_DISPLAY (f
, face
);
23798 if (CHAR_BYTE8_P (glyph
->u
.ch
))
23799 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
23801 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
23803 if (code
== FONT_INVALID_CODE
)
23807 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23812 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
23813 Return 1 if FONT has a glyph for C, otherwise return 0. */
23816 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
23820 if (CHAR_BYTE8_P (c
))
23821 code
= CHAR_TO_BYTE8 (c
);
23823 code
= font
->driver
->encode_char (font
, c
);
23825 if (code
== FONT_INVALID_CODE
)
23827 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23832 /* Fill glyph string S with composition components specified by S->cmp.
23834 BASE_FACE is the base face of the composition.
23835 S->cmp_from is the index of the first component for S.
23837 OVERLAPS non-zero means S should draw the foreground only, and use
23838 its physical height for clipping. See also draw_glyphs.
23840 Value is the index of a component not in S. */
23843 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
23847 /* For all glyphs of this composition, starting at the offset
23848 S->cmp_from, until we reach the end of the definition or encounter a
23849 glyph that requires the different face, add it to S. */
23854 s
->for_overlaps
= overlaps
;
23857 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
23859 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
23861 /* TAB in a composition means display glyphs with padding space
23862 on the left or right. */
23865 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
23868 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
23875 s
->font
= s
->face
->font
;
23877 else if (s
->face
!= face
)
23885 if (s
->face
== NULL
)
23887 s
->face
= base_face
->ascii_face
;
23888 s
->font
= s
->face
->font
;
23891 /* All glyph strings for the same composition has the same width,
23892 i.e. the width set for the first component of the composition. */
23893 s
->width
= s
->first_glyph
->pixel_width
;
23895 /* If the specified font could not be loaded, use the frame's
23896 default font, but record the fact that we couldn't load it in
23897 the glyph string so that we can draw rectangles for the
23898 characters of the glyph string. */
23899 if (s
->font
== NULL
)
23901 s
->font_not_found_p
= 1;
23902 s
->font
= FRAME_FONT (s
->f
);
23905 /* Adjust base line for subscript/superscript text. */
23906 s
->ybase
+= s
->first_glyph
->voffset
;
23908 /* This glyph string must always be drawn with 16-bit functions. */
23915 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
23916 int start
, int end
, int overlaps
)
23918 struct glyph
*glyph
, *last
;
23919 Lisp_Object lgstring
;
23922 s
->for_overlaps
= overlaps
;
23923 glyph
= s
->row
->glyphs
[s
->area
] + start
;
23924 last
= s
->row
->glyphs
[s
->area
] + end
;
23925 s
->cmp_id
= glyph
->u
.cmp
.id
;
23926 s
->cmp_from
= glyph
->slice
.cmp
.from
;
23927 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
23928 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
23929 lgstring
= composition_gstring_from_id (s
->cmp_id
);
23930 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
23932 while (glyph
< last
23933 && glyph
->u
.cmp
.automatic
23934 && glyph
->u
.cmp
.id
== s
->cmp_id
23935 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
23936 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
23938 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
23940 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
23941 unsigned code
= LGLYPH_CODE (lglyph
);
23943 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
23945 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
23946 return glyph
- s
->row
->glyphs
[s
->area
];
23950 /* Fill glyph string S from a sequence glyphs for glyphless characters.
23951 See the comment of fill_glyph_string for arguments.
23952 Value is the index of the first glyph not in S. */
23956 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
23957 int start
, int end
, int overlaps
)
23959 struct glyph
*glyph
, *last
;
23962 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
23963 s
->for_overlaps
= overlaps
;
23964 glyph
= s
->row
->glyphs
[s
->area
] + start
;
23965 last
= s
->row
->glyphs
[s
->area
] + end
;
23966 voffset
= glyph
->voffset
;
23967 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
23968 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
23970 s
->width
= glyph
->pixel_width
;
23972 while (glyph
< last
23973 && glyph
->type
== GLYPHLESS_GLYPH
23974 && glyph
->voffset
== voffset
23975 && glyph
->face_id
== face_id
)
23978 s
->width
+= glyph
->pixel_width
;
23981 s
->ybase
+= voffset
;
23982 return glyph
- s
->row
->glyphs
[s
->area
];
23986 /* Fill glyph string S from a sequence of character glyphs.
23988 FACE_ID is the face id of the string. START is the index of the
23989 first glyph to consider, END is the index of the last + 1.
23990 OVERLAPS non-zero means S should draw the foreground only, and use
23991 its physical height for clipping. See also draw_glyphs.
23993 Value is the index of the first glyph not in S. */
23996 fill_glyph_string (struct glyph_string
*s
, int face_id
,
23997 int start
, int end
, int overlaps
)
23999 struct glyph
*glyph
, *last
;
24001 int glyph_not_available_p
;
24003 eassert (s
->f
== XFRAME (s
->w
->frame
));
24004 eassert (s
->nchars
== 0);
24005 eassert (start
>= 0 && end
> start
);
24007 s
->for_overlaps
= overlaps
;
24008 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24009 last
= s
->row
->glyphs
[s
->area
] + end
;
24010 voffset
= glyph
->voffset
;
24011 s
->padding_p
= glyph
->padding_p
;
24012 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24014 while (glyph
< last
24015 && glyph
->type
== CHAR_GLYPH
24016 && glyph
->voffset
== voffset
24017 /* Same face id implies same font, nowadays. */
24018 && glyph
->face_id
== face_id
24019 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24023 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24024 s
->char2b
+ s
->nchars
,
24026 s
->two_byte_p
= two_byte_p
;
24028 eassert (s
->nchars
<= end
- start
);
24029 s
->width
+= glyph
->pixel_width
;
24030 if (glyph
++->padding_p
!= s
->padding_p
)
24034 s
->font
= s
->face
->font
;
24036 /* If the specified font could not be loaded, use the frame's font,
24037 but record the fact that we couldn't load it in
24038 S->font_not_found_p so that we can draw rectangles for the
24039 characters of the glyph string. */
24040 if (s
->font
== NULL
|| glyph_not_available_p
)
24042 s
->font_not_found_p
= 1;
24043 s
->font
= FRAME_FONT (s
->f
);
24046 /* Adjust base line for subscript/superscript text. */
24047 s
->ybase
+= voffset
;
24049 eassert (s
->face
&& s
->face
->gc
);
24050 return glyph
- s
->row
->glyphs
[s
->area
];
24054 /* Fill glyph string S from image glyph S->first_glyph. */
24057 fill_image_glyph_string (struct glyph_string
*s
)
24059 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24060 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24062 s
->slice
= s
->first_glyph
->slice
.img
;
24063 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24064 s
->font
= s
->face
->font
;
24065 s
->width
= s
->first_glyph
->pixel_width
;
24067 /* Adjust base line for subscript/superscript text. */
24068 s
->ybase
+= s
->first_glyph
->voffset
;
24072 /* Fill glyph string S from a sequence of stretch glyphs.
24074 START is the index of the first glyph to consider,
24075 END is the index of the last + 1.
24077 Value is the index of the first glyph not in S. */
24080 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24082 struct glyph
*glyph
, *last
;
24083 int voffset
, face_id
;
24085 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24087 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24088 last
= s
->row
->glyphs
[s
->area
] + end
;
24089 face_id
= glyph
->face_id
;
24090 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24091 s
->font
= s
->face
->font
;
24092 s
->width
= glyph
->pixel_width
;
24094 voffset
= glyph
->voffset
;
24098 && glyph
->type
== STRETCH_GLYPH
24099 && glyph
->voffset
== voffset
24100 && glyph
->face_id
== face_id
);
24102 s
->width
+= glyph
->pixel_width
;
24104 /* Adjust base line for subscript/superscript text. */
24105 s
->ybase
+= voffset
;
24107 /* The case that face->gc == 0 is handled when drawing the glyph
24108 string by calling PREPARE_FACE_FOR_DISPLAY. */
24110 return glyph
- s
->row
->glyphs
[s
->area
];
24113 static struct font_metrics
*
24114 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24116 static struct font_metrics metrics
;
24121 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24122 if (code
== FONT_INVALID_CODE
)
24124 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24129 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24130 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24131 assumed to be zero. */
24134 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24136 *left
= *right
= 0;
24138 if (glyph
->type
== CHAR_GLYPH
)
24142 struct font_metrics
*pcm
;
24144 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
24145 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
24147 if (pcm
->rbearing
> pcm
->width
)
24148 *right
= pcm
->rbearing
- pcm
->width
;
24149 if (pcm
->lbearing
< 0)
24150 *left
= -pcm
->lbearing
;
24153 else if (glyph
->type
== COMPOSITE_GLYPH
)
24155 if (! glyph
->u
.cmp
.automatic
)
24157 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24159 if (cmp
->rbearing
> cmp
->pixel_width
)
24160 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24161 if (cmp
->lbearing
< 0)
24162 *left
= - cmp
->lbearing
;
24166 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24167 struct font_metrics metrics
;
24169 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24170 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24171 if (metrics
.rbearing
> metrics
.width
)
24172 *right
= metrics
.rbearing
- metrics
.width
;
24173 if (metrics
.lbearing
< 0)
24174 *left
= - metrics
.lbearing
;
24180 /* Return the index of the first glyph preceding glyph string S that
24181 is overwritten by S because of S's left overhang. Value is -1
24182 if no glyphs are overwritten. */
24185 left_overwritten (struct glyph_string
*s
)
24189 if (s
->left_overhang
)
24192 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24193 int first
= s
->first_glyph
- glyphs
;
24195 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24196 x
-= glyphs
[i
].pixel_width
;
24207 /* Return the index of the first glyph preceding glyph string S that
24208 is overwriting S because of its right overhang. Value is -1 if no
24209 glyph in front of S overwrites S. */
24212 left_overwriting (struct glyph_string
*s
)
24215 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24216 int first
= s
->first_glyph
- glyphs
;
24220 for (i
= first
- 1; i
>= 0; --i
)
24223 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24226 x
-= glyphs
[i
].pixel_width
;
24233 /* Return the index of the last glyph following glyph string S that is
24234 overwritten by S because of S's right overhang. Value is -1 if
24235 no such glyph is found. */
24238 right_overwritten (struct glyph_string
*s
)
24242 if (s
->right_overhang
)
24245 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24246 int first
= (s
->first_glyph
- glyphs
24247 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24248 int end
= s
->row
->used
[s
->area
];
24250 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24251 x
+= glyphs
[i
].pixel_width
;
24260 /* Return the index of the last glyph following glyph string S that
24261 overwrites S because of its left overhang. Value is negative
24262 if no such glyph is found. */
24265 right_overwriting (struct glyph_string
*s
)
24268 int end
= s
->row
->used
[s
->area
];
24269 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24270 int first
= (s
->first_glyph
- glyphs
24271 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24275 for (i
= first
; i
< end
; ++i
)
24278 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24281 x
+= glyphs
[i
].pixel_width
;
24288 /* Set background width of glyph string S. START is the index of the
24289 first glyph following S. LAST_X is the right-most x-position + 1
24290 in the drawing area. */
24293 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24295 /* If the face of this glyph string has to be drawn to the end of
24296 the drawing area, set S->extends_to_end_of_line_p. */
24298 if (start
== s
->row
->used
[s
->area
]
24299 && ((s
->row
->fill_line_p
24300 && (s
->hl
== DRAW_NORMAL_TEXT
24301 || s
->hl
== DRAW_IMAGE_RAISED
24302 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24303 || s
->hl
== DRAW_MOUSE_FACE
))
24304 s
->extends_to_end_of_line_p
= 1;
24306 /* If S extends its face to the end of the line, set its
24307 background_width to the distance to the right edge of the drawing
24309 if (s
->extends_to_end_of_line_p
)
24310 s
->background_width
= last_x
- s
->x
+ 1;
24312 s
->background_width
= s
->width
;
24316 /* Compute overhangs and x-positions for glyph string S and its
24317 predecessors, or successors. X is the starting x-position for S.
24318 BACKWARD_P non-zero means process predecessors. */
24321 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
24327 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24328 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24338 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24339 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24349 /* The following macros are only called from draw_glyphs below.
24350 They reference the following parameters of that function directly:
24351 `w', `row', `area', and `overlap_p'
24352 as well as the following local variables:
24353 `s', `f', and `hdc' (in W32) */
24356 /* On W32, silently add local `hdc' variable to argument list of
24357 init_glyph_string. */
24358 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24359 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24361 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24362 init_glyph_string (s, char2b, w, row, area, start, hl)
24365 /* Add a glyph string for a stretch glyph to the list of strings
24366 between HEAD and TAIL. START is the index of the stretch glyph in
24367 row area AREA of glyph row ROW. END is the index of the last glyph
24368 in that glyph row area. X is the current output position assigned
24369 to the new glyph string constructed. HL overrides that face of the
24370 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24371 is the right-most x-position of the drawing area. */
24373 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24374 and below -- keep them on one line. */
24375 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24378 s = alloca (sizeof *s); \
24379 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24380 START = fill_stretch_glyph_string (s, START, END); \
24381 append_glyph_string (&HEAD, &TAIL, s); \
24387 /* Add a glyph string for an image glyph to the list of strings
24388 between HEAD and TAIL. START is the index of the image glyph in
24389 row area AREA of glyph row ROW. END is the index of the last glyph
24390 in that glyph row area. X is the current output position assigned
24391 to the new glyph string constructed. HL overrides that face of the
24392 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24393 is the right-most x-position of the drawing area. */
24395 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24398 s = alloca (sizeof *s); \
24399 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24400 fill_image_glyph_string (s); \
24401 append_glyph_string (&HEAD, &TAIL, s); \
24408 /* Add a glyph string for a sequence of character glyphs to the list
24409 of strings between HEAD and TAIL. START is the index of the first
24410 glyph in row area AREA of glyph row ROW that is part of the new
24411 glyph string. END is the index of the last glyph in that glyph row
24412 area. X is the current output position assigned to the new glyph
24413 string constructed. HL overrides that face of the glyph; e.g. it
24414 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24415 right-most x-position of the drawing area. */
24417 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24423 face_id = (row)->glyphs[area][START].face_id; \
24425 s = alloca (sizeof *s); \
24426 char2b = alloca ((END - START) * sizeof *char2b); \
24427 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24428 append_glyph_string (&HEAD, &TAIL, s); \
24430 START = fill_glyph_string (s, face_id, START, END, overlaps); \
24435 /* Add a glyph string for a composite sequence to the list of strings
24436 between HEAD and TAIL. START is the index of the first glyph in
24437 row area AREA of glyph row ROW that is part of the new glyph
24438 string. END is the index of the last glyph in that glyph row area.
24439 X is the current output position assigned to the new glyph string
24440 constructed. HL overrides that face of the glyph; e.g. it is
24441 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
24442 x-position of the drawing area. */
24444 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24446 int face_id = (row)->glyphs[area][START].face_id; \
24447 struct face *base_face = FACE_FROM_ID (f, face_id); \
24448 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
24449 struct composition *cmp = composition_table[cmp_id]; \
24451 struct glyph_string *first_s = NULL; \
24454 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
24456 /* Make glyph_strings for each glyph sequence that is drawable by \
24457 the same face, and append them to HEAD/TAIL. */ \
24458 for (n = 0; n < cmp->glyph_len;) \
24460 s = alloca (sizeof *s); \
24461 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24462 append_glyph_string (&(HEAD), &(TAIL), s); \
24468 n = fill_composite_glyph_string (s, base_face, overlaps); \
24476 /* Add a glyph string for a glyph-string sequence to the list of strings
24477 between HEAD and TAIL. */
24479 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24483 Lisp_Object gstring; \
24485 face_id = (row)->glyphs[area][START].face_id; \
24486 gstring = (composition_gstring_from_id \
24487 ((row)->glyphs[area][START].u.cmp.id)); \
24488 s = alloca (sizeof *s); \
24489 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
24490 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24491 append_glyph_string (&(HEAD), &(TAIL), s); \
24493 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
24497 /* Add a glyph string for a sequence of glyphless character's glyphs
24498 to the list of strings between HEAD and TAIL. The meanings of
24499 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
24501 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24506 face_id = (row)->glyphs[area][START].face_id; \
24508 s = alloca (sizeof *s); \
24509 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24510 append_glyph_string (&HEAD, &TAIL, s); \
24512 START = fill_glyphless_glyph_string (s, face_id, START, END, \
24518 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
24519 of AREA of glyph row ROW on window W between indices START and END.
24520 HL overrides the face for drawing glyph strings, e.g. it is
24521 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
24522 x-positions of the drawing area.
24524 This is an ugly monster macro construct because we must use alloca
24525 to allocate glyph strings (because draw_glyphs can be called
24526 asynchronously). */
24528 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24531 HEAD = TAIL = NULL; \
24532 while (START < END) \
24534 struct glyph *first_glyph = (row)->glyphs[area] + START; \
24535 switch (first_glyph->type) \
24538 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
24542 case COMPOSITE_GLYPH: \
24543 if (first_glyph->u.cmp.automatic) \
24544 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
24547 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
24551 case STRETCH_GLYPH: \
24552 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
24556 case IMAGE_GLYPH: \
24557 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
24561 case GLYPHLESS_GLYPH: \
24562 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
24572 set_glyph_string_background_width (s, START, LAST_X); \
24579 /* Draw glyphs between START and END in AREA of ROW on window W,
24580 starting at x-position X. X is relative to AREA in W. HL is a
24581 face-override with the following meaning:
24583 DRAW_NORMAL_TEXT draw normally
24584 DRAW_CURSOR draw in cursor face
24585 DRAW_MOUSE_FACE draw in mouse face.
24586 DRAW_INVERSE_VIDEO draw in mode line face
24587 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
24588 DRAW_IMAGE_RAISED draw an image with a raised relief around it
24590 If OVERLAPS is non-zero, draw only the foreground of characters and
24591 clip to the physical height of ROW. Non-zero value also defines
24592 the overlapping part to be drawn:
24594 OVERLAPS_PRED overlap with preceding rows
24595 OVERLAPS_SUCC overlap with succeeding rows
24596 OVERLAPS_BOTH overlap with both preceding/succeeding rows
24597 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
24599 Value is the x-position reached, relative to AREA of W. */
24602 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
24603 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
24604 enum draw_glyphs_face hl
, int overlaps
)
24606 struct glyph_string
*head
, *tail
;
24607 struct glyph_string
*s
;
24608 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
24609 int i
, j
, x_reached
, last_x
, area_left
= 0;
24610 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24613 ALLOCATE_HDC (hdc
, f
);
24615 /* Let's rather be paranoid than getting a SEGV. */
24616 end
= min (end
, row
->used
[area
]);
24617 start
= clip_to_bounds (0, start
, end
);
24619 /* Translate X to frame coordinates. Set last_x to the right
24620 end of the drawing area. */
24621 if (row
->full_width_p
)
24623 /* X is relative to the left edge of W, without scroll bars
24625 area_left
= WINDOW_LEFT_EDGE_X (w
);
24626 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
24627 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
24631 area_left
= window_box_left (w
, area
);
24632 last_x
= area_left
+ window_box_width (w
, area
);
24636 /* Build a doubly-linked list of glyph_string structures between
24637 head and tail from what we have to draw. Note that the macro
24638 BUILD_GLYPH_STRINGS will modify its start parameter. That's
24639 the reason we use a separate variable `i'. */
24641 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
24643 x_reached
= tail
->x
+ tail
->background_width
;
24647 /* If there are any glyphs with lbearing < 0 or rbearing > width in
24648 the row, redraw some glyphs in front or following the glyph
24649 strings built above. */
24650 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
24652 struct glyph_string
*h
, *t
;
24653 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24654 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
24655 int check_mouse_face
= 0;
24658 /* If mouse highlighting is on, we may need to draw adjacent
24659 glyphs using mouse-face highlighting. */
24660 if (area
== TEXT_AREA
&& row
->mouse_face_p
24661 && hlinfo
->mouse_face_beg_row
>= 0
24662 && hlinfo
->mouse_face_end_row
>= 0)
24664 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
24666 if (row_vpos
>= hlinfo
->mouse_face_beg_row
24667 && row_vpos
<= hlinfo
->mouse_face_end_row
)
24669 check_mouse_face
= 1;
24670 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
24671 ? hlinfo
->mouse_face_beg_col
: 0;
24672 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
24673 ? hlinfo
->mouse_face_end_col
24674 : row
->used
[TEXT_AREA
];
24678 /* Compute overhangs for all glyph strings. */
24679 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
24680 for (s
= head
; s
; s
= s
->next
)
24681 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
24683 /* Prepend glyph strings for glyphs in front of the first glyph
24684 string that are overwritten because of the first glyph
24685 string's left overhang. The background of all strings
24686 prepended must be drawn because the first glyph string
24688 i
= left_overwritten (head
);
24691 enum draw_glyphs_face overlap_hl
;
24693 /* If this row contains mouse highlighting, attempt to draw
24694 the overlapped glyphs with the correct highlight. This
24695 code fails if the overlap encompasses more than one glyph
24696 and mouse-highlight spans only some of these glyphs.
24697 However, making it work perfectly involves a lot more
24698 code, and I don't know if the pathological case occurs in
24699 practice, so we'll stick to this for now. --- cyd */
24700 if (check_mouse_face
24701 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24702 overlap_hl
= DRAW_MOUSE_FACE
;
24704 overlap_hl
= DRAW_NORMAL_TEXT
;
24707 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
24708 overlap_hl
, dummy_x
, last_x
);
24710 compute_overhangs_and_x (t
, head
->x
, 1);
24711 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24715 /* Prepend glyph strings for glyphs in front of the first glyph
24716 string that overwrite that glyph string because of their
24717 right overhang. For these strings, only the foreground must
24718 be drawn, because it draws over the glyph string at `head'.
24719 The background must not be drawn because this would overwrite
24720 right overhangs of preceding glyphs for which no glyph
24722 i
= left_overwriting (head
);
24725 enum draw_glyphs_face overlap_hl
;
24727 if (check_mouse_face
24728 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24729 overlap_hl
= DRAW_MOUSE_FACE
;
24731 overlap_hl
= DRAW_NORMAL_TEXT
;
24734 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
24735 overlap_hl
, dummy_x
, last_x
);
24736 for (s
= h
; s
; s
= s
->next
)
24737 s
->background_filled_p
= 1;
24738 compute_overhangs_and_x (t
, head
->x
, 1);
24739 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24742 /* Append glyphs strings for glyphs following the last glyph
24743 string tail that are overwritten by tail. The background of
24744 these strings has to be drawn because tail's foreground draws
24746 i
= right_overwritten (tail
);
24749 enum draw_glyphs_face overlap_hl
;
24751 if (check_mouse_face
24752 && mouse_beg_col
< i
&& mouse_end_col
> end
)
24753 overlap_hl
= DRAW_MOUSE_FACE
;
24755 overlap_hl
= DRAW_NORMAL_TEXT
;
24757 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
24758 overlap_hl
, x
, last_x
);
24759 /* Because BUILD_GLYPH_STRINGS updates the first argument,
24760 we don't have `end = i;' here. */
24761 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
24762 append_glyph_string_lists (&head
, &tail
, h
, t
);
24766 /* Append glyph strings for glyphs following the last glyph
24767 string tail that overwrite tail. The foreground of such
24768 glyphs has to be drawn because it writes into the background
24769 of tail. The background must not be drawn because it could
24770 paint over the foreground of following glyphs. */
24771 i
= right_overwriting (tail
);
24774 enum draw_glyphs_face overlap_hl
;
24775 if (check_mouse_face
24776 && mouse_beg_col
< i
&& mouse_end_col
> end
)
24777 overlap_hl
= DRAW_MOUSE_FACE
;
24779 overlap_hl
= DRAW_NORMAL_TEXT
;
24782 i
++; /* We must include the Ith glyph. */
24783 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
24784 overlap_hl
, x
, last_x
);
24785 for (s
= h
; s
; s
= s
->next
)
24786 s
->background_filled_p
= 1;
24787 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
24788 append_glyph_string_lists (&head
, &tail
, h
, t
);
24790 if (clip_head
|| clip_tail
)
24791 for (s
= head
; s
; s
= s
->next
)
24793 s
->clip_head
= clip_head
;
24794 s
->clip_tail
= clip_tail
;
24798 /* Draw all strings. */
24799 for (s
= head
; s
; s
= s
->next
)
24800 FRAME_RIF (f
)->draw_glyph_string (s
);
24803 /* When focus a sole frame and move horizontally, this sets on_p to 0
24804 causing a failure to erase prev cursor position. */
24805 if (area
== TEXT_AREA
24806 && !row
->full_width_p
24807 /* When drawing overlapping rows, only the glyph strings'
24808 foreground is drawn, which doesn't erase a cursor
24812 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
24813 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
24814 : (tail
? tail
->x
+ tail
->background_width
: x
));
24818 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
24819 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
24823 /* Value is the x-position up to which drawn, relative to AREA of W.
24824 This doesn't include parts drawn because of overhangs. */
24825 if (row
->full_width_p
)
24826 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
24828 x_reached
-= area_left
;
24830 RELEASE_HDC (hdc
, f
);
24835 /* Expand row matrix if too narrow. Don't expand if area
24838 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
24840 if (!it->f->fonts_changed \
24841 && (it->glyph_row->glyphs[area] \
24842 < it->glyph_row->glyphs[area + 1])) \
24844 it->w->ncols_scale_factor++; \
24845 it->f->fonts_changed = 1; \
24849 /* Store one glyph for IT->char_to_display in IT->glyph_row.
24850 Called from x_produce_glyphs when IT->glyph_row is non-null. */
24853 append_glyph (struct it
*it
)
24855 struct glyph
*glyph
;
24856 enum glyph_row_area area
= it
->area
;
24858 eassert (it
->glyph_row
);
24859 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
24861 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24862 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24864 /* If the glyph row is reversed, we need to prepend the glyph
24865 rather than append it. */
24866 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24870 /* Make room for the additional glyph. */
24871 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24873 glyph
= it
->glyph_row
->glyphs
[area
];
24875 glyph
->charpos
= CHARPOS (it
->position
);
24876 glyph
->object
= it
->object
;
24877 if (it
->pixel_width
> 0)
24879 glyph
->pixel_width
= it
->pixel_width
;
24880 glyph
->padding_p
= 0;
24884 /* Assure at least 1-pixel width. Otherwise, cursor can't
24885 be displayed correctly. */
24886 glyph
->pixel_width
= 1;
24887 glyph
->padding_p
= 1;
24889 glyph
->ascent
= it
->ascent
;
24890 glyph
->descent
= it
->descent
;
24891 glyph
->voffset
= it
->voffset
;
24892 glyph
->type
= CHAR_GLYPH
;
24893 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24894 glyph
->multibyte_p
= it
->multibyte_p
;
24895 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24897 /* In R2L rows, the left and the right box edges need to be
24898 drawn in reverse direction. */
24899 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24900 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24904 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24905 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24907 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24908 || it
->phys_descent
> it
->descent
);
24909 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
24910 glyph
->face_id
= it
->face_id
;
24911 glyph
->u
.ch
= it
->char_to_display
;
24912 glyph
->slice
.img
= null_glyph_slice
;
24913 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24916 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24917 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24919 glyph
->bidi_type
= it
->bidi_it
.type
;
24923 glyph
->resolved_level
= 0;
24924 glyph
->bidi_type
= UNKNOWN_BT
;
24926 ++it
->glyph_row
->used
[area
];
24929 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24932 /* Store one glyph for the composition IT->cmp_it.id in
24933 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
24937 append_composite_glyph (struct it
*it
)
24939 struct glyph
*glyph
;
24940 enum glyph_row_area area
= it
->area
;
24942 eassert (it
->glyph_row
);
24944 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24945 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24947 /* If the glyph row is reversed, we need to prepend the glyph
24948 rather than append it. */
24949 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
24953 /* Make room for the new glyph. */
24954 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
24956 glyph
= it
->glyph_row
->glyphs
[it
->area
];
24958 glyph
->charpos
= it
->cmp_it
.charpos
;
24959 glyph
->object
= it
->object
;
24960 glyph
->pixel_width
= it
->pixel_width
;
24961 glyph
->ascent
= it
->ascent
;
24962 glyph
->descent
= it
->descent
;
24963 glyph
->voffset
= it
->voffset
;
24964 glyph
->type
= COMPOSITE_GLYPH
;
24965 if (it
->cmp_it
.ch
< 0)
24967 glyph
->u
.cmp
.automatic
= 0;
24968 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
24969 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
24973 glyph
->u
.cmp
.automatic
= 1;
24974 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
24975 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
24976 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
24978 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24979 glyph
->multibyte_p
= it
->multibyte_p
;
24980 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24982 /* In R2L rows, the left and the right box edges need to be
24983 drawn in reverse direction. */
24984 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24985 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24989 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24990 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24992 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24993 || it
->phys_descent
> it
->descent
);
24994 glyph
->padding_p
= 0;
24995 glyph
->glyph_not_available_p
= 0;
24996 glyph
->face_id
= it
->face_id
;
24997 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25000 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25001 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25003 glyph
->bidi_type
= it
->bidi_it
.type
;
25005 ++it
->glyph_row
->used
[area
];
25008 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25012 /* Change IT->ascent and IT->height according to the setting of
25016 take_vertical_position_into_account (struct it
*it
)
25020 if (it
->voffset
< 0)
25021 /* Increase the ascent so that we can display the text higher
25023 it
->ascent
-= it
->voffset
;
25025 /* Increase the descent so that we can display the text lower
25027 it
->descent
+= it
->voffset
;
25032 /* Produce glyphs/get display metrics for the image IT is loaded with.
25033 See the description of struct display_iterator in dispextern.h for
25034 an overview of struct display_iterator. */
25037 produce_image_glyph (struct it
*it
)
25041 int glyph_ascent
, crop
;
25042 struct glyph_slice slice
;
25044 eassert (it
->what
== IT_IMAGE
);
25046 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25048 /* Make sure X resources of the face is loaded. */
25049 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
25051 if (it
->image_id
< 0)
25053 /* Fringe bitmap. */
25054 it
->ascent
= it
->phys_ascent
= 0;
25055 it
->descent
= it
->phys_descent
= 0;
25056 it
->pixel_width
= 0;
25061 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25063 /* Make sure X resources of the image is loaded. */
25064 prepare_image_for_display (it
->f
, img
);
25066 slice
.x
= slice
.y
= 0;
25067 slice
.width
= img
->width
;
25068 slice
.height
= img
->height
;
25070 if (INTEGERP (it
->slice
.x
))
25071 slice
.x
= XINT (it
->slice
.x
);
25072 else if (FLOATP (it
->slice
.x
))
25073 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25075 if (INTEGERP (it
->slice
.y
))
25076 slice
.y
= XINT (it
->slice
.y
);
25077 else if (FLOATP (it
->slice
.y
))
25078 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25080 if (INTEGERP (it
->slice
.width
))
25081 slice
.width
= XINT (it
->slice
.width
);
25082 else if (FLOATP (it
->slice
.width
))
25083 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25085 if (INTEGERP (it
->slice
.height
))
25086 slice
.height
= XINT (it
->slice
.height
);
25087 else if (FLOATP (it
->slice
.height
))
25088 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25090 if (slice
.x
>= img
->width
)
25091 slice
.x
= img
->width
;
25092 if (slice
.y
>= img
->height
)
25093 slice
.y
= img
->height
;
25094 if (slice
.x
+ slice
.width
>= img
->width
)
25095 slice
.width
= img
->width
- slice
.x
;
25096 if (slice
.y
+ slice
.height
> img
->height
)
25097 slice
.height
= img
->height
- slice
.y
;
25099 if (slice
.width
== 0 || slice
.height
== 0)
25102 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25104 it
->descent
= slice
.height
- glyph_ascent
;
25106 it
->descent
+= img
->vmargin
;
25107 if (slice
.y
+ slice
.height
== img
->height
)
25108 it
->descent
+= img
->vmargin
;
25109 it
->phys_descent
= it
->descent
;
25111 it
->pixel_width
= slice
.width
;
25113 it
->pixel_width
+= img
->hmargin
;
25114 if (slice
.x
+ slice
.width
== img
->width
)
25115 it
->pixel_width
+= img
->hmargin
;
25117 /* It's quite possible for images to have an ascent greater than
25118 their height, so don't get confused in that case. */
25119 if (it
->descent
< 0)
25124 if (face
->box
!= FACE_NO_BOX
)
25126 if (face
->box_line_width
> 0)
25129 it
->ascent
+= face
->box_line_width
;
25130 if (slice
.y
+ slice
.height
== img
->height
)
25131 it
->descent
+= face
->box_line_width
;
25134 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25135 it
->pixel_width
+= eabs (face
->box_line_width
);
25136 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25137 it
->pixel_width
+= eabs (face
->box_line_width
);
25140 take_vertical_position_into_account (it
);
25142 /* Automatically crop wide image glyphs at right edge so we can
25143 draw the cursor on same display row. */
25144 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25145 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25147 it
->pixel_width
-= crop
;
25148 slice
.width
-= crop
;
25153 struct glyph
*glyph
;
25154 enum glyph_row_area area
= it
->area
;
25156 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25157 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25159 glyph
->charpos
= CHARPOS (it
->position
);
25160 glyph
->object
= it
->object
;
25161 glyph
->pixel_width
= it
->pixel_width
;
25162 glyph
->ascent
= glyph_ascent
;
25163 glyph
->descent
= it
->descent
;
25164 glyph
->voffset
= it
->voffset
;
25165 glyph
->type
= IMAGE_GLYPH
;
25166 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25167 glyph
->multibyte_p
= it
->multibyte_p
;
25168 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25170 /* In R2L rows, the left and the right box edges need to be
25171 drawn in reverse direction. */
25172 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25173 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25177 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25178 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25180 glyph
->overlaps_vertically_p
= 0;
25181 glyph
->padding_p
= 0;
25182 glyph
->glyph_not_available_p
= 0;
25183 glyph
->face_id
= it
->face_id
;
25184 glyph
->u
.img_id
= img
->id
;
25185 glyph
->slice
.img
= slice
;
25186 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25189 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25190 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25192 glyph
->bidi_type
= it
->bidi_it
.type
;
25194 ++it
->glyph_row
->used
[area
];
25197 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25202 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25203 of the glyph, WIDTH and HEIGHT are the width and height of the
25204 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25207 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25208 int width
, int height
, int ascent
)
25210 struct glyph
*glyph
;
25211 enum glyph_row_area area
= it
->area
;
25213 eassert (ascent
>= 0 && ascent
<= height
);
25215 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25216 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25218 /* If the glyph row is reversed, we need to prepend the glyph
25219 rather than append it. */
25220 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25224 /* Make room for the additional glyph. */
25225 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25227 glyph
= it
->glyph_row
->glyphs
[area
];
25229 glyph
->charpos
= CHARPOS (it
->position
);
25230 glyph
->object
= object
;
25231 glyph
->pixel_width
= width
;
25232 glyph
->ascent
= ascent
;
25233 glyph
->descent
= height
- ascent
;
25234 glyph
->voffset
= it
->voffset
;
25235 glyph
->type
= STRETCH_GLYPH
;
25236 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25237 glyph
->multibyte_p
= it
->multibyte_p
;
25238 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25240 /* In R2L rows, the left and the right box edges need to be
25241 drawn in reverse direction. */
25242 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25243 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25247 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25248 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25250 glyph
->overlaps_vertically_p
= 0;
25251 glyph
->padding_p
= 0;
25252 glyph
->glyph_not_available_p
= 0;
25253 glyph
->face_id
= it
->face_id
;
25254 glyph
->u
.stretch
.ascent
= ascent
;
25255 glyph
->u
.stretch
.height
= height
;
25256 glyph
->slice
.img
= null_glyph_slice
;
25257 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25260 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25261 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25263 glyph
->bidi_type
= it
->bidi_it
.type
;
25267 glyph
->resolved_level
= 0;
25268 glyph
->bidi_type
= UNKNOWN_BT
;
25270 ++it
->glyph_row
->used
[area
];
25273 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25276 #endif /* HAVE_WINDOW_SYSTEM */
25278 /* Produce a stretch glyph for iterator IT. IT->object is the value
25279 of the glyph property displayed. The value must be a list
25280 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25283 1. `:width WIDTH' specifies that the space should be WIDTH *
25284 canonical char width wide. WIDTH may be an integer or floating
25287 2. `:relative-width FACTOR' specifies that the width of the stretch
25288 should be computed from the width of the first character having the
25289 `glyph' property, and should be FACTOR times that width.
25291 3. `:align-to HPOS' specifies that the space should be wide enough
25292 to reach HPOS, a value in canonical character units.
25294 Exactly one of the above pairs must be present.
25296 4. `:height HEIGHT' specifies that the height of the stretch produced
25297 should be HEIGHT, measured in canonical character units.
25299 5. `:relative-height FACTOR' specifies that the height of the
25300 stretch should be FACTOR times the height of the characters having
25301 the glyph property.
25303 Either none or exactly one of 4 or 5 must be present.
25305 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25306 of the stretch should be used for the ascent of the stretch.
25307 ASCENT must be in the range 0 <= ASCENT <= 100. */
25310 produce_stretch_glyph (struct it
*it
)
25312 /* (space :width WIDTH :height HEIGHT ...) */
25313 Lisp_Object prop
, plist
;
25314 int width
= 0, height
= 0, align_to
= -1;
25315 int zero_width_ok_p
= 0;
25317 struct font
*font
= NULL
;
25319 #ifdef HAVE_WINDOW_SYSTEM
25321 int zero_height_ok_p
= 0;
25323 if (FRAME_WINDOW_P (it
->f
))
25325 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25326 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25327 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
25331 /* List should start with `space'. */
25332 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
25333 plist
= XCDR (it
->object
);
25335 /* Compute the width of the stretch. */
25336 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
25337 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
25339 /* Absolute width `:width WIDTH' specified and valid. */
25340 zero_width_ok_p
= 1;
25343 #ifdef HAVE_WINDOW_SYSTEM
25344 else if (FRAME_WINDOW_P (it
->f
)
25345 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
25347 /* Relative width `:relative-width FACTOR' specified and valid.
25348 Compute the width of the characters having the `glyph'
25351 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
25354 if (it
->multibyte_p
)
25355 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
25358 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
25359 if (! ASCII_CHAR_P (it2
.c
))
25360 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
25363 it2
.glyph_row
= NULL
;
25364 it2
.what
= IT_CHARACTER
;
25365 x_produce_glyphs (&it2
);
25366 width
= NUMVAL (prop
) * it2
.pixel_width
;
25368 #endif /* HAVE_WINDOW_SYSTEM */
25369 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
25370 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
25372 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
25373 align_to
= (align_to
< 0
25375 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
25376 else if (align_to
< 0)
25377 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
25378 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
25379 zero_width_ok_p
= 1;
25382 /* Nothing specified -> width defaults to canonical char width. */
25383 width
= FRAME_COLUMN_WIDTH (it
->f
);
25385 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
25388 #ifdef HAVE_WINDOW_SYSTEM
25389 /* Compute height. */
25390 if (FRAME_WINDOW_P (it
->f
))
25392 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
25393 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25396 zero_height_ok_p
= 1;
25398 else if (prop
= Fplist_get (plist
, QCrelative_height
),
25400 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
25402 height
= FONT_HEIGHT (font
);
25404 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
25407 /* Compute percentage of height used for ascent. If
25408 `:ascent ASCENT' is present and valid, use that. Otherwise,
25409 derive the ascent from the font in use. */
25410 if (prop
= Fplist_get (plist
, QCascent
),
25411 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
25412 ascent
= height
* NUMVAL (prop
) / 100.0;
25413 else if (!NILP (prop
)
25414 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25415 ascent
= min (max (0, (int)tem
), height
);
25417 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
25420 #endif /* HAVE_WINDOW_SYSTEM */
25423 if (width
> 0 && it
->line_wrap
!= TRUNCATE
25424 && it
->current_x
+ width
> it
->last_visible_x
)
25426 width
= it
->last_visible_x
- it
->current_x
;
25427 #ifdef HAVE_WINDOW_SYSTEM
25428 /* Subtract one more pixel from the stretch width, but only on
25429 GUI frames, since on a TTY each glyph is one "pixel" wide. */
25430 width
-= FRAME_WINDOW_P (it
->f
);
25434 if (width
> 0 && height
> 0 && it
->glyph_row
)
25436 Lisp_Object o_object
= it
->object
;
25437 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
25440 if (!STRINGP (object
))
25441 object
= it
->w
->contents
;
25442 #ifdef HAVE_WINDOW_SYSTEM
25443 if (FRAME_WINDOW_P (it
->f
))
25444 append_stretch_glyph (it
, object
, width
, height
, ascent
);
25448 it
->object
= object
;
25449 it
->char_to_display
= ' ';
25450 it
->pixel_width
= it
->len
= 1;
25452 tty_append_glyph (it
);
25453 it
->object
= o_object
;
25457 it
->pixel_width
= width
;
25458 #ifdef HAVE_WINDOW_SYSTEM
25459 if (FRAME_WINDOW_P (it
->f
))
25461 it
->ascent
= it
->phys_ascent
= ascent
;
25462 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
25463 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
25464 take_vertical_position_into_account (it
);
25468 it
->nglyphs
= width
;
25471 /* Get information about special display element WHAT in an
25472 environment described by IT. WHAT is one of IT_TRUNCATION or
25473 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
25474 non-null glyph_row member. This function ensures that fields like
25475 face_id, c, len of IT are left untouched. */
25478 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
25485 temp_it
.object
= make_number (0);
25486 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
25488 if (what
== IT_CONTINUATION
)
25490 /* Continuation glyph. For R2L lines, we mirror it by hand. */
25491 if (it
->bidi_it
.paragraph_dir
== R2L
)
25492 SET_GLYPH_FROM_CHAR (glyph
, '/');
25494 SET_GLYPH_FROM_CHAR (glyph
, '\\');
25496 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25498 /* FIXME: Should we mirror GC for R2L lines? */
25499 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25500 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25503 else if (what
== IT_TRUNCATION
)
25505 /* Truncation glyph. */
25506 SET_GLYPH_FROM_CHAR (glyph
, '$');
25508 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25510 /* FIXME: Should we mirror GC for R2L lines? */
25511 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25512 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25518 #ifdef HAVE_WINDOW_SYSTEM
25519 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
25520 is turned off, we precede the truncation/continuation glyphs by a
25521 stretch glyph whose width is computed such that these special
25522 glyphs are aligned at the window margin, even when very different
25523 fonts are used in different glyph rows. */
25524 if (FRAME_WINDOW_P (temp_it
.f
)
25525 /* init_iterator calls this with it->glyph_row == NULL, and it
25526 wants only the pixel width of the truncation/continuation
25528 && temp_it
.glyph_row
25529 /* insert_left_trunc_glyphs calls us at the beginning of the
25530 row, and it has its own calculation of the stretch glyph
25532 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
25533 && (temp_it
.glyph_row
->reversed_p
25534 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
25535 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
25537 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
25539 if (stretch_width
> 0)
25541 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
25542 struct font
*font
=
25543 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
25544 int stretch_ascent
=
25545 (((temp_it
.ascent
+ temp_it
.descent
)
25546 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
25548 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
25549 temp_it
.ascent
+ temp_it
.descent
,
25556 temp_it
.what
= IT_CHARACTER
;
25558 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
25559 temp_it
.face_id
= GLYPH_FACE (glyph
);
25560 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
25562 PRODUCE_GLYPHS (&temp_it
);
25563 it
->pixel_width
= temp_it
.pixel_width
;
25564 it
->nglyphs
= temp_it
.pixel_width
;
25567 #ifdef HAVE_WINDOW_SYSTEM
25569 /* Calculate line-height and line-spacing properties.
25570 An integer value specifies explicit pixel value.
25571 A float value specifies relative value to current face height.
25572 A cons (float . face-name) specifies relative value to
25573 height of specified face font.
25575 Returns height in pixels, or nil. */
25579 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
25580 int boff
, int override
)
25582 Lisp_Object face_name
= Qnil
;
25583 int ascent
, descent
, height
;
25585 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
25590 face_name
= XCAR (val
);
25592 if (!NUMBERP (val
))
25593 val
= make_number (1);
25594 if (NILP (face_name
))
25596 height
= it
->ascent
+ it
->descent
;
25601 if (NILP (face_name
))
25603 font
= FRAME_FONT (it
->f
);
25604 boff
= FRAME_BASELINE_OFFSET (it
->f
);
25606 else if (EQ (face_name
, Qt
))
25615 face_id
= lookup_named_face (it
->f
, face_name
, 0);
25617 return make_number (-1);
25619 face
= FACE_FROM_ID (it
->f
, face_id
);
25622 return make_number (-1);
25623 boff
= font
->baseline_offset
;
25624 if (font
->vertical_centering
)
25625 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25628 ascent
= FONT_BASE (font
) + boff
;
25629 descent
= FONT_DESCENT (font
) - boff
;
25633 it
->override_ascent
= ascent
;
25634 it
->override_descent
= descent
;
25635 it
->override_boff
= boff
;
25638 height
= ascent
+ descent
;
25642 height
= (int)(XFLOAT_DATA (val
) * height
);
25643 else if (INTEGERP (val
))
25644 height
*= XINT (val
);
25646 return make_number (height
);
25650 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
25651 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
25652 and only if this is for a character for which no font was found.
25654 If the display method (it->glyphless_method) is
25655 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
25656 length of the acronym or the hexadecimal string, UPPER_XOFF and
25657 UPPER_YOFF are pixel offsets for the upper part of the string,
25658 LOWER_XOFF and LOWER_YOFF are for the lower part.
25660 For the other display methods, LEN through LOWER_YOFF are zero. */
25663 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
25664 short upper_xoff
, short upper_yoff
,
25665 short lower_xoff
, short lower_yoff
)
25667 struct glyph
*glyph
;
25668 enum glyph_row_area area
= it
->area
;
25670 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25671 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25673 /* If the glyph row is reversed, we need to prepend the glyph
25674 rather than append it. */
25675 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25679 /* Make room for the additional glyph. */
25680 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25682 glyph
= it
->glyph_row
->glyphs
[area
];
25684 glyph
->charpos
= CHARPOS (it
->position
);
25685 glyph
->object
= it
->object
;
25686 glyph
->pixel_width
= it
->pixel_width
;
25687 glyph
->ascent
= it
->ascent
;
25688 glyph
->descent
= it
->descent
;
25689 glyph
->voffset
= it
->voffset
;
25690 glyph
->type
= GLYPHLESS_GLYPH
;
25691 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
25692 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
25693 glyph
->u
.glyphless
.len
= len
;
25694 glyph
->u
.glyphless
.ch
= it
->c
;
25695 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
25696 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
25697 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
25698 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
25699 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25700 glyph
->multibyte_p
= it
->multibyte_p
;
25701 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25703 /* In R2L rows, the left and the right box edges need to be
25704 drawn in reverse direction. */
25705 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25706 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25710 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25711 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25713 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25714 || it
->phys_descent
> it
->descent
);
25715 glyph
->padding_p
= 0;
25716 glyph
->glyph_not_available_p
= 0;
25717 glyph
->face_id
= face_id
;
25718 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25721 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25722 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25724 glyph
->bidi_type
= it
->bidi_it
.type
;
25726 ++it
->glyph_row
->used
[area
];
25729 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25733 /* Produce a glyph for a glyphless character for iterator IT.
25734 IT->glyphless_method specifies which method to use for displaying
25735 the character. See the description of enum
25736 glyphless_display_method in dispextern.h for the detail.
25738 FOR_NO_FONT is nonzero if and only if this is for a character for
25739 which no font was found. ACRONYM, if non-nil, is an acronym string
25740 for the character. */
25743 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
25748 int base_width
, base_height
, width
, height
;
25749 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
25752 /* Get the metrics of the base font. We always refer to the current
25754 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
25755 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25756 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
25757 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
25758 base_height
= it
->ascent
+ it
->descent
;
25759 base_width
= font
->average_width
;
25761 face_id
= merge_glyphless_glyph_face (it
);
25763 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
25765 it
->pixel_width
= THIN_SPACE_WIDTH
;
25767 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
25769 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
25771 width
= CHAR_WIDTH (it
->c
);
25774 else if (width
> 4)
25776 it
->pixel_width
= base_width
* width
;
25778 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
25784 unsigned int code
[6];
25786 int ascent
, descent
;
25787 struct font_metrics metrics_upper
, metrics_lower
;
25789 face
= FACE_FROM_ID (it
->f
, face_id
);
25790 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25791 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
25793 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
25795 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
25796 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
25797 if (CONSP (acronym
))
25798 acronym
= XCAR (acronym
);
25799 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
25803 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
25804 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
25807 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
25808 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
25809 upper_len
= (len
+ 1) / 2;
25810 font
->driver
->text_extents (font
, code
, upper_len
,
25812 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
25817 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
25818 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
25819 upper_xoff
= upper_yoff
= 2; /* the typical case */
25820 if (base_width
>= width
)
25822 /* Align the upper to the left, the lower to the right. */
25823 it
->pixel_width
= base_width
;
25824 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
25828 /* Center the shorter one. */
25829 it
->pixel_width
= width
;
25830 if (metrics_upper
.width
>= metrics_lower
.width
)
25831 lower_xoff
= (width
- metrics_lower
.width
) / 2;
25834 /* FIXME: This code doesn't look right. It formerly was
25835 missing the "lower_xoff = 0;", which couldn't have
25836 been right since it left lower_xoff uninitialized. */
25838 upper_xoff
= (width
- metrics_upper
.width
) / 2;
25842 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
25843 top, bottom, and between upper and lower strings. */
25844 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
25845 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
25846 /* Center vertically.
25847 H:base_height, D:base_descent
25848 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
25850 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
25851 descent = D - H/2 + h/2;
25852 lower_yoff = descent - 2 - ld;
25853 upper_yoff = lower_yoff - la - 1 - ud; */
25854 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
25855 descent
= it
->descent
- (base_height
- height
) / 2;
25856 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
25857 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
25858 - metrics_upper
.descent
);
25859 /* Don't make the height shorter than the base height. */
25860 if (height
> base_height
)
25862 it
->ascent
= ascent
;
25863 it
->descent
= descent
;
25867 it
->phys_ascent
= it
->ascent
;
25868 it
->phys_descent
= it
->descent
;
25870 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
25871 upper_xoff
, upper_yoff
,
25872 lower_xoff
, lower_yoff
);
25874 take_vertical_position_into_account (it
);
25879 Produce glyphs/get display metrics for the display element IT is
25880 loaded with. See the description of struct it in dispextern.h
25881 for an overview of struct it. */
25884 x_produce_glyphs (struct it
*it
)
25886 int extra_line_spacing
= it
->extra_line_spacing
;
25888 it
->glyph_not_available_p
= 0;
25890 if (it
->what
== IT_CHARACTER
)
25893 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25894 struct font
*font
= face
->font
;
25895 struct font_metrics
*pcm
= NULL
;
25896 int boff
; /* Baseline offset. */
25900 /* When no suitable font is found, display this character by
25901 the method specified in the first extra slot of
25902 Vglyphless_char_display. */
25903 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
25905 eassert (it
->what
== IT_GLYPHLESS
);
25906 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
25910 boff
= font
->baseline_offset
;
25911 if (font
->vertical_centering
)
25912 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25914 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
25920 if (it
->override_ascent
>= 0)
25922 it
->ascent
= it
->override_ascent
;
25923 it
->descent
= it
->override_descent
;
25924 boff
= it
->override_boff
;
25928 it
->ascent
= FONT_BASE (font
) + boff
;
25929 it
->descent
= FONT_DESCENT (font
) - boff
;
25932 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
25934 pcm
= get_per_char_metric (font
, &char2b
);
25935 if (pcm
->width
== 0
25936 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
25942 it
->phys_ascent
= pcm
->ascent
+ boff
;
25943 it
->phys_descent
= pcm
->descent
- boff
;
25944 it
->pixel_width
= pcm
->width
;
25948 it
->glyph_not_available_p
= 1;
25949 it
->phys_ascent
= it
->ascent
;
25950 it
->phys_descent
= it
->descent
;
25951 it
->pixel_width
= font
->space_width
;
25954 if (it
->constrain_row_ascent_descent_p
)
25956 if (it
->descent
> it
->max_descent
)
25958 it
->ascent
+= it
->descent
- it
->max_descent
;
25959 it
->descent
= it
->max_descent
;
25961 if (it
->ascent
> it
->max_ascent
)
25963 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
25964 it
->ascent
= it
->max_ascent
;
25966 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
25967 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
25968 extra_line_spacing
= 0;
25971 /* If this is a space inside a region of text with
25972 `space-width' property, change its width. */
25973 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
25975 it
->pixel_width
*= XFLOATINT (it
->space_width
);
25977 /* If face has a box, add the box thickness to the character
25978 height. If character has a box line to the left and/or
25979 right, add the box line width to the character's width. */
25980 if (face
->box
!= FACE_NO_BOX
)
25982 int thick
= face
->box_line_width
;
25986 it
->ascent
+= thick
;
25987 it
->descent
+= thick
;
25992 if (it
->start_of_box_run_p
)
25993 it
->pixel_width
+= thick
;
25994 if (it
->end_of_box_run_p
)
25995 it
->pixel_width
+= thick
;
25998 /* If face has an overline, add the height of the overline
25999 (1 pixel) and a 1 pixel margin to the character height. */
26000 if (face
->overline_p
)
26001 it
->ascent
+= overline_margin
;
26003 if (it
->constrain_row_ascent_descent_p
)
26005 if (it
->ascent
> it
->max_ascent
)
26006 it
->ascent
= it
->max_ascent
;
26007 if (it
->descent
> it
->max_descent
)
26008 it
->descent
= it
->max_descent
;
26011 take_vertical_position_into_account (it
);
26013 /* If we have to actually produce glyphs, do it. */
26018 /* Translate a space with a `space-width' property
26019 into a stretch glyph. */
26020 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26021 / FONT_HEIGHT (font
));
26022 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26023 it
->ascent
+ it
->descent
, ascent
);
26028 /* If characters with lbearing or rbearing are displayed
26029 in this line, record that fact in a flag of the
26030 glyph row. This is used to optimize X output code. */
26031 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26032 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26034 if (! stretched_p
&& it
->pixel_width
== 0)
26035 /* We assure that all visible glyphs have at least 1-pixel
26037 it
->pixel_width
= 1;
26039 else if (it
->char_to_display
== '\n')
26041 /* A newline has no width, but we need the height of the
26042 line. But if previous part of the line sets a height,
26043 don't increase that height. */
26045 Lisp_Object height
;
26046 Lisp_Object total_height
= Qnil
;
26048 it
->override_ascent
= -1;
26049 it
->pixel_width
= 0;
26052 height
= get_it_property (it
, Qline_height
);
26053 /* Split (line-height total-height) list. */
26055 && CONSP (XCDR (height
))
26056 && NILP (XCDR (XCDR (height
))))
26058 total_height
= XCAR (XCDR (height
));
26059 height
= XCAR (height
);
26061 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
26063 if (it
->override_ascent
>= 0)
26065 it
->ascent
= it
->override_ascent
;
26066 it
->descent
= it
->override_descent
;
26067 boff
= it
->override_boff
;
26071 it
->ascent
= FONT_BASE (font
) + boff
;
26072 it
->descent
= FONT_DESCENT (font
) - boff
;
26075 if (EQ (height
, Qt
))
26077 if (it
->descent
> it
->max_descent
)
26079 it
->ascent
+= it
->descent
- it
->max_descent
;
26080 it
->descent
= it
->max_descent
;
26082 if (it
->ascent
> it
->max_ascent
)
26084 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26085 it
->ascent
= it
->max_ascent
;
26087 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26088 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26089 it
->constrain_row_ascent_descent_p
= 1;
26090 extra_line_spacing
= 0;
26094 Lisp_Object spacing
;
26096 it
->phys_ascent
= it
->ascent
;
26097 it
->phys_descent
= it
->descent
;
26099 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26100 && face
->box
!= FACE_NO_BOX
26101 && face
->box_line_width
> 0)
26103 it
->ascent
+= face
->box_line_width
;
26104 it
->descent
+= face
->box_line_width
;
26107 && XINT (height
) > it
->ascent
+ it
->descent
)
26108 it
->ascent
= XINT (height
) - it
->descent
;
26110 if (!NILP (total_height
))
26111 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
26114 spacing
= get_it_property (it
, Qline_spacing
);
26115 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
26117 if (INTEGERP (spacing
))
26119 extra_line_spacing
= XINT (spacing
);
26120 if (!NILP (total_height
))
26121 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26125 else /* i.e. (it->char_to_display == '\t') */
26127 if (font
->space_width
> 0)
26129 int tab_width
= it
->tab_width
* font
->space_width
;
26130 int x
= it
->current_x
+ it
->continuation_lines_width
;
26131 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26133 /* If the distance from the current position to the next tab
26134 stop is less than a space character width, use the
26135 tab stop after that. */
26136 if (next_tab_x
- x
< font
->space_width
)
26137 next_tab_x
+= tab_width
;
26139 it
->pixel_width
= next_tab_x
- x
;
26141 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
26142 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
26146 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26147 it
->ascent
+ it
->descent
, it
->ascent
);
26152 it
->pixel_width
= 0;
26157 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26159 /* A static composition.
26161 Note: A composition is represented as one glyph in the
26162 glyph matrix. There are no padding glyphs.
26164 Important note: pixel_width, ascent, and descent are the
26165 values of what is drawn by draw_glyphs (i.e. the values of
26166 the overall glyphs composed). */
26167 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26168 int boff
; /* baseline offset */
26169 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26170 int glyph_len
= cmp
->glyph_len
;
26171 struct font
*font
= face
->font
;
26175 /* If we have not yet calculated pixel size data of glyphs of
26176 the composition for the current face font, calculate them
26177 now. Theoretically, we have to check all fonts for the
26178 glyphs, but that requires much time and memory space. So,
26179 here we check only the font of the first glyph. This may
26180 lead to incorrect display, but it's very rare, and C-l
26181 (recenter-top-bottom) can correct the display anyway. */
26182 if (! cmp
->font
|| cmp
->font
!= font
)
26184 /* Ascent and descent of the font of the first character
26185 of this composition (adjusted by baseline offset).
26186 Ascent and descent of overall glyphs should not be less
26187 than these, respectively. */
26188 int font_ascent
, font_descent
, font_height
;
26189 /* Bounding box of the overall glyphs. */
26190 int leftmost
, rightmost
, lowest
, highest
;
26191 int lbearing
, rbearing
;
26192 int i
, width
, ascent
, descent
;
26193 int left_padded
= 0, right_padded
= 0;
26194 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26196 struct font_metrics
*pcm
;
26197 int font_not_found_p
;
26200 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26201 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26203 if (glyph_len
< cmp
->glyph_len
)
26205 for (i
= 0; i
< glyph_len
; i
++)
26207 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26209 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26214 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26215 : IT_CHARPOS (*it
));
26216 /* If no suitable font is found, use the default font. */
26217 font_not_found_p
= font
== NULL
;
26218 if (font_not_found_p
)
26220 face
= face
->ascii_face
;
26223 boff
= font
->baseline_offset
;
26224 if (font
->vertical_centering
)
26225 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26226 font_ascent
= FONT_BASE (font
) + boff
;
26227 font_descent
= FONT_DESCENT (font
) - boff
;
26228 font_height
= FONT_HEIGHT (font
);
26233 if (! font_not_found_p
)
26235 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26237 pcm
= get_per_char_metric (font
, &char2b
);
26240 /* Initialize the bounding box. */
26243 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26244 ascent
= pcm
->ascent
;
26245 descent
= pcm
->descent
;
26246 lbearing
= pcm
->lbearing
;
26247 rbearing
= pcm
->rbearing
;
26251 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26252 ascent
= FONT_BASE (font
);
26253 descent
= FONT_DESCENT (font
);
26260 lowest
= - descent
+ boff
;
26261 highest
= ascent
+ boff
;
26263 if (! font_not_found_p
26264 && font
->default_ascent
26265 && CHAR_TABLE_P (Vuse_default_ascent
)
26266 && !NILP (Faref (Vuse_default_ascent
,
26267 make_number (it
->char_to_display
))))
26268 highest
= font
->default_ascent
+ boff
;
26270 /* Draw the first glyph at the normal position. It may be
26271 shifted to right later if some other glyphs are drawn
26273 cmp
->offsets
[i
* 2] = 0;
26274 cmp
->offsets
[i
* 2 + 1] = boff
;
26275 cmp
->lbearing
= lbearing
;
26276 cmp
->rbearing
= rbearing
;
26278 /* Set cmp->offsets for the remaining glyphs. */
26279 for (i
++; i
< glyph_len
; i
++)
26281 int left
, right
, btm
, top
;
26282 int ch
= COMPOSITION_GLYPH (cmp
, i
);
26284 struct face
*this_face
;
26288 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
26289 this_face
= FACE_FROM_ID (it
->f
, face_id
);
26290 font
= this_face
->font
;
26296 get_char_face_and_encoding (it
->f
, ch
, face_id
,
26298 pcm
= get_per_char_metric (font
, &char2b
);
26301 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26304 width
= pcm
->width
;
26305 ascent
= pcm
->ascent
;
26306 descent
= pcm
->descent
;
26307 lbearing
= pcm
->lbearing
;
26308 rbearing
= pcm
->rbearing
;
26309 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
26311 /* Relative composition with or without
26312 alternate chars. */
26313 left
= (leftmost
+ rightmost
- width
) / 2;
26314 btm
= - descent
+ boff
;
26315 if (font
->relative_compose
26316 && (! CHAR_TABLE_P (Vignore_relative_composition
)
26317 || NILP (Faref (Vignore_relative_composition
,
26318 make_number (ch
)))))
26321 if (- descent
>= font
->relative_compose
)
26322 /* One extra pixel between two glyphs. */
26324 else if (ascent
<= 0)
26325 /* One extra pixel between two glyphs. */
26326 btm
= lowest
- 1 - ascent
- descent
;
26331 /* A composition rule is specified by an integer
26332 value that encodes global and new reference
26333 points (GREF and NREF). GREF and NREF are
26334 specified by numbers as below:
26336 0---1---2 -- ascent
26340 9--10--11 -- center
26342 ---3---4---5--- baseline
26344 6---7---8 -- descent
26346 int rule
= COMPOSITION_RULE (cmp
, i
);
26347 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
26349 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
26350 grefx
= gref
% 3, nrefx
= nref
% 3;
26351 grefy
= gref
/ 3, nrefy
= nref
/ 3;
26353 xoff
= font_height
* (xoff
- 128) / 256;
26355 yoff
= font_height
* (yoff
- 128) / 256;
26358 + grefx
* (rightmost
- leftmost
) / 2
26359 - nrefx
* width
/ 2
26362 btm
= ((grefy
== 0 ? highest
26364 : grefy
== 2 ? lowest
26365 : (highest
+ lowest
) / 2)
26366 - (nrefy
== 0 ? ascent
+ descent
26367 : nrefy
== 1 ? descent
- boff
26369 : (ascent
+ descent
) / 2)
26373 cmp
->offsets
[i
* 2] = left
;
26374 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
26376 /* Update the bounding box of the overall glyphs. */
26379 right
= left
+ width
;
26380 if (left
< leftmost
)
26382 if (right
> rightmost
)
26385 top
= btm
+ descent
+ ascent
;
26391 if (cmp
->lbearing
> left
+ lbearing
)
26392 cmp
->lbearing
= left
+ lbearing
;
26393 if (cmp
->rbearing
< left
+ rbearing
)
26394 cmp
->rbearing
= left
+ rbearing
;
26398 /* If there are glyphs whose x-offsets are negative,
26399 shift all glyphs to the right and make all x-offsets
26403 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26404 cmp
->offsets
[i
* 2] -= leftmost
;
26405 rightmost
-= leftmost
;
26406 cmp
->lbearing
-= leftmost
;
26407 cmp
->rbearing
-= leftmost
;
26410 if (left_padded
&& cmp
->lbearing
< 0)
26412 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26413 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
26414 rightmost
-= cmp
->lbearing
;
26415 cmp
->rbearing
-= cmp
->lbearing
;
26418 if (right_padded
&& rightmost
< cmp
->rbearing
)
26420 rightmost
= cmp
->rbearing
;
26423 cmp
->pixel_width
= rightmost
;
26424 cmp
->ascent
= highest
;
26425 cmp
->descent
= - lowest
;
26426 if (cmp
->ascent
< font_ascent
)
26427 cmp
->ascent
= font_ascent
;
26428 if (cmp
->descent
< font_descent
)
26429 cmp
->descent
= font_descent
;
26433 && (cmp
->lbearing
< 0
26434 || cmp
->rbearing
> cmp
->pixel_width
))
26435 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26437 it
->pixel_width
= cmp
->pixel_width
;
26438 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
26439 it
->descent
= it
->phys_descent
= cmp
->descent
;
26440 if (face
->box
!= FACE_NO_BOX
)
26442 int thick
= face
->box_line_width
;
26446 it
->ascent
+= thick
;
26447 it
->descent
+= thick
;
26452 if (it
->start_of_box_run_p
)
26453 it
->pixel_width
+= thick
;
26454 if (it
->end_of_box_run_p
)
26455 it
->pixel_width
+= thick
;
26458 /* If face has an overline, add the height of the overline
26459 (1 pixel) and a 1 pixel margin to the character height. */
26460 if (face
->overline_p
)
26461 it
->ascent
+= overline_margin
;
26463 take_vertical_position_into_account (it
);
26464 if (it
->ascent
< 0)
26466 if (it
->descent
< 0)
26469 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
26470 append_composite_glyph (it
);
26472 else if (it
->what
== IT_COMPOSITION
)
26474 /* A dynamic (automatic) composition. */
26475 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26476 Lisp_Object gstring
;
26477 struct font_metrics metrics
;
26481 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
26483 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
26486 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
26487 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26488 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
26489 it
->descent
= it
->phys_descent
= metrics
.descent
;
26490 if (face
->box
!= FACE_NO_BOX
)
26492 int thick
= face
->box_line_width
;
26496 it
->ascent
+= thick
;
26497 it
->descent
+= thick
;
26502 if (it
->start_of_box_run_p
)
26503 it
->pixel_width
+= thick
;
26504 if (it
->end_of_box_run_p
)
26505 it
->pixel_width
+= thick
;
26507 /* If face has an overline, add the height of the overline
26508 (1 pixel) and a 1 pixel margin to the character height. */
26509 if (face
->overline_p
)
26510 it
->ascent
+= overline_margin
;
26511 take_vertical_position_into_account (it
);
26512 if (it
->ascent
< 0)
26514 if (it
->descent
< 0)
26518 append_composite_glyph (it
);
26520 else if (it
->what
== IT_GLYPHLESS
)
26521 produce_glyphless_glyph (it
, 0, Qnil
);
26522 else if (it
->what
== IT_IMAGE
)
26523 produce_image_glyph (it
);
26524 else if (it
->what
== IT_STRETCH
)
26525 produce_stretch_glyph (it
);
26528 /* Accumulate dimensions. Note: can't assume that it->descent > 0
26529 because this isn't true for images with `:ascent 100'. */
26530 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
26531 if (it
->area
== TEXT_AREA
)
26532 it
->current_x
+= it
->pixel_width
;
26534 if (extra_line_spacing
> 0)
26536 it
->descent
+= extra_line_spacing
;
26537 if (extra_line_spacing
> it
->max_extra_line_spacing
)
26538 it
->max_extra_line_spacing
= extra_line_spacing
;
26541 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
26542 it
->max_descent
= max (it
->max_descent
, it
->descent
);
26543 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
26544 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
26548 Output LEN glyphs starting at START at the nominal cursor position.
26549 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
26550 being updated, and UPDATED_AREA is the area of that row being updated. */
26553 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26554 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26556 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
26558 eassert (updated_row
);
26559 /* When the window is hscrolled, cursor hpos can legitimately be out
26560 of bounds, but we draw the cursor at the corresponding window
26561 margin in that case. */
26562 if (!updated_row
->reversed_p
&& chpos
< 0)
26564 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
26565 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
26569 /* Write glyphs. */
26571 hpos
= start
- updated_row
->glyphs
[updated_area
];
26572 x
= draw_glyphs (w
, w
->output_cursor
.x
,
26573 updated_row
, updated_area
,
26575 DRAW_NORMAL_TEXT
, 0);
26577 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
26578 if (updated_area
== TEXT_AREA
26579 && w
->phys_cursor_on_p
26580 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
26582 && chpos
< hpos
+ len
)
26583 w
->phys_cursor_on_p
= 0;
26587 /* Advance the output cursor. */
26588 w
->output_cursor
.hpos
+= len
;
26589 w
->output_cursor
.x
= x
;
26594 Insert LEN glyphs from START at the nominal cursor position. */
26597 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26598 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26601 int line_height
, shift_by_width
, shifted_region_width
;
26602 struct glyph_row
*row
;
26603 struct glyph
*glyph
;
26604 int frame_x
, frame_y
;
26607 eassert (updated_row
);
26609 f
= XFRAME (WINDOW_FRAME (w
));
26611 /* Get the height of the line we are in. */
26613 line_height
= row
->height
;
26615 /* Get the width of the glyphs to insert. */
26616 shift_by_width
= 0;
26617 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
26618 shift_by_width
+= glyph
->pixel_width
;
26620 /* Get the width of the region to shift right. */
26621 shifted_region_width
= (window_box_width (w
, updated_area
)
26622 - w
->output_cursor
.x
26626 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
26627 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
26629 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
26630 line_height
, shift_by_width
);
26632 /* Write the glyphs. */
26633 hpos
= start
- row
->glyphs
[updated_area
];
26634 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
26636 DRAW_NORMAL_TEXT
, 0);
26638 /* Advance the output cursor. */
26639 w
->output_cursor
.hpos
+= len
;
26640 w
->output_cursor
.x
+= shift_by_width
;
26646 Erase the current text line from the nominal cursor position
26647 (inclusive) to pixel column TO_X (exclusive). The idea is that
26648 everything from TO_X onward is already erased.
26650 TO_X is a pixel position relative to UPDATED_AREA of currently
26651 updated window W. TO_X == -1 means clear to the end of this area. */
26654 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
26655 enum glyph_row_area updated_area
, int to_x
)
26658 int max_x
, min_y
, max_y
;
26659 int from_x
, from_y
, to_y
;
26661 eassert (updated_row
);
26662 f
= XFRAME (w
->frame
);
26664 if (updated_row
->full_width_p
)
26665 max_x
= (WINDOW_PIXEL_WIDTH (w
)
26666 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
26668 max_x
= window_box_width (w
, updated_area
);
26669 max_y
= window_text_bottom_y (w
);
26671 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
26672 of window. For TO_X > 0, truncate to end of drawing area. */
26678 to_x
= min (to_x
, max_x
);
26680 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
26682 /* Notice if the cursor will be cleared by this operation. */
26683 if (!updated_row
->full_width_p
)
26684 notice_overwritten_cursor (w
, updated_area
,
26685 w
->output_cursor
.x
, -1,
26687 MATRIX_ROW_BOTTOM_Y (updated_row
));
26689 from_x
= w
->output_cursor
.x
;
26691 /* Translate to frame coordinates. */
26692 if (updated_row
->full_width_p
)
26694 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
26695 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
26699 int area_left
= window_box_left (w
, updated_area
);
26700 from_x
+= area_left
;
26704 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
26705 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
26706 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
26708 /* Prevent inadvertently clearing to end of the X window. */
26709 if (to_x
> from_x
&& to_y
> from_y
)
26712 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
26713 to_x
- from_x
, to_y
- from_y
);
26718 #endif /* HAVE_WINDOW_SYSTEM */
26722 /***********************************************************************
26724 ***********************************************************************/
26726 /* Value is the internal representation of the specified cursor type
26727 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
26728 of the bar cursor. */
26730 static enum text_cursor_kinds
26731 get_specified_cursor_type (Lisp_Object arg
, int *width
)
26733 enum text_cursor_kinds type
;
26738 if (EQ (arg
, Qbox
))
26739 return FILLED_BOX_CURSOR
;
26741 if (EQ (arg
, Qhollow
))
26742 return HOLLOW_BOX_CURSOR
;
26744 if (EQ (arg
, Qbar
))
26751 && EQ (XCAR (arg
), Qbar
)
26752 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
26754 *width
= XINT (XCDR (arg
));
26758 if (EQ (arg
, Qhbar
))
26761 return HBAR_CURSOR
;
26765 && EQ (XCAR (arg
), Qhbar
)
26766 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
26768 *width
= XINT (XCDR (arg
));
26769 return HBAR_CURSOR
;
26772 /* Treat anything unknown as "hollow box cursor".
26773 It was bad to signal an error; people have trouble fixing
26774 .Xdefaults with Emacs, when it has something bad in it. */
26775 type
= HOLLOW_BOX_CURSOR
;
26780 /* Set the default cursor types for specified frame. */
26782 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
26787 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
26788 FRAME_CURSOR_WIDTH (f
) = width
;
26790 /* By default, set up the blink-off state depending on the on-state. */
26792 tem
= Fassoc (arg
, Vblink_cursor_alist
);
26795 FRAME_BLINK_OFF_CURSOR (f
)
26796 = get_specified_cursor_type (XCDR (tem
), &width
);
26797 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
26800 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
26802 /* Make sure the cursor gets redrawn. */
26803 f
->cursor_type_changed
= 1;
26807 #ifdef HAVE_WINDOW_SYSTEM
26809 /* Return the cursor we want to be displayed in window W. Return
26810 width of bar/hbar cursor through WIDTH arg. Return with
26811 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
26812 (i.e. if the `system caret' should track this cursor).
26814 In a mini-buffer window, we want the cursor only to appear if we
26815 are reading input from this window. For the selected window, we
26816 want the cursor type given by the frame parameter or buffer local
26817 setting of cursor-type. If explicitly marked off, draw no cursor.
26818 In all other cases, we want a hollow box cursor. */
26820 static enum text_cursor_kinds
26821 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
26822 int *active_cursor
)
26824 struct frame
*f
= XFRAME (w
->frame
);
26825 struct buffer
*b
= XBUFFER (w
->contents
);
26826 int cursor_type
= DEFAULT_CURSOR
;
26827 Lisp_Object alt_cursor
;
26828 int non_selected
= 0;
26830 *active_cursor
= 1;
26833 if (cursor_in_echo_area
26834 && FRAME_HAS_MINIBUF_P (f
)
26835 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
26837 if (w
== XWINDOW (echo_area_window
))
26839 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
26841 *width
= FRAME_CURSOR_WIDTH (f
);
26842 return FRAME_DESIRED_CURSOR (f
);
26845 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
26848 *active_cursor
= 0;
26852 /* Detect a nonselected window or nonselected frame. */
26853 else if (w
!= XWINDOW (f
->selected_window
)
26854 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
26856 *active_cursor
= 0;
26858 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
26864 /* Never display a cursor in a window in which cursor-type is nil. */
26865 if (NILP (BVAR (b
, cursor_type
)))
26868 /* Get the normal cursor type for this window. */
26869 if (EQ (BVAR (b
, cursor_type
), Qt
))
26871 cursor_type
= FRAME_DESIRED_CURSOR (f
);
26872 *width
= FRAME_CURSOR_WIDTH (f
);
26875 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
26877 /* Use cursor-in-non-selected-windows instead
26878 for non-selected window or frame. */
26881 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
26882 if (!EQ (Qt
, alt_cursor
))
26883 return get_specified_cursor_type (alt_cursor
, width
);
26884 /* t means modify the normal cursor type. */
26885 if (cursor_type
== FILLED_BOX_CURSOR
)
26886 cursor_type
= HOLLOW_BOX_CURSOR
;
26887 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
26889 return cursor_type
;
26892 /* Use normal cursor if not blinked off. */
26893 if (!w
->cursor_off_p
)
26895 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26897 if (cursor_type
== FILLED_BOX_CURSOR
)
26899 /* Using a block cursor on large images can be very annoying.
26900 So use a hollow cursor for "large" images.
26901 If image is not transparent (no mask), also use hollow cursor. */
26902 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26903 if (img
!= NULL
&& IMAGEP (img
->spec
))
26905 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
26906 where N = size of default frame font size.
26907 This should cover most of the "tiny" icons people may use. */
26909 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
26910 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
26911 cursor_type
= HOLLOW_BOX_CURSOR
;
26914 else if (cursor_type
!= NO_CURSOR
)
26916 /* Display current only supports BOX and HOLLOW cursors for images.
26917 So for now, unconditionally use a HOLLOW cursor when cursor is
26918 not a solid box cursor. */
26919 cursor_type
= HOLLOW_BOX_CURSOR
;
26922 return cursor_type
;
26925 /* Cursor is blinked off, so determine how to "toggle" it. */
26927 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
26928 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
26929 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
26931 /* Then see if frame has specified a specific blink off cursor type. */
26932 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
26934 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
26935 return FRAME_BLINK_OFF_CURSOR (f
);
26939 /* Some people liked having a permanently visible blinking cursor,
26940 while others had very strong opinions against it. So it was
26941 decided to remove it. KFS 2003-09-03 */
26943 /* Finally perform built-in cursor blinking:
26944 filled box <-> hollow box
26945 wide [h]bar <-> narrow [h]bar
26946 narrow [h]bar <-> no cursor
26947 other type <-> no cursor */
26949 if (cursor_type
== FILLED_BOX_CURSOR
)
26950 return HOLLOW_BOX_CURSOR
;
26952 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
26955 return cursor_type
;
26963 /* Notice when the text cursor of window W has been completely
26964 overwritten by a drawing operation that outputs glyphs in AREA
26965 starting at X0 and ending at X1 in the line starting at Y0 and
26966 ending at Y1. X coordinates are area-relative. X1 < 0 means all
26967 the rest of the line after X0 has been written. Y coordinates
26968 are window-relative. */
26971 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
26972 int x0
, int x1
, int y0
, int y1
)
26974 int cx0
, cx1
, cy0
, cy1
;
26975 struct glyph_row
*row
;
26977 if (!w
->phys_cursor_on_p
)
26979 if (area
!= TEXT_AREA
)
26982 if (w
->phys_cursor
.vpos
< 0
26983 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
26984 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
26985 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
26988 if (row
->cursor_in_fringe_p
)
26990 row
->cursor_in_fringe_p
= 0;
26991 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
26992 w
->phys_cursor_on_p
= 0;
26996 cx0
= w
->phys_cursor
.x
;
26997 cx1
= cx0
+ w
->phys_cursor_width
;
26998 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27001 /* The cursor image will be completely removed from the
27002 screen if the output area intersects the cursor area in
27003 y-direction. When we draw in [y0 y1[, and some part of
27004 the cursor is at y < y0, that part must have been drawn
27005 before. When scrolling, the cursor is erased before
27006 actually scrolling, so we don't come here. When not
27007 scrolling, the rows above the old cursor row must have
27008 changed, and in this case these rows must have written
27009 over the cursor image.
27011 Likewise if part of the cursor is below y1, with the
27012 exception of the cursor being in the first blank row at
27013 the buffer and window end because update_text_area
27014 doesn't draw that row. (Except when it does, but
27015 that's handled in update_text_area.) */
27017 cy0
= w
->phys_cursor
.y
;
27018 cy1
= cy0
+ w
->phys_cursor_height
;
27019 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27022 w
->phys_cursor_on_p
= 0;
27025 #endif /* HAVE_WINDOW_SYSTEM */
27028 /************************************************************************
27030 ************************************************************************/
27032 #ifdef HAVE_WINDOW_SYSTEM
27035 Fix the display of area AREA of overlapping row ROW in window W
27036 with respect to the overlapping part OVERLAPS. */
27039 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27040 enum glyph_row_area area
, int overlaps
)
27047 for (i
= 0; i
< row
->used
[area
];)
27049 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27051 int start
= i
, start_x
= x
;
27055 x
+= row
->glyphs
[area
][i
].pixel_width
;
27058 while (i
< row
->used
[area
]
27059 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27061 draw_glyphs (w
, start_x
, row
, area
,
27063 DRAW_NORMAL_TEXT
, overlaps
);
27067 x
+= row
->glyphs
[area
][i
].pixel_width
;
27077 Draw the cursor glyph of window W in glyph row ROW. See the
27078 comment of draw_glyphs for the meaning of HL. */
27081 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27082 enum draw_glyphs_face hl
)
27084 /* If cursor hpos is out of bounds, don't draw garbage. This can
27085 happen in mini-buffer windows when switching between echo area
27086 glyphs and mini-buffer. */
27087 if ((row
->reversed_p
27088 ? (w
->phys_cursor
.hpos
>= 0)
27089 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27091 int on_p
= w
->phys_cursor_on_p
;
27093 int hpos
= w
->phys_cursor
.hpos
;
27095 /* When the window is hscrolled, cursor hpos can legitimately be
27096 out of bounds, but we draw the cursor at the corresponding
27097 window margin in that case. */
27098 if (!row
->reversed_p
&& hpos
< 0)
27100 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27101 hpos
= row
->used
[TEXT_AREA
] - 1;
27103 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27105 w
->phys_cursor_on_p
= on_p
;
27107 if (hl
== DRAW_CURSOR
)
27108 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27109 /* When we erase the cursor, and ROW is overlapped by other
27110 rows, make sure that these overlapping parts of other rows
27112 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27114 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27116 if (row
> w
->current_matrix
->rows
27117 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27118 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27119 OVERLAPS_ERASED_CURSOR
);
27121 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27122 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27123 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27124 OVERLAPS_ERASED_CURSOR
);
27130 /* Erase the image of a cursor of window W from the screen. */
27136 erase_phys_cursor (struct window
*w
)
27138 struct frame
*f
= XFRAME (w
->frame
);
27139 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27140 int hpos
= w
->phys_cursor
.hpos
;
27141 int vpos
= w
->phys_cursor
.vpos
;
27142 int mouse_face_here_p
= 0;
27143 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27144 struct glyph_row
*cursor_row
;
27145 struct glyph
*cursor_glyph
;
27146 enum draw_glyphs_face hl
;
27148 /* No cursor displayed or row invalidated => nothing to do on the
27150 if (w
->phys_cursor_type
== NO_CURSOR
)
27151 goto mark_cursor_off
;
27153 /* VPOS >= active_glyphs->nrows means that window has been resized.
27154 Don't bother to erase the cursor. */
27155 if (vpos
>= active_glyphs
->nrows
)
27156 goto mark_cursor_off
;
27158 /* If row containing cursor is marked invalid, there is nothing we
27160 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27161 if (!cursor_row
->enabled_p
)
27162 goto mark_cursor_off
;
27164 /* If line spacing is > 0, old cursor may only be partially visible in
27165 window after split-window. So adjust visible height. */
27166 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27167 window_text_bottom_y (w
) - cursor_row
->y
);
27169 /* If row is completely invisible, don't attempt to delete a cursor which
27170 isn't there. This can happen if cursor is at top of a window, and
27171 we switch to a buffer with a header line in that window. */
27172 if (cursor_row
->visible_height
<= 0)
27173 goto mark_cursor_off
;
27175 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27176 if (cursor_row
->cursor_in_fringe_p
)
27178 cursor_row
->cursor_in_fringe_p
= 0;
27179 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27180 goto mark_cursor_off
;
27183 /* This can happen when the new row is shorter than the old one.
27184 In this case, either draw_glyphs or clear_end_of_line
27185 should have cleared the cursor. Note that we wouldn't be
27186 able to erase the cursor in this case because we don't have a
27187 cursor glyph at hand. */
27188 if ((cursor_row
->reversed_p
27189 ? (w
->phys_cursor
.hpos
< 0)
27190 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27191 goto mark_cursor_off
;
27193 /* When the window is hscrolled, cursor hpos can legitimately be out
27194 of bounds, but we draw the cursor at the corresponding window
27195 margin in that case. */
27196 if (!cursor_row
->reversed_p
&& hpos
< 0)
27198 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27199 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27201 /* If the cursor is in the mouse face area, redisplay that when
27202 we clear the cursor. */
27203 if (! NILP (hlinfo
->mouse_face_window
)
27204 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27205 /* Don't redraw the cursor's spot in mouse face if it is at the
27206 end of a line (on a newline). The cursor appears there, but
27207 mouse highlighting does not. */
27208 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27209 mouse_face_here_p
= 1;
27211 /* Maybe clear the display under the cursor. */
27212 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27215 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27218 cursor_glyph
= get_phys_cursor_glyph (w
);
27219 if (cursor_glyph
== NULL
)
27220 goto mark_cursor_off
;
27222 width
= cursor_glyph
->pixel_width
;
27223 left_x
= window_box_left_offset (w
, TEXT_AREA
);
27224 x
= w
->phys_cursor
.x
;
27226 width
-= left_x
- x
;
27227 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27228 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27229 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
27232 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27235 /* Erase the cursor by redrawing the character underneath it. */
27236 if (mouse_face_here_p
)
27237 hl
= DRAW_MOUSE_FACE
;
27239 hl
= DRAW_NORMAL_TEXT
;
27240 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27243 w
->phys_cursor_on_p
= 0;
27244 w
->phys_cursor_type
= NO_CURSOR
;
27249 Display or clear cursor of window W. If ON is zero, clear the
27250 cursor. If it is non-zero, display the cursor. If ON is nonzero,
27251 where to put the cursor is specified by HPOS, VPOS, X and Y. */
27254 display_and_set_cursor (struct window
*w
, bool on
,
27255 int hpos
, int vpos
, int x
, int y
)
27257 struct frame
*f
= XFRAME (w
->frame
);
27258 int new_cursor_type
;
27259 int new_cursor_width
;
27261 struct glyph_row
*glyph_row
;
27262 struct glyph
*glyph
;
27264 /* This is pointless on invisible frames, and dangerous on garbaged
27265 windows and frames; in the latter case, the frame or window may
27266 be in the midst of changing its size, and x and y may be off the
27268 if (! FRAME_VISIBLE_P (f
)
27269 || FRAME_GARBAGED_P (f
)
27270 || vpos
>= w
->current_matrix
->nrows
27271 || hpos
>= w
->current_matrix
->matrix_w
)
27274 /* If cursor is off and we want it off, return quickly. */
27275 if (!on
&& !w
->phys_cursor_on_p
)
27278 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27279 /* If cursor row is not enabled, we don't really know where to
27280 display the cursor. */
27281 if (!glyph_row
->enabled_p
)
27283 w
->phys_cursor_on_p
= 0;
27288 if (!glyph_row
->exact_window_width_line_p
27289 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
27290 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
27292 eassert (input_blocked_p ());
27294 /* Set new_cursor_type to the cursor we want to be displayed. */
27295 new_cursor_type
= get_window_cursor_type (w
, glyph
,
27296 &new_cursor_width
, &active_cursor
);
27298 /* If cursor is currently being shown and we don't want it to be or
27299 it is in the wrong place, or the cursor type is not what we want,
27301 if (w
->phys_cursor_on_p
27303 || w
->phys_cursor
.x
!= x
27304 || w
->phys_cursor
.y
!= y
27305 || new_cursor_type
!= w
->phys_cursor_type
27306 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
27307 && new_cursor_width
!= w
->phys_cursor_width
)))
27308 erase_phys_cursor (w
);
27310 /* Don't check phys_cursor_on_p here because that flag is only set
27311 to zero in some cases where we know that the cursor has been
27312 completely erased, to avoid the extra work of erasing the cursor
27313 twice. In other words, phys_cursor_on_p can be 1 and the cursor
27314 still not be visible, or it has only been partly erased. */
27317 w
->phys_cursor_ascent
= glyph_row
->ascent
;
27318 w
->phys_cursor_height
= glyph_row
->height
;
27320 /* Set phys_cursor_.* before x_draw_.* is called because some
27321 of them may need the information. */
27322 w
->phys_cursor
.x
= x
;
27323 w
->phys_cursor
.y
= glyph_row
->y
;
27324 w
->phys_cursor
.hpos
= hpos
;
27325 w
->phys_cursor
.vpos
= vpos
;
27328 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
27329 new_cursor_type
, new_cursor_width
,
27330 on
, active_cursor
);
27334 /* Switch the display of W's cursor on or off, according to the value
27338 update_window_cursor (struct window
*w
, bool on
)
27340 /* Don't update cursor in windows whose frame is in the process
27341 of being deleted. */
27342 if (w
->current_matrix
)
27344 int hpos
= w
->phys_cursor
.hpos
;
27345 int vpos
= w
->phys_cursor
.vpos
;
27346 struct glyph_row
*row
;
27348 if (vpos
>= w
->current_matrix
->nrows
27349 || hpos
>= w
->current_matrix
->matrix_w
)
27352 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27354 /* When the window is hscrolled, cursor hpos can legitimately be
27355 out of bounds, but we draw the cursor at the corresponding
27356 window margin in that case. */
27357 if (!row
->reversed_p
&& hpos
< 0)
27359 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27360 hpos
= row
->used
[TEXT_AREA
] - 1;
27363 display_and_set_cursor (w
, on
, hpos
, vpos
,
27364 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27370 /* Call update_window_cursor with parameter ON_P on all leaf windows
27371 in the window tree rooted at W. */
27374 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
27378 if (WINDOWP (w
->contents
))
27379 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
27381 update_window_cursor (w
, on_p
);
27383 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
27389 Display the cursor on window W, or clear it, according to ON_P.
27390 Don't change the cursor's position. */
27393 x_update_cursor (struct frame
*f
, bool on_p
)
27395 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
27400 Clear the cursor of window W to background color, and mark the
27401 cursor as not shown. This is used when the text where the cursor
27402 is about to be rewritten. */
27405 x_clear_cursor (struct window
*w
)
27407 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
27408 update_window_cursor (w
, 0);
27411 #endif /* HAVE_WINDOW_SYSTEM */
27413 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
27416 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
27417 int start_hpos
, int end_hpos
,
27418 enum draw_glyphs_face draw
)
27420 #ifdef HAVE_WINDOW_SYSTEM
27421 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
27423 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
27427 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
27428 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
27432 /* Display the active region described by mouse_face_* according to DRAW. */
27435 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
27437 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
27438 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27440 if (/* If window is in the process of being destroyed, don't bother
27442 w
->current_matrix
!= NULL
27443 /* Don't update mouse highlight if hidden. */
27444 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
27445 /* Recognize when we are called to operate on rows that don't exist
27446 anymore. This can happen when a window is split. */
27447 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
27449 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
27450 struct glyph_row
*row
, *first
, *last
;
27452 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
27453 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
27455 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
27457 int start_hpos
, end_hpos
, start_x
;
27459 /* For all but the first row, the highlight starts at column 0. */
27462 /* R2L rows have BEG and END in reversed order, but the
27463 screen drawing geometry is always left to right. So
27464 we need to mirror the beginning and end of the
27465 highlighted area in R2L rows. */
27466 if (!row
->reversed_p
)
27468 start_hpos
= hlinfo
->mouse_face_beg_col
;
27469 start_x
= hlinfo
->mouse_face_beg_x
;
27471 else if (row
== last
)
27473 start_hpos
= hlinfo
->mouse_face_end_col
;
27474 start_x
= hlinfo
->mouse_face_end_x
;
27482 else if (row
->reversed_p
&& row
== last
)
27484 start_hpos
= hlinfo
->mouse_face_end_col
;
27485 start_x
= hlinfo
->mouse_face_end_x
;
27495 if (!row
->reversed_p
)
27496 end_hpos
= hlinfo
->mouse_face_end_col
;
27497 else if (row
== first
)
27498 end_hpos
= hlinfo
->mouse_face_beg_col
;
27501 end_hpos
= row
->used
[TEXT_AREA
];
27502 if (draw
== DRAW_NORMAL_TEXT
)
27503 row
->fill_line_p
= 1; /* Clear to end of line */
27506 else if (row
->reversed_p
&& row
== first
)
27507 end_hpos
= hlinfo
->mouse_face_beg_col
;
27510 end_hpos
= row
->used
[TEXT_AREA
];
27511 if (draw
== DRAW_NORMAL_TEXT
)
27512 row
->fill_line_p
= 1; /* Clear to end of line */
27515 if (end_hpos
> start_hpos
)
27517 draw_row_with_mouse_face (w
, start_x
, row
,
27518 start_hpos
, end_hpos
, draw
);
27521 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
27525 #ifdef HAVE_WINDOW_SYSTEM
27526 /* When we've written over the cursor, arrange for it to
27527 be displayed again. */
27528 if (FRAME_WINDOW_P (f
)
27529 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
27531 int hpos
= w
->phys_cursor
.hpos
;
27533 /* When the window is hscrolled, cursor hpos can legitimately be
27534 out of bounds, but we draw the cursor at the corresponding
27535 window margin in that case. */
27536 if (!row
->reversed_p
&& hpos
< 0)
27538 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27539 hpos
= row
->used
[TEXT_AREA
] - 1;
27542 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
27543 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27546 #endif /* HAVE_WINDOW_SYSTEM */
27549 #ifdef HAVE_WINDOW_SYSTEM
27550 /* Change the mouse cursor. */
27551 if (FRAME_WINDOW_P (f
))
27553 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
27554 if (draw
== DRAW_NORMAL_TEXT
27555 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
27556 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
27559 if (draw
== DRAW_MOUSE_FACE
)
27560 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
27562 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
27564 #endif /* HAVE_WINDOW_SYSTEM */
27568 Clear out the mouse-highlighted active region.
27569 Redraw it un-highlighted first. Value is non-zero if mouse
27570 face was actually drawn unhighlighted. */
27573 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
27577 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
27579 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
27583 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27584 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27585 hlinfo
->mouse_face_window
= Qnil
;
27586 hlinfo
->mouse_face_overlay
= Qnil
;
27590 /* Return true if the coordinates HPOS and VPOS on windows W are
27591 within the mouse face on that window. */
27593 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
27595 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27597 /* Quickly resolve the easy cases. */
27598 if (!(WINDOWP (hlinfo
->mouse_face_window
)
27599 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
27601 if (vpos
< hlinfo
->mouse_face_beg_row
27602 || vpos
> hlinfo
->mouse_face_end_row
)
27604 if (vpos
> hlinfo
->mouse_face_beg_row
27605 && vpos
< hlinfo
->mouse_face_end_row
)
27608 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
27610 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27612 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
27615 else if ((vpos
== hlinfo
->mouse_face_beg_row
27616 && hpos
>= hlinfo
->mouse_face_beg_col
)
27617 || (vpos
== hlinfo
->mouse_face_end_row
27618 && hpos
< hlinfo
->mouse_face_end_col
))
27623 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27625 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_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
))
27639 True if physical cursor of window W is within mouse face. */
27642 cursor_in_mouse_face_p (struct window
*w
)
27644 int hpos
= w
->phys_cursor
.hpos
;
27645 int vpos
= w
->phys_cursor
.vpos
;
27646 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27648 /* When the window is hscrolled, cursor hpos can legitimately be out
27649 of bounds, but we draw the cursor at the corresponding window
27650 margin in that case. */
27651 if (!row
->reversed_p
&& hpos
< 0)
27653 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27654 hpos
= row
->used
[TEXT_AREA
] - 1;
27656 return coords_in_mouse_face_p (w
, hpos
, vpos
);
27661 /* Find the glyph rows START_ROW and END_ROW of window W that display
27662 characters between buffer positions START_CHARPOS and END_CHARPOS
27663 (excluding END_CHARPOS). DISP_STRING is a display string that
27664 covers these buffer positions. This is similar to
27665 row_containing_pos, but is more accurate when bidi reordering makes
27666 buffer positions change non-linearly with glyph rows. */
27668 rows_from_pos_range (struct window
*w
,
27669 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
27670 Lisp_Object disp_string
,
27671 struct glyph_row
**start
, struct glyph_row
**end
)
27673 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27674 int last_y
= window_text_bottom_y (w
);
27675 struct glyph_row
*row
;
27680 while (!first
->enabled_p
27681 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
27684 /* Find the START row. */
27686 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
27689 /* A row can potentially be the START row if the range of the
27690 characters it displays intersects the range
27691 [START_CHARPOS..END_CHARPOS). */
27692 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
27693 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
27694 /* See the commentary in row_containing_pos, for the
27695 explanation of the complicated way to check whether
27696 some position is beyond the end of the characters
27697 displayed by a row. */
27698 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27699 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27700 && !row
->ends_at_zv_p
27701 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
27702 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27703 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27704 && !row
->ends_at_zv_p
27705 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
27707 /* Found a candidate row. Now make sure at least one of the
27708 glyphs it displays has a charpos from the range
27709 [START_CHARPOS..END_CHARPOS).
27711 This is not obvious because bidi reordering could make
27712 buffer positions of a row be 1,2,3,102,101,100, and if we
27713 want to highlight characters in [50..60), we don't want
27714 this row, even though [50..60) does intersect [1..103),
27715 the range of character positions given by the row's start
27716 and end positions. */
27717 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
27718 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
27722 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
27723 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
27724 /* A glyph that comes from DISP_STRING is by
27725 definition to be highlighted. */
27726 || EQ (g
->object
, disp_string
))
27735 /* Find the END row. */
27737 /* If the last row is partially visible, start looking for END
27738 from that row, instead of starting from FIRST. */
27739 && !(row
->enabled_p
27740 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
27742 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
27744 struct glyph_row
*next
= row
+ 1;
27745 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
27747 if (!next
->enabled_p
27748 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
27749 /* The first row >= START whose range of displayed characters
27750 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
27751 is the row END + 1. */
27752 || (start_charpos
< next_start
27753 && end_charpos
< next_start
)
27754 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
27755 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
27756 && !next
->ends_at_zv_p
27757 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
27758 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
27759 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
27760 && !next
->ends_at_zv_p
27761 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
27768 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
27769 but none of the characters it displays are in the range, it is
27771 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
27772 struct glyph
*s
= g
;
27773 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
27777 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
27778 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
27779 /* If the buffer position of the first glyph in
27780 the row is equal to END_CHARPOS, it means
27781 the last character to be highlighted is the
27782 newline of ROW, and we must consider NEXT as
27784 || (((!next
->reversed_p
&& g
== s
)
27785 || (next
->reversed_p
&& g
== e
- 1))
27786 && (g
->charpos
== end_charpos
27787 /* Special case for when NEXT is an
27788 empty line at ZV. */
27789 || (g
->charpos
== -1
27790 && !row
->ends_at_zv_p
27791 && next_start
== end_charpos
)))))
27792 /* A glyph that comes from DISP_STRING is by
27793 definition to be highlighted. */
27794 || EQ (g
->object
, disp_string
))
27803 /* The first row that ends at ZV must be the last to be
27805 else if (next
->ends_at_zv_p
)
27814 /* This function sets the mouse_face_* elements of HLINFO, assuming
27815 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
27816 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
27817 for the overlay or run of text properties specifying the mouse
27818 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
27819 before-string and after-string that must also be highlighted.
27820 DISP_STRING, if non-nil, is a display string that may cover some
27821 or all of the highlighted text. */
27824 mouse_face_from_buffer_pos (Lisp_Object window
,
27825 Mouse_HLInfo
*hlinfo
,
27826 ptrdiff_t mouse_charpos
,
27827 ptrdiff_t start_charpos
,
27828 ptrdiff_t end_charpos
,
27829 Lisp_Object before_string
,
27830 Lisp_Object after_string
,
27831 Lisp_Object disp_string
)
27833 struct window
*w
= XWINDOW (window
);
27834 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27835 struct glyph_row
*r1
, *r2
;
27836 struct glyph
*glyph
, *end
;
27837 ptrdiff_t ignore
, pos
;
27840 eassert (NILP (disp_string
) || STRINGP (disp_string
));
27841 eassert (NILP (before_string
) || STRINGP (before_string
));
27842 eassert (NILP (after_string
) || STRINGP (after_string
));
27844 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
27845 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
27847 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
27848 /* If the before-string or display-string contains newlines,
27849 rows_from_pos_range skips to its last row. Move back. */
27850 if (!NILP (before_string
) || !NILP (disp_string
))
27852 struct glyph_row
*prev
;
27853 while ((prev
= r1
- 1, prev
>= first
)
27854 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
27855 && prev
->used
[TEXT_AREA
] > 0)
27857 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
27858 glyph
= beg
+ prev
->used
[TEXT_AREA
];
27859 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
27861 || !(EQ (glyph
->object
, before_string
)
27862 || EQ (glyph
->object
, disp_string
)))
27869 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
27870 hlinfo
->mouse_face_past_end
= 1;
27872 else if (!NILP (after_string
))
27874 /* If the after-string has newlines, advance to its last row. */
27875 struct glyph_row
*next
;
27876 struct glyph_row
*last
27877 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
27879 for (next
= r2
+ 1;
27881 && next
->used
[TEXT_AREA
] > 0
27882 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
27886 /* The rest of the display engine assumes that mouse_face_beg_row is
27887 either above mouse_face_end_row or identical to it. But with
27888 bidi-reordered continued lines, the row for START_CHARPOS could
27889 be below the row for END_CHARPOS. If so, swap the rows and store
27890 them in correct order. */
27893 struct glyph_row
*tem
= r2
;
27899 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
27900 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
27902 /* For a bidi-reordered row, the positions of BEFORE_STRING,
27903 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
27904 could be anywhere in the row and in any order. The strategy
27905 below is to find the leftmost and the rightmost glyph that
27906 belongs to either of these 3 strings, or whose position is
27907 between START_CHARPOS and END_CHARPOS, and highlight all the
27908 glyphs between those two. This may cover more than just the text
27909 between START_CHARPOS and END_CHARPOS if the range of characters
27910 strides the bidi level boundary, e.g. if the beginning is in R2L
27911 text while the end is in L2R text or vice versa. */
27912 if (!r1
->reversed_p
)
27914 /* This row is in a left to right paragraph. Scan it left to
27916 glyph
= r1
->glyphs
[TEXT_AREA
];
27917 end
= glyph
+ r1
->used
[TEXT_AREA
];
27920 /* Skip truncation glyphs at the start of the glyph row. */
27921 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
27923 && INTEGERP (glyph
->object
)
27924 && glyph
->charpos
< 0;
27926 x
+= glyph
->pixel_width
;
27928 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
27929 or DISP_STRING, and the first glyph from buffer whose
27930 position is between START_CHARPOS and END_CHARPOS. */
27932 && !INTEGERP (glyph
->object
)
27933 && !EQ (glyph
->object
, disp_string
)
27934 && !(BUFFERP (glyph
->object
)
27935 && (glyph
->charpos
>= start_charpos
27936 && glyph
->charpos
< end_charpos
));
27939 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27940 are present at buffer positions between START_CHARPOS and
27941 END_CHARPOS, or if they come from an overlay. */
27942 if (EQ (glyph
->object
, before_string
))
27944 pos
= string_buffer_position (before_string
,
27946 /* If pos == 0, it means before_string came from an
27947 overlay, not from a buffer position. */
27948 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27951 else if (EQ (glyph
->object
, after_string
))
27953 pos
= string_buffer_position (after_string
, end_charpos
);
27954 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27957 x
+= glyph
->pixel_width
;
27959 hlinfo
->mouse_face_beg_x
= x
;
27960 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
27964 /* This row is in a right to left paragraph. Scan it right to
27968 end
= r1
->glyphs
[TEXT_AREA
] - 1;
27969 glyph
= end
+ r1
->used
[TEXT_AREA
];
27971 /* Skip truncation glyphs at the start of the glyph row. */
27972 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
27974 && INTEGERP (glyph
->object
)
27975 && glyph
->charpos
< 0;
27979 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
27980 or DISP_STRING, and the first glyph from buffer whose
27981 position is between START_CHARPOS and END_CHARPOS. */
27983 && !INTEGERP (glyph
->object
)
27984 && !EQ (glyph
->object
, disp_string
)
27985 && !(BUFFERP (glyph
->object
)
27986 && (glyph
->charpos
>= start_charpos
27987 && glyph
->charpos
< end_charpos
));
27990 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27991 are present at buffer positions between START_CHARPOS and
27992 END_CHARPOS, or if they come from an overlay. */
27993 if (EQ (glyph
->object
, before_string
))
27995 pos
= string_buffer_position (before_string
, start_charpos
);
27996 /* If pos == 0, it means before_string came from an
27997 overlay, not from a buffer position. */
27998 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28001 else if (EQ (glyph
->object
, after_string
))
28003 pos
= string_buffer_position (after_string
, end_charpos
);
28004 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28009 glyph
++; /* first glyph to the right of the highlighted area */
28010 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28011 x
+= g
->pixel_width
;
28012 hlinfo
->mouse_face_beg_x
= x
;
28013 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28016 /* If the highlight ends in a different row, compute GLYPH and END
28017 for the end row. Otherwise, reuse the values computed above for
28018 the row where the highlight begins. */
28021 if (!r2
->reversed_p
)
28023 glyph
= r2
->glyphs
[TEXT_AREA
];
28024 end
= glyph
+ r2
->used
[TEXT_AREA
];
28029 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28030 glyph
= end
+ r2
->used
[TEXT_AREA
];
28034 if (!r2
->reversed_p
)
28036 /* Skip truncation and continuation glyphs near the end of the
28037 row, and also blanks and stretch glyphs inserted by
28038 extend_face_to_end_of_line. */
28040 && INTEGERP ((end
- 1)->object
))
28042 /* Scan the rest of the glyph row from the end, looking for the
28043 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28044 DISP_STRING, or whose position is between START_CHARPOS
28048 && !INTEGERP (end
->object
)
28049 && !EQ (end
->object
, disp_string
)
28050 && !(BUFFERP (end
->object
)
28051 && (end
->charpos
>= start_charpos
28052 && end
->charpos
< end_charpos
));
28055 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28056 are present at buffer positions between START_CHARPOS and
28057 END_CHARPOS, or if they come from an overlay. */
28058 if (EQ (end
->object
, before_string
))
28060 pos
= string_buffer_position (before_string
, start_charpos
);
28061 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28064 else if (EQ (end
->object
, after_string
))
28066 pos
= string_buffer_position (after_string
, end_charpos
);
28067 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28071 /* Find the X coordinate of the last glyph to be highlighted. */
28072 for (; glyph
<= end
; ++glyph
)
28073 x
+= glyph
->pixel_width
;
28075 hlinfo
->mouse_face_end_x
= x
;
28076 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28080 /* Skip truncation and continuation glyphs near the end of the
28081 row, and also blanks and stretch glyphs inserted by
28082 extend_face_to_end_of_line. */
28086 && INTEGERP (end
->object
))
28088 x
+= end
->pixel_width
;
28091 /* Scan the rest of the glyph row from the end, looking for the
28092 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28093 DISP_STRING, or whose position is between START_CHARPOS
28097 && !INTEGERP (end
->object
)
28098 && !EQ (end
->object
, disp_string
)
28099 && !(BUFFERP (end
->object
)
28100 && (end
->charpos
>= start_charpos
28101 && end
->charpos
< end_charpos
));
28104 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28105 are present at buffer positions between START_CHARPOS and
28106 END_CHARPOS, or if they come from an overlay. */
28107 if (EQ (end
->object
, before_string
))
28109 pos
= string_buffer_position (before_string
, start_charpos
);
28110 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28113 else if (EQ (end
->object
, after_string
))
28115 pos
= string_buffer_position (after_string
, end_charpos
);
28116 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28119 x
+= end
->pixel_width
;
28121 /* If we exited the above loop because we arrived at the last
28122 glyph of the row, and its buffer position is still not in
28123 range, it means the last character in range is the preceding
28124 newline. Bump the end column and x values to get past the
28127 && BUFFERP (end
->object
)
28128 && (end
->charpos
< start_charpos
28129 || end
->charpos
>= end_charpos
))
28131 x
+= end
->pixel_width
;
28134 hlinfo
->mouse_face_end_x
= x
;
28135 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28138 hlinfo
->mouse_face_window
= window
;
28139 hlinfo
->mouse_face_face_id
28140 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28142 !hlinfo
->mouse_face_hidden
, -1);
28143 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28146 /* The following function is not used anymore (replaced with
28147 mouse_face_from_string_pos), but I leave it here for the time
28148 being, in case someone would. */
28150 #if 0 /* not used */
28152 /* Find the position of the glyph for position POS in OBJECT in
28153 window W's current matrix, and return in *X, *Y the pixel
28154 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28156 RIGHT_P non-zero means return the position of the right edge of the
28157 glyph, RIGHT_P zero means return the left edge position.
28159 If no glyph for POS exists in the matrix, return the position of
28160 the glyph with the next smaller position that is in the matrix, if
28161 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
28162 exists in the matrix, return the position of the glyph with the
28163 next larger position in OBJECT.
28165 Value is non-zero if a glyph was found. */
28168 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28169 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
28171 int yb
= window_text_bottom_y (w
);
28172 struct glyph_row
*r
;
28173 struct glyph
*best_glyph
= NULL
;
28174 struct glyph_row
*best_row
= NULL
;
28177 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28178 r
->enabled_p
&& r
->y
< yb
;
28181 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28182 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28185 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28186 if (EQ (g
->object
, object
))
28188 if (g
->charpos
== pos
)
28195 else if (best_glyph
== NULL
28196 || ((eabs (g
->charpos
- pos
)
28197 < eabs (best_glyph
->charpos
- pos
))
28200 : g
->charpos
> pos
)))
28214 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28218 *x
+= best_glyph
->pixel_width
;
28223 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28226 return best_glyph
!= NULL
;
28228 #endif /* not used */
28230 /* Find the positions of the first and the last glyphs in window W's
28231 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28232 (assumed to be a string), and return in HLINFO's mouse_face_*
28233 members the pixel and column/row coordinates of those glyphs. */
28236 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28237 Lisp_Object object
,
28238 ptrdiff_t startpos
, ptrdiff_t endpos
)
28240 int yb
= window_text_bottom_y (w
);
28241 struct glyph_row
*r
;
28242 struct glyph
*g
, *e
;
28246 /* Find the glyph row with at least one position in the range
28247 [STARTPOS..ENDPOS), and the first glyph in that row whose
28248 position belongs to that range. */
28249 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28250 r
->enabled_p
&& r
->y
< yb
;
28253 if (!r
->reversed_p
)
28255 g
= r
->glyphs
[TEXT_AREA
];
28256 e
= g
+ r
->used
[TEXT_AREA
];
28257 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28258 if (EQ (g
->object
, object
)
28259 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28261 hlinfo
->mouse_face_beg_row
28262 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28263 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28264 hlinfo
->mouse_face_beg_x
= gx
;
28273 e
= r
->glyphs
[TEXT_AREA
];
28274 g
= e
+ r
->used
[TEXT_AREA
];
28275 for ( ; g
> e
; --g
)
28276 if (EQ ((g
-1)->object
, object
)
28277 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
28279 hlinfo
->mouse_face_beg_row
28280 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28281 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28282 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
28283 gx
+= g1
->pixel_width
;
28284 hlinfo
->mouse_face_beg_x
= gx
;
28296 /* Starting with the next row, look for the first row which does NOT
28297 include any glyphs whose positions are in the range. */
28298 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
28300 g
= r
->glyphs
[TEXT_AREA
];
28301 e
= g
+ r
->used
[TEXT_AREA
];
28303 for ( ; g
< e
; ++g
)
28304 if (EQ (g
->object
, object
)
28305 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28314 /* The highlighted region ends on the previous row. */
28317 /* Set the end row. */
28318 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28320 /* Compute and set the end column and the end column's horizontal
28321 pixel coordinate. */
28322 if (!r
->reversed_p
)
28324 g
= r
->glyphs
[TEXT_AREA
];
28325 e
= g
+ r
->used
[TEXT_AREA
];
28326 for ( ; e
> g
; --e
)
28327 if (EQ ((e
-1)->object
, object
)
28328 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
28330 hlinfo
->mouse_face_end_col
= e
- g
;
28332 for (gx
= r
->x
; g
< e
; ++g
)
28333 gx
+= g
->pixel_width
;
28334 hlinfo
->mouse_face_end_x
= gx
;
28338 e
= r
->glyphs
[TEXT_AREA
];
28339 g
= e
+ r
->used
[TEXT_AREA
];
28340 for (gx
= r
->x
; e
< g
; ++e
)
28342 if (EQ (e
->object
, object
)
28343 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
28345 gx
+= e
->pixel_width
;
28347 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
28348 hlinfo
->mouse_face_end_x
= gx
;
28352 #ifdef HAVE_WINDOW_SYSTEM
28354 /* See if position X, Y is within a hot-spot of an image. */
28357 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
28359 if (!CONSP (hot_spot
))
28362 if (EQ (XCAR (hot_spot
), Qrect
))
28364 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
28365 Lisp_Object rect
= XCDR (hot_spot
);
28369 if (!CONSP (XCAR (rect
)))
28371 if (!CONSP (XCDR (rect
)))
28373 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
28375 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
28377 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
28379 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
28383 else if (EQ (XCAR (hot_spot
), Qcircle
))
28385 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
28386 Lisp_Object circ
= XCDR (hot_spot
);
28387 Lisp_Object lr
, lx0
, ly0
;
28389 && CONSP (XCAR (circ
))
28390 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
28391 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
28392 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
28394 double r
= XFLOATINT (lr
);
28395 double dx
= XINT (lx0
) - x
;
28396 double dy
= XINT (ly0
) - y
;
28397 return (dx
* dx
+ dy
* dy
<= r
* r
);
28400 else if (EQ (XCAR (hot_spot
), Qpoly
))
28402 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
28403 if (VECTORP (XCDR (hot_spot
)))
28405 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
28406 Lisp_Object
*poly
= v
->contents
;
28407 ptrdiff_t n
= v
->header
.size
;
28410 Lisp_Object lx
, ly
;
28413 /* Need an even number of coordinates, and at least 3 edges. */
28414 if (n
< 6 || n
& 1)
28417 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
28418 If count is odd, we are inside polygon. Pixels on edges
28419 may or may not be included depending on actual geometry of the
28421 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
28422 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
28424 x0
= XINT (lx
), y0
= XINT (ly
);
28425 for (i
= 0; i
< n
; i
+= 2)
28427 int x1
= x0
, y1
= y0
;
28428 if ((lx
= poly
[i
], !INTEGERP (lx
))
28429 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
28431 x0
= XINT (lx
), y0
= XINT (ly
);
28433 /* Does this segment cross the X line? */
28441 if (y
> y0
&& y
> y1
)
28443 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
28453 find_hot_spot (Lisp_Object map
, int x
, int y
)
28455 while (CONSP (map
))
28457 if (CONSP (XCAR (map
))
28458 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
28466 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
28468 doc
: /* Lookup in image map MAP coordinates X and Y.
28469 An image map is an alist where each element has the format (AREA ID PLIST).
28470 An AREA is specified as either a rectangle, a circle, or a polygon:
28471 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
28472 pixel coordinates of the upper left and bottom right corners.
28473 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
28474 and the radius of the circle; r may be a float or integer.
28475 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
28476 vector describes one corner in the polygon.
28477 Returns the alist element for the first matching AREA in MAP. */)
28478 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
28486 return find_hot_spot (map
,
28487 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
28488 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
28492 /* Display frame CURSOR, optionally using shape defined by POINTER. */
28494 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
28496 /* Do not change cursor shape while dragging mouse. */
28497 if (!NILP (do_mouse_tracking
))
28500 if (!NILP (pointer
))
28502 if (EQ (pointer
, Qarrow
))
28503 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28504 else if (EQ (pointer
, Qhand
))
28505 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
28506 else if (EQ (pointer
, Qtext
))
28507 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
28508 else if (EQ (pointer
, intern ("hdrag")))
28509 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28510 else if (EQ (pointer
, intern ("nhdrag")))
28511 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
28512 #ifdef HAVE_X_WINDOWS
28513 else if (EQ (pointer
, intern ("vdrag")))
28514 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28516 else if (EQ (pointer
, intern ("hourglass")))
28517 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
28518 else if (EQ (pointer
, Qmodeline
))
28519 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
28521 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28524 if (cursor
!= No_Cursor
)
28525 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
28528 #endif /* HAVE_WINDOW_SYSTEM */
28530 /* Take proper action when mouse has moved to the mode or header line
28531 or marginal area AREA of window W, x-position X and y-position Y.
28532 X is relative to the start of the text display area of W, so the
28533 width of bitmap areas and scroll bars must be subtracted to get a
28534 position relative to the start of the mode line. */
28537 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
28538 enum window_part area
)
28540 struct window
*w
= XWINDOW (window
);
28541 struct frame
*f
= XFRAME (w
->frame
);
28542 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28543 #ifdef HAVE_WINDOW_SYSTEM
28544 Display_Info
*dpyinfo
;
28546 Cursor cursor
= No_Cursor
;
28547 Lisp_Object pointer
= Qnil
;
28548 int dx
, dy
, width
, height
;
28550 Lisp_Object string
, object
= Qnil
;
28551 Lisp_Object pos
IF_LINT (= Qnil
), help
;
28553 Lisp_Object mouse_face
;
28554 int original_x_pixel
= x
;
28555 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
28556 struct glyph_row
*row
IF_LINT (= 0);
28558 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
28563 /* Kludge alert: mode_line_string takes X/Y in pixels, but
28564 returns them in row/column units! */
28565 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
28566 &object
, &dx
, &dy
, &width
, &height
);
28568 row
= (area
== ON_MODE_LINE
28569 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
28570 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
28572 /* Find the glyph under the mouse pointer. */
28573 if (row
->mode_line_p
&& row
->enabled_p
)
28575 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
28576 end
= glyph
+ row
->used
[TEXT_AREA
];
28578 for (x0
= original_x_pixel
;
28579 glyph
< end
&& x0
>= glyph
->pixel_width
;
28581 x0
-= glyph
->pixel_width
;
28589 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
28590 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
28591 returns them in row/column units! */
28592 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
28593 &object
, &dx
, &dy
, &width
, &height
);
28598 #ifdef HAVE_WINDOW_SYSTEM
28599 if (IMAGEP (object
))
28601 Lisp_Object image_map
, hotspot
;
28602 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
28604 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
28606 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
28610 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
28611 If so, we could look for mouse-enter, mouse-leave
28612 properties in PLIST (and do something...). */
28613 hotspot
= XCDR (hotspot
);
28614 if (CONSP (hotspot
)
28615 && (plist
= XCAR (hotspot
), CONSP (plist
)))
28617 pointer
= Fplist_get (plist
, Qpointer
);
28618 if (NILP (pointer
))
28620 help
= Fplist_get (plist
, Qhelp_echo
);
28623 help_echo_string
= help
;
28624 XSETWINDOW (help_echo_window
, w
);
28625 help_echo_object
= w
->contents
;
28626 help_echo_pos
= charpos
;
28630 if (NILP (pointer
))
28631 pointer
= Fplist_get (XCDR (object
), QCpointer
);
28633 #endif /* HAVE_WINDOW_SYSTEM */
28635 if (STRINGP (string
))
28636 pos
= make_number (charpos
);
28638 /* Set the help text and mouse pointer. If the mouse is on a part
28639 of the mode line without any text (e.g. past the right edge of
28640 the mode line text), use the default help text and pointer. */
28641 if (STRINGP (string
) || area
== ON_MODE_LINE
)
28643 /* Arrange to display the help by setting the global variables
28644 help_echo_string, help_echo_object, and help_echo_pos. */
28647 if (STRINGP (string
))
28648 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
28652 help_echo_string
= help
;
28653 XSETWINDOW (help_echo_window
, w
);
28654 help_echo_object
= string
;
28655 help_echo_pos
= charpos
;
28657 else if (area
== ON_MODE_LINE
)
28659 Lisp_Object default_help
28660 = buffer_local_value_1 (Qmode_line_default_help_echo
,
28663 if (STRINGP (default_help
))
28665 help_echo_string
= default_help
;
28666 XSETWINDOW (help_echo_window
, w
);
28667 help_echo_object
= Qnil
;
28668 help_echo_pos
= -1;
28673 #ifdef HAVE_WINDOW_SYSTEM
28674 /* Change the mouse pointer according to what is under it. */
28675 if (FRAME_WINDOW_P (f
))
28677 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
28679 || NILP (Vresize_mini_windows
));
28681 dpyinfo
= FRAME_DISPLAY_INFO (f
);
28682 if (STRINGP (string
))
28684 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28686 if (NILP (pointer
))
28687 pointer
= Fget_text_property (pos
, Qpointer
, string
);
28689 /* Change the mouse pointer according to what is under X/Y. */
28691 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
28694 map
= Fget_text_property (pos
, Qlocal_map
, string
);
28695 if (!KEYMAPP (map
))
28696 map
= Fget_text_property (pos
, Qkeymap
, string
);
28697 if (!KEYMAPP (map
) && draggable
)
28698 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
28701 else if (draggable
)
28702 /* Default mode-line pointer. */
28703 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28708 /* Change the mouse face according to what is under X/Y. */
28709 if (STRINGP (string
))
28711 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
28712 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
28713 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
28718 struct glyph
* tmp_glyph
;
28722 int total_pixel_width
;
28723 ptrdiff_t begpos
, endpos
, ignore
;
28727 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
28728 Qmouse_face
, string
, Qnil
);
28734 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
28736 endpos
= SCHARS (string
);
28740 /* Calculate the glyph position GPOS of GLYPH in the
28741 displayed string, relative to the beginning of the
28742 highlighted part of the string.
28744 Note: GPOS is different from CHARPOS. CHARPOS is the
28745 position of GLYPH in the internal string object. A mode
28746 line string format has structures which are converted to
28747 a flattened string by the Emacs Lisp interpreter. The
28748 internal string is an element of those structures. The
28749 displayed string is the flattened string. */
28750 tmp_glyph
= row_start_glyph
;
28751 while (tmp_glyph
< glyph
28752 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
28753 && begpos
<= tmp_glyph
->charpos
28754 && tmp_glyph
->charpos
< endpos
)))
28756 gpos
= glyph
- tmp_glyph
;
28758 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
28759 the highlighted part of the displayed string to which
28760 GLYPH belongs. Note: GSEQ_LENGTH is different from
28761 SCHARS (STRING), because the latter returns the length of
28762 the internal string. */
28763 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
28765 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
28766 && begpos
<= tmp_glyph
->charpos
28767 && tmp_glyph
->charpos
< endpos
));
28770 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
28772 /* Calculate the total pixel width of all the glyphs between
28773 the beginning of the highlighted area and GLYPH. */
28774 total_pixel_width
= 0;
28775 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
28776 total_pixel_width
+= tmp_glyph
->pixel_width
;
28778 /* Pre calculation of re-rendering position. Note: X is in
28779 column units here, after the call to mode_line_string or
28780 marginal_area_string. */
28782 vpos
= (area
== ON_MODE_LINE
28783 ? (w
->current_matrix
)->nrows
- 1
28786 /* If GLYPH's position is included in the region that is
28787 already drawn in mouse face, we have nothing to do. */
28788 if ( EQ (window
, hlinfo
->mouse_face_window
)
28789 && (!row
->reversed_p
28790 ? (hlinfo
->mouse_face_beg_col
<= hpos
28791 && hpos
< hlinfo
->mouse_face_end_col
)
28792 /* In R2L rows we swap BEG and END, see below. */
28793 : (hlinfo
->mouse_face_end_col
<= hpos
28794 && hpos
< hlinfo
->mouse_face_beg_col
))
28795 && hlinfo
->mouse_face_beg_row
== vpos
)
28798 if (clear_mouse_face (hlinfo
))
28799 cursor
= No_Cursor
;
28801 if (!row
->reversed_p
)
28803 hlinfo
->mouse_face_beg_col
= hpos
;
28804 hlinfo
->mouse_face_beg_x
= original_x_pixel
28805 - (total_pixel_width
+ dx
);
28806 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
28807 hlinfo
->mouse_face_end_x
= 0;
28811 /* In R2L rows, show_mouse_face expects BEG and END
28812 coordinates to be swapped. */
28813 hlinfo
->mouse_face_end_col
= hpos
;
28814 hlinfo
->mouse_face_end_x
= original_x_pixel
28815 - (total_pixel_width
+ dx
);
28816 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
28817 hlinfo
->mouse_face_beg_x
= 0;
28820 hlinfo
->mouse_face_beg_row
= vpos
;
28821 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
28822 hlinfo
->mouse_face_past_end
= 0;
28823 hlinfo
->mouse_face_window
= window
;
28825 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
28830 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28832 if (NILP (pointer
))
28835 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
28836 clear_mouse_face (hlinfo
);
28838 #ifdef HAVE_WINDOW_SYSTEM
28839 if (FRAME_WINDOW_P (f
))
28840 define_frame_cursor1 (f
, cursor
, pointer
);
28846 Take proper action when the mouse has moved to position X, Y on
28847 frame F with regards to highlighting portions of display that have
28848 mouse-face properties. Also de-highlight portions of display where
28849 the mouse was before, set the mouse pointer shape as appropriate
28850 for the mouse coordinates, and activate help echo (tooltips).
28851 X and Y can be negative or out of range. */
28854 note_mouse_highlight (struct frame
*f
, int x
, int y
)
28856 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28857 enum window_part part
= ON_NOTHING
;
28858 Lisp_Object window
;
28860 Cursor cursor
= No_Cursor
;
28861 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
28864 /* When a menu is active, don't highlight because this looks odd. */
28865 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
28866 if (popup_activated ())
28870 if (!f
->glyphs_initialized_p
28871 || f
->pointer_invisible
)
28874 hlinfo
->mouse_face_mouse_x
= x
;
28875 hlinfo
->mouse_face_mouse_y
= y
;
28876 hlinfo
->mouse_face_mouse_frame
= f
;
28878 if (hlinfo
->mouse_face_defer
)
28881 /* Which window is that in? */
28882 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
28884 /* If displaying active text in another window, clear that. */
28885 if (! EQ (window
, hlinfo
->mouse_face_window
)
28886 /* Also clear if we move out of text area in same window. */
28887 || (!NILP (hlinfo
->mouse_face_window
)
28890 && part
!= ON_MODE_LINE
28891 && part
!= ON_HEADER_LINE
))
28892 clear_mouse_face (hlinfo
);
28894 /* Not on a window -> return. */
28895 if (!WINDOWP (window
))
28898 /* Reset help_echo_string. It will get recomputed below. */
28899 help_echo_string
= Qnil
;
28901 /* Convert to window-relative pixel coordinates. */
28902 w
= XWINDOW (window
);
28903 frame_to_window_pixel_xy (w
, &x
, &y
);
28905 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
28906 /* Handle tool-bar window differently since it doesn't display a
28908 if (EQ (window
, f
->tool_bar_window
))
28910 note_tool_bar_highlight (f
, x
, y
);
28915 /* Mouse is on the mode, header line or margin? */
28916 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
28917 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
28919 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
28921 #ifdef HAVE_WINDOW_SYSTEM
28922 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
28924 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28925 /* Show non-text cursor (Bug#16647). */
28933 #ifdef HAVE_WINDOW_SYSTEM
28934 if (part
== ON_VERTICAL_BORDER
)
28936 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28937 help_echo_string
= build_string ("drag-mouse-1: resize");
28939 else if (part
== ON_RIGHT_DIVIDER
)
28941 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28942 help_echo_string
= build_string ("drag-mouse-1: resize");
28944 else if (part
== ON_BOTTOM_DIVIDER
)
28945 if (! WINDOW_BOTTOMMOST_P (w
)
28947 || NILP (Vresize_mini_windows
))
28949 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
28950 help_echo_string
= build_string ("drag-mouse-1: resize");
28953 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28954 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
28955 || part
== ON_SCROLL_BAR
)
28956 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28958 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
28961 /* Are we in a window whose display is up to date?
28962 And verify the buffer's text has not changed. */
28963 b
= XBUFFER (w
->contents
);
28964 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
28966 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
28968 struct glyph
*glyph
;
28969 Lisp_Object object
;
28970 Lisp_Object mouse_face
= Qnil
, position
;
28971 Lisp_Object
*overlay_vec
= NULL
;
28972 ptrdiff_t i
, noverlays
;
28973 struct buffer
*obuf
;
28974 ptrdiff_t obegv
, ozv
;
28977 /* Find the glyph under X/Y. */
28978 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
28980 #ifdef HAVE_WINDOW_SYSTEM
28981 /* Look for :pointer property on image. */
28982 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
28984 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
28985 if (img
!= NULL
&& IMAGEP (img
->spec
))
28987 Lisp_Object image_map
, hotspot
;
28988 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
28990 && (hotspot
= find_hot_spot (image_map
,
28991 glyph
->slice
.img
.x
+ dx
,
28992 glyph
->slice
.img
.y
+ dy
),
28994 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
28998 /* Could check XCAR (hotspot) to see if we enter/leave
29000 If so, we could look for mouse-enter, mouse-leave
29001 properties in PLIST (and do something...). */
29002 hotspot
= XCDR (hotspot
);
29003 if (CONSP (hotspot
)
29004 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29006 pointer
= Fplist_get (plist
, Qpointer
);
29007 if (NILP (pointer
))
29009 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29010 if (!NILP (help_echo_string
))
29012 help_echo_window
= window
;
29013 help_echo_object
= glyph
->object
;
29014 help_echo_pos
= glyph
->charpos
;
29018 if (NILP (pointer
))
29019 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29022 #endif /* HAVE_WINDOW_SYSTEM */
29024 /* Clear mouse face if X/Y not over text. */
29026 || area
!= TEXT_AREA
29027 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29028 /* Glyph's OBJECT is an integer for glyphs inserted by the
29029 display engine for its internal purposes, like truncation
29030 and continuation glyphs and blanks beyond the end of
29031 line's text on text terminals. If we are over such a
29032 glyph, we are not over any text. */
29033 || INTEGERP (glyph
->object
)
29034 /* R2L rows have a stretch glyph at their front, which
29035 stands for no text, whereas L2R rows have no glyphs at
29036 all beyond the end of text. Treat such stretch glyphs
29037 like we do with NULL glyphs in L2R rows. */
29038 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29039 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29040 && glyph
->type
== STRETCH_GLYPH
29041 && glyph
->avoid_cursor_p
))
29043 if (clear_mouse_face (hlinfo
))
29044 cursor
= No_Cursor
;
29045 #ifdef HAVE_WINDOW_SYSTEM
29046 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29048 if (area
!= TEXT_AREA
)
29049 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29051 pointer
= Vvoid_text_area_pointer
;
29057 pos
= glyph
->charpos
;
29058 object
= glyph
->object
;
29059 if (!STRINGP (object
) && !BUFFERP (object
))
29062 /* If we get an out-of-range value, return now; avoid an error. */
29063 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29066 /* Make the window's buffer temporarily current for
29067 overlays_at and compute_char_face. */
29068 obuf
= current_buffer
;
29069 current_buffer
= b
;
29075 /* Is this char mouse-active or does it have help-echo? */
29076 position
= make_number (pos
);
29078 if (BUFFERP (object
))
29080 /* Put all the overlays we want in a vector in overlay_vec. */
29081 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
29082 /* Sort overlays into increasing priority order. */
29083 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29088 if (NILP (Vmouse_highlight
))
29090 clear_mouse_face (hlinfo
);
29091 goto check_help_echo
;
29094 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29097 cursor
= No_Cursor
;
29099 /* Check mouse-face highlighting. */
29101 /* If there exists an overlay with mouse-face overlapping
29102 the one we are currently highlighting, we have to
29103 check if we enter the overlapping overlay, and then
29104 highlight only that. */
29105 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29106 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29108 /* Find the highest priority overlay with a mouse-face. */
29109 Lisp_Object overlay
= Qnil
;
29110 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29112 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29113 if (!NILP (mouse_face
))
29114 overlay
= overlay_vec
[i
];
29117 /* If we're highlighting the same overlay as before, there's
29118 no need to do that again. */
29119 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29120 goto check_help_echo
;
29121 hlinfo
->mouse_face_overlay
= overlay
;
29123 /* Clear the display of the old active region, if any. */
29124 if (clear_mouse_face (hlinfo
))
29125 cursor
= No_Cursor
;
29127 /* If no overlay applies, get a text property. */
29128 if (NILP (overlay
))
29129 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29131 /* Next, compute the bounds of the mouse highlighting and
29133 if (!NILP (mouse_face
) && STRINGP (object
))
29135 /* The mouse-highlighting comes from a display string
29136 with a mouse-face. */
29140 s
= Fprevious_single_property_change
29141 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29142 e
= Fnext_single_property_change
29143 (position
, Qmouse_face
, object
, Qnil
);
29145 s
= make_number (0);
29147 e
= make_number (SCHARS (object
));
29148 mouse_face_from_string_pos (w
, hlinfo
, object
,
29149 XINT (s
), XINT (e
));
29150 hlinfo
->mouse_face_past_end
= 0;
29151 hlinfo
->mouse_face_window
= window
;
29152 hlinfo
->mouse_face_face_id
29153 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29154 glyph
->face_id
, 1);
29155 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29156 cursor
= No_Cursor
;
29160 /* The mouse-highlighting, if any, comes from an overlay
29161 or text property in the buffer. */
29162 Lisp_Object buffer
IF_LINT (= Qnil
);
29163 Lisp_Object disp_string
IF_LINT (= Qnil
);
29165 if (STRINGP (object
))
29167 /* If we are on a display string with no mouse-face,
29168 check if the text under it has one. */
29169 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29170 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29171 pos
= string_buffer_position (object
, start
);
29174 mouse_face
= get_char_property_and_overlay
29175 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29176 buffer
= w
->contents
;
29177 disp_string
= object
;
29183 disp_string
= Qnil
;
29186 if (!NILP (mouse_face
))
29188 Lisp_Object before
, after
;
29189 Lisp_Object before_string
, after_string
;
29190 /* To correctly find the limits of mouse highlight
29191 in a bidi-reordered buffer, we must not use the
29192 optimization of limiting the search in
29193 previous-single-property-change and
29194 next-single-property-change, because
29195 rows_from_pos_range needs the real start and end
29196 positions to DTRT in this case. That's because
29197 the first row visible in a window does not
29198 necessarily display the character whose position
29199 is the smallest. */
29201 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29202 ? Fmarker_position (w
->start
)
29205 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29206 ? make_number (BUF_Z (XBUFFER (buffer
))
29207 - w
->window_end_pos
)
29210 if (NILP (overlay
))
29212 /* Handle the text property case. */
29213 before
= Fprevious_single_property_change
29214 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29215 after
= Fnext_single_property_change
29216 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29217 before_string
= after_string
= Qnil
;
29221 /* Handle the overlay case. */
29222 before
= Foverlay_start (overlay
);
29223 after
= Foverlay_end (overlay
);
29224 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29225 after_string
= Foverlay_get (overlay
, Qafter_string
);
29227 if (!STRINGP (before_string
)) before_string
= Qnil
;
29228 if (!STRINGP (after_string
)) after_string
= Qnil
;
29231 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29234 : XFASTINT (before
),
29236 ? BUF_Z (XBUFFER (buffer
))
29237 : XFASTINT (after
),
29238 before_string
, after_string
,
29240 cursor
= No_Cursor
;
29247 /* Look for a `help-echo' property. */
29248 if (NILP (help_echo_string
)) {
29249 Lisp_Object help
, overlay
;
29251 /* Check overlays first. */
29252 help
= overlay
= Qnil
;
29253 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29255 overlay
= overlay_vec
[i
];
29256 help
= Foverlay_get (overlay
, Qhelp_echo
);
29261 help_echo_string
= help
;
29262 help_echo_window
= window
;
29263 help_echo_object
= overlay
;
29264 help_echo_pos
= pos
;
29268 Lisp_Object obj
= glyph
->object
;
29269 ptrdiff_t charpos
= glyph
->charpos
;
29271 /* Try text properties. */
29274 && charpos
< SCHARS (obj
))
29276 help
= Fget_text_property (make_number (charpos
),
29280 /* If the string itself doesn't specify a help-echo,
29281 see if the buffer text ``under'' it does. */
29282 struct glyph_row
*r
29283 = MATRIX_ROW (w
->current_matrix
, vpos
);
29284 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29285 ptrdiff_t p
= string_buffer_position (obj
, start
);
29288 help
= Fget_char_property (make_number (p
),
29289 Qhelp_echo
, w
->contents
);
29298 else if (BUFFERP (obj
)
29301 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
29306 help_echo_string
= help
;
29307 help_echo_window
= window
;
29308 help_echo_object
= obj
;
29309 help_echo_pos
= charpos
;
29314 #ifdef HAVE_WINDOW_SYSTEM
29315 /* Look for a `pointer' property. */
29316 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29318 /* Check overlays first. */
29319 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
29320 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
29322 if (NILP (pointer
))
29324 Lisp_Object obj
= glyph
->object
;
29325 ptrdiff_t charpos
= glyph
->charpos
;
29327 /* Try text properties. */
29330 && charpos
< SCHARS (obj
))
29332 pointer
= Fget_text_property (make_number (charpos
),
29334 if (NILP (pointer
))
29336 /* If the string itself doesn't specify a pointer,
29337 see if the buffer text ``under'' it does. */
29338 struct glyph_row
*r
29339 = MATRIX_ROW (w
->current_matrix
, vpos
);
29340 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29341 ptrdiff_t p
= string_buffer_position (obj
, start
);
29343 pointer
= Fget_char_property (make_number (p
),
29344 Qpointer
, w
->contents
);
29347 else if (BUFFERP (obj
)
29350 pointer
= Fget_text_property (make_number (charpos
),
29354 #endif /* HAVE_WINDOW_SYSTEM */
29358 current_buffer
= obuf
;
29363 #ifdef HAVE_WINDOW_SYSTEM
29364 if (FRAME_WINDOW_P (f
))
29365 define_frame_cursor1 (f
, cursor
, pointer
);
29367 /* This is here to prevent a compiler error, about "label at end of
29368 compound statement". */
29375 Clear any mouse-face on window W. This function is part of the
29376 redisplay interface, and is called from try_window_id and similar
29377 functions to ensure the mouse-highlight is off. */
29380 x_clear_window_mouse_face (struct window
*w
)
29382 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
29383 Lisp_Object window
;
29386 XSETWINDOW (window
, w
);
29387 if (EQ (window
, hlinfo
->mouse_face_window
))
29388 clear_mouse_face (hlinfo
);
29394 Just discard the mouse face information for frame F, if any.
29395 This is used when the size of F is changed. */
29398 cancel_mouse_face (struct frame
*f
)
29400 Lisp_Object window
;
29401 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29403 window
= hlinfo
->mouse_face_window
;
29404 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
29405 reset_mouse_highlight (hlinfo
);
29410 /***********************************************************************
29412 ***********************************************************************/
29414 #ifdef HAVE_WINDOW_SYSTEM
29416 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
29417 which intersects rectangle R. R is in window-relative coordinates. */
29420 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
29421 enum glyph_row_area area
)
29423 struct glyph
*first
= row
->glyphs
[area
];
29424 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
29425 struct glyph
*last
;
29426 int first_x
, start_x
, x
;
29428 if (area
== TEXT_AREA
&& row
->fill_line_p
)
29429 /* If row extends face to end of line write the whole line. */
29430 draw_glyphs (w
, 0, row
, area
,
29431 0, row
->used
[area
],
29432 DRAW_NORMAL_TEXT
, 0);
29435 /* Set START_X to the window-relative start position for drawing glyphs of
29436 AREA. The first glyph of the text area can be partially visible.
29437 The first glyphs of other areas cannot. */
29438 start_x
= window_box_left_offset (w
, area
);
29440 if (area
== TEXT_AREA
)
29443 /* Find the first glyph that must be redrawn. */
29445 && x
+ first
->pixel_width
< r
->x
)
29447 x
+= first
->pixel_width
;
29451 /* Find the last one. */
29455 && x
< r
->x
+ r
->width
)
29457 x
+= last
->pixel_width
;
29463 draw_glyphs (w
, first_x
- start_x
, row
, area
,
29464 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
29465 DRAW_NORMAL_TEXT
, 0);
29470 /* Redraw the parts of the glyph row ROW on window W intersecting
29471 rectangle R. R is in window-relative coordinates. Value is
29472 non-zero if mouse-face was overwritten. */
29475 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
29477 eassert (row
->enabled_p
);
29479 if (row
->mode_line_p
|| w
->pseudo_window_p
)
29480 draw_glyphs (w
, 0, row
, TEXT_AREA
,
29481 0, row
->used
[TEXT_AREA
],
29482 DRAW_NORMAL_TEXT
, 0);
29485 if (row
->used
[LEFT_MARGIN_AREA
])
29486 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
29487 if (row
->used
[TEXT_AREA
])
29488 expose_area (w
, row
, r
, TEXT_AREA
);
29489 if (row
->used
[RIGHT_MARGIN_AREA
])
29490 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
29491 draw_row_fringe_bitmaps (w
, row
);
29494 return row
->mouse_face_p
;
29498 /* Redraw those parts of glyphs rows during expose event handling that
29499 overlap other rows. Redrawing of an exposed line writes over parts
29500 of lines overlapping that exposed line; this function fixes that.
29502 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
29503 row in W's current matrix that is exposed and overlaps other rows.
29504 LAST_OVERLAPPING_ROW is the last such row. */
29507 expose_overlaps (struct window
*w
,
29508 struct glyph_row
*first_overlapping_row
,
29509 struct glyph_row
*last_overlapping_row
,
29512 struct glyph_row
*row
;
29514 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
29515 if (row
->overlapping_p
)
29517 eassert (row
->enabled_p
&& !row
->mode_line_p
);
29520 if (row
->used
[LEFT_MARGIN_AREA
])
29521 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
29523 if (row
->used
[TEXT_AREA
])
29524 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
29526 if (row
->used
[RIGHT_MARGIN_AREA
])
29527 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
29533 /* Return non-zero if W's cursor intersects rectangle R. */
29536 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
29538 XRectangle cr
, result
;
29539 struct glyph
*cursor_glyph
;
29540 struct glyph_row
*row
;
29542 if (w
->phys_cursor
.vpos
>= 0
29543 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
29544 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
29546 && row
->cursor_in_fringe_p
)
29548 /* Cursor is in the fringe. */
29549 cr
.x
= window_box_right_offset (w
,
29550 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
29551 ? RIGHT_MARGIN_AREA
29554 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
29555 cr
.height
= row
->height
;
29556 return x_intersect_rectangles (&cr
, r
, &result
);
29559 cursor_glyph
= get_phys_cursor_glyph (w
);
29562 /* r is relative to W's box, but w->phys_cursor.x is relative
29563 to left edge of W's TEXT area. Adjust it. */
29564 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
29565 cr
.y
= w
->phys_cursor
.y
;
29566 cr
.width
= cursor_glyph
->pixel_width
;
29567 cr
.height
= w
->phys_cursor_height
;
29568 /* ++KFS: W32 version used W32-specific IntersectRect here, but
29569 I assume the effect is the same -- and this is portable. */
29570 return x_intersect_rectangles (&cr
, r
, &result
);
29572 /* If we don't understand the format, pretend we're not in the hot-spot. */
29578 Draw a vertical window border to the right of window W if W doesn't
29579 have vertical scroll bars. */
29582 x_draw_vertical_border (struct window
*w
)
29584 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29586 /* We could do better, if we knew what type of scroll-bar the adjacent
29587 windows (on either side) have... But we don't :-(
29588 However, I think this works ok. ++KFS 2003-04-25 */
29590 /* Redraw borders between horizontally adjacent windows. Don't
29591 do it for frames with vertical scroll bars because either the
29592 right scroll bar of a window, or the left scroll bar of its
29593 neighbor will suffice as a border. */
29594 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
29597 /* Note: It is necessary to redraw both the left and the right
29598 borders, for when only this single window W is being
29600 if (!WINDOW_RIGHTMOST_P (w
)
29601 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
29603 int x0
, x1
, y0
, y1
;
29605 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29608 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29611 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
29614 if (!WINDOW_LEFTMOST_P (w
)
29615 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
29617 int x0
, x1
, y0
, y1
;
29619 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29622 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29625 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
29630 /* Draw window dividers for window W. */
29633 x_draw_right_divider (struct window
*w
)
29635 struct frame
*f
= WINDOW_XFRAME (w
);
29637 if (w
->mini
|| w
->pseudo_window_p
)
29639 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
29641 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
29642 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29643 int y0
= WINDOW_TOP_EDGE_Y (w
);
29644 /* The bottom divider prevails. */
29645 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29647 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29652 x_draw_bottom_divider (struct window
*w
)
29654 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29656 if (w
->mini
|| w
->pseudo_window_p
)
29658 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
29660 int x0
= WINDOW_LEFT_EDGE_X (w
);
29661 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29662 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29663 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
29665 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29669 /* Redraw the part of window W intersection rectangle FR. Pixel
29670 coordinates in FR are frame-relative. Call this function with
29671 input blocked. Value is non-zero if the exposure overwrites
29675 expose_window (struct window
*w
, XRectangle
*fr
)
29677 struct frame
*f
= XFRAME (w
->frame
);
29679 int mouse_face_overwritten_p
= 0;
29681 /* If window is not yet fully initialized, do nothing. This can
29682 happen when toolkit scroll bars are used and a window is split.
29683 Reconfiguring the scroll bar will generate an expose for a newly
29685 if (w
->current_matrix
== NULL
)
29688 /* When we're currently updating the window, display and current
29689 matrix usually don't agree. Arrange for a thorough display
29691 if (w
->must_be_updated_p
)
29693 SET_FRAME_GARBAGED (f
);
29697 /* Frame-relative pixel rectangle of W. */
29698 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
29699 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
29700 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
29701 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
29703 if (x_intersect_rectangles (fr
, &wr
, &r
))
29705 int yb
= window_text_bottom_y (w
);
29706 struct glyph_row
*row
;
29707 int cursor_cleared_p
, phys_cursor_on_p
;
29708 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
29710 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
29711 r
.x
, r
.y
, r
.width
, r
.height
));
29713 /* Convert to window coordinates. */
29714 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
29715 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
29717 /* Turn off the cursor. */
29718 if (!w
->pseudo_window_p
29719 && phys_cursor_in_rect_p (w
, &r
))
29721 x_clear_cursor (w
);
29722 cursor_cleared_p
= 1;
29725 cursor_cleared_p
= 0;
29727 /* If the row containing the cursor extends face to end of line,
29728 then expose_area might overwrite the cursor outside the
29729 rectangle and thus notice_overwritten_cursor might clear
29730 w->phys_cursor_on_p. We remember the original value and
29731 check later if it is changed. */
29732 phys_cursor_on_p
= w
->phys_cursor_on_p
;
29734 /* Update lines intersecting rectangle R. */
29735 first_overlapping_row
= last_overlapping_row
= NULL
;
29736 for (row
= w
->current_matrix
->rows
;
29741 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
29743 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
29744 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
29745 || (r
.y
>= y0
&& r
.y
< y1
)
29746 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
29748 /* A header line may be overlapping, but there is no need
29749 to fix overlapping areas for them. KFS 2005-02-12 */
29750 if (row
->overlapping_p
&& !row
->mode_line_p
)
29752 if (first_overlapping_row
== NULL
)
29753 first_overlapping_row
= row
;
29754 last_overlapping_row
= row
;
29758 if (expose_line (w
, row
, &r
))
29759 mouse_face_overwritten_p
= 1;
29762 else if (row
->overlapping_p
)
29764 /* We must redraw a row overlapping the exposed area. */
29766 ? y0
+ row
->phys_height
> r
.y
29767 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
29769 if (first_overlapping_row
== NULL
)
29770 first_overlapping_row
= row
;
29771 last_overlapping_row
= row
;
29779 /* Display the mode line if there is one. */
29780 if (WINDOW_WANTS_MODELINE_P (w
)
29781 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
29783 && row
->y
< r
.y
+ r
.height
)
29785 if (expose_line (w
, row
, &r
))
29786 mouse_face_overwritten_p
= 1;
29789 if (!w
->pseudo_window_p
)
29791 /* Fix the display of overlapping rows. */
29792 if (first_overlapping_row
)
29793 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
29796 /* Draw border between windows. */
29797 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
29798 x_draw_right_divider (w
);
29800 x_draw_vertical_border (w
);
29802 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
29803 x_draw_bottom_divider (w
);
29805 /* Turn the cursor on again. */
29806 if (cursor_cleared_p
29807 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
29808 update_window_cursor (w
, 1);
29812 return mouse_face_overwritten_p
;
29817 /* Redraw (parts) of all windows in the window tree rooted at W that
29818 intersect R. R contains frame pixel coordinates. Value is
29819 non-zero if the exposure overwrites mouse-face. */
29822 expose_window_tree (struct window
*w
, XRectangle
*r
)
29824 struct frame
*f
= XFRAME (w
->frame
);
29825 int mouse_face_overwritten_p
= 0;
29827 while (w
&& !FRAME_GARBAGED_P (f
))
29829 if (WINDOWP (w
->contents
))
29830 mouse_face_overwritten_p
29831 |= expose_window_tree (XWINDOW (w
->contents
), r
);
29833 mouse_face_overwritten_p
|= expose_window (w
, r
);
29835 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
29838 return mouse_face_overwritten_p
;
29843 Redisplay an exposed area of frame F. X and Y are the upper-left
29844 corner of the exposed rectangle. W and H are width and height of
29845 the exposed area. All are pixel values. W or H zero means redraw
29846 the entire frame. */
29849 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
29852 int mouse_face_overwritten_p
= 0;
29854 TRACE ((stderr
, "expose_frame "));
29856 /* No need to redraw if frame will be redrawn soon. */
29857 if (FRAME_GARBAGED_P (f
))
29859 TRACE ((stderr
, " garbaged\n"));
29863 /* If basic faces haven't been realized yet, there is no point in
29864 trying to redraw anything. This can happen when we get an expose
29865 event while Emacs is starting, e.g. by moving another window. */
29866 if (FRAME_FACE_CACHE (f
) == NULL
29867 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
29869 TRACE ((stderr
, " no faces\n"));
29873 if (w
== 0 || h
== 0)
29876 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
29877 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
29887 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
29888 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
29890 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
29891 if (WINDOWP (f
->tool_bar_window
))
29892 mouse_face_overwritten_p
29893 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
29896 #ifdef HAVE_X_WINDOWS
29898 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
29899 if (WINDOWP (f
->menu_bar_window
))
29900 mouse_face_overwritten_p
29901 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
29902 #endif /* not USE_X_TOOLKIT and not USE_GTK */
29906 /* Some window managers support a focus-follows-mouse style with
29907 delayed raising of frames. Imagine a partially obscured frame,
29908 and moving the mouse into partially obscured mouse-face on that
29909 frame. The visible part of the mouse-face will be highlighted,
29910 then the WM raises the obscured frame. With at least one WM, KDE
29911 2.1, Emacs is not getting any event for the raising of the frame
29912 (even tried with SubstructureRedirectMask), only Expose events.
29913 These expose events will draw text normally, i.e. not
29914 highlighted. Which means we must redo the highlight here.
29915 Subsume it under ``we love X''. --gerd 2001-08-15 */
29916 /* Included in Windows version because Windows most likely does not
29917 do the right thing if any third party tool offers
29918 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
29919 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
29921 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29922 if (f
== hlinfo
->mouse_face_mouse_frame
)
29924 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
29925 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
29926 clear_mouse_face (hlinfo
);
29927 note_mouse_highlight (f
, mouse_x
, mouse_y
);
29934 Determine the intersection of two rectangles R1 and R2. Return
29935 the intersection in *RESULT. Value is non-zero if RESULT is not
29939 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
29941 XRectangle
*left
, *right
;
29942 XRectangle
*upper
, *lower
;
29943 int intersection_p
= 0;
29945 /* Rearrange so that R1 is the left-most rectangle. */
29947 left
= r1
, right
= r2
;
29949 left
= r2
, right
= r1
;
29951 /* X0 of the intersection is right.x0, if this is inside R1,
29952 otherwise there is no intersection. */
29953 if (right
->x
<= left
->x
+ left
->width
)
29955 result
->x
= right
->x
;
29957 /* The right end of the intersection is the minimum of
29958 the right ends of left and right. */
29959 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
29962 /* Same game for Y. */
29964 upper
= r1
, lower
= r2
;
29966 upper
= r2
, lower
= r1
;
29968 /* The upper end of the intersection is lower.y0, if this is inside
29969 of upper. Otherwise, there is no intersection. */
29970 if (lower
->y
<= upper
->y
+ upper
->height
)
29972 result
->y
= lower
->y
;
29974 /* The lower end of the intersection is the minimum of the lower
29975 ends of upper and lower. */
29976 result
->height
= (min (lower
->y
+ lower
->height
,
29977 upper
->y
+ upper
->height
)
29979 intersection_p
= 1;
29983 return intersection_p
;
29986 #endif /* HAVE_WINDOW_SYSTEM */
29989 /***********************************************************************
29991 ***********************************************************************/
29994 syms_of_xdisp (void)
29996 Vwith_echo_area_save_vector
= Qnil
;
29997 staticpro (&Vwith_echo_area_save_vector
);
29999 Vmessage_stack
= Qnil
;
30000 staticpro (&Vmessage_stack
);
30002 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30003 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30005 message_dolog_marker1
= Fmake_marker ();
30006 staticpro (&message_dolog_marker1
);
30007 message_dolog_marker2
= Fmake_marker ();
30008 staticpro (&message_dolog_marker2
);
30009 message_dolog_marker3
= Fmake_marker ();
30010 staticpro (&message_dolog_marker3
);
30013 defsubr (&Sdump_frame_glyph_matrix
);
30014 defsubr (&Sdump_glyph_matrix
);
30015 defsubr (&Sdump_glyph_row
);
30016 defsubr (&Sdump_tool_bar_row
);
30017 defsubr (&Strace_redisplay
);
30018 defsubr (&Strace_to_stderr
);
30020 #ifdef HAVE_WINDOW_SYSTEM
30021 defsubr (&Stool_bar_height
);
30022 defsubr (&Slookup_image_map
);
30024 defsubr (&Sline_pixel_height
);
30025 defsubr (&Sformat_mode_line
);
30026 defsubr (&Sinvisible_p
);
30027 defsubr (&Scurrent_bidi_paragraph_direction
);
30028 defsubr (&Swindow_text_pixel_size
);
30029 defsubr (&Smove_point_visually
);
30031 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30032 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30033 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30034 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30035 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30036 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30037 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30038 DEFSYM (Qeval
, "eval");
30039 DEFSYM (QCdata
, ":data");
30040 DEFSYM (Qdisplay
, "display");
30041 DEFSYM (Qspace_width
, "space-width");
30042 DEFSYM (Qraise
, "raise");
30043 DEFSYM (Qslice
, "slice");
30044 DEFSYM (Qspace
, "space");
30045 DEFSYM (Qmargin
, "margin");
30046 DEFSYM (Qpointer
, "pointer");
30047 DEFSYM (Qleft_margin
, "left-margin");
30048 DEFSYM (Qright_margin
, "right-margin");
30049 DEFSYM (Qcenter
, "center");
30050 DEFSYM (Qline_height
, "line-height");
30051 DEFSYM (QCalign_to
, ":align-to");
30052 DEFSYM (QCrelative_width
, ":relative-width");
30053 DEFSYM (QCrelative_height
, ":relative-height");
30054 DEFSYM (QCeval
, ":eval");
30055 DEFSYM (QCpropertize
, ":propertize");
30056 DEFSYM (QCfile
, ":file");
30057 DEFSYM (Qfontified
, "fontified");
30058 DEFSYM (Qfontification_functions
, "fontification-functions");
30059 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30060 DEFSYM (Qescape_glyph
, "escape-glyph");
30061 DEFSYM (Qnobreak_space
, "nobreak-space");
30062 DEFSYM (Qimage
, "image");
30063 DEFSYM (Qtext
, "text");
30064 DEFSYM (Qboth
, "both");
30065 DEFSYM (Qboth_horiz
, "both-horiz");
30066 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30067 DEFSYM (QCmap
, ":map");
30068 DEFSYM (QCpointer
, ":pointer");
30069 DEFSYM (Qrect
, "rect");
30070 DEFSYM (Qcircle
, "circle");
30071 DEFSYM (Qpoly
, "poly");
30072 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
30073 DEFSYM (Qgrow_only
, "grow-only");
30074 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30075 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30076 DEFSYM (Qposition
, "position");
30077 DEFSYM (Qbuffer_position
, "buffer-position");
30078 DEFSYM (Qobject
, "object");
30079 DEFSYM (Qbar
, "bar");
30080 DEFSYM (Qhbar
, "hbar");
30081 DEFSYM (Qbox
, "box");
30082 DEFSYM (Qhollow
, "hollow");
30083 DEFSYM (Qhand
, "hand");
30084 DEFSYM (Qarrow
, "arrow");
30085 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30087 list_of_error
= list1 (list2 (intern_c_string ("error"),
30088 intern_c_string ("void-variable")));
30089 staticpro (&list_of_error
);
30091 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30092 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30093 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30094 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30096 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30097 staticpro (&echo_buffer
[0]);
30098 staticpro (&echo_buffer
[1]);
30100 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30101 staticpro (&echo_area_buffer
[0]);
30102 staticpro (&echo_area_buffer
[1]);
30104 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30105 staticpro (&Vmessages_buffer_name
);
30107 mode_line_proptrans_alist
= Qnil
;
30108 staticpro (&mode_line_proptrans_alist
);
30109 mode_line_string_list
= Qnil
;
30110 staticpro (&mode_line_string_list
);
30111 mode_line_string_face
= Qnil
;
30112 staticpro (&mode_line_string_face
);
30113 mode_line_string_face_prop
= Qnil
;
30114 staticpro (&mode_line_string_face_prop
);
30115 Vmode_line_unwind_vector
= Qnil
;
30116 staticpro (&Vmode_line_unwind_vector
);
30118 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30120 help_echo_string
= Qnil
;
30121 staticpro (&help_echo_string
);
30122 help_echo_object
= Qnil
;
30123 staticpro (&help_echo_object
);
30124 help_echo_window
= Qnil
;
30125 staticpro (&help_echo_window
);
30126 previous_help_echo_string
= Qnil
;
30127 staticpro (&previous_help_echo_string
);
30128 help_echo_pos
= -1;
30130 DEFSYM (Qright_to_left
, "right-to-left");
30131 DEFSYM (Qleft_to_right
, "left-to-right");
30133 #ifdef HAVE_WINDOW_SYSTEM
30134 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30135 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30136 For example, if a block cursor is over a tab, it will be drawn as
30137 wide as that tab on the display. */);
30138 x_stretch_cursor_p
= 0;
30141 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30142 doc
: /* Non-nil means highlight trailing whitespace.
30143 The face used for trailing whitespace is `trailing-whitespace'. */);
30144 Vshow_trailing_whitespace
= Qnil
;
30146 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30147 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30148 If the value is t, Emacs highlights non-ASCII chars which have the
30149 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30150 or `escape-glyph' face respectively.
30152 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30153 U+2011 (non-breaking hyphen) are affected.
30155 Any other non-nil value means to display these characters as a escape
30156 glyph followed by an ordinary space or hyphen.
30158 A value of nil means no special handling of these characters. */);
30159 Vnobreak_char_display
= Qt
;
30161 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30162 doc
: /* The pointer shape to show in void text areas.
30163 A value of nil means to show the text pointer. Other options are `arrow',
30164 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
30165 Vvoid_text_area_pointer
= Qarrow
;
30167 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30168 doc
: /* Non-nil means don't actually do any redisplay.
30169 This is used for internal purposes. */);
30170 Vinhibit_redisplay
= Qnil
;
30172 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30173 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30174 Vglobal_mode_string
= Qnil
;
30176 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30177 doc
: /* Marker for where to display an arrow on top of the buffer text.
30178 This must be the beginning of a line in order to work.
30179 See also `overlay-arrow-string'. */);
30180 Voverlay_arrow_position
= Qnil
;
30182 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30183 doc
: /* String to display as an arrow in non-window frames.
30184 See also `overlay-arrow-position'. */);
30185 Voverlay_arrow_string
= build_pure_c_string ("=>");
30187 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30188 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30189 The symbols on this list are examined during redisplay to determine
30190 where to display overlay arrows. */);
30191 Voverlay_arrow_variable_list
30192 = list1 (intern_c_string ("overlay-arrow-position"));
30194 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30195 doc
: /* The number of lines to try scrolling a window by when point moves out.
30196 If that fails to bring point back on frame, point is centered instead.
30197 If this is zero, point is always centered after it moves off frame.
30198 If you want scrolling to always be a line at a time, you should set
30199 `scroll-conservatively' to a large value rather than set this to 1. */);
30201 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30202 doc
: /* Scroll up to this many lines, to bring point back on screen.
30203 If point moves off-screen, redisplay will scroll by up to
30204 `scroll-conservatively' lines in order to bring point just barely
30205 onto the screen again. If that cannot be done, then redisplay
30206 recenters point as usual.
30208 If the value is greater than 100, redisplay will never recenter point,
30209 but will always scroll just enough text to bring point into view, even
30210 if you move far away.
30212 A value of zero means always recenter point if it moves off screen. */);
30213 scroll_conservatively
= 0;
30215 DEFVAR_INT ("scroll-margin", scroll_margin
,
30216 doc
: /* Number of lines of margin at the top and bottom of a window.
30217 Recenter the window whenever point gets within this many lines
30218 of the top or bottom of the window. */);
30221 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
30222 doc
: /* Pixels per inch value for non-window system displays.
30223 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30224 Vdisplay_pixels_per_inch
= make_float (72.0);
30227 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
30230 DEFVAR_LISP ("truncate-partial-width-windows",
30231 Vtruncate_partial_width_windows
,
30232 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
30233 For an integer value, truncate lines in each window narrower than the
30234 full frame width, provided the window width is less than that integer;
30235 otherwise, respect the value of `truncate-lines'.
30237 For any other non-nil value, truncate lines in all windows that do
30238 not span the full frame width.
30240 A value of nil means to respect the value of `truncate-lines'.
30242 If `word-wrap' is enabled, you might want to reduce this. */);
30243 Vtruncate_partial_width_windows
= make_number (50);
30245 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
30246 doc
: /* Maximum buffer size for which line number should be displayed.
30247 If the buffer is bigger than this, the line number does not appear
30248 in the mode line. A value of nil means no limit. */);
30249 Vline_number_display_limit
= Qnil
;
30251 DEFVAR_INT ("line-number-display-limit-width",
30252 line_number_display_limit_width
,
30253 doc
: /* Maximum line width (in characters) for line number display.
30254 If the average length of the lines near point is bigger than this, then the
30255 line number may be omitted from the mode line. */);
30256 line_number_display_limit_width
= 200;
30258 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
30259 doc
: /* Non-nil means highlight region even in nonselected windows. */);
30260 highlight_nonselected_windows
= 0;
30262 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
30263 doc
: /* Non-nil if more than one frame is visible on this display.
30264 Minibuffer-only frames don't count, but iconified frames do.
30265 This variable is not guaranteed to be accurate except while processing
30266 `frame-title-format' and `icon-title-format'. */);
30268 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
30269 doc
: /* Template for displaying the title bar of visible frames.
30270 \(Assuming the window manager supports this feature.)
30272 This variable has the same structure as `mode-line-format', except that
30273 the %c and %l constructs are ignored. It is used only on frames for
30274 which no explicit name has been set \(see `modify-frame-parameters'). */);
30276 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
30277 doc
: /* Template for displaying the title bar of an iconified frame.
30278 \(Assuming the window manager supports this feature.)
30279 This variable has the same structure as `mode-line-format' (which see),
30280 and is used only on frames for which no explicit name has been set
30281 \(see `modify-frame-parameters'). */);
30283 = Vframe_title_format
30284 = listn (CONSTYPE_PURE
, 3,
30285 intern_c_string ("multiple-frames"),
30286 build_pure_c_string ("%b"),
30287 listn (CONSTYPE_PURE
, 4,
30288 empty_unibyte_string
,
30289 intern_c_string ("invocation-name"),
30290 build_pure_c_string ("@"),
30291 intern_c_string ("system-name")));
30293 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
30294 doc
: /* Maximum number of lines to keep in the message log buffer.
30295 If nil, disable message logging. If t, log messages but don't truncate
30296 the buffer when it becomes large. */);
30297 Vmessage_log_max
= make_number (1000);
30299 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
30300 doc
: /* Functions called before redisplay, if window sizes have changed.
30301 The value should be a list of functions that take one argument.
30302 Just before redisplay, for each frame, if any of its windows have changed
30303 size since the last redisplay, or have been split or deleted,
30304 all the functions in the list are called, with the frame as argument. */);
30305 Vwindow_size_change_functions
= Qnil
;
30307 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
30308 doc
: /* List of functions to call before redisplaying a window with scrolling.
30309 Each function is called with two arguments, the window and its new
30310 display-start position. Note that these functions are also called by
30311 `set-window-buffer'. Also note that the value of `window-end' is not
30312 valid when these functions are called.
30314 Warning: Do not use this feature to alter the way the window
30315 is scrolled. It is not designed for that, and such use probably won't
30317 Vwindow_scroll_functions
= Qnil
;
30319 DEFVAR_LISP ("window-text-change-functions",
30320 Vwindow_text_change_functions
,
30321 doc
: /* Functions to call in redisplay when text in the window might change. */);
30322 Vwindow_text_change_functions
= Qnil
;
30324 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
30325 doc
: /* Functions called when redisplay of a window reaches the end trigger.
30326 Each function is called with two arguments, the window and the end trigger value.
30327 See `set-window-redisplay-end-trigger'. */);
30328 Vredisplay_end_trigger_functions
= Qnil
;
30330 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
30331 doc
: /* Non-nil means autoselect window with mouse pointer.
30332 If nil, do not autoselect windows.
30333 A positive number means delay autoselection by that many seconds: a
30334 window is autoselected only after the mouse has remained in that
30335 window for the duration of the delay.
30336 A negative number has a similar effect, but causes windows to be
30337 autoselected only after the mouse has stopped moving. \(Because of
30338 the way Emacs compares mouse events, you will occasionally wait twice
30339 that time before the window gets selected.\)
30340 Any other value means to autoselect window instantaneously when the
30341 mouse pointer enters it.
30343 Autoselection selects the minibuffer only if it is active, and never
30344 unselects the minibuffer if it is active.
30346 When customizing this variable make sure that the actual value of
30347 `focus-follows-mouse' matches the behavior of your window manager. */);
30348 Vmouse_autoselect_window
= Qnil
;
30350 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
30351 doc
: /* Non-nil means automatically resize tool-bars.
30352 This dynamically changes the tool-bar's height to the minimum height
30353 that is needed to make all tool-bar items visible.
30354 If value is `grow-only', the tool-bar's height is only increased
30355 automatically; to decrease the tool-bar height, use \\[recenter]. */);
30356 Vauto_resize_tool_bars
= Qt
;
30358 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
30359 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
30360 auto_raise_tool_bar_buttons_p
= 1;
30362 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
30363 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
30364 make_cursor_line_fully_visible_p
= 1;
30366 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
30367 doc
: /* Border below tool-bar in pixels.
30368 If an integer, use it as the height of the border.
30369 If it is one of `internal-border-width' or `border-width', use the
30370 value of the corresponding frame parameter.
30371 Otherwise, no border is added below the tool-bar. */);
30372 Vtool_bar_border
= Qinternal_border_width
;
30374 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
30375 doc
: /* Margin around tool-bar buttons in pixels.
30376 If an integer, use that for both horizontal and vertical margins.
30377 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
30378 HORZ specifying the horizontal margin, and VERT specifying the
30379 vertical margin. */);
30380 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
30382 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
30383 doc
: /* Relief thickness of tool-bar buttons. */);
30384 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
30386 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
30387 doc
: /* Tool bar style to use.
30389 image - show images only
30390 text - show text only
30391 both - show both, text below image
30392 both-horiz - show text to the right of the image
30393 text-image-horiz - show text to the left of the image
30394 any other - use system default or image if no system default.
30396 This variable only affects the GTK+ toolkit version of Emacs. */);
30397 Vtool_bar_style
= Qnil
;
30399 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
30400 doc
: /* Maximum number of characters a label can have to be shown.
30401 The tool bar style must also show labels for this to have any effect, see
30402 `tool-bar-style'. */);
30403 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
30405 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
30406 doc
: /* List of functions to call to fontify regions of text.
30407 Each function is called with one argument POS. Functions must
30408 fontify a region starting at POS in the current buffer, and give
30409 fontified regions the property `fontified'. */);
30410 Vfontification_functions
= Qnil
;
30411 Fmake_variable_buffer_local (Qfontification_functions
);
30413 DEFVAR_BOOL ("unibyte-display-via-language-environment",
30414 unibyte_display_via_language_environment
,
30415 doc
: /* Non-nil means display unibyte text according to language environment.
30416 Specifically, this means that raw bytes in the range 160-255 decimal
30417 are displayed by converting them to the equivalent multibyte characters
30418 according to the current language environment. As a result, they are
30419 displayed according to the current fontset.
30421 Note that this variable affects only how these bytes are displayed,
30422 but does not change the fact they are interpreted as raw bytes. */);
30423 unibyte_display_via_language_environment
= 0;
30425 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
30426 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
30427 If a float, it specifies a fraction of the mini-window frame's height.
30428 If an integer, it specifies a number of lines. */);
30429 Vmax_mini_window_height
= make_float (0.25);
30431 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
30432 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
30433 A value of nil means don't automatically resize mini-windows.
30434 A value of t means resize them to fit the text displayed in them.
30435 A value of `grow-only', the default, means let mini-windows grow only;
30436 they return to their normal size when the minibuffer is closed, or the
30437 echo area becomes empty. */);
30438 Vresize_mini_windows
= Qgrow_only
;
30440 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
30441 doc
: /* Alist specifying how to blink the cursor off.
30442 Each element has the form (ON-STATE . OFF-STATE). Whenever the
30443 `cursor-type' frame-parameter or variable equals ON-STATE,
30444 comparing using `equal', Emacs uses OFF-STATE to specify
30445 how to blink it off. ON-STATE and OFF-STATE are values for
30446 the `cursor-type' frame parameter.
30448 If a frame's ON-STATE has no entry in this list,
30449 the frame's other specifications determine how to blink the cursor off. */);
30450 Vblink_cursor_alist
= Qnil
;
30452 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
30453 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
30454 If non-nil, windows are automatically scrolled horizontally to make
30455 point visible. */);
30456 automatic_hscrolling_p
= 1;
30457 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
30459 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
30460 doc
: /* How many columns away from the window edge point is allowed to get
30461 before automatic hscrolling will horizontally scroll the window. */);
30462 hscroll_margin
= 5;
30464 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
30465 doc
: /* How many columns to scroll the window when point gets too close to the edge.
30466 When point is less than `hscroll-margin' columns from the window
30467 edge, automatic hscrolling will scroll the window by the amount of columns
30468 determined by this variable. If its value is a positive integer, scroll that
30469 many columns. If it's a positive floating-point number, it specifies the
30470 fraction of the window's width to scroll. If it's nil or zero, point will be
30471 centered horizontally after the scroll. Any other value, including negative
30472 numbers, are treated as if the value were zero.
30474 Automatic hscrolling always moves point outside the scroll margin, so if
30475 point was more than scroll step columns inside the margin, the window will
30476 scroll more than the value given by the scroll step.
30478 Note that the lower bound for automatic hscrolling specified by `scroll-left'
30479 and `scroll-right' overrides this variable's effect. */);
30480 Vhscroll_step
= make_number (0);
30482 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
30483 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
30484 Bind this around calls to `message' to let it take effect. */);
30485 message_truncate_lines
= 0;
30487 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
30488 doc
: /* Normal hook run to update the menu bar definitions.
30489 Redisplay runs this hook before it redisplays the menu bar.
30490 This is used to update menus such as Buffers, whose contents depend on
30492 Vmenu_bar_update_hook
= Qnil
;
30494 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
30495 doc
: /* Frame for which we are updating a menu.
30496 The enable predicate for a menu binding should check this variable. */);
30497 Vmenu_updating_frame
= Qnil
;
30499 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
30500 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
30501 inhibit_menubar_update
= 0;
30503 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
30504 doc
: /* Prefix prepended to all continuation lines at display time.
30505 The value may be a string, an image, or a stretch-glyph; it is
30506 interpreted in the same way as the value of a `display' text property.
30508 This variable is overridden by any `wrap-prefix' text or overlay
30511 To add a prefix to non-continuation lines, use `line-prefix'. */);
30512 Vwrap_prefix
= Qnil
;
30513 DEFSYM (Qwrap_prefix
, "wrap-prefix");
30514 Fmake_variable_buffer_local (Qwrap_prefix
);
30516 DEFVAR_LISP ("line-prefix", Vline_prefix
,
30517 doc
: /* Prefix prepended to all non-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 `line-prefix' text or overlay
30524 To add a prefix to continuation lines, use `wrap-prefix'. */);
30525 Vline_prefix
= Qnil
;
30526 DEFSYM (Qline_prefix
, "line-prefix");
30527 Fmake_variable_buffer_local (Qline_prefix
);
30529 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
30530 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
30531 inhibit_eval_during_redisplay
= 0;
30533 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
30534 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
30535 inhibit_free_realized_faces
= 0;
30538 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
30539 doc
: /* Inhibit try_window_id display optimization. */);
30540 inhibit_try_window_id
= 0;
30542 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
30543 doc
: /* Inhibit try_window_reusing display optimization. */);
30544 inhibit_try_window_reusing
= 0;
30546 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
30547 doc
: /* Inhibit try_cursor_movement display optimization. */);
30548 inhibit_try_cursor_movement
= 0;
30549 #endif /* GLYPH_DEBUG */
30551 DEFVAR_INT ("overline-margin", overline_margin
,
30552 doc
: /* Space between overline and text, in pixels.
30553 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
30554 margin to the character height. */);
30555 overline_margin
= 2;
30557 DEFVAR_INT ("underline-minimum-offset",
30558 underline_minimum_offset
,
30559 doc
: /* Minimum distance between baseline and underline.
30560 This can improve legibility of underlined text at small font sizes,
30561 particularly when using variable `x-use-underline-position-properties'
30562 with fonts that specify an UNDERLINE_POSITION relatively close to the
30563 baseline. The default value is 1. */);
30564 underline_minimum_offset
= 1;
30566 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
30567 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
30568 This feature only works when on a window system that can change
30569 cursor shapes. */);
30570 display_hourglass_p
= 1;
30572 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
30573 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
30574 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
30576 #ifdef HAVE_WINDOW_SYSTEM
30577 hourglass_atimer
= NULL
;
30578 hourglass_shown_p
= 0;
30579 #endif /* HAVE_WINDOW_SYSTEM */
30581 DEFSYM (Qglyphless_char
, "glyphless-char");
30582 DEFSYM (Qhex_code
, "hex-code");
30583 DEFSYM (Qempty_box
, "empty-box");
30584 DEFSYM (Qthin_space
, "thin-space");
30585 DEFSYM (Qzero_width
, "zero-width");
30587 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
30588 doc
: /* Function run just before redisplay.
30589 It is called with one argument, which is the set of windows that are to
30590 be redisplayed. This set can be nil (meaning, only the selected window),
30591 or t (meaning all windows). */);
30592 Vpre_redisplay_function
= intern ("ignore");
30594 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
30595 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
30597 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
30598 doc
: /* Char-table defining glyphless characters.
30599 Each element, if non-nil, should be one of the following:
30600 an ASCII acronym string: display this string in a box
30601 `hex-code': display the hexadecimal code of a character in a box
30602 `empty-box': display as an empty box
30603 `thin-space': display as 1-pixel width space
30604 `zero-width': don't display
30605 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
30606 display method for graphical terminals and text terminals respectively.
30607 GRAPHICAL and TEXT should each have one of the values listed above.
30609 The char-table has one extra slot to control the display of a character for
30610 which no font is found. This slot only takes effect on graphical terminals.
30611 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
30612 `thin-space'. The default is `empty-box'.
30614 If a character has a non-nil entry in an active display table, the
30615 display table takes effect; in this case, Emacs does not consult
30616 `glyphless-char-display' at all. */);
30617 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
30618 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
30621 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
30622 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
30623 Vdebug_on_message
= Qnil
;
30625 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
30627 Vredisplay__all_windows_cause
30628 = Fmake_vector (make_number (100), make_number (0));
30630 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
30632 Vredisplay__mode_lines_cause
30633 = Fmake_vector (make_number (100), make_number (0));
30637 /* Initialize this module when Emacs starts. */
30642 CHARPOS (this_line_start_pos
) = 0;
30644 if (!noninteractive
)
30646 struct window
*m
= XWINDOW (minibuf_window
);
30647 Lisp_Object frame
= m
->frame
;
30648 struct frame
*f
= XFRAME (frame
);
30649 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
30650 struct window
*r
= XWINDOW (root
);
30653 echo_area_window
= minibuf_window
;
30655 r
->top_line
= FRAME_TOP_MARGIN (f
);
30656 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
30657 r
->total_cols
= FRAME_COLS (f
);
30658 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30659 r
->total_lines
= FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
30660 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
30662 m
->top_line
= FRAME_LINES (f
) - 1;
30663 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
30664 m
->total_cols
= FRAME_COLS (f
);
30665 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30666 m
->total_lines
= 1;
30667 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
30669 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
30670 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
30671 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
30673 /* The default ellipsis glyphs `...'. */
30674 for (i
= 0; i
< 3; ++i
)
30675 default_invis_vector
[i
] = make_number ('.');
30679 /* Allocate the buffer for frame titles.
30680 Also used for `format-mode-line'. */
30682 mode_line_noprop_buf
= xmalloc (size
);
30683 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
30684 mode_line_noprop_ptr
= mode_line_noprop_buf
;
30685 mode_line_target
= MODE_LINE_DISPLAY
;
30688 help_echo_showing_p
= 0;
30691 #ifdef HAVE_WINDOW_SYSTEM
30693 /* Platform-independent portion of hourglass implementation. */
30695 /* Cancel a currently active hourglass timer, and start a new one. */
30697 start_hourglass (void)
30699 struct timespec delay
;
30701 cancel_hourglass ();
30703 if (INTEGERP (Vhourglass_delay
)
30704 && XINT (Vhourglass_delay
) > 0)
30705 delay
= make_timespec (min (XINT (Vhourglass_delay
),
30706 TYPE_MAXIMUM (time_t)),
30708 else if (FLOATP (Vhourglass_delay
)
30709 && XFLOAT_DATA (Vhourglass_delay
) > 0)
30710 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
30712 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
30716 extern void w32_note_current_window (void);
30717 w32_note_current_window ();
30719 #endif /* HAVE_NTGUI */
30721 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
30722 show_hourglass
, NULL
);
30726 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
30729 cancel_hourglass (void)
30731 if (hourglass_atimer
)
30733 cancel_atimer (hourglass_atimer
);
30734 hourglass_atimer
= NULL
;
30737 if (hourglass_shown_p
)
30741 #endif /* HAVE_WINDOW_SYSTEM */