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
;
5112 else if (!frame_window_p
)
5115 #ifdef HAVE_WINDOW_SYSTEM
5116 value
= XCAR (XCDR (spec
));
5117 if (!SYMBOLP (value
)
5118 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
5119 /* If we return here, POSITION has been advanced
5120 across the text with this property. */
5122 if (it
&& it
->bidi_p
)
5124 it
->position
= *position
;
5125 iterate_out_of_display_property (it
);
5126 *position
= it
->position
;
5133 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
5135 if (CONSP (XCDR (XCDR (spec
))))
5137 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5138 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5144 /* Save current settings of IT so that we can restore them
5145 when we are finished with the glyph property value. */
5146 push_it (it
, position
);
5148 it
->area
= TEXT_AREA
;
5149 it
->what
= IT_IMAGE
;
5150 it
->image_id
= -1; /* no image */
5151 it
->position
= start_pos
;
5152 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5153 it
->method
= GET_FROM_IMAGE
;
5154 it
->from_overlay
= Qnil
;
5155 it
->face_id
= face_id
;
5156 it
->from_disp_prop_p
= true;
5158 /* Say that we haven't consumed the characters with
5159 `display' property yet. The call to pop_it in
5160 set_iterator_to_next will clean this up. */
5161 *position
= start_pos
;
5163 if (EQ (XCAR (spec
), Qleft_fringe
))
5165 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5166 it
->left_user_fringe_face_id
= face_id
;
5170 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5171 it
->right_user_fringe_face_id
= face_id
;
5174 #endif /* HAVE_WINDOW_SYSTEM */
5178 /* Prepare to handle `((margin left-margin) ...)',
5179 `((margin right-margin) ...)' and `((margin nil) ...)'
5180 prefixes for display specifications. */
5181 location
= Qunbound
;
5182 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5186 value
= XCDR (spec
);
5188 value
= XCAR (value
);
5191 if (EQ (XCAR (tem
), Qmargin
)
5192 && (tem
= XCDR (tem
),
5193 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5195 || EQ (tem
, Qleft_margin
)
5196 || EQ (tem
, Qright_margin
))))
5200 if (EQ (location
, Qunbound
))
5206 /* After this point, VALUE is the property after any
5207 margin prefix has been stripped. It must be a string,
5208 an image specification, or `(space ...)'.
5210 LOCATION specifies where to display: `left-margin',
5211 `right-margin' or nil. */
5213 valid_p
= (STRINGP (value
)
5214 #ifdef HAVE_WINDOW_SYSTEM
5215 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5216 && valid_image_p (value
))
5217 #endif /* not HAVE_WINDOW_SYSTEM */
5218 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
5220 if (valid_p
&& !display_replaced_p
)
5226 /* Callers need to know whether the display spec is any kind
5227 of `(space ...)' spec that is about to affect text-area
5229 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5234 /* Save current settings of IT so that we can restore them
5235 when we are finished with the glyph property value. */
5236 push_it (it
, position
);
5237 it
->from_overlay
= overlay
;
5238 it
->from_disp_prop_p
= true;
5240 if (NILP (location
))
5241 it
->area
= TEXT_AREA
;
5242 else if (EQ (location
, Qleft_margin
))
5243 it
->area
= LEFT_MARGIN_AREA
;
5245 it
->area
= RIGHT_MARGIN_AREA
;
5247 if (STRINGP (value
))
5250 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5251 it
->current
.overlay_string_index
= -1;
5252 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5253 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5254 it
->method
= GET_FROM_STRING
;
5255 it
->stop_charpos
= 0;
5257 it
->base_level_stop
= 0;
5258 it
->string_from_display_prop_p
= true;
5259 /* Say that we haven't consumed the characters with
5260 `display' property yet. The call to pop_it in
5261 set_iterator_to_next will clean this up. */
5262 if (BUFFERP (object
))
5263 *position
= start_pos
;
5265 /* Force paragraph direction to be that of the parent
5266 object. If the parent object's paragraph direction is
5267 not yet determined, default to L2R. */
5268 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5269 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5271 it
->paragraph_embedding
= L2R
;
5273 /* Set up the bidi iterator for this display string. */
5276 it
->bidi_it
.string
.lstring
= it
->string
;
5277 it
->bidi_it
.string
.s
= NULL
;
5278 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5279 it
->bidi_it
.string
.bufpos
= bufpos
;
5280 it
->bidi_it
.string
.from_disp_str
= 1;
5281 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5282 it
->bidi_it
.w
= it
->w
;
5283 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5286 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5288 it
->method
= GET_FROM_STRETCH
;
5290 *position
= it
->position
= start_pos
;
5291 retval
= 1 + (it
->area
== TEXT_AREA
);
5293 #ifdef HAVE_WINDOW_SYSTEM
5296 it
->what
= IT_IMAGE
;
5297 it
->image_id
= lookup_image (it
->f
, value
);
5298 it
->position
= start_pos
;
5299 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5300 it
->method
= GET_FROM_IMAGE
;
5302 /* Say that we haven't consumed the characters with
5303 `display' property yet. The call to pop_it in
5304 set_iterator_to_next will clean this up. */
5305 *position
= start_pos
;
5307 #endif /* HAVE_WINDOW_SYSTEM */
5312 /* Invalid property or property not supported. Restore
5313 POSITION to what it was before. */
5314 *position
= start_pos
;
5318 /* Check if PROP is a display property value whose text should be
5319 treated as intangible. OVERLAY is the overlay from which PROP
5320 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5321 specify the buffer position covered by PROP. */
5324 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5325 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5327 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5328 struct text_pos position
;
5330 SET_TEXT_POS (position
, charpos
, bytepos
);
5331 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5332 &position
, charpos
, frame_window_p
);
5336 /* Return 1 if PROP is a display sub-property value containing STRING.
5338 Implementation note: this and the following function are really
5339 special cases of handle_display_spec and
5340 handle_single_display_spec, and should ideally use the same code.
5341 Until they do, these two pairs must be consistent and must be
5342 modified in sync. */
5345 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5347 if (EQ (string
, prop
))
5350 /* Skip over `when FORM'. */
5351 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5356 /* Actually, the condition following `when' should be eval'ed,
5357 like handle_single_display_spec does, and we should return
5358 zero if it evaluates to nil. However, this function is
5359 called only when the buffer was already displayed and some
5360 glyph in the glyph matrix was found to come from a display
5361 string. Therefore, the condition was already evaluated, and
5362 the result was non-nil, otherwise the display string wouldn't
5363 have been displayed and we would have never been called for
5364 this property. Thus, we can skip the evaluation and assume
5365 its result is non-nil. */
5370 /* Skip over `margin LOCATION'. */
5371 if (EQ (XCAR (prop
), Qmargin
))
5382 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5386 /* Return 1 if STRING appears in the `display' property PROP. */
5389 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5392 && !EQ (XCAR (prop
), Qwhen
)
5393 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5395 /* A list of sub-properties. */
5396 while (CONSP (prop
))
5398 if (single_display_spec_string_p (XCAR (prop
), string
))
5403 else if (VECTORP (prop
))
5405 /* A vector of sub-properties. */
5407 for (i
= 0; i
< ASIZE (prop
); ++i
)
5408 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5412 return single_display_spec_string_p (prop
, string
);
5417 /* Look for STRING in overlays and text properties in the current
5418 buffer, between character positions FROM and TO (excluding TO).
5419 BACK_P non-zero means look back (in this case, TO is supposed to be
5421 Value is the first character position where STRING was found, or
5422 zero if it wasn't found before hitting TO.
5424 This function may only use code that doesn't eval because it is
5425 called asynchronously from note_mouse_highlight. */
5428 string_buffer_position_lim (Lisp_Object string
,
5429 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5431 Lisp_Object limit
, prop
, pos
;
5434 pos
= make_number (max (from
, BEGV
));
5436 if (!back_p
) /* looking forward */
5438 limit
= make_number (min (to
, ZV
));
5439 while (!found
&& !EQ (pos
, limit
))
5441 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5442 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5445 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5449 else /* looking back */
5451 limit
= make_number (max (to
, BEGV
));
5452 while (!found
&& !EQ (pos
, limit
))
5454 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5455 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5458 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5463 return found
? XINT (pos
) : 0;
5466 /* Determine which buffer position in current buffer STRING comes from.
5467 AROUND_CHARPOS is an approximate position where it could come from.
5468 Value is the buffer position or 0 if it couldn't be determined.
5470 This function is necessary because we don't record buffer positions
5471 in glyphs generated from strings (to keep struct glyph small).
5472 This function may only use code that doesn't eval because it is
5473 called asynchronously from note_mouse_highlight. */
5476 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5478 const int MAX_DISTANCE
= 1000;
5479 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5480 around_charpos
+ MAX_DISTANCE
,
5484 found
= string_buffer_position_lim (string
, around_charpos
,
5485 around_charpos
- MAX_DISTANCE
, 1);
5491 /***********************************************************************
5492 `composition' property
5493 ***********************************************************************/
5495 /* Set up iterator IT from `composition' property at its current
5496 position. Called from handle_stop. */
5498 static enum prop_handled
5499 handle_composition_prop (struct it
*it
)
5501 Lisp_Object prop
, string
;
5502 ptrdiff_t pos
, pos_byte
, start
, end
;
5504 if (STRINGP (it
->string
))
5508 pos
= IT_STRING_CHARPOS (*it
);
5509 pos_byte
= IT_STRING_BYTEPOS (*it
);
5510 string
= it
->string
;
5511 s
= SDATA (string
) + pos_byte
;
5512 it
->c
= STRING_CHAR (s
);
5516 pos
= IT_CHARPOS (*it
);
5517 pos_byte
= IT_BYTEPOS (*it
);
5519 it
->c
= FETCH_CHAR (pos_byte
);
5522 /* If there's a valid composition and point is not inside of the
5523 composition (in the case that the composition is from the current
5524 buffer), draw a glyph composed from the composition components. */
5525 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5526 && composition_valid_p (start
, end
, prop
)
5527 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5530 /* As we can't handle this situation (perhaps font-lock added
5531 a new composition), we just return here hoping that next
5532 redisplay will detect this composition much earlier. */
5533 return HANDLED_NORMALLY
;
5536 if (STRINGP (it
->string
))
5537 pos_byte
= string_char_to_byte (it
->string
, start
);
5539 pos_byte
= CHAR_TO_BYTE (start
);
5541 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5544 if (it
->cmp_it
.id
>= 0)
5547 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5548 it
->cmp_it
.nglyphs
= -1;
5552 return HANDLED_NORMALLY
;
5557 /***********************************************************************
5559 ***********************************************************************/
5561 /* The following structure is used to record overlay strings for
5562 later sorting in load_overlay_strings. */
5564 struct overlay_entry
5566 Lisp_Object overlay
;
5573 /* Set up iterator IT from overlay strings at its current position.
5574 Called from handle_stop. */
5576 static enum prop_handled
5577 handle_overlay_change (struct it
*it
)
5579 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5580 return HANDLED_RECOMPUTE_PROPS
;
5582 return HANDLED_NORMALLY
;
5586 /* Set up the next overlay string for delivery by IT, if there is an
5587 overlay string to deliver. Called by set_iterator_to_next when the
5588 end of the current overlay string is reached. If there are more
5589 overlay strings to display, IT->string and
5590 IT->current.overlay_string_index are set appropriately here.
5591 Otherwise IT->string is set to nil. */
5594 next_overlay_string (struct it
*it
)
5596 ++it
->current
.overlay_string_index
;
5597 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5599 /* No more overlay strings. Restore IT's settings to what
5600 they were before overlay strings were processed, and
5601 continue to deliver from current_buffer. */
5603 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5606 || (NILP (it
->string
)
5607 && it
->method
== GET_FROM_BUFFER
5608 && it
->stop_charpos
>= BEGV
5609 && it
->stop_charpos
<= it
->end_charpos
));
5610 it
->current
.overlay_string_index
= -1;
5611 it
->n_overlay_strings
= 0;
5612 it
->overlay_strings_charpos
= -1;
5613 /* If there's an empty display string on the stack, pop the
5614 stack, to resync the bidi iterator with IT's position. Such
5615 empty strings are pushed onto the stack in
5616 get_overlay_strings_1. */
5617 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5620 /* If we're at the end of the buffer, record that we have
5621 processed the overlay strings there already, so that
5622 next_element_from_buffer doesn't try it again. */
5623 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5624 it
->overlay_strings_at_end_processed_p
= true;
5628 /* There are more overlay strings to process. If
5629 IT->current.overlay_string_index has advanced to a position
5630 where we must load IT->overlay_strings with more strings, do
5631 it. We must load at the IT->overlay_strings_charpos where
5632 IT->n_overlay_strings was originally computed; when invisible
5633 text is present, this might not be IT_CHARPOS (Bug#7016). */
5634 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5636 if (it
->current
.overlay_string_index
&& i
== 0)
5637 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5639 /* Initialize IT to deliver display elements from the overlay
5641 it
->string
= it
->overlay_strings
[i
];
5642 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5643 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5644 it
->method
= GET_FROM_STRING
;
5645 it
->stop_charpos
= 0;
5646 it
->end_charpos
= SCHARS (it
->string
);
5647 if (it
->cmp_it
.stop_pos
>= 0)
5648 it
->cmp_it
.stop_pos
= 0;
5650 it
->base_level_stop
= 0;
5652 /* Set up the bidi iterator for this overlay string. */
5655 it
->bidi_it
.string
.lstring
= it
->string
;
5656 it
->bidi_it
.string
.s
= NULL
;
5657 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5658 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5659 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5660 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5661 it
->bidi_it
.w
= it
->w
;
5662 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5670 /* Compare two overlay_entry structures E1 and E2. Used as a
5671 comparison function for qsort in load_overlay_strings. Overlay
5672 strings for the same position are sorted so that
5674 1. All after-strings come in front of before-strings, except
5675 when they come from the same overlay.
5677 2. Within after-strings, strings are sorted so that overlay strings
5678 from overlays with higher priorities come first.
5680 2. Within before-strings, strings are sorted so that overlay
5681 strings from overlays with higher priorities come last.
5683 Value is analogous to strcmp. */
5687 compare_overlay_entries (const void *e1
, const void *e2
)
5689 struct overlay_entry
const *entry1
= e1
;
5690 struct overlay_entry
const *entry2
= e2
;
5693 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5695 /* Let after-strings appear in front of before-strings if
5696 they come from different overlays. */
5697 if (EQ (entry1
->overlay
, entry2
->overlay
))
5698 result
= entry1
->after_string_p
? 1 : -1;
5700 result
= entry1
->after_string_p
? -1 : 1;
5702 else if (entry1
->priority
!= entry2
->priority
)
5704 if (entry1
->after_string_p
)
5705 /* After-strings sorted in order of decreasing priority. */
5706 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5708 /* Before-strings sorted in order of increasing priority. */
5709 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5718 /* Load the vector IT->overlay_strings with overlay strings from IT's
5719 current buffer position, or from CHARPOS if that is > 0. Set
5720 IT->n_overlays to the total number of overlay strings found.
5722 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5723 a time. On entry into load_overlay_strings,
5724 IT->current.overlay_string_index gives the number of overlay
5725 strings that have already been loaded by previous calls to this
5728 IT->add_overlay_start contains an additional overlay start
5729 position to consider for taking overlay strings from, if non-zero.
5730 This position comes into play when the overlay has an `invisible'
5731 property, and both before and after-strings. When we've skipped to
5732 the end of the overlay, because of its `invisible' property, we
5733 nevertheless want its before-string to appear.
5734 IT->add_overlay_start will contain the overlay start position
5737 Overlay strings are sorted so that after-string strings come in
5738 front of before-string strings. Within before and after-strings,
5739 strings are sorted by overlay priority. See also function
5740 compare_overlay_entries. */
5743 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5745 Lisp_Object overlay
, window
, str
, invisible
;
5746 struct Lisp_Overlay
*ov
;
5747 ptrdiff_t start
, end
;
5748 ptrdiff_t size
= 20;
5749 ptrdiff_t n
= 0, i
, j
;
5751 struct overlay_entry
*entries
= alloca (size
* sizeof *entries
);
5755 charpos
= IT_CHARPOS (*it
);
5757 /* Append the overlay string STRING of overlay OVERLAY to vector
5758 `entries' which has size `size' and currently contains `n'
5759 elements. AFTER_P non-zero means STRING is an after-string of
5761 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5764 Lisp_Object priority; \
5768 struct overlay_entry *old = entries; \
5769 SAFE_NALLOCA (entries, 2, size); \
5770 memcpy (entries, old, size * sizeof *entries); \
5774 entries[n].string = (STRING); \
5775 entries[n].overlay = (OVERLAY); \
5776 priority = Foverlay_get ((OVERLAY), Qpriority); \
5777 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5778 entries[n].after_string_p = (AFTER_P); \
5783 /* Process overlay before the overlay center. */
5784 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5786 XSETMISC (overlay
, ov
);
5787 eassert (OVERLAYP (overlay
));
5788 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5789 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5794 /* Skip this overlay if it doesn't start or end at IT's current
5796 if (end
!= charpos
&& start
!= charpos
)
5799 /* Skip this overlay if it doesn't apply to IT->w. */
5800 window
= Foverlay_get (overlay
, Qwindow
);
5801 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5804 /* If the text ``under'' the overlay is invisible, both before-
5805 and after-strings from this overlay are visible; start and
5806 end position are indistinguishable. */
5807 invisible
= Foverlay_get (overlay
, Qinvisible
);
5808 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5810 /* If overlay has a non-empty before-string, record it. */
5811 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5812 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5814 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5816 /* If overlay has a non-empty after-string, record it. */
5817 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5818 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5820 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5823 /* Process overlays after the overlay center. */
5824 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5826 XSETMISC (overlay
, ov
);
5827 eassert (OVERLAYP (overlay
));
5828 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5829 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5831 if (start
> charpos
)
5834 /* Skip this overlay if it doesn't start or end at IT's current
5836 if (end
!= charpos
&& start
!= charpos
)
5839 /* Skip this overlay if it doesn't apply to IT->w. */
5840 window
= Foverlay_get (overlay
, Qwindow
);
5841 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5844 /* If the text ``under'' the overlay is invisible, it has a zero
5845 dimension, and both before- and after-strings apply. */
5846 invisible
= Foverlay_get (overlay
, Qinvisible
);
5847 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5849 /* If overlay has a non-empty before-string, record it. */
5850 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5851 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5853 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5855 /* If overlay has a non-empty after-string, record it. */
5856 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5857 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5859 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5862 #undef RECORD_OVERLAY_STRING
5866 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5868 /* Record number of overlay strings, and where we computed it. */
5869 it
->n_overlay_strings
= n
;
5870 it
->overlay_strings_charpos
= charpos
;
5872 /* IT->current.overlay_string_index is the number of overlay strings
5873 that have already been consumed by IT. Copy some of the
5874 remaining overlay strings to IT->overlay_strings. */
5876 j
= it
->current
.overlay_string_index
;
5877 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5879 it
->overlay_strings
[i
] = entries
[j
].string
;
5880 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5888 /* Get the first chunk of overlay strings at IT's current buffer
5889 position, or at CHARPOS if that is > 0. Value is non-zero if at
5890 least one overlay string was found. */
5893 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5895 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5896 process. This fills IT->overlay_strings with strings, and sets
5897 IT->n_overlay_strings to the total number of strings to process.
5898 IT->pos.overlay_string_index has to be set temporarily to zero
5899 because load_overlay_strings needs this; it must be set to -1
5900 when no overlay strings are found because a zero value would
5901 indicate a position in the first overlay string. */
5902 it
->current
.overlay_string_index
= 0;
5903 load_overlay_strings (it
, charpos
);
5905 /* If we found overlay strings, set up IT to deliver display
5906 elements from the first one. Otherwise set up IT to deliver
5907 from current_buffer. */
5908 if (it
->n_overlay_strings
)
5910 /* Make sure we know settings in current_buffer, so that we can
5911 restore meaningful values when we're done with the overlay
5914 compute_stop_pos (it
);
5915 eassert (it
->face_id
>= 0);
5917 /* Save IT's settings. They are restored after all overlay
5918 strings have been processed. */
5919 eassert (!compute_stop_p
|| it
->sp
== 0);
5921 /* When called from handle_stop, there might be an empty display
5922 string loaded. In that case, don't bother saving it. But
5923 don't use this optimization with the bidi iterator, since we
5924 need the corresponding pop_it call to resync the bidi
5925 iterator's position with IT's position, after we are done
5926 with the overlay strings. (The corresponding call to pop_it
5927 in case of an empty display string is in
5928 next_overlay_string.) */
5930 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5933 /* Set up IT to deliver display elements from the first overlay
5935 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5936 it
->string
= it
->overlay_strings
[0];
5937 it
->from_overlay
= Qnil
;
5938 it
->stop_charpos
= 0;
5939 eassert (STRINGP (it
->string
));
5940 it
->end_charpos
= SCHARS (it
->string
);
5942 it
->base_level_stop
= 0;
5943 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5944 it
->method
= GET_FROM_STRING
;
5945 it
->from_disp_prop_p
= 0;
5947 /* Force paragraph direction to be that of the parent
5949 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5950 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5952 it
->paragraph_embedding
= L2R
;
5954 /* Set up the bidi iterator for this overlay string. */
5957 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5959 it
->bidi_it
.string
.lstring
= it
->string
;
5960 it
->bidi_it
.string
.s
= NULL
;
5961 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5962 it
->bidi_it
.string
.bufpos
= pos
;
5963 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5964 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5965 it
->bidi_it
.w
= it
->w
;
5966 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5971 it
->current
.overlay_string_index
= -1;
5976 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5979 it
->method
= GET_FROM_BUFFER
;
5981 (void) get_overlay_strings_1 (it
, charpos
, 1);
5985 /* Value is non-zero if we found at least one overlay string. */
5986 return STRINGP (it
->string
);
5991 /***********************************************************************
5992 Saving and restoring state
5993 ***********************************************************************/
5995 /* Save current settings of IT on IT->stack. Called, for example,
5996 before setting up IT for an overlay string, to be able to restore
5997 IT's settings to what they were after the overlay string has been
5998 processed. If POSITION is non-NULL, it is the position to save on
5999 the stack instead of IT->position. */
6002 push_it (struct it
*it
, struct text_pos
*position
)
6004 struct iterator_stack_entry
*p
;
6006 eassert (it
->sp
< IT_STACK_SIZE
);
6007 p
= it
->stack
+ it
->sp
;
6009 p
->stop_charpos
= it
->stop_charpos
;
6010 p
->prev_stop
= it
->prev_stop
;
6011 p
->base_level_stop
= it
->base_level_stop
;
6012 p
->cmp_it
= it
->cmp_it
;
6013 eassert (it
->face_id
>= 0);
6014 p
->face_id
= it
->face_id
;
6015 p
->string
= it
->string
;
6016 p
->method
= it
->method
;
6017 p
->from_overlay
= it
->from_overlay
;
6020 case GET_FROM_IMAGE
:
6021 p
->u
.image
.object
= it
->object
;
6022 p
->u
.image
.image_id
= it
->image_id
;
6023 p
->u
.image
.slice
= it
->slice
;
6025 case GET_FROM_STRETCH
:
6026 p
->u
.stretch
.object
= it
->object
;
6029 p
->position
= position
? *position
: it
->position
;
6030 p
->current
= it
->current
;
6031 p
->end_charpos
= it
->end_charpos
;
6032 p
->string_nchars
= it
->string_nchars
;
6034 p
->multibyte_p
= it
->multibyte_p
;
6035 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
6036 p
->space_width
= it
->space_width
;
6037 p
->font_height
= it
->font_height
;
6038 p
->voffset
= it
->voffset
;
6039 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
6040 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
6041 p
->display_ellipsis_p
= 0;
6042 p
->line_wrap
= it
->line_wrap
;
6043 p
->bidi_p
= it
->bidi_p
;
6044 p
->paragraph_embedding
= it
->paragraph_embedding
;
6045 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
6048 /* Save the state of the bidi iterator as well. */
6050 bidi_push_it (&it
->bidi_it
);
6054 iterate_out_of_display_property (struct it
*it
)
6056 int buffer_p
= !STRINGP (it
->string
);
6057 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
6058 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
6060 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
6062 /* Maybe initialize paragraph direction. If we are at the beginning
6063 of a new paragraph, next_element_from_buffer may not have a
6064 chance to do that. */
6065 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
6066 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6067 /* prev_stop can be zero, so check against BEGV as well. */
6068 while (it
->bidi_it
.charpos
>= bob
6069 && it
->prev_stop
<= it
->bidi_it
.charpos
6070 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
6071 && it
->bidi_it
.charpos
< eob
)
6072 bidi_move_to_visually_next (&it
->bidi_it
);
6073 /* Record the stop_pos we just crossed, for when we cross it
6075 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
6076 it
->prev_stop
= CHARPOS (it
->position
);
6077 /* If we ended up not where pop_it put us, resync IT's
6078 positional members with the bidi iterator. */
6079 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
6080 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
6082 it
->current
.pos
= it
->position
;
6084 it
->current
.string_pos
= it
->position
;
6087 /* Restore IT's settings from IT->stack. Called, for example, when no
6088 more overlay strings must be processed, and we return to delivering
6089 display elements from a buffer, or when the end of a string from a
6090 `display' property is reached and we return to delivering display
6091 elements from an overlay string, or from a buffer. */
6094 pop_it (struct it
*it
)
6096 struct iterator_stack_entry
*p
;
6097 int from_display_prop
= it
->from_disp_prop_p
;
6099 eassert (it
->sp
> 0);
6101 p
= it
->stack
+ it
->sp
;
6102 it
->stop_charpos
= p
->stop_charpos
;
6103 it
->prev_stop
= p
->prev_stop
;
6104 it
->base_level_stop
= p
->base_level_stop
;
6105 it
->cmp_it
= p
->cmp_it
;
6106 it
->face_id
= p
->face_id
;
6107 it
->current
= p
->current
;
6108 it
->position
= p
->position
;
6109 it
->string
= p
->string
;
6110 it
->from_overlay
= p
->from_overlay
;
6111 if (NILP (it
->string
))
6112 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6113 it
->method
= p
->method
;
6116 case GET_FROM_IMAGE
:
6117 it
->image_id
= p
->u
.image
.image_id
;
6118 it
->object
= p
->u
.image
.object
;
6119 it
->slice
= p
->u
.image
.slice
;
6121 case GET_FROM_STRETCH
:
6122 it
->object
= p
->u
.stretch
.object
;
6124 case GET_FROM_BUFFER
:
6125 it
->object
= it
->w
->contents
;
6127 case GET_FROM_STRING
:
6129 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6131 /* Restore the face_box_p flag, since it could have been
6132 overwritten by the face of the object that we just finished
6135 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6136 it
->object
= it
->string
;
6139 case GET_FROM_DISPLAY_VECTOR
:
6141 it
->method
= GET_FROM_C_STRING
;
6142 else if (STRINGP (it
->string
))
6143 it
->method
= GET_FROM_STRING
;
6146 it
->method
= GET_FROM_BUFFER
;
6147 it
->object
= it
->w
->contents
;
6150 it
->end_charpos
= p
->end_charpos
;
6151 it
->string_nchars
= p
->string_nchars
;
6153 it
->multibyte_p
= p
->multibyte_p
;
6154 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6155 it
->space_width
= p
->space_width
;
6156 it
->font_height
= p
->font_height
;
6157 it
->voffset
= p
->voffset
;
6158 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6159 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6160 it
->line_wrap
= p
->line_wrap
;
6161 it
->bidi_p
= p
->bidi_p
;
6162 it
->paragraph_embedding
= p
->paragraph_embedding
;
6163 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6166 bidi_pop_it (&it
->bidi_it
);
6167 /* Bidi-iterate until we get out of the portion of text, if any,
6168 covered by a `display' text property or by an overlay with
6169 `display' property. (We cannot just jump there, because the
6170 internal coherency of the bidi iterator state can not be
6171 preserved across such jumps.) We also must determine the
6172 paragraph base direction if the overlay we just processed is
6173 at the beginning of a new paragraph. */
6174 if (from_display_prop
6175 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6176 iterate_out_of_display_property (it
);
6178 eassert ((BUFFERP (it
->object
)
6179 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6180 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6181 || (STRINGP (it
->object
)
6182 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6183 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6184 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6190 /***********************************************************************
6192 ***********************************************************************/
6194 /* Set IT's current position to the previous line start. */
6197 back_to_previous_line_start (struct it
*it
)
6199 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6202 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6206 /* Move IT to the next line start.
6208 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
6209 we skipped over part of the text (as opposed to moving the iterator
6210 continuously over the text). Otherwise, don't change the value
6213 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6214 iterator on the newline, if it was found.
6216 Newlines may come from buffer text, overlay strings, or strings
6217 displayed via the `display' property. That's the reason we can't
6218 simply use find_newline_no_quit.
6220 Note that this function may not skip over invisible text that is so
6221 because of text properties and immediately follows a newline. If
6222 it would, function reseat_at_next_visible_line_start, when called
6223 from set_iterator_to_next, would effectively make invisible
6224 characters following a newline part of the wrong glyph row, which
6225 leads to wrong cursor motion. */
6228 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
6229 struct bidi_it
*bidi_it_prev
)
6231 ptrdiff_t old_selective
;
6232 int newline_found_p
, n
;
6233 const int MAX_NEWLINE_DISTANCE
= 500;
6235 /* If already on a newline, just consume it to avoid unintended
6236 skipping over invisible text below. */
6237 if (it
->what
== IT_CHARACTER
6239 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6241 if (it
->bidi_p
&& bidi_it_prev
)
6242 *bidi_it_prev
= it
->bidi_it
;
6243 set_iterator_to_next (it
, 0);
6248 /* Don't handle selective display in the following. It's (a)
6249 unnecessary because it's done by the caller, and (b) leads to an
6250 infinite recursion because next_element_from_ellipsis indirectly
6251 calls this function. */
6252 old_selective
= it
->selective
;
6255 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6256 from buffer text. */
6257 for (n
= newline_found_p
= 0;
6258 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6259 n
+= STRINGP (it
->string
) ? 0 : 1)
6261 if (!get_next_display_element (it
))
6263 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6264 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6265 *bidi_it_prev
= it
->bidi_it
;
6266 set_iterator_to_next (it
, 0);
6269 /* If we didn't find a newline near enough, see if we can use a
6271 if (!newline_found_p
)
6273 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6274 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6278 eassert (!STRINGP (it
->string
));
6280 /* If there isn't any `display' property in sight, and no
6281 overlays, we can just use the position of the newline in
6283 if (it
->stop_charpos
>= limit
6284 || ((pos
= Fnext_single_property_change (make_number (start
),
6286 make_number (limit
)),
6288 && next_overlay_change (start
) == ZV
))
6292 IT_CHARPOS (*it
) = limit
;
6293 IT_BYTEPOS (*it
) = bytepos
;
6297 struct bidi_it bprev
;
6299 /* Help bidi.c avoid expensive searches for display
6300 properties and overlays, by telling it that there are
6301 none up to `limit'. */
6302 if (it
->bidi_it
.disp_pos
< limit
)
6304 it
->bidi_it
.disp_pos
= limit
;
6305 it
->bidi_it
.disp_prop
= 0;
6308 bprev
= it
->bidi_it
;
6309 bidi_move_to_visually_next (&it
->bidi_it
);
6310 } while (it
->bidi_it
.charpos
!= limit
);
6311 IT_CHARPOS (*it
) = limit
;
6312 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6314 *bidi_it_prev
= bprev
;
6316 *skipped_p
= newline_found_p
= true;
6320 while (get_next_display_element (it
)
6321 && !newline_found_p
)
6323 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6324 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6325 *bidi_it_prev
= it
->bidi_it
;
6326 set_iterator_to_next (it
, 0);
6331 it
->selective
= old_selective
;
6332 return newline_found_p
;
6336 /* Set IT's current position to the previous visible line start. Skip
6337 invisible text that is so either due to text properties or due to
6338 selective display. Caution: this does not change IT->current_x and
6342 back_to_previous_visible_line_start (struct it
*it
)
6344 while (IT_CHARPOS (*it
) > BEGV
)
6346 back_to_previous_line_start (it
);
6348 if (IT_CHARPOS (*it
) <= BEGV
)
6351 /* If selective > 0, then lines indented more than its value are
6353 if (it
->selective
> 0
6354 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6358 /* Check the newline before point for invisibility. */
6361 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6362 Qinvisible
, it
->window
);
6363 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6367 if (IT_CHARPOS (*it
) <= BEGV
)
6372 void *it2data
= NULL
;
6375 Lisp_Object val
, overlay
;
6377 SAVE_IT (it2
, *it
, it2data
);
6379 /* If newline is part of a composition, continue from start of composition */
6380 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6381 && beg
< IT_CHARPOS (*it
))
6384 /* If newline is replaced by a display property, find start of overlay
6385 or interval and continue search from that point. */
6386 pos
= --IT_CHARPOS (it2
);
6389 bidi_unshelve_cache (NULL
, 0);
6390 it2
.string_from_display_prop_p
= 0;
6391 it2
.from_disp_prop_p
= 0;
6392 if (handle_display_prop (&it2
) == HANDLED_RETURN
6393 && !NILP (val
= get_char_property_and_overlay
6394 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6395 && (OVERLAYP (overlay
)
6396 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6397 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6399 RESTORE_IT (it
, it
, it2data
);
6403 /* Newline is not replaced by anything -- so we are done. */
6404 RESTORE_IT (it
, it
, it2data
);
6410 IT_CHARPOS (*it
) = beg
;
6411 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6415 it
->continuation_lines_width
= 0;
6417 eassert (IT_CHARPOS (*it
) >= BEGV
);
6418 eassert (IT_CHARPOS (*it
) == BEGV
6419 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6424 /* Reseat iterator IT at the previous visible line start. Skip
6425 invisible text that is so either due to text properties or due to
6426 selective display. At the end, update IT's overlay information,
6427 face information etc. */
6430 reseat_at_previous_visible_line_start (struct it
*it
)
6432 back_to_previous_visible_line_start (it
);
6433 reseat (it
, it
->current
.pos
, 1);
6438 /* Reseat iterator IT on the next visible line start in the current
6439 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6440 preceding the line start. Skip over invisible text that is so
6441 because of selective display. Compute faces, overlays etc at the
6442 new position. Note that this function does not skip over text that
6443 is invisible because of text properties. */
6446 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6448 int newline_found_p
, skipped_p
= 0;
6449 struct bidi_it bidi_it_prev
;
6451 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6453 /* Skip over lines that are invisible because they are indented
6454 more than the value of IT->selective. */
6455 if (it
->selective
> 0)
6456 while (IT_CHARPOS (*it
) < ZV
6457 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6460 eassert (IT_BYTEPOS (*it
) == BEGV
6461 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6463 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6466 /* Position on the newline if that's what's requested. */
6467 if (on_newline_p
&& newline_found_p
)
6469 if (STRINGP (it
->string
))
6471 if (IT_STRING_CHARPOS (*it
) > 0)
6475 --IT_STRING_CHARPOS (*it
);
6476 --IT_STRING_BYTEPOS (*it
);
6480 /* We need to restore the bidi iterator to the state
6481 it had on the newline, and resync the IT's
6482 position with that. */
6483 it
->bidi_it
= bidi_it_prev
;
6484 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6485 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6489 else if (IT_CHARPOS (*it
) > BEGV
)
6498 /* We need to restore the bidi iterator to the state it
6499 had on the newline and resync IT with that. */
6500 it
->bidi_it
= bidi_it_prev
;
6501 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6502 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6504 reseat (it
, it
->current
.pos
, 0);
6508 reseat (it
, it
->current
.pos
, 0);
6515 /***********************************************************************
6516 Changing an iterator's position
6517 ***********************************************************************/
6519 /* Change IT's current position to POS in current_buffer. If FORCE_P
6520 is non-zero, always check for text properties at the new position.
6521 Otherwise, text properties are only looked up if POS >=
6522 IT->check_charpos of a property. */
6525 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6527 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6529 reseat_1 (it
, pos
, 0);
6531 /* Determine where to check text properties. Avoid doing it
6532 where possible because text property lookup is very expensive. */
6534 || CHARPOS (pos
) > it
->stop_charpos
6535 || CHARPOS (pos
) < original_pos
)
6539 /* For bidi iteration, we need to prime prev_stop and
6540 base_level_stop with our best estimations. */
6541 /* Implementation note: Of course, POS is not necessarily a
6542 stop position, so assigning prev_pos to it is a lie; we
6543 should have called compute_stop_backwards. However, if
6544 the current buffer does not include any R2L characters,
6545 that call would be a waste of cycles, because the
6546 iterator will never move back, and thus never cross this
6547 "fake" stop position. So we delay that backward search
6548 until the time we really need it, in next_element_from_buffer. */
6549 if (CHARPOS (pos
) != it
->prev_stop
)
6550 it
->prev_stop
= CHARPOS (pos
);
6551 if (CHARPOS (pos
) < it
->base_level_stop
)
6552 it
->base_level_stop
= 0; /* meaning it's unknown */
6558 it
->prev_stop
= it
->base_level_stop
= 0;
6567 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6568 IT->stop_pos to POS, also. */
6571 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6573 /* Don't call this function when scanning a C string. */
6574 eassert (it
->s
== NULL
);
6576 /* POS must be a reasonable value. */
6577 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6579 it
->current
.pos
= it
->position
= pos
;
6580 it
->end_charpos
= ZV
;
6582 it
->current
.dpvec_index
= -1;
6583 it
->current
.overlay_string_index
= -1;
6584 IT_STRING_CHARPOS (*it
) = -1;
6585 IT_STRING_BYTEPOS (*it
) = -1;
6587 it
->method
= GET_FROM_BUFFER
;
6588 it
->object
= it
->w
->contents
;
6589 it
->area
= TEXT_AREA
;
6590 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6592 it
->string_from_display_prop_p
= 0;
6593 it
->string_from_prefix_prop_p
= 0;
6595 it
->from_disp_prop_p
= 0;
6596 it
->face_before_selective_p
= 0;
6599 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6601 bidi_unshelve_cache (NULL
, 0);
6602 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6603 it
->bidi_it
.string
.s
= NULL
;
6604 it
->bidi_it
.string
.lstring
= Qnil
;
6605 it
->bidi_it
.string
.bufpos
= 0;
6606 it
->bidi_it
.string
.from_disp_str
= 0;
6607 it
->bidi_it
.string
.unibyte
= 0;
6608 it
->bidi_it
.w
= it
->w
;
6613 it
->stop_charpos
= CHARPOS (pos
);
6614 it
->base_level_stop
= CHARPOS (pos
);
6616 /* This make the information stored in it->cmp_it invalidate. */
6621 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6622 If S is non-null, it is a C string to iterate over. Otherwise,
6623 STRING gives a Lisp string to iterate over.
6625 If PRECISION > 0, don't return more then PRECISION number of
6626 characters from the string.
6628 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6629 characters have been returned. FIELD_WIDTH < 0 means an infinite
6632 MULTIBYTE = 0 means disable processing of multibyte characters,
6633 MULTIBYTE > 0 means enable it,
6634 MULTIBYTE < 0 means use IT->multibyte_p.
6636 IT must be initialized via a prior call to init_iterator before
6637 calling this function. */
6640 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6641 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6644 /* No text property checks performed by default, but see below. */
6645 it
->stop_charpos
= -1;
6647 /* Set iterator position and end position. */
6648 memset (&it
->current
, 0, sizeof it
->current
);
6649 it
->current
.overlay_string_index
= -1;
6650 it
->current
.dpvec_index
= -1;
6651 eassert (charpos
>= 0);
6653 /* If STRING is specified, use its multibyteness, otherwise use the
6654 setting of MULTIBYTE, if specified. */
6656 it
->multibyte_p
= multibyte
> 0;
6658 /* Bidirectional reordering of strings is controlled by the default
6659 value of bidi-display-reordering. Don't try to reorder while
6660 loading loadup.el, as the necessary character property tables are
6661 not yet available. */
6664 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6668 eassert (STRINGP (string
));
6669 it
->string
= string
;
6671 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6672 it
->method
= GET_FROM_STRING
;
6673 it
->current
.string_pos
= string_pos (charpos
, string
);
6677 it
->bidi_it
.string
.lstring
= string
;
6678 it
->bidi_it
.string
.s
= NULL
;
6679 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6680 it
->bidi_it
.string
.bufpos
= 0;
6681 it
->bidi_it
.string
.from_disp_str
= 0;
6682 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6683 it
->bidi_it
.w
= it
->w
;
6684 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6685 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6690 it
->s
= (const unsigned char *) s
;
6693 /* Note that we use IT->current.pos, not it->current.string_pos,
6694 for displaying C strings. */
6695 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6696 if (it
->multibyte_p
)
6698 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6699 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6703 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6704 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6709 it
->bidi_it
.string
.lstring
= Qnil
;
6710 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6711 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6712 it
->bidi_it
.string
.bufpos
= 0;
6713 it
->bidi_it
.string
.from_disp_str
= 0;
6714 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6715 it
->bidi_it
.w
= it
->w
;
6716 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6719 it
->method
= GET_FROM_C_STRING
;
6722 /* PRECISION > 0 means don't return more than PRECISION characters
6724 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6726 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6728 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6731 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6732 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6733 FIELD_WIDTH < 0 means infinite field width. This is useful for
6734 padding with `-' at the end of a mode line. */
6735 if (field_width
< 0)
6736 field_width
= INFINITY
;
6737 /* Implementation note: We deliberately don't enlarge
6738 it->bidi_it.string.schars here to fit it->end_charpos, because
6739 the bidi iterator cannot produce characters out of thin air. */
6740 if (field_width
> it
->end_charpos
- charpos
)
6741 it
->end_charpos
= charpos
+ field_width
;
6743 /* Use the standard display table for displaying strings. */
6744 if (DISP_TABLE_P (Vstandard_display_table
))
6745 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6747 it
->stop_charpos
= charpos
;
6748 it
->prev_stop
= charpos
;
6749 it
->base_level_stop
= 0;
6752 it
->bidi_it
.first_elt
= 1;
6753 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6754 it
->bidi_it
.disp_pos
= -1;
6756 if (s
== NULL
&& it
->multibyte_p
)
6758 ptrdiff_t endpos
= SCHARS (it
->string
);
6759 if (endpos
> it
->end_charpos
)
6760 endpos
= it
->end_charpos
;
6761 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6769 /***********************************************************************
6771 ***********************************************************************/
6773 /* Map enum it_method value to corresponding next_element_from_* function. */
6775 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6777 next_element_from_buffer
,
6778 next_element_from_display_vector
,
6779 next_element_from_string
,
6780 next_element_from_c_string
,
6781 next_element_from_image
,
6782 next_element_from_stretch
6785 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6788 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6789 (possibly with the following characters). */
6791 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6792 ((IT)->cmp_it.id >= 0 \
6793 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6794 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6795 END_CHARPOS, (IT)->w, \
6796 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6800 /* Lookup the char-table Vglyphless_char_display for character C (-1
6801 if we want information for no-font case), and return the display
6802 method symbol. By side-effect, update it->what and
6803 it->glyphless_method. This function is called from
6804 get_next_display_element for each character element, and from
6805 x_produce_glyphs when no suitable font was found. */
6808 lookup_glyphless_char_display (int c
, struct it
*it
)
6810 Lisp_Object glyphless_method
= Qnil
;
6812 if (CHAR_TABLE_P (Vglyphless_char_display
)
6813 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6817 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6818 if (CONSP (glyphless_method
))
6819 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6820 ? XCAR (glyphless_method
)
6821 : XCDR (glyphless_method
);
6824 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6828 if (NILP (glyphless_method
))
6831 /* The default is to display the character by a proper font. */
6833 /* The default for the no-font case is to display an empty box. */
6834 glyphless_method
= Qempty_box
;
6836 if (EQ (glyphless_method
, Qzero_width
))
6839 return glyphless_method
;
6840 /* This method can't be used for the no-font case. */
6841 glyphless_method
= Qempty_box
;
6843 if (EQ (glyphless_method
, Qthin_space
))
6844 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6845 else if (EQ (glyphless_method
, Qempty_box
))
6846 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6847 else if (EQ (glyphless_method
, Qhex_code
))
6848 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6849 else if (STRINGP (glyphless_method
))
6850 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6853 /* Invalid value. We use the default method. */
6854 glyphless_method
= Qnil
;
6857 it
->what
= IT_GLYPHLESS
;
6858 return glyphless_method
;
6861 /* Merge escape glyph face and cache the result. */
6863 static struct frame
*last_escape_glyph_frame
= NULL
;
6864 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6865 static int last_escape_glyph_merged_face_id
= 0;
6868 merge_escape_glyph_face (struct it
*it
)
6872 if (it
->f
== last_escape_glyph_frame
6873 && it
->face_id
== last_escape_glyph_face_id
)
6874 face_id
= last_escape_glyph_merged_face_id
;
6877 /* Merge the `escape-glyph' face into the current face. */
6878 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6879 last_escape_glyph_frame
= it
->f
;
6880 last_escape_glyph_face_id
= it
->face_id
;
6881 last_escape_glyph_merged_face_id
= face_id
;
6886 /* Likewise for glyphless glyph face. */
6888 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6889 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6890 static int last_glyphless_glyph_merged_face_id
= 0;
6893 merge_glyphless_glyph_face (struct it
*it
)
6897 if (it
->f
== last_glyphless_glyph_frame
6898 && it
->face_id
== last_glyphless_glyph_face_id
)
6899 face_id
= last_glyphless_glyph_merged_face_id
;
6902 /* Merge the `glyphless-char' face into the current face. */
6903 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6904 last_glyphless_glyph_frame
= it
->f
;
6905 last_glyphless_glyph_face_id
= it
->face_id
;
6906 last_glyphless_glyph_merged_face_id
= face_id
;
6911 /* Load IT's display element fields with information about the next
6912 display element from the current position of IT. Value is zero if
6913 end of buffer (or C string) is reached. */
6916 get_next_display_element (struct it
*it
)
6918 /* Non-zero means that we found a display element. Zero means that
6919 we hit the end of what we iterate over. Performance note: the
6920 function pointer `method' used here turns out to be faster than
6921 using a sequence of if-statements. */
6925 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6927 if (it
->what
== IT_CHARACTER
)
6929 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6930 and only if (a) the resolved directionality of that character
6932 /* FIXME: Do we need an exception for characters from display
6934 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6935 it
->c
= bidi_mirror_char (it
->c
);
6936 /* Map via display table or translate control characters.
6937 IT->c, IT->len etc. have been set to the next character by
6938 the function call above. If we have a display table, and it
6939 contains an entry for IT->c, translate it. Don't do this if
6940 IT->c itself comes from a display table, otherwise we could
6941 end up in an infinite recursion. (An alternative could be to
6942 count the recursion depth of this function and signal an
6943 error when a certain maximum depth is reached.) Is it worth
6945 if (success_p
&& it
->dpvec
== NULL
)
6948 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6949 int nonascii_space_p
= 0;
6950 int nonascii_hyphen_p
= 0;
6951 int c
= it
->c
; /* This is the character to display. */
6953 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6955 eassert (SINGLE_BYTE_CHAR_P (c
));
6956 if (unibyte_display_via_language_environment
)
6958 c
= DECODE_CHAR (unibyte
, c
);
6960 c
= BYTE8_TO_CHAR (it
->c
);
6963 c
= BYTE8_TO_CHAR (it
->c
);
6967 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6970 struct Lisp_Vector
*v
= XVECTOR (dv
);
6972 /* Return the first character from the display table
6973 entry, if not empty. If empty, don't display the
6974 current character. */
6977 it
->dpvec_char_len
= it
->len
;
6978 it
->dpvec
= v
->contents
;
6979 it
->dpend
= v
->contents
+ v
->header
.size
;
6980 it
->current
.dpvec_index
= 0;
6981 it
->dpvec_face_id
= -1;
6982 it
->saved_face_id
= it
->face_id
;
6983 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6988 set_iterator_to_next (it
, 0);
6993 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6995 if (it
->what
== IT_GLYPHLESS
)
6997 /* Don't display this character. */
6998 set_iterator_to_next (it
, 0);
7002 /* If `nobreak-char-display' is non-nil, we display
7003 non-ASCII spaces and hyphens specially. */
7004 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
7007 nonascii_space_p
= true;
7008 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
7009 nonascii_hyphen_p
= true;
7012 /* Translate control characters into `\003' or `^C' form.
7013 Control characters coming from a display table entry are
7014 currently not translated because we use IT->dpvec to hold
7015 the translation. This could easily be changed but I
7016 don't believe that it is worth doing.
7018 The characters handled by `nobreak-char-display' must be
7021 Non-printable characters and raw-byte characters are also
7022 translated to octal form. */
7023 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
7024 ? (it
->area
!= TEXT_AREA
7025 /* In mode line, treat \n, \t like other crl chars. */
7028 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
7029 || (c
!= '\n' && c
!= '\t'))
7031 || nonascii_hyphen_p
7033 || ! CHAR_PRINTABLE_P (c
))))
7035 /* C is a control character, non-ASCII space/hyphen,
7036 raw-byte, or a non-printable character which must be
7037 displayed either as '\003' or as `^C' where the '\\'
7038 and '^' can be defined in the display table. Fill
7039 IT->ctl_chars with glyphs for what we have to
7040 display. Then, set IT->dpvec to these glyphs. */
7047 /* Handle control characters with ^. */
7049 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
7053 g
= '^'; /* default glyph for Control */
7054 /* Set IT->ctl_chars[0] to the glyph for `^'. */
7056 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7058 g
= GLYPH_CODE_CHAR (gc
);
7059 lface_id
= GLYPH_CODE_FACE (gc
);
7063 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7064 : merge_escape_glyph_face (it
));
7066 XSETINT (it
->ctl_chars
[0], g
);
7067 XSETINT (it
->ctl_chars
[1], c
^ 0100);
7069 goto display_control
;
7072 /* Handle non-ascii space in the mode where it only gets
7075 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7077 /* Merge `nobreak-space' into the current face. */
7078 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7080 XSETINT (it
->ctl_chars
[0], ' ');
7082 goto display_control
;
7085 /* Handle sequences that start with the "escape glyph". */
7087 /* the default escape glyph is \. */
7088 escape_glyph
= '\\';
7091 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7093 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7094 lface_id
= GLYPH_CODE_FACE (gc
);
7098 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7099 : merge_escape_glyph_face (it
));
7101 /* Draw non-ASCII hyphen with just highlighting: */
7103 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7105 XSETINT (it
->ctl_chars
[0], '-');
7107 goto display_control
;
7110 /* Draw non-ASCII space/hyphen with escape glyph: */
7112 if (nonascii_space_p
|| nonascii_hyphen_p
)
7114 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7115 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7117 goto display_control
;
7124 if (CHAR_BYTE8_P (c
))
7125 /* Display \200 instead of \17777600. */
7126 c
= CHAR_TO_BYTE8 (c
);
7127 len
= sprintf (str
, "%03o", c
);
7129 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7130 for (i
= 0; i
< len
; i
++)
7131 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7136 /* Set up IT->dpvec and return first character from it. */
7137 it
->dpvec_char_len
= it
->len
;
7138 it
->dpvec
= it
->ctl_chars
;
7139 it
->dpend
= it
->dpvec
+ ctl_len
;
7140 it
->current
.dpvec_index
= 0;
7141 it
->dpvec_face_id
= face_id
;
7142 it
->saved_face_id
= it
->face_id
;
7143 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7147 it
->char_to_display
= c
;
7151 it
->char_to_display
= it
->c
;
7155 #ifdef HAVE_WINDOW_SYSTEM
7156 /* Adjust face id for a multibyte character. There are no multibyte
7157 character in unibyte text. */
7158 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7161 && FRAME_WINDOW_P (it
->f
))
7163 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7165 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7167 /* Automatic composition with glyph-string. */
7168 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7170 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7174 ptrdiff_t pos
= (it
->s
? -1
7175 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7176 : IT_CHARPOS (*it
));
7179 if (it
->what
== IT_CHARACTER
)
7180 c
= it
->char_to_display
;
7183 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7187 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7188 /* TAB in a composition means display glyphs with
7189 padding space on the left or right. */
7190 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7193 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7196 #endif /* HAVE_WINDOW_SYSTEM */
7199 /* Is this character the last one of a run of characters with
7200 box? If yes, set IT->end_of_box_run_p to 1. */
7204 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7206 int face_id
= underlying_face_id (it
);
7207 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7211 if (face
->box
== FACE_NO_BOX
)
7213 /* If the box comes from face properties in a
7214 display string, check faces in that string. */
7215 int string_face_id
= face_after_it_pos (it
);
7216 it
->end_of_box_run_p
7217 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7220 /* Otherwise, the box comes from the underlying face.
7221 If this is the last string character displayed, check
7222 the next buffer location. */
7223 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7224 /* n_overlay_strings is unreliable unless
7225 overlay_string_index is non-negative. */
7226 && ((it
->current
.overlay_string_index
>= 0
7227 && (it
->current
.overlay_string_index
7228 == it
->n_overlay_strings
- 1))
7229 /* A string from display property. */
7230 || it
->from_disp_prop_p
))
7234 struct text_pos pos
= it
->current
.pos
;
7236 /* For a string from a display property, the next
7237 buffer position is stored in the 'position'
7238 member of the iteration stack slot below the
7239 current one, see handle_single_display_spec. By
7240 contrast, it->current.pos was is not yet updated
7241 to point to that buffer position; that will
7242 happen in pop_it, after we finish displaying the
7243 current string. Note that we already checked
7244 above that it->sp is positive, so subtracting one
7246 if (it
->from_disp_prop_p
)
7247 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7249 INC_TEXT_POS (pos
, it
->multibyte_p
);
7251 if (CHARPOS (pos
) >= ZV
)
7252 it
->end_of_box_run_p
= true;
7255 next_face_id
= face_at_buffer_position
7256 (it
->w
, CHARPOS (pos
), &ignore
,
7257 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, 0, -1);
7258 it
->end_of_box_run_p
7259 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7265 /* next_element_from_display_vector sets this flag according to
7266 faces of the display vector glyphs, see there. */
7267 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7269 int face_id
= face_after_it_pos (it
);
7270 it
->end_of_box_run_p
7271 = (face_id
!= it
->face_id
7272 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7275 /* If we reached the end of the object we've been iterating (e.g., a
7276 display string or an overlay string), and there's something on
7277 IT->stack, proceed with what's on the stack. It doesn't make
7278 sense to return zero if there's unprocessed stuff on the stack,
7279 because otherwise that stuff will never be displayed. */
7280 if (!success_p
&& it
->sp
> 0)
7282 set_iterator_to_next (it
, 0);
7283 success_p
= get_next_display_element (it
);
7286 /* Value is 0 if end of buffer or string reached. */
7291 /* Move IT to the next display element.
7293 RESEAT_P non-zero means if called on a newline in buffer text,
7294 skip to the next visible line start.
7296 Functions get_next_display_element and set_iterator_to_next are
7297 separate because I find this arrangement easier to handle than a
7298 get_next_display_element function that also increments IT's
7299 position. The way it is we can first look at an iterator's current
7300 display element, decide whether it fits on a line, and if it does,
7301 increment the iterator position. The other way around we probably
7302 would either need a flag indicating whether the iterator has to be
7303 incremented the next time, or we would have to implement a
7304 decrement position function which would not be easy to write. */
7307 set_iterator_to_next (struct it
*it
, int reseat_p
)
7309 /* Reset flags indicating start and end of a sequence of characters
7310 with box. Reset them at the start of this function because
7311 moving the iterator to a new position might set them. */
7312 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
7316 case GET_FROM_BUFFER
:
7317 /* The current display element of IT is a character from
7318 current_buffer. Advance in the buffer, and maybe skip over
7319 invisible lines that are so because of selective display. */
7320 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7321 reseat_at_next_visible_line_start (it
, 0);
7322 else if (it
->cmp_it
.id
>= 0)
7324 /* We are currently getting glyphs from a composition. */
7329 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7330 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7331 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7333 it
->cmp_it
.from
= it
->cmp_it
.to
;
7338 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7340 it
->end_charpos
, Qnil
);
7343 else if (! it
->cmp_it
.reversed_p
)
7345 /* Composition created while scanning forward. */
7346 /* Update IT's char/byte positions to point to the first
7347 character of the next grapheme cluster, or to the
7348 character visually after the current composition. */
7349 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7350 bidi_move_to_visually_next (&it
->bidi_it
);
7351 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7352 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7354 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7356 /* Proceed to the next grapheme cluster. */
7357 it
->cmp_it
.from
= it
->cmp_it
.to
;
7361 /* No more grapheme clusters in this composition.
7362 Find the next stop position. */
7363 ptrdiff_t stop
= it
->end_charpos
;
7364 if (it
->bidi_it
.scan_dir
< 0)
7365 /* Now we are scanning backward and don't know
7368 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7369 IT_BYTEPOS (*it
), stop
, Qnil
);
7374 /* Composition created while scanning backward. */
7375 /* Update IT's char/byte positions to point to the last
7376 character of the previous grapheme cluster, or the
7377 character visually after the current composition. */
7378 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7379 bidi_move_to_visually_next (&it
->bidi_it
);
7380 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7381 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7382 if (it
->cmp_it
.from
> 0)
7384 /* Proceed to the previous grapheme cluster. */
7385 it
->cmp_it
.to
= it
->cmp_it
.from
;
7389 /* No more grapheme clusters in this composition.
7390 Find the next stop position. */
7391 ptrdiff_t stop
= it
->end_charpos
;
7392 if (it
->bidi_it
.scan_dir
< 0)
7393 /* Now we are scanning backward and don't know
7396 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7397 IT_BYTEPOS (*it
), stop
, Qnil
);
7403 eassert (it
->len
!= 0);
7407 IT_BYTEPOS (*it
) += it
->len
;
7408 IT_CHARPOS (*it
) += 1;
7412 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7413 /* If this is a new paragraph, determine its base
7414 direction (a.k.a. its base embedding level). */
7415 if (it
->bidi_it
.new_paragraph
)
7416 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7417 bidi_move_to_visually_next (&it
->bidi_it
);
7418 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7419 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7420 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7422 /* As the scan direction was changed, we must
7423 re-compute the stop position for composition. */
7424 ptrdiff_t stop
= it
->end_charpos
;
7425 if (it
->bidi_it
.scan_dir
< 0)
7427 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7428 IT_BYTEPOS (*it
), stop
, Qnil
);
7431 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7435 case GET_FROM_C_STRING
:
7436 /* Current display element of IT is from a C string. */
7438 /* If the string position is beyond string's end, it means
7439 next_element_from_c_string is padding the string with
7440 blanks, in which case we bypass the bidi iterator,
7441 because it cannot deal with such virtual characters. */
7442 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7444 IT_BYTEPOS (*it
) += it
->len
;
7445 IT_CHARPOS (*it
) += 1;
7449 bidi_move_to_visually_next (&it
->bidi_it
);
7450 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7451 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7455 case GET_FROM_DISPLAY_VECTOR
:
7456 /* Current display element of IT is from a display table entry.
7457 Advance in the display table definition. Reset it to null if
7458 end reached, and continue with characters from buffers/
7460 ++it
->current
.dpvec_index
;
7462 /* Restore face of the iterator to what they were before the
7463 display vector entry (these entries may contain faces). */
7464 it
->face_id
= it
->saved_face_id
;
7466 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7468 int recheck_faces
= it
->ellipsis_p
;
7471 it
->method
= GET_FROM_C_STRING
;
7472 else if (STRINGP (it
->string
))
7473 it
->method
= GET_FROM_STRING
;
7476 it
->method
= GET_FROM_BUFFER
;
7477 it
->object
= it
->w
->contents
;
7481 it
->current
.dpvec_index
= -1;
7483 /* Skip over characters which were displayed via IT->dpvec. */
7484 if (it
->dpvec_char_len
< 0)
7485 reseat_at_next_visible_line_start (it
, 1);
7486 else if (it
->dpvec_char_len
> 0)
7488 if (it
->method
== GET_FROM_STRING
7489 && it
->current
.overlay_string_index
>= 0
7490 && it
->n_overlay_strings
> 0)
7491 it
->ignore_overlay_strings_at_pos_p
= true;
7492 it
->len
= it
->dpvec_char_len
;
7493 set_iterator_to_next (it
, reseat_p
);
7496 /* Maybe recheck faces after display vector. */
7498 it
->stop_charpos
= IT_CHARPOS (*it
);
7502 case GET_FROM_STRING
:
7503 /* Current display element is a character from a Lisp string. */
7504 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7505 /* Don't advance past string end. These conditions are true
7506 when set_iterator_to_next is called at the end of
7507 get_next_display_element, in which case the Lisp string is
7508 already exhausted, and all we want is pop the iterator
7510 if (it
->current
.overlay_string_index
>= 0)
7512 /* This is an overlay string, so there's no padding with
7513 spaces, and the number of characters in the string is
7514 where the string ends. */
7515 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7516 goto consider_string_end
;
7520 /* Not an overlay string. There could be padding, so test
7521 against it->end_charpos. */
7522 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7523 goto consider_string_end
;
7525 if (it
->cmp_it
.id
>= 0)
7531 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7532 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7533 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7534 it
->cmp_it
.from
= it
->cmp_it
.to
;
7538 composition_compute_stop_pos (&it
->cmp_it
,
7539 IT_STRING_CHARPOS (*it
),
7540 IT_STRING_BYTEPOS (*it
),
7541 it
->end_charpos
, it
->string
);
7544 else if (! it
->cmp_it
.reversed_p
)
7546 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7547 bidi_move_to_visually_next (&it
->bidi_it
);
7548 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7549 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7551 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7552 it
->cmp_it
.from
= it
->cmp_it
.to
;
7555 ptrdiff_t stop
= it
->end_charpos
;
7556 if (it
->bidi_it
.scan_dir
< 0)
7558 composition_compute_stop_pos (&it
->cmp_it
,
7559 IT_STRING_CHARPOS (*it
),
7560 IT_STRING_BYTEPOS (*it
), stop
,
7566 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7567 bidi_move_to_visually_next (&it
->bidi_it
);
7568 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7569 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7570 if (it
->cmp_it
.from
> 0)
7571 it
->cmp_it
.to
= it
->cmp_it
.from
;
7574 ptrdiff_t stop
= it
->end_charpos
;
7575 if (it
->bidi_it
.scan_dir
< 0)
7577 composition_compute_stop_pos (&it
->cmp_it
,
7578 IT_STRING_CHARPOS (*it
),
7579 IT_STRING_BYTEPOS (*it
), stop
,
7587 /* If the string position is beyond string's end, it
7588 means next_element_from_string is padding the string
7589 with blanks, in which case we bypass the bidi
7590 iterator, because it cannot deal with such virtual
7592 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7594 IT_STRING_BYTEPOS (*it
) += it
->len
;
7595 IT_STRING_CHARPOS (*it
) += 1;
7599 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7601 bidi_move_to_visually_next (&it
->bidi_it
);
7602 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7603 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7604 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7606 ptrdiff_t stop
= it
->end_charpos
;
7608 if (it
->bidi_it
.scan_dir
< 0)
7610 composition_compute_stop_pos (&it
->cmp_it
,
7611 IT_STRING_CHARPOS (*it
),
7612 IT_STRING_BYTEPOS (*it
), stop
,
7618 consider_string_end
:
7620 if (it
->current
.overlay_string_index
>= 0)
7622 /* IT->string is an overlay string. Advance to the
7623 next, if there is one. */
7624 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7627 next_overlay_string (it
);
7629 setup_for_ellipsis (it
, 0);
7634 /* IT->string is not an overlay string. If we reached
7635 its end, and there is something on IT->stack, proceed
7636 with what is on the stack. This can be either another
7637 string, this time an overlay string, or a buffer. */
7638 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7642 if (it
->method
== GET_FROM_STRING
)
7643 goto consider_string_end
;
7648 case GET_FROM_IMAGE
:
7649 case GET_FROM_STRETCH
:
7650 /* The position etc with which we have to proceed are on
7651 the stack. The position may be at the end of a string,
7652 if the `display' property takes up the whole string. */
7653 eassert (it
->sp
> 0);
7655 if (it
->method
== GET_FROM_STRING
)
7656 goto consider_string_end
;
7660 /* There are no other methods defined, so this should be a bug. */
7664 eassert (it
->method
!= GET_FROM_STRING
7665 || (STRINGP (it
->string
)
7666 && IT_STRING_CHARPOS (*it
) >= 0));
7669 /* Load IT's display element fields with information about the next
7670 display element which comes from a display table entry or from the
7671 result of translating a control character to one of the forms `^C'
7674 IT->dpvec holds the glyphs to return as characters.
7675 IT->saved_face_id holds the face id before the display vector--it
7676 is restored into IT->face_id in set_iterator_to_next. */
7679 next_element_from_display_vector (struct it
*it
)
7682 int prev_face_id
= it
->face_id
;
7686 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7688 it
->face_id
= it
->saved_face_id
;
7690 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7691 That seemed totally bogus - so I changed it... */
7692 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7694 if (GLYPH_CODE_P (gc
))
7696 struct face
*this_face
, *prev_face
, *next_face
;
7698 it
->c
= GLYPH_CODE_CHAR (gc
);
7699 it
->len
= CHAR_BYTES (it
->c
);
7701 /* The entry may contain a face id to use. Such a face id is
7702 the id of a Lisp face, not a realized face. A face id of
7703 zero means no face is specified. */
7704 if (it
->dpvec_face_id
>= 0)
7705 it
->face_id
= it
->dpvec_face_id
;
7708 int lface_id
= GLYPH_CODE_FACE (gc
);
7710 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7714 /* Glyphs in the display vector could have the box face, so we
7715 need to set the related flags in the iterator, as
7717 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7718 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7720 /* Is this character the first character of a box-face run? */
7721 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7723 || prev_face
->box
== FACE_NO_BOX
));
7725 /* For the last character of the box-face run, we need to look
7726 either at the next glyph from the display vector, or at the
7727 face we saw before the display vector. */
7728 next_face_id
= it
->saved_face_id
;
7729 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7731 if (it
->dpvec_face_id
>= 0)
7732 next_face_id
= it
->dpvec_face_id
;
7736 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7739 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7743 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7744 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7746 || next_face
->box
== FACE_NO_BOX
));
7747 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7750 /* Display table entry is invalid. Return a space. */
7751 it
->c
= ' ', it
->len
= 1;
7753 /* Don't change position and object of the iterator here. They are
7754 still the values of the character that had this display table
7755 entry or was translated, and that's what we want. */
7756 it
->what
= IT_CHARACTER
;
7760 /* Get the first element of string/buffer in the visual order, after
7761 being reseated to a new position in a string or a buffer. */
7763 get_visually_first_element (struct it
*it
)
7765 int string_p
= STRINGP (it
->string
) || it
->s
;
7766 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7767 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7769 if (STRINGP (it
->string
))
7771 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7772 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7776 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7777 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7780 if (it
->bidi_it
.charpos
== eob
)
7782 /* Nothing to do, but reset the FIRST_ELT flag, like
7783 bidi_paragraph_init does, because we are not going to
7785 it
->bidi_it
.first_elt
= 0;
7787 else if (it
->bidi_it
.charpos
== bob
7789 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7790 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7792 /* If we are at the beginning of a line/string, we can produce
7793 the next element right away. */
7794 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7795 bidi_move_to_visually_next (&it
->bidi_it
);
7799 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7801 /* We need to prime the bidi iterator starting at the line's or
7802 string's beginning, before we will be able to produce the
7805 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7807 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7808 IT_BYTEPOS (*it
), -1,
7809 &it
->bidi_it
.bytepos
);
7810 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7813 /* Now return to buffer/string position where we were asked
7814 to get the next display element, and produce that. */
7815 bidi_move_to_visually_next (&it
->bidi_it
);
7817 while (it
->bidi_it
.bytepos
!= orig_bytepos
7818 && it
->bidi_it
.charpos
< eob
);
7821 /* Adjust IT's position information to where we ended up. */
7822 if (STRINGP (it
->string
))
7824 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7825 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7829 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7830 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7833 if (STRINGP (it
->string
) || !it
->s
)
7835 ptrdiff_t stop
, charpos
, bytepos
;
7837 if (STRINGP (it
->string
))
7840 stop
= SCHARS (it
->string
);
7841 if (stop
> it
->end_charpos
)
7842 stop
= it
->end_charpos
;
7843 charpos
= IT_STRING_CHARPOS (*it
);
7844 bytepos
= IT_STRING_BYTEPOS (*it
);
7848 stop
= it
->end_charpos
;
7849 charpos
= IT_CHARPOS (*it
);
7850 bytepos
= IT_BYTEPOS (*it
);
7852 if (it
->bidi_it
.scan_dir
< 0)
7854 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7859 /* Load IT with the next display element from Lisp string IT->string.
7860 IT->current.string_pos is the current position within the string.
7861 If IT->current.overlay_string_index >= 0, the Lisp string is an
7865 next_element_from_string (struct it
*it
)
7867 struct text_pos position
;
7869 eassert (STRINGP (it
->string
));
7870 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7871 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7872 position
= it
->current
.string_pos
;
7874 /* With bidi reordering, the character to display might not be the
7875 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7876 that we were reseat()ed to a new string, whose paragraph
7877 direction is not known. */
7878 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7880 get_visually_first_element (it
);
7881 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7884 /* Time to check for invisible text? */
7885 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7887 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7890 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7891 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7893 /* With bidi non-linear iteration, we could find
7894 ourselves far beyond the last computed stop_charpos,
7895 with several other stop positions in between that we
7896 missed. Scan them all now, in buffer's logical
7897 order, until we find and handle the last stop_charpos
7898 that precedes our current position. */
7899 handle_stop_backwards (it
, it
->stop_charpos
);
7900 return GET_NEXT_DISPLAY_ELEMENT (it
);
7906 /* Take note of the stop position we just moved
7907 across, for when we will move back across it. */
7908 it
->prev_stop
= it
->stop_charpos
;
7909 /* If we are at base paragraph embedding level, take
7910 note of the last stop position seen at this
7912 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7913 it
->base_level_stop
= it
->stop_charpos
;
7917 /* Since a handler may have changed IT->method, we must
7919 return GET_NEXT_DISPLAY_ELEMENT (it
);
7923 /* If we are before prev_stop, we may have overstepped
7924 on our way backwards a stop_pos, and if so, we need
7925 to handle that stop_pos. */
7926 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7927 /* We can sometimes back up for reasons that have nothing
7928 to do with bidi reordering. E.g., compositions. The
7929 code below is only needed when we are above the base
7930 embedding level, so test for that explicitly. */
7931 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7933 /* If we lost track of base_level_stop, we have no better
7934 place for handle_stop_backwards to start from than string
7935 beginning. This happens, e.g., when we were reseated to
7936 the previous screenful of text by vertical-motion. */
7937 if (it
->base_level_stop
<= 0
7938 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7939 it
->base_level_stop
= 0;
7940 handle_stop_backwards (it
, it
->base_level_stop
);
7941 return GET_NEXT_DISPLAY_ELEMENT (it
);
7945 if (it
->current
.overlay_string_index
>= 0)
7947 /* Get the next character from an overlay string. In overlay
7948 strings, there is no field width or padding with spaces to
7950 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7955 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7956 IT_STRING_BYTEPOS (*it
),
7957 it
->bidi_it
.scan_dir
< 0
7959 : SCHARS (it
->string
))
7960 && next_element_from_composition (it
))
7964 else if (STRING_MULTIBYTE (it
->string
))
7966 const unsigned char *s
= (SDATA (it
->string
)
7967 + IT_STRING_BYTEPOS (*it
));
7968 it
->c
= string_char_and_length (s
, &it
->len
);
7972 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7978 /* Get the next character from a Lisp string that is not an
7979 overlay string. Such strings come from the mode line, for
7980 example. We may have to pad with spaces, or truncate the
7981 string. See also next_element_from_c_string. */
7982 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7987 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7989 /* Pad with spaces. */
7990 it
->c
= ' ', it
->len
= 1;
7991 CHARPOS (position
) = BYTEPOS (position
) = -1;
7993 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7994 IT_STRING_BYTEPOS (*it
),
7995 it
->bidi_it
.scan_dir
< 0
7997 : it
->string_nchars
)
7998 && next_element_from_composition (it
))
8002 else if (STRING_MULTIBYTE (it
->string
))
8004 const unsigned char *s
= (SDATA (it
->string
)
8005 + IT_STRING_BYTEPOS (*it
));
8006 it
->c
= string_char_and_length (s
, &it
->len
);
8010 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
8015 /* Record what we have and where it came from. */
8016 it
->what
= IT_CHARACTER
;
8017 it
->object
= it
->string
;
8018 it
->position
= position
;
8023 /* Load IT with next display element from C string IT->s.
8024 IT->string_nchars is the maximum number of characters to return
8025 from the string. IT->end_charpos may be greater than
8026 IT->string_nchars when this function is called, in which case we
8027 may have to return padding spaces. Value is zero if end of string
8028 reached, including padding spaces. */
8031 next_element_from_c_string (struct it
*it
)
8033 bool success_p
= true;
8036 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
8037 it
->what
= IT_CHARACTER
;
8038 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
8041 /* With bidi reordering, the character to display might not be the
8042 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8043 we were reseated to a new string, whose paragraph direction is
8045 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8046 get_visually_first_element (it
);
8048 /* IT's position can be greater than IT->string_nchars in case a
8049 field width or precision has been specified when the iterator was
8051 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8053 /* End of the game. */
8057 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
8059 /* Pad with spaces. */
8060 it
->c
= ' ', it
->len
= 1;
8061 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
8063 else if (it
->multibyte_p
)
8064 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
8066 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
8072 /* Set up IT to return characters from an ellipsis, if appropriate.
8073 The definition of the ellipsis glyphs may come from a display table
8074 entry. This function fills IT with the first glyph from the
8075 ellipsis if an ellipsis is to be displayed. */
8078 next_element_from_ellipsis (struct it
*it
)
8080 if (it
->selective_display_ellipsis_p
)
8081 setup_for_ellipsis (it
, it
->len
);
8084 /* The face at the current position may be different from the
8085 face we find after the invisible text. Remember what it
8086 was in IT->saved_face_id, and signal that it's there by
8087 setting face_before_selective_p. */
8088 it
->saved_face_id
= it
->face_id
;
8089 it
->method
= GET_FROM_BUFFER
;
8090 it
->object
= it
->w
->contents
;
8091 reseat_at_next_visible_line_start (it
, 1);
8092 it
->face_before_selective_p
= true;
8095 return GET_NEXT_DISPLAY_ELEMENT (it
);
8099 /* Deliver an image display element. The iterator IT is already
8100 filled with image information (done in handle_display_prop). Value
8105 next_element_from_image (struct it
*it
)
8107 it
->what
= IT_IMAGE
;
8108 it
->ignore_overlay_strings_at_pos_p
= 0;
8113 /* Fill iterator IT with next display element from a stretch glyph
8114 property. IT->object is the value of the text property. Value is
8118 next_element_from_stretch (struct it
*it
)
8120 it
->what
= IT_STRETCH
;
8124 /* Scan backwards from IT's current position until we find a stop
8125 position, or until BEGV. This is called when we find ourself
8126 before both the last known prev_stop and base_level_stop while
8127 reordering bidirectional text. */
8130 compute_stop_pos_backwards (struct it
*it
)
8132 const int SCAN_BACK_LIMIT
= 1000;
8133 struct text_pos pos
;
8134 struct display_pos save_current
= it
->current
;
8135 struct text_pos save_position
= it
->position
;
8136 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8137 ptrdiff_t where_we_are
= charpos
;
8138 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8139 ptrdiff_t save_end_pos
= it
->end_charpos
;
8141 eassert (NILP (it
->string
) && !it
->s
);
8142 eassert (it
->bidi_p
);
8146 it
->end_charpos
= min (charpos
+ 1, ZV
);
8147 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8148 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8149 reseat_1 (it
, pos
, 0);
8150 compute_stop_pos (it
);
8151 /* We must advance forward, right? */
8152 if (it
->stop_charpos
<= charpos
)
8155 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8157 if (it
->stop_charpos
<= where_we_are
)
8158 it
->prev_stop
= it
->stop_charpos
;
8160 it
->prev_stop
= BEGV
;
8162 it
->current
= save_current
;
8163 it
->position
= save_position
;
8164 it
->stop_charpos
= save_stop_pos
;
8165 it
->end_charpos
= save_end_pos
;
8168 /* Scan forward from CHARPOS in the current buffer/string, until we
8169 find a stop position > current IT's position. Then handle the stop
8170 position before that. This is called when we bump into a stop
8171 position while reordering bidirectional text. CHARPOS should be
8172 the last previously processed stop_pos (or BEGV/0, if none were
8173 processed yet) whose position is less that IT's current
8177 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8179 int bufp
= !STRINGP (it
->string
);
8180 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8181 struct display_pos save_current
= it
->current
;
8182 struct text_pos save_position
= it
->position
;
8183 struct text_pos pos1
;
8184 ptrdiff_t next_stop
;
8186 /* Scan in strict logical order. */
8187 eassert (it
->bidi_p
);
8191 it
->prev_stop
= charpos
;
8194 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8195 reseat_1 (it
, pos1
, 0);
8198 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8199 compute_stop_pos (it
);
8200 /* We must advance forward, right? */
8201 if (it
->stop_charpos
<= it
->prev_stop
)
8203 charpos
= it
->stop_charpos
;
8205 while (charpos
<= where_we_are
);
8208 it
->current
= save_current
;
8209 it
->position
= save_position
;
8210 next_stop
= it
->stop_charpos
;
8211 it
->stop_charpos
= it
->prev_stop
;
8213 it
->stop_charpos
= next_stop
;
8216 /* Load IT with the next display element from current_buffer. Value
8217 is zero if end of buffer reached. IT->stop_charpos is the next
8218 position at which to stop and check for text properties or buffer
8222 next_element_from_buffer (struct it
*it
)
8224 bool success_p
= true;
8226 eassert (IT_CHARPOS (*it
) >= BEGV
);
8227 eassert (NILP (it
->string
) && !it
->s
);
8228 eassert (!it
->bidi_p
8229 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8230 && it
->bidi_it
.string
.s
== NULL
));
8232 /* With bidi reordering, the character to display might not be the
8233 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8234 we were reseat()ed to a new buffer position, which is potentially
8235 a different paragraph. */
8236 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8238 get_visually_first_element (it
);
8239 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8242 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8244 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8246 int overlay_strings_follow_p
;
8248 /* End of the game, except when overlay strings follow that
8249 haven't been returned yet. */
8250 if (it
->overlay_strings_at_end_processed_p
)
8251 overlay_strings_follow_p
= 0;
8254 it
->overlay_strings_at_end_processed_p
= true;
8255 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8258 if (overlay_strings_follow_p
)
8259 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8263 it
->position
= it
->current
.pos
;
8267 else if (!(!it
->bidi_p
8268 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8269 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8271 /* With bidi non-linear iteration, we could find ourselves
8272 far beyond the last computed stop_charpos, with several
8273 other stop positions in between that we missed. Scan
8274 them all now, in buffer's logical order, until we find
8275 and handle the last stop_charpos that precedes our
8276 current position. */
8277 handle_stop_backwards (it
, it
->stop_charpos
);
8278 return GET_NEXT_DISPLAY_ELEMENT (it
);
8284 /* Take note of the stop position we just moved across,
8285 for when we will move back across it. */
8286 it
->prev_stop
= it
->stop_charpos
;
8287 /* If we are at base paragraph embedding level, take
8288 note of the last stop position seen at this
8290 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8291 it
->base_level_stop
= it
->stop_charpos
;
8294 return GET_NEXT_DISPLAY_ELEMENT (it
);
8298 /* If we are before prev_stop, we may have overstepped on
8299 our way backwards a stop_pos, and if so, we need to
8300 handle that stop_pos. */
8301 && IT_CHARPOS (*it
) < it
->prev_stop
8302 /* We can sometimes back up for reasons that have nothing
8303 to do with bidi reordering. E.g., compositions. The
8304 code below is only needed when we are above the base
8305 embedding level, so test for that explicitly. */
8306 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8308 if (it
->base_level_stop
<= 0
8309 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8311 /* If we lost track of base_level_stop, we need to find
8312 prev_stop by looking backwards. This happens, e.g., when
8313 we were reseated to the previous screenful of text by
8315 it
->base_level_stop
= BEGV
;
8316 compute_stop_pos_backwards (it
);
8317 handle_stop_backwards (it
, it
->prev_stop
);
8320 handle_stop_backwards (it
, it
->base_level_stop
);
8321 return GET_NEXT_DISPLAY_ELEMENT (it
);
8325 /* No face changes, overlays etc. in sight, so just return a
8326 character from current_buffer. */
8330 /* Maybe run the redisplay end trigger hook. Performance note:
8331 This doesn't seem to cost measurable time. */
8332 if (it
->redisplay_end_trigger_charpos
8334 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8335 run_redisplay_end_trigger_hook (it
);
8337 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8338 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8340 && next_element_from_composition (it
))
8345 /* Get the next character, maybe multibyte. */
8346 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8347 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
8348 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8350 it
->c
= *p
, it
->len
= 1;
8352 /* Record what we have and where it came from. */
8353 it
->what
= IT_CHARACTER
;
8354 it
->object
= it
->w
->contents
;
8355 it
->position
= it
->current
.pos
;
8357 /* Normally we return the character found above, except when we
8358 really want to return an ellipsis for selective display. */
8363 /* A value of selective > 0 means hide lines indented more
8364 than that number of columns. */
8365 if (it
->selective
> 0
8366 && IT_CHARPOS (*it
) + 1 < ZV
8367 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8368 IT_BYTEPOS (*it
) + 1,
8371 success_p
= next_element_from_ellipsis (it
);
8372 it
->dpvec_char_len
= -1;
8375 else if (it
->c
== '\r' && it
->selective
== -1)
8377 /* A value of selective == -1 means that everything from the
8378 CR to the end of the line is invisible, with maybe an
8379 ellipsis displayed for it. */
8380 success_p
= next_element_from_ellipsis (it
);
8381 it
->dpvec_char_len
= -1;
8386 /* Value is zero if end of buffer reached. */
8387 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8392 /* Run the redisplay end trigger hook for IT. */
8395 run_redisplay_end_trigger_hook (struct it
*it
)
8397 Lisp_Object args
[3];
8399 /* IT->glyph_row should be non-null, i.e. we should be actually
8400 displaying something, or otherwise we should not run the hook. */
8401 eassert (it
->glyph_row
);
8403 /* Set up hook arguments. */
8404 args
[0] = Qredisplay_end_trigger_functions
;
8405 args
[1] = it
->window
;
8406 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8407 it
->redisplay_end_trigger_charpos
= 0;
8409 /* Since we are *trying* to run these functions, don't try to run
8410 them again, even if they get an error. */
8411 wset_redisplay_end_trigger (it
->w
, Qnil
);
8412 Frun_hook_with_args (3, args
);
8414 /* Notice if it changed the face of the character we are on. */
8415 handle_face_prop (it
);
8419 /* Deliver a composition display element. Unlike the other
8420 next_element_from_XXX, this function is not registered in the array
8421 get_next_element[]. It is called from next_element_from_buffer and
8422 next_element_from_string when necessary. */
8425 next_element_from_composition (struct it
*it
)
8427 it
->what
= IT_COMPOSITION
;
8428 it
->len
= it
->cmp_it
.nbytes
;
8429 if (STRINGP (it
->string
))
8433 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8434 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8437 it
->position
= it
->current
.string_pos
;
8438 it
->object
= it
->string
;
8439 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8440 IT_STRING_BYTEPOS (*it
), it
->string
);
8446 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8447 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8450 if (it
->bidi_it
.new_paragraph
)
8451 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8452 /* Resync the bidi iterator with IT's new position.
8453 FIXME: this doesn't support bidirectional text. */
8454 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8455 bidi_move_to_visually_next (&it
->bidi_it
);
8459 it
->position
= it
->current
.pos
;
8460 it
->object
= it
->w
->contents
;
8461 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8462 IT_BYTEPOS (*it
), Qnil
);
8469 /***********************************************************************
8470 Moving an iterator without producing glyphs
8471 ***********************************************************************/
8473 /* Check if iterator is at a position corresponding to a valid buffer
8474 position after some move_it_ call. */
8476 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8477 ((it)->method == GET_FROM_STRING \
8478 ? IT_STRING_CHARPOS (*it) == 0 \
8482 /* Move iterator IT to a specified buffer or X position within one
8483 line on the display without producing glyphs.
8485 OP should be a bit mask including some or all of these bits:
8486 MOVE_TO_X: Stop upon reaching x-position TO_X.
8487 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8488 Regardless of OP's value, stop upon reaching the end of the display line.
8490 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8491 This means, in particular, that TO_X includes window's horizontal
8494 The return value has several possible values that
8495 say what condition caused the scan to stop:
8497 MOVE_POS_MATCH_OR_ZV
8498 - when TO_POS or ZV was reached.
8501 -when TO_X was reached before TO_POS or ZV were reached.
8504 - when we reached the end of the display area and the line must
8508 - when we reached the end of the display area and the line is
8512 - when we stopped at a line end, i.e. a newline or a CR and selective
8515 static enum move_it_result
8516 move_it_in_display_line_to (struct it
*it
,
8517 ptrdiff_t to_charpos
, int to_x
,
8518 enum move_operation_enum op
)
8520 enum move_it_result result
= MOVE_UNDEFINED
;
8521 struct glyph_row
*saved_glyph_row
;
8522 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8523 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8524 void *ppos_data
= NULL
;
8526 enum it_method prev_method
= it
->method
;
8527 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8528 int saw_smaller_pos
= prev_pos
< to_charpos
;
8530 /* Don't produce glyphs in produce_glyphs. */
8531 saved_glyph_row
= it
->glyph_row
;
8532 it
->glyph_row
= NULL
;
8534 /* Use wrap_it to save a copy of IT wherever a word wrap could
8535 occur. Use atpos_it to save a copy of IT at the desired buffer
8536 position, if found, so that we can scan ahead and check if the
8537 word later overshoots the window edge. Use atx_it similarly, for
8543 /* Use ppos_it under bidi reordering to save a copy of IT for the
8544 initial position. We restore that position in IT when we have
8545 scanned the entire display line without finding a match for
8546 TO_CHARPOS and all the character positions are greater than
8547 TO_CHARPOS. We then restart the scan from the initial position,
8548 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8549 the closest to TO_CHARPOS. */
8552 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8554 SAVE_IT (ppos_it
, *it
, ppos_data
);
8555 closest_pos
= IT_CHARPOS (*it
);
8561 #define BUFFER_POS_REACHED_P() \
8562 ((op & MOVE_TO_POS) != 0 \
8563 && BUFFERP (it->object) \
8564 && (IT_CHARPOS (*it) == to_charpos \
8566 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8567 && IT_CHARPOS (*it) > to_charpos) \
8568 || (it->what == IT_COMPOSITION \
8569 && ((IT_CHARPOS (*it) > to_charpos \
8570 && to_charpos >= it->cmp_it.charpos) \
8571 || (IT_CHARPOS (*it) < to_charpos \
8572 && to_charpos <= it->cmp_it.charpos)))) \
8573 && (it->method == GET_FROM_BUFFER \
8574 || (it->method == GET_FROM_DISPLAY_VECTOR \
8575 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8577 /* If there's a line-/wrap-prefix, handle it. */
8578 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8579 && it
->current_y
< it
->last_visible_y
)
8580 handle_line_prefix (it
);
8582 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8583 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8587 int x
, i
, ascent
= 0, descent
= 0;
8589 /* Utility macro to reset an iterator with x, ascent, and descent. */
8590 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8591 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8592 (IT)->max_descent = descent)
8594 /* Stop if we move beyond TO_CHARPOS (after an image or a
8595 display string or stretch glyph). */
8596 if ((op
& MOVE_TO_POS
) != 0
8597 && BUFFERP (it
->object
)
8598 && it
->method
== GET_FROM_BUFFER
8600 /* When the iterator is at base embedding level, we
8601 are guaranteed that characters are delivered for
8602 display in strictly increasing order of their
8603 buffer positions. */
8604 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8605 && IT_CHARPOS (*it
) > to_charpos
)
8607 && (prev_method
== GET_FROM_IMAGE
8608 || prev_method
== GET_FROM_STRETCH
8609 || prev_method
== GET_FROM_STRING
)
8610 /* Passed TO_CHARPOS from left to right. */
8611 && ((prev_pos
< to_charpos
8612 && IT_CHARPOS (*it
) > to_charpos
)
8613 /* Passed TO_CHARPOS from right to left. */
8614 || (prev_pos
> to_charpos
8615 && IT_CHARPOS (*it
) < to_charpos
)))))
8617 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8619 result
= MOVE_POS_MATCH_OR_ZV
;
8622 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8623 /* If wrap_it is valid, the current position might be in a
8624 word that is wrapped. So, save the iterator in
8625 atpos_it and continue to see if wrapping happens. */
8626 SAVE_IT (atpos_it
, *it
, atpos_data
);
8629 /* Stop when ZV reached.
8630 We used to stop here when TO_CHARPOS reached as well, but that is
8631 too soon if this glyph does not fit on this line. So we handle it
8632 explicitly below. */
8633 if (!get_next_display_element (it
))
8635 result
= MOVE_POS_MATCH_OR_ZV
;
8639 if (it
->line_wrap
== TRUNCATE
)
8641 if (BUFFER_POS_REACHED_P ())
8643 result
= MOVE_POS_MATCH_OR_ZV
;
8649 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8651 if (IT_DISPLAYING_WHITESPACE (it
))
8655 /* We have reached a glyph that follows one or more
8656 whitespace characters. If the position is
8657 already found, we are done. */
8658 if (atpos_it
.sp
>= 0)
8660 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8661 result
= MOVE_POS_MATCH_OR_ZV
;
8666 RESTORE_IT (it
, &atx_it
, atx_data
);
8667 result
= MOVE_X_REACHED
;
8670 /* Otherwise, we can wrap here. */
8671 SAVE_IT (wrap_it
, *it
, wrap_data
);
8677 /* Remember the line height for the current line, in case
8678 the next element doesn't fit on the line. */
8679 ascent
= it
->max_ascent
;
8680 descent
= it
->max_descent
;
8682 /* The call to produce_glyphs will get the metrics of the
8683 display element IT is loaded with. Record the x-position
8684 before this display element, in case it doesn't fit on the
8688 PRODUCE_GLYPHS (it
);
8690 if (it
->area
!= TEXT_AREA
)
8692 prev_method
= it
->method
;
8693 if (it
->method
== GET_FROM_BUFFER
)
8694 prev_pos
= IT_CHARPOS (*it
);
8695 set_iterator_to_next (it
, 1);
8696 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8697 SET_TEXT_POS (this_line_min_pos
,
8698 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8700 && (op
& MOVE_TO_POS
)
8701 && IT_CHARPOS (*it
) > to_charpos
8702 && IT_CHARPOS (*it
) < closest_pos
)
8703 closest_pos
= IT_CHARPOS (*it
);
8707 /* The number of glyphs we get back in IT->nglyphs will normally
8708 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8709 character on a terminal frame, or (iii) a line end. For the
8710 second case, IT->nglyphs - 1 padding glyphs will be present.
8711 (On X frames, there is only one glyph produced for a
8712 composite character.)
8714 The behavior implemented below means, for continuation lines,
8715 that as many spaces of a TAB as fit on the current line are
8716 displayed there. For terminal frames, as many glyphs of a
8717 multi-glyph character are displayed in the current line, too.
8718 This is what the old redisplay code did, and we keep it that
8719 way. Under X, the whole shape of a complex character must
8720 fit on the line or it will be completely displayed in the
8723 Note that both for tabs and padding glyphs, all glyphs have
8727 /* More than one glyph or glyph doesn't fit on line. All
8728 glyphs have the same width. */
8729 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8731 int x_before_this_char
= x
;
8732 int hpos_before_this_char
= it
->hpos
;
8734 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8736 new_x
= x
+ single_glyph_width
;
8738 /* We want to leave anything reaching TO_X to the caller. */
8739 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8741 if (BUFFER_POS_REACHED_P ())
8743 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8744 goto buffer_pos_reached
;
8745 if (atpos_it
.sp
< 0)
8747 SAVE_IT (atpos_it
, *it
, atpos_data
);
8748 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8753 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8756 result
= MOVE_X_REACHED
;
8761 SAVE_IT (atx_it
, *it
, atx_data
);
8762 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8767 if (/* Lines are continued. */
8768 it
->line_wrap
!= TRUNCATE
8769 && (/* And glyph doesn't fit on the line. */
8770 new_x
> it
->last_visible_x
8771 /* Or it fits exactly and we're on a window
8773 || (new_x
== it
->last_visible_x
8774 && FRAME_WINDOW_P (it
->f
)
8775 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8776 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8777 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8779 if (/* IT->hpos == 0 means the very first glyph
8780 doesn't fit on the line, e.g. a wide image. */
8782 || (new_x
== it
->last_visible_x
8783 && FRAME_WINDOW_P (it
->f
)
8784 /* When word-wrap is ON and we have a valid
8785 wrap point, we don't allow the last glyph
8786 to "just barely fit" on the line. */
8787 && (it
->line_wrap
!= WORD_WRAP
8788 || wrap_it
.sp
< 0)))
8791 it
->current_x
= new_x
;
8793 /* The character's last glyph just barely fits
8795 if (i
== it
->nglyphs
- 1)
8797 /* If this is the destination position,
8798 return a position *before* it in this row,
8799 now that we know it fits in this row. */
8800 if (BUFFER_POS_REACHED_P ())
8802 if (it
->line_wrap
!= WORD_WRAP
8805 it
->hpos
= hpos_before_this_char
;
8806 it
->current_x
= x_before_this_char
;
8807 result
= MOVE_POS_MATCH_OR_ZV
;
8810 if (it
->line_wrap
== WORD_WRAP
8813 SAVE_IT (atpos_it
, *it
, atpos_data
);
8814 atpos_it
.current_x
= x_before_this_char
;
8815 atpos_it
.hpos
= hpos_before_this_char
;
8819 prev_method
= it
->method
;
8820 if (it
->method
== GET_FROM_BUFFER
)
8821 prev_pos
= IT_CHARPOS (*it
);
8822 set_iterator_to_next (it
, 1);
8823 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8824 SET_TEXT_POS (this_line_min_pos
,
8825 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8826 /* On graphical terminals, newlines may
8827 "overflow" into the fringe if
8828 overflow-newline-into-fringe is non-nil.
8829 On text terminals, and on graphical
8830 terminals with no right margin, newlines
8831 may overflow into the last glyph on the
8833 if (!FRAME_WINDOW_P (it
->f
)
8835 && it
->bidi_it
.paragraph_dir
== R2L
)
8836 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8837 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8838 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8840 if (!get_next_display_element (it
))
8842 result
= MOVE_POS_MATCH_OR_ZV
;
8845 if (BUFFER_POS_REACHED_P ())
8847 if (ITERATOR_AT_END_OF_LINE_P (it
))
8848 result
= MOVE_POS_MATCH_OR_ZV
;
8850 result
= MOVE_LINE_CONTINUED
;
8853 if (ITERATOR_AT_END_OF_LINE_P (it
)
8854 && (it
->line_wrap
!= WORD_WRAP
8857 result
= MOVE_NEWLINE_OR_CR
;
8864 IT_RESET_X_ASCENT_DESCENT (it
);
8866 if (wrap_it
.sp
>= 0)
8868 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8873 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8875 result
= MOVE_LINE_CONTINUED
;
8879 if (BUFFER_POS_REACHED_P ())
8881 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8882 goto buffer_pos_reached
;
8883 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8885 SAVE_IT (atpos_it
, *it
, atpos_data
);
8886 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8890 if (new_x
> it
->first_visible_x
)
8892 /* Glyph is visible. Increment number of glyphs that
8893 would be displayed. */
8898 if (result
!= MOVE_UNDEFINED
)
8901 else if (BUFFER_POS_REACHED_P ())
8904 IT_RESET_X_ASCENT_DESCENT (it
);
8905 result
= MOVE_POS_MATCH_OR_ZV
;
8908 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8910 /* Stop when TO_X specified and reached. This check is
8911 necessary here because of lines consisting of a line end,
8912 only. The line end will not produce any glyphs and we
8913 would never get MOVE_X_REACHED. */
8914 eassert (it
->nglyphs
== 0);
8915 result
= MOVE_X_REACHED
;
8919 /* Is this a line end? If yes, we're done. */
8920 if (ITERATOR_AT_END_OF_LINE_P (it
))
8922 /* If we are past TO_CHARPOS, but never saw any character
8923 positions smaller than TO_CHARPOS, return
8924 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8926 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8928 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8930 if (closest_pos
< ZV
)
8932 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8933 /* Don't recurse if closest_pos is equal to
8934 to_charpos, since we have just tried that. */
8935 if (closest_pos
!= to_charpos
)
8936 move_it_in_display_line_to (it
, closest_pos
, -1,
8938 result
= MOVE_POS_MATCH_OR_ZV
;
8941 goto buffer_pos_reached
;
8943 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8944 && IT_CHARPOS (*it
) > to_charpos
)
8945 goto buffer_pos_reached
;
8947 result
= MOVE_NEWLINE_OR_CR
;
8950 result
= MOVE_NEWLINE_OR_CR
;
8954 prev_method
= it
->method
;
8955 if (it
->method
== GET_FROM_BUFFER
)
8956 prev_pos
= IT_CHARPOS (*it
);
8957 /* The current display element has been consumed. Advance
8959 set_iterator_to_next (it
, 1);
8960 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8961 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8962 if (IT_CHARPOS (*it
) < to_charpos
)
8963 saw_smaller_pos
= 1;
8965 && (op
& MOVE_TO_POS
)
8966 && IT_CHARPOS (*it
) >= to_charpos
8967 && IT_CHARPOS (*it
) < closest_pos
)
8968 closest_pos
= IT_CHARPOS (*it
);
8970 /* Stop if lines are truncated and IT's current x-position is
8971 past the right edge of the window now. */
8972 if (it
->line_wrap
== TRUNCATE
8973 && it
->current_x
>= it
->last_visible_x
)
8975 if (!FRAME_WINDOW_P (it
->f
)
8976 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8977 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8978 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8979 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8983 if ((at_eob_p
= !get_next_display_element (it
))
8984 || BUFFER_POS_REACHED_P ()
8985 /* If we are past TO_CHARPOS, but never saw any
8986 character positions smaller than TO_CHARPOS,
8987 return MOVE_POS_MATCH_OR_ZV, like the
8988 unidirectional display did. */
8989 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8991 && IT_CHARPOS (*it
) > to_charpos
))
8994 && !BUFFER_POS_REACHED_P ()
8995 && !at_eob_p
&& closest_pos
< ZV
)
8997 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8998 if (closest_pos
!= to_charpos
)
8999 move_it_in_display_line_to (it
, closest_pos
, -1,
9002 result
= MOVE_POS_MATCH_OR_ZV
;
9005 if (ITERATOR_AT_END_OF_LINE_P (it
))
9007 result
= MOVE_NEWLINE_OR_CR
;
9011 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
9013 && IT_CHARPOS (*it
) > to_charpos
)
9015 if (closest_pos
< ZV
)
9017 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9018 if (closest_pos
!= to_charpos
)
9019 move_it_in_display_line_to (it
, closest_pos
, -1,
9022 result
= MOVE_POS_MATCH_OR_ZV
;
9025 result
= MOVE_LINE_TRUNCATED
;
9028 #undef IT_RESET_X_ASCENT_DESCENT
9031 #undef BUFFER_POS_REACHED_P
9033 /* If we scanned beyond to_pos and didn't find a point to wrap at,
9034 restore the saved iterator. */
9035 if (atpos_it
.sp
>= 0)
9036 RESTORE_IT (it
, &atpos_it
, atpos_data
);
9037 else if (atx_it
.sp
>= 0)
9038 RESTORE_IT (it
, &atx_it
, atx_data
);
9043 bidi_unshelve_cache (atpos_data
, 1);
9045 bidi_unshelve_cache (atx_data
, 1);
9047 bidi_unshelve_cache (wrap_data
, 1);
9049 bidi_unshelve_cache (ppos_data
, 1);
9051 /* Restore the iterator settings altered at the beginning of this
9053 it
->glyph_row
= saved_glyph_row
;
9057 /* For external use. */
9059 move_it_in_display_line (struct it
*it
,
9060 ptrdiff_t to_charpos
, int to_x
,
9061 enum move_operation_enum op
)
9063 if (it
->line_wrap
== WORD_WRAP
9064 && (op
& MOVE_TO_X
))
9067 void *save_data
= NULL
;
9070 SAVE_IT (save_it
, *it
, save_data
);
9071 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9072 /* When word-wrap is on, TO_X may lie past the end
9073 of a wrapped line. Then it->current is the
9074 character on the next line, so backtrack to the
9075 space before the wrap point. */
9076 if (skip
== MOVE_LINE_CONTINUED
)
9078 int prev_x
= max (it
->current_x
- 1, 0);
9079 RESTORE_IT (it
, &save_it
, save_data
);
9080 move_it_in_display_line_to
9081 (it
, -1, prev_x
, MOVE_TO_X
);
9084 bidi_unshelve_cache (save_data
, 1);
9087 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9091 /* Move IT forward until it satisfies one or more of the criteria in
9092 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9094 OP is a bit-mask that specifies where to stop, and in particular,
9095 which of those four position arguments makes a difference. See the
9096 description of enum move_operation_enum.
9098 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9099 screen line, this function will set IT to the next position that is
9100 displayed to the right of TO_CHARPOS on the screen.
9102 Return the maximum pixel length of any line scanned but never more
9103 than it.last_visible_x. */
9106 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9108 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9109 int line_height
, line_start_x
= 0, reached
= 0;
9110 int max_current_x
= 0;
9111 void *backup_data
= NULL
;
9115 if (op
& MOVE_TO_VPOS
)
9117 /* If no TO_CHARPOS and no TO_X specified, stop at the
9118 start of the line TO_VPOS. */
9119 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9121 if (it
->vpos
== to_vpos
)
9127 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9131 /* TO_VPOS >= 0 means stop at TO_X in the line at
9132 TO_VPOS, or at TO_POS, whichever comes first. */
9133 if (it
->vpos
== to_vpos
)
9139 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9141 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9146 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9148 /* We have reached TO_X but not in the line we want. */
9149 skip
= move_it_in_display_line_to (it
, to_charpos
,
9151 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9159 else if (op
& MOVE_TO_Y
)
9161 struct it it_backup
;
9163 if (it
->line_wrap
== WORD_WRAP
)
9164 SAVE_IT (it_backup
, *it
, backup_data
);
9166 /* TO_Y specified means stop at TO_X in the line containing
9167 TO_Y---or at TO_CHARPOS if this is reached first. The
9168 problem is that we can't really tell whether the line
9169 contains TO_Y before we have completely scanned it, and
9170 this may skip past TO_X. What we do is to first scan to
9173 If TO_X is not specified, use a TO_X of zero. The reason
9174 is to make the outcome of this function more predictable.
9175 If we didn't use TO_X == 0, we would stop at the end of
9176 the line which is probably not what a caller would expect
9178 skip
= move_it_in_display_line_to
9179 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9180 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9182 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9183 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9185 else if (skip
== MOVE_X_REACHED
)
9187 /* If TO_X was reached, we want to know whether TO_Y is
9188 in the line. We know this is the case if the already
9189 scanned glyphs make the line tall enough. Otherwise,
9190 we must check by scanning the rest of the line. */
9191 line_height
= it
->max_ascent
+ it
->max_descent
;
9192 if (to_y
>= it
->current_y
9193 && to_y
< it
->current_y
+ line_height
)
9198 SAVE_IT (it_backup
, *it
, backup_data
);
9199 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9200 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9202 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9203 line_height
= it
->max_ascent
+ it
->max_descent
;
9204 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9206 if (to_y
>= it
->current_y
9207 && to_y
< it
->current_y
+ line_height
)
9209 /* If TO_Y is in this line and TO_X was reached
9210 above, we scanned too far. We have to restore
9211 IT's settings to the ones before skipping. But
9212 keep the more accurate values of max_ascent and
9213 max_descent we've found while skipping the rest
9214 of the line, for the sake of callers, such as
9215 pos_visible_p, that need to know the line
9217 int max_ascent
= it
->max_ascent
;
9218 int max_descent
= it
->max_descent
;
9220 RESTORE_IT (it
, &it_backup
, backup_data
);
9221 it
->max_ascent
= max_ascent
;
9222 it
->max_descent
= max_descent
;
9228 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9234 /* Check whether TO_Y is in this line. */
9235 line_height
= it
->max_ascent
+ it
->max_descent
;
9236 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9238 if (to_y
>= it
->current_y
9239 && to_y
< it
->current_y
+ line_height
)
9241 if (to_y
> it
->current_y
)
9242 max_current_x
= max (it
->current_x
, max_current_x
);
9244 /* When word-wrap is on, TO_X may lie past the end
9245 of a wrapped line. Then it->current is the
9246 character on the next line, so backtrack to the
9247 space before the wrap point. */
9248 if (skip
== MOVE_LINE_CONTINUED
9249 && it
->line_wrap
== WORD_WRAP
)
9251 int prev_x
= max (it
->current_x
- 1, 0);
9252 RESTORE_IT (it
, &it_backup
, backup_data
);
9253 skip
= move_it_in_display_line_to
9254 (it
, -1, prev_x
, MOVE_TO_X
);
9263 max_current_x
= max (it
->current_x
, max_current_x
);
9267 else if (BUFFERP (it
->object
)
9268 && (it
->method
== GET_FROM_BUFFER
9269 || it
->method
== GET_FROM_STRETCH
)
9270 && IT_CHARPOS (*it
) >= to_charpos
9271 /* Under bidi iteration, a call to set_iterator_to_next
9272 can scan far beyond to_charpos if the initial
9273 portion of the next line needs to be reordered. In
9274 that case, give move_it_in_display_line_to another
9277 && it
->bidi_it
.scan_dir
== -1))
9278 skip
= MOVE_POS_MATCH_OR_ZV
;
9280 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9284 case MOVE_POS_MATCH_OR_ZV
:
9285 max_current_x
= max (it
->current_x
, max_current_x
);
9289 case MOVE_NEWLINE_OR_CR
:
9290 max_current_x
= max (it
->current_x
, max_current_x
);
9291 set_iterator_to_next (it
, 1);
9292 it
->continuation_lines_width
= 0;
9295 case MOVE_LINE_TRUNCATED
:
9296 max_current_x
= it
->last_visible_x
;
9297 it
->continuation_lines_width
= 0;
9298 reseat_at_next_visible_line_start (it
, 0);
9299 if ((op
& MOVE_TO_POS
) != 0
9300 && IT_CHARPOS (*it
) > to_charpos
)
9307 case MOVE_LINE_CONTINUED
:
9308 max_current_x
= it
->last_visible_x
;
9309 /* For continued lines ending in a tab, some of the glyphs
9310 associated with the tab are displayed on the current
9311 line. Since it->current_x does not include these glyphs,
9312 we use it->last_visible_x instead. */
9315 it
->continuation_lines_width
+= it
->last_visible_x
;
9316 /* When moving by vpos, ensure that the iterator really
9317 advances to the next line (bug#847, bug#969). Fixme:
9318 do we need to do this in other circumstances? */
9319 if (it
->current_x
!= it
->last_visible_x
9320 && (op
& MOVE_TO_VPOS
)
9321 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9323 line_start_x
= it
->current_x
+ it
->pixel_width
9324 - it
->last_visible_x
;
9325 if (FRAME_WINDOW_P (it
->f
))
9327 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9328 struct font
*face_font
= face
->font
;
9330 /* When display_line produces a continued line
9331 that ends in a TAB, it skips a tab stop that
9332 is closer than the font's space character
9333 width (see x_produce_glyphs where it produces
9334 the stretch glyph which represents a TAB).
9335 We need to reproduce the same logic here. */
9336 eassert (face_font
);
9339 if (line_start_x
< face_font
->space_width
)
9341 += it
->tab_width
* face_font
->space_width
;
9344 set_iterator_to_next (it
, 0);
9348 it
->continuation_lines_width
+= it
->current_x
;
9355 /* Reset/increment for the next run. */
9356 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9357 it
->current_x
= line_start_x
;
9360 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9362 last_height
= it
->max_ascent
+ it
->max_descent
;
9363 it
->max_ascent
= it
->max_descent
= 0;
9368 /* On text terminals, we may stop at the end of a line in the middle
9369 of a multi-character glyph. If the glyph itself is continued,
9370 i.e. it is actually displayed on the next line, don't treat this
9371 stopping point as valid; move to the next line instead (unless
9372 that brings us offscreen). */
9373 if (!FRAME_WINDOW_P (it
->f
)
9375 && IT_CHARPOS (*it
) == to_charpos
9376 && it
->what
== IT_CHARACTER
9378 && it
->line_wrap
== WINDOW_WRAP
9379 && it
->current_x
== it
->last_visible_x
- 1
9382 && it
->vpos
< it
->w
->window_end_vpos
)
9384 it
->continuation_lines_width
+= it
->current_x
;
9385 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9386 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9388 last_height
= it
->max_ascent
+ it
->max_descent
;
9392 bidi_unshelve_cache (backup_data
, 1);
9394 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9396 return max_current_x
;
9400 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9402 If DY > 0, move IT backward at least that many pixels. DY = 0
9403 means move IT backward to the preceding line start or BEGV. This
9404 function may move over more than DY pixels if IT->current_y - DY
9405 ends up in the middle of a line; in this case IT->current_y will be
9406 set to the top of the line moved to. */
9409 move_it_vertically_backward (struct it
*it
, int dy
)
9413 void *it2data
= NULL
, *it3data
= NULL
;
9414 ptrdiff_t start_pos
;
9416 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9417 ptrdiff_t pos_limit
;
9422 start_pos
= IT_CHARPOS (*it
);
9424 /* Estimate how many newlines we must move back. */
9425 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9426 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9429 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9431 /* Set the iterator's position that many lines back. But don't go
9432 back more than NLINES full screen lines -- this wins a day with
9433 buffers which have very long lines. */
9434 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9435 back_to_previous_visible_line_start (it
);
9437 /* Reseat the iterator here. When moving backward, we don't want
9438 reseat to skip forward over invisible text, set up the iterator
9439 to deliver from overlay strings at the new position etc. So,
9440 use reseat_1 here. */
9441 reseat_1 (it
, it
->current
.pos
, 1);
9443 /* We are now surely at a line start. */
9444 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9445 reordering is in effect. */
9446 it
->continuation_lines_width
= 0;
9448 /* Move forward and see what y-distance we moved. First move to the
9449 start of the next line so that we get its height. We need this
9450 height to be able to tell whether we reached the specified
9452 SAVE_IT (it2
, *it
, it2data
);
9453 it2
.max_ascent
= it2
.max_descent
= 0;
9456 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9457 MOVE_TO_POS
| MOVE_TO_VPOS
);
9459 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9460 /* If we are in a display string which starts at START_POS,
9461 and that display string includes a newline, and we are
9462 right after that newline (i.e. at the beginning of a
9463 display line), exit the loop, because otherwise we will
9464 infloop, since move_it_to will see that it is already at
9465 START_POS and will not move. */
9466 || (it2
.method
== GET_FROM_STRING
9467 && IT_CHARPOS (it2
) == start_pos
9468 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9469 eassert (IT_CHARPOS (*it
) >= BEGV
);
9470 SAVE_IT (it3
, it2
, it3data
);
9472 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9473 eassert (IT_CHARPOS (*it
) >= BEGV
);
9474 /* H is the actual vertical distance from the position in *IT
9475 and the starting position. */
9476 h
= it2
.current_y
- it
->current_y
;
9477 /* NLINES is the distance in number of lines. */
9478 nlines
= it2
.vpos
- it
->vpos
;
9480 /* Correct IT's y and vpos position
9481 so that they are relative to the starting point. */
9487 /* DY == 0 means move to the start of the screen line. The
9488 value of nlines is > 0 if continuation lines were involved,
9489 or if the original IT position was at start of a line. */
9490 RESTORE_IT (it
, it
, it2data
);
9492 move_it_by_lines (it
, nlines
);
9493 /* The above code moves us to some position NLINES down,
9494 usually to its first glyph (leftmost in an L2R line), but
9495 that's not necessarily the start of the line, under bidi
9496 reordering. We want to get to the character position
9497 that is immediately after the newline of the previous
9500 && !it
->continuation_lines_width
9501 && !STRINGP (it
->string
)
9502 && IT_CHARPOS (*it
) > BEGV
9503 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9505 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9508 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9509 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9511 bidi_unshelve_cache (it3data
, 1);
9515 /* The y-position we try to reach, relative to *IT.
9516 Note that H has been subtracted in front of the if-statement. */
9517 int target_y
= it
->current_y
+ h
- dy
;
9518 int y0
= it3
.current_y
;
9522 RESTORE_IT (&it3
, &it3
, it3data
);
9523 y1
= line_bottom_y (&it3
);
9524 line_height
= y1
- y0
;
9525 RESTORE_IT (it
, it
, it2data
);
9526 /* If we did not reach target_y, try to move further backward if
9527 we can. If we moved too far backward, try to move forward. */
9528 if (target_y
< it
->current_y
9529 /* This is heuristic. In a window that's 3 lines high, with
9530 a line height of 13 pixels each, recentering with point
9531 on the bottom line will try to move -39/2 = 19 pixels
9532 backward. Try to avoid moving into the first line. */
9533 && (it
->current_y
- target_y
9534 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9535 && IT_CHARPOS (*it
) > BEGV
)
9537 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9538 target_y
- it
->current_y
));
9539 dy
= it
->current_y
- target_y
;
9540 goto move_further_back
;
9542 else if (target_y
>= it
->current_y
+ line_height
9543 && IT_CHARPOS (*it
) < ZV
)
9545 /* Should move forward by at least one line, maybe more.
9547 Note: Calling move_it_by_lines can be expensive on
9548 terminal frames, where compute_motion is used (via
9549 vmotion) to do the job, when there are very long lines
9550 and truncate-lines is nil. That's the reason for
9551 treating terminal frames specially here. */
9553 if (!FRAME_WINDOW_P (it
->f
))
9554 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9559 move_it_by_lines (it
, 1);
9561 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9568 /* Move IT by a specified amount of pixel lines DY. DY negative means
9569 move backwards. DY = 0 means move to start of screen line. At the
9570 end, IT will be on the start of a screen line. */
9573 move_it_vertically (struct it
*it
, int dy
)
9576 move_it_vertically_backward (it
, -dy
);
9579 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9580 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9581 MOVE_TO_POS
| MOVE_TO_Y
);
9582 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9584 /* If buffer ends in ZV without a newline, move to the start of
9585 the line to satisfy the post-condition. */
9586 if (IT_CHARPOS (*it
) == ZV
9588 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9589 move_it_by_lines (it
, 0);
9594 /* Move iterator IT past the end of the text line it is in. */
9597 move_it_past_eol (struct it
*it
)
9599 enum move_it_result rc
;
9601 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9602 if (rc
== MOVE_NEWLINE_OR_CR
)
9603 set_iterator_to_next (it
, 0);
9607 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9608 negative means move up. DVPOS == 0 means move to the start of the
9611 Optimization idea: If we would know that IT->f doesn't use
9612 a face with proportional font, we could be faster for
9613 truncate-lines nil. */
9616 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9619 /* The commented-out optimization uses vmotion on terminals. This
9620 gives bad results, because elements like it->what, on which
9621 callers such as pos_visible_p rely, aren't updated. */
9622 /* struct position pos;
9623 if (!FRAME_WINDOW_P (it->f))
9625 struct text_pos textpos;
9627 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9628 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9629 reseat (it, textpos, 1);
9630 it->vpos += pos.vpos;
9631 it->current_y += pos.vpos;
9637 /* DVPOS == 0 means move to the start of the screen line. */
9638 move_it_vertically_backward (it
, 0);
9639 /* Let next call to line_bottom_y calculate real line height. */
9644 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9645 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9647 /* Only move to the next buffer position if we ended up in a
9648 string from display property, not in an overlay string
9649 (before-string or after-string). That is because the
9650 latter don't conceal the underlying buffer position, so
9651 we can ask to move the iterator to the exact position we
9652 are interested in. Note that, even if we are already at
9653 IT_CHARPOS (*it), the call below is not a no-op, as it
9654 will detect that we are at the end of the string, pop the
9655 iterator, and compute it->current_x and it->hpos
9657 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9658 -1, -1, -1, MOVE_TO_POS
);
9664 void *it2data
= NULL
;
9665 ptrdiff_t start_charpos
, i
;
9667 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9668 bool hit_pos_limit
= false;
9669 ptrdiff_t pos_limit
;
9671 /* Start at the beginning of the screen line containing IT's
9672 position. This may actually move vertically backwards,
9673 in case of overlays, so adjust dvpos accordingly. */
9675 move_it_vertically_backward (it
, 0);
9678 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9679 screen lines, and reseat the iterator there. */
9680 start_charpos
= IT_CHARPOS (*it
);
9681 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9684 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9686 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9687 back_to_previous_visible_line_start (it
);
9688 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9689 hit_pos_limit
= true;
9690 reseat (it
, it
->current
.pos
, 1);
9692 /* Move further back if we end up in a string or an image. */
9693 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9695 /* First try to move to start of display line. */
9697 move_it_vertically_backward (it
, 0);
9699 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9701 /* If start of line is still in string or image,
9702 move further back. */
9703 back_to_previous_visible_line_start (it
);
9704 reseat (it
, it
->current
.pos
, 1);
9708 it
->current_x
= it
->hpos
= 0;
9710 /* Above call may have moved too far if continuation lines
9711 are involved. Scan forward and see if it did. */
9712 SAVE_IT (it2
, *it
, it2data
);
9713 it2
.vpos
= it2
.current_y
= 0;
9714 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9715 it
->vpos
-= it2
.vpos
;
9716 it
->current_y
-= it2
.current_y
;
9717 it
->current_x
= it
->hpos
= 0;
9719 /* If we moved too far back, move IT some lines forward. */
9720 if (it2
.vpos
> -dvpos
)
9722 int delta
= it2
.vpos
+ dvpos
;
9724 RESTORE_IT (&it2
, &it2
, it2data
);
9725 SAVE_IT (it2
, *it
, it2data
);
9726 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9727 /* Move back again if we got too far ahead. */
9728 if (IT_CHARPOS (*it
) >= start_charpos
)
9729 RESTORE_IT (it
, &it2
, it2data
);
9731 bidi_unshelve_cache (it2data
, 1);
9733 else if (hit_pos_limit
&& pos_limit
> BEGV
9734 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9736 /* If we hit the limit, but still didn't make it far enough
9737 back, that means there's a display string with a newline
9738 covering a large chunk of text, and that caused
9739 back_to_previous_visible_line_start try to go too far.
9740 Punish those who commit such atrocities by going back
9741 until we've reached DVPOS, after lifting the limit, which
9742 could make it slow for very long lines. "If it hurts,
9745 RESTORE_IT (it
, it
, it2data
);
9746 for (i
= -dvpos
; i
> 0; --i
)
9748 back_to_previous_visible_line_start (it
);
9751 reseat_1 (it
, it
->current
.pos
, 1);
9754 RESTORE_IT (it
, it
, it2data
);
9758 /* Return true if IT points into the middle of a display vector. */
9761 in_display_vector_p (struct it
*it
)
9763 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9764 && it
->current
.dpvec_index
> 0
9765 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9768 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9769 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9770 WINDOW must be a live window and defaults to the selected one. The
9771 return value is a cons of the maximum pixel-width of any text line and
9772 the maximum pixel-height of all text lines.
9774 The optional argument FROM, if non-nil, specifies the first text
9775 position and defaults to the minimum accessible position of the buffer.
9776 If FROM is t, use the minimum accessible position that is not a newline
9777 character. TO, if non-nil, specifies the last text position and
9778 defaults to the maximum accessible position of the buffer. If TO is t,
9779 use the maximum accessible position that is not a newline character.
9781 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9782 width that can be returned. X-LIMIT nil or omitted, means to use the
9783 pixel-width of WINDOW's body; use this if you do not intend to change
9784 the width of WINDOW. Use the maximum width WINDOW may assume if you
9785 intend to change WINDOW's width. In any case, text whose x-coordinate
9786 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9787 can take some time, it's always a good idea to make this argument as
9788 small as possible; in particular, if the buffer contains long lines that
9789 shall be truncated anyway.
9791 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9792 height that can be returned. Text lines whose y-coordinate is beyond
9793 Y-LIMIT are ignored. Since calculating the text height of a large
9794 buffer can take some time, it makes sense to specify this argument if
9795 the size of the buffer is unknown.
9797 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9798 include the height of the mode- or header-line of WINDOW in the return
9799 value. If it is either the symbol `mode-line' or `header-line', include
9800 only the height of that line, if present, in the return value. If t,
9801 include the height of both, if present, in the return value. */)
9802 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
, Lisp_Object y_limit
,
9803 Lisp_Object mode_and_header_line
)
9805 struct window
*w
= decode_live_window (window
);
9809 struct buffer
*old_buffer
= NULL
;
9810 ptrdiff_t start
, end
, pos
;
9811 struct text_pos startp
;
9812 void *itdata
= NULL
;
9813 int c
, max_y
= -1, x
= 0, y
= 0;
9819 if (b
!= current_buffer
)
9821 old_buffer
= current_buffer
;
9822 set_buffer_internal (b
);
9827 else if (EQ (from
, Qt
))
9830 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9831 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9833 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9838 CHECK_NUMBER_COERCE_MARKER (from
);
9839 start
= min (max (XINT (from
), BEGV
), ZV
);
9844 else if (EQ (to
, Qt
))
9847 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9848 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9850 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9855 CHECK_NUMBER_COERCE_MARKER (to
);
9856 end
= max (start
, min (XINT (to
), ZV
));
9859 if (!NILP (y_limit
))
9861 CHECK_NUMBER (y_limit
);
9862 max_y
= min (XINT (y_limit
), INT_MAX
);
9865 itdata
= bidi_shelve_cache ();
9866 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9867 start_display (&it
, w
, startp
);
9870 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9873 CHECK_NUMBER (x_limit
);
9874 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9875 /* Actually, we never want move_it_to stop at to_x. But to make
9876 sure that move_it_in_display_line_to always moves far enough,
9877 we set it to INT_MAX and specify MOVE_TO_X. */
9878 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9879 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9882 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9884 if (!EQ (mode_and_header_line
, Qheader_line
)
9885 && !EQ (mode_and_header_line
, Qt
))
9886 /* Do not count the header-line which was counted automatically by
9888 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9890 if (EQ (mode_and_header_line
, Qmode_line
)
9891 || EQ (mode_and_header_line
, Qt
))
9892 /* Do count the mode-line which is not included automatically by
9894 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9896 bidi_unshelve_cache (itdata
, 0);
9899 set_buffer_internal (old_buffer
);
9901 return Fcons (make_number (x
), make_number (y
));
9904 /***********************************************************************
9906 ***********************************************************************/
9909 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9913 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9915 Lisp_Object args
[3];
9916 Lisp_Object msg
, fmt
;
9919 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9923 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9925 args
[0] = fmt
= build_string (format
);
9928 msg
= Fformat (3, args
);
9930 len
= SBYTES (msg
) + 1;
9931 buffer
= SAFE_ALLOCA (len
);
9932 memcpy (buffer
, SDATA (msg
), len
);
9934 message_dolog (buffer
, len
- 1, 1, 0);
9941 /* Output a newline in the *Messages* buffer if "needs" one. */
9944 message_log_maybe_newline (void)
9946 if (message_log_need_newline
)
9947 message_dolog ("", 0, 1, 0);
9951 /* Add a string M of length NBYTES to the message log, optionally
9952 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9953 true, means interpret the contents of M as multibyte. This
9954 function calls low-level routines in order to bypass text property
9955 hooks, etc. which might not be safe to run.
9957 This may GC (insert may run before/after change hooks),
9958 so the buffer M must NOT point to a Lisp string. */
9961 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9963 const unsigned char *msg
= (const unsigned char *) m
;
9965 if (!NILP (Vmemory_full
))
9968 if (!NILP (Vmessage_log_max
))
9970 struct buffer
*oldbuf
;
9971 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9972 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9973 ptrdiff_t point_at_end
= 0;
9974 ptrdiff_t zv_at_end
= 0;
9975 Lisp_Object old_deactivate_mark
;
9976 struct gcpro gcpro1
;
9978 old_deactivate_mark
= Vdeactivate_mark
;
9979 oldbuf
= current_buffer
;
9981 /* Ensure the Messages buffer exists, and switch to it.
9982 If we created it, set the major-mode. */
9985 if (NILP (Fget_buffer (Vmessages_buffer_name
))) newbuffer
= 1;
9987 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9990 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9991 call0 (intern ("messages-buffer-mode"));
9994 bset_undo_list (current_buffer
, Qt
);
9995 bset_cache_long_scans (current_buffer
, Qnil
);
9997 oldpoint
= message_dolog_marker1
;
9998 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9999 oldbegv
= message_dolog_marker2
;
10000 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
10001 oldzv
= message_dolog_marker3
;
10002 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
10003 GCPRO1 (old_deactivate_mark
);
10011 BEGV_BYTE
= BEG_BYTE
;
10014 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10016 /* Insert the string--maybe converting multibyte to single byte
10017 or vice versa, so that all the text fits the buffer. */
10019 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10025 /* Convert a multibyte string to single-byte
10026 for the *Message* buffer. */
10027 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
10029 c
= string_char_and_length (msg
+ i
, &char_bytes
);
10030 work
[0] = (ASCII_CHAR_P (c
)
10032 : multibyte_char_to_unibyte (c
));
10033 insert_1_both (work
, 1, 1, 1, 0, 0);
10036 else if (! multibyte
10037 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10041 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10042 /* Convert a single-byte string to multibyte
10043 for the *Message* buffer. */
10044 for (i
= 0; i
< nbytes
; i
++)
10047 MAKE_CHAR_MULTIBYTE (c
);
10048 char_bytes
= CHAR_STRING (c
, str
);
10049 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
10053 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
, 1, 0, 0);
10057 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
10060 insert_1_both ("\n", 1, 1, 1, 0, 0);
10062 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
10064 this_bol_byte
= PT_BYTE
;
10066 /* See if this line duplicates the previous one.
10067 If so, combine duplicates. */
10068 if (this_bol
> BEG
)
10070 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
10072 prev_bol_byte
= PT_BYTE
;
10074 dups
= message_log_check_duplicate (prev_bol_byte
,
10078 del_range_both (prev_bol
, prev_bol_byte
,
10079 this_bol
, this_bol_byte
, 0);
10082 char dupstr
[sizeof " [ times]"
10083 + INT_STRLEN_BOUND (printmax_t
)];
10085 /* If you change this format, don't forget to also
10086 change message_log_check_duplicate. */
10087 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10088 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10089 insert_1_both (dupstr
, duplen
, duplen
, 1, 0, 1);
10094 /* If we have more than the desired maximum number of lines
10095 in the *Messages* buffer now, delete the oldest ones.
10096 This is safe because we don't have undo in this buffer. */
10098 if (NATNUMP (Vmessage_log_max
))
10100 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10101 -XFASTINT (Vmessage_log_max
) - 1, 0);
10102 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
10105 BEGV
= marker_position (oldbegv
);
10106 BEGV_BYTE
= marker_byte_position (oldbegv
);
10115 ZV
= marker_position (oldzv
);
10116 ZV_BYTE
= marker_byte_position (oldzv
);
10120 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10122 /* We can't do Fgoto_char (oldpoint) because it will run some
10124 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10125 marker_byte_position (oldpoint
));
10128 unchain_marker (XMARKER (oldpoint
));
10129 unchain_marker (XMARKER (oldbegv
));
10130 unchain_marker (XMARKER (oldzv
));
10132 /* We called insert_1_both above with its 5th argument (PREPARE)
10133 zero, which prevents insert_1_both from calling
10134 prepare_to_modify_buffer, which in turns prevents us from
10135 incrementing windows_or_buffers_changed even if *Messages* is
10136 shown in some window. So we must manually set
10137 windows_or_buffers_changed here to make up for that. */
10138 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10139 bset_redisplay (current_buffer
);
10141 set_buffer_internal (oldbuf
);
10143 message_log_need_newline
= !nlflag
;
10144 Vdeactivate_mark
= old_deactivate_mark
;
10149 /* We are at the end of the buffer after just having inserted a newline.
10150 (Note: We depend on the fact we won't be crossing the gap.)
10151 Check to see if the most recent message looks a lot like the previous one.
10152 Return 0 if different, 1 if the new one should just replace it, or a
10153 value N > 1 if we should also append " [N times]". */
10156 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10159 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10161 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10162 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10164 for (i
= 0; i
< len
; i
++)
10166 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10168 if (p1
[i
] != p2
[i
])
10174 if (*p1
++ == ' ' && *p1
++ == '[')
10177 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10178 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10185 /* Display an echo area message M with a specified length of NBYTES
10186 bytes. The string may include null characters. If M is not a
10187 string, clear out any existing message, and let the mini-buffer
10190 This function cancels echoing. */
10193 message3 (Lisp_Object m
)
10195 struct gcpro gcpro1
;
10198 clear_message (true, true);
10201 /* First flush out any partial line written with print. */
10202 message_log_maybe_newline ();
10205 ptrdiff_t nbytes
= SBYTES (m
);
10206 bool multibyte
= STRING_MULTIBYTE (m
);
10208 char *buffer
= SAFE_ALLOCA (nbytes
);
10209 memcpy (buffer
, SDATA (m
), nbytes
);
10210 message_dolog (buffer
, nbytes
, 1, multibyte
);
10213 message3_nolog (m
);
10219 /* The non-logging version of message3.
10220 This does not cancel echoing, because it is used for echoing.
10221 Perhaps we need to make a separate function for echoing
10222 and make this cancel echoing. */
10225 message3_nolog (Lisp_Object m
)
10227 struct frame
*sf
= SELECTED_FRAME ();
10229 if (FRAME_INITIAL_P (sf
))
10231 if (noninteractive_need_newline
)
10232 putc ('\n', stderr
);
10233 noninteractive_need_newline
= 0;
10236 Lisp_Object s
= ENCODE_SYSTEM (m
);
10238 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10240 if (cursor_in_echo_area
== 0)
10241 fprintf (stderr
, "\n");
10244 /* Error messages get reported properly by cmd_error, so this must be just an
10245 informative message; if the frame hasn't really been initialized yet, just
10247 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10249 /* Get the frame containing the mini-buffer
10250 that the selected frame is using. */
10251 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10252 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10253 struct frame
*f
= XFRAME (frame
);
10255 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10256 Fmake_frame_visible (frame
);
10258 if (STRINGP (m
) && SCHARS (m
) > 0)
10261 if (minibuffer_auto_raise
)
10262 Fraise_frame (frame
);
10263 /* Assume we are not echoing.
10264 (If we are, echo_now will override this.) */
10265 echo_message_buffer
= Qnil
;
10268 clear_message (true, true);
10270 do_pending_window_change (0);
10271 echo_area_display (1);
10272 do_pending_window_change (0);
10273 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10274 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10279 /* Display a null-terminated echo area message M. If M is 0, clear
10280 out any existing message, and let the mini-buffer text show through.
10282 The buffer M must continue to exist until after the echo area gets
10283 cleared or some other message gets displayed there. Do not pass
10284 text that is stored in a Lisp string. Do not pass text in a buffer
10285 that was alloca'd. */
10288 message1 (const char *m
)
10290 message3 (m
? build_unibyte_string (m
) : Qnil
);
10294 /* The non-logging counterpart of message1. */
10297 message1_nolog (const char *m
)
10299 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10302 /* Display a message M which contains a single %s
10303 which gets replaced with STRING. */
10306 message_with_string (const char *m
, Lisp_Object string
, int log
)
10308 CHECK_STRING (string
);
10310 if (noninteractive
)
10314 /* ENCODE_SYSTEM below can GC and/or relocate the Lisp
10315 String whose data pointer might be passed to us in M. So
10316 we use a local copy. */
10317 char *fmt
= xstrdup (m
);
10319 if (noninteractive_need_newline
)
10320 putc ('\n', stderr
);
10321 noninteractive_need_newline
= 0;
10322 fprintf (stderr
, fmt
, SDATA (ENCODE_SYSTEM (string
)));
10323 if (!cursor_in_echo_area
)
10324 fprintf (stderr
, "\n");
10329 else if (INTERACTIVE
)
10331 /* The frame whose minibuffer we're going to display the message on.
10332 It may be larger than the selected frame, so we need
10333 to use its buffer, not the selected frame's buffer. */
10334 Lisp_Object mini_window
;
10335 struct frame
*f
, *sf
= SELECTED_FRAME ();
10337 /* Get the frame containing the minibuffer
10338 that the selected frame is using. */
10339 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10340 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10342 /* Error messages get reported properly by cmd_error, so this must be
10343 just an informative message; if the frame hasn't really been
10344 initialized yet, just toss it. */
10345 if (f
->glyphs_initialized_p
)
10347 Lisp_Object args
[2], msg
;
10348 struct gcpro gcpro1
, gcpro2
;
10350 args
[0] = build_string (m
);
10351 args
[1] = msg
= string
;
10352 GCPRO2 (args
[0], msg
);
10355 msg
= Fformat (2, args
);
10360 message3_nolog (msg
);
10364 /* Print should start at the beginning of the message
10365 buffer next time. */
10366 message_buf_print
= 0;
10372 /* Dump an informative message to the minibuf. If M is 0, clear out
10373 any existing message, and let the mini-buffer text show through. */
10376 vmessage (const char *m
, va_list ap
)
10378 if (noninteractive
)
10382 if (noninteractive_need_newline
)
10383 putc ('\n', stderr
);
10384 noninteractive_need_newline
= 0;
10385 vfprintf (stderr
, m
, ap
);
10386 if (cursor_in_echo_area
== 0)
10387 fprintf (stderr
, "\n");
10391 else if (INTERACTIVE
)
10393 /* The frame whose mini-buffer we're going to display the message
10394 on. It may be larger than the selected frame, so we need to
10395 use its buffer, not the selected frame's buffer. */
10396 Lisp_Object mini_window
;
10397 struct frame
*f
, *sf
= SELECTED_FRAME ();
10399 /* Get the frame containing the mini-buffer
10400 that the selected frame is using. */
10401 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10402 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10404 /* Error messages get reported properly by cmd_error, so this must be
10405 just an informative message; if the frame hasn't really been
10406 initialized yet, just toss it. */
10407 if (f
->glyphs_initialized_p
)
10412 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10413 char *message_buf
= alloca (maxsize
+ 1);
10415 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10417 message3 (make_string (message_buf
, len
));
10422 /* Print should start at the beginning of the message
10423 buffer next time. */
10424 message_buf_print
= 0;
10430 message (const char *m
, ...)
10440 /* The non-logging version of message. */
10443 message_nolog (const char *m
, ...)
10445 Lisp_Object old_log_max
;
10448 old_log_max
= Vmessage_log_max
;
10449 Vmessage_log_max
= Qnil
;
10451 Vmessage_log_max
= old_log_max
;
10457 /* Display the current message in the current mini-buffer. This is
10458 only called from error handlers in process.c, and is not time
10462 update_echo_area (void)
10464 if (!NILP (echo_area_buffer
[0]))
10466 Lisp_Object string
;
10467 string
= Fcurrent_message ();
10473 /* Make sure echo area buffers in `echo_buffers' are live.
10474 If they aren't, make new ones. */
10477 ensure_echo_area_buffers (void)
10481 for (i
= 0; i
< 2; ++i
)
10482 if (!BUFFERP (echo_buffer
[i
])
10483 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10486 Lisp_Object old_buffer
;
10489 old_buffer
= echo_buffer
[i
];
10490 echo_buffer
[i
] = Fget_buffer_create
10491 (make_formatted_string (name
, " *Echo Area %d*", i
));
10492 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10493 /* to force word wrap in echo area -
10494 it was decided to postpone this*/
10495 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10497 for (j
= 0; j
< 2; ++j
)
10498 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10499 echo_area_buffer
[j
] = echo_buffer
[i
];
10504 /* Call FN with args A1..A2 with either the current or last displayed
10505 echo_area_buffer as current buffer.
10507 WHICH zero means use the current message buffer
10508 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10509 from echo_buffer[] and clear it.
10511 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10512 suitable buffer from echo_buffer[] and clear it.
10514 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10515 that the current message becomes the last displayed one, make
10516 choose a suitable buffer for echo_area_buffer[0], and clear it.
10518 Value is what FN returns. */
10521 with_echo_area_buffer (struct window
*w
, int which
,
10522 int (*fn
) (ptrdiff_t, Lisp_Object
),
10523 ptrdiff_t a1
, Lisp_Object a2
)
10525 Lisp_Object buffer
;
10526 int this_one
, the_other
, clear_buffer_p
, rc
;
10527 ptrdiff_t count
= SPECPDL_INDEX ();
10529 /* If buffers aren't live, make new ones. */
10530 ensure_echo_area_buffers ();
10532 clear_buffer_p
= 0;
10535 this_one
= 0, the_other
= 1;
10536 else if (which
> 0)
10537 this_one
= 1, the_other
= 0;
10540 this_one
= 0, the_other
= 1;
10541 clear_buffer_p
= true;
10543 /* We need a fresh one in case the current echo buffer equals
10544 the one containing the last displayed echo area message. */
10545 if (!NILP (echo_area_buffer
[this_one
])
10546 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10547 echo_area_buffer
[this_one
] = Qnil
;
10550 /* Choose a suitable buffer from echo_buffer[] is we don't
10552 if (NILP (echo_area_buffer
[this_one
]))
10554 echo_area_buffer
[this_one
]
10555 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10556 ? echo_buffer
[the_other
]
10557 : echo_buffer
[this_one
]);
10558 clear_buffer_p
= true;
10561 buffer
= echo_area_buffer
[this_one
];
10563 /* Don't get confused by reusing the buffer used for echoing
10564 for a different purpose. */
10565 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10568 record_unwind_protect (unwind_with_echo_area_buffer
,
10569 with_echo_area_buffer_unwind_data (w
));
10571 /* Make the echo area buffer current. Note that for display
10572 purposes, it is not necessary that the displayed window's buffer
10573 == current_buffer, except for text property lookup. So, let's
10574 only set that buffer temporarily here without doing a full
10575 Fset_window_buffer. We must also change w->pointm, though,
10576 because otherwise an assertions in unshow_buffer fails, and Emacs
10578 set_buffer_internal_1 (XBUFFER (buffer
));
10581 wset_buffer (w
, buffer
);
10582 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10585 bset_undo_list (current_buffer
, Qt
);
10586 bset_read_only (current_buffer
, Qnil
);
10587 specbind (Qinhibit_read_only
, Qt
);
10588 specbind (Qinhibit_modification_hooks
, Qt
);
10590 if (clear_buffer_p
&& Z
> BEG
)
10591 del_range (BEG
, Z
);
10593 eassert (BEGV
>= BEG
);
10594 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10598 eassert (BEGV
>= BEG
);
10599 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10601 unbind_to (count
, Qnil
);
10606 /* Save state that should be preserved around the call to the function
10607 FN called in with_echo_area_buffer. */
10610 with_echo_area_buffer_unwind_data (struct window
*w
)
10613 Lisp_Object vector
, tmp
;
10615 /* Reduce consing by keeping one vector in
10616 Vwith_echo_area_save_vector. */
10617 vector
= Vwith_echo_area_save_vector
;
10618 Vwith_echo_area_save_vector
= Qnil
;
10621 vector
= Fmake_vector (make_number (9), Qnil
);
10623 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10624 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10625 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10629 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10630 ASET (vector
, i
, w
->contents
); ++i
;
10631 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10632 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10633 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10634 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10639 for (; i
< end
; ++i
)
10640 ASET (vector
, i
, Qnil
);
10643 eassert (i
== ASIZE (vector
));
10648 /* Restore global state from VECTOR which was created by
10649 with_echo_area_buffer_unwind_data. */
10652 unwind_with_echo_area_buffer (Lisp_Object vector
)
10654 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10655 Vdeactivate_mark
= AREF (vector
, 1);
10656 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10658 if (WINDOWP (AREF (vector
, 3)))
10661 Lisp_Object buffer
;
10663 w
= XWINDOW (AREF (vector
, 3));
10664 buffer
= AREF (vector
, 4);
10666 wset_buffer (w
, buffer
);
10667 set_marker_both (w
->pointm
, buffer
,
10668 XFASTINT (AREF (vector
, 5)),
10669 XFASTINT (AREF (vector
, 6)));
10670 set_marker_both (w
->start
, buffer
,
10671 XFASTINT (AREF (vector
, 7)),
10672 XFASTINT (AREF (vector
, 8)));
10675 Vwith_echo_area_save_vector
= vector
;
10679 /* Set up the echo area for use by print functions. MULTIBYTE_P
10680 non-zero means we will print multibyte. */
10683 setup_echo_area_for_printing (int multibyte_p
)
10685 /* If we can't find an echo area any more, exit. */
10686 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10687 Fkill_emacs (Qnil
);
10689 ensure_echo_area_buffers ();
10691 if (!message_buf_print
)
10693 /* A message has been output since the last time we printed.
10694 Choose a fresh echo area buffer. */
10695 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10696 echo_area_buffer
[0] = echo_buffer
[1];
10698 echo_area_buffer
[0] = echo_buffer
[0];
10700 /* Switch to that buffer and clear it. */
10701 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10702 bset_truncate_lines (current_buffer
, Qnil
);
10706 ptrdiff_t count
= SPECPDL_INDEX ();
10707 specbind (Qinhibit_read_only
, Qt
);
10708 /* Note that undo recording is always disabled. */
10709 del_range (BEG
, Z
);
10710 unbind_to (count
, Qnil
);
10712 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10714 /* Set up the buffer for the multibyteness we need. */
10716 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10717 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10719 /* Raise the frame containing the echo area. */
10720 if (minibuffer_auto_raise
)
10722 struct frame
*sf
= SELECTED_FRAME ();
10723 Lisp_Object mini_window
;
10724 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10725 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10728 message_log_maybe_newline ();
10729 message_buf_print
= 1;
10733 if (NILP (echo_area_buffer
[0]))
10735 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10736 echo_area_buffer
[0] = echo_buffer
[1];
10738 echo_area_buffer
[0] = echo_buffer
[0];
10741 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10743 /* Someone switched buffers between print requests. */
10744 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10745 bset_truncate_lines (current_buffer
, Qnil
);
10751 /* Display an echo area message in window W. Value is non-zero if W's
10752 height is changed. If display_last_displayed_message_p is
10753 non-zero, display the message that was last displayed, otherwise
10754 display the current message. */
10757 display_echo_area (struct window
*w
)
10759 int i
, no_message_p
, window_height_changed_p
;
10761 /* Temporarily disable garbage collections while displaying the echo
10762 area. This is done because a GC can print a message itself.
10763 That message would modify the echo area buffer's contents while a
10764 redisplay of the buffer is going on, and seriously confuse
10766 ptrdiff_t count
= inhibit_garbage_collection ();
10768 /* If there is no message, we must call display_echo_area_1
10769 nevertheless because it resizes the window. But we will have to
10770 reset the echo_area_buffer in question to nil at the end because
10771 with_echo_area_buffer will sets it to an empty buffer. */
10772 i
= display_last_displayed_message_p
? 1 : 0;
10773 no_message_p
= NILP (echo_area_buffer
[i
]);
10775 window_height_changed_p
10776 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10777 display_echo_area_1
,
10778 (intptr_t) w
, Qnil
);
10781 echo_area_buffer
[i
] = Qnil
;
10783 unbind_to (count
, Qnil
);
10784 return window_height_changed_p
;
10788 /* Helper for display_echo_area. Display the current buffer which
10789 contains the current echo area message in window W, a mini-window,
10790 a pointer to which is passed in A1. A2..A4 are currently not used.
10791 Change the height of W so that all of the message is displayed.
10792 Value is non-zero if height of W was changed. */
10795 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10798 struct window
*w
= (struct window
*) i1
;
10799 Lisp_Object window
;
10800 struct text_pos start
;
10801 int window_height_changed_p
= 0;
10803 /* Do this before displaying, so that we have a large enough glyph
10804 matrix for the display. If we can't get enough space for the
10805 whole text, display the last N lines. That works by setting w->start. */
10806 window_height_changed_p
= resize_mini_window (w
, 0);
10808 /* Use the starting position chosen by resize_mini_window. */
10809 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10812 clear_glyph_matrix (w
->desired_matrix
);
10813 XSETWINDOW (window
, w
);
10814 try_window (window
, start
, 0);
10816 return window_height_changed_p
;
10820 /* Resize the echo area window to exactly the size needed for the
10821 currently displayed message, if there is one. If a mini-buffer
10822 is active, don't shrink it. */
10825 resize_echo_area_exactly (void)
10827 if (BUFFERP (echo_area_buffer
[0])
10828 && WINDOWP (echo_area_window
))
10830 struct window
*w
= XWINDOW (echo_area_window
);
10831 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10832 int resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10833 (intptr_t) w
, resize_exactly
);
10836 windows_or_buffers_changed
= 42;
10837 update_mode_lines
= 30;
10838 redisplay_internal ();
10844 /* Callback function for with_echo_area_buffer, when used from
10845 resize_echo_area_exactly. A1 contains a pointer to the window to
10846 resize, EXACTLY non-nil means resize the mini-window exactly to the
10847 size of the text displayed. A3 and A4 are not used. Value is what
10848 resize_mini_window returns. */
10851 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10854 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10858 /* Resize mini-window W to fit the size of its contents. EXACT_P
10859 means size the window exactly to the size needed. Otherwise, it's
10860 only enlarged until W's buffer is empty.
10862 Set W->start to the right place to begin display. If the whole
10863 contents fit, start at the beginning. Otherwise, start so as
10864 to make the end of the contents appear. This is particularly
10865 important for y-or-n-p, but seems desirable generally.
10867 Value is non-zero if the window height has been changed. */
10870 resize_mini_window (struct window
*w
, int exact_p
)
10872 struct frame
*f
= XFRAME (w
->frame
);
10873 int window_height_changed_p
= 0;
10875 eassert (MINI_WINDOW_P (w
));
10877 /* By default, start display at the beginning. */
10878 set_marker_both (w
->start
, w
->contents
,
10879 BUF_BEGV (XBUFFER (w
->contents
)),
10880 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10882 /* Don't resize windows while redisplaying a window; it would
10883 confuse redisplay functions when the size of the window they are
10884 displaying changes from under them. Such a resizing can happen,
10885 for instance, when which-func prints a long message while
10886 we are running fontification-functions. We're running these
10887 functions with safe_call which binds inhibit-redisplay to t. */
10888 if (!NILP (Vinhibit_redisplay
))
10891 /* Nil means don't try to resize. */
10892 if (NILP (Vresize_mini_windows
)
10893 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10896 if (!FRAME_MINIBUF_ONLY_P (f
))
10899 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10900 + WINDOW_PIXEL_HEIGHT (w
));
10901 int unit
= FRAME_LINE_HEIGHT (f
);
10902 int height
, max_height
;
10903 struct text_pos start
;
10904 struct buffer
*old_current_buffer
= NULL
;
10906 if (current_buffer
!= XBUFFER (w
->contents
))
10908 old_current_buffer
= current_buffer
;
10909 set_buffer_internal (XBUFFER (w
->contents
));
10912 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10914 /* Compute the max. number of lines specified by the user. */
10915 if (FLOATP (Vmax_mini_window_height
))
10916 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10917 else if (INTEGERP (Vmax_mini_window_height
))
10918 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10920 max_height
= total_height
/ 4;
10922 /* Correct that max. height if it's bogus. */
10923 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10925 /* Find out the height of the text in the window. */
10926 if (it
.line_wrap
== TRUNCATE
)
10931 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10932 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10933 height
= it
.current_y
+ last_height
;
10935 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10936 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10939 /* Compute a suitable window start. */
10940 if (height
> max_height
)
10942 height
= (max_height
/ unit
) * unit
;
10943 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10944 move_it_vertically_backward (&it
, height
- unit
);
10945 start
= it
.current
.pos
;
10948 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10949 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10951 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10953 /* Let it grow only, until we display an empty message, in which
10954 case the window shrinks again. */
10955 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10957 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10959 FRAME_WINDOWS_FROZEN (f
) = 1;
10960 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10961 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10963 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10964 && (exact_p
|| BEGV
== ZV
))
10966 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10968 FRAME_WINDOWS_FROZEN (f
) = 0;
10969 shrink_mini_window (w
, 1);
10970 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10975 /* Always resize to exact size needed. */
10976 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10978 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10980 FRAME_WINDOWS_FROZEN (f
) = 1;
10981 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10982 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10984 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10986 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10988 FRAME_WINDOWS_FROZEN (f
) = 0;
10989 shrink_mini_window (w
, 1);
10993 FRAME_WINDOWS_FROZEN (f
) = 1;
10994 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10997 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11001 if (old_current_buffer
)
11002 set_buffer_internal (old_current_buffer
);
11005 return window_height_changed_p
;
11009 /* Value is the current message, a string, or nil if there is no
11010 current message. */
11013 current_message (void)
11017 if (!BUFFERP (echo_area_buffer
[0]))
11021 with_echo_area_buffer (0, 0, current_message_1
,
11022 (intptr_t) &msg
, Qnil
);
11024 echo_area_buffer
[0] = Qnil
;
11032 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
11035 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
11038 *msg
= make_buffer_string (BEG
, Z
, 1);
11045 /* Push the current message on Vmessage_stack for later restoration
11046 by restore_message. Value is non-zero if the current message isn't
11047 empty. This is a relatively infrequent operation, so it's not
11048 worth optimizing. */
11051 push_message (void)
11053 Lisp_Object msg
= current_message ();
11054 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
11055 return STRINGP (msg
);
11059 /* Restore message display from the top of Vmessage_stack. */
11062 restore_message (void)
11064 eassert (CONSP (Vmessage_stack
));
11065 message3_nolog (XCAR (Vmessage_stack
));
11069 /* Handler for unwind-protect calling pop_message. */
11072 pop_message_unwind (void)
11074 /* Pop the top-most entry off Vmessage_stack. */
11075 eassert (CONSP (Vmessage_stack
));
11076 Vmessage_stack
= XCDR (Vmessage_stack
);
11080 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11081 exits. If the stack is not empty, we have a missing pop_message
11085 check_message_stack (void)
11087 if (!NILP (Vmessage_stack
))
11092 /* Truncate to NCHARS what will be displayed in the echo area the next
11093 time we display it---but don't redisplay it now. */
11096 truncate_echo_area (ptrdiff_t nchars
)
11099 echo_area_buffer
[0] = Qnil
;
11100 else if (!noninteractive
11102 && !NILP (echo_area_buffer
[0]))
11104 struct frame
*sf
= SELECTED_FRAME ();
11105 /* Error messages get reported properly by cmd_error, so this must be
11106 just an informative message; if the frame hasn't really been
11107 initialized yet, just toss it. */
11108 if (sf
->glyphs_initialized_p
)
11109 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11114 /* Helper function for truncate_echo_area. Truncate the current
11115 message to at most NCHARS characters. */
11118 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11120 if (BEG
+ nchars
< Z
)
11121 del_range (BEG
+ nchars
, Z
);
11123 echo_area_buffer
[0] = Qnil
;
11127 /* Set the current message to STRING. */
11130 set_message (Lisp_Object string
)
11132 eassert (STRINGP (string
));
11134 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11136 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11137 message_buf_print
= 0;
11138 help_echo_showing_p
= 0;
11140 if (STRINGP (Vdebug_on_message
)
11141 && STRINGP (string
)
11142 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11143 call_debugger (list2 (Qerror
, string
));
11147 /* Helper function for set_message. First argument is ignored and second
11148 argument has the same meaning as for set_message.
11149 This function is called with the echo area buffer being current. */
11152 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11154 eassert (STRINGP (string
));
11156 /* Change multibyteness of the echo buffer appropriately. */
11157 if (message_enable_multibyte
11158 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11159 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11161 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11162 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11163 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11165 /* Insert new message at BEG. */
11166 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11168 /* This function takes care of single/multibyte conversion.
11169 We just have to ensure that the echo area buffer has the right
11170 setting of enable_multibyte_characters. */
11171 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), 1);
11177 /* Clear messages. CURRENT_P non-zero means clear the current
11178 message. LAST_DISPLAYED_P non-zero means clear the message
11182 clear_message (bool current_p
, bool last_displayed_p
)
11186 echo_area_buffer
[0] = Qnil
;
11187 message_cleared_p
= true;
11190 if (last_displayed_p
)
11191 echo_area_buffer
[1] = Qnil
;
11193 message_buf_print
= 0;
11196 /* Clear garbaged frames.
11198 This function is used where the old redisplay called
11199 redraw_garbaged_frames which in turn called redraw_frame which in
11200 turn called clear_frame. The call to clear_frame was a source of
11201 flickering. I believe a clear_frame is not necessary. It should
11202 suffice in the new redisplay to invalidate all current matrices,
11203 and ensure a complete redisplay of all windows. */
11206 clear_garbaged_frames (void)
11208 if (frame_garbaged
)
11210 Lisp_Object tail
, frame
;
11212 FOR_EACH_FRAME (tail
, frame
)
11214 struct frame
*f
= XFRAME (frame
);
11216 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11221 clear_current_matrices (f
);
11222 fset_redisplay (f
);
11223 f
->garbaged
= false;
11224 f
->resized_p
= false;
11228 frame_garbaged
= false;
11233 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
11234 is non-zero update selected_frame. Value is non-zero if the
11235 mini-windows height has been changed. */
11238 echo_area_display (int update_frame_p
)
11240 Lisp_Object mini_window
;
11243 int window_height_changed_p
= 0;
11244 struct frame
*sf
= SELECTED_FRAME ();
11246 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11247 w
= XWINDOW (mini_window
);
11248 f
= XFRAME (WINDOW_FRAME (w
));
11250 /* Don't display if frame is invisible or not yet initialized. */
11251 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11254 #ifdef HAVE_WINDOW_SYSTEM
11255 /* When Emacs starts, selected_frame may be the initial terminal
11256 frame. If we let this through, a message would be displayed on
11258 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11260 #endif /* HAVE_WINDOW_SYSTEM */
11262 /* Redraw garbaged frames. */
11263 clear_garbaged_frames ();
11265 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11267 echo_area_window
= mini_window
;
11268 window_height_changed_p
= display_echo_area (w
);
11269 w
->must_be_updated_p
= true;
11271 /* Update the display, unless called from redisplay_internal.
11272 Also don't update the screen during redisplay itself. The
11273 update will happen at the end of redisplay, and an update
11274 here could cause confusion. */
11275 if (update_frame_p
&& !redisplaying_p
)
11279 /* If the display update has been interrupted by pending
11280 input, update mode lines in the frame. Due to the
11281 pending input, it might have been that redisplay hasn't
11282 been called, so that mode lines above the echo area are
11283 garbaged. This looks odd, so we prevent it here. */
11284 if (!display_completed
)
11285 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11287 if (window_height_changed_p
11288 /* Don't do this if Emacs is shutting down. Redisplay
11289 needs to run hooks. */
11290 && !NILP (Vrun_hooks
))
11292 /* Must update other windows. Likewise as in other
11293 cases, don't let this update be interrupted by
11295 ptrdiff_t count
= SPECPDL_INDEX ();
11296 specbind (Qredisplay_dont_pause
, Qt
);
11297 windows_or_buffers_changed
= 44;
11298 redisplay_internal ();
11299 unbind_to (count
, Qnil
);
11301 else if (FRAME_WINDOW_P (f
) && n
== 0)
11303 /* Window configuration is the same as before.
11304 Can do with a display update of the echo area,
11305 unless we displayed some mode lines. */
11306 update_single_window (w
, 1);
11310 update_frame (f
, 1, 1);
11312 /* If cursor is in the echo area, make sure that the next
11313 redisplay displays the minibuffer, so that the cursor will
11314 be replaced with what the minibuffer wants. */
11315 if (cursor_in_echo_area
)
11316 wset_redisplay (XWINDOW (mini_window
));
11319 else if (!EQ (mini_window
, selected_window
))
11320 wset_redisplay (XWINDOW (mini_window
));
11322 /* Last displayed message is now the current message. */
11323 echo_area_buffer
[1] = echo_area_buffer
[0];
11324 /* Inform read_char that we're not echoing. */
11325 echo_message_buffer
= Qnil
;
11327 /* Prevent redisplay optimization in redisplay_internal by resetting
11328 this_line_start_pos. This is done because the mini-buffer now
11329 displays the message instead of its buffer text. */
11330 if (EQ (mini_window
, selected_window
))
11331 CHARPOS (this_line_start_pos
) = 0;
11333 return window_height_changed_p
;
11336 /* Nonzero if W's buffer was changed but not saved. */
11339 window_buffer_changed (struct window
*w
)
11341 struct buffer
*b
= XBUFFER (w
->contents
);
11343 eassert (BUFFER_LIVE_P (b
));
11345 return (((BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
));
11348 /* Nonzero if W has %c in its mode line and mode line should be updated. */
11351 mode_line_update_needed (struct window
*w
)
11353 return (w
->column_number_displayed
!= -1
11354 && !(PT
== w
->last_point
&& !window_outdated (w
))
11355 && (w
->column_number_displayed
!= current_column ()));
11358 /* Nonzero if window start of W is frozen and may not be changed during
11362 window_frozen_p (struct window
*w
)
11364 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11366 Lisp_Object window
;
11368 XSETWINDOW (window
, w
);
11369 if (MINI_WINDOW_P (w
))
11371 else if (EQ (window
, selected_window
))
11373 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11374 && EQ (window
, Vminibuf_scroll_window
))
11375 /* This special window can't be frozen too. */
11383 /***********************************************************************
11384 Mode Lines and Frame Titles
11385 ***********************************************************************/
11387 /* A buffer for constructing non-propertized mode-line strings and
11388 frame titles in it; allocated from the heap in init_xdisp and
11389 resized as needed in store_mode_line_noprop_char. */
11391 static char *mode_line_noprop_buf
;
11393 /* The buffer's end, and a current output position in it. */
11395 static char *mode_line_noprop_buf_end
;
11396 static char *mode_line_noprop_ptr
;
11398 #define MODE_LINE_NOPROP_LEN(start) \
11399 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11402 MODE_LINE_DISPLAY
= 0,
11406 } mode_line_target
;
11408 /* Alist that caches the results of :propertize.
11409 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11410 static Lisp_Object mode_line_proptrans_alist
;
11412 /* List of strings making up the mode-line. */
11413 static Lisp_Object mode_line_string_list
;
11415 /* Base face property when building propertized mode line string. */
11416 static Lisp_Object mode_line_string_face
;
11417 static Lisp_Object mode_line_string_face_prop
;
11420 /* Unwind data for mode line strings */
11422 static Lisp_Object Vmode_line_unwind_vector
;
11425 format_mode_line_unwind_data (struct frame
*target_frame
,
11426 struct buffer
*obuf
,
11428 int save_proptrans
)
11430 Lisp_Object vector
, tmp
;
11432 /* Reduce consing by keeping one vector in
11433 Vwith_echo_area_save_vector. */
11434 vector
= Vmode_line_unwind_vector
;
11435 Vmode_line_unwind_vector
= Qnil
;
11438 vector
= Fmake_vector (make_number (10), Qnil
);
11440 ASET (vector
, 0, make_number (mode_line_target
));
11441 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11442 ASET (vector
, 2, mode_line_string_list
);
11443 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11444 ASET (vector
, 4, mode_line_string_face
);
11445 ASET (vector
, 5, mode_line_string_face_prop
);
11448 XSETBUFFER (tmp
, obuf
);
11451 ASET (vector
, 6, tmp
);
11452 ASET (vector
, 7, owin
);
11455 /* Similarly to `with-selected-window', if the operation selects
11456 a window on another frame, we must restore that frame's
11457 selected window, and (for a tty) the top-frame. */
11458 ASET (vector
, 8, target_frame
->selected_window
);
11459 if (FRAME_TERMCAP_P (target_frame
))
11460 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11467 unwind_format_mode_line (Lisp_Object vector
)
11469 Lisp_Object old_window
= AREF (vector
, 7);
11470 Lisp_Object target_frame_window
= AREF (vector
, 8);
11471 Lisp_Object old_top_frame
= AREF (vector
, 9);
11473 mode_line_target
= XINT (AREF (vector
, 0));
11474 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11475 mode_line_string_list
= AREF (vector
, 2);
11476 if (! EQ (AREF (vector
, 3), Qt
))
11477 mode_line_proptrans_alist
= AREF (vector
, 3);
11478 mode_line_string_face
= AREF (vector
, 4);
11479 mode_line_string_face_prop
= AREF (vector
, 5);
11481 /* Select window before buffer, since it may change the buffer. */
11482 if (!NILP (old_window
))
11484 /* If the operation that we are unwinding had selected a window
11485 on a different frame, reset its frame-selected-window. For a
11486 text terminal, reset its top-frame if necessary. */
11487 if (!NILP (target_frame_window
))
11490 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11492 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11493 Fselect_window (target_frame_window
, Qt
);
11495 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11496 Fselect_frame (old_top_frame
, Qt
);
11499 Fselect_window (old_window
, Qt
);
11502 if (!NILP (AREF (vector
, 6)))
11504 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11505 ASET (vector
, 6, Qnil
);
11508 Vmode_line_unwind_vector
= vector
;
11512 /* Store a single character C for the frame title in mode_line_noprop_buf.
11513 Re-allocate mode_line_noprop_buf if necessary. */
11516 store_mode_line_noprop_char (char c
)
11518 /* If output position has reached the end of the allocated buffer,
11519 increase the buffer's size. */
11520 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11522 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11523 ptrdiff_t size
= len
;
11524 mode_line_noprop_buf
=
11525 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11526 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11527 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11530 *mode_line_noprop_ptr
++ = c
;
11534 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11535 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11536 characters that yield more columns than PRECISION; PRECISION <= 0
11537 means copy the whole string. Pad with spaces until FIELD_WIDTH
11538 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11539 pad. Called from display_mode_element when it is used to build a
11543 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11545 const unsigned char *str
= (const unsigned char *) string
;
11547 ptrdiff_t dummy
, nbytes
;
11549 /* Copy at most PRECISION chars from STR. */
11550 nbytes
= strlen (string
);
11551 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11553 store_mode_line_noprop_char (*str
++);
11555 /* Fill up with spaces until FIELD_WIDTH reached. */
11556 while (field_width
> 0
11557 && n
< field_width
)
11559 store_mode_line_noprop_char (' ');
11566 /***********************************************************************
11568 ***********************************************************************/
11570 #ifdef HAVE_WINDOW_SYSTEM
11572 /* Set the title of FRAME, if it has changed. The title format is
11573 Vicon_title_format if FRAME is iconified, otherwise it is
11574 frame_title_format. */
11577 x_consider_frame_title (Lisp_Object frame
)
11579 struct frame
*f
= XFRAME (frame
);
11581 if (FRAME_WINDOW_P (f
)
11582 || FRAME_MINIBUF_ONLY_P (f
)
11583 || f
->explicit_name
)
11585 /* Do we have more than one visible frame on this X display? */
11586 Lisp_Object tail
, other_frame
, fmt
;
11587 ptrdiff_t title_start
;
11591 ptrdiff_t count
= SPECPDL_INDEX ();
11593 FOR_EACH_FRAME (tail
, other_frame
)
11595 struct frame
*tf
= XFRAME (other_frame
);
11598 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11599 && !FRAME_MINIBUF_ONLY_P (tf
)
11600 && !EQ (other_frame
, tip_frame
)
11601 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11605 /* Set global variable indicating that multiple frames exist. */
11606 multiple_frames
= CONSP (tail
);
11608 /* Switch to the buffer of selected window of the frame. Set up
11609 mode_line_target so that display_mode_element will output into
11610 mode_line_noprop_buf; then display the title. */
11611 record_unwind_protect (unwind_format_mode_line
,
11612 format_mode_line_unwind_data
11613 (f
, current_buffer
, selected_window
, 0));
11615 Fselect_window (f
->selected_window
, Qt
);
11616 set_buffer_internal_1
11617 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11618 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11620 mode_line_target
= MODE_LINE_TITLE
;
11621 title_start
= MODE_LINE_NOPROP_LEN (0);
11622 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11623 NULL
, DEFAULT_FACE_ID
);
11624 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11625 len
= MODE_LINE_NOPROP_LEN (title_start
);
11626 title
= mode_line_noprop_buf
+ title_start
;
11627 unbind_to (count
, Qnil
);
11629 /* Set the title only if it's changed. This avoids consing in
11630 the common case where it hasn't. (If it turns out that we've
11631 already wasted too much time by walking through the list with
11632 display_mode_element, then we might need to optimize at a
11633 higher level than this.) */
11634 if (! STRINGP (f
->name
)
11635 || SBYTES (f
->name
) != len
11636 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11637 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11641 #endif /* not HAVE_WINDOW_SYSTEM */
11644 /***********************************************************************
11646 ***********************************************************************/
11648 /* Non-zero if we will not redisplay all visible windows. */
11649 #define REDISPLAY_SOME_P() \
11650 ((windows_or_buffers_changed == 0 \
11651 || windows_or_buffers_changed == REDISPLAY_SOME) \
11652 && (update_mode_lines == 0 \
11653 || update_mode_lines == REDISPLAY_SOME))
11655 /* Prepare for redisplay by updating menu-bar item lists when
11656 appropriate. This can call eval. */
11659 prepare_menu_bars (void)
11661 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11662 bool some_windows
= REDISPLAY_SOME_P ();
11663 struct gcpro gcpro1
, gcpro2
;
11664 Lisp_Object tooltip_frame
;
11666 #ifdef HAVE_WINDOW_SYSTEM
11667 tooltip_frame
= tip_frame
;
11669 tooltip_frame
= Qnil
;
11672 if (FUNCTIONP (Vpre_redisplay_function
))
11674 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11675 if (all_windows
&& some_windows
)
11677 Lisp_Object ws
= window_list ();
11678 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11680 Lisp_Object
this = XCAR (ws
);
11681 struct window
*w
= XWINDOW (this);
11683 || XFRAME (w
->frame
)->redisplay
11684 || XBUFFER (w
->contents
)->text
->redisplay
)
11686 windows
= Fcons (this, windows
);
11690 safe__call1 (true, Vpre_redisplay_function
, windows
);
11693 /* Update all frame titles based on their buffer names, etc. We do
11694 this before the menu bars so that the buffer-menu will show the
11695 up-to-date frame titles. */
11696 #ifdef HAVE_WINDOW_SYSTEM
11699 Lisp_Object tail
, frame
;
11701 FOR_EACH_FRAME (tail
, frame
)
11703 struct frame
*f
= XFRAME (frame
);
11704 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11708 && !XBUFFER (w
->contents
)->text
->redisplay
)
11711 if (!EQ (frame
, tooltip_frame
)
11712 && (FRAME_ICONIFIED_P (f
)
11713 || FRAME_VISIBLE_P (f
) == 1
11714 /* Exclude TTY frames that are obscured because they
11715 are not the top frame on their console. This is
11716 because x_consider_frame_title actually switches
11717 to the frame, which for TTY frames means it is
11718 marked as garbaged, and will be completely
11719 redrawn on the next redisplay cycle. This causes
11720 TTY frames to be completely redrawn, when there
11721 are more than one of them, even though nothing
11722 should be changed on display. */
11723 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11724 x_consider_frame_title (frame
);
11727 #endif /* HAVE_WINDOW_SYSTEM */
11729 /* Update the menu bar item lists, if appropriate. This has to be
11730 done before any actual redisplay or generation of display lines. */
11734 Lisp_Object tail
, frame
;
11735 ptrdiff_t count
= SPECPDL_INDEX ();
11736 /* 1 means that update_menu_bar has run its hooks
11737 so any further calls to update_menu_bar shouldn't do so again. */
11738 int menu_bar_hooks_run
= 0;
11740 record_unwind_save_match_data ();
11742 FOR_EACH_FRAME (tail
, frame
)
11744 struct frame
*f
= XFRAME (frame
);
11745 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11747 /* Ignore tooltip frame. */
11748 if (EQ (frame
, tooltip_frame
))
11754 && !XBUFFER (w
->contents
)->text
->redisplay
)
11757 /* If a window on this frame changed size, report that to
11758 the user and clear the size-change flag. */
11759 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11761 Lisp_Object functions
;
11763 /* Clear flag first in case we get an error below. */
11764 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11765 functions
= Vwindow_size_change_functions
;
11766 GCPRO2 (tail
, functions
);
11768 while (CONSP (functions
))
11770 if (!EQ (XCAR (functions
), Qt
))
11771 call1 (XCAR (functions
), frame
);
11772 functions
= XCDR (functions
);
11778 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11779 #ifdef HAVE_WINDOW_SYSTEM
11780 update_tool_bar (f
, 0);
11783 if (windows_or_buffers_changed
11786 (f
, Fbuffer_modified_p (XWINDOW (f
->selected_window
)->contents
));
11791 unbind_to (count
, Qnil
);
11795 struct frame
*sf
= SELECTED_FRAME ();
11796 update_menu_bar (sf
, 1, 0);
11797 #ifdef HAVE_WINDOW_SYSTEM
11798 update_tool_bar (sf
, 1);
11804 /* Update the menu bar item list for frame F. This has to be done
11805 before we start to fill in any display lines, because it can call
11808 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11810 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11811 already ran the menu bar hooks for this redisplay, so there
11812 is no need to run them again. The return value is the
11813 updated value of this flag, to pass to the next call. */
11816 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11818 Lisp_Object window
;
11819 register struct window
*w
;
11821 /* If called recursively during a menu update, do nothing. This can
11822 happen when, for instance, an activate-menubar-hook causes a
11824 if (inhibit_menubar_update
)
11827 window
= FRAME_SELECTED_WINDOW (f
);
11828 w
= XWINDOW (window
);
11830 if (FRAME_WINDOW_P (f
)
11832 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11833 || defined (HAVE_NS) || defined (USE_GTK)
11834 FRAME_EXTERNAL_MENU_BAR (f
)
11836 FRAME_MENU_BAR_LINES (f
) > 0
11838 : FRAME_MENU_BAR_LINES (f
) > 0)
11840 /* If the user has switched buffers or windows, we need to
11841 recompute to reflect the new bindings. But we'll
11842 recompute when update_mode_lines is set too; that means
11843 that people can use force-mode-line-update to request
11844 that the menu bar be recomputed. The adverse effect on
11845 the rest of the redisplay algorithm is about the same as
11846 windows_or_buffers_changed anyway. */
11847 if (windows_or_buffers_changed
11848 /* This used to test w->update_mode_line, but we believe
11849 there is no need to recompute the menu in that case. */
11850 || update_mode_lines
11851 || window_buffer_changed (w
))
11853 struct buffer
*prev
= current_buffer
;
11854 ptrdiff_t count
= SPECPDL_INDEX ();
11856 specbind (Qinhibit_menubar_update
, Qt
);
11858 set_buffer_internal_1 (XBUFFER (w
->contents
));
11859 if (save_match_data
)
11860 record_unwind_save_match_data ();
11861 if (NILP (Voverriding_local_map_menu_flag
))
11863 specbind (Qoverriding_terminal_local_map
, Qnil
);
11864 specbind (Qoverriding_local_map
, Qnil
);
11869 /* Run the Lucid hook. */
11870 safe_run_hooks (Qactivate_menubar_hook
);
11872 /* If it has changed current-menubar from previous value,
11873 really recompute the menu-bar from the value. */
11874 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11875 call0 (Qrecompute_lucid_menubar
);
11877 safe_run_hooks (Qmenu_bar_update_hook
);
11882 XSETFRAME (Vmenu_updating_frame
, f
);
11883 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11885 /* Redisplay the menu bar in case we changed it. */
11886 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11887 || defined (HAVE_NS) || defined (USE_GTK)
11888 if (FRAME_WINDOW_P (f
))
11890 #if defined (HAVE_NS)
11891 /* All frames on Mac OS share the same menubar. So only
11892 the selected frame should be allowed to set it. */
11893 if (f
== SELECTED_FRAME ())
11895 set_frame_menubar (f
, 0, 0);
11898 /* On a terminal screen, the menu bar is an ordinary screen
11899 line, and this makes it get updated. */
11900 w
->update_mode_line
= 1;
11901 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11902 /* In the non-toolkit version, the menu bar is an ordinary screen
11903 line, and this makes it get updated. */
11904 w
->update_mode_line
= 1;
11905 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11907 unbind_to (count
, Qnil
);
11908 set_buffer_internal_1 (prev
);
11915 /***********************************************************************
11917 ***********************************************************************/
11919 #ifdef HAVE_WINDOW_SYSTEM
11921 /* Tool-bar item index of the item on which a mouse button was pressed
11924 int last_tool_bar_item
;
11926 /* Select `frame' temporarily without running all the code in
11928 FIXME: Maybe do_switch_frame should be trimmed down similarly
11929 when `norecord' is set. */
11931 fast_set_selected_frame (Lisp_Object frame
)
11933 if (!EQ (selected_frame
, frame
))
11935 selected_frame
= frame
;
11936 selected_window
= XFRAME (frame
)->selected_window
;
11940 /* Update the tool-bar item list for frame F. This has to be done
11941 before we start to fill in any display lines. Called from
11942 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11943 and restore it here. */
11946 update_tool_bar (struct frame
*f
, int save_match_data
)
11948 #if defined (USE_GTK) || defined (HAVE_NS)
11949 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11951 int do_update
= (WINDOWP (f
->tool_bar_window
)
11952 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0);
11957 Lisp_Object window
;
11960 window
= FRAME_SELECTED_WINDOW (f
);
11961 w
= XWINDOW (window
);
11963 /* If the user has switched buffers or windows, we need to
11964 recompute to reflect the new bindings. But we'll
11965 recompute when update_mode_lines is set too; that means
11966 that people can use force-mode-line-update to request
11967 that the menu bar be recomputed. The adverse effect on
11968 the rest of the redisplay algorithm is about the same as
11969 windows_or_buffers_changed anyway. */
11970 if (windows_or_buffers_changed
11971 || w
->update_mode_line
11972 || update_mode_lines
11973 || window_buffer_changed (w
))
11975 struct buffer
*prev
= current_buffer
;
11976 ptrdiff_t count
= SPECPDL_INDEX ();
11977 Lisp_Object frame
, new_tool_bar
;
11978 int new_n_tool_bar
;
11979 struct gcpro gcpro1
;
11981 /* Set current_buffer to the buffer of the selected
11982 window of the frame, so that we get the right local
11984 set_buffer_internal_1 (XBUFFER (w
->contents
));
11986 /* Save match data, if we must. */
11987 if (save_match_data
)
11988 record_unwind_save_match_data ();
11990 /* Make sure that we don't accidentally use bogus keymaps. */
11991 if (NILP (Voverriding_local_map_menu_flag
))
11993 specbind (Qoverriding_terminal_local_map
, Qnil
);
11994 specbind (Qoverriding_local_map
, Qnil
);
11997 GCPRO1 (new_tool_bar
);
11999 /* We must temporarily set the selected frame to this frame
12000 before calling tool_bar_items, because the calculation of
12001 the tool-bar keymap uses the selected frame (see
12002 `tool-bar-make-keymap' in tool-bar.el). */
12003 eassert (EQ (selected_window
,
12004 /* Since we only explicitly preserve selected_frame,
12005 check that selected_window would be redundant. */
12006 XFRAME (selected_frame
)->selected_window
));
12007 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
12008 XSETFRAME (frame
, f
);
12009 fast_set_selected_frame (frame
);
12011 /* Build desired tool-bar items from keymaps. */
12013 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
12016 /* Redisplay the tool-bar if we changed it. */
12017 if (new_n_tool_bar
!= f
->n_tool_bar_items
12018 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
12020 /* Redisplay that happens asynchronously due to an expose event
12021 may access f->tool_bar_items. Make sure we update both
12022 variables within BLOCK_INPUT so no such event interrupts. */
12024 fset_tool_bar_items (f
, new_tool_bar
);
12025 f
->n_tool_bar_items
= new_n_tool_bar
;
12026 w
->update_mode_line
= 1;
12032 unbind_to (count
, Qnil
);
12033 set_buffer_internal_1 (prev
);
12038 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12040 /* Set F->desired_tool_bar_string to a Lisp string representing frame
12041 F's desired tool-bar contents. F->tool_bar_items must have
12042 been set up previously by calling prepare_menu_bars. */
12045 build_desired_tool_bar_string (struct frame
*f
)
12047 int i
, size
, size_needed
;
12048 struct gcpro gcpro1
, gcpro2
, gcpro3
;
12049 Lisp_Object image
, plist
, props
;
12051 image
= plist
= props
= Qnil
;
12052 GCPRO3 (image
, plist
, props
);
12054 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
12055 Otherwise, make a new string. */
12057 /* The size of the string we might be able to reuse. */
12058 size
= (STRINGP (f
->desired_tool_bar_string
)
12059 ? SCHARS (f
->desired_tool_bar_string
)
12062 /* We need one space in the string for each image. */
12063 size_needed
= f
->n_tool_bar_items
;
12065 /* Reuse f->desired_tool_bar_string, if possible. */
12066 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
12067 fset_desired_tool_bar_string
12068 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
12071 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
12072 Fremove_text_properties (make_number (0), make_number (size
),
12073 props
, f
->desired_tool_bar_string
);
12076 /* Put a `display' property on the string for the images to display,
12077 put a `menu_item' property on tool-bar items with a value that
12078 is the index of the item in F's tool-bar item vector. */
12079 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
12081 #define PROP(IDX) \
12082 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12084 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
12085 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
12086 int hmargin
, vmargin
, relief
, idx
, end
;
12088 /* If image is a vector, choose the image according to the
12090 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
12091 if (VECTORP (image
))
12095 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12096 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12099 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12100 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12102 eassert (ASIZE (image
) >= idx
);
12103 image
= AREF (image
, idx
);
12108 /* Ignore invalid image specifications. */
12109 if (!valid_image_p (image
))
12112 /* Display the tool-bar button pressed, or depressed. */
12113 plist
= Fcopy_sequence (XCDR (image
));
12115 /* Compute margin and relief to draw. */
12116 relief
= (tool_bar_button_relief
>= 0
12117 ? tool_bar_button_relief
12118 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12119 hmargin
= vmargin
= relief
;
12121 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12122 INT_MAX
- max (hmargin
, vmargin
)))
12124 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12125 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12127 else if (CONSP (Vtool_bar_button_margin
))
12129 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12130 INT_MAX
- hmargin
))
12131 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12133 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12134 INT_MAX
- vmargin
))
12135 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12138 if (auto_raise_tool_bar_buttons_p
)
12140 /* Add a `:relief' property to the image spec if the item is
12144 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12151 /* If image is selected, display it pressed, i.e. with a
12152 negative relief. If it's not selected, display it with a
12154 plist
= Fplist_put (plist
, QCrelief
,
12156 ? make_number (-relief
)
12157 : make_number (relief
)));
12162 /* Put a margin around the image. */
12163 if (hmargin
|| vmargin
)
12165 if (hmargin
== vmargin
)
12166 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12168 plist
= Fplist_put (plist
, QCmargin
,
12169 Fcons (make_number (hmargin
),
12170 make_number (vmargin
)));
12173 /* If button is not enabled, and we don't have special images
12174 for the disabled state, make the image appear disabled by
12175 applying an appropriate algorithm to it. */
12176 if (!enabled_p
&& idx
< 0)
12177 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12179 /* Put a `display' text property on the string for the image to
12180 display. Put a `menu-item' property on the string that gives
12181 the start of this item's properties in the tool-bar items
12183 image
= Fcons (Qimage
, plist
);
12184 props
= list4 (Qdisplay
, image
,
12185 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12187 /* Let the last image hide all remaining spaces in the tool bar
12188 string. The string can be longer than needed when we reuse a
12189 previous string. */
12190 if (i
+ 1 == f
->n_tool_bar_items
)
12191 end
= SCHARS (f
->desired_tool_bar_string
);
12194 Fadd_text_properties (make_number (i
), make_number (end
),
12195 props
, f
->desired_tool_bar_string
);
12203 /* Display one line of the tool-bar of frame IT->f.
12205 HEIGHT specifies the desired height of the tool-bar line.
12206 If the actual height of the glyph row is less than HEIGHT, the
12207 row's height is increased to HEIGHT, and the icons are centered
12208 vertically in the new height.
12210 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12211 count a final empty row in case the tool-bar width exactly matches
12216 display_tool_bar_line (struct it
*it
, int height
)
12218 struct glyph_row
*row
= it
->glyph_row
;
12219 int max_x
= it
->last_visible_x
;
12220 struct glyph
*last
;
12222 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12223 clear_glyph_row (row
);
12224 row
->enabled_p
= true;
12225 row
->y
= it
->current_y
;
12227 /* Note that this isn't made use of if the face hasn't a box,
12228 so there's no need to check the face here. */
12229 it
->start_of_box_run_p
= 1;
12231 while (it
->current_x
< max_x
)
12233 int x
, n_glyphs_before
, i
, nglyphs
;
12234 struct it it_before
;
12236 /* Get the next display element. */
12237 if (!get_next_display_element (it
))
12239 /* Don't count empty row if we are counting needed tool-bar lines. */
12240 if (height
< 0 && !it
->hpos
)
12245 /* Produce glyphs. */
12246 n_glyphs_before
= row
->used
[TEXT_AREA
];
12249 PRODUCE_GLYPHS (it
);
12251 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12253 x
= it_before
.current_x
;
12254 while (i
< nglyphs
)
12256 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12258 if (x
+ glyph
->pixel_width
> max_x
)
12260 /* Glyph doesn't fit on line. Backtrack. */
12261 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12263 /* If this is the only glyph on this line, it will never fit on the
12264 tool-bar, so skip it. But ensure there is at least one glyph,
12265 so we don't accidentally disable the tool-bar. */
12266 if (n_glyphs_before
== 0
12267 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12273 x
+= glyph
->pixel_width
;
12277 /* Stop at line end. */
12278 if (ITERATOR_AT_END_OF_LINE_P (it
))
12281 set_iterator_to_next (it
, 1);
12286 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12288 /* Use default face for the border below the tool bar.
12290 FIXME: When auto-resize-tool-bars is grow-only, there is
12291 no additional border below the possibly empty tool-bar lines.
12292 So to make the extra empty lines look "normal", we have to
12293 use the tool-bar face for the border too. */
12294 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12295 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12296 it
->face_id
= DEFAULT_FACE_ID
;
12298 extend_face_to_end_of_line (it
);
12299 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12300 last
->right_box_line_p
= 1;
12301 if (last
== row
->glyphs
[TEXT_AREA
])
12302 last
->left_box_line_p
= 1;
12304 /* Make line the desired height and center it vertically. */
12305 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12307 /* Don't add more than one line height. */
12308 height
%= FRAME_LINE_HEIGHT (it
->f
);
12309 it
->max_ascent
+= height
/ 2;
12310 it
->max_descent
+= (height
+ 1) / 2;
12313 compute_line_metrics (it
);
12315 /* If line is empty, make it occupy the rest of the tool-bar. */
12316 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12318 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12319 row
->visible_height
= row
->height
;
12320 row
->ascent
= row
->phys_ascent
= 0;
12321 row
->extra_line_spacing
= 0;
12324 row
->full_width_p
= 1;
12325 row
->continued_p
= 0;
12326 row
->truncated_on_left_p
= 0;
12327 row
->truncated_on_right_p
= 0;
12329 it
->current_x
= it
->hpos
= 0;
12330 it
->current_y
+= row
->height
;
12336 /* Max tool-bar height. Basically, this is what makes all other windows
12337 disappear when the frame gets too small. Rethink this! */
12339 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
12340 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
12342 /* Value is the number of pixels needed to make all tool-bar items of
12343 frame F visible. The actual number of glyph rows needed is
12344 returned in *N_ROWS if non-NULL. */
12347 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12349 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12351 /* tool_bar_height is called from redisplay_tool_bar after building
12352 the desired matrix, so use (unused) mode-line row as temporary row to
12353 avoid destroying the first tool-bar row. */
12354 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12356 /* Initialize an iterator for iteration over
12357 F->desired_tool_bar_string in the tool-bar window of frame F. */
12358 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12359 it
.first_visible_x
= 0;
12360 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12361 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12362 it
.paragraph_embedding
= L2R
;
12364 while (!ITERATOR_AT_END_P (&it
))
12366 clear_glyph_row (temp_row
);
12367 it
.glyph_row
= temp_row
;
12368 display_tool_bar_line (&it
, -1);
12370 clear_glyph_row (temp_row
);
12372 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12374 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12377 return it
.current_y
;
12379 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12382 #endif /* !USE_GTK && !HAVE_NS */
12384 #if defined USE_GTK || defined HAVE_NS
12385 EXFUN (Ftool_bar_height
, 2) ATTRIBUTE_CONST
;
12386 EXFUN (Ftool_bar_lines_needed
, 1) ATTRIBUTE_CONST
;
12389 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12391 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12392 If FRAME is nil or omitted, use the selected frame. Optional argument
12393 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12394 (Lisp_Object frame
, Lisp_Object pixelwise
)
12398 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12399 struct frame
*f
= decode_any_frame (frame
);
12401 if (WINDOWP (f
->tool_bar_window
)
12402 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12404 update_tool_bar (f
, 1);
12405 if (f
->n_tool_bar_items
)
12407 build_desired_tool_bar_string (f
);
12408 height
= tool_bar_height (f
, NULL
, NILP (pixelwise
) ? 0 : 1);
12413 return make_number (height
);
12417 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
12418 height should be changed. */
12421 redisplay_tool_bar (struct frame
*f
)
12423 #if defined (USE_GTK) || defined (HAVE_NS)
12425 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12426 update_frame_tool_bar (f
);
12429 #else /* !USE_GTK && !HAVE_NS */
12433 struct glyph_row
*row
;
12435 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12436 do anything. This means you must start with tool-bar-lines
12437 non-zero to get the auto-sizing effect. Or in other words, you
12438 can turn off tool-bars by specifying tool-bar-lines zero. */
12439 if (!WINDOWP (f
->tool_bar_window
)
12440 || (w
= XWINDOW (f
->tool_bar_window
),
12441 WINDOW_PIXEL_HEIGHT (w
) == 0))
12444 /* Set up an iterator for the tool-bar window. */
12445 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12446 it
.first_visible_x
= 0;
12447 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12448 row
= it
.glyph_row
;
12450 /* Build a string that represents the contents of the tool-bar. */
12451 build_desired_tool_bar_string (f
);
12452 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12453 /* FIXME: This should be controlled by a user option. But it
12454 doesn't make sense to have an R2L tool bar if the menu bar cannot
12455 be drawn also R2L, and making the menu bar R2L is tricky due
12456 toolkit-specific code that implements it. If an R2L tool bar is
12457 ever supported, display_tool_bar_line should also be augmented to
12458 call unproduce_glyphs like display_line and display_string
12460 it
.paragraph_embedding
= L2R
;
12462 if (f
->n_tool_bar_rows
== 0)
12464 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, 1);
12466 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12469 int new_lines
= ((new_height
+ FRAME_LINE_HEIGHT (f
) - 1)
12470 / FRAME_LINE_HEIGHT (f
));
12472 XSETFRAME (frame
, f
);
12473 Fmodify_frame_parameters (frame
,
12474 list1 (Fcons (Qtool_bar_lines
,
12475 make_number (new_lines
))));
12476 /* Always do that now. */
12477 clear_glyph_matrix (w
->desired_matrix
);
12478 f
->fonts_changed
= 1;
12483 /* Display as many lines as needed to display all tool-bar items. */
12485 if (f
->n_tool_bar_rows
> 0)
12487 int border
, rows
, height
, extra
;
12489 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12490 border
= XINT (Vtool_bar_border
);
12491 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12492 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12493 else if (EQ (Vtool_bar_border
, Qborder_width
))
12494 border
= f
->border_width
;
12500 rows
= f
->n_tool_bar_rows
;
12501 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12502 extra
= it
.last_visible_y
- border
- height
* rows
;
12504 while (it
.current_y
< it
.last_visible_y
)
12507 if (extra
> 0 && rows
-- > 0)
12509 h
= (extra
+ rows
- 1) / rows
;
12512 display_tool_bar_line (&it
, height
+ h
);
12517 while (it
.current_y
< it
.last_visible_y
)
12518 display_tool_bar_line (&it
, 0);
12521 /* It doesn't make much sense to try scrolling in the tool-bar
12522 window, so don't do it. */
12523 w
->desired_matrix
->no_scrolling_p
= 1;
12524 w
->must_be_updated_p
= 1;
12526 if (!NILP (Vauto_resize_tool_bars
))
12528 /* Do we really allow the toolbar to occupy the whole frame? */
12529 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
12530 int change_height_p
= 0;
12532 /* If we couldn't display everything, change the tool-bar's
12533 height if there is room for more. */
12534 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
12535 && it
.current_y
< max_tool_bar_height
)
12536 change_height_p
= 1;
12538 /* We subtract 1 because display_tool_bar_line advances the
12539 glyph_row pointer before returning to its caller. We want to
12540 examine the last glyph row produced by
12541 display_tool_bar_line. */
12542 row
= it
.glyph_row
- 1;
12544 /* If there are blank lines at the end, except for a partially
12545 visible blank line at the end that is smaller than
12546 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12547 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12548 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12549 change_height_p
= 1;
12551 /* If row displays tool-bar items, but is partially visible,
12552 change the tool-bar's height. */
12553 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12554 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
12555 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
12556 change_height_p
= 1;
12558 /* Resize windows as needed by changing the `tool-bar-lines'
12559 frame parameter. */
12560 if (change_height_p
)
12564 int new_height
= tool_bar_height (f
, &nrows
, 1);
12566 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12567 && !f
->minimize_tool_bar_window_p
)
12568 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12569 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12570 f
->minimize_tool_bar_window_p
= 0;
12572 if (change_height_p
)
12574 /* Current size of the tool-bar window in canonical line
12576 int old_lines
= WINDOW_TOTAL_LINES (w
);
12577 /* Required size of the tool-bar window in canonical
12579 int new_lines
= ((new_height
+ FRAME_LINE_HEIGHT (f
) - 1)
12580 / FRAME_LINE_HEIGHT (f
));
12581 /* Maximum size of the tool-bar window in canonical line
12582 units that this frame can allow. */
12584 WINDOW_TOTAL_LINES (XWINDOW (FRAME_ROOT_WINDOW (f
))) - 1;
12586 /* Don't try to change the tool-bar window size and set
12587 the fonts_changed flag unless really necessary. That
12588 flag causes redisplay to give up and retry
12589 redisplaying the frame from scratch, so setting it
12590 unnecessarily can lead to nasty redisplay loops. */
12591 if (new_lines
<= max_lines
12592 && eabs (new_lines
- old_lines
) >= 1)
12594 XSETFRAME (frame
, f
);
12595 Fmodify_frame_parameters (frame
,
12596 list1 (Fcons (Qtool_bar_lines
,
12597 make_number (new_lines
))));
12598 clear_glyph_matrix (w
->desired_matrix
);
12599 f
->n_tool_bar_rows
= nrows
;
12600 f
->fonts_changed
= 1;
12607 f
->minimize_tool_bar_window_p
= 0;
12610 #endif /* USE_GTK || HAVE_NS */
12613 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12615 /* Get information about the tool-bar item which is displayed in GLYPH
12616 on frame F. Return in *PROP_IDX the index where tool-bar item
12617 properties start in F->tool_bar_items. Value is zero if
12618 GLYPH doesn't display a tool-bar item. */
12621 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12627 /* This function can be called asynchronously, which means we must
12628 exclude any possibility that Fget_text_property signals an
12630 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12631 charpos
= max (0, charpos
);
12633 /* Get the text property `menu-item' at pos. The value of that
12634 property is the start index of this item's properties in
12635 F->tool_bar_items. */
12636 prop
= Fget_text_property (make_number (charpos
),
12637 Qmenu_item
, f
->current_tool_bar_string
);
12638 if (INTEGERP (prop
))
12640 *prop_idx
= XINT (prop
);
12650 /* Get information about the tool-bar item at position X/Y on frame F.
12651 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12652 the current matrix of the tool-bar window of F, or NULL if not
12653 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12654 item in F->tool_bar_items. Value is
12656 -1 if X/Y is not on a tool-bar item
12657 0 if X/Y is on the same item that was highlighted before.
12661 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12662 int *hpos
, int *vpos
, int *prop_idx
)
12664 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12665 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12668 /* Find the glyph under X/Y. */
12669 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12670 if (*glyph
== NULL
)
12673 /* Get the start of this tool-bar item's properties in
12674 f->tool_bar_items. */
12675 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12678 /* Is mouse on the highlighted item? */
12679 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12680 && *vpos
>= hlinfo
->mouse_face_beg_row
12681 && *vpos
<= hlinfo
->mouse_face_end_row
12682 && (*vpos
> hlinfo
->mouse_face_beg_row
12683 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12684 && (*vpos
< hlinfo
->mouse_face_end_row
12685 || *hpos
< hlinfo
->mouse_face_end_col
12686 || hlinfo
->mouse_face_past_end
))
12694 Handle mouse button event on the tool-bar of frame F, at
12695 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12696 0 for button release. MODIFIERS is event modifiers for button
12700 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12703 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12704 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12705 int hpos
, vpos
, prop_idx
;
12706 struct glyph
*glyph
;
12707 Lisp_Object enabled_p
;
12710 /* If not on the highlighted tool-bar item, and mouse-highlight is
12711 non-nil, return. This is so we generate the tool-bar button
12712 click only when the mouse button is released on the same item as
12713 where it was pressed. However, when mouse-highlight is disabled,
12714 generate the click when the button is released regardless of the
12715 highlight, since tool-bar items are not highlighted in that
12717 frame_to_window_pixel_xy (w
, &x
, &y
);
12718 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12720 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12723 /* When mouse-highlight is off, generate the click for the item
12724 where the button was pressed, disregarding where it was
12726 if (NILP (Vmouse_highlight
) && !down_p
)
12727 prop_idx
= last_tool_bar_item
;
12729 /* If item is disabled, do nothing. */
12730 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12731 if (NILP (enabled_p
))
12736 /* Show item in pressed state. */
12737 if (!NILP (Vmouse_highlight
))
12738 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12739 last_tool_bar_item
= prop_idx
;
12743 Lisp_Object key
, frame
;
12744 struct input_event event
;
12745 EVENT_INIT (event
);
12747 /* Show item in released state. */
12748 if (!NILP (Vmouse_highlight
))
12749 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12751 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12753 XSETFRAME (frame
, f
);
12754 event
.kind
= TOOL_BAR_EVENT
;
12755 event
.frame_or_window
= frame
;
12757 kbd_buffer_store_event (&event
);
12759 event
.kind
= TOOL_BAR_EVENT
;
12760 event
.frame_or_window
= frame
;
12762 event
.modifiers
= modifiers
;
12763 kbd_buffer_store_event (&event
);
12764 last_tool_bar_item
= -1;
12769 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12770 tool-bar window-relative coordinates X/Y. Called from
12771 note_mouse_highlight. */
12774 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12776 Lisp_Object window
= f
->tool_bar_window
;
12777 struct window
*w
= XWINDOW (window
);
12778 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12779 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12781 struct glyph
*glyph
;
12782 struct glyph_row
*row
;
12784 Lisp_Object enabled_p
;
12786 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12787 int mouse_down_p
, rc
;
12789 /* Function note_mouse_highlight is called with negative X/Y
12790 values when mouse moves outside of the frame. */
12791 if (x
<= 0 || y
<= 0)
12793 clear_mouse_face (hlinfo
);
12797 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12800 /* Not on tool-bar item. */
12801 clear_mouse_face (hlinfo
);
12805 /* On same tool-bar item as before. */
12806 goto set_help_echo
;
12808 clear_mouse_face (hlinfo
);
12810 /* Mouse is down, but on different tool-bar item? */
12811 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12812 && f
== dpyinfo
->last_mouse_frame
);
12815 && last_tool_bar_item
!= prop_idx
)
12818 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12820 /* If tool-bar item is not enabled, don't highlight it. */
12821 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12822 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12824 /* Compute the x-position of the glyph. In front and past the
12825 image is a space. We include this in the highlighted area. */
12826 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12827 for (i
= x
= 0; i
< hpos
; ++i
)
12828 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12830 /* Record this as the current active region. */
12831 hlinfo
->mouse_face_beg_col
= hpos
;
12832 hlinfo
->mouse_face_beg_row
= vpos
;
12833 hlinfo
->mouse_face_beg_x
= x
;
12834 hlinfo
->mouse_face_past_end
= 0;
12836 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12837 hlinfo
->mouse_face_end_row
= vpos
;
12838 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12839 hlinfo
->mouse_face_window
= window
;
12840 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12842 /* Display it as active. */
12843 show_mouse_face (hlinfo
, draw
);
12848 /* Set help_echo_string to a help string to display for this tool-bar item.
12849 XTread_socket does the rest. */
12850 help_echo_object
= help_echo_window
= Qnil
;
12851 help_echo_pos
= -1;
12852 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12853 if (NILP (help_echo_string
))
12854 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12857 #endif /* !USE_GTK && !HAVE_NS */
12859 #endif /* HAVE_WINDOW_SYSTEM */
12863 /************************************************************************
12864 Horizontal scrolling
12865 ************************************************************************/
12867 static int hscroll_window_tree (Lisp_Object
);
12868 static int hscroll_windows (Lisp_Object
);
12870 /* For all leaf windows in the window tree rooted at WINDOW, set their
12871 hscroll value so that PT is (i) visible in the window, and (ii) so
12872 that it is not within a certain margin at the window's left and
12873 right border. Value is non-zero if any window's hscroll has been
12877 hscroll_window_tree (Lisp_Object window
)
12879 int hscrolled_p
= 0;
12880 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12881 int hscroll_step_abs
= 0;
12882 double hscroll_step_rel
= 0;
12884 if (hscroll_relative_p
)
12886 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12887 if (hscroll_step_rel
< 0)
12889 hscroll_relative_p
= 0;
12890 hscroll_step_abs
= 0;
12893 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12895 hscroll_step_abs
= XINT (Vhscroll_step
);
12896 if (hscroll_step_abs
< 0)
12897 hscroll_step_abs
= 0;
12900 hscroll_step_abs
= 0;
12902 while (WINDOWP (window
))
12904 struct window
*w
= XWINDOW (window
);
12906 if (WINDOWP (w
->contents
))
12907 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12908 else if (w
->cursor
.vpos
>= 0)
12911 int text_area_width
;
12912 struct glyph_row
*cursor_row
;
12913 struct glyph_row
*bottom_row
;
12916 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12917 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12918 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12920 cursor_row
= bottom_row
- 1;
12922 if (!cursor_row
->enabled_p
)
12924 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12925 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12926 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12928 cursor_row
= bottom_row
- 1;
12930 row_r2l_p
= cursor_row
->reversed_p
;
12932 text_area_width
= window_box_width (w
, TEXT_AREA
);
12934 /* Scroll when cursor is inside this scroll margin. */
12935 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12937 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12938 /* In some pathological cases, like restoring a window
12939 configuration into a frame that is much smaller than
12940 the one from which the configuration was saved, we
12941 get glyph rows whose start and end have zero buffer
12942 positions, which we cannot handle below. Just skip
12944 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12945 /* For left-to-right rows, hscroll when cursor is either
12946 (i) inside the right hscroll margin, or (ii) if it is
12947 inside the left margin and the window is already
12951 && w
->cursor
.x
<= h_margin
)
12952 || (cursor_row
->enabled_p
12953 && cursor_row
->truncated_on_right_p
12954 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12955 /* For right-to-left rows, the logic is similar,
12956 except that rules for scrolling to left and right
12957 are reversed. E.g., if cursor.x <= h_margin, we
12958 need to hscroll "to the right" unconditionally,
12959 and that will scroll the screen to the left so as
12960 to reveal the next portion of the row. */
12962 && ((cursor_row
->enabled_p
12963 /* FIXME: It is confusing to set the
12964 truncated_on_right_p flag when R2L rows
12965 are actually truncated on the left. */
12966 && cursor_row
->truncated_on_right_p
12967 && w
->cursor
.x
<= h_margin
)
12969 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12973 struct buffer
*saved_current_buffer
;
12977 /* Find point in a display of infinite width. */
12978 saved_current_buffer
= current_buffer
;
12979 current_buffer
= XBUFFER (w
->contents
);
12981 if (w
== XWINDOW (selected_window
))
12984 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12986 /* Move iterator to pt starting at cursor_row->start in
12987 a line with infinite width. */
12988 init_to_row_start (&it
, w
, cursor_row
);
12989 it
.last_visible_x
= INFINITY
;
12990 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12991 current_buffer
= saved_current_buffer
;
12993 /* Position cursor in window. */
12994 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12995 hscroll
= max (0, (it
.current_x
12996 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12997 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12998 : (text_area_width
/ 2))))
12999 / FRAME_COLUMN_WIDTH (it
.f
);
13000 else if ((!row_r2l_p
13001 && w
->cursor
.x
>= text_area_width
- h_margin
)
13002 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
13004 if (hscroll_relative_p
)
13005 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
13008 wanted_x
= text_area_width
13009 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
13012 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
13016 if (hscroll_relative_p
)
13017 wanted_x
= text_area_width
* hscroll_step_rel
13020 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
13023 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
13025 hscroll
= max (hscroll
, w
->min_hscroll
);
13027 /* Don't prevent redisplay optimizations if hscroll
13028 hasn't changed, as it will unnecessarily slow down
13030 if (w
->hscroll
!= hscroll
)
13032 XBUFFER (w
->contents
)->prevent_redisplay_optimizations_p
= 1;
13033 w
->hscroll
= hscroll
;
13042 /* Value is non-zero if hscroll of any leaf window has been changed. */
13043 return hscrolled_p
;
13047 /* Set hscroll so that cursor is visible and not inside horizontal
13048 scroll margins for all windows in the tree rooted at WINDOW. See
13049 also hscroll_window_tree above. Value is non-zero if any window's
13050 hscroll has been changed. If it has, desired matrices on the frame
13051 of WINDOW are cleared. */
13054 hscroll_windows (Lisp_Object window
)
13056 int hscrolled_p
= hscroll_window_tree (window
);
13058 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
13059 return hscrolled_p
;
13064 /************************************************************************
13066 ************************************************************************/
13068 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
13069 to a non-zero value. This is sometimes handy to have in a debugger
13074 /* First and last unchanged row for try_window_id. */
13076 static int debug_first_unchanged_at_end_vpos
;
13077 static int debug_last_unchanged_at_beg_vpos
;
13079 /* Delta vpos and y. */
13081 static int debug_dvpos
, debug_dy
;
13083 /* Delta in characters and bytes for try_window_id. */
13085 static ptrdiff_t debug_delta
, debug_delta_bytes
;
13087 /* Values of window_end_pos and window_end_vpos at the end of
13090 static ptrdiff_t debug_end_vpos
;
13092 /* Append a string to W->desired_matrix->method. FMT is a printf
13093 format string. If trace_redisplay_p is true also printf the
13094 resulting string to stderr. */
13096 static void debug_method_add (struct window
*, char const *, ...)
13097 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13100 debug_method_add (struct window
*w
, char const *fmt
, ...)
13103 char *method
= w
->desired_matrix
->method
;
13104 int len
= strlen (method
);
13105 int size
= sizeof w
->desired_matrix
->method
;
13106 int remaining
= size
- len
- 1;
13109 if (len
&& remaining
)
13112 --remaining
, ++len
;
13115 va_start (ap
, fmt
);
13116 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13119 if (trace_redisplay_p
)
13120 fprintf (stderr
, "%p (%s): %s\n",
13122 ((BUFFERP (w
->contents
)
13123 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13124 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13129 #endif /* GLYPH_DEBUG */
13132 /* Value is non-zero if all changes in window W, which displays
13133 current_buffer, are in the text between START and END. START is a
13134 buffer position, END is given as a distance from Z. Used in
13135 redisplay_internal for display optimization. */
13138 text_outside_line_unchanged_p (struct window
*w
,
13139 ptrdiff_t start
, ptrdiff_t end
)
13141 int unchanged_p
= 1;
13143 /* If text or overlays have changed, see where. */
13144 if (window_outdated (w
))
13146 /* Gap in the line? */
13147 if (GPT
< start
|| Z
- GPT
< end
)
13150 /* Changes start in front of the line, or end after it? */
13152 && (BEG_UNCHANGED
< start
- 1
13153 || END_UNCHANGED
< end
))
13156 /* If selective display, can't optimize if changes start at the
13157 beginning of the line. */
13159 && INTEGERP (BVAR (current_buffer
, selective_display
))
13160 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13161 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13164 /* If there are overlays at the start or end of the line, these
13165 may have overlay strings with newlines in them. A change at
13166 START, for instance, may actually concern the display of such
13167 overlay strings as well, and they are displayed on different
13168 lines. So, quickly rule out this case. (For the future, it
13169 might be desirable to implement something more telling than
13170 just BEG/END_UNCHANGED.) */
13173 if (BEG
+ BEG_UNCHANGED
== start
13174 && overlay_touches_p (start
))
13176 if (END_UNCHANGED
== end
13177 && overlay_touches_p (Z
- end
))
13181 /* Under bidi reordering, adding or deleting a character in the
13182 beginning of a paragraph, before the first strong directional
13183 character, can change the base direction of the paragraph (unless
13184 the buffer specifies a fixed paragraph direction), which will
13185 require to redisplay the whole paragraph. It might be worthwhile
13186 to find the paragraph limits and widen the range of redisplayed
13187 lines to that, but for now just give up this optimization. */
13188 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13189 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13193 return unchanged_p
;
13197 /* Do a frame update, taking possible shortcuts into account. This is
13198 the main external entry point for redisplay.
13200 If the last redisplay displayed an echo area message and that message
13201 is no longer requested, we clear the echo area or bring back the
13202 mini-buffer if that is in use. */
13207 redisplay_internal ();
13212 overlay_arrow_string_or_property (Lisp_Object var
)
13216 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13219 return Voverlay_arrow_string
;
13222 /* Return 1 if there are any overlay-arrows in current_buffer. */
13224 overlay_arrow_in_current_buffer_p (void)
13228 for (vlist
= Voverlay_arrow_variable_list
;
13230 vlist
= XCDR (vlist
))
13232 Lisp_Object var
= XCAR (vlist
);
13235 if (!SYMBOLP (var
))
13237 val
= find_symbol_value (var
);
13239 && current_buffer
== XMARKER (val
)->buffer
)
13246 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
13250 overlay_arrows_changed_p (void)
13254 for (vlist
= Voverlay_arrow_variable_list
;
13256 vlist
= XCDR (vlist
))
13258 Lisp_Object var
= XCAR (vlist
);
13259 Lisp_Object val
, pstr
;
13261 if (!SYMBOLP (var
))
13263 val
= find_symbol_value (var
);
13264 if (!MARKERP (val
))
13266 if (! EQ (COERCE_MARKER (val
),
13267 Fget (var
, Qlast_arrow_position
))
13268 || ! (pstr
= overlay_arrow_string_or_property (var
),
13269 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13275 /* Mark overlay arrows to be updated on next redisplay. */
13278 update_overlay_arrows (int up_to_date
)
13282 for (vlist
= Voverlay_arrow_variable_list
;
13284 vlist
= XCDR (vlist
))
13286 Lisp_Object var
= XCAR (vlist
);
13288 if (!SYMBOLP (var
))
13291 if (up_to_date
> 0)
13293 Lisp_Object val
= find_symbol_value (var
);
13294 Fput (var
, Qlast_arrow_position
,
13295 COERCE_MARKER (val
));
13296 Fput (var
, Qlast_arrow_string
,
13297 overlay_arrow_string_or_property (var
));
13299 else if (up_to_date
< 0
13300 || !NILP (Fget (var
, Qlast_arrow_position
)))
13302 Fput (var
, Qlast_arrow_position
, Qt
);
13303 Fput (var
, Qlast_arrow_string
, Qt
);
13309 /* Return overlay arrow string to display at row.
13310 Return integer (bitmap number) for arrow bitmap in left fringe.
13311 Return nil if no overlay arrow. */
13314 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13318 for (vlist
= Voverlay_arrow_variable_list
;
13320 vlist
= XCDR (vlist
))
13322 Lisp_Object var
= XCAR (vlist
);
13325 if (!SYMBOLP (var
))
13328 val
= find_symbol_value (var
);
13331 && current_buffer
== XMARKER (val
)->buffer
13332 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13334 if (FRAME_WINDOW_P (it
->f
)
13335 /* FIXME: if ROW->reversed_p is set, this should test
13336 the right fringe, not the left one. */
13337 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13339 #ifdef HAVE_WINDOW_SYSTEM
13340 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13343 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
13344 return make_number (fringe_bitmap
);
13347 return make_number (-1); /* Use default arrow bitmap. */
13349 return overlay_arrow_string_or_property (var
);
13356 /* Return 1 if point moved out of or into a composition. Otherwise
13357 return 0. PREV_BUF and PREV_PT are the last point buffer and
13358 position. BUF and PT are the current point buffer and position. */
13361 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13362 struct buffer
*buf
, ptrdiff_t pt
)
13364 ptrdiff_t start
, end
;
13366 Lisp_Object buffer
;
13368 XSETBUFFER (buffer
, buf
);
13369 /* Check a composition at the last point if point moved within the
13371 if (prev_buf
== buf
)
13374 /* Point didn't move. */
13377 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13378 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13379 && composition_valid_p (start
, end
, prop
)
13380 && start
< prev_pt
&& end
> prev_pt
)
13381 /* The last point was within the composition. Return 1 iff
13382 point moved out of the composition. */
13383 return (pt
<= start
|| pt
>= end
);
13386 /* Check a composition at the current point. */
13387 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13388 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13389 && composition_valid_p (start
, end
, prop
)
13390 && start
< pt
&& end
> pt
);
13393 /* Reconsider the clip changes of buffer which is displayed in W. */
13396 reconsider_clip_changes (struct window
*w
)
13398 struct buffer
*b
= XBUFFER (w
->contents
);
13400 if (b
->clip_changed
13401 && w
->window_end_valid
13402 && w
->current_matrix
->buffer
== b
13403 && w
->current_matrix
->zv
== BUF_ZV (b
)
13404 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13405 b
->clip_changed
= 0;
13407 /* If display wasn't paused, and W is not a tool bar window, see if
13408 point has been moved into or out of a composition. In that case,
13409 we set b->clip_changed to 1 to force updating the screen. If
13410 b->clip_changed has already been set to 1, we can skip this
13412 if (!b
->clip_changed
&& w
->window_end_valid
)
13414 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13415 ? PT
: marker_position (w
->pointm
));
13417 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13418 && check_point_in_composition (w
->current_matrix
->buffer
,
13419 w
->last_point
, b
, pt
))
13420 b
->clip_changed
= 1;
13425 propagate_buffer_redisplay (void)
13426 { /* Resetting b->text->redisplay is problematic!
13427 We can't just reset it in the case that some window that displays
13428 it has not been redisplayed; and such a window can stay
13429 unredisplayed for a long time if it's currently invisible.
13430 But we do want to reset it at the end of redisplay otherwise
13431 its displayed windows will keep being redisplayed over and over
13433 So we copy all b->text->redisplay flags up to their windows here,
13434 such that mark_window_display_accurate can safely reset
13435 b->text->redisplay. */
13436 Lisp_Object ws
= window_list ();
13437 for (; CONSP (ws
); ws
= XCDR (ws
))
13439 struct window
*thisw
= XWINDOW (XCAR (ws
));
13440 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13441 if (thisb
->text
->redisplay
)
13442 thisw
->redisplay
= true;
13446 #define STOP_POLLING \
13447 do { if (! polling_stopped_here) stop_polling (); \
13448 polling_stopped_here = 1; } while (0)
13450 #define RESUME_POLLING \
13451 do { if (polling_stopped_here) start_polling (); \
13452 polling_stopped_here = 0; } while (0)
13455 /* Perhaps in the future avoid recentering windows if it
13456 is not necessary; currently that causes some problems. */
13459 redisplay_internal (void)
13461 struct window
*w
= XWINDOW (selected_window
);
13465 bool must_finish
= 0, match_p
;
13466 struct text_pos tlbufpos
, tlendpos
;
13467 int number_of_visible_frames
;
13470 int polling_stopped_here
= 0;
13471 Lisp_Object tail
, frame
;
13473 /* True means redisplay has to consider all windows on all
13474 frames. False, only selected_window is considered. */
13475 bool consider_all_windows_p
;
13477 /* True means redisplay has to redisplay the miniwindow. */
13478 bool update_miniwindow_p
= false;
13480 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13482 /* No redisplay if running in batch mode or frame is not yet fully
13483 initialized, or redisplay is explicitly turned off by setting
13484 Vinhibit_redisplay. */
13485 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13486 || !NILP (Vinhibit_redisplay
))
13489 /* Don't examine these until after testing Vinhibit_redisplay.
13490 When Emacs is shutting down, perhaps because its connection to
13491 X has dropped, we should not look at them at all. */
13492 fr
= XFRAME (w
->frame
);
13493 sf
= SELECTED_FRAME ();
13495 if (!fr
->glyphs_initialized_p
)
13498 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13499 if (popup_activated ())
13503 /* I don't think this happens but let's be paranoid. */
13504 if (redisplaying_p
)
13507 /* Record a function that clears redisplaying_p
13508 when we leave this function. */
13509 count
= SPECPDL_INDEX ();
13510 record_unwind_protect_void (unwind_redisplay
);
13511 redisplaying_p
= 1;
13512 specbind (Qinhibit_free_realized_faces
, Qnil
);
13514 /* Record this function, so it appears on the profiler's backtraces. */
13515 record_in_backtrace (Qredisplay_internal
, &Qnil
, 0);
13517 FOR_EACH_FRAME (tail
, frame
)
13518 XFRAME (frame
)->already_hscrolled_p
= 0;
13521 /* Remember the currently selected window. */
13525 last_escape_glyph_frame
= NULL
;
13526 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13527 last_glyphless_glyph_frame
= NULL
;
13528 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13530 /* If face_change_count is non-zero, init_iterator will free all
13531 realized faces, which includes the faces referenced from current
13532 matrices. So, we can't reuse current matrices in this case. */
13533 if (face_change_count
)
13534 windows_or_buffers_changed
= 47;
13536 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13537 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13539 /* Since frames on a single ASCII terminal share the same
13540 display area, displaying a different frame means redisplay
13541 the whole thing. */
13542 SET_FRAME_GARBAGED (sf
);
13544 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13546 FRAME_TTY (sf
)->previous_frame
= sf
;
13549 /* Set the visible flags for all frames. Do this before checking for
13550 resized or garbaged frames; they want to know if their frames are
13551 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13552 number_of_visible_frames
= 0;
13554 FOR_EACH_FRAME (tail
, frame
)
13556 struct frame
*f
= XFRAME (frame
);
13558 if (FRAME_VISIBLE_P (f
))
13560 ++number_of_visible_frames
;
13561 /* Adjust matrices for visible frames only. */
13562 if (f
->fonts_changed
)
13564 adjust_frame_glyphs (f
);
13565 f
->fonts_changed
= 0;
13567 /* If cursor type has been changed on the frame
13568 other than selected, consider all frames. */
13569 if (f
!= sf
&& f
->cursor_type_changed
)
13570 update_mode_lines
= 31;
13572 clear_desired_matrices (f
);
13575 /* Notice any pending interrupt request to change frame size. */
13576 do_pending_window_change (1);
13578 /* do_pending_window_change could change the selected_window due to
13579 frame resizing which makes the selected window too small. */
13580 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13583 /* Clear frames marked as garbaged. */
13584 clear_garbaged_frames ();
13586 /* Build menubar and tool-bar items. */
13587 if (NILP (Vmemory_full
))
13588 prepare_menu_bars ();
13590 reconsider_clip_changes (w
);
13592 /* In most cases selected window displays current buffer. */
13593 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13596 /* Detect case that we need to write or remove a star in the mode line. */
13597 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13598 w
->update_mode_line
= 1;
13600 if (mode_line_update_needed (w
))
13601 w
->update_mode_line
= 1;
13603 /* If reconsider_clip_changes above decided that the narrowing
13604 in the current buffer changed, make sure all other windows
13605 showing that buffer will be redisplayed. */
13606 if (current_buffer
->clip_changed
)
13607 bset_update_mode_line (current_buffer
);
13610 /* Normally the message* functions will have already displayed and
13611 updated the echo area, but the frame may have been trashed, or
13612 the update may have been preempted, so display the echo area
13613 again here. Checking message_cleared_p captures the case that
13614 the echo area should be cleared. */
13615 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13616 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13617 || (message_cleared_p
13618 && minibuf_level
== 0
13619 /* If the mini-window is currently selected, this means the
13620 echo-area doesn't show through. */
13621 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13623 int window_height_changed_p
= echo_area_display (0);
13625 if (message_cleared_p
)
13626 update_miniwindow_p
= true;
13630 /* If we don't display the current message, don't clear the
13631 message_cleared_p flag, because, if we did, we wouldn't clear
13632 the echo area in the next redisplay which doesn't preserve
13634 if (!display_last_displayed_message_p
)
13635 message_cleared_p
= 0;
13637 if (window_height_changed_p
)
13639 windows_or_buffers_changed
= 50;
13641 /* If window configuration was changed, frames may have been
13642 marked garbaged. Clear them or we will experience
13643 surprises wrt scrolling. */
13644 clear_garbaged_frames ();
13647 else if (EQ (selected_window
, minibuf_window
)
13648 && (current_buffer
->clip_changed
|| window_outdated (w
))
13649 && resize_mini_window (w
, 0))
13651 /* Resized active mini-window to fit the size of what it is
13652 showing if its contents might have changed. */
13655 /* If window configuration was changed, frames may have been
13656 marked garbaged. Clear them or we will experience
13657 surprises wrt scrolling. */
13658 clear_garbaged_frames ();
13661 if (windows_or_buffers_changed
&& !update_mode_lines
)
13662 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13663 only the windows's contents needs to be refreshed, or whether the
13664 mode-lines also need a refresh. */
13665 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13666 ? REDISPLAY_SOME
: 32);
13668 /* If specs for an arrow have changed, do thorough redisplay
13669 to ensure we remove any arrow that should no longer exist. */
13670 if (overlay_arrows_changed_p ())
13671 /* Apparently, this is the only case where we update other windows,
13672 without updating other mode-lines. */
13673 windows_or_buffers_changed
= 49;
13675 consider_all_windows_p
= (update_mode_lines
13676 || windows_or_buffers_changed
);
13678 #define AINC(a,i) \
13679 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13680 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13682 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13683 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13685 /* Optimize the case that only the line containing the cursor in the
13686 selected window has changed. Variables starting with this_ are
13687 set in display_line and record information about the line
13688 containing the cursor. */
13689 tlbufpos
= this_line_start_pos
;
13690 tlendpos
= this_line_end_pos
;
13691 if (!consider_all_windows_p
13692 && CHARPOS (tlbufpos
) > 0
13693 && !w
->update_mode_line
13694 && !current_buffer
->clip_changed
13695 && !current_buffer
->prevent_redisplay_optimizations_p
13696 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13697 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13698 && !XFRAME (w
->frame
)->cursor_type_changed
13699 /* Make sure recorded data applies to current buffer, etc. */
13700 && this_line_buffer
== current_buffer
13703 && !w
->optional_new_start
13704 /* Point must be on the line that we have info recorded about. */
13705 && PT
>= CHARPOS (tlbufpos
)
13706 && PT
<= Z
- CHARPOS (tlendpos
)
13707 /* All text outside that line, including its final newline,
13708 must be unchanged. */
13709 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13710 CHARPOS (tlendpos
)))
13712 if (CHARPOS (tlbufpos
) > BEGV
13713 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13714 && (CHARPOS (tlbufpos
) == ZV
13715 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13716 /* Former continuation line has disappeared by becoming empty. */
13718 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13720 /* We have to handle the case of continuation around a
13721 wide-column character (see the comment in indent.c around
13724 For instance, in the following case:
13726 -------- Insert --------
13727 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13728 J_I_ ==> J_I_ `^^' are cursors.
13732 As we have to redraw the line above, we cannot use this
13736 int line_height_before
= this_line_pixel_height
;
13738 /* Note that start_display will handle the case that the
13739 line starting at tlbufpos is a continuation line. */
13740 start_display (&it
, w
, tlbufpos
);
13742 /* Implementation note: It this still necessary? */
13743 if (it
.current_x
!= this_line_start_x
)
13746 TRACE ((stderr
, "trying display optimization 1\n"));
13747 w
->cursor
.vpos
= -1;
13748 overlay_arrow_seen
= 0;
13749 it
.vpos
= this_line_vpos
;
13750 it
.current_y
= this_line_y
;
13751 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13752 display_line (&it
);
13754 /* If line contains point, is not continued,
13755 and ends at same distance from eob as before, we win. */
13756 if (w
->cursor
.vpos
>= 0
13757 /* Line is not continued, otherwise this_line_start_pos
13758 would have been set to 0 in display_line. */
13759 && CHARPOS (this_line_start_pos
)
13760 /* Line ends as before. */
13761 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13762 /* Line has same height as before. Otherwise other lines
13763 would have to be shifted up or down. */
13764 && this_line_pixel_height
== line_height_before
)
13766 /* If this is not the window's last line, we must adjust
13767 the charstarts of the lines below. */
13768 if (it
.current_y
< it
.last_visible_y
)
13770 struct glyph_row
*row
13771 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13772 ptrdiff_t delta
, delta_bytes
;
13774 /* We used to distinguish between two cases here,
13775 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13776 when the line ends in a newline or the end of the
13777 buffer's accessible portion. But both cases did
13778 the same, so they were collapsed. */
13780 - CHARPOS (tlendpos
)
13781 - MATRIX_ROW_START_CHARPOS (row
));
13782 delta_bytes
= (Z_BYTE
13783 - BYTEPOS (tlendpos
)
13784 - MATRIX_ROW_START_BYTEPOS (row
));
13786 increment_matrix_positions (w
->current_matrix
,
13787 this_line_vpos
+ 1,
13788 w
->current_matrix
->nrows
,
13789 delta
, delta_bytes
);
13792 /* If this row displays text now but previously didn't,
13793 or vice versa, w->window_end_vpos may have to be
13795 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13797 if (w
->window_end_vpos
< this_line_vpos
)
13798 w
->window_end_vpos
= this_line_vpos
;
13800 else if (w
->window_end_vpos
== this_line_vpos
13801 && this_line_vpos
> 0)
13802 w
->window_end_vpos
= this_line_vpos
- 1;
13803 w
->window_end_valid
= 0;
13805 /* Update hint: No need to try to scroll in update_window. */
13806 w
->desired_matrix
->no_scrolling_p
= 1;
13809 *w
->desired_matrix
->method
= 0;
13810 debug_method_add (w
, "optimization 1");
13812 #ifdef HAVE_WINDOW_SYSTEM
13813 update_window_fringes (w
, 0);
13820 else if (/* Cursor position hasn't changed. */
13821 PT
== w
->last_point
13822 /* Make sure the cursor was last displayed
13823 in this window. Otherwise we have to reposition it. */
13825 /* PXW: Must be converted to pixels, probably. */
13826 && 0 <= w
->cursor
.vpos
13827 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13831 do_pending_window_change (1);
13832 /* If selected_window changed, redisplay again. */
13833 if (WINDOWP (selected_window
)
13834 && (w
= XWINDOW (selected_window
)) != sw
)
13837 /* We used to always goto end_of_redisplay here, but this
13838 isn't enough if we have a blinking cursor. */
13839 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13840 goto end_of_redisplay
;
13844 /* If highlighting the region, or if the cursor is in the echo area,
13845 then we can't just move the cursor. */
13846 else if (NILP (Vshow_trailing_whitespace
)
13847 && !cursor_in_echo_area
)
13850 struct glyph_row
*row
;
13852 /* Skip from tlbufpos to PT and see where it is. Note that
13853 PT may be in invisible text. If so, we will end at the
13854 next visible position. */
13855 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13856 NULL
, DEFAULT_FACE_ID
);
13857 it
.current_x
= this_line_start_x
;
13858 it
.current_y
= this_line_y
;
13859 it
.vpos
= this_line_vpos
;
13861 /* The call to move_it_to stops in front of PT, but
13862 moves over before-strings. */
13863 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13865 if (it
.vpos
== this_line_vpos
13866 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13869 eassert (this_line_vpos
== it
.vpos
);
13870 eassert (this_line_y
== it
.current_y
);
13871 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13873 *w
->desired_matrix
->method
= 0;
13874 debug_method_add (w
, "optimization 3");
13883 /* Text changed drastically or point moved off of line. */
13884 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13887 CHARPOS (this_line_start_pos
) = 0;
13888 ++clear_face_cache_count
;
13889 #ifdef HAVE_WINDOW_SYSTEM
13890 ++clear_image_cache_count
;
13893 /* Build desired matrices, and update the display. If
13894 consider_all_windows_p is non-zero, do it for all windows on all
13895 frames. Otherwise do it for selected_window, only. */
13897 if (consider_all_windows_p
)
13899 FOR_EACH_FRAME (tail
, frame
)
13900 XFRAME (frame
)->updated_p
= 0;
13902 propagate_buffer_redisplay ();
13904 FOR_EACH_FRAME (tail
, frame
)
13906 struct frame
*f
= XFRAME (frame
);
13908 /* We don't have to do anything for unselected terminal
13910 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13911 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13916 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13919 /* Only GC scrollbars when we redisplay the whole frame. */
13920 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13921 /* Mark all the scroll bars to be removed; we'll redeem
13922 the ones we want when we redisplay their windows. */
13923 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13924 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13926 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13927 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13928 /* Remember that the invisible frames need to be redisplayed next
13929 time they're visible. */
13930 else if (!REDISPLAY_SOME_P ())
13931 f
->redisplay
= true;
13933 /* The X error handler may have deleted that frame. */
13934 if (!FRAME_LIVE_P (f
))
13937 /* Any scroll bars which redisplay_windows should have
13938 nuked should now go away. */
13939 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13940 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13942 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13944 /* If fonts changed on visible frame, display again. */
13945 if (f
->fonts_changed
)
13947 adjust_frame_glyphs (f
);
13948 f
->fonts_changed
= 0;
13952 /* See if we have to hscroll. */
13953 if (!f
->already_hscrolled_p
)
13955 f
->already_hscrolled_p
= 1;
13956 if (hscroll_windows (f
->root_window
))
13960 /* Prevent various kinds of signals during display
13961 update. stdio is not robust about handling
13962 signals, which can cause an apparent I/O error. */
13963 if (interrupt_input
)
13964 unrequest_sigio ();
13967 pending
|= update_frame (f
, 0, 0);
13968 f
->cursor_type_changed
= 0;
13974 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13978 /* Do the mark_window_display_accurate after all windows have
13979 been redisplayed because this call resets flags in buffers
13980 which are needed for proper redisplay. */
13981 FOR_EACH_FRAME (tail
, frame
)
13983 struct frame
*f
= XFRAME (frame
);
13986 f
->redisplay
= false;
13987 mark_window_display_accurate (f
->root_window
, 1);
13988 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13989 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13994 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13996 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13997 struct frame
*mini_frame
;
13999 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
14000 /* Use list_of_error, not Qerror, so that
14001 we catch only errors and don't run the debugger. */
14002 internal_condition_case_1 (redisplay_window_1
, selected_window
,
14004 redisplay_window_error
);
14005 if (update_miniwindow_p
)
14006 internal_condition_case_1 (redisplay_window_1
, mini_window
,
14008 redisplay_window_error
);
14010 /* Compare desired and current matrices, perform output. */
14013 /* If fonts changed, display again. */
14014 if (sf
->fonts_changed
)
14017 /* Prevent various kinds of signals during display update.
14018 stdio is not robust about handling signals,
14019 which can cause an apparent I/O error. */
14020 if (interrupt_input
)
14021 unrequest_sigio ();
14024 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
14026 if (hscroll_windows (selected_window
))
14029 XWINDOW (selected_window
)->must_be_updated_p
= true;
14030 pending
= update_frame (sf
, 0, 0);
14031 sf
->cursor_type_changed
= 0;
14034 /* We may have called echo_area_display at the top of this
14035 function. If the echo area is on another frame, that may
14036 have put text on a frame other than the selected one, so the
14037 above call to update_frame would not have caught it. Catch
14039 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
14040 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
14042 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
14044 XWINDOW (mini_window
)->must_be_updated_p
= true;
14045 pending
|= update_frame (mini_frame
, 0, 0);
14046 mini_frame
->cursor_type_changed
= 0;
14047 if (!pending
&& hscroll_windows (mini_window
))
14052 /* If display was paused because of pending input, make sure we do a
14053 thorough update the next time. */
14056 /* Prevent the optimization at the beginning of
14057 redisplay_internal that tries a single-line update of the
14058 line containing the cursor in the selected window. */
14059 CHARPOS (this_line_start_pos
) = 0;
14061 /* Let the overlay arrow be updated the next time. */
14062 update_overlay_arrows (0);
14064 /* If we pause after scrolling, some rows in the current
14065 matrices of some windows are not valid. */
14066 if (!WINDOW_FULL_WIDTH_P (w
)
14067 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
14068 update_mode_lines
= 36;
14072 if (!consider_all_windows_p
)
14074 /* This has already been done above if
14075 consider_all_windows_p is set. */
14076 if (XBUFFER (w
->contents
)->text
->redisplay
14077 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
14078 /* This can happen if b->text->redisplay was set during
14080 propagate_buffer_redisplay ();
14081 mark_window_display_accurate_1 (w
, 1);
14083 /* Say overlay arrows are up to date. */
14084 update_overlay_arrows (1);
14086 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
14087 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
14090 update_mode_lines
= 0;
14091 windows_or_buffers_changed
= 0;
14094 /* Start SIGIO interrupts coming again. Having them off during the
14095 code above makes it less likely one will discard output, but not
14096 impossible, since there might be stuff in the system buffer here.
14097 But it is much hairier to try to do anything about that. */
14098 if (interrupt_input
)
14102 /* If a frame has become visible which was not before, redisplay
14103 again, so that we display it. Expose events for such a frame
14104 (which it gets when becoming visible) don't call the parts of
14105 redisplay constructing glyphs, so simply exposing a frame won't
14106 display anything in this case. So, we have to display these
14107 frames here explicitly. */
14112 FOR_EACH_FRAME (tail
, frame
)
14114 if (XFRAME (frame
)->visible
)
14118 if (new_count
!= number_of_visible_frames
)
14119 windows_or_buffers_changed
= 52;
14122 /* Change frame size now if a change is pending. */
14123 do_pending_window_change (1);
14125 /* If we just did a pending size change, or have additional
14126 visible frames, or selected_window changed, redisplay again. */
14127 if ((windows_or_buffers_changed
&& !pending
)
14128 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14131 /* Clear the face and image caches.
14133 We used to do this only if consider_all_windows_p. But the cache
14134 needs to be cleared if a timer creates images in the current
14135 buffer (e.g. the test case in Bug#6230). */
14137 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14139 clear_face_cache (0);
14140 clear_face_cache_count
= 0;
14143 #ifdef HAVE_WINDOW_SYSTEM
14144 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14146 clear_image_caches (Qnil
);
14147 clear_image_cache_count
= 0;
14149 #endif /* HAVE_WINDOW_SYSTEM */
14152 if (interrupt_input
&& interrupts_deferred
)
14155 unbind_to (count
, Qnil
);
14160 /* Redisplay, but leave alone any recent echo area message unless
14161 another message has been requested in its place.
14163 This is useful in situations where you need to redisplay but no
14164 user action has occurred, making it inappropriate for the message
14165 area to be cleared. See tracking_off and
14166 wait_reading_process_output for examples of these situations.
14168 FROM_WHERE is an integer saying from where this function was
14169 called. This is useful for debugging. */
14172 redisplay_preserve_echo_area (int from_where
)
14174 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14176 if (!NILP (echo_area_buffer
[1]))
14178 /* We have a previously displayed message, but no current
14179 message. Redisplay the previous message. */
14180 display_last_displayed_message_p
= 1;
14181 redisplay_internal ();
14182 display_last_displayed_message_p
= 0;
14185 redisplay_internal ();
14187 flush_frame (SELECTED_FRAME ());
14191 /* Function registered with record_unwind_protect in redisplay_internal. */
14194 unwind_redisplay (void)
14196 redisplaying_p
= 0;
14200 /* Mark the display of leaf window W as accurate or inaccurate.
14201 If ACCURATE_P is non-zero mark display of W as accurate. If
14202 ACCURATE_P is zero, arrange for W to be redisplayed the next
14203 time redisplay_internal is called. */
14206 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
14208 struct buffer
*b
= XBUFFER (w
->contents
);
14210 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14211 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14212 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14216 b
->clip_changed
= false;
14217 b
->prevent_redisplay_optimizations_p
= false;
14218 eassert (buffer_window_count (b
) > 0);
14219 /* Resetting b->text->redisplay is problematic!
14220 In order to make it safer to do it here, redisplay_internal must
14221 have copied all b->text->redisplay to their respective windows. */
14222 b
->text
->redisplay
= false;
14224 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14225 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14226 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14227 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14229 w
->current_matrix
->buffer
= b
;
14230 w
->current_matrix
->begv
= BUF_BEGV (b
);
14231 w
->current_matrix
->zv
= BUF_ZV (b
);
14233 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14234 w
->last_cursor_off_p
= w
->cursor_off_p
;
14236 if (w
== XWINDOW (selected_window
))
14237 w
->last_point
= BUF_PT (b
);
14239 w
->last_point
= marker_position (w
->pointm
);
14241 w
->window_end_valid
= true;
14242 w
->update_mode_line
= false;
14245 w
->redisplay
= !accurate_p
;
14249 /* Mark the display of windows in the window tree rooted at WINDOW as
14250 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
14251 windows as accurate. If ACCURATE_P is zero, arrange for windows to
14252 be redisplayed the next time redisplay_internal is called. */
14255 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
14259 for (; !NILP (window
); window
= w
->next
)
14261 w
= XWINDOW (window
);
14262 if (WINDOWP (w
->contents
))
14263 mark_window_display_accurate (w
->contents
, accurate_p
);
14265 mark_window_display_accurate_1 (w
, accurate_p
);
14269 update_overlay_arrows (1);
14271 /* Force a thorough redisplay the next time by setting
14272 last_arrow_position and last_arrow_string to t, which is
14273 unequal to any useful value of Voverlay_arrow_... */
14274 update_overlay_arrows (-1);
14278 /* Return value in display table DP (Lisp_Char_Table *) for character
14279 C. Since a display table doesn't have any parent, we don't have to
14280 follow parent. Do not call this function directly but use the
14281 macro DISP_CHAR_VECTOR. */
14284 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14288 if (ASCII_CHAR_P (c
))
14291 if (SUB_CHAR_TABLE_P (val
))
14292 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14298 XSETCHAR_TABLE (table
, dp
);
14299 val
= char_table_ref (table
, c
);
14308 /***********************************************************************
14310 ***********************************************************************/
14312 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14315 redisplay_windows (Lisp_Object window
)
14317 while (!NILP (window
))
14319 struct window
*w
= XWINDOW (window
);
14321 if (WINDOWP (w
->contents
))
14322 redisplay_windows (w
->contents
);
14323 else if (BUFFERP (w
->contents
))
14325 displayed_buffer
= XBUFFER (w
->contents
);
14326 /* Use list_of_error, not Qerror, so that
14327 we catch only errors and don't run the debugger. */
14328 internal_condition_case_1 (redisplay_window_0
, window
,
14330 redisplay_window_error
);
14338 redisplay_window_error (Lisp_Object ignore
)
14340 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14345 redisplay_window_0 (Lisp_Object window
)
14347 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14348 redisplay_window (window
, false);
14353 redisplay_window_1 (Lisp_Object window
)
14355 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14356 redisplay_window (window
, true);
14361 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14362 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14363 which positions recorded in ROW differ from current buffer
14366 Return 0 if cursor is not on this row, 1 otherwise. */
14369 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14370 struct glyph_matrix
*matrix
,
14371 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14374 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14375 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14376 struct glyph
*cursor
= NULL
;
14377 /* The last known character position in row. */
14378 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14380 ptrdiff_t pt_old
= PT
- delta
;
14381 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14382 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14383 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14384 /* A glyph beyond the edge of TEXT_AREA which we should never
14386 struct glyph
*glyphs_end
= end
;
14387 /* Non-zero means we've found a match for cursor position, but that
14388 glyph has the avoid_cursor_p flag set. */
14389 int match_with_avoid_cursor
= 0;
14390 /* Non-zero means we've seen at least one glyph that came from a
14392 int string_seen
= 0;
14393 /* Largest and smallest buffer positions seen so far during scan of
14395 ptrdiff_t bpos_max
= pos_before
;
14396 ptrdiff_t bpos_min
= pos_after
;
14397 /* Last buffer position covered by an overlay string with an integer
14398 `cursor' property. */
14399 ptrdiff_t bpos_covered
= 0;
14400 /* Non-zero means the display string on which to display the cursor
14401 comes from a text property, not from an overlay. */
14402 int string_from_text_prop
= 0;
14404 /* Don't even try doing anything if called for a mode-line or
14405 header-line row, since the rest of the code isn't prepared to
14406 deal with such calamities. */
14407 eassert (!row
->mode_line_p
);
14408 if (row
->mode_line_p
)
14411 /* Skip over glyphs not having an object at the start and the end of
14412 the row. These are special glyphs like truncation marks on
14413 terminal frames. */
14414 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14416 if (!row
->reversed_p
)
14419 && INTEGERP (glyph
->object
)
14420 && glyph
->charpos
< 0)
14422 x
+= glyph
->pixel_width
;
14426 && INTEGERP ((end
- 1)->object
)
14427 /* CHARPOS is zero for blanks and stretch glyphs
14428 inserted by extend_face_to_end_of_line. */
14429 && (end
- 1)->charpos
<= 0)
14431 glyph_before
= glyph
- 1;
14438 /* If the glyph row is reversed, we need to process it from back
14439 to front, so swap the edge pointers. */
14440 glyphs_end
= end
= glyph
- 1;
14441 glyph
+= row
->used
[TEXT_AREA
] - 1;
14443 while (glyph
> end
+ 1
14444 && INTEGERP (glyph
->object
)
14445 && glyph
->charpos
< 0)
14448 x
-= glyph
->pixel_width
;
14450 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
14452 /* By default, in reversed rows we put the cursor on the
14453 rightmost (first in the reading order) glyph. */
14454 for (g
= end
+ 1; g
< glyph
; g
++)
14455 x
+= g
->pixel_width
;
14457 && INTEGERP ((end
+ 1)->object
)
14458 && (end
+ 1)->charpos
<= 0)
14460 glyph_before
= glyph
+ 1;
14464 else if (row
->reversed_p
)
14466 /* In R2L rows that don't display text, put the cursor on the
14467 rightmost glyph. Case in point: an empty last line that is
14468 part of an R2L paragraph. */
14470 /* Avoid placing the cursor on the last glyph of the row, where
14471 on terminal frames we hold the vertical border between
14472 adjacent windows. */
14473 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14474 && !WINDOW_RIGHTMOST_P (w
)
14475 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14477 x
= -1; /* will be computed below, at label compute_x */
14480 /* Step 1: Try to find the glyph whose character position
14481 corresponds to point. If that's not possible, find 2 glyphs
14482 whose character positions are the closest to point, one before
14483 point, the other after it. */
14484 if (!row
->reversed_p
)
14485 while (/* not marched to end of glyph row */
14487 /* glyph was not inserted by redisplay for internal purposes */
14488 && !INTEGERP (glyph
->object
))
14490 if (BUFFERP (glyph
->object
))
14492 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14494 if (glyph
->charpos
> bpos_max
)
14495 bpos_max
= glyph
->charpos
;
14496 if (glyph
->charpos
< bpos_min
)
14497 bpos_min
= glyph
->charpos
;
14498 if (!glyph
->avoid_cursor_p
)
14500 /* If we hit point, we've found the glyph on which to
14501 display the cursor. */
14504 match_with_avoid_cursor
= 0;
14507 /* See if we've found a better approximation to
14508 POS_BEFORE or to POS_AFTER. */
14509 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14511 pos_before
= glyph
->charpos
;
14512 glyph_before
= glyph
;
14514 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14516 pos_after
= glyph
->charpos
;
14517 glyph_after
= glyph
;
14520 else if (dpos
== 0)
14521 match_with_avoid_cursor
= 1;
14523 else if (STRINGP (glyph
->object
))
14525 Lisp_Object chprop
;
14526 ptrdiff_t glyph_pos
= glyph
->charpos
;
14528 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14530 if (!NILP (chprop
))
14532 /* If the string came from a `display' text property,
14533 look up the buffer position of that property and
14534 use that position to update bpos_max, as if we
14535 actually saw such a position in one of the row's
14536 glyphs. This helps with supporting integer values
14537 of `cursor' property on the display string in
14538 situations where most or all of the row's buffer
14539 text is completely covered by display properties,
14540 so that no glyph with valid buffer positions is
14541 ever seen in the row. */
14542 ptrdiff_t prop_pos
=
14543 string_buffer_position_lim (glyph
->object
, pos_before
,
14546 if (prop_pos
>= pos_before
)
14547 bpos_max
= prop_pos
;
14549 if (INTEGERP (chprop
))
14551 bpos_covered
= bpos_max
+ XINT (chprop
);
14552 /* If the `cursor' property covers buffer positions up
14553 to and including point, we should display cursor on
14554 this glyph. Note that, if a `cursor' property on one
14555 of the string's characters has an integer value, we
14556 will break out of the loop below _before_ we get to
14557 the position match above. IOW, integer values of
14558 the `cursor' property override the "exact match for
14559 point" strategy of positioning the cursor. */
14560 /* Implementation note: bpos_max == pt_old when, e.g.,
14561 we are in an empty line, where bpos_max is set to
14562 MATRIX_ROW_START_CHARPOS, see above. */
14563 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14572 x
+= glyph
->pixel_width
;
14575 else if (glyph
> end
) /* row is reversed */
14576 while (!INTEGERP (glyph
->object
))
14578 if (BUFFERP (glyph
->object
))
14580 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14582 if (glyph
->charpos
> bpos_max
)
14583 bpos_max
= glyph
->charpos
;
14584 if (glyph
->charpos
< bpos_min
)
14585 bpos_min
= glyph
->charpos
;
14586 if (!glyph
->avoid_cursor_p
)
14590 match_with_avoid_cursor
= 0;
14593 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14595 pos_before
= glyph
->charpos
;
14596 glyph_before
= glyph
;
14598 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14600 pos_after
= glyph
->charpos
;
14601 glyph_after
= glyph
;
14604 else if (dpos
== 0)
14605 match_with_avoid_cursor
= 1;
14607 else if (STRINGP (glyph
->object
))
14609 Lisp_Object chprop
;
14610 ptrdiff_t glyph_pos
= glyph
->charpos
;
14612 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14614 if (!NILP (chprop
))
14616 ptrdiff_t prop_pos
=
14617 string_buffer_position_lim (glyph
->object
, pos_before
,
14620 if (prop_pos
>= pos_before
)
14621 bpos_max
= prop_pos
;
14623 if (INTEGERP (chprop
))
14625 bpos_covered
= bpos_max
+ XINT (chprop
);
14626 /* If the `cursor' property covers buffer positions up
14627 to and including point, we should display cursor on
14629 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14638 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14640 x
--; /* can't use any pixel_width */
14643 x
-= glyph
->pixel_width
;
14646 /* Step 2: If we didn't find an exact match for point, we need to
14647 look for a proper place to put the cursor among glyphs between
14648 GLYPH_BEFORE and GLYPH_AFTER. */
14649 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14650 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14651 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14653 /* An empty line has a single glyph whose OBJECT is zero and
14654 whose CHARPOS is the position of a newline on that line.
14655 Note that on a TTY, there are more glyphs after that, which
14656 were produced by extend_face_to_end_of_line, but their
14657 CHARPOS is zero or negative. */
14659 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14660 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0
14661 /* On a TTY, continued and truncated rows also have a glyph at
14662 their end whose OBJECT is zero and whose CHARPOS is
14663 positive (the continuation and truncation glyphs), but such
14664 rows are obviously not "empty". */
14665 && !(row
->continued_p
|| row
->truncated_on_right_p
);
14667 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14669 ptrdiff_t ellipsis_pos
;
14671 /* Scan back over the ellipsis glyphs. */
14672 if (!row
->reversed_p
)
14674 ellipsis_pos
= (glyph
- 1)->charpos
;
14675 while (glyph
> row
->glyphs
[TEXT_AREA
]
14676 && (glyph
- 1)->charpos
== ellipsis_pos
)
14677 glyph
--, x
-= glyph
->pixel_width
;
14678 /* That loop always goes one position too far, including
14679 the glyph before the ellipsis. So scan forward over
14681 x
+= glyph
->pixel_width
;
14684 else /* row is reversed */
14686 ellipsis_pos
= (glyph
+ 1)->charpos
;
14687 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14688 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14689 glyph
++, x
+= glyph
->pixel_width
;
14690 x
-= glyph
->pixel_width
;
14694 else if (match_with_avoid_cursor
)
14696 cursor
= glyph_after
;
14699 else if (string_seen
)
14701 int incr
= row
->reversed_p
? -1 : +1;
14703 /* Need to find the glyph that came out of a string which is
14704 present at point. That glyph is somewhere between
14705 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14706 positioned between POS_BEFORE and POS_AFTER in the
14708 struct glyph
*start
, *stop
;
14709 ptrdiff_t pos
= pos_before
;
14713 /* If the row ends in a newline from a display string,
14714 reordering could have moved the glyphs belonging to the
14715 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14716 in this case we extend the search to the last glyph in
14717 the row that was not inserted by redisplay. */
14718 if (row
->ends_in_newline_from_string_p
)
14721 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14724 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14725 correspond to POS_BEFORE and POS_AFTER, respectively. We
14726 need START and STOP in the order that corresponds to the
14727 row's direction as given by its reversed_p flag. If the
14728 directionality of characters between POS_BEFORE and
14729 POS_AFTER is the opposite of the row's base direction,
14730 these characters will have been reordered for display,
14731 and we need to reverse START and STOP. */
14732 if (!row
->reversed_p
)
14734 start
= min (glyph_before
, glyph_after
);
14735 stop
= max (glyph_before
, glyph_after
);
14739 start
= max (glyph_before
, glyph_after
);
14740 stop
= min (glyph_before
, glyph_after
);
14742 for (glyph
= start
+ incr
;
14743 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14746 /* Any glyphs that come from the buffer are here because
14747 of bidi reordering. Skip them, and only pay
14748 attention to glyphs that came from some string. */
14749 if (STRINGP (glyph
->object
))
14753 /* If the display property covers the newline, we
14754 need to search for it one position farther. */
14755 ptrdiff_t lim
= pos_after
14756 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14758 string_from_text_prop
= 0;
14759 str
= glyph
->object
;
14760 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14761 if (tem
== 0 /* from overlay */
14764 /* If the string from which this glyph came is
14765 found in the buffer at point, or at position
14766 that is closer to point than pos_after, then
14767 we've found the glyph we've been looking for.
14768 If it comes from an overlay (tem == 0), and
14769 it has the `cursor' property on one of its
14770 glyphs, record that glyph as a candidate for
14771 displaying the cursor. (As in the
14772 unidirectional version, we will display the
14773 cursor on the last candidate we find.) */
14776 || (tem
- pt_old
> 0 && tem
< pos_after
))
14778 /* The glyphs from this string could have
14779 been reordered. Find the one with the
14780 smallest string position. Or there could
14781 be a character in the string with the
14782 `cursor' property, which means display
14783 cursor on that character's glyph. */
14784 ptrdiff_t strpos
= glyph
->charpos
;
14789 string_from_text_prop
= 1;
14792 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14793 && EQ (glyph
->object
, str
);
14797 ptrdiff_t gpos
= glyph
->charpos
;
14799 cprop
= Fget_char_property (make_number (gpos
),
14807 if (tem
&& glyph
->charpos
< strpos
)
14809 strpos
= glyph
->charpos
;
14815 || (tem
- pt_old
> 0 && tem
< pos_after
))
14819 pos
= tem
+ 1; /* don't find previous instances */
14821 /* This string is not what we want; skip all of the
14822 glyphs that came from it. */
14823 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14824 && EQ (glyph
->object
, str
))
14831 /* If we reached the end of the line, and END was from a string,
14832 the cursor is not on this line. */
14834 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14835 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14836 && STRINGP (end
->object
)
14837 && row
->continued_p
)
14840 /* A truncated row may not include PT among its character positions.
14841 Setting the cursor inside the scroll margin will trigger
14842 recalculation of hscroll in hscroll_window_tree. But if a
14843 display string covers point, defer to the string-handling
14844 code below to figure this out. */
14845 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14847 cursor
= glyph_before
;
14850 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14851 /* Zero-width characters produce no glyphs. */
14853 && (row
->reversed_p
14854 ? glyph_after
> glyphs_end
14855 : glyph_after
< glyphs_end
)))
14857 cursor
= glyph_after
;
14863 if (cursor
!= NULL
)
14865 else if (glyph
== glyphs_end
14866 && pos_before
== pos_after
14867 && STRINGP ((row
->reversed_p
14868 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14869 : row
->glyphs
[TEXT_AREA
])->object
))
14871 /* If all the glyphs of this row came from strings, put the
14872 cursor on the first glyph of the row. This avoids having the
14873 cursor outside of the text area in this very rare and hard
14877 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14878 : row
->glyphs
[TEXT_AREA
];
14884 /* Need to compute x that corresponds to GLYPH. */
14885 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14887 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14889 x
+= g
->pixel_width
;
14893 /* ROW could be part of a continued line, which, under bidi
14894 reordering, might have other rows whose start and end charpos
14895 occlude point. Only set w->cursor if we found a better
14896 approximation to the cursor position than we have from previously
14897 examined candidate rows belonging to the same continued line. */
14898 if (/* We already have a candidate row. */
14899 w
->cursor
.vpos
>= 0
14900 /* That candidate is not the row we are processing. */
14901 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14902 /* Make sure cursor.vpos specifies a row whose start and end
14903 charpos occlude point, and it is valid candidate for being a
14904 cursor-row. This is because some callers of this function
14905 leave cursor.vpos at the row where the cursor was displayed
14906 during the last redisplay cycle. */
14907 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14908 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14909 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14912 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14914 /* Don't consider glyphs that are outside TEXT_AREA. */
14915 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14917 /* Keep the candidate whose buffer position is the closest to
14918 point or has the `cursor' property. */
14919 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14920 w
->cursor
.hpos
>= 0
14921 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14922 && ((BUFFERP (g1
->object
)
14923 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14924 || (BUFFERP (glyph
->object
)
14925 && eabs (g1
->charpos
- pt_old
)
14926 < eabs (glyph
->charpos
- pt_old
))))
14927 /* Previous candidate is a glyph from a string that has
14928 a non-nil `cursor' property. */
14929 || (STRINGP (g1
->object
)
14930 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14931 Qcursor
, g1
->object
))
14932 /* Previous candidate is from the same display
14933 string as this one, and the display string
14934 came from a text property. */
14935 || (EQ (g1
->object
, glyph
->object
)
14936 && string_from_text_prop
)
14937 /* this candidate is from newline and its
14938 position is not an exact match */
14939 || (INTEGERP (glyph
->object
)
14940 && glyph
->charpos
!= pt_old
)))))
14942 /* If this candidate gives an exact match, use that. */
14943 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14944 /* If this candidate is a glyph created for the
14945 terminating newline of a line, and point is on that
14946 newline, it wins because it's an exact match. */
14947 || (!row
->continued_p
14948 && INTEGERP (glyph
->object
)
14949 && glyph
->charpos
== 0
14950 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14951 /* Otherwise, keep the candidate that comes from a row
14952 spanning less buffer positions. This may win when one or
14953 both candidate positions are on glyphs that came from
14954 display strings, for which we cannot compare buffer
14956 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14957 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14958 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14961 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14963 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14964 w
->cursor
.y
= row
->y
+ dy
;
14966 if (w
== XWINDOW (selected_window
))
14968 if (!row
->continued_p
14969 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14972 this_line_buffer
= XBUFFER (w
->contents
);
14974 CHARPOS (this_line_start_pos
)
14975 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14976 BYTEPOS (this_line_start_pos
)
14977 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14979 CHARPOS (this_line_end_pos
)
14980 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14981 BYTEPOS (this_line_end_pos
)
14982 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14984 this_line_y
= w
->cursor
.y
;
14985 this_line_pixel_height
= row
->height
;
14986 this_line_vpos
= w
->cursor
.vpos
;
14987 this_line_start_x
= row
->x
;
14990 CHARPOS (this_line_start_pos
) = 0;
14997 /* Run window scroll functions, if any, for WINDOW with new window
14998 start STARTP. Sets the window start of WINDOW to that position.
15000 We assume that the window's buffer is really current. */
15002 static struct text_pos
15003 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
15005 struct window
*w
= XWINDOW (window
);
15006 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
15008 eassert (current_buffer
== XBUFFER (w
->contents
));
15010 if (!NILP (Vwindow_scroll_functions
))
15012 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
15013 make_number (CHARPOS (startp
)));
15014 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15015 /* In case the hook functions switch buffers. */
15016 set_buffer_internal (XBUFFER (w
->contents
));
15023 /* Make sure the line containing the cursor is fully visible.
15024 A value of 1 means there is nothing to be done.
15025 (Either the line is fully visible, or it cannot be made so,
15026 or we cannot tell.)
15028 If FORCE_P is non-zero, return 0 even if partial visible cursor row
15029 is higher than window.
15031 If CURRENT_MATRIX_P is non-zero, use the information from the
15032 window's current glyph matrix; otherwise use the desired glyph
15035 A value of 0 means the caller should do scrolling
15036 as if point had gone off the screen. */
15039 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
15041 struct glyph_matrix
*matrix
;
15042 struct glyph_row
*row
;
15045 if (!make_cursor_line_fully_visible_p
)
15048 /* It's not always possible to find the cursor, e.g, when a window
15049 is full of overlay strings. Don't do anything in that case. */
15050 if (w
->cursor
.vpos
< 0)
15053 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
15054 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
15056 /* If the cursor row is not partially visible, there's nothing to do. */
15057 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
15060 /* If the row the cursor is in is taller than the window's height,
15061 it's not clear what to do, so do nothing. */
15062 window_height
= window_box_height (w
);
15063 if (row
->height
>= window_height
)
15065 if (!force_p
|| MINI_WINDOW_P (w
)
15066 || w
->vscroll
|| w
->cursor
.vpos
== 0)
15073 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
15074 non-zero means only WINDOW is redisplayed in redisplay_internal.
15075 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
15076 in redisplay_window to bring a partially visible line into view in
15077 the case that only the cursor has moved.
15079 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
15080 last screen line's vertical height extends past the end of the screen.
15084 1 if scrolling succeeded
15086 0 if scrolling didn't find point.
15088 -1 if new fonts have been loaded so that we must interrupt
15089 redisplay, adjust glyph matrices, and try again. */
15095 SCROLLING_NEED_LARGER_MATRICES
15098 /* If scroll-conservatively is more than this, never recenter.
15100 If you change this, don't forget to update the doc string of
15101 `scroll-conservatively' and the Emacs manual. */
15102 #define SCROLL_LIMIT 100
15105 try_scrolling (Lisp_Object window
, int just_this_one_p
,
15106 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15107 int temp_scroll_step
, int last_line_misfit
)
15109 struct window
*w
= XWINDOW (window
);
15110 struct frame
*f
= XFRAME (w
->frame
);
15111 struct text_pos pos
, startp
;
15113 int this_scroll_margin
, scroll_max
, rc
, height
;
15114 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
15115 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
15116 Lisp_Object aggressive
;
15117 /* We will never try scrolling more than this number of lines. */
15118 int scroll_limit
= SCROLL_LIMIT
;
15119 int frame_line_height
= default_line_pixel_height (w
);
15120 int window_total_lines
15121 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15124 debug_method_add (w
, "try_scrolling");
15127 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15129 /* Compute scroll margin height in pixels. We scroll when point is
15130 within this distance from the top or bottom of the window. */
15131 if (scroll_margin
> 0)
15132 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15133 * frame_line_height
;
15135 this_scroll_margin
= 0;
15137 /* Force arg_scroll_conservatively to have a reasonable value, to
15138 avoid scrolling too far away with slow move_it_* functions. Note
15139 that the user can supply scroll-conservatively equal to
15140 `most-positive-fixnum', which can be larger than INT_MAX. */
15141 if (arg_scroll_conservatively
> scroll_limit
)
15143 arg_scroll_conservatively
= scroll_limit
+ 1;
15144 scroll_max
= scroll_limit
* frame_line_height
;
15146 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15147 /* Compute how much we should try to scroll maximally to bring
15148 point into view. */
15149 scroll_max
= (max (scroll_step
,
15150 max (arg_scroll_conservatively
, temp_scroll_step
))
15151 * frame_line_height
);
15152 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15153 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15154 /* We're trying to scroll because of aggressive scrolling but no
15155 scroll_step is set. Choose an arbitrary one. */
15156 scroll_max
= 10 * frame_line_height
;
15162 /* Decide whether to scroll down. */
15163 if (PT
> CHARPOS (startp
))
15165 int scroll_margin_y
;
15167 /* Compute the pixel ypos of the scroll margin, then move IT to
15168 either that ypos or PT, whichever comes first. */
15169 start_display (&it
, w
, startp
);
15170 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15171 - frame_line_height
* extra_scroll_margin_lines
;
15172 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15173 (MOVE_TO_POS
| MOVE_TO_Y
));
15175 if (PT
> CHARPOS (it
.current
.pos
))
15177 int y0
= line_bottom_y (&it
);
15178 /* Compute how many pixels below window bottom to stop searching
15179 for PT. This avoids costly search for PT that is far away if
15180 the user limited scrolling by a small number of lines, but
15181 always finds PT if scroll_conservatively is set to a large
15182 number, such as most-positive-fixnum. */
15183 int slack
= max (scroll_max
, 10 * frame_line_height
);
15184 int y_to_move
= it
.last_visible_y
+ slack
;
15186 /* Compute the distance from the scroll margin to PT or to
15187 the scroll limit, whichever comes first. This should
15188 include the height of the cursor line, to make that line
15190 move_it_to (&it
, PT
, -1, y_to_move
,
15191 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15192 dy
= line_bottom_y (&it
) - y0
;
15194 if (dy
> scroll_max
)
15195 return SCROLLING_FAILED
;
15204 /* Point is in or below the bottom scroll margin, so move the
15205 window start down. If scrolling conservatively, move it just
15206 enough down to make point visible. If scroll_step is set,
15207 move it down by scroll_step. */
15208 if (arg_scroll_conservatively
)
15210 = min (max (dy
, frame_line_height
),
15211 frame_line_height
* arg_scroll_conservatively
);
15212 else if (scroll_step
|| temp_scroll_step
)
15213 amount_to_scroll
= scroll_max
;
15216 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15217 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15218 if (NUMBERP (aggressive
))
15220 double float_amount
= XFLOATINT (aggressive
) * height
;
15221 int aggressive_scroll
= float_amount
;
15222 if (aggressive_scroll
== 0 && float_amount
> 0)
15223 aggressive_scroll
= 1;
15224 /* Don't let point enter the scroll margin near top of
15225 the window. This could happen if the value of
15226 scroll_up_aggressively is too large and there are
15227 non-zero margins, because scroll_up_aggressively
15228 means put point that fraction of window height
15229 _from_the_bottom_margin_. */
15230 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15231 aggressive_scroll
= height
- 2*this_scroll_margin
;
15232 amount_to_scroll
= dy
+ aggressive_scroll
;
15236 if (amount_to_scroll
<= 0)
15237 return SCROLLING_FAILED
;
15239 start_display (&it
, w
, startp
);
15240 if (arg_scroll_conservatively
<= scroll_limit
)
15241 move_it_vertically (&it
, amount_to_scroll
);
15244 /* Extra precision for users who set scroll-conservatively
15245 to a large number: make sure the amount we scroll
15246 the window start is never less than amount_to_scroll,
15247 which was computed as distance from window bottom to
15248 point. This matters when lines at window top and lines
15249 below window bottom have different height. */
15251 void *it1data
= NULL
;
15252 /* We use a temporary it1 because line_bottom_y can modify
15253 its argument, if it moves one line down; see there. */
15256 SAVE_IT (it1
, it
, it1data
);
15257 start_y
= line_bottom_y (&it1
);
15259 RESTORE_IT (&it
, &it
, it1data
);
15260 move_it_by_lines (&it
, 1);
15261 SAVE_IT (it1
, it
, it1data
);
15262 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15265 /* If STARTP is unchanged, move it down another screen line. */
15266 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
15267 move_it_by_lines (&it
, 1);
15268 startp
= it
.current
.pos
;
15272 struct text_pos scroll_margin_pos
= startp
;
15275 /* See if point is inside the scroll margin at the top of the
15277 if (this_scroll_margin
)
15281 start_display (&it
, w
, startp
);
15282 y_start
= it
.current_y
;
15283 move_it_vertically (&it
, this_scroll_margin
);
15284 scroll_margin_pos
= it
.current
.pos
;
15285 /* If we didn't move enough before hitting ZV, request
15286 additional amount of scroll, to move point out of the
15288 if (IT_CHARPOS (it
) == ZV
15289 && it
.current_y
- y_start
< this_scroll_margin
)
15290 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15293 if (PT
< CHARPOS (scroll_margin_pos
))
15295 /* Point is in the scroll margin at the top of the window or
15296 above what is displayed in the window. */
15299 /* Compute the vertical distance from PT to the scroll
15300 margin position. Move as far as scroll_max allows, or
15301 one screenful, or 10 screen lines, whichever is largest.
15302 Give up if distance is greater than scroll_max or if we
15303 didn't reach the scroll margin position. */
15304 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15305 start_display (&it
, w
, pos
);
15307 y_to_move
= max (it
.last_visible_y
,
15308 max (scroll_max
, 10 * frame_line_height
));
15309 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15311 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15312 dy
= it
.current_y
- y0
;
15313 if (dy
> scroll_max
15314 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15315 return SCROLLING_FAILED
;
15317 /* Additional scroll for when ZV was too close to point. */
15320 /* Compute new window start. */
15321 start_display (&it
, w
, startp
);
15323 if (arg_scroll_conservatively
)
15324 amount_to_scroll
= max (dy
, frame_line_height
*
15325 max (scroll_step
, temp_scroll_step
));
15326 else if (scroll_step
|| temp_scroll_step
)
15327 amount_to_scroll
= scroll_max
;
15330 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15331 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15332 if (NUMBERP (aggressive
))
15334 double float_amount
= XFLOATINT (aggressive
) * height
;
15335 int aggressive_scroll
= float_amount
;
15336 if (aggressive_scroll
== 0 && float_amount
> 0)
15337 aggressive_scroll
= 1;
15338 /* Don't let point enter the scroll margin near
15339 bottom of the window, if the value of
15340 scroll_down_aggressively happens to be too
15342 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15343 aggressive_scroll
= height
- 2*this_scroll_margin
;
15344 amount_to_scroll
= dy
+ aggressive_scroll
;
15348 if (amount_to_scroll
<= 0)
15349 return SCROLLING_FAILED
;
15351 move_it_vertically_backward (&it
, amount_to_scroll
);
15352 startp
= it
.current
.pos
;
15356 /* Run window scroll functions. */
15357 startp
= run_window_scroll_functions (window
, startp
);
15359 /* Display the window. Give up if new fonts are loaded, or if point
15361 if (!try_window (window
, startp
, 0))
15362 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15363 else if (w
->cursor
.vpos
< 0)
15365 clear_glyph_matrix (w
->desired_matrix
);
15366 rc
= SCROLLING_FAILED
;
15370 /* Maybe forget recorded base line for line number display. */
15371 if (!just_this_one_p
15372 || current_buffer
->clip_changed
15373 || BEG_UNCHANGED
< CHARPOS (startp
))
15374 w
->base_line_number
= 0;
15376 /* If cursor ends up on a partially visible line,
15377 treat that as being off the bottom of the screen. */
15378 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
15379 /* It's possible that the cursor is on the first line of the
15380 buffer, which is partially obscured due to a vscroll
15381 (Bug#7537). In that case, avoid looping forever. */
15382 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15384 clear_glyph_matrix (w
->desired_matrix
);
15385 ++extra_scroll_margin_lines
;
15388 rc
= SCROLLING_SUCCESS
;
15395 /* Compute a suitable window start for window W if display of W starts
15396 on a continuation line. Value is non-zero if a new window start
15399 The new window start will be computed, based on W's width, starting
15400 from the start of the continued line. It is the start of the
15401 screen line with the minimum distance from the old start W->start. */
15404 compute_window_start_on_continuation_line (struct window
*w
)
15406 struct text_pos pos
, start_pos
;
15407 int window_start_changed_p
= 0;
15409 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15411 /* If window start is on a continuation line... Window start may be
15412 < BEGV in case there's invisible text at the start of the
15413 buffer (M-x rmail, for example). */
15414 if (CHARPOS (start_pos
) > BEGV
15415 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15418 struct glyph_row
*row
;
15420 /* Handle the case that the window start is out of range. */
15421 if (CHARPOS (start_pos
) < BEGV
)
15422 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15423 else if (CHARPOS (start_pos
) > ZV
)
15424 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15426 /* Find the start of the continued line. This should be fast
15427 because find_newline is fast (newline cache). */
15428 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
15429 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15430 row
, DEFAULT_FACE_ID
);
15431 reseat_at_previous_visible_line_start (&it
);
15433 /* If the line start is "too far" away from the window start,
15434 say it takes too much time to compute a new window start. */
15435 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15436 /* PXW: Do we need upper bounds here? */
15437 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15439 int min_distance
, distance
;
15441 /* Move forward by display lines to find the new window
15442 start. If window width was enlarged, the new start can
15443 be expected to be > the old start. If window width was
15444 decreased, the new window start will be < the old start.
15445 So, we're looking for the display line start with the
15446 minimum distance from the old window start. */
15447 pos
= it
.current
.pos
;
15448 min_distance
= INFINITY
;
15449 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15450 distance
< min_distance
)
15452 min_distance
= distance
;
15453 pos
= it
.current
.pos
;
15454 if (it
.line_wrap
== WORD_WRAP
)
15456 /* Under WORD_WRAP, move_it_by_lines is likely to
15457 overshoot and stop not at the first, but the
15458 second character from the left margin. So in
15459 that case, we need a more tight control on the X
15460 coordinate of the iterator than move_it_by_lines
15461 promises in its contract. The method is to first
15462 go to the last (rightmost) visible character of a
15463 line, then move to the leftmost character on the
15464 next line in a separate call. */
15465 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15466 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15467 move_it_to (&it
, ZV
, 0,
15468 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15469 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15472 move_it_by_lines (&it
, 1);
15475 /* Set the window start there. */
15476 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15477 window_start_changed_p
= 1;
15481 return window_start_changed_p
;
15485 /* Try cursor movement in case text has not changed in window WINDOW,
15486 with window start STARTP. Value is
15488 CURSOR_MOVEMENT_SUCCESS if successful
15490 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15492 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15493 display. *SCROLL_STEP is set to 1, under certain circumstances, if
15494 we want to scroll as if scroll-step were set to 1. See the code.
15496 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15497 which case we have to abort this redisplay, and adjust matrices
15502 CURSOR_MOVEMENT_SUCCESS
,
15503 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15504 CURSOR_MOVEMENT_MUST_SCROLL
,
15505 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15509 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
15511 struct window
*w
= XWINDOW (window
);
15512 struct frame
*f
= XFRAME (w
->frame
);
15513 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15516 if (inhibit_try_cursor_movement
)
15520 /* Previously, there was a check for Lisp integer in the
15521 if-statement below. Now, this field is converted to
15522 ptrdiff_t, thus zero means invalid position in a buffer. */
15523 eassert (w
->last_point
> 0);
15524 /* Likewise there was a check whether window_end_vpos is nil or larger
15525 than the window. Now window_end_vpos is int and so never nil, but
15526 let's leave eassert to check whether it fits in the window. */
15527 eassert (w
->window_end_vpos
< w
->current_matrix
->nrows
);
15529 /* Handle case where text has not changed, only point, and it has
15530 not moved off the frame. */
15531 if (/* Point may be in this window. */
15532 PT
>= CHARPOS (startp
)
15533 /* Selective display hasn't changed. */
15534 && !current_buffer
->clip_changed
15535 /* Function force-mode-line-update is used to force a thorough
15536 redisplay. It sets either windows_or_buffers_changed or
15537 update_mode_lines. So don't take a shortcut here for these
15539 && !update_mode_lines
15540 && !windows_or_buffers_changed
15541 && !f
->cursor_type_changed
15542 && NILP (Vshow_trailing_whitespace
)
15543 /* This code is not used for mini-buffer for the sake of the case
15544 of redisplaying to replace an echo area message; since in
15545 that case the mini-buffer contents per se are usually
15546 unchanged. This code is of no real use in the mini-buffer
15547 since the handling of this_line_start_pos, etc., in redisplay
15548 handles the same cases. */
15549 && !EQ (window
, minibuf_window
)
15550 && (FRAME_WINDOW_P (f
)
15551 || !overlay_arrow_in_current_buffer_p ()))
15553 int this_scroll_margin
, top_scroll_margin
;
15554 struct glyph_row
*row
= NULL
;
15555 int frame_line_height
= default_line_pixel_height (w
);
15556 int window_total_lines
15557 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15560 debug_method_add (w
, "cursor movement");
15563 /* Scroll if point within this distance from the top or bottom
15564 of the window. This is a pixel value. */
15565 if (scroll_margin
> 0)
15567 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15568 this_scroll_margin
*= frame_line_height
;
15571 this_scroll_margin
= 0;
15573 top_scroll_margin
= this_scroll_margin
;
15574 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15575 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15577 /* Start with the row the cursor was displayed during the last
15578 not paused redisplay. Give up if that row is not valid. */
15579 if (w
->last_cursor_vpos
< 0
15580 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15581 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15584 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15585 if (row
->mode_line_p
)
15587 if (!row
->enabled_p
)
15588 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15591 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15593 int scroll_p
= 0, must_scroll
= 0;
15594 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15596 if (PT
> w
->last_point
)
15598 /* Point has moved forward. */
15599 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15600 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15602 eassert (row
->enabled_p
);
15606 /* If the end position of a row equals the start
15607 position of the next row, and PT is at that position,
15608 we would rather display cursor in the next line. */
15609 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15610 && MATRIX_ROW_END_CHARPOS (row
) == PT
15611 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15612 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15613 && !cursor_row_p (row
))
15616 /* If within the scroll margin, scroll. Note that
15617 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15618 the next line would be drawn, and that
15619 this_scroll_margin can be zero. */
15620 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15621 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15622 /* Line is completely visible last line in window
15623 and PT is to be set in the next line. */
15624 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15625 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15626 && !row
->ends_at_zv_p
15627 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15630 else if (PT
< w
->last_point
)
15632 /* Cursor has to be moved backward. Note that PT >=
15633 CHARPOS (startp) because of the outer if-statement. */
15634 while (!row
->mode_line_p
15635 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15636 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15637 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15638 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15639 row
> w
->current_matrix
->rows
15640 && (row
-1)->ends_in_newline_from_string_p
))))
15641 && (row
->y
> top_scroll_margin
15642 || CHARPOS (startp
) == BEGV
))
15644 eassert (row
->enabled_p
);
15648 /* Consider the following case: Window starts at BEGV,
15649 there is invisible, intangible text at BEGV, so that
15650 display starts at some point START > BEGV. It can
15651 happen that we are called with PT somewhere between
15652 BEGV and START. Try to handle that case. */
15653 if (row
< w
->current_matrix
->rows
15654 || row
->mode_line_p
)
15656 row
= w
->current_matrix
->rows
;
15657 if (row
->mode_line_p
)
15661 /* Due to newlines in overlay strings, we may have to
15662 skip forward over overlay strings. */
15663 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15664 && MATRIX_ROW_END_CHARPOS (row
) == PT
15665 && !cursor_row_p (row
))
15668 /* If within the scroll margin, scroll. */
15669 if (row
->y
< top_scroll_margin
15670 && CHARPOS (startp
) != BEGV
)
15675 /* Cursor did not move. So don't scroll even if cursor line
15676 is partially visible, as it was so before. */
15677 rc
= CURSOR_MOVEMENT_SUCCESS
;
15680 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15681 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15683 /* if PT is not in the glyph row, give up. */
15684 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15687 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15688 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15690 struct glyph_row
*row1
;
15692 /* If rows are bidi-reordered and point moved, back up
15693 until we find a row that does not belong to a
15694 continuation line. This is because we must consider
15695 all rows of a continued line as candidates for the
15696 new cursor positioning, since row start and end
15697 positions change non-linearly with vertical position
15699 /* FIXME: Revisit this when glyph ``spilling'' in
15700 continuation lines' rows is implemented for
15701 bidi-reordered rows. */
15702 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15703 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15706 /* If we hit the beginning of the displayed portion
15707 without finding the first row of a continued
15711 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15714 eassert (row
->enabled_p
);
15719 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15720 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15721 /* Make sure this isn't a header line by any chance, since
15722 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15723 && !row
->mode_line_p
15724 && make_cursor_line_fully_visible_p
)
15726 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15727 && !row
->ends_at_zv_p
15728 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15729 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15730 else if (row
->height
> window_box_height (w
))
15732 /* If we end up in a partially visible line, let's
15733 make it fully visible, except when it's taller
15734 than the window, in which case we can't do much
15737 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15741 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15742 if (!cursor_row_fully_visible_p (w
, 0, 1))
15743 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15745 rc
= CURSOR_MOVEMENT_SUCCESS
;
15749 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15750 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15751 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15753 /* With bidi-reordered rows, there could be more than
15754 one candidate row whose start and end positions
15755 occlude point. We need to let set_cursor_from_row
15756 find the best candidate. */
15757 /* FIXME: Revisit this when glyph ``spilling'' in
15758 continuation lines' rows is implemented for
15759 bidi-reordered rows. */
15764 int at_zv_p
= 0, exact_match_p
= 0;
15766 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15767 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15768 && cursor_row_p (row
))
15769 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15771 /* As soon as we've found the exact match for point,
15772 or the first suitable row whose ends_at_zv_p flag
15773 is set, we are done. */
15776 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15777 w
->cursor
.vpos
)->ends_at_zv_p
;
15779 && w
->cursor
.hpos
>= 0
15780 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15783 struct glyph_row
*candidate
=
15784 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15786 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15787 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15790 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15791 || (INTEGERP (g
->object
)
15792 && (g
->charpos
== PT
15793 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15795 if (at_zv_p
|| exact_match_p
)
15797 rc
= CURSOR_MOVEMENT_SUCCESS
;
15801 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15805 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15806 || row
->continued_p
)
15807 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15808 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15809 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15810 /* If we didn't find any candidate rows, or exited the
15811 loop before all the candidates were examined, signal
15812 to the caller that this method failed. */
15813 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15815 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15816 && !row
->continued_p
))
15817 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15819 rc
= CURSOR_MOVEMENT_SUCCESS
;
15825 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15827 rc
= CURSOR_MOVEMENT_SUCCESS
;
15832 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15833 && MATRIX_ROW_START_CHARPOS (row
) == PT
15834 && cursor_row_p (row
));
15842 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15846 set_vertical_scroll_bar (struct window
*w
)
15848 ptrdiff_t start
, end
, whole
;
15850 /* Calculate the start and end positions for the current window.
15851 At some point, it would be nice to choose between scrollbars
15852 which reflect the whole buffer size, with special markers
15853 indicating narrowing, and scrollbars which reflect only the
15856 Note that mini-buffers sometimes aren't displaying any text. */
15857 if (!MINI_WINDOW_P (w
)
15858 || (w
== XWINDOW (minibuf_window
)
15859 && NILP (echo_area_buffer
[0])))
15861 struct buffer
*buf
= XBUFFER (w
->contents
);
15862 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15863 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15864 /* I don't think this is guaranteed to be right. For the
15865 moment, we'll pretend it is. */
15866 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15870 if (whole
< (end
- start
))
15871 whole
= end
- start
;
15874 start
= end
= whole
= 0;
15876 /* Indicate what this scroll bar ought to be displaying now. */
15877 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15878 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15879 (w
, end
- start
, whole
, start
);
15883 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15884 selected_window is redisplayed.
15886 We can return without actually redisplaying the window if fonts has been
15887 changed on window's frame. In that case, redisplay_internal will retry.
15889 As one of the important parts of redisplaying a window, we need to
15890 decide whether the previous window-start position (stored in the
15891 window's w->start marker position) is still valid, and if it isn't,
15892 recompute it. Some details about that:
15894 . The previous window-start could be in a continuation line, in
15895 which case we need to recompute it when the window width
15896 changes. See compute_window_start_on_continuation_line and its
15899 . The text that changed since last redisplay could include the
15900 previous window-start position. In that case, we try to salvage
15901 what we can from the current glyph matrix by calling
15902 try_scrolling, which see.
15904 . Some Emacs command could force us to use a specific window-start
15905 position by setting the window's force_start flag, or gently
15906 propose doing that by setting the window's optional_new_start
15907 flag. In these cases, we try using the specified start point if
15908 that succeeds (i.e. the window desired matrix is successfully
15909 recomputed, and point location is within the window). In case
15910 of optional_new_start, we first check if the specified start
15911 position is feasible, i.e. if it will allow point to be
15912 displayed in the window. If using the specified start point
15913 fails, e.g., if new fonts are needed to be loaded, we abort the
15914 redisplay cycle and leave it up to the next cycle to figure out
15917 . Note that the window's force_start flag is sometimes set by
15918 redisplay itself, when it decides that the previous window start
15919 point is fine and should be kept. Search for "goto force_start"
15920 below to see the details. Like the values of window-start
15921 specified outside of redisplay, these internally-deduced values
15922 are tested for feasibility, and ignored if found to be
15925 . Note that the function try_window, used to completely redisplay
15926 a window, accepts the window's start point as its argument.
15927 This is used several times in the redisplay code to control
15928 where the window start will be, according to user options such
15929 as scroll-conservatively, and also to ensure the screen line
15930 showing point will be fully (as opposed to partially) visible on
15934 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15936 struct window
*w
= XWINDOW (window
);
15937 struct frame
*f
= XFRAME (w
->frame
);
15938 struct buffer
*buffer
= XBUFFER (w
->contents
);
15939 struct buffer
*old
= current_buffer
;
15940 struct text_pos lpoint
, opoint
, startp
;
15941 int update_mode_line
;
15944 /* Record it now because it's overwritten. */
15945 bool current_matrix_up_to_date_p
= false;
15946 bool used_current_matrix_p
= false;
15947 /* This is less strict than current_matrix_up_to_date_p.
15948 It indicates that the buffer contents and narrowing are unchanged. */
15949 bool buffer_unchanged_p
= false;
15950 int temp_scroll_step
= 0;
15951 ptrdiff_t count
= SPECPDL_INDEX ();
15953 int centering_position
= -1;
15954 int last_line_misfit
= 0;
15955 ptrdiff_t beg_unchanged
, end_unchanged
;
15956 int frame_line_height
;
15958 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15962 *w
->desired_matrix
->method
= 0;
15965 if (!just_this_one_p
15966 && REDISPLAY_SOME_P ()
15969 && !buffer
->text
->redisplay
15970 && BUF_PT (buffer
) == w
->last_point
)
15973 /* Make sure that both W's markers are valid. */
15974 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15975 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15977 /* We come here again if we need to run window-text-change-functions
15980 reconsider_clip_changes (w
);
15981 frame_line_height
= default_line_pixel_height (w
);
15983 /* Has the mode line to be updated? */
15984 update_mode_line
= (w
->update_mode_line
15985 || update_mode_lines
15986 || buffer
->clip_changed
15987 || buffer
->prevent_redisplay_optimizations_p
);
15989 if (!just_this_one_p
)
15990 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15991 cleverly elsewhere. */
15992 w
->must_be_updated_p
= true;
15994 if (MINI_WINDOW_P (w
))
15996 if (w
== XWINDOW (echo_area_window
)
15997 && !NILP (echo_area_buffer
[0]))
15999 if (update_mode_line
)
16000 /* We may have to update a tty frame's menu bar or a
16001 tool-bar. Example `M-x C-h C-h C-g'. */
16002 goto finish_menu_bars
;
16004 /* We've already displayed the echo area glyphs in this window. */
16005 goto finish_scroll_bars
;
16007 else if ((w
!= XWINDOW (minibuf_window
)
16008 || minibuf_level
== 0)
16009 /* When buffer is nonempty, redisplay window normally. */
16010 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
16011 /* Quail displays non-mini buffers in minibuffer window.
16012 In that case, redisplay the window normally. */
16013 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
16015 /* W is a mini-buffer window, but it's not active, so clear
16017 int yb
= window_text_bottom_y (w
);
16018 struct glyph_row
*row
;
16021 for (y
= 0, row
= w
->desired_matrix
->rows
;
16023 y
+= row
->height
, ++row
)
16024 blank_row (w
, row
, y
);
16025 goto finish_scroll_bars
;
16028 clear_glyph_matrix (w
->desired_matrix
);
16031 /* Otherwise set up data on this window; select its buffer and point
16033 /* Really select the buffer, for the sake of buffer-local
16035 set_buffer_internal_1 (XBUFFER (w
->contents
));
16037 current_matrix_up_to_date_p
16038 = (w
->window_end_valid
16039 && !current_buffer
->clip_changed
16040 && !current_buffer
->prevent_redisplay_optimizations_p
16041 && !window_outdated (w
));
16043 /* Run the window-text-change-functions
16044 if it is possible that the text on the screen has changed
16045 (either due to modification of the text, or any other reason). */
16046 if (!current_matrix_up_to_date_p
16047 && !NILP (Vwindow_text_change_functions
))
16049 safe_run_hooks (Qwindow_text_change_functions
);
16053 beg_unchanged
= BEG_UNCHANGED
;
16054 end_unchanged
= END_UNCHANGED
;
16056 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16058 specbind (Qinhibit_point_motion_hooks
, Qt
);
16061 = (w
->window_end_valid
16062 && !current_buffer
->clip_changed
16063 && !window_outdated (w
));
16065 /* When windows_or_buffers_changed is non-zero, we can't rely
16066 on the window end being valid, so set it to zero there. */
16067 if (windows_or_buffers_changed
)
16069 /* If window starts on a continuation line, maybe adjust the
16070 window start in case the window's width changed. */
16071 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16072 compute_window_start_on_continuation_line (w
);
16074 w
->window_end_valid
= false;
16075 /* If so, we also can't rely on current matrix
16076 and should not fool try_cursor_movement below. */
16077 current_matrix_up_to_date_p
= false;
16080 /* Some sanity checks. */
16081 CHECK_WINDOW_END (w
);
16082 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16084 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16087 if (mode_line_update_needed (w
))
16088 update_mode_line
= 1;
16090 /* Point refers normally to the selected window. For any other
16091 window, set up appropriate value. */
16092 if (!EQ (window
, selected_window
))
16094 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16095 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16099 new_pt_byte
= BEGV_BYTE
;
16100 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16102 else if (new_pt
> (ZV
- 1))
16105 new_pt_byte
= ZV_BYTE
;
16106 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16109 /* We don't use SET_PT so that the point-motion hooks don't run. */
16110 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16113 /* If any of the character widths specified in the display table
16114 have changed, invalidate the width run cache. It's true that
16115 this may be a bit late to catch such changes, but the rest of
16116 redisplay goes (non-fatally) haywire when the display table is
16117 changed, so why should we worry about doing any better? */
16118 if (current_buffer
->width_run_cache
16119 || (current_buffer
->base_buffer
16120 && current_buffer
->base_buffer
->width_run_cache
))
16122 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16124 if (! disptab_matches_widthtab
16125 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16127 struct buffer
*buf
= current_buffer
;
16129 if (buf
->base_buffer
)
16130 buf
= buf
->base_buffer
;
16131 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16132 recompute_width_table (current_buffer
, disptab
);
16136 /* If window-start is screwed up, choose a new one. */
16137 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16140 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16142 /* If someone specified a new starting point but did not insist,
16143 check whether it can be used. */
16144 if ((w
->optional_new_start
|| window_frozen_p (w
))
16145 && CHARPOS (startp
) >= BEGV
16146 && CHARPOS (startp
) <= ZV
)
16148 ptrdiff_t it_charpos
;
16150 w
->optional_new_start
= 0;
16151 start_display (&it
, w
, startp
);
16152 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16153 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16154 /* Record IT's position now, since line_bottom_y might change
16156 it_charpos
= IT_CHARPOS (it
);
16157 /* Make sure we set the force_start flag only if the cursor row
16158 will be fully visible. Otherwise, the code under force_start
16159 label below will try to move point back into view, which is
16160 not what the code which sets optional_new_start wants. */
16161 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16162 && !w
->force_start
)
16164 if (it_charpos
== PT
)
16165 w
->force_start
= 1;
16166 /* IT may overshoot PT if text at PT is invisible. */
16167 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16168 w
->force_start
= 1;
16170 if (w
->force_start
)
16172 if (window_frozen_p (w
))
16173 debug_method_add (w
, "set force_start from frozen window start");
16175 debug_method_add (w
, "set force_start from optional_new_start");
16183 /* Handle case where place to start displaying has been specified,
16184 unless the specified location is outside the accessible range. */
16185 if (w
->force_start
)
16187 /* We set this later on if we have to adjust point. */
16190 w
->force_start
= 0;
16192 w
->window_end_valid
= 0;
16194 /* Forget any recorded base line for line number display. */
16195 if (!buffer_unchanged_p
)
16196 w
->base_line_number
= 0;
16198 /* Redisplay the mode line. Select the buffer properly for that.
16199 Also, run the hook window-scroll-functions
16200 because we have scrolled. */
16201 /* Note, we do this after clearing force_start because
16202 if there's an error, it is better to forget about force_start
16203 than to get into an infinite loop calling the hook functions
16204 and having them get more errors. */
16205 if (!update_mode_line
16206 || ! NILP (Vwindow_scroll_functions
))
16208 update_mode_line
= 1;
16209 w
->update_mode_line
= 1;
16210 startp
= run_window_scroll_functions (window
, startp
);
16213 if (CHARPOS (startp
) < BEGV
)
16214 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16215 else if (CHARPOS (startp
) > ZV
)
16216 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16218 /* Redisplay, then check if cursor has been set during the
16219 redisplay. Give up if new fonts were loaded. */
16220 /* We used to issue a CHECK_MARGINS argument to try_window here,
16221 but this causes scrolling to fail when point begins inside
16222 the scroll margin (bug#148) -- cyd */
16223 if (!try_window (window
, startp
, 0))
16225 w
->force_start
= 1;
16226 clear_glyph_matrix (w
->desired_matrix
);
16227 goto need_larger_matrices
;
16230 if (w
->cursor
.vpos
< 0)
16232 /* If point does not appear, try to move point so it does
16233 appear. The desired matrix has been built above, so we
16234 can use it here. */
16235 new_vpos
= window_box_height (w
) / 2;
16238 if (!cursor_row_fully_visible_p (w
, 0, 0))
16240 /* Point does appear, but on a line partly visible at end of window.
16241 Move it back to a fully-visible line. */
16242 new_vpos
= window_box_height (w
);
16243 /* But if window_box_height suggests a Y coordinate that is
16244 not less than we already have, that line will clearly not
16245 be fully visible, so give up and scroll the display.
16246 This can happen when the default face uses a font whose
16247 dimensions are different from the frame's default
16249 if (new_vpos
>= w
->cursor
.y
)
16251 w
->cursor
.vpos
= -1;
16252 clear_glyph_matrix (w
->desired_matrix
);
16253 goto try_to_scroll
;
16256 else if (w
->cursor
.vpos
>= 0)
16258 /* Some people insist on not letting point enter the scroll
16259 margin, even though this part handles windows that didn't
16261 int window_total_lines
16262 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16263 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16264 int pixel_margin
= margin
* frame_line_height
;
16265 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16267 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16268 below, which finds the row to move point to, advances by
16269 the Y coordinate of the _next_ row, see the definition of
16270 MATRIX_ROW_BOTTOM_Y. */
16271 if (w
->cursor
.vpos
< margin
+ header_line
)
16273 w
->cursor
.vpos
= -1;
16274 clear_glyph_matrix (w
->desired_matrix
);
16275 goto try_to_scroll
;
16279 int window_height
= window_box_height (w
);
16282 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16283 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16285 w
->cursor
.vpos
= -1;
16286 clear_glyph_matrix (w
->desired_matrix
);
16287 goto try_to_scroll
;
16292 /* If we need to move point for either of the above reasons,
16293 now actually do it. */
16296 struct glyph_row
*row
;
16298 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16299 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16302 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16303 MATRIX_ROW_START_BYTEPOS (row
));
16305 if (w
!= XWINDOW (selected_window
))
16306 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16307 else if (current_buffer
== old
)
16308 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16310 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16312 /* Re-run pre-redisplay-function so it can update the region
16313 according to the new position of point. */
16314 /* Other than the cursor, w's redisplay is done so we can set its
16315 redisplay to false. Also the buffer's redisplay can be set to
16316 false, since propagate_buffer_redisplay should have already
16317 propagated its info to `w' anyway. */
16318 w
->redisplay
= false;
16319 XBUFFER (w
->contents
)->text
->redisplay
= false;
16320 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16322 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16324 /* pre-redisplay-function made changes (e.g. move the region)
16325 that require another round of redisplay. */
16326 clear_glyph_matrix (w
->desired_matrix
);
16327 if (!try_window (window
, startp
, 0))
16328 goto need_larger_matrices
;
16331 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, 0, 0))
16333 clear_glyph_matrix (w
->desired_matrix
);
16334 goto try_to_scroll
;
16338 debug_method_add (w
, "forced window start");
16343 /* Handle case where text has not changed, only point, and it has
16344 not moved off the frame, and we are not retrying after hscroll.
16345 (current_matrix_up_to_date_p is nonzero when retrying.) */
16346 if (current_matrix_up_to_date_p
16347 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16348 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16352 case CURSOR_MOVEMENT_SUCCESS
:
16353 used_current_matrix_p
= 1;
16356 case CURSOR_MOVEMENT_MUST_SCROLL
:
16357 goto try_to_scroll
;
16363 /* If current starting point was originally the beginning of a line
16364 but no longer is, find a new starting point. */
16365 else if (w
->start_at_line_beg
16366 && !(CHARPOS (startp
) <= BEGV
16367 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16370 debug_method_add (w
, "recenter 1");
16375 /* Try scrolling with try_window_id. Value is > 0 if update has
16376 been done, it is -1 if we know that the same window start will
16377 not work. It is 0 if unsuccessful for some other reason. */
16378 else if ((tem
= try_window_id (w
)) != 0)
16381 debug_method_add (w
, "try_window_id %d", tem
);
16384 if (f
->fonts_changed
)
16385 goto need_larger_matrices
;
16389 /* Otherwise try_window_id has returned -1 which means that we
16390 don't want the alternative below this comment to execute. */
16392 else if (CHARPOS (startp
) >= BEGV
16393 && CHARPOS (startp
) <= ZV
16394 && PT
>= CHARPOS (startp
)
16395 && (CHARPOS (startp
) < ZV
16396 /* Avoid starting at end of buffer. */
16397 || CHARPOS (startp
) == BEGV
16398 || !window_outdated (w
)))
16400 int d1
, d2
, d5
, d6
;
16403 /* If first window line is a continuation line, and window start
16404 is inside the modified region, but the first change is before
16405 current window start, we must select a new window start.
16407 However, if this is the result of a down-mouse event (e.g. by
16408 extending the mouse-drag-overlay), we don't want to select a
16409 new window start, since that would change the position under
16410 the mouse, resulting in an unwanted mouse-movement rather
16411 than a simple mouse-click. */
16412 if (!w
->start_at_line_beg
16413 && NILP (do_mouse_tracking
)
16414 && CHARPOS (startp
) > BEGV
16415 && CHARPOS (startp
) > BEG
+ beg_unchanged
16416 && CHARPOS (startp
) <= Z
- end_unchanged
16417 /* Even if w->start_at_line_beg is nil, a new window may
16418 start at a line_beg, since that's how set_buffer_window
16419 sets it. So, we need to check the return value of
16420 compute_window_start_on_continuation_line. (See also
16422 && XMARKER (w
->start
)->buffer
== current_buffer
16423 && compute_window_start_on_continuation_line (w
)
16424 /* It doesn't make sense to force the window start like we
16425 do at label force_start if it is already known that point
16426 will not be fully visible in the resulting window, because
16427 doing so will move point from its correct position
16428 instead of scrolling the window to bring point into view.
16430 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16431 /* A very tall row could need more than the window height,
16432 in which case we accept that it is partially visible. */
16433 && (rtop
!= 0) == (rbot
!= 0))
16435 w
->force_start
= 1;
16436 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16438 debug_method_add (w
, "recomputed window start in continuation line");
16444 debug_method_add (w
, "same window start");
16447 /* Try to redisplay starting at same place as before.
16448 If point has not moved off frame, accept the results. */
16449 if (!current_matrix_up_to_date_p
16450 /* Don't use try_window_reusing_current_matrix in this case
16451 because a window scroll function can have changed the
16453 || !NILP (Vwindow_scroll_functions
)
16454 || MINI_WINDOW_P (w
)
16455 || !(used_current_matrix_p
16456 = try_window_reusing_current_matrix (w
)))
16458 IF_DEBUG (debug_method_add (w
, "1"));
16459 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16460 /* -1 means we need to scroll.
16461 0 means we need new matrices, but fonts_changed
16462 is set in that case, so we will detect it below. */
16463 goto try_to_scroll
;
16466 if (f
->fonts_changed
)
16467 goto need_larger_matrices
;
16469 if (w
->cursor
.vpos
>= 0)
16471 if (!just_this_one_p
16472 || current_buffer
->clip_changed
16473 || BEG_UNCHANGED
< CHARPOS (startp
))
16474 /* Forget any recorded base line for line number display. */
16475 w
->base_line_number
= 0;
16477 if (!cursor_row_fully_visible_p (w
, 1, 0))
16479 clear_glyph_matrix (w
->desired_matrix
);
16480 last_line_misfit
= 1;
16482 /* Drop through and scroll. */
16487 clear_glyph_matrix (w
->desired_matrix
);
16492 /* Redisplay the mode line. Select the buffer properly for that. */
16493 if (!update_mode_line
)
16495 update_mode_line
= 1;
16496 w
->update_mode_line
= 1;
16499 /* Try to scroll by specified few lines. */
16500 if ((scroll_conservatively
16501 || emacs_scroll_step
16502 || temp_scroll_step
16503 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16504 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16505 && CHARPOS (startp
) >= BEGV
16506 && CHARPOS (startp
) <= ZV
)
16508 /* The function returns -1 if new fonts were loaded, 1 if
16509 successful, 0 if not successful. */
16510 int ss
= try_scrolling (window
, just_this_one_p
,
16511 scroll_conservatively
,
16513 temp_scroll_step
, last_line_misfit
);
16516 case SCROLLING_SUCCESS
:
16519 case SCROLLING_NEED_LARGER_MATRICES
:
16520 goto need_larger_matrices
;
16522 case SCROLLING_FAILED
:
16530 /* Finally, just choose a place to start which positions point
16531 according to user preferences. */
16536 debug_method_add (w
, "recenter");
16539 /* Forget any previously recorded base line for line number display. */
16540 if (!buffer_unchanged_p
)
16541 w
->base_line_number
= 0;
16543 /* Determine the window start relative to point. */
16544 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16545 it
.current_y
= it
.last_visible_y
;
16546 if (centering_position
< 0)
16548 int window_total_lines
16549 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16552 ? min (scroll_margin
, window_total_lines
/ 4)
16554 ptrdiff_t margin_pos
= CHARPOS (startp
);
16555 Lisp_Object aggressive
;
16558 /* If there is a scroll margin at the top of the window, find
16559 its character position. */
16561 /* Cannot call start_display if startp is not in the
16562 accessible region of the buffer. This can happen when we
16563 have just switched to a different buffer and/or changed
16564 its restriction. In that case, startp is initialized to
16565 the character position 1 (BEGV) because we did not yet
16566 have chance to display the buffer even once. */
16567 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16570 void *it1data
= NULL
;
16572 SAVE_IT (it1
, it
, it1data
);
16573 start_display (&it1
, w
, startp
);
16574 move_it_vertically (&it1
, margin
* frame_line_height
);
16575 margin_pos
= IT_CHARPOS (it1
);
16576 RESTORE_IT (&it
, &it
, it1data
);
16578 scrolling_up
= PT
> margin_pos
;
16581 ? BVAR (current_buffer
, scroll_up_aggressively
)
16582 : BVAR (current_buffer
, scroll_down_aggressively
);
16584 if (!MINI_WINDOW_P (w
)
16585 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16589 /* Setting scroll-conservatively overrides
16590 scroll-*-aggressively. */
16591 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16593 double float_amount
= XFLOATINT (aggressive
);
16595 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16596 if (pt_offset
== 0 && float_amount
> 0)
16598 if (pt_offset
&& margin
> 0)
16601 /* Compute how much to move the window start backward from
16602 point so that point will be displayed where the user
16606 centering_position
= it
.last_visible_y
;
16608 centering_position
-= pt_offset
;
16609 centering_position
-=
16610 frame_line_height
* (1 + margin
+ (last_line_misfit
!= 0))
16611 + WINDOW_HEADER_LINE_HEIGHT (w
);
16612 /* Don't let point enter the scroll margin near top of
16614 if (centering_position
< margin
* frame_line_height
)
16615 centering_position
= margin
* frame_line_height
;
16618 centering_position
= margin
* frame_line_height
+ pt_offset
;
16621 /* Set the window start half the height of the window backward
16623 centering_position
= window_box_height (w
) / 2;
16625 move_it_vertically_backward (&it
, centering_position
);
16627 eassert (IT_CHARPOS (it
) >= BEGV
);
16629 /* The function move_it_vertically_backward may move over more
16630 than the specified y-distance. If it->w is small, e.g. a
16631 mini-buffer window, we may end up in front of the window's
16632 display area. Start displaying at the start of the line
16633 containing PT in this case. */
16634 if (it
.current_y
<= 0)
16636 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16637 move_it_vertically_backward (&it
, 0);
16641 it
.current_x
= it
.hpos
= 0;
16643 /* Set the window start position here explicitly, to avoid an
16644 infinite loop in case the functions in window-scroll-functions
16646 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16648 /* Run scroll hooks. */
16649 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16651 /* Redisplay the window. */
16652 if (!current_matrix_up_to_date_p
16653 || windows_or_buffers_changed
16654 || f
->cursor_type_changed
16655 /* Don't use try_window_reusing_current_matrix in this case
16656 because it can have changed the buffer. */
16657 || !NILP (Vwindow_scroll_functions
)
16658 || !just_this_one_p
16659 || MINI_WINDOW_P (w
)
16660 || !(used_current_matrix_p
16661 = try_window_reusing_current_matrix (w
)))
16662 try_window (window
, startp
, 0);
16664 /* If new fonts have been loaded (due to fontsets), give up. We
16665 have to start a new redisplay since we need to re-adjust glyph
16667 if (f
->fonts_changed
)
16668 goto need_larger_matrices
;
16670 /* If cursor did not appear assume that the middle of the window is
16671 in the first line of the window. Do it again with the next line.
16672 (Imagine a window of height 100, displaying two lines of height
16673 60. Moving back 50 from it->last_visible_y will end in the first
16675 if (w
->cursor
.vpos
< 0)
16677 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16679 clear_glyph_matrix (w
->desired_matrix
);
16680 move_it_by_lines (&it
, 1);
16681 try_window (window
, it
.current
.pos
, 0);
16683 else if (PT
< IT_CHARPOS (it
))
16685 clear_glyph_matrix (w
->desired_matrix
);
16686 move_it_by_lines (&it
, -1);
16687 try_window (window
, it
.current
.pos
, 0);
16691 /* Not much we can do about it. */
16695 /* Consider the following case: Window starts at BEGV, there is
16696 invisible, intangible text at BEGV, so that display starts at
16697 some point START > BEGV. It can happen that we are called with
16698 PT somewhere between BEGV and START. Try to handle that case,
16699 and similar ones. */
16700 if (w
->cursor
.vpos
< 0)
16702 /* First, try locating the proper glyph row for PT. */
16703 struct glyph_row
*row
=
16704 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16706 /* Sometimes point is at the beginning of invisible text that is
16707 before the 1st character displayed in the row. In that case,
16708 row_containing_pos fails to find the row, because no glyphs
16709 with appropriate buffer positions are present in the row.
16710 Therefore, we next try to find the row which shows the 1st
16711 position after the invisible text. */
16715 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16718 if (TEXT_PROP_MEANS_INVISIBLE (val
))
16721 Lisp_Object invis_end
=
16722 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16725 if (NATNUMP (invis_end
))
16726 alt_pos
= XFASTINT (invis_end
);
16729 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16733 /* Finally, fall back on the first row of the window after the
16734 header line (if any). This is slightly better than not
16735 displaying the cursor at all. */
16738 row
= w
->current_matrix
->rows
;
16739 if (row
->mode_line_p
)
16742 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16745 if (!cursor_row_fully_visible_p (w
, 0, 0))
16747 /* If vscroll is enabled, disable it and try again. */
16751 clear_glyph_matrix (w
->desired_matrix
);
16755 /* Users who set scroll-conservatively to a large number want
16756 point just above/below the scroll margin. If we ended up
16757 with point's row partially visible, move the window start to
16758 make that row fully visible and out of the margin. */
16759 if (scroll_conservatively
> SCROLL_LIMIT
)
16761 int window_total_lines
16762 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16765 ? min (scroll_margin
, window_total_lines
/ 4)
16767 int move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16769 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16770 clear_glyph_matrix (w
->desired_matrix
);
16771 if (1 == try_window (window
, it
.current
.pos
,
16772 TRY_WINDOW_CHECK_MARGINS
))
16776 /* If centering point failed to make the whole line visible,
16777 put point at the top instead. That has to make the whole line
16778 visible, if it can be done. */
16779 if (centering_position
== 0)
16782 clear_glyph_matrix (w
->desired_matrix
);
16783 centering_position
= 0;
16789 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16790 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16791 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16793 /* Display the mode line, if we must. */
16794 if ((update_mode_line
16795 /* If window not full width, must redo its mode line
16796 if (a) the window to its side is being redone and
16797 (b) we do a frame-based redisplay. This is a consequence
16798 of how inverted lines are drawn in frame-based redisplay. */
16799 || (!just_this_one_p
16800 && !FRAME_WINDOW_P (f
)
16801 && !WINDOW_FULL_WIDTH_P (w
))
16802 /* Line number to display. */
16803 || w
->base_line_pos
> 0
16804 /* Column number is displayed and different from the one displayed. */
16805 || (w
->column_number_displayed
!= -1
16806 && (w
->column_number_displayed
!= current_column ())))
16807 /* This means that the window has a mode line. */
16808 && (WINDOW_WANTS_MODELINE_P (w
)
16809 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16812 display_mode_lines (w
);
16814 /* If mode line height has changed, arrange for a thorough
16815 immediate redisplay using the correct mode line height. */
16816 if (WINDOW_WANTS_MODELINE_P (w
)
16817 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16819 f
->fonts_changed
= 1;
16820 w
->mode_line_height
= -1;
16821 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16822 = DESIRED_MODE_LINE_HEIGHT (w
);
16825 /* If header line height has changed, arrange for a thorough
16826 immediate redisplay using the correct header line height. */
16827 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16828 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16830 f
->fonts_changed
= 1;
16831 w
->header_line_height
= -1;
16832 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16833 = DESIRED_HEADER_LINE_HEIGHT (w
);
16836 if (f
->fonts_changed
)
16837 goto need_larger_matrices
;
16840 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16842 w
->base_line_pos
= 0;
16843 w
->base_line_number
= 0;
16848 /* When we reach a frame's selected window, redo the frame's menu bar. */
16849 if (update_mode_line
16850 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16852 int redisplay_menu_p
= 0;
16854 if (FRAME_WINDOW_P (f
))
16856 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16857 || defined (HAVE_NS) || defined (USE_GTK)
16858 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16860 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16864 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16866 if (redisplay_menu_p
)
16867 display_menu_bar (w
);
16869 #ifdef HAVE_WINDOW_SYSTEM
16870 if (FRAME_WINDOW_P (f
))
16872 #if defined (USE_GTK) || defined (HAVE_NS)
16873 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16874 redisplay_tool_bar (f
);
16876 if (WINDOWP (f
->tool_bar_window
)
16877 && (FRAME_TOOL_BAR_HEIGHT (f
) > 0
16878 || !NILP (Vauto_resize_tool_bars
))
16879 && redisplay_tool_bar (f
))
16880 ignore_mouse_drag_p
= 1;
16886 #ifdef HAVE_WINDOW_SYSTEM
16887 if (FRAME_WINDOW_P (f
)
16888 && update_window_fringes (w
, (just_this_one_p
16889 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16890 || w
->pseudo_window_p
)))
16894 if (draw_window_fringes (w
, 1))
16896 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16897 x_draw_right_divider (w
);
16899 x_draw_vertical_border (w
);
16905 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16906 x_draw_bottom_divider (w
);
16907 #endif /* HAVE_WINDOW_SYSTEM */
16909 /* We go to this label, with fonts_changed set, if it is
16910 necessary to try again using larger glyph matrices.
16911 We have to redeem the scroll bar even in this case,
16912 because the loop in redisplay_internal expects that. */
16913 need_larger_matrices
:
16915 finish_scroll_bars
:
16917 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16919 /* Set the thumb's position and size. */
16920 set_vertical_scroll_bar (w
);
16922 /* Note that we actually used the scroll bar attached to this
16923 window, so it shouldn't be deleted at the end of redisplay. */
16924 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16925 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16928 /* Restore current_buffer and value of point in it. The window
16929 update may have changed the buffer, so first make sure `opoint'
16930 is still valid (Bug#6177). */
16931 if (CHARPOS (opoint
) < BEGV
)
16932 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16933 else if (CHARPOS (opoint
) > ZV
)
16934 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16936 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16938 set_buffer_internal_1 (old
);
16939 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16940 shorter. This can be caused by log truncation in *Messages*. */
16941 if (CHARPOS (lpoint
) <= ZV
)
16942 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16944 unbind_to (count
, Qnil
);
16948 /* Build the complete desired matrix of WINDOW with a window start
16949 buffer position POS.
16951 Value is 1 if successful. It is zero if fonts were loaded during
16952 redisplay which makes re-adjusting glyph matrices necessary, and -1
16953 if point would appear in the scroll margins.
16954 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16955 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16959 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16961 struct window
*w
= XWINDOW (window
);
16963 struct glyph_row
*last_text_row
= NULL
;
16964 struct frame
*f
= XFRAME (w
->frame
);
16965 int frame_line_height
= default_line_pixel_height (w
);
16967 /* Make POS the new window start. */
16968 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16970 /* Mark cursor position as unknown. No overlay arrow seen. */
16971 w
->cursor
.vpos
= -1;
16972 overlay_arrow_seen
= 0;
16974 /* Initialize iterator and info to start at POS. */
16975 start_display (&it
, w
, pos
);
16977 /* Display all lines of W. */
16978 while (it
.current_y
< it
.last_visible_y
)
16980 if (display_line (&it
))
16981 last_text_row
= it
.glyph_row
- 1;
16982 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16986 /* Don't let the cursor end in the scroll margins. */
16987 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16988 && !MINI_WINDOW_P (w
))
16990 int this_scroll_margin
;
16991 int window_total_lines
16992 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16994 if (scroll_margin
> 0)
16996 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16997 this_scroll_margin
*= frame_line_height
;
17000 this_scroll_margin
= 0;
17002 if ((w
->cursor
.y
>= 0 /* not vscrolled */
17003 && w
->cursor
.y
< this_scroll_margin
17004 && CHARPOS (pos
) > BEGV
17005 && IT_CHARPOS (it
) < ZV
)
17006 /* rms: considering make_cursor_line_fully_visible_p here
17007 seems to give wrong results. We don't want to recenter
17008 when the last line is partly visible, we want to allow
17009 that case to be handled in the usual way. */
17010 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
17012 w
->cursor
.vpos
= -1;
17013 clear_glyph_matrix (w
->desired_matrix
);
17018 /* If bottom moved off end of frame, change mode line percentage. */
17019 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
17020 w
->update_mode_line
= 1;
17022 /* Set window_end_pos to the offset of the last character displayed
17023 on the window from the end of current_buffer. Set
17024 window_end_vpos to its row number. */
17027 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17028 adjust_window_ends (w
, last_text_row
, 0);
17030 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17031 w
->window_end_vpos
)));
17035 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17036 w
->window_end_pos
= Z
- ZV
;
17037 w
->window_end_vpos
= 0;
17040 /* But that is not valid info until redisplay finishes. */
17041 w
->window_end_valid
= 0;
17047 /************************************************************************
17048 Window redisplay reusing current matrix when buffer has not changed
17049 ************************************************************************/
17051 /* Try redisplay of window W showing an unchanged buffer with a
17052 different window start than the last time it was displayed by
17053 reusing its current matrix. Value is non-zero if successful.
17054 W->start is the new window start. */
17057 try_window_reusing_current_matrix (struct window
*w
)
17059 struct frame
*f
= XFRAME (w
->frame
);
17060 struct glyph_row
*bottom_row
;
17063 struct text_pos start
, new_start
;
17064 int nrows_scrolled
, i
;
17065 struct glyph_row
*last_text_row
;
17066 struct glyph_row
*last_reused_text_row
;
17067 struct glyph_row
*start_row
;
17068 int start_vpos
, min_y
, max_y
;
17071 if (inhibit_try_window_reusing
)
17075 if (/* This function doesn't handle terminal frames. */
17076 !FRAME_WINDOW_P (f
)
17077 /* Don't try to reuse the display if windows have been split
17079 || windows_or_buffers_changed
17080 || f
->cursor_type_changed
)
17083 /* Can't do this if showing trailing whitespace. */
17084 if (!NILP (Vshow_trailing_whitespace
))
17087 /* If top-line visibility has changed, give up. */
17088 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17089 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17092 /* Give up if old or new display is scrolled vertically. We could
17093 make this function handle this, but right now it doesn't. */
17094 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17095 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17098 /* The variable new_start now holds the new window start. The old
17099 start `start' can be determined from the current matrix. */
17100 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17101 start
= start_row
->minpos
;
17102 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17104 /* Clear the desired matrix for the display below. */
17105 clear_glyph_matrix (w
->desired_matrix
);
17107 if (CHARPOS (new_start
) <= CHARPOS (start
))
17109 /* Don't use this method if the display starts with an ellipsis
17110 displayed for invisible text. It's not easy to handle that case
17111 below, and it's certainly not worth the effort since this is
17112 not a frequent case. */
17113 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17116 IF_DEBUG (debug_method_add (w
, "twu1"));
17118 /* Display up to a row that can be reused. The variable
17119 last_text_row is set to the last row displayed that displays
17120 text. Note that it.vpos == 0 if or if not there is a
17121 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17122 start_display (&it
, w
, new_start
);
17123 w
->cursor
.vpos
= -1;
17124 last_text_row
= last_reused_text_row
= NULL
;
17126 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17128 /* If we have reached into the characters in the START row,
17129 that means the line boundaries have changed. So we
17130 can't start copying with the row START. Maybe it will
17131 work to start copying with the following row. */
17132 while (IT_CHARPOS (it
) > CHARPOS (start
))
17134 /* Advance to the next row as the "start". */
17136 start
= start_row
->minpos
;
17137 /* If there are no more rows to try, or just one, give up. */
17138 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17139 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17140 || CHARPOS (start
) == ZV
)
17142 clear_glyph_matrix (w
->desired_matrix
);
17146 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17148 /* If we have reached alignment, we can copy the rest of the
17150 if (IT_CHARPOS (it
) == CHARPOS (start
)
17151 /* Don't accept "alignment" inside a display vector,
17152 since start_row could have started in the middle of
17153 that same display vector (thus their character
17154 positions match), and we have no way of telling if
17155 that is the case. */
17156 && it
.current
.dpvec_index
< 0)
17159 if (display_line (&it
))
17160 last_text_row
= it
.glyph_row
- 1;
17164 /* A value of current_y < last_visible_y means that we stopped
17165 at the previous window start, which in turn means that we
17166 have at least one reusable row. */
17167 if (it
.current_y
< it
.last_visible_y
)
17169 struct glyph_row
*row
;
17171 /* IT.vpos always starts from 0; it counts text lines. */
17172 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17174 /* Find PT if not already found in the lines displayed. */
17175 if (w
->cursor
.vpos
< 0)
17177 int dy
= it
.current_y
- start_row
->y
;
17179 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17180 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17182 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17183 dy
, nrows_scrolled
);
17186 clear_glyph_matrix (w
->desired_matrix
);
17191 /* Scroll the display. Do it before the current matrix is
17192 changed. The problem here is that update has not yet
17193 run, i.e. part of the current matrix is not up to date.
17194 scroll_run_hook will clear the cursor, and use the
17195 current matrix to get the height of the row the cursor is
17197 run
.current_y
= start_row
->y
;
17198 run
.desired_y
= it
.current_y
;
17199 run
.height
= it
.last_visible_y
- it
.current_y
;
17201 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17204 FRAME_RIF (f
)->update_window_begin_hook (w
);
17205 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17206 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17207 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17211 /* Shift current matrix down by nrows_scrolled lines. */
17212 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17213 rotate_matrix (w
->current_matrix
,
17215 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17218 /* Disable lines that must be updated. */
17219 for (i
= 0; i
< nrows_scrolled
; ++i
)
17220 (start_row
+ i
)->enabled_p
= false;
17222 /* Re-compute Y positions. */
17223 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17224 max_y
= it
.last_visible_y
;
17225 for (row
= start_row
+ nrows_scrolled
;
17229 row
->y
= it
.current_y
;
17230 row
->visible_height
= row
->height
;
17232 if (row
->y
< min_y
)
17233 row
->visible_height
-= min_y
- row
->y
;
17234 if (row
->y
+ row
->height
> max_y
)
17235 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17236 if (row
->fringe_bitmap_periodic_p
)
17237 row
->redraw_fringe_bitmaps_p
= 1;
17239 it
.current_y
+= row
->height
;
17241 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17242 last_reused_text_row
= row
;
17243 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17247 /* Disable lines in the current matrix which are now
17248 below the window. */
17249 for (++row
; row
< bottom_row
; ++row
)
17250 row
->enabled_p
= row
->mode_line_p
= 0;
17253 /* Update window_end_pos etc.; last_reused_text_row is the last
17254 reused row from the current matrix containing text, if any.
17255 The value of last_text_row is the last displayed line
17256 containing text. */
17257 if (last_reused_text_row
)
17258 adjust_window_ends (w
, last_reused_text_row
, 1);
17259 else if (last_text_row
)
17260 adjust_window_ends (w
, last_text_row
, 0);
17263 /* This window must be completely empty. */
17264 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17265 w
->window_end_pos
= Z
- ZV
;
17266 w
->window_end_vpos
= 0;
17268 w
->window_end_valid
= 0;
17270 /* Update hint: don't try scrolling again in update_window. */
17271 w
->desired_matrix
->no_scrolling_p
= 1;
17274 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17278 else if (CHARPOS (new_start
) > CHARPOS (start
))
17280 struct glyph_row
*pt_row
, *row
;
17281 struct glyph_row
*first_reusable_row
;
17282 struct glyph_row
*first_row_to_display
;
17284 int yb
= window_text_bottom_y (w
);
17286 /* Find the row starting at new_start, if there is one. Don't
17287 reuse a partially visible line at the end. */
17288 first_reusable_row
= start_row
;
17289 while (first_reusable_row
->enabled_p
17290 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17291 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17292 < CHARPOS (new_start
)))
17293 ++first_reusable_row
;
17295 /* Give up if there is no row to reuse. */
17296 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17297 || !first_reusable_row
->enabled_p
17298 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17299 != CHARPOS (new_start
)))
17302 /* We can reuse fully visible rows beginning with
17303 first_reusable_row to the end of the window. Set
17304 first_row_to_display to the first row that cannot be reused.
17305 Set pt_row to the row containing point, if there is any. */
17307 for (first_row_to_display
= first_reusable_row
;
17308 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17309 ++first_row_to_display
)
17311 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17312 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17313 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17314 && first_row_to_display
->ends_at_zv_p
17315 && pt_row
== NULL
)))
17316 pt_row
= first_row_to_display
;
17319 /* Start displaying at the start of first_row_to_display. */
17320 eassert (first_row_to_display
->y
< yb
);
17321 init_to_row_start (&it
, w
, first_row_to_display
);
17323 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17325 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17327 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17328 + WINDOW_HEADER_LINE_HEIGHT (w
));
17330 /* Display lines beginning with first_row_to_display in the
17331 desired matrix. Set last_text_row to the last row displayed
17332 that displays text. */
17333 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17334 if (pt_row
== NULL
)
17335 w
->cursor
.vpos
= -1;
17336 last_text_row
= NULL
;
17337 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17338 if (display_line (&it
))
17339 last_text_row
= it
.glyph_row
- 1;
17341 /* If point is in a reused row, adjust y and vpos of the cursor
17345 w
->cursor
.vpos
-= nrows_scrolled
;
17346 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17349 /* Give up if point isn't in a row displayed or reused. (This
17350 also handles the case where w->cursor.vpos < nrows_scrolled
17351 after the calls to display_line, which can happen with scroll
17352 margins. See bug#1295.) */
17353 if (w
->cursor
.vpos
< 0)
17355 clear_glyph_matrix (w
->desired_matrix
);
17359 /* Scroll the display. */
17360 run
.current_y
= first_reusable_row
->y
;
17361 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17362 run
.height
= it
.last_visible_y
- run
.current_y
;
17363 dy
= run
.current_y
- run
.desired_y
;
17368 FRAME_RIF (f
)->update_window_begin_hook (w
);
17369 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17370 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17371 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17375 /* Adjust Y positions of reused rows. */
17376 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17377 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17378 max_y
= it
.last_visible_y
;
17379 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17382 row
->visible_height
= row
->height
;
17383 if (row
->y
< min_y
)
17384 row
->visible_height
-= min_y
- row
->y
;
17385 if (row
->y
+ row
->height
> max_y
)
17386 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17387 if (row
->fringe_bitmap_periodic_p
)
17388 row
->redraw_fringe_bitmaps_p
= 1;
17391 /* Scroll the current matrix. */
17392 eassert (nrows_scrolled
> 0);
17393 rotate_matrix (w
->current_matrix
,
17395 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17398 /* Disable rows not reused. */
17399 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17400 row
->enabled_p
= false;
17402 /* Point may have moved to a different line, so we cannot assume that
17403 the previous cursor position is valid; locate the correct row. */
17406 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17408 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17409 && !row
->ends_at_zv_p
;
17413 w
->cursor
.y
= row
->y
;
17415 if (row
< bottom_row
)
17417 /* Can't simply scan the row for point with
17418 bidi-reordered glyph rows. Let set_cursor_from_row
17419 figure out where to put the cursor, and if it fails,
17421 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17423 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17426 clear_glyph_matrix (w
->desired_matrix
);
17432 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17433 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17436 && (!BUFFERP (glyph
->object
)
17437 || glyph
->charpos
< PT
);
17441 w
->cursor
.x
+= glyph
->pixel_width
;
17447 /* Adjust window end. A null value of last_text_row means that
17448 the window end is in reused rows which in turn means that
17449 only its vpos can have changed. */
17451 adjust_window_ends (w
, last_text_row
, 0);
17453 w
->window_end_vpos
-= nrows_scrolled
;
17455 w
->window_end_valid
= 0;
17456 w
->desired_matrix
->no_scrolling_p
= 1;
17459 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17469 /************************************************************************
17470 Window redisplay reusing current matrix when buffer has changed
17471 ************************************************************************/
17473 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17474 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17475 ptrdiff_t *, ptrdiff_t *);
17476 static struct glyph_row
*
17477 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17478 struct glyph_row
*);
17481 /* Return the last row in MATRIX displaying text. If row START is
17482 non-null, start searching with that row. IT gives the dimensions
17483 of the display. Value is null if matrix is empty; otherwise it is
17484 a pointer to the row found. */
17486 static struct glyph_row
*
17487 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17488 struct glyph_row
*start
)
17490 struct glyph_row
*row
, *row_found
;
17492 /* Set row_found to the last row in IT->w's current matrix
17493 displaying text. The loop looks funny but think of partially
17496 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17497 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17499 eassert (row
->enabled_p
);
17501 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17510 /* Return the last row in the current matrix of W that is not affected
17511 by changes at the start of current_buffer that occurred since W's
17512 current matrix was built. Value is null if no such row exists.
17514 BEG_UNCHANGED us the number of characters unchanged at the start of
17515 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17516 first changed character in current_buffer. Characters at positions <
17517 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17518 when the current matrix was built. */
17520 static struct glyph_row
*
17521 find_last_unchanged_at_beg_row (struct window
*w
)
17523 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17524 struct glyph_row
*row
;
17525 struct glyph_row
*row_found
= NULL
;
17526 int yb
= window_text_bottom_y (w
);
17528 /* Find the last row displaying unchanged text. */
17529 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17530 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17531 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17534 if (/* If row ends before first_changed_pos, it is unchanged,
17535 except in some case. */
17536 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17537 /* When row ends in ZV and we write at ZV it is not
17539 && !row
->ends_at_zv_p
17540 /* When first_changed_pos is the end of a continued line,
17541 row is not unchanged because it may be no longer
17543 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17544 && (row
->continued_p
17545 || row
->exact_window_width_line_p
))
17546 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17547 needs to be recomputed, so don't consider this row as
17548 unchanged. This happens when the last line was
17549 bidi-reordered and was killed immediately before this
17550 redisplay cycle. In that case, ROW->end stores the
17551 buffer position of the first visual-order character of
17552 the killed text, which is now beyond ZV. */
17553 && CHARPOS (row
->end
.pos
) <= ZV
)
17556 /* Stop if last visible row. */
17557 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17565 /* Find the first glyph row in the current matrix of W that is not
17566 affected by changes at the end of current_buffer since the
17567 time W's current matrix was built.
17569 Return in *DELTA the number of chars by which buffer positions in
17570 unchanged text at the end of current_buffer must be adjusted.
17572 Return in *DELTA_BYTES the corresponding number of bytes.
17574 Value is null if no such row exists, i.e. all rows are affected by
17577 static struct glyph_row
*
17578 find_first_unchanged_at_end_row (struct window
*w
,
17579 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17581 struct glyph_row
*row
;
17582 struct glyph_row
*row_found
= NULL
;
17584 *delta
= *delta_bytes
= 0;
17586 /* Display must not have been paused, otherwise the current matrix
17587 is not up to date. */
17588 eassert (w
->window_end_valid
);
17590 /* A value of window_end_pos >= END_UNCHANGED means that the window
17591 end is in the range of changed text. If so, there is no
17592 unchanged row at the end of W's current matrix. */
17593 if (w
->window_end_pos
>= END_UNCHANGED
)
17596 /* Set row to the last row in W's current matrix displaying text. */
17597 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17599 /* If matrix is entirely empty, no unchanged row exists. */
17600 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17602 /* The value of row is the last glyph row in the matrix having a
17603 meaningful buffer position in it. The end position of row
17604 corresponds to window_end_pos. This allows us to translate
17605 buffer positions in the current matrix to current buffer
17606 positions for characters not in changed text. */
17608 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17609 ptrdiff_t Z_BYTE_old
=
17610 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17611 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17612 struct glyph_row
*first_text_row
17613 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17615 *delta
= Z
- Z_old
;
17616 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17618 /* Set last_unchanged_pos to the buffer position of the last
17619 character in the buffer that has not been changed. Z is the
17620 index + 1 of the last character in current_buffer, i.e. by
17621 subtracting END_UNCHANGED we get the index of the last
17622 unchanged character, and we have to add BEG to get its buffer
17624 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17625 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17627 /* Search backward from ROW for a row displaying a line that
17628 starts at a minimum position >= last_unchanged_pos_old. */
17629 for (; row
> first_text_row
; --row
)
17631 /* This used to abort, but it can happen.
17632 It is ok to just stop the search instead here. KFS. */
17633 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17636 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17641 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17647 /* Make sure that glyph rows in the current matrix of window W
17648 reference the same glyph memory as corresponding rows in the
17649 frame's frame matrix. This function is called after scrolling W's
17650 current matrix on a terminal frame in try_window_id and
17651 try_window_reusing_current_matrix. */
17654 sync_frame_with_window_matrix_rows (struct window
*w
)
17656 struct frame
*f
= XFRAME (w
->frame
);
17657 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17659 /* Preconditions: W must be a leaf window and full-width. Its frame
17660 must have a frame matrix. */
17661 eassert (BUFFERP (w
->contents
));
17662 eassert (WINDOW_FULL_WIDTH_P (w
));
17663 eassert (!FRAME_WINDOW_P (f
));
17665 /* If W is a full-width window, glyph pointers in W's current matrix
17666 have, by definition, to be the same as glyph pointers in the
17667 corresponding frame matrix. Note that frame matrices have no
17668 marginal areas (see build_frame_matrix). */
17669 window_row
= w
->current_matrix
->rows
;
17670 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17671 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17672 while (window_row
< window_row_end
)
17674 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17675 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17677 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17678 frame_row
->glyphs
[TEXT_AREA
] = start
;
17679 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17680 frame_row
->glyphs
[LAST_AREA
] = end
;
17682 /* Disable frame rows whose corresponding window rows have
17683 been disabled in try_window_id. */
17684 if (!window_row
->enabled_p
)
17685 frame_row
->enabled_p
= false;
17687 ++window_row
, ++frame_row
;
17692 /* Find the glyph row in window W containing CHARPOS. Consider all
17693 rows between START and END (not inclusive). END null means search
17694 all rows to the end of the display area of W. Value is the row
17695 containing CHARPOS or null. */
17698 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17699 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17701 struct glyph_row
*row
= start
;
17702 struct glyph_row
*best_row
= NULL
;
17703 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17706 /* If we happen to start on a header-line, skip that. */
17707 if (row
->mode_line_p
)
17710 if ((end
&& row
>= end
) || !row
->enabled_p
)
17713 last_y
= window_text_bottom_y (w
) - dy
;
17717 /* Give up if we have gone too far. */
17718 if (end
&& row
>= end
)
17720 /* This formerly returned if they were equal.
17721 I think that both quantities are of a "last plus one" type;
17722 if so, when they are equal, the row is within the screen. -- rms. */
17723 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17726 /* If it is in this row, return this row. */
17727 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17728 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17729 /* The end position of a row equals the start
17730 position of the next row. If CHARPOS is there, we
17731 would rather consider it displayed in the next
17732 line, except when this line ends in ZV. */
17733 && !row_for_charpos_p (row
, charpos
)))
17734 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17738 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17739 || (!best_row
&& !row
->continued_p
))
17741 /* In bidi-reordered rows, there could be several rows whose
17742 edges surround CHARPOS, all of these rows belonging to
17743 the same continued line. We need to find the row which
17744 fits CHARPOS the best. */
17745 for (g
= row
->glyphs
[TEXT_AREA
];
17746 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17749 if (!STRINGP (g
->object
))
17751 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17753 mindif
= eabs (g
->charpos
- charpos
);
17755 /* Exact match always wins. */
17762 else if (best_row
&& !row
->continued_p
)
17769 /* Try to redisplay window W by reusing its existing display. W's
17770 current matrix must be up to date when this function is called,
17771 i.e. window_end_valid must be nonzero.
17775 >= 1 if successful, i.e. display has been updated
17777 1 means the changes were in front of a newline that precedes
17778 the window start, and the whole current matrix was reused
17779 2 means the changes were after the last position displayed
17780 in the window, and the whole current matrix was reused
17781 3 means portions of the current matrix were reused, while
17782 some of the screen lines were redrawn
17783 -1 if redisplay with same window start is known not to succeed
17784 0 if otherwise unsuccessful
17786 The following steps are performed:
17788 1. Find the last row in the current matrix of W that is not
17789 affected by changes at the start of current_buffer. If no such row
17792 2. Find the first row in W's current matrix that is not affected by
17793 changes at the end of current_buffer. Maybe there is no such row.
17795 3. Display lines beginning with the row + 1 found in step 1 to the
17796 row found in step 2 or, if step 2 didn't find a row, to the end of
17799 4. If cursor is not known to appear on the window, give up.
17801 5. If display stopped at the row found in step 2, scroll the
17802 display and current matrix as needed.
17804 6. Maybe display some lines at the end of W, if we must. This can
17805 happen under various circumstances, like a partially visible line
17806 becoming fully visible, or because newly displayed lines are displayed
17807 in smaller font sizes.
17809 7. Update W's window end information. */
17812 try_window_id (struct window
*w
)
17814 struct frame
*f
= XFRAME (w
->frame
);
17815 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17816 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17817 struct glyph_row
*last_unchanged_at_beg_row
;
17818 struct glyph_row
*first_unchanged_at_end_row
;
17819 struct glyph_row
*row
;
17820 struct glyph_row
*bottom_row
;
17823 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17825 struct text_pos start_pos
;
17827 int first_unchanged_at_end_vpos
= 0;
17828 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17829 struct text_pos start
;
17830 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17833 if (inhibit_try_window_id
)
17837 /* This is handy for debugging. */
17839 #define GIVE_UP(X) \
17841 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17845 #define GIVE_UP(X) return 0
17848 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17850 /* Don't use this for mini-windows because these can show
17851 messages and mini-buffers, and we don't handle that here. */
17852 if (MINI_WINDOW_P (w
))
17855 /* This flag is used to prevent redisplay optimizations. */
17856 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17859 /* This function's optimizations cannot be used if overlays have
17860 changed in the buffer displayed by the window, so give up if they
17862 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17865 /* Verify that narrowing has not changed.
17866 Also verify that we were not told to prevent redisplay optimizations.
17867 It would be nice to further
17868 reduce the number of cases where this prevents try_window_id. */
17869 if (current_buffer
->clip_changed
17870 || current_buffer
->prevent_redisplay_optimizations_p
)
17873 /* Window must either use window-based redisplay or be full width. */
17874 if (!FRAME_WINDOW_P (f
)
17875 && (!FRAME_LINE_INS_DEL_OK (f
)
17876 || !WINDOW_FULL_WIDTH_P (w
)))
17879 /* Give up if point is known NOT to appear in W. */
17880 if (PT
< CHARPOS (start
))
17883 /* Another way to prevent redisplay optimizations. */
17884 if (w
->last_modified
== 0)
17887 /* Verify that window is not hscrolled. */
17888 if (w
->hscroll
!= 0)
17891 /* Verify that display wasn't paused. */
17892 if (!w
->window_end_valid
)
17895 /* Likewise if highlighting trailing whitespace. */
17896 if (!NILP (Vshow_trailing_whitespace
))
17899 /* Can't use this if overlay arrow position and/or string have
17901 if (overlay_arrows_changed_p ())
17904 /* When word-wrap is on, adding a space to the first word of a
17905 wrapped line can change the wrap position, altering the line
17906 above it. It might be worthwhile to handle this more
17907 intelligently, but for now just redisplay from scratch. */
17908 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17911 /* Under bidi reordering, adding or deleting a character in the
17912 beginning of a paragraph, before the first strong directional
17913 character, can change the base direction of the paragraph (unless
17914 the buffer specifies a fixed paragraph direction), which will
17915 require to redisplay the whole paragraph. It might be worthwhile
17916 to find the paragraph limits and widen the range of redisplayed
17917 lines to that, but for now just give up this optimization and
17918 redisplay from scratch. */
17919 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17920 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17923 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17924 only if buffer has really changed. The reason is that the gap is
17925 initially at Z for freshly visited files. The code below would
17926 set end_unchanged to 0 in that case. */
17927 if (MODIFF
> SAVE_MODIFF
17928 /* This seems to happen sometimes after saving a buffer. */
17929 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17931 if (GPT
- BEG
< BEG_UNCHANGED
)
17932 BEG_UNCHANGED
= GPT
- BEG
;
17933 if (Z
- GPT
< END_UNCHANGED
)
17934 END_UNCHANGED
= Z
- GPT
;
17937 /* The position of the first and last character that has been changed. */
17938 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17939 last_changed_charpos
= Z
- END_UNCHANGED
;
17941 /* If window starts after a line end, and the last change is in
17942 front of that newline, then changes don't affect the display.
17943 This case happens with stealth-fontification. Note that although
17944 the display is unchanged, glyph positions in the matrix have to
17945 be adjusted, of course. */
17946 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17947 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17948 && ((last_changed_charpos
< CHARPOS (start
)
17949 && CHARPOS (start
) == BEGV
)
17950 || (last_changed_charpos
< CHARPOS (start
) - 1
17951 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17953 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17954 struct glyph_row
*r0
;
17956 /* Compute how many chars/bytes have been added to or removed
17957 from the buffer. */
17958 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17959 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17960 Z_delta
= Z
- Z_old
;
17961 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17963 /* Give up if PT is not in the window. Note that it already has
17964 been checked at the start of try_window_id that PT is not in
17965 front of the window start. */
17966 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17969 /* If window start is unchanged, we can reuse the whole matrix
17970 as is, after adjusting glyph positions. No need to compute
17971 the window end again, since its offset from Z hasn't changed. */
17972 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17973 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17974 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17975 /* PT must not be in a partially visible line. */
17976 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17977 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17979 /* Adjust positions in the glyph matrix. */
17980 if (Z_delta
|| Z_delta_bytes
)
17982 struct glyph_row
*r1
17983 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17984 increment_matrix_positions (w
->current_matrix
,
17985 MATRIX_ROW_VPOS (r0
, current_matrix
),
17986 MATRIX_ROW_VPOS (r1
, current_matrix
),
17987 Z_delta
, Z_delta_bytes
);
17990 /* Set the cursor. */
17991 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17993 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17998 /* Handle the case that changes are all below what is displayed in
17999 the window, and that PT is in the window. This shortcut cannot
18000 be taken if ZV is visible in the window, and text has been added
18001 there that is visible in the window. */
18002 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
18003 /* ZV is not visible in the window, or there are no
18004 changes at ZV, actually. */
18005 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
18006 || first_changed_charpos
== last_changed_charpos
))
18008 struct glyph_row
*r0
;
18010 /* Give up if PT is not in the window. Note that it already has
18011 been checked at the start of try_window_id that PT is not in
18012 front of the window start. */
18013 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
18016 /* If window start is unchanged, we can reuse the whole matrix
18017 as is, without changing glyph positions since no text has
18018 been added/removed in front of the window end. */
18019 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18020 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
18021 /* PT must not be in a partially visible line. */
18022 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18023 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18025 /* We have to compute the window end anew since text
18026 could have been added/removed after it. */
18027 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18028 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18030 /* Set the cursor. */
18031 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18033 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18038 /* Give up if window start is in the changed area.
18040 The condition used to read
18042 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18044 but why that was tested escapes me at the moment. */
18045 if (CHARPOS (start
) >= first_changed_charpos
18046 && CHARPOS (start
) <= last_changed_charpos
)
18049 /* Check that window start agrees with the start of the first glyph
18050 row in its current matrix. Check this after we know the window
18051 start is not in changed text, otherwise positions would not be
18053 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18054 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18057 /* Give up if the window ends in strings. Overlay strings
18058 at the end are difficult to handle, so don't try. */
18059 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18060 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18063 /* Compute the position at which we have to start displaying new
18064 lines. Some of the lines at the top of the window might be
18065 reusable because they are not displaying changed text. Find the
18066 last row in W's current matrix not affected by changes at the
18067 start of current_buffer. Value is null if changes start in the
18068 first line of window. */
18069 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18070 if (last_unchanged_at_beg_row
)
18072 /* Avoid starting to display in the middle of a character, a TAB
18073 for instance. This is easier than to set up the iterator
18074 exactly, and it's not a frequent case, so the additional
18075 effort wouldn't really pay off. */
18076 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18077 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18078 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18079 --last_unchanged_at_beg_row
;
18081 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18084 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
18086 start_pos
= it
.current
.pos
;
18088 /* Start displaying new lines in the desired matrix at the same
18089 vpos we would use in the current matrix, i.e. below
18090 last_unchanged_at_beg_row. */
18091 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18093 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18094 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18096 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18100 /* There are no reusable lines at the start of the window.
18101 Start displaying in the first text line. */
18102 start_display (&it
, w
, start
);
18103 it
.vpos
= it
.first_vpos
;
18104 start_pos
= it
.current
.pos
;
18107 /* Find the first row that is not affected by changes at the end of
18108 the buffer. Value will be null if there is no unchanged row, in
18109 which case we must redisplay to the end of the window. delta
18110 will be set to the value by which buffer positions beginning with
18111 first_unchanged_at_end_row have to be adjusted due to text
18113 first_unchanged_at_end_row
18114 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18115 IF_DEBUG (debug_delta
= delta
);
18116 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18118 /* Set stop_pos to the buffer position up to which we will have to
18119 display new lines. If first_unchanged_at_end_row != NULL, this
18120 is the buffer position of the start of the line displayed in that
18121 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18122 that we don't stop at a buffer position. */
18124 if (first_unchanged_at_end_row
)
18126 eassert (last_unchanged_at_beg_row
== NULL
18127 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18129 /* If this is a continuation line, move forward to the next one
18130 that isn't. Changes in lines above affect this line.
18131 Caution: this may move first_unchanged_at_end_row to a row
18132 not displaying text. */
18133 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18134 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18135 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18136 < it
.last_visible_y
))
18137 ++first_unchanged_at_end_row
;
18139 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18140 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18141 >= it
.last_visible_y
))
18142 first_unchanged_at_end_row
= NULL
;
18145 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18147 first_unchanged_at_end_vpos
18148 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18149 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18152 else if (last_unchanged_at_beg_row
== NULL
)
18158 /* Either there is no unchanged row at the end, or the one we have
18159 now displays text. This is a necessary condition for the window
18160 end pos calculation at the end of this function. */
18161 eassert (first_unchanged_at_end_row
== NULL
18162 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18164 debug_last_unchanged_at_beg_vpos
18165 = (last_unchanged_at_beg_row
18166 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18168 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18170 #endif /* GLYPH_DEBUG */
18173 /* Display new lines. Set last_text_row to the last new line
18174 displayed which has text on it, i.e. might end up as being the
18175 line where the window_end_vpos is. */
18176 w
->cursor
.vpos
= -1;
18177 last_text_row
= NULL
;
18178 overlay_arrow_seen
= 0;
18179 while (it
.current_y
< it
.last_visible_y
18180 && !f
->fonts_changed
18181 && (first_unchanged_at_end_row
== NULL
18182 || IT_CHARPOS (it
) < stop_pos
))
18184 if (display_line (&it
))
18185 last_text_row
= it
.glyph_row
- 1;
18188 if (f
->fonts_changed
)
18192 /* Compute differences in buffer positions, y-positions etc. for
18193 lines reused at the bottom of the window. Compute what we can
18195 if (first_unchanged_at_end_row
18196 /* No lines reused because we displayed everything up to the
18197 bottom of the window. */
18198 && it
.current_y
< it
.last_visible_y
)
18201 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18203 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18204 run
.current_y
= first_unchanged_at_end_row
->y
;
18205 run
.desired_y
= run
.current_y
+ dy
;
18206 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18210 delta
= delta_bytes
= dvpos
= dy
18211 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18212 first_unchanged_at_end_row
= NULL
;
18214 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18217 /* Find the cursor if not already found. We have to decide whether
18218 PT will appear on this window (it sometimes doesn't, but this is
18219 not a very frequent case.) This decision has to be made before
18220 the current matrix is altered. A value of cursor.vpos < 0 means
18221 that PT is either in one of the lines beginning at
18222 first_unchanged_at_end_row or below the window. Don't care for
18223 lines that might be displayed later at the window end; as
18224 mentioned, this is not a frequent case. */
18225 if (w
->cursor
.vpos
< 0)
18227 /* Cursor in unchanged rows at the top? */
18228 if (PT
< CHARPOS (start_pos
)
18229 && last_unchanged_at_beg_row
)
18231 row
= row_containing_pos (w
, PT
,
18232 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18233 last_unchanged_at_beg_row
+ 1, 0);
18235 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18238 /* Start from first_unchanged_at_end_row looking for PT. */
18239 else if (first_unchanged_at_end_row
)
18241 row
= row_containing_pos (w
, PT
- delta
,
18242 first_unchanged_at_end_row
, NULL
, 0);
18244 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18245 delta_bytes
, dy
, dvpos
);
18248 /* Give up if cursor was not found. */
18249 if (w
->cursor
.vpos
< 0)
18251 clear_glyph_matrix (w
->desired_matrix
);
18256 /* Don't let the cursor end in the scroll margins. */
18258 int this_scroll_margin
, cursor_height
;
18259 int frame_line_height
= default_line_pixel_height (w
);
18260 int window_total_lines
18261 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18263 this_scroll_margin
=
18264 max (0, min (scroll_margin
, window_total_lines
/ 4));
18265 this_scroll_margin
*= frame_line_height
;
18266 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18268 if ((w
->cursor
.y
< this_scroll_margin
18269 && CHARPOS (start
) > BEGV
)
18270 /* Old redisplay didn't take scroll margin into account at the bottom,
18271 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18272 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18273 ? cursor_height
+ this_scroll_margin
18274 : 1)) > it
.last_visible_y
)
18276 w
->cursor
.vpos
= -1;
18277 clear_glyph_matrix (w
->desired_matrix
);
18282 /* Scroll the display. Do it before changing the current matrix so
18283 that xterm.c doesn't get confused about where the cursor glyph is
18285 if (dy
&& run
.height
)
18289 if (FRAME_WINDOW_P (f
))
18291 FRAME_RIF (f
)->update_window_begin_hook (w
);
18292 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18293 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18294 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
18298 /* Terminal frame. In this case, dvpos gives the number of
18299 lines to scroll by; dvpos < 0 means scroll up. */
18301 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18302 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18303 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18304 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
18305 + window_internal_height (w
));
18307 #if defined (HAVE_GPM) || defined (MSDOS)
18308 x_clear_window_mouse_face (w
);
18310 /* Perform the operation on the screen. */
18313 /* Scroll last_unchanged_at_beg_row to the end of the
18314 window down dvpos lines. */
18315 set_terminal_window (f
, end
);
18317 /* On dumb terminals delete dvpos lines at the end
18318 before inserting dvpos empty lines. */
18319 if (!FRAME_SCROLL_REGION_OK (f
))
18320 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18322 /* Insert dvpos empty lines in front of
18323 last_unchanged_at_beg_row. */
18324 ins_del_lines (f
, from
, dvpos
);
18326 else if (dvpos
< 0)
18328 /* Scroll up last_unchanged_at_beg_vpos to the end of
18329 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18330 set_terminal_window (f
, end
);
18332 /* Delete dvpos lines in front of
18333 last_unchanged_at_beg_vpos. ins_del_lines will set
18334 the cursor to the given vpos and emit |dvpos| delete
18336 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18338 /* On a dumb terminal insert dvpos empty lines at the
18340 if (!FRAME_SCROLL_REGION_OK (f
))
18341 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18344 set_terminal_window (f
, 0);
18350 /* Shift reused rows of the current matrix to the right position.
18351 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18353 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18354 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18357 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18358 bottom_vpos
, dvpos
);
18359 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18362 else if (dvpos
> 0)
18364 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18365 bottom_vpos
, dvpos
);
18366 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18367 first_unchanged_at_end_vpos
+ dvpos
);
18370 /* For frame-based redisplay, make sure that current frame and window
18371 matrix are in sync with respect to glyph memory. */
18372 if (!FRAME_WINDOW_P (f
))
18373 sync_frame_with_window_matrix_rows (w
);
18375 /* Adjust buffer positions in reused rows. */
18376 if (delta
|| delta_bytes
)
18377 increment_matrix_positions (current_matrix
,
18378 first_unchanged_at_end_vpos
+ dvpos
,
18379 bottom_vpos
, delta
, delta_bytes
);
18381 /* Adjust Y positions. */
18383 shift_glyph_matrix (w
, current_matrix
,
18384 first_unchanged_at_end_vpos
+ dvpos
,
18387 if (first_unchanged_at_end_row
)
18389 first_unchanged_at_end_row
+= dvpos
;
18390 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18391 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18392 first_unchanged_at_end_row
= NULL
;
18395 /* If scrolling up, there may be some lines to display at the end of
18397 last_text_row_at_end
= NULL
;
18400 /* Scrolling up can leave for example a partially visible line
18401 at the end of the window to be redisplayed. */
18402 /* Set last_row to the glyph row in the current matrix where the
18403 window end line is found. It has been moved up or down in
18404 the matrix by dvpos. */
18405 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18406 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18408 /* If last_row is the window end line, it should display text. */
18409 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18411 /* If window end line was partially visible before, begin
18412 displaying at that line. Otherwise begin displaying with the
18413 line following it. */
18414 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18416 init_to_row_start (&it
, w
, last_row
);
18417 it
.vpos
= last_vpos
;
18418 it
.current_y
= last_row
->y
;
18422 init_to_row_end (&it
, w
, last_row
);
18423 it
.vpos
= 1 + last_vpos
;
18424 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18428 /* We may start in a continuation line. If so, we have to
18429 get the right continuation_lines_width and current_x. */
18430 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18431 it
.hpos
= it
.current_x
= 0;
18433 /* Display the rest of the lines at the window end. */
18434 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18435 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18437 /* Is it always sure that the display agrees with lines in
18438 the current matrix? I don't think so, so we mark rows
18439 displayed invalid in the current matrix by setting their
18440 enabled_p flag to zero. */
18441 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18442 if (display_line (&it
))
18443 last_text_row_at_end
= it
.glyph_row
- 1;
18447 /* Update window_end_pos and window_end_vpos. */
18448 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18450 /* Window end line if one of the preserved rows from the current
18451 matrix. Set row to the last row displaying text in current
18452 matrix starting at first_unchanged_at_end_row, after
18454 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18455 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18456 first_unchanged_at_end_row
);
18457 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18458 adjust_window_ends (w
, row
, 1);
18459 eassert (w
->window_end_bytepos
>= 0);
18460 IF_DEBUG (debug_method_add (w
, "A"));
18462 else if (last_text_row_at_end
)
18464 adjust_window_ends (w
, last_text_row_at_end
, 0);
18465 eassert (w
->window_end_bytepos
>= 0);
18466 IF_DEBUG (debug_method_add (w
, "B"));
18468 else if (last_text_row
)
18470 /* We have displayed either to the end of the window or at the
18471 end of the window, i.e. the last row with text is to be found
18472 in the desired matrix. */
18473 adjust_window_ends (w
, last_text_row
, 0);
18474 eassert (w
->window_end_bytepos
>= 0);
18476 else if (first_unchanged_at_end_row
== NULL
18477 && last_text_row
== NULL
18478 && last_text_row_at_end
== NULL
)
18480 /* Displayed to end of window, but no line containing text was
18481 displayed. Lines were deleted at the end of the window. */
18482 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
18483 int vpos
= w
->window_end_vpos
;
18484 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18485 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18488 row
== NULL
&& vpos
>= first_vpos
;
18489 --vpos
, --current_row
, --desired_row
)
18491 if (desired_row
->enabled_p
)
18493 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18496 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18500 eassert (row
!= NULL
);
18501 w
->window_end_vpos
= vpos
+ 1;
18502 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18503 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18504 eassert (w
->window_end_bytepos
>= 0);
18505 IF_DEBUG (debug_method_add (w
, "C"));
18510 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18511 debug_end_vpos
= w
->window_end_vpos
));
18513 /* Record that display has not been completed. */
18514 w
->window_end_valid
= 0;
18515 w
->desired_matrix
->no_scrolling_p
= 1;
18523 /***********************************************************************
18524 More debugging support
18525 ***********************************************************************/
18529 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18530 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18531 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18534 /* Dump the contents of glyph matrix MATRIX on stderr.
18536 GLYPHS 0 means don't show glyph contents.
18537 GLYPHS 1 means show glyphs in short form
18538 GLYPHS > 1 means show glyphs in long form. */
18541 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18544 for (i
= 0; i
< matrix
->nrows
; ++i
)
18545 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18549 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18550 the glyph row and area where the glyph comes from. */
18553 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18555 if (glyph
->type
== CHAR_GLYPH
18556 || glyph
->type
== GLYPHLESS_GLYPH
)
18559 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18560 glyph
- row
->glyphs
[TEXT_AREA
],
18561 (glyph
->type
== CHAR_GLYPH
18565 (BUFFERP (glyph
->object
)
18567 : (STRINGP (glyph
->object
)
18569 : (INTEGERP (glyph
->object
)
18572 glyph
->pixel_width
,
18574 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18578 glyph
->left_box_line_p
,
18579 glyph
->right_box_line_p
);
18581 else if (glyph
->type
== STRETCH_GLYPH
)
18584 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18585 glyph
- row
->glyphs
[TEXT_AREA
],
18588 (BUFFERP (glyph
->object
)
18590 : (STRINGP (glyph
->object
)
18592 : (INTEGERP (glyph
->object
)
18595 glyph
->pixel_width
,
18599 glyph
->left_box_line_p
,
18600 glyph
->right_box_line_p
);
18602 else if (glyph
->type
== IMAGE_GLYPH
)
18605 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18606 glyph
- row
->glyphs
[TEXT_AREA
],
18609 (BUFFERP (glyph
->object
)
18611 : (STRINGP (glyph
->object
)
18613 : (INTEGERP (glyph
->object
)
18616 glyph
->pixel_width
,
18620 glyph
->left_box_line_p
,
18621 glyph
->right_box_line_p
);
18623 else if (glyph
->type
== COMPOSITE_GLYPH
)
18626 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18627 glyph
- row
->glyphs
[TEXT_AREA
],
18630 (BUFFERP (glyph
->object
)
18632 : (STRINGP (glyph
->object
)
18634 : (INTEGERP (glyph
->object
)
18637 glyph
->pixel_width
,
18639 if (glyph
->u
.cmp
.automatic
)
18642 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18643 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18645 glyph
->left_box_line_p
,
18646 glyph
->right_box_line_p
);
18651 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18652 GLYPHS 0 means don't show glyph contents.
18653 GLYPHS 1 means show glyphs in short form
18654 GLYPHS > 1 means show glyphs in long form. */
18657 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18661 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18662 fprintf (stderr
, "==============================================================================\n");
18664 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18665 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18667 MATRIX_ROW_START_CHARPOS (row
),
18668 MATRIX_ROW_END_CHARPOS (row
),
18669 row
->used
[TEXT_AREA
],
18670 row
->contains_overlapping_glyphs_p
,
18672 row
->truncated_on_left_p
,
18673 row
->truncated_on_right_p
,
18675 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18676 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18679 row
->ends_in_middle_of_char_p
,
18680 row
->starts_in_middle_of_char_p
,
18686 row
->visible_height
,
18689 /* The next 3 lines should align to "Start" in the header. */
18690 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18691 row
->end
.overlay_string_index
,
18692 row
->continuation_lines_width
);
18693 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18694 CHARPOS (row
->start
.string_pos
),
18695 CHARPOS (row
->end
.string_pos
));
18696 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18697 row
->end
.dpvec_index
);
18704 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18706 struct glyph
*glyph
= row
->glyphs
[area
];
18707 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18709 /* Glyph for a line end in text. */
18710 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18713 if (glyph
< glyph_end
)
18714 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18716 for (; glyph
< glyph_end
; ++glyph
)
18717 dump_glyph (row
, glyph
, area
);
18720 else if (glyphs
== 1)
18724 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18726 char *s
= alloca (row
->used
[area
] + 4);
18729 for (i
= 0; i
< row
->used
[area
]; ++i
)
18731 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18732 if (i
== row
->used
[area
] - 1
18733 && area
== TEXT_AREA
18734 && INTEGERP (glyph
->object
)
18735 && glyph
->type
== CHAR_GLYPH
18736 && glyph
->u
.ch
== ' ')
18738 strcpy (&s
[i
], "[\\n]");
18741 else if (glyph
->type
== CHAR_GLYPH
18742 && glyph
->u
.ch
< 0x80
18743 && glyph
->u
.ch
>= ' ')
18744 s
[i
] = glyph
->u
.ch
;
18750 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18756 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18757 Sdump_glyph_matrix
, 0, 1, "p",
18758 doc
: /* Dump the current matrix of the selected window to stderr.
18759 Shows contents of glyph row structures. With non-nil
18760 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18761 glyphs in short form, otherwise show glyphs in long form. */)
18762 (Lisp_Object glyphs
)
18764 struct window
*w
= XWINDOW (selected_window
);
18765 struct buffer
*buffer
= XBUFFER (w
->contents
);
18767 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18768 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18769 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18770 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18771 fprintf (stderr
, "=============================================\n");
18772 dump_glyph_matrix (w
->current_matrix
,
18773 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18778 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18779 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
18782 struct frame
*f
= XFRAME (selected_frame
);
18783 dump_glyph_matrix (f
->current_matrix
, 1);
18788 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18789 doc
: /* Dump glyph row ROW to stderr.
18790 GLYPH 0 means don't dump glyphs.
18791 GLYPH 1 means dump glyphs in short form.
18792 GLYPH > 1 or omitted means dump glyphs in long form. */)
18793 (Lisp_Object row
, Lisp_Object glyphs
)
18795 struct glyph_matrix
*matrix
;
18798 CHECK_NUMBER (row
);
18799 matrix
= XWINDOW (selected_window
)->current_matrix
;
18801 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18802 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18804 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18809 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18810 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18811 GLYPH 0 means don't dump glyphs.
18812 GLYPH 1 means dump glyphs in short form.
18813 GLYPH > 1 or omitted means dump glyphs in long form.
18815 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18817 (Lisp_Object row
, Lisp_Object glyphs
)
18819 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18820 struct frame
*sf
= SELECTED_FRAME ();
18821 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18824 CHECK_NUMBER (row
);
18826 if (vpos
>= 0 && vpos
< m
->nrows
)
18827 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18828 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18834 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18835 doc
: /* Toggle tracing of redisplay.
18836 With ARG, turn tracing on if and only if ARG is positive. */)
18840 trace_redisplay_p
= !trace_redisplay_p
;
18843 arg
= Fprefix_numeric_value (arg
);
18844 trace_redisplay_p
= XINT (arg
) > 0;
18851 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18852 doc
: /* Like `format', but print result to stderr.
18853 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18854 (ptrdiff_t nargs
, Lisp_Object
*args
)
18856 Lisp_Object s
= Fformat (nargs
, args
);
18857 fprintf (stderr
, "%s", SDATA (s
));
18861 #endif /* GLYPH_DEBUG */
18865 /***********************************************************************
18866 Building Desired Matrix Rows
18867 ***********************************************************************/
18869 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18870 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18872 static struct glyph_row
*
18873 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18875 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18876 struct buffer
*buffer
= XBUFFER (w
->contents
);
18877 struct buffer
*old
= current_buffer
;
18878 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18879 int arrow_len
= SCHARS (overlay_arrow_string
);
18880 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18881 const unsigned char *p
;
18884 int n_glyphs_before
;
18886 set_buffer_temp (buffer
);
18887 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18888 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18889 SET_TEXT_POS (it
.position
, 0, 0);
18891 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18893 while (p
< arrow_end
)
18895 Lisp_Object face
, ilisp
;
18897 /* Get the next character. */
18899 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18902 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18903 if (! ASCII_CHAR_P (it
.c
))
18904 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18908 /* Get its face. */
18909 ilisp
= make_number (p
- arrow_string
);
18910 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18911 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18913 /* Compute its width, get its glyphs. */
18914 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18915 SET_TEXT_POS (it
.position
, -1, -1);
18916 PRODUCE_GLYPHS (&it
);
18918 /* If this character doesn't fit any more in the line, we have
18919 to remove some glyphs. */
18920 if (it
.current_x
> it
.last_visible_x
)
18922 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18927 set_buffer_temp (old
);
18928 return it
.glyph_row
;
18932 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18933 glyphs to insert is determined by produce_special_glyphs. */
18936 insert_left_trunc_glyphs (struct it
*it
)
18938 struct it truncate_it
;
18939 struct glyph
*from
, *end
, *to
, *toend
;
18941 eassert (!FRAME_WINDOW_P (it
->f
)
18942 || (!it
->glyph_row
->reversed_p
18943 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18944 || (it
->glyph_row
->reversed_p
18945 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18947 /* Get the truncation glyphs. */
18949 truncate_it
.current_x
= 0;
18950 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18951 truncate_it
.glyph_row
= &scratch_glyph_row
;
18952 truncate_it
.area
= TEXT_AREA
;
18953 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18954 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18955 truncate_it
.object
= make_number (0);
18956 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18958 /* Overwrite glyphs from IT with truncation glyphs. */
18959 if (!it
->glyph_row
->reversed_p
)
18961 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18963 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18964 end
= from
+ tused
;
18965 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18966 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18967 if (FRAME_WINDOW_P (it
->f
))
18969 /* On GUI frames, when variable-size fonts are displayed,
18970 the truncation glyphs may need more pixels than the row's
18971 glyphs they overwrite. We overwrite more glyphs to free
18972 enough screen real estate, and enlarge the stretch glyph
18973 on the right (see display_line), if there is one, to
18974 preserve the screen position of the truncation glyphs on
18977 struct glyph
*g
= to
;
18980 /* The first glyph could be partially visible, in which case
18981 it->glyph_row->x will be negative. But we want the left
18982 truncation glyphs to be aligned at the left margin of the
18983 window, so we override the x coordinate at which the row
18985 it
->glyph_row
->x
= 0;
18986 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18988 w
+= g
->pixel_width
;
18991 if (g
- to
- tused
> 0)
18993 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18994 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18996 used
= it
->glyph_row
->used
[TEXT_AREA
];
18997 if (it
->glyph_row
->truncated_on_right_p
18998 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18999 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
19002 int extra
= w
- it
->truncation_pixel_width
;
19004 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
19011 /* There may be padding glyphs left over. Overwrite them too. */
19012 if (!FRAME_WINDOW_P (it
->f
))
19014 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19016 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19023 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19027 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19029 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19030 that back to front. */
19031 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19032 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19033 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19034 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19035 if (FRAME_WINDOW_P (it
->f
))
19038 struct glyph
*g
= to
;
19040 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19042 w
+= g
->pixel_width
;
19045 if (to
- g
- tused
> 0)
19047 if (it
->glyph_row
->truncated_on_right_p
19048 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19049 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19051 int extra
= w
- it
->truncation_pixel_width
;
19053 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19057 while (from
>= end
&& to
>= toend
)
19059 if (!FRAME_WINDOW_P (it
->f
))
19061 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19064 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19065 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19066 while (from
>= end
&& to
>= toend
)
19072 /* Need to free some room before prepending additional
19074 int move_by
= from
- end
+ 1;
19075 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19076 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19078 for ( ; g
>= g0
; g
--)
19080 while (from
>= end
)
19082 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19087 /* Compute the hash code for ROW. */
19089 row_hash (struct glyph_row
*row
)
19092 unsigned hashval
= 0;
19094 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19095 for (k
= 0; k
< row
->used
[area
]; ++k
)
19096 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19097 + row
->glyphs
[area
][k
].u
.val
19098 + row
->glyphs
[area
][k
].face_id
19099 + row
->glyphs
[area
][k
].padding_p
19100 + (row
->glyphs
[area
][k
].type
<< 2));
19105 /* Compute the pixel height and width of IT->glyph_row.
19107 Most of the time, ascent and height of a display line will be equal
19108 to the max_ascent and max_height values of the display iterator
19109 structure. This is not the case if
19111 1. We hit ZV without displaying anything. In this case, max_ascent
19112 and max_height will be zero.
19114 2. We have some glyphs that don't contribute to the line height.
19115 (The glyph row flag contributes_to_line_height_p is for future
19116 pixmap extensions).
19118 The first case is easily covered by using default values because in
19119 these cases, the line height does not really matter, except that it
19120 must not be zero. */
19123 compute_line_metrics (struct it
*it
)
19125 struct glyph_row
*row
= it
->glyph_row
;
19127 if (FRAME_WINDOW_P (it
->f
))
19129 int i
, min_y
, max_y
;
19131 /* The line may consist of one space only, that was added to
19132 place the cursor on it. If so, the row's height hasn't been
19134 if (row
->height
== 0)
19136 if (it
->max_ascent
+ it
->max_descent
== 0)
19137 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19138 row
->ascent
= it
->max_ascent
;
19139 row
->height
= it
->max_ascent
+ it
->max_descent
;
19140 row
->phys_ascent
= it
->max_phys_ascent
;
19141 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19142 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19145 /* Compute the width of this line. */
19146 row
->pixel_width
= row
->x
;
19147 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19148 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19150 eassert (row
->pixel_width
>= 0);
19151 eassert (row
->ascent
>= 0 && row
->height
> 0);
19153 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19154 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19156 /* If first line's physical ascent is larger than its logical
19157 ascent, use the physical ascent, and make the row taller.
19158 This makes accented characters fully visible. */
19159 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19160 && row
->phys_ascent
> row
->ascent
)
19162 row
->height
+= row
->phys_ascent
- row
->ascent
;
19163 row
->ascent
= row
->phys_ascent
;
19166 /* Compute how much of the line is visible. */
19167 row
->visible_height
= row
->height
;
19169 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19170 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19172 if (row
->y
< min_y
)
19173 row
->visible_height
-= min_y
- row
->y
;
19174 if (row
->y
+ row
->height
> max_y
)
19175 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19179 row
->pixel_width
= row
->used
[TEXT_AREA
];
19180 if (row
->continued_p
)
19181 row
->pixel_width
-= it
->continuation_pixel_width
;
19182 else if (row
->truncated_on_right_p
)
19183 row
->pixel_width
-= it
->truncation_pixel_width
;
19184 row
->ascent
= row
->phys_ascent
= 0;
19185 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19186 row
->extra_line_spacing
= 0;
19189 /* Compute a hash code for this row. */
19190 row
->hash
= row_hash (row
);
19192 it
->max_ascent
= it
->max_descent
= 0;
19193 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19197 /* Append one space to the glyph row of iterator IT if doing a
19198 window-based redisplay. The space has the same face as
19199 IT->face_id. Value is non-zero if a space was added.
19201 This function is called to make sure that there is always one glyph
19202 at the end of a glyph row that the cursor can be set on under
19203 window-systems. (If there weren't such a glyph we would not know
19204 how wide and tall a box cursor should be displayed).
19206 At the same time this space let's a nicely handle clearing to the
19207 end of the line if the row ends in italic text. */
19210 append_space_for_newline (struct it
*it
, int default_face_p
)
19212 if (FRAME_WINDOW_P (it
->f
))
19214 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19216 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19217 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19219 /* Save some values that must not be changed.
19220 Must save IT->c and IT->len because otherwise
19221 ITERATOR_AT_END_P wouldn't work anymore after
19222 append_space_for_newline has been called. */
19223 enum display_element_type saved_what
= it
->what
;
19224 int saved_c
= it
->c
, saved_len
= it
->len
;
19225 int saved_char_to_display
= it
->char_to_display
;
19226 int saved_x
= it
->current_x
;
19227 int saved_face_id
= it
->face_id
;
19228 int saved_box_end
= it
->end_of_box_run_p
;
19229 struct text_pos saved_pos
;
19230 Lisp_Object saved_object
;
19233 saved_object
= it
->object
;
19234 saved_pos
= it
->position
;
19236 it
->what
= IT_CHARACTER
;
19237 memset (&it
->position
, 0, sizeof it
->position
);
19238 it
->object
= make_number (0);
19239 it
->c
= it
->char_to_display
= ' ';
19242 /* If the default face was remapped, be sure to use the
19243 remapped face for the appended newline. */
19244 if (default_face_p
)
19245 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19246 else if (it
->face_before_selective_p
)
19247 it
->face_id
= it
->saved_face_id
;
19248 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19249 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19250 /* In R2L rows, we will prepend a stretch glyph that will
19251 have the end_of_box_run_p flag set for it, so there's no
19252 need for the appended newline glyph to have that flag
19254 if (it
->glyph_row
->reversed_p
19255 /* But if the appended newline glyph goes all the way to
19256 the end of the row, there will be no stretch glyph,
19257 so leave the box flag set. */
19258 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19259 it
->end_of_box_run_p
= 0;
19261 PRODUCE_GLYPHS (it
);
19263 it
->override_ascent
= -1;
19264 it
->constrain_row_ascent_descent_p
= 0;
19265 it
->current_x
= saved_x
;
19266 it
->object
= saved_object
;
19267 it
->position
= saved_pos
;
19268 it
->what
= saved_what
;
19269 it
->face_id
= saved_face_id
;
19270 it
->len
= saved_len
;
19272 it
->char_to_display
= saved_char_to_display
;
19273 it
->end_of_box_run_p
= saved_box_end
;
19282 /* Extend the face of the last glyph in the text area of IT->glyph_row
19283 to the end of the display line. Called from display_line. If the
19284 glyph row is empty, add a space glyph to it so that we know the
19285 face to draw. Set the glyph row flag fill_line_p. If the glyph
19286 row is R2L, prepend a stretch glyph to cover the empty space to the
19287 left of the leftmost glyph. */
19290 extend_face_to_end_of_line (struct it
*it
)
19292 struct face
*face
, *default_face
;
19293 struct frame
*f
= it
->f
;
19295 /* If line is already filled, do nothing. Non window-system frames
19296 get a grace of one more ``pixel'' because their characters are
19297 1-``pixel'' wide, so they hit the equality too early. This grace
19298 is needed only for R2L rows that are not continued, to produce
19299 one extra blank where we could display the cursor. */
19300 if ((it
->current_x
>= it
->last_visible_x
19301 + (!FRAME_WINDOW_P (f
)
19302 && it
->glyph_row
->reversed_p
19303 && !it
->glyph_row
->continued_p
))
19304 /* If the window has display margins, we will need to extend
19305 their face even if the text area is filled. */
19306 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19307 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19310 /* The default face, possibly remapped. */
19311 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19313 /* Face extension extends the background and box of IT->face_id
19314 to the end of the line. If the background equals the background
19315 of the frame, we don't have to do anything. */
19316 if (it
->face_before_selective_p
)
19317 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19319 face
= FACE_FROM_ID (f
, it
->face_id
);
19321 if (FRAME_WINDOW_P (f
)
19322 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19323 && face
->box
== FACE_NO_BOX
19324 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19325 #ifdef HAVE_WINDOW_SYSTEM
19328 && !it
->glyph_row
->reversed_p
)
19331 /* Set the glyph row flag indicating that the face of the last glyph
19332 in the text area has to be drawn to the end of the text area. */
19333 it
->glyph_row
->fill_line_p
= 1;
19335 /* If current character of IT is not ASCII, make sure we have the
19336 ASCII face. This will be automatically undone the next time
19337 get_next_display_element returns a multibyte character. Note
19338 that the character will always be single byte in unibyte
19340 if (!ASCII_CHAR_P (it
->c
))
19342 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19345 if (FRAME_WINDOW_P (f
))
19347 /* If the row is empty, add a space with the current face of IT,
19348 so that we know which face to draw. */
19349 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19351 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19352 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19353 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19355 /* Mode line and the header line don't have margins, and
19356 likewise the frame's tool-bar window, if there is any. */
19357 if (!(it
->glyph_row
->mode_line_p
19358 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19359 || (WINDOWP (f
->tool_bar_window
)
19360 && it
->w
== XWINDOW (f
->tool_bar_window
))
19364 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19365 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19367 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19368 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19370 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19372 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19373 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19375 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19376 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19378 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19381 #ifdef HAVE_WINDOW_SYSTEM
19382 if (it
->glyph_row
->reversed_p
)
19384 /* Prepend a stretch glyph to the row, such that the
19385 rightmost glyph will be drawn flushed all the way to the
19386 right margin of the window. The stretch glyph that will
19387 occupy the empty space, if any, to the left of the
19389 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19390 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19391 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19393 int row_width
, stretch_ascent
, stretch_width
;
19394 struct text_pos saved_pos
;
19395 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
19397 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19398 row_width
+= g
->pixel_width
;
19400 /* FIXME: There are various minor display glitches in R2L
19401 rows when only one of the fringes is missing. The
19402 strange condition below produces the least bad effect. */
19403 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19404 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19405 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19406 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19408 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19409 stretch_width
-= row_width
;
19411 if (stretch_width
> 0)
19414 (((it
->ascent
+ it
->descent
)
19415 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19416 saved_pos
= it
->position
;
19417 memset (&it
->position
, 0, sizeof it
->position
);
19418 saved_avoid_cursor
= it
->avoid_cursor_p
;
19419 it
->avoid_cursor_p
= 1;
19420 saved_face_id
= it
->face_id
;
19421 saved_box_start
= it
->start_of_box_run_p
;
19422 /* The last row's stretch glyph should get the default
19423 face, to avoid painting the rest of the window with
19424 the region face, if the region ends at ZV. */
19425 if (it
->glyph_row
->ends_at_zv_p
)
19426 it
->face_id
= default_face
->id
;
19428 it
->face_id
= face
->id
;
19429 it
->start_of_box_run_p
= 0;
19430 append_stretch_glyph (it
, make_number (0), stretch_width
,
19431 it
->ascent
+ it
->descent
, stretch_ascent
);
19432 it
->position
= saved_pos
;
19433 it
->avoid_cursor_p
= saved_avoid_cursor
;
19434 it
->face_id
= saved_face_id
;
19435 it
->start_of_box_run_p
= saved_box_start
;
19437 /* If stretch_width comes out negative, it means that the
19438 last glyph is only partially visible. In R2L rows, we
19439 want the leftmost glyph to be partially visible, so we
19440 need to give the row the corresponding left offset. */
19441 if (stretch_width
< 0)
19442 it
->glyph_row
->x
= stretch_width
;
19444 #endif /* HAVE_WINDOW_SYSTEM */
19448 /* Save some values that must not be changed. */
19449 int saved_x
= it
->current_x
;
19450 struct text_pos saved_pos
;
19451 Lisp_Object saved_object
;
19452 enum display_element_type saved_what
= it
->what
;
19453 int saved_face_id
= it
->face_id
;
19455 saved_object
= it
->object
;
19456 saved_pos
= it
->position
;
19458 it
->what
= IT_CHARACTER
;
19459 memset (&it
->position
, 0, sizeof it
->position
);
19460 it
->object
= make_number (0);
19461 it
->c
= it
->char_to_display
= ' ';
19464 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19465 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19466 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19467 && !it
->glyph_row
->mode_line_p
19468 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19470 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19471 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19473 for (it
->current_x
= 0; g
< e
; g
++)
19474 it
->current_x
+= g
->pixel_width
;
19476 it
->area
= LEFT_MARGIN_AREA
;
19477 it
->face_id
= default_face
->id
;
19478 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19479 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19481 PRODUCE_GLYPHS (it
);
19482 /* term.c:produce_glyphs advances it->current_x only for
19484 it
->current_x
+= it
->pixel_width
;
19487 it
->current_x
= saved_x
;
19488 it
->area
= TEXT_AREA
;
19491 /* The last row's blank glyphs should get the default face, to
19492 avoid painting the rest of the window with the region face,
19493 if the region ends at ZV. */
19494 if (it
->glyph_row
->ends_at_zv_p
)
19495 it
->face_id
= default_face
->id
;
19497 it
->face_id
= face
->id
;
19498 PRODUCE_GLYPHS (it
);
19500 while (it
->current_x
<= it
->last_visible_x
)
19501 PRODUCE_GLYPHS (it
);
19503 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19504 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19505 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19506 && !it
->glyph_row
->mode_line_p
19507 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19509 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19510 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19512 for ( ; g
< e
; g
++)
19513 it
->current_x
+= g
->pixel_width
;
19515 it
->area
= RIGHT_MARGIN_AREA
;
19516 it
->face_id
= default_face
->id
;
19517 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19518 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19520 PRODUCE_GLYPHS (it
);
19521 it
->current_x
+= it
->pixel_width
;
19524 it
->area
= TEXT_AREA
;
19527 /* Don't count these blanks really. It would let us insert a left
19528 truncation glyph below and make us set the cursor on them, maybe. */
19529 it
->current_x
= saved_x
;
19530 it
->object
= saved_object
;
19531 it
->position
= saved_pos
;
19532 it
->what
= saved_what
;
19533 it
->face_id
= saved_face_id
;
19538 /* Value is non-zero if text starting at CHARPOS in current_buffer is
19539 trailing whitespace. */
19542 trailing_whitespace_p (ptrdiff_t charpos
)
19544 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19547 while (bytepos
< ZV_BYTE
19548 && (c
= FETCH_CHAR (bytepos
),
19549 c
== ' ' || c
== '\t'))
19552 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19554 if (bytepos
!= PT_BYTE
)
19561 /* Highlight trailing whitespace, if any, in ROW. */
19564 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19566 int used
= row
->used
[TEXT_AREA
];
19570 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19571 struct glyph
*glyph
= start
+ used
- 1;
19573 if (row
->reversed_p
)
19575 /* Right-to-left rows need to be processed in the opposite
19576 direction, so swap the edge pointers. */
19578 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19581 /* Skip over glyphs inserted to display the cursor at the
19582 end of a line, for extending the face of the last glyph
19583 to the end of the line on terminals, and for truncation
19584 and continuation glyphs. */
19585 if (!row
->reversed_p
)
19587 while (glyph
>= start
19588 && glyph
->type
== CHAR_GLYPH
19589 && INTEGERP (glyph
->object
))
19594 while (glyph
<= start
19595 && glyph
->type
== CHAR_GLYPH
19596 && INTEGERP (glyph
->object
))
19600 /* If last glyph is a space or stretch, and it's trailing
19601 whitespace, set the face of all trailing whitespace glyphs in
19602 IT->glyph_row to `trailing-whitespace'. */
19603 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19604 && BUFFERP (glyph
->object
)
19605 && (glyph
->type
== STRETCH_GLYPH
19606 || (glyph
->type
== CHAR_GLYPH
19607 && glyph
->u
.ch
== ' '))
19608 && trailing_whitespace_p (glyph
->charpos
))
19610 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
19614 if (!row
->reversed_p
)
19616 while (glyph
>= start
19617 && BUFFERP (glyph
->object
)
19618 && (glyph
->type
== STRETCH_GLYPH
19619 || (glyph
->type
== CHAR_GLYPH
19620 && glyph
->u
.ch
== ' ')))
19621 (glyph
--)->face_id
= face_id
;
19625 while (glyph
<= start
19626 && BUFFERP (glyph
->object
)
19627 && (glyph
->type
== STRETCH_GLYPH
19628 || (glyph
->type
== CHAR_GLYPH
19629 && glyph
->u
.ch
== ' ')))
19630 (glyph
++)->face_id
= face_id
;
19637 /* Value is non-zero if glyph row ROW should be
19638 considered to hold the buffer position CHARPOS. */
19641 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19645 if (charpos
== CHARPOS (row
->end
.pos
)
19646 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19648 /* Suppose the row ends on a string.
19649 Unless the row is continued, that means it ends on a newline
19650 in the string. If it's anything other than a display string
19651 (e.g., a before-string from an overlay), we don't want the
19652 cursor there. (This heuristic seems to give the optimal
19653 behavior for the various types of multi-line strings.)
19654 One exception: if the string has `cursor' property on one of
19655 its characters, we _do_ want the cursor there. */
19656 if (CHARPOS (row
->end
.string_pos
) >= 0)
19658 if (row
->continued_p
)
19662 /* Check for `display' property. */
19663 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19664 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19665 struct glyph
*glyph
;
19668 for (glyph
= end
; glyph
>= beg
; --glyph
)
19669 if (STRINGP (glyph
->object
))
19672 = Fget_char_property (make_number (charpos
),
19676 && display_prop_string_p (prop
, glyph
->object
));
19677 /* If there's a `cursor' property on one of the
19678 string's characters, this row is a cursor row,
19679 even though this is not a display string. */
19682 Lisp_Object s
= glyph
->object
;
19684 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19686 ptrdiff_t gpos
= glyph
->charpos
;
19688 if (!NILP (Fget_char_property (make_number (gpos
),
19700 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19702 /* If the row ends in middle of a real character,
19703 and the line is continued, we want the cursor here.
19704 That's because CHARPOS (ROW->end.pos) would equal
19705 PT if PT is before the character. */
19706 if (!row
->ends_in_ellipsis_p
)
19707 result
= row
->continued_p
;
19709 /* If the row ends in an ellipsis, then
19710 CHARPOS (ROW->end.pos) will equal point after the
19711 invisible text. We want that position to be displayed
19712 after the ellipsis. */
19715 /* If the row ends at ZV, display the cursor at the end of that
19716 row instead of at the start of the row below. */
19717 else if (row
->ends_at_zv_p
)
19726 /* Value is non-zero if glyph row ROW should be
19727 used to hold the cursor. */
19730 cursor_row_p (struct glyph_row
*row
)
19732 return row_for_charpos_p (row
, PT
);
19737 /* Push the property PROP so that it will be rendered at the current
19738 position in IT. Return 1 if PROP was successfully pushed, 0
19739 otherwise. Called from handle_line_prefix to handle the
19740 `line-prefix' and `wrap-prefix' properties. */
19743 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19745 struct text_pos pos
=
19746 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19748 eassert (it
->method
== GET_FROM_BUFFER
19749 || it
->method
== GET_FROM_DISPLAY_VECTOR
19750 || it
->method
== GET_FROM_STRING
);
19752 /* We need to save the current buffer/string position, so it will be
19753 restored by pop_it, because iterate_out_of_display_property
19754 depends on that being set correctly, but some situations leave
19755 it->position not yet set when this function is called. */
19756 push_it (it
, &pos
);
19758 if (STRINGP (prop
))
19760 if (SCHARS (prop
) == 0)
19767 it
->string_from_prefix_prop_p
= 1;
19768 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19769 it
->current
.overlay_string_index
= -1;
19770 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19771 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19772 it
->method
= GET_FROM_STRING
;
19773 it
->stop_charpos
= 0;
19775 it
->base_level_stop
= 0;
19777 /* Force paragraph direction to be that of the parent
19779 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19780 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19782 it
->paragraph_embedding
= L2R
;
19784 /* Set up the bidi iterator for this display string. */
19787 it
->bidi_it
.string
.lstring
= it
->string
;
19788 it
->bidi_it
.string
.s
= NULL
;
19789 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19790 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19791 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19792 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19793 it
->bidi_it
.w
= it
->w
;
19794 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19797 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19799 it
->method
= GET_FROM_STRETCH
;
19802 #ifdef HAVE_WINDOW_SYSTEM
19803 else if (IMAGEP (prop
))
19805 it
->what
= IT_IMAGE
;
19806 it
->image_id
= lookup_image (it
->f
, prop
);
19807 it
->method
= GET_FROM_IMAGE
;
19809 #endif /* HAVE_WINDOW_SYSTEM */
19812 pop_it (it
); /* bogus display property, give up */
19819 /* Return the character-property PROP at the current position in IT. */
19822 get_it_property (struct it
*it
, Lisp_Object prop
)
19824 Lisp_Object position
, object
= it
->object
;
19826 if (STRINGP (object
))
19827 position
= make_number (IT_STRING_CHARPOS (*it
));
19828 else if (BUFFERP (object
))
19830 position
= make_number (IT_CHARPOS (*it
));
19831 object
= it
->window
;
19836 return Fget_char_property (position
, prop
, object
);
19839 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19842 handle_line_prefix (struct it
*it
)
19844 Lisp_Object prefix
;
19846 if (it
->continuation_lines_width
> 0)
19848 prefix
= get_it_property (it
, Qwrap_prefix
);
19850 prefix
= Vwrap_prefix
;
19854 prefix
= get_it_property (it
, Qline_prefix
);
19856 prefix
= Vline_prefix
;
19858 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19860 /* If the prefix is wider than the window, and we try to wrap
19861 it, it would acquire its own wrap prefix, and so on till the
19862 iterator stack overflows. So, don't wrap the prefix. */
19863 it
->line_wrap
= TRUNCATE
;
19864 it
->avoid_cursor_p
= 1;
19870 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19871 only for R2L lines from display_line and display_string, when they
19872 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19873 the line/string needs to be continued on the next glyph row. */
19875 unproduce_glyphs (struct it
*it
, int n
)
19877 struct glyph
*glyph
, *end
;
19879 eassert (it
->glyph_row
);
19880 eassert (it
->glyph_row
->reversed_p
);
19881 eassert (it
->area
== TEXT_AREA
);
19882 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19884 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19885 n
= it
->glyph_row
->used
[TEXT_AREA
];
19886 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19887 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19888 for ( ; glyph
< end
; glyph
++)
19889 glyph
[-n
] = *glyph
;
19892 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19893 and ROW->maxpos. */
19895 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19896 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19897 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19899 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19900 lines' rows is implemented for bidi-reordered rows. */
19902 /* ROW->minpos is the value of min_pos, the minimal buffer position
19903 we have in ROW, or ROW->start.pos if that is smaller. */
19904 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19905 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19907 /* We didn't find buffer positions smaller than ROW->start, or
19908 didn't find _any_ valid buffer positions in any of the glyphs,
19909 so we must trust the iterator's computed positions. */
19910 row
->minpos
= row
->start
.pos
;
19913 max_pos
= CHARPOS (it
->current
.pos
);
19914 max_bpos
= BYTEPOS (it
->current
.pos
);
19917 /* Here are the various use-cases for ending the row, and the
19918 corresponding values for ROW->maxpos:
19920 Line ends in a newline from buffer eol_pos + 1
19921 Line is continued from buffer max_pos + 1
19922 Line is truncated on right it->current.pos
19923 Line ends in a newline from string max_pos + 1(*)
19924 (*) + 1 only when line ends in a forward scan
19925 Line is continued from string max_pos
19926 Line is continued from display vector max_pos
19927 Line is entirely from a string min_pos == max_pos
19928 Line is entirely from a display vector min_pos == max_pos
19929 Line that ends at ZV ZV
19931 If you discover other use-cases, please add them here as
19933 if (row
->ends_at_zv_p
)
19934 row
->maxpos
= it
->current
.pos
;
19935 else if (row
->used
[TEXT_AREA
])
19937 int seen_this_string
= 0;
19938 struct glyph_row
*r1
= row
- 1;
19940 /* Did we see the same display string on the previous row? */
19941 if (STRINGP (it
->object
)
19942 /* this is not the first row */
19943 && row
> it
->w
->desired_matrix
->rows
19944 /* previous row is not the header line */
19945 && !r1
->mode_line_p
19946 /* previous row also ends in a newline from a string */
19947 && r1
->ends_in_newline_from_string_p
)
19949 struct glyph
*start
, *end
;
19951 /* Search for the last glyph of the previous row that came
19952 from buffer or string. Depending on whether the row is
19953 L2R or R2L, we need to process it front to back or the
19954 other way round. */
19955 if (!r1
->reversed_p
)
19957 start
= r1
->glyphs
[TEXT_AREA
];
19958 end
= start
+ r1
->used
[TEXT_AREA
];
19959 /* Glyphs inserted by redisplay have an integer (zero)
19960 as their object. */
19962 && INTEGERP ((end
- 1)->object
)
19963 && (end
- 1)->charpos
<= 0)
19967 if (EQ ((end
- 1)->object
, it
->object
))
19968 seen_this_string
= 1;
19971 /* If all the glyphs of the previous row were inserted
19972 by redisplay, it means the previous row was
19973 produced from a single newline, which is only
19974 possible if that newline came from the same string
19975 as the one which produced this ROW. */
19976 seen_this_string
= 1;
19980 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19981 start
= end
+ r1
->used
[TEXT_AREA
];
19983 && INTEGERP ((end
+ 1)->object
)
19984 && (end
+ 1)->charpos
<= 0)
19988 if (EQ ((end
+ 1)->object
, it
->object
))
19989 seen_this_string
= 1;
19992 seen_this_string
= 1;
19995 /* Take note of each display string that covers a newline only
19996 once, the first time we see it. This is for when a display
19997 string includes more than one newline in it. */
19998 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20000 /* If we were scanning the buffer forward when we displayed
20001 the string, we want to account for at least one buffer
20002 position that belongs to this row (position covered by
20003 the display string), so that cursor positioning will
20004 consider this row as a candidate when point is at the end
20005 of the visual line represented by this row. This is not
20006 required when scanning back, because max_pos will already
20007 have a much larger value. */
20008 if (CHARPOS (row
->end
.pos
) > max_pos
)
20009 INC_BOTH (max_pos
, max_bpos
);
20010 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20012 else if (CHARPOS (it
->eol_pos
) > 0)
20013 SET_TEXT_POS (row
->maxpos
,
20014 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20015 else if (row
->continued_p
)
20017 /* If max_pos is different from IT's current position, it
20018 means IT->method does not belong to the display element
20019 at max_pos. However, it also means that the display
20020 element at max_pos was displayed in its entirety on this
20021 line, which is equivalent to saying that the next line
20022 starts at the next buffer position. */
20023 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20024 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20027 INC_BOTH (max_pos
, max_bpos
);
20028 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20031 else if (row
->truncated_on_right_p
)
20032 /* display_line already called reseat_at_next_visible_line_start,
20033 which puts the iterator at the beginning of the next line, in
20034 the logical order. */
20035 row
->maxpos
= it
->current
.pos
;
20036 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20037 /* A line that is entirely from a string/image/stretch... */
20038 row
->maxpos
= row
->minpos
;
20043 row
->maxpos
= it
->current
.pos
;
20046 /* Construct the glyph row IT->glyph_row in the desired matrix of
20047 IT->w from text at the current position of IT. See dispextern.h
20048 for an overview of struct it. Value is non-zero if
20049 IT->glyph_row displays text, as opposed to a line displaying ZV
20053 display_line (struct it
*it
)
20055 struct glyph_row
*row
= it
->glyph_row
;
20056 Lisp_Object overlay_arrow_string
;
20058 void *wrap_data
= NULL
;
20059 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
20060 int wrap_row_used
= -1;
20061 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20062 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20063 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20064 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20065 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20067 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20068 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20069 bool pending_handle_line_prefix
= false;
20071 /* We always start displaying at hpos zero even if hscrolled. */
20072 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20074 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20075 >= it
->w
->desired_matrix
->nrows
)
20077 it
->w
->nrows_scale_factor
++;
20078 it
->f
->fonts_changed
= 1;
20082 /* Clear the result glyph row and enable it. */
20083 prepare_desired_row (it
->w
, row
, false);
20085 row
->y
= it
->current_y
;
20086 row
->start
= it
->start
;
20087 row
->continuation_lines_width
= it
->continuation_lines_width
;
20088 row
->displays_text_p
= 1;
20089 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20090 it
->starts_in_middle_of_char_p
= 0;
20092 /* Arrange the overlays nicely for our purposes. Usually, we call
20093 display_line on only one line at a time, in which case this
20094 can't really hurt too much, or we call it on lines which appear
20095 one after another in the buffer, in which case all calls to
20096 recenter_overlay_lists but the first will be pretty cheap. */
20097 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20099 /* Move over display elements that are not visible because we are
20100 hscrolled. This may stop at an x-position < IT->first_visible_x
20101 if the first glyph is partially visible or if we hit a line end. */
20102 if (it
->current_x
< it
->first_visible_x
)
20104 enum move_it_result move_result
;
20106 this_line_min_pos
= row
->start
.pos
;
20107 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20108 MOVE_TO_POS
| MOVE_TO_X
);
20109 /* If we are under a large hscroll, move_it_in_display_line_to
20110 could hit the end of the line without reaching
20111 it->first_visible_x. Pretend that we did reach it. This is
20112 especially important on a TTY, where we will call
20113 extend_face_to_end_of_line, which needs to know how many
20114 blank glyphs to produce. */
20115 if (it
->current_x
< it
->first_visible_x
20116 && (move_result
== MOVE_NEWLINE_OR_CR
20117 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20118 it
->current_x
= it
->first_visible_x
;
20120 /* Record the smallest positions seen while we moved over
20121 display elements that are not visible. This is needed by
20122 redisplay_internal for optimizing the case where the cursor
20123 stays inside the same line. The rest of this function only
20124 considers positions that are actually displayed, so
20125 RECORD_MAX_MIN_POS will not otherwise record positions that
20126 are hscrolled to the left of the left edge of the window. */
20127 min_pos
= CHARPOS (this_line_min_pos
);
20128 min_bpos
= BYTEPOS (this_line_min_pos
);
20130 else if (it
->area
== TEXT_AREA
)
20132 /* We only do this when not calling move_it_in_display_line_to
20133 above, because that function calls itself handle_line_prefix. */
20134 handle_line_prefix (it
);
20138 /* Line-prefix and wrap-prefix are always displayed in the text
20139 area. But if this is the first call to display_line after
20140 init_iterator, the iterator might have been set up to write
20141 into a marginal area, e.g. if the line begins with some
20142 display property that writes to the margins. So we need to
20143 wait with the call to handle_line_prefix until whatever
20144 writes to the margin has done its job. */
20145 pending_handle_line_prefix
= true;
20148 /* Get the initial row height. This is either the height of the
20149 text hscrolled, if there is any, or zero. */
20150 row
->ascent
= it
->max_ascent
;
20151 row
->height
= it
->max_ascent
+ it
->max_descent
;
20152 row
->phys_ascent
= it
->max_phys_ascent
;
20153 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20154 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20156 /* Utility macro to record max and min buffer positions seen until now. */
20157 #define RECORD_MAX_MIN_POS(IT) \
20160 int composition_p = !STRINGP ((IT)->string) \
20161 && ((IT)->what == IT_COMPOSITION); \
20162 ptrdiff_t current_pos = \
20163 composition_p ? (IT)->cmp_it.charpos \
20164 : IT_CHARPOS (*(IT)); \
20165 ptrdiff_t current_bpos = \
20166 composition_p ? CHAR_TO_BYTE (current_pos) \
20167 : IT_BYTEPOS (*(IT)); \
20168 if (current_pos < min_pos) \
20170 min_pos = current_pos; \
20171 min_bpos = current_bpos; \
20173 if (IT_CHARPOS (*it) > max_pos) \
20175 max_pos = IT_CHARPOS (*it); \
20176 max_bpos = IT_BYTEPOS (*it); \
20181 /* Loop generating characters. The loop is left with IT on the next
20182 character to display. */
20185 int n_glyphs_before
, hpos_before
, x_before
;
20187 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20189 /* Retrieve the next thing to display. Value is zero if end of
20191 if (!get_next_display_element (it
))
20193 /* Maybe add a space at the end of this line that is used to
20194 display the cursor there under X. Set the charpos of the
20195 first glyph of blank lines not corresponding to any text
20197 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20198 row
->exact_window_width_line_p
= 1;
20199 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
20200 || row
->used
[TEXT_AREA
] == 0)
20202 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20203 row
->displays_text_p
= 0;
20205 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20206 && (!MINI_WINDOW_P (it
->w
)
20207 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20208 row
->indicate_empty_line_p
= 1;
20211 it
->continuation_lines_width
= 0;
20212 row
->ends_at_zv_p
= 1;
20213 /* A row that displays right-to-left text must always have
20214 its last face extended all the way to the end of line,
20215 even if this row ends in ZV, because we still write to
20216 the screen left to right. We also need to extend the
20217 last face if the default face is remapped to some
20218 different face, otherwise the functions that clear
20219 portions of the screen will clear with the default face's
20220 background color. */
20221 if (row
->reversed_p
20222 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20223 extend_face_to_end_of_line (it
);
20227 /* Now, get the metrics of what we want to display. This also
20228 generates glyphs in `row' (which is IT->glyph_row). */
20229 n_glyphs_before
= row
->used
[TEXT_AREA
];
20232 /* Remember the line height so far in case the next element doesn't
20233 fit on the line. */
20234 if (it
->line_wrap
!= TRUNCATE
)
20236 ascent
= it
->max_ascent
;
20237 descent
= it
->max_descent
;
20238 phys_ascent
= it
->max_phys_ascent
;
20239 phys_descent
= it
->max_phys_descent
;
20241 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20243 if (IT_DISPLAYING_WHITESPACE (it
))
20247 SAVE_IT (wrap_it
, *it
, wrap_data
);
20249 wrap_row_used
= row
->used
[TEXT_AREA
];
20250 wrap_row_ascent
= row
->ascent
;
20251 wrap_row_height
= row
->height
;
20252 wrap_row_phys_ascent
= row
->phys_ascent
;
20253 wrap_row_phys_height
= row
->phys_height
;
20254 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20255 wrap_row_min_pos
= min_pos
;
20256 wrap_row_min_bpos
= min_bpos
;
20257 wrap_row_max_pos
= max_pos
;
20258 wrap_row_max_bpos
= max_bpos
;
20264 PRODUCE_GLYPHS (it
);
20266 /* If this display element was in marginal areas, continue with
20268 if (it
->area
!= TEXT_AREA
)
20270 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20271 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20272 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20273 row
->phys_height
= max (row
->phys_height
,
20274 it
->max_phys_ascent
+ it
->max_phys_descent
);
20275 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20276 it
->max_extra_line_spacing
);
20277 set_iterator_to_next (it
, 1);
20278 /* If we didn't handle the line/wrap prefix above, and the
20279 call to set_iterator_to_next just switched to TEXT_AREA,
20280 process the prefix now. */
20281 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20283 pending_handle_line_prefix
= false;
20284 handle_line_prefix (it
);
20289 /* Does the display element fit on the line? If we truncate
20290 lines, we should draw past the right edge of the window. If
20291 we don't truncate, we want to stop so that we can display the
20292 continuation glyph before the right margin. If lines are
20293 continued, there are two possible strategies for characters
20294 resulting in more than 1 glyph (e.g. tabs): Display as many
20295 glyphs as possible in this line and leave the rest for the
20296 continuation line, or display the whole element in the next
20297 line. Original redisplay did the former, so we do it also. */
20298 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20299 hpos_before
= it
->hpos
;
20302 if (/* Not a newline. */
20304 /* Glyphs produced fit entirely in the line. */
20305 && it
->current_x
< it
->last_visible_x
)
20307 it
->hpos
+= nglyphs
;
20308 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20309 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20310 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20311 row
->phys_height
= max (row
->phys_height
,
20312 it
->max_phys_ascent
+ it
->max_phys_descent
);
20313 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20314 it
->max_extra_line_spacing
);
20315 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20316 /* In R2L rows, we arrange in extend_face_to_end_of_line
20317 to add a right offset to the line, by a suitable
20318 change to the stretch glyph that is the leftmost
20319 glyph of the line. */
20320 && !row
->reversed_p
)
20321 row
->x
= x
- it
->first_visible_x
;
20322 /* Record the maximum and minimum buffer positions seen so
20323 far in glyphs that will be displayed by this row. */
20325 RECORD_MAX_MIN_POS (it
);
20330 struct glyph
*glyph
;
20332 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20334 /* Identify the glyphs added by the last call to
20335 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20336 the previous glyphs. */
20337 if (!row
->reversed_p
)
20338 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20340 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20341 new_x
= x
+ glyph
->pixel_width
;
20343 if (/* Lines are continued. */
20344 it
->line_wrap
!= TRUNCATE
20345 && (/* Glyph doesn't fit on the line. */
20346 new_x
> it
->last_visible_x
20347 /* Or it fits exactly on a window system frame. */
20348 || (new_x
== it
->last_visible_x
20349 && FRAME_WINDOW_P (it
->f
)
20350 && (row
->reversed_p
20351 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20352 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20354 /* End of a continued line. */
20357 || (new_x
== it
->last_visible_x
20358 && FRAME_WINDOW_P (it
->f
)
20359 && (row
->reversed_p
20360 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20361 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20363 /* Current glyph is the only one on the line or
20364 fits exactly on the line. We must continue
20365 the line because we can't draw the cursor
20366 after the glyph. */
20367 row
->continued_p
= 1;
20368 it
->current_x
= new_x
;
20369 it
->continuation_lines_width
+= new_x
;
20371 if (i
== nglyphs
- 1)
20373 /* If line-wrap is on, check if a previous
20374 wrap point was found. */
20375 if (wrap_row_used
> 0
20376 /* Even if there is a previous wrap
20377 point, continue the line here as
20378 usual, if (i) the previous character
20379 was a space or tab AND (ii) the
20380 current character is not. */
20382 || IT_DISPLAYING_WHITESPACE (it
)))
20385 /* Record the maximum and minimum buffer
20386 positions seen so far in glyphs that will be
20387 displayed by this row. */
20389 RECORD_MAX_MIN_POS (it
);
20390 set_iterator_to_next (it
, 1);
20391 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20393 if (!get_next_display_element (it
))
20395 row
->exact_window_width_line_p
= 1;
20396 it
->continuation_lines_width
= 0;
20397 row
->continued_p
= 0;
20398 row
->ends_at_zv_p
= 1;
20400 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20402 row
->continued_p
= 0;
20403 row
->exact_window_width_line_p
= 1;
20407 else if (it
->bidi_p
)
20408 RECORD_MAX_MIN_POS (it
);
20409 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20410 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20411 extend_face_to_end_of_line (it
);
20413 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20414 && !FRAME_WINDOW_P (it
->f
))
20416 /* A padding glyph that doesn't fit on this line.
20417 This means the whole character doesn't fit
20419 if (row
->reversed_p
)
20420 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20421 - n_glyphs_before
);
20422 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20424 /* Fill the rest of the row with continuation
20425 glyphs like in 20.x. */
20426 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20427 < row
->glyphs
[1 + TEXT_AREA
])
20428 produce_special_glyphs (it
, IT_CONTINUATION
);
20430 row
->continued_p
= 1;
20431 it
->current_x
= x_before
;
20432 it
->continuation_lines_width
+= x_before
;
20434 /* Restore the height to what it was before the
20435 element not fitting on the line. */
20436 it
->max_ascent
= ascent
;
20437 it
->max_descent
= descent
;
20438 it
->max_phys_ascent
= phys_ascent
;
20439 it
->max_phys_descent
= phys_descent
;
20440 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20441 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20442 extend_face_to_end_of_line (it
);
20444 else if (wrap_row_used
> 0)
20447 if (row
->reversed_p
)
20448 unproduce_glyphs (it
,
20449 row
->used
[TEXT_AREA
] - wrap_row_used
);
20450 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20451 it
->continuation_lines_width
+= wrap_x
;
20452 row
->used
[TEXT_AREA
] = wrap_row_used
;
20453 row
->ascent
= wrap_row_ascent
;
20454 row
->height
= wrap_row_height
;
20455 row
->phys_ascent
= wrap_row_phys_ascent
;
20456 row
->phys_height
= wrap_row_phys_height
;
20457 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20458 min_pos
= wrap_row_min_pos
;
20459 min_bpos
= wrap_row_min_bpos
;
20460 max_pos
= wrap_row_max_pos
;
20461 max_bpos
= wrap_row_max_bpos
;
20462 row
->continued_p
= 1;
20463 row
->ends_at_zv_p
= 0;
20464 row
->exact_window_width_line_p
= 0;
20465 it
->continuation_lines_width
+= x
;
20467 /* Make sure that a non-default face is extended
20468 up to the right margin of the window. */
20469 extend_face_to_end_of_line (it
);
20471 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20473 /* A TAB that extends past the right edge of the
20474 window. This produces a single glyph on
20475 window system frames. We leave the glyph in
20476 this row and let it fill the row, but don't
20477 consume the TAB. */
20478 if ((row
->reversed_p
20479 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20480 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20481 produce_special_glyphs (it
, IT_CONTINUATION
);
20482 it
->continuation_lines_width
+= it
->last_visible_x
;
20483 row
->ends_in_middle_of_char_p
= 1;
20484 row
->continued_p
= 1;
20485 glyph
->pixel_width
= it
->last_visible_x
- x
;
20486 it
->starts_in_middle_of_char_p
= 1;
20487 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20488 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20489 extend_face_to_end_of_line (it
);
20493 /* Something other than a TAB that draws past
20494 the right edge of the window. Restore
20495 positions to values before the element. */
20496 if (row
->reversed_p
)
20497 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20498 - (n_glyphs_before
+ i
));
20499 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20501 /* Display continuation glyphs. */
20502 it
->current_x
= x_before
;
20503 it
->continuation_lines_width
+= x
;
20504 if (!FRAME_WINDOW_P (it
->f
)
20505 || (row
->reversed_p
20506 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20507 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20508 produce_special_glyphs (it
, IT_CONTINUATION
);
20509 row
->continued_p
= 1;
20511 extend_face_to_end_of_line (it
);
20513 if (nglyphs
> 1 && i
> 0)
20515 row
->ends_in_middle_of_char_p
= 1;
20516 it
->starts_in_middle_of_char_p
= 1;
20519 /* Restore the height to what it was before the
20520 element not fitting on the line. */
20521 it
->max_ascent
= ascent
;
20522 it
->max_descent
= descent
;
20523 it
->max_phys_ascent
= phys_ascent
;
20524 it
->max_phys_descent
= phys_descent
;
20529 else if (new_x
> it
->first_visible_x
)
20531 /* Increment number of glyphs actually displayed. */
20534 /* Record the maximum and minimum buffer positions
20535 seen so far in glyphs that will be displayed by
20538 RECORD_MAX_MIN_POS (it
);
20540 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20541 /* Glyph is partially visible, i.e. row starts at
20542 negative X position. Don't do that in R2L
20543 rows, where we arrange to add a right offset to
20544 the line in extend_face_to_end_of_line, by a
20545 suitable change to the stretch glyph that is
20546 the leftmost glyph of the line. */
20547 row
->x
= x
- it
->first_visible_x
;
20548 /* When the last glyph of an R2L row only fits
20549 partially on the line, we need to set row->x to a
20550 negative offset, so that the leftmost glyph is
20551 the one that is partially visible. But if we are
20552 going to produce the truncation glyph, this will
20553 be taken care of in produce_special_glyphs. */
20554 if (row
->reversed_p
20555 && new_x
> it
->last_visible_x
20556 && !(it
->line_wrap
== TRUNCATE
20557 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20559 eassert (FRAME_WINDOW_P (it
->f
));
20560 row
->x
= it
->last_visible_x
- new_x
;
20565 /* Glyph is completely off the left margin of the
20566 window. This should not happen because of the
20567 move_it_in_display_line at the start of this
20568 function, unless the text display area of the
20569 window is empty. */
20570 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20573 /* Even if this display element produced no glyphs at all,
20574 we want to record its position. */
20575 if (it
->bidi_p
&& nglyphs
== 0)
20576 RECORD_MAX_MIN_POS (it
);
20578 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20579 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20580 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20581 row
->phys_height
= max (row
->phys_height
,
20582 it
->max_phys_ascent
+ it
->max_phys_descent
);
20583 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20584 it
->max_extra_line_spacing
);
20586 /* End of this display line if row is continued. */
20587 if (row
->continued_p
|| row
->ends_at_zv_p
)
20592 /* Is this a line end? If yes, we're also done, after making
20593 sure that a non-default face is extended up to the right
20594 margin of the window. */
20595 if (ITERATOR_AT_END_OF_LINE_P (it
))
20597 int used_before
= row
->used
[TEXT_AREA
];
20599 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20601 /* Add a space at the end of the line that is used to
20602 display the cursor there. */
20603 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20604 append_space_for_newline (it
, 0);
20606 /* Extend the face to the end of the line. */
20607 extend_face_to_end_of_line (it
);
20609 /* Make sure we have the position. */
20610 if (used_before
== 0)
20611 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20613 /* Record the position of the newline, for use in
20615 it
->eol_pos
= it
->current
.pos
;
20617 /* Consume the line end. This skips over invisible lines. */
20618 set_iterator_to_next (it
, 1);
20619 it
->continuation_lines_width
= 0;
20623 /* Proceed with next display element. Note that this skips
20624 over lines invisible because of selective display. */
20625 set_iterator_to_next (it
, 1);
20627 /* If we truncate lines, we are done when the last displayed
20628 glyphs reach past the right margin of the window. */
20629 if (it
->line_wrap
== TRUNCATE
20630 && ((FRAME_WINDOW_P (it
->f
)
20631 /* Images are preprocessed in produce_image_glyph such
20632 that they are cropped at the right edge of the
20633 window, so an image glyph will always end exactly at
20634 last_visible_x, even if there's no right fringe. */
20635 && ((row
->reversed_p
20636 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20637 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20638 || it
->what
== IT_IMAGE
))
20639 ? (it
->current_x
>= it
->last_visible_x
)
20640 : (it
->current_x
> it
->last_visible_x
)))
20642 /* Maybe add truncation glyphs. */
20643 if (!FRAME_WINDOW_P (it
->f
)
20644 || (row
->reversed_p
20645 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20646 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20650 if (!row
->reversed_p
)
20652 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20653 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20658 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20659 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20661 /* Remove any padding glyphs at the front of ROW, to
20662 make room for the truncation glyphs we will be
20663 adding below. The loop below always inserts at
20664 least one truncation glyph, so also remove the
20665 last glyph added to ROW. */
20666 unproduce_glyphs (it
, i
+ 1);
20667 /* Adjust i for the loop below. */
20668 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20671 /* produce_special_glyphs overwrites the last glyph, so
20672 we don't want that if we want to keep that last
20673 glyph, which means it's an image. */
20674 if (it
->current_x
> it
->last_visible_x
)
20676 it
->current_x
= x_before
;
20677 if (!FRAME_WINDOW_P (it
->f
))
20679 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20681 row
->used
[TEXT_AREA
] = i
;
20682 produce_special_glyphs (it
, IT_TRUNCATION
);
20687 row
->used
[TEXT_AREA
] = i
;
20688 produce_special_glyphs (it
, IT_TRUNCATION
);
20690 it
->hpos
= hpos_before
;
20693 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20695 /* Don't truncate if we can overflow newline into fringe. */
20696 if (!get_next_display_element (it
))
20698 it
->continuation_lines_width
= 0;
20699 row
->ends_at_zv_p
= 1;
20700 row
->exact_window_width_line_p
= 1;
20703 if (ITERATOR_AT_END_OF_LINE_P (it
))
20705 row
->exact_window_width_line_p
= 1;
20706 goto at_end_of_line
;
20708 it
->current_x
= x_before
;
20709 it
->hpos
= hpos_before
;
20712 row
->truncated_on_right_p
= 1;
20713 it
->continuation_lines_width
= 0;
20714 reseat_at_next_visible_line_start (it
, 0);
20715 /* We insist below that IT's position be at ZV because in
20716 bidi-reordered lines the character at visible line start
20717 might not be the character that follows the newline in
20718 the logical order. */
20719 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
20720 row
->ends_at_zv_p
=
20721 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
20723 row
->ends_at_zv_p
= false;
20729 bidi_unshelve_cache (wrap_data
, 1);
20731 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20732 at the left window margin. */
20733 if (it
->first_visible_x
20734 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20736 if (!FRAME_WINDOW_P (it
->f
)
20737 || (((row
->reversed_p
20738 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20739 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20740 /* Don't let insert_left_trunc_glyphs overwrite the
20741 first glyph of the row if it is an image. */
20742 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20743 insert_left_trunc_glyphs (it
);
20744 row
->truncated_on_left_p
= 1;
20747 /* Remember the position at which this line ends.
20749 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20750 cannot be before the call to find_row_edges below, since that is
20751 where these positions are determined. */
20752 row
->end
= it
->current
;
20755 row
->minpos
= row
->start
.pos
;
20756 row
->maxpos
= row
->end
.pos
;
20760 /* ROW->minpos and ROW->maxpos must be the smallest and
20761 `1 + the largest' buffer positions in ROW. But if ROW was
20762 bidi-reordered, these two positions can be anywhere in the
20763 row, so we must determine them now. */
20764 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20767 /* If the start of this line is the overlay arrow-position, then
20768 mark this glyph row as the one containing the overlay arrow.
20769 This is clearly a mess with variable size fonts. It would be
20770 better to let it be displayed like cursors under X. */
20771 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20772 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20773 !NILP (overlay_arrow_string
)))
20775 /* Overlay arrow in window redisplay is a fringe bitmap. */
20776 if (STRINGP (overlay_arrow_string
))
20778 struct glyph_row
*arrow_row
20779 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20780 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20781 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20782 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20783 struct glyph
*p2
, *end
;
20785 /* Copy the arrow glyphs. */
20786 while (glyph
< arrow_end
)
20789 /* Throw away padding glyphs. */
20791 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20792 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20798 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20803 eassert (INTEGERP (overlay_arrow_string
));
20804 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20806 overlay_arrow_seen
= 1;
20809 /* Highlight trailing whitespace. */
20810 if (!NILP (Vshow_trailing_whitespace
))
20811 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20813 /* Compute pixel dimensions of this line. */
20814 compute_line_metrics (it
);
20816 /* Implementation note: No changes in the glyphs of ROW or in their
20817 faces can be done past this point, because compute_line_metrics
20818 computes ROW's hash value and stores it within the glyph_row
20821 /* Record whether this row ends inside an ellipsis. */
20822 row
->ends_in_ellipsis_p
20823 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20824 && it
->ellipsis_p
);
20826 /* Save fringe bitmaps in this row. */
20827 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20828 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20829 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20830 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20832 it
->left_user_fringe_bitmap
= 0;
20833 it
->left_user_fringe_face_id
= 0;
20834 it
->right_user_fringe_bitmap
= 0;
20835 it
->right_user_fringe_face_id
= 0;
20837 /* Maybe set the cursor. */
20838 cvpos
= it
->w
->cursor
.vpos
;
20840 /* In bidi-reordered rows, keep checking for proper cursor
20841 position even if one has been found already, because buffer
20842 positions in such rows change non-linearly with ROW->VPOS,
20843 when a line is continued. One exception: when we are at ZV,
20844 display cursor on the first suitable glyph row, since all
20845 the empty rows after that also have their position set to ZV. */
20846 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20847 lines' rows is implemented for bidi-reordered rows. */
20849 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20850 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20851 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20852 && cursor_row_p (row
))
20853 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20855 /* Prepare for the next line. This line starts horizontally at (X
20856 HPOS) = (0 0). Vertical positions are incremented. As a
20857 convenience for the caller, IT->glyph_row is set to the next
20859 it
->current_x
= it
->hpos
= 0;
20860 it
->current_y
+= row
->height
;
20861 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20864 /* The next row should by default use the same value of the
20865 reversed_p flag as this one. set_iterator_to_next decides when
20866 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20867 the flag accordingly. */
20868 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20869 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20870 it
->start
= row
->end
;
20871 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20873 #undef RECORD_MAX_MIN_POS
20876 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20877 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20878 doc
: /* Return paragraph direction at point in BUFFER.
20879 Value is either `left-to-right' or `right-to-left'.
20880 If BUFFER is omitted or nil, it defaults to the current buffer.
20882 Paragraph direction determines how the text in the paragraph is displayed.
20883 In left-to-right paragraphs, text begins at the left margin of the window
20884 and the reading direction is generally left to right. In right-to-left
20885 paragraphs, text begins at the right margin and is read from right to left.
20887 See also `bidi-paragraph-direction'. */)
20888 (Lisp_Object buffer
)
20890 struct buffer
*buf
= current_buffer
;
20891 struct buffer
*old
= buf
;
20893 if (! NILP (buffer
))
20895 CHECK_BUFFER (buffer
);
20896 buf
= XBUFFER (buffer
);
20899 if (NILP (BVAR (buf
, bidi_display_reordering
))
20900 || NILP (BVAR (buf
, enable_multibyte_characters
))
20901 /* When we are loading loadup.el, the character property tables
20902 needed for bidi iteration are not yet available. */
20903 || !NILP (Vpurify_flag
))
20904 return Qleft_to_right
;
20905 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20906 return BVAR (buf
, bidi_paragraph_direction
);
20909 /* Determine the direction from buffer text. We could try to
20910 use current_matrix if it is up to date, but this seems fast
20911 enough as it is. */
20912 struct bidi_it itb
;
20913 ptrdiff_t pos
= BUF_PT (buf
);
20914 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20916 void *itb_data
= bidi_shelve_cache ();
20918 set_buffer_temp (buf
);
20919 /* bidi_paragraph_init finds the base direction of the paragraph
20920 by searching forward from paragraph start. We need the base
20921 direction of the current or _previous_ paragraph, so we need
20922 to make sure we are within that paragraph. To that end, find
20923 the previous non-empty line. */
20924 if (pos
>= ZV
&& pos
> BEGV
)
20925 DEC_BOTH (pos
, bytepos
);
20926 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20927 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20929 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20930 || c
== ' ' || c
== '\t' || c
== '\f')
20932 if (bytepos
<= BEGV_BYTE
)
20937 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20940 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20941 itb
.paragraph_dir
= NEUTRAL_DIR
;
20942 itb
.string
.s
= NULL
;
20943 itb
.string
.lstring
= Qnil
;
20944 itb
.string
.bufpos
= 0;
20945 itb
.string
.from_disp_str
= 0;
20946 itb
.string
.unibyte
= 0;
20947 /* We have no window to use here for ignoring window-specific
20948 overlays. Using NULL for window pointer will cause
20949 compute_display_string_pos to use the current buffer. */
20951 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20952 bidi_unshelve_cache (itb_data
, 0);
20953 set_buffer_temp (old
);
20954 switch (itb
.paragraph_dir
)
20957 return Qleft_to_right
;
20960 return Qright_to_left
;
20968 DEFUN ("move-point-visually", Fmove_point_visually
,
20969 Smove_point_visually
, 1, 1, 0,
20970 doc
: /* Move point in the visual order in the specified DIRECTION.
20971 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
20974 Value is the new character position of point. */)
20975 (Lisp_Object direction
)
20977 struct window
*w
= XWINDOW (selected_window
);
20978 struct buffer
*b
= XBUFFER (w
->contents
);
20979 struct glyph_row
*row
;
20981 Lisp_Object paragraph_dir
;
20983 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
20984 (!(ROW)->continued_p \
20985 && INTEGERP ((GLYPH)->object) \
20986 && (GLYPH)->type == CHAR_GLYPH \
20987 && (GLYPH)->u.ch == ' ' \
20988 && (GLYPH)->charpos >= 0 \
20989 && !(GLYPH)->avoid_cursor_p)
20991 CHECK_NUMBER (direction
);
20992 dir
= XINT (direction
);
20998 /* If current matrix is up-to-date, we can use the information
20999 recorded in the glyphs, at least as long as the goal is on the
21001 if (w
->window_end_valid
21002 && !windows_or_buffers_changed
21004 && !b
->clip_changed
21005 && !b
->prevent_redisplay_optimizations_p
21006 && !window_outdated (w
)
21007 /* We rely below on the cursor coordinates to be up to date, but
21008 we cannot trust them if some command moved point since the
21009 last complete redisplay. */
21010 && w
->last_point
== BUF_PT (b
)
21011 && w
->cursor
.vpos
>= 0
21012 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21013 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21015 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21016 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21017 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21019 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21021 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21023 SET_PT (g
->charpos
);
21024 w
->cursor
.vpos
= -1;
21025 return make_number (PT
);
21027 else if (!INTEGERP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21031 if (BUFFERP (gpt
->object
))
21034 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21035 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21037 new_pos
-= (row
->reversed_p
? -dir
: dir
);;
21039 else if (BUFFERP (g
->object
))
21040 new_pos
= g
->charpos
;
21044 w
->cursor
.vpos
= -1;
21045 return make_number (PT
);
21047 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21049 /* Glyphs inserted at the end of a non-empty line for
21050 positioning the cursor have zero charpos, so we must
21051 deduce the value of point by other means. */
21052 if (g
->charpos
> 0)
21053 SET_PT (g
->charpos
);
21054 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21056 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21057 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21060 w
->cursor
.vpos
= -1;
21061 return make_number (PT
);
21064 if (g
== e
|| INTEGERP (g
->object
))
21066 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21067 goto simulate_display
;
21068 if (!row
->reversed_p
)
21072 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21073 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21074 goto simulate_display
;
21078 if (row
->reversed_p
&& !row
->continued_p
)
21080 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21081 w
->cursor
.vpos
= -1;
21082 return make_number (PT
);
21084 g
= row
->glyphs
[TEXT_AREA
];
21085 e
= g
+ row
->used
[TEXT_AREA
];
21086 for ( ; g
< e
; g
++)
21088 if (BUFFERP (g
->object
)
21089 /* Empty lines have only one glyph, which stands
21090 for the newline, and whose charpos is the
21091 buffer position of the newline. */
21092 || ROW_GLYPH_NEWLINE_P (row
, g
)
21093 /* When the buffer ends in a newline, the line at
21094 EOB also has one glyph, but its charpos is -1. */
21095 || (row
->ends_at_zv_p
21096 && !row
->reversed_p
21097 && INTEGERP (g
->object
)
21098 && g
->type
== CHAR_GLYPH
21099 && g
->u
.ch
== ' '))
21101 if (g
->charpos
> 0)
21102 SET_PT (g
->charpos
);
21103 else if (!row
->reversed_p
21104 && row
->ends_at_zv_p
21109 w
->cursor
.vpos
= -1;
21110 return make_number (PT
);
21116 if (!row
->reversed_p
&& !row
->continued_p
)
21118 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21119 w
->cursor
.vpos
= -1;
21120 return make_number (PT
);
21122 e
= row
->glyphs
[TEXT_AREA
];
21123 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21124 for ( ; g
>= e
; g
--)
21126 if (BUFFERP (g
->object
)
21127 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21129 /* Empty R2L lines on GUI frames have the buffer
21130 position of the newline stored in the stretch
21132 || g
->type
== STRETCH_GLYPH
21133 || (row
->ends_at_zv_p
21135 && INTEGERP (g
->object
)
21136 && g
->type
== CHAR_GLYPH
21137 && g
->u
.ch
== ' '))
21139 if (g
->charpos
> 0)
21140 SET_PT (g
->charpos
);
21141 else if (row
->reversed_p
21142 && row
->ends_at_zv_p
21147 w
->cursor
.vpos
= -1;
21148 return make_number (PT
);
21157 /* If we wind up here, we failed to move by using the glyphs, so we
21158 need to simulate display instead. */
21161 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21163 paragraph_dir
= Qleft_to_right
;
21164 if (EQ (paragraph_dir
, Qright_to_left
))
21166 if (PT
<= BEGV
&& dir
< 0)
21167 xsignal0 (Qbeginning_of_buffer
);
21168 else if (PT
>= ZV
&& dir
> 0)
21169 xsignal0 (Qend_of_buffer
);
21172 struct text_pos pt
;
21174 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21176 bool overshoot_expected
= false;
21177 bool target_is_eol_p
= false;
21179 /* Setup the arena. */
21180 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21181 start_display (&it
, w
, pt
);
21183 if (it
.cmp_it
.id
< 0
21184 && it
.method
== GET_FROM_STRING
21185 && it
.area
== TEXT_AREA
21186 && it
.string_from_display_prop_p
21187 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21188 overshoot_expected
= true;
21190 /* Find the X coordinate of point. We start from the beginning
21191 of this or previous line to make sure we are before point in
21192 the logical order (since the move_it_* functions can only
21195 reseat_at_previous_visible_line_start (&it
);
21196 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21197 if (IT_CHARPOS (it
) != PT
)
21199 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21200 -1, -1, -1, MOVE_TO_POS
);
21201 /* If we missed point because the character there is
21202 displayed out of a display vector that has more than one
21203 glyph, retry expecting overshoot. */
21204 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21205 && it
.current
.dpvec_index
> 0
21206 && !overshoot_expected
)
21208 overshoot_expected
= true;
21211 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21212 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21214 pt_x
= it
.current_x
;
21216 if (dir
> 0 || overshoot_expected
)
21218 struct glyph_row
*row
= it
.glyph_row
;
21220 /* When point is at beginning of line, we don't have
21221 information about the glyph there loaded into struct
21222 it. Calling get_next_display_element fixes that. */
21224 get_next_display_element (&it
);
21225 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21226 it
.glyph_row
= NULL
;
21227 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21228 it
.glyph_row
= row
;
21229 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21230 it, lest it will become out of sync with it's buffer
21232 it
.current_x
= pt_x
;
21235 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21236 pixel_width
= it
.pixel_width
;
21237 if (overshoot_expected
&& at_eol_p
)
21239 else if (pixel_width
<= 0)
21242 /* If there's a display string (or something similar) at point,
21243 we are actually at the glyph to the left of point, so we need
21244 to correct the X coordinate. */
21245 if (overshoot_expected
)
21248 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21250 pt_x
+= pixel_width
;
21253 /* Compute target X coordinate, either to the left or to the
21254 right of point. On TTY frames, all characters have the same
21255 pixel width of 1, so we can use that. On GUI frames we don't
21256 have an easy way of getting at the pixel width of the
21257 character to the left of point, so we use a different method
21258 of getting to that place. */
21260 target_x
= pt_x
+ pixel_width
;
21262 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21264 /* Target X coordinate could be one line above or below the line
21265 of point, in which case we need to adjust the target X
21266 coordinate. Also, if moving to the left, we need to begin at
21267 the left edge of the point's screen line. */
21272 start_display (&it
, w
, pt
);
21273 reseat_at_previous_visible_line_start (&it
);
21274 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21276 move_it_by_lines (&it
, pt_vpos
);
21280 move_it_by_lines (&it
, -1);
21281 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21282 target_is_eol_p
= true;
21283 /* Under word-wrap, we don't know the x coordinate of
21284 the last character displayed on the previous line,
21285 which immediately precedes the wrap point. To find
21286 out its x coordinate, we try moving to the right
21287 margin of the window, which will stop at the wrap
21288 point, and then reset target_x to point at the
21289 character that precedes the wrap point. This is not
21290 needed on GUI frames, because (see below) there we
21291 move from the left margin one grapheme cluster at a
21292 time, and stop when we hit the wrap point. */
21293 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21295 void *it_data
= NULL
;
21298 SAVE_IT (it2
, it
, it_data
);
21299 move_it_in_display_line_to (&it
, ZV
, target_x
,
21300 MOVE_TO_POS
| MOVE_TO_X
);
21301 /* If we arrived at target_x, that _is_ the last
21302 character on the previous line. */
21303 if (it
.current_x
!= target_x
)
21304 target_x
= it
.current_x
- 1;
21305 RESTORE_IT (&it
, &it2
, it_data
);
21312 || (target_x
>= it
.last_visible_x
21313 && it
.line_wrap
!= TRUNCATE
))
21316 move_it_by_lines (&it
, 0);
21317 move_it_by_lines (&it
, 1);
21322 /* Move to the target X coordinate. */
21323 #ifdef HAVE_WINDOW_SYSTEM
21324 /* On GUI frames, as we don't know the X coordinate of the
21325 character to the left of point, moving point to the left
21326 requires walking, one grapheme cluster at a time, until we
21327 find ourself at a place immediately to the left of the
21328 character at point. */
21329 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21331 struct text_pos new_pos
;
21332 enum move_it_result rc
= MOVE_X_REACHED
;
21334 if (it
.current_x
== 0)
21335 get_next_display_element (&it
);
21336 if (it
.what
== IT_COMPOSITION
)
21338 new_pos
.charpos
= it
.cmp_it
.charpos
;
21339 new_pos
.bytepos
= -1;
21342 new_pos
= it
.current
.pos
;
21344 while (it
.current_x
+ it
.pixel_width
<= target_x
21345 && (rc
== MOVE_X_REACHED
21346 /* Under word-wrap, move_it_in_display_line_to
21347 stops at correct coordinates, but sometimes
21348 returns MOVE_POS_MATCH_OR_ZV. */
21349 || (it
.line_wrap
== WORD_WRAP
21350 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21352 int new_x
= it
.current_x
+ it
.pixel_width
;
21354 /* For composed characters, we want the position of the
21355 first character in the grapheme cluster (usually, the
21356 composition's base character), whereas it.current
21357 might give us the position of the _last_ one, e.g. if
21358 the composition is rendered in reverse due to bidi
21360 if (it
.what
== IT_COMPOSITION
)
21362 new_pos
.charpos
= it
.cmp_it
.charpos
;
21363 new_pos
.bytepos
= -1;
21366 new_pos
= it
.current
.pos
;
21367 if (new_x
== it
.current_x
)
21369 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21370 MOVE_TO_POS
| MOVE_TO_X
);
21371 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21374 /* The previous position we saw in the loop is the one we
21376 if (new_pos
.bytepos
== -1)
21377 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21378 it
.current
.pos
= new_pos
;
21382 if (it
.current_x
!= target_x
)
21383 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21385 /* When lines are truncated, the above loop will stop at the
21386 window edge. But we want to get to the end of line, even if
21387 it is beyond the window edge; automatic hscroll will then
21388 scroll the window to show point as appropriate. */
21389 if (target_is_eol_p
&& it
.line_wrap
== TRUNCATE
21390 && get_next_display_element (&it
))
21392 struct text_pos new_pos
= it
.current
.pos
;
21394 while (!ITERATOR_AT_END_OF_LINE_P (&it
))
21396 set_iterator_to_next (&it
, 0);
21397 if (it
.method
== GET_FROM_BUFFER
)
21398 new_pos
= it
.current
.pos
;
21399 if (!get_next_display_element (&it
))
21403 it
.current
.pos
= new_pos
;
21406 /* If we ended up in a display string that covers point, move to
21407 buffer position to the right in the visual order. */
21410 while (IT_CHARPOS (it
) == PT
)
21412 set_iterator_to_next (&it
, 0);
21413 if (!get_next_display_element (&it
))
21418 /* Move point to that position. */
21419 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21422 return make_number (PT
);
21424 #undef ROW_GLYPH_NEWLINE_P
21428 /***********************************************************************
21430 ***********************************************************************/
21432 /* Redisplay the menu bar in the frame for window W.
21434 The menu bar of X frames that don't have X toolkit support is
21435 displayed in a special window W->frame->menu_bar_window.
21437 The menu bar of terminal frames is treated specially as far as
21438 glyph matrices are concerned. Menu bar lines are not part of
21439 windows, so the update is done directly on the frame matrix rows
21440 for the menu bar. */
21443 display_menu_bar (struct window
*w
)
21445 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21450 /* Don't do all this for graphical frames. */
21452 if (FRAME_W32_P (f
))
21455 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21461 if (FRAME_NS_P (f
))
21463 #endif /* HAVE_NS */
21465 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21466 eassert (!FRAME_WINDOW_P (f
));
21467 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21468 it
.first_visible_x
= 0;
21469 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21470 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21471 if (FRAME_WINDOW_P (f
))
21473 /* Menu bar lines are displayed in the desired matrix of the
21474 dummy window menu_bar_window. */
21475 struct window
*menu_w
;
21476 menu_w
= XWINDOW (f
->menu_bar_window
);
21477 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21479 it
.first_visible_x
= 0;
21480 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21483 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21485 /* This is a TTY frame, i.e. character hpos/vpos are used as
21487 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21489 it
.first_visible_x
= 0;
21490 it
.last_visible_x
= FRAME_COLS (f
);
21493 /* FIXME: This should be controlled by a user option. See the
21494 comments in redisplay_tool_bar and display_mode_line about
21496 it
.paragraph_embedding
= L2R
;
21498 /* Clear all rows of the menu bar. */
21499 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21501 struct glyph_row
*row
= it
.glyph_row
+ i
;
21502 clear_glyph_row (row
);
21503 row
->enabled_p
= true;
21504 row
->full_width_p
= 1;
21507 /* Display all items of the menu bar. */
21508 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21509 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21511 Lisp_Object string
;
21513 /* Stop at nil string. */
21514 string
= AREF (items
, i
+ 1);
21518 /* Remember where item was displayed. */
21519 ASET (items
, i
+ 3, make_number (it
.hpos
));
21521 /* Display the item, pad with one space. */
21522 if (it
.current_x
< it
.last_visible_x
)
21523 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21524 SCHARS (string
) + 1, 0, 0, -1);
21527 /* Fill out the line with spaces. */
21528 if (it
.current_x
< it
.last_visible_x
)
21529 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21531 /* Compute the total height of the lines. */
21532 compute_line_metrics (&it
);
21535 /* Deep copy of a glyph row, including the glyphs. */
21537 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21539 struct glyph
*pointers
[1 + LAST_AREA
];
21540 int to_used
= to
->used
[TEXT_AREA
];
21542 /* Save glyph pointers of TO. */
21543 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21545 /* Do a structure assignment. */
21548 /* Restore original glyph pointers of TO. */
21549 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21551 /* Copy the glyphs. */
21552 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21553 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21555 /* If we filled only part of the TO row, fill the rest with
21556 space_glyph (which will display as empty space). */
21557 if (to_used
> from
->used
[TEXT_AREA
])
21558 fill_up_frame_row_with_spaces (to
, to_used
);
21561 /* Display one menu item on a TTY, by overwriting the glyphs in the
21562 frame F's desired glyph matrix with glyphs produced from the menu
21563 item text. Called from term.c to display TTY drop-down menus one
21566 ITEM_TEXT is the menu item text as a C string.
21568 FACE_ID is the face ID to be used for this menu item. FACE_ID
21569 could specify one of 3 faces: a face for an enabled item, a face
21570 for a disabled item, or a face for a selected item.
21572 X and Y are coordinates of the first glyph in the frame's desired
21573 matrix to be overwritten by the menu item. Since this is a TTY, Y
21574 is the zero-based number of the glyph row and X is the zero-based
21575 glyph number in the row, starting from left, where to start
21576 displaying the item.
21578 SUBMENU non-zero means this menu item drops down a submenu, which
21579 should be indicated by displaying a proper visual cue after the
21583 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21584 int x
, int y
, int submenu
)
21587 struct frame
*f
= SELECTED_FRAME ();
21588 struct window
*w
= XWINDOW (f
->selected_window
);
21589 int saved_used
, saved_truncated
, saved_width
, saved_reversed
;
21590 struct glyph_row
*row
;
21591 size_t item_len
= strlen (item_text
);
21593 eassert (FRAME_TERMCAP_P (f
));
21595 /* Don't write beyond the matrix's last row. This can happen for
21596 TTY screens that are not high enough to show the entire menu.
21597 (This is actually a bit of defensive programming, as
21598 tty_menu_display already limits the number of menu items to one
21599 less than the number of screen lines.) */
21600 if (y
>= f
->desired_matrix
->nrows
)
21603 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21604 it
.first_visible_x
= 0;
21605 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21606 row
= it
.glyph_row
;
21607 /* Start with the row contents from the current matrix. */
21608 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21609 saved_width
= row
->full_width_p
;
21610 row
->full_width_p
= 1;
21611 saved_reversed
= row
->reversed_p
;
21612 row
->reversed_p
= 0;
21613 row
->enabled_p
= true;
21615 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21617 eassert (x
< f
->desired_matrix
->matrix_w
);
21618 it
.current_x
= it
.hpos
= x
;
21619 it
.current_y
= it
.vpos
= y
;
21620 saved_used
= row
->used
[TEXT_AREA
];
21621 saved_truncated
= row
->truncated_on_right_p
;
21622 row
->used
[TEXT_AREA
] = x
;
21623 it
.face_id
= face_id
;
21624 it
.line_wrap
= TRUNCATE
;
21626 /* FIXME: This should be controlled by a user option. See the
21627 comments in redisplay_tool_bar and display_mode_line about this.
21628 Also, if paragraph_embedding could ever be R2L, changes will be
21629 needed to avoid shifting to the right the row characters in
21630 term.c:append_glyph. */
21631 it
.paragraph_embedding
= L2R
;
21633 /* Pad with a space on the left. */
21634 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21636 /* Display the menu item, pad with spaces to WIDTH. */
21639 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21640 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21642 /* Indicate with " >" that there's a submenu. */
21643 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21644 FRAME_COLS (f
) - 1, -1);
21647 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21648 width
, 0, FRAME_COLS (f
) - 1, -1);
21650 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21651 row
->truncated_on_right_p
= saved_truncated
;
21652 row
->hash
= row_hash (row
);
21653 row
->full_width_p
= saved_width
;
21654 row
->reversed_p
= saved_reversed
;
21657 /***********************************************************************
21659 ***********************************************************************/
21661 /* Redisplay mode lines in the window tree whose root is WINDOW. If
21662 FORCE is non-zero, redisplay mode lines unconditionally.
21663 Otherwise, redisplay only mode lines that are garbaged. Value is
21664 the number of windows whose mode lines were redisplayed. */
21667 redisplay_mode_lines (Lisp_Object window
, bool force
)
21671 while (!NILP (window
))
21673 struct window
*w
= XWINDOW (window
);
21675 if (WINDOWP (w
->contents
))
21676 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
21678 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
21679 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
21681 struct text_pos lpoint
;
21682 struct buffer
*old
= current_buffer
;
21684 /* Set the window's buffer for the mode line display. */
21685 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
21686 set_buffer_internal_1 (XBUFFER (w
->contents
));
21688 /* Point refers normally to the selected window. For any
21689 other window, set up appropriate value. */
21690 if (!EQ (window
, selected_window
))
21692 struct text_pos pt
;
21694 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
21695 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
21698 /* Display mode lines. */
21699 clear_glyph_matrix (w
->desired_matrix
);
21700 if (display_mode_lines (w
))
21703 /* Restore old settings. */
21704 set_buffer_internal_1 (old
);
21705 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
21715 /* Display the mode and/or header line of window W. Value is the
21716 sum number of mode lines and header lines displayed. */
21719 display_mode_lines (struct window
*w
)
21721 Lisp_Object old_selected_window
= selected_window
;
21722 Lisp_Object old_selected_frame
= selected_frame
;
21723 Lisp_Object new_frame
= w
->frame
;
21724 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
21727 selected_frame
= new_frame
;
21728 /* FIXME: If we were to allow the mode-line's computation changing the buffer
21729 or window's point, then we'd need select_window_1 here as well. */
21730 XSETWINDOW (selected_window
, w
);
21731 XFRAME (new_frame
)->selected_window
= selected_window
;
21733 /* These will be set while the mode line specs are processed. */
21734 line_number_displayed
= 0;
21735 w
->column_number_displayed
= -1;
21737 if (WINDOW_WANTS_MODELINE_P (w
))
21739 struct window
*sel_w
= XWINDOW (old_selected_window
);
21741 /* Select mode line face based on the real selected window. */
21742 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
21743 BVAR (current_buffer
, mode_line_format
));
21747 if (WINDOW_WANTS_HEADER_LINE_P (w
))
21749 display_mode_line (w
, HEADER_LINE_FACE_ID
,
21750 BVAR (current_buffer
, header_line_format
));
21754 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
21755 selected_frame
= old_selected_frame
;
21756 selected_window
= old_selected_window
;
21758 w
->must_be_updated_p
= true;
21763 /* Display mode or header line of window W. FACE_ID specifies which
21764 line to display; it is either MODE_LINE_FACE_ID or
21765 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
21766 display. Value is the pixel height of the mode/header line
21770 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
21774 ptrdiff_t count
= SPECPDL_INDEX ();
21776 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21777 /* Don't extend on a previously drawn mode-line.
21778 This may happen if called from pos_visible_p. */
21779 it
.glyph_row
->enabled_p
= false;
21780 prepare_desired_row (w
, it
.glyph_row
, true);
21782 it
.glyph_row
->mode_line_p
= 1;
21784 /* FIXME: This should be controlled by a user option. But
21785 supporting such an option is not trivial, since the mode line is
21786 made up of many separate strings. */
21787 it
.paragraph_embedding
= L2R
;
21789 record_unwind_protect (unwind_format_mode_line
,
21790 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
21792 mode_line_target
= MODE_LINE_DISPLAY
;
21794 /* Temporarily make frame's keyboard the current kboard so that
21795 kboard-local variables in the mode_line_format will get the right
21797 push_kboard (FRAME_KBOARD (it
.f
));
21798 record_unwind_save_match_data ();
21799 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21802 unbind_to (count
, Qnil
);
21804 /* Fill up with spaces. */
21805 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
21807 compute_line_metrics (&it
);
21808 it
.glyph_row
->full_width_p
= 1;
21809 it
.glyph_row
->continued_p
= 0;
21810 it
.glyph_row
->truncated_on_left_p
= 0;
21811 it
.glyph_row
->truncated_on_right_p
= 0;
21813 /* Make a 3D mode-line have a shadow at its right end. */
21814 face
= FACE_FROM_ID (it
.f
, face_id
);
21815 extend_face_to_end_of_line (&it
);
21816 if (face
->box
!= FACE_NO_BOX
)
21818 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
21819 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
21820 last
->right_box_line_p
= 1;
21823 return it
.glyph_row
->height
;
21826 /* Move element ELT in LIST to the front of LIST.
21827 Return the updated list. */
21830 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
21832 register Lisp_Object tail
, prev
;
21833 register Lisp_Object tem
;
21837 while (CONSP (tail
))
21843 /* Splice out the link TAIL. */
21845 list
= XCDR (tail
);
21847 Fsetcdr (prev
, XCDR (tail
));
21849 /* Now make it the first. */
21850 Fsetcdr (tail
, list
);
21855 tail
= XCDR (tail
);
21859 /* Not found--return unchanged LIST. */
21863 /* Contribute ELT to the mode line for window IT->w. How it
21864 translates into text depends on its data type.
21866 IT describes the display environment in which we display, as usual.
21868 DEPTH is the depth in recursion. It is used to prevent
21869 infinite recursion here.
21871 FIELD_WIDTH is the number of characters the display of ELT should
21872 occupy in the mode line, and PRECISION is the maximum number of
21873 characters to display from ELT's representation. See
21874 display_string for details.
21876 Returns the hpos of the end of the text generated by ELT.
21878 PROPS is a property list to add to any string we encounter.
21880 If RISKY is nonzero, remove (disregard) any properties in any string
21881 we encounter, and ignore :eval and :propertize.
21883 The global variable `mode_line_target' determines whether the
21884 output is passed to `store_mode_line_noprop',
21885 `store_mode_line_string', or `display_string'. */
21888 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
21889 Lisp_Object elt
, Lisp_Object props
, int risky
)
21891 int n
= 0, field
, prec
;
21896 elt
= build_string ("*too-deep*");
21900 switch (XTYPE (elt
))
21904 /* A string: output it and check for %-constructs within it. */
21906 ptrdiff_t offset
= 0;
21908 if (SCHARS (elt
) > 0
21909 && (!NILP (props
) || risky
))
21911 Lisp_Object oprops
, aelt
;
21912 oprops
= Ftext_properties_at (make_number (0), elt
);
21914 /* If the starting string's properties are not what
21915 we want, translate the string. Also, if the string
21916 is risky, do that anyway. */
21918 if (NILP (Fequal (props
, oprops
)) || risky
)
21920 /* If the starting string has properties,
21921 merge the specified ones onto the existing ones. */
21922 if (! NILP (oprops
) && !risky
)
21926 oprops
= Fcopy_sequence (oprops
);
21928 while (CONSP (tem
))
21930 oprops
= Fplist_put (oprops
, XCAR (tem
),
21931 XCAR (XCDR (tem
)));
21932 tem
= XCDR (XCDR (tem
));
21937 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
21938 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
21940 /* AELT is what we want. Move it to the front
21941 without consing. */
21943 mode_line_proptrans_alist
21944 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
21950 /* If AELT has the wrong props, it is useless.
21951 so get rid of it. */
21953 mode_line_proptrans_alist
21954 = Fdelq (aelt
, mode_line_proptrans_alist
);
21956 elt
= Fcopy_sequence (elt
);
21957 Fset_text_properties (make_number (0), Flength (elt
),
21959 /* Add this item to mode_line_proptrans_alist. */
21960 mode_line_proptrans_alist
21961 = Fcons (Fcons (elt
, props
),
21962 mode_line_proptrans_alist
);
21963 /* Truncate mode_line_proptrans_alist
21964 to at most 50 elements. */
21965 tem
= Fnthcdr (make_number (50),
21966 mode_line_proptrans_alist
);
21968 XSETCDR (tem
, Qnil
);
21977 prec
= precision
- n
;
21978 switch (mode_line_target
)
21980 case MODE_LINE_NOPROP
:
21981 case MODE_LINE_TITLE
:
21982 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
21984 case MODE_LINE_STRING
:
21985 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
21987 case MODE_LINE_DISPLAY
:
21988 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
21989 0, prec
, 0, STRING_MULTIBYTE (elt
));
21996 /* Handle the non-literal case. */
21998 while ((precision
<= 0 || n
< precision
)
21999 && SREF (elt
, offset
) != 0
22000 && (mode_line_target
!= MODE_LINE_DISPLAY
22001 || it
->current_x
< it
->last_visible_x
))
22003 ptrdiff_t last_offset
= offset
;
22005 /* Advance to end of string or next format specifier. */
22006 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22009 if (offset
- 1 != last_offset
)
22011 ptrdiff_t nchars
, nbytes
;
22013 /* Output to end of string or up to '%'. Field width
22014 is length of string. Don't output more than
22015 PRECISION allows us. */
22018 prec
= c_string_width (SDATA (elt
) + last_offset
,
22019 offset
- last_offset
, precision
- n
,
22022 switch (mode_line_target
)
22024 case MODE_LINE_NOPROP
:
22025 case MODE_LINE_TITLE
:
22026 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22028 case MODE_LINE_STRING
:
22030 ptrdiff_t bytepos
= last_offset
;
22031 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22032 ptrdiff_t endpos
= (precision
<= 0
22033 ? string_byte_to_char (elt
, offset
)
22034 : charpos
+ nchars
);
22036 n
+= store_mode_line_string (NULL
,
22037 Fsubstring (elt
, make_number (charpos
),
22038 make_number (endpos
)),
22042 case MODE_LINE_DISPLAY
:
22044 ptrdiff_t bytepos
= last_offset
;
22045 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22047 if (precision
<= 0)
22048 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22049 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22051 STRING_MULTIBYTE (elt
));
22056 else /* c == '%' */
22058 ptrdiff_t percent_position
= offset
;
22060 /* Get the specified minimum width. Zero means
22063 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22064 field
= field
* 10 + c
- '0';
22066 /* Don't pad beyond the total padding allowed. */
22067 if (field_width
- n
> 0 && field
> field_width
- n
)
22068 field
= field_width
- n
;
22070 /* Note that either PRECISION <= 0 or N < PRECISION. */
22071 prec
= precision
- n
;
22074 n
+= display_mode_element (it
, depth
, field
, prec
,
22075 Vglobal_mode_string
, props
,
22080 ptrdiff_t bytepos
, charpos
;
22082 Lisp_Object string
;
22084 bytepos
= percent_position
;
22085 charpos
= (STRING_MULTIBYTE (elt
)
22086 ? string_byte_to_char (elt
, bytepos
)
22088 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22089 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22091 switch (mode_line_target
)
22093 case MODE_LINE_NOPROP
:
22094 case MODE_LINE_TITLE
:
22095 n
+= store_mode_line_noprop (spec
, field
, prec
);
22097 case MODE_LINE_STRING
:
22099 Lisp_Object tem
= build_string (spec
);
22100 props
= Ftext_properties_at (make_number (charpos
), elt
);
22101 /* Should only keep face property in props */
22102 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
22105 case MODE_LINE_DISPLAY
:
22107 int nglyphs_before
, nwritten
;
22109 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22110 nwritten
= display_string (spec
, string
, elt
,
22115 /* Assign to the glyphs written above the
22116 string where the `%x' came from, position
22120 struct glyph
*glyph
22121 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22125 for (i
= 0; i
< nwritten
; ++i
)
22127 glyph
[i
].object
= elt
;
22128 glyph
[i
].charpos
= charpos
;
22145 /* A symbol: process the value of the symbol recursively
22146 as if it appeared here directly. Avoid error if symbol void.
22147 Special case: if value of symbol is a string, output the string
22150 register Lisp_Object tem
;
22152 /* If the variable is not marked as risky to set
22153 then its contents are risky to use. */
22154 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22157 tem
= Fboundp (elt
);
22160 tem
= Fsymbol_value (elt
);
22161 /* If value is a string, output that string literally:
22162 don't check for % within it. */
22166 if (!EQ (tem
, elt
))
22168 /* Give up right away for nil or t. */
22178 register Lisp_Object car
, tem
;
22180 /* A cons cell: five distinct cases.
22181 If first element is :eval or :propertize, do something special.
22182 If first element is a string or a cons, process all the elements
22183 and effectively concatenate them.
22184 If first element is a negative number, truncate displaying cdr to
22185 at most that many characters. If positive, pad (with spaces)
22186 to at least that many characters.
22187 If first element is a symbol, process the cadr or caddr recursively
22188 according to whether the symbol's value is non-nil or nil. */
22190 if (EQ (car
, QCeval
))
22192 /* An element of the form (:eval FORM) means evaluate FORM
22193 and use the result as mode line elements. */
22198 if (CONSP (XCDR (elt
)))
22201 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22202 n
+= display_mode_element (it
, depth
, field_width
- n
,
22203 precision
- n
, spec
, props
,
22207 else if (EQ (car
, QCpropertize
))
22209 /* An element of the form (:propertize ELT PROPS...)
22210 means display ELT but applying properties PROPS. */
22215 if (CONSP (XCDR (elt
)))
22216 n
+= display_mode_element (it
, depth
, field_width
- n
,
22217 precision
- n
, XCAR (XCDR (elt
)),
22218 XCDR (XCDR (elt
)), risky
);
22220 else if (SYMBOLP (car
))
22222 tem
= Fboundp (car
);
22226 /* elt is now the cdr, and we know it is a cons cell.
22227 Use its car if CAR has a non-nil value. */
22230 tem
= Fsymbol_value (car
);
22237 /* Symbol's value is nil (or symbol is unbound)
22238 Get the cddr of the original list
22239 and if possible find the caddr and use that. */
22243 else if (!CONSP (elt
))
22248 else if (INTEGERP (car
))
22250 register int lim
= XINT (car
);
22254 /* Negative int means reduce maximum width. */
22255 if (precision
<= 0)
22258 precision
= min (precision
, -lim
);
22262 /* Padding specified. Don't let it be more than
22263 current maximum. */
22265 lim
= min (precision
, lim
);
22267 /* If that's more padding than already wanted, queue it.
22268 But don't reduce padding already specified even if
22269 that is beyond the current truncation point. */
22270 field_width
= max (lim
, field_width
);
22274 else if (STRINGP (car
) || CONSP (car
))
22276 Lisp_Object halftail
= elt
;
22280 && (precision
<= 0 || n
< precision
))
22282 n
+= display_mode_element (it
, depth
,
22283 /* Do padding only after the last
22284 element in the list. */
22285 (! CONSP (XCDR (elt
))
22288 precision
- n
, XCAR (elt
),
22292 if ((len
& 1) == 0)
22293 halftail
= XCDR (halftail
);
22294 /* Check for cycle. */
22295 if (EQ (halftail
, elt
))
22304 elt
= build_string ("*invalid*");
22308 /* Pad to FIELD_WIDTH. */
22309 if (field_width
> 0 && n
< field_width
)
22311 switch (mode_line_target
)
22313 case MODE_LINE_NOPROP
:
22314 case MODE_LINE_TITLE
:
22315 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22317 case MODE_LINE_STRING
:
22318 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
22320 case MODE_LINE_DISPLAY
:
22321 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22330 /* Store a mode-line string element in mode_line_string_list.
22332 If STRING is non-null, display that C string. Otherwise, the Lisp
22333 string LISP_STRING is displayed.
22335 FIELD_WIDTH is the minimum number of output glyphs to produce.
22336 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22337 with spaces. FIELD_WIDTH <= 0 means don't pad.
22339 PRECISION is the maximum number of characters to output from
22340 STRING. PRECISION <= 0 means don't truncate the string.
22342 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
22343 properties to the string.
22345 PROPS are the properties to add to the string.
22346 The mode_line_string_face face property is always added to the string.
22350 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
22351 int field_width
, int precision
, Lisp_Object props
)
22356 if (string
!= NULL
)
22358 len
= strlen (string
);
22359 if (precision
> 0 && len
> precision
)
22361 lisp_string
= make_string (string
, len
);
22363 props
= mode_line_string_face_prop
;
22364 else if (!NILP (mode_line_string_face
))
22366 Lisp_Object face
= Fplist_get (props
, Qface
);
22367 props
= Fcopy_sequence (props
);
22369 face
= mode_line_string_face
;
22371 face
= list2 (face
, mode_line_string_face
);
22372 props
= Fplist_put (props
, Qface
, face
);
22374 Fadd_text_properties (make_number (0), make_number (len
),
22375 props
, lisp_string
);
22379 len
= XFASTINT (Flength (lisp_string
));
22380 if (precision
> 0 && len
> precision
)
22383 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22386 if (!NILP (mode_line_string_face
))
22390 props
= Ftext_properties_at (make_number (0), lisp_string
);
22391 face
= Fplist_get (props
, Qface
);
22393 face
= mode_line_string_face
;
22395 face
= list2 (face
, mode_line_string_face
);
22396 props
= list2 (Qface
, face
);
22398 lisp_string
= Fcopy_sequence (lisp_string
);
22401 Fadd_text_properties (make_number (0), make_number (len
),
22402 props
, lisp_string
);
22407 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22411 if (field_width
> len
)
22413 field_width
-= len
;
22414 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22416 Fadd_text_properties (make_number (0), make_number (field_width
),
22417 props
, lisp_string
);
22418 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22426 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22428 doc
: /* Format a string out of a mode line format specification.
22429 First arg FORMAT specifies the mode line format (see `mode-line-format'
22430 for details) to use.
22432 By default, the format is evaluated for the currently selected window.
22434 Optional second arg FACE specifies the face property to put on all
22435 characters for which no face is specified. The value nil means the
22436 default face. The value t means whatever face the window's mode line
22437 currently uses (either `mode-line' or `mode-line-inactive',
22438 depending on whether the window is the selected window or not).
22439 An integer value means the value string has no text
22442 Optional third and fourth args WINDOW and BUFFER specify the window
22443 and buffer to use as the context for the formatting (defaults
22444 are the selected window and the WINDOW's buffer). */)
22445 (Lisp_Object format
, Lisp_Object face
,
22446 Lisp_Object window
, Lisp_Object buffer
)
22451 struct buffer
*old_buffer
= NULL
;
22453 int no_props
= INTEGERP (face
);
22454 ptrdiff_t count
= SPECPDL_INDEX ();
22456 int string_start
= 0;
22458 w
= decode_any_window (window
);
22459 XSETWINDOW (window
, w
);
22462 buffer
= w
->contents
;
22463 CHECK_BUFFER (buffer
);
22465 /* Make formatting the modeline a non-op when noninteractive, otherwise
22466 there will be problems later caused by a partially initialized frame. */
22467 if (NILP (format
) || noninteractive
)
22468 return empty_unibyte_string
;
22473 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22474 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22475 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22476 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22477 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22478 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22479 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22482 old_buffer
= current_buffer
;
22484 /* Save things including mode_line_proptrans_alist,
22485 and set that to nil so that we don't alter the outer value. */
22486 record_unwind_protect (unwind_format_mode_line
,
22487 format_mode_line_unwind_data
22488 (XFRAME (WINDOW_FRAME (w
)),
22489 old_buffer
, selected_window
, 1));
22490 mode_line_proptrans_alist
= Qnil
;
22492 Fselect_window (window
, Qt
);
22493 set_buffer_internal_1 (XBUFFER (buffer
));
22495 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22499 mode_line_target
= MODE_LINE_NOPROP
;
22500 mode_line_string_face_prop
= Qnil
;
22501 mode_line_string_list
= Qnil
;
22502 string_start
= MODE_LINE_NOPROP_LEN (0);
22506 mode_line_target
= MODE_LINE_STRING
;
22507 mode_line_string_list
= Qnil
;
22508 mode_line_string_face
= face
;
22509 mode_line_string_face_prop
22510 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22513 push_kboard (FRAME_KBOARD (it
.f
));
22514 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
22519 len
= MODE_LINE_NOPROP_LEN (string_start
);
22520 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22524 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22525 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
22526 empty_unibyte_string
);
22529 unbind_to (count
, Qnil
);
22533 /* Write a null-terminated, right justified decimal representation of
22534 the positive integer D to BUF using a minimal field width WIDTH. */
22537 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22539 register char *p
= buf
;
22547 *p
++ = d
% 10 + '0';
22552 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22563 /* Write a null-terminated, right justified decimal and "human
22564 readable" representation of the nonnegative integer D to BUF using
22565 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22567 static const char power_letter
[] =
22581 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22583 /* We aim to represent the nonnegative integer D as
22584 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22585 ptrdiff_t quotient
= d
;
22587 /* -1 means: do not use TENTHS. */
22591 /* Length of QUOTIENT.TENTHS as a string. */
22597 if (quotient
>= 1000)
22599 /* Scale to the appropriate EXPONENT. */
22602 remainder
= quotient
% 1000;
22606 while (quotient
>= 1000);
22608 /* Round to nearest and decide whether to use TENTHS or not. */
22611 tenths
= remainder
/ 100;
22612 if (remainder
% 100 >= 50)
22619 if (quotient
== 10)
22627 if (remainder
>= 500)
22629 if (quotient
< 999)
22640 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22641 if (tenths
== -1 && quotient
<= 99)
22648 p
= psuffix
= buf
+ max (width
, length
);
22650 /* Print EXPONENT. */
22651 *psuffix
++ = power_letter
[exponent
];
22654 /* Print TENTHS. */
22657 *--p
= '0' + tenths
;
22661 /* Print QUOTIENT. */
22664 int digit
= quotient
% 10;
22665 *--p
= '0' + digit
;
22667 while ((quotient
/= 10) != 0);
22669 /* Print leading spaces. */
22674 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22675 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
22676 type of CODING_SYSTEM. Return updated pointer into BUF. */
22678 static unsigned char invalid_eol_type
[] = "(*invalid*)";
22681 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
22684 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
22685 const unsigned char *eol_str
;
22687 /* The EOL conversion we are using. */
22688 Lisp_Object eoltype
;
22690 val
= CODING_SYSTEM_SPEC (coding_system
);
22693 if (!VECTORP (val
)) /* Not yet decided. */
22695 *buf
++ = multibyte
? '-' : ' ';
22697 eoltype
= eol_mnemonic_undecided
;
22698 /* Don't mention EOL conversion if it isn't decided. */
22703 Lisp_Object eolvalue
;
22705 attrs
= AREF (val
, 0);
22706 eolvalue
= AREF (val
, 2);
22709 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
22714 /* The EOL conversion that is normal on this system. */
22716 if (NILP (eolvalue
)) /* Not yet decided. */
22717 eoltype
= eol_mnemonic_undecided
;
22718 else if (VECTORP (eolvalue
)) /* Not yet decided. */
22719 eoltype
= eol_mnemonic_undecided
;
22720 else /* eolvalue is Qunix, Qdos, or Qmac. */
22721 eoltype
= (EQ (eolvalue
, Qunix
)
22722 ? eol_mnemonic_unix
22723 : (EQ (eolvalue
, Qdos
) == 1
22724 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
22730 /* Mention the EOL conversion if it is not the usual one. */
22731 if (STRINGP (eoltype
))
22733 eol_str
= SDATA (eoltype
);
22734 eol_str_len
= SBYTES (eoltype
);
22736 else if (CHARACTERP (eoltype
))
22738 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
22739 int c
= XFASTINT (eoltype
);
22740 eol_str_len
= CHAR_STRING (c
, tmp
);
22745 eol_str
= invalid_eol_type
;
22746 eol_str_len
= sizeof (invalid_eol_type
) - 1;
22748 memcpy (buf
, eol_str
, eol_str_len
);
22749 buf
+= eol_str_len
;
22755 /* Return a string for the output of a mode line %-spec for window W,
22756 generated by character C. FIELD_WIDTH > 0 means pad the string
22757 returned with spaces to that value. Return a Lisp string in
22758 *STRING if the resulting string is taken from that Lisp string.
22760 Note we operate on the current buffer for most purposes. */
22762 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
22764 static const char *
22765 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
22766 Lisp_Object
*string
)
22769 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22770 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
22771 /* We are going to use f->decode_mode_spec_buffer as the buffer to
22772 produce strings from numerical values, so limit preposterously
22773 large values of FIELD_WIDTH to avoid overrunning the buffer's
22774 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
22775 bytes plus the terminating null. */
22776 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
22777 struct buffer
*b
= current_buffer
;
22785 if (!NILP (BVAR (b
, read_only
)))
22787 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22792 /* This differs from %* only for a modified read-only buffer. */
22793 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22795 if (!NILP (BVAR (b
, read_only
)))
22800 /* This differs from %* in ignoring read-only-ness. */
22801 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22813 if (command_loop_level
> 5)
22815 p
= decode_mode_spec_buf
;
22816 for (i
= 0; i
< command_loop_level
; i
++)
22819 return decode_mode_spec_buf
;
22827 if (command_loop_level
> 5)
22829 p
= decode_mode_spec_buf
;
22830 for (i
= 0; i
< command_loop_level
; i
++)
22833 return decode_mode_spec_buf
;
22840 /* Let lots_of_dashes be a string of infinite length. */
22841 if (mode_line_target
== MODE_LINE_NOPROP
22842 || mode_line_target
== MODE_LINE_STRING
)
22844 if (field_width
<= 0
22845 || field_width
> sizeof (lots_of_dashes
))
22847 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
22848 decode_mode_spec_buf
[i
] = '-';
22849 decode_mode_spec_buf
[i
] = '\0';
22850 return decode_mode_spec_buf
;
22853 return lots_of_dashes
;
22857 obj
= BVAR (b
, name
);
22861 /* %c and %l are ignored in `frame-title-format'.
22862 (In redisplay_internal, the frame title is drawn _before_ the
22863 windows are updated, so the stuff which depends on actual
22864 window contents (such as %l) may fail to render properly, or
22865 even crash emacs.) */
22866 if (mode_line_target
== MODE_LINE_TITLE
)
22870 ptrdiff_t col
= current_column ();
22871 w
->column_number_displayed
= col
;
22872 pint2str (decode_mode_spec_buf
, width
, col
);
22873 return decode_mode_spec_buf
;
22877 #ifndef SYSTEM_MALLOC
22879 if (NILP (Vmemory_full
))
22882 return "!MEM FULL! ";
22889 /* %F displays the frame name. */
22890 if (!NILP (f
->title
))
22891 return SSDATA (f
->title
);
22892 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
22893 return SSDATA (f
->name
);
22897 obj
= BVAR (b
, filename
);
22902 ptrdiff_t size
= ZV
- BEGV
;
22903 pint2str (decode_mode_spec_buf
, width
, size
);
22904 return decode_mode_spec_buf
;
22909 ptrdiff_t size
= ZV
- BEGV
;
22910 pint2hrstr (decode_mode_spec_buf
, width
, size
);
22911 return decode_mode_spec_buf
;
22916 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
22917 ptrdiff_t topline
, nlines
, height
;
22920 /* %c and %l are ignored in `frame-title-format'. */
22921 if (mode_line_target
== MODE_LINE_TITLE
)
22924 startpos
= marker_position (w
->start
);
22925 startpos_byte
= marker_byte_position (w
->start
);
22926 height
= WINDOW_TOTAL_LINES (w
);
22928 /* If we decided that this buffer isn't suitable for line numbers,
22929 don't forget that too fast. */
22930 if (w
->base_line_pos
== -1)
22933 /* If the buffer is very big, don't waste time. */
22934 if (INTEGERP (Vline_number_display_limit
)
22935 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
22937 w
->base_line_pos
= 0;
22938 w
->base_line_number
= 0;
22942 if (w
->base_line_number
> 0
22943 && w
->base_line_pos
> 0
22944 && w
->base_line_pos
<= startpos
)
22946 line
= w
->base_line_number
;
22947 linepos
= w
->base_line_pos
;
22948 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
22953 linepos
= BUF_BEGV (b
);
22954 linepos_byte
= BUF_BEGV_BYTE (b
);
22957 /* Count lines from base line to window start position. */
22958 nlines
= display_count_lines (linepos_byte
,
22962 topline
= nlines
+ line
;
22964 /* Determine a new base line, if the old one is too close
22965 or too far away, or if we did not have one.
22966 "Too close" means it's plausible a scroll-down would
22967 go back past it. */
22968 if (startpos
== BUF_BEGV (b
))
22970 w
->base_line_number
= topline
;
22971 w
->base_line_pos
= BUF_BEGV (b
);
22973 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
22974 || linepos
== BUF_BEGV (b
))
22976 ptrdiff_t limit
= BUF_BEGV (b
);
22977 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
22978 ptrdiff_t position
;
22979 ptrdiff_t distance
=
22980 (height
* 2 + 30) * line_number_display_limit_width
;
22982 if (startpos
- distance
> limit
)
22984 limit
= startpos
- distance
;
22985 limit_byte
= CHAR_TO_BYTE (limit
);
22988 nlines
= display_count_lines (startpos_byte
,
22990 - (height
* 2 + 30),
22992 /* If we couldn't find the lines we wanted within
22993 line_number_display_limit_width chars per line,
22994 give up on line numbers for this window. */
22995 if (position
== limit_byte
&& limit
== startpos
- distance
)
22997 w
->base_line_pos
= -1;
22998 w
->base_line_number
= 0;
23002 w
->base_line_number
= topline
- nlines
;
23003 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23006 /* Now count lines from the start pos to point. */
23007 nlines
= display_count_lines (startpos_byte
,
23008 PT_BYTE
, PT
, &junk
);
23010 /* Record that we did display the line number. */
23011 line_number_displayed
= 1;
23013 /* Make the string to show. */
23014 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23015 return decode_mode_spec_buf
;
23018 char* p
= decode_mode_spec_buf
;
23019 int pad
= width
- 2;
23025 return decode_mode_spec_buf
;
23031 obj
= BVAR (b
, mode_name
);
23035 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23041 ptrdiff_t pos
= marker_position (w
->start
);
23042 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23044 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23046 if (pos
<= BUF_BEGV (b
))
23051 else if (pos
<= BUF_BEGV (b
))
23055 if (total
> 1000000)
23056 /* Do it differently for a large value, to avoid overflow. */
23057 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23059 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23060 /* We can't normally display a 3-digit number,
23061 so get us a 2-digit number that is close. */
23064 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23065 return decode_mode_spec_buf
;
23069 /* Display percentage of size above the bottom of the screen. */
23072 ptrdiff_t toppos
= marker_position (w
->start
);
23073 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23074 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23076 if (botpos
>= BUF_ZV (b
))
23078 if (toppos
<= BUF_BEGV (b
))
23085 if (total
> 1000000)
23086 /* Do it differently for a large value, to avoid overflow. */
23087 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23089 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23090 /* We can't normally display a 3-digit number,
23091 so get us a 2-digit number that is close. */
23094 if (toppos
<= BUF_BEGV (b
))
23095 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23097 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23098 return decode_mode_spec_buf
;
23103 /* status of process */
23104 obj
= Fget_buffer_process (Fcurrent_buffer ());
23106 return "no process";
23108 obj
= Fsymbol_name (Fprocess_status (obj
));
23114 ptrdiff_t count
= inhibit_garbage_collection ();
23115 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23116 Lisp_Object val
= Qnil
;
23118 if (STRINGP (curdir
))
23119 val
= call1 (intern ("file-remote-p"), curdir
);
23121 unbind_to (count
, Qnil
);
23130 /* coding-system (not including end-of-line format) */
23132 /* coding-system (including end-of-line type) */
23134 int eol_flag
= (c
== 'Z');
23135 char *p
= decode_mode_spec_buf
;
23137 if (! FRAME_WINDOW_P (f
))
23139 /* No need to mention EOL here--the terminal never needs
23140 to do EOL conversion. */
23141 p
= decode_mode_spec_coding (CODING_ID_NAME
23142 (FRAME_KEYBOARD_CODING (f
)->id
),
23144 p
= decode_mode_spec_coding (CODING_ID_NAME
23145 (FRAME_TERMINAL_CODING (f
)->id
),
23148 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23151 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
23152 #ifdef subprocesses
23153 obj
= Fget_buffer_process (Fcurrent_buffer ());
23154 if (PROCESSP (obj
))
23156 p
= decode_mode_spec_coding
23157 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23158 p
= decode_mode_spec_coding
23159 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23161 #endif /* subprocesses */
23164 return decode_mode_spec_buf
;
23171 return SSDATA (obj
);
23178 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23179 means count lines back from START_BYTE. But don't go beyond
23180 LIMIT_BYTE. Return the number of lines thus found (always
23183 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23184 either the position COUNT lines after/before START_BYTE, if we
23185 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23189 display_count_lines (ptrdiff_t start_byte
,
23190 ptrdiff_t limit_byte
, ptrdiff_t count
,
23191 ptrdiff_t *byte_pos_ptr
)
23193 register unsigned char *cursor
;
23194 unsigned char *base
;
23196 register ptrdiff_t ceiling
;
23197 register unsigned char *ceiling_addr
;
23198 ptrdiff_t orig_count
= count
;
23200 /* If we are not in selective display mode,
23201 check only for newlines. */
23202 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
23203 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23207 while (start_byte
< limit_byte
)
23209 ceiling
= BUFFER_CEILING_OF (start_byte
);
23210 ceiling
= min (limit_byte
- 1, ceiling
);
23211 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23212 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23216 if (selective_display
)
23218 while (*cursor
!= '\n' && *cursor
!= 015
23219 && ++cursor
!= ceiling_addr
)
23221 if (cursor
== ceiling_addr
)
23226 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23235 start_byte
+= cursor
- base
;
23236 *byte_pos_ptr
= start_byte
;
23240 while (cursor
< ceiling_addr
);
23242 start_byte
+= ceiling_addr
- base
;
23247 while (start_byte
> limit_byte
)
23249 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23250 ceiling
= max (limit_byte
, ceiling
);
23251 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23252 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23255 if (selective_display
)
23257 while (--cursor
>= ceiling_addr
23258 && *cursor
!= '\n' && *cursor
!= 015)
23260 if (cursor
< ceiling_addr
)
23265 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23272 start_byte
+= cursor
- base
+ 1;
23273 *byte_pos_ptr
= start_byte
;
23274 /* When scanning backwards, we should
23275 not count the newline posterior to which we stop. */
23276 return - orig_count
- 1;
23279 start_byte
+= ceiling_addr
- base
;
23283 *byte_pos_ptr
= limit_byte
;
23286 return - orig_count
+ count
;
23287 return orig_count
- count
;
23293 /***********************************************************************
23295 ***********************************************************************/
23297 /* Display a NUL-terminated string, starting with index START.
23299 If STRING is non-null, display that C string. Otherwise, the Lisp
23300 string LISP_STRING is displayed. There's a case that STRING is
23301 non-null and LISP_STRING is not nil. It means STRING is a string
23302 data of LISP_STRING. In that case, we display LISP_STRING while
23303 ignoring its text properties.
23305 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23306 FACE_STRING. Display STRING or LISP_STRING with the face at
23307 FACE_STRING_POS in FACE_STRING:
23309 Display the string in the environment given by IT, but use the
23310 standard display table, temporarily.
23312 FIELD_WIDTH is the minimum number of output glyphs to produce.
23313 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23314 with spaces. If STRING has more characters, more than FIELD_WIDTH
23315 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23317 PRECISION is the maximum number of characters to output from
23318 STRING. PRECISION < 0 means don't truncate the string.
23320 This is roughly equivalent to printf format specifiers:
23322 FIELD_WIDTH PRECISION PRINTF
23323 ----------------------------------------
23329 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23330 display them, and < 0 means obey the current buffer's value of
23331 enable_multibyte_characters.
23333 Value is the number of columns displayed. */
23336 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23337 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23338 int field_width
, int precision
, int max_x
, int multibyte
)
23340 int hpos_at_start
= it
->hpos
;
23341 int saved_face_id
= it
->face_id
;
23342 struct glyph_row
*row
= it
->glyph_row
;
23343 ptrdiff_t it_charpos
;
23345 /* Initialize the iterator IT for iteration over STRING beginning
23346 with index START. */
23347 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23348 precision
, field_width
, multibyte
);
23349 if (string
&& STRINGP (lisp_string
))
23350 /* LISP_STRING is the one returned by decode_mode_spec. We should
23351 ignore its text properties. */
23352 it
->stop_charpos
= it
->end_charpos
;
23354 /* If displaying STRING, set up the face of the iterator from
23355 FACE_STRING, if that's given. */
23356 if (STRINGP (face_string
))
23362 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23363 0, &endptr
, it
->base_face_id
, 0);
23364 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23365 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23368 /* Set max_x to the maximum allowed X position. Don't let it go
23369 beyond the right edge of the window. */
23371 max_x
= it
->last_visible_x
;
23373 max_x
= min (max_x
, it
->last_visible_x
);
23375 /* Skip over display elements that are not visible. because IT->w is
23377 if (it
->current_x
< it
->first_visible_x
)
23378 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23379 MOVE_TO_POS
| MOVE_TO_X
);
23381 row
->ascent
= it
->max_ascent
;
23382 row
->height
= it
->max_ascent
+ it
->max_descent
;
23383 row
->phys_ascent
= it
->max_phys_ascent
;
23384 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23385 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23387 if (STRINGP (it
->string
))
23388 it_charpos
= IT_STRING_CHARPOS (*it
);
23390 it_charpos
= IT_CHARPOS (*it
);
23392 /* This condition is for the case that we are called with current_x
23393 past last_visible_x. */
23394 while (it
->current_x
< max_x
)
23396 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23398 /* Get the next display element. */
23399 if (!get_next_display_element (it
))
23402 /* Produce glyphs. */
23403 x_before
= it
->current_x
;
23404 n_glyphs_before
= row
->used
[TEXT_AREA
];
23405 PRODUCE_GLYPHS (it
);
23407 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23410 while (i
< nglyphs
)
23412 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23414 if (it
->line_wrap
!= TRUNCATE
23415 && x
+ glyph
->pixel_width
> max_x
)
23417 /* End of continued line or max_x reached. */
23418 if (CHAR_GLYPH_PADDING_P (*glyph
))
23420 /* A wide character is unbreakable. */
23421 if (row
->reversed_p
)
23422 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23423 - n_glyphs_before
);
23424 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23425 it
->current_x
= x_before
;
23429 if (row
->reversed_p
)
23430 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23431 - (n_glyphs_before
+ i
));
23432 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23437 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23439 /* Glyph is at least partially visible. */
23441 if (x
< it
->first_visible_x
)
23442 row
->x
= x
- it
->first_visible_x
;
23446 /* Glyph is off the left margin of the display area.
23447 Should not happen. */
23451 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23452 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23453 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23454 row
->phys_height
= max (row
->phys_height
,
23455 it
->max_phys_ascent
+ it
->max_phys_descent
);
23456 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23457 it
->max_extra_line_spacing
);
23458 x
+= glyph
->pixel_width
;
23462 /* Stop if max_x reached. */
23466 /* Stop at line ends. */
23467 if (ITERATOR_AT_END_OF_LINE_P (it
))
23469 it
->continuation_lines_width
= 0;
23473 set_iterator_to_next (it
, 1);
23474 if (STRINGP (it
->string
))
23475 it_charpos
= IT_STRING_CHARPOS (*it
);
23477 it_charpos
= IT_CHARPOS (*it
);
23479 /* Stop if truncating at the right edge. */
23480 if (it
->line_wrap
== TRUNCATE
23481 && it
->current_x
>= it
->last_visible_x
)
23483 /* Add truncation mark, but don't do it if the line is
23484 truncated at a padding space. */
23485 if (it_charpos
< it
->string_nchars
)
23487 if (!FRAME_WINDOW_P (it
->f
))
23491 if (it
->current_x
> it
->last_visible_x
)
23493 if (!row
->reversed_p
)
23495 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23496 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23501 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23502 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23504 unproduce_glyphs (it
, ii
+ 1);
23505 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23507 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23509 row
->used
[TEXT_AREA
] = ii
;
23510 produce_special_glyphs (it
, IT_TRUNCATION
);
23513 produce_special_glyphs (it
, IT_TRUNCATION
);
23515 row
->truncated_on_right_p
= 1;
23521 /* Maybe insert a truncation at the left. */
23522 if (it
->first_visible_x
23525 if (!FRAME_WINDOW_P (it
->f
)
23526 || (row
->reversed_p
23527 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23528 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23529 insert_left_trunc_glyphs (it
);
23530 row
->truncated_on_left_p
= 1;
23533 it
->face_id
= saved_face_id
;
23535 /* Value is number of columns displayed. */
23536 return it
->hpos
- hpos_at_start
;
23541 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23542 appears as an element of LIST or as the car of an element of LIST.
23543 If PROPVAL is a list, compare each element against LIST in that
23544 way, and return 1/2 if any element of PROPVAL is found in LIST.
23545 Otherwise return 0. This function cannot quit.
23546 The return value is 2 if the text is invisible but with an ellipsis
23547 and 1 if it's invisible and without an ellipsis. */
23550 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
23552 register Lisp_Object tail
, proptail
;
23554 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23556 register Lisp_Object tem
;
23558 if (EQ (propval
, tem
))
23560 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23561 return NILP (XCDR (tem
)) ? 1 : 2;
23564 if (CONSP (propval
))
23566 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23568 Lisp_Object propelt
;
23569 propelt
= XCAR (proptail
);
23570 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23572 register Lisp_Object tem
;
23574 if (EQ (propelt
, tem
))
23576 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23577 return NILP (XCDR (tem
)) ? 1 : 2;
23585 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23586 doc
: /* Non-nil if the property makes the text invisible.
23587 POS-OR-PROP can be a marker or number, in which case it is taken to be
23588 a position in the current buffer and the value of the `invisible' property
23589 is checked; or it can be some other value, which is then presumed to be the
23590 value of the `invisible' property of the text of interest.
23591 The non-nil value returned can be t for truly invisible text or something
23592 else if the text is replaced by an ellipsis. */)
23593 (Lisp_Object pos_or_prop
)
23596 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23597 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23599 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23600 return (invis
== 0 ? Qnil
23602 : make_number (invis
));
23605 /* Calculate a width or height in pixels from a specification using
23606 the following elements:
23609 NUM - a (fractional) multiple of the default font width/height
23610 (NUM) - specifies exactly NUM pixels
23611 UNIT - a fixed number of pixels, see below.
23612 ELEMENT - size of a display element in pixels, see below.
23613 (NUM . SPEC) - equals NUM * SPEC
23614 (+ SPEC SPEC ...) - add pixel values
23615 (- SPEC SPEC ...) - subtract pixel values
23616 (- SPEC) - negate pixel value
23619 INT or FLOAT - a number constant
23620 SYMBOL - use symbol's (buffer local) variable binding.
23623 in - pixels per inch *)
23624 mm - pixels per 1/1000 meter *)
23625 cm - pixels per 1/100 meter *)
23626 width - width of current font in pixels.
23627 height - height of current font in pixels.
23629 *) using the ratio(s) defined in display-pixels-per-inch.
23633 left-fringe - left fringe width in pixels
23634 right-fringe - right fringe width in pixels
23636 left-margin - left margin width in pixels
23637 right-margin - right margin width in pixels
23639 scroll-bar - scroll-bar area width in pixels
23643 Pixels corresponding to 5 inches:
23646 Total width of non-text areas on left side of window (if scroll-bar is on left):
23647 '(space :width (+ left-fringe left-margin scroll-bar))
23649 Align to first text column (in header line):
23650 '(space :align-to 0)
23652 Align to middle of text area minus half the width of variable `my-image'
23653 containing a loaded image:
23654 '(space :align-to (0.5 . (- text my-image)))
23656 Width of left margin minus width of 1 character in the default font:
23657 '(space :width (- left-margin 1))
23659 Width of left margin minus width of 2 characters in the current font:
23660 '(space :width (- left-margin (2 . width)))
23662 Center 1 character over left-margin (in header line):
23663 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23665 Different ways to express width of left fringe plus left margin minus one pixel:
23666 '(space :width (- (+ left-fringe left-margin) (1)))
23667 '(space :width (+ left-fringe left-margin (- (1))))
23668 '(space :width (+ left-fringe left-margin (-1)))
23673 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
23674 struct font
*font
, int width_p
, int *align_to
)
23678 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
23679 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
23682 return OK_PIXELS (0);
23684 eassert (FRAME_LIVE_P (it
->f
));
23686 if (SYMBOLP (prop
))
23688 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
23690 char *unit
= SSDATA (SYMBOL_NAME (prop
));
23692 if (unit
[0] == 'i' && unit
[1] == 'n')
23694 else if (unit
[0] == 'm' && unit
[1] == 'm')
23696 else if (unit
[0] == 'c' && unit
[1] == 'm')
23702 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
23703 : FRAME_RES_Y (it
->f
));
23706 return OK_PIXELS (ppi
/ pixels
);
23711 #ifdef HAVE_WINDOW_SYSTEM
23712 if (EQ (prop
, Qheight
))
23713 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
23714 if (EQ (prop
, Qwidth
))
23715 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
23717 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
23718 return OK_PIXELS (1);
23721 if (EQ (prop
, Qtext
))
23722 return OK_PIXELS (width_p
23723 ? window_box_width (it
->w
, TEXT_AREA
)
23724 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
23726 if (align_to
&& *align_to
< 0)
23729 if (EQ (prop
, Qleft
))
23730 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
23731 if (EQ (prop
, Qright
))
23732 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
23733 if (EQ (prop
, Qcenter
))
23734 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
23735 + window_box_width (it
->w
, TEXT_AREA
) / 2);
23736 if (EQ (prop
, Qleft_fringe
))
23737 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23738 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
23739 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
23740 if (EQ (prop
, Qright_fringe
))
23741 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23742 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23743 : window_box_right_offset (it
->w
, TEXT_AREA
));
23744 if (EQ (prop
, Qleft_margin
))
23745 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
23746 if (EQ (prop
, Qright_margin
))
23747 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
23748 if (EQ (prop
, Qscroll_bar
))
23749 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
23751 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23752 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23753 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23758 if (EQ (prop
, Qleft_fringe
))
23759 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
23760 if (EQ (prop
, Qright_fringe
))
23761 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
23762 if (EQ (prop
, Qleft_margin
))
23763 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
23764 if (EQ (prop
, Qright_margin
))
23765 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
23766 if (EQ (prop
, Qscroll_bar
))
23767 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
23770 prop
= buffer_local_value_1 (prop
, it
->w
->contents
);
23771 if (EQ (prop
, Qunbound
))
23775 if (INTEGERP (prop
) || FLOATP (prop
))
23777 int base_unit
= (width_p
23778 ? FRAME_COLUMN_WIDTH (it
->f
)
23779 : FRAME_LINE_HEIGHT (it
->f
));
23780 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
23785 Lisp_Object car
= XCAR (prop
);
23786 Lisp_Object cdr
= XCDR (prop
);
23790 #ifdef HAVE_WINDOW_SYSTEM
23791 if (FRAME_WINDOW_P (it
->f
)
23792 && valid_image_p (prop
))
23794 ptrdiff_t id
= lookup_image (it
->f
, prop
);
23795 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
23797 return OK_PIXELS (width_p
? img
->width
: img
->height
);
23800 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
23806 while (CONSP (cdr
))
23808 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
23809 font
, width_p
, align_to
))
23812 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
23817 if (EQ (car
, Qminus
))
23819 return OK_PIXELS (pixels
);
23822 car
= buffer_local_value_1 (car
, it
->w
->contents
);
23823 if (EQ (car
, Qunbound
))
23827 if (INTEGERP (car
) || FLOATP (car
))
23830 pixels
= XFLOATINT (car
);
23832 return OK_PIXELS (pixels
);
23833 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
23834 font
, width_p
, align_to
))
23835 return OK_PIXELS (pixels
* fact
);
23846 /***********************************************************************
23848 ***********************************************************************/
23850 #ifdef HAVE_WINDOW_SYSTEM
23855 dump_glyph_string (struct glyph_string
*s
)
23857 fprintf (stderr
, "glyph string\n");
23858 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
23859 s
->x
, s
->y
, s
->width
, s
->height
);
23860 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
23861 fprintf (stderr
, " hl = %d\n", s
->hl
);
23862 fprintf (stderr
, " left overhang = %d, right = %d\n",
23863 s
->left_overhang
, s
->right_overhang
);
23864 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
23865 fprintf (stderr
, " extends to end of line = %d\n",
23866 s
->extends_to_end_of_line_p
);
23867 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
23868 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
23871 #endif /* GLYPH_DEBUG */
23873 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
23874 of XChar2b structures for S; it can't be allocated in
23875 init_glyph_string because it must be allocated via `alloca'. W
23876 is the window on which S is drawn. ROW and AREA are the glyph row
23877 and area within the row from which S is constructed. START is the
23878 index of the first glyph structure covered by S. HL is a
23879 face-override for drawing S. */
23882 #define OPTIONAL_HDC(hdc) HDC hdc,
23883 #define DECLARE_HDC(hdc) HDC hdc;
23884 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
23885 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
23888 #ifndef OPTIONAL_HDC
23889 #define OPTIONAL_HDC(hdc)
23890 #define DECLARE_HDC(hdc)
23891 #define ALLOCATE_HDC(hdc, f)
23892 #define RELEASE_HDC(hdc, f)
23896 init_glyph_string (struct glyph_string
*s
,
23898 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
23899 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
23901 memset (s
, 0, sizeof *s
);
23903 s
->f
= XFRAME (w
->frame
);
23907 s
->display
= FRAME_X_DISPLAY (s
->f
);
23908 s
->window
= FRAME_X_WINDOW (s
->f
);
23909 s
->char2b
= char2b
;
23913 s
->first_glyph
= row
->glyphs
[area
] + start
;
23914 s
->height
= row
->height
;
23915 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
23916 s
->ybase
= s
->y
+ row
->ascent
;
23920 /* Append the list of glyph strings with head H and tail T to the list
23921 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
23924 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23925 struct glyph_string
*h
, struct glyph_string
*t
)
23939 /* Prepend the list of glyph strings with head H and tail T to the
23940 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
23944 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23945 struct glyph_string
*h
, struct glyph_string
*t
)
23959 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
23960 Set *HEAD and *TAIL to the resulting list. */
23963 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
23964 struct glyph_string
*s
)
23966 s
->next
= s
->prev
= NULL
;
23967 append_glyph_string_lists (head
, tail
, s
, s
);
23971 /* Get face and two-byte form of character C in face FACE_ID on frame F.
23972 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
23973 make sure that X resources for the face returned are allocated.
23974 Value is a pointer to a realized face that is ready for display if
23975 DISPLAY_P is non-zero. */
23977 static struct face
*
23978 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
23979 XChar2b
*char2b
, int display_p
)
23981 struct face
*face
= FACE_FROM_ID (f
, face_id
);
23986 code
= face
->font
->driver
->encode_char (face
->font
, c
);
23988 if (code
== FONT_INVALID_CODE
)
23991 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23993 /* Make sure X resources of the face are allocated. */
23994 #ifdef HAVE_X_WINDOWS
23998 eassert (face
!= NULL
);
23999 PREPARE_FACE_FOR_DISPLAY (f
, face
);
24006 /* Get face and two-byte form of character glyph GLYPH on frame F.
24007 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24008 a pointer to a realized face that is ready for display. */
24010 static struct face
*
24011 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24012 XChar2b
*char2b
, int *two_byte_p
)
24017 eassert (glyph
->type
== CHAR_GLYPH
);
24018 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24020 /* Make sure X resources of the face are allocated. */
24021 eassert (face
!= NULL
);
24022 PREPARE_FACE_FOR_DISPLAY (f
, face
);
24029 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24030 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24032 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24034 if (code
== FONT_INVALID_CODE
)
24038 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24043 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24044 Return 1 if FONT has a glyph for C, otherwise return 0. */
24047 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24051 if (CHAR_BYTE8_P (c
))
24052 code
= CHAR_TO_BYTE8 (c
);
24054 code
= font
->driver
->encode_char (font
, c
);
24056 if (code
== FONT_INVALID_CODE
)
24058 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24063 /* Fill glyph string S with composition components specified by S->cmp.
24065 BASE_FACE is the base face of the composition.
24066 S->cmp_from is the index of the first component for S.
24068 OVERLAPS non-zero means S should draw the foreground only, and use
24069 its physical height for clipping. See also draw_glyphs.
24071 Value is the index of a component not in S. */
24074 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24078 /* For all glyphs of this composition, starting at the offset
24079 S->cmp_from, until we reach the end of the definition or encounter a
24080 glyph that requires the different face, add it to S. */
24085 s
->for_overlaps
= overlaps
;
24088 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24090 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24092 /* TAB in a composition means display glyphs with padding space
24093 on the left or right. */
24096 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24099 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24106 s
->font
= s
->face
->font
;
24108 else if (s
->face
!= face
)
24116 if (s
->face
== NULL
)
24118 s
->face
= base_face
->ascii_face
;
24119 s
->font
= s
->face
->font
;
24122 /* All glyph strings for the same composition has the same width,
24123 i.e. the width set for the first component of the composition. */
24124 s
->width
= s
->first_glyph
->pixel_width
;
24126 /* If the specified font could not be loaded, use the frame's
24127 default font, but record the fact that we couldn't load it in
24128 the glyph string so that we can draw rectangles for the
24129 characters of the glyph string. */
24130 if (s
->font
== NULL
)
24132 s
->font_not_found_p
= 1;
24133 s
->font
= FRAME_FONT (s
->f
);
24136 /* Adjust base line for subscript/superscript text. */
24137 s
->ybase
+= s
->first_glyph
->voffset
;
24139 /* This glyph string must always be drawn with 16-bit functions. */
24146 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24147 int start
, int end
, int overlaps
)
24149 struct glyph
*glyph
, *last
;
24150 Lisp_Object lgstring
;
24153 s
->for_overlaps
= overlaps
;
24154 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24155 last
= s
->row
->glyphs
[s
->area
] + end
;
24156 s
->cmp_id
= glyph
->u
.cmp
.id
;
24157 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24158 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24159 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24160 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24161 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24163 while (glyph
< last
24164 && glyph
->u
.cmp
.automatic
24165 && glyph
->u
.cmp
.id
== s
->cmp_id
24166 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24167 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24169 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24171 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24172 unsigned code
= LGLYPH_CODE (lglyph
);
24174 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24176 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24177 return glyph
- s
->row
->glyphs
[s
->area
];
24181 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24182 See the comment of fill_glyph_string for arguments.
24183 Value is the index of the first glyph not in S. */
24187 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24188 int start
, int end
, int overlaps
)
24190 struct glyph
*glyph
, *last
;
24193 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24194 s
->for_overlaps
= overlaps
;
24195 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24196 last
= s
->row
->glyphs
[s
->area
] + end
;
24197 voffset
= glyph
->voffset
;
24198 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24199 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24201 s
->width
= glyph
->pixel_width
;
24203 while (glyph
< last
24204 && glyph
->type
== GLYPHLESS_GLYPH
24205 && glyph
->voffset
== voffset
24206 && glyph
->face_id
== face_id
)
24209 s
->width
+= glyph
->pixel_width
;
24212 s
->ybase
+= voffset
;
24213 return glyph
- s
->row
->glyphs
[s
->area
];
24217 /* Fill glyph string S from a sequence of character glyphs.
24219 FACE_ID is the face id of the string. START is the index of the
24220 first glyph to consider, END is the index of the last + 1.
24221 OVERLAPS non-zero means S should draw the foreground only, and use
24222 its physical height for clipping. See also draw_glyphs.
24224 Value is the index of the first glyph not in S. */
24227 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24228 int start
, int end
, int overlaps
)
24230 struct glyph
*glyph
, *last
;
24232 int glyph_not_available_p
;
24234 eassert (s
->f
== XFRAME (s
->w
->frame
));
24235 eassert (s
->nchars
== 0);
24236 eassert (start
>= 0 && end
> start
);
24238 s
->for_overlaps
= overlaps
;
24239 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24240 last
= s
->row
->glyphs
[s
->area
] + end
;
24241 voffset
= glyph
->voffset
;
24242 s
->padding_p
= glyph
->padding_p
;
24243 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24245 while (glyph
< last
24246 && glyph
->type
== CHAR_GLYPH
24247 && glyph
->voffset
== voffset
24248 /* Same face id implies same font, nowadays. */
24249 && glyph
->face_id
== face_id
24250 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24254 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24255 s
->char2b
+ s
->nchars
,
24257 s
->two_byte_p
= two_byte_p
;
24259 eassert (s
->nchars
<= end
- start
);
24260 s
->width
+= glyph
->pixel_width
;
24261 if (glyph
++->padding_p
!= s
->padding_p
)
24265 s
->font
= s
->face
->font
;
24267 /* If the specified font could not be loaded, use the frame's font,
24268 but record the fact that we couldn't load it in
24269 S->font_not_found_p so that we can draw rectangles for the
24270 characters of the glyph string. */
24271 if (s
->font
== NULL
|| glyph_not_available_p
)
24273 s
->font_not_found_p
= 1;
24274 s
->font
= FRAME_FONT (s
->f
);
24277 /* Adjust base line for subscript/superscript text. */
24278 s
->ybase
+= voffset
;
24280 eassert (s
->face
&& s
->face
->gc
);
24281 return glyph
- s
->row
->glyphs
[s
->area
];
24285 /* Fill glyph string S from image glyph S->first_glyph. */
24288 fill_image_glyph_string (struct glyph_string
*s
)
24290 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24291 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24293 s
->slice
= s
->first_glyph
->slice
.img
;
24294 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24295 s
->font
= s
->face
->font
;
24296 s
->width
= s
->first_glyph
->pixel_width
;
24298 /* Adjust base line for subscript/superscript text. */
24299 s
->ybase
+= s
->first_glyph
->voffset
;
24303 /* Fill glyph string S from a sequence of stretch glyphs.
24305 START is the index of the first glyph to consider,
24306 END is the index of the last + 1.
24308 Value is the index of the first glyph not in S. */
24311 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24313 struct glyph
*glyph
, *last
;
24314 int voffset
, face_id
;
24316 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24318 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24319 last
= s
->row
->glyphs
[s
->area
] + end
;
24320 face_id
= glyph
->face_id
;
24321 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24322 s
->font
= s
->face
->font
;
24323 s
->width
= glyph
->pixel_width
;
24325 voffset
= glyph
->voffset
;
24329 && glyph
->type
== STRETCH_GLYPH
24330 && glyph
->voffset
== voffset
24331 && glyph
->face_id
== face_id
);
24333 s
->width
+= glyph
->pixel_width
;
24335 /* Adjust base line for subscript/superscript text. */
24336 s
->ybase
+= voffset
;
24338 /* The case that face->gc == 0 is handled when drawing the glyph
24339 string by calling PREPARE_FACE_FOR_DISPLAY. */
24341 return glyph
- s
->row
->glyphs
[s
->area
];
24344 static struct font_metrics
*
24345 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24347 static struct font_metrics metrics
;
24352 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24353 if (code
== FONT_INVALID_CODE
)
24355 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24360 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24361 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24362 assumed to be zero. */
24365 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24367 *left
= *right
= 0;
24369 if (glyph
->type
== CHAR_GLYPH
)
24373 struct font_metrics
*pcm
;
24375 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
24376 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
24378 if (pcm
->rbearing
> pcm
->width
)
24379 *right
= pcm
->rbearing
- pcm
->width
;
24380 if (pcm
->lbearing
< 0)
24381 *left
= -pcm
->lbearing
;
24384 else if (glyph
->type
== COMPOSITE_GLYPH
)
24386 if (! glyph
->u
.cmp
.automatic
)
24388 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24390 if (cmp
->rbearing
> cmp
->pixel_width
)
24391 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24392 if (cmp
->lbearing
< 0)
24393 *left
= - cmp
->lbearing
;
24397 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24398 struct font_metrics metrics
;
24400 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24401 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24402 if (metrics
.rbearing
> metrics
.width
)
24403 *right
= metrics
.rbearing
- metrics
.width
;
24404 if (metrics
.lbearing
< 0)
24405 *left
= - metrics
.lbearing
;
24411 /* Return the index of the first glyph preceding glyph string S that
24412 is overwritten by S because of S's left overhang. Value is -1
24413 if no glyphs are overwritten. */
24416 left_overwritten (struct glyph_string
*s
)
24420 if (s
->left_overhang
)
24423 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24424 int first
= s
->first_glyph
- glyphs
;
24426 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24427 x
-= glyphs
[i
].pixel_width
;
24438 /* Return the index of the first glyph preceding glyph string S that
24439 is overwriting S because of its right overhang. Value is -1 if no
24440 glyph in front of S overwrites S. */
24443 left_overwriting (struct glyph_string
*s
)
24446 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24447 int first
= s
->first_glyph
- glyphs
;
24451 for (i
= first
- 1; i
>= 0; --i
)
24454 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24457 x
-= glyphs
[i
].pixel_width
;
24464 /* Return the index of the last glyph following glyph string S that is
24465 overwritten by S because of S's right overhang. Value is -1 if
24466 no such glyph is found. */
24469 right_overwritten (struct glyph_string
*s
)
24473 if (s
->right_overhang
)
24476 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24477 int first
= (s
->first_glyph
- glyphs
24478 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24479 int end
= s
->row
->used
[s
->area
];
24481 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24482 x
+= glyphs
[i
].pixel_width
;
24491 /* Return the index of the last glyph following glyph string S that
24492 overwrites S because of its left overhang. Value is negative
24493 if no such glyph is found. */
24496 right_overwriting (struct glyph_string
*s
)
24499 int end
= s
->row
->used
[s
->area
];
24500 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24501 int first
= (s
->first_glyph
- glyphs
24502 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24506 for (i
= first
; i
< end
; ++i
)
24509 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24512 x
+= glyphs
[i
].pixel_width
;
24519 /* Set background width of glyph string S. START is the index of the
24520 first glyph following S. LAST_X is the right-most x-position + 1
24521 in the drawing area. */
24524 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24526 /* If the face of this glyph string has to be drawn to the end of
24527 the drawing area, set S->extends_to_end_of_line_p. */
24529 if (start
== s
->row
->used
[s
->area
]
24530 && ((s
->row
->fill_line_p
24531 && (s
->hl
== DRAW_NORMAL_TEXT
24532 || s
->hl
== DRAW_IMAGE_RAISED
24533 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24534 || s
->hl
== DRAW_MOUSE_FACE
))
24535 s
->extends_to_end_of_line_p
= 1;
24537 /* If S extends its face to the end of the line, set its
24538 background_width to the distance to the right edge of the drawing
24540 if (s
->extends_to_end_of_line_p
)
24541 s
->background_width
= last_x
- s
->x
+ 1;
24543 s
->background_width
= s
->width
;
24547 /* Compute overhangs and x-positions for glyph string S and its
24548 predecessors, or successors. X is the starting x-position for S.
24549 BACKWARD_P non-zero means process predecessors. */
24552 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
24558 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24559 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24569 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24570 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24580 /* The following macros are only called from draw_glyphs below.
24581 They reference the following parameters of that function directly:
24582 `w', `row', `area', and `overlap_p'
24583 as well as the following local variables:
24584 `s', `f', and `hdc' (in W32) */
24587 /* On W32, silently add local `hdc' variable to argument list of
24588 init_glyph_string. */
24589 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24590 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24592 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24593 init_glyph_string (s, char2b, w, row, area, start, hl)
24596 /* Add a glyph string for a stretch glyph to the list of strings
24597 between HEAD and TAIL. START is the index of the stretch glyph in
24598 row area AREA of glyph row ROW. END is the index of the last glyph
24599 in that glyph row area. X is the current output position assigned
24600 to the new glyph string constructed. HL overrides that face of the
24601 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24602 is the right-most x-position of the drawing area. */
24604 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24605 and below -- keep them on one line. */
24606 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24609 s = alloca (sizeof *s); \
24610 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24611 START = fill_stretch_glyph_string (s, START, END); \
24612 append_glyph_string (&HEAD, &TAIL, s); \
24618 /* Add a glyph string for an image glyph to the list of strings
24619 between HEAD and TAIL. START is the index of the image glyph in
24620 row area AREA of glyph row ROW. END is the index of the last glyph
24621 in that glyph row area. X is the current output position assigned
24622 to the new glyph string constructed. HL overrides that face of the
24623 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24624 is the right-most x-position of the drawing area. */
24626 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24629 s = alloca (sizeof *s); \
24630 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24631 fill_image_glyph_string (s); \
24632 append_glyph_string (&HEAD, &TAIL, s); \
24639 /* Add a glyph string for a sequence of character glyphs to the list
24640 of strings between HEAD and TAIL. START is the index of the first
24641 glyph in row area AREA of glyph row ROW that is part of the new
24642 glyph string. END is the index of the last glyph in that glyph row
24643 area. X is the current output position assigned to the new glyph
24644 string constructed. HL overrides that face of the glyph; e.g. it
24645 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24646 right-most x-position of the drawing area. */
24648 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24654 face_id = (row)->glyphs[area][START].face_id; \
24656 s = alloca (sizeof *s); \
24657 char2b = alloca ((END - START) * sizeof *char2b); \
24658 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24659 append_glyph_string (&HEAD, &TAIL, s); \
24661 START = fill_glyph_string (s, face_id, START, END, overlaps); \
24666 /* Add a glyph string for a composite sequence to the list of strings
24667 between HEAD and TAIL. START is the index of the first glyph in
24668 row area AREA of glyph row ROW that is part of the new glyph
24669 string. END is the index of the last glyph in that glyph row area.
24670 X is the current output position assigned to the new glyph string
24671 constructed. HL overrides that face of the glyph; e.g. it is
24672 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
24673 x-position of the drawing area. */
24675 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24677 int face_id = (row)->glyphs[area][START].face_id; \
24678 struct face *base_face = FACE_FROM_ID (f, face_id); \
24679 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
24680 struct composition *cmp = composition_table[cmp_id]; \
24682 struct glyph_string *first_s = NULL; \
24685 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
24687 /* Make glyph_strings for each glyph sequence that is drawable by \
24688 the same face, and append them to HEAD/TAIL. */ \
24689 for (n = 0; n < cmp->glyph_len;) \
24691 s = alloca (sizeof *s); \
24692 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24693 append_glyph_string (&(HEAD), &(TAIL), s); \
24699 n = fill_composite_glyph_string (s, base_face, overlaps); \
24707 /* Add a glyph string for a glyph-string sequence to the list of strings
24708 between HEAD and TAIL. */
24710 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24714 Lisp_Object gstring; \
24716 face_id = (row)->glyphs[area][START].face_id; \
24717 gstring = (composition_gstring_from_id \
24718 ((row)->glyphs[area][START].u.cmp.id)); \
24719 s = alloca (sizeof *s); \
24720 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
24721 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24722 append_glyph_string (&(HEAD), &(TAIL), s); \
24724 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
24728 /* Add a glyph string for a sequence of glyphless character's glyphs
24729 to the list of strings between HEAD and TAIL. The meanings of
24730 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
24732 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24737 face_id = (row)->glyphs[area][START].face_id; \
24739 s = alloca (sizeof *s); \
24740 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24741 append_glyph_string (&HEAD, &TAIL, s); \
24743 START = fill_glyphless_glyph_string (s, face_id, START, END, \
24749 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
24750 of AREA of glyph row ROW on window W between indices START and END.
24751 HL overrides the face for drawing glyph strings, e.g. it is
24752 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
24753 x-positions of the drawing area.
24755 This is an ugly monster macro construct because we must use alloca
24756 to allocate glyph strings (because draw_glyphs can be called
24757 asynchronously). */
24759 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24762 HEAD = TAIL = NULL; \
24763 while (START < END) \
24765 struct glyph *first_glyph = (row)->glyphs[area] + START; \
24766 switch (first_glyph->type) \
24769 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
24773 case COMPOSITE_GLYPH: \
24774 if (first_glyph->u.cmp.automatic) \
24775 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
24778 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
24782 case STRETCH_GLYPH: \
24783 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
24787 case IMAGE_GLYPH: \
24788 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
24792 case GLYPHLESS_GLYPH: \
24793 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
24803 set_glyph_string_background_width (s, START, LAST_X); \
24810 /* Draw glyphs between START and END in AREA of ROW on window W,
24811 starting at x-position X. X is relative to AREA in W. HL is a
24812 face-override with the following meaning:
24814 DRAW_NORMAL_TEXT draw normally
24815 DRAW_CURSOR draw in cursor face
24816 DRAW_MOUSE_FACE draw in mouse face.
24817 DRAW_INVERSE_VIDEO draw in mode line face
24818 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
24819 DRAW_IMAGE_RAISED draw an image with a raised relief around it
24821 If OVERLAPS is non-zero, draw only the foreground of characters and
24822 clip to the physical height of ROW. Non-zero value also defines
24823 the overlapping part to be drawn:
24825 OVERLAPS_PRED overlap with preceding rows
24826 OVERLAPS_SUCC overlap with succeeding rows
24827 OVERLAPS_BOTH overlap with both preceding/succeeding rows
24828 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
24830 Value is the x-position reached, relative to AREA of W. */
24833 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
24834 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
24835 enum draw_glyphs_face hl
, int overlaps
)
24837 struct glyph_string
*head
, *tail
;
24838 struct glyph_string
*s
;
24839 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
24840 int i
, j
, x_reached
, last_x
, area_left
= 0;
24841 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24844 ALLOCATE_HDC (hdc
, f
);
24846 /* Let's rather be paranoid than getting a SEGV. */
24847 end
= min (end
, row
->used
[area
]);
24848 start
= clip_to_bounds (0, start
, end
);
24850 /* Translate X to frame coordinates. Set last_x to the right
24851 end of the drawing area. */
24852 if (row
->full_width_p
)
24854 /* X is relative to the left edge of W, without scroll bars
24856 area_left
= WINDOW_LEFT_EDGE_X (w
);
24857 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
24858 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
24862 area_left
= window_box_left (w
, area
);
24863 last_x
= area_left
+ window_box_width (w
, area
);
24867 /* Build a doubly-linked list of glyph_string structures between
24868 head and tail from what we have to draw. Note that the macro
24869 BUILD_GLYPH_STRINGS will modify its start parameter. That's
24870 the reason we use a separate variable `i'. */
24872 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
24874 x_reached
= tail
->x
+ tail
->background_width
;
24878 /* If there are any glyphs with lbearing < 0 or rbearing > width in
24879 the row, redraw some glyphs in front or following the glyph
24880 strings built above. */
24881 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
24883 struct glyph_string
*h
, *t
;
24884 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24885 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
24886 int check_mouse_face
= 0;
24889 /* If mouse highlighting is on, we may need to draw adjacent
24890 glyphs using mouse-face highlighting. */
24891 if (area
== TEXT_AREA
&& row
->mouse_face_p
24892 && hlinfo
->mouse_face_beg_row
>= 0
24893 && hlinfo
->mouse_face_end_row
>= 0)
24895 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
24897 if (row_vpos
>= hlinfo
->mouse_face_beg_row
24898 && row_vpos
<= hlinfo
->mouse_face_end_row
)
24900 check_mouse_face
= 1;
24901 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
24902 ? hlinfo
->mouse_face_beg_col
: 0;
24903 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
24904 ? hlinfo
->mouse_face_end_col
24905 : row
->used
[TEXT_AREA
];
24909 /* Compute overhangs for all glyph strings. */
24910 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
24911 for (s
= head
; s
; s
= s
->next
)
24912 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
24914 /* Prepend glyph strings for glyphs in front of the first glyph
24915 string that are overwritten because of the first glyph
24916 string's left overhang. The background of all strings
24917 prepended must be drawn because the first glyph string
24919 i
= left_overwritten (head
);
24922 enum draw_glyphs_face overlap_hl
;
24924 /* If this row contains mouse highlighting, attempt to draw
24925 the overlapped glyphs with the correct highlight. This
24926 code fails if the overlap encompasses more than one glyph
24927 and mouse-highlight spans only some of these glyphs.
24928 However, making it work perfectly involves a lot more
24929 code, and I don't know if the pathological case occurs in
24930 practice, so we'll stick to this for now. --- cyd */
24931 if (check_mouse_face
24932 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24933 overlap_hl
= DRAW_MOUSE_FACE
;
24935 overlap_hl
= DRAW_NORMAL_TEXT
;
24938 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
24939 overlap_hl
, dummy_x
, last_x
);
24941 compute_overhangs_and_x (t
, head
->x
, 1);
24942 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24946 /* Prepend glyph strings for glyphs in front of the first glyph
24947 string that overwrite that glyph string because of their
24948 right overhang. For these strings, only the foreground must
24949 be drawn, because it draws over the glyph string at `head'.
24950 The background must not be drawn because this would overwrite
24951 right overhangs of preceding glyphs for which no glyph
24953 i
= left_overwriting (head
);
24956 enum draw_glyphs_face overlap_hl
;
24958 if (check_mouse_face
24959 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24960 overlap_hl
= DRAW_MOUSE_FACE
;
24962 overlap_hl
= DRAW_NORMAL_TEXT
;
24965 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
24966 overlap_hl
, dummy_x
, last_x
);
24967 for (s
= h
; s
; s
= s
->next
)
24968 s
->background_filled_p
= 1;
24969 compute_overhangs_and_x (t
, head
->x
, 1);
24970 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24973 /* Append glyphs strings for glyphs following the last glyph
24974 string tail that are overwritten by tail. The background of
24975 these strings has to be drawn because tail's foreground draws
24977 i
= right_overwritten (tail
);
24980 enum draw_glyphs_face overlap_hl
;
24982 if (check_mouse_face
24983 && mouse_beg_col
< i
&& mouse_end_col
> end
)
24984 overlap_hl
= DRAW_MOUSE_FACE
;
24986 overlap_hl
= DRAW_NORMAL_TEXT
;
24988 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
24989 overlap_hl
, x
, last_x
);
24990 /* Because BUILD_GLYPH_STRINGS updates the first argument,
24991 we don't have `end = i;' here. */
24992 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
24993 append_glyph_string_lists (&head
, &tail
, h
, t
);
24997 /* Append glyph strings for glyphs following the last glyph
24998 string tail that overwrite tail. The foreground of such
24999 glyphs has to be drawn because it writes into the background
25000 of tail. The background must not be drawn because it could
25001 paint over the foreground of following glyphs. */
25002 i
= right_overwriting (tail
);
25005 enum draw_glyphs_face overlap_hl
;
25006 if (check_mouse_face
25007 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25008 overlap_hl
= DRAW_MOUSE_FACE
;
25010 overlap_hl
= DRAW_NORMAL_TEXT
;
25013 i
++; /* We must include the Ith glyph. */
25014 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25015 overlap_hl
, x
, last_x
);
25016 for (s
= h
; s
; s
= s
->next
)
25017 s
->background_filled_p
= 1;
25018 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
25019 append_glyph_string_lists (&head
, &tail
, h
, t
);
25021 if (clip_head
|| clip_tail
)
25022 for (s
= head
; s
; s
= s
->next
)
25024 s
->clip_head
= clip_head
;
25025 s
->clip_tail
= clip_tail
;
25029 /* Draw all strings. */
25030 for (s
= head
; s
; s
= s
->next
)
25031 FRAME_RIF (f
)->draw_glyph_string (s
);
25034 /* When focus a sole frame and move horizontally, this sets on_p to 0
25035 causing a failure to erase prev cursor position. */
25036 if (area
== TEXT_AREA
25037 && !row
->full_width_p
25038 /* When drawing overlapping rows, only the glyph strings'
25039 foreground is drawn, which doesn't erase a cursor
25043 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25044 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25045 : (tail
? tail
->x
+ tail
->background_width
: x
));
25049 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25050 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25054 /* Value is the x-position up to which drawn, relative to AREA of W.
25055 This doesn't include parts drawn because of overhangs. */
25056 if (row
->full_width_p
)
25057 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25059 x_reached
-= area_left
;
25061 RELEASE_HDC (hdc
, f
);
25066 /* Expand row matrix if too narrow. Don't expand if area
25069 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25071 if (!it->f->fonts_changed \
25072 && (it->glyph_row->glyphs[area] \
25073 < it->glyph_row->glyphs[area + 1])) \
25075 it->w->ncols_scale_factor++; \
25076 it->f->fonts_changed = 1; \
25080 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25081 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25084 append_glyph (struct it
*it
)
25086 struct glyph
*glyph
;
25087 enum glyph_row_area area
= it
->area
;
25089 eassert (it
->glyph_row
);
25090 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25092 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25093 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25095 /* If the glyph row is reversed, we need to prepend the glyph
25096 rather than append it. */
25097 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25101 /* Make room for the additional glyph. */
25102 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25104 glyph
= it
->glyph_row
->glyphs
[area
];
25106 glyph
->charpos
= CHARPOS (it
->position
);
25107 glyph
->object
= it
->object
;
25108 if (it
->pixel_width
> 0)
25110 glyph
->pixel_width
= it
->pixel_width
;
25111 glyph
->padding_p
= 0;
25115 /* Assure at least 1-pixel width. Otherwise, cursor can't
25116 be displayed correctly. */
25117 glyph
->pixel_width
= 1;
25118 glyph
->padding_p
= 1;
25120 glyph
->ascent
= it
->ascent
;
25121 glyph
->descent
= it
->descent
;
25122 glyph
->voffset
= it
->voffset
;
25123 glyph
->type
= CHAR_GLYPH
;
25124 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25125 glyph
->multibyte_p
= it
->multibyte_p
;
25126 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25128 /* In R2L rows, the left and the right box edges need to be
25129 drawn in reverse direction. */
25130 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25131 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25135 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25136 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25138 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25139 || it
->phys_descent
> it
->descent
);
25140 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25141 glyph
->face_id
= it
->face_id
;
25142 glyph
->u
.ch
= it
->char_to_display
;
25143 glyph
->slice
.img
= null_glyph_slice
;
25144 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25147 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25148 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25150 glyph
->bidi_type
= it
->bidi_it
.type
;
25154 glyph
->resolved_level
= 0;
25155 glyph
->bidi_type
= UNKNOWN_BT
;
25157 ++it
->glyph_row
->used
[area
];
25160 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25163 /* Store one glyph for the composition IT->cmp_it.id in
25164 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25168 append_composite_glyph (struct it
*it
)
25170 struct glyph
*glyph
;
25171 enum glyph_row_area area
= it
->area
;
25173 eassert (it
->glyph_row
);
25175 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25176 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25178 /* If the glyph row is reversed, we need to prepend the glyph
25179 rather than append it. */
25180 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25184 /* Make room for the new glyph. */
25185 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25187 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25189 glyph
->charpos
= it
->cmp_it
.charpos
;
25190 glyph
->object
= it
->object
;
25191 glyph
->pixel_width
= it
->pixel_width
;
25192 glyph
->ascent
= it
->ascent
;
25193 glyph
->descent
= it
->descent
;
25194 glyph
->voffset
= it
->voffset
;
25195 glyph
->type
= COMPOSITE_GLYPH
;
25196 if (it
->cmp_it
.ch
< 0)
25198 glyph
->u
.cmp
.automatic
= 0;
25199 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25200 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25204 glyph
->u
.cmp
.automatic
= 1;
25205 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25206 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25207 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25209 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25210 glyph
->multibyte_p
= it
->multibyte_p
;
25211 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25213 /* In R2L rows, the left and the right box edges need to be
25214 drawn in reverse direction. */
25215 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25216 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25220 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25221 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25223 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25224 || it
->phys_descent
> it
->descent
);
25225 glyph
->padding_p
= 0;
25226 glyph
->glyph_not_available_p
= 0;
25227 glyph
->face_id
= it
->face_id
;
25228 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25231 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25232 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25234 glyph
->bidi_type
= it
->bidi_it
.type
;
25236 ++it
->glyph_row
->used
[area
];
25239 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25243 /* Change IT->ascent and IT->height according to the setting of
25247 take_vertical_position_into_account (struct it
*it
)
25251 if (it
->voffset
< 0)
25252 /* Increase the ascent so that we can display the text higher
25254 it
->ascent
-= it
->voffset
;
25256 /* Increase the descent so that we can display the text lower
25258 it
->descent
+= it
->voffset
;
25263 /* Produce glyphs/get display metrics for the image IT is loaded with.
25264 See the description of struct display_iterator in dispextern.h for
25265 an overview of struct display_iterator. */
25268 produce_image_glyph (struct it
*it
)
25272 int glyph_ascent
, crop
;
25273 struct glyph_slice slice
;
25275 eassert (it
->what
== IT_IMAGE
);
25277 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25279 /* Make sure X resources of the face is loaded. */
25280 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
25282 if (it
->image_id
< 0)
25284 /* Fringe bitmap. */
25285 it
->ascent
= it
->phys_ascent
= 0;
25286 it
->descent
= it
->phys_descent
= 0;
25287 it
->pixel_width
= 0;
25292 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25294 /* Make sure X resources of the image is loaded. */
25295 prepare_image_for_display (it
->f
, img
);
25297 slice
.x
= slice
.y
= 0;
25298 slice
.width
= img
->width
;
25299 slice
.height
= img
->height
;
25301 if (INTEGERP (it
->slice
.x
))
25302 slice
.x
= XINT (it
->slice
.x
);
25303 else if (FLOATP (it
->slice
.x
))
25304 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25306 if (INTEGERP (it
->slice
.y
))
25307 slice
.y
= XINT (it
->slice
.y
);
25308 else if (FLOATP (it
->slice
.y
))
25309 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25311 if (INTEGERP (it
->slice
.width
))
25312 slice
.width
= XINT (it
->slice
.width
);
25313 else if (FLOATP (it
->slice
.width
))
25314 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25316 if (INTEGERP (it
->slice
.height
))
25317 slice
.height
= XINT (it
->slice
.height
);
25318 else if (FLOATP (it
->slice
.height
))
25319 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25321 if (slice
.x
>= img
->width
)
25322 slice
.x
= img
->width
;
25323 if (slice
.y
>= img
->height
)
25324 slice
.y
= img
->height
;
25325 if (slice
.x
+ slice
.width
>= img
->width
)
25326 slice
.width
= img
->width
- slice
.x
;
25327 if (slice
.y
+ slice
.height
> img
->height
)
25328 slice
.height
= img
->height
- slice
.y
;
25330 if (slice
.width
== 0 || slice
.height
== 0)
25333 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25335 it
->descent
= slice
.height
- glyph_ascent
;
25337 it
->descent
+= img
->vmargin
;
25338 if (slice
.y
+ slice
.height
== img
->height
)
25339 it
->descent
+= img
->vmargin
;
25340 it
->phys_descent
= it
->descent
;
25342 it
->pixel_width
= slice
.width
;
25344 it
->pixel_width
+= img
->hmargin
;
25345 if (slice
.x
+ slice
.width
== img
->width
)
25346 it
->pixel_width
+= img
->hmargin
;
25348 /* It's quite possible for images to have an ascent greater than
25349 their height, so don't get confused in that case. */
25350 if (it
->descent
< 0)
25355 if (face
->box
!= FACE_NO_BOX
)
25357 if (face
->box_line_width
> 0)
25360 it
->ascent
+= face
->box_line_width
;
25361 if (slice
.y
+ slice
.height
== img
->height
)
25362 it
->descent
+= face
->box_line_width
;
25365 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25366 it
->pixel_width
+= eabs (face
->box_line_width
);
25367 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25368 it
->pixel_width
+= eabs (face
->box_line_width
);
25371 take_vertical_position_into_account (it
);
25373 /* Automatically crop wide image glyphs at right edge so we can
25374 draw the cursor on same display row. */
25375 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25376 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25378 it
->pixel_width
-= crop
;
25379 slice
.width
-= crop
;
25384 struct glyph
*glyph
;
25385 enum glyph_row_area area
= it
->area
;
25387 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25388 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25390 glyph
->charpos
= CHARPOS (it
->position
);
25391 glyph
->object
= it
->object
;
25392 glyph
->pixel_width
= it
->pixel_width
;
25393 glyph
->ascent
= glyph_ascent
;
25394 glyph
->descent
= it
->descent
;
25395 glyph
->voffset
= it
->voffset
;
25396 glyph
->type
= IMAGE_GLYPH
;
25397 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25398 glyph
->multibyte_p
= it
->multibyte_p
;
25399 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25401 /* In R2L rows, the left and the right box edges need to be
25402 drawn in reverse direction. */
25403 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25404 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25408 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25409 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25411 glyph
->overlaps_vertically_p
= 0;
25412 glyph
->padding_p
= 0;
25413 glyph
->glyph_not_available_p
= 0;
25414 glyph
->face_id
= it
->face_id
;
25415 glyph
->u
.img_id
= img
->id
;
25416 glyph
->slice
.img
= slice
;
25417 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25420 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25421 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25423 glyph
->bidi_type
= it
->bidi_it
.type
;
25425 ++it
->glyph_row
->used
[area
];
25428 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25433 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25434 of the glyph, WIDTH and HEIGHT are the width and height of the
25435 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25438 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25439 int width
, int height
, int ascent
)
25441 struct glyph
*glyph
;
25442 enum glyph_row_area area
= it
->area
;
25444 eassert (ascent
>= 0 && ascent
<= height
);
25446 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25447 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25449 /* If the glyph row is reversed, we need to prepend the glyph
25450 rather than append it. */
25451 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25455 /* Make room for the additional glyph. */
25456 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25458 glyph
= it
->glyph_row
->glyphs
[area
];
25460 /* Decrease the width of the first glyph of the row that
25461 begins before first_visible_x (e.g., due to hscroll).
25462 This is so the overall width of the row becomes smaller
25463 by the scroll amount, and the stretch glyph appended by
25464 extend_face_to_end_of_line will be wider, to shift the
25465 row glyphs to the right. (In L2R rows, the corresponding
25466 left-shift effect is accomplished by setting row->x to a
25467 negative value, which won't work with R2L rows.)
25469 This must leave us with a positive value of WIDTH, since
25470 otherwise the call to move_it_in_display_line_to at the
25471 beginning of display_line would have got past the entire
25472 first glyph, and then it->current_x would have been
25473 greater or equal to it->first_visible_x. */
25474 if (it
->current_x
< it
->first_visible_x
)
25475 width
-= it
->first_visible_x
- it
->current_x
;
25476 eassert (width
> 0);
25478 glyph
->charpos
= CHARPOS (it
->position
);
25479 glyph
->object
= object
;
25480 glyph
->pixel_width
= width
;
25481 glyph
->ascent
= ascent
;
25482 glyph
->descent
= height
- ascent
;
25483 glyph
->voffset
= it
->voffset
;
25484 glyph
->type
= STRETCH_GLYPH
;
25485 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25486 glyph
->multibyte_p
= it
->multibyte_p
;
25487 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25489 /* In R2L rows, the left and the right box edges need to be
25490 drawn in reverse direction. */
25491 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25492 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25496 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25497 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25499 glyph
->overlaps_vertically_p
= 0;
25500 glyph
->padding_p
= 0;
25501 glyph
->glyph_not_available_p
= 0;
25502 glyph
->face_id
= it
->face_id
;
25503 glyph
->u
.stretch
.ascent
= ascent
;
25504 glyph
->u
.stretch
.height
= height
;
25505 glyph
->slice
.img
= null_glyph_slice
;
25506 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25509 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25510 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25512 glyph
->bidi_type
= it
->bidi_it
.type
;
25516 glyph
->resolved_level
= 0;
25517 glyph
->bidi_type
= UNKNOWN_BT
;
25519 ++it
->glyph_row
->used
[area
];
25522 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25525 #endif /* HAVE_WINDOW_SYSTEM */
25527 /* Produce a stretch glyph for iterator IT. IT->object is the value
25528 of the glyph property displayed. The value must be a list
25529 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25532 1. `:width WIDTH' specifies that the space should be WIDTH *
25533 canonical char width wide. WIDTH may be an integer or floating
25536 2. `:relative-width FACTOR' specifies that the width of the stretch
25537 should be computed from the width of the first character having the
25538 `glyph' property, and should be FACTOR times that width.
25540 3. `:align-to HPOS' specifies that the space should be wide enough
25541 to reach HPOS, a value in canonical character units.
25543 Exactly one of the above pairs must be present.
25545 4. `:height HEIGHT' specifies that the height of the stretch produced
25546 should be HEIGHT, measured in canonical character units.
25548 5. `:relative-height FACTOR' specifies that the height of the
25549 stretch should be FACTOR times the height of the characters having
25550 the glyph property.
25552 Either none or exactly one of 4 or 5 must be present.
25554 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25555 of the stretch should be used for the ascent of the stretch.
25556 ASCENT must be in the range 0 <= ASCENT <= 100. */
25559 produce_stretch_glyph (struct it
*it
)
25561 /* (space :width WIDTH :height HEIGHT ...) */
25562 Lisp_Object prop
, plist
;
25563 int width
= 0, height
= 0, align_to
= -1;
25564 int zero_width_ok_p
= 0;
25566 struct font
*font
= NULL
;
25568 #ifdef HAVE_WINDOW_SYSTEM
25570 int zero_height_ok_p
= 0;
25572 if (FRAME_WINDOW_P (it
->f
))
25574 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25575 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25576 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
25580 /* List should start with `space'. */
25581 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
25582 plist
= XCDR (it
->object
);
25584 /* Compute the width of the stretch. */
25585 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
25586 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
25588 /* Absolute width `:width WIDTH' specified and valid. */
25589 zero_width_ok_p
= 1;
25592 #ifdef HAVE_WINDOW_SYSTEM
25593 else if (FRAME_WINDOW_P (it
->f
)
25594 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
25596 /* Relative width `:relative-width FACTOR' specified and valid.
25597 Compute the width of the characters having the `glyph'
25600 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
25603 if (it
->multibyte_p
)
25604 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
25607 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
25608 if (! ASCII_CHAR_P (it2
.c
))
25609 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
25612 it2
.glyph_row
= NULL
;
25613 it2
.what
= IT_CHARACTER
;
25614 x_produce_glyphs (&it2
);
25615 width
= NUMVAL (prop
) * it2
.pixel_width
;
25617 #endif /* HAVE_WINDOW_SYSTEM */
25618 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
25619 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
25621 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
25622 align_to
= (align_to
< 0
25624 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
25625 else if (align_to
< 0)
25626 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
25627 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
25628 zero_width_ok_p
= 1;
25631 /* Nothing specified -> width defaults to canonical char width. */
25632 width
= FRAME_COLUMN_WIDTH (it
->f
);
25634 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
25637 #ifdef HAVE_WINDOW_SYSTEM
25638 /* Compute height. */
25639 if (FRAME_WINDOW_P (it
->f
))
25641 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
25642 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25645 zero_height_ok_p
= 1;
25647 else if (prop
= Fplist_get (plist
, QCrelative_height
),
25649 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
25651 height
= FONT_HEIGHT (font
);
25653 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
25656 /* Compute percentage of height used for ascent. If
25657 `:ascent ASCENT' is present and valid, use that. Otherwise,
25658 derive the ascent from the font in use. */
25659 if (prop
= Fplist_get (plist
, QCascent
),
25660 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
25661 ascent
= height
* NUMVAL (prop
) / 100.0;
25662 else if (!NILP (prop
)
25663 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25664 ascent
= min (max (0, (int)tem
), height
);
25666 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
25669 #endif /* HAVE_WINDOW_SYSTEM */
25672 if (width
> 0 && it
->line_wrap
!= TRUNCATE
25673 && it
->current_x
+ width
> it
->last_visible_x
)
25675 width
= it
->last_visible_x
- it
->current_x
;
25676 #ifdef HAVE_WINDOW_SYSTEM
25677 /* Subtract one more pixel from the stretch width, but only on
25678 GUI frames, since on a TTY each glyph is one "pixel" wide. */
25679 width
-= FRAME_WINDOW_P (it
->f
);
25683 if (width
> 0 && height
> 0 && it
->glyph_row
)
25685 Lisp_Object o_object
= it
->object
;
25686 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
25689 if (!STRINGP (object
))
25690 object
= it
->w
->contents
;
25691 #ifdef HAVE_WINDOW_SYSTEM
25692 if (FRAME_WINDOW_P (it
->f
))
25693 append_stretch_glyph (it
, object
, width
, height
, ascent
);
25697 it
->object
= object
;
25698 it
->char_to_display
= ' ';
25699 it
->pixel_width
= it
->len
= 1;
25701 tty_append_glyph (it
);
25702 it
->object
= o_object
;
25706 it
->pixel_width
= width
;
25707 #ifdef HAVE_WINDOW_SYSTEM
25708 if (FRAME_WINDOW_P (it
->f
))
25710 it
->ascent
= it
->phys_ascent
= ascent
;
25711 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
25712 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
25713 take_vertical_position_into_account (it
);
25717 it
->nglyphs
= width
;
25720 /* Get information about special display element WHAT in an
25721 environment described by IT. WHAT is one of IT_TRUNCATION or
25722 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
25723 non-null glyph_row member. This function ensures that fields like
25724 face_id, c, len of IT are left untouched. */
25727 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
25734 temp_it
.object
= make_number (0);
25735 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
25737 if (what
== IT_CONTINUATION
)
25739 /* Continuation glyph. For R2L lines, we mirror it by hand. */
25740 if (it
->bidi_it
.paragraph_dir
== R2L
)
25741 SET_GLYPH_FROM_CHAR (glyph
, '/');
25743 SET_GLYPH_FROM_CHAR (glyph
, '\\');
25745 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25747 /* FIXME: Should we mirror GC for R2L lines? */
25748 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25749 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25752 else if (what
== IT_TRUNCATION
)
25754 /* Truncation glyph. */
25755 SET_GLYPH_FROM_CHAR (glyph
, '$');
25757 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25759 /* FIXME: Should we mirror GC for R2L lines? */
25760 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25761 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25767 #ifdef HAVE_WINDOW_SYSTEM
25768 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
25769 is turned off, we precede the truncation/continuation glyphs by a
25770 stretch glyph whose width is computed such that these special
25771 glyphs are aligned at the window margin, even when very different
25772 fonts are used in different glyph rows. */
25773 if (FRAME_WINDOW_P (temp_it
.f
)
25774 /* init_iterator calls this with it->glyph_row == NULL, and it
25775 wants only the pixel width of the truncation/continuation
25777 && temp_it
.glyph_row
25778 /* insert_left_trunc_glyphs calls us at the beginning of the
25779 row, and it has its own calculation of the stretch glyph
25781 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
25782 && (temp_it
.glyph_row
->reversed_p
25783 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
25784 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
25786 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
25788 if (stretch_width
> 0)
25790 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
25791 struct font
*font
=
25792 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
25793 int stretch_ascent
=
25794 (((temp_it
.ascent
+ temp_it
.descent
)
25795 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
25797 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
25798 temp_it
.ascent
+ temp_it
.descent
,
25805 temp_it
.what
= IT_CHARACTER
;
25806 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
25807 temp_it
.face_id
= GLYPH_FACE (glyph
);
25808 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
25810 PRODUCE_GLYPHS (&temp_it
);
25811 it
->pixel_width
= temp_it
.pixel_width
;
25812 it
->nglyphs
= temp_it
.nglyphs
;
25815 #ifdef HAVE_WINDOW_SYSTEM
25817 /* Calculate line-height and line-spacing properties.
25818 An integer value specifies explicit pixel value.
25819 A float value specifies relative value to current face height.
25820 A cons (float . face-name) specifies relative value to
25821 height of specified face font.
25823 Returns height in pixels, or nil. */
25827 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
25828 int boff
, int override
)
25830 Lisp_Object face_name
= Qnil
;
25831 int ascent
, descent
, height
;
25833 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
25838 face_name
= XCAR (val
);
25840 if (!NUMBERP (val
))
25841 val
= make_number (1);
25842 if (NILP (face_name
))
25844 height
= it
->ascent
+ it
->descent
;
25849 if (NILP (face_name
))
25851 font
= FRAME_FONT (it
->f
);
25852 boff
= FRAME_BASELINE_OFFSET (it
->f
);
25854 else if (EQ (face_name
, Qt
))
25863 face_id
= lookup_named_face (it
->f
, face_name
, 0);
25865 return make_number (-1);
25867 face
= FACE_FROM_ID (it
->f
, face_id
);
25870 return make_number (-1);
25871 boff
= font
->baseline_offset
;
25872 if (font
->vertical_centering
)
25873 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25876 ascent
= FONT_BASE (font
) + boff
;
25877 descent
= FONT_DESCENT (font
) - boff
;
25881 it
->override_ascent
= ascent
;
25882 it
->override_descent
= descent
;
25883 it
->override_boff
= boff
;
25886 height
= ascent
+ descent
;
25890 height
= (int)(XFLOAT_DATA (val
) * height
);
25891 else if (INTEGERP (val
))
25892 height
*= XINT (val
);
25894 return make_number (height
);
25898 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
25899 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
25900 and only if this is for a character for which no font was found.
25902 If the display method (it->glyphless_method) is
25903 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
25904 length of the acronym or the hexadecimal string, UPPER_XOFF and
25905 UPPER_YOFF are pixel offsets for the upper part of the string,
25906 LOWER_XOFF and LOWER_YOFF are for the lower part.
25908 For the other display methods, LEN through LOWER_YOFF are zero. */
25911 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
25912 short upper_xoff
, short upper_yoff
,
25913 short lower_xoff
, short lower_yoff
)
25915 struct glyph
*glyph
;
25916 enum glyph_row_area area
= it
->area
;
25918 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25919 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25921 /* If the glyph row is reversed, we need to prepend the glyph
25922 rather than append it. */
25923 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25927 /* Make room for the additional glyph. */
25928 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25930 glyph
= it
->glyph_row
->glyphs
[area
];
25932 glyph
->charpos
= CHARPOS (it
->position
);
25933 glyph
->object
= it
->object
;
25934 glyph
->pixel_width
= it
->pixel_width
;
25935 glyph
->ascent
= it
->ascent
;
25936 glyph
->descent
= it
->descent
;
25937 glyph
->voffset
= it
->voffset
;
25938 glyph
->type
= GLYPHLESS_GLYPH
;
25939 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
25940 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
25941 glyph
->u
.glyphless
.len
= len
;
25942 glyph
->u
.glyphless
.ch
= it
->c
;
25943 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
25944 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
25945 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
25946 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
25947 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25948 glyph
->multibyte_p
= it
->multibyte_p
;
25949 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25951 /* In R2L rows, the left and the right box edges need to be
25952 drawn in reverse direction. */
25953 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25954 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25958 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25959 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25961 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25962 || it
->phys_descent
> it
->descent
);
25963 glyph
->padding_p
= 0;
25964 glyph
->glyph_not_available_p
= 0;
25965 glyph
->face_id
= face_id
;
25966 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25969 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25970 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25972 glyph
->bidi_type
= it
->bidi_it
.type
;
25974 ++it
->glyph_row
->used
[area
];
25977 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25981 /* Produce a glyph for a glyphless character for iterator IT.
25982 IT->glyphless_method specifies which method to use for displaying
25983 the character. See the description of enum
25984 glyphless_display_method in dispextern.h for the detail.
25986 FOR_NO_FONT is nonzero if and only if this is for a character for
25987 which no font was found. ACRONYM, if non-nil, is an acronym string
25988 for the character. */
25991 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
25996 int base_width
, base_height
, width
, height
;
25997 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26000 /* Get the metrics of the base font. We always refer to the current
26002 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26003 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26004 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
26005 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
26006 base_height
= it
->ascent
+ it
->descent
;
26007 base_width
= font
->average_width
;
26009 face_id
= merge_glyphless_glyph_face (it
);
26011 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26013 it
->pixel_width
= THIN_SPACE_WIDTH
;
26015 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26017 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26019 width
= CHAR_WIDTH (it
->c
);
26022 else if (width
> 4)
26024 it
->pixel_width
= base_width
* width
;
26026 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26032 unsigned int code
[6];
26034 int ascent
, descent
;
26035 struct font_metrics metrics_upper
, metrics_lower
;
26037 face
= FACE_FROM_ID (it
->f
, face_id
);
26038 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26039 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
26041 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26043 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26044 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26045 if (CONSP (acronym
))
26046 acronym
= XCAR (acronym
);
26047 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26051 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26052 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
26055 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
26056 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26057 upper_len
= (len
+ 1) / 2;
26058 font
->driver
->text_extents (font
, code
, upper_len
,
26060 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26065 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26066 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26067 upper_xoff
= upper_yoff
= 2; /* the typical case */
26068 if (base_width
>= width
)
26070 /* Align the upper to the left, the lower to the right. */
26071 it
->pixel_width
= base_width
;
26072 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26076 /* Center the shorter one. */
26077 it
->pixel_width
= width
;
26078 if (metrics_upper
.width
>= metrics_lower
.width
)
26079 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26082 /* FIXME: This code doesn't look right. It formerly was
26083 missing the "lower_xoff = 0;", which couldn't have
26084 been right since it left lower_xoff uninitialized. */
26086 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26090 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26091 top, bottom, and between upper and lower strings. */
26092 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26093 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26094 /* Center vertically.
26095 H:base_height, D:base_descent
26096 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26098 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26099 descent = D - H/2 + h/2;
26100 lower_yoff = descent - 2 - ld;
26101 upper_yoff = lower_yoff - la - 1 - ud; */
26102 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26103 descent
= it
->descent
- (base_height
- height
) / 2;
26104 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26105 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26106 - metrics_upper
.descent
);
26107 /* Don't make the height shorter than the base height. */
26108 if (height
> base_height
)
26110 it
->ascent
= ascent
;
26111 it
->descent
= descent
;
26115 it
->phys_ascent
= it
->ascent
;
26116 it
->phys_descent
= it
->descent
;
26118 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26119 upper_xoff
, upper_yoff
,
26120 lower_xoff
, lower_yoff
);
26122 take_vertical_position_into_account (it
);
26127 Produce glyphs/get display metrics for the display element IT is
26128 loaded with. See the description of struct it in dispextern.h
26129 for an overview of struct it. */
26132 x_produce_glyphs (struct it
*it
)
26134 int extra_line_spacing
= it
->extra_line_spacing
;
26136 it
->glyph_not_available_p
= 0;
26138 if (it
->what
== IT_CHARACTER
)
26141 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26142 struct font
*font
= face
->font
;
26143 struct font_metrics
*pcm
= NULL
;
26144 int boff
; /* Baseline offset. */
26148 /* When no suitable font is found, display this character by
26149 the method specified in the first extra slot of
26150 Vglyphless_char_display. */
26151 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26153 eassert (it
->what
== IT_GLYPHLESS
);
26154 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
26158 boff
= font
->baseline_offset
;
26159 if (font
->vertical_centering
)
26160 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26162 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26168 if (it
->override_ascent
>= 0)
26170 it
->ascent
= it
->override_ascent
;
26171 it
->descent
= it
->override_descent
;
26172 boff
= it
->override_boff
;
26176 it
->ascent
= FONT_BASE (font
) + boff
;
26177 it
->descent
= FONT_DESCENT (font
) - boff
;
26180 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26182 pcm
= get_per_char_metric (font
, &char2b
);
26183 if (pcm
->width
== 0
26184 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26190 it
->phys_ascent
= pcm
->ascent
+ boff
;
26191 it
->phys_descent
= pcm
->descent
- boff
;
26192 it
->pixel_width
= pcm
->width
;
26196 it
->glyph_not_available_p
= 1;
26197 it
->phys_ascent
= it
->ascent
;
26198 it
->phys_descent
= it
->descent
;
26199 it
->pixel_width
= font
->space_width
;
26202 if (it
->constrain_row_ascent_descent_p
)
26204 if (it
->descent
> it
->max_descent
)
26206 it
->ascent
+= it
->descent
- it
->max_descent
;
26207 it
->descent
= it
->max_descent
;
26209 if (it
->ascent
> it
->max_ascent
)
26211 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26212 it
->ascent
= it
->max_ascent
;
26214 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26215 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26216 extra_line_spacing
= 0;
26219 /* If this is a space inside a region of text with
26220 `space-width' property, change its width. */
26221 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26223 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26225 /* If face has a box, add the box thickness to the character
26226 height. If character has a box line to the left and/or
26227 right, add the box line width to the character's width. */
26228 if (face
->box
!= FACE_NO_BOX
)
26230 int thick
= face
->box_line_width
;
26234 it
->ascent
+= thick
;
26235 it
->descent
+= thick
;
26240 if (it
->start_of_box_run_p
)
26241 it
->pixel_width
+= thick
;
26242 if (it
->end_of_box_run_p
)
26243 it
->pixel_width
+= thick
;
26246 /* If face has an overline, add the height of the overline
26247 (1 pixel) and a 1 pixel margin to the character height. */
26248 if (face
->overline_p
)
26249 it
->ascent
+= overline_margin
;
26251 if (it
->constrain_row_ascent_descent_p
)
26253 if (it
->ascent
> it
->max_ascent
)
26254 it
->ascent
= it
->max_ascent
;
26255 if (it
->descent
> it
->max_descent
)
26256 it
->descent
= it
->max_descent
;
26259 take_vertical_position_into_account (it
);
26261 /* If we have to actually produce glyphs, do it. */
26266 /* Translate a space with a `space-width' property
26267 into a stretch glyph. */
26268 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26269 / FONT_HEIGHT (font
));
26270 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26271 it
->ascent
+ it
->descent
, ascent
);
26276 /* If characters with lbearing or rbearing are displayed
26277 in this line, record that fact in a flag of the
26278 glyph row. This is used to optimize X output code. */
26279 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26280 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26282 if (! stretched_p
&& it
->pixel_width
== 0)
26283 /* We assure that all visible glyphs have at least 1-pixel
26285 it
->pixel_width
= 1;
26287 else if (it
->char_to_display
== '\n')
26289 /* A newline has no width, but we need the height of the
26290 line. But if previous part of the line sets a height,
26291 don't increase that height. */
26293 Lisp_Object height
;
26294 Lisp_Object total_height
= Qnil
;
26296 it
->override_ascent
= -1;
26297 it
->pixel_width
= 0;
26300 height
= get_it_property (it
, Qline_height
);
26301 /* Split (line-height total-height) list. */
26303 && CONSP (XCDR (height
))
26304 && NILP (XCDR (XCDR (height
))))
26306 total_height
= XCAR (XCDR (height
));
26307 height
= XCAR (height
);
26309 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
26311 if (it
->override_ascent
>= 0)
26313 it
->ascent
= it
->override_ascent
;
26314 it
->descent
= it
->override_descent
;
26315 boff
= it
->override_boff
;
26319 it
->ascent
= FONT_BASE (font
) + boff
;
26320 it
->descent
= FONT_DESCENT (font
) - boff
;
26323 if (EQ (height
, Qt
))
26325 if (it
->descent
> it
->max_descent
)
26327 it
->ascent
+= it
->descent
- it
->max_descent
;
26328 it
->descent
= it
->max_descent
;
26330 if (it
->ascent
> it
->max_ascent
)
26332 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26333 it
->ascent
= it
->max_ascent
;
26335 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26336 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26337 it
->constrain_row_ascent_descent_p
= 1;
26338 extra_line_spacing
= 0;
26342 Lisp_Object spacing
;
26344 it
->phys_ascent
= it
->ascent
;
26345 it
->phys_descent
= it
->descent
;
26347 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26348 && face
->box
!= FACE_NO_BOX
26349 && face
->box_line_width
> 0)
26351 it
->ascent
+= face
->box_line_width
;
26352 it
->descent
+= face
->box_line_width
;
26355 && XINT (height
) > it
->ascent
+ it
->descent
)
26356 it
->ascent
= XINT (height
) - it
->descent
;
26358 if (!NILP (total_height
))
26359 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
26362 spacing
= get_it_property (it
, Qline_spacing
);
26363 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
26365 if (INTEGERP (spacing
))
26367 extra_line_spacing
= XINT (spacing
);
26368 if (!NILP (total_height
))
26369 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26373 else /* i.e. (it->char_to_display == '\t') */
26375 if (font
->space_width
> 0)
26377 int tab_width
= it
->tab_width
* font
->space_width
;
26378 int x
= it
->current_x
+ it
->continuation_lines_width
;
26379 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26381 /* If the distance from the current position to the next tab
26382 stop is less than a space character width, use the
26383 tab stop after that. */
26384 if (next_tab_x
- x
< font
->space_width
)
26385 next_tab_x
+= tab_width
;
26387 it
->pixel_width
= next_tab_x
- x
;
26389 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
26390 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
26394 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26395 it
->ascent
+ it
->descent
, it
->ascent
);
26400 it
->pixel_width
= 0;
26405 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26407 /* A static composition.
26409 Note: A composition is represented as one glyph in the
26410 glyph matrix. There are no padding glyphs.
26412 Important note: pixel_width, ascent, and descent are the
26413 values of what is drawn by draw_glyphs (i.e. the values of
26414 the overall glyphs composed). */
26415 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26416 int boff
; /* baseline offset */
26417 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26418 int glyph_len
= cmp
->glyph_len
;
26419 struct font
*font
= face
->font
;
26423 /* If we have not yet calculated pixel size data of glyphs of
26424 the composition for the current face font, calculate them
26425 now. Theoretically, we have to check all fonts for the
26426 glyphs, but that requires much time and memory space. So,
26427 here we check only the font of the first glyph. This may
26428 lead to incorrect display, but it's very rare, and C-l
26429 (recenter-top-bottom) can correct the display anyway. */
26430 if (! cmp
->font
|| cmp
->font
!= font
)
26432 /* Ascent and descent of the font of the first character
26433 of this composition (adjusted by baseline offset).
26434 Ascent and descent of overall glyphs should not be less
26435 than these, respectively. */
26436 int font_ascent
, font_descent
, font_height
;
26437 /* Bounding box of the overall glyphs. */
26438 int leftmost
, rightmost
, lowest
, highest
;
26439 int lbearing
, rbearing
;
26440 int i
, width
, ascent
, descent
;
26441 int left_padded
= 0, right_padded
= 0;
26442 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26444 struct font_metrics
*pcm
;
26445 int font_not_found_p
;
26448 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26449 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26451 if (glyph_len
< cmp
->glyph_len
)
26453 for (i
= 0; i
< glyph_len
; i
++)
26455 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26457 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26462 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26463 : IT_CHARPOS (*it
));
26464 /* If no suitable font is found, use the default font. */
26465 font_not_found_p
= font
== NULL
;
26466 if (font_not_found_p
)
26468 face
= face
->ascii_face
;
26471 boff
= font
->baseline_offset
;
26472 if (font
->vertical_centering
)
26473 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26474 font_ascent
= FONT_BASE (font
) + boff
;
26475 font_descent
= FONT_DESCENT (font
) - boff
;
26476 font_height
= FONT_HEIGHT (font
);
26481 if (! font_not_found_p
)
26483 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26485 pcm
= get_per_char_metric (font
, &char2b
);
26488 /* Initialize the bounding box. */
26491 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26492 ascent
= pcm
->ascent
;
26493 descent
= pcm
->descent
;
26494 lbearing
= pcm
->lbearing
;
26495 rbearing
= pcm
->rbearing
;
26499 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26500 ascent
= FONT_BASE (font
);
26501 descent
= FONT_DESCENT (font
);
26508 lowest
= - descent
+ boff
;
26509 highest
= ascent
+ boff
;
26511 if (! font_not_found_p
26512 && font
->default_ascent
26513 && CHAR_TABLE_P (Vuse_default_ascent
)
26514 && !NILP (Faref (Vuse_default_ascent
,
26515 make_number (it
->char_to_display
))))
26516 highest
= font
->default_ascent
+ boff
;
26518 /* Draw the first glyph at the normal position. It may be
26519 shifted to right later if some other glyphs are drawn
26521 cmp
->offsets
[i
* 2] = 0;
26522 cmp
->offsets
[i
* 2 + 1] = boff
;
26523 cmp
->lbearing
= lbearing
;
26524 cmp
->rbearing
= rbearing
;
26526 /* Set cmp->offsets for the remaining glyphs. */
26527 for (i
++; i
< glyph_len
; i
++)
26529 int left
, right
, btm
, top
;
26530 int ch
= COMPOSITION_GLYPH (cmp
, i
);
26532 struct face
*this_face
;
26536 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
26537 this_face
= FACE_FROM_ID (it
->f
, face_id
);
26538 font
= this_face
->font
;
26544 get_char_face_and_encoding (it
->f
, ch
, face_id
,
26546 pcm
= get_per_char_metric (font
, &char2b
);
26549 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26552 width
= pcm
->width
;
26553 ascent
= pcm
->ascent
;
26554 descent
= pcm
->descent
;
26555 lbearing
= pcm
->lbearing
;
26556 rbearing
= pcm
->rbearing
;
26557 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
26559 /* Relative composition with or without
26560 alternate chars. */
26561 left
= (leftmost
+ rightmost
- width
) / 2;
26562 btm
= - descent
+ boff
;
26563 if (font
->relative_compose
26564 && (! CHAR_TABLE_P (Vignore_relative_composition
)
26565 || NILP (Faref (Vignore_relative_composition
,
26566 make_number (ch
)))))
26569 if (- descent
>= font
->relative_compose
)
26570 /* One extra pixel between two glyphs. */
26572 else if (ascent
<= 0)
26573 /* One extra pixel between two glyphs. */
26574 btm
= lowest
- 1 - ascent
- descent
;
26579 /* A composition rule is specified by an integer
26580 value that encodes global and new reference
26581 points (GREF and NREF). GREF and NREF are
26582 specified by numbers as below:
26584 0---1---2 -- ascent
26588 9--10--11 -- center
26590 ---3---4---5--- baseline
26592 6---7---8 -- descent
26594 int rule
= COMPOSITION_RULE (cmp
, i
);
26595 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
26597 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
26598 grefx
= gref
% 3, nrefx
= nref
% 3;
26599 grefy
= gref
/ 3, nrefy
= nref
/ 3;
26601 xoff
= font_height
* (xoff
- 128) / 256;
26603 yoff
= font_height
* (yoff
- 128) / 256;
26606 + grefx
* (rightmost
- leftmost
) / 2
26607 - nrefx
* width
/ 2
26610 btm
= ((grefy
== 0 ? highest
26612 : grefy
== 2 ? lowest
26613 : (highest
+ lowest
) / 2)
26614 - (nrefy
== 0 ? ascent
+ descent
26615 : nrefy
== 1 ? descent
- boff
26617 : (ascent
+ descent
) / 2)
26621 cmp
->offsets
[i
* 2] = left
;
26622 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
26624 /* Update the bounding box of the overall glyphs. */
26627 right
= left
+ width
;
26628 if (left
< leftmost
)
26630 if (right
> rightmost
)
26633 top
= btm
+ descent
+ ascent
;
26639 if (cmp
->lbearing
> left
+ lbearing
)
26640 cmp
->lbearing
= left
+ lbearing
;
26641 if (cmp
->rbearing
< left
+ rbearing
)
26642 cmp
->rbearing
= left
+ rbearing
;
26646 /* If there are glyphs whose x-offsets are negative,
26647 shift all glyphs to the right and make all x-offsets
26651 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26652 cmp
->offsets
[i
* 2] -= leftmost
;
26653 rightmost
-= leftmost
;
26654 cmp
->lbearing
-= leftmost
;
26655 cmp
->rbearing
-= leftmost
;
26658 if (left_padded
&& cmp
->lbearing
< 0)
26660 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26661 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
26662 rightmost
-= cmp
->lbearing
;
26663 cmp
->rbearing
-= cmp
->lbearing
;
26666 if (right_padded
&& rightmost
< cmp
->rbearing
)
26668 rightmost
= cmp
->rbearing
;
26671 cmp
->pixel_width
= rightmost
;
26672 cmp
->ascent
= highest
;
26673 cmp
->descent
= - lowest
;
26674 if (cmp
->ascent
< font_ascent
)
26675 cmp
->ascent
= font_ascent
;
26676 if (cmp
->descent
< font_descent
)
26677 cmp
->descent
= font_descent
;
26681 && (cmp
->lbearing
< 0
26682 || cmp
->rbearing
> cmp
->pixel_width
))
26683 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26685 it
->pixel_width
= cmp
->pixel_width
;
26686 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
26687 it
->descent
= it
->phys_descent
= cmp
->descent
;
26688 if (face
->box
!= FACE_NO_BOX
)
26690 int thick
= face
->box_line_width
;
26694 it
->ascent
+= thick
;
26695 it
->descent
+= thick
;
26700 if (it
->start_of_box_run_p
)
26701 it
->pixel_width
+= thick
;
26702 if (it
->end_of_box_run_p
)
26703 it
->pixel_width
+= thick
;
26706 /* If face has an overline, add the height of the overline
26707 (1 pixel) and a 1 pixel margin to the character height. */
26708 if (face
->overline_p
)
26709 it
->ascent
+= overline_margin
;
26711 take_vertical_position_into_account (it
);
26712 if (it
->ascent
< 0)
26714 if (it
->descent
< 0)
26717 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
26718 append_composite_glyph (it
);
26720 else if (it
->what
== IT_COMPOSITION
)
26722 /* A dynamic (automatic) composition. */
26723 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26724 Lisp_Object gstring
;
26725 struct font_metrics metrics
;
26729 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
26731 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
26734 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
26735 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26736 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
26737 it
->descent
= it
->phys_descent
= metrics
.descent
;
26738 if (face
->box
!= FACE_NO_BOX
)
26740 int thick
= face
->box_line_width
;
26744 it
->ascent
+= thick
;
26745 it
->descent
+= thick
;
26750 if (it
->start_of_box_run_p
)
26751 it
->pixel_width
+= thick
;
26752 if (it
->end_of_box_run_p
)
26753 it
->pixel_width
+= thick
;
26755 /* If face has an overline, add the height of the overline
26756 (1 pixel) and a 1 pixel margin to the character height. */
26757 if (face
->overline_p
)
26758 it
->ascent
+= overline_margin
;
26759 take_vertical_position_into_account (it
);
26760 if (it
->ascent
< 0)
26762 if (it
->descent
< 0)
26766 append_composite_glyph (it
);
26768 else if (it
->what
== IT_GLYPHLESS
)
26769 produce_glyphless_glyph (it
, 0, Qnil
);
26770 else if (it
->what
== IT_IMAGE
)
26771 produce_image_glyph (it
);
26772 else if (it
->what
== IT_STRETCH
)
26773 produce_stretch_glyph (it
);
26776 /* Accumulate dimensions. Note: can't assume that it->descent > 0
26777 because this isn't true for images with `:ascent 100'. */
26778 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
26779 if (it
->area
== TEXT_AREA
)
26780 it
->current_x
+= it
->pixel_width
;
26782 if (extra_line_spacing
> 0)
26784 it
->descent
+= extra_line_spacing
;
26785 if (extra_line_spacing
> it
->max_extra_line_spacing
)
26786 it
->max_extra_line_spacing
= extra_line_spacing
;
26789 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
26790 it
->max_descent
= max (it
->max_descent
, it
->descent
);
26791 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
26792 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
26796 Output LEN glyphs starting at START at the nominal cursor position.
26797 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
26798 being updated, and UPDATED_AREA is the area of that row being updated. */
26801 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26802 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26804 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
26806 eassert (updated_row
);
26807 /* When the window is hscrolled, cursor hpos can legitimately be out
26808 of bounds, but we draw the cursor at the corresponding window
26809 margin in that case. */
26810 if (!updated_row
->reversed_p
&& chpos
< 0)
26812 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
26813 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
26817 /* Write glyphs. */
26819 hpos
= start
- updated_row
->glyphs
[updated_area
];
26820 x
= draw_glyphs (w
, w
->output_cursor
.x
,
26821 updated_row
, updated_area
,
26823 DRAW_NORMAL_TEXT
, 0);
26825 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
26826 if (updated_area
== TEXT_AREA
26827 && w
->phys_cursor_on_p
26828 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
26830 && chpos
< hpos
+ len
)
26831 w
->phys_cursor_on_p
= 0;
26835 /* Advance the output cursor. */
26836 w
->output_cursor
.hpos
+= len
;
26837 w
->output_cursor
.x
= x
;
26842 Insert LEN glyphs from START at the nominal cursor position. */
26845 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26846 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26849 int line_height
, shift_by_width
, shifted_region_width
;
26850 struct glyph_row
*row
;
26851 struct glyph
*glyph
;
26852 int frame_x
, frame_y
;
26855 eassert (updated_row
);
26857 f
= XFRAME (WINDOW_FRAME (w
));
26859 /* Get the height of the line we are in. */
26861 line_height
= row
->height
;
26863 /* Get the width of the glyphs to insert. */
26864 shift_by_width
= 0;
26865 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
26866 shift_by_width
+= glyph
->pixel_width
;
26868 /* Get the width of the region to shift right. */
26869 shifted_region_width
= (window_box_width (w
, updated_area
)
26870 - w
->output_cursor
.x
26874 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
26875 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
26877 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
26878 line_height
, shift_by_width
);
26880 /* Write the glyphs. */
26881 hpos
= start
- row
->glyphs
[updated_area
];
26882 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
26884 DRAW_NORMAL_TEXT
, 0);
26886 /* Advance the output cursor. */
26887 w
->output_cursor
.hpos
+= len
;
26888 w
->output_cursor
.x
+= shift_by_width
;
26894 Erase the current text line from the nominal cursor position
26895 (inclusive) to pixel column TO_X (exclusive). The idea is that
26896 everything from TO_X onward is already erased.
26898 TO_X is a pixel position relative to UPDATED_AREA of currently
26899 updated window W. TO_X == -1 means clear to the end of this area. */
26902 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
26903 enum glyph_row_area updated_area
, int to_x
)
26906 int max_x
, min_y
, max_y
;
26907 int from_x
, from_y
, to_y
;
26909 eassert (updated_row
);
26910 f
= XFRAME (w
->frame
);
26912 if (updated_row
->full_width_p
)
26913 max_x
= (WINDOW_PIXEL_WIDTH (w
)
26914 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
26916 max_x
= window_box_width (w
, updated_area
);
26917 max_y
= window_text_bottom_y (w
);
26919 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
26920 of window. For TO_X > 0, truncate to end of drawing area. */
26926 to_x
= min (to_x
, max_x
);
26928 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
26930 /* Notice if the cursor will be cleared by this operation. */
26931 if (!updated_row
->full_width_p
)
26932 notice_overwritten_cursor (w
, updated_area
,
26933 w
->output_cursor
.x
, -1,
26935 MATRIX_ROW_BOTTOM_Y (updated_row
));
26937 from_x
= w
->output_cursor
.x
;
26939 /* Translate to frame coordinates. */
26940 if (updated_row
->full_width_p
)
26942 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
26943 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
26947 int area_left
= window_box_left (w
, updated_area
);
26948 from_x
+= area_left
;
26952 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
26953 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
26954 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
26956 /* Prevent inadvertently clearing to end of the X window. */
26957 if (to_x
> from_x
&& to_y
> from_y
)
26960 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
26961 to_x
- from_x
, to_y
- from_y
);
26966 #endif /* HAVE_WINDOW_SYSTEM */
26970 /***********************************************************************
26972 ***********************************************************************/
26974 /* Value is the internal representation of the specified cursor type
26975 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
26976 of the bar cursor. */
26978 static enum text_cursor_kinds
26979 get_specified_cursor_type (Lisp_Object arg
, int *width
)
26981 enum text_cursor_kinds type
;
26986 if (EQ (arg
, Qbox
))
26987 return FILLED_BOX_CURSOR
;
26989 if (EQ (arg
, Qhollow
))
26990 return HOLLOW_BOX_CURSOR
;
26992 if (EQ (arg
, Qbar
))
26999 && EQ (XCAR (arg
), Qbar
)
27000 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27002 *width
= XINT (XCDR (arg
));
27006 if (EQ (arg
, Qhbar
))
27009 return HBAR_CURSOR
;
27013 && EQ (XCAR (arg
), Qhbar
)
27014 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27016 *width
= XINT (XCDR (arg
));
27017 return HBAR_CURSOR
;
27020 /* Treat anything unknown as "hollow box cursor".
27021 It was bad to signal an error; people have trouble fixing
27022 .Xdefaults with Emacs, when it has something bad in it. */
27023 type
= HOLLOW_BOX_CURSOR
;
27028 /* Set the default cursor types for specified frame. */
27030 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27035 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27036 FRAME_CURSOR_WIDTH (f
) = width
;
27038 /* By default, set up the blink-off state depending on the on-state. */
27040 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27043 FRAME_BLINK_OFF_CURSOR (f
)
27044 = get_specified_cursor_type (XCDR (tem
), &width
);
27045 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27048 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27050 /* Make sure the cursor gets redrawn. */
27051 f
->cursor_type_changed
= 1;
27055 #ifdef HAVE_WINDOW_SYSTEM
27057 /* Return the cursor we want to be displayed in window W. Return
27058 width of bar/hbar cursor through WIDTH arg. Return with
27059 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
27060 (i.e. if the `system caret' should track this cursor).
27062 In a mini-buffer window, we want the cursor only to appear if we
27063 are reading input from this window. For the selected window, we
27064 want the cursor type given by the frame parameter or buffer local
27065 setting of cursor-type. If explicitly marked off, draw no cursor.
27066 In all other cases, we want a hollow box cursor. */
27068 static enum text_cursor_kinds
27069 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27070 int *active_cursor
)
27072 struct frame
*f
= XFRAME (w
->frame
);
27073 struct buffer
*b
= XBUFFER (w
->contents
);
27074 int cursor_type
= DEFAULT_CURSOR
;
27075 Lisp_Object alt_cursor
;
27076 int non_selected
= 0;
27078 *active_cursor
= 1;
27081 if (cursor_in_echo_area
27082 && FRAME_HAS_MINIBUF_P (f
)
27083 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27085 if (w
== XWINDOW (echo_area_window
))
27087 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27089 *width
= FRAME_CURSOR_WIDTH (f
);
27090 return FRAME_DESIRED_CURSOR (f
);
27093 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27096 *active_cursor
= 0;
27100 /* Detect a nonselected window or nonselected frame. */
27101 else if (w
!= XWINDOW (f
->selected_window
)
27102 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27104 *active_cursor
= 0;
27106 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27112 /* Never display a cursor in a window in which cursor-type is nil. */
27113 if (NILP (BVAR (b
, cursor_type
)))
27116 /* Get the normal cursor type for this window. */
27117 if (EQ (BVAR (b
, cursor_type
), Qt
))
27119 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27120 *width
= FRAME_CURSOR_WIDTH (f
);
27123 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27125 /* Use cursor-in-non-selected-windows instead
27126 for non-selected window or frame. */
27129 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27130 if (!EQ (Qt
, alt_cursor
))
27131 return get_specified_cursor_type (alt_cursor
, width
);
27132 /* t means modify the normal cursor type. */
27133 if (cursor_type
== FILLED_BOX_CURSOR
)
27134 cursor_type
= HOLLOW_BOX_CURSOR
;
27135 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27137 return cursor_type
;
27140 /* Use normal cursor if not blinked off. */
27141 if (!w
->cursor_off_p
)
27143 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27145 if (cursor_type
== FILLED_BOX_CURSOR
)
27147 /* Using a block cursor on large images can be very annoying.
27148 So use a hollow cursor for "large" images.
27149 If image is not transparent (no mask), also use hollow cursor. */
27150 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27151 if (img
!= NULL
&& IMAGEP (img
->spec
))
27153 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27154 where N = size of default frame font size.
27155 This should cover most of the "tiny" icons people may use. */
27157 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27158 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27159 cursor_type
= HOLLOW_BOX_CURSOR
;
27162 else if (cursor_type
!= NO_CURSOR
)
27164 /* Display current only supports BOX and HOLLOW cursors for images.
27165 So for now, unconditionally use a HOLLOW cursor when cursor is
27166 not a solid box cursor. */
27167 cursor_type
= HOLLOW_BOX_CURSOR
;
27170 return cursor_type
;
27173 /* Cursor is blinked off, so determine how to "toggle" it. */
27175 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27176 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
27177 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
27179 /* Then see if frame has specified a specific blink off cursor type. */
27180 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
27182 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
27183 return FRAME_BLINK_OFF_CURSOR (f
);
27187 /* Some people liked having a permanently visible blinking cursor,
27188 while others had very strong opinions against it. So it was
27189 decided to remove it. KFS 2003-09-03 */
27191 /* Finally perform built-in cursor blinking:
27192 filled box <-> hollow box
27193 wide [h]bar <-> narrow [h]bar
27194 narrow [h]bar <-> no cursor
27195 other type <-> no cursor */
27197 if (cursor_type
== FILLED_BOX_CURSOR
)
27198 return HOLLOW_BOX_CURSOR
;
27200 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
27203 return cursor_type
;
27211 /* Notice when the text cursor of window W has been completely
27212 overwritten by a drawing operation that outputs glyphs in AREA
27213 starting at X0 and ending at X1 in the line starting at Y0 and
27214 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27215 the rest of the line after X0 has been written. Y coordinates
27216 are window-relative. */
27219 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
27220 int x0
, int x1
, int y0
, int y1
)
27222 int cx0
, cx1
, cy0
, cy1
;
27223 struct glyph_row
*row
;
27225 if (!w
->phys_cursor_on_p
)
27227 if (area
!= TEXT_AREA
)
27230 if (w
->phys_cursor
.vpos
< 0
27231 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27232 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27233 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27236 if (row
->cursor_in_fringe_p
)
27238 row
->cursor_in_fringe_p
= 0;
27239 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27240 w
->phys_cursor_on_p
= 0;
27244 cx0
= w
->phys_cursor
.x
;
27245 cx1
= cx0
+ w
->phys_cursor_width
;
27246 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27249 /* The cursor image will be completely removed from the
27250 screen if the output area intersects the cursor area in
27251 y-direction. When we draw in [y0 y1[, and some part of
27252 the cursor is at y < y0, that part must have been drawn
27253 before. When scrolling, the cursor is erased before
27254 actually scrolling, so we don't come here. When not
27255 scrolling, the rows above the old cursor row must have
27256 changed, and in this case these rows must have written
27257 over the cursor image.
27259 Likewise if part of the cursor is below y1, with the
27260 exception of the cursor being in the first blank row at
27261 the buffer and window end because update_text_area
27262 doesn't draw that row. (Except when it does, but
27263 that's handled in update_text_area.) */
27265 cy0
= w
->phys_cursor
.y
;
27266 cy1
= cy0
+ w
->phys_cursor_height
;
27267 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27270 w
->phys_cursor_on_p
= 0;
27273 #endif /* HAVE_WINDOW_SYSTEM */
27276 /************************************************************************
27278 ************************************************************************/
27280 #ifdef HAVE_WINDOW_SYSTEM
27283 Fix the display of area AREA of overlapping row ROW in window W
27284 with respect to the overlapping part OVERLAPS. */
27287 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27288 enum glyph_row_area area
, int overlaps
)
27295 for (i
= 0; i
< row
->used
[area
];)
27297 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27299 int start
= i
, start_x
= x
;
27303 x
+= row
->glyphs
[area
][i
].pixel_width
;
27306 while (i
< row
->used
[area
]
27307 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27309 draw_glyphs (w
, start_x
, row
, area
,
27311 DRAW_NORMAL_TEXT
, overlaps
);
27315 x
+= row
->glyphs
[area
][i
].pixel_width
;
27325 Draw the cursor glyph of window W in glyph row ROW. See the
27326 comment of draw_glyphs for the meaning of HL. */
27329 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27330 enum draw_glyphs_face hl
)
27332 /* If cursor hpos is out of bounds, don't draw garbage. This can
27333 happen in mini-buffer windows when switching between echo area
27334 glyphs and mini-buffer. */
27335 if ((row
->reversed_p
27336 ? (w
->phys_cursor
.hpos
>= 0)
27337 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27339 int on_p
= w
->phys_cursor_on_p
;
27341 int hpos
= w
->phys_cursor
.hpos
;
27343 /* When the window is hscrolled, cursor hpos can legitimately be
27344 out of bounds, but we draw the cursor at the corresponding
27345 window margin in that case. */
27346 if (!row
->reversed_p
&& hpos
< 0)
27348 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27349 hpos
= row
->used
[TEXT_AREA
] - 1;
27351 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27353 w
->phys_cursor_on_p
= on_p
;
27355 if (hl
== DRAW_CURSOR
)
27356 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27357 /* When we erase the cursor, and ROW is overlapped by other
27358 rows, make sure that these overlapping parts of other rows
27360 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27362 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27364 if (row
> w
->current_matrix
->rows
27365 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27366 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27367 OVERLAPS_ERASED_CURSOR
);
27369 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27370 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27371 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27372 OVERLAPS_ERASED_CURSOR
);
27378 /* Erase the image of a cursor of window W from the screen. */
27384 erase_phys_cursor (struct window
*w
)
27386 struct frame
*f
= XFRAME (w
->frame
);
27387 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27388 int hpos
= w
->phys_cursor
.hpos
;
27389 int vpos
= w
->phys_cursor
.vpos
;
27390 int mouse_face_here_p
= 0;
27391 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27392 struct glyph_row
*cursor_row
;
27393 struct glyph
*cursor_glyph
;
27394 enum draw_glyphs_face hl
;
27396 /* No cursor displayed or row invalidated => nothing to do on the
27398 if (w
->phys_cursor_type
== NO_CURSOR
)
27399 goto mark_cursor_off
;
27401 /* VPOS >= active_glyphs->nrows means that window has been resized.
27402 Don't bother to erase the cursor. */
27403 if (vpos
>= active_glyphs
->nrows
)
27404 goto mark_cursor_off
;
27406 /* If row containing cursor is marked invalid, there is nothing we
27408 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27409 if (!cursor_row
->enabled_p
)
27410 goto mark_cursor_off
;
27412 /* If line spacing is > 0, old cursor may only be partially visible in
27413 window after split-window. So adjust visible height. */
27414 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27415 window_text_bottom_y (w
) - cursor_row
->y
);
27417 /* If row is completely invisible, don't attempt to delete a cursor which
27418 isn't there. This can happen if cursor is at top of a window, and
27419 we switch to a buffer with a header line in that window. */
27420 if (cursor_row
->visible_height
<= 0)
27421 goto mark_cursor_off
;
27423 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27424 if (cursor_row
->cursor_in_fringe_p
)
27426 cursor_row
->cursor_in_fringe_p
= 0;
27427 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27428 goto mark_cursor_off
;
27431 /* This can happen when the new row is shorter than the old one.
27432 In this case, either draw_glyphs or clear_end_of_line
27433 should have cleared the cursor. Note that we wouldn't be
27434 able to erase the cursor in this case because we don't have a
27435 cursor glyph at hand. */
27436 if ((cursor_row
->reversed_p
27437 ? (w
->phys_cursor
.hpos
< 0)
27438 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27439 goto mark_cursor_off
;
27441 /* When the window is hscrolled, cursor hpos can legitimately be out
27442 of bounds, but we draw the cursor at the corresponding window
27443 margin in that case. */
27444 if (!cursor_row
->reversed_p
&& hpos
< 0)
27446 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27447 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27449 /* If the cursor is in the mouse face area, redisplay that when
27450 we clear the cursor. */
27451 if (! NILP (hlinfo
->mouse_face_window
)
27452 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27453 /* Don't redraw the cursor's spot in mouse face if it is at the
27454 end of a line (on a newline). The cursor appears there, but
27455 mouse highlighting does not. */
27456 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27457 mouse_face_here_p
= 1;
27459 /* Maybe clear the display under the cursor. */
27460 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27463 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27466 cursor_glyph
= get_phys_cursor_glyph (w
);
27467 if (cursor_glyph
== NULL
)
27468 goto mark_cursor_off
;
27470 width
= cursor_glyph
->pixel_width
;
27471 left_x
= window_box_left_offset (w
, TEXT_AREA
);
27472 x
= w
->phys_cursor
.x
;
27474 width
-= left_x
- x
;
27475 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27476 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27477 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
27480 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27483 /* Erase the cursor by redrawing the character underneath it. */
27484 if (mouse_face_here_p
)
27485 hl
= DRAW_MOUSE_FACE
;
27487 hl
= DRAW_NORMAL_TEXT
;
27488 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27491 w
->phys_cursor_on_p
= 0;
27492 w
->phys_cursor_type
= NO_CURSOR
;
27497 Display or clear cursor of window W. If ON is zero, clear the
27498 cursor. If it is non-zero, display the cursor. If ON is nonzero,
27499 where to put the cursor is specified by HPOS, VPOS, X and Y. */
27502 display_and_set_cursor (struct window
*w
, bool on
,
27503 int hpos
, int vpos
, int x
, int y
)
27505 struct frame
*f
= XFRAME (w
->frame
);
27506 int new_cursor_type
;
27507 int new_cursor_width
;
27509 struct glyph_row
*glyph_row
;
27510 struct glyph
*glyph
;
27512 /* This is pointless on invisible frames, and dangerous on garbaged
27513 windows and frames; in the latter case, the frame or window may
27514 be in the midst of changing its size, and x and y may be off the
27516 if (! FRAME_VISIBLE_P (f
)
27517 || FRAME_GARBAGED_P (f
)
27518 || vpos
>= w
->current_matrix
->nrows
27519 || hpos
>= w
->current_matrix
->matrix_w
)
27522 /* If cursor is off and we want it off, return quickly. */
27523 if (!on
&& !w
->phys_cursor_on_p
)
27526 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27527 /* If cursor row is not enabled, we don't really know where to
27528 display the cursor. */
27529 if (!glyph_row
->enabled_p
)
27531 w
->phys_cursor_on_p
= 0;
27536 if (!glyph_row
->exact_window_width_line_p
27537 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
27538 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
27540 eassert (input_blocked_p ());
27542 /* Set new_cursor_type to the cursor we want to be displayed. */
27543 new_cursor_type
= get_window_cursor_type (w
, glyph
,
27544 &new_cursor_width
, &active_cursor
);
27546 /* If cursor is currently being shown and we don't want it to be or
27547 it is in the wrong place, or the cursor type is not what we want,
27549 if (w
->phys_cursor_on_p
27551 || w
->phys_cursor
.x
!= x
27552 || w
->phys_cursor
.y
!= y
27553 /* HPOS can be negative in R2L rows whose
27554 exact_window_width_line_p flag is set (i.e. their newline
27555 would "overflow into the fringe"). */
27557 || new_cursor_type
!= w
->phys_cursor_type
27558 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
27559 && new_cursor_width
!= w
->phys_cursor_width
)))
27560 erase_phys_cursor (w
);
27562 /* Don't check phys_cursor_on_p here because that flag is only set
27563 to zero in some cases where we know that the cursor has been
27564 completely erased, to avoid the extra work of erasing the cursor
27565 twice. In other words, phys_cursor_on_p can be 1 and the cursor
27566 still not be visible, or it has only been partly erased. */
27569 w
->phys_cursor_ascent
= glyph_row
->ascent
;
27570 w
->phys_cursor_height
= glyph_row
->height
;
27572 /* Set phys_cursor_.* before x_draw_.* is called because some
27573 of them may need the information. */
27574 w
->phys_cursor
.x
= x
;
27575 w
->phys_cursor
.y
= glyph_row
->y
;
27576 w
->phys_cursor
.hpos
= hpos
;
27577 w
->phys_cursor
.vpos
= vpos
;
27580 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
27581 new_cursor_type
, new_cursor_width
,
27582 on
, active_cursor
);
27586 /* Switch the display of W's cursor on or off, according to the value
27590 update_window_cursor (struct window
*w
, bool on
)
27592 /* Don't update cursor in windows whose frame is in the process
27593 of being deleted. */
27594 if (w
->current_matrix
)
27596 int hpos
= w
->phys_cursor
.hpos
;
27597 int vpos
= w
->phys_cursor
.vpos
;
27598 struct glyph_row
*row
;
27600 if (vpos
>= w
->current_matrix
->nrows
27601 || hpos
>= w
->current_matrix
->matrix_w
)
27604 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27606 /* When the window is hscrolled, cursor hpos can legitimately be
27607 out of bounds, but we draw the cursor at the corresponding
27608 window margin in that case. */
27609 if (!row
->reversed_p
&& hpos
< 0)
27611 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27612 hpos
= row
->used
[TEXT_AREA
] - 1;
27615 display_and_set_cursor (w
, on
, hpos
, vpos
,
27616 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27622 /* Call update_window_cursor with parameter ON_P on all leaf windows
27623 in the window tree rooted at W. */
27626 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
27630 if (WINDOWP (w
->contents
))
27631 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
27633 update_window_cursor (w
, on_p
);
27635 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
27641 Display the cursor on window W, or clear it, according to ON_P.
27642 Don't change the cursor's position. */
27645 x_update_cursor (struct frame
*f
, bool on_p
)
27647 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
27652 Clear the cursor of window W to background color, and mark the
27653 cursor as not shown. This is used when the text where the cursor
27654 is about to be rewritten. */
27657 x_clear_cursor (struct window
*w
)
27659 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
27660 update_window_cursor (w
, 0);
27663 #endif /* HAVE_WINDOW_SYSTEM */
27665 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
27668 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
27669 int start_hpos
, int end_hpos
,
27670 enum draw_glyphs_face draw
)
27672 #ifdef HAVE_WINDOW_SYSTEM
27673 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
27675 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
27679 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
27680 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
27684 /* Display the active region described by mouse_face_* according to DRAW. */
27687 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
27689 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
27690 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27692 if (/* If window is in the process of being destroyed, don't bother
27694 w
->current_matrix
!= NULL
27695 /* Don't update mouse highlight if hidden. */
27696 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
27697 /* Recognize when we are called to operate on rows that don't exist
27698 anymore. This can happen when a window is split. */
27699 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
27701 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
27702 struct glyph_row
*row
, *first
, *last
;
27704 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
27705 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
27707 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
27709 int start_hpos
, end_hpos
, start_x
;
27711 /* For all but the first row, the highlight starts at column 0. */
27714 /* R2L rows have BEG and END in reversed order, but the
27715 screen drawing geometry is always left to right. So
27716 we need to mirror the beginning and end of the
27717 highlighted area in R2L rows. */
27718 if (!row
->reversed_p
)
27720 start_hpos
= hlinfo
->mouse_face_beg_col
;
27721 start_x
= hlinfo
->mouse_face_beg_x
;
27723 else if (row
== last
)
27725 start_hpos
= hlinfo
->mouse_face_end_col
;
27726 start_x
= hlinfo
->mouse_face_end_x
;
27734 else if (row
->reversed_p
&& row
== last
)
27736 start_hpos
= hlinfo
->mouse_face_end_col
;
27737 start_x
= hlinfo
->mouse_face_end_x
;
27747 if (!row
->reversed_p
)
27748 end_hpos
= hlinfo
->mouse_face_end_col
;
27749 else if (row
== first
)
27750 end_hpos
= hlinfo
->mouse_face_beg_col
;
27753 end_hpos
= row
->used
[TEXT_AREA
];
27754 if (draw
== DRAW_NORMAL_TEXT
)
27755 row
->fill_line_p
= 1; /* Clear to end of line */
27758 else if (row
->reversed_p
&& row
== first
)
27759 end_hpos
= hlinfo
->mouse_face_beg_col
;
27762 end_hpos
= row
->used
[TEXT_AREA
];
27763 if (draw
== DRAW_NORMAL_TEXT
)
27764 row
->fill_line_p
= 1; /* Clear to end of line */
27767 if (end_hpos
> start_hpos
)
27769 draw_row_with_mouse_face (w
, start_x
, row
,
27770 start_hpos
, end_hpos
, draw
);
27773 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
27777 #ifdef HAVE_WINDOW_SYSTEM
27778 /* When we've written over the cursor, arrange for it to
27779 be displayed again. */
27780 if (FRAME_WINDOW_P (f
)
27781 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
27783 int hpos
= w
->phys_cursor
.hpos
;
27785 /* When the window is hscrolled, cursor hpos can legitimately be
27786 out of bounds, but we draw the cursor at the corresponding
27787 window margin in that case. */
27788 if (!row
->reversed_p
&& hpos
< 0)
27790 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27791 hpos
= row
->used
[TEXT_AREA
] - 1;
27794 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
27795 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27798 #endif /* HAVE_WINDOW_SYSTEM */
27801 #ifdef HAVE_WINDOW_SYSTEM
27802 /* Change the mouse cursor. */
27803 if (FRAME_WINDOW_P (f
))
27805 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
27806 if (draw
== DRAW_NORMAL_TEXT
27807 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
27808 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
27811 if (draw
== DRAW_MOUSE_FACE
)
27812 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
27814 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
27816 #endif /* HAVE_WINDOW_SYSTEM */
27820 Clear out the mouse-highlighted active region.
27821 Redraw it un-highlighted first. Value is non-zero if mouse
27822 face was actually drawn unhighlighted. */
27825 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
27829 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
27831 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
27835 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27836 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27837 hlinfo
->mouse_face_window
= Qnil
;
27838 hlinfo
->mouse_face_overlay
= Qnil
;
27842 /* Return true if the coordinates HPOS and VPOS on windows W are
27843 within the mouse face on that window. */
27845 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
27847 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27849 /* Quickly resolve the easy cases. */
27850 if (!(WINDOWP (hlinfo
->mouse_face_window
)
27851 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
27853 if (vpos
< hlinfo
->mouse_face_beg_row
27854 || vpos
> hlinfo
->mouse_face_end_row
)
27856 if (vpos
> hlinfo
->mouse_face_beg_row
27857 && vpos
< hlinfo
->mouse_face_end_row
)
27860 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
27862 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27864 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
27867 else if ((vpos
== hlinfo
->mouse_face_beg_row
27868 && hpos
>= hlinfo
->mouse_face_beg_col
)
27869 || (vpos
== hlinfo
->mouse_face_end_row
27870 && hpos
< hlinfo
->mouse_face_end_col
))
27875 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27877 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
27880 else if ((vpos
== hlinfo
->mouse_face_beg_row
27881 && hpos
<= hlinfo
->mouse_face_beg_col
)
27882 || (vpos
== hlinfo
->mouse_face_end_row
27883 && hpos
> hlinfo
->mouse_face_end_col
))
27891 True if physical cursor of window W is within mouse face. */
27894 cursor_in_mouse_face_p (struct window
*w
)
27896 int hpos
= w
->phys_cursor
.hpos
;
27897 int vpos
= w
->phys_cursor
.vpos
;
27898 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27900 /* When the window is hscrolled, cursor hpos can legitimately be out
27901 of bounds, but we draw the cursor at the corresponding window
27902 margin in that case. */
27903 if (!row
->reversed_p
&& hpos
< 0)
27905 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27906 hpos
= row
->used
[TEXT_AREA
] - 1;
27908 return coords_in_mouse_face_p (w
, hpos
, vpos
);
27913 /* Find the glyph rows START_ROW and END_ROW of window W that display
27914 characters between buffer positions START_CHARPOS and END_CHARPOS
27915 (excluding END_CHARPOS). DISP_STRING is a display string that
27916 covers these buffer positions. This is similar to
27917 row_containing_pos, but is more accurate when bidi reordering makes
27918 buffer positions change non-linearly with glyph rows. */
27920 rows_from_pos_range (struct window
*w
,
27921 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
27922 Lisp_Object disp_string
,
27923 struct glyph_row
**start
, struct glyph_row
**end
)
27925 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27926 int last_y
= window_text_bottom_y (w
);
27927 struct glyph_row
*row
;
27932 while (!first
->enabled_p
27933 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
27936 /* Find the START row. */
27938 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
27941 /* A row can potentially be the START row if the range of the
27942 characters it displays intersects the range
27943 [START_CHARPOS..END_CHARPOS). */
27944 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
27945 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
27946 /* See the commentary in row_containing_pos, for the
27947 explanation of the complicated way to check whether
27948 some position is beyond the end of the characters
27949 displayed by a row. */
27950 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27951 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27952 && !row
->ends_at_zv_p
27953 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
27954 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27955 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27956 && !row
->ends_at_zv_p
27957 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
27959 /* Found a candidate row. Now make sure at least one of the
27960 glyphs it displays has a charpos from the range
27961 [START_CHARPOS..END_CHARPOS).
27963 This is not obvious because bidi reordering could make
27964 buffer positions of a row be 1,2,3,102,101,100, and if we
27965 want to highlight characters in [50..60), we don't want
27966 this row, even though [50..60) does intersect [1..103),
27967 the range of character positions given by the row's start
27968 and end positions. */
27969 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
27970 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
27974 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
27975 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
27976 /* A glyph that comes from DISP_STRING is by
27977 definition to be highlighted. */
27978 || EQ (g
->object
, disp_string
))
27987 /* Find the END row. */
27989 /* If the last row is partially visible, start looking for END
27990 from that row, instead of starting from FIRST. */
27991 && !(row
->enabled_p
27992 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
27994 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
27996 struct glyph_row
*next
= row
+ 1;
27997 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
27999 if (!next
->enabled_p
28000 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28001 /* The first row >= START whose range of displayed characters
28002 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28003 is the row END + 1. */
28004 || (start_charpos
< next_start
28005 && end_charpos
< next_start
)
28006 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28007 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28008 && !next
->ends_at_zv_p
28009 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28010 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28011 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28012 && !next
->ends_at_zv_p
28013 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28020 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28021 but none of the characters it displays are in the range, it is
28023 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28024 struct glyph
*s
= g
;
28025 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28029 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
28030 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28031 /* If the buffer position of the first glyph in
28032 the row is equal to END_CHARPOS, it means
28033 the last character to be highlighted is the
28034 newline of ROW, and we must consider NEXT as
28036 || (((!next
->reversed_p
&& g
== s
)
28037 || (next
->reversed_p
&& g
== e
- 1))
28038 && (g
->charpos
== end_charpos
28039 /* Special case for when NEXT is an
28040 empty line at ZV. */
28041 || (g
->charpos
== -1
28042 && !row
->ends_at_zv_p
28043 && next_start
== end_charpos
)))))
28044 /* A glyph that comes from DISP_STRING is by
28045 definition to be highlighted. */
28046 || EQ (g
->object
, disp_string
))
28055 /* The first row that ends at ZV must be the last to be
28057 else if (next
->ends_at_zv_p
)
28066 /* This function sets the mouse_face_* elements of HLINFO, assuming
28067 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28068 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28069 for the overlay or run of text properties specifying the mouse
28070 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28071 before-string and after-string that must also be highlighted.
28072 DISP_STRING, if non-nil, is a display string that may cover some
28073 or all of the highlighted text. */
28076 mouse_face_from_buffer_pos (Lisp_Object window
,
28077 Mouse_HLInfo
*hlinfo
,
28078 ptrdiff_t mouse_charpos
,
28079 ptrdiff_t start_charpos
,
28080 ptrdiff_t end_charpos
,
28081 Lisp_Object before_string
,
28082 Lisp_Object after_string
,
28083 Lisp_Object disp_string
)
28085 struct window
*w
= XWINDOW (window
);
28086 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28087 struct glyph_row
*r1
, *r2
;
28088 struct glyph
*glyph
, *end
;
28089 ptrdiff_t ignore
, pos
;
28092 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28093 eassert (NILP (before_string
) || STRINGP (before_string
));
28094 eassert (NILP (after_string
) || STRINGP (after_string
));
28096 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28097 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28099 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28100 /* If the before-string or display-string contains newlines,
28101 rows_from_pos_range skips to its last row. Move back. */
28102 if (!NILP (before_string
) || !NILP (disp_string
))
28104 struct glyph_row
*prev
;
28105 while ((prev
= r1
- 1, prev
>= first
)
28106 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28107 && prev
->used
[TEXT_AREA
] > 0)
28109 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28110 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28111 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
28113 || !(EQ (glyph
->object
, before_string
)
28114 || EQ (glyph
->object
, disp_string
)))
28121 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28122 hlinfo
->mouse_face_past_end
= 1;
28124 else if (!NILP (after_string
))
28126 /* If the after-string has newlines, advance to its last row. */
28127 struct glyph_row
*next
;
28128 struct glyph_row
*last
28129 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28131 for (next
= r2
+ 1;
28133 && next
->used
[TEXT_AREA
] > 0
28134 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28138 /* The rest of the display engine assumes that mouse_face_beg_row is
28139 either above mouse_face_end_row or identical to it. But with
28140 bidi-reordered continued lines, the row for START_CHARPOS could
28141 be below the row for END_CHARPOS. If so, swap the rows and store
28142 them in correct order. */
28145 struct glyph_row
*tem
= r2
;
28151 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28152 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28154 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28155 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28156 could be anywhere in the row and in any order. The strategy
28157 below is to find the leftmost and the rightmost glyph that
28158 belongs to either of these 3 strings, or whose position is
28159 between START_CHARPOS and END_CHARPOS, and highlight all the
28160 glyphs between those two. This may cover more than just the text
28161 between START_CHARPOS and END_CHARPOS if the range of characters
28162 strides the bidi level boundary, e.g. if the beginning is in R2L
28163 text while the end is in L2R text or vice versa. */
28164 if (!r1
->reversed_p
)
28166 /* This row is in a left to right paragraph. Scan it left to
28168 glyph
= r1
->glyphs
[TEXT_AREA
];
28169 end
= glyph
+ r1
->used
[TEXT_AREA
];
28172 /* Skip truncation glyphs at the start of the glyph row. */
28173 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28175 && INTEGERP (glyph
->object
)
28176 && glyph
->charpos
< 0;
28178 x
+= glyph
->pixel_width
;
28180 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28181 or DISP_STRING, and the first glyph from buffer whose
28182 position is between START_CHARPOS and END_CHARPOS. */
28184 && !INTEGERP (glyph
->object
)
28185 && !EQ (glyph
->object
, disp_string
)
28186 && !(BUFFERP (glyph
->object
)
28187 && (glyph
->charpos
>= start_charpos
28188 && glyph
->charpos
< end_charpos
));
28191 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28192 are present at buffer positions between START_CHARPOS and
28193 END_CHARPOS, or if they come from an overlay. */
28194 if (EQ (glyph
->object
, before_string
))
28196 pos
= string_buffer_position (before_string
,
28198 /* If pos == 0, it means before_string came from an
28199 overlay, not from a buffer position. */
28200 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28203 else if (EQ (glyph
->object
, after_string
))
28205 pos
= string_buffer_position (after_string
, end_charpos
);
28206 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28209 x
+= glyph
->pixel_width
;
28211 hlinfo
->mouse_face_beg_x
= x
;
28212 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28216 /* This row is in a right to left paragraph. Scan it right to
28220 end
= r1
->glyphs
[TEXT_AREA
] - 1;
28221 glyph
= end
+ r1
->used
[TEXT_AREA
];
28223 /* Skip truncation glyphs at the start of the glyph row. */
28224 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28226 && INTEGERP (glyph
->object
)
28227 && glyph
->charpos
< 0;
28231 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28232 or DISP_STRING, and the first glyph from buffer whose
28233 position is between START_CHARPOS and END_CHARPOS. */
28235 && !INTEGERP (glyph
->object
)
28236 && !EQ (glyph
->object
, disp_string
)
28237 && !(BUFFERP (glyph
->object
)
28238 && (glyph
->charpos
>= start_charpos
28239 && glyph
->charpos
< end_charpos
));
28242 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28243 are present at buffer positions between START_CHARPOS and
28244 END_CHARPOS, or if they come from an overlay. */
28245 if (EQ (glyph
->object
, before_string
))
28247 pos
= string_buffer_position (before_string
, start_charpos
);
28248 /* If pos == 0, it means before_string came from an
28249 overlay, not from a buffer position. */
28250 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28253 else if (EQ (glyph
->object
, after_string
))
28255 pos
= string_buffer_position (after_string
, end_charpos
);
28256 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28261 glyph
++; /* first glyph to the right of the highlighted area */
28262 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28263 x
+= g
->pixel_width
;
28264 hlinfo
->mouse_face_beg_x
= x
;
28265 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28268 /* If the highlight ends in a different row, compute GLYPH and END
28269 for the end row. Otherwise, reuse the values computed above for
28270 the row where the highlight begins. */
28273 if (!r2
->reversed_p
)
28275 glyph
= r2
->glyphs
[TEXT_AREA
];
28276 end
= glyph
+ r2
->used
[TEXT_AREA
];
28281 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28282 glyph
= end
+ r2
->used
[TEXT_AREA
];
28286 if (!r2
->reversed_p
)
28288 /* Skip truncation and continuation glyphs near the end of the
28289 row, and also blanks and stretch glyphs inserted by
28290 extend_face_to_end_of_line. */
28292 && INTEGERP ((end
- 1)->object
))
28294 /* Scan the rest of the glyph row from the end, looking for the
28295 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28296 DISP_STRING, or whose position is between START_CHARPOS
28300 && !INTEGERP (end
->object
)
28301 && !EQ (end
->object
, disp_string
)
28302 && !(BUFFERP (end
->object
)
28303 && (end
->charpos
>= start_charpos
28304 && end
->charpos
< end_charpos
));
28307 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28308 are present at buffer positions between START_CHARPOS and
28309 END_CHARPOS, or if they come from an overlay. */
28310 if (EQ (end
->object
, before_string
))
28312 pos
= string_buffer_position (before_string
, start_charpos
);
28313 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28316 else if (EQ (end
->object
, after_string
))
28318 pos
= string_buffer_position (after_string
, end_charpos
);
28319 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28323 /* Find the X coordinate of the last glyph to be highlighted. */
28324 for (; glyph
<= end
; ++glyph
)
28325 x
+= glyph
->pixel_width
;
28327 hlinfo
->mouse_face_end_x
= x
;
28328 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28332 /* Skip truncation and continuation glyphs near the end of the
28333 row, and also blanks and stretch glyphs inserted by
28334 extend_face_to_end_of_line. */
28338 && INTEGERP (end
->object
))
28340 x
+= end
->pixel_width
;
28343 /* Scan the rest of the glyph row from the end, looking for the
28344 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28345 DISP_STRING, or whose position is between START_CHARPOS
28349 && !INTEGERP (end
->object
)
28350 && !EQ (end
->object
, disp_string
)
28351 && !(BUFFERP (end
->object
)
28352 && (end
->charpos
>= start_charpos
28353 && end
->charpos
< end_charpos
));
28356 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28357 are present at buffer positions between START_CHARPOS and
28358 END_CHARPOS, or if they come from an overlay. */
28359 if (EQ (end
->object
, before_string
))
28361 pos
= string_buffer_position (before_string
, start_charpos
);
28362 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28365 else if (EQ (end
->object
, after_string
))
28367 pos
= string_buffer_position (after_string
, end_charpos
);
28368 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28371 x
+= end
->pixel_width
;
28373 /* If we exited the above loop because we arrived at the last
28374 glyph of the row, and its buffer position is still not in
28375 range, it means the last character in range is the preceding
28376 newline. Bump the end column and x values to get past the
28379 && BUFFERP (end
->object
)
28380 && (end
->charpos
< start_charpos
28381 || end
->charpos
>= end_charpos
))
28383 x
+= end
->pixel_width
;
28386 hlinfo
->mouse_face_end_x
= x
;
28387 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28390 hlinfo
->mouse_face_window
= window
;
28391 hlinfo
->mouse_face_face_id
28392 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28394 !hlinfo
->mouse_face_hidden
, -1);
28395 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28398 /* The following function is not used anymore (replaced with
28399 mouse_face_from_string_pos), but I leave it here for the time
28400 being, in case someone would. */
28402 #if 0 /* not used */
28404 /* Find the position of the glyph for position POS in OBJECT in
28405 window W's current matrix, and return in *X, *Y the pixel
28406 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28408 RIGHT_P non-zero means return the position of the right edge of the
28409 glyph, RIGHT_P zero means return the left edge position.
28411 If no glyph for POS exists in the matrix, return the position of
28412 the glyph with the next smaller position that is in the matrix, if
28413 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
28414 exists in the matrix, return the position of the glyph with the
28415 next larger position in OBJECT.
28417 Value is non-zero if a glyph was found. */
28420 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28421 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
28423 int yb
= window_text_bottom_y (w
);
28424 struct glyph_row
*r
;
28425 struct glyph
*best_glyph
= NULL
;
28426 struct glyph_row
*best_row
= NULL
;
28429 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28430 r
->enabled_p
&& r
->y
< yb
;
28433 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28434 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28437 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28438 if (EQ (g
->object
, object
))
28440 if (g
->charpos
== pos
)
28447 else if (best_glyph
== NULL
28448 || ((eabs (g
->charpos
- pos
)
28449 < eabs (best_glyph
->charpos
- pos
))
28452 : g
->charpos
> pos
)))
28466 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28470 *x
+= best_glyph
->pixel_width
;
28475 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28478 return best_glyph
!= NULL
;
28480 #endif /* not used */
28482 /* Find the positions of the first and the last glyphs in window W's
28483 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28484 (assumed to be a string), and return in HLINFO's mouse_face_*
28485 members the pixel and column/row coordinates of those glyphs. */
28488 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28489 Lisp_Object object
,
28490 ptrdiff_t startpos
, ptrdiff_t endpos
)
28492 int yb
= window_text_bottom_y (w
);
28493 struct glyph_row
*r
;
28494 struct glyph
*g
, *e
;
28498 /* Find the glyph row with at least one position in the range
28499 [STARTPOS..ENDPOS), and the first glyph in that row whose
28500 position belongs to that range. */
28501 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28502 r
->enabled_p
&& r
->y
< yb
;
28505 if (!r
->reversed_p
)
28507 g
= r
->glyphs
[TEXT_AREA
];
28508 e
= g
+ r
->used
[TEXT_AREA
];
28509 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28510 if (EQ (g
->object
, object
)
28511 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28513 hlinfo
->mouse_face_beg_row
28514 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28515 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28516 hlinfo
->mouse_face_beg_x
= gx
;
28525 e
= r
->glyphs
[TEXT_AREA
];
28526 g
= e
+ r
->used
[TEXT_AREA
];
28527 for ( ; g
> e
; --g
)
28528 if (EQ ((g
-1)->object
, object
)
28529 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
28531 hlinfo
->mouse_face_beg_row
28532 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28533 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28534 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
28535 gx
+= g1
->pixel_width
;
28536 hlinfo
->mouse_face_beg_x
= gx
;
28548 /* Starting with the next row, look for the first row which does NOT
28549 include any glyphs whose positions are in the range. */
28550 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
28552 g
= r
->glyphs
[TEXT_AREA
];
28553 e
= g
+ r
->used
[TEXT_AREA
];
28555 for ( ; g
< e
; ++g
)
28556 if (EQ (g
->object
, object
)
28557 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28566 /* The highlighted region ends on the previous row. */
28569 /* Set the end row. */
28570 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28572 /* Compute and set the end column and the end column's horizontal
28573 pixel coordinate. */
28574 if (!r
->reversed_p
)
28576 g
= r
->glyphs
[TEXT_AREA
];
28577 e
= g
+ r
->used
[TEXT_AREA
];
28578 for ( ; e
> g
; --e
)
28579 if (EQ ((e
-1)->object
, object
)
28580 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
28582 hlinfo
->mouse_face_end_col
= e
- g
;
28584 for (gx
= r
->x
; g
< e
; ++g
)
28585 gx
+= g
->pixel_width
;
28586 hlinfo
->mouse_face_end_x
= gx
;
28590 e
= r
->glyphs
[TEXT_AREA
];
28591 g
= e
+ r
->used
[TEXT_AREA
];
28592 for (gx
= r
->x
; e
< g
; ++e
)
28594 if (EQ (e
->object
, object
)
28595 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
28597 gx
+= e
->pixel_width
;
28599 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
28600 hlinfo
->mouse_face_end_x
= gx
;
28604 #ifdef HAVE_WINDOW_SYSTEM
28606 /* See if position X, Y is within a hot-spot of an image. */
28609 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
28611 if (!CONSP (hot_spot
))
28614 if (EQ (XCAR (hot_spot
), Qrect
))
28616 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
28617 Lisp_Object rect
= XCDR (hot_spot
);
28621 if (!CONSP (XCAR (rect
)))
28623 if (!CONSP (XCDR (rect
)))
28625 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
28627 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
28629 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
28631 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
28635 else if (EQ (XCAR (hot_spot
), Qcircle
))
28637 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
28638 Lisp_Object circ
= XCDR (hot_spot
);
28639 Lisp_Object lr
, lx0
, ly0
;
28641 && CONSP (XCAR (circ
))
28642 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
28643 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
28644 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
28646 double r
= XFLOATINT (lr
);
28647 double dx
= XINT (lx0
) - x
;
28648 double dy
= XINT (ly0
) - y
;
28649 return (dx
* dx
+ dy
* dy
<= r
* r
);
28652 else if (EQ (XCAR (hot_spot
), Qpoly
))
28654 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
28655 if (VECTORP (XCDR (hot_spot
)))
28657 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
28658 Lisp_Object
*poly
= v
->contents
;
28659 ptrdiff_t n
= v
->header
.size
;
28662 Lisp_Object lx
, ly
;
28665 /* Need an even number of coordinates, and at least 3 edges. */
28666 if (n
< 6 || n
& 1)
28669 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
28670 If count is odd, we are inside polygon. Pixels on edges
28671 may or may not be included depending on actual geometry of the
28673 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
28674 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
28676 x0
= XINT (lx
), y0
= XINT (ly
);
28677 for (i
= 0; i
< n
; i
+= 2)
28679 int x1
= x0
, y1
= y0
;
28680 if ((lx
= poly
[i
], !INTEGERP (lx
))
28681 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
28683 x0
= XINT (lx
), y0
= XINT (ly
);
28685 /* Does this segment cross the X line? */
28693 if (y
> y0
&& y
> y1
)
28695 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
28705 find_hot_spot (Lisp_Object map
, int x
, int y
)
28707 while (CONSP (map
))
28709 if (CONSP (XCAR (map
))
28710 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
28718 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
28720 doc
: /* Lookup in image map MAP coordinates X and Y.
28721 An image map is an alist where each element has the format (AREA ID PLIST).
28722 An AREA is specified as either a rectangle, a circle, or a polygon:
28723 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
28724 pixel coordinates of the upper left and bottom right corners.
28725 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
28726 and the radius of the circle; r may be a float or integer.
28727 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
28728 vector describes one corner in the polygon.
28729 Returns the alist element for the first matching AREA in MAP. */)
28730 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
28738 return find_hot_spot (map
,
28739 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
28740 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
28744 /* Display frame CURSOR, optionally using shape defined by POINTER. */
28746 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
28748 /* Do not change cursor shape while dragging mouse. */
28749 if (!NILP (do_mouse_tracking
))
28752 if (!NILP (pointer
))
28754 if (EQ (pointer
, Qarrow
))
28755 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28756 else if (EQ (pointer
, Qhand
))
28757 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
28758 else if (EQ (pointer
, Qtext
))
28759 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
28760 else if (EQ (pointer
, intern ("hdrag")))
28761 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28762 else if (EQ (pointer
, intern ("nhdrag")))
28763 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
28764 #ifdef HAVE_X_WINDOWS
28765 else if (EQ (pointer
, intern ("vdrag")))
28766 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28768 else if (EQ (pointer
, intern ("hourglass")))
28769 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
28770 else if (EQ (pointer
, Qmodeline
))
28771 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
28773 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28776 if (cursor
!= No_Cursor
)
28777 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
28780 #endif /* HAVE_WINDOW_SYSTEM */
28782 /* Take proper action when mouse has moved to the mode or header line
28783 or marginal area AREA of window W, x-position X and y-position Y.
28784 X is relative to the start of the text display area of W, so the
28785 width of bitmap areas and scroll bars must be subtracted to get a
28786 position relative to the start of the mode line. */
28789 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
28790 enum window_part area
)
28792 struct window
*w
= XWINDOW (window
);
28793 struct frame
*f
= XFRAME (w
->frame
);
28794 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28795 #ifdef HAVE_WINDOW_SYSTEM
28796 Display_Info
*dpyinfo
;
28798 Cursor cursor
= No_Cursor
;
28799 Lisp_Object pointer
= Qnil
;
28800 int dx
, dy
, width
, height
;
28802 Lisp_Object string
, object
= Qnil
;
28803 Lisp_Object pos
IF_LINT (= Qnil
), help
;
28805 Lisp_Object mouse_face
;
28806 int original_x_pixel
= x
;
28807 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
28808 struct glyph_row
*row
IF_LINT (= 0);
28810 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
28815 /* Kludge alert: mode_line_string takes X/Y in pixels, but
28816 returns them in row/column units! */
28817 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
28818 &object
, &dx
, &dy
, &width
, &height
);
28820 row
= (area
== ON_MODE_LINE
28821 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
28822 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
28824 /* Find the glyph under the mouse pointer. */
28825 if (row
->mode_line_p
&& row
->enabled_p
)
28827 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
28828 end
= glyph
+ row
->used
[TEXT_AREA
];
28830 for (x0
= original_x_pixel
;
28831 glyph
< end
&& x0
>= glyph
->pixel_width
;
28833 x0
-= glyph
->pixel_width
;
28841 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
28842 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
28843 returns them in row/column units! */
28844 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
28845 &object
, &dx
, &dy
, &width
, &height
);
28850 #ifdef HAVE_WINDOW_SYSTEM
28851 if (IMAGEP (object
))
28853 Lisp_Object image_map
, hotspot
;
28854 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
28856 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
28858 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
28862 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
28863 If so, we could look for mouse-enter, mouse-leave
28864 properties in PLIST (and do something...). */
28865 hotspot
= XCDR (hotspot
);
28866 if (CONSP (hotspot
)
28867 && (plist
= XCAR (hotspot
), CONSP (plist
)))
28869 pointer
= Fplist_get (plist
, Qpointer
);
28870 if (NILP (pointer
))
28872 help
= Fplist_get (plist
, Qhelp_echo
);
28875 help_echo_string
= help
;
28876 XSETWINDOW (help_echo_window
, w
);
28877 help_echo_object
= w
->contents
;
28878 help_echo_pos
= charpos
;
28882 if (NILP (pointer
))
28883 pointer
= Fplist_get (XCDR (object
), QCpointer
);
28885 #endif /* HAVE_WINDOW_SYSTEM */
28887 if (STRINGP (string
))
28888 pos
= make_number (charpos
);
28890 /* Set the help text and mouse pointer. If the mouse is on a part
28891 of the mode line without any text (e.g. past the right edge of
28892 the mode line text), use the default help text and pointer. */
28893 if (STRINGP (string
) || area
== ON_MODE_LINE
)
28895 /* Arrange to display the help by setting the global variables
28896 help_echo_string, help_echo_object, and help_echo_pos. */
28899 if (STRINGP (string
))
28900 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
28904 help_echo_string
= help
;
28905 XSETWINDOW (help_echo_window
, w
);
28906 help_echo_object
= string
;
28907 help_echo_pos
= charpos
;
28909 else if (area
== ON_MODE_LINE
)
28911 Lisp_Object default_help
28912 = buffer_local_value_1 (Qmode_line_default_help_echo
,
28915 if (STRINGP (default_help
))
28917 help_echo_string
= default_help
;
28918 XSETWINDOW (help_echo_window
, w
);
28919 help_echo_object
= Qnil
;
28920 help_echo_pos
= -1;
28925 #ifdef HAVE_WINDOW_SYSTEM
28926 /* Change the mouse pointer according to what is under it. */
28927 if (FRAME_WINDOW_P (f
))
28929 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
28931 || NILP (Vresize_mini_windows
));
28933 dpyinfo
= FRAME_DISPLAY_INFO (f
);
28934 if (STRINGP (string
))
28936 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28938 if (NILP (pointer
))
28939 pointer
= Fget_text_property (pos
, Qpointer
, string
);
28941 /* Change the mouse pointer according to what is under X/Y. */
28943 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
28946 map
= Fget_text_property (pos
, Qlocal_map
, string
);
28947 if (!KEYMAPP (map
))
28948 map
= Fget_text_property (pos
, Qkeymap
, string
);
28949 if (!KEYMAPP (map
) && draggable
)
28950 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
28953 else if (draggable
)
28954 /* Default mode-line pointer. */
28955 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28960 /* Change the mouse face according to what is under X/Y. */
28961 if (STRINGP (string
))
28963 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
28964 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
28965 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
28970 struct glyph
* tmp_glyph
;
28974 int total_pixel_width
;
28975 ptrdiff_t begpos
, endpos
, ignore
;
28979 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
28980 Qmouse_face
, string
, Qnil
);
28986 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
28988 endpos
= SCHARS (string
);
28992 /* Calculate the glyph position GPOS of GLYPH in the
28993 displayed string, relative to the beginning of the
28994 highlighted part of the string.
28996 Note: GPOS is different from CHARPOS. CHARPOS is the
28997 position of GLYPH in the internal string object. A mode
28998 line string format has structures which are converted to
28999 a flattened string by the Emacs Lisp interpreter. The
29000 internal string is an element of those structures. The
29001 displayed string is the flattened string. */
29002 tmp_glyph
= row_start_glyph
;
29003 while (tmp_glyph
< glyph
29004 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29005 && begpos
<= tmp_glyph
->charpos
29006 && tmp_glyph
->charpos
< endpos
)))
29008 gpos
= glyph
- tmp_glyph
;
29010 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29011 the highlighted part of the displayed string to which
29012 GLYPH belongs. Note: GSEQ_LENGTH is different from
29013 SCHARS (STRING), because the latter returns the length of
29014 the internal string. */
29015 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29017 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29018 && begpos
<= tmp_glyph
->charpos
29019 && tmp_glyph
->charpos
< endpos
));
29022 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29024 /* Calculate the total pixel width of all the glyphs between
29025 the beginning of the highlighted area and GLYPH. */
29026 total_pixel_width
= 0;
29027 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29028 total_pixel_width
+= tmp_glyph
->pixel_width
;
29030 /* Pre calculation of re-rendering position. Note: X is in
29031 column units here, after the call to mode_line_string or
29032 marginal_area_string. */
29034 vpos
= (area
== ON_MODE_LINE
29035 ? (w
->current_matrix
)->nrows
- 1
29038 /* If GLYPH's position is included in the region that is
29039 already drawn in mouse face, we have nothing to do. */
29040 if ( EQ (window
, hlinfo
->mouse_face_window
)
29041 && (!row
->reversed_p
29042 ? (hlinfo
->mouse_face_beg_col
<= hpos
29043 && hpos
< hlinfo
->mouse_face_end_col
)
29044 /* In R2L rows we swap BEG and END, see below. */
29045 : (hlinfo
->mouse_face_end_col
<= hpos
29046 && hpos
< hlinfo
->mouse_face_beg_col
))
29047 && hlinfo
->mouse_face_beg_row
== vpos
)
29050 if (clear_mouse_face (hlinfo
))
29051 cursor
= No_Cursor
;
29053 if (!row
->reversed_p
)
29055 hlinfo
->mouse_face_beg_col
= hpos
;
29056 hlinfo
->mouse_face_beg_x
= original_x_pixel
29057 - (total_pixel_width
+ dx
);
29058 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29059 hlinfo
->mouse_face_end_x
= 0;
29063 /* In R2L rows, show_mouse_face expects BEG and END
29064 coordinates to be swapped. */
29065 hlinfo
->mouse_face_end_col
= hpos
;
29066 hlinfo
->mouse_face_end_x
= original_x_pixel
29067 - (total_pixel_width
+ dx
);
29068 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29069 hlinfo
->mouse_face_beg_x
= 0;
29072 hlinfo
->mouse_face_beg_row
= vpos
;
29073 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29074 hlinfo
->mouse_face_past_end
= 0;
29075 hlinfo
->mouse_face_window
= window
;
29077 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29082 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29084 if (NILP (pointer
))
29087 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29088 clear_mouse_face (hlinfo
);
29090 #ifdef HAVE_WINDOW_SYSTEM
29091 if (FRAME_WINDOW_P (f
))
29092 define_frame_cursor1 (f
, cursor
, pointer
);
29098 Take proper action when the mouse has moved to position X, Y on
29099 frame F with regards to highlighting portions of display that have
29100 mouse-face properties. Also de-highlight portions of display where
29101 the mouse was before, set the mouse pointer shape as appropriate
29102 for the mouse coordinates, and activate help echo (tooltips).
29103 X and Y can be negative or out of range. */
29106 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29108 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29109 enum window_part part
= ON_NOTHING
;
29110 Lisp_Object window
;
29112 Cursor cursor
= No_Cursor
;
29113 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29116 /* When a menu is active, don't highlight because this looks odd. */
29117 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29118 if (popup_activated ())
29122 if (!f
->glyphs_initialized_p
29123 || f
->pointer_invisible
)
29126 hlinfo
->mouse_face_mouse_x
= x
;
29127 hlinfo
->mouse_face_mouse_y
= y
;
29128 hlinfo
->mouse_face_mouse_frame
= f
;
29130 if (hlinfo
->mouse_face_defer
)
29133 /* Which window is that in? */
29134 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
29136 /* If displaying active text in another window, clear that. */
29137 if (! EQ (window
, hlinfo
->mouse_face_window
)
29138 /* Also clear if we move out of text area in same window. */
29139 || (!NILP (hlinfo
->mouse_face_window
)
29142 && part
!= ON_MODE_LINE
29143 && part
!= ON_HEADER_LINE
))
29144 clear_mouse_face (hlinfo
);
29146 /* Not on a window -> return. */
29147 if (!WINDOWP (window
))
29150 /* Reset help_echo_string. It will get recomputed below. */
29151 help_echo_string
= Qnil
;
29153 /* Convert to window-relative pixel coordinates. */
29154 w
= XWINDOW (window
);
29155 frame_to_window_pixel_xy (w
, &x
, &y
);
29157 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29158 /* Handle tool-bar window differently since it doesn't display a
29160 if (EQ (window
, f
->tool_bar_window
))
29162 note_tool_bar_highlight (f
, x
, y
);
29167 /* Mouse is on the mode, header line or margin? */
29168 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29169 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29171 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29173 #ifdef HAVE_WINDOW_SYSTEM
29174 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29176 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29177 /* Show non-text cursor (Bug#16647). */
29185 #ifdef HAVE_WINDOW_SYSTEM
29186 if (part
== ON_VERTICAL_BORDER
)
29188 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29189 help_echo_string
= build_string ("drag-mouse-1: resize");
29191 else if (part
== ON_RIGHT_DIVIDER
)
29193 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29194 help_echo_string
= build_string ("drag-mouse-1: resize");
29196 else if (part
== ON_BOTTOM_DIVIDER
)
29197 if (! WINDOW_BOTTOMMOST_P (w
)
29199 || NILP (Vresize_mini_windows
))
29201 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29202 help_echo_string
= build_string ("drag-mouse-1: resize");
29205 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29206 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
29207 || part
== ON_SCROLL_BAR
)
29208 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29210 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29213 /* Are we in a window whose display is up to date?
29214 And verify the buffer's text has not changed. */
29215 b
= XBUFFER (w
->contents
);
29216 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
29218 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
29220 struct glyph
*glyph
;
29221 Lisp_Object object
;
29222 Lisp_Object mouse_face
= Qnil
, position
;
29223 Lisp_Object
*overlay_vec
= NULL
;
29224 ptrdiff_t i
, noverlays
;
29225 struct buffer
*obuf
;
29226 ptrdiff_t obegv
, ozv
;
29229 /* Find the glyph under X/Y. */
29230 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
29232 #ifdef HAVE_WINDOW_SYSTEM
29233 /* Look for :pointer property on image. */
29234 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29236 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29237 if (img
!= NULL
&& IMAGEP (img
->spec
))
29239 Lisp_Object image_map
, hotspot
;
29240 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29242 && (hotspot
= find_hot_spot (image_map
,
29243 glyph
->slice
.img
.x
+ dx
,
29244 glyph
->slice
.img
.y
+ dy
),
29246 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29250 /* Could check XCAR (hotspot) to see if we enter/leave
29252 If so, we could look for mouse-enter, mouse-leave
29253 properties in PLIST (and do something...). */
29254 hotspot
= XCDR (hotspot
);
29255 if (CONSP (hotspot
)
29256 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29258 pointer
= Fplist_get (plist
, Qpointer
);
29259 if (NILP (pointer
))
29261 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29262 if (!NILP (help_echo_string
))
29264 help_echo_window
= window
;
29265 help_echo_object
= glyph
->object
;
29266 help_echo_pos
= glyph
->charpos
;
29270 if (NILP (pointer
))
29271 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29274 #endif /* HAVE_WINDOW_SYSTEM */
29276 /* Clear mouse face if X/Y not over text. */
29278 || area
!= TEXT_AREA
29279 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29280 /* Glyph's OBJECT is an integer for glyphs inserted by the
29281 display engine for its internal purposes, like truncation
29282 and continuation glyphs and blanks beyond the end of
29283 line's text on text terminals. If we are over such a
29284 glyph, we are not over any text. */
29285 || INTEGERP (glyph
->object
)
29286 /* R2L rows have a stretch glyph at their front, which
29287 stands for no text, whereas L2R rows have no glyphs at
29288 all beyond the end of text. Treat such stretch glyphs
29289 like we do with NULL glyphs in L2R rows. */
29290 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29291 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29292 && glyph
->type
== STRETCH_GLYPH
29293 && glyph
->avoid_cursor_p
))
29295 if (clear_mouse_face (hlinfo
))
29296 cursor
= No_Cursor
;
29297 #ifdef HAVE_WINDOW_SYSTEM
29298 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29300 if (area
!= TEXT_AREA
)
29301 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29303 pointer
= Vvoid_text_area_pointer
;
29309 pos
= glyph
->charpos
;
29310 object
= glyph
->object
;
29311 if (!STRINGP (object
) && !BUFFERP (object
))
29314 /* If we get an out-of-range value, return now; avoid an error. */
29315 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29318 /* Make the window's buffer temporarily current for
29319 overlays_at and compute_char_face. */
29320 obuf
= current_buffer
;
29321 current_buffer
= b
;
29327 /* Is this char mouse-active or does it have help-echo? */
29328 position
= make_number (pos
);
29330 if (BUFFERP (object
))
29332 /* Put all the overlays we want in a vector in overlay_vec. */
29333 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
29334 /* Sort overlays into increasing priority order. */
29335 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29340 if (NILP (Vmouse_highlight
))
29342 clear_mouse_face (hlinfo
);
29343 goto check_help_echo
;
29346 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29349 cursor
= No_Cursor
;
29351 /* Check mouse-face highlighting. */
29353 /* If there exists an overlay with mouse-face overlapping
29354 the one we are currently highlighting, we have to
29355 check if we enter the overlapping overlay, and then
29356 highlight only that. */
29357 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29358 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29360 /* Find the highest priority overlay with a mouse-face. */
29361 Lisp_Object overlay
= Qnil
;
29362 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29364 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29365 if (!NILP (mouse_face
))
29366 overlay
= overlay_vec
[i
];
29369 /* If we're highlighting the same overlay as before, there's
29370 no need to do that again. */
29371 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29372 goto check_help_echo
;
29373 hlinfo
->mouse_face_overlay
= overlay
;
29375 /* Clear the display of the old active region, if any. */
29376 if (clear_mouse_face (hlinfo
))
29377 cursor
= No_Cursor
;
29379 /* If no overlay applies, get a text property. */
29380 if (NILP (overlay
))
29381 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29383 /* Next, compute the bounds of the mouse highlighting and
29385 if (!NILP (mouse_face
) && STRINGP (object
))
29387 /* The mouse-highlighting comes from a display string
29388 with a mouse-face. */
29392 s
= Fprevious_single_property_change
29393 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29394 e
= Fnext_single_property_change
29395 (position
, Qmouse_face
, object
, Qnil
);
29397 s
= make_number (0);
29399 e
= make_number (SCHARS (object
));
29400 mouse_face_from_string_pos (w
, hlinfo
, object
,
29401 XINT (s
), XINT (e
));
29402 hlinfo
->mouse_face_past_end
= 0;
29403 hlinfo
->mouse_face_window
= window
;
29404 hlinfo
->mouse_face_face_id
29405 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29406 glyph
->face_id
, 1);
29407 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29408 cursor
= No_Cursor
;
29412 /* The mouse-highlighting, if any, comes from an overlay
29413 or text property in the buffer. */
29414 Lisp_Object buffer
IF_LINT (= Qnil
);
29415 Lisp_Object disp_string
IF_LINT (= Qnil
);
29417 if (STRINGP (object
))
29419 /* If we are on a display string with no mouse-face,
29420 check if the text under it has one. */
29421 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29422 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29423 pos
= string_buffer_position (object
, start
);
29426 mouse_face
= get_char_property_and_overlay
29427 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29428 buffer
= w
->contents
;
29429 disp_string
= object
;
29435 disp_string
= Qnil
;
29438 if (!NILP (mouse_face
))
29440 Lisp_Object before
, after
;
29441 Lisp_Object before_string
, after_string
;
29442 /* To correctly find the limits of mouse highlight
29443 in a bidi-reordered buffer, we must not use the
29444 optimization of limiting the search in
29445 previous-single-property-change and
29446 next-single-property-change, because
29447 rows_from_pos_range needs the real start and end
29448 positions to DTRT in this case. That's because
29449 the first row visible in a window does not
29450 necessarily display the character whose position
29451 is the smallest. */
29453 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29454 ? Fmarker_position (w
->start
)
29457 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29458 ? make_number (BUF_Z (XBUFFER (buffer
))
29459 - w
->window_end_pos
)
29462 if (NILP (overlay
))
29464 /* Handle the text property case. */
29465 before
= Fprevious_single_property_change
29466 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29467 after
= Fnext_single_property_change
29468 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29469 before_string
= after_string
= Qnil
;
29473 /* Handle the overlay case. */
29474 before
= Foverlay_start (overlay
);
29475 after
= Foverlay_end (overlay
);
29476 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29477 after_string
= Foverlay_get (overlay
, Qafter_string
);
29479 if (!STRINGP (before_string
)) before_string
= Qnil
;
29480 if (!STRINGP (after_string
)) after_string
= Qnil
;
29483 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29486 : XFASTINT (before
),
29488 ? BUF_Z (XBUFFER (buffer
))
29489 : XFASTINT (after
),
29490 before_string
, after_string
,
29492 cursor
= No_Cursor
;
29499 /* Look for a `help-echo' property. */
29500 if (NILP (help_echo_string
)) {
29501 Lisp_Object help
, overlay
;
29503 /* Check overlays first. */
29504 help
= overlay
= Qnil
;
29505 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29507 overlay
= overlay_vec
[i
];
29508 help
= Foverlay_get (overlay
, Qhelp_echo
);
29513 help_echo_string
= help
;
29514 help_echo_window
= window
;
29515 help_echo_object
= overlay
;
29516 help_echo_pos
= pos
;
29520 Lisp_Object obj
= glyph
->object
;
29521 ptrdiff_t charpos
= glyph
->charpos
;
29523 /* Try text properties. */
29526 && charpos
< SCHARS (obj
))
29528 help
= Fget_text_property (make_number (charpos
),
29532 /* If the string itself doesn't specify a help-echo,
29533 see if the buffer text ``under'' it does. */
29534 struct glyph_row
*r
29535 = MATRIX_ROW (w
->current_matrix
, vpos
);
29536 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29537 ptrdiff_t p
= string_buffer_position (obj
, start
);
29540 help
= Fget_char_property (make_number (p
),
29541 Qhelp_echo
, w
->contents
);
29550 else if (BUFFERP (obj
)
29553 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
29558 help_echo_string
= help
;
29559 help_echo_window
= window
;
29560 help_echo_object
= obj
;
29561 help_echo_pos
= charpos
;
29566 #ifdef HAVE_WINDOW_SYSTEM
29567 /* Look for a `pointer' property. */
29568 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29570 /* Check overlays first. */
29571 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
29572 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
29574 if (NILP (pointer
))
29576 Lisp_Object obj
= glyph
->object
;
29577 ptrdiff_t charpos
= glyph
->charpos
;
29579 /* Try text properties. */
29582 && charpos
< SCHARS (obj
))
29584 pointer
= Fget_text_property (make_number (charpos
),
29586 if (NILP (pointer
))
29588 /* If the string itself doesn't specify a pointer,
29589 see if the buffer text ``under'' it does. */
29590 struct glyph_row
*r
29591 = MATRIX_ROW (w
->current_matrix
, vpos
);
29592 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29593 ptrdiff_t p
= string_buffer_position (obj
, start
);
29595 pointer
= Fget_char_property (make_number (p
),
29596 Qpointer
, w
->contents
);
29599 else if (BUFFERP (obj
)
29602 pointer
= Fget_text_property (make_number (charpos
),
29606 #endif /* HAVE_WINDOW_SYSTEM */
29610 current_buffer
= obuf
;
29615 #ifdef HAVE_WINDOW_SYSTEM
29616 if (FRAME_WINDOW_P (f
))
29617 define_frame_cursor1 (f
, cursor
, pointer
);
29619 /* This is here to prevent a compiler error, about "label at end of
29620 compound statement". */
29627 Clear any mouse-face on window W. This function is part of the
29628 redisplay interface, and is called from try_window_id and similar
29629 functions to ensure the mouse-highlight is off. */
29632 x_clear_window_mouse_face (struct window
*w
)
29634 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
29635 Lisp_Object window
;
29638 XSETWINDOW (window
, w
);
29639 if (EQ (window
, hlinfo
->mouse_face_window
))
29640 clear_mouse_face (hlinfo
);
29646 Just discard the mouse face information for frame F, if any.
29647 This is used when the size of F is changed. */
29650 cancel_mouse_face (struct frame
*f
)
29652 Lisp_Object window
;
29653 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29655 window
= hlinfo
->mouse_face_window
;
29656 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
29657 reset_mouse_highlight (hlinfo
);
29662 /***********************************************************************
29664 ***********************************************************************/
29666 #ifdef HAVE_WINDOW_SYSTEM
29668 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
29669 which intersects rectangle R. R is in window-relative coordinates. */
29672 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
29673 enum glyph_row_area area
)
29675 struct glyph
*first
= row
->glyphs
[area
];
29676 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
29677 struct glyph
*last
;
29678 int first_x
, start_x
, x
;
29680 if (area
== TEXT_AREA
&& row
->fill_line_p
)
29681 /* If row extends face to end of line write the whole line. */
29682 draw_glyphs (w
, 0, row
, area
,
29683 0, row
->used
[area
],
29684 DRAW_NORMAL_TEXT
, 0);
29687 /* Set START_X to the window-relative start position for drawing glyphs of
29688 AREA. The first glyph of the text area can be partially visible.
29689 The first glyphs of other areas cannot. */
29690 start_x
= window_box_left_offset (w
, area
);
29692 if (area
== TEXT_AREA
)
29695 /* Find the first glyph that must be redrawn. */
29697 && x
+ first
->pixel_width
< r
->x
)
29699 x
+= first
->pixel_width
;
29703 /* Find the last one. */
29707 && x
< r
->x
+ r
->width
)
29709 x
+= last
->pixel_width
;
29715 draw_glyphs (w
, first_x
- start_x
, row
, area
,
29716 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
29717 DRAW_NORMAL_TEXT
, 0);
29722 /* Redraw the parts of the glyph row ROW on window W intersecting
29723 rectangle R. R is in window-relative coordinates. Value is
29724 non-zero if mouse-face was overwritten. */
29727 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
29729 eassert (row
->enabled_p
);
29731 if (row
->mode_line_p
|| w
->pseudo_window_p
)
29732 draw_glyphs (w
, 0, row
, TEXT_AREA
,
29733 0, row
->used
[TEXT_AREA
],
29734 DRAW_NORMAL_TEXT
, 0);
29737 if (row
->used
[LEFT_MARGIN_AREA
])
29738 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
29739 if (row
->used
[TEXT_AREA
])
29740 expose_area (w
, row
, r
, TEXT_AREA
);
29741 if (row
->used
[RIGHT_MARGIN_AREA
])
29742 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
29743 draw_row_fringe_bitmaps (w
, row
);
29746 return row
->mouse_face_p
;
29750 /* Redraw those parts of glyphs rows during expose event handling that
29751 overlap other rows. Redrawing of an exposed line writes over parts
29752 of lines overlapping that exposed line; this function fixes that.
29754 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
29755 row in W's current matrix that is exposed and overlaps other rows.
29756 LAST_OVERLAPPING_ROW is the last such row. */
29759 expose_overlaps (struct window
*w
,
29760 struct glyph_row
*first_overlapping_row
,
29761 struct glyph_row
*last_overlapping_row
,
29764 struct glyph_row
*row
;
29766 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
29767 if (row
->overlapping_p
)
29769 eassert (row
->enabled_p
&& !row
->mode_line_p
);
29772 if (row
->used
[LEFT_MARGIN_AREA
])
29773 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
29775 if (row
->used
[TEXT_AREA
])
29776 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
29778 if (row
->used
[RIGHT_MARGIN_AREA
])
29779 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
29785 /* Return non-zero if W's cursor intersects rectangle R. */
29788 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
29790 XRectangle cr
, result
;
29791 struct glyph
*cursor_glyph
;
29792 struct glyph_row
*row
;
29794 if (w
->phys_cursor
.vpos
>= 0
29795 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
29796 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
29798 && row
->cursor_in_fringe_p
)
29800 /* Cursor is in the fringe. */
29801 cr
.x
= window_box_right_offset (w
,
29802 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
29803 ? RIGHT_MARGIN_AREA
29806 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
29807 cr
.height
= row
->height
;
29808 return x_intersect_rectangles (&cr
, r
, &result
);
29811 cursor_glyph
= get_phys_cursor_glyph (w
);
29814 /* r is relative to W's box, but w->phys_cursor.x is relative
29815 to left edge of W's TEXT area. Adjust it. */
29816 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
29817 cr
.y
= w
->phys_cursor
.y
;
29818 cr
.width
= cursor_glyph
->pixel_width
;
29819 cr
.height
= w
->phys_cursor_height
;
29820 /* ++KFS: W32 version used W32-specific IntersectRect here, but
29821 I assume the effect is the same -- and this is portable. */
29822 return x_intersect_rectangles (&cr
, r
, &result
);
29824 /* If we don't understand the format, pretend we're not in the hot-spot. */
29830 Draw a vertical window border to the right of window W if W doesn't
29831 have vertical scroll bars. */
29834 x_draw_vertical_border (struct window
*w
)
29836 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29838 /* We could do better, if we knew what type of scroll-bar the adjacent
29839 windows (on either side) have... But we don't :-(
29840 However, I think this works ok. ++KFS 2003-04-25 */
29842 /* Redraw borders between horizontally adjacent windows. Don't
29843 do it for frames with vertical scroll bars because either the
29844 right scroll bar of a window, or the left scroll bar of its
29845 neighbor will suffice as a border. */
29846 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
29849 /* Note: It is necessary to redraw both the left and the right
29850 borders, for when only this single window W is being
29852 if (!WINDOW_RIGHTMOST_P (w
)
29853 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
29855 int x0
, x1
, y0
, y1
;
29857 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29860 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29863 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
29866 if (!WINDOW_LEFTMOST_P (w
)
29867 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
29869 int x0
, x1
, y0
, y1
;
29871 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29874 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29877 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
29882 /* Draw window dividers for window W. */
29885 x_draw_right_divider (struct window
*w
)
29887 struct frame
*f
= WINDOW_XFRAME (w
);
29889 if (w
->mini
|| w
->pseudo_window_p
)
29891 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
29893 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
29894 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29895 int y0
= WINDOW_TOP_EDGE_Y (w
);
29896 /* The bottom divider prevails. */
29897 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29899 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29904 x_draw_bottom_divider (struct window
*w
)
29906 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29908 if (w
->mini
|| w
->pseudo_window_p
)
29910 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
29912 int x0
= WINDOW_LEFT_EDGE_X (w
);
29913 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29914 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29915 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
29917 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29921 /* Redraw the part of window W intersection rectangle FR. Pixel
29922 coordinates in FR are frame-relative. Call this function with
29923 input blocked. Value is non-zero if the exposure overwrites
29927 expose_window (struct window
*w
, XRectangle
*fr
)
29929 struct frame
*f
= XFRAME (w
->frame
);
29931 int mouse_face_overwritten_p
= 0;
29933 /* If window is not yet fully initialized, do nothing. This can
29934 happen when toolkit scroll bars are used and a window is split.
29935 Reconfiguring the scroll bar will generate an expose for a newly
29937 if (w
->current_matrix
== NULL
)
29940 /* When we're currently updating the window, display and current
29941 matrix usually don't agree. Arrange for a thorough display
29943 if (w
->must_be_updated_p
)
29945 SET_FRAME_GARBAGED (f
);
29949 /* Frame-relative pixel rectangle of W. */
29950 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
29951 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
29952 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
29953 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
29955 if (x_intersect_rectangles (fr
, &wr
, &r
))
29957 int yb
= window_text_bottom_y (w
);
29958 struct glyph_row
*row
;
29959 int cursor_cleared_p
, phys_cursor_on_p
;
29960 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
29962 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
29963 r
.x
, r
.y
, r
.width
, r
.height
));
29965 /* Convert to window coordinates. */
29966 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
29967 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
29969 /* Turn off the cursor. */
29970 if (!w
->pseudo_window_p
29971 && phys_cursor_in_rect_p (w
, &r
))
29973 x_clear_cursor (w
);
29974 cursor_cleared_p
= 1;
29977 cursor_cleared_p
= 0;
29979 /* If the row containing the cursor extends face to end of line,
29980 then expose_area might overwrite the cursor outside the
29981 rectangle and thus notice_overwritten_cursor might clear
29982 w->phys_cursor_on_p. We remember the original value and
29983 check later if it is changed. */
29984 phys_cursor_on_p
= w
->phys_cursor_on_p
;
29986 /* Update lines intersecting rectangle R. */
29987 first_overlapping_row
= last_overlapping_row
= NULL
;
29988 for (row
= w
->current_matrix
->rows
;
29993 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
29995 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
29996 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
29997 || (r
.y
>= y0
&& r
.y
< y1
)
29998 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
30000 /* A header line may be overlapping, but there is no need
30001 to fix overlapping areas for them. KFS 2005-02-12 */
30002 if (row
->overlapping_p
&& !row
->mode_line_p
)
30004 if (first_overlapping_row
== NULL
)
30005 first_overlapping_row
= row
;
30006 last_overlapping_row
= row
;
30010 if (expose_line (w
, row
, &r
))
30011 mouse_face_overwritten_p
= 1;
30014 else if (row
->overlapping_p
)
30016 /* We must redraw a row overlapping the exposed area. */
30018 ? y0
+ row
->phys_height
> r
.y
30019 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30021 if (first_overlapping_row
== NULL
)
30022 first_overlapping_row
= row
;
30023 last_overlapping_row
= row
;
30031 /* Display the mode line if there is one. */
30032 if (WINDOW_WANTS_MODELINE_P (w
)
30033 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30035 && row
->y
< r
.y
+ r
.height
)
30037 if (expose_line (w
, row
, &r
))
30038 mouse_face_overwritten_p
= 1;
30041 if (!w
->pseudo_window_p
)
30043 /* Fix the display of overlapping rows. */
30044 if (first_overlapping_row
)
30045 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30048 /* Draw border between windows. */
30049 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30050 x_draw_right_divider (w
);
30052 x_draw_vertical_border (w
);
30054 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30055 x_draw_bottom_divider (w
);
30057 /* Turn the cursor on again. */
30058 if (cursor_cleared_p
30059 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30060 update_window_cursor (w
, 1);
30064 return mouse_face_overwritten_p
;
30069 /* Redraw (parts) of all windows in the window tree rooted at W that
30070 intersect R. R contains frame pixel coordinates. Value is
30071 non-zero if the exposure overwrites mouse-face. */
30074 expose_window_tree (struct window
*w
, XRectangle
*r
)
30076 struct frame
*f
= XFRAME (w
->frame
);
30077 int mouse_face_overwritten_p
= 0;
30079 while (w
&& !FRAME_GARBAGED_P (f
))
30081 if (WINDOWP (w
->contents
))
30082 mouse_face_overwritten_p
30083 |= expose_window_tree (XWINDOW (w
->contents
), r
);
30085 mouse_face_overwritten_p
|= expose_window (w
, r
);
30087 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30090 return mouse_face_overwritten_p
;
30095 Redisplay an exposed area of frame F. X and Y are the upper-left
30096 corner of the exposed rectangle. W and H are width and height of
30097 the exposed area. All are pixel values. W or H zero means redraw
30098 the entire frame. */
30101 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30104 int mouse_face_overwritten_p
= 0;
30106 TRACE ((stderr
, "expose_frame "));
30108 /* No need to redraw if frame will be redrawn soon. */
30109 if (FRAME_GARBAGED_P (f
))
30111 TRACE ((stderr
, " garbaged\n"));
30115 /* If basic faces haven't been realized yet, there is no point in
30116 trying to redraw anything. This can happen when we get an expose
30117 event while Emacs is starting, e.g. by moving another window. */
30118 if (FRAME_FACE_CACHE (f
) == NULL
30119 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30121 TRACE ((stderr
, " no faces\n"));
30125 if (w
== 0 || h
== 0)
30128 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
30129 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
30139 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30140 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30142 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30143 if (WINDOWP (f
->tool_bar_window
))
30144 mouse_face_overwritten_p
30145 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30148 #ifdef HAVE_X_WINDOWS
30150 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30151 if (WINDOWP (f
->menu_bar_window
))
30152 mouse_face_overwritten_p
30153 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30154 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30158 /* Some window managers support a focus-follows-mouse style with
30159 delayed raising of frames. Imagine a partially obscured frame,
30160 and moving the mouse into partially obscured mouse-face on that
30161 frame. The visible part of the mouse-face will be highlighted,
30162 then the WM raises the obscured frame. With at least one WM, KDE
30163 2.1, Emacs is not getting any event for the raising of the frame
30164 (even tried with SubstructureRedirectMask), only Expose events.
30165 These expose events will draw text normally, i.e. not
30166 highlighted. Which means we must redo the highlight here.
30167 Subsume it under ``we love X''. --gerd 2001-08-15 */
30168 /* Included in Windows version because Windows most likely does not
30169 do the right thing if any third party tool offers
30170 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30171 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
30173 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30174 if (f
== hlinfo
->mouse_face_mouse_frame
)
30176 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
30177 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
30178 clear_mouse_face (hlinfo
);
30179 note_mouse_highlight (f
, mouse_x
, mouse_y
);
30186 Determine the intersection of two rectangles R1 and R2. Return
30187 the intersection in *RESULT. Value is non-zero if RESULT is not
30191 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
30193 XRectangle
*left
, *right
;
30194 XRectangle
*upper
, *lower
;
30195 int intersection_p
= 0;
30197 /* Rearrange so that R1 is the left-most rectangle. */
30199 left
= r1
, right
= r2
;
30201 left
= r2
, right
= r1
;
30203 /* X0 of the intersection is right.x0, if this is inside R1,
30204 otherwise there is no intersection. */
30205 if (right
->x
<= left
->x
+ left
->width
)
30207 result
->x
= right
->x
;
30209 /* The right end of the intersection is the minimum of
30210 the right ends of left and right. */
30211 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
30214 /* Same game for Y. */
30216 upper
= r1
, lower
= r2
;
30218 upper
= r2
, lower
= r1
;
30220 /* The upper end of the intersection is lower.y0, if this is inside
30221 of upper. Otherwise, there is no intersection. */
30222 if (lower
->y
<= upper
->y
+ upper
->height
)
30224 result
->y
= lower
->y
;
30226 /* The lower end of the intersection is the minimum of the lower
30227 ends of upper and lower. */
30228 result
->height
= (min (lower
->y
+ lower
->height
,
30229 upper
->y
+ upper
->height
)
30231 intersection_p
= 1;
30235 return intersection_p
;
30238 #endif /* HAVE_WINDOW_SYSTEM */
30241 /***********************************************************************
30243 ***********************************************************************/
30246 syms_of_xdisp (void)
30248 Vwith_echo_area_save_vector
= Qnil
;
30249 staticpro (&Vwith_echo_area_save_vector
);
30251 Vmessage_stack
= Qnil
;
30252 staticpro (&Vmessage_stack
);
30254 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30255 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30257 message_dolog_marker1
= Fmake_marker ();
30258 staticpro (&message_dolog_marker1
);
30259 message_dolog_marker2
= Fmake_marker ();
30260 staticpro (&message_dolog_marker2
);
30261 message_dolog_marker3
= Fmake_marker ();
30262 staticpro (&message_dolog_marker3
);
30265 defsubr (&Sdump_frame_glyph_matrix
);
30266 defsubr (&Sdump_glyph_matrix
);
30267 defsubr (&Sdump_glyph_row
);
30268 defsubr (&Sdump_tool_bar_row
);
30269 defsubr (&Strace_redisplay
);
30270 defsubr (&Strace_to_stderr
);
30272 #ifdef HAVE_WINDOW_SYSTEM
30273 defsubr (&Stool_bar_height
);
30274 defsubr (&Slookup_image_map
);
30276 defsubr (&Sline_pixel_height
);
30277 defsubr (&Sformat_mode_line
);
30278 defsubr (&Sinvisible_p
);
30279 defsubr (&Scurrent_bidi_paragraph_direction
);
30280 defsubr (&Swindow_text_pixel_size
);
30281 defsubr (&Smove_point_visually
);
30283 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30284 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30285 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30286 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30287 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30288 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30289 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30290 DEFSYM (Qeval
, "eval");
30291 DEFSYM (QCdata
, ":data");
30292 DEFSYM (Qdisplay
, "display");
30293 DEFSYM (Qspace_width
, "space-width");
30294 DEFSYM (Qraise
, "raise");
30295 DEFSYM (Qslice
, "slice");
30296 DEFSYM (Qspace
, "space");
30297 DEFSYM (Qmargin
, "margin");
30298 DEFSYM (Qpointer
, "pointer");
30299 DEFSYM (Qleft_margin
, "left-margin");
30300 DEFSYM (Qright_margin
, "right-margin");
30301 DEFSYM (Qcenter
, "center");
30302 DEFSYM (Qline_height
, "line-height");
30303 DEFSYM (QCalign_to
, ":align-to");
30304 DEFSYM (QCrelative_width
, ":relative-width");
30305 DEFSYM (QCrelative_height
, ":relative-height");
30306 DEFSYM (QCeval
, ":eval");
30307 DEFSYM (QCpropertize
, ":propertize");
30308 DEFSYM (QCfile
, ":file");
30309 DEFSYM (Qfontified
, "fontified");
30310 DEFSYM (Qfontification_functions
, "fontification-functions");
30311 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30312 DEFSYM (Qescape_glyph
, "escape-glyph");
30313 DEFSYM (Qnobreak_space
, "nobreak-space");
30314 DEFSYM (Qimage
, "image");
30315 DEFSYM (Qtext
, "text");
30316 DEFSYM (Qboth
, "both");
30317 DEFSYM (Qboth_horiz
, "both-horiz");
30318 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30319 DEFSYM (QCmap
, ":map");
30320 DEFSYM (QCpointer
, ":pointer");
30321 DEFSYM (Qrect
, "rect");
30322 DEFSYM (Qcircle
, "circle");
30323 DEFSYM (Qpoly
, "poly");
30324 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
30325 DEFSYM (Qgrow_only
, "grow-only");
30326 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30327 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30328 DEFSYM (Qposition
, "position");
30329 DEFSYM (Qbuffer_position
, "buffer-position");
30330 DEFSYM (Qobject
, "object");
30331 DEFSYM (Qbar
, "bar");
30332 DEFSYM (Qhbar
, "hbar");
30333 DEFSYM (Qbox
, "box");
30334 DEFSYM (Qhollow
, "hollow");
30335 DEFSYM (Qhand
, "hand");
30336 DEFSYM (Qarrow
, "arrow");
30337 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30339 list_of_error
= list1 (list2 (intern_c_string ("error"),
30340 intern_c_string ("void-variable")));
30341 staticpro (&list_of_error
);
30343 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30344 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30345 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30346 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30348 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30349 staticpro (&echo_buffer
[0]);
30350 staticpro (&echo_buffer
[1]);
30352 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30353 staticpro (&echo_area_buffer
[0]);
30354 staticpro (&echo_area_buffer
[1]);
30356 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30357 staticpro (&Vmessages_buffer_name
);
30359 mode_line_proptrans_alist
= Qnil
;
30360 staticpro (&mode_line_proptrans_alist
);
30361 mode_line_string_list
= Qnil
;
30362 staticpro (&mode_line_string_list
);
30363 mode_line_string_face
= Qnil
;
30364 staticpro (&mode_line_string_face
);
30365 mode_line_string_face_prop
= Qnil
;
30366 staticpro (&mode_line_string_face_prop
);
30367 Vmode_line_unwind_vector
= Qnil
;
30368 staticpro (&Vmode_line_unwind_vector
);
30370 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30372 help_echo_string
= Qnil
;
30373 staticpro (&help_echo_string
);
30374 help_echo_object
= Qnil
;
30375 staticpro (&help_echo_object
);
30376 help_echo_window
= Qnil
;
30377 staticpro (&help_echo_window
);
30378 previous_help_echo_string
= Qnil
;
30379 staticpro (&previous_help_echo_string
);
30380 help_echo_pos
= -1;
30382 DEFSYM (Qright_to_left
, "right-to-left");
30383 DEFSYM (Qleft_to_right
, "left-to-right");
30385 #ifdef HAVE_WINDOW_SYSTEM
30386 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30387 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30388 For example, if a block cursor is over a tab, it will be drawn as
30389 wide as that tab on the display. */);
30390 x_stretch_cursor_p
= 0;
30393 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30394 doc
: /* Non-nil means highlight trailing whitespace.
30395 The face used for trailing whitespace is `trailing-whitespace'. */);
30396 Vshow_trailing_whitespace
= Qnil
;
30398 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30399 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30400 If the value is t, Emacs highlights non-ASCII chars which have the
30401 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30402 or `escape-glyph' face respectively.
30404 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30405 U+2011 (non-breaking hyphen) are affected.
30407 Any other non-nil value means to display these characters as a escape
30408 glyph followed by an ordinary space or hyphen.
30410 A value of nil means no special handling of these characters. */);
30411 Vnobreak_char_display
= Qt
;
30413 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30414 doc
: /* The pointer shape to show in void text areas.
30415 A value of nil means to show the text pointer. Other options are `arrow',
30416 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
30417 Vvoid_text_area_pointer
= Qarrow
;
30419 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30420 doc
: /* Non-nil means don't actually do any redisplay.
30421 This is used for internal purposes. */);
30422 Vinhibit_redisplay
= Qnil
;
30424 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30425 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30426 Vglobal_mode_string
= Qnil
;
30428 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30429 doc
: /* Marker for where to display an arrow on top of the buffer text.
30430 This must be the beginning of a line in order to work.
30431 See also `overlay-arrow-string'. */);
30432 Voverlay_arrow_position
= Qnil
;
30434 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30435 doc
: /* String to display as an arrow in non-window frames.
30436 See also `overlay-arrow-position'. */);
30437 Voverlay_arrow_string
= build_pure_c_string ("=>");
30439 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30440 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30441 The symbols on this list are examined during redisplay to determine
30442 where to display overlay arrows. */);
30443 Voverlay_arrow_variable_list
30444 = list1 (intern_c_string ("overlay-arrow-position"));
30446 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30447 doc
: /* The number of lines to try scrolling a window by when point moves out.
30448 If that fails to bring point back on frame, point is centered instead.
30449 If this is zero, point is always centered after it moves off frame.
30450 If you want scrolling to always be a line at a time, you should set
30451 `scroll-conservatively' to a large value rather than set this to 1. */);
30453 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30454 doc
: /* Scroll up to this many lines, to bring point back on screen.
30455 If point moves off-screen, redisplay will scroll by up to
30456 `scroll-conservatively' lines in order to bring point just barely
30457 onto the screen again. If that cannot be done, then redisplay
30458 recenters point as usual.
30460 If the value is greater than 100, redisplay will never recenter point,
30461 but will always scroll just enough text to bring point into view, even
30462 if you move far away.
30464 A value of zero means always recenter point if it moves off screen. */);
30465 scroll_conservatively
= 0;
30467 DEFVAR_INT ("scroll-margin", scroll_margin
,
30468 doc
: /* Number of lines of margin at the top and bottom of a window.
30469 Recenter the window whenever point gets within this many lines
30470 of the top or bottom of the window. */);
30473 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
30474 doc
: /* Pixels per inch value for non-window system displays.
30475 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30476 Vdisplay_pixels_per_inch
= make_float (72.0);
30479 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
30482 DEFVAR_LISP ("truncate-partial-width-windows",
30483 Vtruncate_partial_width_windows
,
30484 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
30485 For an integer value, truncate lines in each window narrower than the
30486 full frame width, provided the window width is less than that integer;
30487 otherwise, respect the value of `truncate-lines'.
30489 For any other non-nil value, truncate lines in all windows that do
30490 not span the full frame width.
30492 A value of nil means to respect the value of `truncate-lines'.
30494 If `word-wrap' is enabled, you might want to reduce this. */);
30495 Vtruncate_partial_width_windows
= make_number (50);
30497 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
30498 doc
: /* Maximum buffer size for which line number should be displayed.
30499 If the buffer is bigger than this, the line number does not appear
30500 in the mode line. A value of nil means no limit. */);
30501 Vline_number_display_limit
= Qnil
;
30503 DEFVAR_INT ("line-number-display-limit-width",
30504 line_number_display_limit_width
,
30505 doc
: /* Maximum line width (in characters) for line number display.
30506 If the average length of the lines near point is bigger than this, then the
30507 line number may be omitted from the mode line. */);
30508 line_number_display_limit_width
= 200;
30510 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
30511 doc
: /* Non-nil means highlight region even in nonselected windows. */);
30512 highlight_nonselected_windows
= 0;
30514 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
30515 doc
: /* Non-nil if more than one frame is visible on this display.
30516 Minibuffer-only frames don't count, but iconified frames do.
30517 This variable is not guaranteed to be accurate except while processing
30518 `frame-title-format' and `icon-title-format'. */);
30520 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
30521 doc
: /* Template for displaying the title bar of visible frames.
30522 \(Assuming the window manager supports this feature.)
30524 This variable has the same structure as `mode-line-format', except that
30525 the %c and %l constructs are ignored. It is used only on frames for
30526 which no explicit name has been set \(see `modify-frame-parameters'). */);
30528 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
30529 doc
: /* Template for displaying the title bar of an iconified frame.
30530 \(Assuming the window manager supports this feature.)
30531 This variable has the same structure as `mode-line-format' (which see),
30532 and is used only on frames for which no explicit name has been set
30533 \(see `modify-frame-parameters'). */);
30535 = Vframe_title_format
30536 = listn (CONSTYPE_PURE
, 3,
30537 intern_c_string ("multiple-frames"),
30538 build_pure_c_string ("%b"),
30539 listn (CONSTYPE_PURE
, 4,
30540 empty_unibyte_string
,
30541 intern_c_string ("invocation-name"),
30542 build_pure_c_string ("@"),
30543 intern_c_string ("system-name")));
30545 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
30546 doc
: /* Maximum number of lines to keep in the message log buffer.
30547 If nil, disable message logging. If t, log messages but don't truncate
30548 the buffer when it becomes large. */);
30549 Vmessage_log_max
= make_number (1000);
30551 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
30552 doc
: /* Functions called before redisplay, if window sizes have changed.
30553 The value should be a list of functions that take one argument.
30554 Just before redisplay, for each frame, if any of its windows have changed
30555 size since the last redisplay, or have been split or deleted,
30556 all the functions in the list are called, with the frame as argument. */);
30557 Vwindow_size_change_functions
= Qnil
;
30559 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
30560 doc
: /* List of functions to call before redisplaying a window with scrolling.
30561 Each function is called with two arguments, the window and its new
30562 display-start position. Note that these functions are also called by
30563 `set-window-buffer'. Also note that the value of `window-end' is not
30564 valid when these functions are called.
30566 Warning: Do not use this feature to alter the way the window
30567 is scrolled. It is not designed for that, and such use probably won't
30569 Vwindow_scroll_functions
= Qnil
;
30571 DEFVAR_LISP ("window-text-change-functions",
30572 Vwindow_text_change_functions
,
30573 doc
: /* Functions to call in redisplay when text in the window might change. */);
30574 Vwindow_text_change_functions
= Qnil
;
30576 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
30577 doc
: /* Functions called when redisplay of a window reaches the end trigger.
30578 Each function is called with two arguments, the window and the end trigger value.
30579 See `set-window-redisplay-end-trigger'. */);
30580 Vredisplay_end_trigger_functions
= Qnil
;
30582 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
30583 doc
: /* Non-nil means autoselect window with mouse pointer.
30584 If nil, do not autoselect windows.
30585 A positive number means delay autoselection by that many seconds: a
30586 window is autoselected only after the mouse has remained in that
30587 window for the duration of the delay.
30588 A negative number has a similar effect, but causes windows to be
30589 autoselected only after the mouse has stopped moving. \(Because of
30590 the way Emacs compares mouse events, you will occasionally wait twice
30591 that time before the window gets selected.\)
30592 Any other value means to autoselect window instantaneously when the
30593 mouse pointer enters it.
30595 Autoselection selects the minibuffer only if it is active, and never
30596 unselects the minibuffer if it is active.
30598 When customizing this variable make sure that the actual value of
30599 `focus-follows-mouse' matches the behavior of your window manager. */);
30600 Vmouse_autoselect_window
= Qnil
;
30602 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
30603 doc
: /* Non-nil means automatically resize tool-bars.
30604 This dynamically changes the tool-bar's height to the minimum height
30605 that is needed to make all tool-bar items visible.
30606 If value is `grow-only', the tool-bar's height is only increased
30607 automatically; to decrease the tool-bar height, use \\[recenter]. */);
30608 Vauto_resize_tool_bars
= Qt
;
30610 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
30611 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
30612 auto_raise_tool_bar_buttons_p
= 1;
30614 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
30615 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
30616 make_cursor_line_fully_visible_p
= 1;
30618 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
30619 doc
: /* Border below tool-bar in pixels.
30620 If an integer, use it as the height of the border.
30621 If it is one of `internal-border-width' or `border-width', use the
30622 value of the corresponding frame parameter.
30623 Otherwise, no border is added below the tool-bar. */);
30624 Vtool_bar_border
= Qinternal_border_width
;
30626 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
30627 doc
: /* Margin around tool-bar buttons in pixels.
30628 If an integer, use that for both horizontal and vertical margins.
30629 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
30630 HORZ specifying the horizontal margin, and VERT specifying the
30631 vertical margin. */);
30632 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
30634 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
30635 doc
: /* Relief thickness of tool-bar buttons. */);
30636 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
30638 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
30639 doc
: /* Tool bar style to use.
30641 image - show images only
30642 text - show text only
30643 both - show both, text below image
30644 both-horiz - show text to the right of the image
30645 text-image-horiz - show text to the left of the image
30646 any other - use system default or image if no system default.
30648 This variable only affects the GTK+ toolkit version of Emacs. */);
30649 Vtool_bar_style
= Qnil
;
30651 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
30652 doc
: /* Maximum number of characters a label can have to be shown.
30653 The tool bar style must also show labels for this to have any effect, see
30654 `tool-bar-style'. */);
30655 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
30657 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
30658 doc
: /* List of functions to call to fontify regions of text.
30659 Each function is called with one argument POS. Functions must
30660 fontify a region starting at POS in the current buffer, and give
30661 fontified regions the property `fontified'. */);
30662 Vfontification_functions
= Qnil
;
30663 Fmake_variable_buffer_local (Qfontification_functions
);
30665 DEFVAR_BOOL ("unibyte-display-via-language-environment",
30666 unibyte_display_via_language_environment
,
30667 doc
: /* Non-nil means display unibyte text according to language environment.
30668 Specifically, this means that raw bytes in the range 160-255 decimal
30669 are displayed by converting them to the equivalent multibyte characters
30670 according to the current language environment. As a result, they are
30671 displayed according to the current fontset.
30673 Note that this variable affects only how these bytes are displayed,
30674 but does not change the fact they are interpreted as raw bytes. */);
30675 unibyte_display_via_language_environment
= 0;
30677 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
30678 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
30679 If a float, it specifies a fraction of the mini-window frame's height.
30680 If an integer, it specifies a number of lines. */);
30681 Vmax_mini_window_height
= make_float (0.25);
30683 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
30684 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
30685 A value of nil means don't automatically resize mini-windows.
30686 A value of t means resize them to fit the text displayed in them.
30687 A value of `grow-only', the default, means let mini-windows grow only;
30688 they return to their normal size when the minibuffer is closed, or the
30689 echo area becomes empty. */);
30690 Vresize_mini_windows
= Qgrow_only
;
30692 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
30693 doc
: /* Alist specifying how to blink the cursor off.
30694 Each element has the form (ON-STATE . OFF-STATE). Whenever the
30695 `cursor-type' frame-parameter or variable equals ON-STATE,
30696 comparing using `equal', Emacs uses OFF-STATE to specify
30697 how to blink it off. ON-STATE and OFF-STATE are values for
30698 the `cursor-type' frame parameter.
30700 If a frame's ON-STATE has no entry in this list,
30701 the frame's other specifications determine how to blink the cursor off. */);
30702 Vblink_cursor_alist
= Qnil
;
30704 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
30705 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
30706 If non-nil, windows are automatically scrolled horizontally to make
30707 point visible. */);
30708 automatic_hscrolling_p
= 1;
30709 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
30711 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
30712 doc
: /* How many columns away from the window edge point is allowed to get
30713 before automatic hscrolling will horizontally scroll the window. */);
30714 hscroll_margin
= 5;
30716 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
30717 doc
: /* How many columns to scroll the window when point gets too close to the edge.
30718 When point is less than `hscroll-margin' columns from the window
30719 edge, automatic hscrolling will scroll the window by the amount of columns
30720 determined by this variable. If its value is a positive integer, scroll that
30721 many columns. If it's a positive floating-point number, it specifies the
30722 fraction of the window's width to scroll. If it's nil or zero, point will be
30723 centered horizontally after the scroll. Any other value, including negative
30724 numbers, are treated as if the value were zero.
30726 Automatic hscrolling always moves point outside the scroll margin, so if
30727 point was more than scroll step columns inside the margin, the window will
30728 scroll more than the value given by the scroll step.
30730 Note that the lower bound for automatic hscrolling specified by `scroll-left'
30731 and `scroll-right' overrides this variable's effect. */);
30732 Vhscroll_step
= make_number (0);
30734 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
30735 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
30736 Bind this around calls to `message' to let it take effect. */);
30737 message_truncate_lines
= 0;
30739 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
30740 doc
: /* Normal hook run to update the menu bar definitions.
30741 Redisplay runs this hook before it redisplays the menu bar.
30742 This is used to update menus such as Buffers, whose contents depend on
30744 Vmenu_bar_update_hook
= Qnil
;
30746 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
30747 doc
: /* Frame for which we are updating a menu.
30748 The enable predicate for a menu binding should check this variable. */);
30749 Vmenu_updating_frame
= Qnil
;
30751 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
30752 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
30753 inhibit_menubar_update
= 0;
30755 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
30756 doc
: /* Prefix prepended to all continuation lines at display time.
30757 The value may be a string, an image, or a stretch-glyph; it is
30758 interpreted in the same way as the value of a `display' text property.
30760 This variable is overridden by any `wrap-prefix' text or overlay
30763 To add a prefix to non-continuation lines, use `line-prefix'. */);
30764 Vwrap_prefix
= Qnil
;
30765 DEFSYM (Qwrap_prefix
, "wrap-prefix");
30766 Fmake_variable_buffer_local (Qwrap_prefix
);
30768 DEFVAR_LISP ("line-prefix", Vline_prefix
,
30769 doc
: /* Prefix prepended to all non-continuation lines at display time.
30770 The value may be a string, an image, or a stretch-glyph; it is
30771 interpreted in the same way as the value of a `display' text property.
30773 This variable is overridden by any `line-prefix' text or overlay
30776 To add a prefix to continuation lines, use `wrap-prefix'. */);
30777 Vline_prefix
= Qnil
;
30778 DEFSYM (Qline_prefix
, "line-prefix");
30779 Fmake_variable_buffer_local (Qline_prefix
);
30781 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
30782 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
30783 inhibit_eval_during_redisplay
= 0;
30785 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
30786 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
30787 inhibit_free_realized_faces
= 0;
30790 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
30791 doc
: /* Inhibit try_window_id display optimization. */);
30792 inhibit_try_window_id
= 0;
30794 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
30795 doc
: /* Inhibit try_window_reusing display optimization. */);
30796 inhibit_try_window_reusing
= 0;
30798 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
30799 doc
: /* Inhibit try_cursor_movement display optimization. */);
30800 inhibit_try_cursor_movement
= 0;
30801 #endif /* GLYPH_DEBUG */
30803 DEFVAR_INT ("overline-margin", overline_margin
,
30804 doc
: /* Space between overline and text, in pixels.
30805 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
30806 margin to the character height. */);
30807 overline_margin
= 2;
30809 DEFVAR_INT ("underline-minimum-offset",
30810 underline_minimum_offset
,
30811 doc
: /* Minimum distance between baseline and underline.
30812 This can improve legibility of underlined text at small font sizes,
30813 particularly when using variable `x-use-underline-position-properties'
30814 with fonts that specify an UNDERLINE_POSITION relatively close to the
30815 baseline. The default value is 1. */);
30816 underline_minimum_offset
= 1;
30818 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
30819 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
30820 This feature only works when on a window system that can change
30821 cursor shapes. */);
30822 display_hourglass_p
= 1;
30824 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
30825 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
30826 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
30828 #ifdef HAVE_WINDOW_SYSTEM
30829 hourglass_atimer
= NULL
;
30830 hourglass_shown_p
= 0;
30831 #endif /* HAVE_WINDOW_SYSTEM */
30833 DEFSYM (Qglyphless_char
, "glyphless-char");
30834 DEFSYM (Qhex_code
, "hex-code");
30835 DEFSYM (Qempty_box
, "empty-box");
30836 DEFSYM (Qthin_space
, "thin-space");
30837 DEFSYM (Qzero_width
, "zero-width");
30839 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
30840 doc
: /* Function run just before redisplay.
30841 It is called with one argument, which is the set of windows that are to
30842 be redisplayed. This set can be nil (meaning, only the selected window),
30843 or t (meaning all windows). */);
30844 Vpre_redisplay_function
= intern ("ignore");
30846 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
30847 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
30849 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
30850 doc
: /* Char-table defining glyphless characters.
30851 Each element, if non-nil, should be one of the following:
30852 an ASCII acronym string: display this string in a box
30853 `hex-code': display the hexadecimal code of a character in a box
30854 `empty-box': display as an empty box
30855 `thin-space': display as 1-pixel width space
30856 `zero-width': don't display
30857 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
30858 display method for graphical terminals and text terminals respectively.
30859 GRAPHICAL and TEXT should each have one of the values listed above.
30861 The char-table has one extra slot to control the display of a character for
30862 which no font is found. This slot only takes effect on graphical terminals.
30863 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
30864 `thin-space'. The default is `empty-box'.
30866 If a character has a non-nil entry in an active display table, the
30867 display table takes effect; in this case, Emacs does not consult
30868 `glyphless-char-display' at all. */);
30869 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
30870 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
30873 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
30874 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
30875 Vdebug_on_message
= Qnil
;
30877 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
30879 Vredisplay__all_windows_cause
30880 = Fmake_vector (make_number (100), make_number (0));
30882 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
30884 Vredisplay__mode_lines_cause
30885 = Fmake_vector (make_number (100), make_number (0));
30889 /* Initialize this module when Emacs starts. */
30894 CHARPOS (this_line_start_pos
) = 0;
30896 if (!noninteractive
)
30898 struct window
*m
= XWINDOW (minibuf_window
);
30899 Lisp_Object frame
= m
->frame
;
30900 struct frame
*f
= XFRAME (frame
);
30901 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
30902 struct window
*r
= XWINDOW (root
);
30905 echo_area_window
= minibuf_window
;
30907 r
->top_line
= FRAME_TOP_MARGIN (f
);
30908 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
30909 r
->total_cols
= FRAME_COLS (f
);
30910 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30911 r
->total_lines
= FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
30912 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
30914 m
->top_line
= FRAME_LINES (f
) - 1;
30915 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
30916 m
->total_cols
= FRAME_COLS (f
);
30917 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30918 m
->total_lines
= 1;
30919 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
30921 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
30922 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
30923 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
30925 /* The default ellipsis glyphs `...'. */
30926 for (i
= 0; i
< 3; ++i
)
30927 default_invis_vector
[i
] = make_number ('.');
30931 /* Allocate the buffer for frame titles.
30932 Also used for `format-mode-line'. */
30934 mode_line_noprop_buf
= xmalloc (size
);
30935 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
30936 mode_line_noprop_ptr
= mode_line_noprop_buf
;
30937 mode_line_target
= MODE_LINE_DISPLAY
;
30940 help_echo_showing_p
= 0;
30943 #ifdef HAVE_WINDOW_SYSTEM
30945 /* Platform-independent portion of hourglass implementation. */
30947 /* Cancel a currently active hourglass timer, and start a new one. */
30949 start_hourglass (void)
30951 struct timespec delay
;
30953 cancel_hourglass ();
30955 if (INTEGERP (Vhourglass_delay
)
30956 && XINT (Vhourglass_delay
) > 0)
30957 delay
= make_timespec (min (XINT (Vhourglass_delay
),
30958 TYPE_MAXIMUM (time_t)),
30960 else if (FLOATP (Vhourglass_delay
)
30961 && XFLOAT_DATA (Vhourglass_delay
) > 0)
30962 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
30964 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
30968 extern void w32_note_current_window (void);
30969 w32_note_current_window ();
30971 #endif /* HAVE_NTGUI */
30973 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
30974 show_hourglass
, NULL
);
30978 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
30981 cancel_hourglass (void)
30983 if (hourglass_atimer
)
30985 cancel_atimer (hourglass_atimer
);
30986 hourglass_atimer
= NULL
;
30989 if (hourglass_shown_p
)
30993 #endif /* HAVE_WINDOW_SYSTEM */