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 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1458 void *save_it_data
= NULL
;
1460 /* Calling line_bottom_y may change it.method, it.position, etc. */
1461 SAVE_IT (save_it
, it
, save_it_data
);
1463 bottom_y
= line_bottom_y (&it
);
1464 if (top_y
< window_top_y
)
1465 visible_p
= bottom_y
> window_top_y
;
1466 else if (top_y
< it
.last_visible_y
)
1468 if (bottom_y
>= it
.last_visible_y
1469 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1470 && IT_CHARPOS (it
) < charpos
)
1472 /* When the last line of the window is scanned backwards
1473 under bidi iteration, we could be duped into thinking
1474 that we have passed CHARPOS, when in fact move_it_to
1475 simply stopped short of CHARPOS because it reached
1476 last_visible_y. To see if that's what happened, we call
1477 move_it_to again with a slightly larger vertical limit,
1478 and see if it actually moved vertically; if it did, we
1479 didn't really reach CHARPOS, which is beyond window end. */
1480 /* Why 10? because we don't know how many canonical lines
1481 will the height of the next line(s) be. So we guess. */
1482 int ten_more_lines
= 10 * default_line_pixel_height (w
);
1484 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1485 MOVE_TO_POS
| MOVE_TO_Y
);
1486 if (it
.current_y
> top_y
)
1490 RESTORE_IT (&it
, &save_it
, save_it_data
);
1493 if (it
.method
== GET_FROM_DISPLAY_VECTOR
)
1495 /* We stopped on the last glyph of a display vector.
1496 Try and recompute. Hack alert! */
1497 if (charpos
< 2 || top
.charpos
>= charpos
)
1498 top_x
= it
.glyph_row
->x
;
1501 struct it it2
, it2_prev
;
1502 /* The idea is to get to the previous buffer
1503 position, consume the character there, and use
1504 the pixel coordinates we get after that. But if
1505 the previous buffer position is also displayed
1506 from a display vector, we need to consume all of
1507 the glyphs from that display vector. */
1508 start_display (&it2
, w
, top
);
1509 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1510 /* If we didn't get to CHARPOS - 1, there's some
1511 replacing display property at that position, and
1512 we stopped after it. That is exactly the place
1513 whose coordinates we want. */
1514 if (IT_CHARPOS (it2
) != charpos
- 1)
1518 /* Iterate until we get out of the display
1519 vector that displays the character at
1522 get_next_display_element (&it2
);
1523 PRODUCE_GLYPHS (&it2
);
1525 set_iterator_to_next (&it2
, 1);
1526 } while (it2
.method
== GET_FROM_DISPLAY_VECTOR
1527 && IT_CHARPOS (it2
) < charpos
);
1529 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev
)
1530 || it2_prev
.current_x
> it2_prev
.last_visible_x
)
1531 top_x
= it
.glyph_row
->x
;
1534 top_x
= it2_prev
.current_x
;
1535 top_y
= it2_prev
.current_y
;
1539 else if (IT_CHARPOS (it
) != charpos
)
1541 Lisp_Object cpos
= make_number (charpos
);
1542 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1543 Lisp_Object string
= string_from_display_spec (spec
);
1544 struct text_pos tpos
;
1545 int replacing_spec_p
;
1546 bool newline_in_string
1548 && memchr (SDATA (string
), '\n', SBYTES (string
)));
1550 SET_TEXT_POS (tpos
, charpos
, CHAR_TO_BYTE (charpos
));
1553 && handle_display_spec (NULL
, spec
, Qnil
, Qnil
, &tpos
,
1554 charpos
, FRAME_WINDOW_P (it
.f
)));
1555 /* The tricky code below is needed because there's a
1556 discrepancy between move_it_to and how we set cursor
1557 when PT is at the beginning of a portion of text
1558 covered by a display property or an overlay with a
1559 display property, or the display line ends in a
1560 newline from a display string. move_it_to will stop
1561 _after_ such display strings, whereas
1562 set_cursor_from_row conspires with cursor_row_p to
1563 place the cursor on the first glyph produced from the
1566 /* We have overshoot PT because it is covered by a
1567 display property that replaces the text it covers.
1568 If the string includes embedded newlines, we are also
1569 in the wrong display line. Backtrack to the correct
1570 line, where the display property begins. */
1571 if (replacing_spec_p
)
1573 Lisp_Object startpos
, endpos
;
1574 EMACS_INT start
, end
;
1578 /* Find the first and the last buffer positions
1579 covered by the display string. */
1581 Fnext_single_char_property_change (cpos
, Qdisplay
,
1584 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1586 start
= XFASTINT (startpos
);
1587 end
= XFASTINT (endpos
);
1588 /* Move to the last buffer position before the
1589 display property. */
1590 start_display (&it3
, w
, top
);
1591 if (start
> CHARPOS (top
))
1592 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1593 /* Move forward one more line if the position before
1594 the display string is a newline or if it is the
1595 rightmost character on a line that is
1596 continued or word-wrapped. */
1597 if (it3
.method
== GET_FROM_BUFFER
1599 || FETCH_BYTE (IT_BYTEPOS (it3
)) == '\n'))
1600 move_it_by_lines (&it3
, 1);
1601 else if (move_it_in_display_line_to (&it3
, -1,
1605 == MOVE_LINE_CONTINUED
)
1607 move_it_by_lines (&it3
, 1);
1608 /* When we are under word-wrap, the #$@%!
1609 move_it_by_lines moves 2 lines, so we need to
1611 if (it3
.line_wrap
== WORD_WRAP
)
1612 move_it_by_lines (&it3
, -1);
1615 /* Record the vertical coordinate of the display
1616 line where we wound up. */
1617 top_y
= it3
.current_y
;
1620 /* When characters are reordered for display,
1621 the character displayed to the left of the
1622 display string could be _after_ the display
1623 property in the logical order. Use the
1624 smallest vertical position of these two. */
1625 start_display (&it3
, w
, top
);
1626 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1627 if (it3
.current_y
< top_y
)
1628 top_y
= it3
.current_y
;
1630 /* Move from the top of the window to the beginning
1631 of the display line where the display string
1633 start_display (&it3
, w
, top
);
1634 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1635 /* If it3_moved stays zero after the 'while' loop
1636 below, that means we already were at a newline
1637 before the loop (e.g., the display string begins
1638 with a newline), so we don't need to (and cannot)
1639 inspect the glyphs of it3.glyph_row, because
1640 PRODUCE_GLYPHS will not produce anything for a
1641 newline, and thus it3.glyph_row stays at its
1642 stale content it got at top of the window. */
1644 /* Finally, advance the iterator until we hit the
1645 first display element whose character position is
1646 CHARPOS, or until the first newline from the
1647 display string, which signals the end of the
1649 while (get_next_display_element (&it3
))
1651 PRODUCE_GLYPHS (&it3
);
1652 if (IT_CHARPOS (it3
) == charpos
1653 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1656 set_iterator_to_next (&it3
, 0);
1658 top_x
= it3
.current_x
- it3
.pixel_width
;
1659 /* Normally, we would exit the above loop because we
1660 found the display element whose character
1661 position is CHARPOS. For the contingency that we
1662 didn't, and stopped at the first newline from the
1663 display string, move back over the glyphs
1664 produced from the string, until we find the
1665 rightmost glyph not from the string. */
1667 && newline_in_string
1668 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1670 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1671 + it3
.glyph_row
->used
[TEXT_AREA
];
1673 while (EQ ((g
- 1)->object
, string
))
1676 top_x
-= g
->pixel_width
;
1678 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1679 + it3
.glyph_row
->used
[TEXT_AREA
]);
1685 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1686 *rtop
= max (0, window_top_y
- top_y
);
1687 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1688 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1689 - max (top_y
, window_top_y
)));
1695 /* Either we were asked to provide info about WINDOW_END, or
1696 CHARPOS is in the partially visible glyph row at end of
1699 void *it2data
= NULL
;
1701 SAVE_IT (it2
, it
, it2data
);
1702 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1703 move_it_by_lines (&it
, 1);
1704 if (charpos
< IT_CHARPOS (it
)
1705 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1708 RESTORE_IT (&it2
, &it2
, it2data
);
1709 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1711 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1712 *rtop
= max (0, -it2
.current_y
);
1713 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1714 - it
.last_visible_y
));
1715 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1717 - max (it2
.current_y
,
1718 WINDOW_HEADER_LINE_HEIGHT (w
))));
1722 bidi_unshelve_cache (it2data
, 1);
1724 bidi_unshelve_cache (itdata
, 0);
1727 set_buffer_internal_1 (old_buffer
);
1729 if (visible_p
&& w
->hscroll
> 0)
1731 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1732 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1735 /* Debugging code. */
1737 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1738 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1740 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1747 /* Return the next character from STR. Return in *LEN the length of
1748 the character. This is like STRING_CHAR_AND_LENGTH but never
1749 returns an invalid character. If we find one, we return a `?', but
1750 with the length of the invalid character. */
1753 string_char_and_length (const unsigned char *str
, int *len
)
1757 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1758 if (!CHAR_VALID_P (c
))
1759 /* We may not change the length here because other places in Emacs
1760 don't use this function, i.e. they silently accept invalid
1769 /* Given a position POS containing a valid character and byte position
1770 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1772 static struct text_pos
1773 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1775 eassert (STRINGP (string
) && nchars
>= 0);
1777 if (STRING_MULTIBYTE (string
))
1779 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1784 string_char_and_length (p
, &len
);
1787 BYTEPOS (pos
) += len
;
1791 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1797 /* Value is the text position, i.e. character and byte position,
1798 for character position CHARPOS in STRING. */
1800 static struct text_pos
1801 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1803 struct text_pos pos
;
1804 eassert (STRINGP (string
));
1805 eassert (charpos
>= 0);
1806 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1811 /* Value is a text position, i.e. character and byte position, for
1812 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1813 means recognize multibyte characters. */
1815 static struct text_pos
1816 c_string_pos (ptrdiff_t charpos
, const char *s
, bool multibyte_p
)
1818 struct text_pos pos
;
1820 eassert (s
!= NULL
);
1821 eassert (charpos
>= 0);
1827 SET_TEXT_POS (pos
, 0, 0);
1830 string_char_and_length ((const unsigned char *) s
, &len
);
1833 BYTEPOS (pos
) += len
;
1837 SET_TEXT_POS (pos
, charpos
, charpos
);
1843 /* Value is the number of characters in C string S. MULTIBYTE_P
1844 non-zero means recognize multibyte characters. */
1847 number_of_chars (const char *s
, bool multibyte_p
)
1853 ptrdiff_t rest
= strlen (s
);
1855 const unsigned char *p
= (const unsigned char *) s
;
1857 for (nchars
= 0; rest
> 0; ++nchars
)
1859 string_char_and_length (p
, &len
);
1860 rest
-= len
, p
+= len
;
1864 nchars
= strlen (s
);
1870 /* Compute byte position NEWPOS->bytepos corresponding to
1871 NEWPOS->charpos. POS is a known position in string STRING.
1872 NEWPOS->charpos must be >= POS.charpos. */
1875 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1877 eassert (STRINGP (string
));
1878 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1880 if (STRING_MULTIBYTE (string
))
1881 *newpos
= string_pos_nchars_ahead (pos
, string
,
1882 CHARPOS (*newpos
) - CHARPOS (pos
));
1884 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1888 Return an estimation of the pixel height of mode or header lines on
1889 frame F. FACE_ID specifies what line's height to estimate. */
1892 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1894 #ifdef HAVE_WINDOW_SYSTEM
1895 if (FRAME_WINDOW_P (f
))
1897 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1899 /* This function is called so early when Emacs starts that the face
1900 cache and mode line face are not yet initialized. */
1901 if (FRAME_FACE_CACHE (f
))
1903 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1907 height
= FONT_HEIGHT (face
->font
);
1908 if (face
->box_line_width
> 0)
1909 height
+= 2 * face
->box_line_width
;
1920 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1921 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1922 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1923 not force the value into range. */
1926 pixel_to_glyph_coords (struct frame
*f
, register int pix_x
, register int pix_y
,
1927 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1930 #ifdef HAVE_WINDOW_SYSTEM
1931 if (FRAME_WINDOW_P (f
))
1933 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1934 even for negative values. */
1936 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1938 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1940 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1941 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1944 STORE_NATIVE_RECT (*bounds
,
1945 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1946 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1947 FRAME_COLUMN_WIDTH (f
) - 1,
1948 FRAME_LINE_HEIGHT (f
) - 1);
1950 /* PXW: Should we clip pixels before converting to columns/lines? */
1955 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1956 pix_x
= FRAME_TOTAL_COLS (f
);
1960 else if (pix_y
> FRAME_LINES (f
))
1961 pix_y
= FRAME_LINES (f
);
1971 /* Find the glyph under window-relative coordinates X/Y in window W.
1972 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1973 strings. Return in *HPOS and *VPOS the row and column number of
1974 the glyph found. Return in *AREA the glyph area containing X.
1975 Value is a pointer to the glyph found or null if X/Y is not on
1976 text, or we can't tell because W's current matrix is not up to
1979 static struct glyph
*
1980 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1981 int *dx
, int *dy
, int *area
)
1983 struct glyph
*glyph
, *end
;
1984 struct glyph_row
*row
= NULL
;
1987 /* Find row containing Y. Give up if some row is not enabled. */
1988 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1990 row
= MATRIX_ROW (w
->current_matrix
, i
);
1991 if (!row
->enabled_p
)
1993 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
2000 /* Give up if Y is not in the window. */
2001 if (i
== w
->current_matrix
->nrows
)
2004 /* Get the glyph area containing X. */
2005 if (w
->pseudo_window_p
)
2012 if (x
< window_box_left_offset (w
, TEXT_AREA
))
2014 *area
= LEFT_MARGIN_AREA
;
2015 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
2017 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
2020 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
2024 *area
= RIGHT_MARGIN_AREA
;
2025 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
2029 /* Find glyph containing X. */
2030 glyph
= row
->glyphs
[*area
];
2031 end
= glyph
+ row
->used
[*area
];
2033 while (glyph
< end
&& x
>= glyph
->pixel_width
)
2035 x
-= glyph
->pixel_width
;
2045 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
2048 *hpos
= glyph
- row
->glyphs
[*area
];
2052 /* Convert frame-relative x/y to coordinates relative to window W.
2053 Takes pseudo-windows into account. */
2056 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
2058 if (w
->pseudo_window_p
)
2060 /* A pseudo-window is always full-width, and starts at the
2061 left edge of the frame, plus a frame border. */
2062 struct frame
*f
= XFRAME (w
->frame
);
2063 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
2064 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
2068 *x
-= WINDOW_LEFT_EDGE_X (w
);
2069 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
2073 #ifdef HAVE_WINDOW_SYSTEM
2076 Return in RECTS[] at most N clipping rectangles for glyph string S.
2077 Return the number of stored rectangles. */
2080 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
2087 if (s
->row
->full_width_p
)
2089 /* Draw full-width. X coordinates are relative to S->w->left_col. */
2090 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
2091 if (s
->row
->mode_line_p
)
2092 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
) - WINDOW_RIGHT_DIVIDER_WIDTH (s
->w
);
2094 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
);
2096 /* Unless displaying a mode or menu bar line, which are always
2097 fully visible, clip to the visible part of the row. */
2098 if (s
->w
->pseudo_window_p
)
2099 r
.height
= s
->row
->visible_height
;
2101 r
.height
= s
->height
;
2105 /* This is a text line that may be partially visible. */
2106 r
.x
= window_box_left (s
->w
, s
->area
);
2107 r
.width
= window_box_width (s
->w
, s
->area
);
2108 r
.height
= s
->row
->visible_height
;
2112 if (r
.x
< s
->clip_head
->x
)
2114 if (r
.width
>= s
->clip_head
->x
- r
.x
)
2115 r
.width
-= s
->clip_head
->x
- r
.x
;
2118 r
.x
= s
->clip_head
->x
;
2121 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
2123 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
2124 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
2129 /* If S draws overlapping rows, it's sufficient to use the top and
2130 bottom of the window for clipping because this glyph string
2131 intentionally draws over other lines. */
2132 if (s
->for_overlaps
)
2134 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2135 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2137 /* Alas, the above simple strategy does not work for the
2138 environments with anti-aliased text: if the same text is
2139 drawn onto the same place multiple times, it gets thicker.
2140 If the overlap we are processing is for the erased cursor, we
2141 take the intersection with the rectangle of the cursor. */
2142 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2144 XRectangle rc
, r_save
= r
;
2146 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2147 rc
.y
= s
->w
->phys_cursor
.y
;
2148 rc
.width
= s
->w
->phys_cursor_width
;
2149 rc
.height
= s
->w
->phys_cursor_height
;
2151 x_intersect_rectangles (&r_save
, &rc
, &r
);
2156 /* Don't use S->y for clipping because it doesn't take partially
2157 visible lines into account. For example, it can be negative for
2158 partially visible lines at the top of a window. */
2159 if (!s
->row
->full_width_p
2160 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2161 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2163 r
.y
= max (0, s
->row
->y
);
2166 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2168 /* If drawing the cursor, don't let glyph draw outside its
2169 advertised boundaries. Cleartype does this under some circumstances. */
2170 if (s
->hl
== DRAW_CURSOR
)
2172 struct glyph
*glyph
= s
->first_glyph
;
2177 r
.width
-= s
->x
- r
.x
;
2180 r
.width
= min (r
.width
, glyph
->pixel_width
);
2182 /* If r.y is below window bottom, ensure that we still see a cursor. */
2183 height
= min (glyph
->ascent
+ glyph
->descent
,
2184 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2185 max_y
= window_text_bottom_y (s
->w
) - height
;
2186 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2187 if (s
->ybase
- glyph
->ascent
> max_y
)
2194 /* Don't draw cursor glyph taller than our actual glyph. */
2195 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2196 if (height
< r
.height
)
2198 max_y
= r
.y
+ r
.height
;
2199 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2200 r
.height
= min (max_y
- r
.y
, height
);
2207 XRectangle r_save
= r
;
2209 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2213 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2214 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2216 #ifdef CONVERT_FROM_XRECT
2217 CONVERT_FROM_XRECT (r
, *rects
);
2225 /* If we are processing overlapping and allowed to return
2226 multiple clipping rectangles, we exclude the row of the glyph
2227 string from the clipping rectangle. This is to avoid drawing
2228 the same text on the environment with anti-aliasing. */
2229 #ifdef CONVERT_FROM_XRECT
2232 XRectangle
*rs
= rects
;
2234 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2236 if (s
->for_overlaps
& OVERLAPS_PRED
)
2239 if (r
.y
+ r
.height
> row_y
)
2242 rs
[i
].height
= row_y
- r
.y
;
2248 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2251 if (r
.y
< row_y
+ s
->row
->visible_height
)
2253 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2255 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2256 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2265 #ifdef CONVERT_FROM_XRECT
2266 for (i
= 0; i
< n
; i
++)
2267 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2274 Return in *NR the clipping rectangle for glyph string S. */
2277 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2279 get_glyph_string_clip_rects (s
, nr
, 1);
2284 Return the position and height of the phys cursor in window W.
2285 Set w->phys_cursor_width to width of phys cursor.
2289 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2290 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2292 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2293 int x
, y
, wd
, h
, h0
, y0
;
2295 /* Compute the width of the rectangle to draw. If on a stretch
2296 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2297 rectangle as wide as the glyph, but use a canonical character
2299 wd
= glyph
->pixel_width
- 1;
2300 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2304 x
= w
->phys_cursor
.x
;
2311 if (glyph
->type
== STRETCH_GLYPH
2312 && !x_stretch_cursor_p
)
2313 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2314 w
->phys_cursor_width
= wd
;
2316 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2318 /* If y is below window bottom, ensure that we still see a cursor. */
2319 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2321 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2322 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2324 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2327 h
= max (h
- (y0
- y
) + 1, h0
);
2332 y0
= window_text_bottom_y (w
) - h0
;
2340 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2341 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2346 * Remember which glyph the mouse is over.
2350 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2354 struct glyph_row
*r
, *gr
, *end_row
;
2355 enum window_part part
;
2356 enum glyph_row_area area
;
2357 int x
, y
, width
, height
;
2359 /* Try to determine frame pixel position and size of the glyph under
2360 frame pixel coordinates X/Y on frame F. */
2362 if (window_resize_pixelwise
)
2367 else if (!f
->glyphs_initialized_p
2368 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2371 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2372 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2376 w
= XWINDOW (window
);
2377 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2378 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2380 x
= window_relative_x_coord (w
, part
, gx
);
2381 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2383 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2384 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2386 if (w
->pseudo_window_p
)
2389 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2395 case ON_LEFT_MARGIN
:
2396 area
= LEFT_MARGIN_AREA
;
2399 case ON_RIGHT_MARGIN
:
2400 area
= RIGHT_MARGIN_AREA
;
2403 case ON_HEADER_LINE
:
2405 gr
= (part
== ON_HEADER_LINE
2406 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2407 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2410 goto text_glyph_row_found
;
2417 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2418 if (r
->y
+ r
->height
> y
)
2424 text_glyph_row_found
:
2427 struct glyph
*g
= gr
->glyphs
[area
];
2428 struct glyph
*end
= g
+ gr
->used
[area
];
2430 height
= gr
->height
;
2431 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2432 if (gx
+ g
->pixel_width
> x
)
2437 if (g
->type
== IMAGE_GLYPH
)
2439 /* Don't remember when mouse is over image, as
2440 image may have hot-spots. */
2441 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2444 width
= g
->pixel_width
;
2448 /* Use nominal char spacing at end of line. */
2450 gx
+= (x
/ width
) * width
;
2453 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2455 gx
+= window_box_left_offset (w
, area
);
2456 /* Don't expand over the modeline to make sure the vertical
2457 drag cursor is shown early enough. */
2458 height
= min (height
,
2459 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2464 /* Use nominal line height at end of window. */
2465 gx
= (x
/ width
) * width
;
2467 gy
+= (y
/ height
) * height
;
2468 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2469 /* See comment above. */
2470 height
= min (height
,
2471 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2475 case ON_LEFT_FRINGE
:
2476 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2477 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2478 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2479 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2482 case ON_RIGHT_FRINGE
:
2483 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2484 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2485 : window_box_right_offset (w
, TEXT_AREA
));
2486 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0
2487 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
2488 && !WINDOW_RIGHTMOST_P (w
))
2489 if (gx
< WINDOW_PIXEL_WIDTH (w
) - width
)
2490 /* Make sure the vertical border can get her own glyph to the
2491 right of the one we build here. */
2492 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
) - width
;
2494 width
= WINDOW_PIXEL_WIDTH (w
) - gx
;
2496 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2500 case ON_VERTICAL_BORDER
:
2501 gx
= WINDOW_PIXEL_WIDTH (w
) - width
;
2505 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2507 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2508 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2509 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2511 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2515 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2516 if (r
->y
+ r
->height
> y
)
2523 height
= gr
->height
;
2526 /* Use nominal line height at end of window. */
2528 gy
+= (y
/ height
) * height
;
2532 case ON_RIGHT_DIVIDER
:
2533 gx
= WINDOW_PIXEL_WIDTH (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2534 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2536 /* The bottom divider prevails. */
2537 height
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2540 case ON_BOTTOM_DIVIDER
:
2542 width
= WINDOW_PIXEL_WIDTH (w
);
2543 gy
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2544 height
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2550 /* If there is no glyph under the mouse, then we divide the screen
2551 into a grid of the smallest glyph in the frame, and use that
2554 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2555 round down even for negative values. */
2561 gx
= (gx
/ width
) * width
;
2562 gy
= (gy
/ height
) * height
;
2568 gx
+= WINDOW_LEFT_EDGE_X (w
);
2569 gy
+= WINDOW_TOP_EDGE_Y (w
);
2572 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2574 /* Visible feedback for debugging. */
2577 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2578 f
->output_data
.x
->normal_gc
,
2579 gx
, gy
, width
, height
);
2585 #endif /* HAVE_WINDOW_SYSTEM */
2588 adjust_window_ends (struct window
*w
, struct glyph_row
*row
, bool current
)
2591 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
2592 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
2594 = MATRIX_ROW_VPOS (row
, current
? w
->current_matrix
: w
->desired_matrix
);
2597 /***********************************************************************
2598 Lisp form evaluation
2599 ***********************************************************************/
2601 /* Error handler for safe_eval and safe_call. */
2604 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2606 add_to_log ("Error during redisplay: %S signaled %S",
2607 Flist (nargs
, args
), arg
);
2611 /* Call function FUNC with the rest of NARGS - 1 arguments
2612 following. Return the result, or nil if something went
2613 wrong. Prevent redisplay during the evaluation. */
2616 safe__call (bool inhibit_quit
, ptrdiff_t nargs
, Lisp_Object func
, va_list ap
)
2620 if (inhibit_eval_during_redisplay
)
2625 ptrdiff_t count
= SPECPDL_INDEX ();
2626 struct gcpro gcpro1
;
2627 Lisp_Object
*args
= alloca (nargs
* word_size
);
2630 for (i
= 1; i
< nargs
; i
++)
2631 args
[i
] = va_arg (ap
, Lisp_Object
);
2634 gcpro1
.nvars
= nargs
;
2635 specbind (Qinhibit_redisplay
, Qt
);
2637 specbind (Qinhibit_quit
, Qt
);
2638 /* Use Qt to ensure debugger does not run,
2639 so there is no possibility of wanting to redisplay. */
2640 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2643 val
= unbind_to (count
, val
);
2650 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2655 va_start (ap
, func
);
2656 retval
= safe__call (false, nargs
, func
, ap
);
2661 /* Call function FN with one argument ARG.
2662 Return the result, or nil if something went wrong. */
2665 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2667 return safe_call (2, fn
, arg
);
2671 safe__call1 (bool inhibit_quit
, Lisp_Object fn
, ...)
2677 retval
= safe__call (inhibit_quit
, 2, fn
, ap
);
2682 static Lisp_Object Qeval
;
2685 safe_eval (Lisp_Object sexpr
)
2687 return safe__call1 (false, Qeval
, sexpr
);
2691 safe__eval (bool inhibit_quit
, Lisp_Object sexpr
)
2693 return safe__call1 (inhibit_quit
, Qeval
, sexpr
);
2696 /* Call function FN with two arguments ARG1 and ARG2.
2697 Return the result, or nil if something went wrong. */
2700 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2702 return safe_call (3, fn
, arg1
, arg2
);
2707 /***********************************************************************
2709 ***********************************************************************/
2713 /* Define CHECK_IT to perform sanity checks on iterators.
2714 This is for debugging. It is too slow to do unconditionally. */
2717 check_it (struct it
*it
)
2719 if (it
->method
== GET_FROM_STRING
)
2721 eassert (STRINGP (it
->string
));
2722 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2726 eassert (IT_STRING_CHARPOS (*it
) < 0);
2727 if (it
->method
== GET_FROM_BUFFER
)
2729 /* Check that character and byte positions agree. */
2730 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2735 eassert (it
->current
.dpvec_index
>= 0);
2737 eassert (it
->current
.dpvec_index
< 0);
2740 #define CHECK_IT(IT) check_it ((IT))
2744 #define CHECK_IT(IT) (void) 0
2749 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2751 /* Check that the window end of window W is what we expect it
2752 to be---the last row in the current matrix displaying text. */
2755 check_window_end (struct window
*w
)
2757 if (!MINI_WINDOW_P (w
) && w
->window_end_valid
)
2759 struct glyph_row
*row
;
2760 eassert ((row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
),
2762 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2763 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2767 #define CHECK_WINDOW_END(W) check_window_end ((W))
2771 #define CHECK_WINDOW_END(W) (void) 0
2773 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
2775 /***********************************************************************
2776 Iterator initialization
2777 ***********************************************************************/
2779 /* Initialize IT for displaying current_buffer in window W, starting
2780 at character position CHARPOS. CHARPOS < 0 means that no buffer
2781 position is specified which is useful when the iterator is assigned
2782 a position later. BYTEPOS is the byte position corresponding to
2785 If ROW is not null, calls to produce_glyphs with IT as parameter
2786 will produce glyphs in that row.
2788 BASE_FACE_ID is the id of a base face to use. It must be one of
2789 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2790 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2791 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2793 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2794 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2795 will be initialized to use the corresponding mode line glyph row of
2796 the desired matrix of W. */
2799 init_iterator (struct it
*it
, struct window
*w
,
2800 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2801 struct glyph_row
*row
, enum face_id base_face_id
)
2803 enum face_id remapped_base_face_id
= base_face_id
;
2805 /* Some precondition checks. */
2806 eassert (w
!= NULL
&& it
!= NULL
);
2807 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2810 /* If face attributes have been changed since the last redisplay,
2811 free realized faces now because they depend on face definitions
2812 that might have changed. Don't free faces while there might be
2813 desired matrices pending which reference these faces. */
2814 if (face_change_count
&& !inhibit_free_realized_faces
)
2816 face_change_count
= 0;
2817 free_all_realized_faces (Qnil
);
2820 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2821 if (! NILP (Vface_remapping_alist
))
2822 remapped_base_face_id
2823 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2825 /* Use one of the mode line rows of W's desired matrix if
2829 if (base_face_id
== MODE_LINE_FACE_ID
2830 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2831 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2832 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2833 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2837 memset (it
, 0, sizeof *it
);
2838 it
->current
.overlay_string_index
= -1;
2839 it
->current
.dpvec_index
= -1;
2840 it
->base_face_id
= remapped_base_face_id
;
2842 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2843 it
->paragraph_embedding
= L2R
;
2844 it
->bidi_it
.string
.lstring
= Qnil
;
2845 it
->bidi_it
.string
.s
= NULL
;
2846 it
->bidi_it
.string
.bufpos
= 0;
2849 /* The window in which we iterate over current_buffer: */
2850 XSETWINDOW (it
->window
, w
);
2852 it
->f
= XFRAME (w
->frame
);
2856 /* Extra space between lines (on window systems only). */
2857 if (base_face_id
== DEFAULT_FACE_ID
2858 && FRAME_WINDOW_P (it
->f
))
2860 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2861 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2862 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2863 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2864 * FRAME_LINE_HEIGHT (it
->f
));
2865 else if (it
->f
->extra_line_spacing
> 0)
2866 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2867 it
->max_extra_line_spacing
= 0;
2870 /* If realized faces have been removed, e.g. because of face
2871 attribute changes of named faces, recompute them. When running
2872 in batch mode, the face cache of the initial frame is null. If
2873 we happen to get called, make a dummy face cache. */
2874 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2875 init_frame_faces (it
->f
);
2876 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2877 recompute_basic_faces (it
->f
);
2879 /* Current value of the `slice', `space-width', and 'height' properties. */
2880 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2881 it
->space_width
= Qnil
;
2882 it
->font_height
= Qnil
;
2883 it
->override_ascent
= -1;
2885 /* Are control characters displayed as `^C'? */
2886 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2888 /* -1 means everything between a CR and the following line end
2889 is invisible. >0 means lines indented more than this value are
2891 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2893 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2895 : (!NILP (BVAR (current_buffer
, selective_display
))
2897 it
->selective_display_ellipsis_p
2898 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2900 /* Display table to use. */
2901 it
->dp
= window_display_table (w
);
2903 /* Are multibyte characters enabled in current_buffer? */
2904 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2906 /* Get the position at which the redisplay_end_trigger hook should
2907 be run, if it is to be run at all. */
2908 if (MARKERP (w
->redisplay_end_trigger
)
2909 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2910 it
->redisplay_end_trigger_charpos
2911 = marker_position (w
->redisplay_end_trigger
);
2912 else if (INTEGERP (w
->redisplay_end_trigger
))
2913 it
->redisplay_end_trigger_charpos
2914 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2917 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2919 /* Are lines in the display truncated? */
2920 if (base_face_id
!= DEFAULT_FACE_ID
2922 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2923 && ((!NILP (Vtruncate_partial_width_windows
)
2924 && !INTEGERP (Vtruncate_partial_width_windows
))
2925 || (INTEGERP (Vtruncate_partial_width_windows
)
2926 /* PXW: Shall we do something about this? */
2927 && (WINDOW_TOTAL_COLS (it
->w
)
2928 < XINT (Vtruncate_partial_width_windows
))))))
2929 it
->line_wrap
= TRUNCATE
;
2930 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2931 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2932 ? WINDOW_WRAP
: WORD_WRAP
;
2934 it
->line_wrap
= TRUNCATE
;
2936 /* Get dimensions of truncation and continuation glyphs. These are
2937 displayed as fringe bitmaps under X, but we need them for such
2938 frames when the fringes are turned off. But leave the dimensions
2939 zero for tooltip frames, as these glyphs look ugly there and also
2940 sabotage calculations of tooltip dimensions in x-show-tip. */
2941 #ifdef HAVE_WINDOW_SYSTEM
2942 if (!(FRAME_WINDOW_P (it
->f
)
2943 && FRAMEP (tip_frame
)
2944 && it
->f
== XFRAME (tip_frame
)))
2947 if (it
->line_wrap
== TRUNCATE
)
2949 /* We will need the truncation glyph. */
2950 eassert (it
->glyph_row
== NULL
);
2951 produce_special_glyphs (it
, IT_TRUNCATION
);
2952 it
->truncation_pixel_width
= it
->pixel_width
;
2956 /* We will need the continuation glyph. */
2957 eassert (it
->glyph_row
== NULL
);
2958 produce_special_glyphs (it
, IT_CONTINUATION
);
2959 it
->continuation_pixel_width
= it
->pixel_width
;
2963 /* Reset these values to zero because the produce_special_glyphs
2964 above has changed them. */
2965 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2966 it
->phys_ascent
= it
->phys_descent
= 0;
2968 /* Set this after getting the dimensions of truncation and
2969 continuation glyphs, so that we don't produce glyphs when calling
2970 produce_special_glyphs, above. */
2971 it
->glyph_row
= row
;
2972 it
->area
= TEXT_AREA
;
2974 /* Forget any previous info about this row being reversed. */
2976 it
->glyph_row
->reversed_p
= 0;
2978 /* Get the dimensions of the display area. The display area
2979 consists of the visible window area plus a horizontally scrolled
2980 part to the left of the window. All x-values are relative to the
2981 start of this total display area. */
2982 if (base_face_id
!= DEFAULT_FACE_ID
)
2984 /* Mode lines, menu bar in terminal frames. */
2985 it
->first_visible_x
= 0;
2986 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2991 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2992 it
->last_visible_x
= (it
->first_visible_x
2993 + window_box_width (w
, TEXT_AREA
));
2995 /* If we truncate lines, leave room for the truncation glyph(s) at
2996 the right margin. Otherwise, leave room for the continuation
2997 glyph(s). Done only if the window has no right fringe. */
2998 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
3000 if (it
->line_wrap
== TRUNCATE
)
3001 it
->last_visible_x
-= it
->truncation_pixel_width
;
3003 it
->last_visible_x
-= it
->continuation_pixel_width
;
3006 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
3007 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
3010 /* Leave room for a border glyph. */
3011 if (!FRAME_WINDOW_P (it
->f
)
3012 && !WINDOW_RIGHTMOST_P (it
->w
))
3013 it
->last_visible_x
-= 1;
3015 it
->last_visible_y
= window_text_bottom_y (w
);
3017 /* For mode lines and alike, arrange for the first glyph having a
3018 left box line if the face specifies a box. */
3019 if (base_face_id
!= DEFAULT_FACE_ID
)
3023 it
->face_id
= remapped_base_face_id
;
3025 /* If we have a boxed mode line, make the first character appear
3026 with a left box line. */
3027 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
3028 if (face
&& face
->box
!= FACE_NO_BOX
)
3029 it
->start_of_box_run_p
= true;
3032 /* If a buffer position was specified, set the iterator there,
3033 getting overlays and face properties from that position. */
3034 if (charpos
>= BUF_BEG (current_buffer
))
3036 it
->stop_charpos
= charpos
;
3037 it
->end_charpos
= ZV
;
3038 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
3039 IT_CHARPOS (*it
) = charpos
;
3040 IT_BYTEPOS (*it
) = bytepos
;
3042 /* We will rely on `reseat' to set this up properly, via
3043 handle_face_prop. */
3044 it
->face_id
= it
->base_face_id
;
3046 it
->start
= it
->current
;
3047 /* Do we need to reorder bidirectional text? Not if this is a
3048 unibyte buffer: by definition, none of the single-byte
3049 characters are strong R2L, so no reordering is needed. And
3050 bidi.c doesn't support unibyte buffers anyway. Also, don't
3051 reorder while we are loading loadup.el, since the tables of
3052 character properties needed for reordering are not yet
3056 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
3059 /* If we are to reorder bidirectional text, init the bidi
3063 /* Since we don't know at this point whether there will be
3064 any R2L lines in the window, we reserve space for
3065 truncation/continuation glyphs even if only the left
3066 fringe is absent. */
3067 if (base_face_id
== DEFAULT_FACE_ID
3068 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
3069 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
3071 if (it
->line_wrap
== TRUNCATE
)
3072 it
->last_visible_x
-= it
->truncation_pixel_width
;
3074 it
->last_visible_x
-= it
->continuation_pixel_width
;
3076 /* Note the paragraph direction that this buffer wants to
3078 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
3080 it
->paragraph_embedding
= L2R
;
3081 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
3083 it
->paragraph_embedding
= R2L
;
3085 it
->paragraph_embedding
= NEUTRAL_DIR
;
3086 bidi_unshelve_cache (NULL
, 0);
3087 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
3091 /* Compute faces etc. */
3092 reseat (it
, it
->current
.pos
, 1);
3099 /* Initialize IT for the display of window W with window start POS. */
3102 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
3104 struct glyph_row
*row
;
3105 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
3107 row
= w
->desired_matrix
->rows
+ first_vpos
;
3108 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
3109 it
->first_vpos
= first_vpos
;
3111 /* Don't reseat to previous visible line start if current start
3112 position is in a string or image. */
3113 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
3115 int start_at_line_beg_p
;
3116 int first_y
= it
->current_y
;
3118 /* If window start is not at a line start, skip forward to POS to
3119 get the correct continuation lines width. */
3120 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
3121 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
3122 if (!start_at_line_beg_p
)
3126 reseat_at_previous_visible_line_start (it
);
3127 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
3129 new_x
= it
->current_x
+ it
->pixel_width
;
3131 /* If lines are continued, this line may end in the middle
3132 of a multi-glyph character (e.g. a control character
3133 displayed as \003, or in the middle of an overlay
3134 string). In this case move_it_to above will not have
3135 taken us to the start of the continuation line but to the
3136 end of the continued line. */
3137 if (it
->current_x
> 0
3138 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
3139 && (/* And glyph doesn't fit on the line. */
3140 new_x
> it
->last_visible_x
3141 /* Or it fits exactly and we're on a window
3143 || (new_x
== it
->last_visible_x
3144 && FRAME_WINDOW_P (it
->f
)
3145 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
3146 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
3147 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
3149 if ((it
->current
.dpvec_index
>= 0
3150 || it
->current
.overlay_string_index
>= 0)
3151 /* If we are on a newline from a display vector or
3152 overlay string, then we are already at the end of
3153 a screen line; no need to go to the next line in
3154 that case, as this line is not really continued.
3155 (If we do go to the next line, C-e will not DTRT.) */
3158 set_iterator_to_next (it
, 1);
3159 move_it_in_display_line_to (it
, -1, -1, 0);
3162 it
->continuation_lines_width
+= it
->current_x
;
3164 /* If the character at POS is displayed via a display
3165 vector, move_it_to above stops at the final glyph of
3166 IT->dpvec. To make the caller redisplay that character
3167 again (a.k.a. start at POS), we need to reset the
3168 dpvec_index to the beginning of IT->dpvec. */
3169 else if (it
->current
.dpvec_index
>= 0)
3170 it
->current
.dpvec_index
= 0;
3172 /* We're starting a new display line, not affected by the
3173 height of the continued line, so clear the appropriate
3174 fields in the iterator structure. */
3175 it
->max_ascent
= it
->max_descent
= 0;
3176 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3178 it
->current_y
= first_y
;
3180 it
->current_x
= it
->hpos
= 0;
3186 /* Return 1 if POS is a position in ellipses displayed for invisible
3187 text. W is the window we display, for text property lookup. */
3190 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3192 Lisp_Object prop
, window
;
3194 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3196 /* If POS specifies a position in a display vector, this might
3197 be for an ellipsis displayed for invisible text. We won't
3198 get the iterator set up for delivering that ellipsis unless
3199 we make sure that it gets aware of the invisible text. */
3200 if (pos
->dpvec_index
>= 0
3201 && pos
->overlay_string_index
< 0
3202 && CHARPOS (pos
->string_pos
) < 0
3204 && (XSETWINDOW (window
, w
),
3205 prop
= Fget_char_property (make_number (charpos
),
3206 Qinvisible
, window
),
3207 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
3209 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3211 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3218 /* Initialize IT for stepping through current_buffer in window W,
3219 starting at position POS that includes overlay string and display
3220 vector/ control character translation position information. Value
3221 is zero if there are overlay strings with newlines at POS. */
3224 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3226 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3227 int i
, overlay_strings_with_newlines
= 0;
3229 /* If POS specifies a position in a display vector, this might
3230 be for an ellipsis displayed for invisible text. We won't
3231 get the iterator set up for delivering that ellipsis unless
3232 we make sure that it gets aware of the invisible text. */
3233 if (in_ellipses_for_invisible_text_p (pos
, w
))
3239 /* Keep in mind: the call to reseat in init_iterator skips invisible
3240 text, so we might end up at a position different from POS. This
3241 is only a problem when POS is a row start after a newline and an
3242 overlay starts there with an after-string, and the overlay has an
3243 invisible property. Since we don't skip invisible text in
3244 display_line and elsewhere immediately after consuming the
3245 newline before the row start, such a POS will not be in a string,
3246 but the call to init_iterator below will move us to the
3248 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3250 /* This only scans the current chunk -- it should scan all chunks.
3251 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3252 to 16 in 22.1 to make this a lesser problem. */
3253 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3255 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3256 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3258 while (s
< e
&& *s
!= '\n')
3263 overlay_strings_with_newlines
= 1;
3268 /* If position is within an overlay string, set up IT to the right
3270 if (pos
->overlay_string_index
>= 0)
3274 /* If the first overlay string happens to have a `display'
3275 property for an image, the iterator will be set up for that
3276 image, and we have to undo that setup first before we can
3277 correct the overlay string index. */
3278 if (it
->method
== GET_FROM_IMAGE
)
3281 /* We already have the first chunk of overlay strings in
3282 IT->overlay_strings. Load more until the one for
3283 pos->overlay_string_index is in IT->overlay_strings. */
3284 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3286 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3287 it
->current
.overlay_string_index
= 0;
3290 load_overlay_strings (it
, 0);
3291 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3295 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3296 relative_index
= (it
->current
.overlay_string_index
3297 % OVERLAY_STRING_CHUNK_SIZE
);
3298 it
->string
= it
->overlay_strings
[relative_index
];
3299 eassert (STRINGP (it
->string
));
3300 it
->current
.string_pos
= pos
->string_pos
;
3301 it
->method
= GET_FROM_STRING
;
3302 it
->end_charpos
= SCHARS (it
->string
);
3303 /* Set up the bidi iterator for this overlay string. */
3306 it
->bidi_it
.string
.lstring
= it
->string
;
3307 it
->bidi_it
.string
.s
= NULL
;
3308 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3309 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3310 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3311 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3312 it
->bidi_it
.w
= it
->w
;
3313 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3314 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3316 /* Synchronize the state of the bidi iterator with
3317 pos->string_pos. For any string position other than
3318 zero, this will be done automagically when we resume
3319 iteration over the string and get_visually_first_element
3320 is called. But if string_pos is zero, and the string is
3321 to be reordered for display, we need to resync manually,
3322 since it could be that the iteration state recorded in
3323 pos ended at string_pos of 0 moving backwards in string. */
3324 if (CHARPOS (pos
->string_pos
) == 0)
3326 get_visually_first_element (it
);
3327 if (IT_STRING_CHARPOS (*it
) != 0)
3330 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3331 bidi_move_to_visually_next (&it
->bidi_it
);
3332 } while (it
->bidi_it
.charpos
!= 0);
3334 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3335 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3339 if (CHARPOS (pos
->string_pos
) >= 0)
3341 /* Recorded position is not in an overlay string, but in another
3342 string. This can only be a string from a `display' property.
3343 IT should already be filled with that string. */
3344 it
->current
.string_pos
= pos
->string_pos
;
3345 eassert (STRINGP (it
->string
));
3347 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3348 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3351 /* Restore position in display vector translations, control
3352 character translations or ellipses. */
3353 if (pos
->dpvec_index
>= 0)
3355 if (it
->dpvec
== NULL
)
3356 get_next_display_element (it
);
3357 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3358 it
->current
.dpvec_index
= pos
->dpvec_index
;
3362 return !overlay_strings_with_newlines
;
3366 /* Initialize IT for stepping through current_buffer in window W
3367 starting at ROW->start. */
3370 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3372 init_from_display_pos (it
, w
, &row
->start
);
3373 it
->start
= row
->start
;
3374 it
->continuation_lines_width
= row
->continuation_lines_width
;
3379 /* Initialize IT for stepping through current_buffer in window W
3380 starting in the line following ROW, i.e. starting at ROW->end.
3381 Value is zero if there are overlay strings with newlines at ROW's
3385 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3389 if (init_from_display_pos (it
, w
, &row
->end
))
3391 if (row
->continued_p
)
3392 it
->continuation_lines_width
3393 = row
->continuation_lines_width
+ row
->pixel_width
;
3404 /***********************************************************************
3406 ***********************************************************************/
3408 /* Called when IT reaches IT->stop_charpos. Handle text property and
3409 overlay changes. Set IT->stop_charpos to the next position where
3413 handle_stop (struct it
*it
)
3415 enum prop_handled handled
;
3416 int handle_overlay_change_p
;
3420 it
->current
.dpvec_index
= -1;
3421 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3422 it
->ignore_overlay_strings_at_pos_p
= 0;
3425 /* Use face of preceding text for ellipsis (if invisible) */
3426 if (it
->selective_display_ellipsis_p
)
3427 it
->saved_face_id
= it
->face_id
;
3429 /* Here's the description of the semantics of, and the logic behind,
3430 the various HANDLED_* statuses:
3432 HANDLED_NORMALLY means the handler did its job, and the loop
3433 should proceed to calling the next handler in order.
3435 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3436 change in the properties and overlays at current position, so the
3437 loop should be restarted, to re-invoke the handlers that were
3438 already called. This happens when fontification-functions were
3439 called by handle_fontified_prop, and actually fontified
3440 something. Another case where HANDLED_RECOMPUTE_PROPS is
3441 returned is when we discover overlay strings that need to be
3442 displayed right away. The loop below will continue for as long
3443 as the status is HANDLED_RECOMPUTE_PROPS.
3445 HANDLED_RETURN means return immediately to the caller, to
3446 continue iteration without calling any further handlers. This is
3447 used when we need to act on some property right away, for example
3448 when we need to display the ellipsis or a replacing display
3449 property, such as display string or image.
3451 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3452 consumed, and the handler switched to the next overlay string.
3453 This signals the loop below to refrain from looking for more
3454 overlays before all the overlay strings of the current overlay
3457 Some of the handlers called by the loop push the iterator state
3458 onto the stack (see 'push_it'), and arrange for the iteration to
3459 continue with another object, such as an image, a display string,
3460 or an overlay string. In most such cases, it->stop_charpos is
3461 set to the first character of the string, so that when the
3462 iteration resumes, this function will immediately be called
3463 again, to examine the properties at the beginning of the string.
3465 When a display or overlay string is exhausted, the iterator state
3466 is popped (see 'pop_it'), and iteration continues with the
3467 previous object. Again, in many such cases this function is
3468 called again to find the next position where properties might
3473 handled
= HANDLED_NORMALLY
;
3475 /* Call text property handlers. */
3476 for (p
= it_props
; p
->handler
; ++p
)
3478 handled
= p
->handler (it
);
3480 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3482 else if (handled
== HANDLED_RETURN
)
3484 /* We still want to show before and after strings from
3485 overlays even if the actual buffer text is replaced. */
3486 if (!handle_overlay_change_p
3488 /* Don't call get_overlay_strings_1 if we already
3489 have overlay strings loaded, because doing so
3490 will load them again and push the iterator state
3491 onto the stack one more time, which is not
3492 expected by the rest of the code that processes
3494 || (it
->current
.overlay_string_index
< 0
3495 ? !get_overlay_strings_1 (it
, 0, 0)
3499 setup_for_ellipsis (it
, 0);
3500 /* When handling a display spec, we might load an
3501 empty string. In that case, discard it here. We
3502 used to discard it in handle_single_display_spec,
3503 but that causes get_overlay_strings_1, above, to
3504 ignore overlay strings that we must check. */
3505 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3509 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3513 it
->ignore_overlay_strings_at_pos_p
= true;
3514 it
->string_from_display_prop_p
= 0;
3515 it
->from_disp_prop_p
= 0;
3516 handle_overlay_change_p
= 0;
3518 handled
= HANDLED_RECOMPUTE_PROPS
;
3521 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3522 handle_overlay_change_p
= 0;
3525 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3527 /* Don't check for overlay strings below when set to deliver
3528 characters from a display vector. */
3529 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3530 handle_overlay_change_p
= 0;
3532 /* Handle overlay changes.
3533 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3534 if it finds overlays. */
3535 if (handle_overlay_change_p
)
3536 handled
= handle_overlay_change (it
);
3541 setup_for_ellipsis (it
, 0);
3545 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3547 /* Determine where to stop next. */
3548 if (handled
== HANDLED_NORMALLY
)
3549 compute_stop_pos (it
);
3553 /* Compute IT->stop_charpos from text property and overlay change
3554 information for IT's current position. */
3557 compute_stop_pos (struct it
*it
)
3559 register INTERVAL iv
, next_iv
;
3560 Lisp_Object object
, limit
, position
;
3561 ptrdiff_t charpos
, bytepos
;
3563 if (STRINGP (it
->string
))
3565 /* Strings are usually short, so don't limit the search for
3567 it
->stop_charpos
= it
->end_charpos
;
3568 object
= it
->string
;
3570 charpos
= IT_STRING_CHARPOS (*it
);
3571 bytepos
= IT_STRING_BYTEPOS (*it
);
3577 /* If end_charpos is out of range for some reason, such as a
3578 misbehaving display function, rationalize it (Bug#5984). */
3579 if (it
->end_charpos
> ZV
)
3580 it
->end_charpos
= ZV
;
3581 it
->stop_charpos
= it
->end_charpos
;
3583 /* If next overlay change is in front of the current stop pos
3584 (which is IT->end_charpos), stop there. Note: value of
3585 next_overlay_change is point-max if no overlay change
3587 charpos
= IT_CHARPOS (*it
);
3588 bytepos
= IT_BYTEPOS (*it
);
3589 pos
= next_overlay_change (charpos
);
3590 if (pos
< it
->stop_charpos
)
3591 it
->stop_charpos
= pos
;
3593 /* Set up variables for computing the stop position from text
3594 property changes. */
3595 XSETBUFFER (object
, current_buffer
);
3596 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3599 /* Get the interval containing IT's position. Value is a null
3600 interval if there isn't such an interval. */
3601 position
= make_number (charpos
);
3602 iv
= validate_interval_range (object
, &position
, &position
, 0);
3605 Lisp_Object values_here
[LAST_PROP_IDX
];
3608 /* Get properties here. */
3609 for (p
= it_props
; p
->handler
; ++p
)
3610 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3612 /* Look for an interval following iv that has different
3614 for (next_iv
= next_interval (iv
);
3617 || XFASTINT (limit
) > next_iv
->position
));
3618 next_iv
= next_interval (next_iv
))
3620 for (p
= it_props
; p
->handler
; ++p
)
3622 Lisp_Object new_value
;
3624 new_value
= textget (next_iv
->plist
, *p
->name
);
3625 if (!EQ (values_here
[p
->idx
], new_value
))
3635 if (INTEGERP (limit
)
3636 && next_iv
->position
>= XFASTINT (limit
))
3637 /* No text property change up to limit. */
3638 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3640 /* Text properties change in next_iv. */
3641 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3645 if (it
->cmp_it
.id
< 0)
3647 ptrdiff_t stoppos
= it
->end_charpos
;
3649 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3651 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3652 stoppos
, it
->string
);
3655 eassert (STRINGP (it
->string
)
3656 || (it
->stop_charpos
>= BEGV
3657 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3661 /* Return the position of the next overlay change after POS in
3662 current_buffer. Value is point-max if no overlay change
3663 follows. This is like `next-overlay-change' but doesn't use
3667 next_overlay_change (ptrdiff_t pos
)
3669 ptrdiff_t i
, noverlays
;
3671 Lisp_Object
*overlays
;
3673 /* Get all overlays at the given position. */
3674 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3676 /* If any of these overlays ends before endpos,
3677 use its ending point instead. */
3678 for (i
= 0; i
< noverlays
; ++i
)
3683 oend
= OVERLAY_END (overlays
[i
]);
3684 oendpos
= OVERLAY_POSITION (oend
);
3685 endpos
= min (endpos
, oendpos
);
3691 /* How many characters forward to search for a display property or
3692 display string. Searching too far forward makes the bidi display
3693 sluggish, especially in small windows. */
3694 #define MAX_DISP_SCAN 250
3696 /* Return the character position of a display string at or after
3697 position specified by POSITION. If no display string exists at or
3698 after POSITION, return ZV. A display string is either an overlay
3699 with `display' property whose value is a string, or a `display'
3700 text property whose value is a string. STRING is data about the
3701 string to iterate; if STRING->lstring is nil, we are iterating a
3702 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3703 on a GUI frame. DISP_PROP is set to zero if we searched
3704 MAX_DISP_SCAN characters forward without finding any display
3705 strings, non-zero otherwise. It is set to 2 if the display string
3706 uses any kind of `(space ...)' spec that will produce a stretch of
3707 white space in the text area. */
3709 compute_display_string_pos (struct text_pos
*position
,
3710 struct bidi_string_data
*string
,
3712 int frame_window_p
, int *disp_prop
)
3714 /* OBJECT = nil means current buffer. */
3715 Lisp_Object object
, object1
;
3716 Lisp_Object pos
, spec
, limpos
;
3717 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3718 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3719 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3720 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3722 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3723 struct text_pos tpos
;
3726 if (string
&& STRINGP (string
->lstring
))
3727 object1
= object
= string
->lstring
;
3728 else if (w
&& !string_p
)
3730 XSETWINDOW (object
, w
);
3734 object1
= object
= Qnil
;
3739 /* We don't support display properties whose values are strings
3740 that have display string properties. */
3741 || string
->from_disp_str
3742 /* C strings cannot have display properties. */
3743 || (string
->s
&& !STRINGP (object
)))
3749 /* If the character at CHARPOS is where the display string begins,
3751 pos
= make_number (charpos
);
3752 if (STRINGP (object
))
3753 bufpos
= string
->bufpos
;
3757 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3759 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3762 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3770 /* Look forward for the first character with a `display' property
3771 that will replace the underlying text when displayed. */
3772 limpos
= make_number (lim
);
3774 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3775 CHARPOS (tpos
) = XFASTINT (pos
);
3776 if (CHARPOS (tpos
) >= lim
)
3781 if (STRINGP (object
))
3782 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3784 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3785 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3786 if (!STRINGP (object
))
3787 bufpos
= CHARPOS (tpos
);
3788 } while (NILP (spec
)
3789 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3790 bufpos
, frame_window_p
)));
3794 return CHARPOS (tpos
);
3797 /* Return the character position of the end of the display string that
3798 started at CHARPOS. If there's no display string at CHARPOS,
3799 return -1. A display string is either an overlay with `display'
3800 property whose value is a string or a `display' text property whose
3801 value is a string. */
3803 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3805 /* OBJECT = nil means current buffer. */
3806 Lisp_Object object
=
3807 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3808 Lisp_Object pos
= make_number (charpos
);
3810 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3812 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3815 /* It could happen that the display property or overlay was removed
3816 since we found it in compute_display_string_pos above. One way
3817 this can happen is if JIT font-lock was called (through
3818 handle_fontified_prop), and jit-lock-functions remove text
3819 properties or overlays from the portion of buffer that includes
3820 CHARPOS. Muse mode is known to do that, for example. In this
3821 case, we return -1 to the caller, to signal that no display
3822 string is actually present at CHARPOS. See bidi_fetch_char for
3823 how this is handled.
3825 An alternative would be to never look for display properties past
3826 it->stop_charpos. But neither compute_display_string_pos nor
3827 bidi_fetch_char that calls it know or care where the next
3829 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3832 /* Look forward for the first character where the `display' property
3834 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3836 return XFASTINT (pos
);
3841 /***********************************************************************
3843 ***********************************************************************/
3845 /* Handle changes in the `fontified' property of the current buffer by
3846 calling hook functions from Qfontification_functions to fontify
3849 static enum prop_handled
3850 handle_fontified_prop (struct it
*it
)
3852 Lisp_Object prop
, pos
;
3853 enum prop_handled handled
= HANDLED_NORMALLY
;
3855 if (!NILP (Vmemory_full
))
3858 /* Get the value of the `fontified' property at IT's current buffer
3859 position. (The `fontified' property doesn't have a special
3860 meaning in strings.) If the value is nil, call functions from
3861 Qfontification_functions. */
3862 if (!STRINGP (it
->string
)
3864 && !NILP (Vfontification_functions
)
3865 && !NILP (Vrun_hooks
)
3866 && (pos
= make_number (IT_CHARPOS (*it
)),
3867 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3868 /* Ignore the special cased nil value always present at EOB since
3869 no amount of fontifying will be able to change it. */
3870 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3872 ptrdiff_t count
= SPECPDL_INDEX ();
3874 struct buffer
*obuf
= current_buffer
;
3875 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3876 bool old_clip_changed
= current_buffer
->clip_changed
;
3878 val
= Vfontification_functions
;
3879 specbind (Qfontification_functions
, Qnil
);
3881 eassert (it
->end_charpos
== ZV
);
3883 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3884 safe_call1 (val
, pos
);
3887 Lisp_Object fns
, fn
;
3888 struct gcpro gcpro1
, gcpro2
;
3893 for (; CONSP (val
); val
= XCDR (val
))
3899 /* A value of t indicates this hook has a local
3900 binding; it means to run the global binding too.
3901 In a global value, t should not occur. If it
3902 does, we must ignore it to avoid an endless
3904 for (fns
= Fdefault_value (Qfontification_functions
);
3910 safe_call1 (fn
, pos
);
3914 safe_call1 (fn
, pos
);
3920 unbind_to (count
, Qnil
);
3922 /* Fontification functions routinely call `save-restriction'.
3923 Normally, this tags clip_changed, which can confuse redisplay
3924 (see discussion in Bug#6671). Since we don't perform any
3925 special handling of fontification changes in the case where
3926 `save-restriction' isn't called, there's no point doing so in
3927 this case either. So, if the buffer's restrictions are
3928 actually left unchanged, reset clip_changed. */
3929 if (obuf
== current_buffer
)
3931 if (begv
== BEGV
&& zv
== ZV
)
3932 current_buffer
->clip_changed
= old_clip_changed
;
3934 /* There isn't much we can reasonably do to protect against
3935 misbehaving fontification, but here's a fig leaf. */
3936 else if (BUFFER_LIVE_P (obuf
))
3937 set_buffer_internal_1 (obuf
);
3939 /* The fontification code may have added/removed text.
3940 It could do even a lot worse, but let's at least protect against
3941 the most obvious case where only the text past `pos' gets changed',
3942 as is/was done in grep.el where some escapes sequences are turned
3943 into face properties (bug#7876). */
3944 it
->end_charpos
= ZV
;
3946 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3947 something. This avoids an endless loop if they failed to
3948 fontify the text for which reason ever. */
3949 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3950 handled
= HANDLED_RECOMPUTE_PROPS
;
3958 /***********************************************************************
3960 ***********************************************************************/
3962 /* Set up iterator IT from face properties at its current position.
3963 Called from handle_stop. */
3965 static enum prop_handled
3966 handle_face_prop (struct it
*it
)
3969 ptrdiff_t next_stop
;
3971 if (!STRINGP (it
->string
))
3974 = face_at_buffer_position (it
->w
,
3978 + TEXT_PROP_DISTANCE_LIMIT
),
3979 0, it
->base_face_id
);
3981 /* Is this a start of a run of characters with box face?
3982 Caveat: this can be called for a freshly initialized
3983 iterator; face_id is -1 in this case. We know that the new
3984 face will not change until limit, i.e. if the new face has a
3985 box, all characters up to limit will have one. But, as
3986 usual, we don't know whether limit is really the end. */
3987 if (new_face_id
!= it
->face_id
)
3989 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3990 /* If it->face_id is -1, old_face below will be NULL, see
3991 the definition of FACE_FROM_ID. This will happen if this
3992 is the initial call that gets the face. */
3993 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3995 /* If the value of face_id of the iterator is -1, we have to
3996 look in front of IT's position and see whether there is a
3997 face there that's different from new_face_id. */
3998 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
4000 int prev_face_id
= face_before_it_pos (it
);
4002 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
4005 /* If the new face has a box, but the old face does not,
4006 this is the start of a run of characters with box face,
4007 i.e. this character has a shadow on the left side. */
4008 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
4009 && (old_face
== NULL
|| !old_face
->box
));
4010 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4018 Lisp_Object from_overlay
4019 = (it
->current
.overlay_string_index
>= 0
4020 ? it
->string_overlays
[it
->current
.overlay_string_index
4021 % OVERLAY_STRING_CHUNK_SIZE
]
4024 /* See if we got to this string directly or indirectly from
4025 an overlay property. That includes the before-string or
4026 after-string of an overlay, strings in display properties
4027 provided by an overlay, their text properties, etc.
4029 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
4030 if (! NILP (from_overlay
))
4031 for (i
= it
->sp
- 1; i
>= 0; i
--)
4033 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
4035 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
4036 % OVERLAY_STRING_CHUNK_SIZE
];
4037 else if (! NILP (it
->stack
[i
].from_overlay
))
4038 from_overlay
= it
->stack
[i
].from_overlay
;
4040 if (!NILP (from_overlay
))
4044 if (! NILP (from_overlay
))
4046 bufpos
= IT_CHARPOS (*it
);
4047 /* For a string from an overlay, the base face depends
4048 only on text properties and ignores overlays. */
4050 = face_for_overlay_string (it
->w
,
4054 + TEXT_PROP_DISTANCE_LIMIT
),
4062 /* For strings from a `display' property, use the face at
4063 IT's current buffer position as the base face to merge
4064 with, so that overlay strings appear in the same face as
4065 surrounding text, unless they specify their own faces.
4066 For strings from wrap-prefix and line-prefix properties,
4067 use the default face, possibly remapped via
4068 Vface_remapping_alist. */
4069 /* Note that the fact that we use the face at _buffer_
4070 position means that a 'display' property on an overlay
4071 string will not inherit the face of that overlay string,
4072 but will instead revert to the face of buffer text
4073 covered by the overlay. This is visible, e.g., when the
4074 overlay specifies a box face, but neither the buffer nor
4075 the display string do. This sounds like a design bug,
4076 but Emacs always did that since v21.1, so changing that
4077 might be a big deal. */
4078 base_face_id
= it
->string_from_prefix_prop_p
4079 ? (!NILP (Vface_remapping_alist
)
4080 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
4082 : underlying_face_id (it
);
4085 new_face_id
= face_at_string_position (it
->w
,
4087 IT_STRING_CHARPOS (*it
),
4092 /* Is this a start of a run of characters with box? Caveat:
4093 this can be called for a freshly allocated iterator; face_id
4094 is -1 is this case. We know that the new face will not
4095 change until the next check pos, i.e. if the new face has a
4096 box, all characters up to that position will have a
4097 box. But, as usual, we don't know whether that position
4098 is really the end. */
4099 if (new_face_id
!= it
->face_id
)
4101 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
4102 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4104 /* If new face has a box but old face hasn't, this is the
4105 start of a run of characters with box, i.e. it has a
4106 shadow on the left side. */
4107 it
->start_of_box_run_p
4108 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
4109 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4113 it
->face_id
= new_face_id
;
4114 return HANDLED_NORMALLY
;
4118 /* Return the ID of the face ``underlying'' IT's current position,
4119 which is in a string. If the iterator is associated with a
4120 buffer, return the face at IT's current buffer position.
4121 Otherwise, use the iterator's base_face_id. */
4124 underlying_face_id (struct it
*it
)
4126 int face_id
= it
->base_face_id
, i
;
4128 eassert (STRINGP (it
->string
));
4130 for (i
= it
->sp
- 1; i
>= 0; --i
)
4131 if (NILP (it
->stack
[i
].string
))
4132 face_id
= it
->stack
[i
].face_id
;
4138 /* Compute the face one character before or after the current position
4139 of IT, in the visual order. BEFORE_P non-zero means get the face
4140 in front (to the left in L2R paragraphs, to the right in R2L
4141 paragraphs) of IT's screen position. Value is the ID of the face. */
4144 face_before_or_after_it_pos (struct it
*it
, int before_p
)
4147 ptrdiff_t next_check_charpos
;
4149 void *it_copy_data
= NULL
;
4151 eassert (it
->s
== NULL
);
4153 if (STRINGP (it
->string
))
4155 ptrdiff_t bufpos
, charpos
;
4158 /* No face change past the end of the string (for the case
4159 we are padding with spaces). No face change before the
4161 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4162 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4167 /* Set charpos to the position before or after IT's current
4168 position, in the logical order, which in the non-bidi
4169 case is the same as the visual order. */
4171 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4172 else if (it
->what
== IT_COMPOSITION
)
4173 /* For composition, we must check the character after the
4175 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4177 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4183 /* With bidi iteration, the character before the current
4184 in the visual order cannot be found by simple
4185 iteration, because "reverse" reordering is not
4186 supported. Instead, we need to use the move_it_*
4187 family of functions. */
4188 /* Ignore face changes before the first visible
4189 character on this display line. */
4190 if (it
->current_x
<= it
->first_visible_x
)
4192 SAVE_IT (it_copy
, *it
, it_copy_data
);
4193 /* Implementation note: Since move_it_in_display_line
4194 works in the iterator geometry, and thinks the first
4195 character is always the leftmost, even in R2L lines,
4196 we don't need to distinguish between the R2L and L2R
4198 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
4199 it_copy
.current_x
- 1, MOVE_TO_X
);
4200 charpos
= IT_STRING_CHARPOS (it_copy
);
4201 RESTORE_IT (it
, it
, it_copy_data
);
4205 /* Set charpos to the string position of the character
4206 that comes after IT's current position in the visual
4208 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4212 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4214 charpos
= it_copy
.bidi_it
.charpos
;
4217 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4219 if (it
->current
.overlay_string_index
>= 0)
4220 bufpos
= IT_CHARPOS (*it
);
4224 base_face_id
= underlying_face_id (it
);
4226 /* Get the face for ASCII, or unibyte. */
4227 face_id
= face_at_string_position (it
->w
,
4231 &next_check_charpos
,
4234 /* Correct the face for charsets different from ASCII. Do it
4235 for the multibyte case only. The face returned above is
4236 suitable for unibyte text if IT->string is unibyte. */
4237 if (STRING_MULTIBYTE (it
->string
))
4239 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4240 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4242 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4244 c
= string_char_and_length (p
, &len
);
4245 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4250 struct text_pos pos
;
4252 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4253 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4256 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4257 pos
= it
->current
.pos
;
4262 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4265 if (it
->what
== IT_COMPOSITION
)
4267 /* For composition, we must check the position after
4269 pos
.charpos
+= it
->cmp_it
.nchars
;
4270 pos
.bytepos
+= it
->len
;
4273 INC_TEXT_POS (pos
, it
->multibyte_p
);
4280 /* With bidi iteration, the character before the current
4281 in the visual order cannot be found by simple
4282 iteration, because "reverse" reordering is not
4283 supported. Instead, we need to use the move_it_*
4284 family of functions. */
4285 /* Ignore face changes before the first visible
4286 character on this display line. */
4287 if (it
->current_x
<= it
->first_visible_x
)
4289 SAVE_IT (it_copy
, *it
, it_copy_data
);
4290 /* Implementation note: Since move_it_in_display_line
4291 works in the iterator geometry, and thinks the first
4292 character is always the leftmost, even in R2L lines,
4293 we don't need to distinguish between the R2L and L2R
4295 move_it_in_display_line (&it_copy
, ZV
,
4296 it_copy
.current_x
- 1, MOVE_TO_X
);
4297 pos
= it_copy
.current
.pos
;
4298 RESTORE_IT (it
, it
, it_copy_data
);
4302 /* Set charpos to the buffer position of the character
4303 that comes after IT's current position in the visual
4305 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4309 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4312 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4315 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4317 /* Determine face for CHARSET_ASCII, or unibyte. */
4318 face_id
= face_at_buffer_position (it
->w
,
4320 &next_check_charpos
,
4323 /* Correct the face for charsets different from ASCII. Do it
4324 for the multibyte case only. The face returned above is
4325 suitable for unibyte text if current_buffer is unibyte. */
4326 if (it
->multibyte_p
)
4328 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4329 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4330 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4339 /***********************************************************************
4341 ***********************************************************************/
4343 /* Set up iterator IT from invisible properties at its current
4344 position. Called from handle_stop. */
4346 static enum prop_handled
4347 handle_invisible_prop (struct it
*it
)
4349 enum prop_handled handled
= HANDLED_NORMALLY
;
4353 if (STRINGP (it
->string
))
4355 Lisp_Object end_charpos
, limit
, charpos
;
4357 /* Get the value of the invisible text property at the
4358 current position. Value will be nil if there is no such
4360 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4361 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4362 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4364 if (invis_p
&& IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4366 /* Record whether we have to display an ellipsis for the
4368 int display_ellipsis_p
= (invis_p
== 2);
4369 ptrdiff_t len
, endpos
;
4371 handled
= HANDLED_RECOMPUTE_PROPS
;
4373 /* Get the position at which the next visible text can be
4374 found in IT->string, if any. */
4375 endpos
= len
= SCHARS (it
->string
);
4376 XSETINT (limit
, len
);
4379 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4381 if (INTEGERP (end_charpos
))
4383 endpos
= XFASTINT (end_charpos
);
4384 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4385 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4387 display_ellipsis_p
= true;
4390 while (invis_p
&& endpos
< len
);
4392 if (display_ellipsis_p
)
4393 it
->ellipsis_p
= true;
4397 /* Text at END_CHARPOS is visible. Move IT there. */
4398 struct text_pos old
;
4401 old
= it
->current
.string_pos
;
4402 oldpos
= CHARPOS (old
);
4405 if (it
->bidi_it
.first_elt
4406 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4407 bidi_paragraph_init (it
->paragraph_embedding
,
4409 /* Bidi-iterate out of the invisible text. */
4412 bidi_move_to_visually_next (&it
->bidi_it
);
4414 while (oldpos
<= it
->bidi_it
.charpos
4415 && it
->bidi_it
.charpos
< endpos
);
4417 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4418 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4419 if (IT_CHARPOS (*it
) >= endpos
)
4420 it
->prev_stop
= endpos
;
4424 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4425 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4430 /* The rest of the string is invisible. If this is an
4431 overlay string, proceed with the next overlay string
4432 or whatever comes and return a character from there. */
4433 if (it
->current
.overlay_string_index
>= 0
4434 && !display_ellipsis_p
)
4436 next_overlay_string (it
);
4437 /* Don't check for overlay strings when we just
4438 finished processing them. */
4439 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4443 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4444 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4451 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4452 Lisp_Object pos
, overlay
;
4454 /* First of all, is there invisible text at this position? */
4455 tem
= start_charpos
= IT_CHARPOS (*it
);
4456 pos
= make_number (tem
);
4457 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4459 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4461 /* If we are on invisible text, skip over it. */
4462 if (invis_p
&& start_charpos
< it
->end_charpos
)
4464 /* Record whether we have to display an ellipsis for the
4466 int display_ellipsis_p
= invis_p
== 2;
4468 handled
= HANDLED_RECOMPUTE_PROPS
;
4470 /* Loop skipping over invisible text. The loop is left at
4471 ZV or with IT on the first char being visible again. */
4474 /* Try to skip some invisible text. Return value is the
4475 position reached which can be equal to where we start
4476 if there is nothing invisible there. This skips both
4477 over invisible text properties and overlays with
4478 invisible property. */
4479 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4481 /* If we skipped nothing at all we weren't at invisible
4482 text in the first place. If everything to the end of
4483 the buffer was skipped, end the loop. */
4484 if (newpos
== tem
|| newpos
>= ZV
)
4488 /* We skipped some characters but not necessarily
4489 all there are. Check if we ended up on visible
4490 text. Fget_char_property returns the property of
4491 the char before the given position, i.e. if we
4492 get invis_p = 0, this means that the char at
4493 newpos is visible. */
4494 pos
= make_number (newpos
);
4495 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4496 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4499 /* If we ended up on invisible text, proceed to
4500 skip starting with next_stop. */
4504 /* If there are adjacent invisible texts, don't lose the
4505 second one's ellipsis. */
4507 display_ellipsis_p
= true;
4511 /* The position newpos is now either ZV or on visible text. */
4514 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4516 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4518 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4520 /* If the invisible text ends on a newline or on a
4521 character after a newline, we can avoid the costly,
4522 character by character, bidi iteration to NEWPOS, and
4523 instead simply reseat the iterator there. That's
4524 because all bidi reordering information is tossed at
4525 the newline. This is a big win for modes that hide
4526 complete lines, like Outline, Org, etc. */
4527 if (on_newline
|| after_newline
)
4529 struct text_pos tpos
;
4530 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4532 SET_TEXT_POS (tpos
, newpos
, bpos
);
4533 reseat_1 (it
, tpos
, 0);
4534 /* If we reseat on a newline/ZV, we need to prep the
4535 bidi iterator for advancing to the next character
4536 after the newline/EOB, keeping the current paragraph
4537 direction (so that PRODUCE_GLYPHS does TRT wrt
4538 prepending/appending glyphs to a glyph row). */
4541 it
->bidi_it
.first_elt
= 0;
4542 it
->bidi_it
.paragraph_dir
= pdir
;
4543 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4544 it
->bidi_it
.nchars
= 1;
4545 it
->bidi_it
.ch_len
= 1;
4548 else /* Must use the slow method. */
4550 /* With bidi iteration, the region of invisible text
4551 could start and/or end in the middle of a
4552 non-base embedding level. Therefore, we need to
4553 skip invisible text using the bidi iterator,
4554 starting at IT's current position, until we find
4555 ourselves outside of the invisible text.
4556 Skipping invisible text _after_ bidi iteration
4557 avoids affecting the visual order of the
4558 displayed text when invisible properties are
4559 added or removed. */
4560 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4562 /* If we were `reseat'ed to a new paragraph,
4563 determine the paragraph base direction. We
4564 need to do it now because
4565 next_element_from_buffer may not have a
4566 chance to do it, if we are going to skip any
4567 text at the beginning, which resets the
4569 bidi_paragraph_init (it
->paragraph_embedding
,
4574 bidi_move_to_visually_next (&it
->bidi_it
);
4576 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4577 && it
->bidi_it
.charpos
< newpos
);
4578 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4579 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4580 /* If we overstepped NEWPOS, record its position in
4581 the iterator, so that we skip invisible text if
4582 later the bidi iteration lands us in the
4583 invisible region again. */
4584 if (IT_CHARPOS (*it
) >= newpos
)
4585 it
->prev_stop
= newpos
;
4590 IT_CHARPOS (*it
) = newpos
;
4591 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4594 /* If there are before-strings at the start of invisible
4595 text, and the text is invisible because of a text
4596 property, arrange to show before-strings because 20.x did
4597 it that way. (If the text is invisible because of an
4598 overlay property instead of a text property, this is
4599 already handled in the overlay code.) */
4601 && get_overlay_strings (it
, it
->stop_charpos
))
4603 handled
= HANDLED_RECOMPUTE_PROPS
;
4606 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4607 /* The call to get_overlay_strings above recomputes
4608 it->stop_charpos, but it only considers changes
4609 in properties and overlays beyond iterator's
4610 current position. This causes us to miss changes
4611 that happen exactly where the invisible property
4612 ended. So we play it safe here and force the
4613 iterator to check for potential stop positions
4614 immediately after the invisible text. Note that
4615 if get_overlay_strings returns non-zero, it
4616 normally also pushed the iterator stack, so we
4617 need to update the stop position in the slot
4618 below the current one. */
4619 it
->stack
[it
->sp
- 1].stop_charpos
4620 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4623 else if (display_ellipsis_p
)
4625 /* Make sure that the glyphs of the ellipsis will get
4626 correct `charpos' values. If we would not update
4627 it->position here, the glyphs would belong to the
4628 last visible character _before_ the invisible
4629 text, which confuses `set_cursor_from_row'.
4631 We use the last invisible position instead of the
4632 first because this way the cursor is always drawn on
4633 the first "." of the ellipsis, whenever PT is inside
4634 the invisible text. Otherwise the cursor would be
4635 placed _after_ the ellipsis when the point is after the
4636 first invisible character. */
4637 if (!STRINGP (it
->object
))
4639 it
->position
.charpos
= newpos
- 1;
4640 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4642 it
->ellipsis_p
= true;
4643 /* Let the ellipsis display before
4644 considering any properties of the following char.
4645 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4646 handled
= HANDLED_RETURN
;
4655 /* Make iterator IT return `...' next.
4656 Replaces LEN characters from buffer. */
4659 setup_for_ellipsis (struct it
*it
, int len
)
4661 /* Use the display table definition for `...'. Invalid glyphs
4662 will be handled by the method returning elements from dpvec. */
4663 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4665 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4666 it
->dpvec
= v
->contents
;
4667 it
->dpend
= v
->contents
+ v
->header
.size
;
4671 /* Default `...'. */
4672 it
->dpvec
= default_invis_vector
;
4673 it
->dpend
= default_invis_vector
+ 3;
4676 it
->dpvec_char_len
= len
;
4677 it
->current
.dpvec_index
= 0;
4678 it
->dpvec_face_id
= -1;
4680 /* Remember the current face id in case glyphs specify faces.
4681 IT's face is restored in set_iterator_to_next.
4682 saved_face_id was set to preceding char's face in handle_stop. */
4683 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4684 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4686 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4687 it
->ellipsis_p
= true;
4692 /***********************************************************************
4694 ***********************************************************************/
4696 /* Set up iterator IT from `display' property at its current position.
4697 Called from handle_stop.
4698 We return HANDLED_RETURN if some part of the display property
4699 overrides the display of the buffer text itself.
4700 Otherwise we return HANDLED_NORMALLY. */
4702 static enum prop_handled
4703 handle_display_prop (struct it
*it
)
4705 Lisp_Object propval
, object
, overlay
;
4706 struct text_pos
*position
;
4708 /* Nonzero if some property replaces the display of the text itself. */
4709 int display_replaced_p
= 0;
4711 if (STRINGP (it
->string
))
4713 object
= it
->string
;
4714 position
= &it
->current
.string_pos
;
4715 bufpos
= CHARPOS (it
->current
.pos
);
4719 XSETWINDOW (object
, it
->w
);
4720 position
= &it
->current
.pos
;
4721 bufpos
= CHARPOS (*position
);
4724 /* Reset those iterator values set from display property values. */
4725 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4726 it
->space_width
= Qnil
;
4727 it
->font_height
= Qnil
;
4730 /* We don't support recursive `display' properties, i.e. string
4731 values that have a string `display' property, that have a string
4732 `display' property etc. */
4733 if (!it
->string_from_display_prop_p
)
4734 it
->area
= TEXT_AREA
;
4736 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4737 Qdisplay
, object
, &overlay
);
4739 return HANDLED_NORMALLY
;
4740 /* Now OVERLAY is the overlay that gave us this property, or nil
4741 if it was a text property. */
4743 if (!STRINGP (it
->string
))
4744 object
= it
->w
->contents
;
4746 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4748 FRAME_WINDOW_P (it
->f
));
4750 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4753 /* Subroutine of handle_display_prop. Returns non-zero if the display
4754 specification in SPEC is a replacing specification, i.e. it would
4755 replace the text covered by `display' property with something else,
4756 such as an image or a display string. If SPEC includes any kind or
4757 `(space ...) specification, the value is 2; this is used by
4758 compute_display_string_pos, which see.
4760 See handle_single_display_spec for documentation of arguments.
4761 frame_window_p is non-zero if the window being redisplayed is on a
4762 GUI frame; this argument is used only if IT is NULL, see below.
4764 IT can be NULL, if this is called by the bidi reordering code
4765 through compute_display_string_pos, which see. In that case, this
4766 function only examines SPEC, but does not otherwise "handle" it, in
4767 the sense that it doesn't set up members of IT from the display
4770 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4771 Lisp_Object overlay
, struct text_pos
*position
,
4772 ptrdiff_t bufpos
, int frame_window_p
)
4774 int replacing_p
= 0;
4778 /* Simple specifications. */
4779 && !EQ (XCAR (spec
), Qimage
)
4780 && !EQ (XCAR (spec
), Qspace
)
4781 && !EQ (XCAR (spec
), Qwhen
)
4782 && !EQ (XCAR (spec
), Qslice
)
4783 && !EQ (XCAR (spec
), Qspace_width
)
4784 && !EQ (XCAR (spec
), Qheight
)
4785 && !EQ (XCAR (spec
), Qraise
)
4786 /* Marginal area specifications. */
4787 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4788 && !EQ (XCAR (spec
), Qleft_fringe
)
4789 && !EQ (XCAR (spec
), Qright_fringe
)
4790 && !NILP (XCAR (spec
)))
4792 for (; CONSP (spec
); spec
= XCDR (spec
))
4794 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4795 overlay
, position
, bufpos
,
4796 replacing_p
, frame_window_p
)))
4799 /* If some text in a string is replaced, `position' no
4800 longer points to the position of `object'. */
4801 if (!it
|| STRINGP (object
))
4806 else if (VECTORP (spec
))
4809 for (i
= 0; i
< ASIZE (spec
); ++i
)
4810 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4811 overlay
, position
, bufpos
,
4812 replacing_p
, frame_window_p
)))
4815 /* If some text in a string is replaced, `position' no
4816 longer points to the position of `object'. */
4817 if (!it
|| STRINGP (object
))
4823 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4824 position
, bufpos
, 0,
4832 /* Value is the position of the end of the `display' property starting
4833 at START_POS in OBJECT. */
4835 static struct text_pos
4836 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4839 struct text_pos end_pos
;
4841 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4842 Qdisplay
, object
, Qnil
);
4843 CHARPOS (end_pos
) = XFASTINT (end
);
4844 if (STRINGP (object
))
4845 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4847 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4853 /* Set up IT from a single `display' property specification SPEC. OBJECT
4854 is the object in which the `display' property was found. *POSITION
4855 is the position in OBJECT at which the `display' property was found.
4856 BUFPOS is the buffer position of OBJECT (different from POSITION if
4857 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4858 previously saw a display specification which already replaced text
4859 display with something else, for example an image; we ignore such
4860 properties after the first one has been processed.
4862 OVERLAY is the overlay this `display' property came from,
4863 or nil if it was a text property.
4865 If SPEC is a `space' or `image' specification, and in some other
4866 cases too, set *POSITION to the position where the `display'
4869 If IT is NULL, only examine the property specification in SPEC, but
4870 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4871 is intended to be displayed in a window on a GUI frame.
4873 Value is non-zero if something was found which replaces the display
4874 of buffer or string text. */
4877 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4878 Lisp_Object overlay
, struct text_pos
*position
,
4879 ptrdiff_t bufpos
, int display_replaced_p
,
4883 Lisp_Object location
, value
;
4884 struct text_pos start_pos
= *position
;
4887 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4888 If the result is non-nil, use VALUE instead of SPEC. */
4890 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4899 if (!NILP (form
) && !EQ (form
, Qt
))
4901 ptrdiff_t count
= SPECPDL_INDEX ();
4902 struct gcpro gcpro1
;
4904 /* Bind `object' to the object having the `display' property, a
4905 buffer or string. Bind `position' to the position in the
4906 object where the property was found, and `buffer-position'
4907 to the current position in the buffer. */
4910 XSETBUFFER (object
, current_buffer
);
4911 specbind (Qobject
, object
);
4912 specbind (Qposition
, make_number (CHARPOS (*position
)));
4913 specbind (Qbuffer_position
, make_number (bufpos
));
4915 form
= safe_eval (form
);
4917 unbind_to (count
, Qnil
);
4923 /* Handle `(height HEIGHT)' specifications. */
4925 && EQ (XCAR (spec
), Qheight
)
4926 && CONSP (XCDR (spec
)))
4930 if (!FRAME_WINDOW_P (it
->f
))
4933 it
->font_height
= XCAR (XCDR (spec
));
4934 if (!NILP (it
->font_height
))
4936 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4937 int new_height
= -1;
4939 if (CONSP (it
->font_height
)
4940 && (EQ (XCAR (it
->font_height
), Qplus
)
4941 || EQ (XCAR (it
->font_height
), Qminus
))
4942 && CONSP (XCDR (it
->font_height
))
4943 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4945 /* `(+ N)' or `(- N)' where N is an integer. */
4946 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4947 if (EQ (XCAR (it
->font_height
), Qplus
))
4949 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4951 else if (FUNCTIONP (it
->font_height
))
4953 /* Call function with current height as argument.
4954 Value is the new height. */
4956 height
= safe_call1 (it
->font_height
,
4957 face
->lface
[LFACE_HEIGHT_INDEX
]);
4958 if (NUMBERP (height
))
4959 new_height
= XFLOATINT (height
);
4961 else if (NUMBERP (it
->font_height
))
4963 /* Value is a multiple of the canonical char height. */
4966 f
= FACE_FROM_ID (it
->f
,
4967 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4968 new_height
= (XFLOATINT (it
->font_height
)
4969 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4973 /* Evaluate IT->font_height with `height' bound to the
4974 current specified height to get the new height. */
4975 ptrdiff_t count
= SPECPDL_INDEX ();
4977 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4978 value
= safe_eval (it
->font_height
);
4979 unbind_to (count
, Qnil
);
4981 if (NUMBERP (value
))
4982 new_height
= XFLOATINT (value
);
4986 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4993 /* Handle `(space-width WIDTH)'. */
4995 && EQ (XCAR (spec
), Qspace_width
)
4996 && CONSP (XCDR (spec
)))
5000 if (!FRAME_WINDOW_P (it
->f
))
5003 value
= XCAR (XCDR (spec
));
5004 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
5005 it
->space_width
= value
;
5011 /* Handle `(slice X Y WIDTH HEIGHT)'. */
5013 && EQ (XCAR (spec
), Qslice
))
5019 if (!FRAME_WINDOW_P (it
->f
))
5022 if (tem
= XCDR (spec
), CONSP (tem
))
5024 it
->slice
.x
= XCAR (tem
);
5025 if (tem
= XCDR (tem
), CONSP (tem
))
5027 it
->slice
.y
= XCAR (tem
);
5028 if (tem
= XCDR (tem
), CONSP (tem
))
5030 it
->slice
.width
= XCAR (tem
);
5031 if (tem
= XCDR (tem
), CONSP (tem
))
5032 it
->slice
.height
= XCAR (tem
);
5041 /* Handle `(raise FACTOR)'. */
5043 && EQ (XCAR (spec
), Qraise
)
5044 && CONSP (XCDR (spec
)))
5048 if (!FRAME_WINDOW_P (it
->f
))
5051 #ifdef HAVE_WINDOW_SYSTEM
5052 value
= XCAR (XCDR (spec
));
5053 if (NUMBERP (value
))
5055 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5056 it
->voffset
= - (XFLOATINT (value
)
5057 * (FONT_HEIGHT (face
->font
)));
5059 #endif /* HAVE_WINDOW_SYSTEM */
5065 /* Don't handle the other kinds of display specifications
5066 inside a string that we got from a `display' property. */
5067 if (it
&& it
->string_from_display_prop_p
)
5070 /* Characters having this form of property are not displayed, so
5071 we have to find the end of the property. */
5074 start_pos
= *position
;
5075 *position
= display_prop_end (it
, object
, start_pos
);
5079 /* Stop the scan at that end position--we assume that all
5080 text properties change there. */
5082 it
->stop_charpos
= position
->charpos
;
5084 /* Handle `(left-fringe BITMAP [FACE])'
5085 and `(right-fringe BITMAP [FACE])'. */
5087 && (EQ (XCAR (spec
), Qleft_fringe
)
5088 || EQ (XCAR (spec
), Qright_fringe
))
5089 && CONSP (XCDR (spec
)))
5095 if (!FRAME_WINDOW_P (it
->f
))
5096 /* If we return here, POSITION has been advanced
5097 across the text with this property. */
5099 /* Synchronize the bidi iterator with POSITION. This is
5100 needed because we are not going to push the iterator
5101 on behalf of this display property, so there will be
5102 no pop_it call to do this synchronization for us. */
5105 it
->position
= *position
;
5106 iterate_out_of_display_property (it
);
5107 *position
= it
->position
;
5109 /* If we were to display this fringe bitmap,
5110 next_element_from_image would have reset this flag.
5111 Do the same, to avoid affecting overlays that
5113 it
->ignore_overlay_strings_at_pos_p
= 0;
5117 else if (!frame_window_p
)
5120 #ifdef HAVE_WINDOW_SYSTEM
5121 value
= XCAR (XCDR (spec
));
5122 if (!SYMBOLP (value
)
5123 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
5124 /* If we return here, POSITION has been advanced
5125 across the text with this property. */
5127 if (it
&& it
->bidi_p
)
5129 it
->position
= *position
;
5130 iterate_out_of_display_property (it
);
5131 *position
= it
->position
;
5134 /* Reset this flag like next_element_from_image would. */
5135 it
->ignore_overlay_strings_at_pos_p
= 0;
5141 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
5143 if (CONSP (XCDR (XCDR (spec
))))
5145 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5146 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5152 /* Save current settings of IT so that we can restore them
5153 when we are finished with the glyph property value. */
5154 push_it (it
, position
);
5156 it
->area
= TEXT_AREA
;
5157 it
->what
= IT_IMAGE
;
5158 it
->image_id
= -1; /* no image */
5159 it
->position
= start_pos
;
5160 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5161 it
->method
= GET_FROM_IMAGE
;
5162 it
->from_overlay
= Qnil
;
5163 it
->face_id
= face_id
;
5164 it
->from_disp_prop_p
= true;
5166 /* Say that we haven't consumed the characters with
5167 `display' property yet. The call to pop_it in
5168 set_iterator_to_next will clean this up. */
5169 *position
= start_pos
;
5171 if (EQ (XCAR (spec
), Qleft_fringe
))
5173 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5174 it
->left_user_fringe_face_id
= face_id
;
5178 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5179 it
->right_user_fringe_face_id
= face_id
;
5182 #endif /* HAVE_WINDOW_SYSTEM */
5186 /* Prepare to handle `((margin left-margin) ...)',
5187 `((margin right-margin) ...)' and `((margin nil) ...)'
5188 prefixes for display specifications. */
5189 location
= Qunbound
;
5190 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5194 value
= XCDR (spec
);
5196 value
= XCAR (value
);
5199 if (EQ (XCAR (tem
), Qmargin
)
5200 && (tem
= XCDR (tem
),
5201 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5203 || EQ (tem
, Qleft_margin
)
5204 || EQ (tem
, Qright_margin
))))
5208 if (EQ (location
, Qunbound
))
5214 /* After this point, VALUE is the property after any
5215 margin prefix has been stripped. It must be a string,
5216 an image specification, or `(space ...)'.
5218 LOCATION specifies where to display: `left-margin',
5219 `right-margin' or nil. */
5221 valid_p
= (STRINGP (value
)
5222 #ifdef HAVE_WINDOW_SYSTEM
5223 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5224 && valid_image_p (value
))
5225 #endif /* not HAVE_WINDOW_SYSTEM */
5226 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
5228 if (valid_p
&& !display_replaced_p
)
5234 /* Callers need to know whether the display spec is any kind
5235 of `(space ...)' spec that is about to affect text-area
5237 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5242 /* Save current settings of IT so that we can restore them
5243 when we are finished with the glyph property value. */
5244 push_it (it
, position
);
5245 it
->from_overlay
= overlay
;
5246 it
->from_disp_prop_p
= true;
5248 if (NILP (location
))
5249 it
->area
= TEXT_AREA
;
5250 else if (EQ (location
, Qleft_margin
))
5251 it
->area
= LEFT_MARGIN_AREA
;
5253 it
->area
= RIGHT_MARGIN_AREA
;
5255 if (STRINGP (value
))
5258 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5259 it
->current
.overlay_string_index
= -1;
5260 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5261 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5262 it
->method
= GET_FROM_STRING
;
5263 it
->stop_charpos
= 0;
5265 it
->base_level_stop
= 0;
5266 it
->string_from_display_prop_p
= true;
5267 /* Say that we haven't consumed the characters with
5268 `display' property yet. The call to pop_it in
5269 set_iterator_to_next will clean this up. */
5270 if (BUFFERP (object
))
5271 *position
= start_pos
;
5273 /* Force paragraph direction to be that of the parent
5274 object. If the parent object's paragraph direction is
5275 not yet determined, default to L2R. */
5276 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5277 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5279 it
->paragraph_embedding
= L2R
;
5281 /* Set up the bidi iterator for this display string. */
5284 it
->bidi_it
.string
.lstring
= it
->string
;
5285 it
->bidi_it
.string
.s
= NULL
;
5286 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5287 it
->bidi_it
.string
.bufpos
= bufpos
;
5288 it
->bidi_it
.string
.from_disp_str
= 1;
5289 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5290 it
->bidi_it
.w
= it
->w
;
5291 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5294 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5296 it
->method
= GET_FROM_STRETCH
;
5298 *position
= it
->position
= start_pos
;
5299 retval
= 1 + (it
->area
== TEXT_AREA
);
5301 #ifdef HAVE_WINDOW_SYSTEM
5304 it
->what
= IT_IMAGE
;
5305 it
->image_id
= lookup_image (it
->f
, value
);
5306 it
->position
= start_pos
;
5307 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5308 it
->method
= GET_FROM_IMAGE
;
5310 /* Say that we haven't consumed the characters with
5311 `display' property yet. The call to pop_it in
5312 set_iterator_to_next will clean this up. */
5313 *position
= start_pos
;
5315 #endif /* HAVE_WINDOW_SYSTEM */
5320 /* Invalid property or property not supported. Restore
5321 POSITION to what it was before. */
5322 *position
= start_pos
;
5326 /* Check if PROP is a display property value whose text should be
5327 treated as intangible. OVERLAY is the overlay from which PROP
5328 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5329 specify the buffer position covered by PROP. */
5332 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5333 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5335 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5336 struct text_pos position
;
5338 SET_TEXT_POS (position
, charpos
, bytepos
);
5339 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5340 &position
, charpos
, frame_window_p
);
5344 /* Return 1 if PROP is a display sub-property value containing STRING.
5346 Implementation note: this and the following function are really
5347 special cases of handle_display_spec and
5348 handle_single_display_spec, and should ideally use the same code.
5349 Until they do, these two pairs must be consistent and must be
5350 modified in sync. */
5353 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5355 if (EQ (string
, prop
))
5358 /* Skip over `when FORM'. */
5359 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5364 /* Actually, the condition following `when' should be eval'ed,
5365 like handle_single_display_spec does, and we should return
5366 zero if it evaluates to nil. However, this function is
5367 called only when the buffer was already displayed and some
5368 glyph in the glyph matrix was found to come from a display
5369 string. Therefore, the condition was already evaluated, and
5370 the result was non-nil, otherwise the display string wouldn't
5371 have been displayed and we would have never been called for
5372 this property. Thus, we can skip the evaluation and assume
5373 its result is non-nil. */
5378 /* Skip over `margin LOCATION'. */
5379 if (EQ (XCAR (prop
), Qmargin
))
5390 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5394 /* Return 1 if STRING appears in the `display' property PROP. */
5397 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5400 && !EQ (XCAR (prop
), Qwhen
)
5401 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5403 /* A list of sub-properties. */
5404 while (CONSP (prop
))
5406 if (single_display_spec_string_p (XCAR (prop
), string
))
5411 else if (VECTORP (prop
))
5413 /* A vector of sub-properties. */
5415 for (i
= 0; i
< ASIZE (prop
); ++i
)
5416 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5420 return single_display_spec_string_p (prop
, string
);
5425 /* Look for STRING in overlays and text properties in the current
5426 buffer, between character positions FROM and TO (excluding TO).
5427 BACK_P non-zero means look back (in this case, TO is supposed to be
5429 Value is the first character position where STRING was found, or
5430 zero if it wasn't found before hitting TO.
5432 This function may only use code that doesn't eval because it is
5433 called asynchronously from note_mouse_highlight. */
5436 string_buffer_position_lim (Lisp_Object string
,
5437 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5439 Lisp_Object limit
, prop
, pos
;
5442 pos
= make_number (max (from
, BEGV
));
5444 if (!back_p
) /* looking forward */
5446 limit
= make_number (min (to
, ZV
));
5447 while (!found
&& !EQ (pos
, limit
))
5449 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5450 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5453 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5457 else /* looking back */
5459 limit
= make_number (max (to
, BEGV
));
5460 while (!found
&& !EQ (pos
, limit
))
5462 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5463 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5466 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5471 return found
? XINT (pos
) : 0;
5474 /* Determine which buffer position in current buffer STRING comes from.
5475 AROUND_CHARPOS is an approximate position where it could come from.
5476 Value is the buffer position or 0 if it couldn't be determined.
5478 This function is necessary because we don't record buffer positions
5479 in glyphs generated from strings (to keep struct glyph small).
5480 This function may only use code that doesn't eval because it is
5481 called asynchronously from note_mouse_highlight. */
5484 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5486 const int MAX_DISTANCE
= 1000;
5487 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5488 around_charpos
+ MAX_DISTANCE
,
5492 found
= string_buffer_position_lim (string
, around_charpos
,
5493 around_charpos
- MAX_DISTANCE
, 1);
5499 /***********************************************************************
5500 `composition' property
5501 ***********************************************************************/
5503 /* Set up iterator IT from `composition' property at its current
5504 position. Called from handle_stop. */
5506 static enum prop_handled
5507 handle_composition_prop (struct it
*it
)
5509 Lisp_Object prop
, string
;
5510 ptrdiff_t pos
, pos_byte
, start
, end
;
5512 if (STRINGP (it
->string
))
5516 pos
= IT_STRING_CHARPOS (*it
);
5517 pos_byte
= IT_STRING_BYTEPOS (*it
);
5518 string
= it
->string
;
5519 s
= SDATA (string
) + pos_byte
;
5520 it
->c
= STRING_CHAR (s
);
5524 pos
= IT_CHARPOS (*it
);
5525 pos_byte
= IT_BYTEPOS (*it
);
5527 it
->c
= FETCH_CHAR (pos_byte
);
5530 /* If there's a valid composition and point is not inside of the
5531 composition (in the case that the composition is from the current
5532 buffer), draw a glyph composed from the composition components. */
5533 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5534 && composition_valid_p (start
, end
, prop
)
5535 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5538 /* As we can't handle this situation (perhaps font-lock added
5539 a new composition), we just return here hoping that next
5540 redisplay will detect this composition much earlier. */
5541 return HANDLED_NORMALLY
;
5544 if (STRINGP (it
->string
))
5545 pos_byte
= string_char_to_byte (it
->string
, start
);
5547 pos_byte
= CHAR_TO_BYTE (start
);
5549 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5552 if (it
->cmp_it
.id
>= 0)
5555 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5556 it
->cmp_it
.nglyphs
= -1;
5560 return HANDLED_NORMALLY
;
5565 /***********************************************************************
5567 ***********************************************************************/
5569 /* The following structure is used to record overlay strings for
5570 later sorting in load_overlay_strings. */
5572 struct overlay_entry
5574 Lisp_Object overlay
;
5581 /* Set up iterator IT from overlay strings at its current position.
5582 Called from handle_stop. */
5584 static enum prop_handled
5585 handle_overlay_change (struct it
*it
)
5587 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5588 return HANDLED_RECOMPUTE_PROPS
;
5590 return HANDLED_NORMALLY
;
5594 /* Set up the next overlay string for delivery by IT, if there is an
5595 overlay string to deliver. Called by set_iterator_to_next when the
5596 end of the current overlay string is reached. If there are more
5597 overlay strings to display, IT->string and
5598 IT->current.overlay_string_index are set appropriately here.
5599 Otherwise IT->string is set to nil. */
5602 next_overlay_string (struct it
*it
)
5604 ++it
->current
.overlay_string_index
;
5605 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5607 /* No more overlay strings. Restore IT's settings to what
5608 they were before overlay strings were processed, and
5609 continue to deliver from current_buffer. */
5611 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5614 || (NILP (it
->string
)
5615 && it
->method
== GET_FROM_BUFFER
5616 && it
->stop_charpos
>= BEGV
5617 && it
->stop_charpos
<= it
->end_charpos
));
5618 it
->current
.overlay_string_index
= -1;
5619 it
->n_overlay_strings
= 0;
5620 it
->overlay_strings_charpos
= -1;
5621 /* If there's an empty display string on the stack, pop the
5622 stack, to resync the bidi iterator with IT's position. Such
5623 empty strings are pushed onto the stack in
5624 get_overlay_strings_1. */
5625 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5628 /* If we're at the end of the buffer, record that we have
5629 processed the overlay strings there already, so that
5630 next_element_from_buffer doesn't try it again. */
5631 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5632 it
->overlay_strings_at_end_processed_p
= true;
5636 /* There are more overlay strings to process. If
5637 IT->current.overlay_string_index has advanced to a position
5638 where we must load IT->overlay_strings with more strings, do
5639 it. We must load at the IT->overlay_strings_charpos where
5640 IT->n_overlay_strings was originally computed; when invisible
5641 text is present, this might not be IT_CHARPOS (Bug#7016). */
5642 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5644 if (it
->current
.overlay_string_index
&& i
== 0)
5645 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5647 /* Initialize IT to deliver display elements from the overlay
5649 it
->string
= it
->overlay_strings
[i
];
5650 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5651 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5652 it
->method
= GET_FROM_STRING
;
5653 it
->stop_charpos
= 0;
5654 it
->end_charpos
= SCHARS (it
->string
);
5655 if (it
->cmp_it
.stop_pos
>= 0)
5656 it
->cmp_it
.stop_pos
= 0;
5658 it
->base_level_stop
= 0;
5660 /* Set up the bidi iterator for this overlay string. */
5663 it
->bidi_it
.string
.lstring
= it
->string
;
5664 it
->bidi_it
.string
.s
= NULL
;
5665 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5666 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5667 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5668 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5669 it
->bidi_it
.w
= it
->w
;
5670 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5678 /* Compare two overlay_entry structures E1 and E2. Used as a
5679 comparison function for qsort in load_overlay_strings. Overlay
5680 strings for the same position are sorted so that
5682 1. All after-strings come in front of before-strings, except
5683 when they come from the same overlay.
5685 2. Within after-strings, strings are sorted so that overlay strings
5686 from overlays with higher priorities come first.
5688 2. Within before-strings, strings are sorted so that overlay
5689 strings from overlays with higher priorities come last.
5691 Value is analogous to strcmp. */
5695 compare_overlay_entries (const void *e1
, const void *e2
)
5697 struct overlay_entry
const *entry1
= e1
;
5698 struct overlay_entry
const *entry2
= e2
;
5701 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5703 /* Let after-strings appear in front of before-strings if
5704 they come from different overlays. */
5705 if (EQ (entry1
->overlay
, entry2
->overlay
))
5706 result
= entry1
->after_string_p
? 1 : -1;
5708 result
= entry1
->after_string_p
? -1 : 1;
5710 else if (entry1
->priority
!= entry2
->priority
)
5712 if (entry1
->after_string_p
)
5713 /* After-strings sorted in order of decreasing priority. */
5714 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5716 /* Before-strings sorted in order of increasing priority. */
5717 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5726 /* Load the vector IT->overlay_strings with overlay strings from IT's
5727 current buffer position, or from CHARPOS if that is > 0. Set
5728 IT->n_overlays to the total number of overlay strings found.
5730 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5731 a time. On entry into load_overlay_strings,
5732 IT->current.overlay_string_index gives the number of overlay
5733 strings that have already been loaded by previous calls to this
5736 IT->add_overlay_start contains an additional overlay start
5737 position to consider for taking overlay strings from, if non-zero.
5738 This position comes into play when the overlay has an `invisible'
5739 property, and both before and after-strings. When we've skipped to
5740 the end of the overlay, because of its `invisible' property, we
5741 nevertheless want its before-string to appear.
5742 IT->add_overlay_start will contain the overlay start position
5745 Overlay strings are sorted so that after-string strings come in
5746 front of before-string strings. Within before and after-strings,
5747 strings are sorted by overlay priority. See also function
5748 compare_overlay_entries. */
5751 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5753 Lisp_Object overlay
, window
, str
, invisible
;
5754 struct Lisp_Overlay
*ov
;
5755 ptrdiff_t start
, end
;
5756 ptrdiff_t size
= 20;
5757 ptrdiff_t n
= 0, i
, j
;
5759 struct overlay_entry
*entries
= alloca (size
* sizeof *entries
);
5763 charpos
= IT_CHARPOS (*it
);
5765 /* Append the overlay string STRING of overlay OVERLAY to vector
5766 `entries' which has size `size' and currently contains `n'
5767 elements. AFTER_P non-zero means STRING is an after-string of
5769 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5772 Lisp_Object priority; \
5776 struct overlay_entry *old = entries; \
5777 SAFE_NALLOCA (entries, 2, size); \
5778 memcpy (entries, old, size * sizeof *entries); \
5782 entries[n].string = (STRING); \
5783 entries[n].overlay = (OVERLAY); \
5784 priority = Foverlay_get ((OVERLAY), Qpriority); \
5785 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5786 entries[n].after_string_p = (AFTER_P); \
5791 /* Process overlay before the overlay center. */
5792 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5794 XSETMISC (overlay
, ov
);
5795 eassert (OVERLAYP (overlay
));
5796 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5797 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5802 /* Skip this overlay if it doesn't start or end at IT's current
5804 if (end
!= charpos
&& start
!= charpos
)
5807 /* Skip this overlay if it doesn't apply to IT->w. */
5808 window
= Foverlay_get (overlay
, Qwindow
);
5809 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5812 /* If the text ``under'' the overlay is invisible, both before-
5813 and after-strings from this overlay are visible; start and
5814 end position are indistinguishable. */
5815 invisible
= Foverlay_get (overlay
, Qinvisible
);
5816 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5818 /* If overlay has a non-empty before-string, record it. */
5819 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5820 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5822 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5824 /* If overlay has a non-empty after-string, record it. */
5825 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5826 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5828 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5831 /* Process overlays after the overlay center. */
5832 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5834 XSETMISC (overlay
, ov
);
5835 eassert (OVERLAYP (overlay
));
5836 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5837 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5839 if (start
> charpos
)
5842 /* Skip this overlay if it doesn't start or end at IT's current
5844 if (end
!= charpos
&& start
!= charpos
)
5847 /* Skip this overlay if it doesn't apply to IT->w. */
5848 window
= Foverlay_get (overlay
, Qwindow
);
5849 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5852 /* If the text ``under'' the overlay is invisible, it has a zero
5853 dimension, and both before- and after-strings apply. */
5854 invisible
= Foverlay_get (overlay
, Qinvisible
);
5855 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5857 /* If overlay has a non-empty before-string, record it. */
5858 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5859 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5861 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5863 /* If overlay has a non-empty after-string, record it. */
5864 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5865 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5867 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5870 #undef RECORD_OVERLAY_STRING
5874 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5876 /* Record number of overlay strings, and where we computed it. */
5877 it
->n_overlay_strings
= n
;
5878 it
->overlay_strings_charpos
= charpos
;
5880 /* IT->current.overlay_string_index is the number of overlay strings
5881 that have already been consumed by IT. Copy some of the
5882 remaining overlay strings to IT->overlay_strings. */
5884 j
= it
->current
.overlay_string_index
;
5885 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5887 it
->overlay_strings
[i
] = entries
[j
].string
;
5888 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5896 /* Get the first chunk of overlay strings at IT's current buffer
5897 position, or at CHARPOS if that is > 0. Value is non-zero if at
5898 least one overlay string was found. */
5901 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5903 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5904 process. This fills IT->overlay_strings with strings, and sets
5905 IT->n_overlay_strings to the total number of strings to process.
5906 IT->pos.overlay_string_index has to be set temporarily to zero
5907 because load_overlay_strings needs this; it must be set to -1
5908 when no overlay strings are found because a zero value would
5909 indicate a position in the first overlay string. */
5910 it
->current
.overlay_string_index
= 0;
5911 load_overlay_strings (it
, charpos
);
5913 /* If we found overlay strings, set up IT to deliver display
5914 elements from the first one. Otherwise set up IT to deliver
5915 from current_buffer. */
5916 if (it
->n_overlay_strings
)
5918 /* Make sure we know settings in current_buffer, so that we can
5919 restore meaningful values when we're done with the overlay
5922 compute_stop_pos (it
);
5923 eassert (it
->face_id
>= 0);
5925 /* Save IT's settings. They are restored after all overlay
5926 strings have been processed. */
5927 eassert (!compute_stop_p
|| it
->sp
== 0);
5929 /* When called from handle_stop, there might be an empty display
5930 string loaded. In that case, don't bother saving it. But
5931 don't use this optimization with the bidi iterator, since we
5932 need the corresponding pop_it call to resync the bidi
5933 iterator's position with IT's position, after we are done
5934 with the overlay strings. (The corresponding call to pop_it
5935 in case of an empty display string is in
5936 next_overlay_string.) */
5938 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5941 /* Set up IT to deliver display elements from the first overlay
5943 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5944 it
->string
= it
->overlay_strings
[0];
5945 it
->from_overlay
= Qnil
;
5946 it
->stop_charpos
= 0;
5947 eassert (STRINGP (it
->string
));
5948 it
->end_charpos
= SCHARS (it
->string
);
5950 it
->base_level_stop
= 0;
5951 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5952 it
->method
= GET_FROM_STRING
;
5953 it
->from_disp_prop_p
= 0;
5955 /* Force paragraph direction to be that of the parent
5957 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5958 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5960 it
->paragraph_embedding
= L2R
;
5962 /* Set up the bidi iterator for this overlay string. */
5965 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5967 it
->bidi_it
.string
.lstring
= it
->string
;
5968 it
->bidi_it
.string
.s
= NULL
;
5969 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5970 it
->bidi_it
.string
.bufpos
= pos
;
5971 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5972 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5973 it
->bidi_it
.w
= it
->w
;
5974 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5979 it
->current
.overlay_string_index
= -1;
5984 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5987 it
->method
= GET_FROM_BUFFER
;
5989 (void) get_overlay_strings_1 (it
, charpos
, 1);
5993 /* Value is non-zero if we found at least one overlay string. */
5994 return STRINGP (it
->string
);
5999 /***********************************************************************
6000 Saving and restoring state
6001 ***********************************************************************/
6003 /* Save current settings of IT on IT->stack. Called, for example,
6004 before setting up IT for an overlay string, to be able to restore
6005 IT's settings to what they were after the overlay string has been
6006 processed. If POSITION is non-NULL, it is the position to save on
6007 the stack instead of IT->position. */
6010 push_it (struct it
*it
, struct text_pos
*position
)
6012 struct iterator_stack_entry
*p
;
6014 eassert (it
->sp
< IT_STACK_SIZE
);
6015 p
= it
->stack
+ it
->sp
;
6017 p
->stop_charpos
= it
->stop_charpos
;
6018 p
->prev_stop
= it
->prev_stop
;
6019 p
->base_level_stop
= it
->base_level_stop
;
6020 p
->cmp_it
= it
->cmp_it
;
6021 eassert (it
->face_id
>= 0);
6022 p
->face_id
= it
->face_id
;
6023 p
->string
= it
->string
;
6024 p
->method
= it
->method
;
6025 p
->from_overlay
= it
->from_overlay
;
6028 case GET_FROM_IMAGE
:
6029 p
->u
.image
.object
= it
->object
;
6030 p
->u
.image
.image_id
= it
->image_id
;
6031 p
->u
.image
.slice
= it
->slice
;
6033 case GET_FROM_STRETCH
:
6034 p
->u
.stretch
.object
= it
->object
;
6037 p
->position
= position
? *position
: it
->position
;
6038 p
->current
= it
->current
;
6039 p
->end_charpos
= it
->end_charpos
;
6040 p
->string_nchars
= it
->string_nchars
;
6042 p
->multibyte_p
= it
->multibyte_p
;
6043 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
6044 p
->space_width
= it
->space_width
;
6045 p
->font_height
= it
->font_height
;
6046 p
->voffset
= it
->voffset
;
6047 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
6048 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
6049 p
->display_ellipsis_p
= 0;
6050 p
->line_wrap
= it
->line_wrap
;
6051 p
->bidi_p
= it
->bidi_p
;
6052 p
->paragraph_embedding
= it
->paragraph_embedding
;
6053 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
6056 /* Save the state of the bidi iterator as well. */
6058 bidi_push_it (&it
->bidi_it
);
6062 iterate_out_of_display_property (struct it
*it
)
6064 int buffer_p
= !STRINGP (it
->string
);
6065 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
6066 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
6068 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
6070 /* Maybe initialize paragraph direction. If we are at the beginning
6071 of a new paragraph, next_element_from_buffer may not have a
6072 chance to do that. */
6073 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
6074 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6075 /* prev_stop can be zero, so check against BEGV as well. */
6076 while (it
->bidi_it
.charpos
>= bob
6077 && it
->prev_stop
<= it
->bidi_it
.charpos
6078 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
6079 && it
->bidi_it
.charpos
< eob
)
6080 bidi_move_to_visually_next (&it
->bidi_it
);
6081 /* Record the stop_pos we just crossed, for when we cross it
6083 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
6084 it
->prev_stop
= CHARPOS (it
->position
);
6085 /* If we ended up not where pop_it put us, resync IT's
6086 positional members with the bidi iterator. */
6087 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
6088 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
6090 it
->current
.pos
= it
->position
;
6092 it
->current
.string_pos
= it
->position
;
6095 /* Restore IT's settings from IT->stack. Called, for example, when no
6096 more overlay strings must be processed, and we return to delivering
6097 display elements from a buffer, or when the end of a string from a
6098 `display' property is reached and we return to delivering display
6099 elements from an overlay string, or from a buffer. */
6102 pop_it (struct it
*it
)
6104 struct iterator_stack_entry
*p
;
6105 int from_display_prop
= it
->from_disp_prop_p
;
6107 eassert (it
->sp
> 0);
6109 p
= it
->stack
+ it
->sp
;
6110 it
->stop_charpos
= p
->stop_charpos
;
6111 it
->prev_stop
= p
->prev_stop
;
6112 it
->base_level_stop
= p
->base_level_stop
;
6113 it
->cmp_it
= p
->cmp_it
;
6114 it
->face_id
= p
->face_id
;
6115 it
->current
= p
->current
;
6116 it
->position
= p
->position
;
6117 it
->string
= p
->string
;
6118 it
->from_overlay
= p
->from_overlay
;
6119 if (NILP (it
->string
))
6120 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6121 it
->method
= p
->method
;
6124 case GET_FROM_IMAGE
:
6125 it
->image_id
= p
->u
.image
.image_id
;
6126 it
->object
= p
->u
.image
.object
;
6127 it
->slice
= p
->u
.image
.slice
;
6129 case GET_FROM_STRETCH
:
6130 it
->object
= p
->u
.stretch
.object
;
6132 case GET_FROM_BUFFER
:
6133 it
->object
= it
->w
->contents
;
6135 case GET_FROM_STRING
:
6137 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6139 /* Restore the face_box_p flag, since it could have been
6140 overwritten by the face of the object that we just finished
6143 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6144 it
->object
= it
->string
;
6147 case GET_FROM_DISPLAY_VECTOR
:
6149 it
->method
= GET_FROM_C_STRING
;
6150 else if (STRINGP (it
->string
))
6151 it
->method
= GET_FROM_STRING
;
6154 it
->method
= GET_FROM_BUFFER
;
6155 it
->object
= it
->w
->contents
;
6158 it
->end_charpos
= p
->end_charpos
;
6159 it
->string_nchars
= p
->string_nchars
;
6161 it
->multibyte_p
= p
->multibyte_p
;
6162 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6163 it
->space_width
= p
->space_width
;
6164 it
->font_height
= p
->font_height
;
6165 it
->voffset
= p
->voffset
;
6166 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6167 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6168 it
->line_wrap
= p
->line_wrap
;
6169 it
->bidi_p
= p
->bidi_p
;
6170 it
->paragraph_embedding
= p
->paragraph_embedding
;
6171 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6174 bidi_pop_it (&it
->bidi_it
);
6175 /* Bidi-iterate until we get out of the portion of text, if any,
6176 covered by a `display' text property or by an overlay with
6177 `display' property. (We cannot just jump there, because the
6178 internal coherency of the bidi iterator state can not be
6179 preserved across such jumps.) We also must determine the
6180 paragraph base direction if the overlay we just processed is
6181 at the beginning of a new paragraph. */
6182 if (from_display_prop
6183 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6184 iterate_out_of_display_property (it
);
6186 eassert ((BUFFERP (it
->object
)
6187 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6188 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6189 || (STRINGP (it
->object
)
6190 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6191 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6192 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6198 /***********************************************************************
6200 ***********************************************************************/
6202 /* Set IT's current position to the previous line start. */
6205 back_to_previous_line_start (struct it
*it
)
6207 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6210 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6214 /* Move IT to the next line start.
6216 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
6217 we skipped over part of the text (as opposed to moving the iterator
6218 continuously over the text). Otherwise, don't change the value
6221 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6222 iterator on the newline, if it was found.
6224 Newlines may come from buffer text, overlay strings, or strings
6225 displayed via the `display' property. That's the reason we can't
6226 simply use find_newline_no_quit.
6228 Note that this function may not skip over invisible text that is so
6229 because of text properties and immediately follows a newline. If
6230 it would, function reseat_at_next_visible_line_start, when called
6231 from set_iterator_to_next, would effectively make invisible
6232 characters following a newline part of the wrong glyph row, which
6233 leads to wrong cursor motion. */
6236 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
6237 struct bidi_it
*bidi_it_prev
)
6239 ptrdiff_t old_selective
;
6240 int newline_found_p
, n
;
6241 const int MAX_NEWLINE_DISTANCE
= 500;
6243 /* If already on a newline, just consume it to avoid unintended
6244 skipping over invisible text below. */
6245 if (it
->what
== IT_CHARACTER
6247 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6249 if (it
->bidi_p
&& bidi_it_prev
)
6250 *bidi_it_prev
= it
->bidi_it
;
6251 set_iterator_to_next (it
, 0);
6256 /* Don't handle selective display in the following. It's (a)
6257 unnecessary because it's done by the caller, and (b) leads to an
6258 infinite recursion because next_element_from_ellipsis indirectly
6259 calls this function. */
6260 old_selective
= it
->selective
;
6263 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6264 from buffer text. */
6265 for (n
= newline_found_p
= 0;
6266 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6267 n
+= STRINGP (it
->string
) ? 0 : 1)
6269 if (!get_next_display_element (it
))
6271 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6272 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6273 *bidi_it_prev
= it
->bidi_it
;
6274 set_iterator_to_next (it
, 0);
6277 /* If we didn't find a newline near enough, see if we can use a
6279 if (!newline_found_p
)
6281 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6282 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6286 eassert (!STRINGP (it
->string
));
6288 /* If there isn't any `display' property in sight, and no
6289 overlays, we can just use the position of the newline in
6291 if (it
->stop_charpos
>= limit
6292 || ((pos
= Fnext_single_property_change (make_number (start
),
6294 make_number (limit
)),
6296 && next_overlay_change (start
) == ZV
))
6300 IT_CHARPOS (*it
) = limit
;
6301 IT_BYTEPOS (*it
) = bytepos
;
6305 struct bidi_it bprev
;
6307 /* Help bidi.c avoid expensive searches for display
6308 properties and overlays, by telling it that there are
6309 none up to `limit'. */
6310 if (it
->bidi_it
.disp_pos
< limit
)
6312 it
->bidi_it
.disp_pos
= limit
;
6313 it
->bidi_it
.disp_prop
= 0;
6316 bprev
= it
->bidi_it
;
6317 bidi_move_to_visually_next (&it
->bidi_it
);
6318 } while (it
->bidi_it
.charpos
!= limit
);
6319 IT_CHARPOS (*it
) = limit
;
6320 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6322 *bidi_it_prev
= bprev
;
6324 *skipped_p
= newline_found_p
= true;
6328 while (get_next_display_element (it
)
6329 && !newline_found_p
)
6331 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6332 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6333 *bidi_it_prev
= it
->bidi_it
;
6334 set_iterator_to_next (it
, 0);
6339 it
->selective
= old_selective
;
6340 return newline_found_p
;
6344 /* Set IT's current position to the previous visible line start. Skip
6345 invisible text that is so either due to text properties or due to
6346 selective display. Caution: this does not change IT->current_x and
6350 back_to_previous_visible_line_start (struct it
*it
)
6352 while (IT_CHARPOS (*it
) > BEGV
)
6354 back_to_previous_line_start (it
);
6356 if (IT_CHARPOS (*it
) <= BEGV
)
6359 /* If selective > 0, then lines indented more than its value are
6361 if (it
->selective
> 0
6362 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6366 /* Check the newline before point for invisibility. */
6369 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6370 Qinvisible
, it
->window
);
6371 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6375 if (IT_CHARPOS (*it
) <= BEGV
)
6380 void *it2data
= NULL
;
6383 Lisp_Object val
, overlay
;
6385 SAVE_IT (it2
, *it
, it2data
);
6387 /* If newline is part of a composition, continue from start of composition */
6388 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6389 && beg
< IT_CHARPOS (*it
))
6392 /* If newline is replaced by a display property, find start of overlay
6393 or interval and continue search from that point. */
6394 pos
= --IT_CHARPOS (it2
);
6397 bidi_unshelve_cache (NULL
, 0);
6398 it2
.string_from_display_prop_p
= 0;
6399 it2
.from_disp_prop_p
= 0;
6400 if (handle_display_prop (&it2
) == HANDLED_RETURN
6401 && !NILP (val
= get_char_property_and_overlay
6402 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6403 && (OVERLAYP (overlay
)
6404 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6405 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6407 RESTORE_IT (it
, it
, it2data
);
6411 /* Newline is not replaced by anything -- so we are done. */
6412 RESTORE_IT (it
, it
, it2data
);
6418 IT_CHARPOS (*it
) = beg
;
6419 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6423 it
->continuation_lines_width
= 0;
6425 eassert (IT_CHARPOS (*it
) >= BEGV
);
6426 eassert (IT_CHARPOS (*it
) == BEGV
6427 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6432 /* Reseat iterator IT at the previous visible line start. Skip
6433 invisible text that is so either due to text properties or due to
6434 selective display. At the end, update IT's overlay information,
6435 face information etc. */
6438 reseat_at_previous_visible_line_start (struct it
*it
)
6440 back_to_previous_visible_line_start (it
);
6441 reseat (it
, it
->current
.pos
, 1);
6446 /* Reseat iterator IT on the next visible line start in the current
6447 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6448 preceding the line start. Skip over invisible text that is so
6449 because of selective display. Compute faces, overlays etc at the
6450 new position. Note that this function does not skip over text that
6451 is invisible because of text properties. */
6454 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6456 int newline_found_p
, skipped_p
= 0;
6457 struct bidi_it bidi_it_prev
;
6459 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6461 /* Skip over lines that are invisible because they are indented
6462 more than the value of IT->selective. */
6463 if (it
->selective
> 0)
6464 while (IT_CHARPOS (*it
) < ZV
6465 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6468 eassert (IT_BYTEPOS (*it
) == BEGV
6469 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6471 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6474 /* Position on the newline if that's what's requested. */
6475 if (on_newline_p
&& newline_found_p
)
6477 if (STRINGP (it
->string
))
6479 if (IT_STRING_CHARPOS (*it
) > 0)
6483 --IT_STRING_CHARPOS (*it
);
6484 --IT_STRING_BYTEPOS (*it
);
6488 /* We need to restore the bidi iterator to the state
6489 it had on the newline, and resync the IT's
6490 position with that. */
6491 it
->bidi_it
= bidi_it_prev
;
6492 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6493 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6497 else if (IT_CHARPOS (*it
) > BEGV
)
6506 /* We need to restore the bidi iterator to the state it
6507 had on the newline and resync IT with that. */
6508 it
->bidi_it
= bidi_it_prev
;
6509 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6510 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6512 reseat (it
, it
->current
.pos
, 0);
6516 reseat (it
, it
->current
.pos
, 0);
6523 /***********************************************************************
6524 Changing an iterator's position
6525 ***********************************************************************/
6527 /* Change IT's current position to POS in current_buffer. If FORCE_P
6528 is non-zero, always check for text properties at the new position.
6529 Otherwise, text properties are only looked up if POS >=
6530 IT->check_charpos of a property. */
6533 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6535 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6537 reseat_1 (it
, pos
, 0);
6539 /* Determine where to check text properties. Avoid doing it
6540 where possible because text property lookup is very expensive. */
6542 || CHARPOS (pos
) > it
->stop_charpos
6543 || CHARPOS (pos
) < original_pos
)
6547 /* For bidi iteration, we need to prime prev_stop and
6548 base_level_stop with our best estimations. */
6549 /* Implementation note: Of course, POS is not necessarily a
6550 stop position, so assigning prev_pos to it is a lie; we
6551 should have called compute_stop_backwards. However, if
6552 the current buffer does not include any R2L characters,
6553 that call would be a waste of cycles, because the
6554 iterator will never move back, and thus never cross this
6555 "fake" stop position. So we delay that backward search
6556 until the time we really need it, in next_element_from_buffer. */
6557 if (CHARPOS (pos
) != it
->prev_stop
)
6558 it
->prev_stop
= CHARPOS (pos
);
6559 if (CHARPOS (pos
) < it
->base_level_stop
)
6560 it
->base_level_stop
= 0; /* meaning it's unknown */
6566 it
->prev_stop
= it
->base_level_stop
= 0;
6575 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6576 IT->stop_pos to POS, also. */
6579 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6581 /* Don't call this function when scanning a C string. */
6582 eassert (it
->s
== NULL
);
6584 /* POS must be a reasonable value. */
6585 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6587 it
->current
.pos
= it
->position
= pos
;
6588 it
->end_charpos
= ZV
;
6590 it
->current
.dpvec_index
= -1;
6591 it
->current
.overlay_string_index
= -1;
6592 IT_STRING_CHARPOS (*it
) = -1;
6593 IT_STRING_BYTEPOS (*it
) = -1;
6595 it
->method
= GET_FROM_BUFFER
;
6596 it
->object
= it
->w
->contents
;
6597 it
->area
= TEXT_AREA
;
6598 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6600 it
->string_from_display_prop_p
= 0;
6601 it
->string_from_prefix_prop_p
= 0;
6603 it
->from_disp_prop_p
= 0;
6604 it
->face_before_selective_p
= 0;
6607 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6609 bidi_unshelve_cache (NULL
, 0);
6610 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6611 it
->bidi_it
.string
.s
= NULL
;
6612 it
->bidi_it
.string
.lstring
= Qnil
;
6613 it
->bidi_it
.string
.bufpos
= 0;
6614 it
->bidi_it
.string
.from_disp_str
= 0;
6615 it
->bidi_it
.string
.unibyte
= 0;
6616 it
->bidi_it
.w
= it
->w
;
6621 it
->stop_charpos
= CHARPOS (pos
);
6622 it
->base_level_stop
= CHARPOS (pos
);
6624 /* This make the information stored in it->cmp_it invalidate. */
6629 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6630 If S is non-null, it is a C string to iterate over. Otherwise,
6631 STRING gives a Lisp string to iterate over.
6633 If PRECISION > 0, don't return more then PRECISION number of
6634 characters from the string.
6636 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6637 characters have been returned. FIELD_WIDTH < 0 means an infinite
6640 MULTIBYTE = 0 means disable processing of multibyte characters,
6641 MULTIBYTE > 0 means enable it,
6642 MULTIBYTE < 0 means use IT->multibyte_p.
6644 IT must be initialized via a prior call to init_iterator before
6645 calling this function. */
6648 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6649 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6652 /* No text property checks performed by default, but see below. */
6653 it
->stop_charpos
= -1;
6655 /* Set iterator position and end position. */
6656 memset (&it
->current
, 0, sizeof it
->current
);
6657 it
->current
.overlay_string_index
= -1;
6658 it
->current
.dpvec_index
= -1;
6659 eassert (charpos
>= 0);
6661 /* If STRING is specified, use its multibyteness, otherwise use the
6662 setting of MULTIBYTE, if specified. */
6664 it
->multibyte_p
= multibyte
> 0;
6666 /* Bidirectional reordering of strings is controlled by the default
6667 value of bidi-display-reordering. Don't try to reorder while
6668 loading loadup.el, as the necessary character property tables are
6669 not yet available. */
6672 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6676 eassert (STRINGP (string
));
6677 it
->string
= string
;
6679 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6680 it
->method
= GET_FROM_STRING
;
6681 it
->current
.string_pos
= string_pos (charpos
, string
);
6685 it
->bidi_it
.string
.lstring
= string
;
6686 it
->bidi_it
.string
.s
= NULL
;
6687 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6688 it
->bidi_it
.string
.bufpos
= 0;
6689 it
->bidi_it
.string
.from_disp_str
= 0;
6690 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6691 it
->bidi_it
.w
= it
->w
;
6692 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6693 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6698 it
->s
= (const unsigned char *) s
;
6701 /* Note that we use IT->current.pos, not it->current.string_pos,
6702 for displaying C strings. */
6703 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6704 if (it
->multibyte_p
)
6706 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6707 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6711 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6712 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6717 it
->bidi_it
.string
.lstring
= Qnil
;
6718 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6719 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6720 it
->bidi_it
.string
.bufpos
= 0;
6721 it
->bidi_it
.string
.from_disp_str
= 0;
6722 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6723 it
->bidi_it
.w
= it
->w
;
6724 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6727 it
->method
= GET_FROM_C_STRING
;
6730 /* PRECISION > 0 means don't return more than PRECISION characters
6732 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6734 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6736 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6739 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6740 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6741 FIELD_WIDTH < 0 means infinite field width. This is useful for
6742 padding with `-' at the end of a mode line. */
6743 if (field_width
< 0)
6744 field_width
= INFINITY
;
6745 /* Implementation note: We deliberately don't enlarge
6746 it->bidi_it.string.schars here to fit it->end_charpos, because
6747 the bidi iterator cannot produce characters out of thin air. */
6748 if (field_width
> it
->end_charpos
- charpos
)
6749 it
->end_charpos
= charpos
+ field_width
;
6751 /* Use the standard display table for displaying strings. */
6752 if (DISP_TABLE_P (Vstandard_display_table
))
6753 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6755 it
->stop_charpos
= charpos
;
6756 it
->prev_stop
= charpos
;
6757 it
->base_level_stop
= 0;
6760 it
->bidi_it
.first_elt
= 1;
6761 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6762 it
->bidi_it
.disp_pos
= -1;
6764 if (s
== NULL
&& it
->multibyte_p
)
6766 ptrdiff_t endpos
= SCHARS (it
->string
);
6767 if (endpos
> it
->end_charpos
)
6768 endpos
= it
->end_charpos
;
6769 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6777 /***********************************************************************
6779 ***********************************************************************/
6781 /* Map enum it_method value to corresponding next_element_from_* function. */
6783 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6785 next_element_from_buffer
,
6786 next_element_from_display_vector
,
6787 next_element_from_string
,
6788 next_element_from_c_string
,
6789 next_element_from_image
,
6790 next_element_from_stretch
6793 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6796 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6797 (possibly with the following characters). */
6799 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6800 ((IT)->cmp_it.id >= 0 \
6801 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6802 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6803 END_CHARPOS, (IT)->w, \
6804 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6808 /* Lookup the char-table Vglyphless_char_display for character C (-1
6809 if we want information for no-font case), and return the display
6810 method symbol. By side-effect, update it->what and
6811 it->glyphless_method. This function is called from
6812 get_next_display_element for each character element, and from
6813 x_produce_glyphs when no suitable font was found. */
6816 lookup_glyphless_char_display (int c
, struct it
*it
)
6818 Lisp_Object glyphless_method
= Qnil
;
6820 if (CHAR_TABLE_P (Vglyphless_char_display
)
6821 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6825 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6826 if (CONSP (glyphless_method
))
6827 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6828 ? XCAR (glyphless_method
)
6829 : XCDR (glyphless_method
);
6832 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6836 if (NILP (glyphless_method
))
6839 /* The default is to display the character by a proper font. */
6841 /* The default for the no-font case is to display an empty box. */
6842 glyphless_method
= Qempty_box
;
6844 if (EQ (glyphless_method
, Qzero_width
))
6847 return glyphless_method
;
6848 /* This method can't be used for the no-font case. */
6849 glyphless_method
= Qempty_box
;
6851 if (EQ (glyphless_method
, Qthin_space
))
6852 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6853 else if (EQ (glyphless_method
, Qempty_box
))
6854 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6855 else if (EQ (glyphless_method
, Qhex_code
))
6856 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6857 else if (STRINGP (glyphless_method
))
6858 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6861 /* Invalid value. We use the default method. */
6862 glyphless_method
= Qnil
;
6865 it
->what
= IT_GLYPHLESS
;
6866 return glyphless_method
;
6869 /* Merge escape glyph face and cache the result. */
6871 static struct frame
*last_escape_glyph_frame
= NULL
;
6872 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6873 static int last_escape_glyph_merged_face_id
= 0;
6876 merge_escape_glyph_face (struct it
*it
)
6880 if (it
->f
== last_escape_glyph_frame
6881 && it
->face_id
== last_escape_glyph_face_id
)
6882 face_id
= last_escape_glyph_merged_face_id
;
6885 /* Merge the `escape-glyph' face into the current face. */
6886 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6887 last_escape_glyph_frame
= it
->f
;
6888 last_escape_glyph_face_id
= it
->face_id
;
6889 last_escape_glyph_merged_face_id
= face_id
;
6894 /* Likewise for glyphless glyph face. */
6896 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6897 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6898 static int last_glyphless_glyph_merged_face_id
= 0;
6901 merge_glyphless_glyph_face (struct it
*it
)
6905 if (it
->f
== last_glyphless_glyph_frame
6906 && it
->face_id
== last_glyphless_glyph_face_id
)
6907 face_id
= last_glyphless_glyph_merged_face_id
;
6910 /* Merge the `glyphless-char' face into the current face. */
6911 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6912 last_glyphless_glyph_frame
= it
->f
;
6913 last_glyphless_glyph_face_id
= it
->face_id
;
6914 last_glyphless_glyph_merged_face_id
= face_id
;
6919 /* Load IT's display element fields with information about the next
6920 display element from the current position of IT. Value is zero if
6921 end of buffer (or C string) is reached. */
6924 get_next_display_element (struct it
*it
)
6926 /* Non-zero means that we found a display element. Zero means that
6927 we hit the end of what we iterate over. Performance note: the
6928 function pointer `method' used here turns out to be faster than
6929 using a sequence of if-statements. */
6933 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6935 if (it
->what
== IT_CHARACTER
)
6937 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6938 and only if (a) the resolved directionality of that character
6940 /* FIXME: Do we need an exception for characters from display
6942 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6943 it
->c
= bidi_mirror_char (it
->c
);
6944 /* Map via display table or translate control characters.
6945 IT->c, IT->len etc. have been set to the next character by
6946 the function call above. If we have a display table, and it
6947 contains an entry for IT->c, translate it. Don't do this if
6948 IT->c itself comes from a display table, otherwise we could
6949 end up in an infinite recursion. (An alternative could be to
6950 count the recursion depth of this function and signal an
6951 error when a certain maximum depth is reached.) Is it worth
6953 if (success_p
&& it
->dpvec
== NULL
)
6956 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6957 int nonascii_space_p
= 0;
6958 int nonascii_hyphen_p
= 0;
6959 int c
= it
->c
; /* This is the character to display. */
6961 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6963 eassert (SINGLE_BYTE_CHAR_P (c
));
6964 if (unibyte_display_via_language_environment
)
6966 c
= DECODE_CHAR (unibyte
, c
);
6968 c
= BYTE8_TO_CHAR (it
->c
);
6971 c
= BYTE8_TO_CHAR (it
->c
);
6975 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6978 struct Lisp_Vector
*v
= XVECTOR (dv
);
6980 /* Return the first character from the display table
6981 entry, if not empty. If empty, don't display the
6982 current character. */
6985 it
->dpvec_char_len
= it
->len
;
6986 it
->dpvec
= v
->contents
;
6987 it
->dpend
= v
->contents
+ v
->header
.size
;
6988 it
->current
.dpvec_index
= 0;
6989 it
->dpvec_face_id
= -1;
6990 it
->saved_face_id
= it
->face_id
;
6991 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6996 set_iterator_to_next (it
, 0);
7001 if (! NILP (lookup_glyphless_char_display (c
, it
)))
7003 if (it
->what
== IT_GLYPHLESS
)
7005 /* Don't display this character. */
7006 set_iterator_to_next (it
, 0);
7010 /* If `nobreak-char-display' is non-nil, we display
7011 non-ASCII spaces and hyphens specially. */
7012 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
7015 nonascii_space_p
= true;
7016 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
7017 nonascii_hyphen_p
= true;
7020 /* Translate control characters into `\003' or `^C' form.
7021 Control characters coming from a display table entry are
7022 currently not translated because we use IT->dpvec to hold
7023 the translation. This could easily be changed but I
7024 don't believe that it is worth doing.
7026 The characters handled by `nobreak-char-display' must be
7029 Non-printable characters and raw-byte characters are also
7030 translated to octal form. */
7031 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
7032 ? (it
->area
!= TEXT_AREA
7033 /* In mode line, treat \n, \t like other crl chars. */
7036 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
7037 || (c
!= '\n' && c
!= '\t'))
7039 || nonascii_hyphen_p
7041 || ! CHAR_PRINTABLE_P (c
))))
7043 /* C is a control character, non-ASCII space/hyphen,
7044 raw-byte, or a non-printable character which must be
7045 displayed either as '\003' or as `^C' where the '\\'
7046 and '^' can be defined in the display table. Fill
7047 IT->ctl_chars with glyphs for what we have to
7048 display. Then, set IT->dpvec to these glyphs. */
7055 /* Handle control characters with ^. */
7057 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
7061 g
= '^'; /* default glyph for Control */
7062 /* Set IT->ctl_chars[0] to the glyph for `^'. */
7064 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7066 g
= GLYPH_CODE_CHAR (gc
);
7067 lface_id
= GLYPH_CODE_FACE (gc
);
7071 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7072 : merge_escape_glyph_face (it
));
7074 XSETINT (it
->ctl_chars
[0], g
);
7075 XSETINT (it
->ctl_chars
[1], c
^ 0100);
7077 goto display_control
;
7080 /* Handle non-ascii space in the mode where it only gets
7083 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7085 /* Merge `nobreak-space' into the current face. */
7086 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7088 XSETINT (it
->ctl_chars
[0], ' ');
7090 goto display_control
;
7093 /* Handle sequences that start with the "escape glyph". */
7095 /* the default escape glyph is \. */
7096 escape_glyph
= '\\';
7099 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7101 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7102 lface_id
= GLYPH_CODE_FACE (gc
);
7106 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7107 : merge_escape_glyph_face (it
));
7109 /* Draw non-ASCII hyphen with just highlighting: */
7111 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7113 XSETINT (it
->ctl_chars
[0], '-');
7115 goto display_control
;
7118 /* Draw non-ASCII space/hyphen with escape glyph: */
7120 if (nonascii_space_p
|| nonascii_hyphen_p
)
7122 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7123 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7125 goto display_control
;
7132 if (CHAR_BYTE8_P (c
))
7133 /* Display \200 instead of \17777600. */
7134 c
= CHAR_TO_BYTE8 (c
);
7135 len
= sprintf (str
, "%03o", c
);
7137 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7138 for (i
= 0; i
< len
; i
++)
7139 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7144 /* Set up IT->dpvec and return first character from it. */
7145 it
->dpvec_char_len
= it
->len
;
7146 it
->dpvec
= it
->ctl_chars
;
7147 it
->dpend
= it
->dpvec
+ ctl_len
;
7148 it
->current
.dpvec_index
= 0;
7149 it
->dpvec_face_id
= face_id
;
7150 it
->saved_face_id
= it
->face_id
;
7151 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7155 it
->char_to_display
= c
;
7159 it
->char_to_display
= it
->c
;
7163 #ifdef HAVE_WINDOW_SYSTEM
7164 /* Adjust face id for a multibyte character. There are no multibyte
7165 character in unibyte text. */
7166 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7169 && FRAME_WINDOW_P (it
->f
))
7171 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7173 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7175 /* Automatic composition with glyph-string. */
7176 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7178 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7182 ptrdiff_t pos
= (it
->s
? -1
7183 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7184 : IT_CHARPOS (*it
));
7187 if (it
->what
== IT_CHARACTER
)
7188 c
= it
->char_to_display
;
7191 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7195 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7196 /* TAB in a composition means display glyphs with
7197 padding space on the left or right. */
7198 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7201 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7204 #endif /* HAVE_WINDOW_SYSTEM */
7207 /* Is this character the last one of a run of characters with
7208 box? If yes, set IT->end_of_box_run_p to 1. */
7212 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7214 int face_id
= underlying_face_id (it
);
7215 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7219 if (face
->box
== FACE_NO_BOX
)
7221 /* If the box comes from face properties in a
7222 display string, check faces in that string. */
7223 int string_face_id
= face_after_it_pos (it
);
7224 it
->end_of_box_run_p
7225 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7228 /* Otherwise, the box comes from the underlying face.
7229 If this is the last string character displayed, check
7230 the next buffer location. */
7231 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7232 /* n_overlay_strings is unreliable unless
7233 overlay_string_index is non-negative. */
7234 && ((it
->current
.overlay_string_index
>= 0
7235 && (it
->current
.overlay_string_index
7236 == it
->n_overlay_strings
- 1))
7237 /* A string from display property. */
7238 || it
->from_disp_prop_p
))
7242 struct text_pos pos
= it
->current
.pos
;
7244 /* For a string from a display property, the next
7245 buffer position is stored in the 'position'
7246 member of the iteration stack slot below the
7247 current one, see handle_single_display_spec. By
7248 contrast, it->current.pos was is not yet updated
7249 to point to that buffer position; that will
7250 happen in pop_it, after we finish displaying the
7251 current string. Note that we already checked
7252 above that it->sp is positive, so subtracting one
7254 if (it
->from_disp_prop_p
)
7255 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7257 INC_TEXT_POS (pos
, it
->multibyte_p
);
7259 if (CHARPOS (pos
) >= ZV
)
7260 it
->end_of_box_run_p
= true;
7263 next_face_id
= face_at_buffer_position
7264 (it
->w
, CHARPOS (pos
), &ignore
,
7265 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, 0, -1);
7266 it
->end_of_box_run_p
7267 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7273 /* next_element_from_display_vector sets this flag according to
7274 faces of the display vector glyphs, see there. */
7275 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7277 int face_id
= face_after_it_pos (it
);
7278 it
->end_of_box_run_p
7279 = (face_id
!= it
->face_id
7280 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7283 /* If we reached the end of the object we've been iterating (e.g., a
7284 display string or an overlay string), and there's something on
7285 IT->stack, proceed with what's on the stack. It doesn't make
7286 sense to return zero if there's unprocessed stuff on the stack,
7287 because otherwise that stuff will never be displayed. */
7288 if (!success_p
&& it
->sp
> 0)
7290 set_iterator_to_next (it
, 0);
7291 success_p
= get_next_display_element (it
);
7294 /* Value is 0 if end of buffer or string reached. */
7299 /* Move IT to the next display element.
7301 RESEAT_P non-zero means if called on a newline in buffer text,
7302 skip to the next visible line start.
7304 Functions get_next_display_element and set_iterator_to_next are
7305 separate because I find this arrangement easier to handle than a
7306 get_next_display_element function that also increments IT's
7307 position. The way it is we can first look at an iterator's current
7308 display element, decide whether it fits on a line, and if it does,
7309 increment the iterator position. The other way around we probably
7310 would either need a flag indicating whether the iterator has to be
7311 incremented the next time, or we would have to implement a
7312 decrement position function which would not be easy to write. */
7315 set_iterator_to_next (struct it
*it
, int reseat_p
)
7317 /* Reset flags indicating start and end of a sequence of characters
7318 with box. Reset them at the start of this function because
7319 moving the iterator to a new position might set them. */
7320 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
7324 case GET_FROM_BUFFER
:
7325 /* The current display element of IT is a character from
7326 current_buffer. Advance in the buffer, and maybe skip over
7327 invisible lines that are so because of selective display. */
7328 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7329 reseat_at_next_visible_line_start (it
, 0);
7330 else if (it
->cmp_it
.id
>= 0)
7332 /* We are currently getting glyphs from a composition. */
7337 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7338 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7339 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7341 it
->cmp_it
.from
= it
->cmp_it
.to
;
7346 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7348 it
->end_charpos
, Qnil
);
7351 else if (! it
->cmp_it
.reversed_p
)
7353 /* Composition created while scanning forward. */
7354 /* Update IT's char/byte positions to point to the first
7355 character of the next grapheme cluster, or to the
7356 character visually after the current composition. */
7357 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7358 bidi_move_to_visually_next (&it
->bidi_it
);
7359 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7360 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7362 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7364 /* Proceed to the next grapheme cluster. */
7365 it
->cmp_it
.from
= it
->cmp_it
.to
;
7369 /* No more grapheme clusters in this composition.
7370 Find the next stop position. */
7371 ptrdiff_t stop
= it
->end_charpos
;
7372 if (it
->bidi_it
.scan_dir
< 0)
7373 /* Now we are scanning backward and don't know
7376 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7377 IT_BYTEPOS (*it
), stop
, Qnil
);
7382 /* Composition created while scanning backward. */
7383 /* Update IT's char/byte positions to point to the last
7384 character of the previous grapheme cluster, or the
7385 character visually after the current composition. */
7386 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7387 bidi_move_to_visually_next (&it
->bidi_it
);
7388 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7389 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7390 if (it
->cmp_it
.from
> 0)
7392 /* Proceed to the previous grapheme cluster. */
7393 it
->cmp_it
.to
= it
->cmp_it
.from
;
7397 /* No more grapheme clusters in this composition.
7398 Find the next stop position. */
7399 ptrdiff_t stop
= it
->end_charpos
;
7400 if (it
->bidi_it
.scan_dir
< 0)
7401 /* Now we are scanning backward and don't know
7404 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7405 IT_BYTEPOS (*it
), stop
, Qnil
);
7411 eassert (it
->len
!= 0);
7415 IT_BYTEPOS (*it
) += it
->len
;
7416 IT_CHARPOS (*it
) += 1;
7420 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7421 /* If this is a new paragraph, determine its base
7422 direction (a.k.a. its base embedding level). */
7423 if (it
->bidi_it
.new_paragraph
)
7424 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7425 bidi_move_to_visually_next (&it
->bidi_it
);
7426 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7427 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7428 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7430 /* As the scan direction was changed, we must
7431 re-compute the stop position for composition. */
7432 ptrdiff_t stop
= it
->end_charpos
;
7433 if (it
->bidi_it
.scan_dir
< 0)
7435 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7436 IT_BYTEPOS (*it
), stop
, Qnil
);
7439 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7443 case GET_FROM_C_STRING
:
7444 /* Current display element of IT is from a C string. */
7446 /* If the string position is beyond string's end, it means
7447 next_element_from_c_string is padding the string with
7448 blanks, in which case we bypass the bidi iterator,
7449 because it cannot deal with such virtual characters. */
7450 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7452 IT_BYTEPOS (*it
) += it
->len
;
7453 IT_CHARPOS (*it
) += 1;
7457 bidi_move_to_visually_next (&it
->bidi_it
);
7458 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7459 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7463 case GET_FROM_DISPLAY_VECTOR
:
7464 /* Current display element of IT is from a display table entry.
7465 Advance in the display table definition. Reset it to null if
7466 end reached, and continue with characters from buffers/
7468 ++it
->current
.dpvec_index
;
7470 /* Restore face of the iterator to what they were before the
7471 display vector entry (these entries may contain faces). */
7472 it
->face_id
= it
->saved_face_id
;
7474 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7476 int recheck_faces
= it
->ellipsis_p
;
7479 it
->method
= GET_FROM_C_STRING
;
7480 else if (STRINGP (it
->string
))
7481 it
->method
= GET_FROM_STRING
;
7484 it
->method
= GET_FROM_BUFFER
;
7485 it
->object
= it
->w
->contents
;
7489 it
->current
.dpvec_index
= -1;
7491 /* Skip over characters which were displayed via IT->dpvec. */
7492 if (it
->dpvec_char_len
< 0)
7493 reseat_at_next_visible_line_start (it
, 1);
7494 else if (it
->dpvec_char_len
> 0)
7496 if (it
->method
== GET_FROM_STRING
7497 && it
->current
.overlay_string_index
>= 0
7498 && it
->n_overlay_strings
> 0)
7499 it
->ignore_overlay_strings_at_pos_p
= true;
7500 it
->len
= it
->dpvec_char_len
;
7501 set_iterator_to_next (it
, reseat_p
);
7504 /* Maybe recheck faces after display vector. */
7506 it
->stop_charpos
= IT_CHARPOS (*it
);
7510 case GET_FROM_STRING
:
7511 /* Current display element is a character from a Lisp string. */
7512 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7513 /* Don't advance past string end. These conditions are true
7514 when set_iterator_to_next is called at the end of
7515 get_next_display_element, in which case the Lisp string is
7516 already exhausted, and all we want is pop the iterator
7518 if (it
->current
.overlay_string_index
>= 0)
7520 /* This is an overlay string, so there's no padding with
7521 spaces, and the number of characters in the string is
7522 where the string ends. */
7523 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7524 goto consider_string_end
;
7528 /* Not an overlay string. There could be padding, so test
7529 against it->end_charpos. */
7530 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7531 goto consider_string_end
;
7533 if (it
->cmp_it
.id
>= 0)
7539 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7540 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7541 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7542 it
->cmp_it
.from
= it
->cmp_it
.to
;
7546 composition_compute_stop_pos (&it
->cmp_it
,
7547 IT_STRING_CHARPOS (*it
),
7548 IT_STRING_BYTEPOS (*it
),
7549 it
->end_charpos
, it
->string
);
7552 else if (! it
->cmp_it
.reversed_p
)
7554 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7555 bidi_move_to_visually_next (&it
->bidi_it
);
7556 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7557 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7559 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7560 it
->cmp_it
.from
= it
->cmp_it
.to
;
7563 ptrdiff_t stop
= it
->end_charpos
;
7564 if (it
->bidi_it
.scan_dir
< 0)
7566 composition_compute_stop_pos (&it
->cmp_it
,
7567 IT_STRING_CHARPOS (*it
),
7568 IT_STRING_BYTEPOS (*it
), stop
,
7574 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7575 bidi_move_to_visually_next (&it
->bidi_it
);
7576 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7577 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7578 if (it
->cmp_it
.from
> 0)
7579 it
->cmp_it
.to
= it
->cmp_it
.from
;
7582 ptrdiff_t stop
= it
->end_charpos
;
7583 if (it
->bidi_it
.scan_dir
< 0)
7585 composition_compute_stop_pos (&it
->cmp_it
,
7586 IT_STRING_CHARPOS (*it
),
7587 IT_STRING_BYTEPOS (*it
), stop
,
7595 /* If the string position is beyond string's end, it
7596 means next_element_from_string is padding the string
7597 with blanks, in which case we bypass the bidi
7598 iterator, because it cannot deal with such virtual
7600 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7602 IT_STRING_BYTEPOS (*it
) += it
->len
;
7603 IT_STRING_CHARPOS (*it
) += 1;
7607 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7609 bidi_move_to_visually_next (&it
->bidi_it
);
7610 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7611 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7612 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7614 ptrdiff_t stop
= it
->end_charpos
;
7616 if (it
->bidi_it
.scan_dir
< 0)
7618 composition_compute_stop_pos (&it
->cmp_it
,
7619 IT_STRING_CHARPOS (*it
),
7620 IT_STRING_BYTEPOS (*it
), stop
,
7626 consider_string_end
:
7628 if (it
->current
.overlay_string_index
>= 0)
7630 /* IT->string is an overlay string. Advance to the
7631 next, if there is one. */
7632 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7635 next_overlay_string (it
);
7637 setup_for_ellipsis (it
, 0);
7642 /* IT->string is not an overlay string. If we reached
7643 its end, and there is something on IT->stack, proceed
7644 with what is on the stack. This can be either another
7645 string, this time an overlay string, or a buffer. */
7646 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7650 if (it
->method
== GET_FROM_STRING
)
7651 goto consider_string_end
;
7656 case GET_FROM_IMAGE
:
7657 case GET_FROM_STRETCH
:
7658 /* The position etc with which we have to proceed are on
7659 the stack. The position may be at the end of a string,
7660 if the `display' property takes up the whole string. */
7661 eassert (it
->sp
> 0);
7663 if (it
->method
== GET_FROM_STRING
)
7664 goto consider_string_end
;
7668 /* There are no other methods defined, so this should be a bug. */
7672 eassert (it
->method
!= GET_FROM_STRING
7673 || (STRINGP (it
->string
)
7674 && IT_STRING_CHARPOS (*it
) >= 0));
7677 /* Load IT's display element fields with information about the next
7678 display element which comes from a display table entry or from the
7679 result of translating a control character to one of the forms `^C'
7682 IT->dpvec holds the glyphs to return as characters.
7683 IT->saved_face_id holds the face id before the display vector--it
7684 is restored into IT->face_id in set_iterator_to_next. */
7687 next_element_from_display_vector (struct it
*it
)
7690 int prev_face_id
= it
->face_id
;
7694 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7696 it
->face_id
= it
->saved_face_id
;
7698 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7699 That seemed totally bogus - so I changed it... */
7700 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7702 if (GLYPH_CODE_P (gc
))
7704 struct face
*this_face
, *prev_face
, *next_face
;
7706 it
->c
= GLYPH_CODE_CHAR (gc
);
7707 it
->len
= CHAR_BYTES (it
->c
);
7709 /* The entry may contain a face id to use. Such a face id is
7710 the id of a Lisp face, not a realized face. A face id of
7711 zero means no face is specified. */
7712 if (it
->dpvec_face_id
>= 0)
7713 it
->face_id
= it
->dpvec_face_id
;
7716 int lface_id
= GLYPH_CODE_FACE (gc
);
7718 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7722 /* Glyphs in the display vector could have the box face, so we
7723 need to set the related flags in the iterator, as
7725 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7726 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7728 /* Is this character the first character of a box-face run? */
7729 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7731 || prev_face
->box
== FACE_NO_BOX
));
7733 /* For the last character of the box-face run, we need to look
7734 either at the next glyph from the display vector, or at the
7735 face we saw before the display vector. */
7736 next_face_id
= it
->saved_face_id
;
7737 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7739 if (it
->dpvec_face_id
>= 0)
7740 next_face_id
= it
->dpvec_face_id
;
7744 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7747 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7751 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7752 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7754 || next_face
->box
== FACE_NO_BOX
));
7755 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7758 /* Display table entry is invalid. Return a space. */
7759 it
->c
= ' ', it
->len
= 1;
7761 /* Don't change position and object of the iterator here. They are
7762 still the values of the character that had this display table
7763 entry or was translated, and that's what we want. */
7764 it
->what
= IT_CHARACTER
;
7768 /* Get the first element of string/buffer in the visual order, after
7769 being reseated to a new position in a string or a buffer. */
7771 get_visually_first_element (struct it
*it
)
7773 int string_p
= STRINGP (it
->string
) || it
->s
;
7774 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7775 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7777 if (STRINGP (it
->string
))
7779 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7780 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7784 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7785 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7788 if (it
->bidi_it
.charpos
== eob
)
7790 /* Nothing to do, but reset the FIRST_ELT flag, like
7791 bidi_paragraph_init does, because we are not going to
7793 it
->bidi_it
.first_elt
= 0;
7795 else if (it
->bidi_it
.charpos
== bob
7797 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7798 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7800 /* If we are at the beginning of a line/string, we can produce
7801 the next element right away. */
7802 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7803 bidi_move_to_visually_next (&it
->bidi_it
);
7807 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7809 /* We need to prime the bidi iterator starting at the line's or
7810 string's beginning, before we will be able to produce the
7813 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7815 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7816 IT_BYTEPOS (*it
), -1,
7817 &it
->bidi_it
.bytepos
);
7818 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7821 /* Now return to buffer/string position where we were asked
7822 to get the next display element, and produce that. */
7823 bidi_move_to_visually_next (&it
->bidi_it
);
7825 while (it
->bidi_it
.bytepos
!= orig_bytepos
7826 && it
->bidi_it
.charpos
< eob
);
7829 /* Adjust IT's position information to where we ended up. */
7830 if (STRINGP (it
->string
))
7832 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7833 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7837 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7838 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7841 if (STRINGP (it
->string
) || !it
->s
)
7843 ptrdiff_t stop
, charpos
, bytepos
;
7845 if (STRINGP (it
->string
))
7848 stop
= SCHARS (it
->string
);
7849 if (stop
> it
->end_charpos
)
7850 stop
= it
->end_charpos
;
7851 charpos
= IT_STRING_CHARPOS (*it
);
7852 bytepos
= IT_STRING_BYTEPOS (*it
);
7856 stop
= it
->end_charpos
;
7857 charpos
= IT_CHARPOS (*it
);
7858 bytepos
= IT_BYTEPOS (*it
);
7860 if (it
->bidi_it
.scan_dir
< 0)
7862 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7867 /* Load IT with the next display element from Lisp string IT->string.
7868 IT->current.string_pos is the current position within the string.
7869 If IT->current.overlay_string_index >= 0, the Lisp string is an
7873 next_element_from_string (struct it
*it
)
7875 struct text_pos position
;
7877 eassert (STRINGP (it
->string
));
7878 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7879 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7880 position
= it
->current
.string_pos
;
7882 /* With bidi reordering, the character to display might not be the
7883 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7884 that we were reseat()ed to a new string, whose paragraph
7885 direction is not known. */
7886 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7888 get_visually_first_element (it
);
7889 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7892 /* Time to check for invisible text? */
7893 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7895 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7898 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7899 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7901 /* With bidi non-linear iteration, we could find
7902 ourselves far beyond the last computed stop_charpos,
7903 with several other stop positions in between that we
7904 missed. Scan them all now, in buffer's logical
7905 order, until we find and handle the last stop_charpos
7906 that precedes our current position. */
7907 handle_stop_backwards (it
, it
->stop_charpos
);
7908 return GET_NEXT_DISPLAY_ELEMENT (it
);
7914 /* Take note of the stop position we just moved
7915 across, for when we will move back across it. */
7916 it
->prev_stop
= it
->stop_charpos
;
7917 /* If we are at base paragraph embedding level, take
7918 note of the last stop position seen at this
7920 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7921 it
->base_level_stop
= it
->stop_charpos
;
7925 /* Since a handler may have changed IT->method, we must
7927 return GET_NEXT_DISPLAY_ELEMENT (it
);
7931 /* If we are before prev_stop, we may have overstepped
7932 on our way backwards a stop_pos, and if so, we need
7933 to handle that stop_pos. */
7934 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7935 /* We can sometimes back up for reasons that have nothing
7936 to do with bidi reordering. E.g., compositions. The
7937 code below is only needed when we are above the base
7938 embedding level, so test for that explicitly. */
7939 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7941 /* If we lost track of base_level_stop, we have no better
7942 place for handle_stop_backwards to start from than string
7943 beginning. This happens, e.g., when we were reseated to
7944 the previous screenful of text by vertical-motion. */
7945 if (it
->base_level_stop
<= 0
7946 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7947 it
->base_level_stop
= 0;
7948 handle_stop_backwards (it
, it
->base_level_stop
);
7949 return GET_NEXT_DISPLAY_ELEMENT (it
);
7953 if (it
->current
.overlay_string_index
>= 0)
7955 /* Get the next character from an overlay string. In overlay
7956 strings, there is no field width or padding with spaces to
7958 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7963 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7964 IT_STRING_BYTEPOS (*it
),
7965 it
->bidi_it
.scan_dir
< 0
7967 : SCHARS (it
->string
))
7968 && next_element_from_composition (it
))
7972 else if (STRING_MULTIBYTE (it
->string
))
7974 const unsigned char *s
= (SDATA (it
->string
)
7975 + IT_STRING_BYTEPOS (*it
));
7976 it
->c
= string_char_and_length (s
, &it
->len
);
7980 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7986 /* Get the next character from a Lisp string that is not an
7987 overlay string. Such strings come from the mode line, for
7988 example. We may have to pad with spaces, or truncate the
7989 string. See also next_element_from_c_string. */
7990 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7995 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7997 /* Pad with spaces. */
7998 it
->c
= ' ', it
->len
= 1;
7999 CHARPOS (position
) = BYTEPOS (position
) = -1;
8001 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
8002 IT_STRING_BYTEPOS (*it
),
8003 it
->bidi_it
.scan_dir
< 0
8005 : it
->string_nchars
)
8006 && next_element_from_composition (it
))
8010 else if (STRING_MULTIBYTE (it
->string
))
8012 const unsigned char *s
= (SDATA (it
->string
)
8013 + IT_STRING_BYTEPOS (*it
));
8014 it
->c
= string_char_and_length (s
, &it
->len
);
8018 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
8023 /* Record what we have and where it came from. */
8024 it
->what
= IT_CHARACTER
;
8025 it
->object
= it
->string
;
8026 it
->position
= position
;
8031 /* Load IT with next display element from C string IT->s.
8032 IT->string_nchars is the maximum number of characters to return
8033 from the string. IT->end_charpos may be greater than
8034 IT->string_nchars when this function is called, in which case we
8035 may have to return padding spaces. Value is zero if end of string
8036 reached, including padding spaces. */
8039 next_element_from_c_string (struct it
*it
)
8041 bool success_p
= true;
8044 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
8045 it
->what
= IT_CHARACTER
;
8046 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
8049 /* With bidi reordering, the character to display might not be the
8050 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8051 we were reseated to a new string, whose paragraph direction is
8053 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8054 get_visually_first_element (it
);
8056 /* IT's position can be greater than IT->string_nchars in case a
8057 field width or precision has been specified when the iterator was
8059 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8061 /* End of the game. */
8065 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
8067 /* Pad with spaces. */
8068 it
->c
= ' ', it
->len
= 1;
8069 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
8071 else if (it
->multibyte_p
)
8072 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
8074 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
8080 /* Set up IT to return characters from an ellipsis, if appropriate.
8081 The definition of the ellipsis glyphs may come from a display table
8082 entry. This function fills IT with the first glyph from the
8083 ellipsis if an ellipsis is to be displayed. */
8086 next_element_from_ellipsis (struct it
*it
)
8088 if (it
->selective_display_ellipsis_p
)
8089 setup_for_ellipsis (it
, it
->len
);
8092 /* The face at the current position may be different from the
8093 face we find after the invisible text. Remember what it
8094 was in IT->saved_face_id, and signal that it's there by
8095 setting face_before_selective_p. */
8096 it
->saved_face_id
= it
->face_id
;
8097 it
->method
= GET_FROM_BUFFER
;
8098 it
->object
= it
->w
->contents
;
8099 reseat_at_next_visible_line_start (it
, 1);
8100 it
->face_before_selective_p
= true;
8103 return GET_NEXT_DISPLAY_ELEMENT (it
);
8107 /* Deliver an image display element. The iterator IT is already
8108 filled with image information (done in handle_display_prop). Value
8113 next_element_from_image (struct it
*it
)
8115 it
->what
= IT_IMAGE
;
8116 it
->ignore_overlay_strings_at_pos_p
= 0;
8121 /* Fill iterator IT with next display element from a stretch glyph
8122 property. IT->object is the value of the text property. Value is
8126 next_element_from_stretch (struct it
*it
)
8128 it
->what
= IT_STRETCH
;
8132 /* Scan backwards from IT's current position until we find a stop
8133 position, or until BEGV. This is called when we find ourself
8134 before both the last known prev_stop and base_level_stop while
8135 reordering bidirectional text. */
8138 compute_stop_pos_backwards (struct it
*it
)
8140 const int SCAN_BACK_LIMIT
= 1000;
8141 struct text_pos pos
;
8142 struct display_pos save_current
= it
->current
;
8143 struct text_pos save_position
= it
->position
;
8144 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8145 ptrdiff_t where_we_are
= charpos
;
8146 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8147 ptrdiff_t save_end_pos
= it
->end_charpos
;
8149 eassert (NILP (it
->string
) && !it
->s
);
8150 eassert (it
->bidi_p
);
8154 it
->end_charpos
= min (charpos
+ 1, ZV
);
8155 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8156 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8157 reseat_1 (it
, pos
, 0);
8158 compute_stop_pos (it
);
8159 /* We must advance forward, right? */
8160 if (it
->stop_charpos
<= charpos
)
8163 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8165 if (it
->stop_charpos
<= where_we_are
)
8166 it
->prev_stop
= it
->stop_charpos
;
8168 it
->prev_stop
= BEGV
;
8170 it
->current
= save_current
;
8171 it
->position
= save_position
;
8172 it
->stop_charpos
= save_stop_pos
;
8173 it
->end_charpos
= save_end_pos
;
8176 /* Scan forward from CHARPOS in the current buffer/string, until we
8177 find a stop position > current IT's position. Then handle the stop
8178 position before that. This is called when we bump into a stop
8179 position while reordering bidirectional text. CHARPOS should be
8180 the last previously processed stop_pos (or BEGV/0, if none were
8181 processed yet) whose position is less that IT's current
8185 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8187 int bufp
= !STRINGP (it
->string
);
8188 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8189 struct display_pos save_current
= it
->current
;
8190 struct text_pos save_position
= it
->position
;
8191 struct text_pos pos1
;
8192 ptrdiff_t next_stop
;
8194 /* Scan in strict logical order. */
8195 eassert (it
->bidi_p
);
8199 it
->prev_stop
= charpos
;
8202 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8203 reseat_1 (it
, pos1
, 0);
8206 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8207 compute_stop_pos (it
);
8208 /* We must advance forward, right? */
8209 if (it
->stop_charpos
<= it
->prev_stop
)
8211 charpos
= it
->stop_charpos
;
8213 while (charpos
<= where_we_are
);
8216 it
->current
= save_current
;
8217 it
->position
= save_position
;
8218 next_stop
= it
->stop_charpos
;
8219 it
->stop_charpos
= it
->prev_stop
;
8221 it
->stop_charpos
= next_stop
;
8224 /* Load IT with the next display element from current_buffer. Value
8225 is zero if end of buffer reached. IT->stop_charpos is the next
8226 position at which to stop and check for text properties or buffer
8230 next_element_from_buffer (struct it
*it
)
8232 bool success_p
= true;
8234 eassert (IT_CHARPOS (*it
) >= BEGV
);
8235 eassert (NILP (it
->string
) && !it
->s
);
8236 eassert (!it
->bidi_p
8237 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8238 && it
->bidi_it
.string
.s
== NULL
));
8240 /* With bidi reordering, the character to display might not be the
8241 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8242 we were reseat()ed to a new buffer position, which is potentially
8243 a different paragraph. */
8244 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8246 get_visually_first_element (it
);
8247 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8250 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8252 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8254 int overlay_strings_follow_p
;
8256 /* End of the game, except when overlay strings follow that
8257 haven't been returned yet. */
8258 if (it
->overlay_strings_at_end_processed_p
)
8259 overlay_strings_follow_p
= 0;
8262 it
->overlay_strings_at_end_processed_p
= true;
8263 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8266 if (overlay_strings_follow_p
)
8267 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8271 it
->position
= it
->current
.pos
;
8275 else if (!(!it
->bidi_p
8276 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8277 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8279 /* With bidi non-linear iteration, we could find ourselves
8280 far beyond the last computed stop_charpos, with several
8281 other stop positions in between that we missed. Scan
8282 them all now, in buffer's logical order, until we find
8283 and handle the last stop_charpos that precedes our
8284 current position. */
8285 handle_stop_backwards (it
, it
->stop_charpos
);
8286 return GET_NEXT_DISPLAY_ELEMENT (it
);
8292 /* Take note of the stop position we just moved across,
8293 for when we will move back across it. */
8294 it
->prev_stop
= it
->stop_charpos
;
8295 /* If we are at base paragraph embedding level, take
8296 note of the last stop position seen at this
8298 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8299 it
->base_level_stop
= it
->stop_charpos
;
8302 return GET_NEXT_DISPLAY_ELEMENT (it
);
8306 /* If we are before prev_stop, we may have overstepped on
8307 our way backwards a stop_pos, and if so, we need to
8308 handle that stop_pos. */
8309 && IT_CHARPOS (*it
) < it
->prev_stop
8310 /* We can sometimes back up for reasons that have nothing
8311 to do with bidi reordering. E.g., compositions. The
8312 code below is only needed when we are above the base
8313 embedding level, so test for that explicitly. */
8314 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8316 if (it
->base_level_stop
<= 0
8317 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8319 /* If we lost track of base_level_stop, we need to find
8320 prev_stop by looking backwards. This happens, e.g., when
8321 we were reseated to the previous screenful of text by
8323 it
->base_level_stop
= BEGV
;
8324 compute_stop_pos_backwards (it
);
8325 handle_stop_backwards (it
, it
->prev_stop
);
8328 handle_stop_backwards (it
, it
->base_level_stop
);
8329 return GET_NEXT_DISPLAY_ELEMENT (it
);
8333 /* No face changes, overlays etc. in sight, so just return a
8334 character from current_buffer. */
8338 /* We moved to the next buffer position, so any info about
8339 previously seen overlays is no longer valid. */
8340 it
->ignore_overlay_strings_at_pos_p
= 0;
8342 /* Maybe run the redisplay end trigger hook. Performance note:
8343 This doesn't seem to cost measurable time. */
8344 if (it
->redisplay_end_trigger_charpos
8346 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8347 run_redisplay_end_trigger_hook (it
);
8349 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8350 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8352 && next_element_from_composition (it
))
8357 /* Get the next character, maybe multibyte. */
8358 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8359 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
8360 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8362 it
->c
= *p
, it
->len
= 1;
8364 /* Record what we have and where it came from. */
8365 it
->what
= IT_CHARACTER
;
8366 it
->object
= it
->w
->contents
;
8367 it
->position
= it
->current
.pos
;
8369 /* Normally we return the character found above, except when we
8370 really want to return an ellipsis for selective display. */
8375 /* A value of selective > 0 means hide lines indented more
8376 than that number of columns. */
8377 if (it
->selective
> 0
8378 && IT_CHARPOS (*it
) + 1 < ZV
8379 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8380 IT_BYTEPOS (*it
) + 1,
8383 success_p
= next_element_from_ellipsis (it
);
8384 it
->dpvec_char_len
= -1;
8387 else if (it
->c
== '\r' && it
->selective
== -1)
8389 /* A value of selective == -1 means that everything from the
8390 CR to the end of the line is invisible, with maybe an
8391 ellipsis displayed for it. */
8392 success_p
= next_element_from_ellipsis (it
);
8393 it
->dpvec_char_len
= -1;
8398 /* Value is zero if end of buffer reached. */
8399 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8404 /* Run the redisplay end trigger hook for IT. */
8407 run_redisplay_end_trigger_hook (struct it
*it
)
8409 Lisp_Object args
[3];
8411 /* IT->glyph_row should be non-null, i.e. we should be actually
8412 displaying something, or otherwise we should not run the hook. */
8413 eassert (it
->glyph_row
);
8415 /* Set up hook arguments. */
8416 args
[0] = Qredisplay_end_trigger_functions
;
8417 args
[1] = it
->window
;
8418 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8419 it
->redisplay_end_trigger_charpos
= 0;
8421 /* Since we are *trying* to run these functions, don't try to run
8422 them again, even if they get an error. */
8423 wset_redisplay_end_trigger (it
->w
, Qnil
);
8424 Frun_hook_with_args (3, args
);
8426 /* Notice if it changed the face of the character we are on. */
8427 handle_face_prop (it
);
8431 /* Deliver a composition display element. Unlike the other
8432 next_element_from_XXX, this function is not registered in the array
8433 get_next_element[]. It is called from next_element_from_buffer and
8434 next_element_from_string when necessary. */
8437 next_element_from_composition (struct it
*it
)
8439 it
->what
= IT_COMPOSITION
;
8440 it
->len
= it
->cmp_it
.nbytes
;
8441 if (STRINGP (it
->string
))
8445 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8446 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8449 it
->position
= it
->current
.string_pos
;
8450 it
->object
= it
->string
;
8451 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8452 IT_STRING_BYTEPOS (*it
), it
->string
);
8458 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8459 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8462 if (it
->bidi_it
.new_paragraph
)
8463 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8464 /* Resync the bidi iterator with IT's new position.
8465 FIXME: this doesn't support bidirectional text. */
8466 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8467 bidi_move_to_visually_next (&it
->bidi_it
);
8471 it
->position
= it
->current
.pos
;
8472 it
->object
= it
->w
->contents
;
8473 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8474 IT_BYTEPOS (*it
), Qnil
);
8481 /***********************************************************************
8482 Moving an iterator without producing glyphs
8483 ***********************************************************************/
8485 /* Check if iterator is at a position corresponding to a valid buffer
8486 position after some move_it_ call. */
8488 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8489 ((it)->method == GET_FROM_STRING \
8490 ? IT_STRING_CHARPOS (*it) == 0 \
8494 /* Move iterator IT to a specified buffer or X position within one
8495 line on the display without producing glyphs.
8497 OP should be a bit mask including some or all of these bits:
8498 MOVE_TO_X: Stop upon reaching x-position TO_X.
8499 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8500 Regardless of OP's value, stop upon reaching the end of the display line.
8502 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8503 This means, in particular, that TO_X includes window's horizontal
8506 The return value has several possible values that
8507 say what condition caused the scan to stop:
8509 MOVE_POS_MATCH_OR_ZV
8510 - when TO_POS or ZV was reached.
8513 -when TO_X was reached before TO_POS or ZV were reached.
8516 - when we reached the end of the display area and the line must
8520 - when we reached the end of the display area and the line is
8524 - when we stopped at a line end, i.e. a newline or a CR and selective
8527 static enum move_it_result
8528 move_it_in_display_line_to (struct it
*it
,
8529 ptrdiff_t to_charpos
, int to_x
,
8530 enum move_operation_enum op
)
8532 enum move_it_result result
= MOVE_UNDEFINED
;
8533 struct glyph_row
*saved_glyph_row
;
8534 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8535 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8536 void *ppos_data
= NULL
;
8538 enum it_method prev_method
= it
->method
;
8539 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8540 int saw_smaller_pos
= prev_pos
< to_charpos
;
8542 /* Don't produce glyphs in produce_glyphs. */
8543 saved_glyph_row
= it
->glyph_row
;
8544 it
->glyph_row
= NULL
;
8546 /* Use wrap_it to save a copy of IT wherever a word wrap could
8547 occur. Use atpos_it to save a copy of IT at the desired buffer
8548 position, if found, so that we can scan ahead and check if the
8549 word later overshoots the window edge. Use atx_it similarly, for
8555 /* Use ppos_it under bidi reordering to save a copy of IT for the
8556 initial position. We restore that position in IT when we have
8557 scanned the entire display line without finding a match for
8558 TO_CHARPOS and all the character positions are greater than
8559 TO_CHARPOS. We then restart the scan from the initial position,
8560 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8561 the closest to TO_CHARPOS. */
8564 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8566 SAVE_IT (ppos_it
, *it
, ppos_data
);
8567 closest_pos
= IT_CHARPOS (*it
);
8573 #define BUFFER_POS_REACHED_P() \
8574 ((op & MOVE_TO_POS) != 0 \
8575 && BUFFERP (it->object) \
8576 && (IT_CHARPOS (*it) == to_charpos \
8578 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8579 && IT_CHARPOS (*it) > to_charpos) \
8580 || (it->what == IT_COMPOSITION \
8581 && ((IT_CHARPOS (*it) > to_charpos \
8582 && to_charpos >= it->cmp_it.charpos) \
8583 || (IT_CHARPOS (*it) < to_charpos \
8584 && to_charpos <= it->cmp_it.charpos)))) \
8585 && (it->method == GET_FROM_BUFFER \
8586 || (it->method == GET_FROM_DISPLAY_VECTOR \
8587 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8589 /* If there's a line-/wrap-prefix, handle it. */
8590 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8591 && it
->current_y
< it
->last_visible_y
)
8592 handle_line_prefix (it
);
8594 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8595 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8599 int x
, i
, ascent
= 0, descent
= 0;
8601 /* Utility macro to reset an iterator with x, ascent, and descent. */
8602 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8603 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8604 (IT)->max_descent = descent)
8606 /* Stop if we move beyond TO_CHARPOS (after an image or a
8607 display string or stretch glyph). */
8608 if ((op
& MOVE_TO_POS
) != 0
8609 && BUFFERP (it
->object
)
8610 && it
->method
== GET_FROM_BUFFER
8612 /* When the iterator is at base embedding level, we
8613 are guaranteed that characters are delivered for
8614 display in strictly increasing order of their
8615 buffer positions. */
8616 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8617 && IT_CHARPOS (*it
) > to_charpos
)
8619 && (prev_method
== GET_FROM_IMAGE
8620 || prev_method
== GET_FROM_STRETCH
8621 || prev_method
== GET_FROM_STRING
)
8622 /* Passed TO_CHARPOS from left to right. */
8623 && ((prev_pos
< to_charpos
8624 && IT_CHARPOS (*it
) > to_charpos
)
8625 /* Passed TO_CHARPOS from right to left. */
8626 || (prev_pos
> to_charpos
8627 && IT_CHARPOS (*it
) < to_charpos
)))))
8629 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8631 result
= MOVE_POS_MATCH_OR_ZV
;
8634 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8635 /* If wrap_it is valid, the current position might be in a
8636 word that is wrapped. So, save the iterator in
8637 atpos_it and continue to see if wrapping happens. */
8638 SAVE_IT (atpos_it
, *it
, atpos_data
);
8641 /* Stop when ZV reached.
8642 We used to stop here when TO_CHARPOS reached as well, but that is
8643 too soon if this glyph does not fit on this line. So we handle it
8644 explicitly below. */
8645 if (!get_next_display_element (it
))
8647 result
= MOVE_POS_MATCH_OR_ZV
;
8651 if (it
->line_wrap
== TRUNCATE
)
8653 if (BUFFER_POS_REACHED_P ())
8655 result
= MOVE_POS_MATCH_OR_ZV
;
8661 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8663 if (IT_DISPLAYING_WHITESPACE (it
))
8667 /* We have reached a glyph that follows one or more
8668 whitespace characters. If the position is
8669 already found, we are done. */
8670 if (atpos_it
.sp
>= 0)
8672 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8673 result
= MOVE_POS_MATCH_OR_ZV
;
8678 RESTORE_IT (it
, &atx_it
, atx_data
);
8679 result
= MOVE_X_REACHED
;
8682 /* Otherwise, we can wrap here. */
8683 SAVE_IT (wrap_it
, *it
, wrap_data
);
8689 /* Remember the line height for the current line, in case
8690 the next element doesn't fit on the line. */
8691 ascent
= it
->max_ascent
;
8692 descent
= it
->max_descent
;
8694 /* The call to produce_glyphs will get the metrics of the
8695 display element IT is loaded with. Record the x-position
8696 before this display element, in case it doesn't fit on the
8700 PRODUCE_GLYPHS (it
);
8702 if (it
->area
!= TEXT_AREA
)
8704 prev_method
= it
->method
;
8705 if (it
->method
== GET_FROM_BUFFER
)
8706 prev_pos
= IT_CHARPOS (*it
);
8707 set_iterator_to_next (it
, 1);
8708 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8709 SET_TEXT_POS (this_line_min_pos
,
8710 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8712 && (op
& MOVE_TO_POS
)
8713 && IT_CHARPOS (*it
) > to_charpos
8714 && IT_CHARPOS (*it
) < closest_pos
)
8715 closest_pos
= IT_CHARPOS (*it
);
8719 /* The number of glyphs we get back in IT->nglyphs will normally
8720 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8721 character on a terminal frame, or (iii) a line end. For the
8722 second case, IT->nglyphs - 1 padding glyphs will be present.
8723 (On X frames, there is only one glyph produced for a
8724 composite character.)
8726 The behavior implemented below means, for continuation lines,
8727 that as many spaces of a TAB as fit on the current line are
8728 displayed there. For terminal frames, as many glyphs of a
8729 multi-glyph character are displayed in the current line, too.
8730 This is what the old redisplay code did, and we keep it that
8731 way. Under X, the whole shape of a complex character must
8732 fit on the line or it will be completely displayed in the
8735 Note that both for tabs and padding glyphs, all glyphs have
8739 /* More than one glyph or glyph doesn't fit on line. All
8740 glyphs have the same width. */
8741 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8743 int x_before_this_char
= x
;
8744 int hpos_before_this_char
= it
->hpos
;
8746 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8748 new_x
= x
+ single_glyph_width
;
8750 /* We want to leave anything reaching TO_X to the caller. */
8751 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8753 if (BUFFER_POS_REACHED_P ())
8755 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8756 goto buffer_pos_reached
;
8757 if (atpos_it
.sp
< 0)
8759 SAVE_IT (atpos_it
, *it
, atpos_data
);
8760 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8765 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8768 result
= MOVE_X_REACHED
;
8773 SAVE_IT (atx_it
, *it
, atx_data
);
8774 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8779 if (/* Lines are continued. */
8780 it
->line_wrap
!= TRUNCATE
8781 && (/* And glyph doesn't fit on the line. */
8782 new_x
> it
->last_visible_x
8783 /* Or it fits exactly and we're on a window
8785 || (new_x
== it
->last_visible_x
8786 && FRAME_WINDOW_P (it
->f
)
8787 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8788 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8789 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8791 if (/* IT->hpos == 0 means the very first glyph
8792 doesn't fit on the line, e.g. a wide image. */
8794 || (new_x
== it
->last_visible_x
8795 && FRAME_WINDOW_P (it
->f
)
8796 /* When word-wrap is ON and we have a valid
8797 wrap point, we don't allow the last glyph
8798 to "just barely fit" on the line. */
8799 && (it
->line_wrap
!= WORD_WRAP
8800 || wrap_it
.sp
< 0)))
8803 it
->current_x
= new_x
;
8805 /* The character's last glyph just barely fits
8807 if (i
== it
->nglyphs
- 1)
8809 /* If this is the destination position,
8810 return a position *before* it in this row,
8811 now that we know it fits in this row. */
8812 if (BUFFER_POS_REACHED_P ())
8814 if (it
->line_wrap
!= WORD_WRAP
8817 it
->hpos
= hpos_before_this_char
;
8818 it
->current_x
= x_before_this_char
;
8819 result
= MOVE_POS_MATCH_OR_ZV
;
8822 if (it
->line_wrap
== WORD_WRAP
8825 SAVE_IT (atpos_it
, *it
, atpos_data
);
8826 atpos_it
.current_x
= x_before_this_char
;
8827 atpos_it
.hpos
= hpos_before_this_char
;
8831 prev_method
= it
->method
;
8832 if (it
->method
== GET_FROM_BUFFER
)
8833 prev_pos
= IT_CHARPOS (*it
);
8834 set_iterator_to_next (it
, 1);
8835 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8836 SET_TEXT_POS (this_line_min_pos
,
8837 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8838 /* On graphical terminals, newlines may
8839 "overflow" into the fringe if
8840 overflow-newline-into-fringe is non-nil.
8841 On text terminals, and on graphical
8842 terminals with no right margin, newlines
8843 may overflow into the last glyph on the
8845 if (!FRAME_WINDOW_P (it
->f
)
8847 && it
->bidi_it
.paragraph_dir
== R2L
)
8848 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8849 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8850 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8852 if (!get_next_display_element (it
))
8854 result
= MOVE_POS_MATCH_OR_ZV
;
8857 if (BUFFER_POS_REACHED_P ())
8859 if (ITERATOR_AT_END_OF_LINE_P (it
))
8860 result
= MOVE_POS_MATCH_OR_ZV
;
8862 result
= MOVE_LINE_CONTINUED
;
8865 if (ITERATOR_AT_END_OF_LINE_P (it
)
8866 && (it
->line_wrap
!= WORD_WRAP
8869 result
= MOVE_NEWLINE_OR_CR
;
8876 IT_RESET_X_ASCENT_DESCENT (it
);
8878 if (wrap_it
.sp
>= 0)
8880 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8885 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8887 result
= MOVE_LINE_CONTINUED
;
8891 if (BUFFER_POS_REACHED_P ())
8893 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8894 goto buffer_pos_reached
;
8895 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8897 SAVE_IT (atpos_it
, *it
, atpos_data
);
8898 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8902 if (new_x
> it
->first_visible_x
)
8904 /* Glyph is visible. Increment number of glyphs that
8905 would be displayed. */
8910 if (result
!= MOVE_UNDEFINED
)
8913 else if (BUFFER_POS_REACHED_P ())
8916 IT_RESET_X_ASCENT_DESCENT (it
);
8917 result
= MOVE_POS_MATCH_OR_ZV
;
8920 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8922 /* Stop when TO_X specified and reached. This check is
8923 necessary here because of lines consisting of a line end,
8924 only. The line end will not produce any glyphs and we
8925 would never get MOVE_X_REACHED. */
8926 eassert (it
->nglyphs
== 0);
8927 result
= MOVE_X_REACHED
;
8931 /* Is this a line end? If yes, we're done. */
8932 if (ITERATOR_AT_END_OF_LINE_P (it
))
8934 /* If we are past TO_CHARPOS, but never saw any character
8935 positions smaller than TO_CHARPOS, return
8936 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8938 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8940 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8942 if (closest_pos
< ZV
)
8944 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8945 /* Don't recurse if closest_pos is equal to
8946 to_charpos, since we have just tried that. */
8947 if (closest_pos
!= to_charpos
)
8948 move_it_in_display_line_to (it
, closest_pos
, -1,
8950 result
= MOVE_POS_MATCH_OR_ZV
;
8953 goto buffer_pos_reached
;
8955 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8956 && IT_CHARPOS (*it
) > to_charpos
)
8957 goto buffer_pos_reached
;
8959 result
= MOVE_NEWLINE_OR_CR
;
8962 result
= MOVE_NEWLINE_OR_CR
;
8966 prev_method
= it
->method
;
8967 if (it
->method
== GET_FROM_BUFFER
)
8968 prev_pos
= IT_CHARPOS (*it
);
8969 /* The current display element has been consumed. Advance
8971 set_iterator_to_next (it
, 1);
8972 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8973 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8974 if (IT_CHARPOS (*it
) < to_charpos
)
8975 saw_smaller_pos
= 1;
8977 && (op
& MOVE_TO_POS
)
8978 && IT_CHARPOS (*it
) >= to_charpos
8979 && IT_CHARPOS (*it
) < closest_pos
)
8980 closest_pos
= IT_CHARPOS (*it
);
8982 /* Stop if lines are truncated and IT's current x-position is
8983 past the right edge of the window now. */
8984 if (it
->line_wrap
== TRUNCATE
8985 && it
->current_x
>= it
->last_visible_x
)
8987 if (!FRAME_WINDOW_P (it
->f
)
8988 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8989 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8990 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8991 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8995 if ((at_eob_p
= !get_next_display_element (it
))
8996 || BUFFER_POS_REACHED_P ()
8997 /* If we are past TO_CHARPOS, but never saw any
8998 character positions smaller than TO_CHARPOS,
8999 return MOVE_POS_MATCH_OR_ZV, like the
9000 unidirectional display did. */
9001 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
9003 && IT_CHARPOS (*it
) > to_charpos
))
9006 && !BUFFER_POS_REACHED_P ()
9007 && !at_eob_p
&& closest_pos
< ZV
)
9009 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9010 if (closest_pos
!= to_charpos
)
9011 move_it_in_display_line_to (it
, closest_pos
, -1,
9014 result
= MOVE_POS_MATCH_OR_ZV
;
9017 if (ITERATOR_AT_END_OF_LINE_P (it
))
9019 result
= MOVE_NEWLINE_OR_CR
;
9023 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
9025 && IT_CHARPOS (*it
) > to_charpos
)
9027 if (closest_pos
< ZV
)
9029 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9030 if (closest_pos
!= to_charpos
)
9031 move_it_in_display_line_to (it
, closest_pos
, -1,
9034 result
= MOVE_POS_MATCH_OR_ZV
;
9037 result
= MOVE_LINE_TRUNCATED
;
9040 #undef IT_RESET_X_ASCENT_DESCENT
9043 #undef BUFFER_POS_REACHED_P
9045 /* If we scanned beyond to_pos and didn't find a point to wrap at,
9046 restore the saved iterator. */
9047 if (atpos_it
.sp
>= 0)
9048 RESTORE_IT (it
, &atpos_it
, atpos_data
);
9049 else if (atx_it
.sp
>= 0)
9050 RESTORE_IT (it
, &atx_it
, atx_data
);
9055 bidi_unshelve_cache (atpos_data
, 1);
9057 bidi_unshelve_cache (atx_data
, 1);
9059 bidi_unshelve_cache (wrap_data
, 1);
9061 bidi_unshelve_cache (ppos_data
, 1);
9063 /* Restore the iterator settings altered at the beginning of this
9065 it
->glyph_row
= saved_glyph_row
;
9069 /* For external use. */
9071 move_it_in_display_line (struct it
*it
,
9072 ptrdiff_t to_charpos
, int to_x
,
9073 enum move_operation_enum op
)
9075 if (it
->line_wrap
== WORD_WRAP
9076 && (op
& MOVE_TO_X
))
9079 void *save_data
= NULL
;
9082 SAVE_IT (save_it
, *it
, save_data
);
9083 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9084 /* When word-wrap is on, TO_X may lie past the end
9085 of a wrapped line. Then it->current is the
9086 character on the next line, so backtrack to the
9087 space before the wrap point. */
9088 if (skip
== MOVE_LINE_CONTINUED
)
9090 int prev_x
= max (it
->current_x
- 1, 0);
9091 RESTORE_IT (it
, &save_it
, save_data
);
9092 move_it_in_display_line_to
9093 (it
, -1, prev_x
, MOVE_TO_X
);
9096 bidi_unshelve_cache (save_data
, 1);
9099 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9103 /* Move IT forward until it satisfies one or more of the criteria in
9104 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9106 OP is a bit-mask that specifies where to stop, and in particular,
9107 which of those four position arguments makes a difference. See the
9108 description of enum move_operation_enum.
9110 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9111 screen line, this function will set IT to the next position that is
9112 displayed to the right of TO_CHARPOS on the screen.
9114 Return the maximum pixel length of any line scanned but never more
9115 than it.last_visible_x. */
9118 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9120 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9121 int line_height
, line_start_x
= 0, reached
= 0;
9122 int max_current_x
= 0;
9123 void *backup_data
= NULL
;
9127 if (op
& MOVE_TO_VPOS
)
9129 /* If no TO_CHARPOS and no TO_X specified, stop at the
9130 start of the line TO_VPOS. */
9131 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9133 if (it
->vpos
== to_vpos
)
9139 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9143 /* TO_VPOS >= 0 means stop at TO_X in the line at
9144 TO_VPOS, or at TO_POS, whichever comes first. */
9145 if (it
->vpos
== to_vpos
)
9151 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9153 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9158 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9160 /* We have reached TO_X but not in the line we want. */
9161 skip
= move_it_in_display_line_to (it
, to_charpos
,
9163 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9171 else if (op
& MOVE_TO_Y
)
9173 struct it it_backup
;
9175 if (it
->line_wrap
== WORD_WRAP
)
9176 SAVE_IT (it_backup
, *it
, backup_data
);
9178 /* TO_Y specified means stop at TO_X in the line containing
9179 TO_Y---or at TO_CHARPOS if this is reached first. The
9180 problem is that we can't really tell whether the line
9181 contains TO_Y before we have completely scanned it, and
9182 this may skip past TO_X. What we do is to first scan to
9185 If TO_X is not specified, use a TO_X of zero. The reason
9186 is to make the outcome of this function more predictable.
9187 If we didn't use TO_X == 0, we would stop at the end of
9188 the line which is probably not what a caller would expect
9190 skip
= move_it_in_display_line_to
9191 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9192 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9194 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9195 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9197 else if (skip
== MOVE_X_REACHED
)
9199 /* If TO_X was reached, we want to know whether TO_Y is
9200 in the line. We know this is the case if the already
9201 scanned glyphs make the line tall enough. Otherwise,
9202 we must check by scanning the rest of the line. */
9203 line_height
= it
->max_ascent
+ it
->max_descent
;
9204 if (to_y
>= it
->current_y
9205 && to_y
< it
->current_y
+ line_height
)
9210 SAVE_IT (it_backup
, *it
, backup_data
);
9211 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9212 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9214 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9215 line_height
= it
->max_ascent
+ it
->max_descent
;
9216 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9218 if (to_y
>= it
->current_y
9219 && to_y
< it
->current_y
+ line_height
)
9221 /* If TO_Y is in this line and TO_X was reached
9222 above, we scanned too far. We have to restore
9223 IT's settings to the ones before skipping. But
9224 keep the more accurate values of max_ascent and
9225 max_descent we've found while skipping the rest
9226 of the line, for the sake of callers, such as
9227 pos_visible_p, that need to know the line
9229 int max_ascent
= it
->max_ascent
;
9230 int max_descent
= it
->max_descent
;
9232 RESTORE_IT (it
, &it_backup
, backup_data
);
9233 it
->max_ascent
= max_ascent
;
9234 it
->max_descent
= max_descent
;
9240 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9246 /* Check whether TO_Y is in this line. */
9247 line_height
= it
->max_ascent
+ it
->max_descent
;
9248 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9250 if (to_y
>= it
->current_y
9251 && to_y
< it
->current_y
+ line_height
)
9253 if (to_y
> it
->current_y
)
9254 max_current_x
= max (it
->current_x
, max_current_x
);
9256 /* When word-wrap is on, TO_X may lie past the end
9257 of a wrapped line. Then it->current is the
9258 character on the next line, so backtrack to the
9259 space before the wrap point. */
9260 if (skip
== MOVE_LINE_CONTINUED
9261 && it
->line_wrap
== WORD_WRAP
)
9263 int prev_x
= max (it
->current_x
- 1, 0);
9264 RESTORE_IT (it
, &it_backup
, backup_data
);
9265 skip
= move_it_in_display_line_to
9266 (it
, -1, prev_x
, MOVE_TO_X
);
9275 max_current_x
= max (it
->current_x
, max_current_x
);
9279 else if (BUFFERP (it
->object
)
9280 && (it
->method
== GET_FROM_BUFFER
9281 || it
->method
== GET_FROM_STRETCH
)
9282 && IT_CHARPOS (*it
) >= to_charpos
9283 /* Under bidi iteration, a call to set_iterator_to_next
9284 can scan far beyond to_charpos if the initial
9285 portion of the next line needs to be reordered. In
9286 that case, give move_it_in_display_line_to another
9289 && it
->bidi_it
.scan_dir
== -1))
9290 skip
= MOVE_POS_MATCH_OR_ZV
;
9292 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9296 case MOVE_POS_MATCH_OR_ZV
:
9297 max_current_x
= max (it
->current_x
, max_current_x
);
9301 case MOVE_NEWLINE_OR_CR
:
9302 max_current_x
= max (it
->current_x
, max_current_x
);
9303 set_iterator_to_next (it
, 1);
9304 it
->continuation_lines_width
= 0;
9307 case MOVE_LINE_TRUNCATED
:
9308 max_current_x
= it
->last_visible_x
;
9309 it
->continuation_lines_width
= 0;
9310 reseat_at_next_visible_line_start (it
, 0);
9311 if ((op
& MOVE_TO_POS
) != 0
9312 && IT_CHARPOS (*it
) > to_charpos
)
9319 case MOVE_LINE_CONTINUED
:
9320 max_current_x
= it
->last_visible_x
;
9321 /* For continued lines ending in a tab, some of the glyphs
9322 associated with the tab are displayed on the current
9323 line. Since it->current_x does not include these glyphs,
9324 we use it->last_visible_x instead. */
9327 it
->continuation_lines_width
+= it
->last_visible_x
;
9328 /* When moving by vpos, ensure that the iterator really
9329 advances to the next line (bug#847, bug#969). Fixme:
9330 do we need to do this in other circumstances? */
9331 if (it
->current_x
!= it
->last_visible_x
9332 && (op
& MOVE_TO_VPOS
)
9333 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9335 line_start_x
= it
->current_x
+ it
->pixel_width
9336 - it
->last_visible_x
;
9337 if (FRAME_WINDOW_P (it
->f
))
9339 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9340 struct font
*face_font
= face
->font
;
9342 /* When display_line produces a continued line
9343 that ends in a TAB, it skips a tab stop that
9344 is closer than the font's space character
9345 width (see x_produce_glyphs where it produces
9346 the stretch glyph which represents a TAB).
9347 We need to reproduce the same logic here. */
9348 eassert (face_font
);
9351 if (line_start_x
< face_font
->space_width
)
9353 += it
->tab_width
* face_font
->space_width
;
9356 set_iterator_to_next (it
, 0);
9360 it
->continuation_lines_width
+= it
->current_x
;
9367 /* Reset/increment for the next run. */
9368 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9369 it
->current_x
= line_start_x
;
9372 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9374 last_height
= it
->max_ascent
+ it
->max_descent
;
9375 it
->max_ascent
= it
->max_descent
= 0;
9380 /* On text terminals, we may stop at the end of a line in the middle
9381 of a multi-character glyph. If the glyph itself is continued,
9382 i.e. it is actually displayed on the next line, don't treat this
9383 stopping point as valid; move to the next line instead (unless
9384 that brings us offscreen). */
9385 if (!FRAME_WINDOW_P (it
->f
)
9387 && IT_CHARPOS (*it
) == to_charpos
9388 && it
->what
== IT_CHARACTER
9390 && it
->line_wrap
== WINDOW_WRAP
9391 && it
->current_x
== it
->last_visible_x
- 1
9394 && it
->vpos
< it
->w
->window_end_vpos
)
9396 it
->continuation_lines_width
+= it
->current_x
;
9397 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9398 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9400 last_height
= it
->max_ascent
+ it
->max_descent
;
9404 bidi_unshelve_cache (backup_data
, 1);
9406 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9408 return max_current_x
;
9412 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9414 If DY > 0, move IT backward at least that many pixels. DY = 0
9415 means move IT backward to the preceding line start or BEGV. This
9416 function may move over more than DY pixels if IT->current_y - DY
9417 ends up in the middle of a line; in this case IT->current_y will be
9418 set to the top of the line moved to. */
9421 move_it_vertically_backward (struct it
*it
, int dy
)
9425 void *it2data
= NULL
, *it3data
= NULL
;
9426 ptrdiff_t start_pos
;
9428 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9429 ptrdiff_t pos_limit
;
9434 start_pos
= IT_CHARPOS (*it
);
9436 /* Estimate how many newlines we must move back. */
9437 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9438 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9441 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9443 /* Set the iterator's position that many lines back. But don't go
9444 back more than NLINES full screen lines -- this wins a day with
9445 buffers which have very long lines. */
9446 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9447 back_to_previous_visible_line_start (it
);
9449 /* Reseat the iterator here. When moving backward, we don't want
9450 reseat to skip forward over invisible text, set up the iterator
9451 to deliver from overlay strings at the new position etc. So,
9452 use reseat_1 here. */
9453 reseat_1 (it
, it
->current
.pos
, 1);
9455 /* We are now surely at a line start. */
9456 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9457 reordering is in effect. */
9458 it
->continuation_lines_width
= 0;
9460 /* Move forward and see what y-distance we moved. First move to the
9461 start of the next line so that we get its height. We need this
9462 height to be able to tell whether we reached the specified
9464 SAVE_IT (it2
, *it
, it2data
);
9465 it2
.max_ascent
= it2
.max_descent
= 0;
9468 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9469 MOVE_TO_POS
| MOVE_TO_VPOS
);
9471 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9472 /* If we are in a display string which starts at START_POS,
9473 and that display string includes a newline, and we are
9474 right after that newline (i.e. at the beginning of a
9475 display line), exit the loop, because otherwise we will
9476 infloop, since move_it_to will see that it is already at
9477 START_POS and will not move. */
9478 || (it2
.method
== GET_FROM_STRING
9479 && IT_CHARPOS (it2
) == start_pos
9480 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9481 eassert (IT_CHARPOS (*it
) >= BEGV
);
9482 SAVE_IT (it3
, it2
, it3data
);
9484 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9485 eassert (IT_CHARPOS (*it
) >= BEGV
);
9486 /* H is the actual vertical distance from the position in *IT
9487 and the starting position. */
9488 h
= it2
.current_y
- it
->current_y
;
9489 /* NLINES is the distance in number of lines. */
9490 nlines
= it2
.vpos
- it
->vpos
;
9492 /* Correct IT's y and vpos position
9493 so that they are relative to the starting point. */
9499 /* DY == 0 means move to the start of the screen line. The
9500 value of nlines is > 0 if continuation lines were involved,
9501 or if the original IT position was at start of a line. */
9502 RESTORE_IT (it
, it
, it2data
);
9504 move_it_by_lines (it
, nlines
);
9505 /* The above code moves us to some position NLINES down,
9506 usually to its first glyph (leftmost in an L2R line), but
9507 that's not necessarily the start of the line, under bidi
9508 reordering. We want to get to the character position
9509 that is immediately after the newline of the previous
9512 && !it
->continuation_lines_width
9513 && !STRINGP (it
->string
)
9514 && IT_CHARPOS (*it
) > BEGV
9515 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9517 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9520 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9521 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9523 bidi_unshelve_cache (it3data
, 1);
9527 /* The y-position we try to reach, relative to *IT.
9528 Note that H has been subtracted in front of the if-statement. */
9529 int target_y
= it
->current_y
+ h
- dy
;
9530 int y0
= it3
.current_y
;
9534 RESTORE_IT (&it3
, &it3
, it3data
);
9535 y1
= line_bottom_y (&it3
);
9536 line_height
= y1
- y0
;
9537 RESTORE_IT (it
, it
, it2data
);
9538 /* If we did not reach target_y, try to move further backward if
9539 we can. If we moved too far backward, try to move forward. */
9540 if (target_y
< it
->current_y
9541 /* This is heuristic. In a window that's 3 lines high, with
9542 a line height of 13 pixels each, recentering with point
9543 on the bottom line will try to move -39/2 = 19 pixels
9544 backward. Try to avoid moving into the first line. */
9545 && (it
->current_y
- target_y
9546 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9547 && IT_CHARPOS (*it
) > BEGV
)
9549 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9550 target_y
- it
->current_y
));
9551 dy
= it
->current_y
- target_y
;
9552 goto move_further_back
;
9554 else if (target_y
>= it
->current_y
+ line_height
9555 && IT_CHARPOS (*it
) < ZV
)
9557 /* Should move forward by at least one line, maybe more.
9559 Note: Calling move_it_by_lines can be expensive on
9560 terminal frames, where compute_motion is used (via
9561 vmotion) to do the job, when there are very long lines
9562 and truncate-lines is nil. That's the reason for
9563 treating terminal frames specially here. */
9565 if (!FRAME_WINDOW_P (it
->f
))
9566 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9571 move_it_by_lines (it
, 1);
9573 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9580 /* Move IT by a specified amount of pixel lines DY. DY negative means
9581 move backwards. DY = 0 means move to start of screen line. At the
9582 end, IT will be on the start of a screen line. */
9585 move_it_vertically (struct it
*it
, int dy
)
9588 move_it_vertically_backward (it
, -dy
);
9591 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9592 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9593 MOVE_TO_POS
| MOVE_TO_Y
);
9594 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9596 /* If buffer ends in ZV without a newline, move to the start of
9597 the line to satisfy the post-condition. */
9598 if (IT_CHARPOS (*it
) == ZV
9600 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9601 move_it_by_lines (it
, 0);
9606 /* Move iterator IT past the end of the text line it is in. */
9609 move_it_past_eol (struct it
*it
)
9611 enum move_it_result rc
;
9613 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9614 if (rc
== MOVE_NEWLINE_OR_CR
)
9615 set_iterator_to_next (it
, 0);
9619 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9620 negative means move up. DVPOS == 0 means move to the start of the
9623 Optimization idea: If we would know that IT->f doesn't use
9624 a face with proportional font, we could be faster for
9625 truncate-lines nil. */
9628 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9631 /* The commented-out optimization uses vmotion on terminals. This
9632 gives bad results, because elements like it->what, on which
9633 callers such as pos_visible_p rely, aren't updated. */
9634 /* struct position pos;
9635 if (!FRAME_WINDOW_P (it->f))
9637 struct text_pos textpos;
9639 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9640 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9641 reseat (it, textpos, 1);
9642 it->vpos += pos.vpos;
9643 it->current_y += pos.vpos;
9649 /* DVPOS == 0 means move to the start of the screen line. */
9650 move_it_vertically_backward (it
, 0);
9651 /* Let next call to line_bottom_y calculate real line height. */
9656 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9657 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9659 /* Only move to the next buffer position if we ended up in a
9660 string from display property, not in an overlay string
9661 (before-string or after-string). That is because the
9662 latter don't conceal the underlying buffer position, so
9663 we can ask to move the iterator to the exact position we
9664 are interested in. Note that, even if we are already at
9665 IT_CHARPOS (*it), the call below is not a no-op, as it
9666 will detect that we are at the end of the string, pop the
9667 iterator, and compute it->current_x and it->hpos
9669 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9670 -1, -1, -1, MOVE_TO_POS
);
9676 void *it2data
= NULL
;
9677 ptrdiff_t start_charpos
, i
;
9679 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9680 bool hit_pos_limit
= false;
9681 ptrdiff_t pos_limit
;
9683 /* Start at the beginning of the screen line containing IT's
9684 position. This may actually move vertically backwards,
9685 in case of overlays, so adjust dvpos accordingly. */
9687 move_it_vertically_backward (it
, 0);
9690 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9691 screen lines, and reseat the iterator there. */
9692 start_charpos
= IT_CHARPOS (*it
);
9693 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9696 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9698 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9699 back_to_previous_visible_line_start (it
);
9700 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9701 hit_pos_limit
= true;
9702 reseat (it
, it
->current
.pos
, 1);
9704 /* Move further back if we end up in a string or an image. */
9705 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9707 /* First try to move to start of display line. */
9709 move_it_vertically_backward (it
, 0);
9711 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9713 /* If start of line is still in string or image,
9714 move further back. */
9715 back_to_previous_visible_line_start (it
);
9716 reseat (it
, it
->current
.pos
, 1);
9720 it
->current_x
= it
->hpos
= 0;
9722 /* Above call may have moved too far if continuation lines
9723 are involved. Scan forward and see if it did. */
9724 SAVE_IT (it2
, *it
, it2data
);
9725 it2
.vpos
= it2
.current_y
= 0;
9726 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9727 it
->vpos
-= it2
.vpos
;
9728 it
->current_y
-= it2
.current_y
;
9729 it
->current_x
= it
->hpos
= 0;
9731 /* If we moved too far back, move IT some lines forward. */
9732 if (it2
.vpos
> -dvpos
)
9734 int delta
= it2
.vpos
+ dvpos
;
9736 RESTORE_IT (&it2
, &it2
, it2data
);
9737 SAVE_IT (it2
, *it
, it2data
);
9738 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9739 /* Move back again if we got too far ahead. */
9740 if (IT_CHARPOS (*it
) >= start_charpos
)
9741 RESTORE_IT (it
, &it2
, it2data
);
9743 bidi_unshelve_cache (it2data
, 1);
9745 else if (hit_pos_limit
&& pos_limit
> BEGV
9746 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9748 /* If we hit the limit, but still didn't make it far enough
9749 back, that means there's a display string with a newline
9750 covering a large chunk of text, and that caused
9751 back_to_previous_visible_line_start try to go too far.
9752 Punish those who commit such atrocities by going back
9753 until we've reached DVPOS, after lifting the limit, which
9754 could make it slow for very long lines. "If it hurts,
9757 RESTORE_IT (it
, it
, it2data
);
9758 for (i
= -dvpos
; i
> 0; --i
)
9760 back_to_previous_visible_line_start (it
);
9763 reseat_1 (it
, it
->current
.pos
, 1);
9766 RESTORE_IT (it
, it
, it2data
);
9770 /* Return true if IT points into the middle of a display vector. */
9773 in_display_vector_p (struct it
*it
)
9775 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9776 && it
->current
.dpvec_index
> 0
9777 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9780 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9781 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9782 WINDOW must be a live window and defaults to the selected one. The
9783 return value is a cons of the maximum pixel-width of any text line and
9784 the maximum pixel-height of all text lines.
9786 The optional argument FROM, if non-nil, specifies the first text
9787 position and defaults to the minimum accessible position of the buffer.
9788 If FROM is t, use the minimum accessible position that is not a newline
9789 character. TO, if non-nil, specifies the last text position and
9790 defaults to the maximum accessible position of the buffer. If TO is t,
9791 use the maximum accessible position that is not a newline character.
9793 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9794 width that can be returned. X-LIMIT nil or omitted, means to use the
9795 pixel-width of WINDOW's body; use this if you do not intend to change
9796 the width of WINDOW. Use the maximum width WINDOW may assume if you
9797 intend to change WINDOW's width. In any case, text whose x-coordinate
9798 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9799 can take some time, it's always a good idea to make this argument as
9800 small as possible; in particular, if the buffer contains long lines that
9801 shall be truncated anyway.
9803 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9804 height that can be returned. Text lines whose y-coordinate is beyond
9805 Y-LIMIT are ignored. Since calculating the text height of a large
9806 buffer can take some time, it makes sense to specify this argument if
9807 the size of the buffer is unknown.
9809 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9810 include the height of the mode- or header-line of WINDOW in the return
9811 value. If it is either the symbol `mode-line' or `header-line', include
9812 only the height of that line, if present, in the return value. If t,
9813 include the height of both, if present, in the return value. */)
9814 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
, Lisp_Object y_limit
,
9815 Lisp_Object mode_and_header_line
)
9817 struct window
*w
= decode_live_window (window
);
9821 struct buffer
*old_buffer
= NULL
;
9822 ptrdiff_t start
, end
, pos
;
9823 struct text_pos startp
;
9824 void *itdata
= NULL
;
9825 int c
, max_y
= -1, x
= 0, y
= 0;
9831 if (b
!= current_buffer
)
9833 old_buffer
= current_buffer
;
9834 set_buffer_internal (b
);
9839 else if (EQ (from
, Qt
))
9842 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9843 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9845 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9850 CHECK_NUMBER_COERCE_MARKER (from
);
9851 start
= min (max (XINT (from
), BEGV
), ZV
);
9856 else if (EQ (to
, Qt
))
9859 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9860 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9862 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9867 CHECK_NUMBER_COERCE_MARKER (to
);
9868 end
= max (start
, min (XINT (to
), ZV
));
9871 if (!NILP (y_limit
))
9873 CHECK_NUMBER (y_limit
);
9874 max_y
= min (XINT (y_limit
), INT_MAX
);
9877 itdata
= bidi_shelve_cache ();
9878 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9879 start_display (&it
, w
, startp
);
9882 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9885 CHECK_NUMBER (x_limit
);
9886 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9887 /* Actually, we never want move_it_to stop at to_x. But to make
9888 sure that move_it_in_display_line_to always moves far enough,
9889 we set it to INT_MAX and specify MOVE_TO_X. */
9890 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9891 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9894 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9896 if (!EQ (mode_and_header_line
, Qheader_line
)
9897 && !EQ (mode_and_header_line
, Qt
))
9898 /* Do not count the header-line which was counted automatically by
9900 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9902 if (EQ (mode_and_header_line
, Qmode_line
)
9903 || EQ (mode_and_header_line
, Qt
))
9904 /* Do count the mode-line which is not included automatically by
9906 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9908 bidi_unshelve_cache (itdata
, 0);
9911 set_buffer_internal (old_buffer
);
9913 return Fcons (make_number (x
), make_number (y
));
9916 /***********************************************************************
9918 ***********************************************************************/
9921 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9925 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9927 Lisp_Object args
[3];
9928 Lisp_Object msg
, fmt
;
9931 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9935 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9937 args
[0] = fmt
= build_string (format
);
9940 msg
= Fformat (3, args
);
9942 len
= SBYTES (msg
) + 1;
9943 buffer
= SAFE_ALLOCA (len
);
9944 memcpy (buffer
, SDATA (msg
), len
);
9946 message_dolog (buffer
, len
- 1, 1, 0);
9953 /* Output a newline in the *Messages* buffer if "needs" one. */
9956 message_log_maybe_newline (void)
9958 if (message_log_need_newline
)
9959 message_dolog ("", 0, 1, 0);
9963 /* Add a string M of length NBYTES to the message log, optionally
9964 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9965 true, means interpret the contents of M as multibyte. This
9966 function calls low-level routines in order to bypass text property
9967 hooks, etc. which might not be safe to run.
9969 This may GC (insert may run before/after change hooks),
9970 so the buffer M must NOT point to a Lisp string. */
9973 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9975 const unsigned char *msg
= (const unsigned char *) m
;
9977 if (!NILP (Vmemory_full
))
9980 if (!NILP (Vmessage_log_max
))
9982 struct buffer
*oldbuf
;
9983 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9984 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9985 ptrdiff_t point_at_end
= 0;
9986 ptrdiff_t zv_at_end
= 0;
9987 Lisp_Object old_deactivate_mark
;
9988 struct gcpro gcpro1
;
9990 old_deactivate_mark
= Vdeactivate_mark
;
9991 oldbuf
= current_buffer
;
9993 /* Ensure the Messages buffer exists, and switch to it.
9994 If we created it, set the major-mode. */
9997 if (NILP (Fget_buffer (Vmessages_buffer_name
))) newbuffer
= 1;
9999 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
10002 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
10003 call0 (intern ("messages-buffer-mode"));
10006 bset_undo_list (current_buffer
, Qt
);
10007 bset_cache_long_scans (current_buffer
, Qnil
);
10009 oldpoint
= message_dolog_marker1
;
10010 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
10011 oldbegv
= message_dolog_marker2
;
10012 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
10013 oldzv
= message_dolog_marker3
;
10014 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
10015 GCPRO1 (old_deactivate_mark
);
10023 BEGV_BYTE
= BEG_BYTE
;
10026 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10028 /* Insert the string--maybe converting multibyte to single byte
10029 or vice versa, so that all the text fits the buffer. */
10031 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10037 /* Convert a multibyte string to single-byte
10038 for the *Message* buffer. */
10039 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
10041 c
= string_char_and_length (msg
+ i
, &char_bytes
);
10042 work
[0] = (ASCII_CHAR_P (c
)
10044 : multibyte_char_to_unibyte (c
));
10045 insert_1_both (work
, 1, 1, 1, 0, 0);
10048 else if (! multibyte
10049 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10053 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10054 /* Convert a single-byte string to multibyte
10055 for the *Message* buffer. */
10056 for (i
= 0; i
< nbytes
; i
++)
10059 MAKE_CHAR_MULTIBYTE (c
);
10060 char_bytes
= CHAR_STRING (c
, str
);
10061 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
10065 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
, 1, 0, 0);
10069 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
10072 insert_1_both ("\n", 1, 1, 1, 0, 0);
10074 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
10076 this_bol_byte
= PT_BYTE
;
10078 /* See if this line duplicates the previous one.
10079 If so, combine duplicates. */
10080 if (this_bol
> BEG
)
10082 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
10084 prev_bol_byte
= PT_BYTE
;
10086 dups
= message_log_check_duplicate (prev_bol_byte
,
10090 del_range_both (prev_bol
, prev_bol_byte
,
10091 this_bol
, this_bol_byte
, 0);
10094 char dupstr
[sizeof " [ times]"
10095 + INT_STRLEN_BOUND (printmax_t
)];
10097 /* If you change this format, don't forget to also
10098 change message_log_check_duplicate. */
10099 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10100 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10101 insert_1_both (dupstr
, duplen
, duplen
, 1, 0, 1);
10106 /* If we have more than the desired maximum number of lines
10107 in the *Messages* buffer now, delete the oldest ones.
10108 This is safe because we don't have undo in this buffer. */
10110 if (NATNUMP (Vmessage_log_max
))
10112 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10113 -XFASTINT (Vmessage_log_max
) - 1, 0);
10114 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
10117 BEGV
= marker_position (oldbegv
);
10118 BEGV_BYTE
= marker_byte_position (oldbegv
);
10127 ZV
= marker_position (oldzv
);
10128 ZV_BYTE
= marker_byte_position (oldzv
);
10132 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10134 /* We can't do Fgoto_char (oldpoint) because it will run some
10136 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10137 marker_byte_position (oldpoint
));
10140 unchain_marker (XMARKER (oldpoint
));
10141 unchain_marker (XMARKER (oldbegv
));
10142 unchain_marker (XMARKER (oldzv
));
10144 /* We called insert_1_both above with its 5th argument (PREPARE)
10145 zero, which prevents insert_1_both from calling
10146 prepare_to_modify_buffer, which in turns prevents us from
10147 incrementing windows_or_buffers_changed even if *Messages* is
10148 shown in some window. So we must manually set
10149 windows_or_buffers_changed here to make up for that. */
10150 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10151 bset_redisplay (current_buffer
);
10153 set_buffer_internal (oldbuf
);
10155 message_log_need_newline
= !nlflag
;
10156 Vdeactivate_mark
= old_deactivate_mark
;
10161 /* We are at the end of the buffer after just having inserted a newline.
10162 (Note: We depend on the fact we won't be crossing the gap.)
10163 Check to see if the most recent message looks a lot like the previous one.
10164 Return 0 if different, 1 if the new one should just replace it, or a
10165 value N > 1 if we should also append " [N times]". */
10168 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10171 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10173 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10174 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10176 for (i
= 0; i
< len
; i
++)
10178 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10180 if (p1
[i
] != p2
[i
])
10186 if (*p1
++ == ' ' && *p1
++ == '[')
10189 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10190 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10197 /* Display an echo area message M with a specified length of NBYTES
10198 bytes. The string may include null characters. If M is not a
10199 string, clear out any existing message, and let the mini-buffer
10202 This function cancels echoing. */
10205 message3 (Lisp_Object m
)
10207 struct gcpro gcpro1
;
10210 clear_message (true, true);
10213 /* First flush out any partial line written with print. */
10214 message_log_maybe_newline ();
10217 ptrdiff_t nbytes
= SBYTES (m
);
10218 bool multibyte
= STRING_MULTIBYTE (m
);
10220 char *buffer
= SAFE_ALLOCA (nbytes
);
10221 memcpy (buffer
, SDATA (m
), nbytes
);
10222 message_dolog (buffer
, nbytes
, 1, multibyte
);
10225 message3_nolog (m
);
10231 /* The non-logging version of message3.
10232 This does not cancel echoing, because it is used for echoing.
10233 Perhaps we need to make a separate function for echoing
10234 and make this cancel echoing. */
10237 message3_nolog (Lisp_Object m
)
10239 struct frame
*sf
= SELECTED_FRAME ();
10241 if (FRAME_INITIAL_P (sf
))
10243 if (noninteractive_need_newline
)
10244 putc ('\n', stderr
);
10245 noninteractive_need_newline
= 0;
10248 Lisp_Object s
= ENCODE_SYSTEM (m
);
10250 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10252 if (cursor_in_echo_area
== 0)
10253 fprintf (stderr
, "\n");
10256 /* Error messages get reported properly by cmd_error, so this must be just an
10257 informative message; if the frame hasn't really been initialized yet, just
10259 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10261 /* Get the frame containing the mini-buffer
10262 that the selected frame is using. */
10263 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10264 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10265 struct frame
*f
= XFRAME (frame
);
10267 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10268 Fmake_frame_visible (frame
);
10270 if (STRINGP (m
) && SCHARS (m
) > 0)
10273 if (minibuffer_auto_raise
)
10274 Fraise_frame (frame
);
10275 /* Assume we are not echoing.
10276 (If we are, echo_now will override this.) */
10277 echo_message_buffer
= Qnil
;
10280 clear_message (true, true);
10282 do_pending_window_change (0);
10283 echo_area_display (1);
10284 do_pending_window_change (0);
10285 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10286 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10291 /* Display a null-terminated echo area message M. If M is 0, clear
10292 out any existing message, and let the mini-buffer text show through.
10294 The buffer M must continue to exist until after the echo area gets
10295 cleared or some other message gets displayed there. Do not pass
10296 text that is stored in a Lisp string. Do not pass text in a buffer
10297 that was alloca'd. */
10300 message1 (const char *m
)
10302 message3 (m
? build_unibyte_string (m
) : Qnil
);
10306 /* The non-logging counterpart of message1. */
10309 message1_nolog (const char *m
)
10311 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10314 /* Display a message M which contains a single %s
10315 which gets replaced with STRING. */
10318 message_with_string (const char *m
, Lisp_Object string
, int log
)
10320 CHECK_STRING (string
);
10322 if (noninteractive
)
10326 /* ENCODE_SYSTEM below can GC and/or relocate the Lisp
10327 String whose data pointer might be passed to us in M. So
10328 we use a local copy. */
10329 char *fmt
= xstrdup (m
);
10331 if (noninteractive_need_newline
)
10332 putc ('\n', stderr
);
10333 noninteractive_need_newline
= 0;
10334 fprintf (stderr
, fmt
, SDATA (ENCODE_SYSTEM (string
)));
10335 if (!cursor_in_echo_area
)
10336 fprintf (stderr
, "\n");
10341 else if (INTERACTIVE
)
10343 /* The frame whose minibuffer we're going to display the message on.
10344 It may be larger than the selected frame, so we need
10345 to use its buffer, not the selected frame's buffer. */
10346 Lisp_Object mini_window
;
10347 struct frame
*f
, *sf
= SELECTED_FRAME ();
10349 /* Get the frame containing the minibuffer
10350 that the selected frame is using. */
10351 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10352 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10354 /* Error messages get reported properly by cmd_error, so this must be
10355 just an informative message; if the frame hasn't really been
10356 initialized yet, just toss it. */
10357 if (f
->glyphs_initialized_p
)
10359 Lisp_Object args
[2], msg
;
10360 struct gcpro gcpro1
, gcpro2
;
10362 args
[0] = build_string (m
);
10363 args
[1] = msg
= string
;
10364 GCPRO2 (args
[0], msg
);
10367 msg
= Fformat (2, args
);
10372 message3_nolog (msg
);
10376 /* Print should start at the beginning of the message
10377 buffer next time. */
10378 message_buf_print
= 0;
10384 /* Dump an informative message to the minibuf. If M is 0, clear out
10385 any existing message, and let the mini-buffer text show through. */
10388 vmessage (const char *m
, va_list ap
)
10390 if (noninteractive
)
10394 if (noninteractive_need_newline
)
10395 putc ('\n', stderr
);
10396 noninteractive_need_newline
= 0;
10397 vfprintf (stderr
, m
, ap
);
10398 if (cursor_in_echo_area
== 0)
10399 fprintf (stderr
, "\n");
10403 else if (INTERACTIVE
)
10405 /* The frame whose mini-buffer we're going to display the message
10406 on. It may be larger than the selected frame, so we need to
10407 use its buffer, not the selected frame's buffer. */
10408 Lisp_Object mini_window
;
10409 struct frame
*f
, *sf
= SELECTED_FRAME ();
10411 /* Get the frame containing the mini-buffer
10412 that the selected frame is using. */
10413 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10414 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10416 /* Error messages get reported properly by cmd_error, so this must be
10417 just an informative message; if the frame hasn't really been
10418 initialized yet, just toss it. */
10419 if (f
->glyphs_initialized_p
)
10424 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10425 char *message_buf
= alloca (maxsize
+ 1);
10427 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10429 message3 (make_string (message_buf
, len
));
10434 /* Print should start at the beginning of the message
10435 buffer next time. */
10436 message_buf_print
= 0;
10442 message (const char *m
, ...)
10452 /* The non-logging version of message. */
10455 message_nolog (const char *m
, ...)
10457 Lisp_Object old_log_max
;
10460 old_log_max
= Vmessage_log_max
;
10461 Vmessage_log_max
= Qnil
;
10463 Vmessage_log_max
= old_log_max
;
10469 /* Display the current message in the current mini-buffer. This is
10470 only called from error handlers in process.c, and is not time
10474 update_echo_area (void)
10476 if (!NILP (echo_area_buffer
[0]))
10478 Lisp_Object string
;
10479 string
= Fcurrent_message ();
10485 /* Make sure echo area buffers in `echo_buffers' are live.
10486 If they aren't, make new ones. */
10489 ensure_echo_area_buffers (void)
10493 for (i
= 0; i
< 2; ++i
)
10494 if (!BUFFERP (echo_buffer
[i
])
10495 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10498 Lisp_Object old_buffer
;
10501 old_buffer
= echo_buffer
[i
];
10502 echo_buffer
[i
] = Fget_buffer_create
10503 (make_formatted_string (name
, " *Echo Area %d*", i
));
10504 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10505 /* to force word wrap in echo area -
10506 it was decided to postpone this*/
10507 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10509 for (j
= 0; j
< 2; ++j
)
10510 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10511 echo_area_buffer
[j
] = echo_buffer
[i
];
10516 /* Call FN with args A1..A2 with either the current or last displayed
10517 echo_area_buffer as current buffer.
10519 WHICH zero means use the current message buffer
10520 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10521 from echo_buffer[] and clear it.
10523 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10524 suitable buffer from echo_buffer[] and clear it.
10526 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10527 that the current message becomes the last displayed one, make
10528 choose a suitable buffer for echo_area_buffer[0], and clear it.
10530 Value is what FN returns. */
10533 with_echo_area_buffer (struct window
*w
, int which
,
10534 int (*fn
) (ptrdiff_t, Lisp_Object
),
10535 ptrdiff_t a1
, Lisp_Object a2
)
10537 Lisp_Object buffer
;
10538 int this_one
, the_other
, clear_buffer_p
, rc
;
10539 ptrdiff_t count
= SPECPDL_INDEX ();
10541 /* If buffers aren't live, make new ones. */
10542 ensure_echo_area_buffers ();
10544 clear_buffer_p
= 0;
10547 this_one
= 0, the_other
= 1;
10548 else if (which
> 0)
10549 this_one
= 1, the_other
= 0;
10552 this_one
= 0, the_other
= 1;
10553 clear_buffer_p
= true;
10555 /* We need a fresh one in case the current echo buffer equals
10556 the one containing the last displayed echo area message. */
10557 if (!NILP (echo_area_buffer
[this_one
])
10558 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10559 echo_area_buffer
[this_one
] = Qnil
;
10562 /* Choose a suitable buffer from echo_buffer[] is we don't
10564 if (NILP (echo_area_buffer
[this_one
]))
10566 echo_area_buffer
[this_one
]
10567 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10568 ? echo_buffer
[the_other
]
10569 : echo_buffer
[this_one
]);
10570 clear_buffer_p
= true;
10573 buffer
= echo_area_buffer
[this_one
];
10575 /* Don't get confused by reusing the buffer used for echoing
10576 for a different purpose. */
10577 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10580 record_unwind_protect (unwind_with_echo_area_buffer
,
10581 with_echo_area_buffer_unwind_data (w
));
10583 /* Make the echo area buffer current. Note that for display
10584 purposes, it is not necessary that the displayed window's buffer
10585 == current_buffer, except for text property lookup. So, let's
10586 only set that buffer temporarily here without doing a full
10587 Fset_window_buffer. We must also change w->pointm, though,
10588 because otherwise an assertions in unshow_buffer fails, and Emacs
10590 set_buffer_internal_1 (XBUFFER (buffer
));
10593 wset_buffer (w
, buffer
);
10594 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10597 bset_undo_list (current_buffer
, Qt
);
10598 bset_read_only (current_buffer
, Qnil
);
10599 specbind (Qinhibit_read_only
, Qt
);
10600 specbind (Qinhibit_modification_hooks
, Qt
);
10602 if (clear_buffer_p
&& Z
> BEG
)
10603 del_range (BEG
, Z
);
10605 eassert (BEGV
>= BEG
);
10606 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10610 eassert (BEGV
>= BEG
);
10611 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10613 unbind_to (count
, Qnil
);
10618 /* Save state that should be preserved around the call to the function
10619 FN called in with_echo_area_buffer. */
10622 with_echo_area_buffer_unwind_data (struct window
*w
)
10625 Lisp_Object vector
, tmp
;
10627 /* Reduce consing by keeping one vector in
10628 Vwith_echo_area_save_vector. */
10629 vector
= Vwith_echo_area_save_vector
;
10630 Vwith_echo_area_save_vector
= Qnil
;
10633 vector
= Fmake_vector (make_number (9), Qnil
);
10635 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10636 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10637 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10641 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10642 ASET (vector
, i
, w
->contents
); ++i
;
10643 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10644 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10645 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10646 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10651 for (; i
< end
; ++i
)
10652 ASET (vector
, i
, Qnil
);
10655 eassert (i
== ASIZE (vector
));
10660 /* Restore global state from VECTOR which was created by
10661 with_echo_area_buffer_unwind_data. */
10664 unwind_with_echo_area_buffer (Lisp_Object vector
)
10666 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10667 Vdeactivate_mark
= AREF (vector
, 1);
10668 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10670 if (WINDOWP (AREF (vector
, 3)))
10673 Lisp_Object buffer
;
10675 w
= XWINDOW (AREF (vector
, 3));
10676 buffer
= AREF (vector
, 4);
10678 wset_buffer (w
, buffer
);
10679 set_marker_both (w
->pointm
, buffer
,
10680 XFASTINT (AREF (vector
, 5)),
10681 XFASTINT (AREF (vector
, 6)));
10682 set_marker_both (w
->start
, buffer
,
10683 XFASTINT (AREF (vector
, 7)),
10684 XFASTINT (AREF (vector
, 8)));
10687 Vwith_echo_area_save_vector
= vector
;
10691 /* Set up the echo area for use by print functions. MULTIBYTE_P
10692 non-zero means we will print multibyte. */
10695 setup_echo_area_for_printing (int multibyte_p
)
10697 /* If we can't find an echo area any more, exit. */
10698 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10699 Fkill_emacs (Qnil
);
10701 ensure_echo_area_buffers ();
10703 if (!message_buf_print
)
10705 /* A message has been output since the last time we printed.
10706 Choose a fresh echo area buffer. */
10707 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10708 echo_area_buffer
[0] = echo_buffer
[1];
10710 echo_area_buffer
[0] = echo_buffer
[0];
10712 /* Switch to that buffer and clear it. */
10713 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10714 bset_truncate_lines (current_buffer
, Qnil
);
10718 ptrdiff_t count
= SPECPDL_INDEX ();
10719 specbind (Qinhibit_read_only
, Qt
);
10720 /* Note that undo recording is always disabled. */
10721 del_range (BEG
, Z
);
10722 unbind_to (count
, Qnil
);
10724 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10726 /* Set up the buffer for the multibyteness we need. */
10728 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10729 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10731 /* Raise the frame containing the echo area. */
10732 if (minibuffer_auto_raise
)
10734 struct frame
*sf
= SELECTED_FRAME ();
10735 Lisp_Object mini_window
;
10736 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10737 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10740 message_log_maybe_newline ();
10741 message_buf_print
= 1;
10745 if (NILP (echo_area_buffer
[0]))
10747 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10748 echo_area_buffer
[0] = echo_buffer
[1];
10750 echo_area_buffer
[0] = echo_buffer
[0];
10753 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10755 /* Someone switched buffers between print requests. */
10756 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10757 bset_truncate_lines (current_buffer
, Qnil
);
10763 /* Display an echo area message in window W. Value is non-zero if W's
10764 height is changed. If display_last_displayed_message_p is
10765 non-zero, display the message that was last displayed, otherwise
10766 display the current message. */
10769 display_echo_area (struct window
*w
)
10771 int i
, no_message_p
, window_height_changed_p
;
10773 /* Temporarily disable garbage collections while displaying the echo
10774 area. This is done because a GC can print a message itself.
10775 That message would modify the echo area buffer's contents while a
10776 redisplay of the buffer is going on, and seriously confuse
10778 ptrdiff_t count
= inhibit_garbage_collection ();
10780 /* If there is no message, we must call display_echo_area_1
10781 nevertheless because it resizes the window. But we will have to
10782 reset the echo_area_buffer in question to nil at the end because
10783 with_echo_area_buffer will sets it to an empty buffer. */
10784 i
= display_last_displayed_message_p
? 1 : 0;
10785 no_message_p
= NILP (echo_area_buffer
[i
]);
10787 window_height_changed_p
10788 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10789 display_echo_area_1
,
10790 (intptr_t) w
, Qnil
);
10793 echo_area_buffer
[i
] = Qnil
;
10795 unbind_to (count
, Qnil
);
10796 return window_height_changed_p
;
10800 /* Helper for display_echo_area. Display the current buffer which
10801 contains the current echo area message in window W, a mini-window,
10802 a pointer to which is passed in A1. A2..A4 are currently not used.
10803 Change the height of W so that all of the message is displayed.
10804 Value is non-zero if height of W was changed. */
10807 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10810 struct window
*w
= (struct window
*) i1
;
10811 Lisp_Object window
;
10812 struct text_pos start
;
10813 int window_height_changed_p
= 0;
10815 /* Do this before displaying, so that we have a large enough glyph
10816 matrix for the display. If we can't get enough space for the
10817 whole text, display the last N lines. That works by setting w->start. */
10818 window_height_changed_p
= resize_mini_window (w
, 0);
10820 /* Use the starting position chosen by resize_mini_window. */
10821 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10824 clear_glyph_matrix (w
->desired_matrix
);
10825 XSETWINDOW (window
, w
);
10826 try_window (window
, start
, 0);
10828 return window_height_changed_p
;
10832 /* Resize the echo area window to exactly the size needed for the
10833 currently displayed message, if there is one. If a mini-buffer
10834 is active, don't shrink it. */
10837 resize_echo_area_exactly (void)
10839 if (BUFFERP (echo_area_buffer
[0])
10840 && WINDOWP (echo_area_window
))
10842 struct window
*w
= XWINDOW (echo_area_window
);
10843 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10844 int resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10845 (intptr_t) w
, resize_exactly
);
10848 windows_or_buffers_changed
= 42;
10849 update_mode_lines
= 30;
10850 redisplay_internal ();
10856 /* Callback function for with_echo_area_buffer, when used from
10857 resize_echo_area_exactly. A1 contains a pointer to the window to
10858 resize, EXACTLY non-nil means resize the mini-window exactly to the
10859 size of the text displayed. A3 and A4 are not used. Value is what
10860 resize_mini_window returns. */
10863 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10866 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10870 /* Resize mini-window W to fit the size of its contents. EXACT_P
10871 means size the window exactly to the size needed. Otherwise, it's
10872 only enlarged until W's buffer is empty.
10874 Set W->start to the right place to begin display. If the whole
10875 contents fit, start at the beginning. Otherwise, start so as
10876 to make the end of the contents appear. This is particularly
10877 important for y-or-n-p, but seems desirable generally.
10879 Value is non-zero if the window height has been changed. */
10882 resize_mini_window (struct window
*w
, int exact_p
)
10884 struct frame
*f
= XFRAME (w
->frame
);
10885 int window_height_changed_p
= 0;
10887 eassert (MINI_WINDOW_P (w
));
10889 /* By default, start display at the beginning. */
10890 set_marker_both (w
->start
, w
->contents
,
10891 BUF_BEGV (XBUFFER (w
->contents
)),
10892 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10894 /* Don't resize windows while redisplaying a window; it would
10895 confuse redisplay functions when the size of the window they are
10896 displaying changes from under them. Such a resizing can happen,
10897 for instance, when which-func prints a long message while
10898 we are running fontification-functions. We're running these
10899 functions with safe_call which binds inhibit-redisplay to t. */
10900 if (!NILP (Vinhibit_redisplay
))
10903 /* Nil means don't try to resize. */
10904 if (NILP (Vresize_mini_windows
)
10905 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10908 if (!FRAME_MINIBUF_ONLY_P (f
))
10911 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10912 + WINDOW_PIXEL_HEIGHT (w
));
10913 int unit
= FRAME_LINE_HEIGHT (f
);
10914 int height
, max_height
;
10915 struct text_pos start
;
10916 struct buffer
*old_current_buffer
= NULL
;
10918 if (current_buffer
!= XBUFFER (w
->contents
))
10920 old_current_buffer
= current_buffer
;
10921 set_buffer_internal (XBUFFER (w
->contents
));
10924 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10926 /* Compute the max. number of lines specified by the user. */
10927 if (FLOATP (Vmax_mini_window_height
))
10928 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10929 else if (INTEGERP (Vmax_mini_window_height
))
10930 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10932 max_height
= total_height
/ 4;
10934 /* Correct that max. height if it's bogus. */
10935 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10937 /* Find out the height of the text in the window. */
10938 if (it
.line_wrap
== TRUNCATE
)
10943 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10944 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10945 height
= it
.current_y
+ last_height
;
10947 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10948 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10951 /* Compute a suitable window start. */
10952 if (height
> max_height
)
10954 height
= (max_height
/ unit
) * unit
;
10955 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10956 move_it_vertically_backward (&it
, height
- unit
);
10957 start
= it
.current
.pos
;
10960 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10961 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10963 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10965 /* Let it grow only, until we display an empty message, in which
10966 case the window shrinks again. */
10967 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10969 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10971 FRAME_WINDOWS_FROZEN (f
) = 1;
10972 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10973 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10975 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10976 && (exact_p
|| BEGV
== ZV
))
10978 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10980 FRAME_WINDOWS_FROZEN (f
) = 0;
10981 shrink_mini_window (w
, 1);
10982 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10987 /* Always resize to exact size needed. */
10988 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10990 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10992 FRAME_WINDOWS_FROZEN (f
) = 1;
10993 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10994 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10996 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10998 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11000 FRAME_WINDOWS_FROZEN (f
) = 0;
11001 shrink_mini_window (w
, 1);
11005 FRAME_WINDOWS_FROZEN (f
) = 1;
11006 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
11009 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11013 if (old_current_buffer
)
11014 set_buffer_internal (old_current_buffer
);
11017 return window_height_changed_p
;
11021 /* Value is the current message, a string, or nil if there is no
11022 current message. */
11025 current_message (void)
11029 if (!BUFFERP (echo_area_buffer
[0]))
11033 with_echo_area_buffer (0, 0, current_message_1
,
11034 (intptr_t) &msg
, Qnil
);
11036 echo_area_buffer
[0] = Qnil
;
11044 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
11047 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
11050 *msg
= make_buffer_string (BEG
, Z
, 1);
11057 /* Push the current message on Vmessage_stack for later restoration
11058 by restore_message. Value is non-zero if the current message isn't
11059 empty. This is a relatively infrequent operation, so it's not
11060 worth optimizing. */
11063 push_message (void)
11065 Lisp_Object msg
= current_message ();
11066 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
11067 return STRINGP (msg
);
11071 /* Restore message display from the top of Vmessage_stack. */
11074 restore_message (void)
11076 eassert (CONSP (Vmessage_stack
));
11077 message3_nolog (XCAR (Vmessage_stack
));
11081 /* Handler for unwind-protect calling pop_message. */
11084 pop_message_unwind (void)
11086 /* Pop the top-most entry off Vmessage_stack. */
11087 eassert (CONSP (Vmessage_stack
));
11088 Vmessage_stack
= XCDR (Vmessage_stack
);
11092 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11093 exits. If the stack is not empty, we have a missing pop_message
11097 check_message_stack (void)
11099 if (!NILP (Vmessage_stack
))
11104 /* Truncate to NCHARS what will be displayed in the echo area the next
11105 time we display it---but don't redisplay it now. */
11108 truncate_echo_area (ptrdiff_t nchars
)
11111 echo_area_buffer
[0] = Qnil
;
11112 else if (!noninteractive
11114 && !NILP (echo_area_buffer
[0]))
11116 struct frame
*sf
= SELECTED_FRAME ();
11117 /* Error messages get reported properly by cmd_error, so this must be
11118 just an informative message; if the frame hasn't really been
11119 initialized yet, just toss it. */
11120 if (sf
->glyphs_initialized_p
)
11121 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11126 /* Helper function for truncate_echo_area. Truncate the current
11127 message to at most NCHARS characters. */
11130 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11132 if (BEG
+ nchars
< Z
)
11133 del_range (BEG
+ nchars
, Z
);
11135 echo_area_buffer
[0] = Qnil
;
11139 /* Set the current message to STRING. */
11142 set_message (Lisp_Object string
)
11144 eassert (STRINGP (string
));
11146 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11148 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11149 message_buf_print
= 0;
11150 help_echo_showing_p
= 0;
11152 if (STRINGP (Vdebug_on_message
)
11153 && STRINGP (string
)
11154 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11155 call_debugger (list2 (Qerror
, string
));
11159 /* Helper function for set_message. First argument is ignored and second
11160 argument has the same meaning as for set_message.
11161 This function is called with the echo area buffer being current. */
11164 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11166 eassert (STRINGP (string
));
11168 /* Change multibyteness of the echo buffer appropriately. */
11169 if (message_enable_multibyte
11170 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11171 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11173 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11174 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11175 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11177 /* Insert new message at BEG. */
11178 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11180 /* This function takes care of single/multibyte conversion.
11181 We just have to ensure that the echo area buffer has the right
11182 setting of enable_multibyte_characters. */
11183 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), 1);
11189 /* Clear messages. CURRENT_P non-zero means clear the current
11190 message. LAST_DISPLAYED_P non-zero means clear the message
11194 clear_message (bool current_p
, bool last_displayed_p
)
11198 echo_area_buffer
[0] = Qnil
;
11199 message_cleared_p
= true;
11202 if (last_displayed_p
)
11203 echo_area_buffer
[1] = Qnil
;
11205 message_buf_print
= 0;
11208 /* Clear garbaged frames.
11210 This function is used where the old redisplay called
11211 redraw_garbaged_frames which in turn called redraw_frame which in
11212 turn called clear_frame. The call to clear_frame was a source of
11213 flickering. I believe a clear_frame is not necessary. It should
11214 suffice in the new redisplay to invalidate all current matrices,
11215 and ensure a complete redisplay of all windows. */
11218 clear_garbaged_frames (void)
11220 if (frame_garbaged
)
11222 Lisp_Object tail
, frame
;
11224 FOR_EACH_FRAME (tail
, frame
)
11226 struct frame
*f
= XFRAME (frame
);
11228 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11233 clear_current_matrices (f
);
11234 fset_redisplay (f
);
11235 f
->garbaged
= false;
11236 f
->resized_p
= false;
11240 frame_garbaged
= false;
11245 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
11246 is non-zero update selected_frame. Value is non-zero if the
11247 mini-windows height has been changed. */
11250 echo_area_display (int update_frame_p
)
11252 Lisp_Object mini_window
;
11255 int window_height_changed_p
= 0;
11256 struct frame
*sf
= SELECTED_FRAME ();
11258 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11259 w
= XWINDOW (mini_window
);
11260 f
= XFRAME (WINDOW_FRAME (w
));
11262 /* Don't display if frame is invisible or not yet initialized. */
11263 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11266 #ifdef HAVE_WINDOW_SYSTEM
11267 /* When Emacs starts, selected_frame may be the initial terminal
11268 frame. If we let this through, a message would be displayed on
11270 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11272 #endif /* HAVE_WINDOW_SYSTEM */
11274 /* Redraw garbaged frames. */
11275 clear_garbaged_frames ();
11277 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11279 echo_area_window
= mini_window
;
11280 window_height_changed_p
= display_echo_area (w
);
11281 w
->must_be_updated_p
= true;
11283 /* Update the display, unless called from redisplay_internal.
11284 Also don't update the screen during redisplay itself. The
11285 update will happen at the end of redisplay, and an update
11286 here could cause confusion. */
11287 if (update_frame_p
&& !redisplaying_p
)
11291 /* If the display update has been interrupted by pending
11292 input, update mode lines in the frame. Due to the
11293 pending input, it might have been that redisplay hasn't
11294 been called, so that mode lines above the echo area are
11295 garbaged. This looks odd, so we prevent it here. */
11296 if (!display_completed
)
11297 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11299 if (window_height_changed_p
11300 /* Don't do this if Emacs is shutting down. Redisplay
11301 needs to run hooks. */
11302 && !NILP (Vrun_hooks
))
11304 /* Must update other windows. Likewise as in other
11305 cases, don't let this update be interrupted by
11307 ptrdiff_t count
= SPECPDL_INDEX ();
11308 specbind (Qredisplay_dont_pause
, Qt
);
11309 windows_or_buffers_changed
= 44;
11310 redisplay_internal ();
11311 unbind_to (count
, Qnil
);
11313 else if (FRAME_WINDOW_P (f
) && n
== 0)
11315 /* Window configuration is the same as before.
11316 Can do with a display update of the echo area,
11317 unless we displayed some mode lines. */
11318 update_single_window (w
, 1);
11322 update_frame (f
, 1, 1);
11324 /* If cursor is in the echo area, make sure that the next
11325 redisplay displays the minibuffer, so that the cursor will
11326 be replaced with what the minibuffer wants. */
11327 if (cursor_in_echo_area
)
11328 wset_redisplay (XWINDOW (mini_window
));
11331 else if (!EQ (mini_window
, selected_window
))
11332 wset_redisplay (XWINDOW (mini_window
));
11334 /* Last displayed message is now the current message. */
11335 echo_area_buffer
[1] = echo_area_buffer
[0];
11336 /* Inform read_char that we're not echoing. */
11337 echo_message_buffer
= Qnil
;
11339 /* Prevent redisplay optimization in redisplay_internal by resetting
11340 this_line_start_pos. This is done because the mini-buffer now
11341 displays the message instead of its buffer text. */
11342 if (EQ (mini_window
, selected_window
))
11343 CHARPOS (this_line_start_pos
) = 0;
11345 return window_height_changed_p
;
11348 /* Nonzero if W's buffer was changed but not saved. */
11351 window_buffer_changed (struct window
*w
)
11353 struct buffer
*b
= XBUFFER (w
->contents
);
11355 eassert (BUFFER_LIVE_P (b
));
11357 return (((BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
));
11360 /* Nonzero if W has %c in its mode line and mode line should be updated. */
11363 mode_line_update_needed (struct window
*w
)
11365 return (w
->column_number_displayed
!= -1
11366 && !(PT
== w
->last_point
&& !window_outdated (w
))
11367 && (w
->column_number_displayed
!= current_column ()));
11370 /* Nonzero if window start of W is frozen and may not be changed during
11374 window_frozen_p (struct window
*w
)
11376 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11378 Lisp_Object window
;
11380 XSETWINDOW (window
, w
);
11381 if (MINI_WINDOW_P (w
))
11383 else if (EQ (window
, selected_window
))
11385 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11386 && EQ (window
, Vminibuf_scroll_window
))
11387 /* This special window can't be frozen too. */
11395 /***********************************************************************
11396 Mode Lines and Frame Titles
11397 ***********************************************************************/
11399 /* A buffer for constructing non-propertized mode-line strings and
11400 frame titles in it; allocated from the heap in init_xdisp and
11401 resized as needed in store_mode_line_noprop_char. */
11403 static char *mode_line_noprop_buf
;
11405 /* The buffer's end, and a current output position in it. */
11407 static char *mode_line_noprop_buf_end
;
11408 static char *mode_line_noprop_ptr
;
11410 #define MODE_LINE_NOPROP_LEN(start) \
11411 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11414 MODE_LINE_DISPLAY
= 0,
11418 } mode_line_target
;
11420 /* Alist that caches the results of :propertize.
11421 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11422 static Lisp_Object mode_line_proptrans_alist
;
11424 /* List of strings making up the mode-line. */
11425 static Lisp_Object mode_line_string_list
;
11427 /* Base face property when building propertized mode line string. */
11428 static Lisp_Object mode_line_string_face
;
11429 static Lisp_Object mode_line_string_face_prop
;
11432 /* Unwind data for mode line strings */
11434 static Lisp_Object Vmode_line_unwind_vector
;
11437 format_mode_line_unwind_data (struct frame
*target_frame
,
11438 struct buffer
*obuf
,
11440 int save_proptrans
)
11442 Lisp_Object vector
, tmp
;
11444 /* Reduce consing by keeping one vector in
11445 Vwith_echo_area_save_vector. */
11446 vector
= Vmode_line_unwind_vector
;
11447 Vmode_line_unwind_vector
= Qnil
;
11450 vector
= Fmake_vector (make_number (10), Qnil
);
11452 ASET (vector
, 0, make_number (mode_line_target
));
11453 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11454 ASET (vector
, 2, mode_line_string_list
);
11455 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11456 ASET (vector
, 4, mode_line_string_face
);
11457 ASET (vector
, 5, mode_line_string_face_prop
);
11460 XSETBUFFER (tmp
, obuf
);
11463 ASET (vector
, 6, tmp
);
11464 ASET (vector
, 7, owin
);
11467 /* Similarly to `with-selected-window', if the operation selects
11468 a window on another frame, we must restore that frame's
11469 selected window, and (for a tty) the top-frame. */
11470 ASET (vector
, 8, target_frame
->selected_window
);
11471 if (FRAME_TERMCAP_P (target_frame
))
11472 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11479 unwind_format_mode_line (Lisp_Object vector
)
11481 Lisp_Object old_window
= AREF (vector
, 7);
11482 Lisp_Object target_frame_window
= AREF (vector
, 8);
11483 Lisp_Object old_top_frame
= AREF (vector
, 9);
11485 mode_line_target
= XINT (AREF (vector
, 0));
11486 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11487 mode_line_string_list
= AREF (vector
, 2);
11488 if (! EQ (AREF (vector
, 3), Qt
))
11489 mode_line_proptrans_alist
= AREF (vector
, 3);
11490 mode_line_string_face
= AREF (vector
, 4);
11491 mode_line_string_face_prop
= AREF (vector
, 5);
11493 /* Select window before buffer, since it may change the buffer. */
11494 if (!NILP (old_window
))
11496 /* If the operation that we are unwinding had selected a window
11497 on a different frame, reset its frame-selected-window. For a
11498 text terminal, reset its top-frame if necessary. */
11499 if (!NILP (target_frame_window
))
11502 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11504 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11505 Fselect_window (target_frame_window
, Qt
);
11507 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11508 Fselect_frame (old_top_frame
, Qt
);
11511 Fselect_window (old_window
, Qt
);
11514 if (!NILP (AREF (vector
, 6)))
11516 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11517 ASET (vector
, 6, Qnil
);
11520 Vmode_line_unwind_vector
= vector
;
11524 /* Store a single character C for the frame title in mode_line_noprop_buf.
11525 Re-allocate mode_line_noprop_buf if necessary. */
11528 store_mode_line_noprop_char (char c
)
11530 /* If output position has reached the end of the allocated buffer,
11531 increase the buffer's size. */
11532 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11534 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11535 ptrdiff_t size
= len
;
11536 mode_line_noprop_buf
=
11537 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11538 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11539 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11542 *mode_line_noprop_ptr
++ = c
;
11546 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11547 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11548 characters that yield more columns than PRECISION; PRECISION <= 0
11549 means copy the whole string. Pad with spaces until FIELD_WIDTH
11550 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11551 pad. Called from display_mode_element when it is used to build a
11555 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11557 const unsigned char *str
= (const unsigned char *) string
;
11559 ptrdiff_t dummy
, nbytes
;
11561 /* Copy at most PRECISION chars from STR. */
11562 nbytes
= strlen (string
);
11563 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11565 store_mode_line_noprop_char (*str
++);
11567 /* Fill up with spaces until FIELD_WIDTH reached. */
11568 while (field_width
> 0
11569 && n
< field_width
)
11571 store_mode_line_noprop_char (' ');
11578 /***********************************************************************
11580 ***********************************************************************/
11582 #ifdef HAVE_WINDOW_SYSTEM
11584 /* Set the title of FRAME, if it has changed. The title format is
11585 Vicon_title_format if FRAME is iconified, otherwise it is
11586 frame_title_format. */
11589 x_consider_frame_title (Lisp_Object frame
)
11591 struct frame
*f
= XFRAME (frame
);
11593 if (FRAME_WINDOW_P (f
)
11594 || FRAME_MINIBUF_ONLY_P (f
)
11595 || f
->explicit_name
)
11597 /* Do we have more than one visible frame on this X display? */
11598 Lisp_Object tail
, other_frame
, fmt
;
11599 ptrdiff_t title_start
;
11603 ptrdiff_t count
= SPECPDL_INDEX ();
11605 FOR_EACH_FRAME (tail
, other_frame
)
11607 struct frame
*tf
= XFRAME (other_frame
);
11610 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11611 && !FRAME_MINIBUF_ONLY_P (tf
)
11612 && !EQ (other_frame
, tip_frame
)
11613 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11617 /* Set global variable indicating that multiple frames exist. */
11618 multiple_frames
= CONSP (tail
);
11620 /* Switch to the buffer of selected window of the frame. Set up
11621 mode_line_target so that display_mode_element will output into
11622 mode_line_noprop_buf; then display the title. */
11623 record_unwind_protect (unwind_format_mode_line
,
11624 format_mode_line_unwind_data
11625 (f
, current_buffer
, selected_window
, 0));
11627 Fselect_window (f
->selected_window
, Qt
);
11628 set_buffer_internal_1
11629 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11630 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11632 mode_line_target
= MODE_LINE_TITLE
;
11633 title_start
= MODE_LINE_NOPROP_LEN (0);
11634 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11635 NULL
, DEFAULT_FACE_ID
);
11636 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11637 len
= MODE_LINE_NOPROP_LEN (title_start
);
11638 title
= mode_line_noprop_buf
+ title_start
;
11639 unbind_to (count
, Qnil
);
11641 /* Set the title only if it's changed. This avoids consing in
11642 the common case where it hasn't. (If it turns out that we've
11643 already wasted too much time by walking through the list with
11644 display_mode_element, then we might need to optimize at a
11645 higher level than this.) */
11646 if (! STRINGP (f
->name
)
11647 || SBYTES (f
->name
) != len
11648 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11649 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11653 #endif /* not HAVE_WINDOW_SYSTEM */
11656 /***********************************************************************
11658 ***********************************************************************/
11660 /* Non-zero if we will not redisplay all visible windows. */
11661 #define REDISPLAY_SOME_P() \
11662 ((windows_or_buffers_changed == 0 \
11663 || windows_or_buffers_changed == REDISPLAY_SOME) \
11664 && (update_mode_lines == 0 \
11665 || update_mode_lines == REDISPLAY_SOME))
11667 /* Prepare for redisplay by updating menu-bar item lists when
11668 appropriate. This can call eval. */
11671 prepare_menu_bars (void)
11673 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11674 bool some_windows
= REDISPLAY_SOME_P ();
11675 struct gcpro gcpro1
, gcpro2
;
11676 Lisp_Object tooltip_frame
;
11678 #ifdef HAVE_WINDOW_SYSTEM
11679 tooltip_frame
= tip_frame
;
11681 tooltip_frame
= Qnil
;
11684 if (FUNCTIONP (Vpre_redisplay_function
))
11686 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11687 if (all_windows
&& some_windows
)
11689 Lisp_Object ws
= window_list ();
11690 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11692 Lisp_Object
this = XCAR (ws
);
11693 struct window
*w
= XWINDOW (this);
11695 || XFRAME (w
->frame
)->redisplay
11696 || XBUFFER (w
->contents
)->text
->redisplay
)
11698 windows
= Fcons (this, windows
);
11702 safe__call1 (true, Vpre_redisplay_function
, windows
);
11705 /* Update all frame titles based on their buffer names, etc. We do
11706 this before the menu bars so that the buffer-menu will show the
11707 up-to-date frame titles. */
11708 #ifdef HAVE_WINDOW_SYSTEM
11711 Lisp_Object tail
, frame
;
11713 FOR_EACH_FRAME (tail
, frame
)
11715 struct frame
*f
= XFRAME (frame
);
11716 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11720 && !XBUFFER (w
->contents
)->text
->redisplay
)
11723 if (!EQ (frame
, tooltip_frame
)
11724 && (FRAME_ICONIFIED_P (f
)
11725 || FRAME_VISIBLE_P (f
) == 1
11726 /* Exclude TTY frames that are obscured because they
11727 are not the top frame on their console. This is
11728 because x_consider_frame_title actually switches
11729 to the frame, which for TTY frames means it is
11730 marked as garbaged, and will be completely
11731 redrawn on the next redisplay cycle. This causes
11732 TTY frames to be completely redrawn, when there
11733 are more than one of them, even though nothing
11734 should be changed on display. */
11735 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11736 x_consider_frame_title (frame
);
11739 #endif /* HAVE_WINDOW_SYSTEM */
11741 /* Update the menu bar item lists, if appropriate. This has to be
11742 done before any actual redisplay or generation of display lines. */
11746 Lisp_Object tail
, frame
;
11747 ptrdiff_t count
= SPECPDL_INDEX ();
11748 /* 1 means that update_menu_bar has run its hooks
11749 so any further calls to update_menu_bar shouldn't do so again. */
11750 int menu_bar_hooks_run
= 0;
11752 record_unwind_save_match_data ();
11754 FOR_EACH_FRAME (tail
, frame
)
11756 struct frame
*f
= XFRAME (frame
);
11757 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11759 /* Ignore tooltip frame. */
11760 if (EQ (frame
, tooltip_frame
))
11766 && !XBUFFER (w
->contents
)->text
->redisplay
)
11769 /* If a window on this frame changed size, report that to
11770 the user and clear the size-change flag. */
11771 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11773 Lisp_Object functions
;
11775 /* Clear flag first in case we get an error below. */
11776 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11777 functions
= Vwindow_size_change_functions
;
11778 GCPRO2 (tail
, functions
);
11780 while (CONSP (functions
))
11782 if (!EQ (XCAR (functions
), Qt
))
11783 call1 (XCAR (functions
), frame
);
11784 functions
= XCDR (functions
);
11790 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11791 #ifdef HAVE_WINDOW_SYSTEM
11792 update_tool_bar (f
, 0);
11797 unbind_to (count
, Qnil
);
11801 struct frame
*sf
= SELECTED_FRAME ();
11802 update_menu_bar (sf
, 1, 0);
11803 #ifdef HAVE_WINDOW_SYSTEM
11804 update_tool_bar (sf
, 1);
11810 /* Update the menu bar item list for frame F. This has to be done
11811 before we start to fill in any display lines, because it can call
11814 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11816 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11817 already ran the menu bar hooks for this redisplay, so there
11818 is no need to run them again. The return value is the
11819 updated value of this flag, to pass to the next call. */
11822 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11824 Lisp_Object window
;
11825 register struct window
*w
;
11827 /* If called recursively during a menu update, do nothing. This can
11828 happen when, for instance, an activate-menubar-hook causes a
11830 if (inhibit_menubar_update
)
11833 window
= FRAME_SELECTED_WINDOW (f
);
11834 w
= XWINDOW (window
);
11836 if (FRAME_WINDOW_P (f
)
11838 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11839 || defined (HAVE_NS) || defined (USE_GTK)
11840 FRAME_EXTERNAL_MENU_BAR (f
)
11842 FRAME_MENU_BAR_LINES (f
) > 0
11844 : FRAME_MENU_BAR_LINES (f
) > 0)
11846 /* If the user has switched buffers or windows, we need to
11847 recompute to reflect the new bindings. But we'll
11848 recompute when update_mode_lines is set too; that means
11849 that people can use force-mode-line-update to request
11850 that the menu bar be recomputed. The adverse effect on
11851 the rest of the redisplay algorithm is about the same as
11852 windows_or_buffers_changed anyway. */
11853 if (windows_or_buffers_changed
11854 /* This used to test w->update_mode_line, but we believe
11855 there is no need to recompute the menu in that case. */
11856 || update_mode_lines
11857 || window_buffer_changed (w
))
11859 struct buffer
*prev
= current_buffer
;
11860 ptrdiff_t count
= SPECPDL_INDEX ();
11862 specbind (Qinhibit_menubar_update
, Qt
);
11864 set_buffer_internal_1 (XBUFFER (w
->contents
));
11865 if (save_match_data
)
11866 record_unwind_save_match_data ();
11867 if (NILP (Voverriding_local_map_menu_flag
))
11869 specbind (Qoverriding_terminal_local_map
, Qnil
);
11870 specbind (Qoverriding_local_map
, Qnil
);
11875 /* Run the Lucid hook. */
11876 safe_run_hooks (Qactivate_menubar_hook
);
11878 /* If it has changed current-menubar from previous value,
11879 really recompute the menu-bar from the value. */
11880 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11881 call0 (Qrecompute_lucid_menubar
);
11883 safe_run_hooks (Qmenu_bar_update_hook
);
11888 XSETFRAME (Vmenu_updating_frame
, f
);
11889 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11891 /* Redisplay the menu bar in case we changed it. */
11892 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11893 || defined (HAVE_NS) || defined (USE_GTK)
11894 if (FRAME_WINDOW_P (f
))
11896 #if defined (HAVE_NS)
11897 /* All frames on Mac OS share the same menubar. So only
11898 the selected frame should be allowed to set it. */
11899 if (f
== SELECTED_FRAME ())
11901 set_frame_menubar (f
, 0, 0);
11904 /* On a terminal screen, the menu bar is an ordinary screen
11905 line, and this makes it get updated. */
11906 w
->update_mode_line
= 1;
11907 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11908 /* In the non-toolkit version, the menu bar is an ordinary screen
11909 line, and this makes it get updated. */
11910 w
->update_mode_line
= 1;
11911 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11913 unbind_to (count
, Qnil
);
11914 set_buffer_internal_1 (prev
);
11921 /***********************************************************************
11923 ***********************************************************************/
11925 #ifdef HAVE_WINDOW_SYSTEM
11927 /* Tool-bar item index of the item on which a mouse button was pressed
11930 int last_tool_bar_item
;
11932 /* Select `frame' temporarily without running all the code in
11934 FIXME: Maybe do_switch_frame should be trimmed down similarly
11935 when `norecord' is set. */
11937 fast_set_selected_frame (Lisp_Object frame
)
11939 if (!EQ (selected_frame
, frame
))
11941 selected_frame
= frame
;
11942 selected_window
= XFRAME (frame
)->selected_window
;
11946 /* Update the tool-bar item list for frame F. This has to be done
11947 before we start to fill in any display lines. Called from
11948 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11949 and restore it here. */
11952 update_tool_bar (struct frame
*f
, int save_match_data
)
11954 #if defined (USE_GTK) || defined (HAVE_NS)
11955 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11957 int do_update
= (WINDOWP (f
->tool_bar_window
)
11958 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0);
11963 Lisp_Object window
;
11966 window
= FRAME_SELECTED_WINDOW (f
);
11967 w
= XWINDOW (window
);
11969 /* If the user has switched buffers or windows, we need to
11970 recompute to reflect the new bindings. But we'll
11971 recompute when update_mode_lines is set too; that means
11972 that people can use force-mode-line-update to request
11973 that the menu bar be recomputed. The adverse effect on
11974 the rest of the redisplay algorithm is about the same as
11975 windows_or_buffers_changed anyway. */
11976 if (windows_or_buffers_changed
11977 || w
->update_mode_line
11978 || update_mode_lines
11979 || window_buffer_changed (w
))
11981 struct buffer
*prev
= current_buffer
;
11982 ptrdiff_t count
= SPECPDL_INDEX ();
11983 Lisp_Object frame
, new_tool_bar
;
11984 int new_n_tool_bar
;
11985 struct gcpro gcpro1
;
11987 /* Set current_buffer to the buffer of the selected
11988 window of the frame, so that we get the right local
11990 set_buffer_internal_1 (XBUFFER (w
->contents
));
11992 /* Save match data, if we must. */
11993 if (save_match_data
)
11994 record_unwind_save_match_data ();
11996 /* Make sure that we don't accidentally use bogus keymaps. */
11997 if (NILP (Voverriding_local_map_menu_flag
))
11999 specbind (Qoverriding_terminal_local_map
, Qnil
);
12000 specbind (Qoverriding_local_map
, Qnil
);
12003 GCPRO1 (new_tool_bar
);
12005 /* We must temporarily set the selected frame to this frame
12006 before calling tool_bar_items, because the calculation of
12007 the tool-bar keymap uses the selected frame (see
12008 `tool-bar-make-keymap' in tool-bar.el). */
12009 eassert (EQ (selected_window
,
12010 /* Since we only explicitly preserve selected_frame,
12011 check that selected_window would be redundant. */
12012 XFRAME (selected_frame
)->selected_window
));
12013 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
12014 XSETFRAME (frame
, f
);
12015 fast_set_selected_frame (frame
);
12017 /* Build desired tool-bar items from keymaps. */
12019 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
12022 /* Redisplay the tool-bar if we changed it. */
12023 if (new_n_tool_bar
!= f
->n_tool_bar_items
12024 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
12026 /* Redisplay that happens asynchronously due to an expose event
12027 may access f->tool_bar_items. Make sure we update both
12028 variables within BLOCK_INPUT so no such event interrupts. */
12030 fset_tool_bar_items (f
, new_tool_bar
);
12031 f
->n_tool_bar_items
= new_n_tool_bar
;
12032 w
->update_mode_line
= 1;
12038 unbind_to (count
, Qnil
);
12039 set_buffer_internal_1 (prev
);
12044 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12046 /* Set F->desired_tool_bar_string to a Lisp string representing frame
12047 F's desired tool-bar contents. F->tool_bar_items must have
12048 been set up previously by calling prepare_menu_bars. */
12051 build_desired_tool_bar_string (struct frame
*f
)
12053 int i
, size
, size_needed
;
12054 struct gcpro gcpro1
, gcpro2
, gcpro3
;
12055 Lisp_Object image
, plist
, props
;
12057 image
= plist
= props
= Qnil
;
12058 GCPRO3 (image
, plist
, props
);
12060 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
12061 Otherwise, make a new string. */
12063 /* The size of the string we might be able to reuse. */
12064 size
= (STRINGP (f
->desired_tool_bar_string
)
12065 ? SCHARS (f
->desired_tool_bar_string
)
12068 /* We need one space in the string for each image. */
12069 size_needed
= f
->n_tool_bar_items
;
12071 /* Reuse f->desired_tool_bar_string, if possible. */
12072 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
12073 fset_desired_tool_bar_string
12074 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
12077 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
12078 Fremove_text_properties (make_number (0), make_number (size
),
12079 props
, f
->desired_tool_bar_string
);
12082 /* Put a `display' property on the string for the images to display,
12083 put a `menu_item' property on tool-bar items with a value that
12084 is the index of the item in F's tool-bar item vector. */
12085 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
12087 #define PROP(IDX) \
12088 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12090 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
12091 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
12092 int hmargin
, vmargin
, relief
, idx
, end
;
12094 /* If image is a vector, choose the image according to the
12096 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
12097 if (VECTORP (image
))
12101 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12102 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12105 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12106 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12108 eassert (ASIZE (image
) >= idx
);
12109 image
= AREF (image
, idx
);
12114 /* Ignore invalid image specifications. */
12115 if (!valid_image_p (image
))
12118 /* Display the tool-bar button pressed, or depressed. */
12119 plist
= Fcopy_sequence (XCDR (image
));
12121 /* Compute margin and relief to draw. */
12122 relief
= (tool_bar_button_relief
>= 0
12123 ? tool_bar_button_relief
12124 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12125 hmargin
= vmargin
= relief
;
12127 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12128 INT_MAX
- max (hmargin
, vmargin
)))
12130 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12131 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12133 else if (CONSP (Vtool_bar_button_margin
))
12135 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12136 INT_MAX
- hmargin
))
12137 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12139 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12140 INT_MAX
- vmargin
))
12141 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12144 if (auto_raise_tool_bar_buttons_p
)
12146 /* Add a `:relief' property to the image spec if the item is
12150 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12157 /* If image is selected, display it pressed, i.e. with a
12158 negative relief. If it's not selected, display it with a
12160 plist
= Fplist_put (plist
, QCrelief
,
12162 ? make_number (-relief
)
12163 : make_number (relief
)));
12168 /* Put a margin around the image. */
12169 if (hmargin
|| vmargin
)
12171 if (hmargin
== vmargin
)
12172 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12174 plist
= Fplist_put (plist
, QCmargin
,
12175 Fcons (make_number (hmargin
),
12176 make_number (vmargin
)));
12179 /* If button is not enabled, and we don't have special images
12180 for the disabled state, make the image appear disabled by
12181 applying an appropriate algorithm to it. */
12182 if (!enabled_p
&& idx
< 0)
12183 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12185 /* Put a `display' text property on the string for the image to
12186 display. Put a `menu-item' property on the string that gives
12187 the start of this item's properties in the tool-bar items
12189 image
= Fcons (Qimage
, plist
);
12190 props
= list4 (Qdisplay
, image
,
12191 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12193 /* Let the last image hide all remaining spaces in the tool bar
12194 string. The string can be longer than needed when we reuse a
12195 previous string. */
12196 if (i
+ 1 == f
->n_tool_bar_items
)
12197 end
= SCHARS (f
->desired_tool_bar_string
);
12200 Fadd_text_properties (make_number (i
), make_number (end
),
12201 props
, f
->desired_tool_bar_string
);
12209 /* Display one line of the tool-bar of frame IT->f.
12211 HEIGHT specifies the desired height of the tool-bar line.
12212 If the actual height of the glyph row is less than HEIGHT, the
12213 row's height is increased to HEIGHT, and the icons are centered
12214 vertically in the new height.
12216 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12217 count a final empty row in case the tool-bar width exactly matches
12222 display_tool_bar_line (struct it
*it
, int height
)
12224 struct glyph_row
*row
= it
->glyph_row
;
12225 int max_x
= it
->last_visible_x
;
12226 struct glyph
*last
;
12228 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12229 clear_glyph_row (row
);
12230 row
->enabled_p
= true;
12231 row
->y
= it
->current_y
;
12233 /* Note that this isn't made use of if the face hasn't a box,
12234 so there's no need to check the face here. */
12235 it
->start_of_box_run_p
= 1;
12237 while (it
->current_x
< max_x
)
12239 int x
, n_glyphs_before
, i
, nglyphs
;
12240 struct it it_before
;
12242 /* Get the next display element. */
12243 if (!get_next_display_element (it
))
12245 /* Don't count empty row if we are counting needed tool-bar lines. */
12246 if (height
< 0 && !it
->hpos
)
12251 /* Produce glyphs. */
12252 n_glyphs_before
= row
->used
[TEXT_AREA
];
12255 PRODUCE_GLYPHS (it
);
12257 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12259 x
= it_before
.current_x
;
12260 while (i
< nglyphs
)
12262 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12264 if (x
+ glyph
->pixel_width
> max_x
)
12266 /* Glyph doesn't fit on line. Backtrack. */
12267 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12269 /* If this is the only glyph on this line, it will never fit on the
12270 tool-bar, so skip it. But ensure there is at least one glyph,
12271 so we don't accidentally disable the tool-bar. */
12272 if (n_glyphs_before
== 0
12273 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12279 x
+= glyph
->pixel_width
;
12283 /* Stop at line end. */
12284 if (ITERATOR_AT_END_OF_LINE_P (it
))
12287 set_iterator_to_next (it
, 1);
12292 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12294 /* Use default face for the border below the tool bar.
12296 FIXME: When auto-resize-tool-bars is grow-only, there is
12297 no additional border below the possibly empty tool-bar lines.
12298 So to make the extra empty lines look "normal", we have to
12299 use the tool-bar face for the border too. */
12300 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12301 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12302 it
->face_id
= DEFAULT_FACE_ID
;
12304 extend_face_to_end_of_line (it
);
12305 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12306 last
->right_box_line_p
= 1;
12307 if (last
== row
->glyphs
[TEXT_AREA
])
12308 last
->left_box_line_p
= 1;
12310 /* Make line the desired height and center it vertically. */
12311 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12313 /* Don't add more than one line height. */
12314 height
%= FRAME_LINE_HEIGHT (it
->f
);
12315 it
->max_ascent
+= height
/ 2;
12316 it
->max_descent
+= (height
+ 1) / 2;
12319 compute_line_metrics (it
);
12321 /* If line is empty, make it occupy the rest of the tool-bar. */
12322 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12324 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12325 row
->visible_height
= row
->height
;
12326 row
->ascent
= row
->phys_ascent
= 0;
12327 row
->extra_line_spacing
= 0;
12330 row
->full_width_p
= 1;
12331 row
->continued_p
= 0;
12332 row
->truncated_on_left_p
= 0;
12333 row
->truncated_on_right_p
= 0;
12335 it
->current_x
= it
->hpos
= 0;
12336 it
->current_y
+= row
->height
;
12342 /* Max tool-bar height. Basically, this is what makes all other windows
12343 disappear when the frame gets too small. Rethink this! */
12345 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
12346 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
12348 /* Value is the number of pixels needed to make all tool-bar items of
12349 frame F visible. The actual number of glyph rows needed is
12350 returned in *N_ROWS if non-NULL. */
12353 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12355 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12357 /* tool_bar_height is called from redisplay_tool_bar after building
12358 the desired matrix, so use (unused) mode-line row as temporary row to
12359 avoid destroying the first tool-bar row. */
12360 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12362 /* Initialize an iterator for iteration over
12363 F->desired_tool_bar_string in the tool-bar window of frame F. */
12364 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12365 it
.first_visible_x
= 0;
12366 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12367 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12368 it
.paragraph_embedding
= L2R
;
12370 while (!ITERATOR_AT_END_P (&it
))
12372 clear_glyph_row (temp_row
);
12373 it
.glyph_row
= temp_row
;
12374 display_tool_bar_line (&it
, -1);
12376 clear_glyph_row (temp_row
);
12378 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12380 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12383 return it
.current_y
;
12385 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12388 #endif /* !USE_GTK && !HAVE_NS */
12390 #if defined USE_GTK || defined HAVE_NS
12391 EXFUN (Ftool_bar_height
, 2) ATTRIBUTE_CONST
;
12392 EXFUN (Ftool_bar_lines_needed
, 1) ATTRIBUTE_CONST
;
12395 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12397 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12398 If FRAME is nil or omitted, use the selected frame. Optional argument
12399 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12400 (Lisp_Object frame
, Lisp_Object pixelwise
)
12404 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12405 struct frame
*f
= decode_any_frame (frame
);
12407 if (WINDOWP (f
->tool_bar_window
)
12408 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12410 update_tool_bar (f
, 1);
12411 if (f
->n_tool_bar_items
)
12413 build_desired_tool_bar_string (f
);
12414 height
= tool_bar_height (f
, NULL
, NILP (pixelwise
) ? 0 : 1);
12419 return make_number (height
);
12423 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
12424 height should be changed. */
12427 redisplay_tool_bar (struct frame
*f
)
12429 #if defined (USE_GTK) || defined (HAVE_NS)
12431 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12432 update_frame_tool_bar (f
);
12435 #else /* !USE_GTK && !HAVE_NS */
12439 struct glyph_row
*row
;
12441 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12442 do anything. This means you must start with tool-bar-lines
12443 non-zero to get the auto-sizing effect. Or in other words, you
12444 can turn off tool-bars by specifying tool-bar-lines zero. */
12445 if (!WINDOWP (f
->tool_bar_window
)
12446 || (w
= XWINDOW (f
->tool_bar_window
),
12447 WINDOW_PIXEL_HEIGHT (w
) == 0))
12450 /* Set up an iterator for the tool-bar window. */
12451 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12452 it
.first_visible_x
= 0;
12453 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12454 row
= it
.glyph_row
;
12456 /* Build a string that represents the contents of the tool-bar. */
12457 build_desired_tool_bar_string (f
);
12458 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12459 /* FIXME: This should be controlled by a user option. But it
12460 doesn't make sense to have an R2L tool bar if the menu bar cannot
12461 be drawn also R2L, and making the menu bar R2L is tricky due
12462 toolkit-specific code that implements it. If an R2L tool bar is
12463 ever supported, display_tool_bar_line should also be augmented to
12464 call unproduce_glyphs like display_line and display_string
12466 it
.paragraph_embedding
= L2R
;
12468 if (f
->n_tool_bar_rows
== 0)
12470 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, 1);
12472 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12475 int new_lines
= ((new_height
+ FRAME_LINE_HEIGHT (f
) - 1)
12476 / FRAME_LINE_HEIGHT (f
));
12478 XSETFRAME (frame
, f
);
12479 Fmodify_frame_parameters (frame
,
12480 list1 (Fcons (Qtool_bar_lines
,
12481 make_number (new_lines
))));
12482 /* Always do that now. */
12483 clear_glyph_matrix (w
->desired_matrix
);
12484 f
->fonts_changed
= 1;
12489 /* Display as many lines as needed to display all tool-bar items. */
12491 if (f
->n_tool_bar_rows
> 0)
12493 int border
, rows
, height
, extra
;
12495 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12496 border
= XINT (Vtool_bar_border
);
12497 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12498 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12499 else if (EQ (Vtool_bar_border
, Qborder_width
))
12500 border
= f
->border_width
;
12506 rows
= f
->n_tool_bar_rows
;
12507 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12508 extra
= it
.last_visible_y
- border
- height
* rows
;
12510 while (it
.current_y
< it
.last_visible_y
)
12513 if (extra
> 0 && rows
-- > 0)
12515 h
= (extra
+ rows
- 1) / rows
;
12518 display_tool_bar_line (&it
, height
+ h
);
12523 while (it
.current_y
< it
.last_visible_y
)
12524 display_tool_bar_line (&it
, 0);
12527 /* It doesn't make much sense to try scrolling in the tool-bar
12528 window, so don't do it. */
12529 w
->desired_matrix
->no_scrolling_p
= 1;
12530 w
->must_be_updated_p
= 1;
12532 if (!NILP (Vauto_resize_tool_bars
))
12534 /* Do we really allow the toolbar to occupy the whole frame? */
12535 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
12536 int change_height_p
= 0;
12538 /* If we couldn't display everything, change the tool-bar's
12539 height if there is room for more. */
12540 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
12541 && it
.current_y
< max_tool_bar_height
)
12542 change_height_p
= 1;
12544 /* We subtract 1 because display_tool_bar_line advances the
12545 glyph_row pointer before returning to its caller. We want to
12546 examine the last glyph row produced by
12547 display_tool_bar_line. */
12548 row
= it
.glyph_row
- 1;
12550 /* If there are blank lines at the end, except for a partially
12551 visible blank line at the end that is smaller than
12552 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12553 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12554 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12555 change_height_p
= 1;
12557 /* If row displays tool-bar items, but is partially visible,
12558 change the tool-bar's height. */
12559 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12560 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
12561 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
12562 change_height_p
= 1;
12564 /* Resize windows as needed by changing the `tool-bar-lines'
12565 frame parameter. */
12566 if (change_height_p
)
12570 int new_height
= tool_bar_height (f
, &nrows
, 1);
12572 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12573 && !f
->minimize_tool_bar_window_p
)
12574 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12575 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12576 f
->minimize_tool_bar_window_p
= 0;
12578 if (change_height_p
)
12580 /* Current size of the tool-bar window in canonical line
12582 int old_lines
= WINDOW_TOTAL_LINES (w
);
12583 /* Required size of the tool-bar window in canonical
12585 int new_lines
= ((new_height
+ FRAME_LINE_HEIGHT (f
) - 1)
12586 / FRAME_LINE_HEIGHT (f
));
12587 /* Maximum size of the tool-bar window in canonical line
12588 units that this frame can allow. */
12590 WINDOW_TOTAL_LINES (XWINDOW (FRAME_ROOT_WINDOW (f
))) - 1;
12592 /* Don't try to change the tool-bar window size and set
12593 the fonts_changed flag unless really necessary. That
12594 flag causes redisplay to give up and retry
12595 redisplaying the frame from scratch, so setting it
12596 unnecessarily can lead to nasty redisplay loops. */
12597 if (new_lines
<= max_lines
12598 && eabs (new_lines
- old_lines
) >= 1)
12600 XSETFRAME (frame
, f
);
12601 Fmodify_frame_parameters (frame
,
12602 list1 (Fcons (Qtool_bar_lines
,
12603 make_number (new_lines
))));
12604 clear_glyph_matrix (w
->desired_matrix
);
12605 f
->n_tool_bar_rows
= nrows
;
12606 f
->fonts_changed
= 1;
12613 f
->minimize_tool_bar_window_p
= 0;
12616 #endif /* USE_GTK || HAVE_NS */
12619 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12621 /* Get information about the tool-bar item which is displayed in GLYPH
12622 on frame F. Return in *PROP_IDX the index where tool-bar item
12623 properties start in F->tool_bar_items. Value is zero if
12624 GLYPH doesn't display a tool-bar item. */
12627 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12633 /* This function can be called asynchronously, which means we must
12634 exclude any possibility that Fget_text_property signals an
12636 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12637 charpos
= max (0, charpos
);
12639 /* Get the text property `menu-item' at pos. The value of that
12640 property is the start index of this item's properties in
12641 F->tool_bar_items. */
12642 prop
= Fget_text_property (make_number (charpos
),
12643 Qmenu_item
, f
->current_tool_bar_string
);
12644 if (INTEGERP (prop
))
12646 *prop_idx
= XINT (prop
);
12656 /* Get information about the tool-bar item at position X/Y on frame F.
12657 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12658 the current matrix of the tool-bar window of F, or NULL if not
12659 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12660 item in F->tool_bar_items. Value is
12662 -1 if X/Y is not on a tool-bar item
12663 0 if X/Y is on the same item that was highlighted before.
12667 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12668 int *hpos
, int *vpos
, int *prop_idx
)
12670 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12671 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12674 /* Find the glyph under X/Y. */
12675 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12676 if (*glyph
== NULL
)
12679 /* Get the start of this tool-bar item's properties in
12680 f->tool_bar_items. */
12681 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12684 /* Is mouse on the highlighted item? */
12685 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12686 && *vpos
>= hlinfo
->mouse_face_beg_row
12687 && *vpos
<= hlinfo
->mouse_face_end_row
12688 && (*vpos
> hlinfo
->mouse_face_beg_row
12689 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12690 && (*vpos
< hlinfo
->mouse_face_end_row
12691 || *hpos
< hlinfo
->mouse_face_end_col
12692 || hlinfo
->mouse_face_past_end
))
12700 Handle mouse button event on the tool-bar of frame F, at
12701 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12702 0 for button release. MODIFIERS is event modifiers for button
12706 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12709 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12710 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12711 int hpos
, vpos
, prop_idx
;
12712 struct glyph
*glyph
;
12713 Lisp_Object enabled_p
;
12716 /* If not on the highlighted tool-bar item, and mouse-highlight is
12717 non-nil, return. This is so we generate the tool-bar button
12718 click only when the mouse button is released on the same item as
12719 where it was pressed. However, when mouse-highlight is disabled,
12720 generate the click when the button is released regardless of the
12721 highlight, since tool-bar items are not highlighted in that
12723 frame_to_window_pixel_xy (w
, &x
, &y
);
12724 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12726 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12729 /* When mouse-highlight is off, generate the click for the item
12730 where the button was pressed, disregarding where it was
12732 if (NILP (Vmouse_highlight
) && !down_p
)
12733 prop_idx
= last_tool_bar_item
;
12735 /* If item is disabled, do nothing. */
12736 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12737 if (NILP (enabled_p
))
12742 /* Show item in pressed state. */
12743 if (!NILP (Vmouse_highlight
))
12744 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12745 last_tool_bar_item
= prop_idx
;
12749 Lisp_Object key
, frame
;
12750 struct input_event event
;
12751 EVENT_INIT (event
);
12753 /* Show item in released state. */
12754 if (!NILP (Vmouse_highlight
))
12755 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12757 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12759 XSETFRAME (frame
, f
);
12760 event
.kind
= TOOL_BAR_EVENT
;
12761 event
.frame_or_window
= frame
;
12763 kbd_buffer_store_event (&event
);
12765 event
.kind
= TOOL_BAR_EVENT
;
12766 event
.frame_or_window
= frame
;
12768 event
.modifiers
= modifiers
;
12769 kbd_buffer_store_event (&event
);
12770 last_tool_bar_item
= -1;
12775 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12776 tool-bar window-relative coordinates X/Y. Called from
12777 note_mouse_highlight. */
12780 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12782 Lisp_Object window
= f
->tool_bar_window
;
12783 struct window
*w
= XWINDOW (window
);
12784 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12785 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12787 struct glyph
*glyph
;
12788 struct glyph_row
*row
;
12790 Lisp_Object enabled_p
;
12792 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12793 int mouse_down_p
, rc
;
12795 /* Function note_mouse_highlight is called with negative X/Y
12796 values when mouse moves outside of the frame. */
12797 if (x
<= 0 || y
<= 0)
12799 clear_mouse_face (hlinfo
);
12803 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12806 /* Not on tool-bar item. */
12807 clear_mouse_face (hlinfo
);
12811 /* On same tool-bar item as before. */
12812 goto set_help_echo
;
12814 clear_mouse_face (hlinfo
);
12816 /* Mouse is down, but on different tool-bar item? */
12817 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12818 && f
== dpyinfo
->last_mouse_frame
);
12821 && last_tool_bar_item
!= prop_idx
)
12824 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12826 /* If tool-bar item is not enabled, don't highlight it. */
12827 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12828 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12830 /* Compute the x-position of the glyph. In front and past the
12831 image is a space. We include this in the highlighted area. */
12832 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12833 for (i
= x
= 0; i
< hpos
; ++i
)
12834 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12836 /* Record this as the current active region. */
12837 hlinfo
->mouse_face_beg_col
= hpos
;
12838 hlinfo
->mouse_face_beg_row
= vpos
;
12839 hlinfo
->mouse_face_beg_x
= x
;
12840 hlinfo
->mouse_face_past_end
= 0;
12842 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12843 hlinfo
->mouse_face_end_row
= vpos
;
12844 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12845 hlinfo
->mouse_face_window
= window
;
12846 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12848 /* Display it as active. */
12849 show_mouse_face (hlinfo
, draw
);
12854 /* Set help_echo_string to a help string to display for this tool-bar item.
12855 XTread_socket does the rest. */
12856 help_echo_object
= help_echo_window
= Qnil
;
12857 help_echo_pos
= -1;
12858 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12859 if (NILP (help_echo_string
))
12860 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12863 #endif /* !USE_GTK && !HAVE_NS */
12865 #endif /* HAVE_WINDOW_SYSTEM */
12869 /************************************************************************
12870 Horizontal scrolling
12871 ************************************************************************/
12873 static int hscroll_window_tree (Lisp_Object
);
12874 static int hscroll_windows (Lisp_Object
);
12876 /* For all leaf windows in the window tree rooted at WINDOW, set their
12877 hscroll value so that PT is (i) visible in the window, and (ii) so
12878 that it is not within a certain margin at the window's left and
12879 right border. Value is non-zero if any window's hscroll has been
12883 hscroll_window_tree (Lisp_Object window
)
12885 int hscrolled_p
= 0;
12886 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12887 int hscroll_step_abs
= 0;
12888 double hscroll_step_rel
= 0;
12890 if (hscroll_relative_p
)
12892 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12893 if (hscroll_step_rel
< 0)
12895 hscroll_relative_p
= 0;
12896 hscroll_step_abs
= 0;
12899 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12901 hscroll_step_abs
= XINT (Vhscroll_step
);
12902 if (hscroll_step_abs
< 0)
12903 hscroll_step_abs
= 0;
12906 hscroll_step_abs
= 0;
12908 while (WINDOWP (window
))
12910 struct window
*w
= XWINDOW (window
);
12912 if (WINDOWP (w
->contents
))
12913 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12914 else if (w
->cursor
.vpos
>= 0)
12917 int text_area_width
;
12918 struct glyph_row
*cursor_row
;
12919 struct glyph_row
*bottom_row
;
12922 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12923 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12924 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12926 cursor_row
= bottom_row
- 1;
12928 if (!cursor_row
->enabled_p
)
12930 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12931 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12932 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12934 cursor_row
= bottom_row
- 1;
12936 row_r2l_p
= cursor_row
->reversed_p
;
12938 text_area_width
= window_box_width (w
, TEXT_AREA
);
12940 /* Scroll when cursor is inside this scroll margin. */
12941 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12943 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12944 /* In some pathological cases, like restoring a window
12945 configuration into a frame that is much smaller than
12946 the one from which the configuration was saved, we
12947 get glyph rows whose start and end have zero buffer
12948 positions, which we cannot handle below. Just skip
12950 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12951 /* For left-to-right rows, hscroll when cursor is either
12952 (i) inside the right hscroll margin, or (ii) if it is
12953 inside the left margin and the window is already
12957 && w
->cursor
.x
<= h_margin
)
12958 || (cursor_row
->enabled_p
12959 && cursor_row
->truncated_on_right_p
12960 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12961 /* For right-to-left rows, the logic is similar,
12962 except that rules for scrolling to left and right
12963 are reversed. E.g., if cursor.x <= h_margin, we
12964 need to hscroll "to the right" unconditionally,
12965 and that will scroll the screen to the left so as
12966 to reveal the next portion of the row. */
12968 && ((cursor_row
->enabled_p
12969 /* FIXME: It is confusing to set the
12970 truncated_on_right_p flag when R2L rows
12971 are actually truncated on the left. */
12972 && cursor_row
->truncated_on_right_p
12973 && w
->cursor
.x
<= h_margin
)
12975 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12979 struct buffer
*saved_current_buffer
;
12983 /* Find point in a display of infinite width. */
12984 saved_current_buffer
= current_buffer
;
12985 current_buffer
= XBUFFER (w
->contents
);
12987 if (w
== XWINDOW (selected_window
))
12990 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12992 /* Move iterator to pt starting at cursor_row->start in
12993 a line with infinite width. */
12994 init_to_row_start (&it
, w
, cursor_row
);
12995 it
.last_visible_x
= INFINITY
;
12996 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12997 current_buffer
= saved_current_buffer
;
12999 /* Position cursor in window. */
13000 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
13001 hscroll
= max (0, (it
.current_x
13002 - (ITERATOR_AT_END_OF_LINE_P (&it
)
13003 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
13004 : (text_area_width
/ 2))))
13005 / FRAME_COLUMN_WIDTH (it
.f
);
13006 else if ((!row_r2l_p
13007 && w
->cursor
.x
>= text_area_width
- h_margin
)
13008 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
13010 if (hscroll_relative_p
)
13011 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
13014 wanted_x
= text_area_width
13015 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
13018 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
13022 if (hscroll_relative_p
)
13023 wanted_x
= text_area_width
* hscroll_step_rel
13026 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
13029 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
13031 hscroll
= max (hscroll
, w
->min_hscroll
);
13033 /* Don't prevent redisplay optimizations if hscroll
13034 hasn't changed, as it will unnecessarily slow down
13036 if (w
->hscroll
!= hscroll
)
13038 XBUFFER (w
->contents
)->prevent_redisplay_optimizations_p
= 1;
13039 w
->hscroll
= hscroll
;
13048 /* Value is non-zero if hscroll of any leaf window has been changed. */
13049 return hscrolled_p
;
13053 /* Set hscroll so that cursor is visible and not inside horizontal
13054 scroll margins for all windows in the tree rooted at WINDOW. See
13055 also hscroll_window_tree above. Value is non-zero if any window's
13056 hscroll has been changed. If it has, desired matrices on the frame
13057 of WINDOW are cleared. */
13060 hscroll_windows (Lisp_Object window
)
13062 int hscrolled_p
= hscroll_window_tree (window
);
13064 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
13065 return hscrolled_p
;
13070 /************************************************************************
13072 ************************************************************************/
13074 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
13075 to a non-zero value. This is sometimes handy to have in a debugger
13080 /* First and last unchanged row for try_window_id. */
13082 static int debug_first_unchanged_at_end_vpos
;
13083 static int debug_last_unchanged_at_beg_vpos
;
13085 /* Delta vpos and y. */
13087 static int debug_dvpos
, debug_dy
;
13089 /* Delta in characters and bytes for try_window_id. */
13091 static ptrdiff_t debug_delta
, debug_delta_bytes
;
13093 /* Values of window_end_pos and window_end_vpos at the end of
13096 static ptrdiff_t debug_end_vpos
;
13098 /* Append a string to W->desired_matrix->method. FMT is a printf
13099 format string. If trace_redisplay_p is true also printf the
13100 resulting string to stderr. */
13102 static void debug_method_add (struct window
*, char const *, ...)
13103 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13106 debug_method_add (struct window
*w
, char const *fmt
, ...)
13109 char *method
= w
->desired_matrix
->method
;
13110 int len
= strlen (method
);
13111 int size
= sizeof w
->desired_matrix
->method
;
13112 int remaining
= size
- len
- 1;
13115 if (len
&& remaining
)
13118 --remaining
, ++len
;
13121 va_start (ap
, fmt
);
13122 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13125 if (trace_redisplay_p
)
13126 fprintf (stderr
, "%p (%s): %s\n",
13128 ((BUFFERP (w
->contents
)
13129 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13130 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13135 #endif /* GLYPH_DEBUG */
13138 /* Value is non-zero if all changes in window W, which displays
13139 current_buffer, are in the text between START and END. START is a
13140 buffer position, END is given as a distance from Z. Used in
13141 redisplay_internal for display optimization. */
13144 text_outside_line_unchanged_p (struct window
*w
,
13145 ptrdiff_t start
, ptrdiff_t end
)
13147 int unchanged_p
= 1;
13149 /* If text or overlays have changed, see where. */
13150 if (window_outdated (w
))
13152 /* Gap in the line? */
13153 if (GPT
< start
|| Z
- GPT
< end
)
13156 /* Changes start in front of the line, or end after it? */
13158 && (BEG_UNCHANGED
< start
- 1
13159 || END_UNCHANGED
< end
))
13162 /* If selective display, can't optimize if changes start at the
13163 beginning of the line. */
13165 && INTEGERP (BVAR (current_buffer
, selective_display
))
13166 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13167 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13170 /* If there are overlays at the start or end of the line, these
13171 may have overlay strings with newlines in them. A change at
13172 START, for instance, may actually concern the display of such
13173 overlay strings as well, and they are displayed on different
13174 lines. So, quickly rule out this case. (For the future, it
13175 might be desirable to implement something more telling than
13176 just BEG/END_UNCHANGED.) */
13179 if (BEG
+ BEG_UNCHANGED
== start
13180 && overlay_touches_p (start
))
13182 if (END_UNCHANGED
== end
13183 && overlay_touches_p (Z
- end
))
13187 /* Under bidi reordering, adding or deleting a character in the
13188 beginning of a paragraph, before the first strong directional
13189 character, can change the base direction of the paragraph (unless
13190 the buffer specifies a fixed paragraph direction), which will
13191 require to redisplay the whole paragraph. It might be worthwhile
13192 to find the paragraph limits and widen the range of redisplayed
13193 lines to that, but for now just give up this optimization. */
13194 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13195 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13199 return unchanged_p
;
13203 /* Do a frame update, taking possible shortcuts into account. This is
13204 the main external entry point for redisplay.
13206 If the last redisplay displayed an echo area message and that message
13207 is no longer requested, we clear the echo area or bring back the
13208 mini-buffer if that is in use. */
13213 redisplay_internal ();
13218 overlay_arrow_string_or_property (Lisp_Object var
)
13222 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13225 return Voverlay_arrow_string
;
13228 /* Return 1 if there are any overlay-arrows in current_buffer. */
13230 overlay_arrow_in_current_buffer_p (void)
13234 for (vlist
= Voverlay_arrow_variable_list
;
13236 vlist
= XCDR (vlist
))
13238 Lisp_Object var
= XCAR (vlist
);
13241 if (!SYMBOLP (var
))
13243 val
= find_symbol_value (var
);
13245 && current_buffer
== XMARKER (val
)->buffer
)
13252 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
13256 overlay_arrows_changed_p (void)
13260 for (vlist
= Voverlay_arrow_variable_list
;
13262 vlist
= XCDR (vlist
))
13264 Lisp_Object var
= XCAR (vlist
);
13265 Lisp_Object val
, pstr
;
13267 if (!SYMBOLP (var
))
13269 val
= find_symbol_value (var
);
13270 if (!MARKERP (val
))
13272 if (! EQ (COERCE_MARKER (val
),
13273 Fget (var
, Qlast_arrow_position
))
13274 || ! (pstr
= overlay_arrow_string_or_property (var
),
13275 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13281 /* Mark overlay arrows to be updated on next redisplay. */
13284 update_overlay_arrows (int up_to_date
)
13288 for (vlist
= Voverlay_arrow_variable_list
;
13290 vlist
= XCDR (vlist
))
13292 Lisp_Object var
= XCAR (vlist
);
13294 if (!SYMBOLP (var
))
13297 if (up_to_date
> 0)
13299 Lisp_Object val
= find_symbol_value (var
);
13300 Fput (var
, Qlast_arrow_position
,
13301 COERCE_MARKER (val
));
13302 Fput (var
, Qlast_arrow_string
,
13303 overlay_arrow_string_or_property (var
));
13305 else if (up_to_date
< 0
13306 || !NILP (Fget (var
, Qlast_arrow_position
)))
13308 Fput (var
, Qlast_arrow_position
, Qt
);
13309 Fput (var
, Qlast_arrow_string
, Qt
);
13315 /* Return overlay arrow string to display at row.
13316 Return integer (bitmap number) for arrow bitmap in left fringe.
13317 Return nil if no overlay arrow. */
13320 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13324 for (vlist
= Voverlay_arrow_variable_list
;
13326 vlist
= XCDR (vlist
))
13328 Lisp_Object var
= XCAR (vlist
);
13331 if (!SYMBOLP (var
))
13334 val
= find_symbol_value (var
);
13337 && current_buffer
== XMARKER (val
)->buffer
13338 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13340 if (FRAME_WINDOW_P (it
->f
)
13341 /* FIXME: if ROW->reversed_p is set, this should test
13342 the right fringe, not the left one. */
13343 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13345 #ifdef HAVE_WINDOW_SYSTEM
13346 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13349 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
13350 return make_number (fringe_bitmap
);
13353 return make_number (-1); /* Use default arrow bitmap. */
13355 return overlay_arrow_string_or_property (var
);
13362 /* Return 1 if point moved out of or into a composition. Otherwise
13363 return 0. PREV_BUF and PREV_PT are the last point buffer and
13364 position. BUF and PT are the current point buffer and position. */
13367 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13368 struct buffer
*buf
, ptrdiff_t pt
)
13370 ptrdiff_t start
, end
;
13372 Lisp_Object buffer
;
13374 XSETBUFFER (buffer
, buf
);
13375 /* Check a composition at the last point if point moved within the
13377 if (prev_buf
== buf
)
13380 /* Point didn't move. */
13383 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13384 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13385 && composition_valid_p (start
, end
, prop
)
13386 && start
< prev_pt
&& end
> prev_pt
)
13387 /* The last point was within the composition. Return 1 iff
13388 point moved out of the composition. */
13389 return (pt
<= start
|| pt
>= end
);
13392 /* Check a composition at the current point. */
13393 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13394 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13395 && composition_valid_p (start
, end
, prop
)
13396 && start
< pt
&& end
> pt
);
13399 /* Reconsider the clip changes of buffer which is displayed in W. */
13402 reconsider_clip_changes (struct window
*w
)
13404 struct buffer
*b
= XBUFFER (w
->contents
);
13406 if (b
->clip_changed
13407 && w
->window_end_valid
13408 && w
->current_matrix
->buffer
== b
13409 && w
->current_matrix
->zv
== BUF_ZV (b
)
13410 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13411 b
->clip_changed
= 0;
13413 /* If display wasn't paused, and W is not a tool bar window, see if
13414 point has been moved into or out of a composition. In that case,
13415 we set b->clip_changed to 1 to force updating the screen. If
13416 b->clip_changed has already been set to 1, we can skip this
13418 if (!b
->clip_changed
&& w
->window_end_valid
)
13420 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13421 ? PT
: marker_position (w
->pointm
));
13423 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13424 && check_point_in_composition (w
->current_matrix
->buffer
,
13425 w
->last_point
, b
, pt
))
13426 b
->clip_changed
= 1;
13431 propagate_buffer_redisplay (void)
13432 { /* Resetting b->text->redisplay is problematic!
13433 We can't just reset it in the case that some window that displays
13434 it has not been redisplayed; and such a window can stay
13435 unredisplayed for a long time if it's currently invisible.
13436 But we do want to reset it at the end of redisplay otherwise
13437 its displayed windows will keep being redisplayed over and over
13439 So we copy all b->text->redisplay flags up to their windows here,
13440 such that mark_window_display_accurate can safely reset
13441 b->text->redisplay. */
13442 Lisp_Object ws
= window_list ();
13443 for (; CONSP (ws
); ws
= XCDR (ws
))
13445 struct window
*thisw
= XWINDOW (XCAR (ws
));
13446 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13447 if (thisb
->text
->redisplay
)
13448 thisw
->redisplay
= true;
13452 #define STOP_POLLING \
13453 do { if (! polling_stopped_here) stop_polling (); \
13454 polling_stopped_here = 1; } while (0)
13456 #define RESUME_POLLING \
13457 do { if (polling_stopped_here) start_polling (); \
13458 polling_stopped_here = 0; } while (0)
13461 /* Perhaps in the future avoid recentering windows if it
13462 is not necessary; currently that causes some problems. */
13465 redisplay_internal (void)
13467 struct window
*w
= XWINDOW (selected_window
);
13471 bool must_finish
= 0, match_p
;
13472 struct text_pos tlbufpos
, tlendpos
;
13473 int number_of_visible_frames
;
13476 int polling_stopped_here
= 0;
13477 Lisp_Object tail
, frame
;
13479 /* True means redisplay has to consider all windows on all
13480 frames. False, only selected_window is considered. */
13481 bool consider_all_windows_p
;
13483 /* True means redisplay has to redisplay the miniwindow. */
13484 bool update_miniwindow_p
= false;
13486 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13488 /* No redisplay if running in batch mode or frame is not yet fully
13489 initialized, or redisplay is explicitly turned off by setting
13490 Vinhibit_redisplay. */
13491 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13492 || !NILP (Vinhibit_redisplay
))
13495 /* Don't examine these until after testing Vinhibit_redisplay.
13496 When Emacs is shutting down, perhaps because its connection to
13497 X has dropped, we should not look at them at all. */
13498 fr
= XFRAME (w
->frame
);
13499 sf
= SELECTED_FRAME ();
13501 if (!fr
->glyphs_initialized_p
)
13504 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13505 if (popup_activated ())
13509 /* I don't think this happens but let's be paranoid. */
13510 if (redisplaying_p
)
13513 /* Record a function that clears redisplaying_p
13514 when we leave this function. */
13515 count
= SPECPDL_INDEX ();
13516 record_unwind_protect_void (unwind_redisplay
);
13517 redisplaying_p
= 1;
13518 specbind (Qinhibit_free_realized_faces
, Qnil
);
13520 /* Record this function, so it appears on the profiler's backtraces. */
13521 record_in_backtrace (Qredisplay_internal
, &Qnil
, 0);
13523 FOR_EACH_FRAME (tail
, frame
)
13524 XFRAME (frame
)->already_hscrolled_p
= 0;
13527 /* Remember the currently selected window. */
13531 last_escape_glyph_frame
= NULL
;
13532 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13533 last_glyphless_glyph_frame
= NULL
;
13534 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13536 /* If face_change_count is non-zero, init_iterator will free all
13537 realized faces, which includes the faces referenced from current
13538 matrices. So, we can't reuse current matrices in this case. */
13539 if (face_change_count
)
13540 windows_or_buffers_changed
= 47;
13542 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13543 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13545 /* Since frames on a single ASCII terminal share the same
13546 display area, displaying a different frame means redisplay
13547 the whole thing. */
13548 SET_FRAME_GARBAGED (sf
);
13550 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13552 FRAME_TTY (sf
)->previous_frame
= sf
;
13555 /* Set the visible flags for all frames. Do this before checking for
13556 resized or garbaged frames; they want to know if their frames are
13557 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13558 number_of_visible_frames
= 0;
13560 FOR_EACH_FRAME (tail
, frame
)
13562 struct frame
*f
= XFRAME (frame
);
13564 if (FRAME_VISIBLE_P (f
))
13566 ++number_of_visible_frames
;
13567 /* Adjust matrices for visible frames only. */
13568 if (f
->fonts_changed
)
13570 adjust_frame_glyphs (f
);
13571 f
->fonts_changed
= 0;
13573 /* If cursor type has been changed on the frame
13574 other than selected, consider all frames. */
13575 if (f
!= sf
&& f
->cursor_type_changed
)
13576 update_mode_lines
= 31;
13578 clear_desired_matrices (f
);
13581 /* Notice any pending interrupt request to change frame size. */
13582 do_pending_window_change (1);
13584 /* do_pending_window_change could change the selected_window due to
13585 frame resizing which makes the selected window too small. */
13586 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13589 /* Clear frames marked as garbaged. */
13590 clear_garbaged_frames ();
13592 /* Build menubar and tool-bar items. */
13593 if (NILP (Vmemory_full
))
13594 prepare_menu_bars ();
13596 reconsider_clip_changes (w
);
13598 /* In most cases selected window displays current buffer. */
13599 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13602 /* Detect case that we need to write or remove a star in the mode line. */
13603 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13604 w
->update_mode_line
= 1;
13606 if (mode_line_update_needed (w
))
13607 w
->update_mode_line
= 1;
13609 /* If reconsider_clip_changes above decided that the narrowing
13610 in the current buffer changed, make sure all other windows
13611 showing that buffer will be redisplayed. */
13612 if (current_buffer
->clip_changed
)
13613 bset_update_mode_line (current_buffer
);
13616 /* Normally the message* functions will have already displayed and
13617 updated the echo area, but the frame may have been trashed, or
13618 the update may have been preempted, so display the echo area
13619 again here. Checking message_cleared_p captures the case that
13620 the echo area should be cleared. */
13621 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13622 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13623 || (message_cleared_p
13624 && minibuf_level
== 0
13625 /* If the mini-window is currently selected, this means the
13626 echo-area doesn't show through. */
13627 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13629 int window_height_changed_p
= echo_area_display (0);
13631 if (message_cleared_p
)
13632 update_miniwindow_p
= true;
13636 /* If we don't display the current message, don't clear the
13637 message_cleared_p flag, because, if we did, we wouldn't clear
13638 the echo area in the next redisplay which doesn't preserve
13640 if (!display_last_displayed_message_p
)
13641 message_cleared_p
= 0;
13643 if (window_height_changed_p
)
13645 windows_or_buffers_changed
= 50;
13647 /* If window configuration was changed, frames may have been
13648 marked garbaged. Clear them or we will experience
13649 surprises wrt scrolling. */
13650 clear_garbaged_frames ();
13653 else if (EQ (selected_window
, minibuf_window
)
13654 && (current_buffer
->clip_changed
|| window_outdated (w
))
13655 && resize_mini_window (w
, 0))
13657 /* Resized active mini-window to fit the size of what it is
13658 showing if its contents might have changed. */
13661 /* If window configuration was changed, frames may have been
13662 marked garbaged. Clear them or we will experience
13663 surprises wrt scrolling. */
13664 clear_garbaged_frames ();
13667 if (windows_or_buffers_changed
&& !update_mode_lines
)
13668 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13669 only the windows's contents needs to be refreshed, or whether the
13670 mode-lines also need a refresh. */
13671 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13672 ? REDISPLAY_SOME
: 32);
13674 /* If specs for an arrow have changed, do thorough redisplay
13675 to ensure we remove any arrow that should no longer exist. */
13676 if (overlay_arrows_changed_p ())
13677 /* Apparently, this is the only case where we update other windows,
13678 without updating other mode-lines. */
13679 windows_or_buffers_changed
= 49;
13681 consider_all_windows_p
= (update_mode_lines
13682 || windows_or_buffers_changed
);
13684 #define AINC(a,i) \
13685 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13686 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13688 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13689 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13691 /* Optimize the case that only the line containing the cursor in the
13692 selected window has changed. Variables starting with this_ are
13693 set in display_line and record information about the line
13694 containing the cursor. */
13695 tlbufpos
= this_line_start_pos
;
13696 tlendpos
= this_line_end_pos
;
13697 if (!consider_all_windows_p
13698 && CHARPOS (tlbufpos
) > 0
13699 && !w
->update_mode_line
13700 && !current_buffer
->clip_changed
13701 && !current_buffer
->prevent_redisplay_optimizations_p
13702 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13703 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13704 && !XFRAME (w
->frame
)->cursor_type_changed
13705 /* Make sure recorded data applies to current buffer, etc. */
13706 && this_line_buffer
== current_buffer
13709 && !w
->optional_new_start
13710 /* Point must be on the line that we have info recorded about. */
13711 && PT
>= CHARPOS (tlbufpos
)
13712 && PT
<= Z
- CHARPOS (tlendpos
)
13713 /* All text outside that line, including its final newline,
13714 must be unchanged. */
13715 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13716 CHARPOS (tlendpos
)))
13718 if (CHARPOS (tlbufpos
) > BEGV
13719 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13720 && (CHARPOS (tlbufpos
) == ZV
13721 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13722 /* Former continuation line has disappeared by becoming empty. */
13724 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13726 /* We have to handle the case of continuation around a
13727 wide-column character (see the comment in indent.c around
13730 For instance, in the following case:
13732 -------- Insert --------
13733 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13734 J_I_ ==> J_I_ `^^' are cursors.
13738 As we have to redraw the line above, we cannot use this
13742 int line_height_before
= this_line_pixel_height
;
13744 /* Note that start_display will handle the case that the
13745 line starting at tlbufpos is a continuation line. */
13746 start_display (&it
, w
, tlbufpos
);
13748 /* Implementation note: It this still necessary? */
13749 if (it
.current_x
!= this_line_start_x
)
13752 TRACE ((stderr
, "trying display optimization 1\n"));
13753 w
->cursor
.vpos
= -1;
13754 overlay_arrow_seen
= 0;
13755 it
.vpos
= this_line_vpos
;
13756 it
.current_y
= this_line_y
;
13757 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13758 display_line (&it
);
13760 /* If line contains point, is not continued,
13761 and ends at same distance from eob as before, we win. */
13762 if (w
->cursor
.vpos
>= 0
13763 /* Line is not continued, otherwise this_line_start_pos
13764 would have been set to 0 in display_line. */
13765 && CHARPOS (this_line_start_pos
)
13766 /* Line ends as before. */
13767 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13768 /* Line has same height as before. Otherwise other lines
13769 would have to be shifted up or down. */
13770 && this_line_pixel_height
== line_height_before
)
13772 /* If this is not the window's last line, we must adjust
13773 the charstarts of the lines below. */
13774 if (it
.current_y
< it
.last_visible_y
)
13776 struct glyph_row
*row
13777 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13778 ptrdiff_t delta
, delta_bytes
;
13780 /* We used to distinguish between two cases here,
13781 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13782 when the line ends in a newline or the end of the
13783 buffer's accessible portion. But both cases did
13784 the same, so they were collapsed. */
13786 - CHARPOS (tlendpos
)
13787 - MATRIX_ROW_START_CHARPOS (row
));
13788 delta_bytes
= (Z_BYTE
13789 - BYTEPOS (tlendpos
)
13790 - MATRIX_ROW_START_BYTEPOS (row
));
13792 increment_matrix_positions (w
->current_matrix
,
13793 this_line_vpos
+ 1,
13794 w
->current_matrix
->nrows
,
13795 delta
, delta_bytes
);
13798 /* If this row displays text now but previously didn't,
13799 or vice versa, w->window_end_vpos may have to be
13801 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13803 if (w
->window_end_vpos
< this_line_vpos
)
13804 w
->window_end_vpos
= this_line_vpos
;
13806 else if (w
->window_end_vpos
== this_line_vpos
13807 && this_line_vpos
> 0)
13808 w
->window_end_vpos
= this_line_vpos
- 1;
13809 w
->window_end_valid
= 0;
13811 /* Update hint: No need to try to scroll in update_window. */
13812 w
->desired_matrix
->no_scrolling_p
= 1;
13815 *w
->desired_matrix
->method
= 0;
13816 debug_method_add (w
, "optimization 1");
13818 #ifdef HAVE_WINDOW_SYSTEM
13819 update_window_fringes (w
, 0);
13826 else if (/* Cursor position hasn't changed. */
13827 PT
== w
->last_point
13828 /* Make sure the cursor was last displayed
13829 in this window. Otherwise we have to reposition it. */
13831 /* PXW: Must be converted to pixels, probably. */
13832 && 0 <= w
->cursor
.vpos
13833 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13837 do_pending_window_change (1);
13838 /* If selected_window changed, redisplay again. */
13839 if (WINDOWP (selected_window
)
13840 && (w
= XWINDOW (selected_window
)) != sw
)
13843 /* We used to always goto end_of_redisplay here, but this
13844 isn't enough if we have a blinking cursor. */
13845 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13846 goto end_of_redisplay
;
13850 /* If highlighting the region, or if the cursor is in the echo area,
13851 then we can't just move the cursor. */
13852 else if (NILP (Vshow_trailing_whitespace
)
13853 && !cursor_in_echo_area
)
13856 struct glyph_row
*row
;
13858 /* Skip from tlbufpos to PT and see where it is. Note that
13859 PT may be in invisible text. If so, we will end at the
13860 next visible position. */
13861 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13862 NULL
, DEFAULT_FACE_ID
);
13863 it
.current_x
= this_line_start_x
;
13864 it
.current_y
= this_line_y
;
13865 it
.vpos
= this_line_vpos
;
13867 /* The call to move_it_to stops in front of PT, but
13868 moves over before-strings. */
13869 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13871 if (it
.vpos
== this_line_vpos
13872 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13875 eassert (this_line_vpos
== it
.vpos
);
13876 eassert (this_line_y
== it
.current_y
);
13877 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13879 *w
->desired_matrix
->method
= 0;
13880 debug_method_add (w
, "optimization 3");
13889 /* Text changed drastically or point moved off of line. */
13890 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13893 CHARPOS (this_line_start_pos
) = 0;
13894 ++clear_face_cache_count
;
13895 #ifdef HAVE_WINDOW_SYSTEM
13896 ++clear_image_cache_count
;
13899 /* Build desired matrices, and update the display. If
13900 consider_all_windows_p is non-zero, do it for all windows on all
13901 frames. Otherwise do it for selected_window, only. */
13903 if (consider_all_windows_p
)
13905 FOR_EACH_FRAME (tail
, frame
)
13906 XFRAME (frame
)->updated_p
= 0;
13908 propagate_buffer_redisplay ();
13910 FOR_EACH_FRAME (tail
, frame
)
13912 struct frame
*f
= XFRAME (frame
);
13914 /* We don't have to do anything for unselected terminal
13916 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13917 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13922 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13925 /* Only GC scrollbars when we redisplay the whole frame. */
13926 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13927 /* Mark all the scroll bars to be removed; we'll redeem
13928 the ones we want when we redisplay their windows. */
13929 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13930 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13932 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13933 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13934 /* Remember that the invisible frames need to be redisplayed next
13935 time they're visible. */
13936 else if (!REDISPLAY_SOME_P ())
13937 f
->redisplay
= true;
13939 /* The X error handler may have deleted that frame. */
13940 if (!FRAME_LIVE_P (f
))
13943 /* Any scroll bars which redisplay_windows should have
13944 nuked should now go away. */
13945 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13946 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13948 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13950 /* If fonts changed on visible frame, display again. */
13951 if (f
->fonts_changed
)
13953 adjust_frame_glyphs (f
);
13954 f
->fonts_changed
= 0;
13958 /* See if we have to hscroll. */
13959 if (!f
->already_hscrolled_p
)
13961 f
->already_hscrolled_p
= 1;
13962 if (hscroll_windows (f
->root_window
))
13966 /* Prevent various kinds of signals during display
13967 update. stdio is not robust about handling
13968 signals, which can cause an apparent I/O error. */
13969 if (interrupt_input
)
13970 unrequest_sigio ();
13973 pending
|= update_frame (f
, 0, 0);
13974 f
->cursor_type_changed
= 0;
13980 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13984 /* Do the mark_window_display_accurate after all windows have
13985 been redisplayed because this call resets flags in buffers
13986 which are needed for proper redisplay. */
13987 FOR_EACH_FRAME (tail
, frame
)
13989 struct frame
*f
= XFRAME (frame
);
13992 f
->redisplay
= false;
13993 mark_window_display_accurate (f
->root_window
, 1);
13994 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13995 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
14000 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
14002 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
14003 struct frame
*mini_frame
;
14005 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
14006 /* Use list_of_error, not Qerror, so that
14007 we catch only errors and don't run the debugger. */
14008 internal_condition_case_1 (redisplay_window_1
, selected_window
,
14010 redisplay_window_error
);
14011 if (update_miniwindow_p
)
14012 internal_condition_case_1 (redisplay_window_1
, mini_window
,
14014 redisplay_window_error
);
14016 /* Compare desired and current matrices, perform output. */
14019 /* If fonts changed, display again. */
14020 if (sf
->fonts_changed
)
14023 /* Prevent various kinds of signals during display update.
14024 stdio is not robust about handling signals,
14025 which can cause an apparent I/O error. */
14026 if (interrupt_input
)
14027 unrequest_sigio ();
14030 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
14032 if (hscroll_windows (selected_window
))
14035 XWINDOW (selected_window
)->must_be_updated_p
= true;
14036 pending
= update_frame (sf
, 0, 0);
14037 sf
->cursor_type_changed
= 0;
14040 /* We may have called echo_area_display at the top of this
14041 function. If the echo area is on another frame, that may
14042 have put text on a frame other than the selected one, so the
14043 above call to update_frame would not have caught it. Catch
14045 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
14046 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
14048 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
14050 XWINDOW (mini_window
)->must_be_updated_p
= true;
14051 pending
|= update_frame (mini_frame
, 0, 0);
14052 mini_frame
->cursor_type_changed
= 0;
14053 if (!pending
&& hscroll_windows (mini_window
))
14058 /* If display was paused because of pending input, make sure we do a
14059 thorough update the next time. */
14062 /* Prevent the optimization at the beginning of
14063 redisplay_internal that tries a single-line update of the
14064 line containing the cursor in the selected window. */
14065 CHARPOS (this_line_start_pos
) = 0;
14067 /* Let the overlay arrow be updated the next time. */
14068 update_overlay_arrows (0);
14070 /* If we pause after scrolling, some rows in the current
14071 matrices of some windows are not valid. */
14072 if (!WINDOW_FULL_WIDTH_P (w
)
14073 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
14074 update_mode_lines
= 36;
14078 if (!consider_all_windows_p
)
14080 /* This has already been done above if
14081 consider_all_windows_p is set. */
14082 if (XBUFFER (w
->contents
)->text
->redisplay
14083 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
14084 /* This can happen if b->text->redisplay was set during
14086 propagate_buffer_redisplay ();
14087 mark_window_display_accurate_1 (w
, 1);
14089 /* Say overlay arrows are up to date. */
14090 update_overlay_arrows (1);
14092 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
14093 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
14096 update_mode_lines
= 0;
14097 windows_or_buffers_changed
= 0;
14100 /* Start SIGIO interrupts coming again. Having them off during the
14101 code above makes it less likely one will discard output, but not
14102 impossible, since there might be stuff in the system buffer here.
14103 But it is much hairier to try to do anything about that. */
14104 if (interrupt_input
)
14108 /* If a frame has become visible which was not before, redisplay
14109 again, so that we display it. Expose events for such a frame
14110 (which it gets when becoming visible) don't call the parts of
14111 redisplay constructing glyphs, so simply exposing a frame won't
14112 display anything in this case. So, we have to display these
14113 frames here explicitly. */
14118 FOR_EACH_FRAME (tail
, frame
)
14120 if (XFRAME (frame
)->visible
)
14124 if (new_count
!= number_of_visible_frames
)
14125 windows_or_buffers_changed
= 52;
14128 /* Change frame size now if a change is pending. */
14129 do_pending_window_change (1);
14131 /* If we just did a pending size change, or have additional
14132 visible frames, or selected_window changed, redisplay again. */
14133 if ((windows_or_buffers_changed
&& !pending
)
14134 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14137 /* Clear the face and image caches.
14139 We used to do this only if consider_all_windows_p. But the cache
14140 needs to be cleared if a timer creates images in the current
14141 buffer (e.g. the test case in Bug#6230). */
14143 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14145 clear_face_cache (0);
14146 clear_face_cache_count
= 0;
14149 #ifdef HAVE_WINDOW_SYSTEM
14150 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14152 clear_image_caches (Qnil
);
14153 clear_image_cache_count
= 0;
14155 #endif /* HAVE_WINDOW_SYSTEM */
14159 ns_set_doc_edited ();
14161 if (interrupt_input
&& interrupts_deferred
)
14164 unbind_to (count
, Qnil
);
14169 /* Redisplay, but leave alone any recent echo area message unless
14170 another message has been requested in its place.
14172 This is useful in situations where you need to redisplay but no
14173 user action has occurred, making it inappropriate for the message
14174 area to be cleared. See tracking_off and
14175 wait_reading_process_output for examples of these situations.
14177 FROM_WHERE is an integer saying from where this function was
14178 called. This is useful for debugging. */
14181 redisplay_preserve_echo_area (int from_where
)
14183 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14185 if (!NILP (echo_area_buffer
[1]))
14187 /* We have a previously displayed message, but no current
14188 message. Redisplay the previous message. */
14189 display_last_displayed_message_p
= 1;
14190 redisplay_internal ();
14191 display_last_displayed_message_p
= 0;
14194 redisplay_internal ();
14196 flush_frame (SELECTED_FRAME ());
14200 /* Function registered with record_unwind_protect in redisplay_internal. */
14203 unwind_redisplay (void)
14205 redisplaying_p
= 0;
14209 /* Mark the display of leaf window W as accurate or inaccurate.
14210 If ACCURATE_P is non-zero mark display of W as accurate. If
14211 ACCURATE_P is zero, arrange for W to be redisplayed the next
14212 time redisplay_internal is called. */
14215 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
14217 struct buffer
*b
= XBUFFER (w
->contents
);
14219 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14220 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14221 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14225 b
->clip_changed
= false;
14226 b
->prevent_redisplay_optimizations_p
= false;
14227 eassert (buffer_window_count (b
) > 0);
14228 /* Resetting b->text->redisplay is problematic!
14229 In order to make it safer to do it here, redisplay_internal must
14230 have copied all b->text->redisplay to their respective windows. */
14231 b
->text
->redisplay
= false;
14233 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14234 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14235 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14236 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14238 w
->current_matrix
->buffer
= b
;
14239 w
->current_matrix
->begv
= BUF_BEGV (b
);
14240 w
->current_matrix
->zv
= BUF_ZV (b
);
14242 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14243 w
->last_cursor_off_p
= w
->cursor_off_p
;
14245 if (w
== XWINDOW (selected_window
))
14246 w
->last_point
= BUF_PT (b
);
14248 w
->last_point
= marker_position (w
->pointm
);
14250 w
->window_end_valid
= true;
14251 w
->update_mode_line
= false;
14254 w
->redisplay
= !accurate_p
;
14258 /* Mark the display of windows in the window tree rooted at WINDOW as
14259 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
14260 windows as accurate. If ACCURATE_P is zero, arrange for windows to
14261 be redisplayed the next time redisplay_internal is called. */
14264 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
14268 for (; !NILP (window
); window
= w
->next
)
14270 w
= XWINDOW (window
);
14271 if (WINDOWP (w
->contents
))
14272 mark_window_display_accurate (w
->contents
, accurate_p
);
14274 mark_window_display_accurate_1 (w
, accurate_p
);
14278 update_overlay_arrows (1);
14280 /* Force a thorough redisplay the next time by setting
14281 last_arrow_position and last_arrow_string to t, which is
14282 unequal to any useful value of Voverlay_arrow_... */
14283 update_overlay_arrows (-1);
14287 /* Return value in display table DP (Lisp_Char_Table *) for character
14288 C. Since a display table doesn't have any parent, we don't have to
14289 follow parent. Do not call this function directly but use the
14290 macro DISP_CHAR_VECTOR. */
14293 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14297 if (ASCII_CHAR_P (c
))
14300 if (SUB_CHAR_TABLE_P (val
))
14301 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14307 XSETCHAR_TABLE (table
, dp
);
14308 val
= char_table_ref (table
, c
);
14317 /***********************************************************************
14319 ***********************************************************************/
14321 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14324 redisplay_windows (Lisp_Object window
)
14326 while (!NILP (window
))
14328 struct window
*w
= XWINDOW (window
);
14330 if (WINDOWP (w
->contents
))
14331 redisplay_windows (w
->contents
);
14332 else if (BUFFERP (w
->contents
))
14334 displayed_buffer
= XBUFFER (w
->contents
);
14335 /* Use list_of_error, not Qerror, so that
14336 we catch only errors and don't run the debugger. */
14337 internal_condition_case_1 (redisplay_window_0
, window
,
14339 redisplay_window_error
);
14347 redisplay_window_error (Lisp_Object ignore
)
14349 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14354 redisplay_window_0 (Lisp_Object window
)
14356 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14357 redisplay_window (window
, false);
14362 redisplay_window_1 (Lisp_Object window
)
14364 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14365 redisplay_window (window
, true);
14370 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14371 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14372 which positions recorded in ROW differ from current buffer
14375 Return 0 if cursor is not on this row, 1 otherwise. */
14378 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14379 struct glyph_matrix
*matrix
,
14380 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14383 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14384 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14385 struct glyph
*cursor
= NULL
;
14386 /* The last known character position in row. */
14387 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14389 ptrdiff_t pt_old
= PT
- delta
;
14390 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14391 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14392 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14393 /* A glyph beyond the edge of TEXT_AREA which we should never
14395 struct glyph
*glyphs_end
= end
;
14396 /* Non-zero means we've found a match for cursor position, but that
14397 glyph has the avoid_cursor_p flag set. */
14398 int match_with_avoid_cursor
= 0;
14399 /* Non-zero means we've seen at least one glyph that came from a
14401 int string_seen
= 0;
14402 /* Largest and smallest buffer positions seen so far during scan of
14404 ptrdiff_t bpos_max
= pos_before
;
14405 ptrdiff_t bpos_min
= pos_after
;
14406 /* Last buffer position covered by an overlay string with an integer
14407 `cursor' property. */
14408 ptrdiff_t bpos_covered
= 0;
14409 /* Non-zero means the display string on which to display the cursor
14410 comes from a text property, not from an overlay. */
14411 int string_from_text_prop
= 0;
14413 /* Don't even try doing anything if called for a mode-line or
14414 header-line row, since the rest of the code isn't prepared to
14415 deal with such calamities. */
14416 eassert (!row
->mode_line_p
);
14417 if (row
->mode_line_p
)
14420 /* Skip over glyphs not having an object at the start and the end of
14421 the row. These are special glyphs like truncation marks on
14422 terminal frames. */
14423 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14425 if (!row
->reversed_p
)
14428 && INTEGERP (glyph
->object
)
14429 && glyph
->charpos
< 0)
14431 x
+= glyph
->pixel_width
;
14435 && INTEGERP ((end
- 1)->object
)
14436 /* CHARPOS is zero for blanks and stretch glyphs
14437 inserted by extend_face_to_end_of_line. */
14438 && (end
- 1)->charpos
<= 0)
14440 glyph_before
= glyph
- 1;
14447 /* If the glyph row is reversed, we need to process it from back
14448 to front, so swap the edge pointers. */
14449 glyphs_end
= end
= glyph
- 1;
14450 glyph
+= row
->used
[TEXT_AREA
] - 1;
14452 while (glyph
> end
+ 1
14453 && INTEGERP (glyph
->object
)
14454 && glyph
->charpos
< 0)
14457 x
-= glyph
->pixel_width
;
14459 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
14461 /* By default, in reversed rows we put the cursor on the
14462 rightmost (first in the reading order) glyph. */
14463 for (g
= end
+ 1; g
< glyph
; g
++)
14464 x
+= g
->pixel_width
;
14466 && INTEGERP ((end
+ 1)->object
)
14467 && (end
+ 1)->charpos
<= 0)
14469 glyph_before
= glyph
+ 1;
14473 else if (row
->reversed_p
)
14475 /* In R2L rows that don't display text, put the cursor on the
14476 rightmost glyph. Case in point: an empty last line that is
14477 part of an R2L paragraph. */
14479 /* Avoid placing the cursor on the last glyph of the row, where
14480 on terminal frames we hold the vertical border between
14481 adjacent windows. */
14482 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14483 && !WINDOW_RIGHTMOST_P (w
)
14484 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14486 x
= -1; /* will be computed below, at label compute_x */
14489 /* Step 1: Try to find the glyph whose character position
14490 corresponds to point. If that's not possible, find 2 glyphs
14491 whose character positions are the closest to point, one before
14492 point, the other after it. */
14493 if (!row
->reversed_p
)
14494 while (/* not marched to end of glyph row */
14496 /* glyph was not inserted by redisplay for internal purposes */
14497 && !INTEGERP (glyph
->object
))
14499 if (BUFFERP (glyph
->object
))
14501 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14503 if (glyph
->charpos
> bpos_max
)
14504 bpos_max
= glyph
->charpos
;
14505 if (glyph
->charpos
< bpos_min
)
14506 bpos_min
= glyph
->charpos
;
14507 if (!glyph
->avoid_cursor_p
)
14509 /* If we hit point, we've found the glyph on which to
14510 display the cursor. */
14513 match_with_avoid_cursor
= 0;
14516 /* See if we've found a better approximation to
14517 POS_BEFORE or to POS_AFTER. */
14518 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14520 pos_before
= glyph
->charpos
;
14521 glyph_before
= glyph
;
14523 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14525 pos_after
= glyph
->charpos
;
14526 glyph_after
= glyph
;
14529 else if (dpos
== 0)
14530 match_with_avoid_cursor
= 1;
14532 else if (STRINGP (glyph
->object
))
14534 Lisp_Object chprop
;
14535 ptrdiff_t glyph_pos
= glyph
->charpos
;
14537 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14539 if (!NILP (chprop
))
14541 /* If the string came from a `display' text property,
14542 look up the buffer position of that property and
14543 use that position to update bpos_max, as if we
14544 actually saw such a position in one of the row's
14545 glyphs. This helps with supporting integer values
14546 of `cursor' property on the display string in
14547 situations where most or all of the row's buffer
14548 text is completely covered by display properties,
14549 so that no glyph with valid buffer positions is
14550 ever seen in the row. */
14551 ptrdiff_t prop_pos
=
14552 string_buffer_position_lim (glyph
->object
, pos_before
,
14555 if (prop_pos
>= pos_before
)
14556 bpos_max
= prop_pos
;
14558 if (INTEGERP (chprop
))
14560 bpos_covered
= bpos_max
+ XINT (chprop
);
14561 /* If the `cursor' property covers buffer positions up
14562 to and including point, we should display cursor on
14563 this glyph. Note that, if a `cursor' property on one
14564 of the string's characters has an integer value, we
14565 will break out of the loop below _before_ we get to
14566 the position match above. IOW, integer values of
14567 the `cursor' property override the "exact match for
14568 point" strategy of positioning the cursor. */
14569 /* Implementation note: bpos_max == pt_old when, e.g.,
14570 we are in an empty line, where bpos_max is set to
14571 MATRIX_ROW_START_CHARPOS, see above. */
14572 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14581 x
+= glyph
->pixel_width
;
14584 else if (glyph
> end
) /* row is reversed */
14585 while (!INTEGERP (glyph
->object
))
14587 if (BUFFERP (glyph
->object
))
14589 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14591 if (glyph
->charpos
> bpos_max
)
14592 bpos_max
= glyph
->charpos
;
14593 if (glyph
->charpos
< bpos_min
)
14594 bpos_min
= glyph
->charpos
;
14595 if (!glyph
->avoid_cursor_p
)
14599 match_with_avoid_cursor
= 0;
14602 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14604 pos_before
= glyph
->charpos
;
14605 glyph_before
= glyph
;
14607 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14609 pos_after
= glyph
->charpos
;
14610 glyph_after
= glyph
;
14613 else if (dpos
== 0)
14614 match_with_avoid_cursor
= 1;
14616 else if (STRINGP (glyph
->object
))
14618 Lisp_Object chprop
;
14619 ptrdiff_t glyph_pos
= glyph
->charpos
;
14621 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14623 if (!NILP (chprop
))
14625 ptrdiff_t prop_pos
=
14626 string_buffer_position_lim (glyph
->object
, pos_before
,
14629 if (prop_pos
>= pos_before
)
14630 bpos_max
= prop_pos
;
14632 if (INTEGERP (chprop
))
14634 bpos_covered
= bpos_max
+ XINT (chprop
);
14635 /* If the `cursor' property covers buffer positions up
14636 to and including point, we should display cursor on
14638 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14647 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14649 x
--; /* can't use any pixel_width */
14652 x
-= glyph
->pixel_width
;
14655 /* Step 2: If we didn't find an exact match for point, we need to
14656 look for a proper place to put the cursor among glyphs between
14657 GLYPH_BEFORE and GLYPH_AFTER. */
14658 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14659 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14660 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14662 /* An empty line has a single glyph whose OBJECT is zero and
14663 whose CHARPOS is the position of a newline on that line.
14664 Note that on a TTY, there are more glyphs after that, which
14665 were produced by extend_face_to_end_of_line, but their
14666 CHARPOS is zero or negative. */
14668 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14669 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0
14670 /* On a TTY, continued and truncated rows also have a glyph at
14671 their end whose OBJECT is zero and whose CHARPOS is
14672 positive (the continuation and truncation glyphs), but such
14673 rows are obviously not "empty". */
14674 && !(row
->continued_p
|| row
->truncated_on_right_p
);
14676 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14678 ptrdiff_t ellipsis_pos
;
14680 /* Scan back over the ellipsis glyphs. */
14681 if (!row
->reversed_p
)
14683 ellipsis_pos
= (glyph
- 1)->charpos
;
14684 while (glyph
> row
->glyphs
[TEXT_AREA
]
14685 && (glyph
- 1)->charpos
== ellipsis_pos
)
14686 glyph
--, x
-= glyph
->pixel_width
;
14687 /* That loop always goes one position too far, including
14688 the glyph before the ellipsis. So scan forward over
14690 x
+= glyph
->pixel_width
;
14693 else /* row is reversed */
14695 ellipsis_pos
= (glyph
+ 1)->charpos
;
14696 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14697 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14698 glyph
++, x
+= glyph
->pixel_width
;
14699 x
-= glyph
->pixel_width
;
14703 else if (match_with_avoid_cursor
)
14705 cursor
= glyph_after
;
14708 else if (string_seen
)
14710 int incr
= row
->reversed_p
? -1 : +1;
14712 /* Need to find the glyph that came out of a string which is
14713 present at point. That glyph is somewhere between
14714 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14715 positioned between POS_BEFORE and POS_AFTER in the
14717 struct glyph
*start
, *stop
;
14718 ptrdiff_t pos
= pos_before
;
14722 /* If the row ends in a newline from a display string,
14723 reordering could have moved the glyphs belonging to the
14724 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14725 in this case we extend the search to the last glyph in
14726 the row that was not inserted by redisplay. */
14727 if (row
->ends_in_newline_from_string_p
)
14730 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14733 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14734 correspond to POS_BEFORE and POS_AFTER, respectively. We
14735 need START and STOP in the order that corresponds to the
14736 row's direction as given by its reversed_p flag. If the
14737 directionality of characters between POS_BEFORE and
14738 POS_AFTER is the opposite of the row's base direction,
14739 these characters will have been reordered for display,
14740 and we need to reverse START and STOP. */
14741 if (!row
->reversed_p
)
14743 start
= min (glyph_before
, glyph_after
);
14744 stop
= max (glyph_before
, glyph_after
);
14748 start
= max (glyph_before
, glyph_after
);
14749 stop
= min (glyph_before
, glyph_after
);
14751 for (glyph
= start
+ incr
;
14752 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14755 /* Any glyphs that come from the buffer are here because
14756 of bidi reordering. Skip them, and only pay
14757 attention to glyphs that came from some string. */
14758 if (STRINGP (glyph
->object
))
14762 /* If the display property covers the newline, we
14763 need to search for it one position farther. */
14764 ptrdiff_t lim
= pos_after
14765 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14767 string_from_text_prop
= 0;
14768 str
= glyph
->object
;
14769 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14770 if (tem
== 0 /* from overlay */
14773 /* If the string from which this glyph came is
14774 found in the buffer at point, or at position
14775 that is closer to point than pos_after, then
14776 we've found the glyph we've been looking for.
14777 If it comes from an overlay (tem == 0), and
14778 it has the `cursor' property on one of its
14779 glyphs, record that glyph as a candidate for
14780 displaying the cursor. (As in the
14781 unidirectional version, we will display the
14782 cursor on the last candidate we find.) */
14785 || (tem
- pt_old
> 0 && tem
< pos_after
))
14787 /* The glyphs from this string could have
14788 been reordered. Find the one with the
14789 smallest string position. Or there could
14790 be a character in the string with the
14791 `cursor' property, which means display
14792 cursor on that character's glyph. */
14793 ptrdiff_t strpos
= glyph
->charpos
;
14798 string_from_text_prop
= 1;
14801 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14802 && EQ (glyph
->object
, str
);
14806 ptrdiff_t gpos
= glyph
->charpos
;
14808 cprop
= Fget_char_property (make_number (gpos
),
14816 if (tem
&& glyph
->charpos
< strpos
)
14818 strpos
= glyph
->charpos
;
14824 || (tem
- pt_old
> 0 && tem
< pos_after
))
14828 pos
= tem
+ 1; /* don't find previous instances */
14830 /* This string is not what we want; skip all of the
14831 glyphs that came from it. */
14832 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14833 && EQ (glyph
->object
, str
))
14840 /* If we reached the end of the line, and END was from a string,
14841 the cursor is not on this line. */
14843 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14844 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14845 && STRINGP (end
->object
)
14846 && row
->continued_p
)
14849 /* A truncated row may not include PT among its character positions.
14850 Setting the cursor inside the scroll margin will trigger
14851 recalculation of hscroll in hscroll_window_tree. But if a
14852 display string covers point, defer to the string-handling
14853 code below to figure this out. */
14854 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14856 cursor
= glyph_before
;
14859 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14860 /* Zero-width characters produce no glyphs. */
14862 && (row
->reversed_p
14863 ? glyph_after
> glyphs_end
14864 : glyph_after
< glyphs_end
)))
14866 cursor
= glyph_after
;
14872 if (cursor
!= NULL
)
14874 else if (glyph
== glyphs_end
14875 && pos_before
== pos_after
14876 && STRINGP ((row
->reversed_p
14877 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14878 : row
->glyphs
[TEXT_AREA
])->object
))
14880 /* If all the glyphs of this row came from strings, put the
14881 cursor on the first glyph of the row. This avoids having the
14882 cursor outside of the text area in this very rare and hard
14886 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14887 : row
->glyphs
[TEXT_AREA
];
14893 /* Need to compute x that corresponds to GLYPH. */
14894 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14896 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14898 x
+= g
->pixel_width
;
14902 /* ROW could be part of a continued line, which, under bidi
14903 reordering, might have other rows whose start and end charpos
14904 occlude point. Only set w->cursor if we found a better
14905 approximation to the cursor position than we have from previously
14906 examined candidate rows belonging to the same continued line. */
14907 if (/* We already have a candidate row. */
14908 w
->cursor
.vpos
>= 0
14909 /* That candidate is not the row we are processing. */
14910 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14911 /* Make sure cursor.vpos specifies a row whose start and end
14912 charpos occlude point, and it is valid candidate for being a
14913 cursor-row. This is because some callers of this function
14914 leave cursor.vpos at the row where the cursor was displayed
14915 during the last redisplay cycle. */
14916 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14917 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14918 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14921 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14923 /* Don't consider glyphs that are outside TEXT_AREA. */
14924 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14926 /* Keep the candidate whose buffer position is the closest to
14927 point or has the `cursor' property. */
14928 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14929 w
->cursor
.hpos
>= 0
14930 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14931 && ((BUFFERP (g1
->object
)
14932 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14933 || (BUFFERP (glyph
->object
)
14934 && eabs (g1
->charpos
- pt_old
)
14935 < eabs (glyph
->charpos
- pt_old
))))
14936 /* Previous candidate is a glyph from a string that has
14937 a non-nil `cursor' property. */
14938 || (STRINGP (g1
->object
)
14939 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14940 Qcursor
, g1
->object
))
14941 /* Previous candidate is from the same display
14942 string as this one, and the display string
14943 came from a text property. */
14944 || (EQ (g1
->object
, glyph
->object
)
14945 && string_from_text_prop
)
14946 /* this candidate is from newline and its
14947 position is not an exact match */
14948 || (INTEGERP (glyph
->object
)
14949 && glyph
->charpos
!= pt_old
)))))
14951 /* If this candidate gives an exact match, use that. */
14952 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14953 /* If this candidate is a glyph created for the
14954 terminating newline of a line, and point is on that
14955 newline, it wins because it's an exact match. */
14956 || (!row
->continued_p
14957 && INTEGERP (glyph
->object
)
14958 && glyph
->charpos
== 0
14959 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14960 /* Otherwise, keep the candidate that comes from a row
14961 spanning less buffer positions. This may win when one or
14962 both candidate positions are on glyphs that came from
14963 display strings, for which we cannot compare buffer
14965 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14966 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14967 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14970 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14972 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14973 w
->cursor
.y
= row
->y
+ dy
;
14975 if (w
== XWINDOW (selected_window
))
14977 if (!row
->continued_p
14978 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14981 this_line_buffer
= XBUFFER (w
->contents
);
14983 CHARPOS (this_line_start_pos
)
14984 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14985 BYTEPOS (this_line_start_pos
)
14986 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14988 CHARPOS (this_line_end_pos
)
14989 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14990 BYTEPOS (this_line_end_pos
)
14991 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14993 this_line_y
= w
->cursor
.y
;
14994 this_line_pixel_height
= row
->height
;
14995 this_line_vpos
= w
->cursor
.vpos
;
14996 this_line_start_x
= row
->x
;
14999 CHARPOS (this_line_start_pos
) = 0;
15006 /* Run window scroll functions, if any, for WINDOW with new window
15007 start STARTP. Sets the window start of WINDOW to that position.
15009 We assume that the window's buffer is really current. */
15011 static struct text_pos
15012 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
15014 struct window
*w
= XWINDOW (window
);
15015 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
15017 eassert (current_buffer
== XBUFFER (w
->contents
));
15019 if (!NILP (Vwindow_scroll_functions
))
15021 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
15022 make_number (CHARPOS (startp
)));
15023 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15024 /* In case the hook functions switch buffers. */
15025 set_buffer_internal (XBUFFER (w
->contents
));
15032 /* Make sure the line containing the cursor is fully visible.
15033 A value of 1 means there is nothing to be done.
15034 (Either the line is fully visible, or it cannot be made so,
15035 or we cannot tell.)
15037 If FORCE_P is non-zero, return 0 even if partial visible cursor row
15038 is higher than window.
15040 If CURRENT_MATRIX_P is non-zero, use the information from the
15041 window's current glyph matrix; otherwise use the desired glyph
15044 A value of 0 means the caller should do scrolling
15045 as if point had gone off the screen. */
15048 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
15050 struct glyph_matrix
*matrix
;
15051 struct glyph_row
*row
;
15054 if (!make_cursor_line_fully_visible_p
)
15057 /* It's not always possible to find the cursor, e.g, when a window
15058 is full of overlay strings. Don't do anything in that case. */
15059 if (w
->cursor
.vpos
< 0)
15062 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
15063 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
15065 /* If the cursor row is not partially visible, there's nothing to do. */
15066 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
15069 /* If the row the cursor is in is taller than the window's height,
15070 it's not clear what to do, so do nothing. */
15071 window_height
= window_box_height (w
);
15072 if (row
->height
>= window_height
)
15074 if (!force_p
|| MINI_WINDOW_P (w
)
15075 || w
->vscroll
|| w
->cursor
.vpos
== 0)
15082 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
15083 non-zero means only WINDOW is redisplayed in redisplay_internal.
15084 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
15085 in redisplay_window to bring a partially visible line into view in
15086 the case that only the cursor has moved.
15088 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
15089 last screen line's vertical height extends past the end of the screen.
15093 1 if scrolling succeeded
15095 0 if scrolling didn't find point.
15097 -1 if new fonts have been loaded so that we must interrupt
15098 redisplay, adjust glyph matrices, and try again. */
15104 SCROLLING_NEED_LARGER_MATRICES
15107 /* If scroll-conservatively is more than this, never recenter.
15109 If you change this, don't forget to update the doc string of
15110 `scroll-conservatively' and the Emacs manual. */
15111 #define SCROLL_LIMIT 100
15114 try_scrolling (Lisp_Object window
, int just_this_one_p
,
15115 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15116 int temp_scroll_step
, int last_line_misfit
)
15118 struct window
*w
= XWINDOW (window
);
15119 struct frame
*f
= XFRAME (w
->frame
);
15120 struct text_pos pos
, startp
;
15122 int this_scroll_margin
, scroll_max
, rc
, height
;
15123 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
15124 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
15125 Lisp_Object aggressive
;
15126 /* We will never try scrolling more than this number of lines. */
15127 int scroll_limit
= SCROLL_LIMIT
;
15128 int frame_line_height
= default_line_pixel_height (w
);
15129 int window_total_lines
15130 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15133 debug_method_add (w
, "try_scrolling");
15136 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15138 /* Compute scroll margin height in pixels. We scroll when point is
15139 within this distance from the top or bottom of the window. */
15140 if (scroll_margin
> 0)
15141 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15142 * frame_line_height
;
15144 this_scroll_margin
= 0;
15146 /* Force arg_scroll_conservatively to have a reasonable value, to
15147 avoid scrolling too far away with slow move_it_* functions. Note
15148 that the user can supply scroll-conservatively equal to
15149 `most-positive-fixnum', which can be larger than INT_MAX. */
15150 if (arg_scroll_conservatively
> scroll_limit
)
15152 arg_scroll_conservatively
= scroll_limit
+ 1;
15153 scroll_max
= scroll_limit
* frame_line_height
;
15155 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15156 /* Compute how much we should try to scroll maximally to bring
15157 point into view. */
15158 scroll_max
= (max (scroll_step
,
15159 max (arg_scroll_conservatively
, temp_scroll_step
))
15160 * frame_line_height
);
15161 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15162 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15163 /* We're trying to scroll because of aggressive scrolling but no
15164 scroll_step is set. Choose an arbitrary one. */
15165 scroll_max
= 10 * frame_line_height
;
15171 /* Decide whether to scroll down. */
15172 if (PT
> CHARPOS (startp
))
15174 int scroll_margin_y
;
15176 /* Compute the pixel ypos of the scroll margin, then move IT to
15177 either that ypos or PT, whichever comes first. */
15178 start_display (&it
, w
, startp
);
15179 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15180 - frame_line_height
* extra_scroll_margin_lines
;
15181 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15182 (MOVE_TO_POS
| MOVE_TO_Y
));
15184 if (PT
> CHARPOS (it
.current
.pos
))
15186 int y0
= line_bottom_y (&it
);
15187 /* Compute how many pixels below window bottom to stop searching
15188 for PT. This avoids costly search for PT that is far away if
15189 the user limited scrolling by a small number of lines, but
15190 always finds PT if scroll_conservatively is set to a large
15191 number, such as most-positive-fixnum. */
15192 int slack
= max (scroll_max
, 10 * frame_line_height
);
15193 int y_to_move
= it
.last_visible_y
+ slack
;
15195 /* Compute the distance from the scroll margin to PT or to
15196 the scroll limit, whichever comes first. This should
15197 include the height of the cursor line, to make that line
15199 move_it_to (&it
, PT
, -1, y_to_move
,
15200 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15201 dy
= line_bottom_y (&it
) - y0
;
15203 if (dy
> scroll_max
)
15204 return SCROLLING_FAILED
;
15213 /* Point is in or below the bottom scroll margin, so move the
15214 window start down. If scrolling conservatively, move it just
15215 enough down to make point visible. If scroll_step is set,
15216 move it down by scroll_step. */
15217 if (arg_scroll_conservatively
)
15219 = min (max (dy
, frame_line_height
),
15220 frame_line_height
* arg_scroll_conservatively
);
15221 else if (scroll_step
|| temp_scroll_step
)
15222 amount_to_scroll
= scroll_max
;
15225 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15226 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15227 if (NUMBERP (aggressive
))
15229 double float_amount
= XFLOATINT (aggressive
) * height
;
15230 int aggressive_scroll
= float_amount
;
15231 if (aggressive_scroll
== 0 && float_amount
> 0)
15232 aggressive_scroll
= 1;
15233 /* Don't let point enter the scroll margin near top of
15234 the window. This could happen if the value of
15235 scroll_up_aggressively is too large and there are
15236 non-zero margins, because scroll_up_aggressively
15237 means put point that fraction of window height
15238 _from_the_bottom_margin_. */
15239 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15240 aggressive_scroll
= height
- 2*this_scroll_margin
;
15241 amount_to_scroll
= dy
+ aggressive_scroll
;
15245 if (amount_to_scroll
<= 0)
15246 return SCROLLING_FAILED
;
15248 start_display (&it
, w
, startp
);
15249 if (arg_scroll_conservatively
<= scroll_limit
)
15250 move_it_vertically (&it
, amount_to_scroll
);
15253 /* Extra precision for users who set scroll-conservatively
15254 to a large number: make sure the amount we scroll
15255 the window start is never less than amount_to_scroll,
15256 which was computed as distance from window bottom to
15257 point. This matters when lines at window top and lines
15258 below window bottom have different height. */
15260 void *it1data
= NULL
;
15261 /* We use a temporary it1 because line_bottom_y can modify
15262 its argument, if it moves one line down; see there. */
15265 SAVE_IT (it1
, it
, it1data
);
15266 start_y
= line_bottom_y (&it1
);
15268 RESTORE_IT (&it
, &it
, it1data
);
15269 move_it_by_lines (&it
, 1);
15270 SAVE_IT (it1
, it
, it1data
);
15271 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15274 /* If STARTP is unchanged, move it down another screen line. */
15275 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
15276 move_it_by_lines (&it
, 1);
15277 startp
= it
.current
.pos
;
15281 struct text_pos scroll_margin_pos
= startp
;
15284 /* See if point is inside the scroll margin at the top of the
15286 if (this_scroll_margin
)
15290 start_display (&it
, w
, startp
);
15291 y_start
= it
.current_y
;
15292 move_it_vertically (&it
, this_scroll_margin
);
15293 scroll_margin_pos
= it
.current
.pos
;
15294 /* If we didn't move enough before hitting ZV, request
15295 additional amount of scroll, to move point out of the
15297 if (IT_CHARPOS (it
) == ZV
15298 && it
.current_y
- y_start
< this_scroll_margin
)
15299 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15302 if (PT
< CHARPOS (scroll_margin_pos
))
15304 /* Point is in the scroll margin at the top of the window or
15305 above what is displayed in the window. */
15308 /* Compute the vertical distance from PT to the scroll
15309 margin position. Move as far as scroll_max allows, or
15310 one screenful, or 10 screen lines, whichever is largest.
15311 Give up if distance is greater than scroll_max or if we
15312 didn't reach the scroll margin position. */
15313 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15314 start_display (&it
, w
, pos
);
15316 y_to_move
= max (it
.last_visible_y
,
15317 max (scroll_max
, 10 * frame_line_height
));
15318 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15320 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15321 dy
= it
.current_y
- y0
;
15322 if (dy
> scroll_max
15323 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15324 return SCROLLING_FAILED
;
15326 /* Additional scroll for when ZV was too close to point. */
15329 /* Compute new window start. */
15330 start_display (&it
, w
, startp
);
15332 if (arg_scroll_conservatively
)
15333 amount_to_scroll
= max (dy
, frame_line_height
*
15334 max (scroll_step
, temp_scroll_step
));
15335 else if (scroll_step
|| temp_scroll_step
)
15336 amount_to_scroll
= scroll_max
;
15339 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15340 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15341 if (NUMBERP (aggressive
))
15343 double float_amount
= XFLOATINT (aggressive
) * height
;
15344 int aggressive_scroll
= float_amount
;
15345 if (aggressive_scroll
== 0 && float_amount
> 0)
15346 aggressive_scroll
= 1;
15347 /* Don't let point enter the scroll margin near
15348 bottom of the window, if the value of
15349 scroll_down_aggressively happens to be too
15351 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15352 aggressive_scroll
= height
- 2*this_scroll_margin
;
15353 amount_to_scroll
= dy
+ aggressive_scroll
;
15357 if (amount_to_scroll
<= 0)
15358 return SCROLLING_FAILED
;
15360 move_it_vertically_backward (&it
, amount_to_scroll
);
15361 startp
= it
.current
.pos
;
15365 /* Run window scroll functions. */
15366 startp
= run_window_scroll_functions (window
, startp
);
15368 /* Display the window. Give up if new fonts are loaded, or if point
15370 if (!try_window (window
, startp
, 0))
15371 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15372 else if (w
->cursor
.vpos
< 0)
15374 clear_glyph_matrix (w
->desired_matrix
);
15375 rc
= SCROLLING_FAILED
;
15379 /* Maybe forget recorded base line for line number display. */
15380 if (!just_this_one_p
15381 || current_buffer
->clip_changed
15382 || BEG_UNCHANGED
< CHARPOS (startp
))
15383 w
->base_line_number
= 0;
15385 /* If cursor ends up on a partially visible line,
15386 treat that as being off the bottom of the screen. */
15387 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
15388 /* It's possible that the cursor is on the first line of the
15389 buffer, which is partially obscured due to a vscroll
15390 (Bug#7537). In that case, avoid looping forever. */
15391 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15393 clear_glyph_matrix (w
->desired_matrix
);
15394 ++extra_scroll_margin_lines
;
15397 rc
= SCROLLING_SUCCESS
;
15404 /* Compute a suitable window start for window W if display of W starts
15405 on a continuation line. Value is non-zero if a new window start
15408 The new window start will be computed, based on W's width, starting
15409 from the start of the continued line. It is the start of the
15410 screen line with the minimum distance from the old start W->start. */
15413 compute_window_start_on_continuation_line (struct window
*w
)
15415 struct text_pos pos
, start_pos
;
15416 int window_start_changed_p
= 0;
15418 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15420 /* If window start is on a continuation line... Window start may be
15421 < BEGV in case there's invisible text at the start of the
15422 buffer (M-x rmail, for example). */
15423 if (CHARPOS (start_pos
) > BEGV
15424 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15427 struct glyph_row
*row
;
15429 /* Handle the case that the window start is out of range. */
15430 if (CHARPOS (start_pos
) < BEGV
)
15431 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15432 else if (CHARPOS (start_pos
) > ZV
)
15433 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15435 /* Find the start of the continued line. This should be fast
15436 because find_newline is fast (newline cache). */
15437 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
15438 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15439 row
, DEFAULT_FACE_ID
);
15440 reseat_at_previous_visible_line_start (&it
);
15442 /* If the line start is "too far" away from the window start,
15443 say it takes too much time to compute a new window start. */
15444 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15445 /* PXW: Do we need upper bounds here? */
15446 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15448 int min_distance
, distance
;
15450 /* Move forward by display lines to find the new window
15451 start. If window width was enlarged, the new start can
15452 be expected to be > the old start. If window width was
15453 decreased, the new window start will be < the old start.
15454 So, we're looking for the display line start with the
15455 minimum distance from the old window start. */
15456 pos
= it
.current
.pos
;
15457 min_distance
= INFINITY
;
15458 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15459 distance
< min_distance
)
15461 min_distance
= distance
;
15462 pos
= it
.current
.pos
;
15463 if (it
.line_wrap
== WORD_WRAP
)
15465 /* Under WORD_WRAP, move_it_by_lines is likely to
15466 overshoot and stop not at the first, but the
15467 second character from the left margin. So in
15468 that case, we need a more tight control on the X
15469 coordinate of the iterator than move_it_by_lines
15470 promises in its contract. The method is to first
15471 go to the last (rightmost) visible character of a
15472 line, then move to the leftmost character on the
15473 next line in a separate call. */
15474 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15475 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15476 move_it_to (&it
, ZV
, 0,
15477 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15478 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15481 move_it_by_lines (&it
, 1);
15484 /* Set the window start there. */
15485 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15486 window_start_changed_p
= 1;
15490 return window_start_changed_p
;
15494 /* Try cursor movement in case text has not changed in window WINDOW,
15495 with window start STARTP. Value is
15497 CURSOR_MOVEMENT_SUCCESS if successful
15499 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15501 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15502 display. *SCROLL_STEP is set to 1, under certain circumstances, if
15503 we want to scroll as if scroll-step were set to 1. See the code.
15505 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15506 which case we have to abort this redisplay, and adjust matrices
15511 CURSOR_MOVEMENT_SUCCESS
,
15512 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15513 CURSOR_MOVEMENT_MUST_SCROLL
,
15514 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15518 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
15520 struct window
*w
= XWINDOW (window
);
15521 struct frame
*f
= XFRAME (w
->frame
);
15522 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15525 if (inhibit_try_cursor_movement
)
15529 /* Previously, there was a check for Lisp integer in the
15530 if-statement below. Now, this field is converted to
15531 ptrdiff_t, thus zero means invalid position in a buffer. */
15532 eassert (w
->last_point
> 0);
15533 /* Likewise there was a check whether window_end_vpos is nil or larger
15534 than the window. Now window_end_vpos is int and so never nil, but
15535 let's leave eassert to check whether it fits in the window. */
15536 eassert (w
->window_end_vpos
< w
->current_matrix
->nrows
);
15538 /* Handle case where text has not changed, only point, and it has
15539 not moved off the frame. */
15540 if (/* Point may be in this window. */
15541 PT
>= CHARPOS (startp
)
15542 /* Selective display hasn't changed. */
15543 && !current_buffer
->clip_changed
15544 /* Function force-mode-line-update is used to force a thorough
15545 redisplay. It sets either windows_or_buffers_changed or
15546 update_mode_lines. So don't take a shortcut here for these
15548 && !update_mode_lines
15549 && !windows_or_buffers_changed
15550 && !f
->cursor_type_changed
15551 && NILP (Vshow_trailing_whitespace
)
15552 /* This code is not used for mini-buffer for the sake of the case
15553 of redisplaying to replace an echo area message; since in
15554 that case the mini-buffer contents per se are usually
15555 unchanged. This code is of no real use in the mini-buffer
15556 since the handling of this_line_start_pos, etc., in redisplay
15557 handles the same cases. */
15558 && !EQ (window
, minibuf_window
)
15559 && (FRAME_WINDOW_P (f
)
15560 || !overlay_arrow_in_current_buffer_p ()))
15562 int this_scroll_margin
, top_scroll_margin
;
15563 struct glyph_row
*row
= NULL
;
15564 int frame_line_height
= default_line_pixel_height (w
);
15565 int window_total_lines
15566 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15569 debug_method_add (w
, "cursor movement");
15572 /* Scroll if point within this distance from the top or bottom
15573 of the window. This is a pixel value. */
15574 if (scroll_margin
> 0)
15576 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15577 this_scroll_margin
*= frame_line_height
;
15580 this_scroll_margin
= 0;
15582 top_scroll_margin
= this_scroll_margin
;
15583 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15584 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15586 /* Start with the row the cursor was displayed during the last
15587 not paused redisplay. Give up if that row is not valid. */
15588 if (w
->last_cursor_vpos
< 0
15589 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15590 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15593 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15594 if (row
->mode_line_p
)
15596 if (!row
->enabled_p
)
15597 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15600 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15602 int scroll_p
= 0, must_scroll
= 0;
15603 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15605 if (PT
> w
->last_point
)
15607 /* Point has moved forward. */
15608 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15609 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15611 eassert (row
->enabled_p
);
15615 /* If the end position of a row equals the start
15616 position of the next row, and PT is at that position,
15617 we would rather display cursor in the next line. */
15618 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15619 && MATRIX_ROW_END_CHARPOS (row
) == PT
15620 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15621 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15622 && !cursor_row_p (row
))
15625 /* If within the scroll margin, scroll. Note that
15626 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15627 the next line would be drawn, and that
15628 this_scroll_margin can be zero. */
15629 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15630 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15631 /* Line is completely visible last line in window
15632 and PT is to be set in the next line. */
15633 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15634 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15635 && !row
->ends_at_zv_p
15636 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15639 else if (PT
< w
->last_point
)
15641 /* Cursor has to be moved backward. Note that PT >=
15642 CHARPOS (startp) because of the outer if-statement. */
15643 while (!row
->mode_line_p
15644 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15645 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15646 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15647 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15648 row
> w
->current_matrix
->rows
15649 && (row
-1)->ends_in_newline_from_string_p
))))
15650 && (row
->y
> top_scroll_margin
15651 || CHARPOS (startp
) == BEGV
))
15653 eassert (row
->enabled_p
);
15657 /* Consider the following case: Window starts at BEGV,
15658 there is invisible, intangible text at BEGV, so that
15659 display starts at some point START > BEGV. It can
15660 happen that we are called with PT somewhere between
15661 BEGV and START. Try to handle that case. */
15662 if (row
< w
->current_matrix
->rows
15663 || row
->mode_line_p
)
15665 row
= w
->current_matrix
->rows
;
15666 if (row
->mode_line_p
)
15670 /* Due to newlines in overlay strings, we may have to
15671 skip forward over overlay strings. */
15672 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15673 && MATRIX_ROW_END_CHARPOS (row
) == PT
15674 && !cursor_row_p (row
))
15677 /* If within the scroll margin, scroll. */
15678 if (row
->y
< top_scroll_margin
15679 && CHARPOS (startp
) != BEGV
)
15684 /* Cursor did not move. So don't scroll even if cursor line
15685 is partially visible, as it was so before. */
15686 rc
= CURSOR_MOVEMENT_SUCCESS
;
15689 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15690 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15692 /* if PT is not in the glyph row, give up. */
15693 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15696 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15697 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15699 struct glyph_row
*row1
;
15701 /* If rows are bidi-reordered and point moved, back up
15702 until we find a row that does not belong to a
15703 continuation line. This is because we must consider
15704 all rows of a continued line as candidates for the
15705 new cursor positioning, since row start and end
15706 positions change non-linearly with vertical position
15708 /* FIXME: Revisit this when glyph ``spilling'' in
15709 continuation lines' rows is implemented for
15710 bidi-reordered rows. */
15711 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15712 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15715 /* If we hit the beginning of the displayed portion
15716 without finding the first row of a continued
15720 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15723 eassert (row
->enabled_p
);
15728 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15729 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15730 /* Make sure this isn't a header line by any chance, since
15731 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15732 && !row
->mode_line_p
15733 && make_cursor_line_fully_visible_p
)
15735 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15736 && !row
->ends_at_zv_p
15737 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15738 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15739 else if (row
->height
> window_box_height (w
))
15741 /* If we end up in a partially visible line, let's
15742 make it fully visible, except when it's taller
15743 than the window, in which case we can't do much
15746 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15750 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15751 if (!cursor_row_fully_visible_p (w
, 0, 1))
15752 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15754 rc
= CURSOR_MOVEMENT_SUCCESS
;
15758 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15759 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15760 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15762 /* With bidi-reordered rows, there could be more than
15763 one candidate row whose start and end positions
15764 occlude point. We need to let set_cursor_from_row
15765 find the best candidate. */
15766 /* FIXME: Revisit this when glyph ``spilling'' in
15767 continuation lines' rows is implemented for
15768 bidi-reordered rows. */
15773 int at_zv_p
= 0, exact_match_p
= 0;
15775 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15776 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15777 && cursor_row_p (row
))
15778 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15780 /* As soon as we've found the exact match for point,
15781 or the first suitable row whose ends_at_zv_p flag
15782 is set, we are done. */
15785 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15786 w
->cursor
.vpos
)->ends_at_zv_p
;
15788 && w
->cursor
.hpos
>= 0
15789 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15792 struct glyph_row
*candidate
=
15793 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15795 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15796 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15799 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15800 || (INTEGERP (g
->object
)
15801 && (g
->charpos
== PT
15802 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15804 if (at_zv_p
|| exact_match_p
)
15806 rc
= CURSOR_MOVEMENT_SUCCESS
;
15810 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15814 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15815 || row
->continued_p
)
15816 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15817 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15818 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15819 /* If we didn't find any candidate rows, or exited the
15820 loop before all the candidates were examined, signal
15821 to the caller that this method failed. */
15822 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15824 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15825 && !row
->continued_p
))
15826 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15828 rc
= CURSOR_MOVEMENT_SUCCESS
;
15834 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15836 rc
= CURSOR_MOVEMENT_SUCCESS
;
15841 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15842 && MATRIX_ROW_START_CHARPOS (row
) == PT
15843 && cursor_row_p (row
));
15851 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15855 set_vertical_scroll_bar (struct window
*w
)
15857 ptrdiff_t start
, end
, whole
;
15859 /* Calculate the start and end positions for the current window.
15860 At some point, it would be nice to choose between scrollbars
15861 which reflect the whole buffer size, with special markers
15862 indicating narrowing, and scrollbars which reflect only the
15865 Note that mini-buffers sometimes aren't displaying any text. */
15866 if (!MINI_WINDOW_P (w
)
15867 || (w
== XWINDOW (minibuf_window
)
15868 && NILP (echo_area_buffer
[0])))
15870 struct buffer
*buf
= XBUFFER (w
->contents
);
15871 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15872 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15873 /* I don't think this is guaranteed to be right. For the
15874 moment, we'll pretend it is. */
15875 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15879 if (whole
< (end
- start
))
15880 whole
= end
- start
;
15883 start
= end
= whole
= 0;
15885 /* Indicate what this scroll bar ought to be displaying now. */
15886 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15887 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15888 (w
, end
- start
, whole
, start
);
15892 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15893 selected_window is redisplayed.
15895 We can return without actually redisplaying the window if fonts has been
15896 changed on window's frame. In that case, redisplay_internal will retry.
15898 As one of the important parts of redisplaying a window, we need to
15899 decide whether the previous window-start position (stored in the
15900 window's w->start marker position) is still valid, and if it isn't,
15901 recompute it. Some details about that:
15903 . The previous window-start could be in a continuation line, in
15904 which case we need to recompute it when the window width
15905 changes. See compute_window_start_on_continuation_line and its
15908 . The text that changed since last redisplay could include the
15909 previous window-start position. In that case, we try to salvage
15910 what we can from the current glyph matrix by calling
15911 try_scrolling, which see.
15913 . Some Emacs command could force us to use a specific window-start
15914 position by setting the window's force_start flag, or gently
15915 propose doing that by setting the window's optional_new_start
15916 flag. In these cases, we try using the specified start point if
15917 that succeeds (i.e. the window desired matrix is successfully
15918 recomputed, and point location is within the window). In case
15919 of optional_new_start, we first check if the specified start
15920 position is feasible, i.e. if it will allow point to be
15921 displayed in the window. If using the specified start point
15922 fails, e.g., if new fonts are needed to be loaded, we abort the
15923 redisplay cycle and leave it up to the next cycle to figure out
15926 . Note that the window's force_start flag is sometimes set by
15927 redisplay itself, when it decides that the previous window start
15928 point is fine and should be kept. Search for "goto force_start"
15929 below to see the details. Like the values of window-start
15930 specified outside of redisplay, these internally-deduced values
15931 are tested for feasibility, and ignored if found to be
15934 . Note that the function try_window, used to completely redisplay
15935 a window, accepts the window's start point as its argument.
15936 This is used several times in the redisplay code to control
15937 where the window start will be, according to user options such
15938 as scroll-conservatively, and also to ensure the screen line
15939 showing point will be fully (as opposed to partially) visible on
15943 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15945 struct window
*w
= XWINDOW (window
);
15946 struct frame
*f
= XFRAME (w
->frame
);
15947 struct buffer
*buffer
= XBUFFER (w
->contents
);
15948 struct buffer
*old
= current_buffer
;
15949 struct text_pos lpoint
, opoint
, startp
;
15950 int update_mode_line
;
15953 /* Record it now because it's overwritten. */
15954 bool current_matrix_up_to_date_p
= false;
15955 bool used_current_matrix_p
= false;
15956 /* This is less strict than current_matrix_up_to_date_p.
15957 It indicates that the buffer contents and narrowing are unchanged. */
15958 bool buffer_unchanged_p
= false;
15959 int temp_scroll_step
= 0;
15960 ptrdiff_t count
= SPECPDL_INDEX ();
15962 int centering_position
= -1;
15963 int last_line_misfit
= 0;
15964 ptrdiff_t beg_unchanged
, end_unchanged
;
15965 int frame_line_height
;
15967 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15971 *w
->desired_matrix
->method
= 0;
15974 if (!just_this_one_p
15975 && REDISPLAY_SOME_P ()
15978 && !buffer
->text
->redisplay
15979 && BUF_PT (buffer
) == w
->last_point
)
15982 /* Make sure that both W's markers are valid. */
15983 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15984 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15986 /* We come here again if we need to run window-text-change-functions
15989 reconsider_clip_changes (w
);
15990 frame_line_height
= default_line_pixel_height (w
);
15992 /* Has the mode line to be updated? */
15993 update_mode_line
= (w
->update_mode_line
15994 || update_mode_lines
15995 || buffer
->clip_changed
15996 || buffer
->prevent_redisplay_optimizations_p
);
15998 if (!just_this_one_p
)
15999 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
16000 cleverly elsewhere. */
16001 w
->must_be_updated_p
= true;
16003 if (MINI_WINDOW_P (w
))
16005 if (w
== XWINDOW (echo_area_window
)
16006 && !NILP (echo_area_buffer
[0]))
16008 if (update_mode_line
)
16009 /* We may have to update a tty frame's menu bar or a
16010 tool-bar. Example `M-x C-h C-h C-g'. */
16011 goto finish_menu_bars
;
16013 /* We've already displayed the echo area glyphs in this window. */
16014 goto finish_scroll_bars
;
16016 else if ((w
!= XWINDOW (minibuf_window
)
16017 || minibuf_level
== 0)
16018 /* When buffer is nonempty, redisplay window normally. */
16019 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
16020 /* Quail displays non-mini buffers in minibuffer window.
16021 In that case, redisplay the window normally. */
16022 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
16024 /* W is a mini-buffer window, but it's not active, so clear
16026 int yb
= window_text_bottom_y (w
);
16027 struct glyph_row
*row
;
16030 for (y
= 0, row
= w
->desired_matrix
->rows
;
16032 y
+= row
->height
, ++row
)
16033 blank_row (w
, row
, y
);
16034 goto finish_scroll_bars
;
16037 clear_glyph_matrix (w
->desired_matrix
);
16040 /* Otherwise set up data on this window; select its buffer and point
16042 /* Really select the buffer, for the sake of buffer-local
16044 set_buffer_internal_1 (XBUFFER (w
->contents
));
16046 current_matrix_up_to_date_p
16047 = (w
->window_end_valid
16048 && !current_buffer
->clip_changed
16049 && !current_buffer
->prevent_redisplay_optimizations_p
16050 && !window_outdated (w
));
16052 /* Run the window-text-change-functions
16053 if it is possible that the text on the screen has changed
16054 (either due to modification of the text, or any other reason). */
16055 if (!current_matrix_up_to_date_p
16056 && !NILP (Vwindow_text_change_functions
))
16058 safe_run_hooks (Qwindow_text_change_functions
);
16062 beg_unchanged
= BEG_UNCHANGED
;
16063 end_unchanged
= END_UNCHANGED
;
16065 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16067 specbind (Qinhibit_point_motion_hooks
, Qt
);
16070 = (w
->window_end_valid
16071 && !current_buffer
->clip_changed
16072 && !window_outdated (w
));
16074 /* When windows_or_buffers_changed is non-zero, we can't rely
16075 on the window end being valid, so set it to zero there. */
16076 if (windows_or_buffers_changed
)
16078 /* If window starts on a continuation line, maybe adjust the
16079 window start in case the window's width changed. */
16080 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16081 compute_window_start_on_continuation_line (w
);
16083 w
->window_end_valid
= false;
16084 /* If so, we also can't rely on current matrix
16085 and should not fool try_cursor_movement below. */
16086 current_matrix_up_to_date_p
= false;
16089 /* Some sanity checks. */
16090 CHECK_WINDOW_END (w
);
16091 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16093 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16096 if (mode_line_update_needed (w
))
16097 update_mode_line
= 1;
16099 /* Point refers normally to the selected window. For any other
16100 window, set up appropriate value. */
16101 if (!EQ (window
, selected_window
))
16103 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16104 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16108 new_pt_byte
= BEGV_BYTE
;
16109 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16111 else if (new_pt
> (ZV
- 1))
16114 new_pt_byte
= ZV_BYTE
;
16115 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16118 /* We don't use SET_PT so that the point-motion hooks don't run. */
16119 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16122 /* If any of the character widths specified in the display table
16123 have changed, invalidate the width run cache. It's true that
16124 this may be a bit late to catch such changes, but the rest of
16125 redisplay goes (non-fatally) haywire when the display table is
16126 changed, so why should we worry about doing any better? */
16127 if (current_buffer
->width_run_cache
16128 || (current_buffer
->base_buffer
16129 && current_buffer
->base_buffer
->width_run_cache
))
16131 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16133 if (! disptab_matches_widthtab
16134 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16136 struct buffer
*buf
= current_buffer
;
16138 if (buf
->base_buffer
)
16139 buf
= buf
->base_buffer
;
16140 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16141 recompute_width_table (current_buffer
, disptab
);
16145 /* If window-start is screwed up, choose a new one. */
16146 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16149 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16151 /* If someone specified a new starting point but did not insist,
16152 check whether it can be used. */
16153 if ((w
->optional_new_start
|| window_frozen_p (w
))
16154 && CHARPOS (startp
) >= BEGV
16155 && CHARPOS (startp
) <= ZV
)
16157 ptrdiff_t it_charpos
;
16159 w
->optional_new_start
= 0;
16160 start_display (&it
, w
, startp
);
16161 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16162 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16163 /* Record IT's position now, since line_bottom_y might change
16165 it_charpos
= IT_CHARPOS (it
);
16166 /* Make sure we set the force_start flag only if the cursor row
16167 will be fully visible. Otherwise, the code under force_start
16168 label below will try to move point back into view, which is
16169 not what the code which sets optional_new_start wants. */
16170 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16171 && !w
->force_start
)
16173 if (it_charpos
== PT
)
16174 w
->force_start
= 1;
16175 /* IT may overshoot PT if text at PT is invisible. */
16176 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16177 w
->force_start
= 1;
16179 if (w
->force_start
)
16181 if (window_frozen_p (w
))
16182 debug_method_add (w
, "set force_start from frozen window start");
16184 debug_method_add (w
, "set force_start from optional_new_start");
16192 /* Handle case where place to start displaying has been specified,
16193 unless the specified location is outside the accessible range. */
16194 if (w
->force_start
)
16196 /* We set this later on if we have to adjust point. */
16199 w
->force_start
= 0;
16201 w
->window_end_valid
= 0;
16203 /* Forget any recorded base line for line number display. */
16204 if (!buffer_unchanged_p
)
16205 w
->base_line_number
= 0;
16207 /* Redisplay the mode line. Select the buffer properly for that.
16208 Also, run the hook window-scroll-functions
16209 because we have scrolled. */
16210 /* Note, we do this after clearing force_start because
16211 if there's an error, it is better to forget about force_start
16212 than to get into an infinite loop calling the hook functions
16213 and having them get more errors. */
16214 if (!update_mode_line
16215 || ! NILP (Vwindow_scroll_functions
))
16217 update_mode_line
= 1;
16218 w
->update_mode_line
= 1;
16219 startp
= run_window_scroll_functions (window
, startp
);
16222 if (CHARPOS (startp
) < BEGV
)
16223 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16224 else if (CHARPOS (startp
) > ZV
)
16225 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16227 /* Redisplay, then check if cursor has been set during the
16228 redisplay. Give up if new fonts were loaded. */
16229 /* We used to issue a CHECK_MARGINS argument to try_window here,
16230 but this causes scrolling to fail when point begins inside
16231 the scroll margin (bug#148) -- cyd */
16232 if (!try_window (window
, startp
, 0))
16234 w
->force_start
= 1;
16235 clear_glyph_matrix (w
->desired_matrix
);
16236 goto need_larger_matrices
;
16239 if (w
->cursor
.vpos
< 0)
16241 /* If point does not appear, try to move point so it does
16242 appear. The desired matrix has been built above, so we
16243 can use it here. */
16244 new_vpos
= window_box_height (w
) / 2;
16247 if (!cursor_row_fully_visible_p (w
, 0, 0))
16249 /* Point does appear, but on a line partly visible at end of window.
16250 Move it back to a fully-visible line. */
16251 new_vpos
= window_box_height (w
);
16252 /* But if window_box_height suggests a Y coordinate that is
16253 not less than we already have, that line will clearly not
16254 be fully visible, so give up and scroll the display.
16255 This can happen when the default face uses a font whose
16256 dimensions are different from the frame's default
16258 if (new_vpos
>= w
->cursor
.y
)
16260 w
->cursor
.vpos
= -1;
16261 clear_glyph_matrix (w
->desired_matrix
);
16262 goto try_to_scroll
;
16265 else if (w
->cursor
.vpos
>= 0)
16267 /* Some people insist on not letting point enter the scroll
16268 margin, even though this part handles windows that didn't
16270 int window_total_lines
16271 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16272 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16273 int pixel_margin
= margin
* frame_line_height
;
16274 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16276 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16277 below, which finds the row to move point to, advances by
16278 the Y coordinate of the _next_ row, see the definition of
16279 MATRIX_ROW_BOTTOM_Y. */
16280 if (w
->cursor
.vpos
< margin
+ header_line
)
16282 w
->cursor
.vpos
= -1;
16283 clear_glyph_matrix (w
->desired_matrix
);
16284 goto try_to_scroll
;
16288 int window_height
= window_box_height (w
);
16291 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16292 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16294 w
->cursor
.vpos
= -1;
16295 clear_glyph_matrix (w
->desired_matrix
);
16296 goto try_to_scroll
;
16301 /* If we need to move point for either of the above reasons,
16302 now actually do it. */
16305 struct glyph_row
*row
;
16307 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16308 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16311 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16312 MATRIX_ROW_START_BYTEPOS (row
));
16314 if (w
!= XWINDOW (selected_window
))
16315 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16316 else if (current_buffer
== old
)
16317 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16319 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16321 /* Re-run pre-redisplay-function so it can update the region
16322 according to the new position of point. */
16323 /* Other than the cursor, w's redisplay is done so we can set its
16324 redisplay to false. Also the buffer's redisplay can be set to
16325 false, since propagate_buffer_redisplay should have already
16326 propagated its info to `w' anyway. */
16327 w
->redisplay
= false;
16328 XBUFFER (w
->contents
)->text
->redisplay
= false;
16329 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16331 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16333 /* pre-redisplay-function made changes (e.g. move the region)
16334 that require another round of redisplay. */
16335 clear_glyph_matrix (w
->desired_matrix
);
16336 if (!try_window (window
, startp
, 0))
16337 goto need_larger_matrices
;
16340 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, 0, 0))
16342 clear_glyph_matrix (w
->desired_matrix
);
16343 goto try_to_scroll
;
16347 debug_method_add (w
, "forced window start");
16352 /* Handle case where text has not changed, only point, and it has
16353 not moved off the frame, and we are not retrying after hscroll.
16354 (current_matrix_up_to_date_p is nonzero when retrying.) */
16355 if (current_matrix_up_to_date_p
16356 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16357 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16361 case CURSOR_MOVEMENT_SUCCESS
:
16362 used_current_matrix_p
= 1;
16365 case CURSOR_MOVEMENT_MUST_SCROLL
:
16366 goto try_to_scroll
;
16372 /* If current starting point was originally the beginning of a line
16373 but no longer is, find a new starting point. */
16374 else if (w
->start_at_line_beg
16375 && !(CHARPOS (startp
) <= BEGV
16376 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16379 debug_method_add (w
, "recenter 1");
16384 /* Try scrolling with try_window_id. Value is > 0 if update has
16385 been done, it is -1 if we know that the same window start will
16386 not work. It is 0 if unsuccessful for some other reason. */
16387 else if ((tem
= try_window_id (w
)) != 0)
16390 debug_method_add (w
, "try_window_id %d", tem
);
16393 if (f
->fonts_changed
)
16394 goto need_larger_matrices
;
16398 /* Otherwise try_window_id has returned -1 which means that we
16399 don't want the alternative below this comment to execute. */
16401 else if (CHARPOS (startp
) >= BEGV
16402 && CHARPOS (startp
) <= ZV
16403 && PT
>= CHARPOS (startp
)
16404 && (CHARPOS (startp
) < ZV
16405 /* Avoid starting at end of buffer. */
16406 || CHARPOS (startp
) == BEGV
16407 || !window_outdated (w
)))
16409 int d1
, d2
, d5
, d6
;
16412 /* If first window line is a continuation line, and window start
16413 is inside the modified region, but the first change is before
16414 current window start, we must select a new window start.
16416 However, if this is the result of a down-mouse event (e.g. by
16417 extending the mouse-drag-overlay), we don't want to select a
16418 new window start, since that would change the position under
16419 the mouse, resulting in an unwanted mouse-movement rather
16420 than a simple mouse-click. */
16421 if (!w
->start_at_line_beg
16422 && NILP (do_mouse_tracking
)
16423 && CHARPOS (startp
) > BEGV
16424 && CHARPOS (startp
) > BEG
+ beg_unchanged
16425 && CHARPOS (startp
) <= Z
- end_unchanged
16426 /* Even if w->start_at_line_beg is nil, a new window may
16427 start at a line_beg, since that's how set_buffer_window
16428 sets it. So, we need to check the return value of
16429 compute_window_start_on_continuation_line. (See also
16431 && XMARKER (w
->start
)->buffer
== current_buffer
16432 && compute_window_start_on_continuation_line (w
)
16433 /* It doesn't make sense to force the window start like we
16434 do at label force_start if it is already known that point
16435 will not be fully visible in the resulting window, because
16436 doing so will move point from its correct position
16437 instead of scrolling the window to bring point into view.
16439 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16440 /* A very tall row could need more than the window height,
16441 in which case we accept that it is partially visible. */
16442 && (rtop
!= 0) == (rbot
!= 0))
16444 w
->force_start
= 1;
16445 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16447 debug_method_add (w
, "recomputed window start in continuation line");
16453 debug_method_add (w
, "same window start");
16456 /* Try to redisplay starting at same place as before.
16457 If point has not moved off frame, accept the results. */
16458 if (!current_matrix_up_to_date_p
16459 /* Don't use try_window_reusing_current_matrix in this case
16460 because a window scroll function can have changed the
16462 || !NILP (Vwindow_scroll_functions
)
16463 || MINI_WINDOW_P (w
)
16464 || !(used_current_matrix_p
16465 = try_window_reusing_current_matrix (w
)))
16467 IF_DEBUG (debug_method_add (w
, "1"));
16468 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16469 /* -1 means we need to scroll.
16470 0 means we need new matrices, but fonts_changed
16471 is set in that case, so we will detect it below. */
16472 goto try_to_scroll
;
16475 if (f
->fonts_changed
)
16476 goto need_larger_matrices
;
16478 if (w
->cursor
.vpos
>= 0)
16480 if (!just_this_one_p
16481 || current_buffer
->clip_changed
16482 || BEG_UNCHANGED
< CHARPOS (startp
))
16483 /* Forget any recorded base line for line number display. */
16484 w
->base_line_number
= 0;
16486 if (!cursor_row_fully_visible_p (w
, 1, 0))
16488 clear_glyph_matrix (w
->desired_matrix
);
16489 last_line_misfit
= 1;
16491 /* Drop through and scroll. */
16496 clear_glyph_matrix (w
->desired_matrix
);
16501 /* Redisplay the mode line. Select the buffer properly for that. */
16502 if (!update_mode_line
)
16504 update_mode_line
= 1;
16505 w
->update_mode_line
= 1;
16508 /* Try to scroll by specified few lines. */
16509 if ((scroll_conservatively
16510 || emacs_scroll_step
16511 || temp_scroll_step
16512 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16513 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16514 && CHARPOS (startp
) >= BEGV
16515 && CHARPOS (startp
) <= ZV
)
16517 /* The function returns -1 if new fonts were loaded, 1 if
16518 successful, 0 if not successful. */
16519 int ss
= try_scrolling (window
, just_this_one_p
,
16520 scroll_conservatively
,
16522 temp_scroll_step
, last_line_misfit
);
16525 case SCROLLING_SUCCESS
:
16528 case SCROLLING_NEED_LARGER_MATRICES
:
16529 goto need_larger_matrices
;
16531 case SCROLLING_FAILED
:
16539 /* Finally, just choose a place to start which positions point
16540 according to user preferences. */
16545 debug_method_add (w
, "recenter");
16548 /* Forget any previously recorded base line for line number display. */
16549 if (!buffer_unchanged_p
)
16550 w
->base_line_number
= 0;
16552 /* Determine the window start relative to point. */
16553 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16554 it
.current_y
= it
.last_visible_y
;
16555 if (centering_position
< 0)
16557 int window_total_lines
16558 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16561 ? min (scroll_margin
, window_total_lines
/ 4)
16563 ptrdiff_t margin_pos
= CHARPOS (startp
);
16564 Lisp_Object aggressive
;
16567 /* If there is a scroll margin at the top of the window, find
16568 its character position. */
16570 /* Cannot call start_display if startp is not in the
16571 accessible region of the buffer. This can happen when we
16572 have just switched to a different buffer and/or changed
16573 its restriction. In that case, startp is initialized to
16574 the character position 1 (BEGV) because we did not yet
16575 have chance to display the buffer even once. */
16576 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16579 void *it1data
= NULL
;
16581 SAVE_IT (it1
, it
, it1data
);
16582 start_display (&it1
, w
, startp
);
16583 move_it_vertically (&it1
, margin
* frame_line_height
);
16584 margin_pos
= IT_CHARPOS (it1
);
16585 RESTORE_IT (&it
, &it
, it1data
);
16587 scrolling_up
= PT
> margin_pos
;
16590 ? BVAR (current_buffer
, scroll_up_aggressively
)
16591 : BVAR (current_buffer
, scroll_down_aggressively
);
16593 if (!MINI_WINDOW_P (w
)
16594 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16598 /* Setting scroll-conservatively overrides
16599 scroll-*-aggressively. */
16600 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16602 double float_amount
= XFLOATINT (aggressive
);
16604 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16605 if (pt_offset
== 0 && float_amount
> 0)
16607 if (pt_offset
&& margin
> 0)
16610 /* Compute how much to move the window start backward from
16611 point so that point will be displayed where the user
16615 centering_position
= it
.last_visible_y
;
16617 centering_position
-= pt_offset
;
16618 centering_position
-=
16619 frame_line_height
* (1 + margin
+ (last_line_misfit
!= 0))
16620 + WINDOW_HEADER_LINE_HEIGHT (w
);
16621 /* Don't let point enter the scroll margin near top of
16623 if (centering_position
< margin
* frame_line_height
)
16624 centering_position
= margin
* frame_line_height
;
16627 centering_position
= margin
* frame_line_height
+ pt_offset
;
16630 /* Set the window start half the height of the window backward
16632 centering_position
= window_box_height (w
) / 2;
16634 move_it_vertically_backward (&it
, centering_position
);
16636 eassert (IT_CHARPOS (it
) >= BEGV
);
16638 /* The function move_it_vertically_backward may move over more
16639 than the specified y-distance. If it->w is small, e.g. a
16640 mini-buffer window, we may end up in front of the window's
16641 display area. Start displaying at the start of the line
16642 containing PT in this case. */
16643 if (it
.current_y
<= 0)
16645 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16646 move_it_vertically_backward (&it
, 0);
16650 it
.current_x
= it
.hpos
= 0;
16652 /* Set the window start position here explicitly, to avoid an
16653 infinite loop in case the functions in window-scroll-functions
16655 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16657 /* Run scroll hooks. */
16658 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16660 /* Redisplay the window. */
16661 if (!current_matrix_up_to_date_p
16662 || windows_or_buffers_changed
16663 || f
->cursor_type_changed
16664 /* Don't use try_window_reusing_current_matrix in this case
16665 because it can have changed the buffer. */
16666 || !NILP (Vwindow_scroll_functions
)
16667 || !just_this_one_p
16668 || MINI_WINDOW_P (w
)
16669 || !(used_current_matrix_p
16670 = try_window_reusing_current_matrix (w
)))
16671 try_window (window
, startp
, 0);
16673 /* If new fonts have been loaded (due to fontsets), give up. We
16674 have to start a new redisplay since we need to re-adjust glyph
16676 if (f
->fonts_changed
)
16677 goto need_larger_matrices
;
16679 /* If cursor did not appear assume that the middle of the window is
16680 in the first line of the window. Do it again with the next line.
16681 (Imagine a window of height 100, displaying two lines of height
16682 60. Moving back 50 from it->last_visible_y will end in the first
16684 if (w
->cursor
.vpos
< 0)
16686 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16688 clear_glyph_matrix (w
->desired_matrix
);
16689 move_it_by_lines (&it
, 1);
16690 try_window (window
, it
.current
.pos
, 0);
16692 else if (PT
< IT_CHARPOS (it
))
16694 clear_glyph_matrix (w
->desired_matrix
);
16695 move_it_by_lines (&it
, -1);
16696 try_window (window
, it
.current
.pos
, 0);
16700 /* Not much we can do about it. */
16704 /* Consider the following case: Window starts at BEGV, there is
16705 invisible, intangible text at BEGV, so that display starts at
16706 some point START > BEGV. It can happen that we are called with
16707 PT somewhere between BEGV and START. Try to handle that case,
16708 and similar ones. */
16709 if (w
->cursor
.vpos
< 0)
16711 /* First, try locating the proper glyph row for PT. */
16712 struct glyph_row
*row
=
16713 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16715 /* Sometimes point is at the beginning of invisible text that is
16716 before the 1st character displayed in the row. In that case,
16717 row_containing_pos fails to find the row, because no glyphs
16718 with appropriate buffer positions are present in the row.
16719 Therefore, we next try to find the row which shows the 1st
16720 position after the invisible text. */
16724 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16727 if (TEXT_PROP_MEANS_INVISIBLE (val
))
16730 Lisp_Object invis_end
=
16731 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16734 if (NATNUMP (invis_end
))
16735 alt_pos
= XFASTINT (invis_end
);
16738 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16742 /* Finally, fall back on the first row of the window after the
16743 header line (if any). This is slightly better than not
16744 displaying the cursor at all. */
16747 row
= w
->current_matrix
->rows
;
16748 if (row
->mode_line_p
)
16751 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16754 if (!cursor_row_fully_visible_p (w
, 0, 0))
16756 /* If vscroll is enabled, disable it and try again. */
16760 clear_glyph_matrix (w
->desired_matrix
);
16764 /* Users who set scroll-conservatively to a large number want
16765 point just above/below the scroll margin. If we ended up
16766 with point's row partially visible, move the window start to
16767 make that row fully visible and out of the margin. */
16768 if (scroll_conservatively
> SCROLL_LIMIT
)
16770 int window_total_lines
16771 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16774 ? min (scroll_margin
, window_total_lines
/ 4)
16776 int move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16778 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16779 clear_glyph_matrix (w
->desired_matrix
);
16780 if (1 == try_window (window
, it
.current
.pos
,
16781 TRY_WINDOW_CHECK_MARGINS
))
16785 /* If centering point failed to make the whole line visible,
16786 put point at the top instead. That has to make the whole line
16787 visible, if it can be done. */
16788 if (centering_position
== 0)
16791 clear_glyph_matrix (w
->desired_matrix
);
16792 centering_position
= 0;
16798 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16799 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16800 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16802 /* Display the mode line, if we must. */
16803 if ((update_mode_line
16804 /* If window not full width, must redo its mode line
16805 if (a) the window to its side is being redone and
16806 (b) we do a frame-based redisplay. This is a consequence
16807 of how inverted lines are drawn in frame-based redisplay. */
16808 || (!just_this_one_p
16809 && !FRAME_WINDOW_P (f
)
16810 && !WINDOW_FULL_WIDTH_P (w
))
16811 /* Line number to display. */
16812 || w
->base_line_pos
> 0
16813 /* Column number is displayed and different from the one displayed. */
16814 || (w
->column_number_displayed
!= -1
16815 && (w
->column_number_displayed
!= current_column ())))
16816 /* This means that the window has a mode line. */
16817 && (WINDOW_WANTS_MODELINE_P (w
)
16818 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16821 display_mode_lines (w
);
16823 /* If mode line height has changed, arrange for a thorough
16824 immediate redisplay using the correct mode line height. */
16825 if (WINDOW_WANTS_MODELINE_P (w
)
16826 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16828 f
->fonts_changed
= 1;
16829 w
->mode_line_height
= -1;
16830 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16831 = DESIRED_MODE_LINE_HEIGHT (w
);
16834 /* If header line height has changed, arrange for a thorough
16835 immediate redisplay using the correct header line height. */
16836 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16837 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16839 f
->fonts_changed
= 1;
16840 w
->header_line_height
= -1;
16841 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16842 = DESIRED_HEADER_LINE_HEIGHT (w
);
16845 if (f
->fonts_changed
)
16846 goto need_larger_matrices
;
16849 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16851 w
->base_line_pos
= 0;
16852 w
->base_line_number
= 0;
16857 /* When we reach a frame's selected window, redo the frame's menu bar. */
16858 if (update_mode_line
16859 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16861 int redisplay_menu_p
= 0;
16863 if (FRAME_WINDOW_P (f
))
16865 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16866 || defined (HAVE_NS) || defined (USE_GTK)
16867 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16869 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16873 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16875 if (redisplay_menu_p
)
16876 display_menu_bar (w
);
16878 #ifdef HAVE_WINDOW_SYSTEM
16879 if (FRAME_WINDOW_P (f
))
16881 #if defined (USE_GTK) || defined (HAVE_NS)
16882 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16883 redisplay_tool_bar (f
);
16885 if (WINDOWP (f
->tool_bar_window
)
16886 && (FRAME_TOOL_BAR_HEIGHT (f
) > 0
16887 || !NILP (Vauto_resize_tool_bars
))
16888 && redisplay_tool_bar (f
))
16889 ignore_mouse_drag_p
= 1;
16895 #ifdef HAVE_WINDOW_SYSTEM
16896 if (FRAME_WINDOW_P (f
)
16897 && update_window_fringes (w
, (just_this_one_p
16898 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16899 || w
->pseudo_window_p
)))
16903 if (draw_window_fringes (w
, 1))
16905 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16906 x_draw_right_divider (w
);
16908 x_draw_vertical_border (w
);
16914 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16915 x_draw_bottom_divider (w
);
16916 #endif /* HAVE_WINDOW_SYSTEM */
16918 /* We go to this label, with fonts_changed set, if it is
16919 necessary to try again using larger glyph matrices.
16920 We have to redeem the scroll bar even in this case,
16921 because the loop in redisplay_internal expects that. */
16922 need_larger_matrices
:
16924 finish_scroll_bars
:
16926 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16928 /* Set the thumb's position and size. */
16929 set_vertical_scroll_bar (w
);
16931 /* Note that we actually used the scroll bar attached to this
16932 window, so it shouldn't be deleted at the end of redisplay. */
16933 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16934 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16937 /* Restore current_buffer and value of point in it. The window
16938 update may have changed the buffer, so first make sure `opoint'
16939 is still valid (Bug#6177). */
16940 if (CHARPOS (opoint
) < BEGV
)
16941 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16942 else if (CHARPOS (opoint
) > ZV
)
16943 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16945 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16947 set_buffer_internal_1 (old
);
16948 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16949 shorter. This can be caused by log truncation in *Messages*. */
16950 if (CHARPOS (lpoint
) <= ZV
)
16951 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16953 unbind_to (count
, Qnil
);
16957 /* Build the complete desired matrix of WINDOW with a window start
16958 buffer position POS.
16960 Value is 1 if successful. It is zero if fonts were loaded during
16961 redisplay which makes re-adjusting glyph matrices necessary, and -1
16962 if point would appear in the scroll margins.
16963 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16964 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16968 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16970 struct window
*w
= XWINDOW (window
);
16972 struct glyph_row
*last_text_row
= NULL
;
16973 struct frame
*f
= XFRAME (w
->frame
);
16974 int frame_line_height
= default_line_pixel_height (w
);
16976 /* Make POS the new window start. */
16977 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16979 /* Mark cursor position as unknown. No overlay arrow seen. */
16980 w
->cursor
.vpos
= -1;
16981 overlay_arrow_seen
= 0;
16983 /* Initialize iterator and info to start at POS. */
16984 start_display (&it
, w
, pos
);
16986 /* Display all lines of W. */
16987 while (it
.current_y
< it
.last_visible_y
)
16989 if (display_line (&it
))
16990 last_text_row
= it
.glyph_row
- 1;
16991 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16995 /* Don't let the cursor end in the scroll margins. */
16996 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16997 && !MINI_WINDOW_P (w
))
16999 int this_scroll_margin
;
17000 int window_total_lines
17001 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
17003 if (scroll_margin
> 0)
17005 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
17006 this_scroll_margin
*= frame_line_height
;
17009 this_scroll_margin
= 0;
17011 if ((w
->cursor
.y
>= 0 /* not vscrolled */
17012 && w
->cursor
.y
< this_scroll_margin
17013 && CHARPOS (pos
) > BEGV
17014 && IT_CHARPOS (it
) < ZV
)
17015 /* rms: considering make_cursor_line_fully_visible_p here
17016 seems to give wrong results. We don't want to recenter
17017 when the last line is partly visible, we want to allow
17018 that case to be handled in the usual way. */
17019 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
17021 w
->cursor
.vpos
= -1;
17022 clear_glyph_matrix (w
->desired_matrix
);
17027 /* If bottom moved off end of frame, change mode line percentage. */
17028 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
17029 w
->update_mode_line
= 1;
17031 /* Set window_end_pos to the offset of the last character displayed
17032 on the window from the end of current_buffer. Set
17033 window_end_vpos to its row number. */
17036 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17037 adjust_window_ends (w
, last_text_row
, 0);
17039 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17040 w
->window_end_vpos
)));
17044 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17045 w
->window_end_pos
= Z
- ZV
;
17046 w
->window_end_vpos
= 0;
17049 /* But that is not valid info until redisplay finishes. */
17050 w
->window_end_valid
= 0;
17056 /************************************************************************
17057 Window redisplay reusing current matrix when buffer has not changed
17058 ************************************************************************/
17060 /* Try redisplay of window W showing an unchanged buffer with a
17061 different window start than the last time it was displayed by
17062 reusing its current matrix. Value is non-zero if successful.
17063 W->start is the new window start. */
17066 try_window_reusing_current_matrix (struct window
*w
)
17068 struct frame
*f
= XFRAME (w
->frame
);
17069 struct glyph_row
*bottom_row
;
17072 struct text_pos start
, new_start
;
17073 int nrows_scrolled
, i
;
17074 struct glyph_row
*last_text_row
;
17075 struct glyph_row
*last_reused_text_row
;
17076 struct glyph_row
*start_row
;
17077 int start_vpos
, min_y
, max_y
;
17080 if (inhibit_try_window_reusing
)
17084 if (/* This function doesn't handle terminal frames. */
17085 !FRAME_WINDOW_P (f
)
17086 /* Don't try to reuse the display if windows have been split
17088 || windows_or_buffers_changed
17089 || f
->cursor_type_changed
)
17092 /* Can't do this if showing trailing whitespace. */
17093 if (!NILP (Vshow_trailing_whitespace
))
17096 /* If top-line visibility has changed, give up. */
17097 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17098 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17101 /* Give up if old or new display is scrolled vertically. We could
17102 make this function handle this, but right now it doesn't. */
17103 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17104 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17107 /* The variable new_start now holds the new window start. The old
17108 start `start' can be determined from the current matrix. */
17109 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17110 start
= start_row
->minpos
;
17111 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17113 /* Clear the desired matrix for the display below. */
17114 clear_glyph_matrix (w
->desired_matrix
);
17116 if (CHARPOS (new_start
) <= CHARPOS (start
))
17118 /* Don't use this method if the display starts with an ellipsis
17119 displayed for invisible text. It's not easy to handle that case
17120 below, and it's certainly not worth the effort since this is
17121 not a frequent case. */
17122 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17125 IF_DEBUG (debug_method_add (w
, "twu1"));
17127 /* Display up to a row that can be reused. The variable
17128 last_text_row is set to the last row displayed that displays
17129 text. Note that it.vpos == 0 if or if not there is a
17130 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17131 start_display (&it
, w
, new_start
);
17132 w
->cursor
.vpos
= -1;
17133 last_text_row
= last_reused_text_row
= NULL
;
17135 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17137 /* If we have reached into the characters in the START row,
17138 that means the line boundaries have changed. So we
17139 can't start copying with the row START. Maybe it will
17140 work to start copying with the following row. */
17141 while (IT_CHARPOS (it
) > CHARPOS (start
))
17143 /* Advance to the next row as the "start". */
17145 start
= start_row
->minpos
;
17146 /* If there are no more rows to try, or just one, give up. */
17147 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17148 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17149 || CHARPOS (start
) == ZV
)
17151 clear_glyph_matrix (w
->desired_matrix
);
17155 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17157 /* If we have reached alignment, we can copy the rest of the
17159 if (IT_CHARPOS (it
) == CHARPOS (start
)
17160 /* Don't accept "alignment" inside a display vector,
17161 since start_row could have started in the middle of
17162 that same display vector (thus their character
17163 positions match), and we have no way of telling if
17164 that is the case. */
17165 && it
.current
.dpvec_index
< 0)
17168 if (display_line (&it
))
17169 last_text_row
= it
.glyph_row
- 1;
17173 /* A value of current_y < last_visible_y means that we stopped
17174 at the previous window start, which in turn means that we
17175 have at least one reusable row. */
17176 if (it
.current_y
< it
.last_visible_y
)
17178 struct glyph_row
*row
;
17180 /* IT.vpos always starts from 0; it counts text lines. */
17181 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17183 /* Find PT if not already found in the lines displayed. */
17184 if (w
->cursor
.vpos
< 0)
17186 int dy
= it
.current_y
- start_row
->y
;
17188 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17189 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17191 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17192 dy
, nrows_scrolled
);
17195 clear_glyph_matrix (w
->desired_matrix
);
17200 /* Scroll the display. Do it before the current matrix is
17201 changed. The problem here is that update has not yet
17202 run, i.e. part of the current matrix is not up to date.
17203 scroll_run_hook will clear the cursor, and use the
17204 current matrix to get the height of the row the cursor is
17206 run
.current_y
= start_row
->y
;
17207 run
.desired_y
= it
.current_y
;
17208 run
.height
= it
.last_visible_y
- it
.current_y
;
17210 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17213 FRAME_RIF (f
)->update_window_begin_hook (w
);
17214 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17215 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17216 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17220 /* Shift current matrix down by nrows_scrolled lines. */
17221 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17222 rotate_matrix (w
->current_matrix
,
17224 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17227 /* Disable lines that must be updated. */
17228 for (i
= 0; i
< nrows_scrolled
; ++i
)
17229 (start_row
+ i
)->enabled_p
= false;
17231 /* Re-compute Y positions. */
17232 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17233 max_y
= it
.last_visible_y
;
17234 for (row
= start_row
+ nrows_scrolled
;
17238 row
->y
= it
.current_y
;
17239 row
->visible_height
= row
->height
;
17241 if (row
->y
< min_y
)
17242 row
->visible_height
-= min_y
- row
->y
;
17243 if (row
->y
+ row
->height
> max_y
)
17244 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17245 if (row
->fringe_bitmap_periodic_p
)
17246 row
->redraw_fringe_bitmaps_p
= 1;
17248 it
.current_y
+= row
->height
;
17250 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17251 last_reused_text_row
= row
;
17252 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17256 /* Disable lines in the current matrix which are now
17257 below the window. */
17258 for (++row
; row
< bottom_row
; ++row
)
17259 row
->enabled_p
= row
->mode_line_p
= 0;
17262 /* Update window_end_pos etc.; last_reused_text_row is the last
17263 reused row from the current matrix containing text, if any.
17264 The value of last_text_row is the last displayed line
17265 containing text. */
17266 if (last_reused_text_row
)
17267 adjust_window_ends (w
, last_reused_text_row
, 1);
17268 else if (last_text_row
)
17269 adjust_window_ends (w
, last_text_row
, 0);
17272 /* This window must be completely empty. */
17273 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17274 w
->window_end_pos
= Z
- ZV
;
17275 w
->window_end_vpos
= 0;
17277 w
->window_end_valid
= 0;
17279 /* Update hint: don't try scrolling again in update_window. */
17280 w
->desired_matrix
->no_scrolling_p
= 1;
17283 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17287 else if (CHARPOS (new_start
) > CHARPOS (start
))
17289 struct glyph_row
*pt_row
, *row
;
17290 struct glyph_row
*first_reusable_row
;
17291 struct glyph_row
*first_row_to_display
;
17293 int yb
= window_text_bottom_y (w
);
17295 /* Find the row starting at new_start, if there is one. Don't
17296 reuse a partially visible line at the end. */
17297 first_reusable_row
= start_row
;
17298 while (first_reusable_row
->enabled_p
17299 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17300 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17301 < CHARPOS (new_start
)))
17302 ++first_reusable_row
;
17304 /* Give up if there is no row to reuse. */
17305 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17306 || !first_reusable_row
->enabled_p
17307 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17308 != CHARPOS (new_start
)))
17311 /* We can reuse fully visible rows beginning with
17312 first_reusable_row to the end of the window. Set
17313 first_row_to_display to the first row that cannot be reused.
17314 Set pt_row to the row containing point, if there is any. */
17316 for (first_row_to_display
= first_reusable_row
;
17317 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17318 ++first_row_to_display
)
17320 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17321 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17322 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17323 && first_row_to_display
->ends_at_zv_p
17324 && pt_row
== NULL
)))
17325 pt_row
= first_row_to_display
;
17328 /* Start displaying at the start of first_row_to_display. */
17329 eassert (first_row_to_display
->y
< yb
);
17330 init_to_row_start (&it
, w
, first_row_to_display
);
17332 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17334 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17336 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17337 + WINDOW_HEADER_LINE_HEIGHT (w
));
17339 /* Display lines beginning with first_row_to_display in the
17340 desired matrix. Set last_text_row to the last row displayed
17341 that displays text. */
17342 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17343 if (pt_row
== NULL
)
17344 w
->cursor
.vpos
= -1;
17345 last_text_row
= NULL
;
17346 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17347 if (display_line (&it
))
17348 last_text_row
= it
.glyph_row
- 1;
17350 /* If point is in a reused row, adjust y and vpos of the cursor
17354 w
->cursor
.vpos
-= nrows_scrolled
;
17355 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17358 /* Give up if point isn't in a row displayed or reused. (This
17359 also handles the case where w->cursor.vpos < nrows_scrolled
17360 after the calls to display_line, which can happen with scroll
17361 margins. See bug#1295.) */
17362 if (w
->cursor
.vpos
< 0)
17364 clear_glyph_matrix (w
->desired_matrix
);
17368 /* Scroll the display. */
17369 run
.current_y
= first_reusable_row
->y
;
17370 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17371 run
.height
= it
.last_visible_y
- run
.current_y
;
17372 dy
= run
.current_y
- run
.desired_y
;
17377 FRAME_RIF (f
)->update_window_begin_hook (w
);
17378 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17379 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17380 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17384 /* Adjust Y positions of reused rows. */
17385 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17386 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17387 max_y
= it
.last_visible_y
;
17388 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17391 row
->visible_height
= row
->height
;
17392 if (row
->y
< min_y
)
17393 row
->visible_height
-= min_y
- row
->y
;
17394 if (row
->y
+ row
->height
> max_y
)
17395 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17396 if (row
->fringe_bitmap_periodic_p
)
17397 row
->redraw_fringe_bitmaps_p
= 1;
17400 /* Scroll the current matrix. */
17401 eassert (nrows_scrolled
> 0);
17402 rotate_matrix (w
->current_matrix
,
17404 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17407 /* Disable rows not reused. */
17408 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17409 row
->enabled_p
= false;
17411 /* Point may have moved to a different line, so we cannot assume that
17412 the previous cursor position is valid; locate the correct row. */
17415 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17417 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17418 && !row
->ends_at_zv_p
;
17422 w
->cursor
.y
= row
->y
;
17424 if (row
< bottom_row
)
17426 /* Can't simply scan the row for point with
17427 bidi-reordered glyph rows. Let set_cursor_from_row
17428 figure out where to put the cursor, and if it fails,
17430 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17432 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17435 clear_glyph_matrix (w
->desired_matrix
);
17441 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17442 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17445 && (!BUFFERP (glyph
->object
)
17446 || glyph
->charpos
< PT
);
17450 w
->cursor
.x
+= glyph
->pixel_width
;
17456 /* Adjust window end. A null value of last_text_row means that
17457 the window end is in reused rows which in turn means that
17458 only its vpos can have changed. */
17460 adjust_window_ends (w
, last_text_row
, 0);
17462 w
->window_end_vpos
-= nrows_scrolled
;
17464 w
->window_end_valid
= 0;
17465 w
->desired_matrix
->no_scrolling_p
= 1;
17468 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17478 /************************************************************************
17479 Window redisplay reusing current matrix when buffer has changed
17480 ************************************************************************/
17482 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17483 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17484 ptrdiff_t *, ptrdiff_t *);
17485 static struct glyph_row
*
17486 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17487 struct glyph_row
*);
17490 /* Return the last row in MATRIX displaying text. If row START is
17491 non-null, start searching with that row. IT gives the dimensions
17492 of the display. Value is null if matrix is empty; otherwise it is
17493 a pointer to the row found. */
17495 static struct glyph_row
*
17496 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17497 struct glyph_row
*start
)
17499 struct glyph_row
*row
, *row_found
;
17501 /* Set row_found to the last row in IT->w's current matrix
17502 displaying text. The loop looks funny but think of partially
17505 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17506 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17508 eassert (row
->enabled_p
);
17510 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17519 /* Return the last row in the current matrix of W that is not affected
17520 by changes at the start of current_buffer that occurred since W's
17521 current matrix was built. Value is null if no such row exists.
17523 BEG_UNCHANGED us the number of characters unchanged at the start of
17524 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17525 first changed character in current_buffer. Characters at positions <
17526 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17527 when the current matrix was built. */
17529 static struct glyph_row
*
17530 find_last_unchanged_at_beg_row (struct window
*w
)
17532 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17533 struct glyph_row
*row
;
17534 struct glyph_row
*row_found
= NULL
;
17535 int yb
= window_text_bottom_y (w
);
17537 /* Find the last row displaying unchanged text. */
17538 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17539 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17540 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17543 if (/* If row ends before first_changed_pos, it is unchanged,
17544 except in some case. */
17545 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17546 /* When row ends in ZV and we write at ZV it is not
17548 && !row
->ends_at_zv_p
17549 /* When first_changed_pos is the end of a continued line,
17550 row is not unchanged because it may be no longer
17552 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17553 && (row
->continued_p
17554 || row
->exact_window_width_line_p
))
17555 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17556 needs to be recomputed, so don't consider this row as
17557 unchanged. This happens when the last line was
17558 bidi-reordered and was killed immediately before this
17559 redisplay cycle. In that case, ROW->end stores the
17560 buffer position of the first visual-order character of
17561 the killed text, which is now beyond ZV. */
17562 && CHARPOS (row
->end
.pos
) <= ZV
)
17565 /* Stop if last visible row. */
17566 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17574 /* Find the first glyph row in the current matrix of W that is not
17575 affected by changes at the end of current_buffer since the
17576 time W's current matrix was built.
17578 Return in *DELTA the number of chars by which buffer positions in
17579 unchanged text at the end of current_buffer must be adjusted.
17581 Return in *DELTA_BYTES the corresponding number of bytes.
17583 Value is null if no such row exists, i.e. all rows are affected by
17586 static struct glyph_row
*
17587 find_first_unchanged_at_end_row (struct window
*w
,
17588 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17590 struct glyph_row
*row
;
17591 struct glyph_row
*row_found
= NULL
;
17593 *delta
= *delta_bytes
= 0;
17595 /* Display must not have been paused, otherwise the current matrix
17596 is not up to date. */
17597 eassert (w
->window_end_valid
);
17599 /* A value of window_end_pos >= END_UNCHANGED means that the window
17600 end is in the range of changed text. If so, there is no
17601 unchanged row at the end of W's current matrix. */
17602 if (w
->window_end_pos
>= END_UNCHANGED
)
17605 /* Set row to the last row in W's current matrix displaying text. */
17606 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17608 /* If matrix is entirely empty, no unchanged row exists. */
17609 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17611 /* The value of row is the last glyph row in the matrix having a
17612 meaningful buffer position in it. The end position of row
17613 corresponds to window_end_pos. This allows us to translate
17614 buffer positions in the current matrix to current buffer
17615 positions for characters not in changed text. */
17617 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17618 ptrdiff_t Z_BYTE_old
=
17619 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17620 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17621 struct glyph_row
*first_text_row
17622 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17624 *delta
= Z
- Z_old
;
17625 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17627 /* Set last_unchanged_pos to the buffer position of the last
17628 character in the buffer that has not been changed. Z is the
17629 index + 1 of the last character in current_buffer, i.e. by
17630 subtracting END_UNCHANGED we get the index of the last
17631 unchanged character, and we have to add BEG to get its buffer
17633 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17634 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17636 /* Search backward from ROW for a row displaying a line that
17637 starts at a minimum position >= last_unchanged_pos_old. */
17638 for (; row
> first_text_row
; --row
)
17640 /* This used to abort, but it can happen.
17641 It is ok to just stop the search instead here. KFS. */
17642 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17645 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17650 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17656 /* Make sure that glyph rows in the current matrix of window W
17657 reference the same glyph memory as corresponding rows in the
17658 frame's frame matrix. This function is called after scrolling W's
17659 current matrix on a terminal frame in try_window_id and
17660 try_window_reusing_current_matrix. */
17663 sync_frame_with_window_matrix_rows (struct window
*w
)
17665 struct frame
*f
= XFRAME (w
->frame
);
17666 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17668 /* Preconditions: W must be a leaf window and full-width. Its frame
17669 must have a frame matrix. */
17670 eassert (BUFFERP (w
->contents
));
17671 eassert (WINDOW_FULL_WIDTH_P (w
));
17672 eassert (!FRAME_WINDOW_P (f
));
17674 /* If W is a full-width window, glyph pointers in W's current matrix
17675 have, by definition, to be the same as glyph pointers in the
17676 corresponding frame matrix. Note that frame matrices have no
17677 marginal areas (see build_frame_matrix). */
17678 window_row
= w
->current_matrix
->rows
;
17679 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17680 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17681 while (window_row
< window_row_end
)
17683 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17684 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17686 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17687 frame_row
->glyphs
[TEXT_AREA
] = start
;
17688 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17689 frame_row
->glyphs
[LAST_AREA
] = end
;
17691 /* Disable frame rows whose corresponding window rows have
17692 been disabled in try_window_id. */
17693 if (!window_row
->enabled_p
)
17694 frame_row
->enabled_p
= false;
17696 ++window_row
, ++frame_row
;
17701 /* Find the glyph row in window W containing CHARPOS. Consider all
17702 rows between START and END (not inclusive). END null means search
17703 all rows to the end of the display area of W. Value is the row
17704 containing CHARPOS or null. */
17707 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17708 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17710 struct glyph_row
*row
= start
;
17711 struct glyph_row
*best_row
= NULL
;
17712 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17715 /* If we happen to start on a header-line, skip that. */
17716 if (row
->mode_line_p
)
17719 if ((end
&& row
>= end
) || !row
->enabled_p
)
17722 last_y
= window_text_bottom_y (w
) - dy
;
17726 /* Give up if we have gone too far. */
17727 if (end
&& row
>= end
)
17729 /* This formerly returned if they were equal.
17730 I think that both quantities are of a "last plus one" type;
17731 if so, when they are equal, the row is within the screen. -- rms. */
17732 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17735 /* If it is in this row, return this row. */
17736 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17737 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17738 /* The end position of a row equals the start
17739 position of the next row. If CHARPOS is there, we
17740 would rather consider it displayed in the next
17741 line, except when this line ends in ZV. */
17742 && !row_for_charpos_p (row
, charpos
)))
17743 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17747 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17748 || (!best_row
&& !row
->continued_p
))
17750 /* In bidi-reordered rows, there could be several rows whose
17751 edges surround CHARPOS, all of these rows belonging to
17752 the same continued line. We need to find the row which
17753 fits CHARPOS the best. */
17754 for (g
= row
->glyphs
[TEXT_AREA
];
17755 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17758 if (!STRINGP (g
->object
))
17760 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17762 mindif
= eabs (g
->charpos
- charpos
);
17764 /* Exact match always wins. */
17771 else if (best_row
&& !row
->continued_p
)
17778 /* Try to redisplay window W by reusing its existing display. W's
17779 current matrix must be up to date when this function is called,
17780 i.e. window_end_valid must be nonzero.
17784 >= 1 if successful, i.e. display has been updated
17786 1 means the changes were in front of a newline that precedes
17787 the window start, and the whole current matrix was reused
17788 2 means the changes were after the last position displayed
17789 in the window, and the whole current matrix was reused
17790 3 means portions of the current matrix were reused, while
17791 some of the screen lines were redrawn
17792 -1 if redisplay with same window start is known not to succeed
17793 0 if otherwise unsuccessful
17795 The following steps are performed:
17797 1. Find the last row in the current matrix of W that is not
17798 affected by changes at the start of current_buffer. If no such row
17801 2. Find the first row in W's current matrix that is not affected by
17802 changes at the end of current_buffer. Maybe there is no such row.
17804 3. Display lines beginning with the row + 1 found in step 1 to the
17805 row found in step 2 or, if step 2 didn't find a row, to the end of
17808 4. If cursor is not known to appear on the window, give up.
17810 5. If display stopped at the row found in step 2, scroll the
17811 display and current matrix as needed.
17813 6. Maybe display some lines at the end of W, if we must. This can
17814 happen under various circumstances, like a partially visible line
17815 becoming fully visible, or because newly displayed lines are displayed
17816 in smaller font sizes.
17818 7. Update W's window end information. */
17821 try_window_id (struct window
*w
)
17823 struct frame
*f
= XFRAME (w
->frame
);
17824 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17825 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17826 struct glyph_row
*last_unchanged_at_beg_row
;
17827 struct glyph_row
*first_unchanged_at_end_row
;
17828 struct glyph_row
*row
;
17829 struct glyph_row
*bottom_row
;
17832 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17834 struct text_pos start_pos
;
17836 int first_unchanged_at_end_vpos
= 0;
17837 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17838 struct text_pos start
;
17839 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17842 if (inhibit_try_window_id
)
17846 /* This is handy for debugging. */
17848 #define GIVE_UP(X) \
17850 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17854 #define GIVE_UP(X) return 0
17857 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17859 /* Don't use this for mini-windows because these can show
17860 messages and mini-buffers, and we don't handle that here. */
17861 if (MINI_WINDOW_P (w
))
17864 /* This flag is used to prevent redisplay optimizations. */
17865 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17868 /* This function's optimizations cannot be used if overlays have
17869 changed in the buffer displayed by the window, so give up if they
17871 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17874 /* Verify that narrowing has not changed.
17875 Also verify that we were not told to prevent redisplay optimizations.
17876 It would be nice to further
17877 reduce the number of cases where this prevents try_window_id. */
17878 if (current_buffer
->clip_changed
17879 || current_buffer
->prevent_redisplay_optimizations_p
)
17882 /* Window must either use window-based redisplay or be full width. */
17883 if (!FRAME_WINDOW_P (f
)
17884 && (!FRAME_LINE_INS_DEL_OK (f
)
17885 || !WINDOW_FULL_WIDTH_P (w
)))
17888 /* Give up if point is known NOT to appear in W. */
17889 if (PT
< CHARPOS (start
))
17892 /* Another way to prevent redisplay optimizations. */
17893 if (w
->last_modified
== 0)
17896 /* Verify that window is not hscrolled. */
17897 if (w
->hscroll
!= 0)
17900 /* Verify that display wasn't paused. */
17901 if (!w
->window_end_valid
)
17904 /* Likewise if highlighting trailing whitespace. */
17905 if (!NILP (Vshow_trailing_whitespace
))
17908 /* Can't use this if overlay arrow position and/or string have
17910 if (overlay_arrows_changed_p ())
17913 /* When word-wrap is on, adding a space to the first word of a
17914 wrapped line can change the wrap position, altering the line
17915 above it. It might be worthwhile to handle this more
17916 intelligently, but for now just redisplay from scratch. */
17917 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17920 /* Under bidi reordering, adding or deleting a character in the
17921 beginning of a paragraph, before the first strong directional
17922 character, can change the base direction of the paragraph (unless
17923 the buffer specifies a fixed paragraph direction), which will
17924 require to redisplay the whole paragraph. It might be worthwhile
17925 to find the paragraph limits and widen the range of redisplayed
17926 lines to that, but for now just give up this optimization and
17927 redisplay from scratch. */
17928 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17929 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17932 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17933 only if buffer has really changed. The reason is that the gap is
17934 initially at Z for freshly visited files. The code below would
17935 set end_unchanged to 0 in that case. */
17936 if (MODIFF
> SAVE_MODIFF
17937 /* This seems to happen sometimes after saving a buffer. */
17938 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17940 if (GPT
- BEG
< BEG_UNCHANGED
)
17941 BEG_UNCHANGED
= GPT
- BEG
;
17942 if (Z
- GPT
< END_UNCHANGED
)
17943 END_UNCHANGED
= Z
- GPT
;
17946 /* The position of the first and last character that has been changed. */
17947 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17948 last_changed_charpos
= Z
- END_UNCHANGED
;
17950 /* If window starts after a line end, and the last change is in
17951 front of that newline, then changes don't affect the display.
17952 This case happens with stealth-fontification. Note that although
17953 the display is unchanged, glyph positions in the matrix have to
17954 be adjusted, of course. */
17955 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17956 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17957 && ((last_changed_charpos
< CHARPOS (start
)
17958 && CHARPOS (start
) == BEGV
)
17959 || (last_changed_charpos
< CHARPOS (start
) - 1
17960 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17962 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17963 struct glyph_row
*r0
;
17965 /* Compute how many chars/bytes have been added to or removed
17966 from the buffer. */
17967 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17968 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17969 Z_delta
= Z
- Z_old
;
17970 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17972 /* Give up if PT is not in the window. Note that it already has
17973 been checked at the start of try_window_id that PT is not in
17974 front of the window start. */
17975 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17978 /* If window start is unchanged, we can reuse the whole matrix
17979 as is, after adjusting glyph positions. No need to compute
17980 the window end again, since its offset from Z hasn't changed. */
17981 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17982 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17983 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17984 /* PT must not be in a partially visible line. */
17985 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17986 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17988 /* Adjust positions in the glyph matrix. */
17989 if (Z_delta
|| Z_delta_bytes
)
17991 struct glyph_row
*r1
17992 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17993 increment_matrix_positions (w
->current_matrix
,
17994 MATRIX_ROW_VPOS (r0
, current_matrix
),
17995 MATRIX_ROW_VPOS (r1
, current_matrix
),
17996 Z_delta
, Z_delta_bytes
);
17999 /* Set the cursor. */
18000 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18002 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18007 /* Handle the case that changes are all below what is displayed in
18008 the window, and that PT is in the window. This shortcut cannot
18009 be taken if ZV is visible in the window, and text has been added
18010 there that is visible in the window. */
18011 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
18012 /* ZV is not visible in the window, or there are no
18013 changes at ZV, actually. */
18014 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
18015 || first_changed_charpos
== last_changed_charpos
))
18017 struct glyph_row
*r0
;
18019 /* Give up if PT is not in the window. Note that it already has
18020 been checked at the start of try_window_id that PT is not in
18021 front of the window start. */
18022 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
18025 /* If window start is unchanged, we can reuse the whole matrix
18026 as is, without changing glyph positions since no text has
18027 been added/removed in front of the window end. */
18028 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18029 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
18030 /* PT must not be in a partially visible line. */
18031 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18032 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18034 /* We have to compute the window end anew since text
18035 could have been added/removed after it. */
18036 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18037 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18039 /* Set the cursor. */
18040 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18042 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18047 /* Give up if window start is in the changed area.
18049 The condition used to read
18051 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18053 but why that was tested escapes me at the moment. */
18054 if (CHARPOS (start
) >= first_changed_charpos
18055 && CHARPOS (start
) <= last_changed_charpos
)
18058 /* Check that window start agrees with the start of the first glyph
18059 row in its current matrix. Check this after we know the window
18060 start is not in changed text, otherwise positions would not be
18062 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18063 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18066 /* Give up if the window ends in strings. Overlay strings
18067 at the end are difficult to handle, so don't try. */
18068 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18069 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18072 /* Compute the position at which we have to start displaying new
18073 lines. Some of the lines at the top of the window might be
18074 reusable because they are not displaying changed text. Find the
18075 last row in W's current matrix not affected by changes at the
18076 start of current_buffer. Value is null if changes start in the
18077 first line of window. */
18078 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18079 if (last_unchanged_at_beg_row
)
18081 /* Avoid starting to display in the middle of a character, a TAB
18082 for instance. This is easier than to set up the iterator
18083 exactly, and it's not a frequent case, so the additional
18084 effort wouldn't really pay off. */
18085 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18086 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18087 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18088 --last_unchanged_at_beg_row
;
18090 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18093 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
18095 start_pos
= it
.current
.pos
;
18097 /* Start displaying new lines in the desired matrix at the same
18098 vpos we would use in the current matrix, i.e. below
18099 last_unchanged_at_beg_row. */
18100 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18102 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18103 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18105 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18109 /* There are no reusable lines at the start of the window.
18110 Start displaying in the first text line. */
18111 start_display (&it
, w
, start
);
18112 it
.vpos
= it
.first_vpos
;
18113 start_pos
= it
.current
.pos
;
18116 /* Find the first row that is not affected by changes at the end of
18117 the buffer. Value will be null if there is no unchanged row, in
18118 which case we must redisplay to the end of the window. delta
18119 will be set to the value by which buffer positions beginning with
18120 first_unchanged_at_end_row have to be adjusted due to text
18122 first_unchanged_at_end_row
18123 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18124 IF_DEBUG (debug_delta
= delta
);
18125 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18127 /* Set stop_pos to the buffer position up to which we will have to
18128 display new lines. If first_unchanged_at_end_row != NULL, this
18129 is the buffer position of the start of the line displayed in that
18130 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18131 that we don't stop at a buffer position. */
18133 if (first_unchanged_at_end_row
)
18135 eassert (last_unchanged_at_beg_row
== NULL
18136 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18138 /* If this is a continuation line, move forward to the next one
18139 that isn't. Changes in lines above affect this line.
18140 Caution: this may move first_unchanged_at_end_row to a row
18141 not displaying text. */
18142 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18143 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18144 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18145 < it
.last_visible_y
))
18146 ++first_unchanged_at_end_row
;
18148 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18149 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18150 >= it
.last_visible_y
))
18151 first_unchanged_at_end_row
= NULL
;
18154 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18156 first_unchanged_at_end_vpos
18157 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18158 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18161 else if (last_unchanged_at_beg_row
== NULL
)
18167 /* Either there is no unchanged row at the end, or the one we have
18168 now displays text. This is a necessary condition for the window
18169 end pos calculation at the end of this function. */
18170 eassert (first_unchanged_at_end_row
== NULL
18171 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18173 debug_last_unchanged_at_beg_vpos
18174 = (last_unchanged_at_beg_row
18175 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18177 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18179 #endif /* GLYPH_DEBUG */
18182 /* Display new lines. Set last_text_row to the last new line
18183 displayed which has text on it, i.e. might end up as being the
18184 line where the window_end_vpos is. */
18185 w
->cursor
.vpos
= -1;
18186 last_text_row
= NULL
;
18187 overlay_arrow_seen
= 0;
18188 while (it
.current_y
< it
.last_visible_y
18189 && !f
->fonts_changed
18190 && (first_unchanged_at_end_row
== NULL
18191 || IT_CHARPOS (it
) < stop_pos
))
18193 if (display_line (&it
))
18194 last_text_row
= it
.glyph_row
- 1;
18197 if (f
->fonts_changed
)
18201 /* Compute differences in buffer positions, y-positions etc. for
18202 lines reused at the bottom of the window. Compute what we can
18204 if (first_unchanged_at_end_row
18205 /* No lines reused because we displayed everything up to the
18206 bottom of the window. */
18207 && it
.current_y
< it
.last_visible_y
)
18210 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18212 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18213 run
.current_y
= first_unchanged_at_end_row
->y
;
18214 run
.desired_y
= run
.current_y
+ dy
;
18215 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18219 delta
= delta_bytes
= dvpos
= dy
18220 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18221 first_unchanged_at_end_row
= NULL
;
18223 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18226 /* Find the cursor if not already found. We have to decide whether
18227 PT will appear on this window (it sometimes doesn't, but this is
18228 not a very frequent case.) This decision has to be made before
18229 the current matrix is altered. A value of cursor.vpos < 0 means
18230 that PT is either in one of the lines beginning at
18231 first_unchanged_at_end_row or below the window. Don't care for
18232 lines that might be displayed later at the window end; as
18233 mentioned, this is not a frequent case. */
18234 if (w
->cursor
.vpos
< 0)
18236 /* Cursor in unchanged rows at the top? */
18237 if (PT
< CHARPOS (start_pos
)
18238 && last_unchanged_at_beg_row
)
18240 row
= row_containing_pos (w
, PT
,
18241 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18242 last_unchanged_at_beg_row
+ 1, 0);
18244 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18247 /* Start from first_unchanged_at_end_row looking for PT. */
18248 else if (first_unchanged_at_end_row
)
18250 row
= row_containing_pos (w
, PT
- delta
,
18251 first_unchanged_at_end_row
, NULL
, 0);
18253 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18254 delta_bytes
, dy
, dvpos
);
18257 /* Give up if cursor was not found. */
18258 if (w
->cursor
.vpos
< 0)
18260 clear_glyph_matrix (w
->desired_matrix
);
18265 /* Don't let the cursor end in the scroll margins. */
18267 int this_scroll_margin
, cursor_height
;
18268 int frame_line_height
= default_line_pixel_height (w
);
18269 int window_total_lines
18270 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18272 this_scroll_margin
=
18273 max (0, min (scroll_margin
, window_total_lines
/ 4));
18274 this_scroll_margin
*= frame_line_height
;
18275 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18277 if ((w
->cursor
.y
< this_scroll_margin
18278 && CHARPOS (start
) > BEGV
)
18279 /* Old redisplay didn't take scroll margin into account at the bottom,
18280 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18281 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18282 ? cursor_height
+ this_scroll_margin
18283 : 1)) > it
.last_visible_y
)
18285 w
->cursor
.vpos
= -1;
18286 clear_glyph_matrix (w
->desired_matrix
);
18291 /* Scroll the display. Do it before changing the current matrix so
18292 that xterm.c doesn't get confused about where the cursor glyph is
18294 if (dy
&& run
.height
)
18298 if (FRAME_WINDOW_P (f
))
18300 FRAME_RIF (f
)->update_window_begin_hook (w
);
18301 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18302 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18303 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
18307 /* Terminal frame. In this case, dvpos gives the number of
18308 lines to scroll by; dvpos < 0 means scroll up. */
18310 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18311 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18312 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18313 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
18314 + window_internal_height (w
));
18316 #if defined (HAVE_GPM) || defined (MSDOS)
18317 x_clear_window_mouse_face (w
);
18319 /* Perform the operation on the screen. */
18322 /* Scroll last_unchanged_at_beg_row to the end of the
18323 window down dvpos lines. */
18324 set_terminal_window (f
, end
);
18326 /* On dumb terminals delete dvpos lines at the end
18327 before inserting dvpos empty lines. */
18328 if (!FRAME_SCROLL_REGION_OK (f
))
18329 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18331 /* Insert dvpos empty lines in front of
18332 last_unchanged_at_beg_row. */
18333 ins_del_lines (f
, from
, dvpos
);
18335 else if (dvpos
< 0)
18337 /* Scroll up last_unchanged_at_beg_vpos to the end of
18338 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18339 set_terminal_window (f
, end
);
18341 /* Delete dvpos lines in front of
18342 last_unchanged_at_beg_vpos. ins_del_lines will set
18343 the cursor to the given vpos and emit |dvpos| delete
18345 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18347 /* On a dumb terminal insert dvpos empty lines at the
18349 if (!FRAME_SCROLL_REGION_OK (f
))
18350 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18353 set_terminal_window (f
, 0);
18359 /* Shift reused rows of the current matrix to the right position.
18360 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18362 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18363 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18366 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18367 bottom_vpos
, dvpos
);
18368 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18371 else if (dvpos
> 0)
18373 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18374 bottom_vpos
, dvpos
);
18375 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18376 first_unchanged_at_end_vpos
+ dvpos
);
18379 /* For frame-based redisplay, make sure that current frame and window
18380 matrix are in sync with respect to glyph memory. */
18381 if (!FRAME_WINDOW_P (f
))
18382 sync_frame_with_window_matrix_rows (w
);
18384 /* Adjust buffer positions in reused rows. */
18385 if (delta
|| delta_bytes
)
18386 increment_matrix_positions (current_matrix
,
18387 first_unchanged_at_end_vpos
+ dvpos
,
18388 bottom_vpos
, delta
, delta_bytes
);
18390 /* Adjust Y positions. */
18392 shift_glyph_matrix (w
, current_matrix
,
18393 first_unchanged_at_end_vpos
+ dvpos
,
18396 if (first_unchanged_at_end_row
)
18398 first_unchanged_at_end_row
+= dvpos
;
18399 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18400 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18401 first_unchanged_at_end_row
= NULL
;
18404 /* If scrolling up, there may be some lines to display at the end of
18406 last_text_row_at_end
= NULL
;
18409 /* Scrolling up can leave for example a partially visible line
18410 at the end of the window to be redisplayed. */
18411 /* Set last_row to the glyph row in the current matrix where the
18412 window end line is found. It has been moved up or down in
18413 the matrix by dvpos. */
18414 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18415 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18417 /* If last_row is the window end line, it should display text. */
18418 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18420 /* If window end line was partially visible before, begin
18421 displaying at that line. Otherwise begin displaying with the
18422 line following it. */
18423 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18425 init_to_row_start (&it
, w
, last_row
);
18426 it
.vpos
= last_vpos
;
18427 it
.current_y
= last_row
->y
;
18431 init_to_row_end (&it
, w
, last_row
);
18432 it
.vpos
= 1 + last_vpos
;
18433 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18437 /* We may start in a continuation line. If so, we have to
18438 get the right continuation_lines_width and current_x. */
18439 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18440 it
.hpos
= it
.current_x
= 0;
18442 /* Display the rest of the lines at the window end. */
18443 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18444 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18446 /* Is it always sure that the display agrees with lines in
18447 the current matrix? I don't think so, so we mark rows
18448 displayed invalid in the current matrix by setting their
18449 enabled_p flag to zero. */
18450 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18451 if (display_line (&it
))
18452 last_text_row_at_end
= it
.glyph_row
- 1;
18456 /* Update window_end_pos and window_end_vpos. */
18457 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18459 /* Window end line if one of the preserved rows from the current
18460 matrix. Set row to the last row displaying text in current
18461 matrix starting at first_unchanged_at_end_row, after
18463 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18464 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18465 first_unchanged_at_end_row
);
18466 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18467 adjust_window_ends (w
, row
, 1);
18468 eassert (w
->window_end_bytepos
>= 0);
18469 IF_DEBUG (debug_method_add (w
, "A"));
18471 else if (last_text_row_at_end
)
18473 adjust_window_ends (w
, last_text_row_at_end
, 0);
18474 eassert (w
->window_end_bytepos
>= 0);
18475 IF_DEBUG (debug_method_add (w
, "B"));
18477 else if (last_text_row
)
18479 /* We have displayed either to the end of the window or at the
18480 end of the window, i.e. the last row with text is to be found
18481 in the desired matrix. */
18482 adjust_window_ends (w
, last_text_row
, 0);
18483 eassert (w
->window_end_bytepos
>= 0);
18485 else if (first_unchanged_at_end_row
== NULL
18486 && last_text_row
== NULL
18487 && last_text_row_at_end
== NULL
)
18489 /* Displayed to end of window, but no line containing text was
18490 displayed. Lines were deleted at the end of the window. */
18491 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
18492 int vpos
= w
->window_end_vpos
;
18493 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18494 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18497 row
== NULL
&& vpos
>= first_vpos
;
18498 --vpos
, --current_row
, --desired_row
)
18500 if (desired_row
->enabled_p
)
18502 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18505 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18509 eassert (row
!= NULL
);
18510 w
->window_end_vpos
= vpos
+ 1;
18511 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18512 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18513 eassert (w
->window_end_bytepos
>= 0);
18514 IF_DEBUG (debug_method_add (w
, "C"));
18519 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18520 debug_end_vpos
= w
->window_end_vpos
));
18522 /* Record that display has not been completed. */
18523 w
->window_end_valid
= 0;
18524 w
->desired_matrix
->no_scrolling_p
= 1;
18532 /***********************************************************************
18533 More debugging support
18534 ***********************************************************************/
18538 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18539 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18540 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18543 /* Dump the contents of glyph matrix MATRIX on stderr.
18545 GLYPHS 0 means don't show glyph contents.
18546 GLYPHS 1 means show glyphs in short form
18547 GLYPHS > 1 means show glyphs in long form. */
18550 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18553 for (i
= 0; i
< matrix
->nrows
; ++i
)
18554 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18558 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18559 the glyph row and area where the glyph comes from. */
18562 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18564 if (glyph
->type
== CHAR_GLYPH
18565 || glyph
->type
== GLYPHLESS_GLYPH
)
18568 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18569 glyph
- row
->glyphs
[TEXT_AREA
],
18570 (glyph
->type
== CHAR_GLYPH
18574 (BUFFERP (glyph
->object
)
18576 : (STRINGP (glyph
->object
)
18578 : (INTEGERP (glyph
->object
)
18581 glyph
->pixel_width
,
18583 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18587 glyph
->left_box_line_p
,
18588 glyph
->right_box_line_p
);
18590 else if (glyph
->type
== STRETCH_GLYPH
)
18593 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18594 glyph
- row
->glyphs
[TEXT_AREA
],
18597 (BUFFERP (glyph
->object
)
18599 : (STRINGP (glyph
->object
)
18601 : (INTEGERP (glyph
->object
)
18604 glyph
->pixel_width
,
18608 glyph
->left_box_line_p
,
18609 glyph
->right_box_line_p
);
18611 else if (glyph
->type
== IMAGE_GLYPH
)
18614 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18615 glyph
- row
->glyphs
[TEXT_AREA
],
18618 (BUFFERP (glyph
->object
)
18620 : (STRINGP (glyph
->object
)
18622 : (INTEGERP (glyph
->object
)
18625 glyph
->pixel_width
,
18629 glyph
->left_box_line_p
,
18630 glyph
->right_box_line_p
);
18632 else if (glyph
->type
== COMPOSITE_GLYPH
)
18635 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18636 glyph
- row
->glyphs
[TEXT_AREA
],
18639 (BUFFERP (glyph
->object
)
18641 : (STRINGP (glyph
->object
)
18643 : (INTEGERP (glyph
->object
)
18646 glyph
->pixel_width
,
18648 if (glyph
->u
.cmp
.automatic
)
18651 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18652 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18654 glyph
->left_box_line_p
,
18655 glyph
->right_box_line_p
);
18660 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18661 GLYPHS 0 means don't show glyph contents.
18662 GLYPHS 1 means show glyphs in short form
18663 GLYPHS > 1 means show glyphs in long form. */
18666 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18670 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18671 fprintf (stderr
, "==============================================================================\n");
18673 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18674 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18676 MATRIX_ROW_START_CHARPOS (row
),
18677 MATRIX_ROW_END_CHARPOS (row
),
18678 row
->used
[TEXT_AREA
],
18679 row
->contains_overlapping_glyphs_p
,
18681 row
->truncated_on_left_p
,
18682 row
->truncated_on_right_p
,
18684 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18685 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18688 row
->ends_in_middle_of_char_p
,
18689 row
->starts_in_middle_of_char_p
,
18695 row
->visible_height
,
18698 /* The next 3 lines should align to "Start" in the header. */
18699 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18700 row
->end
.overlay_string_index
,
18701 row
->continuation_lines_width
);
18702 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18703 CHARPOS (row
->start
.string_pos
),
18704 CHARPOS (row
->end
.string_pos
));
18705 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18706 row
->end
.dpvec_index
);
18713 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18715 struct glyph
*glyph
= row
->glyphs
[area
];
18716 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18718 /* Glyph for a line end in text. */
18719 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18722 if (glyph
< glyph_end
)
18723 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18725 for (; glyph
< glyph_end
; ++glyph
)
18726 dump_glyph (row
, glyph
, area
);
18729 else if (glyphs
== 1)
18733 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18735 char *s
= alloca (row
->used
[area
] + 4);
18738 for (i
= 0; i
< row
->used
[area
]; ++i
)
18740 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18741 if (i
== row
->used
[area
] - 1
18742 && area
== TEXT_AREA
18743 && INTEGERP (glyph
->object
)
18744 && glyph
->type
== CHAR_GLYPH
18745 && glyph
->u
.ch
== ' ')
18747 strcpy (&s
[i
], "[\\n]");
18750 else if (glyph
->type
== CHAR_GLYPH
18751 && glyph
->u
.ch
< 0x80
18752 && glyph
->u
.ch
>= ' ')
18753 s
[i
] = glyph
->u
.ch
;
18759 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18765 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18766 Sdump_glyph_matrix
, 0, 1, "p",
18767 doc
: /* Dump the current matrix of the selected window to stderr.
18768 Shows contents of glyph row structures. With non-nil
18769 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18770 glyphs in short form, otherwise show glyphs in long form.
18772 Interactively, no argument means show glyphs in short form;
18773 with numeric argument, its value is passed as the GLYPHS flag. */)
18774 (Lisp_Object glyphs
)
18776 struct window
*w
= XWINDOW (selected_window
);
18777 struct buffer
*buffer
= XBUFFER (w
->contents
);
18779 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18780 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18781 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18782 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18783 fprintf (stderr
, "=============================================\n");
18784 dump_glyph_matrix (w
->current_matrix
,
18785 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18790 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18791 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
18792 Only text-mode frames have frame glyph matrices. */)
18795 struct frame
*f
= XFRAME (selected_frame
);
18797 if (f
->current_matrix
)
18798 dump_glyph_matrix (f
->current_matrix
, 1);
18800 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
18805 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18806 doc
: /* Dump glyph row ROW to stderr.
18807 GLYPH 0 means don't dump glyphs.
18808 GLYPH 1 means dump glyphs in short form.
18809 GLYPH > 1 or omitted means dump glyphs in long form. */)
18810 (Lisp_Object row
, Lisp_Object glyphs
)
18812 struct glyph_matrix
*matrix
;
18815 CHECK_NUMBER (row
);
18816 matrix
= XWINDOW (selected_window
)->current_matrix
;
18818 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18819 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18821 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18826 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18827 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18828 GLYPH 0 means don't dump glyphs.
18829 GLYPH 1 means dump glyphs in short form.
18830 GLYPH > 1 or omitted means dump glyphs in long form.
18832 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18834 (Lisp_Object row
, Lisp_Object glyphs
)
18836 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18837 struct frame
*sf
= SELECTED_FRAME ();
18838 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18841 CHECK_NUMBER (row
);
18843 if (vpos
>= 0 && vpos
< m
->nrows
)
18844 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18845 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18851 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18852 doc
: /* Toggle tracing of redisplay.
18853 With ARG, turn tracing on if and only if ARG is positive. */)
18857 trace_redisplay_p
= !trace_redisplay_p
;
18860 arg
= Fprefix_numeric_value (arg
);
18861 trace_redisplay_p
= XINT (arg
) > 0;
18868 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18869 doc
: /* Like `format', but print result to stderr.
18870 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18871 (ptrdiff_t nargs
, Lisp_Object
*args
)
18873 Lisp_Object s
= Fformat (nargs
, args
);
18874 fprintf (stderr
, "%s", SDATA (s
));
18878 #endif /* GLYPH_DEBUG */
18882 /***********************************************************************
18883 Building Desired Matrix Rows
18884 ***********************************************************************/
18886 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18887 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18889 static struct glyph_row
*
18890 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18892 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18893 struct buffer
*buffer
= XBUFFER (w
->contents
);
18894 struct buffer
*old
= current_buffer
;
18895 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18896 int arrow_len
= SCHARS (overlay_arrow_string
);
18897 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18898 const unsigned char *p
;
18901 int n_glyphs_before
;
18903 set_buffer_temp (buffer
);
18904 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18905 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18906 SET_TEXT_POS (it
.position
, 0, 0);
18908 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18910 while (p
< arrow_end
)
18912 Lisp_Object face
, ilisp
;
18914 /* Get the next character. */
18916 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18919 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18920 if (! ASCII_CHAR_P (it
.c
))
18921 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18925 /* Get its face. */
18926 ilisp
= make_number (p
- arrow_string
);
18927 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18928 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18930 /* Compute its width, get its glyphs. */
18931 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18932 SET_TEXT_POS (it
.position
, -1, -1);
18933 PRODUCE_GLYPHS (&it
);
18935 /* If this character doesn't fit any more in the line, we have
18936 to remove some glyphs. */
18937 if (it
.current_x
> it
.last_visible_x
)
18939 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18944 set_buffer_temp (old
);
18945 return it
.glyph_row
;
18949 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18950 glyphs to insert is determined by produce_special_glyphs. */
18953 insert_left_trunc_glyphs (struct it
*it
)
18955 struct it truncate_it
;
18956 struct glyph
*from
, *end
, *to
, *toend
;
18958 eassert (!FRAME_WINDOW_P (it
->f
)
18959 || (!it
->glyph_row
->reversed_p
18960 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18961 || (it
->glyph_row
->reversed_p
18962 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18964 /* Get the truncation glyphs. */
18966 truncate_it
.current_x
= 0;
18967 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18968 truncate_it
.glyph_row
= &scratch_glyph_row
;
18969 truncate_it
.area
= TEXT_AREA
;
18970 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18971 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18972 truncate_it
.object
= make_number (0);
18973 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18975 /* Overwrite glyphs from IT with truncation glyphs. */
18976 if (!it
->glyph_row
->reversed_p
)
18978 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18980 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18981 end
= from
+ tused
;
18982 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18983 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18984 if (FRAME_WINDOW_P (it
->f
))
18986 /* On GUI frames, when variable-size fonts are displayed,
18987 the truncation glyphs may need more pixels than the row's
18988 glyphs they overwrite. We overwrite more glyphs to free
18989 enough screen real estate, and enlarge the stretch glyph
18990 on the right (see display_line), if there is one, to
18991 preserve the screen position of the truncation glyphs on
18994 struct glyph
*g
= to
;
18997 /* The first glyph could be partially visible, in which case
18998 it->glyph_row->x will be negative. But we want the left
18999 truncation glyphs to be aligned at the left margin of the
19000 window, so we override the x coordinate at which the row
19002 it
->glyph_row
->x
= 0;
19003 while (g
< toend
&& w
< it
->truncation_pixel_width
)
19005 w
+= g
->pixel_width
;
19008 if (g
- to
- tused
> 0)
19010 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
19011 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
19013 used
= it
->glyph_row
->used
[TEXT_AREA
];
19014 if (it
->glyph_row
->truncated_on_right_p
19015 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
19016 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
19019 int extra
= w
- it
->truncation_pixel_width
;
19021 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
19028 /* There may be padding glyphs left over. Overwrite them too. */
19029 if (!FRAME_WINDOW_P (it
->f
))
19031 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19033 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19040 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19044 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19046 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19047 that back to front. */
19048 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19049 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19050 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19051 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19052 if (FRAME_WINDOW_P (it
->f
))
19055 struct glyph
*g
= to
;
19057 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19059 w
+= g
->pixel_width
;
19062 if (to
- g
- tused
> 0)
19064 if (it
->glyph_row
->truncated_on_right_p
19065 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19066 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19068 int extra
= w
- it
->truncation_pixel_width
;
19070 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19074 while (from
>= end
&& to
>= toend
)
19076 if (!FRAME_WINDOW_P (it
->f
))
19078 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19081 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19082 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19083 while (from
>= end
&& to
>= toend
)
19089 /* Need to free some room before prepending additional
19091 int move_by
= from
- end
+ 1;
19092 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19093 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19095 for ( ; g
>= g0
; g
--)
19097 while (from
>= end
)
19099 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19104 /* Compute the hash code for ROW. */
19106 row_hash (struct glyph_row
*row
)
19109 unsigned hashval
= 0;
19111 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19112 for (k
= 0; k
< row
->used
[area
]; ++k
)
19113 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19114 + row
->glyphs
[area
][k
].u
.val
19115 + row
->glyphs
[area
][k
].face_id
19116 + row
->glyphs
[area
][k
].padding_p
19117 + (row
->glyphs
[area
][k
].type
<< 2));
19122 /* Compute the pixel height and width of IT->glyph_row.
19124 Most of the time, ascent and height of a display line will be equal
19125 to the max_ascent and max_height values of the display iterator
19126 structure. This is not the case if
19128 1. We hit ZV without displaying anything. In this case, max_ascent
19129 and max_height will be zero.
19131 2. We have some glyphs that don't contribute to the line height.
19132 (The glyph row flag contributes_to_line_height_p is for future
19133 pixmap extensions).
19135 The first case is easily covered by using default values because in
19136 these cases, the line height does not really matter, except that it
19137 must not be zero. */
19140 compute_line_metrics (struct it
*it
)
19142 struct glyph_row
*row
= it
->glyph_row
;
19144 if (FRAME_WINDOW_P (it
->f
))
19146 int i
, min_y
, max_y
;
19148 /* The line may consist of one space only, that was added to
19149 place the cursor on it. If so, the row's height hasn't been
19151 if (row
->height
== 0)
19153 if (it
->max_ascent
+ it
->max_descent
== 0)
19154 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19155 row
->ascent
= it
->max_ascent
;
19156 row
->height
= it
->max_ascent
+ it
->max_descent
;
19157 row
->phys_ascent
= it
->max_phys_ascent
;
19158 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19159 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19162 /* Compute the width of this line. */
19163 row
->pixel_width
= row
->x
;
19164 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19165 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19167 eassert (row
->pixel_width
>= 0);
19168 eassert (row
->ascent
>= 0 && row
->height
> 0);
19170 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19171 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19173 /* If first line's physical ascent is larger than its logical
19174 ascent, use the physical ascent, and make the row taller.
19175 This makes accented characters fully visible. */
19176 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19177 && row
->phys_ascent
> row
->ascent
)
19179 row
->height
+= row
->phys_ascent
- row
->ascent
;
19180 row
->ascent
= row
->phys_ascent
;
19183 /* Compute how much of the line is visible. */
19184 row
->visible_height
= row
->height
;
19186 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19187 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19189 if (row
->y
< min_y
)
19190 row
->visible_height
-= min_y
- row
->y
;
19191 if (row
->y
+ row
->height
> max_y
)
19192 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19196 row
->pixel_width
= row
->used
[TEXT_AREA
];
19197 if (row
->continued_p
)
19198 row
->pixel_width
-= it
->continuation_pixel_width
;
19199 else if (row
->truncated_on_right_p
)
19200 row
->pixel_width
-= it
->truncation_pixel_width
;
19201 row
->ascent
= row
->phys_ascent
= 0;
19202 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19203 row
->extra_line_spacing
= 0;
19206 /* Compute a hash code for this row. */
19207 row
->hash
= row_hash (row
);
19209 it
->max_ascent
= it
->max_descent
= 0;
19210 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19214 /* Append one space to the glyph row of iterator IT if doing a
19215 window-based redisplay. The space has the same face as
19216 IT->face_id. Value is non-zero if a space was added.
19218 This function is called to make sure that there is always one glyph
19219 at the end of a glyph row that the cursor can be set on under
19220 window-systems. (If there weren't such a glyph we would not know
19221 how wide and tall a box cursor should be displayed).
19223 At the same time this space let's a nicely handle clearing to the
19224 end of the line if the row ends in italic text. */
19227 append_space_for_newline (struct it
*it
, int default_face_p
)
19229 if (FRAME_WINDOW_P (it
->f
))
19231 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19233 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19234 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19236 /* Save some values that must not be changed.
19237 Must save IT->c and IT->len because otherwise
19238 ITERATOR_AT_END_P wouldn't work anymore after
19239 append_space_for_newline has been called. */
19240 enum display_element_type saved_what
= it
->what
;
19241 int saved_c
= it
->c
, saved_len
= it
->len
;
19242 int saved_char_to_display
= it
->char_to_display
;
19243 int saved_x
= it
->current_x
;
19244 int saved_face_id
= it
->face_id
;
19245 int saved_box_end
= it
->end_of_box_run_p
;
19246 struct text_pos saved_pos
;
19247 Lisp_Object saved_object
;
19250 saved_object
= it
->object
;
19251 saved_pos
= it
->position
;
19253 it
->what
= IT_CHARACTER
;
19254 memset (&it
->position
, 0, sizeof it
->position
);
19255 it
->object
= make_number (0);
19256 it
->c
= it
->char_to_display
= ' ';
19259 /* If the default face was remapped, be sure to use the
19260 remapped face for the appended newline. */
19261 if (default_face_p
)
19262 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19263 else if (it
->face_before_selective_p
)
19264 it
->face_id
= it
->saved_face_id
;
19265 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19266 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19267 /* In R2L rows, we will prepend a stretch glyph that will
19268 have the end_of_box_run_p flag set for it, so there's no
19269 need for the appended newline glyph to have that flag
19271 if (it
->glyph_row
->reversed_p
19272 /* But if the appended newline glyph goes all the way to
19273 the end of the row, there will be no stretch glyph,
19274 so leave the box flag set. */
19275 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19276 it
->end_of_box_run_p
= 0;
19278 PRODUCE_GLYPHS (it
);
19280 it
->override_ascent
= -1;
19281 it
->constrain_row_ascent_descent_p
= 0;
19282 it
->current_x
= saved_x
;
19283 it
->object
= saved_object
;
19284 it
->position
= saved_pos
;
19285 it
->what
= saved_what
;
19286 it
->face_id
= saved_face_id
;
19287 it
->len
= saved_len
;
19289 it
->char_to_display
= saved_char_to_display
;
19290 it
->end_of_box_run_p
= saved_box_end
;
19299 /* Extend the face of the last glyph in the text area of IT->glyph_row
19300 to the end of the display line. Called from display_line. If the
19301 glyph row is empty, add a space glyph to it so that we know the
19302 face to draw. Set the glyph row flag fill_line_p. If the glyph
19303 row is R2L, prepend a stretch glyph to cover the empty space to the
19304 left of the leftmost glyph. */
19307 extend_face_to_end_of_line (struct it
*it
)
19309 struct face
*face
, *default_face
;
19310 struct frame
*f
= it
->f
;
19312 /* If line is already filled, do nothing. Non window-system frames
19313 get a grace of one more ``pixel'' because their characters are
19314 1-``pixel'' wide, so they hit the equality too early. This grace
19315 is needed only for R2L rows that are not continued, to produce
19316 one extra blank where we could display the cursor. */
19317 if ((it
->current_x
>= it
->last_visible_x
19318 + (!FRAME_WINDOW_P (f
)
19319 && it
->glyph_row
->reversed_p
19320 && !it
->glyph_row
->continued_p
))
19321 /* If the window has display margins, we will need to extend
19322 their face even if the text area is filled. */
19323 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19324 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19327 /* The default face, possibly remapped. */
19328 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19330 /* Face extension extends the background and box of IT->face_id
19331 to the end of the line. If the background equals the background
19332 of the frame, we don't have to do anything. */
19333 if (it
->face_before_selective_p
)
19334 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19336 face
= FACE_FROM_ID (f
, it
->face_id
);
19338 if (FRAME_WINDOW_P (f
)
19339 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19340 && face
->box
== FACE_NO_BOX
19341 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19342 #ifdef HAVE_WINDOW_SYSTEM
19345 && !it
->glyph_row
->reversed_p
)
19348 /* Set the glyph row flag indicating that the face of the last glyph
19349 in the text area has to be drawn to the end of the text area. */
19350 it
->glyph_row
->fill_line_p
= 1;
19352 /* If current character of IT is not ASCII, make sure we have the
19353 ASCII face. This will be automatically undone the next time
19354 get_next_display_element returns a multibyte character. Note
19355 that the character will always be single byte in unibyte
19357 if (!ASCII_CHAR_P (it
->c
))
19359 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19362 if (FRAME_WINDOW_P (f
))
19364 /* If the row is empty, add a space with the current face of IT,
19365 so that we know which face to draw. */
19366 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19368 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19369 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19370 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19372 /* Mode line and the header line don't have margins, and
19373 likewise the frame's tool-bar window, if there is any. */
19374 if (!(it
->glyph_row
->mode_line_p
19375 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19376 || (WINDOWP (f
->tool_bar_window
)
19377 && it
->w
== XWINDOW (f
->tool_bar_window
))
19381 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19382 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19384 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19385 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19387 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19389 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19390 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19392 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19393 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19395 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19398 #ifdef HAVE_WINDOW_SYSTEM
19399 if (it
->glyph_row
->reversed_p
)
19401 /* Prepend a stretch glyph to the row, such that the
19402 rightmost glyph will be drawn flushed all the way to the
19403 right margin of the window. The stretch glyph that will
19404 occupy the empty space, if any, to the left of the
19406 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19407 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19408 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19410 int row_width
, stretch_ascent
, stretch_width
;
19411 struct text_pos saved_pos
;
19412 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
19414 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19415 row_width
+= g
->pixel_width
;
19417 /* FIXME: There are various minor display glitches in R2L
19418 rows when only one of the fringes is missing. The
19419 strange condition below produces the least bad effect. */
19420 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19421 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19422 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19423 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19425 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19426 stretch_width
-= row_width
;
19428 if (stretch_width
> 0)
19431 (((it
->ascent
+ it
->descent
)
19432 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19433 saved_pos
= it
->position
;
19434 memset (&it
->position
, 0, sizeof it
->position
);
19435 saved_avoid_cursor
= it
->avoid_cursor_p
;
19436 it
->avoid_cursor_p
= 1;
19437 saved_face_id
= it
->face_id
;
19438 saved_box_start
= it
->start_of_box_run_p
;
19439 /* The last row's stretch glyph should get the default
19440 face, to avoid painting the rest of the window with
19441 the region face, if the region ends at ZV. */
19442 if (it
->glyph_row
->ends_at_zv_p
)
19443 it
->face_id
= default_face
->id
;
19445 it
->face_id
= face
->id
;
19446 it
->start_of_box_run_p
= 0;
19447 append_stretch_glyph (it
, make_number (0), stretch_width
,
19448 it
->ascent
+ it
->descent
, stretch_ascent
);
19449 it
->position
= saved_pos
;
19450 it
->avoid_cursor_p
= saved_avoid_cursor
;
19451 it
->face_id
= saved_face_id
;
19452 it
->start_of_box_run_p
= saved_box_start
;
19454 /* If stretch_width comes out negative, it means that the
19455 last glyph is only partially visible. In R2L rows, we
19456 want the leftmost glyph to be partially visible, so we
19457 need to give the row the corresponding left offset. */
19458 if (stretch_width
< 0)
19459 it
->glyph_row
->x
= stretch_width
;
19461 #endif /* HAVE_WINDOW_SYSTEM */
19465 /* Save some values that must not be changed. */
19466 int saved_x
= it
->current_x
;
19467 struct text_pos saved_pos
;
19468 Lisp_Object saved_object
;
19469 enum display_element_type saved_what
= it
->what
;
19470 int saved_face_id
= it
->face_id
;
19472 saved_object
= it
->object
;
19473 saved_pos
= it
->position
;
19475 it
->what
= IT_CHARACTER
;
19476 memset (&it
->position
, 0, sizeof it
->position
);
19477 it
->object
= make_number (0);
19478 it
->c
= it
->char_to_display
= ' ';
19481 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19482 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19483 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19484 && !it
->glyph_row
->mode_line_p
19485 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19487 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19488 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19490 for (it
->current_x
= 0; g
< e
; g
++)
19491 it
->current_x
+= g
->pixel_width
;
19493 it
->area
= LEFT_MARGIN_AREA
;
19494 it
->face_id
= default_face
->id
;
19495 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19496 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19498 PRODUCE_GLYPHS (it
);
19499 /* term.c:produce_glyphs advances it->current_x only for
19501 it
->current_x
+= it
->pixel_width
;
19504 it
->current_x
= saved_x
;
19505 it
->area
= TEXT_AREA
;
19508 /* The last row's blank glyphs should get the default face, to
19509 avoid painting the rest of the window with the region face,
19510 if the region ends at ZV. */
19511 if (it
->glyph_row
->ends_at_zv_p
)
19512 it
->face_id
= default_face
->id
;
19514 it
->face_id
= face
->id
;
19515 PRODUCE_GLYPHS (it
);
19517 while (it
->current_x
<= it
->last_visible_x
)
19518 PRODUCE_GLYPHS (it
);
19520 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19521 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19522 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19523 && !it
->glyph_row
->mode_line_p
19524 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19526 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19527 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19529 for ( ; g
< e
; g
++)
19530 it
->current_x
+= g
->pixel_width
;
19532 it
->area
= RIGHT_MARGIN_AREA
;
19533 it
->face_id
= default_face
->id
;
19534 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19535 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19537 PRODUCE_GLYPHS (it
);
19538 it
->current_x
+= it
->pixel_width
;
19541 it
->area
= TEXT_AREA
;
19544 /* Don't count these blanks really. It would let us insert a left
19545 truncation glyph below and make us set the cursor on them, maybe. */
19546 it
->current_x
= saved_x
;
19547 it
->object
= saved_object
;
19548 it
->position
= saved_pos
;
19549 it
->what
= saved_what
;
19550 it
->face_id
= saved_face_id
;
19555 /* Value is non-zero if text starting at CHARPOS in current_buffer is
19556 trailing whitespace. */
19559 trailing_whitespace_p (ptrdiff_t charpos
)
19561 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19564 while (bytepos
< ZV_BYTE
19565 && (c
= FETCH_CHAR (bytepos
),
19566 c
== ' ' || c
== '\t'))
19569 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19571 if (bytepos
!= PT_BYTE
)
19578 /* Highlight trailing whitespace, if any, in ROW. */
19581 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19583 int used
= row
->used
[TEXT_AREA
];
19587 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19588 struct glyph
*glyph
= start
+ used
- 1;
19590 if (row
->reversed_p
)
19592 /* Right-to-left rows need to be processed in the opposite
19593 direction, so swap the edge pointers. */
19595 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19598 /* Skip over glyphs inserted to display the cursor at the
19599 end of a line, for extending the face of the last glyph
19600 to the end of the line on terminals, and for truncation
19601 and continuation glyphs. */
19602 if (!row
->reversed_p
)
19604 while (glyph
>= start
19605 && glyph
->type
== CHAR_GLYPH
19606 && INTEGERP (glyph
->object
))
19611 while (glyph
<= start
19612 && glyph
->type
== CHAR_GLYPH
19613 && INTEGERP (glyph
->object
))
19617 /* If last glyph is a space or stretch, and it's trailing
19618 whitespace, set the face of all trailing whitespace glyphs in
19619 IT->glyph_row to `trailing-whitespace'. */
19620 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19621 && BUFFERP (glyph
->object
)
19622 && (glyph
->type
== STRETCH_GLYPH
19623 || (glyph
->type
== CHAR_GLYPH
19624 && glyph
->u
.ch
== ' '))
19625 && trailing_whitespace_p (glyph
->charpos
))
19627 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
19631 if (!row
->reversed_p
)
19633 while (glyph
>= start
19634 && BUFFERP (glyph
->object
)
19635 && (glyph
->type
== STRETCH_GLYPH
19636 || (glyph
->type
== CHAR_GLYPH
19637 && glyph
->u
.ch
== ' ')))
19638 (glyph
--)->face_id
= face_id
;
19642 while (glyph
<= start
19643 && BUFFERP (glyph
->object
)
19644 && (glyph
->type
== STRETCH_GLYPH
19645 || (glyph
->type
== CHAR_GLYPH
19646 && glyph
->u
.ch
== ' ')))
19647 (glyph
++)->face_id
= face_id
;
19654 /* Value is non-zero if glyph row ROW should be
19655 considered to hold the buffer position CHARPOS. */
19658 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19662 if (charpos
== CHARPOS (row
->end
.pos
)
19663 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19665 /* Suppose the row ends on a string.
19666 Unless the row is continued, that means it ends on a newline
19667 in the string. If it's anything other than a display string
19668 (e.g., a before-string from an overlay), we don't want the
19669 cursor there. (This heuristic seems to give the optimal
19670 behavior for the various types of multi-line strings.)
19671 One exception: if the string has `cursor' property on one of
19672 its characters, we _do_ want the cursor there. */
19673 if (CHARPOS (row
->end
.string_pos
) >= 0)
19675 if (row
->continued_p
)
19679 /* Check for `display' property. */
19680 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19681 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19682 struct glyph
*glyph
;
19685 for (glyph
= end
; glyph
>= beg
; --glyph
)
19686 if (STRINGP (glyph
->object
))
19689 = Fget_char_property (make_number (charpos
),
19693 && display_prop_string_p (prop
, glyph
->object
));
19694 /* If there's a `cursor' property on one of the
19695 string's characters, this row is a cursor row,
19696 even though this is not a display string. */
19699 Lisp_Object s
= glyph
->object
;
19701 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19703 ptrdiff_t gpos
= glyph
->charpos
;
19705 if (!NILP (Fget_char_property (make_number (gpos
),
19717 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19719 /* If the row ends in middle of a real character,
19720 and the line is continued, we want the cursor here.
19721 That's because CHARPOS (ROW->end.pos) would equal
19722 PT if PT is before the character. */
19723 if (!row
->ends_in_ellipsis_p
)
19724 result
= row
->continued_p
;
19726 /* If the row ends in an ellipsis, then
19727 CHARPOS (ROW->end.pos) will equal point after the
19728 invisible text. We want that position to be displayed
19729 after the ellipsis. */
19732 /* If the row ends at ZV, display the cursor at the end of that
19733 row instead of at the start of the row below. */
19734 else if (row
->ends_at_zv_p
)
19743 /* Value is non-zero if glyph row ROW should be
19744 used to hold the cursor. */
19747 cursor_row_p (struct glyph_row
*row
)
19749 return row_for_charpos_p (row
, PT
);
19754 /* Push the property PROP so that it will be rendered at the current
19755 position in IT. Return 1 if PROP was successfully pushed, 0
19756 otherwise. Called from handle_line_prefix to handle the
19757 `line-prefix' and `wrap-prefix' properties. */
19760 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19762 struct text_pos pos
=
19763 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19765 eassert (it
->method
== GET_FROM_BUFFER
19766 || it
->method
== GET_FROM_DISPLAY_VECTOR
19767 || it
->method
== GET_FROM_STRING
);
19769 /* We need to save the current buffer/string position, so it will be
19770 restored by pop_it, because iterate_out_of_display_property
19771 depends on that being set correctly, but some situations leave
19772 it->position not yet set when this function is called. */
19773 push_it (it
, &pos
);
19775 if (STRINGP (prop
))
19777 if (SCHARS (prop
) == 0)
19784 it
->string_from_prefix_prop_p
= 1;
19785 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19786 it
->current
.overlay_string_index
= -1;
19787 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19788 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19789 it
->method
= GET_FROM_STRING
;
19790 it
->stop_charpos
= 0;
19792 it
->base_level_stop
= 0;
19794 /* Force paragraph direction to be that of the parent
19796 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19797 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19799 it
->paragraph_embedding
= L2R
;
19801 /* Set up the bidi iterator for this display string. */
19804 it
->bidi_it
.string
.lstring
= it
->string
;
19805 it
->bidi_it
.string
.s
= NULL
;
19806 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19807 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19808 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19809 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19810 it
->bidi_it
.w
= it
->w
;
19811 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19814 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19816 it
->method
= GET_FROM_STRETCH
;
19819 #ifdef HAVE_WINDOW_SYSTEM
19820 else if (IMAGEP (prop
))
19822 it
->what
= IT_IMAGE
;
19823 it
->image_id
= lookup_image (it
->f
, prop
);
19824 it
->method
= GET_FROM_IMAGE
;
19826 #endif /* HAVE_WINDOW_SYSTEM */
19829 pop_it (it
); /* bogus display property, give up */
19836 /* Return the character-property PROP at the current position in IT. */
19839 get_it_property (struct it
*it
, Lisp_Object prop
)
19841 Lisp_Object position
, object
= it
->object
;
19843 if (STRINGP (object
))
19844 position
= make_number (IT_STRING_CHARPOS (*it
));
19845 else if (BUFFERP (object
))
19847 position
= make_number (IT_CHARPOS (*it
));
19848 object
= it
->window
;
19853 return Fget_char_property (position
, prop
, object
);
19856 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19859 handle_line_prefix (struct it
*it
)
19861 Lisp_Object prefix
;
19863 if (it
->continuation_lines_width
> 0)
19865 prefix
= get_it_property (it
, Qwrap_prefix
);
19867 prefix
= Vwrap_prefix
;
19871 prefix
= get_it_property (it
, Qline_prefix
);
19873 prefix
= Vline_prefix
;
19875 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19877 /* If the prefix is wider than the window, and we try to wrap
19878 it, it would acquire its own wrap prefix, and so on till the
19879 iterator stack overflows. So, don't wrap the prefix. */
19880 it
->line_wrap
= TRUNCATE
;
19881 it
->avoid_cursor_p
= 1;
19887 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19888 only for R2L lines from display_line and display_string, when they
19889 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19890 the line/string needs to be continued on the next glyph row. */
19892 unproduce_glyphs (struct it
*it
, int n
)
19894 struct glyph
*glyph
, *end
;
19896 eassert (it
->glyph_row
);
19897 eassert (it
->glyph_row
->reversed_p
);
19898 eassert (it
->area
== TEXT_AREA
);
19899 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19901 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19902 n
= it
->glyph_row
->used
[TEXT_AREA
];
19903 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19904 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19905 for ( ; glyph
< end
; glyph
++)
19906 glyph
[-n
] = *glyph
;
19909 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19910 and ROW->maxpos. */
19912 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19913 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19914 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19916 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19917 lines' rows is implemented for bidi-reordered rows. */
19919 /* ROW->minpos is the value of min_pos, the minimal buffer position
19920 we have in ROW, or ROW->start.pos if that is smaller. */
19921 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19922 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19924 /* We didn't find buffer positions smaller than ROW->start, or
19925 didn't find _any_ valid buffer positions in any of the glyphs,
19926 so we must trust the iterator's computed positions. */
19927 row
->minpos
= row
->start
.pos
;
19930 max_pos
= CHARPOS (it
->current
.pos
);
19931 max_bpos
= BYTEPOS (it
->current
.pos
);
19934 /* Here are the various use-cases for ending the row, and the
19935 corresponding values for ROW->maxpos:
19937 Line ends in a newline from buffer eol_pos + 1
19938 Line is continued from buffer max_pos + 1
19939 Line is truncated on right it->current.pos
19940 Line ends in a newline from string max_pos + 1(*)
19941 (*) + 1 only when line ends in a forward scan
19942 Line is continued from string max_pos
19943 Line is continued from display vector max_pos
19944 Line is entirely from a string min_pos == max_pos
19945 Line is entirely from a display vector min_pos == max_pos
19946 Line that ends at ZV ZV
19948 If you discover other use-cases, please add them here as
19950 if (row
->ends_at_zv_p
)
19951 row
->maxpos
= it
->current
.pos
;
19952 else if (row
->used
[TEXT_AREA
])
19954 int seen_this_string
= 0;
19955 struct glyph_row
*r1
= row
- 1;
19957 /* Did we see the same display string on the previous row? */
19958 if (STRINGP (it
->object
)
19959 /* this is not the first row */
19960 && row
> it
->w
->desired_matrix
->rows
19961 /* previous row is not the header line */
19962 && !r1
->mode_line_p
19963 /* previous row also ends in a newline from a string */
19964 && r1
->ends_in_newline_from_string_p
)
19966 struct glyph
*start
, *end
;
19968 /* Search for the last glyph of the previous row that came
19969 from buffer or string. Depending on whether the row is
19970 L2R or R2L, we need to process it front to back or the
19971 other way round. */
19972 if (!r1
->reversed_p
)
19974 start
= r1
->glyphs
[TEXT_AREA
];
19975 end
= start
+ r1
->used
[TEXT_AREA
];
19976 /* Glyphs inserted by redisplay have an integer (zero)
19977 as their object. */
19979 && INTEGERP ((end
- 1)->object
)
19980 && (end
- 1)->charpos
<= 0)
19984 if (EQ ((end
- 1)->object
, it
->object
))
19985 seen_this_string
= 1;
19988 /* If all the glyphs of the previous row were inserted
19989 by redisplay, it means the previous row was
19990 produced from a single newline, which is only
19991 possible if that newline came from the same string
19992 as the one which produced this ROW. */
19993 seen_this_string
= 1;
19997 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19998 start
= end
+ r1
->used
[TEXT_AREA
];
20000 && INTEGERP ((end
+ 1)->object
)
20001 && (end
+ 1)->charpos
<= 0)
20005 if (EQ ((end
+ 1)->object
, it
->object
))
20006 seen_this_string
= 1;
20009 seen_this_string
= 1;
20012 /* Take note of each display string that covers a newline only
20013 once, the first time we see it. This is for when a display
20014 string includes more than one newline in it. */
20015 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20017 /* If we were scanning the buffer forward when we displayed
20018 the string, we want to account for at least one buffer
20019 position that belongs to this row (position covered by
20020 the display string), so that cursor positioning will
20021 consider this row as a candidate when point is at the end
20022 of the visual line represented by this row. This is not
20023 required when scanning back, because max_pos will already
20024 have a much larger value. */
20025 if (CHARPOS (row
->end
.pos
) > max_pos
)
20026 INC_BOTH (max_pos
, max_bpos
);
20027 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20029 else if (CHARPOS (it
->eol_pos
) > 0)
20030 SET_TEXT_POS (row
->maxpos
,
20031 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20032 else if (row
->continued_p
)
20034 /* If max_pos is different from IT's current position, it
20035 means IT->method does not belong to the display element
20036 at max_pos. However, it also means that the display
20037 element at max_pos was displayed in its entirety on this
20038 line, which is equivalent to saying that the next line
20039 starts at the next buffer position. */
20040 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20041 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20044 INC_BOTH (max_pos
, max_bpos
);
20045 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20048 else if (row
->truncated_on_right_p
)
20049 /* display_line already called reseat_at_next_visible_line_start,
20050 which puts the iterator at the beginning of the next line, in
20051 the logical order. */
20052 row
->maxpos
= it
->current
.pos
;
20053 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20054 /* A line that is entirely from a string/image/stretch... */
20055 row
->maxpos
= row
->minpos
;
20060 row
->maxpos
= it
->current
.pos
;
20063 /* Construct the glyph row IT->glyph_row in the desired matrix of
20064 IT->w from text at the current position of IT. See dispextern.h
20065 for an overview of struct it. Value is non-zero if
20066 IT->glyph_row displays text, as opposed to a line displaying ZV
20070 display_line (struct it
*it
)
20072 struct glyph_row
*row
= it
->glyph_row
;
20073 Lisp_Object overlay_arrow_string
;
20075 void *wrap_data
= NULL
;
20076 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
20077 int wrap_row_used
= -1;
20078 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20079 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20080 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20081 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20082 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20084 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20085 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20086 bool pending_handle_line_prefix
= false;
20088 /* We always start displaying at hpos zero even if hscrolled. */
20089 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20091 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20092 >= it
->w
->desired_matrix
->nrows
)
20094 it
->w
->nrows_scale_factor
++;
20095 it
->f
->fonts_changed
= 1;
20099 /* Clear the result glyph row and enable it. */
20100 prepare_desired_row (it
->w
, row
, false);
20102 row
->y
= it
->current_y
;
20103 row
->start
= it
->start
;
20104 row
->continuation_lines_width
= it
->continuation_lines_width
;
20105 row
->displays_text_p
= 1;
20106 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20107 it
->starts_in_middle_of_char_p
= 0;
20109 /* Arrange the overlays nicely for our purposes. Usually, we call
20110 display_line on only one line at a time, in which case this
20111 can't really hurt too much, or we call it on lines which appear
20112 one after another in the buffer, in which case all calls to
20113 recenter_overlay_lists but the first will be pretty cheap. */
20114 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20116 /* Move over display elements that are not visible because we are
20117 hscrolled. This may stop at an x-position < IT->first_visible_x
20118 if the first glyph is partially visible or if we hit a line end. */
20119 if (it
->current_x
< it
->first_visible_x
)
20121 enum move_it_result move_result
;
20123 this_line_min_pos
= row
->start
.pos
;
20124 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20125 MOVE_TO_POS
| MOVE_TO_X
);
20126 /* If we are under a large hscroll, move_it_in_display_line_to
20127 could hit the end of the line without reaching
20128 it->first_visible_x. Pretend that we did reach it. This is
20129 especially important on a TTY, where we will call
20130 extend_face_to_end_of_line, which needs to know how many
20131 blank glyphs to produce. */
20132 if (it
->current_x
< it
->first_visible_x
20133 && (move_result
== MOVE_NEWLINE_OR_CR
20134 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20135 it
->current_x
= it
->first_visible_x
;
20137 /* Record the smallest positions seen while we moved over
20138 display elements that are not visible. This is needed by
20139 redisplay_internal for optimizing the case where the cursor
20140 stays inside the same line. The rest of this function only
20141 considers positions that are actually displayed, so
20142 RECORD_MAX_MIN_POS will not otherwise record positions that
20143 are hscrolled to the left of the left edge of the window. */
20144 min_pos
= CHARPOS (this_line_min_pos
);
20145 min_bpos
= BYTEPOS (this_line_min_pos
);
20147 else if (it
->area
== TEXT_AREA
)
20149 /* We only do this when not calling move_it_in_display_line_to
20150 above, because that function calls itself handle_line_prefix. */
20151 handle_line_prefix (it
);
20155 /* Line-prefix and wrap-prefix are always displayed in the text
20156 area. But if this is the first call to display_line after
20157 init_iterator, the iterator might have been set up to write
20158 into a marginal area, e.g. if the line begins with some
20159 display property that writes to the margins. So we need to
20160 wait with the call to handle_line_prefix until whatever
20161 writes to the margin has done its job. */
20162 pending_handle_line_prefix
= true;
20165 /* Get the initial row height. This is either the height of the
20166 text hscrolled, if there is any, or zero. */
20167 row
->ascent
= it
->max_ascent
;
20168 row
->height
= it
->max_ascent
+ it
->max_descent
;
20169 row
->phys_ascent
= it
->max_phys_ascent
;
20170 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20171 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20173 /* Utility macro to record max and min buffer positions seen until now. */
20174 #define RECORD_MAX_MIN_POS(IT) \
20177 int composition_p = !STRINGP ((IT)->string) \
20178 && ((IT)->what == IT_COMPOSITION); \
20179 ptrdiff_t current_pos = \
20180 composition_p ? (IT)->cmp_it.charpos \
20181 : IT_CHARPOS (*(IT)); \
20182 ptrdiff_t current_bpos = \
20183 composition_p ? CHAR_TO_BYTE (current_pos) \
20184 : IT_BYTEPOS (*(IT)); \
20185 if (current_pos < min_pos) \
20187 min_pos = current_pos; \
20188 min_bpos = current_bpos; \
20190 if (IT_CHARPOS (*it) > max_pos) \
20192 max_pos = IT_CHARPOS (*it); \
20193 max_bpos = IT_BYTEPOS (*it); \
20198 /* Loop generating characters. The loop is left with IT on the next
20199 character to display. */
20202 int n_glyphs_before
, hpos_before
, x_before
;
20204 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20206 /* Retrieve the next thing to display. Value is zero if end of
20208 if (!get_next_display_element (it
))
20210 /* Maybe add a space at the end of this line that is used to
20211 display the cursor there under X. Set the charpos of the
20212 first glyph of blank lines not corresponding to any text
20214 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20215 row
->exact_window_width_line_p
= 1;
20216 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
20217 || row
->used
[TEXT_AREA
] == 0)
20219 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20220 row
->displays_text_p
= 0;
20222 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20223 && (!MINI_WINDOW_P (it
->w
)
20224 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20225 row
->indicate_empty_line_p
= 1;
20228 it
->continuation_lines_width
= 0;
20229 row
->ends_at_zv_p
= 1;
20230 /* A row that displays right-to-left text must always have
20231 its last face extended all the way to the end of line,
20232 even if this row ends in ZV, because we still write to
20233 the screen left to right. We also need to extend the
20234 last face if the default face is remapped to some
20235 different face, otherwise the functions that clear
20236 portions of the screen will clear with the default face's
20237 background color. */
20238 if (row
->reversed_p
20239 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20240 extend_face_to_end_of_line (it
);
20244 /* Now, get the metrics of what we want to display. This also
20245 generates glyphs in `row' (which is IT->glyph_row). */
20246 n_glyphs_before
= row
->used
[TEXT_AREA
];
20249 /* Remember the line height so far in case the next element doesn't
20250 fit on the line. */
20251 if (it
->line_wrap
!= TRUNCATE
)
20253 ascent
= it
->max_ascent
;
20254 descent
= it
->max_descent
;
20255 phys_ascent
= it
->max_phys_ascent
;
20256 phys_descent
= it
->max_phys_descent
;
20258 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20260 if (IT_DISPLAYING_WHITESPACE (it
))
20264 SAVE_IT (wrap_it
, *it
, wrap_data
);
20266 wrap_row_used
= row
->used
[TEXT_AREA
];
20267 wrap_row_ascent
= row
->ascent
;
20268 wrap_row_height
= row
->height
;
20269 wrap_row_phys_ascent
= row
->phys_ascent
;
20270 wrap_row_phys_height
= row
->phys_height
;
20271 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20272 wrap_row_min_pos
= min_pos
;
20273 wrap_row_min_bpos
= min_bpos
;
20274 wrap_row_max_pos
= max_pos
;
20275 wrap_row_max_bpos
= max_bpos
;
20281 PRODUCE_GLYPHS (it
);
20283 /* If this display element was in marginal areas, continue with
20285 if (it
->area
!= TEXT_AREA
)
20287 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20288 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20289 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20290 row
->phys_height
= max (row
->phys_height
,
20291 it
->max_phys_ascent
+ it
->max_phys_descent
);
20292 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20293 it
->max_extra_line_spacing
);
20294 set_iterator_to_next (it
, 1);
20295 /* If we didn't handle the line/wrap prefix above, and the
20296 call to set_iterator_to_next just switched to TEXT_AREA,
20297 process the prefix now. */
20298 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20300 pending_handle_line_prefix
= false;
20301 handle_line_prefix (it
);
20306 /* Does the display element fit on the line? If we truncate
20307 lines, we should draw past the right edge of the window. If
20308 we don't truncate, we want to stop so that we can display the
20309 continuation glyph before the right margin. If lines are
20310 continued, there are two possible strategies for characters
20311 resulting in more than 1 glyph (e.g. tabs): Display as many
20312 glyphs as possible in this line and leave the rest for the
20313 continuation line, or display the whole element in the next
20314 line. Original redisplay did the former, so we do it also. */
20315 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20316 hpos_before
= it
->hpos
;
20319 if (/* Not a newline. */
20321 /* Glyphs produced fit entirely in the line. */
20322 && it
->current_x
< it
->last_visible_x
)
20324 it
->hpos
+= nglyphs
;
20325 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20326 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20327 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20328 row
->phys_height
= max (row
->phys_height
,
20329 it
->max_phys_ascent
+ it
->max_phys_descent
);
20330 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20331 it
->max_extra_line_spacing
);
20332 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20333 /* In R2L rows, we arrange in extend_face_to_end_of_line
20334 to add a right offset to the line, by a suitable
20335 change to the stretch glyph that is the leftmost
20336 glyph of the line. */
20337 && !row
->reversed_p
)
20338 row
->x
= x
- it
->first_visible_x
;
20339 /* Record the maximum and minimum buffer positions seen so
20340 far in glyphs that will be displayed by this row. */
20342 RECORD_MAX_MIN_POS (it
);
20347 struct glyph
*glyph
;
20349 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20351 /* Identify the glyphs added by the last call to
20352 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20353 the previous glyphs. */
20354 if (!row
->reversed_p
)
20355 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20357 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20358 new_x
= x
+ glyph
->pixel_width
;
20360 if (/* Lines are continued. */
20361 it
->line_wrap
!= TRUNCATE
20362 && (/* Glyph doesn't fit on the line. */
20363 new_x
> it
->last_visible_x
20364 /* Or it fits exactly on a window system frame. */
20365 || (new_x
== it
->last_visible_x
20366 && FRAME_WINDOW_P (it
->f
)
20367 && (row
->reversed_p
20368 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20369 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20371 /* End of a continued line. */
20374 || (new_x
== it
->last_visible_x
20375 && FRAME_WINDOW_P (it
->f
)
20376 && (row
->reversed_p
20377 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20378 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20380 /* Current glyph is the only one on the line or
20381 fits exactly on the line. We must continue
20382 the line because we can't draw the cursor
20383 after the glyph. */
20384 row
->continued_p
= 1;
20385 it
->current_x
= new_x
;
20386 it
->continuation_lines_width
+= new_x
;
20388 if (i
== nglyphs
- 1)
20390 /* If line-wrap is on, check if a previous
20391 wrap point was found. */
20392 if (wrap_row_used
> 0
20393 /* Even if there is a previous wrap
20394 point, continue the line here as
20395 usual, if (i) the previous character
20396 was a space or tab AND (ii) the
20397 current character is not. */
20399 || IT_DISPLAYING_WHITESPACE (it
)))
20402 /* Record the maximum and minimum buffer
20403 positions seen so far in glyphs that will be
20404 displayed by this row. */
20406 RECORD_MAX_MIN_POS (it
);
20407 set_iterator_to_next (it
, 1);
20408 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20410 if (!get_next_display_element (it
))
20412 row
->exact_window_width_line_p
= 1;
20413 it
->continuation_lines_width
= 0;
20414 row
->continued_p
= 0;
20415 row
->ends_at_zv_p
= 1;
20417 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20419 row
->continued_p
= 0;
20420 row
->exact_window_width_line_p
= 1;
20424 else if (it
->bidi_p
)
20425 RECORD_MAX_MIN_POS (it
);
20426 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20427 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20428 extend_face_to_end_of_line (it
);
20430 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20431 && !FRAME_WINDOW_P (it
->f
))
20433 /* A padding glyph that doesn't fit on this line.
20434 This means the whole character doesn't fit
20436 if (row
->reversed_p
)
20437 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20438 - n_glyphs_before
);
20439 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20441 /* Fill the rest of the row with continuation
20442 glyphs like in 20.x. */
20443 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20444 < row
->glyphs
[1 + TEXT_AREA
])
20445 produce_special_glyphs (it
, IT_CONTINUATION
);
20447 row
->continued_p
= 1;
20448 it
->current_x
= x_before
;
20449 it
->continuation_lines_width
+= x_before
;
20451 /* Restore the height to what it was before the
20452 element not fitting on the line. */
20453 it
->max_ascent
= ascent
;
20454 it
->max_descent
= descent
;
20455 it
->max_phys_ascent
= phys_ascent
;
20456 it
->max_phys_descent
= phys_descent
;
20457 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20458 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20459 extend_face_to_end_of_line (it
);
20461 else if (wrap_row_used
> 0)
20464 if (row
->reversed_p
)
20465 unproduce_glyphs (it
,
20466 row
->used
[TEXT_AREA
] - wrap_row_used
);
20467 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20468 it
->continuation_lines_width
+= wrap_x
;
20469 row
->used
[TEXT_AREA
] = wrap_row_used
;
20470 row
->ascent
= wrap_row_ascent
;
20471 row
->height
= wrap_row_height
;
20472 row
->phys_ascent
= wrap_row_phys_ascent
;
20473 row
->phys_height
= wrap_row_phys_height
;
20474 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20475 min_pos
= wrap_row_min_pos
;
20476 min_bpos
= wrap_row_min_bpos
;
20477 max_pos
= wrap_row_max_pos
;
20478 max_bpos
= wrap_row_max_bpos
;
20479 row
->continued_p
= 1;
20480 row
->ends_at_zv_p
= 0;
20481 row
->exact_window_width_line_p
= 0;
20482 it
->continuation_lines_width
+= x
;
20484 /* Make sure that a non-default face is extended
20485 up to the right margin of the window. */
20486 extend_face_to_end_of_line (it
);
20488 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20490 /* A TAB that extends past the right edge of the
20491 window. This produces a single glyph on
20492 window system frames. We leave the glyph in
20493 this row and let it fill the row, but don't
20494 consume the TAB. */
20495 if ((row
->reversed_p
20496 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20497 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20498 produce_special_glyphs (it
, IT_CONTINUATION
);
20499 it
->continuation_lines_width
+= it
->last_visible_x
;
20500 row
->ends_in_middle_of_char_p
= 1;
20501 row
->continued_p
= 1;
20502 glyph
->pixel_width
= it
->last_visible_x
- x
;
20503 it
->starts_in_middle_of_char_p
= 1;
20504 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20505 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20506 extend_face_to_end_of_line (it
);
20510 /* Something other than a TAB that draws past
20511 the right edge of the window. Restore
20512 positions to values before the element. */
20513 if (row
->reversed_p
)
20514 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20515 - (n_glyphs_before
+ i
));
20516 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20518 /* Display continuation glyphs. */
20519 it
->current_x
= x_before
;
20520 it
->continuation_lines_width
+= x
;
20521 if (!FRAME_WINDOW_P (it
->f
)
20522 || (row
->reversed_p
20523 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20524 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20525 produce_special_glyphs (it
, IT_CONTINUATION
);
20526 row
->continued_p
= 1;
20528 extend_face_to_end_of_line (it
);
20530 if (nglyphs
> 1 && i
> 0)
20532 row
->ends_in_middle_of_char_p
= 1;
20533 it
->starts_in_middle_of_char_p
= 1;
20536 /* Restore the height to what it was before the
20537 element not fitting on the line. */
20538 it
->max_ascent
= ascent
;
20539 it
->max_descent
= descent
;
20540 it
->max_phys_ascent
= phys_ascent
;
20541 it
->max_phys_descent
= phys_descent
;
20546 else if (new_x
> it
->first_visible_x
)
20548 /* Increment number of glyphs actually displayed. */
20551 /* Record the maximum and minimum buffer positions
20552 seen so far in glyphs that will be displayed by
20555 RECORD_MAX_MIN_POS (it
);
20557 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20558 /* Glyph is partially visible, i.e. row starts at
20559 negative X position. Don't do that in R2L
20560 rows, where we arrange to add a right offset to
20561 the line in extend_face_to_end_of_line, by a
20562 suitable change to the stretch glyph that is
20563 the leftmost glyph of the line. */
20564 row
->x
= x
- it
->first_visible_x
;
20565 /* When the last glyph of an R2L row only fits
20566 partially on the line, we need to set row->x to a
20567 negative offset, so that the leftmost glyph is
20568 the one that is partially visible. But if we are
20569 going to produce the truncation glyph, this will
20570 be taken care of in produce_special_glyphs. */
20571 if (row
->reversed_p
20572 && new_x
> it
->last_visible_x
20573 && !(it
->line_wrap
== TRUNCATE
20574 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20576 eassert (FRAME_WINDOW_P (it
->f
));
20577 row
->x
= it
->last_visible_x
- new_x
;
20582 /* Glyph is completely off the left margin of the
20583 window. This should not happen because of the
20584 move_it_in_display_line at the start of this
20585 function, unless the text display area of the
20586 window is empty. */
20587 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20590 /* Even if this display element produced no glyphs at all,
20591 we want to record its position. */
20592 if (it
->bidi_p
&& nglyphs
== 0)
20593 RECORD_MAX_MIN_POS (it
);
20595 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20596 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20597 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20598 row
->phys_height
= max (row
->phys_height
,
20599 it
->max_phys_ascent
+ it
->max_phys_descent
);
20600 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20601 it
->max_extra_line_spacing
);
20603 /* End of this display line if row is continued. */
20604 if (row
->continued_p
|| row
->ends_at_zv_p
)
20609 /* Is this a line end? If yes, we're also done, after making
20610 sure that a non-default face is extended up to the right
20611 margin of the window. */
20612 if (ITERATOR_AT_END_OF_LINE_P (it
))
20614 int used_before
= row
->used
[TEXT_AREA
];
20616 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20618 /* Add a space at the end of the line that is used to
20619 display the cursor there. */
20620 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20621 append_space_for_newline (it
, 0);
20623 /* Extend the face to the end of the line. */
20624 extend_face_to_end_of_line (it
);
20626 /* Make sure we have the position. */
20627 if (used_before
== 0)
20628 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20630 /* Record the position of the newline, for use in
20632 it
->eol_pos
= it
->current
.pos
;
20634 /* Consume the line end. This skips over invisible lines. */
20635 set_iterator_to_next (it
, 1);
20636 it
->continuation_lines_width
= 0;
20640 /* Proceed with next display element. Note that this skips
20641 over lines invisible because of selective display. */
20642 set_iterator_to_next (it
, 1);
20644 /* If we truncate lines, we are done when the last displayed
20645 glyphs reach past the right margin of the window. */
20646 if (it
->line_wrap
== TRUNCATE
20647 && ((FRAME_WINDOW_P (it
->f
)
20648 /* Images are preprocessed in produce_image_glyph such
20649 that they are cropped at the right edge of the
20650 window, so an image glyph will always end exactly at
20651 last_visible_x, even if there's no right fringe. */
20652 && ((row
->reversed_p
20653 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20654 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20655 || it
->what
== IT_IMAGE
))
20656 ? (it
->current_x
>= it
->last_visible_x
)
20657 : (it
->current_x
> it
->last_visible_x
)))
20659 /* Maybe add truncation glyphs. */
20660 if (!FRAME_WINDOW_P (it
->f
)
20661 || (row
->reversed_p
20662 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20663 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20667 if (!row
->reversed_p
)
20669 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20670 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20675 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20676 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20678 /* Remove any padding glyphs at the front of ROW, to
20679 make room for the truncation glyphs we will be
20680 adding below. The loop below always inserts at
20681 least one truncation glyph, so also remove the
20682 last glyph added to ROW. */
20683 unproduce_glyphs (it
, i
+ 1);
20684 /* Adjust i for the loop below. */
20685 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20688 /* produce_special_glyphs overwrites the last glyph, so
20689 we don't want that if we want to keep that last
20690 glyph, which means it's an image. */
20691 if (it
->current_x
> it
->last_visible_x
)
20693 it
->current_x
= x_before
;
20694 if (!FRAME_WINDOW_P (it
->f
))
20696 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20698 row
->used
[TEXT_AREA
] = i
;
20699 produce_special_glyphs (it
, IT_TRUNCATION
);
20704 row
->used
[TEXT_AREA
] = i
;
20705 produce_special_glyphs (it
, IT_TRUNCATION
);
20707 it
->hpos
= hpos_before
;
20710 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20712 /* Don't truncate if we can overflow newline into fringe. */
20713 if (!get_next_display_element (it
))
20715 it
->continuation_lines_width
= 0;
20716 row
->ends_at_zv_p
= 1;
20717 row
->exact_window_width_line_p
= 1;
20720 if (ITERATOR_AT_END_OF_LINE_P (it
))
20722 row
->exact_window_width_line_p
= 1;
20723 goto at_end_of_line
;
20725 it
->current_x
= x_before
;
20726 it
->hpos
= hpos_before
;
20729 row
->truncated_on_right_p
= 1;
20730 it
->continuation_lines_width
= 0;
20731 reseat_at_next_visible_line_start (it
, 0);
20732 /* We insist below that IT's position be at ZV because in
20733 bidi-reordered lines the character at visible line start
20734 might not be the character that follows the newline in
20735 the logical order. */
20736 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
20737 row
->ends_at_zv_p
=
20738 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
20740 row
->ends_at_zv_p
= false;
20746 bidi_unshelve_cache (wrap_data
, 1);
20748 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20749 at the left window margin. */
20750 if (it
->first_visible_x
20751 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20753 if (!FRAME_WINDOW_P (it
->f
)
20754 || (((row
->reversed_p
20755 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20756 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20757 /* Don't let insert_left_trunc_glyphs overwrite the
20758 first glyph of the row if it is an image. */
20759 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20760 insert_left_trunc_glyphs (it
);
20761 row
->truncated_on_left_p
= 1;
20764 /* Remember the position at which this line ends.
20766 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20767 cannot be before the call to find_row_edges below, since that is
20768 where these positions are determined. */
20769 row
->end
= it
->current
;
20772 row
->minpos
= row
->start
.pos
;
20773 row
->maxpos
= row
->end
.pos
;
20777 /* ROW->minpos and ROW->maxpos must be the smallest and
20778 `1 + the largest' buffer positions in ROW. But if ROW was
20779 bidi-reordered, these two positions can be anywhere in the
20780 row, so we must determine them now. */
20781 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20784 /* If the start of this line is the overlay arrow-position, then
20785 mark this glyph row as the one containing the overlay arrow.
20786 This is clearly a mess with variable size fonts. It would be
20787 better to let it be displayed like cursors under X. */
20788 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20789 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20790 !NILP (overlay_arrow_string
)))
20792 /* Overlay arrow in window redisplay is a fringe bitmap. */
20793 if (STRINGP (overlay_arrow_string
))
20795 struct glyph_row
*arrow_row
20796 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20797 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20798 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20799 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20800 struct glyph
*p2
, *end
;
20802 /* Copy the arrow glyphs. */
20803 while (glyph
< arrow_end
)
20806 /* Throw away padding glyphs. */
20808 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20809 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20815 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20820 eassert (INTEGERP (overlay_arrow_string
));
20821 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20823 overlay_arrow_seen
= 1;
20826 /* Highlight trailing whitespace. */
20827 if (!NILP (Vshow_trailing_whitespace
))
20828 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20830 /* Compute pixel dimensions of this line. */
20831 compute_line_metrics (it
);
20833 /* Implementation note: No changes in the glyphs of ROW or in their
20834 faces can be done past this point, because compute_line_metrics
20835 computes ROW's hash value and stores it within the glyph_row
20838 /* Record whether this row ends inside an ellipsis. */
20839 row
->ends_in_ellipsis_p
20840 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20841 && it
->ellipsis_p
);
20843 /* Save fringe bitmaps in this row. */
20844 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20845 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20846 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20847 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20849 it
->left_user_fringe_bitmap
= 0;
20850 it
->left_user_fringe_face_id
= 0;
20851 it
->right_user_fringe_bitmap
= 0;
20852 it
->right_user_fringe_face_id
= 0;
20854 /* Maybe set the cursor. */
20855 cvpos
= it
->w
->cursor
.vpos
;
20857 /* In bidi-reordered rows, keep checking for proper cursor
20858 position even if one has been found already, because buffer
20859 positions in such rows change non-linearly with ROW->VPOS,
20860 when a line is continued. One exception: when we are at ZV,
20861 display cursor on the first suitable glyph row, since all
20862 the empty rows after that also have their position set to ZV. */
20863 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20864 lines' rows is implemented for bidi-reordered rows. */
20866 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20867 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20868 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20869 && cursor_row_p (row
))
20870 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20872 /* Prepare for the next line. This line starts horizontally at (X
20873 HPOS) = (0 0). Vertical positions are incremented. As a
20874 convenience for the caller, IT->glyph_row is set to the next
20876 it
->current_x
= it
->hpos
= 0;
20877 it
->current_y
+= row
->height
;
20878 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20881 /* The next row should by default use the same value of the
20882 reversed_p flag as this one. set_iterator_to_next decides when
20883 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20884 the flag accordingly. */
20885 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20886 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20887 it
->start
= row
->end
;
20888 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20890 #undef RECORD_MAX_MIN_POS
20893 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20894 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20895 doc
: /* Return paragraph direction at point in BUFFER.
20896 Value is either `left-to-right' or `right-to-left'.
20897 If BUFFER is omitted or nil, it defaults to the current buffer.
20899 Paragraph direction determines how the text in the paragraph is displayed.
20900 In left-to-right paragraphs, text begins at the left margin of the window
20901 and the reading direction is generally left to right. In right-to-left
20902 paragraphs, text begins at the right margin and is read from right to left.
20904 See also `bidi-paragraph-direction'. */)
20905 (Lisp_Object buffer
)
20907 struct buffer
*buf
= current_buffer
;
20908 struct buffer
*old
= buf
;
20910 if (! NILP (buffer
))
20912 CHECK_BUFFER (buffer
);
20913 buf
= XBUFFER (buffer
);
20916 if (NILP (BVAR (buf
, bidi_display_reordering
))
20917 || NILP (BVAR (buf
, enable_multibyte_characters
))
20918 /* When we are loading loadup.el, the character property tables
20919 needed for bidi iteration are not yet available. */
20920 || !NILP (Vpurify_flag
))
20921 return Qleft_to_right
;
20922 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20923 return BVAR (buf
, bidi_paragraph_direction
);
20926 /* Determine the direction from buffer text. We could try to
20927 use current_matrix if it is up to date, but this seems fast
20928 enough as it is. */
20929 struct bidi_it itb
;
20930 ptrdiff_t pos
= BUF_PT (buf
);
20931 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20933 void *itb_data
= bidi_shelve_cache ();
20935 set_buffer_temp (buf
);
20936 /* bidi_paragraph_init finds the base direction of the paragraph
20937 by searching forward from paragraph start. We need the base
20938 direction of the current or _previous_ paragraph, so we need
20939 to make sure we are within that paragraph. To that end, find
20940 the previous non-empty line. */
20941 if (pos
>= ZV
&& pos
> BEGV
)
20942 DEC_BOTH (pos
, bytepos
);
20943 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20944 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20946 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20947 || c
== ' ' || c
== '\t' || c
== '\f')
20949 if (bytepos
<= BEGV_BYTE
)
20954 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20957 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20958 itb
.paragraph_dir
= NEUTRAL_DIR
;
20959 itb
.string
.s
= NULL
;
20960 itb
.string
.lstring
= Qnil
;
20961 itb
.string
.bufpos
= 0;
20962 itb
.string
.from_disp_str
= 0;
20963 itb
.string
.unibyte
= 0;
20964 /* We have no window to use here for ignoring window-specific
20965 overlays. Using NULL for window pointer will cause
20966 compute_display_string_pos to use the current buffer. */
20968 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20969 bidi_unshelve_cache (itb_data
, 0);
20970 set_buffer_temp (old
);
20971 switch (itb
.paragraph_dir
)
20974 return Qleft_to_right
;
20977 return Qright_to_left
;
20985 DEFUN ("move-point-visually", Fmove_point_visually
,
20986 Smove_point_visually
, 1, 1, 0,
20987 doc
: /* Move point in the visual order in the specified DIRECTION.
20988 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
20991 Value is the new character position of point. */)
20992 (Lisp_Object direction
)
20994 struct window
*w
= XWINDOW (selected_window
);
20995 struct buffer
*b
= XBUFFER (w
->contents
);
20996 struct glyph_row
*row
;
20998 Lisp_Object paragraph_dir
;
21000 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21001 (!(ROW)->continued_p \
21002 && INTEGERP ((GLYPH)->object) \
21003 && (GLYPH)->type == CHAR_GLYPH \
21004 && (GLYPH)->u.ch == ' ' \
21005 && (GLYPH)->charpos >= 0 \
21006 && !(GLYPH)->avoid_cursor_p)
21008 CHECK_NUMBER (direction
);
21009 dir
= XINT (direction
);
21015 /* If current matrix is up-to-date, we can use the information
21016 recorded in the glyphs, at least as long as the goal is on the
21018 if (w
->window_end_valid
21019 && !windows_or_buffers_changed
21021 && !b
->clip_changed
21022 && !b
->prevent_redisplay_optimizations_p
21023 && !window_outdated (w
)
21024 /* We rely below on the cursor coordinates to be up to date, but
21025 we cannot trust them if some command moved point since the
21026 last complete redisplay. */
21027 && w
->last_point
== BUF_PT (b
)
21028 && w
->cursor
.vpos
>= 0
21029 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21030 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21032 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21033 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21034 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21036 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21038 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21040 SET_PT (g
->charpos
);
21041 w
->cursor
.vpos
= -1;
21042 return make_number (PT
);
21044 else if (!INTEGERP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21048 if (BUFFERP (gpt
->object
))
21051 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21052 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21054 new_pos
-= (row
->reversed_p
? -dir
: dir
);;
21056 else if (BUFFERP (g
->object
))
21057 new_pos
= g
->charpos
;
21061 w
->cursor
.vpos
= -1;
21062 return make_number (PT
);
21064 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21066 /* Glyphs inserted at the end of a non-empty line for
21067 positioning the cursor have zero charpos, so we must
21068 deduce the value of point by other means. */
21069 if (g
->charpos
> 0)
21070 SET_PT (g
->charpos
);
21071 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21073 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21074 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21077 w
->cursor
.vpos
= -1;
21078 return make_number (PT
);
21081 if (g
== e
|| INTEGERP (g
->object
))
21083 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21084 goto simulate_display
;
21085 if (!row
->reversed_p
)
21089 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21090 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21091 goto simulate_display
;
21095 if (row
->reversed_p
&& !row
->continued_p
)
21097 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21098 w
->cursor
.vpos
= -1;
21099 return make_number (PT
);
21101 g
= row
->glyphs
[TEXT_AREA
];
21102 e
= g
+ row
->used
[TEXT_AREA
];
21103 for ( ; g
< e
; g
++)
21105 if (BUFFERP (g
->object
)
21106 /* Empty lines have only one glyph, which stands
21107 for the newline, and whose charpos is the
21108 buffer position of the newline. */
21109 || ROW_GLYPH_NEWLINE_P (row
, g
)
21110 /* When the buffer ends in a newline, the line at
21111 EOB also has one glyph, but its charpos is -1. */
21112 || (row
->ends_at_zv_p
21113 && !row
->reversed_p
21114 && INTEGERP (g
->object
)
21115 && g
->type
== CHAR_GLYPH
21116 && g
->u
.ch
== ' '))
21118 if (g
->charpos
> 0)
21119 SET_PT (g
->charpos
);
21120 else if (!row
->reversed_p
21121 && row
->ends_at_zv_p
21126 w
->cursor
.vpos
= -1;
21127 return make_number (PT
);
21133 if (!row
->reversed_p
&& !row
->continued_p
)
21135 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21136 w
->cursor
.vpos
= -1;
21137 return make_number (PT
);
21139 e
= row
->glyphs
[TEXT_AREA
];
21140 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21141 for ( ; g
>= e
; g
--)
21143 if (BUFFERP (g
->object
)
21144 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21146 /* Empty R2L lines on GUI frames have the buffer
21147 position of the newline stored in the stretch
21149 || g
->type
== STRETCH_GLYPH
21150 || (row
->ends_at_zv_p
21152 && INTEGERP (g
->object
)
21153 && g
->type
== CHAR_GLYPH
21154 && g
->u
.ch
== ' '))
21156 if (g
->charpos
> 0)
21157 SET_PT (g
->charpos
);
21158 else if (row
->reversed_p
21159 && row
->ends_at_zv_p
21164 w
->cursor
.vpos
= -1;
21165 return make_number (PT
);
21174 /* If we wind up here, we failed to move by using the glyphs, so we
21175 need to simulate display instead. */
21178 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21180 paragraph_dir
= Qleft_to_right
;
21181 if (EQ (paragraph_dir
, Qright_to_left
))
21183 if (PT
<= BEGV
&& dir
< 0)
21184 xsignal0 (Qbeginning_of_buffer
);
21185 else if (PT
>= ZV
&& dir
> 0)
21186 xsignal0 (Qend_of_buffer
);
21189 struct text_pos pt
;
21191 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21193 bool overshoot_expected
= false;
21194 bool target_is_eol_p
= false;
21196 /* Setup the arena. */
21197 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21198 start_display (&it
, w
, pt
);
21200 if (it
.cmp_it
.id
< 0
21201 && it
.method
== GET_FROM_STRING
21202 && it
.area
== TEXT_AREA
21203 && it
.string_from_display_prop_p
21204 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21205 overshoot_expected
= true;
21207 /* Find the X coordinate of point. We start from the beginning
21208 of this or previous line to make sure we are before point in
21209 the logical order (since the move_it_* functions can only
21212 reseat_at_previous_visible_line_start (&it
);
21213 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21214 if (IT_CHARPOS (it
) != PT
)
21216 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21217 -1, -1, -1, MOVE_TO_POS
);
21218 /* If we missed point because the character there is
21219 displayed out of a display vector that has more than one
21220 glyph, retry expecting overshoot. */
21221 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21222 && it
.current
.dpvec_index
> 0
21223 && !overshoot_expected
)
21225 overshoot_expected
= true;
21228 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21229 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21231 pt_x
= it
.current_x
;
21233 if (dir
> 0 || overshoot_expected
)
21235 struct glyph_row
*row
= it
.glyph_row
;
21237 /* When point is at beginning of line, we don't have
21238 information about the glyph there loaded into struct
21239 it. Calling get_next_display_element fixes that. */
21241 get_next_display_element (&it
);
21242 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21243 it
.glyph_row
= NULL
;
21244 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21245 it
.glyph_row
= row
;
21246 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21247 it, lest it will become out of sync with it's buffer
21249 it
.current_x
= pt_x
;
21252 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21253 pixel_width
= it
.pixel_width
;
21254 if (overshoot_expected
&& at_eol_p
)
21256 else if (pixel_width
<= 0)
21259 /* If there's a display string (or something similar) at point,
21260 we are actually at the glyph to the left of point, so we need
21261 to correct the X coordinate. */
21262 if (overshoot_expected
)
21265 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21267 pt_x
+= pixel_width
;
21270 /* Compute target X coordinate, either to the left or to the
21271 right of point. On TTY frames, all characters have the same
21272 pixel width of 1, so we can use that. On GUI frames we don't
21273 have an easy way of getting at the pixel width of the
21274 character to the left of point, so we use a different method
21275 of getting to that place. */
21277 target_x
= pt_x
+ pixel_width
;
21279 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21281 /* Target X coordinate could be one line above or below the line
21282 of point, in which case we need to adjust the target X
21283 coordinate. Also, if moving to the left, we need to begin at
21284 the left edge of the point's screen line. */
21289 start_display (&it
, w
, pt
);
21290 reseat_at_previous_visible_line_start (&it
);
21291 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21293 move_it_by_lines (&it
, pt_vpos
);
21297 move_it_by_lines (&it
, -1);
21298 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21299 target_is_eol_p
= true;
21300 /* Under word-wrap, we don't know the x coordinate of
21301 the last character displayed on the previous line,
21302 which immediately precedes the wrap point. To find
21303 out its x coordinate, we try moving to the right
21304 margin of the window, which will stop at the wrap
21305 point, and then reset target_x to point at the
21306 character that precedes the wrap point. This is not
21307 needed on GUI frames, because (see below) there we
21308 move from the left margin one grapheme cluster at a
21309 time, and stop when we hit the wrap point. */
21310 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21312 void *it_data
= NULL
;
21315 SAVE_IT (it2
, it
, it_data
);
21316 move_it_in_display_line_to (&it
, ZV
, target_x
,
21317 MOVE_TO_POS
| MOVE_TO_X
);
21318 /* If we arrived at target_x, that _is_ the last
21319 character on the previous line. */
21320 if (it
.current_x
!= target_x
)
21321 target_x
= it
.current_x
- 1;
21322 RESTORE_IT (&it
, &it2
, it_data
);
21329 || (target_x
>= it
.last_visible_x
21330 && it
.line_wrap
!= TRUNCATE
))
21333 move_it_by_lines (&it
, 0);
21334 move_it_by_lines (&it
, 1);
21339 /* Move to the target X coordinate. */
21340 #ifdef HAVE_WINDOW_SYSTEM
21341 /* On GUI frames, as we don't know the X coordinate of the
21342 character to the left of point, moving point to the left
21343 requires walking, one grapheme cluster at a time, until we
21344 find ourself at a place immediately to the left of the
21345 character at point. */
21346 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21348 struct text_pos new_pos
;
21349 enum move_it_result rc
= MOVE_X_REACHED
;
21351 if (it
.current_x
== 0)
21352 get_next_display_element (&it
);
21353 if (it
.what
== IT_COMPOSITION
)
21355 new_pos
.charpos
= it
.cmp_it
.charpos
;
21356 new_pos
.bytepos
= -1;
21359 new_pos
= it
.current
.pos
;
21361 while (it
.current_x
+ it
.pixel_width
<= target_x
21362 && (rc
== MOVE_X_REACHED
21363 /* Under word-wrap, move_it_in_display_line_to
21364 stops at correct coordinates, but sometimes
21365 returns MOVE_POS_MATCH_OR_ZV. */
21366 || (it
.line_wrap
== WORD_WRAP
21367 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21369 int new_x
= it
.current_x
+ it
.pixel_width
;
21371 /* For composed characters, we want the position of the
21372 first character in the grapheme cluster (usually, the
21373 composition's base character), whereas it.current
21374 might give us the position of the _last_ one, e.g. if
21375 the composition is rendered in reverse due to bidi
21377 if (it
.what
== IT_COMPOSITION
)
21379 new_pos
.charpos
= it
.cmp_it
.charpos
;
21380 new_pos
.bytepos
= -1;
21383 new_pos
= it
.current
.pos
;
21384 if (new_x
== it
.current_x
)
21386 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21387 MOVE_TO_POS
| MOVE_TO_X
);
21388 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21391 /* The previous position we saw in the loop is the one we
21393 if (new_pos
.bytepos
== -1)
21394 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21395 it
.current
.pos
= new_pos
;
21399 if (it
.current_x
!= target_x
)
21400 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21402 /* When lines are truncated, the above loop will stop at the
21403 window edge. But we want to get to the end of line, even if
21404 it is beyond the window edge; automatic hscroll will then
21405 scroll the window to show point as appropriate. */
21406 if (target_is_eol_p
&& it
.line_wrap
== TRUNCATE
21407 && get_next_display_element (&it
))
21409 struct text_pos new_pos
= it
.current
.pos
;
21411 while (!ITERATOR_AT_END_OF_LINE_P (&it
))
21413 set_iterator_to_next (&it
, 0);
21414 if (it
.method
== GET_FROM_BUFFER
)
21415 new_pos
= it
.current
.pos
;
21416 if (!get_next_display_element (&it
))
21420 it
.current
.pos
= new_pos
;
21423 /* If we ended up in a display string that covers point, move to
21424 buffer position to the right in the visual order. */
21427 while (IT_CHARPOS (it
) == PT
)
21429 set_iterator_to_next (&it
, 0);
21430 if (!get_next_display_element (&it
))
21435 /* Move point to that position. */
21436 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21439 return make_number (PT
);
21441 #undef ROW_GLYPH_NEWLINE_P
21445 /***********************************************************************
21447 ***********************************************************************/
21449 /* Redisplay the menu bar in the frame for window W.
21451 The menu bar of X frames that don't have X toolkit support is
21452 displayed in a special window W->frame->menu_bar_window.
21454 The menu bar of terminal frames is treated specially as far as
21455 glyph matrices are concerned. Menu bar lines are not part of
21456 windows, so the update is done directly on the frame matrix rows
21457 for the menu bar. */
21460 display_menu_bar (struct window
*w
)
21462 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21467 /* Don't do all this for graphical frames. */
21469 if (FRAME_W32_P (f
))
21472 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21478 if (FRAME_NS_P (f
))
21480 #endif /* HAVE_NS */
21482 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21483 eassert (!FRAME_WINDOW_P (f
));
21484 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21485 it
.first_visible_x
= 0;
21486 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21487 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21488 if (FRAME_WINDOW_P (f
))
21490 /* Menu bar lines are displayed in the desired matrix of the
21491 dummy window menu_bar_window. */
21492 struct window
*menu_w
;
21493 menu_w
= XWINDOW (f
->menu_bar_window
);
21494 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21496 it
.first_visible_x
= 0;
21497 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21500 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21502 /* This is a TTY frame, i.e. character hpos/vpos are used as
21504 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21506 it
.first_visible_x
= 0;
21507 it
.last_visible_x
= FRAME_COLS (f
);
21510 /* FIXME: This should be controlled by a user option. See the
21511 comments in redisplay_tool_bar and display_mode_line about
21513 it
.paragraph_embedding
= L2R
;
21515 /* Clear all rows of the menu bar. */
21516 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21518 struct glyph_row
*row
= it
.glyph_row
+ i
;
21519 clear_glyph_row (row
);
21520 row
->enabled_p
= true;
21521 row
->full_width_p
= 1;
21524 /* Display all items of the menu bar. */
21525 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21526 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21528 Lisp_Object string
;
21530 /* Stop at nil string. */
21531 string
= AREF (items
, i
+ 1);
21535 /* Remember where item was displayed. */
21536 ASET (items
, i
+ 3, make_number (it
.hpos
));
21538 /* Display the item, pad with one space. */
21539 if (it
.current_x
< it
.last_visible_x
)
21540 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21541 SCHARS (string
) + 1, 0, 0, -1);
21544 /* Fill out the line with spaces. */
21545 if (it
.current_x
< it
.last_visible_x
)
21546 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21548 /* Compute the total height of the lines. */
21549 compute_line_metrics (&it
);
21552 /* Deep copy of a glyph row, including the glyphs. */
21554 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21556 struct glyph
*pointers
[1 + LAST_AREA
];
21557 int to_used
= to
->used
[TEXT_AREA
];
21559 /* Save glyph pointers of TO. */
21560 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21562 /* Do a structure assignment. */
21565 /* Restore original glyph pointers of TO. */
21566 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21568 /* Copy the glyphs. */
21569 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21570 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21572 /* If we filled only part of the TO row, fill the rest with
21573 space_glyph (which will display as empty space). */
21574 if (to_used
> from
->used
[TEXT_AREA
])
21575 fill_up_frame_row_with_spaces (to
, to_used
);
21578 /* Display one menu item on a TTY, by overwriting the glyphs in the
21579 frame F's desired glyph matrix with glyphs produced from the menu
21580 item text. Called from term.c to display TTY drop-down menus one
21583 ITEM_TEXT is the menu item text as a C string.
21585 FACE_ID is the face ID to be used for this menu item. FACE_ID
21586 could specify one of 3 faces: a face for an enabled item, a face
21587 for a disabled item, or a face for a selected item.
21589 X and Y are coordinates of the first glyph in the frame's desired
21590 matrix to be overwritten by the menu item. Since this is a TTY, Y
21591 is the zero-based number of the glyph row and X is the zero-based
21592 glyph number in the row, starting from left, where to start
21593 displaying the item.
21595 SUBMENU non-zero means this menu item drops down a submenu, which
21596 should be indicated by displaying a proper visual cue after the
21600 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21601 int x
, int y
, int submenu
)
21604 struct frame
*f
= SELECTED_FRAME ();
21605 struct window
*w
= XWINDOW (f
->selected_window
);
21606 int saved_used
, saved_truncated
, saved_width
, saved_reversed
;
21607 struct glyph_row
*row
;
21608 size_t item_len
= strlen (item_text
);
21610 eassert (FRAME_TERMCAP_P (f
));
21612 /* Don't write beyond the matrix's last row. This can happen for
21613 TTY screens that are not high enough to show the entire menu.
21614 (This is actually a bit of defensive programming, as
21615 tty_menu_display already limits the number of menu items to one
21616 less than the number of screen lines.) */
21617 if (y
>= f
->desired_matrix
->nrows
)
21620 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21621 it
.first_visible_x
= 0;
21622 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21623 row
= it
.glyph_row
;
21624 /* Start with the row contents from the current matrix. */
21625 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21626 saved_width
= row
->full_width_p
;
21627 row
->full_width_p
= 1;
21628 saved_reversed
= row
->reversed_p
;
21629 row
->reversed_p
= 0;
21630 row
->enabled_p
= true;
21632 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21634 eassert (x
< f
->desired_matrix
->matrix_w
);
21635 it
.current_x
= it
.hpos
= x
;
21636 it
.current_y
= it
.vpos
= y
;
21637 saved_used
= row
->used
[TEXT_AREA
];
21638 saved_truncated
= row
->truncated_on_right_p
;
21639 row
->used
[TEXT_AREA
] = x
;
21640 it
.face_id
= face_id
;
21641 it
.line_wrap
= TRUNCATE
;
21643 /* FIXME: This should be controlled by a user option. See the
21644 comments in redisplay_tool_bar and display_mode_line about this.
21645 Also, if paragraph_embedding could ever be R2L, changes will be
21646 needed to avoid shifting to the right the row characters in
21647 term.c:append_glyph. */
21648 it
.paragraph_embedding
= L2R
;
21650 /* Pad with a space on the left. */
21651 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21653 /* Display the menu item, pad with spaces to WIDTH. */
21656 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21657 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21659 /* Indicate with " >" that there's a submenu. */
21660 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21661 FRAME_COLS (f
) - 1, -1);
21664 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21665 width
, 0, FRAME_COLS (f
) - 1, -1);
21667 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21668 row
->truncated_on_right_p
= saved_truncated
;
21669 row
->hash
= row_hash (row
);
21670 row
->full_width_p
= saved_width
;
21671 row
->reversed_p
= saved_reversed
;
21674 /***********************************************************************
21676 ***********************************************************************/
21678 /* Redisplay mode lines in the window tree whose root is WINDOW. If
21679 FORCE is non-zero, redisplay mode lines unconditionally.
21680 Otherwise, redisplay only mode lines that are garbaged. Value is
21681 the number of windows whose mode lines were redisplayed. */
21684 redisplay_mode_lines (Lisp_Object window
, bool force
)
21688 while (!NILP (window
))
21690 struct window
*w
= XWINDOW (window
);
21692 if (WINDOWP (w
->contents
))
21693 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
21695 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
21696 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
21698 struct text_pos lpoint
;
21699 struct buffer
*old
= current_buffer
;
21701 /* Set the window's buffer for the mode line display. */
21702 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
21703 set_buffer_internal_1 (XBUFFER (w
->contents
));
21705 /* Point refers normally to the selected window. For any
21706 other window, set up appropriate value. */
21707 if (!EQ (window
, selected_window
))
21709 struct text_pos pt
;
21711 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
21712 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
21715 /* Display mode lines. */
21716 clear_glyph_matrix (w
->desired_matrix
);
21717 if (display_mode_lines (w
))
21720 /* Restore old settings. */
21721 set_buffer_internal_1 (old
);
21722 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
21732 /* Display the mode and/or header line of window W. Value is the
21733 sum number of mode lines and header lines displayed. */
21736 display_mode_lines (struct window
*w
)
21738 Lisp_Object old_selected_window
= selected_window
;
21739 Lisp_Object old_selected_frame
= selected_frame
;
21740 Lisp_Object new_frame
= w
->frame
;
21741 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
21744 selected_frame
= new_frame
;
21745 /* FIXME: If we were to allow the mode-line's computation changing the buffer
21746 or window's point, then we'd need select_window_1 here as well. */
21747 XSETWINDOW (selected_window
, w
);
21748 XFRAME (new_frame
)->selected_window
= selected_window
;
21750 /* These will be set while the mode line specs are processed. */
21751 line_number_displayed
= 0;
21752 w
->column_number_displayed
= -1;
21754 if (WINDOW_WANTS_MODELINE_P (w
))
21756 struct window
*sel_w
= XWINDOW (old_selected_window
);
21758 /* Select mode line face based on the real selected window. */
21759 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
21760 BVAR (current_buffer
, mode_line_format
));
21764 if (WINDOW_WANTS_HEADER_LINE_P (w
))
21766 display_mode_line (w
, HEADER_LINE_FACE_ID
,
21767 BVAR (current_buffer
, header_line_format
));
21771 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
21772 selected_frame
= old_selected_frame
;
21773 selected_window
= old_selected_window
;
21775 w
->must_be_updated_p
= true;
21780 /* Display mode or header line of window W. FACE_ID specifies which
21781 line to display; it is either MODE_LINE_FACE_ID or
21782 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
21783 display. Value is the pixel height of the mode/header line
21787 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
21791 ptrdiff_t count
= SPECPDL_INDEX ();
21793 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21794 /* Don't extend on a previously drawn mode-line.
21795 This may happen if called from pos_visible_p. */
21796 it
.glyph_row
->enabled_p
= false;
21797 prepare_desired_row (w
, it
.glyph_row
, true);
21799 it
.glyph_row
->mode_line_p
= 1;
21801 /* FIXME: This should be controlled by a user option. But
21802 supporting such an option is not trivial, since the mode line is
21803 made up of many separate strings. */
21804 it
.paragraph_embedding
= L2R
;
21806 record_unwind_protect (unwind_format_mode_line
,
21807 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
21809 mode_line_target
= MODE_LINE_DISPLAY
;
21811 /* Temporarily make frame's keyboard the current kboard so that
21812 kboard-local variables in the mode_line_format will get the right
21814 push_kboard (FRAME_KBOARD (it
.f
));
21815 record_unwind_save_match_data ();
21816 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21819 unbind_to (count
, Qnil
);
21821 /* Fill up with spaces. */
21822 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
21824 compute_line_metrics (&it
);
21825 it
.glyph_row
->full_width_p
= 1;
21826 it
.glyph_row
->continued_p
= 0;
21827 it
.glyph_row
->truncated_on_left_p
= 0;
21828 it
.glyph_row
->truncated_on_right_p
= 0;
21830 /* Make a 3D mode-line have a shadow at its right end. */
21831 face
= FACE_FROM_ID (it
.f
, face_id
);
21832 extend_face_to_end_of_line (&it
);
21833 if (face
->box
!= FACE_NO_BOX
)
21835 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
21836 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
21837 last
->right_box_line_p
= 1;
21840 return it
.glyph_row
->height
;
21843 /* Move element ELT in LIST to the front of LIST.
21844 Return the updated list. */
21847 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
21849 register Lisp_Object tail
, prev
;
21850 register Lisp_Object tem
;
21854 while (CONSP (tail
))
21860 /* Splice out the link TAIL. */
21862 list
= XCDR (tail
);
21864 Fsetcdr (prev
, XCDR (tail
));
21866 /* Now make it the first. */
21867 Fsetcdr (tail
, list
);
21872 tail
= XCDR (tail
);
21876 /* Not found--return unchanged LIST. */
21880 /* Contribute ELT to the mode line for window IT->w. How it
21881 translates into text depends on its data type.
21883 IT describes the display environment in which we display, as usual.
21885 DEPTH is the depth in recursion. It is used to prevent
21886 infinite recursion here.
21888 FIELD_WIDTH is the number of characters the display of ELT should
21889 occupy in the mode line, and PRECISION is the maximum number of
21890 characters to display from ELT's representation. See
21891 display_string for details.
21893 Returns the hpos of the end of the text generated by ELT.
21895 PROPS is a property list to add to any string we encounter.
21897 If RISKY is nonzero, remove (disregard) any properties in any string
21898 we encounter, and ignore :eval and :propertize.
21900 The global variable `mode_line_target' determines whether the
21901 output is passed to `store_mode_line_noprop',
21902 `store_mode_line_string', or `display_string'. */
21905 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
21906 Lisp_Object elt
, Lisp_Object props
, int risky
)
21908 int n
= 0, field
, prec
;
21913 elt
= build_string ("*too-deep*");
21917 switch (XTYPE (elt
))
21921 /* A string: output it and check for %-constructs within it. */
21923 ptrdiff_t offset
= 0;
21925 if (SCHARS (elt
) > 0
21926 && (!NILP (props
) || risky
))
21928 Lisp_Object oprops
, aelt
;
21929 oprops
= Ftext_properties_at (make_number (0), elt
);
21931 /* If the starting string's properties are not what
21932 we want, translate the string. Also, if the string
21933 is risky, do that anyway. */
21935 if (NILP (Fequal (props
, oprops
)) || risky
)
21937 /* If the starting string has properties,
21938 merge the specified ones onto the existing ones. */
21939 if (! NILP (oprops
) && !risky
)
21943 oprops
= Fcopy_sequence (oprops
);
21945 while (CONSP (tem
))
21947 oprops
= Fplist_put (oprops
, XCAR (tem
),
21948 XCAR (XCDR (tem
)));
21949 tem
= XCDR (XCDR (tem
));
21954 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
21955 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
21957 /* AELT is what we want. Move it to the front
21958 without consing. */
21960 mode_line_proptrans_alist
21961 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
21967 /* If AELT has the wrong props, it is useless.
21968 so get rid of it. */
21970 mode_line_proptrans_alist
21971 = Fdelq (aelt
, mode_line_proptrans_alist
);
21973 elt
= Fcopy_sequence (elt
);
21974 Fset_text_properties (make_number (0), Flength (elt
),
21976 /* Add this item to mode_line_proptrans_alist. */
21977 mode_line_proptrans_alist
21978 = Fcons (Fcons (elt
, props
),
21979 mode_line_proptrans_alist
);
21980 /* Truncate mode_line_proptrans_alist
21981 to at most 50 elements. */
21982 tem
= Fnthcdr (make_number (50),
21983 mode_line_proptrans_alist
);
21985 XSETCDR (tem
, Qnil
);
21994 prec
= precision
- n
;
21995 switch (mode_line_target
)
21997 case MODE_LINE_NOPROP
:
21998 case MODE_LINE_TITLE
:
21999 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22001 case MODE_LINE_STRING
:
22002 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
22004 case MODE_LINE_DISPLAY
:
22005 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22006 0, prec
, 0, STRING_MULTIBYTE (elt
));
22013 /* Handle the non-literal case. */
22015 while ((precision
<= 0 || n
< precision
)
22016 && SREF (elt
, offset
) != 0
22017 && (mode_line_target
!= MODE_LINE_DISPLAY
22018 || it
->current_x
< it
->last_visible_x
))
22020 ptrdiff_t last_offset
= offset
;
22022 /* Advance to end of string or next format specifier. */
22023 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22026 if (offset
- 1 != last_offset
)
22028 ptrdiff_t nchars
, nbytes
;
22030 /* Output to end of string or up to '%'. Field width
22031 is length of string. Don't output more than
22032 PRECISION allows us. */
22035 prec
= c_string_width (SDATA (elt
) + last_offset
,
22036 offset
- last_offset
, precision
- n
,
22039 switch (mode_line_target
)
22041 case MODE_LINE_NOPROP
:
22042 case MODE_LINE_TITLE
:
22043 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22045 case MODE_LINE_STRING
:
22047 ptrdiff_t bytepos
= last_offset
;
22048 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22049 ptrdiff_t endpos
= (precision
<= 0
22050 ? string_byte_to_char (elt
, offset
)
22051 : charpos
+ nchars
);
22053 n
+= store_mode_line_string (NULL
,
22054 Fsubstring (elt
, make_number (charpos
),
22055 make_number (endpos
)),
22059 case MODE_LINE_DISPLAY
:
22061 ptrdiff_t bytepos
= last_offset
;
22062 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22064 if (precision
<= 0)
22065 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22066 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22068 STRING_MULTIBYTE (elt
));
22073 else /* c == '%' */
22075 ptrdiff_t percent_position
= offset
;
22077 /* Get the specified minimum width. Zero means
22080 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22081 field
= field
* 10 + c
- '0';
22083 /* Don't pad beyond the total padding allowed. */
22084 if (field_width
- n
> 0 && field
> field_width
- n
)
22085 field
= field_width
- n
;
22087 /* Note that either PRECISION <= 0 or N < PRECISION. */
22088 prec
= precision
- n
;
22091 n
+= display_mode_element (it
, depth
, field
, prec
,
22092 Vglobal_mode_string
, props
,
22097 ptrdiff_t bytepos
, charpos
;
22099 Lisp_Object string
;
22101 bytepos
= percent_position
;
22102 charpos
= (STRING_MULTIBYTE (elt
)
22103 ? string_byte_to_char (elt
, bytepos
)
22105 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22106 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22108 switch (mode_line_target
)
22110 case MODE_LINE_NOPROP
:
22111 case MODE_LINE_TITLE
:
22112 n
+= store_mode_line_noprop (spec
, field
, prec
);
22114 case MODE_LINE_STRING
:
22116 Lisp_Object tem
= build_string (spec
);
22117 props
= Ftext_properties_at (make_number (charpos
), elt
);
22118 /* Should only keep face property in props */
22119 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
22122 case MODE_LINE_DISPLAY
:
22124 int nglyphs_before
, nwritten
;
22126 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22127 nwritten
= display_string (spec
, string
, elt
,
22132 /* Assign to the glyphs written above the
22133 string where the `%x' came from, position
22137 struct glyph
*glyph
22138 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22142 for (i
= 0; i
< nwritten
; ++i
)
22144 glyph
[i
].object
= elt
;
22145 glyph
[i
].charpos
= charpos
;
22162 /* A symbol: process the value of the symbol recursively
22163 as if it appeared here directly. Avoid error if symbol void.
22164 Special case: if value of symbol is a string, output the string
22167 register Lisp_Object tem
;
22169 /* If the variable is not marked as risky to set
22170 then its contents are risky to use. */
22171 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22174 tem
= Fboundp (elt
);
22177 tem
= Fsymbol_value (elt
);
22178 /* If value is a string, output that string literally:
22179 don't check for % within it. */
22183 if (!EQ (tem
, elt
))
22185 /* Give up right away for nil or t. */
22195 register Lisp_Object car
, tem
;
22197 /* A cons cell: five distinct cases.
22198 If first element is :eval or :propertize, do something special.
22199 If first element is a string or a cons, process all the elements
22200 and effectively concatenate them.
22201 If first element is a negative number, truncate displaying cdr to
22202 at most that many characters. If positive, pad (with spaces)
22203 to at least that many characters.
22204 If first element is a symbol, process the cadr or caddr recursively
22205 according to whether the symbol's value is non-nil or nil. */
22207 if (EQ (car
, QCeval
))
22209 /* An element of the form (:eval FORM) means evaluate FORM
22210 and use the result as mode line elements. */
22215 if (CONSP (XCDR (elt
)))
22218 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22219 n
+= display_mode_element (it
, depth
, field_width
- n
,
22220 precision
- n
, spec
, props
,
22224 else if (EQ (car
, QCpropertize
))
22226 /* An element of the form (:propertize ELT PROPS...)
22227 means display ELT but applying properties PROPS. */
22232 if (CONSP (XCDR (elt
)))
22233 n
+= display_mode_element (it
, depth
, field_width
- n
,
22234 precision
- n
, XCAR (XCDR (elt
)),
22235 XCDR (XCDR (elt
)), risky
);
22237 else if (SYMBOLP (car
))
22239 tem
= Fboundp (car
);
22243 /* elt is now the cdr, and we know it is a cons cell.
22244 Use its car if CAR has a non-nil value. */
22247 tem
= Fsymbol_value (car
);
22254 /* Symbol's value is nil (or symbol is unbound)
22255 Get the cddr of the original list
22256 and if possible find the caddr and use that. */
22260 else if (!CONSP (elt
))
22265 else if (INTEGERP (car
))
22267 register int lim
= XINT (car
);
22271 /* Negative int means reduce maximum width. */
22272 if (precision
<= 0)
22275 precision
= min (precision
, -lim
);
22279 /* Padding specified. Don't let it be more than
22280 current maximum. */
22282 lim
= min (precision
, lim
);
22284 /* If that's more padding than already wanted, queue it.
22285 But don't reduce padding already specified even if
22286 that is beyond the current truncation point. */
22287 field_width
= max (lim
, field_width
);
22291 else if (STRINGP (car
) || CONSP (car
))
22293 Lisp_Object halftail
= elt
;
22297 && (precision
<= 0 || n
< precision
))
22299 n
+= display_mode_element (it
, depth
,
22300 /* Do padding only after the last
22301 element in the list. */
22302 (! CONSP (XCDR (elt
))
22305 precision
- n
, XCAR (elt
),
22309 if ((len
& 1) == 0)
22310 halftail
= XCDR (halftail
);
22311 /* Check for cycle. */
22312 if (EQ (halftail
, elt
))
22321 elt
= build_string ("*invalid*");
22325 /* Pad to FIELD_WIDTH. */
22326 if (field_width
> 0 && n
< field_width
)
22328 switch (mode_line_target
)
22330 case MODE_LINE_NOPROP
:
22331 case MODE_LINE_TITLE
:
22332 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22334 case MODE_LINE_STRING
:
22335 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
22337 case MODE_LINE_DISPLAY
:
22338 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22347 /* Store a mode-line string element in mode_line_string_list.
22349 If STRING is non-null, display that C string. Otherwise, the Lisp
22350 string LISP_STRING is displayed.
22352 FIELD_WIDTH is the minimum number of output glyphs to produce.
22353 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22354 with spaces. FIELD_WIDTH <= 0 means don't pad.
22356 PRECISION is the maximum number of characters to output from
22357 STRING. PRECISION <= 0 means don't truncate the string.
22359 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
22360 properties to the string.
22362 PROPS are the properties to add to the string.
22363 The mode_line_string_face face property is always added to the string.
22367 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
22368 int field_width
, int precision
, Lisp_Object props
)
22373 if (string
!= NULL
)
22375 len
= strlen (string
);
22376 if (precision
> 0 && len
> precision
)
22378 lisp_string
= make_string (string
, len
);
22380 props
= mode_line_string_face_prop
;
22381 else if (!NILP (mode_line_string_face
))
22383 Lisp_Object face
= Fplist_get (props
, Qface
);
22384 props
= Fcopy_sequence (props
);
22386 face
= mode_line_string_face
;
22388 face
= list2 (face
, mode_line_string_face
);
22389 props
= Fplist_put (props
, Qface
, face
);
22391 Fadd_text_properties (make_number (0), make_number (len
),
22392 props
, lisp_string
);
22396 len
= XFASTINT (Flength (lisp_string
));
22397 if (precision
> 0 && len
> precision
)
22400 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22403 if (!NILP (mode_line_string_face
))
22407 props
= Ftext_properties_at (make_number (0), lisp_string
);
22408 face
= Fplist_get (props
, Qface
);
22410 face
= mode_line_string_face
;
22412 face
= list2 (face
, mode_line_string_face
);
22413 props
= list2 (Qface
, face
);
22415 lisp_string
= Fcopy_sequence (lisp_string
);
22418 Fadd_text_properties (make_number (0), make_number (len
),
22419 props
, lisp_string
);
22424 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22428 if (field_width
> len
)
22430 field_width
-= len
;
22431 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22433 Fadd_text_properties (make_number (0), make_number (field_width
),
22434 props
, lisp_string
);
22435 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22443 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22445 doc
: /* Format a string out of a mode line format specification.
22446 First arg FORMAT specifies the mode line format (see `mode-line-format'
22447 for details) to use.
22449 By default, the format is evaluated for the currently selected window.
22451 Optional second arg FACE specifies the face property to put on all
22452 characters for which no face is specified. The value nil means the
22453 default face. The value t means whatever face the window's mode line
22454 currently uses (either `mode-line' or `mode-line-inactive',
22455 depending on whether the window is the selected window or not).
22456 An integer value means the value string has no text
22459 Optional third and fourth args WINDOW and BUFFER specify the window
22460 and buffer to use as the context for the formatting (defaults
22461 are the selected window and the WINDOW's buffer). */)
22462 (Lisp_Object format
, Lisp_Object face
,
22463 Lisp_Object window
, Lisp_Object buffer
)
22468 struct buffer
*old_buffer
= NULL
;
22470 int no_props
= INTEGERP (face
);
22471 ptrdiff_t count
= SPECPDL_INDEX ();
22473 int string_start
= 0;
22475 w
= decode_any_window (window
);
22476 XSETWINDOW (window
, w
);
22479 buffer
= w
->contents
;
22480 CHECK_BUFFER (buffer
);
22482 /* Make formatting the modeline a non-op when noninteractive, otherwise
22483 there will be problems later caused by a partially initialized frame. */
22484 if (NILP (format
) || noninteractive
)
22485 return empty_unibyte_string
;
22490 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22491 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22492 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22493 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22494 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22495 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22496 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22499 old_buffer
= current_buffer
;
22501 /* Save things including mode_line_proptrans_alist,
22502 and set that to nil so that we don't alter the outer value. */
22503 record_unwind_protect (unwind_format_mode_line
,
22504 format_mode_line_unwind_data
22505 (XFRAME (WINDOW_FRAME (w
)),
22506 old_buffer
, selected_window
, 1));
22507 mode_line_proptrans_alist
= Qnil
;
22509 Fselect_window (window
, Qt
);
22510 set_buffer_internal_1 (XBUFFER (buffer
));
22512 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22516 mode_line_target
= MODE_LINE_NOPROP
;
22517 mode_line_string_face_prop
= Qnil
;
22518 mode_line_string_list
= Qnil
;
22519 string_start
= MODE_LINE_NOPROP_LEN (0);
22523 mode_line_target
= MODE_LINE_STRING
;
22524 mode_line_string_list
= Qnil
;
22525 mode_line_string_face
= face
;
22526 mode_line_string_face_prop
22527 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22530 push_kboard (FRAME_KBOARD (it
.f
));
22531 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
22536 len
= MODE_LINE_NOPROP_LEN (string_start
);
22537 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22541 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22542 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
22543 empty_unibyte_string
);
22546 unbind_to (count
, Qnil
);
22550 /* Write a null-terminated, right justified decimal representation of
22551 the positive integer D to BUF using a minimal field width WIDTH. */
22554 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22556 register char *p
= buf
;
22564 *p
++ = d
% 10 + '0';
22569 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22580 /* Write a null-terminated, right justified decimal and "human
22581 readable" representation of the nonnegative integer D to BUF using
22582 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22584 static const char power_letter
[] =
22598 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22600 /* We aim to represent the nonnegative integer D as
22601 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22602 ptrdiff_t quotient
= d
;
22604 /* -1 means: do not use TENTHS. */
22608 /* Length of QUOTIENT.TENTHS as a string. */
22614 if (quotient
>= 1000)
22616 /* Scale to the appropriate EXPONENT. */
22619 remainder
= quotient
% 1000;
22623 while (quotient
>= 1000);
22625 /* Round to nearest and decide whether to use TENTHS or not. */
22628 tenths
= remainder
/ 100;
22629 if (remainder
% 100 >= 50)
22636 if (quotient
== 10)
22644 if (remainder
>= 500)
22646 if (quotient
< 999)
22657 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22658 if (tenths
== -1 && quotient
<= 99)
22665 p
= psuffix
= buf
+ max (width
, length
);
22667 /* Print EXPONENT. */
22668 *psuffix
++ = power_letter
[exponent
];
22671 /* Print TENTHS. */
22674 *--p
= '0' + tenths
;
22678 /* Print QUOTIENT. */
22681 int digit
= quotient
% 10;
22682 *--p
= '0' + digit
;
22684 while ((quotient
/= 10) != 0);
22686 /* Print leading spaces. */
22691 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22692 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
22693 type of CODING_SYSTEM. Return updated pointer into BUF. */
22695 static unsigned char invalid_eol_type
[] = "(*invalid*)";
22698 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
22701 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
22702 const unsigned char *eol_str
;
22704 /* The EOL conversion we are using. */
22705 Lisp_Object eoltype
;
22707 val
= CODING_SYSTEM_SPEC (coding_system
);
22710 if (!VECTORP (val
)) /* Not yet decided. */
22712 *buf
++ = multibyte
? '-' : ' ';
22714 eoltype
= eol_mnemonic_undecided
;
22715 /* Don't mention EOL conversion if it isn't decided. */
22720 Lisp_Object eolvalue
;
22722 attrs
= AREF (val
, 0);
22723 eolvalue
= AREF (val
, 2);
22726 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
22731 /* The EOL conversion that is normal on this system. */
22733 if (NILP (eolvalue
)) /* Not yet decided. */
22734 eoltype
= eol_mnemonic_undecided
;
22735 else if (VECTORP (eolvalue
)) /* Not yet decided. */
22736 eoltype
= eol_mnemonic_undecided
;
22737 else /* eolvalue is Qunix, Qdos, or Qmac. */
22738 eoltype
= (EQ (eolvalue
, Qunix
)
22739 ? eol_mnemonic_unix
22740 : (EQ (eolvalue
, Qdos
) == 1
22741 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
22747 /* Mention the EOL conversion if it is not the usual one. */
22748 if (STRINGP (eoltype
))
22750 eol_str
= SDATA (eoltype
);
22751 eol_str_len
= SBYTES (eoltype
);
22753 else if (CHARACTERP (eoltype
))
22755 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
22756 int c
= XFASTINT (eoltype
);
22757 eol_str_len
= CHAR_STRING (c
, tmp
);
22762 eol_str
= invalid_eol_type
;
22763 eol_str_len
= sizeof (invalid_eol_type
) - 1;
22765 memcpy (buf
, eol_str
, eol_str_len
);
22766 buf
+= eol_str_len
;
22772 /* Return a string for the output of a mode line %-spec for window W,
22773 generated by character C. FIELD_WIDTH > 0 means pad the string
22774 returned with spaces to that value. Return a Lisp string in
22775 *STRING if the resulting string is taken from that Lisp string.
22777 Note we operate on the current buffer for most purposes. */
22779 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
22781 static const char *
22782 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
22783 Lisp_Object
*string
)
22786 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22787 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
22788 /* We are going to use f->decode_mode_spec_buffer as the buffer to
22789 produce strings from numerical values, so limit preposterously
22790 large values of FIELD_WIDTH to avoid overrunning the buffer's
22791 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
22792 bytes plus the terminating null. */
22793 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
22794 struct buffer
*b
= current_buffer
;
22802 if (!NILP (BVAR (b
, read_only
)))
22804 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22809 /* This differs from %* only for a modified read-only buffer. */
22810 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22812 if (!NILP (BVAR (b
, read_only
)))
22817 /* This differs from %* in ignoring read-only-ness. */
22818 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22830 if (command_loop_level
> 5)
22832 p
= decode_mode_spec_buf
;
22833 for (i
= 0; i
< command_loop_level
; i
++)
22836 return decode_mode_spec_buf
;
22844 if (command_loop_level
> 5)
22846 p
= decode_mode_spec_buf
;
22847 for (i
= 0; i
< command_loop_level
; i
++)
22850 return decode_mode_spec_buf
;
22857 /* Let lots_of_dashes be a string of infinite length. */
22858 if (mode_line_target
== MODE_LINE_NOPROP
22859 || mode_line_target
== MODE_LINE_STRING
)
22861 if (field_width
<= 0
22862 || field_width
> sizeof (lots_of_dashes
))
22864 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
22865 decode_mode_spec_buf
[i
] = '-';
22866 decode_mode_spec_buf
[i
] = '\0';
22867 return decode_mode_spec_buf
;
22870 return lots_of_dashes
;
22874 obj
= BVAR (b
, name
);
22878 /* %c and %l are ignored in `frame-title-format'.
22879 (In redisplay_internal, the frame title is drawn _before_ the
22880 windows are updated, so the stuff which depends on actual
22881 window contents (such as %l) may fail to render properly, or
22882 even crash emacs.) */
22883 if (mode_line_target
== MODE_LINE_TITLE
)
22887 ptrdiff_t col
= current_column ();
22888 w
->column_number_displayed
= col
;
22889 pint2str (decode_mode_spec_buf
, width
, col
);
22890 return decode_mode_spec_buf
;
22894 #ifndef SYSTEM_MALLOC
22896 if (NILP (Vmemory_full
))
22899 return "!MEM FULL! ";
22906 /* %F displays the frame name. */
22907 if (!NILP (f
->title
))
22908 return SSDATA (f
->title
);
22909 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
22910 return SSDATA (f
->name
);
22914 obj
= BVAR (b
, filename
);
22919 ptrdiff_t size
= ZV
- BEGV
;
22920 pint2str (decode_mode_spec_buf
, width
, size
);
22921 return decode_mode_spec_buf
;
22926 ptrdiff_t size
= ZV
- BEGV
;
22927 pint2hrstr (decode_mode_spec_buf
, width
, size
);
22928 return decode_mode_spec_buf
;
22933 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
22934 ptrdiff_t topline
, nlines
, height
;
22937 /* %c and %l are ignored in `frame-title-format'. */
22938 if (mode_line_target
== MODE_LINE_TITLE
)
22941 startpos
= marker_position (w
->start
);
22942 startpos_byte
= marker_byte_position (w
->start
);
22943 height
= WINDOW_TOTAL_LINES (w
);
22945 /* If we decided that this buffer isn't suitable for line numbers,
22946 don't forget that too fast. */
22947 if (w
->base_line_pos
== -1)
22950 /* If the buffer is very big, don't waste time. */
22951 if (INTEGERP (Vline_number_display_limit
)
22952 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
22954 w
->base_line_pos
= 0;
22955 w
->base_line_number
= 0;
22959 if (w
->base_line_number
> 0
22960 && w
->base_line_pos
> 0
22961 && w
->base_line_pos
<= startpos
)
22963 line
= w
->base_line_number
;
22964 linepos
= w
->base_line_pos
;
22965 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
22970 linepos
= BUF_BEGV (b
);
22971 linepos_byte
= BUF_BEGV_BYTE (b
);
22974 /* Count lines from base line to window start position. */
22975 nlines
= display_count_lines (linepos_byte
,
22979 topline
= nlines
+ line
;
22981 /* Determine a new base line, if the old one is too close
22982 or too far away, or if we did not have one.
22983 "Too close" means it's plausible a scroll-down would
22984 go back past it. */
22985 if (startpos
== BUF_BEGV (b
))
22987 w
->base_line_number
= topline
;
22988 w
->base_line_pos
= BUF_BEGV (b
);
22990 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
22991 || linepos
== BUF_BEGV (b
))
22993 ptrdiff_t limit
= BUF_BEGV (b
);
22994 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
22995 ptrdiff_t position
;
22996 ptrdiff_t distance
=
22997 (height
* 2 + 30) * line_number_display_limit_width
;
22999 if (startpos
- distance
> limit
)
23001 limit
= startpos
- distance
;
23002 limit_byte
= CHAR_TO_BYTE (limit
);
23005 nlines
= display_count_lines (startpos_byte
,
23007 - (height
* 2 + 30),
23009 /* If we couldn't find the lines we wanted within
23010 line_number_display_limit_width chars per line,
23011 give up on line numbers for this window. */
23012 if (position
== limit_byte
&& limit
== startpos
- distance
)
23014 w
->base_line_pos
= -1;
23015 w
->base_line_number
= 0;
23019 w
->base_line_number
= topline
- nlines
;
23020 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23023 /* Now count lines from the start pos to point. */
23024 nlines
= display_count_lines (startpos_byte
,
23025 PT_BYTE
, PT
, &junk
);
23027 /* Record that we did display the line number. */
23028 line_number_displayed
= 1;
23030 /* Make the string to show. */
23031 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23032 return decode_mode_spec_buf
;
23035 char* p
= decode_mode_spec_buf
;
23036 int pad
= width
- 2;
23042 return decode_mode_spec_buf
;
23048 obj
= BVAR (b
, mode_name
);
23052 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23058 ptrdiff_t pos
= marker_position (w
->start
);
23059 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23061 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23063 if (pos
<= BUF_BEGV (b
))
23068 else if (pos
<= BUF_BEGV (b
))
23072 if (total
> 1000000)
23073 /* Do it differently for a large value, to avoid overflow. */
23074 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23076 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23077 /* We can't normally display a 3-digit number,
23078 so get us a 2-digit number that is close. */
23081 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23082 return decode_mode_spec_buf
;
23086 /* Display percentage of size above the bottom of the screen. */
23089 ptrdiff_t toppos
= marker_position (w
->start
);
23090 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23091 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23093 if (botpos
>= BUF_ZV (b
))
23095 if (toppos
<= BUF_BEGV (b
))
23102 if (total
> 1000000)
23103 /* Do it differently for a large value, to avoid overflow. */
23104 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23106 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23107 /* We can't normally display a 3-digit number,
23108 so get us a 2-digit number that is close. */
23111 if (toppos
<= BUF_BEGV (b
))
23112 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23114 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23115 return decode_mode_spec_buf
;
23120 /* status of process */
23121 obj
= Fget_buffer_process (Fcurrent_buffer ());
23123 return "no process";
23125 obj
= Fsymbol_name (Fprocess_status (obj
));
23131 ptrdiff_t count
= inhibit_garbage_collection ();
23132 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23133 Lisp_Object val
= Qnil
;
23135 if (STRINGP (curdir
))
23136 val
= call1 (intern ("file-remote-p"), curdir
);
23138 unbind_to (count
, Qnil
);
23147 /* coding-system (not including end-of-line format) */
23149 /* coding-system (including end-of-line type) */
23151 int eol_flag
= (c
== 'Z');
23152 char *p
= decode_mode_spec_buf
;
23154 if (! FRAME_WINDOW_P (f
))
23156 /* No need to mention EOL here--the terminal never needs
23157 to do EOL conversion. */
23158 p
= decode_mode_spec_coding (CODING_ID_NAME
23159 (FRAME_KEYBOARD_CODING (f
)->id
),
23161 p
= decode_mode_spec_coding (CODING_ID_NAME
23162 (FRAME_TERMINAL_CODING (f
)->id
),
23165 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23168 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
23169 #ifdef subprocesses
23170 obj
= Fget_buffer_process (Fcurrent_buffer ());
23171 if (PROCESSP (obj
))
23173 p
= decode_mode_spec_coding
23174 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23175 p
= decode_mode_spec_coding
23176 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23178 #endif /* subprocesses */
23181 return decode_mode_spec_buf
;
23188 return SSDATA (obj
);
23195 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23196 means count lines back from START_BYTE. But don't go beyond
23197 LIMIT_BYTE. Return the number of lines thus found (always
23200 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23201 either the position COUNT lines after/before START_BYTE, if we
23202 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23206 display_count_lines (ptrdiff_t start_byte
,
23207 ptrdiff_t limit_byte
, ptrdiff_t count
,
23208 ptrdiff_t *byte_pos_ptr
)
23210 register unsigned char *cursor
;
23211 unsigned char *base
;
23213 register ptrdiff_t ceiling
;
23214 register unsigned char *ceiling_addr
;
23215 ptrdiff_t orig_count
= count
;
23217 /* If we are not in selective display mode,
23218 check only for newlines. */
23219 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
23220 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23224 while (start_byte
< limit_byte
)
23226 ceiling
= BUFFER_CEILING_OF (start_byte
);
23227 ceiling
= min (limit_byte
- 1, ceiling
);
23228 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23229 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23233 if (selective_display
)
23235 while (*cursor
!= '\n' && *cursor
!= 015
23236 && ++cursor
!= ceiling_addr
)
23238 if (cursor
== ceiling_addr
)
23243 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23252 start_byte
+= cursor
- base
;
23253 *byte_pos_ptr
= start_byte
;
23257 while (cursor
< ceiling_addr
);
23259 start_byte
+= ceiling_addr
- base
;
23264 while (start_byte
> limit_byte
)
23266 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23267 ceiling
= max (limit_byte
, ceiling
);
23268 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23269 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23272 if (selective_display
)
23274 while (--cursor
>= ceiling_addr
23275 && *cursor
!= '\n' && *cursor
!= 015)
23277 if (cursor
< ceiling_addr
)
23282 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23289 start_byte
+= cursor
- base
+ 1;
23290 *byte_pos_ptr
= start_byte
;
23291 /* When scanning backwards, we should
23292 not count the newline posterior to which we stop. */
23293 return - orig_count
- 1;
23296 start_byte
+= ceiling_addr
- base
;
23300 *byte_pos_ptr
= limit_byte
;
23303 return - orig_count
+ count
;
23304 return orig_count
- count
;
23310 /***********************************************************************
23312 ***********************************************************************/
23314 /* Display a NUL-terminated string, starting with index START.
23316 If STRING is non-null, display that C string. Otherwise, the Lisp
23317 string LISP_STRING is displayed. There's a case that STRING is
23318 non-null and LISP_STRING is not nil. It means STRING is a string
23319 data of LISP_STRING. In that case, we display LISP_STRING while
23320 ignoring its text properties.
23322 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23323 FACE_STRING. Display STRING or LISP_STRING with the face at
23324 FACE_STRING_POS in FACE_STRING:
23326 Display the string in the environment given by IT, but use the
23327 standard display table, temporarily.
23329 FIELD_WIDTH is the minimum number of output glyphs to produce.
23330 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23331 with spaces. If STRING has more characters, more than FIELD_WIDTH
23332 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23334 PRECISION is the maximum number of characters to output from
23335 STRING. PRECISION < 0 means don't truncate the string.
23337 This is roughly equivalent to printf format specifiers:
23339 FIELD_WIDTH PRECISION PRINTF
23340 ----------------------------------------
23346 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23347 display them, and < 0 means obey the current buffer's value of
23348 enable_multibyte_characters.
23350 Value is the number of columns displayed. */
23353 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23354 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23355 int field_width
, int precision
, int max_x
, int multibyte
)
23357 int hpos_at_start
= it
->hpos
;
23358 int saved_face_id
= it
->face_id
;
23359 struct glyph_row
*row
= it
->glyph_row
;
23360 ptrdiff_t it_charpos
;
23362 /* Initialize the iterator IT for iteration over STRING beginning
23363 with index START. */
23364 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23365 precision
, field_width
, multibyte
);
23366 if (string
&& STRINGP (lisp_string
))
23367 /* LISP_STRING is the one returned by decode_mode_spec. We should
23368 ignore its text properties. */
23369 it
->stop_charpos
= it
->end_charpos
;
23371 /* If displaying STRING, set up the face of the iterator from
23372 FACE_STRING, if that's given. */
23373 if (STRINGP (face_string
))
23379 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23380 0, &endptr
, it
->base_face_id
, 0);
23381 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23382 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23385 /* Set max_x to the maximum allowed X position. Don't let it go
23386 beyond the right edge of the window. */
23388 max_x
= it
->last_visible_x
;
23390 max_x
= min (max_x
, it
->last_visible_x
);
23392 /* Skip over display elements that are not visible. because IT->w is
23394 if (it
->current_x
< it
->first_visible_x
)
23395 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23396 MOVE_TO_POS
| MOVE_TO_X
);
23398 row
->ascent
= it
->max_ascent
;
23399 row
->height
= it
->max_ascent
+ it
->max_descent
;
23400 row
->phys_ascent
= it
->max_phys_ascent
;
23401 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23402 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23404 if (STRINGP (it
->string
))
23405 it_charpos
= IT_STRING_CHARPOS (*it
);
23407 it_charpos
= IT_CHARPOS (*it
);
23409 /* This condition is for the case that we are called with current_x
23410 past last_visible_x. */
23411 while (it
->current_x
< max_x
)
23413 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23415 /* Get the next display element. */
23416 if (!get_next_display_element (it
))
23419 /* Produce glyphs. */
23420 x_before
= it
->current_x
;
23421 n_glyphs_before
= row
->used
[TEXT_AREA
];
23422 PRODUCE_GLYPHS (it
);
23424 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23427 while (i
< nglyphs
)
23429 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23431 if (it
->line_wrap
!= TRUNCATE
23432 && x
+ glyph
->pixel_width
> max_x
)
23434 /* End of continued line or max_x reached. */
23435 if (CHAR_GLYPH_PADDING_P (*glyph
))
23437 /* A wide character is unbreakable. */
23438 if (row
->reversed_p
)
23439 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23440 - n_glyphs_before
);
23441 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23442 it
->current_x
= x_before
;
23446 if (row
->reversed_p
)
23447 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23448 - (n_glyphs_before
+ i
));
23449 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23454 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23456 /* Glyph is at least partially visible. */
23458 if (x
< it
->first_visible_x
)
23459 row
->x
= x
- it
->first_visible_x
;
23463 /* Glyph is off the left margin of the display area.
23464 Should not happen. */
23468 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23469 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23470 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23471 row
->phys_height
= max (row
->phys_height
,
23472 it
->max_phys_ascent
+ it
->max_phys_descent
);
23473 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23474 it
->max_extra_line_spacing
);
23475 x
+= glyph
->pixel_width
;
23479 /* Stop if max_x reached. */
23483 /* Stop at line ends. */
23484 if (ITERATOR_AT_END_OF_LINE_P (it
))
23486 it
->continuation_lines_width
= 0;
23490 set_iterator_to_next (it
, 1);
23491 if (STRINGP (it
->string
))
23492 it_charpos
= IT_STRING_CHARPOS (*it
);
23494 it_charpos
= IT_CHARPOS (*it
);
23496 /* Stop if truncating at the right edge. */
23497 if (it
->line_wrap
== TRUNCATE
23498 && it
->current_x
>= it
->last_visible_x
)
23500 /* Add truncation mark, but don't do it if the line is
23501 truncated at a padding space. */
23502 if (it_charpos
< it
->string_nchars
)
23504 if (!FRAME_WINDOW_P (it
->f
))
23508 if (it
->current_x
> it
->last_visible_x
)
23510 if (!row
->reversed_p
)
23512 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23513 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23518 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23519 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23521 unproduce_glyphs (it
, ii
+ 1);
23522 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23524 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23526 row
->used
[TEXT_AREA
] = ii
;
23527 produce_special_glyphs (it
, IT_TRUNCATION
);
23530 produce_special_glyphs (it
, IT_TRUNCATION
);
23532 row
->truncated_on_right_p
= 1;
23538 /* Maybe insert a truncation at the left. */
23539 if (it
->first_visible_x
23542 if (!FRAME_WINDOW_P (it
->f
)
23543 || (row
->reversed_p
23544 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23545 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23546 insert_left_trunc_glyphs (it
);
23547 row
->truncated_on_left_p
= 1;
23550 it
->face_id
= saved_face_id
;
23552 /* Value is number of columns displayed. */
23553 return it
->hpos
- hpos_at_start
;
23558 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23559 appears as an element of LIST or as the car of an element of LIST.
23560 If PROPVAL is a list, compare each element against LIST in that
23561 way, and return 1/2 if any element of PROPVAL is found in LIST.
23562 Otherwise return 0. This function cannot quit.
23563 The return value is 2 if the text is invisible but with an ellipsis
23564 and 1 if it's invisible and without an ellipsis. */
23567 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
23569 register Lisp_Object tail
, proptail
;
23571 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23573 register Lisp_Object tem
;
23575 if (EQ (propval
, tem
))
23577 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23578 return NILP (XCDR (tem
)) ? 1 : 2;
23581 if (CONSP (propval
))
23583 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23585 Lisp_Object propelt
;
23586 propelt
= XCAR (proptail
);
23587 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23589 register Lisp_Object tem
;
23591 if (EQ (propelt
, tem
))
23593 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23594 return NILP (XCDR (tem
)) ? 1 : 2;
23602 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23603 doc
: /* Non-nil if the property makes the text invisible.
23604 POS-OR-PROP can be a marker or number, in which case it is taken to be
23605 a position in the current buffer and the value of the `invisible' property
23606 is checked; or it can be some other value, which is then presumed to be the
23607 value of the `invisible' property of the text of interest.
23608 The non-nil value returned can be t for truly invisible text or something
23609 else if the text is replaced by an ellipsis. */)
23610 (Lisp_Object pos_or_prop
)
23613 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23614 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23616 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23617 return (invis
== 0 ? Qnil
23619 : make_number (invis
));
23622 /* Calculate a width or height in pixels from a specification using
23623 the following elements:
23626 NUM - a (fractional) multiple of the default font width/height
23627 (NUM) - specifies exactly NUM pixels
23628 UNIT - a fixed number of pixels, see below.
23629 ELEMENT - size of a display element in pixels, see below.
23630 (NUM . SPEC) - equals NUM * SPEC
23631 (+ SPEC SPEC ...) - add pixel values
23632 (- SPEC SPEC ...) - subtract pixel values
23633 (- SPEC) - negate pixel value
23636 INT or FLOAT - a number constant
23637 SYMBOL - use symbol's (buffer local) variable binding.
23640 in - pixels per inch *)
23641 mm - pixels per 1/1000 meter *)
23642 cm - pixels per 1/100 meter *)
23643 width - width of current font in pixels.
23644 height - height of current font in pixels.
23646 *) using the ratio(s) defined in display-pixels-per-inch.
23650 left-fringe - left fringe width in pixels
23651 right-fringe - right fringe width in pixels
23653 left-margin - left margin width in pixels
23654 right-margin - right margin width in pixels
23656 scroll-bar - scroll-bar area width in pixels
23660 Pixels corresponding to 5 inches:
23663 Total width of non-text areas on left side of window (if scroll-bar is on left):
23664 '(space :width (+ left-fringe left-margin scroll-bar))
23666 Align to first text column (in header line):
23667 '(space :align-to 0)
23669 Align to middle of text area minus half the width of variable `my-image'
23670 containing a loaded image:
23671 '(space :align-to (0.5 . (- text my-image)))
23673 Width of left margin minus width of 1 character in the default font:
23674 '(space :width (- left-margin 1))
23676 Width of left margin minus width of 2 characters in the current font:
23677 '(space :width (- left-margin (2 . width)))
23679 Center 1 character over left-margin (in header line):
23680 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23682 Different ways to express width of left fringe plus left margin minus one pixel:
23683 '(space :width (- (+ left-fringe left-margin) (1)))
23684 '(space :width (+ left-fringe left-margin (- (1))))
23685 '(space :width (+ left-fringe left-margin (-1)))
23690 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
23691 struct font
*font
, int width_p
, int *align_to
)
23695 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
23696 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
23699 return OK_PIXELS (0);
23701 eassert (FRAME_LIVE_P (it
->f
));
23703 if (SYMBOLP (prop
))
23705 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
23707 char *unit
= SSDATA (SYMBOL_NAME (prop
));
23709 if (unit
[0] == 'i' && unit
[1] == 'n')
23711 else if (unit
[0] == 'm' && unit
[1] == 'm')
23713 else if (unit
[0] == 'c' && unit
[1] == 'm')
23719 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
23720 : FRAME_RES_Y (it
->f
));
23723 return OK_PIXELS (ppi
/ pixels
);
23728 #ifdef HAVE_WINDOW_SYSTEM
23729 if (EQ (prop
, Qheight
))
23730 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
23731 if (EQ (prop
, Qwidth
))
23732 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
23734 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
23735 return OK_PIXELS (1);
23738 if (EQ (prop
, Qtext
))
23739 return OK_PIXELS (width_p
23740 ? window_box_width (it
->w
, TEXT_AREA
)
23741 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
23743 if (align_to
&& *align_to
< 0)
23746 if (EQ (prop
, Qleft
))
23747 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
23748 if (EQ (prop
, Qright
))
23749 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
23750 if (EQ (prop
, Qcenter
))
23751 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
23752 + window_box_width (it
->w
, TEXT_AREA
) / 2);
23753 if (EQ (prop
, Qleft_fringe
))
23754 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23755 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
23756 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
23757 if (EQ (prop
, Qright_fringe
))
23758 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23759 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23760 : window_box_right_offset (it
->w
, TEXT_AREA
));
23761 if (EQ (prop
, Qleft_margin
))
23762 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
23763 if (EQ (prop
, Qright_margin
))
23764 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
23765 if (EQ (prop
, Qscroll_bar
))
23766 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
23768 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23769 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23770 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23775 if (EQ (prop
, Qleft_fringe
))
23776 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
23777 if (EQ (prop
, Qright_fringe
))
23778 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
23779 if (EQ (prop
, Qleft_margin
))
23780 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
23781 if (EQ (prop
, Qright_margin
))
23782 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
23783 if (EQ (prop
, Qscroll_bar
))
23784 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
23787 prop
= buffer_local_value_1 (prop
, it
->w
->contents
);
23788 if (EQ (prop
, Qunbound
))
23792 if (INTEGERP (prop
) || FLOATP (prop
))
23794 int base_unit
= (width_p
23795 ? FRAME_COLUMN_WIDTH (it
->f
)
23796 : FRAME_LINE_HEIGHT (it
->f
));
23797 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
23802 Lisp_Object car
= XCAR (prop
);
23803 Lisp_Object cdr
= XCDR (prop
);
23807 #ifdef HAVE_WINDOW_SYSTEM
23808 if (FRAME_WINDOW_P (it
->f
)
23809 && valid_image_p (prop
))
23811 ptrdiff_t id
= lookup_image (it
->f
, prop
);
23812 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
23814 return OK_PIXELS (width_p
? img
->width
: img
->height
);
23817 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
23823 while (CONSP (cdr
))
23825 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
23826 font
, width_p
, align_to
))
23829 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
23834 if (EQ (car
, Qminus
))
23836 return OK_PIXELS (pixels
);
23839 car
= buffer_local_value_1 (car
, it
->w
->contents
);
23840 if (EQ (car
, Qunbound
))
23844 if (INTEGERP (car
) || FLOATP (car
))
23847 pixels
= XFLOATINT (car
);
23849 return OK_PIXELS (pixels
);
23850 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
23851 font
, width_p
, align_to
))
23852 return OK_PIXELS (pixels
* fact
);
23863 /***********************************************************************
23865 ***********************************************************************/
23867 #ifdef HAVE_WINDOW_SYSTEM
23872 dump_glyph_string (struct glyph_string
*s
)
23874 fprintf (stderr
, "glyph string\n");
23875 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
23876 s
->x
, s
->y
, s
->width
, s
->height
);
23877 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
23878 fprintf (stderr
, " hl = %d\n", s
->hl
);
23879 fprintf (stderr
, " left overhang = %d, right = %d\n",
23880 s
->left_overhang
, s
->right_overhang
);
23881 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
23882 fprintf (stderr
, " extends to end of line = %d\n",
23883 s
->extends_to_end_of_line_p
);
23884 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
23885 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
23888 #endif /* GLYPH_DEBUG */
23890 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
23891 of XChar2b structures for S; it can't be allocated in
23892 init_glyph_string because it must be allocated via `alloca'. W
23893 is the window on which S is drawn. ROW and AREA are the glyph row
23894 and area within the row from which S is constructed. START is the
23895 index of the first glyph structure covered by S. HL is a
23896 face-override for drawing S. */
23899 #define OPTIONAL_HDC(hdc) HDC hdc,
23900 #define DECLARE_HDC(hdc) HDC hdc;
23901 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
23902 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
23905 #ifndef OPTIONAL_HDC
23906 #define OPTIONAL_HDC(hdc)
23907 #define DECLARE_HDC(hdc)
23908 #define ALLOCATE_HDC(hdc, f)
23909 #define RELEASE_HDC(hdc, f)
23913 init_glyph_string (struct glyph_string
*s
,
23915 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
23916 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
23918 memset (s
, 0, sizeof *s
);
23920 s
->f
= XFRAME (w
->frame
);
23924 s
->display
= FRAME_X_DISPLAY (s
->f
);
23925 s
->window
= FRAME_X_WINDOW (s
->f
);
23926 s
->char2b
= char2b
;
23930 s
->first_glyph
= row
->glyphs
[area
] + start
;
23931 s
->height
= row
->height
;
23932 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
23933 s
->ybase
= s
->y
+ row
->ascent
;
23937 /* Append the list of glyph strings with head H and tail T to the list
23938 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
23941 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23942 struct glyph_string
*h
, struct glyph_string
*t
)
23956 /* Prepend the list of glyph strings with head H and tail T to the
23957 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
23961 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23962 struct glyph_string
*h
, struct glyph_string
*t
)
23976 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
23977 Set *HEAD and *TAIL to the resulting list. */
23980 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
23981 struct glyph_string
*s
)
23983 s
->next
= s
->prev
= NULL
;
23984 append_glyph_string_lists (head
, tail
, s
, s
);
23988 /* Get face and two-byte form of character C in face FACE_ID on frame F.
23989 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
23990 make sure that X resources for the face returned are allocated.
23991 Value is a pointer to a realized face that is ready for display if
23992 DISPLAY_P is non-zero. */
23994 static struct face
*
23995 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
23996 XChar2b
*char2b
, int display_p
)
23998 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24003 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24005 if (code
== FONT_INVALID_CODE
)
24008 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24010 /* Make sure X resources of the face are allocated. */
24011 #ifdef HAVE_X_WINDOWS
24015 eassert (face
!= NULL
);
24016 PREPARE_FACE_FOR_DISPLAY (f
, face
);
24023 /* Get face and two-byte form of character glyph GLYPH on frame F.
24024 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24025 a pointer to a realized face that is ready for display. */
24027 static struct face
*
24028 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24029 XChar2b
*char2b
, int *two_byte_p
)
24034 eassert (glyph
->type
== CHAR_GLYPH
);
24035 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24037 /* Make sure X resources of the face are allocated. */
24038 eassert (face
!= NULL
);
24039 PREPARE_FACE_FOR_DISPLAY (f
, face
);
24046 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24047 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24049 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24051 if (code
== FONT_INVALID_CODE
)
24055 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24060 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24061 Return 1 if FONT has a glyph for C, otherwise return 0. */
24064 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24068 if (CHAR_BYTE8_P (c
))
24069 code
= CHAR_TO_BYTE8 (c
);
24071 code
= font
->driver
->encode_char (font
, c
);
24073 if (code
== FONT_INVALID_CODE
)
24075 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24080 /* Fill glyph string S with composition components specified by S->cmp.
24082 BASE_FACE is the base face of the composition.
24083 S->cmp_from is the index of the first component for S.
24085 OVERLAPS non-zero means S should draw the foreground only, and use
24086 its physical height for clipping. See also draw_glyphs.
24088 Value is the index of a component not in S. */
24091 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24095 /* For all glyphs of this composition, starting at the offset
24096 S->cmp_from, until we reach the end of the definition or encounter a
24097 glyph that requires the different face, add it to S. */
24102 s
->for_overlaps
= overlaps
;
24105 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24107 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24109 /* TAB in a composition means display glyphs with padding space
24110 on the left or right. */
24113 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24116 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24123 s
->font
= s
->face
->font
;
24125 else if (s
->face
!= face
)
24133 if (s
->face
== NULL
)
24135 s
->face
= base_face
->ascii_face
;
24136 s
->font
= s
->face
->font
;
24139 /* All glyph strings for the same composition has the same width,
24140 i.e. the width set for the first component of the composition. */
24141 s
->width
= s
->first_glyph
->pixel_width
;
24143 /* If the specified font could not be loaded, use the frame's
24144 default font, but record the fact that we couldn't load it in
24145 the glyph string so that we can draw rectangles for the
24146 characters of the glyph string. */
24147 if (s
->font
== NULL
)
24149 s
->font_not_found_p
= 1;
24150 s
->font
= FRAME_FONT (s
->f
);
24153 /* Adjust base line for subscript/superscript text. */
24154 s
->ybase
+= s
->first_glyph
->voffset
;
24156 /* This glyph string must always be drawn with 16-bit functions. */
24163 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24164 int start
, int end
, int overlaps
)
24166 struct glyph
*glyph
, *last
;
24167 Lisp_Object lgstring
;
24170 s
->for_overlaps
= overlaps
;
24171 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24172 last
= s
->row
->glyphs
[s
->area
] + end
;
24173 s
->cmp_id
= glyph
->u
.cmp
.id
;
24174 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24175 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24176 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24177 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24178 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24180 while (glyph
< last
24181 && glyph
->u
.cmp
.automatic
24182 && glyph
->u
.cmp
.id
== s
->cmp_id
24183 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24184 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24186 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24188 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24189 unsigned code
= LGLYPH_CODE (lglyph
);
24191 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24193 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24194 return glyph
- s
->row
->glyphs
[s
->area
];
24198 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24199 See the comment of fill_glyph_string for arguments.
24200 Value is the index of the first glyph not in S. */
24204 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24205 int start
, int end
, int overlaps
)
24207 struct glyph
*glyph
, *last
;
24210 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24211 s
->for_overlaps
= overlaps
;
24212 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24213 last
= s
->row
->glyphs
[s
->area
] + end
;
24214 voffset
= glyph
->voffset
;
24215 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24216 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24218 s
->width
= glyph
->pixel_width
;
24220 while (glyph
< last
24221 && glyph
->type
== GLYPHLESS_GLYPH
24222 && glyph
->voffset
== voffset
24223 && glyph
->face_id
== face_id
)
24226 s
->width
+= glyph
->pixel_width
;
24229 s
->ybase
+= voffset
;
24230 return glyph
- s
->row
->glyphs
[s
->area
];
24234 /* Fill glyph string S from a sequence of character glyphs.
24236 FACE_ID is the face id of the string. START is the index of the
24237 first glyph to consider, END is the index of the last + 1.
24238 OVERLAPS non-zero means S should draw the foreground only, and use
24239 its physical height for clipping. See also draw_glyphs.
24241 Value is the index of the first glyph not in S. */
24244 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24245 int start
, int end
, int overlaps
)
24247 struct glyph
*glyph
, *last
;
24249 int glyph_not_available_p
;
24251 eassert (s
->f
== XFRAME (s
->w
->frame
));
24252 eassert (s
->nchars
== 0);
24253 eassert (start
>= 0 && end
> start
);
24255 s
->for_overlaps
= overlaps
;
24256 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24257 last
= s
->row
->glyphs
[s
->area
] + end
;
24258 voffset
= glyph
->voffset
;
24259 s
->padding_p
= glyph
->padding_p
;
24260 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24262 while (glyph
< last
24263 && glyph
->type
== CHAR_GLYPH
24264 && glyph
->voffset
== voffset
24265 /* Same face id implies same font, nowadays. */
24266 && glyph
->face_id
== face_id
24267 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24271 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24272 s
->char2b
+ s
->nchars
,
24274 s
->two_byte_p
= two_byte_p
;
24276 eassert (s
->nchars
<= end
- start
);
24277 s
->width
+= glyph
->pixel_width
;
24278 if (glyph
++->padding_p
!= s
->padding_p
)
24282 s
->font
= s
->face
->font
;
24284 /* If the specified font could not be loaded, use the frame's font,
24285 but record the fact that we couldn't load it in
24286 S->font_not_found_p so that we can draw rectangles for the
24287 characters of the glyph string. */
24288 if (s
->font
== NULL
|| glyph_not_available_p
)
24290 s
->font_not_found_p
= 1;
24291 s
->font
= FRAME_FONT (s
->f
);
24294 /* Adjust base line for subscript/superscript text. */
24295 s
->ybase
+= voffset
;
24297 eassert (s
->face
&& s
->face
->gc
);
24298 return glyph
- s
->row
->glyphs
[s
->area
];
24302 /* Fill glyph string S from image glyph S->first_glyph. */
24305 fill_image_glyph_string (struct glyph_string
*s
)
24307 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24308 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24310 s
->slice
= s
->first_glyph
->slice
.img
;
24311 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24312 s
->font
= s
->face
->font
;
24313 s
->width
= s
->first_glyph
->pixel_width
;
24315 /* Adjust base line for subscript/superscript text. */
24316 s
->ybase
+= s
->first_glyph
->voffset
;
24320 /* Fill glyph string S from a sequence of stretch glyphs.
24322 START is the index of the first glyph to consider,
24323 END is the index of the last + 1.
24325 Value is the index of the first glyph not in S. */
24328 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24330 struct glyph
*glyph
, *last
;
24331 int voffset
, face_id
;
24333 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24335 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24336 last
= s
->row
->glyphs
[s
->area
] + end
;
24337 face_id
= glyph
->face_id
;
24338 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24339 s
->font
= s
->face
->font
;
24340 s
->width
= glyph
->pixel_width
;
24342 voffset
= glyph
->voffset
;
24346 && glyph
->type
== STRETCH_GLYPH
24347 && glyph
->voffset
== voffset
24348 && glyph
->face_id
== face_id
);
24350 s
->width
+= glyph
->pixel_width
;
24352 /* Adjust base line for subscript/superscript text. */
24353 s
->ybase
+= voffset
;
24355 /* The case that face->gc == 0 is handled when drawing the glyph
24356 string by calling PREPARE_FACE_FOR_DISPLAY. */
24358 return glyph
- s
->row
->glyphs
[s
->area
];
24361 static struct font_metrics
*
24362 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24364 static struct font_metrics metrics
;
24369 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24370 if (code
== FONT_INVALID_CODE
)
24372 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24377 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24378 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24379 assumed to be zero. */
24382 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24384 *left
= *right
= 0;
24386 if (glyph
->type
== CHAR_GLYPH
)
24390 struct font_metrics
*pcm
;
24392 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
24393 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
24395 if (pcm
->rbearing
> pcm
->width
)
24396 *right
= pcm
->rbearing
- pcm
->width
;
24397 if (pcm
->lbearing
< 0)
24398 *left
= -pcm
->lbearing
;
24401 else if (glyph
->type
== COMPOSITE_GLYPH
)
24403 if (! glyph
->u
.cmp
.automatic
)
24405 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24407 if (cmp
->rbearing
> cmp
->pixel_width
)
24408 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24409 if (cmp
->lbearing
< 0)
24410 *left
= - cmp
->lbearing
;
24414 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24415 struct font_metrics metrics
;
24417 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24418 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24419 if (metrics
.rbearing
> metrics
.width
)
24420 *right
= metrics
.rbearing
- metrics
.width
;
24421 if (metrics
.lbearing
< 0)
24422 *left
= - metrics
.lbearing
;
24428 /* Return the index of the first glyph preceding glyph string S that
24429 is overwritten by S because of S's left overhang. Value is -1
24430 if no glyphs are overwritten. */
24433 left_overwritten (struct glyph_string
*s
)
24437 if (s
->left_overhang
)
24440 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24441 int first
= s
->first_glyph
- glyphs
;
24443 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24444 x
-= glyphs
[i
].pixel_width
;
24455 /* Return the index of the first glyph preceding glyph string S that
24456 is overwriting S because of its right overhang. Value is -1 if no
24457 glyph in front of S overwrites S. */
24460 left_overwriting (struct glyph_string
*s
)
24463 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24464 int first
= s
->first_glyph
- glyphs
;
24468 for (i
= first
- 1; i
>= 0; --i
)
24471 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24474 x
-= glyphs
[i
].pixel_width
;
24481 /* Return the index of the last glyph following glyph string S that is
24482 overwritten by S because of S's right overhang. Value is -1 if
24483 no such glyph is found. */
24486 right_overwritten (struct glyph_string
*s
)
24490 if (s
->right_overhang
)
24493 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24494 int first
= (s
->first_glyph
- glyphs
24495 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24496 int end
= s
->row
->used
[s
->area
];
24498 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24499 x
+= glyphs
[i
].pixel_width
;
24508 /* Return the index of the last glyph following glyph string S that
24509 overwrites S because of its left overhang. Value is negative
24510 if no such glyph is found. */
24513 right_overwriting (struct glyph_string
*s
)
24516 int end
= s
->row
->used
[s
->area
];
24517 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24518 int first
= (s
->first_glyph
- glyphs
24519 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24523 for (i
= first
; i
< end
; ++i
)
24526 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24529 x
+= glyphs
[i
].pixel_width
;
24536 /* Set background width of glyph string S. START is the index of the
24537 first glyph following S. LAST_X is the right-most x-position + 1
24538 in the drawing area. */
24541 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24543 /* If the face of this glyph string has to be drawn to the end of
24544 the drawing area, set S->extends_to_end_of_line_p. */
24546 if (start
== s
->row
->used
[s
->area
]
24547 && ((s
->row
->fill_line_p
24548 && (s
->hl
== DRAW_NORMAL_TEXT
24549 || s
->hl
== DRAW_IMAGE_RAISED
24550 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24551 || s
->hl
== DRAW_MOUSE_FACE
))
24552 s
->extends_to_end_of_line_p
= 1;
24554 /* If S extends its face to the end of the line, set its
24555 background_width to the distance to the right edge of the drawing
24557 if (s
->extends_to_end_of_line_p
)
24558 s
->background_width
= last_x
- s
->x
+ 1;
24560 s
->background_width
= s
->width
;
24564 /* Compute overhangs and x-positions for glyph string S and its
24565 predecessors, or successors. X is the starting x-position for S.
24566 BACKWARD_P non-zero means process predecessors. */
24569 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
24575 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24576 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24586 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24587 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24597 /* The following macros are only called from draw_glyphs below.
24598 They reference the following parameters of that function directly:
24599 `w', `row', `area', and `overlap_p'
24600 as well as the following local variables:
24601 `s', `f', and `hdc' (in W32) */
24604 /* On W32, silently add local `hdc' variable to argument list of
24605 init_glyph_string. */
24606 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24607 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24609 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24610 init_glyph_string (s, char2b, w, row, area, start, hl)
24613 /* Add a glyph string for a stretch glyph to the list of strings
24614 between HEAD and TAIL. START is the index of the stretch glyph in
24615 row area AREA of glyph row ROW. END is the index of the last glyph
24616 in that glyph row area. X is the current output position assigned
24617 to the new glyph string constructed. HL overrides that face of the
24618 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24619 is the right-most x-position of the drawing area. */
24621 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24622 and below -- keep them on one line. */
24623 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24626 s = alloca (sizeof *s); \
24627 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24628 START = fill_stretch_glyph_string (s, START, END); \
24629 append_glyph_string (&HEAD, &TAIL, s); \
24635 /* Add a glyph string for an image glyph to the list of strings
24636 between HEAD and TAIL. START is the index of the image glyph in
24637 row area AREA of glyph row ROW. END is the index of the last glyph
24638 in that glyph row area. X is the current output position assigned
24639 to the new glyph string constructed. HL overrides that face of the
24640 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24641 is the right-most x-position of the drawing area. */
24643 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24646 s = alloca (sizeof *s); \
24647 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24648 fill_image_glyph_string (s); \
24649 append_glyph_string (&HEAD, &TAIL, s); \
24656 /* Add a glyph string for a sequence of character glyphs to the list
24657 of strings between HEAD and TAIL. START is the index of the first
24658 glyph in row area AREA of glyph row ROW that is part of the new
24659 glyph string. END is the index of the last glyph in that glyph row
24660 area. X is the current output position assigned to the new glyph
24661 string constructed. HL overrides that face of the glyph; e.g. it
24662 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24663 right-most x-position of the drawing area. */
24665 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24671 face_id = (row)->glyphs[area][START].face_id; \
24673 s = alloca (sizeof *s); \
24674 char2b = alloca ((END - START) * sizeof *char2b); \
24675 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24676 append_glyph_string (&HEAD, &TAIL, s); \
24678 START = fill_glyph_string (s, face_id, START, END, overlaps); \
24683 /* Add a glyph string for a composite sequence to the list of strings
24684 between HEAD and TAIL. START is the index of the first glyph in
24685 row area AREA of glyph row ROW that is part of the new glyph
24686 string. END is the index of the last glyph in that glyph row area.
24687 X is the current output position assigned to the new glyph string
24688 constructed. HL overrides that face of the glyph; e.g. it is
24689 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
24690 x-position of the drawing area. */
24692 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24694 int face_id = (row)->glyphs[area][START].face_id; \
24695 struct face *base_face = FACE_FROM_ID (f, face_id); \
24696 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
24697 struct composition *cmp = composition_table[cmp_id]; \
24699 struct glyph_string *first_s = NULL; \
24702 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
24704 /* Make glyph_strings for each glyph sequence that is drawable by \
24705 the same face, and append them to HEAD/TAIL. */ \
24706 for (n = 0; n < cmp->glyph_len;) \
24708 s = alloca (sizeof *s); \
24709 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24710 append_glyph_string (&(HEAD), &(TAIL), s); \
24716 n = fill_composite_glyph_string (s, base_face, overlaps); \
24724 /* Add a glyph string for a glyph-string sequence to the list of strings
24725 between HEAD and TAIL. */
24727 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24731 Lisp_Object gstring; \
24733 face_id = (row)->glyphs[area][START].face_id; \
24734 gstring = (composition_gstring_from_id \
24735 ((row)->glyphs[area][START].u.cmp.id)); \
24736 s = alloca (sizeof *s); \
24737 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
24738 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24739 append_glyph_string (&(HEAD), &(TAIL), s); \
24741 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
24745 /* Add a glyph string for a sequence of glyphless character's glyphs
24746 to the list of strings between HEAD and TAIL. The meanings of
24747 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
24749 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24754 face_id = (row)->glyphs[area][START].face_id; \
24756 s = alloca (sizeof *s); \
24757 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24758 append_glyph_string (&HEAD, &TAIL, s); \
24760 START = fill_glyphless_glyph_string (s, face_id, START, END, \
24766 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
24767 of AREA of glyph row ROW on window W between indices START and END.
24768 HL overrides the face for drawing glyph strings, e.g. it is
24769 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
24770 x-positions of the drawing area.
24772 This is an ugly monster macro construct because we must use alloca
24773 to allocate glyph strings (because draw_glyphs can be called
24774 asynchronously). */
24776 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24779 HEAD = TAIL = NULL; \
24780 while (START < END) \
24782 struct glyph *first_glyph = (row)->glyphs[area] + START; \
24783 switch (first_glyph->type) \
24786 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
24790 case COMPOSITE_GLYPH: \
24791 if (first_glyph->u.cmp.automatic) \
24792 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
24795 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
24799 case STRETCH_GLYPH: \
24800 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
24804 case IMAGE_GLYPH: \
24805 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
24809 case GLYPHLESS_GLYPH: \
24810 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
24820 set_glyph_string_background_width (s, START, LAST_X); \
24827 /* Draw glyphs between START and END in AREA of ROW on window W,
24828 starting at x-position X. X is relative to AREA in W. HL is a
24829 face-override with the following meaning:
24831 DRAW_NORMAL_TEXT draw normally
24832 DRAW_CURSOR draw in cursor face
24833 DRAW_MOUSE_FACE draw in mouse face.
24834 DRAW_INVERSE_VIDEO draw in mode line face
24835 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
24836 DRAW_IMAGE_RAISED draw an image with a raised relief around it
24838 If OVERLAPS is non-zero, draw only the foreground of characters and
24839 clip to the physical height of ROW. Non-zero value also defines
24840 the overlapping part to be drawn:
24842 OVERLAPS_PRED overlap with preceding rows
24843 OVERLAPS_SUCC overlap with succeeding rows
24844 OVERLAPS_BOTH overlap with both preceding/succeeding rows
24845 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
24847 Value is the x-position reached, relative to AREA of W. */
24850 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
24851 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
24852 enum draw_glyphs_face hl
, int overlaps
)
24854 struct glyph_string
*head
, *tail
;
24855 struct glyph_string
*s
;
24856 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
24857 int i
, j
, x_reached
, last_x
, area_left
= 0;
24858 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24861 ALLOCATE_HDC (hdc
, f
);
24863 /* Let's rather be paranoid than getting a SEGV. */
24864 end
= min (end
, row
->used
[area
]);
24865 start
= clip_to_bounds (0, start
, end
);
24867 /* Translate X to frame coordinates. Set last_x to the right
24868 end of the drawing area. */
24869 if (row
->full_width_p
)
24871 /* X is relative to the left edge of W, without scroll bars
24873 area_left
= WINDOW_LEFT_EDGE_X (w
);
24874 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
24875 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
24879 area_left
= window_box_left (w
, area
);
24880 last_x
= area_left
+ window_box_width (w
, area
);
24884 /* Build a doubly-linked list of glyph_string structures between
24885 head and tail from what we have to draw. Note that the macro
24886 BUILD_GLYPH_STRINGS will modify its start parameter. That's
24887 the reason we use a separate variable `i'. */
24889 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
24891 x_reached
= tail
->x
+ tail
->background_width
;
24895 /* If there are any glyphs with lbearing < 0 or rbearing > width in
24896 the row, redraw some glyphs in front or following the glyph
24897 strings built above. */
24898 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
24900 struct glyph_string
*h
, *t
;
24901 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24902 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
24903 int check_mouse_face
= 0;
24906 /* If mouse highlighting is on, we may need to draw adjacent
24907 glyphs using mouse-face highlighting. */
24908 if (area
== TEXT_AREA
&& row
->mouse_face_p
24909 && hlinfo
->mouse_face_beg_row
>= 0
24910 && hlinfo
->mouse_face_end_row
>= 0)
24912 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
24914 if (row_vpos
>= hlinfo
->mouse_face_beg_row
24915 && row_vpos
<= hlinfo
->mouse_face_end_row
)
24917 check_mouse_face
= 1;
24918 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
24919 ? hlinfo
->mouse_face_beg_col
: 0;
24920 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
24921 ? hlinfo
->mouse_face_end_col
24922 : row
->used
[TEXT_AREA
];
24926 /* Compute overhangs for all glyph strings. */
24927 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
24928 for (s
= head
; s
; s
= s
->next
)
24929 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
24931 /* Prepend glyph strings for glyphs in front of the first glyph
24932 string that are overwritten because of the first glyph
24933 string's left overhang. The background of all strings
24934 prepended must be drawn because the first glyph string
24936 i
= left_overwritten (head
);
24939 enum draw_glyphs_face overlap_hl
;
24941 /* If this row contains mouse highlighting, attempt to draw
24942 the overlapped glyphs with the correct highlight. This
24943 code fails if the overlap encompasses more than one glyph
24944 and mouse-highlight spans only some of these glyphs.
24945 However, making it work perfectly involves a lot more
24946 code, and I don't know if the pathological case occurs in
24947 practice, so we'll stick to this for now. --- cyd */
24948 if (check_mouse_face
24949 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24950 overlap_hl
= DRAW_MOUSE_FACE
;
24952 overlap_hl
= DRAW_NORMAL_TEXT
;
24954 if (hl
!= overlap_hl
)
24957 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
24958 overlap_hl
, dummy_x
, last_x
);
24960 compute_overhangs_and_x (t
, head
->x
, 1);
24961 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24962 if (clip_head
== NULL
)
24966 /* Prepend glyph strings for glyphs in front of the first glyph
24967 string that overwrite that glyph string because of their
24968 right overhang. For these strings, only the foreground must
24969 be drawn, because it draws over the glyph string at `head'.
24970 The background must not be drawn because this would overwrite
24971 right overhangs of preceding glyphs for which no glyph
24973 i
= left_overwriting (head
);
24976 enum draw_glyphs_face overlap_hl
;
24978 if (check_mouse_face
24979 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24980 overlap_hl
= DRAW_MOUSE_FACE
;
24982 overlap_hl
= DRAW_NORMAL_TEXT
;
24984 if (hl
== overlap_hl
|| clip_head
== NULL
)
24986 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
24987 overlap_hl
, dummy_x
, last_x
);
24988 for (s
= h
; s
; s
= s
->next
)
24989 s
->background_filled_p
= 1;
24990 compute_overhangs_and_x (t
, head
->x
, 1);
24991 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24994 /* Append glyphs strings for glyphs following the last glyph
24995 string tail that are overwritten by tail. The background of
24996 these strings has to be drawn because tail's foreground draws
24998 i
= right_overwritten (tail
);
25001 enum draw_glyphs_face overlap_hl
;
25003 if (check_mouse_face
25004 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25005 overlap_hl
= DRAW_MOUSE_FACE
;
25007 overlap_hl
= DRAW_NORMAL_TEXT
;
25009 if (hl
!= overlap_hl
)
25011 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25012 overlap_hl
, x
, last_x
);
25013 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25014 we don't have `end = i;' here. */
25015 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
25016 append_glyph_string_lists (&head
, &tail
, h
, t
);
25017 if (clip_tail
== NULL
)
25021 /* Append glyph strings for glyphs following the last glyph
25022 string tail that overwrite tail. The foreground of such
25023 glyphs has to be drawn because it writes into the background
25024 of tail. The background must not be drawn because it could
25025 paint over the foreground of following glyphs. */
25026 i
= right_overwriting (tail
);
25029 enum draw_glyphs_face overlap_hl
;
25030 if (check_mouse_face
25031 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25032 overlap_hl
= DRAW_MOUSE_FACE
;
25034 overlap_hl
= DRAW_NORMAL_TEXT
;
25036 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25038 i
++; /* We must include the Ith glyph. */
25039 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25040 overlap_hl
, x
, last_x
);
25041 for (s
= h
; s
; s
= s
->next
)
25042 s
->background_filled_p
= 1;
25043 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
25044 append_glyph_string_lists (&head
, &tail
, h
, t
);
25046 if (clip_head
|| clip_tail
)
25047 for (s
= head
; s
; s
= s
->next
)
25049 s
->clip_head
= clip_head
;
25050 s
->clip_tail
= clip_tail
;
25054 /* Draw all strings. */
25055 for (s
= head
; s
; s
= s
->next
)
25056 FRAME_RIF (f
)->draw_glyph_string (s
);
25059 /* When focus a sole frame and move horizontally, this sets on_p to 0
25060 causing a failure to erase prev cursor position. */
25061 if (area
== TEXT_AREA
25062 && !row
->full_width_p
25063 /* When drawing overlapping rows, only the glyph strings'
25064 foreground is drawn, which doesn't erase a cursor
25068 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25069 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25070 : (tail
? tail
->x
+ tail
->background_width
: x
));
25074 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25075 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25079 /* Value is the x-position up to which drawn, relative to AREA of W.
25080 This doesn't include parts drawn because of overhangs. */
25081 if (row
->full_width_p
)
25082 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25084 x_reached
-= area_left
;
25086 RELEASE_HDC (hdc
, f
);
25091 /* Expand row matrix if too narrow. Don't expand if area
25094 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25096 if (!it->f->fonts_changed \
25097 && (it->glyph_row->glyphs[area] \
25098 < it->glyph_row->glyphs[area + 1])) \
25100 it->w->ncols_scale_factor++; \
25101 it->f->fonts_changed = 1; \
25105 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25106 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25109 append_glyph (struct it
*it
)
25111 struct glyph
*glyph
;
25112 enum glyph_row_area area
= it
->area
;
25114 eassert (it
->glyph_row
);
25115 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25117 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25118 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25120 /* If the glyph row is reversed, we need to prepend the glyph
25121 rather than append it. */
25122 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25126 /* Make room for the additional glyph. */
25127 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25129 glyph
= it
->glyph_row
->glyphs
[area
];
25131 glyph
->charpos
= CHARPOS (it
->position
);
25132 glyph
->object
= it
->object
;
25133 if (it
->pixel_width
> 0)
25135 glyph
->pixel_width
= it
->pixel_width
;
25136 glyph
->padding_p
= 0;
25140 /* Assure at least 1-pixel width. Otherwise, cursor can't
25141 be displayed correctly. */
25142 glyph
->pixel_width
= 1;
25143 glyph
->padding_p
= 1;
25145 glyph
->ascent
= it
->ascent
;
25146 glyph
->descent
= it
->descent
;
25147 glyph
->voffset
= it
->voffset
;
25148 glyph
->type
= CHAR_GLYPH
;
25149 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25150 glyph
->multibyte_p
= it
->multibyte_p
;
25151 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25153 /* In R2L rows, the left and the right box edges need to be
25154 drawn in reverse direction. */
25155 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25156 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25160 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25161 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25163 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25164 || it
->phys_descent
> it
->descent
);
25165 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25166 glyph
->face_id
= it
->face_id
;
25167 glyph
->u
.ch
= it
->char_to_display
;
25168 glyph
->slice
.img
= null_glyph_slice
;
25169 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25172 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25173 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25175 glyph
->bidi_type
= it
->bidi_it
.type
;
25179 glyph
->resolved_level
= 0;
25180 glyph
->bidi_type
= UNKNOWN_BT
;
25182 ++it
->glyph_row
->used
[area
];
25185 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25188 /* Store one glyph for the composition IT->cmp_it.id in
25189 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25193 append_composite_glyph (struct it
*it
)
25195 struct glyph
*glyph
;
25196 enum glyph_row_area area
= it
->area
;
25198 eassert (it
->glyph_row
);
25200 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25201 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25203 /* If the glyph row is reversed, we need to prepend the glyph
25204 rather than append it. */
25205 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25209 /* Make room for the new glyph. */
25210 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25212 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25214 glyph
->charpos
= it
->cmp_it
.charpos
;
25215 glyph
->object
= it
->object
;
25216 glyph
->pixel_width
= it
->pixel_width
;
25217 glyph
->ascent
= it
->ascent
;
25218 glyph
->descent
= it
->descent
;
25219 glyph
->voffset
= it
->voffset
;
25220 glyph
->type
= COMPOSITE_GLYPH
;
25221 if (it
->cmp_it
.ch
< 0)
25223 glyph
->u
.cmp
.automatic
= 0;
25224 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25225 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25229 glyph
->u
.cmp
.automatic
= 1;
25230 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25231 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25232 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25234 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25235 glyph
->multibyte_p
= it
->multibyte_p
;
25236 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25238 /* In R2L rows, the left and the right box edges need to be
25239 drawn in reverse direction. */
25240 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25241 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25245 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25246 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25248 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25249 || it
->phys_descent
> it
->descent
);
25250 glyph
->padding_p
= 0;
25251 glyph
->glyph_not_available_p
= 0;
25252 glyph
->face_id
= it
->face_id
;
25253 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25256 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25257 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25259 glyph
->bidi_type
= it
->bidi_it
.type
;
25261 ++it
->glyph_row
->used
[area
];
25264 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25268 /* Change IT->ascent and IT->height according to the setting of
25272 take_vertical_position_into_account (struct it
*it
)
25276 if (it
->voffset
< 0)
25277 /* Increase the ascent so that we can display the text higher
25279 it
->ascent
-= it
->voffset
;
25281 /* Increase the descent so that we can display the text lower
25283 it
->descent
+= it
->voffset
;
25288 /* Produce glyphs/get display metrics for the image IT is loaded with.
25289 See the description of struct display_iterator in dispextern.h for
25290 an overview of struct display_iterator. */
25293 produce_image_glyph (struct it
*it
)
25297 int glyph_ascent
, crop
;
25298 struct glyph_slice slice
;
25300 eassert (it
->what
== IT_IMAGE
);
25302 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25304 /* Make sure X resources of the face is loaded. */
25305 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
25307 if (it
->image_id
< 0)
25309 /* Fringe bitmap. */
25310 it
->ascent
= it
->phys_ascent
= 0;
25311 it
->descent
= it
->phys_descent
= 0;
25312 it
->pixel_width
= 0;
25317 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25319 /* Make sure X resources of the image is loaded. */
25320 prepare_image_for_display (it
->f
, img
);
25322 slice
.x
= slice
.y
= 0;
25323 slice
.width
= img
->width
;
25324 slice
.height
= img
->height
;
25326 if (INTEGERP (it
->slice
.x
))
25327 slice
.x
= XINT (it
->slice
.x
);
25328 else if (FLOATP (it
->slice
.x
))
25329 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25331 if (INTEGERP (it
->slice
.y
))
25332 slice
.y
= XINT (it
->slice
.y
);
25333 else if (FLOATP (it
->slice
.y
))
25334 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25336 if (INTEGERP (it
->slice
.width
))
25337 slice
.width
= XINT (it
->slice
.width
);
25338 else if (FLOATP (it
->slice
.width
))
25339 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25341 if (INTEGERP (it
->slice
.height
))
25342 slice
.height
= XINT (it
->slice
.height
);
25343 else if (FLOATP (it
->slice
.height
))
25344 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25346 if (slice
.x
>= img
->width
)
25347 slice
.x
= img
->width
;
25348 if (slice
.y
>= img
->height
)
25349 slice
.y
= img
->height
;
25350 if (slice
.x
+ slice
.width
>= img
->width
)
25351 slice
.width
= img
->width
- slice
.x
;
25352 if (slice
.y
+ slice
.height
> img
->height
)
25353 slice
.height
= img
->height
- slice
.y
;
25355 if (slice
.width
== 0 || slice
.height
== 0)
25358 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25360 it
->descent
= slice
.height
- glyph_ascent
;
25362 it
->descent
+= img
->vmargin
;
25363 if (slice
.y
+ slice
.height
== img
->height
)
25364 it
->descent
+= img
->vmargin
;
25365 it
->phys_descent
= it
->descent
;
25367 it
->pixel_width
= slice
.width
;
25369 it
->pixel_width
+= img
->hmargin
;
25370 if (slice
.x
+ slice
.width
== img
->width
)
25371 it
->pixel_width
+= img
->hmargin
;
25373 /* It's quite possible for images to have an ascent greater than
25374 their height, so don't get confused in that case. */
25375 if (it
->descent
< 0)
25380 if (face
->box
!= FACE_NO_BOX
)
25382 if (face
->box_line_width
> 0)
25385 it
->ascent
+= face
->box_line_width
;
25386 if (slice
.y
+ slice
.height
== img
->height
)
25387 it
->descent
+= face
->box_line_width
;
25390 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25391 it
->pixel_width
+= eabs (face
->box_line_width
);
25392 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25393 it
->pixel_width
+= eabs (face
->box_line_width
);
25396 take_vertical_position_into_account (it
);
25398 /* Automatically crop wide image glyphs at right edge so we can
25399 draw the cursor on same display row. */
25400 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25401 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25403 it
->pixel_width
-= crop
;
25404 slice
.width
-= crop
;
25409 struct glyph
*glyph
;
25410 enum glyph_row_area area
= it
->area
;
25412 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25413 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25415 glyph
->charpos
= CHARPOS (it
->position
);
25416 glyph
->object
= it
->object
;
25417 glyph
->pixel_width
= it
->pixel_width
;
25418 glyph
->ascent
= glyph_ascent
;
25419 glyph
->descent
= it
->descent
;
25420 glyph
->voffset
= it
->voffset
;
25421 glyph
->type
= IMAGE_GLYPH
;
25422 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25423 glyph
->multibyte_p
= it
->multibyte_p
;
25424 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25426 /* In R2L rows, the left and the right box edges need to be
25427 drawn in reverse direction. */
25428 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25429 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25433 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25434 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25436 glyph
->overlaps_vertically_p
= 0;
25437 glyph
->padding_p
= 0;
25438 glyph
->glyph_not_available_p
= 0;
25439 glyph
->face_id
= it
->face_id
;
25440 glyph
->u
.img_id
= img
->id
;
25441 glyph
->slice
.img
= slice
;
25442 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25445 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25446 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25448 glyph
->bidi_type
= it
->bidi_it
.type
;
25450 ++it
->glyph_row
->used
[area
];
25453 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25458 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25459 of the glyph, WIDTH and HEIGHT are the width and height of the
25460 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25463 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25464 int width
, int height
, int ascent
)
25466 struct glyph
*glyph
;
25467 enum glyph_row_area area
= it
->area
;
25469 eassert (ascent
>= 0 && ascent
<= height
);
25471 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25472 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25474 /* If the glyph row is reversed, we need to prepend the glyph
25475 rather than append it. */
25476 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25480 /* Make room for the additional glyph. */
25481 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25483 glyph
= it
->glyph_row
->glyphs
[area
];
25485 /* Decrease the width of the first glyph of the row that
25486 begins before first_visible_x (e.g., due to hscroll).
25487 This is so the overall width of the row becomes smaller
25488 by the scroll amount, and the stretch glyph appended by
25489 extend_face_to_end_of_line will be wider, to shift the
25490 row glyphs to the right. (In L2R rows, the corresponding
25491 left-shift effect is accomplished by setting row->x to a
25492 negative value, which won't work with R2L rows.)
25494 This must leave us with a positive value of WIDTH, since
25495 otherwise the call to move_it_in_display_line_to at the
25496 beginning of display_line would have got past the entire
25497 first glyph, and then it->current_x would have been
25498 greater or equal to it->first_visible_x. */
25499 if (it
->current_x
< it
->first_visible_x
)
25500 width
-= it
->first_visible_x
- it
->current_x
;
25501 eassert (width
> 0);
25503 glyph
->charpos
= CHARPOS (it
->position
);
25504 glyph
->object
= object
;
25505 glyph
->pixel_width
= width
;
25506 glyph
->ascent
= ascent
;
25507 glyph
->descent
= height
- ascent
;
25508 glyph
->voffset
= it
->voffset
;
25509 glyph
->type
= STRETCH_GLYPH
;
25510 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25511 glyph
->multibyte_p
= it
->multibyte_p
;
25512 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25514 /* In R2L rows, the left and the right box edges need to be
25515 drawn in reverse direction. */
25516 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25517 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25521 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25522 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25524 glyph
->overlaps_vertically_p
= 0;
25525 glyph
->padding_p
= 0;
25526 glyph
->glyph_not_available_p
= 0;
25527 glyph
->face_id
= it
->face_id
;
25528 glyph
->u
.stretch
.ascent
= ascent
;
25529 glyph
->u
.stretch
.height
= height
;
25530 glyph
->slice
.img
= null_glyph_slice
;
25531 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25534 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25535 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25537 glyph
->bidi_type
= it
->bidi_it
.type
;
25541 glyph
->resolved_level
= 0;
25542 glyph
->bidi_type
= UNKNOWN_BT
;
25544 ++it
->glyph_row
->used
[area
];
25547 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25550 #endif /* HAVE_WINDOW_SYSTEM */
25552 /* Produce a stretch glyph for iterator IT. IT->object is the value
25553 of the glyph property displayed. The value must be a list
25554 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25557 1. `:width WIDTH' specifies that the space should be WIDTH *
25558 canonical char width wide. WIDTH may be an integer or floating
25561 2. `:relative-width FACTOR' specifies that the width of the stretch
25562 should be computed from the width of the first character having the
25563 `glyph' property, and should be FACTOR times that width.
25565 3. `:align-to HPOS' specifies that the space should be wide enough
25566 to reach HPOS, a value in canonical character units.
25568 Exactly one of the above pairs must be present.
25570 4. `:height HEIGHT' specifies that the height of the stretch produced
25571 should be HEIGHT, measured in canonical character units.
25573 5. `:relative-height FACTOR' specifies that the height of the
25574 stretch should be FACTOR times the height of the characters having
25575 the glyph property.
25577 Either none or exactly one of 4 or 5 must be present.
25579 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25580 of the stretch should be used for the ascent of the stretch.
25581 ASCENT must be in the range 0 <= ASCENT <= 100. */
25584 produce_stretch_glyph (struct it
*it
)
25586 /* (space :width WIDTH :height HEIGHT ...) */
25587 Lisp_Object prop
, plist
;
25588 int width
= 0, height
= 0, align_to
= -1;
25589 int zero_width_ok_p
= 0;
25591 struct font
*font
= NULL
;
25593 #ifdef HAVE_WINDOW_SYSTEM
25595 int zero_height_ok_p
= 0;
25597 if (FRAME_WINDOW_P (it
->f
))
25599 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25600 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25601 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
25605 /* List should start with `space'. */
25606 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
25607 plist
= XCDR (it
->object
);
25609 /* Compute the width of the stretch. */
25610 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
25611 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
25613 /* Absolute width `:width WIDTH' specified and valid. */
25614 zero_width_ok_p
= 1;
25617 #ifdef HAVE_WINDOW_SYSTEM
25618 else if (FRAME_WINDOW_P (it
->f
)
25619 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
25621 /* Relative width `:relative-width FACTOR' specified and valid.
25622 Compute the width of the characters having the `glyph'
25625 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
25628 if (it
->multibyte_p
)
25629 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
25632 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
25633 if (! ASCII_CHAR_P (it2
.c
))
25634 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
25637 it2
.glyph_row
= NULL
;
25638 it2
.what
= IT_CHARACTER
;
25639 x_produce_glyphs (&it2
);
25640 width
= NUMVAL (prop
) * it2
.pixel_width
;
25642 #endif /* HAVE_WINDOW_SYSTEM */
25643 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
25644 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
25646 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
25647 align_to
= (align_to
< 0
25649 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
25650 else if (align_to
< 0)
25651 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
25652 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
25653 zero_width_ok_p
= 1;
25656 /* Nothing specified -> width defaults to canonical char width. */
25657 width
= FRAME_COLUMN_WIDTH (it
->f
);
25659 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
25662 #ifdef HAVE_WINDOW_SYSTEM
25663 /* Compute height. */
25664 if (FRAME_WINDOW_P (it
->f
))
25666 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
25667 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25670 zero_height_ok_p
= 1;
25672 else if (prop
= Fplist_get (plist
, QCrelative_height
),
25674 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
25676 height
= FONT_HEIGHT (font
);
25678 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
25681 /* Compute percentage of height used for ascent. If
25682 `:ascent ASCENT' is present and valid, use that. Otherwise,
25683 derive the ascent from the font in use. */
25684 if (prop
= Fplist_get (plist
, QCascent
),
25685 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
25686 ascent
= height
* NUMVAL (prop
) / 100.0;
25687 else if (!NILP (prop
)
25688 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25689 ascent
= min (max (0, (int)tem
), height
);
25691 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
25694 #endif /* HAVE_WINDOW_SYSTEM */
25697 if (width
> 0 && it
->line_wrap
!= TRUNCATE
25698 && it
->current_x
+ width
> it
->last_visible_x
)
25700 width
= it
->last_visible_x
- it
->current_x
;
25701 #ifdef HAVE_WINDOW_SYSTEM
25702 /* Subtract one more pixel from the stretch width, but only on
25703 GUI frames, since on a TTY each glyph is one "pixel" wide. */
25704 width
-= FRAME_WINDOW_P (it
->f
);
25708 if (width
> 0 && height
> 0 && it
->glyph_row
)
25710 Lisp_Object o_object
= it
->object
;
25711 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
25714 if (!STRINGP (object
))
25715 object
= it
->w
->contents
;
25716 #ifdef HAVE_WINDOW_SYSTEM
25717 if (FRAME_WINDOW_P (it
->f
))
25718 append_stretch_glyph (it
, object
, width
, height
, ascent
);
25722 it
->object
= object
;
25723 it
->char_to_display
= ' ';
25724 it
->pixel_width
= it
->len
= 1;
25726 tty_append_glyph (it
);
25727 it
->object
= o_object
;
25731 it
->pixel_width
= width
;
25732 #ifdef HAVE_WINDOW_SYSTEM
25733 if (FRAME_WINDOW_P (it
->f
))
25735 it
->ascent
= it
->phys_ascent
= ascent
;
25736 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
25737 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
25738 take_vertical_position_into_account (it
);
25742 it
->nglyphs
= width
;
25745 /* Get information about special display element WHAT in an
25746 environment described by IT. WHAT is one of IT_TRUNCATION or
25747 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
25748 non-null glyph_row member. This function ensures that fields like
25749 face_id, c, len of IT are left untouched. */
25752 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
25759 temp_it
.object
= make_number (0);
25760 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
25762 if (what
== IT_CONTINUATION
)
25764 /* Continuation glyph. For R2L lines, we mirror it by hand. */
25765 if (it
->bidi_it
.paragraph_dir
== R2L
)
25766 SET_GLYPH_FROM_CHAR (glyph
, '/');
25768 SET_GLYPH_FROM_CHAR (glyph
, '\\');
25770 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25772 /* FIXME: Should we mirror GC for R2L lines? */
25773 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25774 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25777 else if (what
== IT_TRUNCATION
)
25779 /* Truncation glyph. */
25780 SET_GLYPH_FROM_CHAR (glyph
, '$');
25782 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25784 /* FIXME: Should we mirror GC for R2L lines? */
25785 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25786 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25792 #ifdef HAVE_WINDOW_SYSTEM
25793 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
25794 is turned off, we precede the truncation/continuation glyphs by a
25795 stretch glyph whose width is computed such that these special
25796 glyphs are aligned at the window margin, even when very different
25797 fonts are used in different glyph rows. */
25798 if (FRAME_WINDOW_P (temp_it
.f
)
25799 /* init_iterator calls this with it->glyph_row == NULL, and it
25800 wants only the pixel width of the truncation/continuation
25802 && temp_it
.glyph_row
25803 /* insert_left_trunc_glyphs calls us at the beginning of the
25804 row, and it has its own calculation of the stretch glyph
25806 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
25807 && (temp_it
.glyph_row
->reversed_p
25808 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
25809 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
25811 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
25813 if (stretch_width
> 0)
25815 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
25816 struct font
*font
=
25817 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
25818 int stretch_ascent
=
25819 (((temp_it
.ascent
+ temp_it
.descent
)
25820 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
25822 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
25823 temp_it
.ascent
+ temp_it
.descent
,
25830 temp_it
.what
= IT_CHARACTER
;
25831 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
25832 temp_it
.face_id
= GLYPH_FACE (glyph
);
25833 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
25835 PRODUCE_GLYPHS (&temp_it
);
25836 it
->pixel_width
= temp_it
.pixel_width
;
25837 it
->nglyphs
= temp_it
.nglyphs
;
25840 #ifdef HAVE_WINDOW_SYSTEM
25842 /* Calculate line-height and line-spacing properties.
25843 An integer value specifies explicit pixel value.
25844 A float value specifies relative value to current face height.
25845 A cons (float . face-name) specifies relative value to
25846 height of specified face font.
25848 Returns height in pixels, or nil. */
25852 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
25853 int boff
, int override
)
25855 Lisp_Object face_name
= Qnil
;
25856 int ascent
, descent
, height
;
25858 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
25863 face_name
= XCAR (val
);
25865 if (!NUMBERP (val
))
25866 val
= make_number (1);
25867 if (NILP (face_name
))
25869 height
= it
->ascent
+ it
->descent
;
25874 if (NILP (face_name
))
25876 font
= FRAME_FONT (it
->f
);
25877 boff
= FRAME_BASELINE_OFFSET (it
->f
);
25879 else if (EQ (face_name
, Qt
))
25888 face_id
= lookup_named_face (it
->f
, face_name
, 0);
25890 return make_number (-1);
25892 face
= FACE_FROM_ID (it
->f
, face_id
);
25895 return make_number (-1);
25896 boff
= font
->baseline_offset
;
25897 if (font
->vertical_centering
)
25898 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25901 ascent
= FONT_BASE (font
) + boff
;
25902 descent
= FONT_DESCENT (font
) - boff
;
25906 it
->override_ascent
= ascent
;
25907 it
->override_descent
= descent
;
25908 it
->override_boff
= boff
;
25911 height
= ascent
+ descent
;
25915 height
= (int)(XFLOAT_DATA (val
) * height
);
25916 else if (INTEGERP (val
))
25917 height
*= XINT (val
);
25919 return make_number (height
);
25923 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
25924 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
25925 and only if this is for a character for which no font was found.
25927 If the display method (it->glyphless_method) is
25928 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
25929 length of the acronym or the hexadecimal string, UPPER_XOFF and
25930 UPPER_YOFF are pixel offsets for the upper part of the string,
25931 LOWER_XOFF and LOWER_YOFF are for the lower part.
25933 For the other display methods, LEN through LOWER_YOFF are zero. */
25936 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
25937 short upper_xoff
, short upper_yoff
,
25938 short lower_xoff
, short lower_yoff
)
25940 struct glyph
*glyph
;
25941 enum glyph_row_area area
= it
->area
;
25943 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25944 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25946 /* If the glyph row is reversed, we need to prepend the glyph
25947 rather than append it. */
25948 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25952 /* Make room for the additional glyph. */
25953 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25955 glyph
= it
->glyph_row
->glyphs
[area
];
25957 glyph
->charpos
= CHARPOS (it
->position
);
25958 glyph
->object
= it
->object
;
25959 glyph
->pixel_width
= it
->pixel_width
;
25960 glyph
->ascent
= it
->ascent
;
25961 glyph
->descent
= it
->descent
;
25962 glyph
->voffset
= it
->voffset
;
25963 glyph
->type
= GLYPHLESS_GLYPH
;
25964 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
25965 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
25966 glyph
->u
.glyphless
.len
= len
;
25967 glyph
->u
.glyphless
.ch
= it
->c
;
25968 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
25969 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
25970 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
25971 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
25972 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25973 glyph
->multibyte_p
= it
->multibyte_p
;
25974 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25976 /* In R2L rows, the left and the right box edges need to be
25977 drawn in reverse direction. */
25978 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25979 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25983 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25984 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25986 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25987 || it
->phys_descent
> it
->descent
);
25988 glyph
->padding_p
= 0;
25989 glyph
->glyph_not_available_p
= 0;
25990 glyph
->face_id
= face_id
;
25991 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25994 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25995 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25997 glyph
->bidi_type
= it
->bidi_it
.type
;
25999 ++it
->glyph_row
->used
[area
];
26002 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26006 /* Produce a glyph for a glyphless character for iterator IT.
26007 IT->glyphless_method specifies which method to use for displaying
26008 the character. See the description of enum
26009 glyphless_display_method in dispextern.h for the detail.
26011 FOR_NO_FONT is nonzero if and only if this is for a character for
26012 which no font was found. ACRONYM, if non-nil, is an acronym string
26013 for the character. */
26016 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
26021 int base_width
, base_height
, width
, height
;
26022 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26025 /* Get the metrics of the base font. We always refer to the current
26027 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26028 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26029 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
26030 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
26031 base_height
= it
->ascent
+ it
->descent
;
26032 base_width
= font
->average_width
;
26034 face_id
= merge_glyphless_glyph_face (it
);
26036 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26038 it
->pixel_width
= THIN_SPACE_WIDTH
;
26040 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26042 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26044 width
= CHAR_WIDTH (it
->c
);
26047 else if (width
> 4)
26049 it
->pixel_width
= base_width
* width
;
26051 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26057 unsigned int code
[6];
26059 int ascent
, descent
;
26060 struct font_metrics metrics_upper
, metrics_lower
;
26062 face
= FACE_FROM_ID (it
->f
, face_id
);
26063 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26064 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
26066 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26068 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26069 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26070 if (CONSP (acronym
))
26071 acronym
= XCAR (acronym
);
26072 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26076 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26077 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
26080 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
26081 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26082 upper_len
= (len
+ 1) / 2;
26083 font
->driver
->text_extents (font
, code
, upper_len
,
26085 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26090 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26091 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26092 upper_xoff
= upper_yoff
= 2; /* the typical case */
26093 if (base_width
>= width
)
26095 /* Align the upper to the left, the lower to the right. */
26096 it
->pixel_width
= base_width
;
26097 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26101 /* Center the shorter one. */
26102 it
->pixel_width
= width
;
26103 if (metrics_upper
.width
>= metrics_lower
.width
)
26104 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26107 /* FIXME: This code doesn't look right. It formerly was
26108 missing the "lower_xoff = 0;", which couldn't have
26109 been right since it left lower_xoff uninitialized. */
26111 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26115 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26116 top, bottom, and between upper and lower strings. */
26117 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26118 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26119 /* Center vertically.
26120 H:base_height, D:base_descent
26121 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26123 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26124 descent = D - H/2 + h/2;
26125 lower_yoff = descent - 2 - ld;
26126 upper_yoff = lower_yoff - la - 1 - ud; */
26127 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26128 descent
= it
->descent
- (base_height
- height
) / 2;
26129 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26130 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26131 - metrics_upper
.descent
);
26132 /* Don't make the height shorter than the base height. */
26133 if (height
> base_height
)
26135 it
->ascent
= ascent
;
26136 it
->descent
= descent
;
26140 it
->phys_ascent
= it
->ascent
;
26141 it
->phys_descent
= it
->descent
;
26143 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26144 upper_xoff
, upper_yoff
,
26145 lower_xoff
, lower_yoff
);
26147 take_vertical_position_into_account (it
);
26152 Produce glyphs/get display metrics for the display element IT is
26153 loaded with. See the description of struct it in dispextern.h
26154 for an overview of struct it. */
26157 x_produce_glyphs (struct it
*it
)
26159 int extra_line_spacing
= it
->extra_line_spacing
;
26161 it
->glyph_not_available_p
= 0;
26163 if (it
->what
== IT_CHARACTER
)
26166 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26167 struct font
*font
= face
->font
;
26168 struct font_metrics
*pcm
= NULL
;
26169 int boff
; /* Baseline offset. */
26173 /* When no suitable font is found, display this character by
26174 the method specified in the first extra slot of
26175 Vglyphless_char_display. */
26176 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26178 eassert (it
->what
== IT_GLYPHLESS
);
26179 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
26183 boff
= font
->baseline_offset
;
26184 if (font
->vertical_centering
)
26185 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26187 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26193 if (it
->override_ascent
>= 0)
26195 it
->ascent
= it
->override_ascent
;
26196 it
->descent
= it
->override_descent
;
26197 boff
= it
->override_boff
;
26201 it
->ascent
= FONT_BASE (font
) + boff
;
26202 it
->descent
= FONT_DESCENT (font
) - boff
;
26205 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26207 pcm
= get_per_char_metric (font
, &char2b
);
26208 if (pcm
->width
== 0
26209 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26215 it
->phys_ascent
= pcm
->ascent
+ boff
;
26216 it
->phys_descent
= pcm
->descent
- boff
;
26217 it
->pixel_width
= pcm
->width
;
26221 it
->glyph_not_available_p
= 1;
26222 it
->phys_ascent
= it
->ascent
;
26223 it
->phys_descent
= it
->descent
;
26224 it
->pixel_width
= font
->space_width
;
26227 if (it
->constrain_row_ascent_descent_p
)
26229 if (it
->descent
> it
->max_descent
)
26231 it
->ascent
+= it
->descent
- it
->max_descent
;
26232 it
->descent
= it
->max_descent
;
26234 if (it
->ascent
> it
->max_ascent
)
26236 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26237 it
->ascent
= it
->max_ascent
;
26239 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26240 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26241 extra_line_spacing
= 0;
26244 /* If this is a space inside a region of text with
26245 `space-width' property, change its width. */
26246 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26248 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26250 /* If face has a box, add the box thickness to the character
26251 height. If character has a box line to the left and/or
26252 right, add the box line width to the character's width. */
26253 if (face
->box
!= FACE_NO_BOX
)
26255 int thick
= face
->box_line_width
;
26259 it
->ascent
+= thick
;
26260 it
->descent
+= thick
;
26265 if (it
->start_of_box_run_p
)
26266 it
->pixel_width
+= thick
;
26267 if (it
->end_of_box_run_p
)
26268 it
->pixel_width
+= thick
;
26271 /* If face has an overline, add the height of the overline
26272 (1 pixel) and a 1 pixel margin to the character height. */
26273 if (face
->overline_p
)
26274 it
->ascent
+= overline_margin
;
26276 if (it
->constrain_row_ascent_descent_p
)
26278 if (it
->ascent
> it
->max_ascent
)
26279 it
->ascent
= it
->max_ascent
;
26280 if (it
->descent
> it
->max_descent
)
26281 it
->descent
= it
->max_descent
;
26284 take_vertical_position_into_account (it
);
26286 /* If we have to actually produce glyphs, do it. */
26291 /* Translate a space with a `space-width' property
26292 into a stretch glyph. */
26293 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26294 / FONT_HEIGHT (font
));
26295 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26296 it
->ascent
+ it
->descent
, ascent
);
26301 /* If characters with lbearing or rbearing are displayed
26302 in this line, record that fact in a flag of the
26303 glyph row. This is used to optimize X output code. */
26304 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26305 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26307 if (! stretched_p
&& it
->pixel_width
== 0)
26308 /* We assure that all visible glyphs have at least 1-pixel
26310 it
->pixel_width
= 1;
26312 else if (it
->char_to_display
== '\n')
26314 /* A newline has no width, but we need the height of the
26315 line. But if previous part of the line sets a height,
26316 don't increase that height. */
26318 Lisp_Object height
;
26319 Lisp_Object total_height
= Qnil
;
26321 it
->override_ascent
= -1;
26322 it
->pixel_width
= 0;
26325 height
= get_it_property (it
, Qline_height
);
26326 /* Split (line-height total-height) list. */
26328 && CONSP (XCDR (height
))
26329 && NILP (XCDR (XCDR (height
))))
26331 total_height
= XCAR (XCDR (height
));
26332 height
= XCAR (height
);
26334 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
26336 if (it
->override_ascent
>= 0)
26338 it
->ascent
= it
->override_ascent
;
26339 it
->descent
= it
->override_descent
;
26340 boff
= it
->override_boff
;
26344 it
->ascent
= FONT_BASE (font
) + boff
;
26345 it
->descent
= FONT_DESCENT (font
) - boff
;
26348 if (EQ (height
, Qt
))
26350 if (it
->descent
> it
->max_descent
)
26352 it
->ascent
+= it
->descent
- it
->max_descent
;
26353 it
->descent
= it
->max_descent
;
26355 if (it
->ascent
> it
->max_ascent
)
26357 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26358 it
->ascent
= it
->max_ascent
;
26360 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26361 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26362 it
->constrain_row_ascent_descent_p
= 1;
26363 extra_line_spacing
= 0;
26367 Lisp_Object spacing
;
26369 it
->phys_ascent
= it
->ascent
;
26370 it
->phys_descent
= it
->descent
;
26372 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26373 && face
->box
!= FACE_NO_BOX
26374 && face
->box_line_width
> 0)
26376 it
->ascent
+= face
->box_line_width
;
26377 it
->descent
+= face
->box_line_width
;
26380 && XINT (height
) > it
->ascent
+ it
->descent
)
26381 it
->ascent
= XINT (height
) - it
->descent
;
26383 if (!NILP (total_height
))
26384 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
26387 spacing
= get_it_property (it
, Qline_spacing
);
26388 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
26390 if (INTEGERP (spacing
))
26392 extra_line_spacing
= XINT (spacing
);
26393 if (!NILP (total_height
))
26394 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26398 else /* i.e. (it->char_to_display == '\t') */
26400 if (font
->space_width
> 0)
26402 int tab_width
= it
->tab_width
* font
->space_width
;
26403 int x
= it
->current_x
+ it
->continuation_lines_width
;
26404 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26406 /* If the distance from the current position to the next tab
26407 stop is less than a space character width, use the
26408 tab stop after that. */
26409 if (next_tab_x
- x
< font
->space_width
)
26410 next_tab_x
+= tab_width
;
26412 it
->pixel_width
= next_tab_x
- x
;
26414 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
26415 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
26419 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26420 it
->ascent
+ it
->descent
, it
->ascent
);
26425 it
->pixel_width
= 0;
26430 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26432 /* A static composition.
26434 Note: A composition is represented as one glyph in the
26435 glyph matrix. There are no padding glyphs.
26437 Important note: pixel_width, ascent, and descent are the
26438 values of what is drawn by draw_glyphs (i.e. the values of
26439 the overall glyphs composed). */
26440 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26441 int boff
; /* baseline offset */
26442 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26443 int glyph_len
= cmp
->glyph_len
;
26444 struct font
*font
= face
->font
;
26448 /* If we have not yet calculated pixel size data of glyphs of
26449 the composition for the current face font, calculate them
26450 now. Theoretically, we have to check all fonts for the
26451 glyphs, but that requires much time and memory space. So,
26452 here we check only the font of the first glyph. This may
26453 lead to incorrect display, but it's very rare, and C-l
26454 (recenter-top-bottom) can correct the display anyway. */
26455 if (! cmp
->font
|| cmp
->font
!= font
)
26457 /* Ascent and descent of the font of the first character
26458 of this composition (adjusted by baseline offset).
26459 Ascent and descent of overall glyphs should not be less
26460 than these, respectively. */
26461 int font_ascent
, font_descent
, font_height
;
26462 /* Bounding box of the overall glyphs. */
26463 int leftmost
, rightmost
, lowest
, highest
;
26464 int lbearing
, rbearing
;
26465 int i
, width
, ascent
, descent
;
26466 int left_padded
= 0, right_padded
= 0;
26467 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26469 struct font_metrics
*pcm
;
26470 int font_not_found_p
;
26473 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26474 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26476 if (glyph_len
< cmp
->glyph_len
)
26478 for (i
= 0; i
< glyph_len
; i
++)
26480 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26482 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26487 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26488 : IT_CHARPOS (*it
));
26489 /* If no suitable font is found, use the default font. */
26490 font_not_found_p
= font
== NULL
;
26491 if (font_not_found_p
)
26493 face
= face
->ascii_face
;
26496 boff
= font
->baseline_offset
;
26497 if (font
->vertical_centering
)
26498 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26499 font_ascent
= FONT_BASE (font
) + boff
;
26500 font_descent
= FONT_DESCENT (font
) - boff
;
26501 font_height
= FONT_HEIGHT (font
);
26506 if (! font_not_found_p
)
26508 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26510 pcm
= get_per_char_metric (font
, &char2b
);
26513 /* Initialize the bounding box. */
26516 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26517 ascent
= pcm
->ascent
;
26518 descent
= pcm
->descent
;
26519 lbearing
= pcm
->lbearing
;
26520 rbearing
= pcm
->rbearing
;
26524 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26525 ascent
= FONT_BASE (font
);
26526 descent
= FONT_DESCENT (font
);
26533 lowest
= - descent
+ boff
;
26534 highest
= ascent
+ boff
;
26536 if (! font_not_found_p
26537 && font
->default_ascent
26538 && CHAR_TABLE_P (Vuse_default_ascent
)
26539 && !NILP (Faref (Vuse_default_ascent
,
26540 make_number (it
->char_to_display
))))
26541 highest
= font
->default_ascent
+ boff
;
26543 /* Draw the first glyph at the normal position. It may be
26544 shifted to right later if some other glyphs are drawn
26546 cmp
->offsets
[i
* 2] = 0;
26547 cmp
->offsets
[i
* 2 + 1] = boff
;
26548 cmp
->lbearing
= lbearing
;
26549 cmp
->rbearing
= rbearing
;
26551 /* Set cmp->offsets for the remaining glyphs. */
26552 for (i
++; i
< glyph_len
; i
++)
26554 int left
, right
, btm
, top
;
26555 int ch
= COMPOSITION_GLYPH (cmp
, i
);
26557 struct face
*this_face
;
26561 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
26562 this_face
= FACE_FROM_ID (it
->f
, face_id
);
26563 font
= this_face
->font
;
26569 get_char_face_and_encoding (it
->f
, ch
, face_id
,
26571 pcm
= get_per_char_metric (font
, &char2b
);
26574 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26577 width
= pcm
->width
;
26578 ascent
= pcm
->ascent
;
26579 descent
= pcm
->descent
;
26580 lbearing
= pcm
->lbearing
;
26581 rbearing
= pcm
->rbearing
;
26582 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
26584 /* Relative composition with or without
26585 alternate chars. */
26586 left
= (leftmost
+ rightmost
- width
) / 2;
26587 btm
= - descent
+ boff
;
26588 if (font
->relative_compose
26589 && (! CHAR_TABLE_P (Vignore_relative_composition
)
26590 || NILP (Faref (Vignore_relative_composition
,
26591 make_number (ch
)))))
26594 if (- descent
>= font
->relative_compose
)
26595 /* One extra pixel between two glyphs. */
26597 else if (ascent
<= 0)
26598 /* One extra pixel between two glyphs. */
26599 btm
= lowest
- 1 - ascent
- descent
;
26604 /* A composition rule is specified by an integer
26605 value that encodes global and new reference
26606 points (GREF and NREF). GREF and NREF are
26607 specified by numbers as below:
26609 0---1---2 -- ascent
26613 9--10--11 -- center
26615 ---3---4---5--- baseline
26617 6---7---8 -- descent
26619 int rule
= COMPOSITION_RULE (cmp
, i
);
26620 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
26622 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
26623 grefx
= gref
% 3, nrefx
= nref
% 3;
26624 grefy
= gref
/ 3, nrefy
= nref
/ 3;
26626 xoff
= font_height
* (xoff
- 128) / 256;
26628 yoff
= font_height
* (yoff
- 128) / 256;
26631 + grefx
* (rightmost
- leftmost
) / 2
26632 - nrefx
* width
/ 2
26635 btm
= ((grefy
== 0 ? highest
26637 : grefy
== 2 ? lowest
26638 : (highest
+ lowest
) / 2)
26639 - (nrefy
== 0 ? ascent
+ descent
26640 : nrefy
== 1 ? descent
- boff
26642 : (ascent
+ descent
) / 2)
26646 cmp
->offsets
[i
* 2] = left
;
26647 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
26649 /* Update the bounding box of the overall glyphs. */
26652 right
= left
+ width
;
26653 if (left
< leftmost
)
26655 if (right
> rightmost
)
26658 top
= btm
+ descent
+ ascent
;
26664 if (cmp
->lbearing
> left
+ lbearing
)
26665 cmp
->lbearing
= left
+ lbearing
;
26666 if (cmp
->rbearing
< left
+ rbearing
)
26667 cmp
->rbearing
= left
+ rbearing
;
26671 /* If there are glyphs whose x-offsets are negative,
26672 shift all glyphs to the right and make all x-offsets
26676 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26677 cmp
->offsets
[i
* 2] -= leftmost
;
26678 rightmost
-= leftmost
;
26679 cmp
->lbearing
-= leftmost
;
26680 cmp
->rbearing
-= leftmost
;
26683 if (left_padded
&& cmp
->lbearing
< 0)
26685 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26686 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
26687 rightmost
-= cmp
->lbearing
;
26688 cmp
->rbearing
-= cmp
->lbearing
;
26691 if (right_padded
&& rightmost
< cmp
->rbearing
)
26693 rightmost
= cmp
->rbearing
;
26696 cmp
->pixel_width
= rightmost
;
26697 cmp
->ascent
= highest
;
26698 cmp
->descent
= - lowest
;
26699 if (cmp
->ascent
< font_ascent
)
26700 cmp
->ascent
= font_ascent
;
26701 if (cmp
->descent
< font_descent
)
26702 cmp
->descent
= font_descent
;
26706 && (cmp
->lbearing
< 0
26707 || cmp
->rbearing
> cmp
->pixel_width
))
26708 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26710 it
->pixel_width
= cmp
->pixel_width
;
26711 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
26712 it
->descent
= it
->phys_descent
= cmp
->descent
;
26713 if (face
->box
!= FACE_NO_BOX
)
26715 int thick
= face
->box_line_width
;
26719 it
->ascent
+= thick
;
26720 it
->descent
+= thick
;
26725 if (it
->start_of_box_run_p
)
26726 it
->pixel_width
+= thick
;
26727 if (it
->end_of_box_run_p
)
26728 it
->pixel_width
+= thick
;
26731 /* If face has an overline, add the height of the overline
26732 (1 pixel) and a 1 pixel margin to the character height. */
26733 if (face
->overline_p
)
26734 it
->ascent
+= overline_margin
;
26736 take_vertical_position_into_account (it
);
26737 if (it
->ascent
< 0)
26739 if (it
->descent
< 0)
26742 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
26743 append_composite_glyph (it
);
26745 else if (it
->what
== IT_COMPOSITION
)
26747 /* A dynamic (automatic) composition. */
26748 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26749 Lisp_Object gstring
;
26750 struct font_metrics metrics
;
26754 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
26756 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
26759 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
26760 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26761 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
26762 it
->descent
= it
->phys_descent
= metrics
.descent
;
26763 if (face
->box
!= FACE_NO_BOX
)
26765 int thick
= face
->box_line_width
;
26769 it
->ascent
+= thick
;
26770 it
->descent
+= thick
;
26775 if (it
->start_of_box_run_p
)
26776 it
->pixel_width
+= thick
;
26777 if (it
->end_of_box_run_p
)
26778 it
->pixel_width
+= thick
;
26780 /* If face has an overline, add the height of the overline
26781 (1 pixel) and a 1 pixel margin to the character height. */
26782 if (face
->overline_p
)
26783 it
->ascent
+= overline_margin
;
26784 take_vertical_position_into_account (it
);
26785 if (it
->ascent
< 0)
26787 if (it
->descent
< 0)
26791 append_composite_glyph (it
);
26793 else if (it
->what
== IT_GLYPHLESS
)
26794 produce_glyphless_glyph (it
, 0, Qnil
);
26795 else if (it
->what
== IT_IMAGE
)
26796 produce_image_glyph (it
);
26797 else if (it
->what
== IT_STRETCH
)
26798 produce_stretch_glyph (it
);
26801 /* Accumulate dimensions. Note: can't assume that it->descent > 0
26802 because this isn't true for images with `:ascent 100'. */
26803 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
26804 if (it
->area
== TEXT_AREA
)
26805 it
->current_x
+= it
->pixel_width
;
26807 if (extra_line_spacing
> 0)
26809 it
->descent
+= extra_line_spacing
;
26810 if (extra_line_spacing
> it
->max_extra_line_spacing
)
26811 it
->max_extra_line_spacing
= extra_line_spacing
;
26814 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
26815 it
->max_descent
= max (it
->max_descent
, it
->descent
);
26816 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
26817 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
26821 Output LEN glyphs starting at START at the nominal cursor position.
26822 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
26823 being updated, and UPDATED_AREA is the area of that row being updated. */
26826 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26827 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26829 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
26831 eassert (updated_row
);
26832 /* When the window is hscrolled, cursor hpos can legitimately be out
26833 of bounds, but we draw the cursor at the corresponding window
26834 margin in that case. */
26835 if (!updated_row
->reversed_p
&& chpos
< 0)
26837 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
26838 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
26842 /* Write glyphs. */
26844 hpos
= start
- updated_row
->glyphs
[updated_area
];
26845 x
= draw_glyphs (w
, w
->output_cursor
.x
,
26846 updated_row
, updated_area
,
26848 DRAW_NORMAL_TEXT
, 0);
26850 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
26851 if (updated_area
== TEXT_AREA
26852 && w
->phys_cursor_on_p
26853 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
26855 && chpos
< hpos
+ len
)
26856 w
->phys_cursor_on_p
= 0;
26860 /* Advance the output cursor. */
26861 w
->output_cursor
.hpos
+= len
;
26862 w
->output_cursor
.x
= x
;
26867 Insert LEN glyphs from START at the nominal cursor position. */
26870 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26871 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26874 int line_height
, shift_by_width
, shifted_region_width
;
26875 struct glyph_row
*row
;
26876 struct glyph
*glyph
;
26877 int frame_x
, frame_y
;
26880 eassert (updated_row
);
26882 f
= XFRAME (WINDOW_FRAME (w
));
26884 /* Get the height of the line we are in. */
26886 line_height
= row
->height
;
26888 /* Get the width of the glyphs to insert. */
26889 shift_by_width
= 0;
26890 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
26891 shift_by_width
+= glyph
->pixel_width
;
26893 /* Get the width of the region to shift right. */
26894 shifted_region_width
= (window_box_width (w
, updated_area
)
26895 - w
->output_cursor
.x
26899 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
26900 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
26902 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
26903 line_height
, shift_by_width
);
26905 /* Write the glyphs. */
26906 hpos
= start
- row
->glyphs
[updated_area
];
26907 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
26909 DRAW_NORMAL_TEXT
, 0);
26911 /* Advance the output cursor. */
26912 w
->output_cursor
.hpos
+= len
;
26913 w
->output_cursor
.x
+= shift_by_width
;
26919 Erase the current text line from the nominal cursor position
26920 (inclusive) to pixel column TO_X (exclusive). The idea is that
26921 everything from TO_X onward is already erased.
26923 TO_X is a pixel position relative to UPDATED_AREA of currently
26924 updated window W. TO_X == -1 means clear to the end of this area. */
26927 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
26928 enum glyph_row_area updated_area
, int to_x
)
26931 int max_x
, min_y
, max_y
;
26932 int from_x
, from_y
, to_y
;
26934 eassert (updated_row
);
26935 f
= XFRAME (w
->frame
);
26937 if (updated_row
->full_width_p
)
26938 max_x
= (WINDOW_PIXEL_WIDTH (w
)
26939 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
26941 max_x
= window_box_width (w
, updated_area
);
26942 max_y
= window_text_bottom_y (w
);
26944 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
26945 of window. For TO_X > 0, truncate to end of drawing area. */
26951 to_x
= min (to_x
, max_x
);
26953 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
26955 /* Notice if the cursor will be cleared by this operation. */
26956 if (!updated_row
->full_width_p
)
26957 notice_overwritten_cursor (w
, updated_area
,
26958 w
->output_cursor
.x
, -1,
26960 MATRIX_ROW_BOTTOM_Y (updated_row
));
26962 from_x
= w
->output_cursor
.x
;
26964 /* Translate to frame coordinates. */
26965 if (updated_row
->full_width_p
)
26967 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
26968 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
26972 int area_left
= window_box_left (w
, updated_area
);
26973 from_x
+= area_left
;
26977 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
26978 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
26979 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
26981 /* Prevent inadvertently clearing to end of the X window. */
26982 if (to_x
> from_x
&& to_y
> from_y
)
26985 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
26986 to_x
- from_x
, to_y
- from_y
);
26991 #endif /* HAVE_WINDOW_SYSTEM */
26995 /***********************************************************************
26997 ***********************************************************************/
26999 /* Value is the internal representation of the specified cursor type
27000 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27001 of the bar cursor. */
27003 static enum text_cursor_kinds
27004 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27006 enum text_cursor_kinds type
;
27011 if (EQ (arg
, Qbox
))
27012 return FILLED_BOX_CURSOR
;
27014 if (EQ (arg
, Qhollow
))
27015 return HOLLOW_BOX_CURSOR
;
27017 if (EQ (arg
, Qbar
))
27024 && EQ (XCAR (arg
), Qbar
)
27025 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27027 *width
= XINT (XCDR (arg
));
27031 if (EQ (arg
, Qhbar
))
27034 return HBAR_CURSOR
;
27038 && EQ (XCAR (arg
), Qhbar
)
27039 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27041 *width
= XINT (XCDR (arg
));
27042 return HBAR_CURSOR
;
27045 /* Treat anything unknown as "hollow box cursor".
27046 It was bad to signal an error; people have trouble fixing
27047 .Xdefaults with Emacs, when it has something bad in it. */
27048 type
= HOLLOW_BOX_CURSOR
;
27053 /* Set the default cursor types for specified frame. */
27055 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27060 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27061 FRAME_CURSOR_WIDTH (f
) = width
;
27063 /* By default, set up the blink-off state depending on the on-state. */
27065 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27068 FRAME_BLINK_OFF_CURSOR (f
)
27069 = get_specified_cursor_type (XCDR (tem
), &width
);
27070 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27073 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27075 /* Make sure the cursor gets redrawn. */
27076 f
->cursor_type_changed
= 1;
27080 #ifdef HAVE_WINDOW_SYSTEM
27082 /* Return the cursor we want to be displayed in window W. Return
27083 width of bar/hbar cursor through WIDTH arg. Return with
27084 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
27085 (i.e. if the `system caret' should track this cursor).
27087 In a mini-buffer window, we want the cursor only to appear if we
27088 are reading input from this window. For the selected window, we
27089 want the cursor type given by the frame parameter or buffer local
27090 setting of cursor-type. If explicitly marked off, draw no cursor.
27091 In all other cases, we want a hollow box cursor. */
27093 static enum text_cursor_kinds
27094 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27095 int *active_cursor
)
27097 struct frame
*f
= XFRAME (w
->frame
);
27098 struct buffer
*b
= XBUFFER (w
->contents
);
27099 int cursor_type
= DEFAULT_CURSOR
;
27100 Lisp_Object alt_cursor
;
27101 int non_selected
= 0;
27103 *active_cursor
= 1;
27106 if (cursor_in_echo_area
27107 && FRAME_HAS_MINIBUF_P (f
)
27108 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27110 if (w
== XWINDOW (echo_area_window
))
27112 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27114 *width
= FRAME_CURSOR_WIDTH (f
);
27115 return FRAME_DESIRED_CURSOR (f
);
27118 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27121 *active_cursor
= 0;
27125 /* Detect a nonselected window or nonselected frame. */
27126 else if (w
!= XWINDOW (f
->selected_window
)
27127 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27129 *active_cursor
= 0;
27131 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27137 /* Never display a cursor in a window in which cursor-type is nil. */
27138 if (NILP (BVAR (b
, cursor_type
)))
27141 /* Get the normal cursor type for this window. */
27142 if (EQ (BVAR (b
, cursor_type
), Qt
))
27144 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27145 *width
= FRAME_CURSOR_WIDTH (f
);
27148 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27150 /* Use cursor-in-non-selected-windows instead
27151 for non-selected window or frame. */
27154 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27155 if (!EQ (Qt
, alt_cursor
))
27156 return get_specified_cursor_type (alt_cursor
, width
);
27157 /* t means modify the normal cursor type. */
27158 if (cursor_type
== FILLED_BOX_CURSOR
)
27159 cursor_type
= HOLLOW_BOX_CURSOR
;
27160 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27162 return cursor_type
;
27165 /* Use normal cursor if not blinked off. */
27166 if (!w
->cursor_off_p
)
27168 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27170 if (cursor_type
== FILLED_BOX_CURSOR
)
27172 /* Using a block cursor on large images can be very annoying.
27173 So use a hollow cursor for "large" images.
27174 If image is not transparent (no mask), also use hollow cursor. */
27175 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27176 if (img
!= NULL
&& IMAGEP (img
->spec
))
27178 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27179 where N = size of default frame font size.
27180 This should cover most of the "tiny" icons people may use. */
27182 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27183 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27184 cursor_type
= HOLLOW_BOX_CURSOR
;
27187 else if (cursor_type
!= NO_CURSOR
)
27189 /* Display current only supports BOX and HOLLOW cursors for images.
27190 So for now, unconditionally use a HOLLOW cursor when cursor is
27191 not a solid box cursor. */
27192 cursor_type
= HOLLOW_BOX_CURSOR
;
27195 return cursor_type
;
27198 /* Cursor is blinked off, so determine how to "toggle" it. */
27200 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27201 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
27202 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
27204 /* Then see if frame has specified a specific blink off cursor type. */
27205 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
27207 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
27208 return FRAME_BLINK_OFF_CURSOR (f
);
27212 /* Some people liked having a permanently visible blinking cursor,
27213 while others had very strong opinions against it. So it was
27214 decided to remove it. KFS 2003-09-03 */
27216 /* Finally perform built-in cursor blinking:
27217 filled box <-> hollow box
27218 wide [h]bar <-> narrow [h]bar
27219 narrow [h]bar <-> no cursor
27220 other type <-> no cursor */
27222 if (cursor_type
== FILLED_BOX_CURSOR
)
27223 return HOLLOW_BOX_CURSOR
;
27225 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
27228 return cursor_type
;
27236 /* Notice when the text cursor of window W has been completely
27237 overwritten by a drawing operation that outputs glyphs in AREA
27238 starting at X0 and ending at X1 in the line starting at Y0 and
27239 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27240 the rest of the line after X0 has been written. Y coordinates
27241 are window-relative. */
27244 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
27245 int x0
, int x1
, int y0
, int y1
)
27247 int cx0
, cx1
, cy0
, cy1
;
27248 struct glyph_row
*row
;
27250 if (!w
->phys_cursor_on_p
)
27252 if (area
!= TEXT_AREA
)
27255 if (w
->phys_cursor
.vpos
< 0
27256 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27257 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27258 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27261 if (row
->cursor_in_fringe_p
)
27263 row
->cursor_in_fringe_p
= 0;
27264 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27265 w
->phys_cursor_on_p
= 0;
27269 cx0
= w
->phys_cursor
.x
;
27270 cx1
= cx0
+ w
->phys_cursor_width
;
27271 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27274 /* The cursor image will be completely removed from the
27275 screen if the output area intersects the cursor area in
27276 y-direction. When we draw in [y0 y1[, and some part of
27277 the cursor is at y < y0, that part must have been drawn
27278 before. When scrolling, the cursor is erased before
27279 actually scrolling, so we don't come here. When not
27280 scrolling, the rows above the old cursor row must have
27281 changed, and in this case these rows must have written
27282 over the cursor image.
27284 Likewise if part of the cursor is below y1, with the
27285 exception of the cursor being in the first blank row at
27286 the buffer and window end because update_text_area
27287 doesn't draw that row. (Except when it does, but
27288 that's handled in update_text_area.) */
27290 cy0
= w
->phys_cursor
.y
;
27291 cy1
= cy0
+ w
->phys_cursor_height
;
27292 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27295 w
->phys_cursor_on_p
= 0;
27298 #endif /* HAVE_WINDOW_SYSTEM */
27301 /************************************************************************
27303 ************************************************************************/
27305 #ifdef HAVE_WINDOW_SYSTEM
27308 Fix the display of area AREA of overlapping row ROW in window W
27309 with respect to the overlapping part OVERLAPS. */
27312 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27313 enum glyph_row_area area
, int overlaps
)
27320 for (i
= 0; i
< row
->used
[area
];)
27322 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27324 int start
= i
, start_x
= x
;
27328 x
+= row
->glyphs
[area
][i
].pixel_width
;
27331 while (i
< row
->used
[area
]
27332 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27334 draw_glyphs (w
, start_x
, row
, area
,
27336 DRAW_NORMAL_TEXT
, overlaps
);
27340 x
+= row
->glyphs
[area
][i
].pixel_width
;
27350 Draw the cursor glyph of window W in glyph row ROW. See the
27351 comment of draw_glyphs for the meaning of HL. */
27354 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27355 enum draw_glyphs_face hl
)
27357 /* If cursor hpos is out of bounds, don't draw garbage. This can
27358 happen in mini-buffer windows when switching between echo area
27359 glyphs and mini-buffer. */
27360 if ((row
->reversed_p
27361 ? (w
->phys_cursor
.hpos
>= 0)
27362 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27364 int on_p
= w
->phys_cursor_on_p
;
27366 int hpos
= w
->phys_cursor
.hpos
;
27368 /* When the window is hscrolled, cursor hpos can legitimately be
27369 out of bounds, but we draw the cursor at the corresponding
27370 window margin in that case. */
27371 if (!row
->reversed_p
&& hpos
< 0)
27373 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27374 hpos
= row
->used
[TEXT_AREA
] - 1;
27376 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27378 w
->phys_cursor_on_p
= on_p
;
27380 if (hl
== DRAW_CURSOR
)
27381 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27382 /* When we erase the cursor, and ROW is overlapped by other
27383 rows, make sure that these overlapping parts of other rows
27385 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27387 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27389 if (row
> w
->current_matrix
->rows
27390 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27391 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27392 OVERLAPS_ERASED_CURSOR
);
27394 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27395 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27396 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27397 OVERLAPS_ERASED_CURSOR
);
27403 /* Erase the image of a cursor of window W from the screen. */
27409 erase_phys_cursor (struct window
*w
)
27411 struct frame
*f
= XFRAME (w
->frame
);
27412 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27413 int hpos
= w
->phys_cursor
.hpos
;
27414 int vpos
= w
->phys_cursor
.vpos
;
27415 int mouse_face_here_p
= 0;
27416 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27417 struct glyph_row
*cursor_row
;
27418 struct glyph
*cursor_glyph
;
27419 enum draw_glyphs_face hl
;
27421 /* No cursor displayed or row invalidated => nothing to do on the
27423 if (w
->phys_cursor_type
== NO_CURSOR
)
27424 goto mark_cursor_off
;
27426 /* VPOS >= active_glyphs->nrows means that window has been resized.
27427 Don't bother to erase the cursor. */
27428 if (vpos
>= active_glyphs
->nrows
)
27429 goto mark_cursor_off
;
27431 /* If row containing cursor is marked invalid, there is nothing we
27433 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27434 if (!cursor_row
->enabled_p
)
27435 goto mark_cursor_off
;
27437 /* If line spacing is > 0, old cursor may only be partially visible in
27438 window after split-window. So adjust visible height. */
27439 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27440 window_text_bottom_y (w
) - cursor_row
->y
);
27442 /* If row is completely invisible, don't attempt to delete a cursor which
27443 isn't there. This can happen if cursor is at top of a window, and
27444 we switch to a buffer with a header line in that window. */
27445 if (cursor_row
->visible_height
<= 0)
27446 goto mark_cursor_off
;
27448 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27449 if (cursor_row
->cursor_in_fringe_p
)
27451 cursor_row
->cursor_in_fringe_p
= 0;
27452 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27453 goto mark_cursor_off
;
27456 /* This can happen when the new row is shorter than the old one.
27457 In this case, either draw_glyphs or clear_end_of_line
27458 should have cleared the cursor. Note that we wouldn't be
27459 able to erase the cursor in this case because we don't have a
27460 cursor glyph at hand. */
27461 if ((cursor_row
->reversed_p
27462 ? (w
->phys_cursor
.hpos
< 0)
27463 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27464 goto mark_cursor_off
;
27466 /* When the window is hscrolled, cursor hpos can legitimately be out
27467 of bounds, but we draw the cursor at the corresponding window
27468 margin in that case. */
27469 if (!cursor_row
->reversed_p
&& hpos
< 0)
27471 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27472 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27474 /* If the cursor is in the mouse face area, redisplay that when
27475 we clear the cursor. */
27476 if (! NILP (hlinfo
->mouse_face_window
)
27477 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27478 /* Don't redraw the cursor's spot in mouse face if it is at the
27479 end of a line (on a newline). The cursor appears there, but
27480 mouse highlighting does not. */
27481 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27482 mouse_face_here_p
= 1;
27484 /* Maybe clear the display under the cursor. */
27485 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27488 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27491 cursor_glyph
= get_phys_cursor_glyph (w
);
27492 if (cursor_glyph
== NULL
)
27493 goto mark_cursor_off
;
27495 width
= cursor_glyph
->pixel_width
;
27496 x
= w
->phys_cursor
.x
;
27502 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27503 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27504 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
27507 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27510 /* Erase the cursor by redrawing the character underneath it. */
27511 if (mouse_face_here_p
)
27512 hl
= DRAW_MOUSE_FACE
;
27514 hl
= DRAW_NORMAL_TEXT
;
27515 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27518 w
->phys_cursor_on_p
= 0;
27519 w
->phys_cursor_type
= NO_CURSOR
;
27524 Display or clear cursor of window W. If ON is zero, clear the
27525 cursor. If it is non-zero, display the cursor. If ON is nonzero,
27526 where to put the cursor is specified by HPOS, VPOS, X and Y. */
27529 display_and_set_cursor (struct window
*w
, bool on
,
27530 int hpos
, int vpos
, int x
, int y
)
27532 struct frame
*f
= XFRAME (w
->frame
);
27533 int new_cursor_type
;
27534 int new_cursor_width
;
27536 struct glyph_row
*glyph_row
;
27537 struct glyph
*glyph
;
27539 /* This is pointless on invisible frames, and dangerous on garbaged
27540 windows and frames; in the latter case, the frame or window may
27541 be in the midst of changing its size, and x and y may be off the
27543 if (! FRAME_VISIBLE_P (f
)
27544 || FRAME_GARBAGED_P (f
)
27545 || vpos
>= w
->current_matrix
->nrows
27546 || hpos
>= w
->current_matrix
->matrix_w
)
27549 /* If cursor is off and we want it off, return quickly. */
27550 if (!on
&& !w
->phys_cursor_on_p
)
27553 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27554 /* If cursor row is not enabled, we don't really know where to
27555 display the cursor. */
27556 if (!glyph_row
->enabled_p
)
27558 w
->phys_cursor_on_p
= 0;
27563 if (!glyph_row
->exact_window_width_line_p
27564 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
27565 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
27567 eassert (input_blocked_p ());
27569 /* Set new_cursor_type to the cursor we want to be displayed. */
27570 new_cursor_type
= get_window_cursor_type (w
, glyph
,
27571 &new_cursor_width
, &active_cursor
);
27573 /* If cursor is currently being shown and we don't want it to be or
27574 it is in the wrong place, or the cursor type is not what we want,
27576 if (w
->phys_cursor_on_p
27578 || w
->phys_cursor
.x
!= x
27579 || w
->phys_cursor
.y
!= y
27580 /* HPOS can be negative in R2L rows whose
27581 exact_window_width_line_p flag is set (i.e. their newline
27582 would "overflow into the fringe"). */
27584 || new_cursor_type
!= w
->phys_cursor_type
27585 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
27586 && new_cursor_width
!= w
->phys_cursor_width
)))
27587 erase_phys_cursor (w
);
27589 /* Don't check phys_cursor_on_p here because that flag is only set
27590 to zero in some cases where we know that the cursor has been
27591 completely erased, to avoid the extra work of erasing the cursor
27592 twice. In other words, phys_cursor_on_p can be 1 and the cursor
27593 still not be visible, or it has only been partly erased. */
27596 w
->phys_cursor_ascent
= glyph_row
->ascent
;
27597 w
->phys_cursor_height
= glyph_row
->height
;
27599 /* Set phys_cursor_.* before x_draw_.* is called because some
27600 of them may need the information. */
27601 w
->phys_cursor
.x
= x
;
27602 w
->phys_cursor
.y
= glyph_row
->y
;
27603 w
->phys_cursor
.hpos
= hpos
;
27604 w
->phys_cursor
.vpos
= vpos
;
27607 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
27608 new_cursor_type
, new_cursor_width
,
27609 on
, active_cursor
);
27613 /* Switch the display of W's cursor on or off, according to the value
27617 update_window_cursor (struct window
*w
, bool on
)
27619 /* Don't update cursor in windows whose frame is in the process
27620 of being deleted. */
27621 if (w
->current_matrix
)
27623 int hpos
= w
->phys_cursor
.hpos
;
27624 int vpos
= w
->phys_cursor
.vpos
;
27625 struct glyph_row
*row
;
27627 if (vpos
>= w
->current_matrix
->nrows
27628 || hpos
>= w
->current_matrix
->matrix_w
)
27631 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27633 /* When the window is hscrolled, cursor hpos can legitimately be
27634 out of bounds, but we draw the cursor at the corresponding
27635 window margin in that case. */
27636 if (!row
->reversed_p
&& hpos
< 0)
27638 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27639 hpos
= row
->used
[TEXT_AREA
] - 1;
27642 display_and_set_cursor (w
, on
, hpos
, vpos
,
27643 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27649 /* Call update_window_cursor with parameter ON_P on all leaf windows
27650 in the window tree rooted at W. */
27653 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
27657 if (WINDOWP (w
->contents
))
27658 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
27660 update_window_cursor (w
, on_p
);
27662 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
27668 Display the cursor on window W, or clear it, according to ON_P.
27669 Don't change the cursor's position. */
27672 x_update_cursor (struct frame
*f
, bool on_p
)
27674 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
27679 Clear the cursor of window W to background color, and mark the
27680 cursor as not shown. This is used when the text where the cursor
27681 is about to be rewritten. */
27684 x_clear_cursor (struct window
*w
)
27686 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
27687 update_window_cursor (w
, 0);
27690 #endif /* HAVE_WINDOW_SYSTEM */
27692 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
27695 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
27696 int start_hpos
, int end_hpos
,
27697 enum draw_glyphs_face draw
)
27699 #ifdef HAVE_WINDOW_SYSTEM
27700 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
27702 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
27706 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
27707 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
27711 /* Display the active region described by mouse_face_* according to DRAW. */
27714 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
27716 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
27717 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27719 if (/* If window is in the process of being destroyed, don't bother
27721 w
->current_matrix
!= NULL
27722 /* Don't update mouse highlight if hidden. */
27723 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
27724 /* Recognize when we are called to operate on rows that don't exist
27725 anymore. This can happen when a window is split. */
27726 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
27728 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
27729 struct glyph_row
*row
, *first
, *last
;
27731 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
27732 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
27734 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
27736 int start_hpos
, end_hpos
, start_x
;
27738 /* For all but the first row, the highlight starts at column 0. */
27741 /* R2L rows have BEG and END in reversed order, but the
27742 screen drawing geometry is always left to right. So
27743 we need to mirror the beginning and end of the
27744 highlighted area in R2L rows. */
27745 if (!row
->reversed_p
)
27747 start_hpos
= hlinfo
->mouse_face_beg_col
;
27748 start_x
= hlinfo
->mouse_face_beg_x
;
27750 else if (row
== last
)
27752 start_hpos
= hlinfo
->mouse_face_end_col
;
27753 start_x
= hlinfo
->mouse_face_end_x
;
27761 else if (row
->reversed_p
&& row
== last
)
27763 start_hpos
= hlinfo
->mouse_face_end_col
;
27764 start_x
= hlinfo
->mouse_face_end_x
;
27774 if (!row
->reversed_p
)
27775 end_hpos
= hlinfo
->mouse_face_end_col
;
27776 else if (row
== first
)
27777 end_hpos
= hlinfo
->mouse_face_beg_col
;
27780 end_hpos
= row
->used
[TEXT_AREA
];
27781 if (draw
== DRAW_NORMAL_TEXT
)
27782 row
->fill_line_p
= 1; /* Clear to end of line */
27785 else if (row
->reversed_p
&& row
== first
)
27786 end_hpos
= hlinfo
->mouse_face_beg_col
;
27789 end_hpos
= row
->used
[TEXT_AREA
];
27790 if (draw
== DRAW_NORMAL_TEXT
)
27791 row
->fill_line_p
= 1; /* Clear to end of line */
27794 if (end_hpos
> start_hpos
)
27796 draw_row_with_mouse_face (w
, start_x
, row
,
27797 start_hpos
, end_hpos
, draw
);
27800 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
27804 #ifdef HAVE_WINDOW_SYSTEM
27805 /* When we've written over the cursor, arrange for it to
27806 be displayed again. */
27807 if (FRAME_WINDOW_P (f
)
27808 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
27810 int hpos
= w
->phys_cursor
.hpos
;
27812 /* When the window is hscrolled, cursor hpos can legitimately be
27813 out of bounds, but we draw the cursor at the corresponding
27814 window margin in that case. */
27815 if (!row
->reversed_p
&& hpos
< 0)
27817 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27818 hpos
= row
->used
[TEXT_AREA
] - 1;
27821 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
27822 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27825 #endif /* HAVE_WINDOW_SYSTEM */
27828 #ifdef HAVE_WINDOW_SYSTEM
27829 /* Change the mouse cursor. */
27830 if (FRAME_WINDOW_P (f
))
27832 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
27833 if (draw
== DRAW_NORMAL_TEXT
27834 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
27835 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
27838 if (draw
== DRAW_MOUSE_FACE
)
27839 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
27841 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
27843 #endif /* HAVE_WINDOW_SYSTEM */
27847 Clear out the mouse-highlighted active region.
27848 Redraw it un-highlighted first. Value is non-zero if mouse
27849 face was actually drawn unhighlighted. */
27852 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
27856 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
27858 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
27862 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27863 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27864 hlinfo
->mouse_face_window
= Qnil
;
27865 hlinfo
->mouse_face_overlay
= Qnil
;
27869 /* Return true if the coordinates HPOS and VPOS on windows W are
27870 within the mouse face on that window. */
27872 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
27874 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27876 /* Quickly resolve the easy cases. */
27877 if (!(WINDOWP (hlinfo
->mouse_face_window
)
27878 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
27880 if (vpos
< hlinfo
->mouse_face_beg_row
27881 || vpos
> hlinfo
->mouse_face_end_row
)
27883 if (vpos
> hlinfo
->mouse_face_beg_row
27884 && vpos
< hlinfo
->mouse_face_end_row
)
27887 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
27889 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27891 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
27894 else if ((vpos
== hlinfo
->mouse_face_beg_row
27895 && hpos
>= hlinfo
->mouse_face_beg_col
)
27896 || (vpos
== hlinfo
->mouse_face_end_row
27897 && hpos
< hlinfo
->mouse_face_end_col
))
27902 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27904 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
27907 else if ((vpos
== hlinfo
->mouse_face_beg_row
27908 && hpos
<= hlinfo
->mouse_face_beg_col
)
27909 || (vpos
== hlinfo
->mouse_face_end_row
27910 && hpos
> hlinfo
->mouse_face_end_col
))
27918 True if physical cursor of window W is within mouse face. */
27921 cursor_in_mouse_face_p (struct window
*w
)
27923 int hpos
= w
->phys_cursor
.hpos
;
27924 int vpos
= w
->phys_cursor
.vpos
;
27925 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27927 /* When the window is hscrolled, cursor hpos can legitimately be out
27928 of bounds, but we draw the cursor at the corresponding window
27929 margin in that case. */
27930 if (!row
->reversed_p
&& hpos
< 0)
27932 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27933 hpos
= row
->used
[TEXT_AREA
] - 1;
27935 return coords_in_mouse_face_p (w
, hpos
, vpos
);
27940 /* Find the glyph rows START_ROW and END_ROW of window W that display
27941 characters between buffer positions START_CHARPOS and END_CHARPOS
27942 (excluding END_CHARPOS). DISP_STRING is a display string that
27943 covers these buffer positions. This is similar to
27944 row_containing_pos, but is more accurate when bidi reordering makes
27945 buffer positions change non-linearly with glyph rows. */
27947 rows_from_pos_range (struct window
*w
,
27948 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
27949 Lisp_Object disp_string
,
27950 struct glyph_row
**start
, struct glyph_row
**end
)
27952 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27953 int last_y
= window_text_bottom_y (w
);
27954 struct glyph_row
*row
;
27959 while (!first
->enabled_p
27960 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
27963 /* Find the START row. */
27965 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
27968 /* A row can potentially be the START row if the range of the
27969 characters it displays intersects the range
27970 [START_CHARPOS..END_CHARPOS). */
27971 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
27972 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
27973 /* See the commentary in row_containing_pos, for the
27974 explanation of the complicated way to check whether
27975 some position is beyond the end of the characters
27976 displayed by a row. */
27977 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27978 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27979 && !row
->ends_at_zv_p
27980 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
27981 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27982 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27983 && !row
->ends_at_zv_p
27984 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
27986 /* Found a candidate row. Now make sure at least one of the
27987 glyphs it displays has a charpos from the range
27988 [START_CHARPOS..END_CHARPOS).
27990 This is not obvious because bidi reordering could make
27991 buffer positions of a row be 1,2,3,102,101,100, and if we
27992 want to highlight characters in [50..60), we don't want
27993 this row, even though [50..60) does intersect [1..103),
27994 the range of character positions given by the row's start
27995 and end positions. */
27996 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
27997 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28001 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
28002 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28003 /* A glyph that comes from DISP_STRING is by
28004 definition to be highlighted. */
28005 || EQ (g
->object
, disp_string
))
28014 /* Find the END row. */
28016 /* If the last row is partially visible, start looking for END
28017 from that row, instead of starting from FIRST. */
28018 && !(row
->enabled_p
28019 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28021 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28023 struct glyph_row
*next
= row
+ 1;
28024 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28026 if (!next
->enabled_p
28027 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28028 /* The first row >= START whose range of displayed characters
28029 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28030 is the row END + 1. */
28031 || (start_charpos
< next_start
28032 && end_charpos
< next_start
)
28033 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28034 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28035 && !next
->ends_at_zv_p
28036 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28037 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28038 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28039 && !next
->ends_at_zv_p
28040 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28047 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28048 but none of the characters it displays are in the range, it is
28050 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28051 struct glyph
*s
= g
;
28052 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28056 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
28057 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28058 /* If the buffer position of the first glyph in
28059 the row is equal to END_CHARPOS, it means
28060 the last character to be highlighted is the
28061 newline of ROW, and we must consider NEXT as
28063 || (((!next
->reversed_p
&& g
== s
)
28064 || (next
->reversed_p
&& g
== e
- 1))
28065 && (g
->charpos
== end_charpos
28066 /* Special case for when NEXT is an
28067 empty line at ZV. */
28068 || (g
->charpos
== -1
28069 && !row
->ends_at_zv_p
28070 && next_start
== end_charpos
)))))
28071 /* A glyph that comes from DISP_STRING is by
28072 definition to be highlighted. */
28073 || EQ (g
->object
, disp_string
))
28082 /* The first row that ends at ZV must be the last to be
28084 else if (next
->ends_at_zv_p
)
28093 /* This function sets the mouse_face_* elements of HLINFO, assuming
28094 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28095 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28096 for the overlay or run of text properties specifying the mouse
28097 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28098 before-string and after-string that must also be highlighted.
28099 DISP_STRING, if non-nil, is a display string that may cover some
28100 or all of the highlighted text. */
28103 mouse_face_from_buffer_pos (Lisp_Object window
,
28104 Mouse_HLInfo
*hlinfo
,
28105 ptrdiff_t mouse_charpos
,
28106 ptrdiff_t start_charpos
,
28107 ptrdiff_t end_charpos
,
28108 Lisp_Object before_string
,
28109 Lisp_Object after_string
,
28110 Lisp_Object disp_string
)
28112 struct window
*w
= XWINDOW (window
);
28113 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28114 struct glyph_row
*r1
, *r2
;
28115 struct glyph
*glyph
, *end
;
28116 ptrdiff_t ignore
, pos
;
28119 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28120 eassert (NILP (before_string
) || STRINGP (before_string
));
28121 eassert (NILP (after_string
) || STRINGP (after_string
));
28123 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28124 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28126 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28127 /* If the before-string or display-string contains newlines,
28128 rows_from_pos_range skips to its last row. Move back. */
28129 if (!NILP (before_string
) || !NILP (disp_string
))
28131 struct glyph_row
*prev
;
28132 while ((prev
= r1
- 1, prev
>= first
)
28133 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28134 && prev
->used
[TEXT_AREA
] > 0)
28136 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28137 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28138 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
28140 || !(EQ (glyph
->object
, before_string
)
28141 || EQ (glyph
->object
, disp_string
)))
28148 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28149 hlinfo
->mouse_face_past_end
= 1;
28151 else if (!NILP (after_string
))
28153 /* If the after-string has newlines, advance to its last row. */
28154 struct glyph_row
*next
;
28155 struct glyph_row
*last
28156 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28158 for (next
= r2
+ 1;
28160 && next
->used
[TEXT_AREA
] > 0
28161 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28165 /* The rest of the display engine assumes that mouse_face_beg_row is
28166 either above mouse_face_end_row or identical to it. But with
28167 bidi-reordered continued lines, the row for START_CHARPOS could
28168 be below the row for END_CHARPOS. If so, swap the rows and store
28169 them in correct order. */
28172 struct glyph_row
*tem
= r2
;
28178 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28179 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28181 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28182 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28183 could be anywhere in the row and in any order. The strategy
28184 below is to find the leftmost and the rightmost glyph that
28185 belongs to either of these 3 strings, or whose position is
28186 between START_CHARPOS and END_CHARPOS, and highlight all the
28187 glyphs between those two. This may cover more than just the text
28188 between START_CHARPOS and END_CHARPOS if the range of characters
28189 strides the bidi level boundary, e.g. if the beginning is in R2L
28190 text while the end is in L2R text or vice versa. */
28191 if (!r1
->reversed_p
)
28193 /* This row is in a left to right paragraph. Scan it left to
28195 glyph
= r1
->glyphs
[TEXT_AREA
];
28196 end
= glyph
+ r1
->used
[TEXT_AREA
];
28199 /* Skip truncation glyphs at the start of the glyph row. */
28200 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28202 && INTEGERP (glyph
->object
)
28203 && glyph
->charpos
< 0;
28205 x
+= glyph
->pixel_width
;
28207 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28208 or DISP_STRING, and the first glyph from buffer whose
28209 position is between START_CHARPOS and END_CHARPOS. */
28211 && !INTEGERP (glyph
->object
)
28212 && !EQ (glyph
->object
, disp_string
)
28213 && !(BUFFERP (glyph
->object
)
28214 && (glyph
->charpos
>= start_charpos
28215 && glyph
->charpos
< end_charpos
));
28218 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28219 are present at buffer positions between START_CHARPOS and
28220 END_CHARPOS, or if they come from an overlay. */
28221 if (EQ (glyph
->object
, before_string
))
28223 pos
= string_buffer_position (before_string
,
28225 /* If pos == 0, it means before_string came from an
28226 overlay, not from a buffer position. */
28227 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28230 else if (EQ (glyph
->object
, after_string
))
28232 pos
= string_buffer_position (after_string
, end_charpos
);
28233 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28236 x
+= glyph
->pixel_width
;
28238 hlinfo
->mouse_face_beg_x
= x
;
28239 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28243 /* This row is in a right to left paragraph. Scan it right to
28247 end
= r1
->glyphs
[TEXT_AREA
] - 1;
28248 glyph
= end
+ r1
->used
[TEXT_AREA
];
28250 /* Skip truncation glyphs at the start of the glyph row. */
28251 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28253 && INTEGERP (glyph
->object
)
28254 && glyph
->charpos
< 0;
28258 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28259 or DISP_STRING, and the first glyph from buffer whose
28260 position is between START_CHARPOS and END_CHARPOS. */
28262 && !INTEGERP (glyph
->object
)
28263 && !EQ (glyph
->object
, disp_string
)
28264 && !(BUFFERP (glyph
->object
)
28265 && (glyph
->charpos
>= start_charpos
28266 && glyph
->charpos
< end_charpos
));
28269 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28270 are present at buffer positions between START_CHARPOS and
28271 END_CHARPOS, or if they come from an overlay. */
28272 if (EQ (glyph
->object
, before_string
))
28274 pos
= string_buffer_position (before_string
, start_charpos
);
28275 /* If pos == 0, it means before_string came from an
28276 overlay, not from a buffer position. */
28277 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28280 else if (EQ (glyph
->object
, after_string
))
28282 pos
= string_buffer_position (after_string
, end_charpos
);
28283 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28288 glyph
++; /* first glyph to the right of the highlighted area */
28289 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28290 x
+= g
->pixel_width
;
28291 hlinfo
->mouse_face_beg_x
= x
;
28292 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28295 /* If the highlight ends in a different row, compute GLYPH and END
28296 for the end row. Otherwise, reuse the values computed above for
28297 the row where the highlight begins. */
28300 if (!r2
->reversed_p
)
28302 glyph
= r2
->glyphs
[TEXT_AREA
];
28303 end
= glyph
+ r2
->used
[TEXT_AREA
];
28308 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28309 glyph
= end
+ r2
->used
[TEXT_AREA
];
28313 if (!r2
->reversed_p
)
28315 /* Skip truncation and continuation glyphs near the end of the
28316 row, and also blanks and stretch glyphs inserted by
28317 extend_face_to_end_of_line. */
28319 && INTEGERP ((end
- 1)->object
))
28321 /* Scan the rest of the glyph row from the end, looking for the
28322 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28323 DISP_STRING, or whose position is between START_CHARPOS
28327 && !INTEGERP (end
->object
)
28328 && !EQ (end
->object
, disp_string
)
28329 && !(BUFFERP (end
->object
)
28330 && (end
->charpos
>= start_charpos
28331 && end
->charpos
< end_charpos
));
28334 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28335 are present at buffer positions between START_CHARPOS and
28336 END_CHARPOS, or if they come from an overlay. */
28337 if (EQ (end
->object
, before_string
))
28339 pos
= string_buffer_position (before_string
, start_charpos
);
28340 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28343 else if (EQ (end
->object
, after_string
))
28345 pos
= string_buffer_position (after_string
, end_charpos
);
28346 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28350 /* Find the X coordinate of the last glyph to be highlighted. */
28351 for (; glyph
<= end
; ++glyph
)
28352 x
+= glyph
->pixel_width
;
28354 hlinfo
->mouse_face_end_x
= x
;
28355 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28359 /* Skip truncation and continuation glyphs near the end of the
28360 row, and also blanks and stretch glyphs inserted by
28361 extend_face_to_end_of_line. */
28365 && INTEGERP (end
->object
))
28367 x
+= end
->pixel_width
;
28370 /* Scan the rest of the glyph row from the end, looking for the
28371 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28372 DISP_STRING, or whose position is between START_CHARPOS
28376 && !INTEGERP (end
->object
)
28377 && !EQ (end
->object
, disp_string
)
28378 && !(BUFFERP (end
->object
)
28379 && (end
->charpos
>= start_charpos
28380 && end
->charpos
< end_charpos
));
28383 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28384 are present at buffer positions between START_CHARPOS and
28385 END_CHARPOS, or if they come from an overlay. */
28386 if (EQ (end
->object
, before_string
))
28388 pos
= string_buffer_position (before_string
, start_charpos
);
28389 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28392 else if (EQ (end
->object
, after_string
))
28394 pos
= string_buffer_position (after_string
, end_charpos
);
28395 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28398 x
+= end
->pixel_width
;
28400 /* If we exited the above loop because we arrived at the last
28401 glyph of the row, and its buffer position is still not in
28402 range, it means the last character in range is the preceding
28403 newline. Bump the end column and x values to get past the
28406 && BUFFERP (end
->object
)
28407 && (end
->charpos
< start_charpos
28408 || end
->charpos
>= end_charpos
))
28410 x
+= end
->pixel_width
;
28413 hlinfo
->mouse_face_end_x
= x
;
28414 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28417 hlinfo
->mouse_face_window
= window
;
28418 hlinfo
->mouse_face_face_id
28419 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28421 !hlinfo
->mouse_face_hidden
, -1);
28422 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28425 /* The following function is not used anymore (replaced with
28426 mouse_face_from_string_pos), but I leave it here for the time
28427 being, in case someone would. */
28429 #if 0 /* not used */
28431 /* Find the position of the glyph for position POS in OBJECT in
28432 window W's current matrix, and return in *X, *Y the pixel
28433 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28435 RIGHT_P non-zero means return the position of the right edge of the
28436 glyph, RIGHT_P zero means return the left edge position.
28438 If no glyph for POS exists in the matrix, return the position of
28439 the glyph with the next smaller position that is in the matrix, if
28440 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
28441 exists in the matrix, return the position of the glyph with the
28442 next larger position in OBJECT.
28444 Value is non-zero if a glyph was found. */
28447 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28448 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
28450 int yb
= window_text_bottom_y (w
);
28451 struct glyph_row
*r
;
28452 struct glyph
*best_glyph
= NULL
;
28453 struct glyph_row
*best_row
= NULL
;
28456 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28457 r
->enabled_p
&& r
->y
< yb
;
28460 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28461 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28464 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28465 if (EQ (g
->object
, object
))
28467 if (g
->charpos
== pos
)
28474 else if (best_glyph
== NULL
28475 || ((eabs (g
->charpos
- pos
)
28476 < eabs (best_glyph
->charpos
- pos
))
28479 : g
->charpos
> pos
)))
28493 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28497 *x
+= best_glyph
->pixel_width
;
28502 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28505 return best_glyph
!= NULL
;
28507 #endif /* not used */
28509 /* Find the positions of the first and the last glyphs in window W's
28510 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28511 (assumed to be a string), and return in HLINFO's mouse_face_*
28512 members the pixel and column/row coordinates of those glyphs. */
28515 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28516 Lisp_Object object
,
28517 ptrdiff_t startpos
, ptrdiff_t endpos
)
28519 int yb
= window_text_bottom_y (w
);
28520 struct glyph_row
*r
;
28521 struct glyph
*g
, *e
;
28525 /* Find the glyph row with at least one position in the range
28526 [STARTPOS..ENDPOS), and the first glyph in that row whose
28527 position belongs to that range. */
28528 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28529 r
->enabled_p
&& r
->y
< yb
;
28532 if (!r
->reversed_p
)
28534 g
= r
->glyphs
[TEXT_AREA
];
28535 e
= g
+ r
->used
[TEXT_AREA
];
28536 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28537 if (EQ (g
->object
, object
)
28538 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28540 hlinfo
->mouse_face_beg_row
28541 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28542 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28543 hlinfo
->mouse_face_beg_x
= gx
;
28552 e
= r
->glyphs
[TEXT_AREA
];
28553 g
= e
+ r
->used
[TEXT_AREA
];
28554 for ( ; g
> e
; --g
)
28555 if (EQ ((g
-1)->object
, object
)
28556 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
28558 hlinfo
->mouse_face_beg_row
28559 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28560 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28561 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
28562 gx
+= g1
->pixel_width
;
28563 hlinfo
->mouse_face_beg_x
= gx
;
28575 /* Starting with the next row, look for the first row which does NOT
28576 include any glyphs whose positions are in the range. */
28577 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
28579 g
= r
->glyphs
[TEXT_AREA
];
28580 e
= g
+ r
->used
[TEXT_AREA
];
28582 for ( ; g
< e
; ++g
)
28583 if (EQ (g
->object
, object
)
28584 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28593 /* The highlighted region ends on the previous row. */
28596 /* Set the end row. */
28597 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28599 /* Compute and set the end column and the end column's horizontal
28600 pixel coordinate. */
28601 if (!r
->reversed_p
)
28603 g
= r
->glyphs
[TEXT_AREA
];
28604 e
= g
+ r
->used
[TEXT_AREA
];
28605 for ( ; e
> g
; --e
)
28606 if (EQ ((e
-1)->object
, object
)
28607 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
28609 hlinfo
->mouse_face_end_col
= e
- g
;
28611 for (gx
= r
->x
; g
< e
; ++g
)
28612 gx
+= g
->pixel_width
;
28613 hlinfo
->mouse_face_end_x
= gx
;
28617 e
= r
->glyphs
[TEXT_AREA
];
28618 g
= e
+ r
->used
[TEXT_AREA
];
28619 for (gx
= r
->x
; e
< g
; ++e
)
28621 if (EQ (e
->object
, object
)
28622 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
28624 gx
+= e
->pixel_width
;
28626 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
28627 hlinfo
->mouse_face_end_x
= gx
;
28631 #ifdef HAVE_WINDOW_SYSTEM
28633 /* See if position X, Y is within a hot-spot of an image. */
28636 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
28638 if (!CONSP (hot_spot
))
28641 if (EQ (XCAR (hot_spot
), Qrect
))
28643 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
28644 Lisp_Object rect
= XCDR (hot_spot
);
28648 if (!CONSP (XCAR (rect
)))
28650 if (!CONSP (XCDR (rect
)))
28652 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
28654 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
28656 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
28658 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
28662 else if (EQ (XCAR (hot_spot
), Qcircle
))
28664 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
28665 Lisp_Object circ
= XCDR (hot_spot
);
28666 Lisp_Object lr
, lx0
, ly0
;
28668 && CONSP (XCAR (circ
))
28669 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
28670 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
28671 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
28673 double r
= XFLOATINT (lr
);
28674 double dx
= XINT (lx0
) - x
;
28675 double dy
= XINT (ly0
) - y
;
28676 return (dx
* dx
+ dy
* dy
<= r
* r
);
28679 else if (EQ (XCAR (hot_spot
), Qpoly
))
28681 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
28682 if (VECTORP (XCDR (hot_spot
)))
28684 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
28685 Lisp_Object
*poly
= v
->contents
;
28686 ptrdiff_t n
= v
->header
.size
;
28689 Lisp_Object lx
, ly
;
28692 /* Need an even number of coordinates, and at least 3 edges. */
28693 if (n
< 6 || n
& 1)
28696 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
28697 If count is odd, we are inside polygon. Pixels on edges
28698 may or may not be included depending on actual geometry of the
28700 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
28701 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
28703 x0
= XINT (lx
), y0
= XINT (ly
);
28704 for (i
= 0; i
< n
; i
+= 2)
28706 int x1
= x0
, y1
= y0
;
28707 if ((lx
= poly
[i
], !INTEGERP (lx
))
28708 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
28710 x0
= XINT (lx
), y0
= XINT (ly
);
28712 /* Does this segment cross the X line? */
28720 if (y
> y0
&& y
> y1
)
28722 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
28732 find_hot_spot (Lisp_Object map
, int x
, int y
)
28734 while (CONSP (map
))
28736 if (CONSP (XCAR (map
))
28737 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
28745 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
28747 doc
: /* Lookup in image map MAP coordinates X and Y.
28748 An image map is an alist where each element has the format (AREA ID PLIST).
28749 An AREA is specified as either a rectangle, a circle, or a polygon:
28750 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
28751 pixel coordinates of the upper left and bottom right corners.
28752 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
28753 and the radius of the circle; r may be a float or integer.
28754 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
28755 vector describes one corner in the polygon.
28756 Returns the alist element for the first matching AREA in MAP. */)
28757 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
28765 return find_hot_spot (map
,
28766 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
28767 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
28771 /* Display frame CURSOR, optionally using shape defined by POINTER. */
28773 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
28775 /* Do not change cursor shape while dragging mouse. */
28776 if (!NILP (do_mouse_tracking
))
28779 if (!NILP (pointer
))
28781 if (EQ (pointer
, Qarrow
))
28782 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28783 else if (EQ (pointer
, Qhand
))
28784 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
28785 else if (EQ (pointer
, Qtext
))
28786 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
28787 else if (EQ (pointer
, intern ("hdrag")))
28788 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28789 else if (EQ (pointer
, intern ("nhdrag")))
28790 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
28791 #ifdef HAVE_X_WINDOWS
28792 else if (EQ (pointer
, intern ("vdrag")))
28793 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28795 else if (EQ (pointer
, intern ("hourglass")))
28796 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
28797 else if (EQ (pointer
, Qmodeline
))
28798 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
28800 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28803 if (cursor
!= No_Cursor
)
28804 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
28807 #endif /* HAVE_WINDOW_SYSTEM */
28809 /* Take proper action when mouse has moved to the mode or header line
28810 or marginal area AREA of window W, x-position X and y-position Y.
28811 X is relative to the start of the text display area of W, so the
28812 width of bitmap areas and scroll bars must be subtracted to get a
28813 position relative to the start of the mode line. */
28816 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
28817 enum window_part area
)
28819 struct window
*w
= XWINDOW (window
);
28820 struct frame
*f
= XFRAME (w
->frame
);
28821 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28822 #ifdef HAVE_WINDOW_SYSTEM
28823 Display_Info
*dpyinfo
;
28825 Cursor cursor
= No_Cursor
;
28826 Lisp_Object pointer
= Qnil
;
28827 int dx
, dy
, width
, height
;
28829 Lisp_Object string
, object
= Qnil
;
28830 Lisp_Object pos
IF_LINT (= Qnil
), help
;
28832 Lisp_Object mouse_face
;
28833 int original_x_pixel
= x
;
28834 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
28835 struct glyph_row
*row
IF_LINT (= 0);
28837 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
28842 /* Kludge alert: mode_line_string takes X/Y in pixels, but
28843 returns them in row/column units! */
28844 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
28845 &object
, &dx
, &dy
, &width
, &height
);
28847 row
= (area
== ON_MODE_LINE
28848 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
28849 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
28851 /* Find the glyph under the mouse pointer. */
28852 if (row
->mode_line_p
&& row
->enabled_p
)
28854 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
28855 end
= glyph
+ row
->used
[TEXT_AREA
];
28857 for (x0
= original_x_pixel
;
28858 glyph
< end
&& x0
>= glyph
->pixel_width
;
28860 x0
-= glyph
->pixel_width
;
28868 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
28869 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
28870 returns them in row/column units! */
28871 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
28872 &object
, &dx
, &dy
, &width
, &height
);
28877 #ifdef HAVE_WINDOW_SYSTEM
28878 if (IMAGEP (object
))
28880 Lisp_Object image_map
, hotspot
;
28881 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
28883 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
28885 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
28889 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
28890 If so, we could look for mouse-enter, mouse-leave
28891 properties in PLIST (and do something...). */
28892 hotspot
= XCDR (hotspot
);
28893 if (CONSP (hotspot
)
28894 && (plist
= XCAR (hotspot
), CONSP (plist
)))
28896 pointer
= Fplist_get (plist
, Qpointer
);
28897 if (NILP (pointer
))
28899 help
= Fplist_get (plist
, Qhelp_echo
);
28902 help_echo_string
= help
;
28903 XSETWINDOW (help_echo_window
, w
);
28904 help_echo_object
= w
->contents
;
28905 help_echo_pos
= charpos
;
28909 if (NILP (pointer
))
28910 pointer
= Fplist_get (XCDR (object
), QCpointer
);
28912 #endif /* HAVE_WINDOW_SYSTEM */
28914 if (STRINGP (string
))
28915 pos
= make_number (charpos
);
28917 /* Set the help text and mouse pointer. If the mouse is on a part
28918 of the mode line without any text (e.g. past the right edge of
28919 the mode line text), use the default help text and pointer. */
28920 if (STRINGP (string
) || area
== ON_MODE_LINE
)
28922 /* Arrange to display the help by setting the global variables
28923 help_echo_string, help_echo_object, and help_echo_pos. */
28926 if (STRINGP (string
))
28927 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
28931 help_echo_string
= help
;
28932 XSETWINDOW (help_echo_window
, w
);
28933 help_echo_object
= string
;
28934 help_echo_pos
= charpos
;
28936 else if (area
== ON_MODE_LINE
)
28938 Lisp_Object default_help
28939 = buffer_local_value_1 (Qmode_line_default_help_echo
,
28942 if (STRINGP (default_help
))
28944 help_echo_string
= default_help
;
28945 XSETWINDOW (help_echo_window
, w
);
28946 help_echo_object
= Qnil
;
28947 help_echo_pos
= -1;
28952 #ifdef HAVE_WINDOW_SYSTEM
28953 /* Change the mouse pointer according to what is under it. */
28954 if (FRAME_WINDOW_P (f
))
28956 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
28958 || NILP (Vresize_mini_windows
));
28960 dpyinfo
= FRAME_DISPLAY_INFO (f
);
28961 if (STRINGP (string
))
28963 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28965 if (NILP (pointer
))
28966 pointer
= Fget_text_property (pos
, Qpointer
, string
);
28968 /* Change the mouse pointer according to what is under X/Y. */
28970 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
28973 map
= Fget_text_property (pos
, Qlocal_map
, string
);
28974 if (!KEYMAPP (map
))
28975 map
= Fget_text_property (pos
, Qkeymap
, string
);
28976 if (!KEYMAPP (map
) && draggable
)
28977 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
28980 else if (draggable
)
28981 /* Default mode-line pointer. */
28982 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28987 /* Change the mouse face according to what is under X/Y. */
28988 if (STRINGP (string
))
28990 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
28991 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
28992 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
28997 struct glyph
* tmp_glyph
;
29001 int total_pixel_width
;
29002 ptrdiff_t begpos
, endpos
, ignore
;
29006 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29007 Qmouse_face
, string
, Qnil
);
29013 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29015 endpos
= SCHARS (string
);
29019 /* Calculate the glyph position GPOS of GLYPH in the
29020 displayed string, relative to the beginning of the
29021 highlighted part of the string.
29023 Note: GPOS is different from CHARPOS. CHARPOS is the
29024 position of GLYPH in the internal string object. A mode
29025 line string format has structures which are converted to
29026 a flattened string by the Emacs Lisp interpreter. The
29027 internal string is an element of those structures. The
29028 displayed string is the flattened string. */
29029 tmp_glyph
= row_start_glyph
;
29030 while (tmp_glyph
< glyph
29031 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29032 && begpos
<= tmp_glyph
->charpos
29033 && tmp_glyph
->charpos
< endpos
)))
29035 gpos
= glyph
- tmp_glyph
;
29037 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29038 the highlighted part of the displayed string to which
29039 GLYPH belongs. Note: GSEQ_LENGTH is different from
29040 SCHARS (STRING), because the latter returns the length of
29041 the internal string. */
29042 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29044 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29045 && begpos
<= tmp_glyph
->charpos
29046 && tmp_glyph
->charpos
< endpos
));
29049 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29051 /* Calculate the total pixel width of all the glyphs between
29052 the beginning of the highlighted area and GLYPH. */
29053 total_pixel_width
= 0;
29054 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29055 total_pixel_width
+= tmp_glyph
->pixel_width
;
29057 /* Pre calculation of re-rendering position. Note: X is in
29058 column units here, after the call to mode_line_string or
29059 marginal_area_string. */
29061 vpos
= (area
== ON_MODE_LINE
29062 ? (w
->current_matrix
)->nrows
- 1
29065 /* If GLYPH's position is included in the region that is
29066 already drawn in mouse face, we have nothing to do. */
29067 if ( EQ (window
, hlinfo
->mouse_face_window
)
29068 && (!row
->reversed_p
29069 ? (hlinfo
->mouse_face_beg_col
<= hpos
29070 && hpos
< hlinfo
->mouse_face_end_col
)
29071 /* In R2L rows we swap BEG and END, see below. */
29072 : (hlinfo
->mouse_face_end_col
<= hpos
29073 && hpos
< hlinfo
->mouse_face_beg_col
))
29074 && hlinfo
->mouse_face_beg_row
== vpos
)
29077 if (clear_mouse_face (hlinfo
))
29078 cursor
= No_Cursor
;
29080 if (!row
->reversed_p
)
29082 hlinfo
->mouse_face_beg_col
= hpos
;
29083 hlinfo
->mouse_face_beg_x
= original_x_pixel
29084 - (total_pixel_width
+ dx
);
29085 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29086 hlinfo
->mouse_face_end_x
= 0;
29090 /* In R2L rows, show_mouse_face expects BEG and END
29091 coordinates to be swapped. */
29092 hlinfo
->mouse_face_end_col
= hpos
;
29093 hlinfo
->mouse_face_end_x
= original_x_pixel
29094 - (total_pixel_width
+ dx
);
29095 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29096 hlinfo
->mouse_face_beg_x
= 0;
29099 hlinfo
->mouse_face_beg_row
= vpos
;
29100 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29101 hlinfo
->mouse_face_past_end
= 0;
29102 hlinfo
->mouse_face_window
= window
;
29104 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29109 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29111 if (NILP (pointer
))
29114 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29115 clear_mouse_face (hlinfo
);
29117 #ifdef HAVE_WINDOW_SYSTEM
29118 if (FRAME_WINDOW_P (f
))
29119 define_frame_cursor1 (f
, cursor
, pointer
);
29125 Take proper action when the mouse has moved to position X, Y on
29126 frame F with regards to highlighting portions of display that have
29127 mouse-face properties. Also de-highlight portions of display where
29128 the mouse was before, set the mouse pointer shape as appropriate
29129 for the mouse coordinates, and activate help echo (tooltips).
29130 X and Y can be negative or out of range. */
29133 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29135 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29136 enum window_part part
= ON_NOTHING
;
29137 Lisp_Object window
;
29139 Cursor cursor
= No_Cursor
;
29140 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29143 /* When a menu is active, don't highlight because this looks odd. */
29144 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29145 if (popup_activated ())
29149 if (!f
->glyphs_initialized_p
29150 || f
->pointer_invisible
)
29153 hlinfo
->mouse_face_mouse_x
= x
;
29154 hlinfo
->mouse_face_mouse_y
= y
;
29155 hlinfo
->mouse_face_mouse_frame
= f
;
29157 if (hlinfo
->mouse_face_defer
)
29160 /* Which window is that in? */
29161 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
29163 /* If displaying active text in another window, clear that. */
29164 if (! EQ (window
, hlinfo
->mouse_face_window
)
29165 /* Also clear if we move out of text area in same window. */
29166 || (!NILP (hlinfo
->mouse_face_window
)
29169 && part
!= ON_MODE_LINE
29170 && part
!= ON_HEADER_LINE
))
29171 clear_mouse_face (hlinfo
);
29173 /* Not on a window -> return. */
29174 if (!WINDOWP (window
))
29177 /* Reset help_echo_string. It will get recomputed below. */
29178 help_echo_string
= Qnil
;
29180 /* Convert to window-relative pixel coordinates. */
29181 w
= XWINDOW (window
);
29182 frame_to_window_pixel_xy (w
, &x
, &y
);
29184 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29185 /* Handle tool-bar window differently since it doesn't display a
29187 if (EQ (window
, f
->tool_bar_window
))
29189 note_tool_bar_highlight (f
, x
, y
);
29194 /* Mouse is on the mode, header line or margin? */
29195 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29196 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29198 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29200 #ifdef HAVE_WINDOW_SYSTEM
29201 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29203 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29204 /* Show non-text cursor (Bug#16647). */
29212 #ifdef HAVE_WINDOW_SYSTEM
29213 if (part
== ON_VERTICAL_BORDER
)
29215 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29216 help_echo_string
= build_string ("drag-mouse-1: resize");
29218 else if (part
== ON_RIGHT_DIVIDER
)
29220 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29221 help_echo_string
= build_string ("drag-mouse-1: resize");
29223 else if (part
== ON_BOTTOM_DIVIDER
)
29224 if (! WINDOW_BOTTOMMOST_P (w
)
29226 || NILP (Vresize_mini_windows
))
29228 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29229 help_echo_string
= build_string ("drag-mouse-1: resize");
29232 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29233 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
29234 || part
== ON_SCROLL_BAR
)
29235 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29237 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29240 /* Are we in a window whose display is up to date?
29241 And verify the buffer's text has not changed. */
29242 b
= XBUFFER (w
->contents
);
29243 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
29245 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
29247 struct glyph
*glyph
;
29248 Lisp_Object object
;
29249 Lisp_Object mouse_face
= Qnil
, position
;
29250 Lisp_Object
*overlay_vec
= NULL
;
29251 ptrdiff_t i
, noverlays
;
29252 struct buffer
*obuf
;
29253 ptrdiff_t obegv
, ozv
;
29256 /* Find the glyph under X/Y. */
29257 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
29259 #ifdef HAVE_WINDOW_SYSTEM
29260 /* Look for :pointer property on image. */
29261 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29263 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29264 if (img
!= NULL
&& IMAGEP (img
->spec
))
29266 Lisp_Object image_map
, hotspot
;
29267 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29269 && (hotspot
= find_hot_spot (image_map
,
29270 glyph
->slice
.img
.x
+ dx
,
29271 glyph
->slice
.img
.y
+ dy
),
29273 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29277 /* Could check XCAR (hotspot) to see if we enter/leave
29279 If so, we could look for mouse-enter, mouse-leave
29280 properties in PLIST (and do something...). */
29281 hotspot
= XCDR (hotspot
);
29282 if (CONSP (hotspot
)
29283 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29285 pointer
= Fplist_get (plist
, Qpointer
);
29286 if (NILP (pointer
))
29288 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29289 if (!NILP (help_echo_string
))
29291 help_echo_window
= window
;
29292 help_echo_object
= glyph
->object
;
29293 help_echo_pos
= glyph
->charpos
;
29297 if (NILP (pointer
))
29298 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29301 #endif /* HAVE_WINDOW_SYSTEM */
29303 /* Clear mouse face if X/Y not over text. */
29305 || area
!= TEXT_AREA
29306 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29307 /* Glyph's OBJECT is an integer for glyphs inserted by the
29308 display engine for its internal purposes, like truncation
29309 and continuation glyphs and blanks beyond the end of
29310 line's text on text terminals. If we are over such a
29311 glyph, we are not over any text. */
29312 || INTEGERP (glyph
->object
)
29313 /* R2L rows have a stretch glyph at their front, which
29314 stands for no text, whereas L2R rows have no glyphs at
29315 all beyond the end of text. Treat such stretch glyphs
29316 like we do with NULL glyphs in L2R rows. */
29317 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29318 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29319 && glyph
->type
== STRETCH_GLYPH
29320 && glyph
->avoid_cursor_p
))
29322 if (clear_mouse_face (hlinfo
))
29323 cursor
= No_Cursor
;
29324 #ifdef HAVE_WINDOW_SYSTEM
29325 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29327 if (area
!= TEXT_AREA
)
29328 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29330 pointer
= Vvoid_text_area_pointer
;
29336 pos
= glyph
->charpos
;
29337 object
= glyph
->object
;
29338 if (!STRINGP (object
) && !BUFFERP (object
))
29341 /* If we get an out-of-range value, return now; avoid an error. */
29342 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29345 /* Make the window's buffer temporarily current for
29346 overlays_at and compute_char_face. */
29347 obuf
= current_buffer
;
29348 current_buffer
= b
;
29354 /* Is this char mouse-active or does it have help-echo? */
29355 position
= make_number (pos
);
29357 if (BUFFERP (object
))
29359 /* Put all the overlays we want in a vector in overlay_vec. */
29360 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
29361 /* Sort overlays into increasing priority order. */
29362 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29367 if (NILP (Vmouse_highlight
))
29369 clear_mouse_face (hlinfo
);
29370 goto check_help_echo
;
29373 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29376 cursor
= No_Cursor
;
29378 /* Check mouse-face highlighting. */
29380 /* If there exists an overlay with mouse-face overlapping
29381 the one we are currently highlighting, we have to
29382 check if we enter the overlapping overlay, and then
29383 highlight only that. */
29384 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29385 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29387 /* Find the highest priority overlay with a mouse-face. */
29388 Lisp_Object overlay
= Qnil
;
29389 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29391 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29392 if (!NILP (mouse_face
))
29393 overlay
= overlay_vec
[i
];
29396 /* If we're highlighting the same overlay as before, there's
29397 no need to do that again. */
29398 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29399 goto check_help_echo
;
29400 hlinfo
->mouse_face_overlay
= overlay
;
29402 /* Clear the display of the old active region, if any. */
29403 if (clear_mouse_face (hlinfo
))
29404 cursor
= No_Cursor
;
29406 /* If no overlay applies, get a text property. */
29407 if (NILP (overlay
))
29408 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29410 /* Next, compute the bounds of the mouse highlighting and
29412 if (!NILP (mouse_face
) && STRINGP (object
))
29414 /* The mouse-highlighting comes from a display string
29415 with a mouse-face. */
29419 s
= Fprevious_single_property_change
29420 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29421 e
= Fnext_single_property_change
29422 (position
, Qmouse_face
, object
, Qnil
);
29424 s
= make_number (0);
29426 e
= make_number (SCHARS (object
));
29427 mouse_face_from_string_pos (w
, hlinfo
, object
,
29428 XINT (s
), XINT (e
));
29429 hlinfo
->mouse_face_past_end
= 0;
29430 hlinfo
->mouse_face_window
= window
;
29431 hlinfo
->mouse_face_face_id
29432 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29433 glyph
->face_id
, 1);
29434 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29435 cursor
= No_Cursor
;
29439 /* The mouse-highlighting, if any, comes from an overlay
29440 or text property in the buffer. */
29441 Lisp_Object buffer
IF_LINT (= Qnil
);
29442 Lisp_Object disp_string
IF_LINT (= Qnil
);
29444 if (STRINGP (object
))
29446 /* If we are on a display string with no mouse-face,
29447 check if the text under it has one. */
29448 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29449 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29450 pos
= string_buffer_position (object
, start
);
29453 mouse_face
= get_char_property_and_overlay
29454 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29455 buffer
= w
->contents
;
29456 disp_string
= object
;
29462 disp_string
= Qnil
;
29465 if (!NILP (mouse_face
))
29467 Lisp_Object before
, after
;
29468 Lisp_Object before_string
, after_string
;
29469 /* To correctly find the limits of mouse highlight
29470 in a bidi-reordered buffer, we must not use the
29471 optimization of limiting the search in
29472 previous-single-property-change and
29473 next-single-property-change, because
29474 rows_from_pos_range needs the real start and end
29475 positions to DTRT in this case. That's because
29476 the first row visible in a window does not
29477 necessarily display the character whose position
29478 is the smallest. */
29480 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29481 ? Fmarker_position (w
->start
)
29484 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29485 ? make_number (BUF_Z (XBUFFER (buffer
))
29486 - w
->window_end_pos
)
29489 if (NILP (overlay
))
29491 /* Handle the text property case. */
29492 before
= Fprevious_single_property_change
29493 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29494 after
= Fnext_single_property_change
29495 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29496 before_string
= after_string
= Qnil
;
29500 /* Handle the overlay case. */
29501 before
= Foverlay_start (overlay
);
29502 after
= Foverlay_end (overlay
);
29503 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29504 after_string
= Foverlay_get (overlay
, Qafter_string
);
29506 if (!STRINGP (before_string
)) before_string
= Qnil
;
29507 if (!STRINGP (after_string
)) after_string
= Qnil
;
29510 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29513 : XFASTINT (before
),
29515 ? BUF_Z (XBUFFER (buffer
))
29516 : XFASTINT (after
),
29517 before_string
, after_string
,
29519 cursor
= No_Cursor
;
29526 /* Look for a `help-echo' property. */
29527 if (NILP (help_echo_string
)) {
29528 Lisp_Object help
, overlay
;
29530 /* Check overlays first. */
29531 help
= overlay
= Qnil
;
29532 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29534 overlay
= overlay_vec
[i
];
29535 help
= Foverlay_get (overlay
, Qhelp_echo
);
29540 help_echo_string
= help
;
29541 help_echo_window
= window
;
29542 help_echo_object
= overlay
;
29543 help_echo_pos
= pos
;
29547 Lisp_Object obj
= glyph
->object
;
29548 ptrdiff_t charpos
= glyph
->charpos
;
29550 /* Try text properties. */
29553 && charpos
< SCHARS (obj
))
29555 help
= Fget_text_property (make_number (charpos
),
29559 /* If the string itself doesn't specify a help-echo,
29560 see if the buffer text ``under'' it does. */
29561 struct glyph_row
*r
29562 = MATRIX_ROW (w
->current_matrix
, vpos
);
29563 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29564 ptrdiff_t p
= string_buffer_position (obj
, start
);
29567 help
= Fget_char_property (make_number (p
),
29568 Qhelp_echo
, w
->contents
);
29577 else if (BUFFERP (obj
)
29580 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
29585 help_echo_string
= help
;
29586 help_echo_window
= window
;
29587 help_echo_object
= obj
;
29588 help_echo_pos
= charpos
;
29593 #ifdef HAVE_WINDOW_SYSTEM
29594 /* Look for a `pointer' property. */
29595 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29597 /* Check overlays first. */
29598 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
29599 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
29601 if (NILP (pointer
))
29603 Lisp_Object obj
= glyph
->object
;
29604 ptrdiff_t charpos
= glyph
->charpos
;
29606 /* Try text properties. */
29609 && charpos
< SCHARS (obj
))
29611 pointer
= Fget_text_property (make_number (charpos
),
29613 if (NILP (pointer
))
29615 /* If the string itself doesn't specify a pointer,
29616 see if the buffer text ``under'' it does. */
29617 struct glyph_row
*r
29618 = MATRIX_ROW (w
->current_matrix
, vpos
);
29619 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29620 ptrdiff_t p
= string_buffer_position (obj
, start
);
29622 pointer
= Fget_char_property (make_number (p
),
29623 Qpointer
, w
->contents
);
29626 else if (BUFFERP (obj
)
29629 pointer
= Fget_text_property (make_number (charpos
),
29633 #endif /* HAVE_WINDOW_SYSTEM */
29637 current_buffer
= obuf
;
29642 #ifdef HAVE_WINDOW_SYSTEM
29643 if (FRAME_WINDOW_P (f
))
29644 define_frame_cursor1 (f
, cursor
, pointer
);
29646 /* This is here to prevent a compiler error, about "label at end of
29647 compound statement". */
29654 Clear any mouse-face on window W. This function is part of the
29655 redisplay interface, and is called from try_window_id and similar
29656 functions to ensure the mouse-highlight is off. */
29659 x_clear_window_mouse_face (struct window
*w
)
29661 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
29662 Lisp_Object window
;
29665 XSETWINDOW (window
, w
);
29666 if (EQ (window
, hlinfo
->mouse_face_window
))
29667 clear_mouse_face (hlinfo
);
29673 Just discard the mouse face information for frame F, if any.
29674 This is used when the size of F is changed. */
29677 cancel_mouse_face (struct frame
*f
)
29679 Lisp_Object window
;
29680 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29682 window
= hlinfo
->mouse_face_window
;
29683 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
29684 reset_mouse_highlight (hlinfo
);
29689 /***********************************************************************
29691 ***********************************************************************/
29693 #ifdef HAVE_WINDOW_SYSTEM
29695 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
29696 which intersects rectangle R. R is in window-relative coordinates. */
29699 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
29700 enum glyph_row_area area
)
29702 struct glyph
*first
= row
->glyphs
[area
];
29703 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
29704 struct glyph
*last
;
29705 int first_x
, start_x
, x
;
29707 if (area
== TEXT_AREA
&& row
->fill_line_p
)
29708 /* If row extends face to end of line write the whole line. */
29709 draw_glyphs (w
, 0, row
, area
,
29710 0, row
->used
[area
],
29711 DRAW_NORMAL_TEXT
, 0);
29714 /* Set START_X to the window-relative start position for drawing glyphs of
29715 AREA. The first glyph of the text area can be partially visible.
29716 The first glyphs of other areas cannot. */
29717 start_x
= window_box_left_offset (w
, area
);
29719 if (area
== TEXT_AREA
)
29722 /* Find the first glyph that must be redrawn. */
29724 && x
+ first
->pixel_width
< r
->x
)
29726 x
+= first
->pixel_width
;
29730 /* Find the last one. */
29734 && x
< r
->x
+ r
->width
)
29736 x
+= last
->pixel_width
;
29742 draw_glyphs (w
, first_x
- start_x
, row
, area
,
29743 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
29744 DRAW_NORMAL_TEXT
, 0);
29749 /* Redraw the parts of the glyph row ROW on window W intersecting
29750 rectangle R. R is in window-relative coordinates. Value is
29751 non-zero if mouse-face was overwritten. */
29754 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
29756 eassert (row
->enabled_p
);
29758 if (row
->mode_line_p
|| w
->pseudo_window_p
)
29759 draw_glyphs (w
, 0, row
, TEXT_AREA
,
29760 0, row
->used
[TEXT_AREA
],
29761 DRAW_NORMAL_TEXT
, 0);
29764 if (row
->used
[LEFT_MARGIN_AREA
])
29765 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
29766 if (row
->used
[TEXT_AREA
])
29767 expose_area (w
, row
, r
, TEXT_AREA
);
29768 if (row
->used
[RIGHT_MARGIN_AREA
])
29769 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
29770 draw_row_fringe_bitmaps (w
, row
);
29773 return row
->mouse_face_p
;
29777 /* Redraw those parts of glyphs rows during expose event handling that
29778 overlap other rows. Redrawing of an exposed line writes over parts
29779 of lines overlapping that exposed line; this function fixes that.
29781 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
29782 row in W's current matrix that is exposed and overlaps other rows.
29783 LAST_OVERLAPPING_ROW is the last such row. */
29786 expose_overlaps (struct window
*w
,
29787 struct glyph_row
*first_overlapping_row
,
29788 struct glyph_row
*last_overlapping_row
,
29791 struct glyph_row
*row
;
29793 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
29794 if (row
->overlapping_p
)
29796 eassert (row
->enabled_p
&& !row
->mode_line_p
);
29799 if (row
->used
[LEFT_MARGIN_AREA
])
29800 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
29802 if (row
->used
[TEXT_AREA
])
29803 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
29805 if (row
->used
[RIGHT_MARGIN_AREA
])
29806 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
29812 /* Return non-zero if W's cursor intersects rectangle R. */
29815 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
29817 XRectangle cr
, result
;
29818 struct glyph
*cursor_glyph
;
29819 struct glyph_row
*row
;
29821 if (w
->phys_cursor
.vpos
>= 0
29822 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
29823 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
29825 && row
->cursor_in_fringe_p
)
29827 /* Cursor is in the fringe. */
29828 cr
.x
= window_box_right_offset (w
,
29829 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
29830 ? RIGHT_MARGIN_AREA
29833 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
29834 cr
.height
= row
->height
;
29835 return x_intersect_rectangles (&cr
, r
, &result
);
29838 cursor_glyph
= get_phys_cursor_glyph (w
);
29841 /* r is relative to W's box, but w->phys_cursor.x is relative
29842 to left edge of W's TEXT area. Adjust it. */
29843 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
29844 cr
.y
= w
->phys_cursor
.y
;
29845 cr
.width
= cursor_glyph
->pixel_width
;
29846 cr
.height
= w
->phys_cursor_height
;
29847 /* ++KFS: W32 version used W32-specific IntersectRect here, but
29848 I assume the effect is the same -- and this is portable. */
29849 return x_intersect_rectangles (&cr
, r
, &result
);
29851 /* If we don't understand the format, pretend we're not in the hot-spot. */
29857 Draw a vertical window border to the right of window W if W doesn't
29858 have vertical scroll bars. */
29861 x_draw_vertical_border (struct window
*w
)
29863 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29865 /* We could do better, if we knew what type of scroll-bar the adjacent
29866 windows (on either side) have... But we don't :-(
29867 However, I think this works ok. ++KFS 2003-04-25 */
29869 /* Redraw borders between horizontally adjacent windows. Don't
29870 do it for frames with vertical scroll bars because either the
29871 right scroll bar of a window, or the left scroll bar of its
29872 neighbor will suffice as a border. */
29873 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
29876 /* Note: It is necessary to redraw both the left and the right
29877 borders, for when only this single window W is being
29879 if (!WINDOW_RIGHTMOST_P (w
)
29880 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
29882 int x0
, x1
, y0
, y1
;
29884 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29887 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29890 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
29893 if (!WINDOW_LEFTMOST_P (w
)
29894 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
29896 int x0
, x1
, y0
, y1
;
29898 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29901 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29904 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
29909 /* Draw window dividers for window W. */
29912 x_draw_right_divider (struct window
*w
)
29914 struct frame
*f
= WINDOW_XFRAME (w
);
29916 if (w
->mini
|| w
->pseudo_window_p
)
29918 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
29920 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
29921 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29922 int y0
= WINDOW_TOP_EDGE_Y (w
);
29923 /* The bottom divider prevails. */
29924 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29926 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29931 x_draw_bottom_divider (struct window
*w
)
29933 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29935 if (w
->mini
|| w
->pseudo_window_p
)
29937 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
29939 int x0
= WINDOW_LEFT_EDGE_X (w
);
29940 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29941 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29942 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
29944 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29948 /* Redraw the part of window W intersection rectangle FR. Pixel
29949 coordinates in FR are frame-relative. Call this function with
29950 input blocked. Value is non-zero if the exposure overwrites
29954 expose_window (struct window
*w
, XRectangle
*fr
)
29956 struct frame
*f
= XFRAME (w
->frame
);
29958 int mouse_face_overwritten_p
= 0;
29960 /* If window is not yet fully initialized, do nothing. This can
29961 happen when toolkit scroll bars are used and a window is split.
29962 Reconfiguring the scroll bar will generate an expose for a newly
29964 if (w
->current_matrix
== NULL
)
29967 /* When we're currently updating the window, display and current
29968 matrix usually don't agree. Arrange for a thorough display
29970 if (w
->must_be_updated_p
)
29972 SET_FRAME_GARBAGED (f
);
29976 /* Frame-relative pixel rectangle of W. */
29977 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
29978 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
29979 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
29980 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
29982 if (x_intersect_rectangles (fr
, &wr
, &r
))
29984 int yb
= window_text_bottom_y (w
);
29985 struct glyph_row
*row
;
29986 int cursor_cleared_p
, phys_cursor_on_p
;
29987 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
29989 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
29990 r
.x
, r
.y
, r
.width
, r
.height
));
29992 /* Convert to window coordinates. */
29993 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
29994 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
29996 /* Turn off the cursor. */
29997 if (!w
->pseudo_window_p
29998 && phys_cursor_in_rect_p (w
, &r
))
30000 x_clear_cursor (w
);
30001 cursor_cleared_p
= 1;
30004 cursor_cleared_p
= 0;
30006 /* If the row containing the cursor extends face to end of line,
30007 then expose_area might overwrite the cursor outside the
30008 rectangle and thus notice_overwritten_cursor might clear
30009 w->phys_cursor_on_p. We remember the original value and
30010 check later if it is changed. */
30011 phys_cursor_on_p
= w
->phys_cursor_on_p
;
30013 /* Update lines intersecting rectangle R. */
30014 first_overlapping_row
= last_overlapping_row
= NULL
;
30015 for (row
= w
->current_matrix
->rows
;
30020 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30022 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
30023 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
30024 || (r
.y
>= y0
&& r
.y
< y1
)
30025 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
30027 /* A header line may be overlapping, but there is no need
30028 to fix overlapping areas for them. KFS 2005-02-12 */
30029 if (row
->overlapping_p
&& !row
->mode_line_p
)
30031 if (first_overlapping_row
== NULL
)
30032 first_overlapping_row
= row
;
30033 last_overlapping_row
= row
;
30037 if (expose_line (w
, row
, &r
))
30038 mouse_face_overwritten_p
= 1;
30041 else if (row
->overlapping_p
)
30043 /* We must redraw a row overlapping the exposed area. */
30045 ? y0
+ row
->phys_height
> r
.y
30046 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30048 if (first_overlapping_row
== NULL
)
30049 first_overlapping_row
= row
;
30050 last_overlapping_row
= row
;
30058 /* Display the mode line if there is one. */
30059 if (WINDOW_WANTS_MODELINE_P (w
)
30060 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30062 && row
->y
< r
.y
+ r
.height
)
30064 if (expose_line (w
, row
, &r
))
30065 mouse_face_overwritten_p
= 1;
30068 if (!w
->pseudo_window_p
)
30070 /* Fix the display of overlapping rows. */
30071 if (first_overlapping_row
)
30072 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30075 /* Draw border between windows. */
30076 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30077 x_draw_right_divider (w
);
30079 x_draw_vertical_border (w
);
30081 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30082 x_draw_bottom_divider (w
);
30084 /* Turn the cursor on again. */
30085 if (cursor_cleared_p
30086 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30087 update_window_cursor (w
, 1);
30091 return mouse_face_overwritten_p
;
30096 /* Redraw (parts) of all windows in the window tree rooted at W that
30097 intersect R. R contains frame pixel coordinates. Value is
30098 non-zero if the exposure overwrites mouse-face. */
30101 expose_window_tree (struct window
*w
, XRectangle
*r
)
30103 struct frame
*f
= XFRAME (w
->frame
);
30104 int mouse_face_overwritten_p
= 0;
30106 while (w
&& !FRAME_GARBAGED_P (f
))
30108 if (WINDOWP (w
->contents
))
30109 mouse_face_overwritten_p
30110 |= expose_window_tree (XWINDOW (w
->contents
), r
);
30112 mouse_face_overwritten_p
|= expose_window (w
, r
);
30114 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30117 return mouse_face_overwritten_p
;
30122 Redisplay an exposed area of frame F. X and Y are the upper-left
30123 corner of the exposed rectangle. W and H are width and height of
30124 the exposed area. All are pixel values. W or H zero means redraw
30125 the entire frame. */
30128 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30131 int mouse_face_overwritten_p
= 0;
30133 TRACE ((stderr
, "expose_frame "));
30135 /* No need to redraw if frame will be redrawn soon. */
30136 if (FRAME_GARBAGED_P (f
))
30138 TRACE ((stderr
, " garbaged\n"));
30142 /* If basic faces haven't been realized yet, there is no point in
30143 trying to redraw anything. This can happen when we get an expose
30144 event while Emacs is starting, e.g. by moving another window. */
30145 if (FRAME_FACE_CACHE (f
) == NULL
30146 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30148 TRACE ((stderr
, " no faces\n"));
30152 if (w
== 0 || h
== 0)
30155 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
30156 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
30166 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30167 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30169 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30170 if (WINDOWP (f
->tool_bar_window
))
30171 mouse_face_overwritten_p
30172 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30175 #ifdef HAVE_X_WINDOWS
30177 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30178 if (WINDOWP (f
->menu_bar_window
))
30179 mouse_face_overwritten_p
30180 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30181 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30185 /* Some window managers support a focus-follows-mouse style with
30186 delayed raising of frames. Imagine a partially obscured frame,
30187 and moving the mouse into partially obscured mouse-face on that
30188 frame. The visible part of the mouse-face will be highlighted,
30189 then the WM raises the obscured frame. With at least one WM, KDE
30190 2.1, Emacs is not getting any event for the raising of the frame
30191 (even tried with SubstructureRedirectMask), only Expose events.
30192 These expose events will draw text normally, i.e. not
30193 highlighted. Which means we must redo the highlight here.
30194 Subsume it under ``we love X''. --gerd 2001-08-15 */
30195 /* Included in Windows version because Windows most likely does not
30196 do the right thing if any third party tool offers
30197 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30198 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
30200 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30201 if (f
== hlinfo
->mouse_face_mouse_frame
)
30203 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
30204 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
30205 clear_mouse_face (hlinfo
);
30206 note_mouse_highlight (f
, mouse_x
, mouse_y
);
30213 Determine the intersection of two rectangles R1 and R2. Return
30214 the intersection in *RESULT. Value is non-zero if RESULT is not
30218 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
30220 XRectangle
*left
, *right
;
30221 XRectangle
*upper
, *lower
;
30222 int intersection_p
= 0;
30224 /* Rearrange so that R1 is the left-most rectangle. */
30226 left
= r1
, right
= r2
;
30228 left
= r2
, right
= r1
;
30230 /* X0 of the intersection is right.x0, if this is inside R1,
30231 otherwise there is no intersection. */
30232 if (right
->x
<= left
->x
+ left
->width
)
30234 result
->x
= right
->x
;
30236 /* The right end of the intersection is the minimum of
30237 the right ends of left and right. */
30238 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
30241 /* Same game for Y. */
30243 upper
= r1
, lower
= r2
;
30245 upper
= r2
, lower
= r1
;
30247 /* The upper end of the intersection is lower.y0, if this is inside
30248 of upper. Otherwise, there is no intersection. */
30249 if (lower
->y
<= upper
->y
+ upper
->height
)
30251 result
->y
= lower
->y
;
30253 /* The lower end of the intersection is the minimum of the lower
30254 ends of upper and lower. */
30255 result
->height
= (min (lower
->y
+ lower
->height
,
30256 upper
->y
+ upper
->height
)
30258 intersection_p
= 1;
30262 return intersection_p
;
30265 #endif /* HAVE_WINDOW_SYSTEM */
30268 /***********************************************************************
30270 ***********************************************************************/
30273 syms_of_xdisp (void)
30275 Vwith_echo_area_save_vector
= Qnil
;
30276 staticpro (&Vwith_echo_area_save_vector
);
30278 Vmessage_stack
= Qnil
;
30279 staticpro (&Vmessage_stack
);
30281 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30282 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30284 message_dolog_marker1
= Fmake_marker ();
30285 staticpro (&message_dolog_marker1
);
30286 message_dolog_marker2
= Fmake_marker ();
30287 staticpro (&message_dolog_marker2
);
30288 message_dolog_marker3
= Fmake_marker ();
30289 staticpro (&message_dolog_marker3
);
30292 defsubr (&Sdump_frame_glyph_matrix
);
30293 defsubr (&Sdump_glyph_matrix
);
30294 defsubr (&Sdump_glyph_row
);
30295 defsubr (&Sdump_tool_bar_row
);
30296 defsubr (&Strace_redisplay
);
30297 defsubr (&Strace_to_stderr
);
30299 #ifdef HAVE_WINDOW_SYSTEM
30300 defsubr (&Stool_bar_height
);
30301 defsubr (&Slookup_image_map
);
30303 defsubr (&Sline_pixel_height
);
30304 defsubr (&Sformat_mode_line
);
30305 defsubr (&Sinvisible_p
);
30306 defsubr (&Scurrent_bidi_paragraph_direction
);
30307 defsubr (&Swindow_text_pixel_size
);
30308 defsubr (&Smove_point_visually
);
30310 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30311 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30312 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30313 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30314 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30315 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30316 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30317 DEFSYM (Qeval
, "eval");
30318 DEFSYM (QCdata
, ":data");
30319 DEFSYM (Qdisplay
, "display");
30320 DEFSYM (Qspace_width
, "space-width");
30321 DEFSYM (Qraise
, "raise");
30322 DEFSYM (Qslice
, "slice");
30323 DEFSYM (Qspace
, "space");
30324 DEFSYM (Qmargin
, "margin");
30325 DEFSYM (Qpointer
, "pointer");
30326 DEFSYM (Qleft_margin
, "left-margin");
30327 DEFSYM (Qright_margin
, "right-margin");
30328 DEFSYM (Qcenter
, "center");
30329 DEFSYM (Qline_height
, "line-height");
30330 DEFSYM (QCalign_to
, ":align-to");
30331 DEFSYM (QCrelative_width
, ":relative-width");
30332 DEFSYM (QCrelative_height
, ":relative-height");
30333 DEFSYM (QCeval
, ":eval");
30334 DEFSYM (QCpropertize
, ":propertize");
30335 DEFSYM (QCfile
, ":file");
30336 DEFSYM (Qfontified
, "fontified");
30337 DEFSYM (Qfontification_functions
, "fontification-functions");
30338 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30339 DEFSYM (Qescape_glyph
, "escape-glyph");
30340 DEFSYM (Qnobreak_space
, "nobreak-space");
30341 DEFSYM (Qimage
, "image");
30342 DEFSYM (Qtext
, "text");
30343 DEFSYM (Qboth
, "both");
30344 DEFSYM (Qboth_horiz
, "both-horiz");
30345 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30346 DEFSYM (QCmap
, ":map");
30347 DEFSYM (QCpointer
, ":pointer");
30348 DEFSYM (Qrect
, "rect");
30349 DEFSYM (Qcircle
, "circle");
30350 DEFSYM (Qpoly
, "poly");
30351 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
30352 DEFSYM (Qgrow_only
, "grow-only");
30353 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30354 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30355 DEFSYM (Qposition
, "position");
30356 DEFSYM (Qbuffer_position
, "buffer-position");
30357 DEFSYM (Qobject
, "object");
30358 DEFSYM (Qbar
, "bar");
30359 DEFSYM (Qhbar
, "hbar");
30360 DEFSYM (Qbox
, "box");
30361 DEFSYM (Qhollow
, "hollow");
30362 DEFSYM (Qhand
, "hand");
30363 DEFSYM (Qarrow
, "arrow");
30364 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30366 list_of_error
= list1 (list2 (intern_c_string ("error"),
30367 intern_c_string ("void-variable")));
30368 staticpro (&list_of_error
);
30370 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30371 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30372 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30373 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30375 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30376 staticpro (&echo_buffer
[0]);
30377 staticpro (&echo_buffer
[1]);
30379 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30380 staticpro (&echo_area_buffer
[0]);
30381 staticpro (&echo_area_buffer
[1]);
30383 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30384 staticpro (&Vmessages_buffer_name
);
30386 mode_line_proptrans_alist
= Qnil
;
30387 staticpro (&mode_line_proptrans_alist
);
30388 mode_line_string_list
= Qnil
;
30389 staticpro (&mode_line_string_list
);
30390 mode_line_string_face
= Qnil
;
30391 staticpro (&mode_line_string_face
);
30392 mode_line_string_face_prop
= Qnil
;
30393 staticpro (&mode_line_string_face_prop
);
30394 Vmode_line_unwind_vector
= Qnil
;
30395 staticpro (&Vmode_line_unwind_vector
);
30397 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30399 help_echo_string
= Qnil
;
30400 staticpro (&help_echo_string
);
30401 help_echo_object
= Qnil
;
30402 staticpro (&help_echo_object
);
30403 help_echo_window
= Qnil
;
30404 staticpro (&help_echo_window
);
30405 previous_help_echo_string
= Qnil
;
30406 staticpro (&previous_help_echo_string
);
30407 help_echo_pos
= -1;
30409 DEFSYM (Qright_to_left
, "right-to-left");
30410 DEFSYM (Qleft_to_right
, "left-to-right");
30412 #ifdef HAVE_WINDOW_SYSTEM
30413 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30414 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30415 For example, if a block cursor is over a tab, it will be drawn as
30416 wide as that tab on the display. */);
30417 x_stretch_cursor_p
= 0;
30420 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30421 doc
: /* Non-nil means highlight trailing whitespace.
30422 The face used for trailing whitespace is `trailing-whitespace'. */);
30423 Vshow_trailing_whitespace
= Qnil
;
30425 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30426 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30427 If the value is t, Emacs highlights non-ASCII chars which have the
30428 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30429 or `escape-glyph' face respectively.
30431 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30432 U+2011 (non-breaking hyphen) are affected.
30434 Any other non-nil value means to display these characters as a escape
30435 glyph followed by an ordinary space or hyphen.
30437 A value of nil means no special handling of these characters. */);
30438 Vnobreak_char_display
= Qt
;
30440 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30441 doc
: /* The pointer shape to show in void text areas.
30442 A value of nil means to show the text pointer. Other options are `arrow',
30443 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
30444 Vvoid_text_area_pointer
= Qarrow
;
30446 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30447 doc
: /* Non-nil means don't actually do any redisplay.
30448 This is used for internal purposes. */);
30449 Vinhibit_redisplay
= Qnil
;
30451 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30452 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30453 Vglobal_mode_string
= Qnil
;
30455 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30456 doc
: /* Marker for where to display an arrow on top of the buffer text.
30457 This must be the beginning of a line in order to work.
30458 See also `overlay-arrow-string'. */);
30459 Voverlay_arrow_position
= Qnil
;
30461 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30462 doc
: /* String to display as an arrow in non-window frames.
30463 See also `overlay-arrow-position'. */);
30464 Voverlay_arrow_string
= build_pure_c_string ("=>");
30466 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30467 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30468 The symbols on this list are examined during redisplay to determine
30469 where to display overlay arrows. */);
30470 Voverlay_arrow_variable_list
30471 = list1 (intern_c_string ("overlay-arrow-position"));
30473 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30474 doc
: /* The number of lines to try scrolling a window by when point moves out.
30475 If that fails to bring point back on frame, point is centered instead.
30476 If this is zero, point is always centered after it moves off frame.
30477 If you want scrolling to always be a line at a time, you should set
30478 `scroll-conservatively' to a large value rather than set this to 1. */);
30480 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30481 doc
: /* Scroll up to this many lines, to bring point back on screen.
30482 If point moves off-screen, redisplay will scroll by up to
30483 `scroll-conservatively' lines in order to bring point just barely
30484 onto the screen again. If that cannot be done, then redisplay
30485 recenters point as usual.
30487 If the value is greater than 100, redisplay will never recenter point,
30488 but will always scroll just enough text to bring point into view, even
30489 if you move far away.
30491 A value of zero means always recenter point if it moves off screen. */);
30492 scroll_conservatively
= 0;
30494 DEFVAR_INT ("scroll-margin", scroll_margin
,
30495 doc
: /* Number of lines of margin at the top and bottom of a window.
30496 Recenter the window whenever point gets within this many lines
30497 of the top or bottom of the window. */);
30500 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
30501 doc
: /* Pixels per inch value for non-window system displays.
30502 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30503 Vdisplay_pixels_per_inch
= make_float (72.0);
30506 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
30509 DEFVAR_LISP ("truncate-partial-width-windows",
30510 Vtruncate_partial_width_windows
,
30511 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
30512 For an integer value, truncate lines in each window narrower than the
30513 full frame width, provided the window width is less than that integer;
30514 otherwise, respect the value of `truncate-lines'.
30516 For any other non-nil value, truncate lines in all windows that do
30517 not span the full frame width.
30519 A value of nil means to respect the value of `truncate-lines'.
30521 If `word-wrap' is enabled, you might want to reduce this. */);
30522 Vtruncate_partial_width_windows
= make_number (50);
30524 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
30525 doc
: /* Maximum buffer size for which line number should be displayed.
30526 If the buffer is bigger than this, the line number does not appear
30527 in the mode line. A value of nil means no limit. */);
30528 Vline_number_display_limit
= Qnil
;
30530 DEFVAR_INT ("line-number-display-limit-width",
30531 line_number_display_limit_width
,
30532 doc
: /* Maximum line width (in characters) for line number display.
30533 If the average length of the lines near point is bigger than this, then the
30534 line number may be omitted from the mode line. */);
30535 line_number_display_limit_width
= 200;
30537 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
30538 doc
: /* Non-nil means highlight region even in nonselected windows. */);
30539 highlight_nonselected_windows
= 0;
30541 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
30542 doc
: /* Non-nil if more than one frame is visible on this display.
30543 Minibuffer-only frames don't count, but iconified frames do.
30544 This variable is not guaranteed to be accurate except while processing
30545 `frame-title-format' and `icon-title-format'. */);
30547 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
30548 doc
: /* Template for displaying the title bar of visible frames.
30549 \(Assuming the window manager supports this feature.)
30551 This variable has the same structure as `mode-line-format', except that
30552 the %c and %l constructs are ignored. It is used only on frames for
30553 which no explicit name has been set \(see `modify-frame-parameters'). */);
30555 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
30556 doc
: /* Template for displaying the title bar of an iconified frame.
30557 \(Assuming the window manager supports this feature.)
30558 This variable has the same structure as `mode-line-format' (which see),
30559 and is used only on frames for which no explicit name has been set
30560 \(see `modify-frame-parameters'). */);
30562 = Vframe_title_format
30563 = listn (CONSTYPE_PURE
, 3,
30564 intern_c_string ("multiple-frames"),
30565 build_pure_c_string ("%b"),
30566 listn (CONSTYPE_PURE
, 4,
30567 empty_unibyte_string
,
30568 intern_c_string ("invocation-name"),
30569 build_pure_c_string ("@"),
30570 intern_c_string ("system-name")));
30572 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
30573 doc
: /* Maximum number of lines to keep in the message log buffer.
30574 If nil, disable message logging. If t, log messages but don't truncate
30575 the buffer when it becomes large. */);
30576 Vmessage_log_max
= make_number (1000);
30578 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
30579 doc
: /* Functions called before redisplay, if window sizes have changed.
30580 The value should be a list of functions that take one argument.
30581 Just before redisplay, for each frame, if any of its windows have changed
30582 size since the last redisplay, or have been split or deleted,
30583 all the functions in the list are called, with the frame as argument. */);
30584 Vwindow_size_change_functions
= Qnil
;
30586 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
30587 doc
: /* List of functions to call before redisplaying a window with scrolling.
30588 Each function is called with two arguments, the window and its new
30589 display-start position. Note that these functions are also called by
30590 `set-window-buffer'. Also note that the value of `window-end' is not
30591 valid when these functions are called.
30593 Warning: Do not use this feature to alter the way the window
30594 is scrolled. It is not designed for that, and such use probably won't
30596 Vwindow_scroll_functions
= Qnil
;
30598 DEFVAR_LISP ("window-text-change-functions",
30599 Vwindow_text_change_functions
,
30600 doc
: /* Functions to call in redisplay when text in the window might change. */);
30601 Vwindow_text_change_functions
= Qnil
;
30603 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
30604 doc
: /* Functions called when redisplay of a window reaches the end trigger.
30605 Each function is called with two arguments, the window and the end trigger value.
30606 See `set-window-redisplay-end-trigger'. */);
30607 Vredisplay_end_trigger_functions
= Qnil
;
30609 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
30610 doc
: /* Non-nil means autoselect window with mouse pointer.
30611 If nil, do not autoselect windows.
30612 A positive number means delay autoselection by that many seconds: a
30613 window is autoselected only after the mouse has remained in that
30614 window for the duration of the delay.
30615 A negative number has a similar effect, but causes windows to be
30616 autoselected only after the mouse has stopped moving. \(Because of
30617 the way Emacs compares mouse events, you will occasionally wait twice
30618 that time before the window gets selected.\)
30619 Any other value means to autoselect window instantaneously when the
30620 mouse pointer enters it.
30622 Autoselection selects the minibuffer only if it is active, and never
30623 unselects the minibuffer if it is active.
30625 When customizing this variable make sure that the actual value of
30626 `focus-follows-mouse' matches the behavior of your window manager. */);
30627 Vmouse_autoselect_window
= Qnil
;
30629 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
30630 doc
: /* Non-nil means automatically resize tool-bars.
30631 This dynamically changes the tool-bar's height to the minimum height
30632 that is needed to make all tool-bar items visible.
30633 If value is `grow-only', the tool-bar's height is only increased
30634 automatically; to decrease the tool-bar height, use \\[recenter]. */);
30635 Vauto_resize_tool_bars
= Qt
;
30637 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
30638 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
30639 auto_raise_tool_bar_buttons_p
= 1;
30641 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
30642 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
30643 make_cursor_line_fully_visible_p
= 1;
30645 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
30646 doc
: /* Border below tool-bar in pixels.
30647 If an integer, use it as the height of the border.
30648 If it is one of `internal-border-width' or `border-width', use the
30649 value of the corresponding frame parameter.
30650 Otherwise, no border is added below the tool-bar. */);
30651 Vtool_bar_border
= Qinternal_border_width
;
30653 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
30654 doc
: /* Margin around tool-bar buttons in pixels.
30655 If an integer, use that for both horizontal and vertical margins.
30656 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
30657 HORZ specifying the horizontal margin, and VERT specifying the
30658 vertical margin. */);
30659 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
30661 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
30662 doc
: /* Relief thickness of tool-bar buttons. */);
30663 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
30665 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
30666 doc
: /* Tool bar style to use.
30668 image - show images only
30669 text - show text only
30670 both - show both, text below image
30671 both-horiz - show text to the right of the image
30672 text-image-horiz - show text to the left of the image
30673 any other - use system default or image if no system default.
30675 This variable only affects the GTK+ toolkit version of Emacs. */);
30676 Vtool_bar_style
= Qnil
;
30678 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
30679 doc
: /* Maximum number of characters a label can have to be shown.
30680 The tool bar style must also show labels for this to have any effect, see
30681 `tool-bar-style'. */);
30682 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
30684 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
30685 doc
: /* List of functions to call to fontify regions of text.
30686 Each function is called with one argument POS. Functions must
30687 fontify a region starting at POS in the current buffer, and give
30688 fontified regions the property `fontified'. */);
30689 Vfontification_functions
= Qnil
;
30690 Fmake_variable_buffer_local (Qfontification_functions
);
30692 DEFVAR_BOOL ("unibyte-display-via-language-environment",
30693 unibyte_display_via_language_environment
,
30694 doc
: /* Non-nil means display unibyte text according to language environment.
30695 Specifically, this means that raw bytes in the range 160-255 decimal
30696 are displayed by converting them to the equivalent multibyte characters
30697 according to the current language environment. As a result, they are
30698 displayed according to the current fontset.
30700 Note that this variable affects only how these bytes are displayed,
30701 but does not change the fact they are interpreted as raw bytes. */);
30702 unibyte_display_via_language_environment
= 0;
30704 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
30705 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
30706 If a float, it specifies a fraction of the mini-window frame's height.
30707 If an integer, it specifies a number of lines. */);
30708 Vmax_mini_window_height
= make_float (0.25);
30710 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
30711 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
30712 A value of nil means don't automatically resize mini-windows.
30713 A value of t means resize them to fit the text displayed in them.
30714 A value of `grow-only', the default, means let mini-windows grow only;
30715 they return to their normal size when the minibuffer is closed, or the
30716 echo area becomes empty. */);
30717 Vresize_mini_windows
= Qgrow_only
;
30719 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
30720 doc
: /* Alist specifying how to blink the cursor off.
30721 Each element has the form (ON-STATE . OFF-STATE). Whenever the
30722 `cursor-type' frame-parameter or variable equals ON-STATE,
30723 comparing using `equal', Emacs uses OFF-STATE to specify
30724 how to blink it off. ON-STATE and OFF-STATE are values for
30725 the `cursor-type' frame parameter.
30727 If a frame's ON-STATE has no entry in this list,
30728 the frame's other specifications determine how to blink the cursor off. */);
30729 Vblink_cursor_alist
= Qnil
;
30731 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
30732 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
30733 If non-nil, windows are automatically scrolled horizontally to make
30734 point visible. */);
30735 automatic_hscrolling_p
= 1;
30736 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
30738 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
30739 doc
: /* How many columns away from the window edge point is allowed to get
30740 before automatic hscrolling will horizontally scroll the window. */);
30741 hscroll_margin
= 5;
30743 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
30744 doc
: /* How many columns to scroll the window when point gets too close to the edge.
30745 When point is less than `hscroll-margin' columns from the window
30746 edge, automatic hscrolling will scroll the window by the amount of columns
30747 determined by this variable. If its value is a positive integer, scroll that
30748 many columns. If it's a positive floating-point number, it specifies the
30749 fraction of the window's width to scroll. If it's nil or zero, point will be
30750 centered horizontally after the scroll. Any other value, including negative
30751 numbers, are treated as if the value were zero.
30753 Automatic hscrolling always moves point outside the scroll margin, so if
30754 point was more than scroll step columns inside the margin, the window will
30755 scroll more than the value given by the scroll step.
30757 Note that the lower bound for automatic hscrolling specified by `scroll-left'
30758 and `scroll-right' overrides this variable's effect. */);
30759 Vhscroll_step
= make_number (0);
30761 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
30762 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
30763 Bind this around calls to `message' to let it take effect. */);
30764 message_truncate_lines
= 0;
30766 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
30767 doc
: /* Normal hook run to update the menu bar definitions.
30768 Redisplay runs this hook before it redisplays the menu bar.
30769 This is used to update menus such as Buffers, whose contents depend on
30771 Vmenu_bar_update_hook
= Qnil
;
30773 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
30774 doc
: /* Frame for which we are updating a menu.
30775 The enable predicate for a menu binding should check this variable. */);
30776 Vmenu_updating_frame
= Qnil
;
30778 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
30779 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
30780 inhibit_menubar_update
= 0;
30782 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
30783 doc
: /* Prefix prepended to all continuation lines at display time.
30784 The value may be a string, an image, or a stretch-glyph; it is
30785 interpreted in the same way as the value of a `display' text property.
30787 This variable is overridden by any `wrap-prefix' text or overlay
30790 To add a prefix to non-continuation lines, use `line-prefix'. */);
30791 Vwrap_prefix
= Qnil
;
30792 DEFSYM (Qwrap_prefix
, "wrap-prefix");
30793 Fmake_variable_buffer_local (Qwrap_prefix
);
30795 DEFVAR_LISP ("line-prefix", Vline_prefix
,
30796 doc
: /* Prefix prepended to all non-continuation lines at display time.
30797 The value may be a string, an image, or a stretch-glyph; it is
30798 interpreted in the same way as the value of a `display' text property.
30800 This variable is overridden by any `line-prefix' text or overlay
30803 To add a prefix to continuation lines, use `wrap-prefix'. */);
30804 Vline_prefix
= Qnil
;
30805 DEFSYM (Qline_prefix
, "line-prefix");
30806 Fmake_variable_buffer_local (Qline_prefix
);
30808 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
30809 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
30810 inhibit_eval_during_redisplay
= 0;
30812 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
30813 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
30814 inhibit_free_realized_faces
= 0;
30817 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
30818 doc
: /* Inhibit try_window_id display optimization. */);
30819 inhibit_try_window_id
= 0;
30821 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
30822 doc
: /* Inhibit try_window_reusing display optimization. */);
30823 inhibit_try_window_reusing
= 0;
30825 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
30826 doc
: /* Inhibit try_cursor_movement display optimization. */);
30827 inhibit_try_cursor_movement
= 0;
30828 #endif /* GLYPH_DEBUG */
30830 DEFVAR_INT ("overline-margin", overline_margin
,
30831 doc
: /* Space between overline and text, in pixels.
30832 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
30833 margin to the character height. */);
30834 overline_margin
= 2;
30836 DEFVAR_INT ("underline-minimum-offset",
30837 underline_minimum_offset
,
30838 doc
: /* Minimum distance between baseline and underline.
30839 This can improve legibility of underlined text at small font sizes,
30840 particularly when using variable `x-use-underline-position-properties'
30841 with fonts that specify an UNDERLINE_POSITION relatively close to the
30842 baseline. The default value is 1. */);
30843 underline_minimum_offset
= 1;
30845 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
30846 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
30847 This feature only works when on a window system that can change
30848 cursor shapes. */);
30849 display_hourglass_p
= 1;
30851 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
30852 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
30853 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
30855 #ifdef HAVE_WINDOW_SYSTEM
30856 hourglass_atimer
= NULL
;
30857 hourglass_shown_p
= 0;
30858 #endif /* HAVE_WINDOW_SYSTEM */
30860 DEFSYM (Qglyphless_char
, "glyphless-char");
30861 DEFSYM (Qhex_code
, "hex-code");
30862 DEFSYM (Qempty_box
, "empty-box");
30863 DEFSYM (Qthin_space
, "thin-space");
30864 DEFSYM (Qzero_width
, "zero-width");
30866 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
30867 doc
: /* Function run just before redisplay.
30868 It is called with one argument, which is the set of windows that are to
30869 be redisplayed. This set can be nil (meaning, only the selected window),
30870 or t (meaning all windows). */);
30871 Vpre_redisplay_function
= intern ("ignore");
30873 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
30874 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
30876 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
30877 doc
: /* Char-table defining glyphless characters.
30878 Each element, if non-nil, should be one of the following:
30879 an ASCII acronym string: display this string in a box
30880 `hex-code': display the hexadecimal code of a character in a box
30881 `empty-box': display as an empty box
30882 `thin-space': display as 1-pixel width space
30883 `zero-width': don't display
30884 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
30885 display method for graphical terminals and text terminals respectively.
30886 GRAPHICAL and TEXT should each have one of the values listed above.
30888 The char-table has one extra slot to control the display of a character for
30889 which no font is found. This slot only takes effect on graphical terminals.
30890 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
30891 `thin-space'. The default is `empty-box'.
30893 If a character has a non-nil entry in an active display table, the
30894 display table takes effect; in this case, Emacs does not consult
30895 `glyphless-char-display' at all. */);
30896 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
30897 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
30900 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
30901 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
30902 Vdebug_on_message
= Qnil
;
30904 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
30906 Vredisplay__all_windows_cause
30907 = Fmake_vector (make_number (100), make_number (0));
30909 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
30911 Vredisplay__mode_lines_cause
30912 = Fmake_vector (make_number (100), make_number (0));
30916 /* Initialize this module when Emacs starts. */
30921 CHARPOS (this_line_start_pos
) = 0;
30923 if (!noninteractive
)
30925 struct window
*m
= XWINDOW (minibuf_window
);
30926 Lisp_Object frame
= m
->frame
;
30927 struct frame
*f
= XFRAME (frame
);
30928 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
30929 struct window
*r
= XWINDOW (root
);
30932 echo_area_window
= minibuf_window
;
30934 r
->top_line
= FRAME_TOP_MARGIN (f
);
30935 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
30936 r
->total_cols
= FRAME_COLS (f
);
30937 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30938 r
->total_lines
= FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
30939 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
30941 m
->top_line
= FRAME_LINES (f
) - 1;
30942 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
30943 m
->total_cols
= FRAME_COLS (f
);
30944 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30945 m
->total_lines
= 1;
30946 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
30948 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
30949 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
30950 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
30952 /* The default ellipsis glyphs `...'. */
30953 for (i
= 0; i
< 3; ++i
)
30954 default_invis_vector
[i
] = make_number ('.');
30958 /* Allocate the buffer for frame titles.
30959 Also used for `format-mode-line'. */
30961 mode_line_noprop_buf
= xmalloc (size
);
30962 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
30963 mode_line_noprop_ptr
= mode_line_noprop_buf
;
30964 mode_line_target
= MODE_LINE_DISPLAY
;
30967 help_echo_showing_p
= 0;
30970 #ifdef HAVE_WINDOW_SYSTEM
30972 /* Platform-independent portion of hourglass implementation. */
30974 /* Cancel a currently active hourglass timer, and start a new one. */
30976 start_hourglass (void)
30978 struct timespec delay
;
30980 cancel_hourglass ();
30982 if (INTEGERP (Vhourglass_delay
)
30983 && XINT (Vhourglass_delay
) > 0)
30984 delay
= make_timespec (min (XINT (Vhourglass_delay
),
30985 TYPE_MAXIMUM (time_t)),
30987 else if (FLOATP (Vhourglass_delay
)
30988 && XFLOAT_DATA (Vhourglass_delay
) > 0)
30989 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
30991 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
30995 extern void w32_note_current_window (void);
30996 w32_note_current_window ();
30998 #endif /* HAVE_NTGUI */
31000 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31001 show_hourglass
, NULL
);
31005 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31008 cancel_hourglass (void)
31010 if (hourglass_atimer
)
31012 cancel_atimer (hourglass_atimer
);
31013 hourglass_atimer
= NULL
;
31016 if (hourglass_shown_p
)
31020 #endif /* HAVE_WINDOW_SYSTEM */