1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2015 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
;
1408 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1411 if (XBUFFER (w
->contents
) != current_buffer
)
1413 old_buffer
= current_buffer
;
1414 set_buffer_internal_1 (XBUFFER (w
->contents
));
1417 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1418 /* Scrolling a minibuffer window via scroll bar when the echo area
1419 shows long text sometimes resets the minibuffer contents behind
1421 if (CHARPOS (top
) > ZV
)
1422 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1424 /* Compute exact mode line heights. */
1425 if (WINDOW_WANTS_MODELINE_P (w
))
1427 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1428 BVAR (current_buffer
, mode_line_format
));
1430 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1431 w
->header_line_height
1432 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1433 BVAR (current_buffer
, header_line_format
));
1435 start_display (&it
, w
, top
);
1436 move_it_to (&it
, charpos
, -1, it
.last_visible_y
- 1, -1,
1437 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1440 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
!= -1)
1441 && IT_CHARPOS (it
) >= charpos
)
1442 /* When scanning backwards under bidi iteration, move_it_to
1443 stops at or _before_ CHARPOS, because it stops at or to
1444 the _right_ of the character at CHARPOS. */
1445 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1446 && IT_CHARPOS (it
) <= charpos
)))
1448 /* We have reached CHARPOS, or passed it. How the call to
1449 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1450 or covered by a display property, move_it_to stops at the end
1451 of the invisible text, to the right of CHARPOS. (ii) If
1452 CHARPOS is in a display vector, move_it_to stops on its last
1454 int top_x
= it
.current_x
;
1455 int top_y
= it
.current_y
;
1456 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1459 void *save_it_data
= NULL
;
1461 /* Calling line_bottom_y may change it.method, it.position, etc. */
1462 SAVE_IT (save_it
, it
, save_it_data
);
1464 bottom_y
= line_bottom_y (&it
);
1465 if (top_y
< window_top_y
)
1466 visible_p
= bottom_y
> window_top_y
;
1467 else if (top_y
< it
.last_visible_y
)
1469 if (bottom_y
>= it
.last_visible_y
1470 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1471 && IT_CHARPOS (it
) < charpos
)
1473 /* When the last line of the window is scanned backwards
1474 under bidi iteration, we could be duped into thinking
1475 that we have passed CHARPOS, when in fact move_it_to
1476 simply stopped short of CHARPOS because it reached
1477 last_visible_y. To see if that's what happened, we call
1478 move_it_to again with a slightly larger vertical limit,
1479 and see if it actually moved vertically; if it did, we
1480 didn't really reach CHARPOS, which is beyond window end. */
1481 /* Why 10? because we don't know how many canonical lines
1482 will the height of the next line(s) be. So we guess. */
1483 int ten_more_lines
= 10 * default_line_pixel_height (w
);
1485 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1486 MOVE_TO_POS
| MOVE_TO_Y
);
1487 if (it
.current_y
> top_y
)
1491 RESTORE_IT (&it
, &save_it
, save_it_data
);
1494 if (it
.method
== GET_FROM_DISPLAY_VECTOR
)
1496 /* We stopped on the last glyph of a display vector.
1497 Try and recompute. Hack alert! */
1498 if (charpos
< 2 || top
.charpos
>= charpos
)
1499 top_x
= it
.glyph_row
->x
;
1502 struct it it2
, it2_prev
;
1503 /* The idea is to get to the previous buffer
1504 position, consume the character there, and use
1505 the pixel coordinates we get after that. But if
1506 the previous buffer position is also displayed
1507 from a display vector, we need to consume all of
1508 the glyphs from that display vector. */
1509 start_display (&it2
, w
, top
);
1510 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1511 /* If we didn't get to CHARPOS - 1, there's some
1512 replacing display property at that position, and
1513 we stopped after it. That is exactly the place
1514 whose coordinates we want. */
1515 if (IT_CHARPOS (it2
) != charpos
- 1)
1519 /* Iterate until we get out of the display
1520 vector that displays the character at
1523 get_next_display_element (&it2
);
1524 PRODUCE_GLYPHS (&it2
);
1526 set_iterator_to_next (&it2
, 1);
1527 } while (it2
.method
== GET_FROM_DISPLAY_VECTOR
1528 && IT_CHARPOS (it2
) < charpos
);
1530 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev
)
1531 || it2_prev
.current_x
> it2_prev
.last_visible_x
)
1532 top_x
= it
.glyph_row
->x
;
1535 top_x
= it2_prev
.current_x
;
1536 top_y
= it2_prev
.current_y
;
1540 else if (IT_CHARPOS (it
) != charpos
)
1542 Lisp_Object cpos
= make_number (charpos
);
1543 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1544 Lisp_Object string
= string_from_display_spec (spec
);
1545 struct text_pos tpos
;
1546 int replacing_spec_p
;
1547 bool newline_in_string
1549 && memchr (SDATA (string
), '\n', SBYTES (string
)));
1551 SET_TEXT_POS (tpos
, charpos
, CHAR_TO_BYTE (charpos
));
1554 && handle_display_spec (NULL
, spec
, Qnil
, Qnil
, &tpos
,
1555 charpos
, FRAME_WINDOW_P (it
.f
)));
1556 /* The tricky code below is needed because there's a
1557 discrepancy between move_it_to and how we set cursor
1558 when PT is at the beginning of a portion of text
1559 covered by a display property or an overlay with a
1560 display property, or the display line ends in a
1561 newline from a display string. move_it_to will stop
1562 _after_ such display strings, whereas
1563 set_cursor_from_row conspires with cursor_row_p to
1564 place the cursor on the first glyph produced from the
1567 /* We have overshoot PT because it is covered by a
1568 display property that replaces the text it covers.
1569 If the string includes embedded newlines, we are also
1570 in the wrong display line. Backtrack to the correct
1571 line, where the display property begins. */
1572 if (replacing_spec_p
)
1574 Lisp_Object startpos
, endpos
;
1575 EMACS_INT start
, end
;
1579 /* Find the first and the last buffer positions
1580 covered by the display string. */
1582 Fnext_single_char_property_change (cpos
, Qdisplay
,
1585 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1587 start
= XFASTINT (startpos
);
1588 end
= XFASTINT (endpos
);
1589 /* Move to the last buffer position before the
1590 display property. */
1591 start_display (&it3
, w
, top
);
1592 if (start
> CHARPOS (top
))
1593 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1594 /* Move forward one more line if the position before
1595 the display string is a newline or if it is the
1596 rightmost character on a line that is
1597 continued or word-wrapped. */
1598 if (it3
.method
== GET_FROM_BUFFER
1600 || FETCH_BYTE (IT_BYTEPOS (it3
)) == '\n'))
1601 move_it_by_lines (&it3
, 1);
1602 else if (move_it_in_display_line_to (&it3
, -1,
1606 == MOVE_LINE_CONTINUED
)
1608 move_it_by_lines (&it3
, 1);
1609 /* When we are under word-wrap, the #$@%!
1610 move_it_by_lines moves 2 lines, so we need to
1612 if (it3
.line_wrap
== WORD_WRAP
)
1613 move_it_by_lines (&it3
, -1);
1616 /* Record the vertical coordinate of the display
1617 line where we wound up. */
1618 top_y
= it3
.current_y
;
1621 /* When characters are reordered for display,
1622 the character displayed to the left of the
1623 display string could be _after_ the display
1624 property in the logical order. Use the
1625 smallest vertical position of these two. */
1626 start_display (&it3
, w
, top
);
1627 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1628 if (it3
.current_y
< top_y
)
1629 top_y
= it3
.current_y
;
1631 /* Move from the top of the window to the beginning
1632 of the display line where the display string
1634 start_display (&it3
, w
, top
);
1635 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1636 /* If it3_moved stays zero after the 'while' loop
1637 below, that means we already were at a newline
1638 before the loop (e.g., the display string begins
1639 with a newline), so we don't need to (and cannot)
1640 inspect the glyphs of it3.glyph_row, because
1641 PRODUCE_GLYPHS will not produce anything for a
1642 newline, and thus it3.glyph_row stays at its
1643 stale content it got at top of the window. */
1645 /* Finally, advance the iterator until we hit the
1646 first display element whose character position is
1647 CHARPOS, or until the first newline from the
1648 display string, which signals the end of the
1650 while (get_next_display_element (&it3
))
1652 PRODUCE_GLYPHS (&it3
);
1653 if (IT_CHARPOS (it3
) == charpos
1654 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1657 set_iterator_to_next (&it3
, 0);
1659 top_x
= it3
.current_x
- it3
.pixel_width
;
1660 /* Normally, we would exit the above loop because we
1661 found the display element whose character
1662 position is CHARPOS. For the contingency that we
1663 didn't, and stopped at the first newline from the
1664 display string, move back over the glyphs
1665 produced from the string, until we find the
1666 rightmost glyph not from the string. */
1668 && newline_in_string
1669 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1671 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1672 + it3
.glyph_row
->used
[TEXT_AREA
];
1674 while (EQ ((g
- 1)->object
, string
))
1677 top_x
-= g
->pixel_width
;
1679 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1680 + it3
.glyph_row
->used
[TEXT_AREA
]);
1686 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1687 *rtop
= max (0, window_top_y
- top_y
);
1688 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1689 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1690 - max (top_y
, window_top_y
)));
1692 if (it
.bidi_it
.paragraph_dir
== R2L
)
1698 /* Either we were asked to provide info about WINDOW_END, or
1699 CHARPOS is in the partially visible glyph row at end of
1702 void *it2data
= NULL
;
1704 SAVE_IT (it2
, it
, it2data
);
1705 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1706 move_it_by_lines (&it
, 1);
1707 if (charpos
< IT_CHARPOS (it
)
1708 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1711 RESTORE_IT (&it2
, &it2
, it2data
);
1712 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1714 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1715 *rtop
= max (0, -it2
.current_y
);
1716 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1717 - it
.last_visible_y
));
1718 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1720 - max (it2
.current_y
,
1721 WINDOW_HEADER_LINE_HEIGHT (w
))));
1723 if (it2
.bidi_it
.paragraph_dir
== R2L
)
1727 bidi_unshelve_cache (it2data
, 1);
1729 bidi_unshelve_cache (itdata
, 0);
1732 set_buffer_internal_1 (old_buffer
);
1738 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1739 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1740 /* For lines in an R2L paragraph, we need to mirror the X pixel
1741 coordinate wrt the text area. For the reasons, see the
1742 commentary in buffer_posn_from_coords and the explanation of
1743 the geometry used by the move_it_* functions at the end of
1744 the large commentary near the beginning of this file. */
1746 *x
= window_box_width (w
, TEXT_AREA
) - *x
- 1;
1750 /* Debugging code. */
1752 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1753 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1755 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1762 /* Return the next character from STR. Return in *LEN the length of
1763 the character. This is like STRING_CHAR_AND_LENGTH but never
1764 returns an invalid character. If we find one, we return a `?', but
1765 with the length of the invalid character. */
1768 string_char_and_length (const unsigned char *str
, int *len
)
1772 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1773 if (!CHAR_VALID_P (c
))
1774 /* We may not change the length here because other places in Emacs
1775 don't use this function, i.e. they silently accept invalid
1784 /* Given a position POS containing a valid character and byte position
1785 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1787 static struct text_pos
1788 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1790 eassert (STRINGP (string
) && nchars
>= 0);
1792 if (STRING_MULTIBYTE (string
))
1794 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1799 string_char_and_length (p
, &len
);
1802 BYTEPOS (pos
) += len
;
1806 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1812 /* Value is the text position, i.e. character and byte position,
1813 for character position CHARPOS in STRING. */
1815 static struct text_pos
1816 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1818 struct text_pos pos
;
1819 eassert (STRINGP (string
));
1820 eassert (charpos
>= 0);
1821 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1826 /* Value is a text position, i.e. character and byte position, for
1827 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1828 means recognize multibyte characters. */
1830 static struct text_pos
1831 c_string_pos (ptrdiff_t charpos
, const char *s
, bool multibyte_p
)
1833 struct text_pos pos
;
1835 eassert (s
!= NULL
);
1836 eassert (charpos
>= 0);
1842 SET_TEXT_POS (pos
, 0, 0);
1845 string_char_and_length ((const unsigned char *) s
, &len
);
1848 BYTEPOS (pos
) += len
;
1852 SET_TEXT_POS (pos
, charpos
, charpos
);
1858 /* Value is the number of characters in C string S. MULTIBYTE_P
1859 non-zero means recognize multibyte characters. */
1862 number_of_chars (const char *s
, bool multibyte_p
)
1868 ptrdiff_t rest
= strlen (s
);
1870 const unsigned char *p
= (const unsigned char *) s
;
1872 for (nchars
= 0; rest
> 0; ++nchars
)
1874 string_char_and_length (p
, &len
);
1875 rest
-= len
, p
+= len
;
1879 nchars
= strlen (s
);
1885 /* Compute byte position NEWPOS->bytepos corresponding to
1886 NEWPOS->charpos. POS is a known position in string STRING.
1887 NEWPOS->charpos must be >= POS.charpos. */
1890 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1892 eassert (STRINGP (string
));
1893 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1895 if (STRING_MULTIBYTE (string
))
1896 *newpos
= string_pos_nchars_ahead (pos
, string
,
1897 CHARPOS (*newpos
) - CHARPOS (pos
));
1899 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1903 Return an estimation of the pixel height of mode or header lines on
1904 frame F. FACE_ID specifies what line's height to estimate. */
1907 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1909 #ifdef HAVE_WINDOW_SYSTEM
1910 if (FRAME_WINDOW_P (f
))
1912 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1914 /* This function is called so early when Emacs starts that the face
1915 cache and mode line face are not yet initialized. */
1916 if (FRAME_FACE_CACHE (f
))
1918 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1922 height
= FONT_HEIGHT (face
->font
);
1923 if (face
->box_line_width
> 0)
1924 height
+= 2 * face
->box_line_width
;
1935 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1936 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1937 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1938 not force the value into range. */
1941 pixel_to_glyph_coords (struct frame
*f
, register int pix_x
, register int pix_y
,
1942 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1945 #ifdef HAVE_WINDOW_SYSTEM
1946 if (FRAME_WINDOW_P (f
))
1948 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1949 even for negative values. */
1951 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1953 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1955 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1956 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1959 STORE_NATIVE_RECT (*bounds
,
1960 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1961 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1962 FRAME_COLUMN_WIDTH (f
) - 1,
1963 FRAME_LINE_HEIGHT (f
) - 1);
1965 /* PXW: Should we clip pixels before converting to columns/lines? */
1970 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1971 pix_x
= FRAME_TOTAL_COLS (f
);
1975 else if (pix_y
> FRAME_LINES (f
))
1976 pix_y
= FRAME_LINES (f
);
1986 /* Find the glyph under window-relative coordinates X/Y in window W.
1987 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1988 strings. Return in *HPOS and *VPOS the row and column number of
1989 the glyph found. Return in *AREA the glyph area containing X.
1990 Value is a pointer to the glyph found or null if X/Y is not on
1991 text, or we can't tell because W's current matrix is not up to
1994 static struct glyph
*
1995 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1996 int *dx
, int *dy
, int *area
)
1998 struct glyph
*glyph
, *end
;
1999 struct glyph_row
*row
= NULL
;
2002 /* Find row containing Y. Give up if some row is not enabled. */
2003 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
2005 row
= MATRIX_ROW (w
->current_matrix
, i
);
2006 if (!row
->enabled_p
)
2008 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
2015 /* Give up if Y is not in the window. */
2016 if (i
== w
->current_matrix
->nrows
)
2019 /* Get the glyph area containing X. */
2020 if (w
->pseudo_window_p
)
2027 if (x
< window_box_left_offset (w
, TEXT_AREA
))
2029 *area
= LEFT_MARGIN_AREA
;
2030 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
2032 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
2035 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
2039 *area
= RIGHT_MARGIN_AREA
;
2040 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
2044 /* Find glyph containing X. */
2045 glyph
= row
->glyphs
[*area
];
2046 end
= glyph
+ row
->used
[*area
];
2048 while (glyph
< end
&& x
>= glyph
->pixel_width
)
2050 x
-= glyph
->pixel_width
;
2060 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
2063 *hpos
= glyph
- row
->glyphs
[*area
];
2067 /* Convert frame-relative x/y to coordinates relative to window W.
2068 Takes pseudo-windows into account. */
2071 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
2073 if (w
->pseudo_window_p
)
2075 /* A pseudo-window is always full-width, and starts at the
2076 left edge of the frame, plus a frame border. */
2077 struct frame
*f
= XFRAME (w
->frame
);
2078 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
2079 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
2083 *x
-= WINDOW_LEFT_EDGE_X (w
);
2084 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
2088 #ifdef HAVE_WINDOW_SYSTEM
2091 Return in RECTS[] at most N clipping rectangles for glyph string S.
2092 Return the number of stored rectangles. */
2095 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
2102 if (s
->row
->full_width_p
)
2104 /* Draw full-width. X coordinates are relative to S->w->left_col. */
2105 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
2106 if (s
->row
->mode_line_p
)
2107 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
) - WINDOW_RIGHT_DIVIDER_WIDTH (s
->w
);
2109 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
);
2111 /* Unless displaying a mode or menu bar line, which are always
2112 fully visible, clip to the visible part of the row. */
2113 if (s
->w
->pseudo_window_p
)
2114 r
.height
= s
->row
->visible_height
;
2116 r
.height
= s
->height
;
2120 /* This is a text line that may be partially visible. */
2121 r
.x
= window_box_left (s
->w
, s
->area
);
2122 r
.width
= window_box_width (s
->w
, s
->area
);
2123 r
.height
= s
->row
->visible_height
;
2127 if (r
.x
< s
->clip_head
->x
)
2129 if (r
.width
>= s
->clip_head
->x
- r
.x
)
2130 r
.width
-= s
->clip_head
->x
- r
.x
;
2133 r
.x
= s
->clip_head
->x
;
2136 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
2138 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
2139 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
2144 /* If S draws overlapping rows, it's sufficient to use the top and
2145 bottom of the window for clipping because this glyph string
2146 intentionally draws over other lines. */
2147 if (s
->for_overlaps
)
2149 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2150 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2152 /* Alas, the above simple strategy does not work for the
2153 environments with anti-aliased text: if the same text is
2154 drawn onto the same place multiple times, it gets thicker.
2155 If the overlap we are processing is for the erased cursor, we
2156 take the intersection with the rectangle of the cursor. */
2157 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2159 XRectangle rc
, r_save
= r
;
2161 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2162 rc
.y
= s
->w
->phys_cursor
.y
;
2163 rc
.width
= s
->w
->phys_cursor_width
;
2164 rc
.height
= s
->w
->phys_cursor_height
;
2166 x_intersect_rectangles (&r_save
, &rc
, &r
);
2171 /* Don't use S->y for clipping because it doesn't take partially
2172 visible lines into account. For example, it can be negative for
2173 partially visible lines at the top of a window. */
2174 if (!s
->row
->full_width_p
2175 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2176 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2178 r
.y
= max (0, s
->row
->y
);
2181 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2183 /* If drawing the cursor, don't let glyph draw outside its
2184 advertised boundaries. Cleartype does this under some circumstances. */
2185 if (s
->hl
== DRAW_CURSOR
)
2187 struct glyph
*glyph
= s
->first_glyph
;
2192 r
.width
-= s
->x
- r
.x
;
2195 r
.width
= min (r
.width
, glyph
->pixel_width
);
2197 /* If r.y is below window bottom, ensure that we still see a cursor. */
2198 height
= min (glyph
->ascent
+ glyph
->descent
,
2199 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2200 max_y
= window_text_bottom_y (s
->w
) - height
;
2201 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2202 if (s
->ybase
- glyph
->ascent
> max_y
)
2209 /* Don't draw cursor glyph taller than our actual glyph. */
2210 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2211 if (height
< r
.height
)
2213 max_y
= r
.y
+ r
.height
;
2214 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2215 r
.height
= min (max_y
- r
.y
, height
);
2222 XRectangle r_save
= r
;
2224 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2228 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2229 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2231 #ifdef CONVERT_FROM_XRECT
2232 CONVERT_FROM_XRECT (r
, *rects
);
2240 /* If we are processing overlapping and allowed to return
2241 multiple clipping rectangles, we exclude the row of the glyph
2242 string from the clipping rectangle. This is to avoid drawing
2243 the same text on the environment with anti-aliasing. */
2244 #ifdef CONVERT_FROM_XRECT
2247 XRectangle
*rs
= rects
;
2249 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2251 if (s
->for_overlaps
& OVERLAPS_PRED
)
2254 if (r
.y
+ r
.height
> row_y
)
2257 rs
[i
].height
= row_y
- r
.y
;
2263 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2266 if (r
.y
< row_y
+ s
->row
->visible_height
)
2268 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2270 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2271 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2280 #ifdef CONVERT_FROM_XRECT
2281 for (i
= 0; i
< n
; i
++)
2282 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2289 Return in *NR the clipping rectangle for glyph string S. */
2292 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2294 get_glyph_string_clip_rects (s
, nr
, 1);
2299 Return the position and height of the phys cursor in window W.
2300 Set w->phys_cursor_width to width of phys cursor.
2304 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2305 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2307 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2308 int x
, y
, wd
, h
, h0
, y0
;
2310 /* Compute the width of the rectangle to draw. If on a stretch
2311 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2312 rectangle as wide as the glyph, but use a canonical character
2314 wd
= glyph
->pixel_width
- 1;
2315 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2319 x
= w
->phys_cursor
.x
;
2326 if (glyph
->type
== STRETCH_GLYPH
2327 && !x_stretch_cursor_p
)
2328 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2329 w
->phys_cursor_width
= wd
;
2331 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2333 /* If y is below window bottom, ensure that we still see a cursor. */
2334 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2336 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2337 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2339 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2342 h
= max (h
- (y0
- y
) + 1, h0
);
2347 y0
= window_text_bottom_y (w
) - h0
;
2355 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2356 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2361 * Remember which glyph the mouse is over.
2365 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2369 struct glyph_row
*r
, *gr
, *end_row
;
2370 enum window_part part
;
2371 enum glyph_row_area area
;
2372 int x
, y
, width
, height
;
2374 /* Try to determine frame pixel position and size of the glyph under
2375 frame pixel coordinates X/Y on frame F. */
2377 if (window_resize_pixelwise
)
2382 else if (!f
->glyphs_initialized_p
2383 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2386 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2387 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2391 w
= XWINDOW (window
);
2392 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2393 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2395 x
= window_relative_x_coord (w
, part
, gx
);
2396 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2398 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2399 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2401 if (w
->pseudo_window_p
)
2404 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2410 case ON_LEFT_MARGIN
:
2411 area
= LEFT_MARGIN_AREA
;
2414 case ON_RIGHT_MARGIN
:
2415 area
= RIGHT_MARGIN_AREA
;
2418 case ON_HEADER_LINE
:
2420 gr
= (part
== ON_HEADER_LINE
2421 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2422 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2425 goto text_glyph_row_found
;
2432 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2433 if (r
->y
+ r
->height
> y
)
2439 text_glyph_row_found
:
2442 struct glyph
*g
= gr
->glyphs
[area
];
2443 struct glyph
*end
= g
+ gr
->used
[area
];
2445 height
= gr
->height
;
2446 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2447 if (gx
+ g
->pixel_width
> x
)
2452 if (g
->type
== IMAGE_GLYPH
)
2454 /* Don't remember when mouse is over image, as
2455 image may have hot-spots. */
2456 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2459 width
= g
->pixel_width
;
2463 /* Use nominal char spacing at end of line. */
2465 gx
+= (x
/ width
) * width
;
2468 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2470 gx
+= window_box_left_offset (w
, area
);
2471 /* Don't expand over the modeline to make sure the vertical
2472 drag cursor is shown early enough. */
2473 height
= min (height
,
2474 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2479 /* Use nominal line height at end of window. */
2480 gx
= (x
/ width
) * width
;
2482 gy
+= (y
/ height
) * height
;
2483 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2484 /* See comment above. */
2485 height
= min (height
,
2486 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2490 case ON_LEFT_FRINGE
:
2491 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2492 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2493 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2494 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2497 case ON_RIGHT_FRINGE
:
2498 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2499 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2500 : window_box_right_offset (w
, TEXT_AREA
));
2501 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0
2502 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
2503 && !WINDOW_RIGHTMOST_P (w
))
2504 if (gx
< WINDOW_PIXEL_WIDTH (w
) - width
)
2505 /* Make sure the vertical border can get her own glyph to the
2506 right of the one we build here. */
2507 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
) - width
;
2509 width
= WINDOW_PIXEL_WIDTH (w
) - gx
;
2511 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2515 case ON_VERTICAL_BORDER
:
2516 gx
= WINDOW_PIXEL_WIDTH (w
) - width
;
2520 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2522 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2523 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2524 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2526 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2530 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2531 if (r
->y
+ r
->height
> y
)
2538 height
= gr
->height
;
2541 /* Use nominal line height at end of window. */
2543 gy
+= (y
/ height
) * height
;
2547 case ON_RIGHT_DIVIDER
:
2548 gx
= WINDOW_PIXEL_WIDTH (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2549 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2551 /* The bottom divider prevails. */
2552 height
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2555 case ON_BOTTOM_DIVIDER
:
2557 width
= WINDOW_PIXEL_WIDTH (w
);
2558 gy
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2559 height
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2565 /* If there is no glyph under the mouse, then we divide the screen
2566 into a grid of the smallest glyph in the frame, and use that
2569 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2570 round down even for negative values. */
2576 gx
= (gx
/ width
) * width
;
2577 gy
= (gy
/ height
) * height
;
2583 gx
+= WINDOW_LEFT_EDGE_X (w
);
2584 gy
+= WINDOW_TOP_EDGE_Y (w
);
2587 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2589 /* Visible feedback for debugging. */
2592 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2593 f
->output_data
.x
->normal_gc
,
2594 gx
, gy
, width
, height
);
2600 #endif /* HAVE_WINDOW_SYSTEM */
2603 adjust_window_ends (struct window
*w
, struct glyph_row
*row
, bool current
)
2606 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
2607 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
2609 = MATRIX_ROW_VPOS (row
, current
? w
->current_matrix
: w
->desired_matrix
);
2612 /***********************************************************************
2613 Lisp form evaluation
2614 ***********************************************************************/
2616 /* Error handler for safe_eval and safe_call. */
2619 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2621 add_to_log ("Error during redisplay: %S signaled %S",
2622 Flist (nargs
, args
), arg
);
2626 /* Call function FUNC with the rest of NARGS - 1 arguments
2627 following. Return the result, or nil if something went
2628 wrong. Prevent redisplay during the evaluation. */
2631 safe__call (bool inhibit_quit
, ptrdiff_t nargs
, Lisp_Object func
, va_list ap
)
2635 if (inhibit_eval_during_redisplay
)
2640 ptrdiff_t count
= SPECPDL_INDEX ();
2641 struct gcpro gcpro1
;
2642 Lisp_Object
*args
= alloca (nargs
* word_size
);
2645 for (i
= 1; i
< nargs
; i
++)
2646 args
[i
] = va_arg (ap
, Lisp_Object
);
2649 gcpro1
.nvars
= nargs
;
2650 specbind (Qinhibit_redisplay
, Qt
);
2652 specbind (Qinhibit_quit
, Qt
);
2653 /* Use Qt to ensure debugger does not run,
2654 so there is no possibility of wanting to redisplay. */
2655 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2658 val
= unbind_to (count
, val
);
2665 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2670 va_start (ap
, func
);
2671 retval
= safe__call (false, nargs
, func
, ap
);
2676 /* Call function FN with one argument ARG.
2677 Return the result, or nil if something went wrong. */
2680 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2682 return safe_call (2, fn
, arg
);
2686 safe__call1 (bool inhibit_quit
, Lisp_Object fn
, ...)
2692 retval
= safe__call (inhibit_quit
, 2, fn
, ap
);
2697 static Lisp_Object Qeval
;
2700 safe_eval (Lisp_Object sexpr
)
2702 return safe__call1 (false, Qeval
, sexpr
);
2706 safe__eval (bool inhibit_quit
, Lisp_Object sexpr
)
2708 return safe__call1 (inhibit_quit
, Qeval
, sexpr
);
2711 /* Call function FN with two arguments ARG1 and ARG2.
2712 Return the result, or nil if something went wrong. */
2715 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2717 return safe_call (3, fn
, arg1
, arg2
);
2722 /***********************************************************************
2724 ***********************************************************************/
2728 /* Define CHECK_IT to perform sanity checks on iterators.
2729 This is for debugging. It is too slow to do unconditionally. */
2732 check_it (struct it
*it
)
2734 if (it
->method
== GET_FROM_STRING
)
2736 eassert (STRINGP (it
->string
));
2737 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2741 eassert (IT_STRING_CHARPOS (*it
) < 0);
2742 if (it
->method
== GET_FROM_BUFFER
)
2744 /* Check that character and byte positions agree. */
2745 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2750 eassert (it
->current
.dpvec_index
>= 0);
2752 eassert (it
->current
.dpvec_index
< 0);
2755 #define CHECK_IT(IT) check_it ((IT))
2759 #define CHECK_IT(IT) (void) 0
2764 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2766 /* Check that the window end of window W is what we expect it
2767 to be---the last row in the current matrix displaying text. */
2770 check_window_end (struct window
*w
)
2772 if (!MINI_WINDOW_P (w
) && w
->window_end_valid
)
2774 struct glyph_row
*row
;
2775 eassert ((row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
),
2777 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2778 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2782 #define CHECK_WINDOW_END(W) check_window_end ((W))
2786 #define CHECK_WINDOW_END(W) (void) 0
2788 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
2790 /***********************************************************************
2791 Iterator initialization
2792 ***********************************************************************/
2794 /* Initialize IT for displaying current_buffer in window W, starting
2795 at character position CHARPOS. CHARPOS < 0 means that no buffer
2796 position is specified which is useful when the iterator is assigned
2797 a position later. BYTEPOS is the byte position corresponding to
2800 If ROW is not null, calls to produce_glyphs with IT as parameter
2801 will produce glyphs in that row.
2803 BASE_FACE_ID is the id of a base face to use. It must be one of
2804 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2805 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2806 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2808 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2809 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2810 will be initialized to use the corresponding mode line glyph row of
2811 the desired matrix of W. */
2814 init_iterator (struct it
*it
, struct window
*w
,
2815 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2816 struct glyph_row
*row
, enum face_id base_face_id
)
2818 enum face_id remapped_base_face_id
= base_face_id
;
2820 /* Some precondition checks. */
2821 eassert (w
!= NULL
&& it
!= NULL
);
2822 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2825 /* If face attributes have been changed since the last redisplay,
2826 free realized faces now because they depend on face definitions
2827 that might have changed. Don't free faces while there might be
2828 desired matrices pending which reference these faces. */
2829 if (face_change_count
&& !inhibit_free_realized_faces
)
2831 face_change_count
= 0;
2832 free_all_realized_faces (Qnil
);
2835 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2836 if (! NILP (Vface_remapping_alist
))
2837 remapped_base_face_id
2838 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2840 /* Use one of the mode line rows of W's desired matrix if
2844 if (base_face_id
== MODE_LINE_FACE_ID
2845 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2846 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2847 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2848 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2852 memset (it
, 0, sizeof *it
);
2853 it
->current
.overlay_string_index
= -1;
2854 it
->current
.dpvec_index
= -1;
2855 it
->base_face_id
= remapped_base_face_id
;
2857 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2858 it
->paragraph_embedding
= L2R
;
2859 it
->bidi_it
.string
.lstring
= Qnil
;
2860 it
->bidi_it
.string
.s
= NULL
;
2861 it
->bidi_it
.string
.bufpos
= 0;
2864 /* The window in which we iterate over current_buffer: */
2865 XSETWINDOW (it
->window
, w
);
2867 it
->f
= XFRAME (w
->frame
);
2871 /* Extra space between lines (on window systems only). */
2872 if (base_face_id
== DEFAULT_FACE_ID
2873 && FRAME_WINDOW_P (it
->f
))
2875 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2876 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2877 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2878 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2879 * FRAME_LINE_HEIGHT (it
->f
));
2880 else if (it
->f
->extra_line_spacing
> 0)
2881 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2882 it
->max_extra_line_spacing
= 0;
2885 /* If realized faces have been removed, e.g. because of face
2886 attribute changes of named faces, recompute them. When running
2887 in batch mode, the face cache of the initial frame is null. If
2888 we happen to get called, make a dummy face cache. */
2889 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2890 init_frame_faces (it
->f
);
2891 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2892 recompute_basic_faces (it
->f
);
2894 /* Current value of the `slice', `space-width', and 'height' properties. */
2895 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2896 it
->space_width
= Qnil
;
2897 it
->font_height
= Qnil
;
2898 it
->override_ascent
= -1;
2900 /* Are control characters displayed as `^C'? */
2901 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2903 /* -1 means everything between a CR and the following line end
2904 is invisible. >0 means lines indented more than this value are
2906 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2908 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2910 : (!NILP (BVAR (current_buffer
, selective_display
))
2912 it
->selective_display_ellipsis_p
2913 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2915 /* Display table to use. */
2916 it
->dp
= window_display_table (w
);
2918 /* Are multibyte characters enabled in current_buffer? */
2919 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2921 /* Get the position at which the redisplay_end_trigger hook should
2922 be run, if it is to be run at all. */
2923 if (MARKERP (w
->redisplay_end_trigger
)
2924 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2925 it
->redisplay_end_trigger_charpos
2926 = marker_position (w
->redisplay_end_trigger
);
2927 else if (INTEGERP (w
->redisplay_end_trigger
))
2928 it
->redisplay_end_trigger_charpos
2929 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2932 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2934 /* Are lines in the display truncated? */
2935 if (base_face_id
!= DEFAULT_FACE_ID
2937 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2938 && ((!NILP (Vtruncate_partial_width_windows
)
2939 && !INTEGERP (Vtruncate_partial_width_windows
))
2940 || (INTEGERP (Vtruncate_partial_width_windows
)
2941 /* PXW: Shall we do something about this? */
2942 && (WINDOW_TOTAL_COLS (it
->w
)
2943 < XINT (Vtruncate_partial_width_windows
))))))
2944 it
->line_wrap
= TRUNCATE
;
2945 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2946 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2947 ? WINDOW_WRAP
: WORD_WRAP
;
2949 it
->line_wrap
= TRUNCATE
;
2951 /* Get dimensions of truncation and continuation glyphs. These are
2952 displayed as fringe bitmaps under X, but we need them for such
2953 frames when the fringes are turned off. But leave the dimensions
2954 zero for tooltip frames, as these glyphs look ugly there and also
2955 sabotage calculations of tooltip dimensions in x-show-tip. */
2956 #ifdef HAVE_WINDOW_SYSTEM
2957 if (!(FRAME_WINDOW_P (it
->f
)
2958 && FRAMEP (tip_frame
)
2959 && it
->f
== XFRAME (tip_frame
)))
2962 if (it
->line_wrap
== TRUNCATE
)
2964 /* We will need the truncation glyph. */
2965 eassert (it
->glyph_row
== NULL
);
2966 produce_special_glyphs (it
, IT_TRUNCATION
);
2967 it
->truncation_pixel_width
= it
->pixel_width
;
2971 /* We will need the continuation glyph. */
2972 eassert (it
->glyph_row
== NULL
);
2973 produce_special_glyphs (it
, IT_CONTINUATION
);
2974 it
->continuation_pixel_width
= it
->pixel_width
;
2978 /* Reset these values to zero because the produce_special_glyphs
2979 above has changed them. */
2980 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2981 it
->phys_ascent
= it
->phys_descent
= 0;
2983 /* Set this after getting the dimensions of truncation and
2984 continuation glyphs, so that we don't produce glyphs when calling
2985 produce_special_glyphs, above. */
2986 it
->glyph_row
= row
;
2987 it
->area
= TEXT_AREA
;
2989 /* Forget any previous info about this row being reversed. */
2991 it
->glyph_row
->reversed_p
= 0;
2993 /* Get the dimensions of the display area. The display area
2994 consists of the visible window area plus a horizontally scrolled
2995 part to the left of the window. All x-values are relative to the
2996 start of this total display area. */
2997 if (base_face_id
!= DEFAULT_FACE_ID
)
2999 /* Mode lines, menu bar in terminal frames. */
3000 it
->first_visible_x
= 0;
3001 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
3006 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
3007 it
->last_visible_x
= (it
->first_visible_x
3008 + window_box_width (w
, TEXT_AREA
));
3010 /* If we truncate lines, leave room for the truncation glyph(s) at
3011 the right margin. Otherwise, leave room for the continuation
3012 glyph(s). Done only if the window has no right fringe. */
3013 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
3015 if (it
->line_wrap
== TRUNCATE
)
3016 it
->last_visible_x
-= it
->truncation_pixel_width
;
3018 it
->last_visible_x
-= it
->continuation_pixel_width
;
3021 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
3022 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
3025 /* Leave room for a border glyph. */
3026 if (!FRAME_WINDOW_P (it
->f
)
3027 && !WINDOW_RIGHTMOST_P (it
->w
))
3028 it
->last_visible_x
-= 1;
3030 it
->last_visible_y
= window_text_bottom_y (w
);
3032 /* For mode lines and alike, arrange for the first glyph having a
3033 left box line if the face specifies a box. */
3034 if (base_face_id
!= DEFAULT_FACE_ID
)
3038 it
->face_id
= remapped_base_face_id
;
3040 /* If we have a boxed mode line, make the first character appear
3041 with a left box line. */
3042 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
3043 if (face
&& face
->box
!= FACE_NO_BOX
)
3044 it
->start_of_box_run_p
= true;
3047 /* If a buffer position was specified, set the iterator there,
3048 getting overlays and face properties from that position. */
3049 if (charpos
>= BUF_BEG (current_buffer
))
3051 it
->stop_charpos
= charpos
;
3052 it
->end_charpos
= ZV
;
3053 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
3054 IT_CHARPOS (*it
) = charpos
;
3055 IT_BYTEPOS (*it
) = bytepos
;
3057 /* We will rely on `reseat' to set this up properly, via
3058 handle_face_prop. */
3059 it
->face_id
= it
->base_face_id
;
3061 it
->start
= it
->current
;
3062 /* Do we need to reorder bidirectional text? Not if this is a
3063 unibyte buffer: by definition, none of the single-byte
3064 characters are strong R2L, so no reordering is needed. And
3065 bidi.c doesn't support unibyte buffers anyway. Also, don't
3066 reorder while we are loading loadup.el, since the tables of
3067 character properties needed for reordering are not yet
3071 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
3074 /* If we are to reorder bidirectional text, init the bidi
3078 /* Since we don't know at this point whether there will be
3079 any R2L lines in the window, we reserve space for
3080 truncation/continuation glyphs even if only the left
3081 fringe is absent. */
3082 if (base_face_id
== DEFAULT_FACE_ID
3083 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
3084 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
3086 if (it
->line_wrap
== TRUNCATE
)
3087 it
->last_visible_x
-= it
->truncation_pixel_width
;
3089 it
->last_visible_x
-= it
->continuation_pixel_width
;
3091 /* Note the paragraph direction that this buffer wants to
3093 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
3095 it
->paragraph_embedding
= L2R
;
3096 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
3098 it
->paragraph_embedding
= R2L
;
3100 it
->paragraph_embedding
= NEUTRAL_DIR
;
3101 bidi_unshelve_cache (NULL
, 0);
3102 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
3106 /* Compute faces etc. */
3107 reseat (it
, it
->current
.pos
, 1);
3114 /* Initialize IT for the display of window W with window start POS. */
3117 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
3119 struct glyph_row
*row
;
3120 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
3122 row
= w
->desired_matrix
->rows
+ first_vpos
;
3123 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
3124 it
->first_vpos
= first_vpos
;
3126 /* Don't reseat to previous visible line start if current start
3127 position is in a string or image. */
3128 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
3130 int start_at_line_beg_p
;
3131 int first_y
= it
->current_y
;
3133 /* If window start is not at a line start, skip forward to POS to
3134 get the correct continuation lines width. */
3135 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
3136 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
3137 if (!start_at_line_beg_p
)
3141 reseat_at_previous_visible_line_start (it
);
3142 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
3144 new_x
= it
->current_x
+ it
->pixel_width
;
3146 /* If lines are continued, this line may end in the middle
3147 of a multi-glyph character (e.g. a control character
3148 displayed as \003, or in the middle of an overlay
3149 string). In this case move_it_to above will not have
3150 taken us to the start of the continuation line but to the
3151 end of the continued line. */
3152 if (it
->current_x
> 0
3153 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
3154 && (/* And glyph doesn't fit on the line. */
3155 new_x
> it
->last_visible_x
3156 /* Or it fits exactly and we're on a window
3158 || (new_x
== it
->last_visible_x
3159 && FRAME_WINDOW_P (it
->f
)
3160 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
3161 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
3162 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
3164 if ((it
->current
.dpvec_index
>= 0
3165 || it
->current
.overlay_string_index
>= 0)
3166 /* If we are on a newline from a display vector or
3167 overlay string, then we are already at the end of
3168 a screen line; no need to go to the next line in
3169 that case, as this line is not really continued.
3170 (If we do go to the next line, C-e will not DTRT.) */
3173 set_iterator_to_next (it
, 1);
3174 move_it_in_display_line_to (it
, -1, -1, 0);
3177 it
->continuation_lines_width
+= it
->current_x
;
3179 /* If the character at POS is displayed via a display
3180 vector, move_it_to above stops at the final glyph of
3181 IT->dpvec. To make the caller redisplay that character
3182 again (a.k.a. start at POS), we need to reset the
3183 dpvec_index to the beginning of IT->dpvec. */
3184 else if (it
->current
.dpvec_index
>= 0)
3185 it
->current
.dpvec_index
= 0;
3187 /* We're starting a new display line, not affected by the
3188 height of the continued line, so clear the appropriate
3189 fields in the iterator structure. */
3190 it
->max_ascent
= it
->max_descent
= 0;
3191 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3193 it
->current_y
= first_y
;
3195 it
->current_x
= it
->hpos
= 0;
3201 /* Return 1 if POS is a position in ellipses displayed for invisible
3202 text. W is the window we display, for text property lookup. */
3205 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3207 Lisp_Object prop
, window
;
3209 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3211 /* If POS specifies a position in a display vector, this might
3212 be for an ellipsis displayed for invisible text. We won't
3213 get the iterator set up for delivering that ellipsis unless
3214 we make sure that it gets aware of the invisible text. */
3215 if (pos
->dpvec_index
>= 0
3216 && pos
->overlay_string_index
< 0
3217 && CHARPOS (pos
->string_pos
) < 0
3219 && (XSETWINDOW (window
, w
),
3220 prop
= Fget_char_property (make_number (charpos
),
3221 Qinvisible
, window
),
3222 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
3224 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3226 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3233 /* Initialize IT for stepping through current_buffer in window W,
3234 starting at position POS that includes overlay string and display
3235 vector/ control character translation position information. Value
3236 is zero if there are overlay strings with newlines at POS. */
3239 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3241 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3242 int i
, overlay_strings_with_newlines
= 0;
3244 /* If POS specifies a position in a display vector, this might
3245 be for an ellipsis displayed for invisible text. We won't
3246 get the iterator set up for delivering that ellipsis unless
3247 we make sure that it gets aware of the invisible text. */
3248 if (in_ellipses_for_invisible_text_p (pos
, w
))
3254 /* Keep in mind: the call to reseat in init_iterator skips invisible
3255 text, so we might end up at a position different from POS. This
3256 is only a problem when POS is a row start after a newline and an
3257 overlay starts there with an after-string, and the overlay has an
3258 invisible property. Since we don't skip invisible text in
3259 display_line and elsewhere immediately after consuming the
3260 newline before the row start, such a POS will not be in a string,
3261 but the call to init_iterator below will move us to the
3263 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3265 /* This only scans the current chunk -- it should scan all chunks.
3266 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3267 to 16 in 22.1 to make this a lesser problem. */
3268 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3270 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3271 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3273 while (s
< e
&& *s
!= '\n')
3278 overlay_strings_with_newlines
= 1;
3283 /* If position is within an overlay string, set up IT to the right
3285 if (pos
->overlay_string_index
>= 0)
3289 /* If the first overlay string happens to have a `display'
3290 property for an image, the iterator will be set up for that
3291 image, and we have to undo that setup first before we can
3292 correct the overlay string index. */
3293 if (it
->method
== GET_FROM_IMAGE
)
3296 /* We already have the first chunk of overlay strings in
3297 IT->overlay_strings. Load more until the one for
3298 pos->overlay_string_index is in IT->overlay_strings. */
3299 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3301 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3302 it
->current
.overlay_string_index
= 0;
3305 load_overlay_strings (it
, 0);
3306 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3310 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3311 relative_index
= (it
->current
.overlay_string_index
3312 % OVERLAY_STRING_CHUNK_SIZE
);
3313 it
->string
= it
->overlay_strings
[relative_index
];
3314 eassert (STRINGP (it
->string
));
3315 it
->current
.string_pos
= pos
->string_pos
;
3316 it
->method
= GET_FROM_STRING
;
3317 it
->end_charpos
= SCHARS (it
->string
);
3318 /* Set up the bidi iterator for this overlay string. */
3321 it
->bidi_it
.string
.lstring
= it
->string
;
3322 it
->bidi_it
.string
.s
= NULL
;
3323 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3324 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3325 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3326 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3327 it
->bidi_it
.w
= it
->w
;
3328 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3329 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3331 /* Synchronize the state of the bidi iterator with
3332 pos->string_pos. For any string position other than
3333 zero, this will be done automagically when we resume
3334 iteration over the string and get_visually_first_element
3335 is called. But if string_pos is zero, and the string is
3336 to be reordered for display, we need to resync manually,
3337 since it could be that the iteration state recorded in
3338 pos ended at string_pos of 0 moving backwards in string. */
3339 if (CHARPOS (pos
->string_pos
) == 0)
3341 get_visually_first_element (it
);
3342 if (IT_STRING_CHARPOS (*it
) != 0)
3345 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3346 bidi_move_to_visually_next (&it
->bidi_it
);
3347 } while (it
->bidi_it
.charpos
!= 0);
3349 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3350 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3354 if (CHARPOS (pos
->string_pos
) >= 0)
3356 /* Recorded position is not in an overlay string, but in another
3357 string. This can only be a string from a `display' property.
3358 IT should already be filled with that string. */
3359 it
->current
.string_pos
= pos
->string_pos
;
3360 eassert (STRINGP (it
->string
));
3362 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3363 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3366 /* Restore position in display vector translations, control
3367 character translations or ellipses. */
3368 if (pos
->dpvec_index
>= 0)
3370 if (it
->dpvec
== NULL
)
3371 get_next_display_element (it
);
3372 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3373 it
->current
.dpvec_index
= pos
->dpvec_index
;
3377 return !overlay_strings_with_newlines
;
3381 /* Initialize IT for stepping through current_buffer in window W
3382 starting at ROW->start. */
3385 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3387 init_from_display_pos (it
, w
, &row
->start
);
3388 it
->start
= row
->start
;
3389 it
->continuation_lines_width
= row
->continuation_lines_width
;
3394 /* Initialize IT for stepping through current_buffer in window W
3395 starting in the line following ROW, i.e. starting at ROW->end.
3396 Value is zero if there are overlay strings with newlines at ROW's
3400 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3404 if (init_from_display_pos (it
, w
, &row
->end
))
3406 if (row
->continued_p
)
3407 it
->continuation_lines_width
3408 = row
->continuation_lines_width
+ row
->pixel_width
;
3419 /***********************************************************************
3421 ***********************************************************************/
3423 /* Called when IT reaches IT->stop_charpos. Handle text property and
3424 overlay changes. Set IT->stop_charpos to the next position where
3428 handle_stop (struct it
*it
)
3430 enum prop_handled handled
;
3431 int handle_overlay_change_p
;
3435 it
->current
.dpvec_index
= -1;
3436 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3437 it
->ignore_overlay_strings_at_pos_p
= 0;
3440 /* Use face of preceding text for ellipsis (if invisible) */
3441 if (it
->selective_display_ellipsis_p
)
3442 it
->saved_face_id
= it
->face_id
;
3444 /* Here's the description of the semantics of, and the logic behind,
3445 the various HANDLED_* statuses:
3447 HANDLED_NORMALLY means the handler did its job, and the loop
3448 should proceed to calling the next handler in order.
3450 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3451 change in the properties and overlays at current position, so the
3452 loop should be restarted, to re-invoke the handlers that were
3453 already called. This happens when fontification-functions were
3454 called by handle_fontified_prop, and actually fontified
3455 something. Another case where HANDLED_RECOMPUTE_PROPS is
3456 returned is when we discover overlay strings that need to be
3457 displayed right away. The loop below will continue for as long
3458 as the status is HANDLED_RECOMPUTE_PROPS.
3460 HANDLED_RETURN means return immediately to the caller, to
3461 continue iteration without calling any further handlers. This is
3462 used when we need to act on some property right away, for example
3463 when we need to display the ellipsis or a replacing display
3464 property, such as display string or image.
3466 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3467 consumed, and the handler switched to the next overlay string.
3468 This signals the loop below to refrain from looking for more
3469 overlays before all the overlay strings of the current overlay
3472 Some of the handlers called by the loop push the iterator state
3473 onto the stack (see 'push_it'), and arrange for the iteration to
3474 continue with another object, such as an image, a display string,
3475 or an overlay string. In most such cases, it->stop_charpos is
3476 set to the first character of the string, so that when the
3477 iteration resumes, this function will immediately be called
3478 again, to examine the properties at the beginning of the string.
3480 When a display or overlay string is exhausted, the iterator state
3481 is popped (see 'pop_it'), and iteration continues with the
3482 previous object. Again, in many such cases this function is
3483 called again to find the next position where properties might
3488 handled
= HANDLED_NORMALLY
;
3490 /* Call text property handlers. */
3491 for (p
= it_props
; p
->handler
; ++p
)
3493 handled
= p
->handler (it
);
3495 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3497 else if (handled
== HANDLED_RETURN
)
3499 /* We still want to show before and after strings from
3500 overlays even if the actual buffer text is replaced. */
3501 if (!handle_overlay_change_p
3503 /* Don't call get_overlay_strings_1 if we already
3504 have overlay strings loaded, because doing so
3505 will load them again and push the iterator state
3506 onto the stack one more time, which is not
3507 expected by the rest of the code that processes
3509 || (it
->current
.overlay_string_index
< 0
3510 ? !get_overlay_strings_1 (it
, 0, 0)
3514 setup_for_ellipsis (it
, 0);
3515 /* When handling a display spec, we might load an
3516 empty string. In that case, discard it here. We
3517 used to discard it in handle_single_display_spec,
3518 but that causes get_overlay_strings_1, above, to
3519 ignore overlay strings that we must check. */
3520 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3524 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3528 it
->ignore_overlay_strings_at_pos_p
= true;
3529 it
->string_from_display_prop_p
= 0;
3530 it
->from_disp_prop_p
= 0;
3531 handle_overlay_change_p
= 0;
3533 handled
= HANDLED_RECOMPUTE_PROPS
;
3536 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3537 handle_overlay_change_p
= 0;
3540 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3542 /* Don't check for overlay strings below when set to deliver
3543 characters from a display vector. */
3544 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3545 handle_overlay_change_p
= 0;
3547 /* Handle overlay changes.
3548 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3549 if it finds overlays. */
3550 if (handle_overlay_change_p
)
3551 handled
= handle_overlay_change (it
);
3556 setup_for_ellipsis (it
, 0);
3560 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3562 /* Determine where to stop next. */
3563 if (handled
== HANDLED_NORMALLY
)
3564 compute_stop_pos (it
);
3568 /* Compute IT->stop_charpos from text property and overlay change
3569 information for IT's current position. */
3572 compute_stop_pos (struct it
*it
)
3574 register INTERVAL iv
, next_iv
;
3575 Lisp_Object object
, limit
, position
;
3576 ptrdiff_t charpos
, bytepos
;
3578 if (STRINGP (it
->string
))
3580 /* Strings are usually short, so don't limit the search for
3582 it
->stop_charpos
= it
->end_charpos
;
3583 object
= it
->string
;
3585 charpos
= IT_STRING_CHARPOS (*it
);
3586 bytepos
= IT_STRING_BYTEPOS (*it
);
3592 /* If end_charpos is out of range for some reason, such as a
3593 misbehaving display function, rationalize it (Bug#5984). */
3594 if (it
->end_charpos
> ZV
)
3595 it
->end_charpos
= ZV
;
3596 it
->stop_charpos
= it
->end_charpos
;
3598 /* If next overlay change is in front of the current stop pos
3599 (which is IT->end_charpos), stop there. Note: value of
3600 next_overlay_change is point-max if no overlay change
3602 charpos
= IT_CHARPOS (*it
);
3603 bytepos
= IT_BYTEPOS (*it
);
3604 pos
= next_overlay_change (charpos
);
3605 if (pos
< it
->stop_charpos
)
3606 it
->stop_charpos
= pos
;
3608 /* Set up variables for computing the stop position from text
3609 property changes. */
3610 XSETBUFFER (object
, current_buffer
);
3611 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3614 /* Get the interval containing IT's position. Value is a null
3615 interval if there isn't such an interval. */
3616 position
= make_number (charpos
);
3617 iv
= validate_interval_range (object
, &position
, &position
, 0);
3620 Lisp_Object values_here
[LAST_PROP_IDX
];
3623 /* Get properties here. */
3624 for (p
= it_props
; p
->handler
; ++p
)
3625 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3627 /* Look for an interval following iv that has different
3629 for (next_iv
= next_interval (iv
);
3632 || XFASTINT (limit
) > next_iv
->position
));
3633 next_iv
= next_interval (next_iv
))
3635 for (p
= it_props
; p
->handler
; ++p
)
3637 Lisp_Object new_value
;
3639 new_value
= textget (next_iv
->plist
, *p
->name
);
3640 if (!EQ (values_here
[p
->idx
], new_value
))
3650 if (INTEGERP (limit
)
3651 && next_iv
->position
>= XFASTINT (limit
))
3652 /* No text property change up to limit. */
3653 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3655 /* Text properties change in next_iv. */
3656 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3660 if (it
->cmp_it
.id
< 0)
3662 ptrdiff_t stoppos
= it
->end_charpos
;
3664 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3666 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3667 stoppos
, it
->string
);
3670 eassert (STRINGP (it
->string
)
3671 || (it
->stop_charpos
>= BEGV
3672 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3676 /* Return the position of the next overlay change after POS in
3677 current_buffer. Value is point-max if no overlay change
3678 follows. This is like `next-overlay-change' but doesn't use
3682 next_overlay_change (ptrdiff_t pos
)
3684 ptrdiff_t i
, noverlays
;
3686 Lisp_Object
*overlays
;
3688 /* Get all overlays at the given position. */
3689 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3691 /* If any of these overlays ends before endpos,
3692 use its ending point instead. */
3693 for (i
= 0; i
< noverlays
; ++i
)
3698 oend
= OVERLAY_END (overlays
[i
]);
3699 oendpos
= OVERLAY_POSITION (oend
);
3700 endpos
= min (endpos
, oendpos
);
3706 /* How many characters forward to search for a display property or
3707 display string. Searching too far forward makes the bidi display
3708 sluggish, especially in small windows. */
3709 #define MAX_DISP_SCAN 250
3711 /* Return the character position of a display string at or after
3712 position specified by POSITION. If no display string exists at or
3713 after POSITION, return ZV. A display string is either an overlay
3714 with `display' property whose value is a string, or a `display'
3715 text property whose value is a string. STRING is data about the
3716 string to iterate; if STRING->lstring is nil, we are iterating a
3717 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3718 on a GUI frame. DISP_PROP is set to zero if we searched
3719 MAX_DISP_SCAN characters forward without finding any display
3720 strings, non-zero otherwise. It is set to 2 if the display string
3721 uses any kind of `(space ...)' spec that will produce a stretch of
3722 white space in the text area. */
3724 compute_display_string_pos (struct text_pos
*position
,
3725 struct bidi_string_data
*string
,
3727 int frame_window_p
, int *disp_prop
)
3729 /* OBJECT = nil means current buffer. */
3730 Lisp_Object object
, object1
;
3731 Lisp_Object pos
, spec
, limpos
;
3732 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3733 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3734 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3735 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3737 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3738 struct text_pos tpos
;
3741 if (string
&& STRINGP (string
->lstring
))
3742 object1
= object
= string
->lstring
;
3743 else if (w
&& !string_p
)
3745 XSETWINDOW (object
, w
);
3749 object1
= object
= Qnil
;
3754 /* We don't support display properties whose values are strings
3755 that have display string properties. */
3756 || string
->from_disp_str
3757 /* C strings cannot have display properties. */
3758 || (string
->s
&& !STRINGP (object
)))
3764 /* If the character at CHARPOS is where the display string begins,
3766 pos
= make_number (charpos
);
3767 if (STRINGP (object
))
3768 bufpos
= string
->bufpos
;
3772 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3774 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3777 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3785 /* Look forward for the first character with a `display' property
3786 that will replace the underlying text when displayed. */
3787 limpos
= make_number (lim
);
3789 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3790 CHARPOS (tpos
) = XFASTINT (pos
);
3791 if (CHARPOS (tpos
) >= lim
)
3796 if (STRINGP (object
))
3797 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3799 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3800 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3801 if (!STRINGP (object
))
3802 bufpos
= CHARPOS (tpos
);
3803 } while (NILP (spec
)
3804 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3805 bufpos
, frame_window_p
)));
3809 return CHARPOS (tpos
);
3812 /* Return the character position of the end of the display string that
3813 started at CHARPOS. If there's no display string at CHARPOS,
3814 return -1. A display string is either an overlay with `display'
3815 property whose value is a string or a `display' text property whose
3816 value is a string. */
3818 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3820 /* OBJECT = nil means current buffer. */
3821 Lisp_Object object
=
3822 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3823 Lisp_Object pos
= make_number (charpos
);
3825 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3827 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3830 /* It could happen that the display property or overlay was removed
3831 since we found it in compute_display_string_pos above. One way
3832 this can happen is if JIT font-lock was called (through
3833 handle_fontified_prop), and jit-lock-functions remove text
3834 properties or overlays from the portion of buffer that includes
3835 CHARPOS. Muse mode is known to do that, for example. In this
3836 case, we return -1 to the caller, to signal that no display
3837 string is actually present at CHARPOS. See bidi_fetch_char for
3838 how this is handled.
3840 An alternative would be to never look for display properties past
3841 it->stop_charpos. But neither compute_display_string_pos nor
3842 bidi_fetch_char that calls it know or care where the next
3844 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3847 /* Look forward for the first character where the `display' property
3849 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3851 return XFASTINT (pos
);
3856 /***********************************************************************
3858 ***********************************************************************/
3860 /* Handle changes in the `fontified' property of the current buffer by
3861 calling hook functions from Qfontification_functions to fontify
3864 static enum prop_handled
3865 handle_fontified_prop (struct it
*it
)
3867 Lisp_Object prop
, pos
;
3868 enum prop_handled handled
= HANDLED_NORMALLY
;
3870 if (!NILP (Vmemory_full
))
3873 /* Get the value of the `fontified' property at IT's current buffer
3874 position. (The `fontified' property doesn't have a special
3875 meaning in strings.) If the value is nil, call functions from
3876 Qfontification_functions. */
3877 if (!STRINGP (it
->string
)
3879 && !NILP (Vfontification_functions
)
3880 && !NILP (Vrun_hooks
)
3881 && (pos
= make_number (IT_CHARPOS (*it
)),
3882 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3883 /* Ignore the special cased nil value always present at EOB since
3884 no amount of fontifying will be able to change it. */
3885 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3887 ptrdiff_t count
= SPECPDL_INDEX ();
3889 struct buffer
*obuf
= current_buffer
;
3890 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3891 bool old_clip_changed
= current_buffer
->clip_changed
;
3893 val
= Vfontification_functions
;
3894 specbind (Qfontification_functions
, Qnil
);
3896 eassert (it
->end_charpos
== ZV
);
3898 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3899 safe_call1 (val
, pos
);
3902 Lisp_Object fns
, fn
;
3903 struct gcpro gcpro1
, gcpro2
;
3908 for (; CONSP (val
); val
= XCDR (val
))
3914 /* A value of t indicates this hook has a local
3915 binding; it means to run the global binding too.
3916 In a global value, t should not occur. If it
3917 does, we must ignore it to avoid an endless
3919 for (fns
= Fdefault_value (Qfontification_functions
);
3925 safe_call1 (fn
, pos
);
3929 safe_call1 (fn
, pos
);
3935 unbind_to (count
, Qnil
);
3937 /* Fontification functions routinely call `save-restriction'.
3938 Normally, this tags clip_changed, which can confuse redisplay
3939 (see discussion in Bug#6671). Since we don't perform any
3940 special handling of fontification changes in the case where
3941 `save-restriction' isn't called, there's no point doing so in
3942 this case either. So, if the buffer's restrictions are
3943 actually left unchanged, reset clip_changed. */
3944 if (obuf
== current_buffer
)
3946 if (begv
== BEGV
&& zv
== ZV
)
3947 current_buffer
->clip_changed
= old_clip_changed
;
3949 /* There isn't much we can reasonably do to protect against
3950 misbehaving fontification, but here's a fig leaf. */
3951 else if (BUFFER_LIVE_P (obuf
))
3952 set_buffer_internal_1 (obuf
);
3954 /* The fontification code may have added/removed text.
3955 It could do even a lot worse, but let's at least protect against
3956 the most obvious case where only the text past `pos' gets changed',
3957 as is/was done in grep.el where some escapes sequences are turned
3958 into face properties (bug#7876). */
3959 it
->end_charpos
= ZV
;
3961 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3962 something. This avoids an endless loop if they failed to
3963 fontify the text for which reason ever. */
3964 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3965 handled
= HANDLED_RECOMPUTE_PROPS
;
3973 /***********************************************************************
3975 ***********************************************************************/
3977 /* Set up iterator IT from face properties at its current position.
3978 Called from handle_stop. */
3980 static enum prop_handled
3981 handle_face_prop (struct it
*it
)
3984 ptrdiff_t next_stop
;
3986 if (!STRINGP (it
->string
))
3989 = face_at_buffer_position (it
->w
,
3993 + TEXT_PROP_DISTANCE_LIMIT
),
3994 0, it
->base_face_id
);
3996 /* Is this a start of a run of characters with box face?
3997 Caveat: this can be called for a freshly initialized
3998 iterator; face_id is -1 in this case. We know that the new
3999 face will not change until limit, i.e. if the new face has a
4000 box, all characters up to limit will have one. But, as
4001 usual, we don't know whether limit is really the end. */
4002 if (new_face_id
!= it
->face_id
)
4004 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
4005 /* If it->face_id is -1, old_face below will be NULL, see
4006 the definition of FACE_FROM_ID. This will happen if this
4007 is the initial call that gets the face. */
4008 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4010 /* If the value of face_id of the iterator is -1, we have to
4011 look in front of IT's position and see whether there is a
4012 face there that's different from new_face_id. */
4013 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
4015 int prev_face_id
= face_before_it_pos (it
);
4017 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
4020 /* If the new face has a box, but the old face does not,
4021 this is the start of a run of characters with box face,
4022 i.e. this character has a shadow on the left side. */
4023 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
4024 && (old_face
== NULL
|| !old_face
->box
));
4025 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4033 Lisp_Object from_overlay
4034 = (it
->current
.overlay_string_index
>= 0
4035 ? it
->string_overlays
[it
->current
.overlay_string_index
4036 % OVERLAY_STRING_CHUNK_SIZE
]
4039 /* See if we got to this string directly or indirectly from
4040 an overlay property. That includes the before-string or
4041 after-string of an overlay, strings in display properties
4042 provided by an overlay, their text properties, etc.
4044 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
4045 if (! NILP (from_overlay
))
4046 for (i
= it
->sp
- 1; i
>= 0; i
--)
4048 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
4050 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
4051 % OVERLAY_STRING_CHUNK_SIZE
];
4052 else if (! NILP (it
->stack
[i
].from_overlay
))
4053 from_overlay
= it
->stack
[i
].from_overlay
;
4055 if (!NILP (from_overlay
))
4059 if (! NILP (from_overlay
))
4061 bufpos
= IT_CHARPOS (*it
);
4062 /* For a string from an overlay, the base face depends
4063 only on text properties and ignores overlays. */
4065 = face_for_overlay_string (it
->w
,
4069 + TEXT_PROP_DISTANCE_LIMIT
),
4077 /* For strings from a `display' property, use the face at
4078 IT's current buffer position as the base face to merge
4079 with, so that overlay strings appear in the same face as
4080 surrounding text, unless they specify their own faces.
4081 For strings from wrap-prefix and line-prefix properties,
4082 use the default face, possibly remapped via
4083 Vface_remapping_alist. */
4084 /* Note that the fact that we use the face at _buffer_
4085 position means that a 'display' property on an overlay
4086 string will not inherit the face of that overlay string,
4087 but will instead revert to the face of buffer text
4088 covered by the overlay. This is visible, e.g., when the
4089 overlay specifies a box face, but neither the buffer nor
4090 the display string do. This sounds like a design bug,
4091 but Emacs always did that since v21.1, so changing that
4092 might be a big deal. */
4093 base_face_id
= it
->string_from_prefix_prop_p
4094 ? (!NILP (Vface_remapping_alist
)
4095 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
4097 : underlying_face_id (it
);
4100 new_face_id
= face_at_string_position (it
->w
,
4102 IT_STRING_CHARPOS (*it
),
4107 /* Is this a start of a run of characters with box? Caveat:
4108 this can be called for a freshly allocated iterator; face_id
4109 is -1 is this case. We know that the new face will not
4110 change until the next check pos, i.e. if the new face has a
4111 box, all characters up to that position will have a
4112 box. But, as usual, we don't know whether that position
4113 is really the end. */
4114 if (new_face_id
!= it
->face_id
)
4116 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
4117 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4119 /* If new face has a box but old face hasn't, this is the
4120 start of a run of characters with box, i.e. it has a
4121 shadow on the left side. */
4122 it
->start_of_box_run_p
4123 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
4124 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4128 it
->face_id
= new_face_id
;
4129 return HANDLED_NORMALLY
;
4133 /* Return the ID of the face ``underlying'' IT's current position,
4134 which is in a string. If the iterator is associated with a
4135 buffer, return the face at IT's current buffer position.
4136 Otherwise, use the iterator's base_face_id. */
4139 underlying_face_id (struct it
*it
)
4141 int face_id
= it
->base_face_id
, i
;
4143 eassert (STRINGP (it
->string
));
4145 for (i
= it
->sp
- 1; i
>= 0; --i
)
4146 if (NILP (it
->stack
[i
].string
))
4147 face_id
= it
->stack
[i
].face_id
;
4153 /* Compute the face one character before or after the current position
4154 of IT, in the visual order. BEFORE_P non-zero means get the face
4155 in front (to the left in L2R paragraphs, to the right in R2L
4156 paragraphs) of IT's screen position. Value is the ID of the face. */
4159 face_before_or_after_it_pos (struct it
*it
, int before_p
)
4162 ptrdiff_t next_check_charpos
;
4164 void *it_copy_data
= NULL
;
4166 eassert (it
->s
== NULL
);
4168 if (STRINGP (it
->string
))
4170 ptrdiff_t bufpos
, charpos
;
4173 /* No face change past the end of the string (for the case
4174 we are padding with spaces). No face change before the
4176 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4177 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4182 /* Set charpos to the position before or after IT's current
4183 position, in the logical order, which in the non-bidi
4184 case is the same as the visual order. */
4186 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4187 else if (it
->what
== IT_COMPOSITION
)
4188 /* For composition, we must check the character after the
4190 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4192 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4198 /* With bidi iteration, the character before the current
4199 in the visual order cannot be found by simple
4200 iteration, because "reverse" reordering is not
4201 supported. Instead, we need to use the move_it_*
4202 family of functions. */
4203 /* Ignore face changes before the first visible
4204 character on this display line. */
4205 if (it
->current_x
<= it
->first_visible_x
)
4207 SAVE_IT (it_copy
, *it
, it_copy_data
);
4208 /* Implementation note: Since move_it_in_display_line
4209 works in the iterator geometry, and thinks the first
4210 character is always the leftmost, even in R2L lines,
4211 we don't need to distinguish between the R2L and L2R
4213 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
4214 it_copy
.current_x
- 1, MOVE_TO_X
);
4215 charpos
= IT_STRING_CHARPOS (it_copy
);
4216 RESTORE_IT (it
, it
, it_copy_data
);
4220 /* Set charpos to the string position of the character
4221 that comes after IT's current position in the visual
4223 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4227 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4229 charpos
= it_copy
.bidi_it
.charpos
;
4232 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4234 if (it
->current
.overlay_string_index
>= 0)
4235 bufpos
= IT_CHARPOS (*it
);
4239 base_face_id
= underlying_face_id (it
);
4241 /* Get the face for ASCII, or unibyte. */
4242 face_id
= face_at_string_position (it
->w
,
4246 &next_check_charpos
,
4249 /* Correct the face for charsets different from ASCII. Do it
4250 for the multibyte case only. The face returned above is
4251 suitable for unibyte text if IT->string is unibyte. */
4252 if (STRING_MULTIBYTE (it
->string
))
4254 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4255 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4257 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4259 c
= string_char_and_length (p
, &len
);
4260 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4265 struct text_pos pos
;
4267 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4268 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4271 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4272 pos
= it
->current
.pos
;
4277 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4280 if (it
->what
== IT_COMPOSITION
)
4282 /* For composition, we must check the position after
4284 pos
.charpos
+= it
->cmp_it
.nchars
;
4285 pos
.bytepos
+= it
->len
;
4288 INC_TEXT_POS (pos
, it
->multibyte_p
);
4295 /* With bidi iteration, the character before the current
4296 in the visual order cannot be found by simple
4297 iteration, because "reverse" reordering is not
4298 supported. Instead, we need to use the move_it_*
4299 family of functions. */
4300 /* Ignore face changes before the first visible
4301 character on this display line. */
4302 if (it
->current_x
<= it
->first_visible_x
)
4304 SAVE_IT (it_copy
, *it
, it_copy_data
);
4305 /* Implementation note: Since move_it_in_display_line
4306 works in the iterator geometry, and thinks the first
4307 character is always the leftmost, even in R2L lines,
4308 we don't need to distinguish between the R2L and L2R
4310 move_it_in_display_line (&it_copy
, ZV
,
4311 it_copy
.current_x
- 1, MOVE_TO_X
);
4312 pos
= it_copy
.current
.pos
;
4313 RESTORE_IT (it
, it
, it_copy_data
);
4317 /* Set charpos to the buffer position of the character
4318 that comes after IT's current position in the visual
4320 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4324 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4327 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4330 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4332 /* Determine face for CHARSET_ASCII, or unibyte. */
4333 face_id
= face_at_buffer_position (it
->w
,
4335 &next_check_charpos
,
4338 /* Correct the face for charsets different from ASCII. Do it
4339 for the multibyte case only. The face returned above is
4340 suitable for unibyte text if current_buffer is unibyte. */
4341 if (it
->multibyte_p
)
4343 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4344 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4345 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4354 /***********************************************************************
4356 ***********************************************************************/
4358 /* Set up iterator IT from invisible properties at its current
4359 position. Called from handle_stop. */
4361 static enum prop_handled
4362 handle_invisible_prop (struct it
*it
)
4364 enum prop_handled handled
= HANDLED_NORMALLY
;
4368 if (STRINGP (it
->string
))
4370 Lisp_Object end_charpos
, limit
, charpos
;
4372 /* Get the value of the invisible text property at the
4373 current position. Value will be nil if there is no such
4375 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4376 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4377 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4379 if (invis_p
&& IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4381 /* Record whether we have to display an ellipsis for the
4383 int display_ellipsis_p
= (invis_p
== 2);
4384 ptrdiff_t len
, endpos
;
4386 handled
= HANDLED_RECOMPUTE_PROPS
;
4388 /* Get the position at which the next visible text can be
4389 found in IT->string, if any. */
4390 endpos
= len
= SCHARS (it
->string
);
4391 XSETINT (limit
, len
);
4394 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4396 if (INTEGERP (end_charpos
))
4398 endpos
= XFASTINT (end_charpos
);
4399 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4400 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4402 display_ellipsis_p
= true;
4405 while (invis_p
&& endpos
< len
);
4407 if (display_ellipsis_p
)
4408 it
->ellipsis_p
= true;
4412 /* Text at END_CHARPOS is visible. Move IT there. */
4413 struct text_pos old
;
4416 old
= it
->current
.string_pos
;
4417 oldpos
= CHARPOS (old
);
4420 if (it
->bidi_it
.first_elt
4421 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4422 bidi_paragraph_init (it
->paragraph_embedding
,
4424 /* Bidi-iterate out of the invisible text. */
4427 bidi_move_to_visually_next (&it
->bidi_it
);
4429 while (oldpos
<= it
->bidi_it
.charpos
4430 && it
->bidi_it
.charpos
< endpos
);
4432 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4433 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4434 if (IT_CHARPOS (*it
) >= endpos
)
4435 it
->prev_stop
= endpos
;
4439 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4440 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4445 /* The rest of the string is invisible. If this is an
4446 overlay string, proceed with the next overlay string
4447 or whatever comes and return a character from there. */
4448 if (it
->current
.overlay_string_index
>= 0
4449 && !display_ellipsis_p
)
4451 next_overlay_string (it
);
4452 /* Don't check for overlay strings when we just
4453 finished processing them. */
4454 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4458 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4459 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4466 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4467 Lisp_Object pos
, overlay
;
4469 /* First of all, is there invisible text at this position? */
4470 tem
= start_charpos
= IT_CHARPOS (*it
);
4471 pos
= make_number (tem
);
4472 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4474 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4476 /* If we are on invisible text, skip over it. */
4477 if (invis_p
&& start_charpos
< it
->end_charpos
)
4479 /* Record whether we have to display an ellipsis for the
4481 int display_ellipsis_p
= invis_p
== 2;
4483 handled
= HANDLED_RECOMPUTE_PROPS
;
4485 /* Loop skipping over invisible text. The loop is left at
4486 ZV or with IT on the first char being visible again. */
4489 /* Try to skip some invisible text. Return value is the
4490 position reached which can be equal to where we start
4491 if there is nothing invisible there. This skips both
4492 over invisible text properties and overlays with
4493 invisible property. */
4494 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4496 /* If we skipped nothing at all we weren't at invisible
4497 text in the first place. If everything to the end of
4498 the buffer was skipped, end the loop. */
4499 if (newpos
== tem
|| newpos
>= ZV
)
4503 /* We skipped some characters but not necessarily
4504 all there are. Check if we ended up on visible
4505 text. Fget_char_property returns the property of
4506 the char before the given position, i.e. if we
4507 get invis_p = 0, this means that the char at
4508 newpos is visible. */
4509 pos
= make_number (newpos
);
4510 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4511 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4514 /* If we ended up on invisible text, proceed to
4515 skip starting with next_stop. */
4519 /* If there are adjacent invisible texts, don't lose the
4520 second one's ellipsis. */
4522 display_ellipsis_p
= true;
4526 /* The position newpos is now either ZV or on visible text. */
4529 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4531 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4533 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4535 /* If the invisible text ends on a newline or on a
4536 character after a newline, we can avoid the costly,
4537 character by character, bidi iteration to NEWPOS, and
4538 instead simply reseat the iterator there. That's
4539 because all bidi reordering information is tossed at
4540 the newline. This is a big win for modes that hide
4541 complete lines, like Outline, Org, etc. */
4542 if (on_newline
|| after_newline
)
4544 struct text_pos tpos
;
4545 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4547 SET_TEXT_POS (tpos
, newpos
, bpos
);
4548 reseat_1 (it
, tpos
, 0);
4549 /* If we reseat on a newline/ZV, we need to prep the
4550 bidi iterator for advancing to the next character
4551 after the newline/EOB, keeping the current paragraph
4552 direction (so that PRODUCE_GLYPHS does TRT wrt
4553 prepending/appending glyphs to a glyph row). */
4556 it
->bidi_it
.first_elt
= 0;
4557 it
->bidi_it
.paragraph_dir
= pdir
;
4558 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4559 it
->bidi_it
.nchars
= 1;
4560 it
->bidi_it
.ch_len
= 1;
4563 else /* Must use the slow method. */
4565 /* With bidi iteration, the region of invisible text
4566 could start and/or end in the middle of a
4567 non-base embedding level. Therefore, we need to
4568 skip invisible text using the bidi iterator,
4569 starting at IT's current position, until we find
4570 ourselves outside of the invisible text.
4571 Skipping invisible text _after_ bidi iteration
4572 avoids affecting the visual order of the
4573 displayed text when invisible properties are
4574 added or removed. */
4575 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4577 /* If we were `reseat'ed to a new paragraph,
4578 determine the paragraph base direction. We
4579 need to do it now because
4580 next_element_from_buffer may not have a
4581 chance to do it, if we are going to skip any
4582 text at the beginning, which resets the
4584 bidi_paragraph_init (it
->paragraph_embedding
,
4589 bidi_move_to_visually_next (&it
->bidi_it
);
4591 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4592 && it
->bidi_it
.charpos
< newpos
);
4593 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4594 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4595 /* If we overstepped NEWPOS, record its position in
4596 the iterator, so that we skip invisible text if
4597 later the bidi iteration lands us in the
4598 invisible region again. */
4599 if (IT_CHARPOS (*it
) >= newpos
)
4600 it
->prev_stop
= newpos
;
4605 IT_CHARPOS (*it
) = newpos
;
4606 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4609 /* If there are before-strings at the start of invisible
4610 text, and the text is invisible because of a text
4611 property, arrange to show before-strings because 20.x did
4612 it that way. (If the text is invisible because of an
4613 overlay property instead of a text property, this is
4614 already handled in the overlay code.) */
4616 && get_overlay_strings (it
, it
->stop_charpos
))
4618 handled
= HANDLED_RECOMPUTE_PROPS
;
4621 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4622 /* The call to get_overlay_strings above recomputes
4623 it->stop_charpos, but it only considers changes
4624 in properties and overlays beyond iterator's
4625 current position. This causes us to miss changes
4626 that happen exactly where the invisible property
4627 ended. So we play it safe here and force the
4628 iterator to check for potential stop positions
4629 immediately after the invisible text. Note that
4630 if get_overlay_strings returns non-zero, it
4631 normally also pushed the iterator stack, so we
4632 need to update the stop position in the slot
4633 below the current one. */
4634 it
->stack
[it
->sp
- 1].stop_charpos
4635 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4638 else if (display_ellipsis_p
)
4640 /* Make sure that the glyphs of the ellipsis will get
4641 correct `charpos' values. If we would not update
4642 it->position here, the glyphs would belong to the
4643 last visible character _before_ the invisible
4644 text, which confuses `set_cursor_from_row'.
4646 We use the last invisible position instead of the
4647 first because this way the cursor is always drawn on
4648 the first "." of the ellipsis, whenever PT is inside
4649 the invisible text. Otherwise the cursor would be
4650 placed _after_ the ellipsis when the point is after the
4651 first invisible character. */
4652 if (!STRINGP (it
->object
))
4654 it
->position
.charpos
= newpos
- 1;
4655 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4657 it
->ellipsis_p
= true;
4658 /* Let the ellipsis display before
4659 considering any properties of the following char.
4660 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4661 handled
= HANDLED_RETURN
;
4670 /* Make iterator IT return `...' next.
4671 Replaces LEN characters from buffer. */
4674 setup_for_ellipsis (struct it
*it
, int len
)
4676 /* Use the display table definition for `...'. Invalid glyphs
4677 will be handled by the method returning elements from dpvec. */
4678 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4680 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4681 it
->dpvec
= v
->contents
;
4682 it
->dpend
= v
->contents
+ v
->header
.size
;
4686 /* Default `...'. */
4687 it
->dpvec
= default_invis_vector
;
4688 it
->dpend
= default_invis_vector
+ 3;
4691 it
->dpvec_char_len
= len
;
4692 it
->current
.dpvec_index
= 0;
4693 it
->dpvec_face_id
= -1;
4695 /* Remember the current face id in case glyphs specify faces.
4696 IT's face is restored in set_iterator_to_next.
4697 saved_face_id was set to preceding char's face in handle_stop. */
4698 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4699 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4701 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4702 it
->ellipsis_p
= true;
4707 /***********************************************************************
4709 ***********************************************************************/
4711 /* Set up iterator IT from `display' property at its current position.
4712 Called from handle_stop.
4713 We return HANDLED_RETURN if some part of the display property
4714 overrides the display of the buffer text itself.
4715 Otherwise we return HANDLED_NORMALLY. */
4717 static enum prop_handled
4718 handle_display_prop (struct it
*it
)
4720 Lisp_Object propval
, object
, overlay
;
4721 struct text_pos
*position
;
4723 /* Nonzero if some property replaces the display of the text itself. */
4724 int display_replaced_p
= 0;
4726 if (STRINGP (it
->string
))
4728 object
= it
->string
;
4729 position
= &it
->current
.string_pos
;
4730 bufpos
= CHARPOS (it
->current
.pos
);
4734 XSETWINDOW (object
, it
->w
);
4735 position
= &it
->current
.pos
;
4736 bufpos
= CHARPOS (*position
);
4739 /* Reset those iterator values set from display property values. */
4740 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4741 it
->space_width
= Qnil
;
4742 it
->font_height
= Qnil
;
4745 /* We don't support recursive `display' properties, i.e. string
4746 values that have a string `display' property, that have a string
4747 `display' property etc. */
4748 if (!it
->string_from_display_prop_p
)
4749 it
->area
= TEXT_AREA
;
4751 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4752 Qdisplay
, object
, &overlay
);
4754 return HANDLED_NORMALLY
;
4755 /* Now OVERLAY is the overlay that gave us this property, or nil
4756 if it was a text property. */
4758 if (!STRINGP (it
->string
))
4759 object
= it
->w
->contents
;
4761 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4763 FRAME_WINDOW_P (it
->f
));
4765 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4768 /* Subroutine of handle_display_prop. Returns non-zero if the display
4769 specification in SPEC is a replacing specification, i.e. it would
4770 replace the text covered by `display' property with something else,
4771 such as an image or a display string. If SPEC includes any kind or
4772 `(space ...) specification, the value is 2; this is used by
4773 compute_display_string_pos, which see.
4775 See handle_single_display_spec for documentation of arguments.
4776 frame_window_p is non-zero if the window being redisplayed is on a
4777 GUI frame; this argument is used only if IT is NULL, see below.
4779 IT can be NULL, if this is called by the bidi reordering code
4780 through compute_display_string_pos, which see. In that case, this
4781 function only examines SPEC, but does not otherwise "handle" it, in
4782 the sense that it doesn't set up members of IT from the display
4785 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4786 Lisp_Object overlay
, struct text_pos
*position
,
4787 ptrdiff_t bufpos
, int frame_window_p
)
4789 int replacing_p
= 0;
4793 /* Simple specifications. */
4794 && !EQ (XCAR (spec
), Qimage
)
4795 && !EQ (XCAR (spec
), Qspace
)
4796 && !EQ (XCAR (spec
), Qwhen
)
4797 && !EQ (XCAR (spec
), Qslice
)
4798 && !EQ (XCAR (spec
), Qspace_width
)
4799 && !EQ (XCAR (spec
), Qheight
)
4800 && !EQ (XCAR (spec
), Qraise
)
4801 /* Marginal area specifications. */
4802 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4803 && !EQ (XCAR (spec
), Qleft_fringe
)
4804 && !EQ (XCAR (spec
), Qright_fringe
)
4805 && !NILP (XCAR (spec
)))
4807 for (; CONSP (spec
); spec
= XCDR (spec
))
4809 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4810 overlay
, position
, bufpos
,
4811 replacing_p
, frame_window_p
)))
4814 /* If some text in a string is replaced, `position' no
4815 longer points to the position of `object'. */
4816 if (!it
|| STRINGP (object
))
4821 else if (VECTORP (spec
))
4824 for (i
= 0; i
< ASIZE (spec
); ++i
)
4825 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4826 overlay
, position
, bufpos
,
4827 replacing_p
, frame_window_p
)))
4830 /* If some text in a string is replaced, `position' no
4831 longer points to the position of `object'. */
4832 if (!it
|| STRINGP (object
))
4838 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4839 position
, bufpos
, 0,
4847 /* Value is the position of the end of the `display' property starting
4848 at START_POS in OBJECT. */
4850 static struct text_pos
4851 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4854 struct text_pos end_pos
;
4856 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4857 Qdisplay
, object
, Qnil
);
4858 CHARPOS (end_pos
) = XFASTINT (end
);
4859 if (STRINGP (object
))
4860 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4862 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4868 /* Set up IT from a single `display' property specification SPEC. OBJECT
4869 is the object in which the `display' property was found. *POSITION
4870 is the position in OBJECT at which the `display' property was found.
4871 BUFPOS is the buffer position of OBJECT (different from POSITION if
4872 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4873 previously saw a display specification which already replaced text
4874 display with something else, for example an image; we ignore such
4875 properties after the first one has been processed.
4877 OVERLAY is the overlay this `display' property came from,
4878 or nil if it was a text property.
4880 If SPEC is a `space' or `image' specification, and in some other
4881 cases too, set *POSITION to the position where the `display'
4884 If IT is NULL, only examine the property specification in SPEC, but
4885 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4886 is intended to be displayed in a window on a GUI frame.
4888 Value is non-zero if something was found which replaces the display
4889 of buffer or string text. */
4892 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4893 Lisp_Object overlay
, struct text_pos
*position
,
4894 ptrdiff_t bufpos
, int display_replaced_p
,
4898 Lisp_Object location
, value
;
4899 struct text_pos start_pos
= *position
;
4902 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4903 If the result is non-nil, use VALUE instead of SPEC. */
4905 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4914 if (!NILP (form
) && !EQ (form
, Qt
))
4916 ptrdiff_t count
= SPECPDL_INDEX ();
4917 struct gcpro gcpro1
;
4919 /* Bind `object' to the object having the `display' property, a
4920 buffer or string. Bind `position' to the position in the
4921 object where the property was found, and `buffer-position'
4922 to the current position in the buffer. */
4925 XSETBUFFER (object
, current_buffer
);
4926 specbind (Qobject
, object
);
4927 specbind (Qposition
, make_number (CHARPOS (*position
)));
4928 specbind (Qbuffer_position
, make_number (bufpos
));
4930 form
= safe_eval (form
);
4932 unbind_to (count
, Qnil
);
4938 /* Handle `(height HEIGHT)' specifications. */
4940 && EQ (XCAR (spec
), Qheight
)
4941 && CONSP (XCDR (spec
)))
4945 if (!FRAME_WINDOW_P (it
->f
))
4948 it
->font_height
= XCAR (XCDR (spec
));
4949 if (!NILP (it
->font_height
))
4951 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4952 int new_height
= -1;
4954 if (CONSP (it
->font_height
)
4955 && (EQ (XCAR (it
->font_height
), Qplus
)
4956 || EQ (XCAR (it
->font_height
), Qminus
))
4957 && CONSP (XCDR (it
->font_height
))
4958 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4960 /* `(+ N)' or `(- N)' where N is an integer. */
4961 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4962 if (EQ (XCAR (it
->font_height
), Qplus
))
4964 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4966 else if (FUNCTIONP (it
->font_height
))
4968 /* Call function with current height as argument.
4969 Value is the new height. */
4971 height
= safe_call1 (it
->font_height
,
4972 face
->lface
[LFACE_HEIGHT_INDEX
]);
4973 if (NUMBERP (height
))
4974 new_height
= XFLOATINT (height
);
4976 else if (NUMBERP (it
->font_height
))
4978 /* Value is a multiple of the canonical char height. */
4981 f
= FACE_FROM_ID (it
->f
,
4982 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4983 new_height
= (XFLOATINT (it
->font_height
)
4984 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4988 /* Evaluate IT->font_height with `height' bound to the
4989 current specified height to get the new height. */
4990 ptrdiff_t count
= SPECPDL_INDEX ();
4992 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4993 value
= safe_eval (it
->font_height
);
4994 unbind_to (count
, Qnil
);
4996 if (NUMBERP (value
))
4997 new_height
= XFLOATINT (value
);
5001 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
5008 /* Handle `(space-width WIDTH)'. */
5010 && EQ (XCAR (spec
), Qspace_width
)
5011 && CONSP (XCDR (spec
)))
5015 if (!FRAME_WINDOW_P (it
->f
))
5018 value
= XCAR (XCDR (spec
));
5019 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
5020 it
->space_width
= value
;
5026 /* Handle `(slice X Y WIDTH HEIGHT)'. */
5028 && EQ (XCAR (spec
), Qslice
))
5034 if (!FRAME_WINDOW_P (it
->f
))
5037 if (tem
= XCDR (spec
), CONSP (tem
))
5039 it
->slice
.x
= XCAR (tem
);
5040 if (tem
= XCDR (tem
), CONSP (tem
))
5042 it
->slice
.y
= XCAR (tem
);
5043 if (tem
= XCDR (tem
), CONSP (tem
))
5045 it
->slice
.width
= XCAR (tem
);
5046 if (tem
= XCDR (tem
), CONSP (tem
))
5047 it
->slice
.height
= XCAR (tem
);
5056 /* Handle `(raise FACTOR)'. */
5058 && EQ (XCAR (spec
), Qraise
)
5059 && CONSP (XCDR (spec
)))
5063 if (!FRAME_WINDOW_P (it
->f
))
5066 #ifdef HAVE_WINDOW_SYSTEM
5067 value
= XCAR (XCDR (spec
));
5068 if (NUMBERP (value
))
5070 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5071 it
->voffset
= - (XFLOATINT (value
)
5072 * (FONT_HEIGHT (face
->font
)));
5074 #endif /* HAVE_WINDOW_SYSTEM */
5080 /* Don't handle the other kinds of display specifications
5081 inside a string that we got from a `display' property. */
5082 if (it
&& it
->string_from_display_prop_p
)
5085 /* Characters having this form of property are not displayed, so
5086 we have to find the end of the property. */
5089 start_pos
= *position
;
5090 *position
= display_prop_end (it
, object
, start_pos
);
5094 /* Stop the scan at that end position--we assume that all
5095 text properties change there. */
5097 it
->stop_charpos
= position
->charpos
;
5099 /* Handle `(left-fringe BITMAP [FACE])'
5100 and `(right-fringe BITMAP [FACE])'. */
5102 && (EQ (XCAR (spec
), Qleft_fringe
)
5103 || EQ (XCAR (spec
), Qright_fringe
))
5104 && CONSP (XCDR (spec
)))
5110 if (!FRAME_WINDOW_P (it
->f
))
5111 /* If we return here, POSITION has been advanced
5112 across the text with this property. */
5114 /* Synchronize the bidi iterator with POSITION. This is
5115 needed because we are not going to push the iterator
5116 on behalf of this display property, so there will be
5117 no pop_it call to do this synchronization for us. */
5120 it
->position
= *position
;
5121 iterate_out_of_display_property (it
);
5122 *position
= it
->position
;
5124 /* If we were to display this fringe bitmap,
5125 next_element_from_image would have reset this flag.
5126 Do the same, to avoid affecting overlays that
5128 it
->ignore_overlay_strings_at_pos_p
= 0;
5132 else if (!frame_window_p
)
5135 #ifdef HAVE_WINDOW_SYSTEM
5136 value
= XCAR (XCDR (spec
));
5137 if (!SYMBOLP (value
)
5138 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
5139 /* If we return here, POSITION has been advanced
5140 across the text with this property. */
5142 if (it
&& it
->bidi_p
)
5144 it
->position
= *position
;
5145 iterate_out_of_display_property (it
);
5146 *position
= it
->position
;
5149 /* Reset this flag like next_element_from_image would. */
5150 it
->ignore_overlay_strings_at_pos_p
= 0;
5156 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
5158 if (CONSP (XCDR (XCDR (spec
))))
5160 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5161 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5167 /* Save current settings of IT so that we can restore them
5168 when we are finished with the glyph property value. */
5169 push_it (it
, position
);
5171 it
->area
= TEXT_AREA
;
5172 it
->what
= IT_IMAGE
;
5173 it
->image_id
= -1; /* no image */
5174 it
->position
= start_pos
;
5175 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5176 it
->method
= GET_FROM_IMAGE
;
5177 it
->from_overlay
= Qnil
;
5178 it
->face_id
= face_id
;
5179 it
->from_disp_prop_p
= true;
5181 /* Say that we haven't consumed the characters with
5182 `display' property yet. The call to pop_it in
5183 set_iterator_to_next will clean this up. */
5184 *position
= start_pos
;
5186 if (EQ (XCAR (spec
), Qleft_fringe
))
5188 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5189 it
->left_user_fringe_face_id
= face_id
;
5193 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5194 it
->right_user_fringe_face_id
= face_id
;
5197 #endif /* HAVE_WINDOW_SYSTEM */
5201 /* Prepare to handle `((margin left-margin) ...)',
5202 `((margin right-margin) ...)' and `((margin nil) ...)'
5203 prefixes for display specifications. */
5204 location
= Qunbound
;
5205 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5209 value
= XCDR (spec
);
5211 value
= XCAR (value
);
5214 if (EQ (XCAR (tem
), Qmargin
)
5215 && (tem
= XCDR (tem
),
5216 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5218 || EQ (tem
, Qleft_margin
)
5219 || EQ (tem
, Qright_margin
))))
5223 if (EQ (location
, Qunbound
))
5229 /* After this point, VALUE is the property after any
5230 margin prefix has been stripped. It must be a string,
5231 an image specification, or `(space ...)'.
5233 LOCATION specifies where to display: `left-margin',
5234 `right-margin' or nil. */
5236 valid_p
= (STRINGP (value
)
5237 #ifdef HAVE_WINDOW_SYSTEM
5238 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5239 && valid_image_p (value
))
5240 #endif /* not HAVE_WINDOW_SYSTEM */
5241 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
5243 if (valid_p
&& !display_replaced_p
)
5249 /* Callers need to know whether the display spec is any kind
5250 of `(space ...)' spec that is about to affect text-area
5252 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5257 /* Save current settings of IT so that we can restore them
5258 when we are finished with the glyph property value. */
5259 push_it (it
, position
);
5260 it
->from_overlay
= overlay
;
5261 it
->from_disp_prop_p
= true;
5263 if (NILP (location
))
5264 it
->area
= TEXT_AREA
;
5265 else if (EQ (location
, Qleft_margin
))
5266 it
->area
= LEFT_MARGIN_AREA
;
5268 it
->area
= RIGHT_MARGIN_AREA
;
5270 if (STRINGP (value
))
5273 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5274 it
->current
.overlay_string_index
= -1;
5275 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5276 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5277 it
->method
= GET_FROM_STRING
;
5278 it
->stop_charpos
= 0;
5280 it
->base_level_stop
= 0;
5281 it
->string_from_display_prop_p
= true;
5282 /* Say that we haven't consumed the characters with
5283 `display' property yet. The call to pop_it in
5284 set_iterator_to_next will clean this up. */
5285 if (BUFFERP (object
))
5286 *position
= start_pos
;
5288 /* Force paragraph direction to be that of the parent
5289 object. If the parent object's paragraph direction is
5290 not yet determined, default to L2R. */
5291 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5292 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5294 it
->paragraph_embedding
= L2R
;
5296 /* Set up the bidi iterator for this display string. */
5299 it
->bidi_it
.string
.lstring
= it
->string
;
5300 it
->bidi_it
.string
.s
= NULL
;
5301 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5302 it
->bidi_it
.string
.bufpos
= bufpos
;
5303 it
->bidi_it
.string
.from_disp_str
= 1;
5304 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5305 it
->bidi_it
.w
= it
->w
;
5306 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5309 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5311 it
->method
= GET_FROM_STRETCH
;
5313 *position
= it
->position
= start_pos
;
5314 retval
= 1 + (it
->area
== TEXT_AREA
);
5316 #ifdef HAVE_WINDOW_SYSTEM
5319 it
->what
= IT_IMAGE
;
5320 it
->image_id
= lookup_image (it
->f
, value
);
5321 it
->position
= start_pos
;
5322 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5323 it
->method
= GET_FROM_IMAGE
;
5325 /* Say that we haven't consumed the characters with
5326 `display' property yet. The call to pop_it in
5327 set_iterator_to_next will clean this up. */
5328 *position
= start_pos
;
5330 #endif /* HAVE_WINDOW_SYSTEM */
5335 /* Invalid property or property not supported. Restore
5336 POSITION to what it was before. */
5337 *position
= start_pos
;
5341 /* Check if PROP is a display property value whose text should be
5342 treated as intangible. OVERLAY is the overlay from which PROP
5343 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5344 specify the buffer position covered by PROP. */
5347 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5348 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5350 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5351 struct text_pos position
;
5353 SET_TEXT_POS (position
, charpos
, bytepos
);
5354 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5355 &position
, charpos
, frame_window_p
);
5359 /* Return 1 if PROP is a display sub-property value containing STRING.
5361 Implementation note: this and the following function are really
5362 special cases of handle_display_spec and
5363 handle_single_display_spec, and should ideally use the same code.
5364 Until they do, these two pairs must be consistent and must be
5365 modified in sync. */
5368 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5370 if (EQ (string
, prop
))
5373 /* Skip over `when FORM'. */
5374 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5379 /* Actually, the condition following `when' should be eval'ed,
5380 like handle_single_display_spec does, and we should return
5381 zero if it evaluates to nil. However, this function is
5382 called only when the buffer was already displayed and some
5383 glyph in the glyph matrix was found to come from a display
5384 string. Therefore, the condition was already evaluated, and
5385 the result was non-nil, otherwise the display string wouldn't
5386 have been displayed and we would have never been called for
5387 this property. Thus, we can skip the evaluation and assume
5388 its result is non-nil. */
5393 /* Skip over `margin LOCATION'. */
5394 if (EQ (XCAR (prop
), Qmargin
))
5405 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5409 /* Return 1 if STRING appears in the `display' property PROP. */
5412 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5415 && !EQ (XCAR (prop
), Qwhen
)
5416 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5418 /* A list of sub-properties. */
5419 while (CONSP (prop
))
5421 if (single_display_spec_string_p (XCAR (prop
), string
))
5426 else if (VECTORP (prop
))
5428 /* A vector of sub-properties. */
5430 for (i
= 0; i
< ASIZE (prop
); ++i
)
5431 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5435 return single_display_spec_string_p (prop
, string
);
5440 /* Look for STRING in overlays and text properties in the current
5441 buffer, between character positions FROM and TO (excluding TO).
5442 BACK_P non-zero means look back (in this case, TO is supposed to be
5444 Value is the first character position where STRING was found, or
5445 zero if it wasn't found before hitting TO.
5447 This function may only use code that doesn't eval because it is
5448 called asynchronously from note_mouse_highlight. */
5451 string_buffer_position_lim (Lisp_Object string
,
5452 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5454 Lisp_Object limit
, prop
, pos
;
5457 pos
= make_number (max (from
, BEGV
));
5459 if (!back_p
) /* looking forward */
5461 limit
= make_number (min (to
, ZV
));
5462 while (!found
&& !EQ (pos
, limit
))
5464 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5465 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5468 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5472 else /* looking back */
5474 limit
= make_number (max (to
, BEGV
));
5475 while (!found
&& !EQ (pos
, limit
))
5477 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5478 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5481 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5486 return found
? XINT (pos
) : 0;
5489 /* Determine which buffer position in current buffer STRING comes from.
5490 AROUND_CHARPOS is an approximate position where it could come from.
5491 Value is the buffer position or 0 if it couldn't be determined.
5493 This function is necessary because we don't record buffer positions
5494 in glyphs generated from strings (to keep struct glyph small).
5495 This function may only use code that doesn't eval because it is
5496 called asynchronously from note_mouse_highlight. */
5499 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5501 const int MAX_DISTANCE
= 1000;
5502 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5503 around_charpos
+ MAX_DISTANCE
,
5507 found
= string_buffer_position_lim (string
, around_charpos
,
5508 around_charpos
- MAX_DISTANCE
, 1);
5514 /***********************************************************************
5515 `composition' property
5516 ***********************************************************************/
5518 /* Set up iterator IT from `composition' property at its current
5519 position. Called from handle_stop. */
5521 static enum prop_handled
5522 handle_composition_prop (struct it
*it
)
5524 Lisp_Object prop
, string
;
5525 ptrdiff_t pos
, pos_byte
, start
, end
;
5527 if (STRINGP (it
->string
))
5531 pos
= IT_STRING_CHARPOS (*it
);
5532 pos_byte
= IT_STRING_BYTEPOS (*it
);
5533 string
= it
->string
;
5534 s
= SDATA (string
) + pos_byte
;
5535 it
->c
= STRING_CHAR (s
);
5539 pos
= IT_CHARPOS (*it
);
5540 pos_byte
= IT_BYTEPOS (*it
);
5542 it
->c
= FETCH_CHAR (pos_byte
);
5545 /* If there's a valid composition and point is not inside of the
5546 composition (in the case that the composition is from the current
5547 buffer), draw a glyph composed from the composition components. */
5548 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5549 && composition_valid_p (start
, end
, prop
)
5550 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5553 /* As we can't handle this situation (perhaps font-lock added
5554 a new composition), we just return here hoping that next
5555 redisplay will detect this composition much earlier. */
5556 return HANDLED_NORMALLY
;
5559 if (STRINGP (it
->string
))
5560 pos_byte
= string_char_to_byte (it
->string
, start
);
5562 pos_byte
= CHAR_TO_BYTE (start
);
5564 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5567 if (it
->cmp_it
.id
>= 0)
5570 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5571 it
->cmp_it
.nglyphs
= -1;
5575 return HANDLED_NORMALLY
;
5580 /***********************************************************************
5582 ***********************************************************************/
5584 /* The following structure is used to record overlay strings for
5585 later sorting in load_overlay_strings. */
5587 struct overlay_entry
5589 Lisp_Object overlay
;
5596 /* Set up iterator IT from overlay strings at its current position.
5597 Called from handle_stop. */
5599 static enum prop_handled
5600 handle_overlay_change (struct it
*it
)
5602 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5603 return HANDLED_RECOMPUTE_PROPS
;
5605 return HANDLED_NORMALLY
;
5609 /* Set up the next overlay string for delivery by IT, if there is an
5610 overlay string to deliver. Called by set_iterator_to_next when the
5611 end of the current overlay string is reached. If there are more
5612 overlay strings to display, IT->string and
5613 IT->current.overlay_string_index are set appropriately here.
5614 Otherwise IT->string is set to nil. */
5617 next_overlay_string (struct it
*it
)
5619 ++it
->current
.overlay_string_index
;
5620 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5622 /* No more overlay strings. Restore IT's settings to what
5623 they were before overlay strings were processed, and
5624 continue to deliver from current_buffer. */
5626 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5629 || (NILP (it
->string
)
5630 && it
->method
== GET_FROM_BUFFER
5631 && it
->stop_charpos
>= BEGV
5632 && it
->stop_charpos
<= it
->end_charpos
));
5633 it
->current
.overlay_string_index
= -1;
5634 it
->n_overlay_strings
= 0;
5635 it
->overlay_strings_charpos
= -1;
5636 /* If there's an empty display string on the stack, pop the
5637 stack, to resync the bidi iterator with IT's position. Such
5638 empty strings are pushed onto the stack in
5639 get_overlay_strings_1. */
5640 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5643 /* If we're at the end of the buffer, record that we have
5644 processed the overlay strings there already, so that
5645 next_element_from_buffer doesn't try it again. */
5646 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5647 it
->overlay_strings_at_end_processed_p
= true;
5651 /* There are more overlay strings to process. If
5652 IT->current.overlay_string_index has advanced to a position
5653 where we must load IT->overlay_strings with more strings, do
5654 it. We must load at the IT->overlay_strings_charpos where
5655 IT->n_overlay_strings was originally computed; when invisible
5656 text is present, this might not be IT_CHARPOS (Bug#7016). */
5657 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5659 if (it
->current
.overlay_string_index
&& i
== 0)
5660 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5662 /* Initialize IT to deliver display elements from the overlay
5664 it
->string
= it
->overlay_strings
[i
];
5665 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5666 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5667 it
->method
= GET_FROM_STRING
;
5668 it
->stop_charpos
= 0;
5669 it
->end_charpos
= SCHARS (it
->string
);
5670 if (it
->cmp_it
.stop_pos
>= 0)
5671 it
->cmp_it
.stop_pos
= 0;
5673 it
->base_level_stop
= 0;
5675 /* Set up the bidi iterator for this overlay string. */
5678 it
->bidi_it
.string
.lstring
= it
->string
;
5679 it
->bidi_it
.string
.s
= NULL
;
5680 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5681 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5682 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5683 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5684 it
->bidi_it
.w
= it
->w
;
5685 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5693 /* Compare two overlay_entry structures E1 and E2. Used as a
5694 comparison function for qsort in load_overlay_strings. Overlay
5695 strings for the same position are sorted so that
5697 1. All after-strings come in front of before-strings, except
5698 when they come from the same overlay.
5700 2. Within after-strings, strings are sorted so that overlay strings
5701 from overlays with higher priorities come first.
5703 2. Within before-strings, strings are sorted so that overlay
5704 strings from overlays with higher priorities come last.
5706 Value is analogous to strcmp. */
5710 compare_overlay_entries (const void *e1
, const void *e2
)
5712 struct overlay_entry
const *entry1
= e1
;
5713 struct overlay_entry
const *entry2
= e2
;
5716 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5718 /* Let after-strings appear in front of before-strings if
5719 they come from different overlays. */
5720 if (EQ (entry1
->overlay
, entry2
->overlay
))
5721 result
= entry1
->after_string_p
? 1 : -1;
5723 result
= entry1
->after_string_p
? -1 : 1;
5725 else if (entry1
->priority
!= entry2
->priority
)
5727 if (entry1
->after_string_p
)
5728 /* After-strings sorted in order of decreasing priority. */
5729 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5731 /* Before-strings sorted in order of increasing priority. */
5732 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5741 /* Load the vector IT->overlay_strings with overlay strings from IT's
5742 current buffer position, or from CHARPOS if that is > 0. Set
5743 IT->n_overlays to the total number of overlay strings found.
5745 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5746 a time. On entry into load_overlay_strings,
5747 IT->current.overlay_string_index gives the number of overlay
5748 strings that have already been loaded by previous calls to this
5751 IT->add_overlay_start contains an additional overlay start
5752 position to consider for taking overlay strings from, if non-zero.
5753 This position comes into play when the overlay has an `invisible'
5754 property, and both before and after-strings. When we've skipped to
5755 the end of the overlay, because of its `invisible' property, we
5756 nevertheless want its before-string to appear.
5757 IT->add_overlay_start will contain the overlay start position
5760 Overlay strings are sorted so that after-string strings come in
5761 front of before-string strings. Within before and after-strings,
5762 strings are sorted by overlay priority. See also function
5763 compare_overlay_entries. */
5766 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5768 Lisp_Object overlay
, window
, str
, invisible
;
5769 struct Lisp_Overlay
*ov
;
5770 ptrdiff_t start
, end
;
5771 ptrdiff_t size
= 20;
5772 ptrdiff_t n
= 0, i
, j
;
5774 struct overlay_entry
*entries
= alloca (size
* sizeof *entries
);
5778 charpos
= IT_CHARPOS (*it
);
5780 /* Append the overlay string STRING of overlay OVERLAY to vector
5781 `entries' which has size `size' and currently contains `n'
5782 elements. AFTER_P non-zero means STRING is an after-string of
5784 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5787 Lisp_Object priority; \
5791 struct overlay_entry *old = entries; \
5792 SAFE_NALLOCA (entries, 2, size); \
5793 memcpy (entries, old, size * sizeof *entries); \
5797 entries[n].string = (STRING); \
5798 entries[n].overlay = (OVERLAY); \
5799 priority = Foverlay_get ((OVERLAY), Qpriority); \
5800 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5801 entries[n].after_string_p = (AFTER_P); \
5806 /* Process overlay before the overlay center. */
5807 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5809 XSETMISC (overlay
, ov
);
5810 eassert (OVERLAYP (overlay
));
5811 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5812 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5817 /* Skip this overlay if it doesn't start or end at IT's current
5819 if (end
!= charpos
&& start
!= charpos
)
5822 /* Skip this overlay if it doesn't apply to IT->w. */
5823 window
= Foverlay_get (overlay
, Qwindow
);
5824 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5827 /* If the text ``under'' the overlay is invisible, both before-
5828 and after-strings from this overlay are visible; start and
5829 end position are indistinguishable. */
5830 invisible
= Foverlay_get (overlay
, Qinvisible
);
5831 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5833 /* If overlay has a non-empty before-string, record it. */
5834 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5835 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5837 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5839 /* If overlay has a non-empty after-string, record it. */
5840 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5841 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5843 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5846 /* Process overlays after the overlay center. */
5847 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5849 XSETMISC (overlay
, ov
);
5850 eassert (OVERLAYP (overlay
));
5851 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5852 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5854 if (start
> charpos
)
5857 /* Skip this overlay if it doesn't start or end at IT's current
5859 if (end
!= charpos
&& start
!= charpos
)
5862 /* Skip this overlay if it doesn't apply to IT->w. */
5863 window
= Foverlay_get (overlay
, Qwindow
);
5864 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5867 /* If the text ``under'' the overlay is invisible, it has a zero
5868 dimension, and both before- and after-strings apply. */
5869 invisible
= Foverlay_get (overlay
, Qinvisible
);
5870 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5872 /* If overlay has a non-empty before-string, record it. */
5873 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5874 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5876 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5878 /* If overlay has a non-empty after-string, record it. */
5879 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5880 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5882 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5885 #undef RECORD_OVERLAY_STRING
5889 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5891 /* Record number of overlay strings, and where we computed it. */
5892 it
->n_overlay_strings
= n
;
5893 it
->overlay_strings_charpos
= charpos
;
5895 /* IT->current.overlay_string_index is the number of overlay strings
5896 that have already been consumed by IT. Copy some of the
5897 remaining overlay strings to IT->overlay_strings. */
5899 j
= it
->current
.overlay_string_index
;
5900 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5902 it
->overlay_strings
[i
] = entries
[j
].string
;
5903 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5911 /* Get the first chunk of overlay strings at IT's current buffer
5912 position, or at CHARPOS if that is > 0. Value is non-zero if at
5913 least one overlay string was found. */
5916 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5918 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5919 process. This fills IT->overlay_strings with strings, and sets
5920 IT->n_overlay_strings to the total number of strings to process.
5921 IT->pos.overlay_string_index has to be set temporarily to zero
5922 because load_overlay_strings needs this; it must be set to -1
5923 when no overlay strings are found because a zero value would
5924 indicate a position in the first overlay string. */
5925 it
->current
.overlay_string_index
= 0;
5926 load_overlay_strings (it
, charpos
);
5928 /* If we found overlay strings, set up IT to deliver display
5929 elements from the first one. Otherwise set up IT to deliver
5930 from current_buffer. */
5931 if (it
->n_overlay_strings
)
5933 /* Make sure we know settings in current_buffer, so that we can
5934 restore meaningful values when we're done with the overlay
5937 compute_stop_pos (it
);
5938 eassert (it
->face_id
>= 0);
5940 /* Save IT's settings. They are restored after all overlay
5941 strings have been processed. */
5942 eassert (!compute_stop_p
|| it
->sp
== 0);
5944 /* When called from handle_stop, there might be an empty display
5945 string loaded. In that case, don't bother saving it. But
5946 don't use this optimization with the bidi iterator, since we
5947 need the corresponding pop_it call to resync the bidi
5948 iterator's position with IT's position, after we are done
5949 with the overlay strings. (The corresponding call to pop_it
5950 in case of an empty display string is in
5951 next_overlay_string.) */
5953 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5956 /* Set up IT to deliver display elements from the first overlay
5958 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5959 it
->string
= it
->overlay_strings
[0];
5960 it
->from_overlay
= Qnil
;
5961 it
->stop_charpos
= 0;
5962 eassert (STRINGP (it
->string
));
5963 it
->end_charpos
= SCHARS (it
->string
);
5965 it
->base_level_stop
= 0;
5966 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5967 it
->method
= GET_FROM_STRING
;
5968 it
->from_disp_prop_p
= 0;
5970 /* Force paragraph direction to be that of the parent
5972 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5973 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5975 it
->paragraph_embedding
= L2R
;
5977 /* Set up the bidi iterator for this overlay string. */
5980 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5982 it
->bidi_it
.string
.lstring
= it
->string
;
5983 it
->bidi_it
.string
.s
= NULL
;
5984 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5985 it
->bidi_it
.string
.bufpos
= pos
;
5986 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5987 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5988 it
->bidi_it
.w
= it
->w
;
5989 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5994 it
->current
.overlay_string_index
= -1;
5999 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
6002 it
->method
= GET_FROM_BUFFER
;
6004 (void) get_overlay_strings_1 (it
, charpos
, 1);
6008 /* Value is non-zero if we found at least one overlay string. */
6009 return STRINGP (it
->string
);
6014 /***********************************************************************
6015 Saving and restoring state
6016 ***********************************************************************/
6018 /* Save current settings of IT on IT->stack. Called, for example,
6019 before setting up IT for an overlay string, to be able to restore
6020 IT's settings to what they were after the overlay string has been
6021 processed. If POSITION is non-NULL, it is the position to save on
6022 the stack instead of IT->position. */
6025 push_it (struct it
*it
, struct text_pos
*position
)
6027 struct iterator_stack_entry
*p
;
6029 eassert (it
->sp
< IT_STACK_SIZE
);
6030 p
= it
->stack
+ it
->sp
;
6032 p
->stop_charpos
= it
->stop_charpos
;
6033 p
->prev_stop
= it
->prev_stop
;
6034 p
->base_level_stop
= it
->base_level_stop
;
6035 p
->cmp_it
= it
->cmp_it
;
6036 eassert (it
->face_id
>= 0);
6037 p
->face_id
= it
->face_id
;
6038 p
->string
= it
->string
;
6039 p
->method
= it
->method
;
6040 p
->from_overlay
= it
->from_overlay
;
6043 case GET_FROM_IMAGE
:
6044 p
->u
.image
.object
= it
->object
;
6045 p
->u
.image
.image_id
= it
->image_id
;
6046 p
->u
.image
.slice
= it
->slice
;
6048 case GET_FROM_STRETCH
:
6049 p
->u
.stretch
.object
= it
->object
;
6052 p
->position
= position
? *position
: it
->position
;
6053 p
->current
= it
->current
;
6054 p
->end_charpos
= it
->end_charpos
;
6055 p
->string_nchars
= it
->string_nchars
;
6057 p
->multibyte_p
= it
->multibyte_p
;
6058 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
6059 p
->space_width
= it
->space_width
;
6060 p
->font_height
= it
->font_height
;
6061 p
->voffset
= it
->voffset
;
6062 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
6063 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
6064 p
->display_ellipsis_p
= 0;
6065 p
->line_wrap
= it
->line_wrap
;
6066 p
->bidi_p
= it
->bidi_p
;
6067 p
->paragraph_embedding
= it
->paragraph_embedding
;
6068 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
6071 /* Save the state of the bidi iterator as well. */
6073 bidi_push_it (&it
->bidi_it
);
6077 iterate_out_of_display_property (struct it
*it
)
6079 int buffer_p
= !STRINGP (it
->string
);
6080 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
6081 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
6083 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
6085 /* Maybe initialize paragraph direction. If we are at the beginning
6086 of a new paragraph, next_element_from_buffer may not have a
6087 chance to do that. */
6088 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
6089 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6090 /* prev_stop can be zero, so check against BEGV as well. */
6091 while (it
->bidi_it
.charpos
>= bob
6092 && it
->prev_stop
<= it
->bidi_it
.charpos
6093 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
6094 && it
->bidi_it
.charpos
< eob
)
6095 bidi_move_to_visually_next (&it
->bidi_it
);
6096 /* Record the stop_pos we just crossed, for when we cross it
6098 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
6099 it
->prev_stop
= CHARPOS (it
->position
);
6100 /* If we ended up not where pop_it put us, resync IT's
6101 positional members with the bidi iterator. */
6102 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
6103 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
6105 it
->current
.pos
= it
->position
;
6107 it
->current
.string_pos
= it
->position
;
6110 /* Restore IT's settings from IT->stack. Called, for example, when no
6111 more overlay strings must be processed, and we return to delivering
6112 display elements from a buffer, or when the end of a string from a
6113 `display' property is reached and we return to delivering display
6114 elements from an overlay string, or from a buffer. */
6117 pop_it (struct it
*it
)
6119 struct iterator_stack_entry
*p
;
6120 int from_display_prop
= it
->from_disp_prop_p
;
6122 eassert (it
->sp
> 0);
6124 p
= it
->stack
+ it
->sp
;
6125 it
->stop_charpos
= p
->stop_charpos
;
6126 it
->prev_stop
= p
->prev_stop
;
6127 it
->base_level_stop
= p
->base_level_stop
;
6128 it
->cmp_it
= p
->cmp_it
;
6129 it
->face_id
= p
->face_id
;
6130 it
->current
= p
->current
;
6131 it
->position
= p
->position
;
6132 it
->string
= p
->string
;
6133 it
->from_overlay
= p
->from_overlay
;
6134 if (NILP (it
->string
))
6135 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6136 it
->method
= p
->method
;
6139 case GET_FROM_IMAGE
:
6140 it
->image_id
= p
->u
.image
.image_id
;
6141 it
->object
= p
->u
.image
.object
;
6142 it
->slice
= p
->u
.image
.slice
;
6144 case GET_FROM_STRETCH
:
6145 it
->object
= p
->u
.stretch
.object
;
6147 case GET_FROM_BUFFER
:
6148 it
->object
= it
->w
->contents
;
6150 case GET_FROM_STRING
:
6152 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6154 /* Restore the face_box_p flag, since it could have been
6155 overwritten by the face of the object that we just finished
6158 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6159 it
->object
= it
->string
;
6162 case GET_FROM_DISPLAY_VECTOR
:
6164 it
->method
= GET_FROM_C_STRING
;
6165 else if (STRINGP (it
->string
))
6166 it
->method
= GET_FROM_STRING
;
6169 it
->method
= GET_FROM_BUFFER
;
6170 it
->object
= it
->w
->contents
;
6173 it
->end_charpos
= p
->end_charpos
;
6174 it
->string_nchars
= p
->string_nchars
;
6176 it
->multibyte_p
= p
->multibyte_p
;
6177 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6178 it
->space_width
= p
->space_width
;
6179 it
->font_height
= p
->font_height
;
6180 it
->voffset
= p
->voffset
;
6181 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6182 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6183 it
->line_wrap
= p
->line_wrap
;
6184 it
->bidi_p
= p
->bidi_p
;
6185 it
->paragraph_embedding
= p
->paragraph_embedding
;
6186 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6189 bidi_pop_it (&it
->bidi_it
);
6190 /* Bidi-iterate until we get out of the portion of text, if any,
6191 covered by a `display' text property or by an overlay with
6192 `display' property. (We cannot just jump there, because the
6193 internal coherency of the bidi iterator state can not be
6194 preserved across such jumps.) We also must determine the
6195 paragraph base direction if the overlay we just processed is
6196 at the beginning of a new paragraph. */
6197 if (from_display_prop
6198 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6199 iterate_out_of_display_property (it
);
6201 eassert ((BUFFERP (it
->object
)
6202 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6203 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6204 || (STRINGP (it
->object
)
6205 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6206 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6207 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6213 /***********************************************************************
6215 ***********************************************************************/
6217 /* Set IT's current position to the previous line start. */
6220 back_to_previous_line_start (struct it
*it
)
6222 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6225 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6229 /* Move IT to the next line start.
6231 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
6232 we skipped over part of the text (as opposed to moving the iterator
6233 continuously over the text). Otherwise, don't change the value
6236 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6237 iterator on the newline, if it was found.
6239 Newlines may come from buffer text, overlay strings, or strings
6240 displayed via the `display' property. That's the reason we can't
6241 simply use find_newline_no_quit.
6243 Note that this function may not skip over invisible text that is so
6244 because of text properties and immediately follows a newline. If
6245 it would, function reseat_at_next_visible_line_start, when called
6246 from set_iterator_to_next, would effectively make invisible
6247 characters following a newline part of the wrong glyph row, which
6248 leads to wrong cursor motion. */
6251 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
6252 struct bidi_it
*bidi_it_prev
)
6254 ptrdiff_t old_selective
;
6255 int newline_found_p
, n
;
6256 const int MAX_NEWLINE_DISTANCE
= 500;
6258 /* If already on a newline, just consume it to avoid unintended
6259 skipping over invisible text below. */
6260 if (it
->what
== IT_CHARACTER
6262 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6264 if (it
->bidi_p
&& bidi_it_prev
)
6265 *bidi_it_prev
= it
->bidi_it
;
6266 set_iterator_to_next (it
, 0);
6271 /* Don't handle selective display in the following. It's (a)
6272 unnecessary because it's done by the caller, and (b) leads to an
6273 infinite recursion because next_element_from_ellipsis indirectly
6274 calls this function. */
6275 old_selective
= it
->selective
;
6278 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6279 from buffer text. */
6280 for (n
= newline_found_p
= 0;
6281 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6282 n
+= STRINGP (it
->string
) ? 0 : 1)
6284 if (!get_next_display_element (it
))
6286 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6287 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6288 *bidi_it_prev
= it
->bidi_it
;
6289 set_iterator_to_next (it
, 0);
6292 /* If we didn't find a newline near enough, see if we can use a
6294 if (!newline_found_p
)
6296 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6297 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6301 eassert (!STRINGP (it
->string
));
6303 /* If there isn't any `display' property in sight, and no
6304 overlays, we can just use the position of the newline in
6306 if (it
->stop_charpos
>= limit
6307 || ((pos
= Fnext_single_property_change (make_number (start
),
6309 make_number (limit
)),
6311 && next_overlay_change (start
) == ZV
))
6315 IT_CHARPOS (*it
) = limit
;
6316 IT_BYTEPOS (*it
) = bytepos
;
6320 struct bidi_it bprev
;
6322 /* Help bidi.c avoid expensive searches for display
6323 properties and overlays, by telling it that there are
6324 none up to `limit'. */
6325 if (it
->bidi_it
.disp_pos
< limit
)
6327 it
->bidi_it
.disp_pos
= limit
;
6328 it
->bidi_it
.disp_prop
= 0;
6331 bprev
= it
->bidi_it
;
6332 bidi_move_to_visually_next (&it
->bidi_it
);
6333 } while (it
->bidi_it
.charpos
!= limit
);
6334 IT_CHARPOS (*it
) = limit
;
6335 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6337 *bidi_it_prev
= bprev
;
6339 *skipped_p
= newline_found_p
= true;
6343 while (get_next_display_element (it
)
6344 && !newline_found_p
)
6346 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6347 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6348 *bidi_it_prev
= it
->bidi_it
;
6349 set_iterator_to_next (it
, 0);
6354 it
->selective
= old_selective
;
6355 return newline_found_p
;
6359 /* Set IT's current position to the previous visible line start. Skip
6360 invisible text that is so either due to text properties or due to
6361 selective display. Caution: this does not change IT->current_x and
6365 back_to_previous_visible_line_start (struct it
*it
)
6367 while (IT_CHARPOS (*it
) > BEGV
)
6369 back_to_previous_line_start (it
);
6371 if (IT_CHARPOS (*it
) <= BEGV
)
6374 /* If selective > 0, then lines indented more than its value are
6376 if (it
->selective
> 0
6377 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6381 /* Check the newline before point for invisibility. */
6384 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6385 Qinvisible
, it
->window
);
6386 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6390 if (IT_CHARPOS (*it
) <= BEGV
)
6395 void *it2data
= NULL
;
6398 Lisp_Object val
, overlay
;
6400 SAVE_IT (it2
, *it
, it2data
);
6402 /* If newline is part of a composition, continue from start of composition */
6403 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6404 && beg
< IT_CHARPOS (*it
))
6407 /* If newline is replaced by a display property, find start of overlay
6408 or interval and continue search from that point. */
6409 pos
= --IT_CHARPOS (it2
);
6412 bidi_unshelve_cache (NULL
, 0);
6413 it2
.string_from_display_prop_p
= 0;
6414 it2
.from_disp_prop_p
= 0;
6415 if (handle_display_prop (&it2
) == HANDLED_RETURN
6416 && !NILP (val
= get_char_property_and_overlay
6417 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6418 && (OVERLAYP (overlay
)
6419 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6420 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6422 RESTORE_IT (it
, it
, it2data
);
6426 /* Newline is not replaced by anything -- so we are done. */
6427 RESTORE_IT (it
, it
, it2data
);
6433 IT_CHARPOS (*it
) = beg
;
6434 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6438 it
->continuation_lines_width
= 0;
6440 eassert (IT_CHARPOS (*it
) >= BEGV
);
6441 eassert (IT_CHARPOS (*it
) == BEGV
6442 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6447 /* Reseat iterator IT at the previous visible line start. Skip
6448 invisible text that is so either due to text properties or due to
6449 selective display. At the end, update IT's overlay information,
6450 face information etc. */
6453 reseat_at_previous_visible_line_start (struct it
*it
)
6455 back_to_previous_visible_line_start (it
);
6456 reseat (it
, it
->current
.pos
, 1);
6461 /* Reseat iterator IT on the next visible line start in the current
6462 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6463 preceding the line start. Skip over invisible text that is so
6464 because of selective display. Compute faces, overlays etc at the
6465 new position. Note that this function does not skip over text that
6466 is invisible because of text properties. */
6469 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6471 int newline_found_p
, skipped_p
= 0;
6472 struct bidi_it bidi_it_prev
;
6474 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6476 /* Skip over lines that are invisible because they are indented
6477 more than the value of IT->selective. */
6478 if (it
->selective
> 0)
6479 while (IT_CHARPOS (*it
) < ZV
6480 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6483 eassert (IT_BYTEPOS (*it
) == BEGV
6484 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6486 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6489 /* Position on the newline if that's what's requested. */
6490 if (on_newline_p
&& newline_found_p
)
6492 if (STRINGP (it
->string
))
6494 if (IT_STRING_CHARPOS (*it
) > 0)
6498 --IT_STRING_CHARPOS (*it
);
6499 --IT_STRING_BYTEPOS (*it
);
6503 /* We need to restore the bidi iterator to the state
6504 it had on the newline, and resync the IT's
6505 position with that. */
6506 it
->bidi_it
= bidi_it_prev
;
6507 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6508 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6512 else if (IT_CHARPOS (*it
) > BEGV
)
6521 /* We need to restore the bidi iterator to the state it
6522 had on the newline and resync IT with that. */
6523 it
->bidi_it
= bidi_it_prev
;
6524 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6525 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6527 reseat (it
, it
->current
.pos
, 0);
6531 reseat (it
, it
->current
.pos
, 0);
6538 /***********************************************************************
6539 Changing an iterator's position
6540 ***********************************************************************/
6542 /* Change IT's current position to POS in current_buffer. If FORCE_P
6543 is non-zero, always check for text properties at the new position.
6544 Otherwise, text properties are only looked up if POS >=
6545 IT->check_charpos of a property. */
6548 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6550 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6552 reseat_1 (it
, pos
, 0);
6554 /* Determine where to check text properties. Avoid doing it
6555 where possible because text property lookup is very expensive. */
6557 || CHARPOS (pos
) > it
->stop_charpos
6558 || CHARPOS (pos
) < original_pos
)
6562 /* For bidi iteration, we need to prime prev_stop and
6563 base_level_stop with our best estimations. */
6564 /* Implementation note: Of course, POS is not necessarily a
6565 stop position, so assigning prev_pos to it is a lie; we
6566 should have called compute_stop_backwards. However, if
6567 the current buffer does not include any R2L characters,
6568 that call would be a waste of cycles, because the
6569 iterator will never move back, and thus never cross this
6570 "fake" stop position. So we delay that backward search
6571 until the time we really need it, in next_element_from_buffer. */
6572 if (CHARPOS (pos
) != it
->prev_stop
)
6573 it
->prev_stop
= CHARPOS (pos
);
6574 if (CHARPOS (pos
) < it
->base_level_stop
)
6575 it
->base_level_stop
= 0; /* meaning it's unknown */
6581 it
->prev_stop
= it
->base_level_stop
= 0;
6590 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6591 IT->stop_pos to POS, also. */
6594 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6596 /* Don't call this function when scanning a C string. */
6597 eassert (it
->s
== NULL
);
6599 /* POS must be a reasonable value. */
6600 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6602 it
->current
.pos
= it
->position
= pos
;
6603 it
->end_charpos
= ZV
;
6605 it
->current
.dpvec_index
= -1;
6606 it
->current
.overlay_string_index
= -1;
6607 IT_STRING_CHARPOS (*it
) = -1;
6608 IT_STRING_BYTEPOS (*it
) = -1;
6610 it
->method
= GET_FROM_BUFFER
;
6611 it
->object
= it
->w
->contents
;
6612 it
->area
= TEXT_AREA
;
6613 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6615 it
->string_from_display_prop_p
= 0;
6616 it
->string_from_prefix_prop_p
= 0;
6618 it
->from_disp_prop_p
= 0;
6619 it
->face_before_selective_p
= 0;
6622 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6624 bidi_unshelve_cache (NULL
, 0);
6625 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6626 it
->bidi_it
.string
.s
= NULL
;
6627 it
->bidi_it
.string
.lstring
= Qnil
;
6628 it
->bidi_it
.string
.bufpos
= 0;
6629 it
->bidi_it
.string
.from_disp_str
= 0;
6630 it
->bidi_it
.string
.unibyte
= 0;
6631 it
->bidi_it
.w
= it
->w
;
6636 it
->stop_charpos
= CHARPOS (pos
);
6637 it
->base_level_stop
= CHARPOS (pos
);
6639 /* This make the information stored in it->cmp_it invalidate. */
6644 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6645 If S is non-null, it is a C string to iterate over. Otherwise,
6646 STRING gives a Lisp string to iterate over.
6648 If PRECISION > 0, don't return more then PRECISION number of
6649 characters from the string.
6651 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6652 characters have been returned. FIELD_WIDTH < 0 means an infinite
6655 MULTIBYTE = 0 means disable processing of multibyte characters,
6656 MULTIBYTE > 0 means enable it,
6657 MULTIBYTE < 0 means use IT->multibyte_p.
6659 IT must be initialized via a prior call to init_iterator before
6660 calling this function. */
6663 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6664 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6667 /* No text property checks performed by default, but see below. */
6668 it
->stop_charpos
= -1;
6670 /* Set iterator position and end position. */
6671 memset (&it
->current
, 0, sizeof it
->current
);
6672 it
->current
.overlay_string_index
= -1;
6673 it
->current
.dpvec_index
= -1;
6674 eassert (charpos
>= 0);
6676 /* If STRING is specified, use its multibyteness, otherwise use the
6677 setting of MULTIBYTE, if specified. */
6679 it
->multibyte_p
= multibyte
> 0;
6681 /* Bidirectional reordering of strings is controlled by the default
6682 value of bidi-display-reordering. Don't try to reorder while
6683 loading loadup.el, as the necessary character property tables are
6684 not yet available. */
6687 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6691 eassert (STRINGP (string
));
6692 it
->string
= string
;
6694 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6695 it
->method
= GET_FROM_STRING
;
6696 it
->current
.string_pos
= string_pos (charpos
, string
);
6700 it
->bidi_it
.string
.lstring
= string
;
6701 it
->bidi_it
.string
.s
= NULL
;
6702 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6703 it
->bidi_it
.string
.bufpos
= 0;
6704 it
->bidi_it
.string
.from_disp_str
= 0;
6705 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6706 it
->bidi_it
.w
= it
->w
;
6707 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6708 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6713 it
->s
= (const unsigned char *) s
;
6716 /* Note that we use IT->current.pos, not it->current.string_pos,
6717 for displaying C strings. */
6718 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6719 if (it
->multibyte_p
)
6721 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6722 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6726 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6727 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6732 it
->bidi_it
.string
.lstring
= Qnil
;
6733 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6734 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6735 it
->bidi_it
.string
.bufpos
= 0;
6736 it
->bidi_it
.string
.from_disp_str
= 0;
6737 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6738 it
->bidi_it
.w
= it
->w
;
6739 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6742 it
->method
= GET_FROM_C_STRING
;
6745 /* PRECISION > 0 means don't return more than PRECISION characters
6747 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6749 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6751 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6754 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6755 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6756 FIELD_WIDTH < 0 means infinite field width. This is useful for
6757 padding with `-' at the end of a mode line. */
6758 if (field_width
< 0)
6759 field_width
= INFINITY
;
6760 /* Implementation note: We deliberately don't enlarge
6761 it->bidi_it.string.schars here to fit it->end_charpos, because
6762 the bidi iterator cannot produce characters out of thin air. */
6763 if (field_width
> it
->end_charpos
- charpos
)
6764 it
->end_charpos
= charpos
+ field_width
;
6766 /* Use the standard display table for displaying strings. */
6767 if (DISP_TABLE_P (Vstandard_display_table
))
6768 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6770 it
->stop_charpos
= charpos
;
6771 it
->prev_stop
= charpos
;
6772 it
->base_level_stop
= 0;
6775 it
->bidi_it
.first_elt
= 1;
6776 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6777 it
->bidi_it
.disp_pos
= -1;
6779 if (s
== NULL
&& it
->multibyte_p
)
6781 ptrdiff_t endpos
= SCHARS (it
->string
);
6782 if (endpos
> it
->end_charpos
)
6783 endpos
= it
->end_charpos
;
6784 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6792 /***********************************************************************
6794 ***********************************************************************/
6796 /* Map enum it_method value to corresponding next_element_from_* function. */
6798 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6800 next_element_from_buffer
,
6801 next_element_from_display_vector
,
6802 next_element_from_string
,
6803 next_element_from_c_string
,
6804 next_element_from_image
,
6805 next_element_from_stretch
6808 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6811 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6812 (possibly with the following characters). */
6814 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6815 ((IT)->cmp_it.id >= 0 \
6816 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6817 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6818 END_CHARPOS, (IT)->w, \
6819 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6823 /* Lookup the char-table Vglyphless_char_display for character C (-1
6824 if we want information for no-font case), and return the display
6825 method symbol. By side-effect, update it->what and
6826 it->glyphless_method. This function is called from
6827 get_next_display_element for each character element, and from
6828 x_produce_glyphs when no suitable font was found. */
6831 lookup_glyphless_char_display (int c
, struct it
*it
)
6833 Lisp_Object glyphless_method
= Qnil
;
6835 if (CHAR_TABLE_P (Vglyphless_char_display
)
6836 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6840 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6841 if (CONSP (glyphless_method
))
6842 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6843 ? XCAR (glyphless_method
)
6844 : XCDR (glyphless_method
);
6847 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6851 if (NILP (glyphless_method
))
6854 /* The default is to display the character by a proper font. */
6856 /* The default for the no-font case is to display an empty box. */
6857 glyphless_method
= Qempty_box
;
6859 if (EQ (glyphless_method
, Qzero_width
))
6862 return glyphless_method
;
6863 /* This method can't be used for the no-font case. */
6864 glyphless_method
= Qempty_box
;
6866 if (EQ (glyphless_method
, Qthin_space
))
6867 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6868 else if (EQ (glyphless_method
, Qempty_box
))
6869 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6870 else if (EQ (glyphless_method
, Qhex_code
))
6871 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6872 else if (STRINGP (glyphless_method
))
6873 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6876 /* Invalid value. We use the default method. */
6877 glyphless_method
= Qnil
;
6880 it
->what
= IT_GLYPHLESS
;
6881 return glyphless_method
;
6884 /* Merge escape glyph face and cache the result. */
6886 static struct frame
*last_escape_glyph_frame
= NULL
;
6887 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6888 static int last_escape_glyph_merged_face_id
= 0;
6891 merge_escape_glyph_face (struct it
*it
)
6895 if (it
->f
== last_escape_glyph_frame
6896 && it
->face_id
== last_escape_glyph_face_id
)
6897 face_id
= last_escape_glyph_merged_face_id
;
6900 /* Merge the `escape-glyph' face into the current face. */
6901 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6902 last_escape_glyph_frame
= it
->f
;
6903 last_escape_glyph_face_id
= it
->face_id
;
6904 last_escape_glyph_merged_face_id
= face_id
;
6909 /* Likewise for glyphless glyph face. */
6911 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6912 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6913 static int last_glyphless_glyph_merged_face_id
= 0;
6916 merge_glyphless_glyph_face (struct it
*it
)
6920 if (it
->f
== last_glyphless_glyph_frame
6921 && it
->face_id
== last_glyphless_glyph_face_id
)
6922 face_id
= last_glyphless_glyph_merged_face_id
;
6925 /* Merge the `glyphless-char' face into the current face. */
6926 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6927 last_glyphless_glyph_frame
= it
->f
;
6928 last_glyphless_glyph_face_id
= it
->face_id
;
6929 last_glyphless_glyph_merged_face_id
= face_id
;
6934 /* Load IT's display element fields with information about the next
6935 display element from the current position of IT. Value is zero if
6936 end of buffer (or C string) is reached. */
6939 get_next_display_element (struct it
*it
)
6941 /* Non-zero means that we found a display element. Zero means that
6942 we hit the end of what we iterate over. Performance note: the
6943 function pointer `method' used here turns out to be faster than
6944 using a sequence of if-statements. */
6948 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6950 if (it
->what
== IT_CHARACTER
)
6952 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6953 and only if (a) the resolved directionality of that character
6955 /* FIXME: Do we need an exception for characters from display
6957 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6958 it
->c
= bidi_mirror_char (it
->c
);
6959 /* Map via display table or translate control characters.
6960 IT->c, IT->len etc. have been set to the next character by
6961 the function call above. If we have a display table, and it
6962 contains an entry for IT->c, translate it. Don't do this if
6963 IT->c itself comes from a display table, otherwise we could
6964 end up in an infinite recursion. (An alternative could be to
6965 count the recursion depth of this function and signal an
6966 error when a certain maximum depth is reached.) Is it worth
6968 if (success_p
&& it
->dpvec
== NULL
)
6971 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6972 int nonascii_space_p
= 0;
6973 int nonascii_hyphen_p
= 0;
6974 int c
= it
->c
; /* This is the character to display. */
6976 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6978 eassert (SINGLE_BYTE_CHAR_P (c
));
6979 if (unibyte_display_via_language_environment
)
6981 c
= DECODE_CHAR (unibyte
, c
);
6983 c
= BYTE8_TO_CHAR (it
->c
);
6986 c
= BYTE8_TO_CHAR (it
->c
);
6990 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6993 struct Lisp_Vector
*v
= XVECTOR (dv
);
6995 /* Return the first character from the display table
6996 entry, if not empty. If empty, don't display the
6997 current character. */
7000 it
->dpvec_char_len
= it
->len
;
7001 it
->dpvec
= v
->contents
;
7002 it
->dpend
= v
->contents
+ v
->header
.size
;
7003 it
->current
.dpvec_index
= 0;
7004 it
->dpvec_face_id
= -1;
7005 it
->saved_face_id
= it
->face_id
;
7006 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7011 set_iterator_to_next (it
, 0);
7016 if (! NILP (lookup_glyphless_char_display (c
, it
)))
7018 if (it
->what
== IT_GLYPHLESS
)
7020 /* Don't display this character. */
7021 set_iterator_to_next (it
, 0);
7025 /* If `nobreak-char-display' is non-nil, we display
7026 non-ASCII spaces and hyphens specially. */
7027 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
7030 nonascii_space_p
= true;
7031 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
7032 nonascii_hyphen_p
= true;
7035 /* Translate control characters into `\003' or `^C' form.
7036 Control characters coming from a display table entry are
7037 currently not translated because we use IT->dpvec to hold
7038 the translation. This could easily be changed but I
7039 don't believe that it is worth doing.
7041 The characters handled by `nobreak-char-display' must be
7044 Non-printable characters and raw-byte characters are also
7045 translated to octal form. */
7046 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
7047 ? (it
->area
!= TEXT_AREA
7048 /* In mode line, treat \n, \t like other crl chars. */
7051 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
7052 || (c
!= '\n' && c
!= '\t'))
7054 || nonascii_hyphen_p
7056 || ! CHAR_PRINTABLE_P (c
))))
7058 /* C is a control character, non-ASCII space/hyphen,
7059 raw-byte, or a non-printable character which must be
7060 displayed either as '\003' or as `^C' where the '\\'
7061 and '^' can be defined in the display table. Fill
7062 IT->ctl_chars with glyphs for what we have to
7063 display. Then, set IT->dpvec to these glyphs. */
7070 /* Handle control characters with ^. */
7072 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
7076 g
= '^'; /* default glyph for Control */
7077 /* Set IT->ctl_chars[0] to the glyph for `^'. */
7079 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7081 g
= GLYPH_CODE_CHAR (gc
);
7082 lface_id
= GLYPH_CODE_FACE (gc
);
7086 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7087 : merge_escape_glyph_face (it
));
7089 XSETINT (it
->ctl_chars
[0], g
);
7090 XSETINT (it
->ctl_chars
[1], c
^ 0100);
7092 goto display_control
;
7095 /* Handle non-ascii space in the mode where it only gets
7098 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7100 /* Merge `nobreak-space' into the current face. */
7101 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7103 XSETINT (it
->ctl_chars
[0], ' ');
7105 goto display_control
;
7108 /* Handle sequences that start with the "escape glyph". */
7110 /* the default escape glyph is \. */
7111 escape_glyph
= '\\';
7114 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7116 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7117 lface_id
= GLYPH_CODE_FACE (gc
);
7121 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7122 : merge_escape_glyph_face (it
));
7124 /* Draw non-ASCII hyphen with just highlighting: */
7126 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7128 XSETINT (it
->ctl_chars
[0], '-');
7130 goto display_control
;
7133 /* Draw non-ASCII space/hyphen with escape glyph: */
7135 if (nonascii_space_p
|| nonascii_hyphen_p
)
7137 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7138 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7140 goto display_control
;
7147 if (CHAR_BYTE8_P (c
))
7148 /* Display \200 instead of \17777600. */
7149 c
= CHAR_TO_BYTE8 (c
);
7150 len
= sprintf (str
, "%03o", c
);
7152 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7153 for (i
= 0; i
< len
; i
++)
7154 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7159 /* Set up IT->dpvec and return first character from it. */
7160 it
->dpvec_char_len
= it
->len
;
7161 it
->dpvec
= it
->ctl_chars
;
7162 it
->dpend
= it
->dpvec
+ ctl_len
;
7163 it
->current
.dpvec_index
= 0;
7164 it
->dpvec_face_id
= face_id
;
7165 it
->saved_face_id
= it
->face_id
;
7166 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7170 it
->char_to_display
= c
;
7174 it
->char_to_display
= it
->c
;
7178 #ifdef HAVE_WINDOW_SYSTEM
7179 /* Adjust face id for a multibyte character. There are no multibyte
7180 character in unibyte text. */
7181 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7184 && FRAME_WINDOW_P (it
->f
))
7186 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7188 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7190 /* Automatic composition with glyph-string. */
7191 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7193 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7197 ptrdiff_t pos
= (it
->s
? -1
7198 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7199 : IT_CHARPOS (*it
));
7202 if (it
->what
== IT_CHARACTER
)
7203 c
= it
->char_to_display
;
7206 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7210 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7211 /* TAB in a composition means display glyphs with
7212 padding space on the left or right. */
7213 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7216 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7219 #endif /* HAVE_WINDOW_SYSTEM */
7222 /* Is this character the last one of a run of characters with
7223 box? If yes, set IT->end_of_box_run_p to 1. */
7227 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7229 int face_id
= underlying_face_id (it
);
7230 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7234 if (face
->box
== FACE_NO_BOX
)
7236 /* If the box comes from face properties in a
7237 display string, check faces in that string. */
7238 int string_face_id
= face_after_it_pos (it
);
7239 it
->end_of_box_run_p
7240 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7243 /* Otherwise, the box comes from the underlying face.
7244 If this is the last string character displayed, check
7245 the next buffer location. */
7246 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7247 /* n_overlay_strings is unreliable unless
7248 overlay_string_index is non-negative. */
7249 && ((it
->current
.overlay_string_index
>= 0
7250 && (it
->current
.overlay_string_index
7251 == it
->n_overlay_strings
- 1))
7252 /* A string from display property. */
7253 || it
->from_disp_prop_p
))
7257 struct text_pos pos
= it
->current
.pos
;
7259 /* For a string from a display property, the next
7260 buffer position is stored in the 'position'
7261 member of the iteration stack slot below the
7262 current one, see handle_single_display_spec. By
7263 contrast, it->current.pos was is not yet updated
7264 to point to that buffer position; that will
7265 happen in pop_it, after we finish displaying the
7266 current string. Note that we already checked
7267 above that it->sp is positive, so subtracting one
7269 if (it
->from_disp_prop_p
)
7270 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7272 INC_TEXT_POS (pos
, it
->multibyte_p
);
7274 if (CHARPOS (pos
) >= ZV
)
7275 it
->end_of_box_run_p
= true;
7278 next_face_id
= face_at_buffer_position
7279 (it
->w
, CHARPOS (pos
), &ignore
,
7280 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, 0, -1);
7281 it
->end_of_box_run_p
7282 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7288 /* next_element_from_display_vector sets this flag according to
7289 faces of the display vector glyphs, see there. */
7290 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7292 int face_id
= face_after_it_pos (it
);
7293 it
->end_of_box_run_p
7294 = (face_id
!= it
->face_id
7295 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7298 /* If we reached the end of the object we've been iterating (e.g., a
7299 display string or an overlay string), and there's something on
7300 IT->stack, proceed with what's on the stack. It doesn't make
7301 sense to return zero if there's unprocessed stuff on the stack,
7302 because otherwise that stuff will never be displayed. */
7303 if (!success_p
&& it
->sp
> 0)
7305 set_iterator_to_next (it
, 0);
7306 success_p
= get_next_display_element (it
);
7309 /* Value is 0 if end of buffer or string reached. */
7314 /* Move IT to the next display element.
7316 RESEAT_P non-zero means if called on a newline in buffer text,
7317 skip to the next visible line start.
7319 Functions get_next_display_element and set_iterator_to_next are
7320 separate because I find this arrangement easier to handle than a
7321 get_next_display_element function that also increments IT's
7322 position. The way it is we can first look at an iterator's current
7323 display element, decide whether it fits on a line, and if it does,
7324 increment the iterator position. The other way around we probably
7325 would either need a flag indicating whether the iterator has to be
7326 incremented the next time, or we would have to implement a
7327 decrement position function which would not be easy to write. */
7330 set_iterator_to_next (struct it
*it
, int reseat_p
)
7332 /* Reset flags indicating start and end of a sequence of characters
7333 with box. Reset them at the start of this function because
7334 moving the iterator to a new position might set them. */
7335 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
7339 case GET_FROM_BUFFER
:
7340 /* The current display element of IT is a character from
7341 current_buffer. Advance in the buffer, and maybe skip over
7342 invisible lines that are so because of selective display. */
7343 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7344 reseat_at_next_visible_line_start (it
, 0);
7345 else if (it
->cmp_it
.id
>= 0)
7347 /* We are currently getting glyphs from a composition. */
7350 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7351 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7357 /* Update IT's char/byte positions to point to the first
7358 character of the next grapheme cluster, or to the
7359 character visually after the current composition. */
7360 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7361 bidi_move_to_visually_next (&it
->bidi_it
);
7362 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7363 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7366 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7367 && it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7369 /* Composition created while scanning forward. Proceed
7370 to the next grapheme cluster. */
7371 it
->cmp_it
.from
= it
->cmp_it
.to
;
7373 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7374 && it
->cmp_it
.from
> 0)
7376 /* Composition created while scanning backward. Proceed
7377 to the previous grapheme cluster. */
7378 it
->cmp_it
.to
= it
->cmp_it
.from
;
7382 /* No more grapheme clusters in this composition.
7383 Find the next stop position. */
7384 ptrdiff_t stop
= it
->end_charpos
;
7386 if (it
->bidi_it
.scan_dir
< 0)
7387 /* Now we are scanning backward and don't know
7390 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7391 IT_BYTEPOS (*it
), stop
, Qnil
);
7396 eassert (it
->len
!= 0);
7400 IT_BYTEPOS (*it
) += it
->len
;
7401 IT_CHARPOS (*it
) += 1;
7405 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7406 /* If this is a new paragraph, determine its base
7407 direction (a.k.a. its base embedding level). */
7408 if (it
->bidi_it
.new_paragraph
)
7409 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7410 bidi_move_to_visually_next (&it
->bidi_it
);
7411 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7412 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7413 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7415 /* As the scan direction was changed, we must
7416 re-compute the stop position for composition. */
7417 ptrdiff_t stop
= it
->end_charpos
;
7418 if (it
->bidi_it
.scan_dir
< 0)
7420 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7421 IT_BYTEPOS (*it
), stop
, Qnil
);
7424 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7428 case GET_FROM_C_STRING
:
7429 /* Current display element of IT is from a C string. */
7431 /* If the string position is beyond string's end, it means
7432 next_element_from_c_string is padding the string with
7433 blanks, in which case we bypass the bidi iterator,
7434 because it cannot deal with such virtual characters. */
7435 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7437 IT_BYTEPOS (*it
) += it
->len
;
7438 IT_CHARPOS (*it
) += 1;
7442 bidi_move_to_visually_next (&it
->bidi_it
);
7443 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7444 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7448 case GET_FROM_DISPLAY_VECTOR
:
7449 /* Current display element of IT is from a display table entry.
7450 Advance in the display table definition. Reset it to null if
7451 end reached, and continue with characters from buffers/
7453 ++it
->current
.dpvec_index
;
7455 /* Restore face of the iterator to what they were before the
7456 display vector entry (these entries may contain faces). */
7457 it
->face_id
= it
->saved_face_id
;
7459 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7461 int recheck_faces
= it
->ellipsis_p
;
7464 it
->method
= GET_FROM_C_STRING
;
7465 else if (STRINGP (it
->string
))
7466 it
->method
= GET_FROM_STRING
;
7469 it
->method
= GET_FROM_BUFFER
;
7470 it
->object
= it
->w
->contents
;
7474 it
->current
.dpvec_index
= -1;
7476 /* Skip over characters which were displayed via IT->dpvec. */
7477 if (it
->dpvec_char_len
< 0)
7478 reseat_at_next_visible_line_start (it
, 1);
7479 else if (it
->dpvec_char_len
> 0)
7481 if (it
->method
== GET_FROM_STRING
7482 && it
->current
.overlay_string_index
>= 0
7483 && it
->n_overlay_strings
> 0)
7484 it
->ignore_overlay_strings_at_pos_p
= true;
7485 it
->len
= it
->dpvec_char_len
;
7486 set_iterator_to_next (it
, reseat_p
);
7489 /* Maybe recheck faces after display vector. */
7491 it
->stop_charpos
= IT_CHARPOS (*it
);
7495 case GET_FROM_STRING
:
7496 /* Current display element is a character from a Lisp string. */
7497 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7498 /* Don't advance past string end. These conditions are true
7499 when set_iterator_to_next is called at the end of
7500 get_next_display_element, in which case the Lisp string is
7501 already exhausted, and all we want is pop the iterator
7503 if (it
->current
.overlay_string_index
>= 0)
7505 /* This is an overlay string, so there's no padding with
7506 spaces, and the number of characters in the string is
7507 where the string ends. */
7508 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7509 goto consider_string_end
;
7513 /* Not an overlay string. There could be padding, so test
7514 against it->end_charpos. */
7515 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7516 goto consider_string_end
;
7518 if (it
->cmp_it
.id
>= 0)
7520 /* We are delivering display elements from a composition.
7521 Update the string position past the grapheme cluster
7522 we've just processed. */
7525 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7526 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7532 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7533 bidi_move_to_visually_next (&it
->bidi_it
);
7534 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7535 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7538 /* Did we exhaust all the grapheme clusters of this
7540 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7541 && (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
))
7543 /* Not all the grapheme clusters were processed yet;
7544 advance to the next cluster. */
7545 it
->cmp_it
.from
= it
->cmp_it
.to
;
7547 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7548 && it
->cmp_it
.from
> 0)
7550 /* Likewise: advance to the next cluster, but going in
7551 the reverse direction. */
7552 it
->cmp_it
.to
= it
->cmp_it
.from
;
7556 /* This composition was fully processed; find the next
7557 candidate place for checking for composed
7559 /* Always limit string searches to the string length;
7560 any padding spaces are not part of the string, and
7561 there cannot be any compositions in that padding. */
7562 ptrdiff_t stop
= SCHARS (it
->string
);
7564 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
7566 else if (it
->end_charpos
< stop
)
7568 /* Cf. PRECISION in reseat_to_string: we might be
7569 limited in how many of the string characters we
7571 stop
= it
->end_charpos
;
7573 composition_compute_stop_pos (&it
->cmp_it
,
7574 IT_STRING_CHARPOS (*it
),
7575 IT_STRING_BYTEPOS (*it
), stop
,
7582 /* If the string position is beyond string's end, it
7583 means next_element_from_string is padding the string
7584 with blanks, in which case we bypass the bidi
7585 iterator, because it cannot deal with such virtual
7587 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7589 IT_STRING_BYTEPOS (*it
) += it
->len
;
7590 IT_STRING_CHARPOS (*it
) += 1;
7594 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7596 bidi_move_to_visually_next (&it
->bidi_it
);
7597 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7598 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7599 /* If the scan direction changes, we may need to update
7600 the place where to check for composed characters. */
7601 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7603 ptrdiff_t stop
= SCHARS (it
->string
);
7605 if (it
->bidi_it
.scan_dir
< 0)
7607 else if (it
->end_charpos
< stop
)
7608 stop
= it
->end_charpos
;
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 /* We moved to the next buffer position, so any info about
8331 previously seen overlays is no longer valid. */
8332 it
->ignore_overlay_strings_at_pos_p
= 0;
8334 /* Maybe run the redisplay end trigger hook. Performance note:
8335 This doesn't seem to cost measurable time. */
8336 if (it
->redisplay_end_trigger_charpos
8338 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8339 run_redisplay_end_trigger_hook (it
);
8341 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8342 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8344 && next_element_from_composition (it
))
8349 /* Get the next character, maybe multibyte. */
8350 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8351 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
8352 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8354 it
->c
= *p
, it
->len
= 1;
8356 /* Record what we have and where it came from. */
8357 it
->what
= IT_CHARACTER
;
8358 it
->object
= it
->w
->contents
;
8359 it
->position
= it
->current
.pos
;
8361 /* Normally we return the character found above, except when we
8362 really want to return an ellipsis for selective display. */
8367 /* A value of selective > 0 means hide lines indented more
8368 than that number of columns. */
8369 if (it
->selective
> 0
8370 && IT_CHARPOS (*it
) + 1 < ZV
8371 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8372 IT_BYTEPOS (*it
) + 1,
8375 success_p
= next_element_from_ellipsis (it
);
8376 it
->dpvec_char_len
= -1;
8379 else if (it
->c
== '\r' && it
->selective
== -1)
8381 /* A value of selective == -1 means that everything from the
8382 CR to the end of the line is invisible, with maybe an
8383 ellipsis displayed for it. */
8384 success_p
= next_element_from_ellipsis (it
);
8385 it
->dpvec_char_len
= -1;
8390 /* Value is zero if end of buffer reached. */
8391 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8396 /* Run the redisplay end trigger hook for IT. */
8399 run_redisplay_end_trigger_hook (struct it
*it
)
8401 Lisp_Object args
[3];
8403 /* IT->glyph_row should be non-null, i.e. we should be actually
8404 displaying something, or otherwise we should not run the hook. */
8405 eassert (it
->glyph_row
);
8407 /* Set up hook arguments. */
8408 args
[0] = Qredisplay_end_trigger_functions
;
8409 args
[1] = it
->window
;
8410 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8411 it
->redisplay_end_trigger_charpos
= 0;
8413 /* Since we are *trying* to run these functions, don't try to run
8414 them again, even if they get an error. */
8415 wset_redisplay_end_trigger (it
->w
, Qnil
);
8416 Frun_hook_with_args (3, args
);
8418 /* Notice if it changed the face of the character we are on. */
8419 handle_face_prop (it
);
8423 /* Deliver a composition display element. Unlike the other
8424 next_element_from_XXX, this function is not registered in the array
8425 get_next_element[]. It is called from next_element_from_buffer and
8426 next_element_from_string when necessary. */
8429 next_element_from_composition (struct it
*it
)
8431 it
->what
= IT_COMPOSITION
;
8432 it
->len
= it
->cmp_it
.nbytes
;
8433 if (STRINGP (it
->string
))
8437 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8438 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8441 it
->position
= it
->current
.string_pos
;
8442 it
->object
= it
->string
;
8443 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8444 IT_STRING_BYTEPOS (*it
), it
->string
);
8450 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8451 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8454 if (it
->bidi_it
.new_paragraph
)
8455 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8456 /* Resync the bidi iterator with IT's new position.
8457 FIXME: this doesn't support bidirectional text. */
8458 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8459 bidi_move_to_visually_next (&it
->bidi_it
);
8463 it
->position
= it
->current
.pos
;
8464 it
->object
= it
->w
->contents
;
8465 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8466 IT_BYTEPOS (*it
), Qnil
);
8473 /***********************************************************************
8474 Moving an iterator without producing glyphs
8475 ***********************************************************************/
8477 /* Check if iterator is at a position corresponding to a valid buffer
8478 position after some move_it_ call. */
8480 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8481 ((it)->method == GET_FROM_STRING \
8482 ? IT_STRING_CHARPOS (*it) == 0 \
8486 /* Move iterator IT to a specified buffer or X position within one
8487 line on the display without producing glyphs.
8489 OP should be a bit mask including some or all of these bits:
8490 MOVE_TO_X: Stop upon reaching x-position TO_X.
8491 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8492 Regardless of OP's value, stop upon reaching the end of the display line.
8494 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8495 This means, in particular, that TO_X includes window's horizontal
8498 The return value has several possible values that
8499 say what condition caused the scan to stop:
8501 MOVE_POS_MATCH_OR_ZV
8502 - when TO_POS or ZV was reached.
8505 -when TO_X was reached before TO_POS or ZV were reached.
8508 - when we reached the end of the display area and the line must
8512 - when we reached the end of the display area and the line is
8516 - when we stopped at a line end, i.e. a newline or a CR and selective
8519 static enum move_it_result
8520 move_it_in_display_line_to (struct it
*it
,
8521 ptrdiff_t to_charpos
, int to_x
,
8522 enum move_operation_enum op
)
8524 enum move_it_result result
= MOVE_UNDEFINED
;
8525 struct glyph_row
*saved_glyph_row
;
8526 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8527 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8528 void *ppos_data
= NULL
;
8530 enum it_method prev_method
= it
->method
;
8531 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8532 int saw_smaller_pos
= prev_pos
< to_charpos
;
8534 /* Don't produce glyphs in produce_glyphs. */
8535 saved_glyph_row
= it
->glyph_row
;
8536 it
->glyph_row
= NULL
;
8538 /* Use wrap_it to save a copy of IT wherever a word wrap could
8539 occur. Use atpos_it to save a copy of IT at the desired buffer
8540 position, if found, so that we can scan ahead and check if the
8541 word later overshoots the window edge. Use atx_it similarly, for
8547 /* Use ppos_it under bidi reordering to save a copy of IT for the
8548 initial position. We restore that position in IT when we have
8549 scanned the entire display line without finding a match for
8550 TO_CHARPOS and all the character positions are greater than
8551 TO_CHARPOS. We then restart the scan from the initial position,
8552 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8553 the closest to TO_CHARPOS. */
8556 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8558 SAVE_IT (ppos_it
, *it
, ppos_data
);
8559 closest_pos
= IT_CHARPOS (*it
);
8565 #define BUFFER_POS_REACHED_P() \
8566 ((op & MOVE_TO_POS) != 0 \
8567 && BUFFERP (it->object) \
8568 && (IT_CHARPOS (*it) == to_charpos \
8570 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8571 && IT_CHARPOS (*it) > to_charpos) \
8572 || (it->what == IT_COMPOSITION \
8573 && ((IT_CHARPOS (*it) > to_charpos \
8574 && to_charpos >= it->cmp_it.charpos) \
8575 || (IT_CHARPOS (*it) < to_charpos \
8576 && to_charpos <= it->cmp_it.charpos)))) \
8577 && (it->method == GET_FROM_BUFFER \
8578 || (it->method == GET_FROM_DISPLAY_VECTOR \
8579 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8581 /* If there's a line-/wrap-prefix, handle it. */
8582 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8583 && it
->current_y
< it
->last_visible_y
)
8584 handle_line_prefix (it
);
8586 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8587 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8591 int x
, i
, ascent
= 0, descent
= 0;
8593 /* Utility macro to reset an iterator with x, ascent, and descent. */
8594 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8595 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8596 (IT)->max_descent = descent)
8598 /* Stop if we move beyond TO_CHARPOS (after an image or a
8599 display string or stretch glyph). */
8600 if ((op
& MOVE_TO_POS
) != 0
8601 && BUFFERP (it
->object
)
8602 && it
->method
== GET_FROM_BUFFER
8604 /* When the iterator is at base embedding level, we
8605 are guaranteed that characters are delivered for
8606 display in strictly increasing order of their
8607 buffer positions. */
8608 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8609 && IT_CHARPOS (*it
) > to_charpos
)
8611 && (prev_method
== GET_FROM_IMAGE
8612 || prev_method
== GET_FROM_STRETCH
8613 || prev_method
== GET_FROM_STRING
)
8614 /* Passed TO_CHARPOS from left to right. */
8615 && ((prev_pos
< to_charpos
8616 && IT_CHARPOS (*it
) > to_charpos
)
8617 /* Passed TO_CHARPOS from right to left. */
8618 || (prev_pos
> to_charpos
8619 && IT_CHARPOS (*it
) < to_charpos
)))))
8621 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8623 result
= MOVE_POS_MATCH_OR_ZV
;
8626 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8627 /* If wrap_it is valid, the current position might be in a
8628 word that is wrapped. So, save the iterator in
8629 atpos_it and continue to see if wrapping happens. */
8630 SAVE_IT (atpos_it
, *it
, atpos_data
);
8633 /* Stop when ZV reached.
8634 We used to stop here when TO_CHARPOS reached as well, but that is
8635 too soon if this glyph does not fit on this line. So we handle it
8636 explicitly below. */
8637 if (!get_next_display_element (it
))
8639 result
= MOVE_POS_MATCH_OR_ZV
;
8643 if (it
->line_wrap
== TRUNCATE
)
8645 if (BUFFER_POS_REACHED_P ())
8647 result
= MOVE_POS_MATCH_OR_ZV
;
8653 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8655 if (IT_DISPLAYING_WHITESPACE (it
))
8659 /* We have reached a glyph that follows one or more
8660 whitespace characters. If the position is
8661 already found, we are done. */
8662 if (atpos_it
.sp
>= 0)
8664 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8665 result
= MOVE_POS_MATCH_OR_ZV
;
8670 RESTORE_IT (it
, &atx_it
, atx_data
);
8671 result
= MOVE_X_REACHED
;
8674 /* Otherwise, we can wrap here. */
8675 SAVE_IT (wrap_it
, *it
, wrap_data
);
8681 /* Remember the line height for the current line, in case
8682 the next element doesn't fit on the line. */
8683 ascent
= it
->max_ascent
;
8684 descent
= it
->max_descent
;
8686 /* The call to produce_glyphs will get the metrics of the
8687 display element IT is loaded with. Record the x-position
8688 before this display element, in case it doesn't fit on the
8692 PRODUCE_GLYPHS (it
);
8694 if (it
->area
!= TEXT_AREA
)
8696 prev_method
= it
->method
;
8697 if (it
->method
== GET_FROM_BUFFER
)
8698 prev_pos
= IT_CHARPOS (*it
);
8699 set_iterator_to_next (it
, 1);
8700 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8701 SET_TEXT_POS (this_line_min_pos
,
8702 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8704 && (op
& MOVE_TO_POS
)
8705 && IT_CHARPOS (*it
) > to_charpos
8706 && IT_CHARPOS (*it
) < closest_pos
)
8707 closest_pos
= IT_CHARPOS (*it
);
8711 /* The number of glyphs we get back in IT->nglyphs will normally
8712 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8713 character on a terminal frame, or (iii) a line end. For the
8714 second case, IT->nglyphs - 1 padding glyphs will be present.
8715 (On X frames, there is only one glyph produced for a
8716 composite character.)
8718 The behavior implemented below means, for continuation lines,
8719 that as many spaces of a TAB as fit on the current line are
8720 displayed there. For terminal frames, as many glyphs of a
8721 multi-glyph character are displayed in the current line, too.
8722 This is what the old redisplay code did, and we keep it that
8723 way. Under X, the whole shape of a complex character must
8724 fit on the line or it will be completely displayed in the
8727 Note that both for tabs and padding glyphs, all glyphs have
8731 /* More than one glyph or glyph doesn't fit on line. All
8732 glyphs have the same width. */
8733 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8735 int x_before_this_char
= x
;
8736 int hpos_before_this_char
= it
->hpos
;
8738 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8740 new_x
= x
+ single_glyph_width
;
8742 /* We want to leave anything reaching TO_X to the caller. */
8743 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8745 if (BUFFER_POS_REACHED_P ())
8747 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8748 goto buffer_pos_reached
;
8749 if (atpos_it
.sp
< 0)
8751 SAVE_IT (atpos_it
, *it
, atpos_data
);
8752 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8757 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8760 result
= MOVE_X_REACHED
;
8765 SAVE_IT (atx_it
, *it
, atx_data
);
8766 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8771 if (/* Lines are continued. */
8772 it
->line_wrap
!= TRUNCATE
8773 && (/* And glyph doesn't fit on the line. */
8774 new_x
> it
->last_visible_x
8775 /* Or it fits exactly and we're on a window
8777 || (new_x
== it
->last_visible_x
8778 && FRAME_WINDOW_P (it
->f
)
8779 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8780 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8781 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8783 if (/* IT->hpos == 0 means the very first glyph
8784 doesn't fit on the line, e.g. a wide image. */
8786 || (new_x
== it
->last_visible_x
8787 && FRAME_WINDOW_P (it
->f
)))
8790 it
->current_x
= new_x
;
8792 /* The character's last glyph just barely fits
8794 if (i
== it
->nglyphs
- 1)
8796 /* If this is the destination position,
8797 return a position *before* it in this row,
8798 now that we know it fits in this row. */
8799 if (BUFFER_POS_REACHED_P ())
8801 if (it
->line_wrap
!= WORD_WRAP
8804 it
->hpos
= hpos_before_this_char
;
8805 it
->current_x
= x_before_this_char
;
8806 result
= MOVE_POS_MATCH_OR_ZV
;
8809 if (it
->line_wrap
== WORD_WRAP
8812 SAVE_IT (atpos_it
, *it
, atpos_data
);
8813 atpos_it
.current_x
= x_before_this_char
;
8814 atpos_it
.hpos
= hpos_before_this_char
;
8818 prev_method
= it
->method
;
8819 if (it
->method
== GET_FROM_BUFFER
)
8820 prev_pos
= IT_CHARPOS (*it
);
8821 set_iterator_to_next (it
, 1);
8822 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8823 SET_TEXT_POS (this_line_min_pos
,
8824 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8825 /* On graphical terminals, newlines may
8826 "overflow" into the fringe if
8827 overflow-newline-into-fringe is non-nil.
8828 On text terminals, and on graphical
8829 terminals with no right margin, newlines
8830 may overflow into the last glyph on the
8832 if (!FRAME_WINDOW_P (it
->f
)
8834 && it
->bidi_it
.paragraph_dir
== R2L
)
8835 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8836 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8837 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8839 if (!get_next_display_element (it
))
8841 result
= MOVE_POS_MATCH_OR_ZV
;
8844 if (BUFFER_POS_REACHED_P ())
8846 if (ITERATOR_AT_END_OF_LINE_P (it
))
8847 result
= MOVE_POS_MATCH_OR_ZV
;
8849 result
= MOVE_LINE_CONTINUED
;
8852 if (ITERATOR_AT_END_OF_LINE_P (it
)
8853 && (it
->line_wrap
!= WORD_WRAP
8855 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
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);
11785 unbind_to (count
, Qnil
);
11789 struct frame
*sf
= SELECTED_FRAME ();
11790 update_menu_bar (sf
, 1, 0);
11791 #ifdef HAVE_WINDOW_SYSTEM
11792 update_tool_bar (sf
, 1);
11798 /* Update the menu bar item list for frame F. This has to be done
11799 before we start to fill in any display lines, because it can call
11802 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11804 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11805 already ran the menu bar hooks for this redisplay, so there
11806 is no need to run them again. The return value is the
11807 updated value of this flag, to pass to the next call. */
11810 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11812 Lisp_Object window
;
11813 register struct window
*w
;
11815 /* If called recursively during a menu update, do nothing. This can
11816 happen when, for instance, an activate-menubar-hook causes a
11818 if (inhibit_menubar_update
)
11821 window
= FRAME_SELECTED_WINDOW (f
);
11822 w
= XWINDOW (window
);
11824 if (FRAME_WINDOW_P (f
)
11826 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11827 || defined (HAVE_NS) || defined (USE_GTK)
11828 FRAME_EXTERNAL_MENU_BAR (f
)
11830 FRAME_MENU_BAR_LINES (f
) > 0
11832 : FRAME_MENU_BAR_LINES (f
) > 0)
11834 /* If the user has switched buffers or windows, we need to
11835 recompute to reflect the new bindings. But we'll
11836 recompute when update_mode_lines is set too; that means
11837 that people can use force-mode-line-update to request
11838 that the menu bar be recomputed. The adverse effect on
11839 the rest of the redisplay algorithm is about the same as
11840 windows_or_buffers_changed anyway. */
11841 if (windows_or_buffers_changed
11842 /* This used to test w->update_mode_line, but we believe
11843 there is no need to recompute the menu in that case. */
11844 || update_mode_lines
11845 || window_buffer_changed (w
))
11847 struct buffer
*prev
= current_buffer
;
11848 ptrdiff_t count
= SPECPDL_INDEX ();
11850 specbind (Qinhibit_menubar_update
, Qt
);
11852 set_buffer_internal_1 (XBUFFER (w
->contents
));
11853 if (save_match_data
)
11854 record_unwind_save_match_data ();
11855 if (NILP (Voverriding_local_map_menu_flag
))
11857 specbind (Qoverriding_terminal_local_map
, Qnil
);
11858 specbind (Qoverriding_local_map
, Qnil
);
11863 /* Run the Lucid hook. */
11864 safe_run_hooks (Qactivate_menubar_hook
);
11866 /* If it has changed current-menubar from previous value,
11867 really recompute the menu-bar from the value. */
11868 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11869 call0 (Qrecompute_lucid_menubar
);
11871 safe_run_hooks (Qmenu_bar_update_hook
);
11876 XSETFRAME (Vmenu_updating_frame
, f
);
11877 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11879 /* Redisplay the menu bar in case we changed it. */
11880 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11881 || defined (HAVE_NS) || defined (USE_GTK)
11882 if (FRAME_WINDOW_P (f
))
11884 #if defined (HAVE_NS)
11885 /* All frames on Mac OS share the same menubar. So only
11886 the selected frame should be allowed to set it. */
11887 if (f
== SELECTED_FRAME ())
11889 set_frame_menubar (f
, 0, 0);
11892 /* On a terminal screen, the menu bar is an ordinary screen
11893 line, and this makes it get updated. */
11894 w
->update_mode_line
= 1;
11895 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11896 /* In the non-toolkit version, the menu bar is an ordinary screen
11897 line, and this makes it get updated. */
11898 w
->update_mode_line
= 1;
11899 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11901 unbind_to (count
, Qnil
);
11902 set_buffer_internal_1 (prev
);
11909 /***********************************************************************
11911 ***********************************************************************/
11913 #ifdef HAVE_WINDOW_SYSTEM
11915 /* Tool-bar item index of the item on which a mouse button was pressed
11918 int last_tool_bar_item
;
11920 /* Select `frame' temporarily without running all the code in
11922 FIXME: Maybe do_switch_frame should be trimmed down similarly
11923 when `norecord' is set. */
11925 fast_set_selected_frame (Lisp_Object frame
)
11927 if (!EQ (selected_frame
, frame
))
11929 selected_frame
= frame
;
11930 selected_window
= XFRAME (frame
)->selected_window
;
11934 /* Update the tool-bar item list for frame F. This has to be done
11935 before we start to fill in any display lines. Called from
11936 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11937 and restore it here. */
11940 update_tool_bar (struct frame
*f
, int save_match_data
)
11942 #if defined (USE_GTK) || defined (HAVE_NS)
11943 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11945 int do_update
= (WINDOWP (f
->tool_bar_window
)
11946 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0);
11951 Lisp_Object window
;
11954 window
= FRAME_SELECTED_WINDOW (f
);
11955 w
= XWINDOW (window
);
11957 /* If the user has switched buffers or windows, we need to
11958 recompute to reflect the new bindings. But we'll
11959 recompute when update_mode_lines is set too; that means
11960 that people can use force-mode-line-update to request
11961 that the menu bar be recomputed. The adverse effect on
11962 the rest of the redisplay algorithm is about the same as
11963 windows_or_buffers_changed anyway. */
11964 if (windows_or_buffers_changed
11965 || w
->update_mode_line
11966 || update_mode_lines
11967 || window_buffer_changed (w
))
11969 struct buffer
*prev
= current_buffer
;
11970 ptrdiff_t count
= SPECPDL_INDEX ();
11971 Lisp_Object frame
, new_tool_bar
;
11972 int new_n_tool_bar
;
11973 struct gcpro gcpro1
;
11975 /* Set current_buffer to the buffer of the selected
11976 window of the frame, so that we get the right local
11978 set_buffer_internal_1 (XBUFFER (w
->contents
));
11980 /* Save match data, if we must. */
11981 if (save_match_data
)
11982 record_unwind_save_match_data ();
11984 /* Make sure that we don't accidentally use bogus keymaps. */
11985 if (NILP (Voverriding_local_map_menu_flag
))
11987 specbind (Qoverriding_terminal_local_map
, Qnil
);
11988 specbind (Qoverriding_local_map
, Qnil
);
11991 GCPRO1 (new_tool_bar
);
11993 /* We must temporarily set the selected frame to this frame
11994 before calling tool_bar_items, because the calculation of
11995 the tool-bar keymap uses the selected frame (see
11996 `tool-bar-make-keymap' in tool-bar.el). */
11997 eassert (EQ (selected_window
,
11998 /* Since we only explicitly preserve selected_frame,
11999 check that selected_window would be redundant. */
12000 XFRAME (selected_frame
)->selected_window
));
12001 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
12002 XSETFRAME (frame
, f
);
12003 fast_set_selected_frame (frame
);
12005 /* Build desired tool-bar items from keymaps. */
12007 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
12010 /* Redisplay the tool-bar if we changed it. */
12011 if (new_n_tool_bar
!= f
->n_tool_bar_items
12012 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
12014 /* Redisplay that happens asynchronously due to an expose event
12015 may access f->tool_bar_items. Make sure we update both
12016 variables within BLOCK_INPUT so no such event interrupts. */
12018 fset_tool_bar_items (f
, new_tool_bar
);
12019 f
->n_tool_bar_items
= new_n_tool_bar
;
12020 w
->update_mode_line
= 1;
12026 unbind_to (count
, Qnil
);
12027 set_buffer_internal_1 (prev
);
12032 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12034 /* Set F->desired_tool_bar_string to a Lisp string representing frame
12035 F's desired tool-bar contents. F->tool_bar_items must have
12036 been set up previously by calling prepare_menu_bars. */
12039 build_desired_tool_bar_string (struct frame
*f
)
12041 int i
, size
, size_needed
;
12042 struct gcpro gcpro1
, gcpro2
, gcpro3
;
12043 Lisp_Object image
, plist
, props
;
12045 image
= plist
= props
= Qnil
;
12046 GCPRO3 (image
, plist
, props
);
12048 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
12049 Otherwise, make a new string. */
12051 /* The size of the string we might be able to reuse. */
12052 size
= (STRINGP (f
->desired_tool_bar_string
)
12053 ? SCHARS (f
->desired_tool_bar_string
)
12056 /* We need one space in the string for each image. */
12057 size_needed
= f
->n_tool_bar_items
;
12059 /* Reuse f->desired_tool_bar_string, if possible. */
12060 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
12061 fset_desired_tool_bar_string
12062 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
12065 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
12066 Fremove_text_properties (make_number (0), make_number (size
),
12067 props
, f
->desired_tool_bar_string
);
12070 /* Put a `display' property on the string for the images to display,
12071 put a `menu_item' property on tool-bar items with a value that
12072 is the index of the item in F's tool-bar item vector. */
12073 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
12075 #define PROP(IDX) \
12076 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12078 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
12079 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
12080 int hmargin
, vmargin
, relief
, idx
, end
;
12082 /* If image is a vector, choose the image according to the
12084 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
12085 if (VECTORP (image
))
12089 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12090 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12093 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12094 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12096 eassert (ASIZE (image
) >= idx
);
12097 image
= AREF (image
, idx
);
12102 /* Ignore invalid image specifications. */
12103 if (!valid_image_p (image
))
12106 /* Display the tool-bar button pressed, or depressed. */
12107 plist
= Fcopy_sequence (XCDR (image
));
12109 /* Compute margin and relief to draw. */
12110 relief
= (tool_bar_button_relief
>= 0
12111 ? tool_bar_button_relief
12112 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12113 hmargin
= vmargin
= relief
;
12115 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12116 INT_MAX
- max (hmargin
, vmargin
)))
12118 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12119 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12121 else if (CONSP (Vtool_bar_button_margin
))
12123 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12124 INT_MAX
- hmargin
))
12125 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12127 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12128 INT_MAX
- vmargin
))
12129 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12132 if (auto_raise_tool_bar_buttons_p
)
12134 /* Add a `:relief' property to the image spec if the item is
12138 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12145 /* If image is selected, display it pressed, i.e. with a
12146 negative relief. If it's not selected, display it with a
12148 plist
= Fplist_put (plist
, QCrelief
,
12150 ? make_number (-relief
)
12151 : make_number (relief
)));
12156 /* Put a margin around the image. */
12157 if (hmargin
|| vmargin
)
12159 if (hmargin
== vmargin
)
12160 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12162 plist
= Fplist_put (plist
, QCmargin
,
12163 Fcons (make_number (hmargin
),
12164 make_number (vmargin
)));
12167 /* If button is not enabled, and we don't have special images
12168 for the disabled state, make the image appear disabled by
12169 applying an appropriate algorithm to it. */
12170 if (!enabled_p
&& idx
< 0)
12171 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12173 /* Put a `display' text property on the string for the image to
12174 display. Put a `menu-item' property on the string that gives
12175 the start of this item's properties in the tool-bar items
12177 image
= Fcons (Qimage
, plist
);
12178 props
= list4 (Qdisplay
, image
,
12179 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12181 /* Let the last image hide all remaining spaces in the tool bar
12182 string. The string can be longer than needed when we reuse a
12183 previous string. */
12184 if (i
+ 1 == f
->n_tool_bar_items
)
12185 end
= SCHARS (f
->desired_tool_bar_string
);
12188 Fadd_text_properties (make_number (i
), make_number (end
),
12189 props
, f
->desired_tool_bar_string
);
12197 /* Display one line of the tool-bar of frame IT->f.
12199 HEIGHT specifies the desired height of the tool-bar line.
12200 If the actual height of the glyph row is less than HEIGHT, the
12201 row's height is increased to HEIGHT, and the icons are centered
12202 vertically in the new height.
12204 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12205 count a final empty row in case the tool-bar width exactly matches
12210 display_tool_bar_line (struct it
*it
, int height
)
12212 struct glyph_row
*row
= it
->glyph_row
;
12213 int max_x
= it
->last_visible_x
;
12214 struct glyph
*last
;
12216 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12217 clear_glyph_row (row
);
12218 row
->enabled_p
= true;
12219 row
->y
= it
->current_y
;
12221 /* Note that this isn't made use of if the face hasn't a box,
12222 so there's no need to check the face here. */
12223 it
->start_of_box_run_p
= 1;
12225 while (it
->current_x
< max_x
)
12227 int x
, n_glyphs_before
, i
, nglyphs
;
12228 struct it it_before
;
12230 /* Get the next display element. */
12231 if (!get_next_display_element (it
))
12233 /* Don't count empty row if we are counting needed tool-bar lines. */
12234 if (height
< 0 && !it
->hpos
)
12239 /* Produce glyphs. */
12240 n_glyphs_before
= row
->used
[TEXT_AREA
];
12243 PRODUCE_GLYPHS (it
);
12245 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12247 x
= it_before
.current_x
;
12248 while (i
< nglyphs
)
12250 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12252 if (x
+ glyph
->pixel_width
> max_x
)
12254 /* Glyph doesn't fit on line. Backtrack. */
12255 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12257 /* If this is the only glyph on this line, it will never fit on the
12258 tool-bar, so skip it. But ensure there is at least one glyph,
12259 so we don't accidentally disable the tool-bar. */
12260 if (n_glyphs_before
== 0
12261 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12267 x
+= glyph
->pixel_width
;
12271 /* Stop at line end. */
12272 if (ITERATOR_AT_END_OF_LINE_P (it
))
12275 set_iterator_to_next (it
, 1);
12280 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12282 /* Use default face for the border below the tool bar.
12284 FIXME: When auto-resize-tool-bars is grow-only, there is
12285 no additional border below the possibly empty tool-bar lines.
12286 So to make the extra empty lines look "normal", we have to
12287 use the tool-bar face for the border too. */
12288 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12289 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12290 it
->face_id
= DEFAULT_FACE_ID
;
12292 extend_face_to_end_of_line (it
);
12293 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12294 last
->right_box_line_p
= 1;
12295 if (last
== row
->glyphs
[TEXT_AREA
])
12296 last
->left_box_line_p
= 1;
12298 /* Make line the desired height and center it vertically. */
12299 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12301 /* Don't add more than one line height. */
12302 height
%= FRAME_LINE_HEIGHT (it
->f
);
12303 it
->max_ascent
+= height
/ 2;
12304 it
->max_descent
+= (height
+ 1) / 2;
12307 compute_line_metrics (it
);
12309 /* If line is empty, make it occupy the rest of the tool-bar. */
12310 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12312 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12313 row
->visible_height
= row
->height
;
12314 row
->ascent
= row
->phys_ascent
= 0;
12315 row
->extra_line_spacing
= 0;
12318 row
->full_width_p
= 1;
12319 row
->continued_p
= 0;
12320 row
->truncated_on_left_p
= 0;
12321 row
->truncated_on_right_p
= 0;
12323 it
->current_x
= it
->hpos
= 0;
12324 it
->current_y
+= row
->height
;
12330 /* Max tool-bar height. Basically, this is what makes all other windows
12331 disappear when the frame gets too small. Rethink this! */
12333 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
12334 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
12336 /* Value is the number of pixels needed to make all tool-bar items of
12337 frame F visible. The actual number of glyph rows needed is
12338 returned in *N_ROWS if non-NULL. */
12341 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12343 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12345 /* tool_bar_height is called from redisplay_tool_bar after building
12346 the desired matrix, so use (unused) mode-line row as temporary row to
12347 avoid destroying the first tool-bar row. */
12348 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12350 /* Initialize an iterator for iteration over
12351 F->desired_tool_bar_string in the tool-bar window of frame F. */
12352 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12353 it
.first_visible_x
= 0;
12354 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12355 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12356 it
.paragraph_embedding
= L2R
;
12358 while (!ITERATOR_AT_END_P (&it
))
12360 clear_glyph_row (temp_row
);
12361 it
.glyph_row
= temp_row
;
12362 display_tool_bar_line (&it
, -1);
12364 clear_glyph_row (temp_row
);
12366 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12368 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12371 return it
.current_y
;
12373 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12376 #endif /* !USE_GTK && !HAVE_NS */
12378 #if defined USE_GTK || defined HAVE_NS
12379 EXFUN (Ftool_bar_height
, 2) ATTRIBUTE_CONST
;
12380 EXFUN (Ftool_bar_lines_needed
, 1) ATTRIBUTE_CONST
;
12383 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12385 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12386 If FRAME is nil or omitted, use the selected frame. Optional argument
12387 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12388 (Lisp_Object frame
, Lisp_Object pixelwise
)
12392 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12393 struct frame
*f
= decode_any_frame (frame
);
12395 if (WINDOWP (f
->tool_bar_window
)
12396 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12398 update_tool_bar (f
, 1);
12399 if (f
->n_tool_bar_items
)
12401 build_desired_tool_bar_string (f
);
12402 height
= tool_bar_height (f
, NULL
, NILP (pixelwise
) ? 0 : 1);
12407 return make_number (height
);
12411 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
12412 height should be changed. */
12415 redisplay_tool_bar (struct frame
*f
)
12417 #if defined (USE_GTK) || defined (HAVE_NS)
12419 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12420 update_frame_tool_bar (f
);
12423 #else /* !USE_GTK && !HAVE_NS */
12427 struct glyph_row
*row
;
12429 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12430 do anything. This means you must start with tool-bar-lines
12431 non-zero to get the auto-sizing effect. Or in other words, you
12432 can turn off tool-bars by specifying tool-bar-lines zero. */
12433 if (!WINDOWP (f
->tool_bar_window
)
12434 || (w
= XWINDOW (f
->tool_bar_window
),
12435 WINDOW_PIXEL_HEIGHT (w
) == 0))
12438 /* Set up an iterator for the tool-bar window. */
12439 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12440 it
.first_visible_x
= 0;
12441 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12442 row
= it
.glyph_row
;
12444 /* Build a string that represents the contents of the tool-bar. */
12445 build_desired_tool_bar_string (f
);
12446 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12447 /* FIXME: This should be controlled by a user option. But it
12448 doesn't make sense to have an R2L tool bar if the menu bar cannot
12449 be drawn also R2L, and making the menu bar R2L is tricky due
12450 toolkit-specific code that implements it. If an R2L tool bar is
12451 ever supported, display_tool_bar_line should also be augmented to
12452 call unproduce_glyphs like display_line and display_string
12454 it
.paragraph_embedding
= L2R
;
12456 if (f
->n_tool_bar_rows
== 0)
12458 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, 1);
12460 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12463 int new_lines
= ((new_height
+ FRAME_LINE_HEIGHT (f
) - 1)
12464 / FRAME_LINE_HEIGHT (f
));
12466 XSETFRAME (frame
, f
);
12467 Fmodify_frame_parameters (frame
,
12468 list1 (Fcons (Qtool_bar_lines
,
12469 make_number (new_lines
))));
12470 /* Always do that now. */
12471 clear_glyph_matrix (w
->desired_matrix
);
12472 f
->fonts_changed
= 1;
12477 /* Display as many lines as needed to display all tool-bar items. */
12479 if (f
->n_tool_bar_rows
> 0)
12481 int border
, rows
, height
, extra
;
12483 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12484 border
= XINT (Vtool_bar_border
);
12485 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12486 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12487 else if (EQ (Vtool_bar_border
, Qborder_width
))
12488 border
= f
->border_width
;
12494 rows
= f
->n_tool_bar_rows
;
12495 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12496 extra
= it
.last_visible_y
- border
- height
* rows
;
12498 while (it
.current_y
< it
.last_visible_y
)
12501 if (extra
> 0 && rows
-- > 0)
12503 h
= (extra
+ rows
- 1) / rows
;
12506 display_tool_bar_line (&it
, height
+ h
);
12511 while (it
.current_y
< it
.last_visible_y
)
12512 display_tool_bar_line (&it
, 0);
12515 /* It doesn't make much sense to try scrolling in the tool-bar
12516 window, so don't do it. */
12517 w
->desired_matrix
->no_scrolling_p
= 1;
12518 w
->must_be_updated_p
= 1;
12520 if (!NILP (Vauto_resize_tool_bars
))
12522 /* Do we really allow the toolbar to occupy the whole frame? */
12523 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
12524 int change_height_p
= 0;
12526 /* If we couldn't display everything, change the tool-bar's
12527 height if there is room for more. */
12528 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
12529 && it
.current_y
< max_tool_bar_height
)
12530 change_height_p
= 1;
12532 /* We subtract 1 because display_tool_bar_line advances the
12533 glyph_row pointer before returning to its caller. We want to
12534 examine the last glyph row produced by
12535 display_tool_bar_line. */
12536 row
= it
.glyph_row
- 1;
12538 /* If there are blank lines at the end, except for a partially
12539 visible blank line at the end that is smaller than
12540 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12541 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12542 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12543 change_height_p
= 1;
12545 /* If row displays tool-bar items, but is partially visible,
12546 change the tool-bar's height. */
12547 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12548 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
12549 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
12550 change_height_p
= 1;
12552 /* Resize windows as needed by changing the `tool-bar-lines'
12553 frame parameter. */
12554 if (change_height_p
)
12558 int new_height
= tool_bar_height (f
, &nrows
, 1);
12560 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12561 && !f
->minimize_tool_bar_window_p
)
12562 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12563 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12564 f
->minimize_tool_bar_window_p
= 0;
12566 if (change_height_p
)
12568 /* Current size of the tool-bar window in canonical line
12570 int old_lines
= WINDOW_TOTAL_LINES (w
);
12571 /* Required size of the tool-bar window in canonical
12573 int new_lines
= ((new_height
+ FRAME_LINE_HEIGHT (f
) - 1)
12574 / FRAME_LINE_HEIGHT (f
));
12575 /* Maximum size of the tool-bar window in canonical line
12576 units that this frame can allow. */
12578 WINDOW_TOTAL_LINES (XWINDOW (FRAME_ROOT_WINDOW (f
))) - 1;
12580 /* Don't try to change the tool-bar window size and set
12581 the fonts_changed flag unless really necessary. That
12582 flag causes redisplay to give up and retry
12583 redisplaying the frame from scratch, so setting it
12584 unnecessarily can lead to nasty redisplay loops. */
12585 if (new_lines
<= max_lines
12586 && eabs (new_lines
- old_lines
) >= 1)
12588 XSETFRAME (frame
, f
);
12589 Fmodify_frame_parameters (frame
,
12590 list1 (Fcons (Qtool_bar_lines
,
12591 make_number (new_lines
))));
12592 clear_glyph_matrix (w
->desired_matrix
);
12593 f
->n_tool_bar_rows
= nrows
;
12594 f
->fonts_changed
= 1;
12601 f
->minimize_tool_bar_window_p
= 0;
12604 #endif /* USE_GTK || HAVE_NS */
12607 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12609 /* Get information about the tool-bar item which is displayed in GLYPH
12610 on frame F. Return in *PROP_IDX the index where tool-bar item
12611 properties start in F->tool_bar_items. Value is zero if
12612 GLYPH doesn't display a tool-bar item. */
12615 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12621 /* This function can be called asynchronously, which means we must
12622 exclude any possibility that Fget_text_property signals an
12624 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12625 charpos
= max (0, charpos
);
12627 /* Get the text property `menu-item' at pos. The value of that
12628 property is the start index of this item's properties in
12629 F->tool_bar_items. */
12630 prop
= Fget_text_property (make_number (charpos
),
12631 Qmenu_item
, f
->current_tool_bar_string
);
12632 if (INTEGERP (prop
))
12634 *prop_idx
= XINT (prop
);
12644 /* Get information about the tool-bar item at position X/Y on frame F.
12645 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12646 the current matrix of the tool-bar window of F, or NULL if not
12647 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12648 item in F->tool_bar_items. Value is
12650 -1 if X/Y is not on a tool-bar item
12651 0 if X/Y is on the same item that was highlighted before.
12655 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12656 int *hpos
, int *vpos
, int *prop_idx
)
12658 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12659 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12662 /* Find the glyph under X/Y. */
12663 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12664 if (*glyph
== NULL
)
12667 /* Get the start of this tool-bar item's properties in
12668 f->tool_bar_items. */
12669 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12672 /* Is mouse on the highlighted item? */
12673 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12674 && *vpos
>= hlinfo
->mouse_face_beg_row
12675 && *vpos
<= hlinfo
->mouse_face_end_row
12676 && (*vpos
> hlinfo
->mouse_face_beg_row
12677 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12678 && (*vpos
< hlinfo
->mouse_face_end_row
12679 || *hpos
< hlinfo
->mouse_face_end_col
12680 || hlinfo
->mouse_face_past_end
))
12688 Handle mouse button event on the tool-bar of frame F, at
12689 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12690 0 for button release. MODIFIERS is event modifiers for button
12694 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12697 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12698 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12699 int hpos
, vpos
, prop_idx
;
12700 struct glyph
*glyph
;
12701 Lisp_Object enabled_p
;
12704 /* If not on the highlighted tool-bar item, and mouse-highlight is
12705 non-nil, return. This is so we generate the tool-bar button
12706 click only when the mouse button is released on the same item as
12707 where it was pressed. However, when mouse-highlight is disabled,
12708 generate the click when the button is released regardless of the
12709 highlight, since tool-bar items are not highlighted in that
12711 frame_to_window_pixel_xy (w
, &x
, &y
);
12712 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12714 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12717 /* When mouse-highlight is off, generate the click for the item
12718 where the button was pressed, disregarding where it was
12720 if (NILP (Vmouse_highlight
) && !down_p
)
12721 prop_idx
= last_tool_bar_item
;
12723 /* If item is disabled, do nothing. */
12724 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12725 if (NILP (enabled_p
))
12730 /* Show item in pressed state. */
12731 if (!NILP (Vmouse_highlight
))
12732 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12733 last_tool_bar_item
= prop_idx
;
12737 Lisp_Object key
, frame
;
12738 struct input_event event
;
12739 EVENT_INIT (event
);
12741 /* Show item in released state. */
12742 if (!NILP (Vmouse_highlight
))
12743 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12745 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12747 XSETFRAME (frame
, f
);
12748 event
.kind
= TOOL_BAR_EVENT
;
12749 event
.frame_or_window
= frame
;
12751 kbd_buffer_store_event (&event
);
12753 event
.kind
= TOOL_BAR_EVENT
;
12754 event
.frame_or_window
= frame
;
12756 event
.modifiers
= modifiers
;
12757 kbd_buffer_store_event (&event
);
12758 last_tool_bar_item
= -1;
12763 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12764 tool-bar window-relative coordinates X/Y. Called from
12765 note_mouse_highlight. */
12768 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12770 Lisp_Object window
= f
->tool_bar_window
;
12771 struct window
*w
= XWINDOW (window
);
12772 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12773 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12775 struct glyph
*glyph
;
12776 struct glyph_row
*row
;
12778 Lisp_Object enabled_p
;
12780 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12781 int mouse_down_p
, rc
;
12783 /* Function note_mouse_highlight is called with negative X/Y
12784 values when mouse moves outside of the frame. */
12785 if (x
<= 0 || y
<= 0)
12787 clear_mouse_face (hlinfo
);
12791 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12794 /* Not on tool-bar item. */
12795 clear_mouse_face (hlinfo
);
12799 /* On same tool-bar item as before. */
12800 goto set_help_echo
;
12802 clear_mouse_face (hlinfo
);
12804 /* Mouse is down, but on different tool-bar item? */
12805 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12806 && f
== dpyinfo
->last_mouse_frame
);
12809 && last_tool_bar_item
!= prop_idx
)
12812 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12814 /* If tool-bar item is not enabled, don't highlight it. */
12815 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12816 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12818 /* Compute the x-position of the glyph. In front and past the
12819 image is a space. We include this in the highlighted area. */
12820 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12821 for (i
= x
= 0; i
< hpos
; ++i
)
12822 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12824 /* Record this as the current active region. */
12825 hlinfo
->mouse_face_beg_col
= hpos
;
12826 hlinfo
->mouse_face_beg_row
= vpos
;
12827 hlinfo
->mouse_face_beg_x
= x
;
12828 hlinfo
->mouse_face_past_end
= 0;
12830 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12831 hlinfo
->mouse_face_end_row
= vpos
;
12832 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12833 hlinfo
->mouse_face_window
= window
;
12834 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12836 /* Display it as active. */
12837 show_mouse_face (hlinfo
, draw
);
12842 /* Set help_echo_string to a help string to display for this tool-bar item.
12843 XTread_socket does the rest. */
12844 help_echo_object
= help_echo_window
= Qnil
;
12845 help_echo_pos
= -1;
12846 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12847 if (NILP (help_echo_string
))
12848 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12851 #endif /* !USE_GTK && !HAVE_NS */
12853 #endif /* HAVE_WINDOW_SYSTEM */
12857 /************************************************************************
12858 Horizontal scrolling
12859 ************************************************************************/
12861 static int hscroll_window_tree (Lisp_Object
);
12862 static int hscroll_windows (Lisp_Object
);
12864 /* For all leaf windows in the window tree rooted at WINDOW, set their
12865 hscroll value so that PT is (i) visible in the window, and (ii) so
12866 that it is not within a certain margin at the window's left and
12867 right border. Value is non-zero if any window's hscroll has been
12871 hscroll_window_tree (Lisp_Object window
)
12873 int hscrolled_p
= 0;
12874 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12875 int hscroll_step_abs
= 0;
12876 double hscroll_step_rel
= 0;
12878 if (hscroll_relative_p
)
12880 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12881 if (hscroll_step_rel
< 0)
12883 hscroll_relative_p
= 0;
12884 hscroll_step_abs
= 0;
12887 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12889 hscroll_step_abs
= XINT (Vhscroll_step
);
12890 if (hscroll_step_abs
< 0)
12891 hscroll_step_abs
= 0;
12894 hscroll_step_abs
= 0;
12896 while (WINDOWP (window
))
12898 struct window
*w
= XWINDOW (window
);
12900 if (WINDOWP (w
->contents
))
12901 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12902 else if (w
->cursor
.vpos
>= 0)
12905 int text_area_width
;
12906 struct glyph_row
*cursor_row
;
12907 struct glyph_row
*bottom_row
;
12910 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12911 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12912 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12914 cursor_row
= bottom_row
- 1;
12916 if (!cursor_row
->enabled_p
)
12918 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12919 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12920 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12922 cursor_row
= bottom_row
- 1;
12924 row_r2l_p
= cursor_row
->reversed_p
;
12926 text_area_width
= window_box_width (w
, TEXT_AREA
);
12928 /* Scroll when cursor is inside this scroll margin. */
12929 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12931 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12932 /* In some pathological cases, like restoring a window
12933 configuration into a frame that is much smaller than
12934 the one from which the configuration was saved, we
12935 get glyph rows whose start and end have zero buffer
12936 positions, which we cannot handle below. Just skip
12938 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12939 /* For left-to-right rows, hscroll when cursor is either
12940 (i) inside the right hscroll margin, or (ii) if it is
12941 inside the left margin and the window is already
12945 && w
->cursor
.x
<= h_margin
)
12946 || (cursor_row
->enabled_p
12947 && cursor_row
->truncated_on_right_p
12948 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12949 /* For right-to-left rows, the logic is similar,
12950 except that rules for scrolling to left and right
12951 are reversed. E.g., if cursor.x <= h_margin, we
12952 need to hscroll "to the right" unconditionally,
12953 and that will scroll the screen to the left so as
12954 to reveal the next portion of the row. */
12956 && ((cursor_row
->enabled_p
12957 /* FIXME: It is confusing to set the
12958 truncated_on_right_p flag when R2L rows
12959 are actually truncated on the left. */
12960 && cursor_row
->truncated_on_right_p
12961 && w
->cursor
.x
<= h_margin
)
12963 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12967 struct buffer
*saved_current_buffer
;
12971 /* Find point in a display of infinite width. */
12972 saved_current_buffer
= current_buffer
;
12973 current_buffer
= XBUFFER (w
->contents
);
12975 if (w
== XWINDOW (selected_window
))
12978 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12980 /* Move iterator to pt starting at cursor_row->start in
12981 a line with infinite width. */
12982 init_to_row_start (&it
, w
, cursor_row
);
12983 it
.last_visible_x
= INFINITY
;
12984 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12985 current_buffer
= saved_current_buffer
;
12987 /* Position cursor in window. */
12988 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12989 hscroll
= max (0, (it
.current_x
12990 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12991 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12992 : (text_area_width
/ 2))))
12993 / FRAME_COLUMN_WIDTH (it
.f
);
12994 else if ((!row_r2l_p
12995 && w
->cursor
.x
>= text_area_width
- h_margin
)
12996 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12998 if (hscroll_relative_p
)
12999 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
13002 wanted_x
= text_area_width
13003 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
13006 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
13010 if (hscroll_relative_p
)
13011 wanted_x
= text_area_width
* hscroll_step_rel
13014 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
13017 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
13019 hscroll
= max (hscroll
, w
->min_hscroll
);
13021 /* Don't prevent redisplay optimizations if hscroll
13022 hasn't changed, as it will unnecessarily slow down
13024 if (w
->hscroll
!= hscroll
)
13026 XBUFFER (w
->contents
)->prevent_redisplay_optimizations_p
= 1;
13027 w
->hscroll
= hscroll
;
13036 /* Value is non-zero if hscroll of any leaf window has been changed. */
13037 return hscrolled_p
;
13041 /* Set hscroll so that cursor is visible and not inside horizontal
13042 scroll margins for all windows in the tree rooted at WINDOW. See
13043 also hscroll_window_tree above. Value is non-zero if any window's
13044 hscroll has been changed. If it has, desired matrices on the frame
13045 of WINDOW are cleared. */
13048 hscroll_windows (Lisp_Object window
)
13050 int hscrolled_p
= hscroll_window_tree (window
);
13052 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
13053 return hscrolled_p
;
13058 /************************************************************************
13060 ************************************************************************/
13062 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
13063 to a non-zero value. This is sometimes handy to have in a debugger
13068 /* First and last unchanged row for try_window_id. */
13070 static int debug_first_unchanged_at_end_vpos
;
13071 static int debug_last_unchanged_at_beg_vpos
;
13073 /* Delta vpos and y. */
13075 static int debug_dvpos
, debug_dy
;
13077 /* Delta in characters and bytes for try_window_id. */
13079 static ptrdiff_t debug_delta
, debug_delta_bytes
;
13081 /* Values of window_end_pos and window_end_vpos at the end of
13084 static ptrdiff_t debug_end_vpos
;
13086 /* Append a string to W->desired_matrix->method. FMT is a printf
13087 format string. If trace_redisplay_p is true also printf the
13088 resulting string to stderr. */
13090 static void debug_method_add (struct window
*, char const *, ...)
13091 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13094 debug_method_add (struct window
*w
, char const *fmt
, ...)
13097 char *method
= w
->desired_matrix
->method
;
13098 int len
= strlen (method
);
13099 int size
= sizeof w
->desired_matrix
->method
;
13100 int remaining
= size
- len
- 1;
13103 if (len
&& remaining
)
13106 --remaining
, ++len
;
13109 va_start (ap
, fmt
);
13110 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13113 if (trace_redisplay_p
)
13114 fprintf (stderr
, "%p (%s): %s\n",
13116 ((BUFFERP (w
->contents
)
13117 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13118 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13123 #endif /* GLYPH_DEBUG */
13126 /* Value is non-zero if all changes in window W, which displays
13127 current_buffer, are in the text between START and END. START is a
13128 buffer position, END is given as a distance from Z. Used in
13129 redisplay_internal for display optimization. */
13132 text_outside_line_unchanged_p (struct window
*w
,
13133 ptrdiff_t start
, ptrdiff_t end
)
13135 int unchanged_p
= 1;
13137 /* If text or overlays have changed, see where. */
13138 if (window_outdated (w
))
13140 /* Gap in the line? */
13141 if (GPT
< start
|| Z
- GPT
< end
)
13144 /* Changes start in front of the line, or end after it? */
13146 && (BEG_UNCHANGED
< start
- 1
13147 || END_UNCHANGED
< end
))
13150 /* If selective display, can't optimize if changes start at the
13151 beginning of the line. */
13153 && INTEGERP (BVAR (current_buffer
, selective_display
))
13154 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13155 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13158 /* If there are overlays at the start or end of the line, these
13159 may have overlay strings with newlines in them. A change at
13160 START, for instance, may actually concern the display of such
13161 overlay strings as well, and they are displayed on different
13162 lines. So, quickly rule out this case. (For the future, it
13163 might be desirable to implement something more telling than
13164 just BEG/END_UNCHANGED.) */
13167 if (BEG
+ BEG_UNCHANGED
== start
13168 && overlay_touches_p (start
))
13170 if (END_UNCHANGED
== end
13171 && overlay_touches_p (Z
- end
))
13175 /* Under bidi reordering, adding or deleting a character in the
13176 beginning of a paragraph, before the first strong directional
13177 character, can change the base direction of the paragraph (unless
13178 the buffer specifies a fixed paragraph direction), which will
13179 require to redisplay the whole paragraph. It might be worthwhile
13180 to find the paragraph limits and widen the range of redisplayed
13181 lines to that, but for now just give up this optimization. */
13182 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13183 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13187 return unchanged_p
;
13191 /* Do a frame update, taking possible shortcuts into account. This is
13192 the main external entry point for redisplay.
13194 If the last redisplay displayed an echo area message and that message
13195 is no longer requested, we clear the echo area or bring back the
13196 mini-buffer if that is in use. */
13201 redisplay_internal ();
13206 overlay_arrow_string_or_property (Lisp_Object var
)
13210 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13213 return Voverlay_arrow_string
;
13216 /* Return 1 if there are any overlay-arrows in current_buffer. */
13218 overlay_arrow_in_current_buffer_p (void)
13222 for (vlist
= Voverlay_arrow_variable_list
;
13224 vlist
= XCDR (vlist
))
13226 Lisp_Object var
= XCAR (vlist
);
13229 if (!SYMBOLP (var
))
13231 val
= find_symbol_value (var
);
13233 && current_buffer
== XMARKER (val
)->buffer
)
13240 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
13244 overlay_arrows_changed_p (void)
13248 for (vlist
= Voverlay_arrow_variable_list
;
13250 vlist
= XCDR (vlist
))
13252 Lisp_Object var
= XCAR (vlist
);
13253 Lisp_Object val
, pstr
;
13255 if (!SYMBOLP (var
))
13257 val
= find_symbol_value (var
);
13258 if (!MARKERP (val
))
13260 if (! EQ (COERCE_MARKER (val
),
13261 Fget (var
, Qlast_arrow_position
))
13262 || ! (pstr
= overlay_arrow_string_or_property (var
),
13263 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13269 /* Mark overlay arrows to be updated on next redisplay. */
13272 update_overlay_arrows (int up_to_date
)
13276 for (vlist
= Voverlay_arrow_variable_list
;
13278 vlist
= XCDR (vlist
))
13280 Lisp_Object var
= XCAR (vlist
);
13282 if (!SYMBOLP (var
))
13285 if (up_to_date
> 0)
13287 Lisp_Object val
= find_symbol_value (var
);
13288 Fput (var
, Qlast_arrow_position
,
13289 COERCE_MARKER (val
));
13290 Fput (var
, Qlast_arrow_string
,
13291 overlay_arrow_string_or_property (var
));
13293 else if (up_to_date
< 0
13294 || !NILP (Fget (var
, Qlast_arrow_position
)))
13296 Fput (var
, Qlast_arrow_position
, Qt
);
13297 Fput (var
, Qlast_arrow_string
, Qt
);
13303 /* Return overlay arrow string to display at row.
13304 Return integer (bitmap number) for arrow bitmap in left fringe.
13305 Return nil if no overlay arrow. */
13308 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13312 for (vlist
= Voverlay_arrow_variable_list
;
13314 vlist
= XCDR (vlist
))
13316 Lisp_Object var
= XCAR (vlist
);
13319 if (!SYMBOLP (var
))
13322 val
= find_symbol_value (var
);
13325 && current_buffer
== XMARKER (val
)->buffer
13326 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13328 if (FRAME_WINDOW_P (it
->f
)
13329 /* FIXME: if ROW->reversed_p is set, this should test
13330 the right fringe, not the left one. */
13331 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13333 #ifdef HAVE_WINDOW_SYSTEM
13334 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13337 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
13338 return make_number (fringe_bitmap
);
13341 return make_number (-1); /* Use default arrow bitmap. */
13343 return overlay_arrow_string_or_property (var
);
13350 /* Return 1 if point moved out of or into a composition. Otherwise
13351 return 0. PREV_BUF and PREV_PT are the last point buffer and
13352 position. BUF and PT are the current point buffer and position. */
13355 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13356 struct buffer
*buf
, ptrdiff_t pt
)
13358 ptrdiff_t start
, end
;
13360 Lisp_Object buffer
;
13362 XSETBUFFER (buffer
, buf
);
13363 /* Check a composition at the last point if point moved within the
13365 if (prev_buf
== buf
)
13368 /* Point didn't move. */
13371 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13372 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13373 && composition_valid_p (start
, end
, prop
)
13374 && start
< prev_pt
&& end
> prev_pt
)
13375 /* The last point was within the composition. Return 1 iff
13376 point moved out of the composition. */
13377 return (pt
<= start
|| pt
>= end
);
13380 /* Check a composition at the current point. */
13381 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13382 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13383 && composition_valid_p (start
, end
, prop
)
13384 && start
< pt
&& end
> pt
);
13387 /* Reconsider the clip changes of buffer which is displayed in W. */
13390 reconsider_clip_changes (struct window
*w
)
13392 struct buffer
*b
= XBUFFER (w
->contents
);
13394 if (b
->clip_changed
13395 && w
->window_end_valid
13396 && w
->current_matrix
->buffer
== b
13397 && w
->current_matrix
->zv
== BUF_ZV (b
)
13398 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13399 b
->clip_changed
= 0;
13401 /* If display wasn't paused, and W is not a tool bar window, see if
13402 point has been moved into or out of a composition. In that case,
13403 we set b->clip_changed to 1 to force updating the screen. If
13404 b->clip_changed has already been set to 1, we can skip this
13406 if (!b
->clip_changed
&& w
->window_end_valid
)
13408 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13409 ? PT
: marker_position (w
->pointm
));
13411 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13412 && check_point_in_composition (w
->current_matrix
->buffer
,
13413 w
->last_point
, b
, pt
))
13414 b
->clip_changed
= 1;
13419 propagate_buffer_redisplay (void)
13420 { /* Resetting b->text->redisplay is problematic!
13421 We can't just reset it in the case that some window that displays
13422 it has not been redisplayed; and such a window can stay
13423 unredisplayed for a long time if it's currently invisible.
13424 But we do want to reset it at the end of redisplay otherwise
13425 its displayed windows will keep being redisplayed over and over
13427 So we copy all b->text->redisplay flags up to their windows here,
13428 such that mark_window_display_accurate can safely reset
13429 b->text->redisplay. */
13430 Lisp_Object ws
= window_list ();
13431 for (; CONSP (ws
); ws
= XCDR (ws
))
13433 struct window
*thisw
= XWINDOW (XCAR (ws
));
13434 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13435 if (thisb
->text
->redisplay
)
13436 thisw
->redisplay
= true;
13440 #define STOP_POLLING \
13441 do { if (! polling_stopped_here) stop_polling (); \
13442 polling_stopped_here = 1; } while (0)
13444 #define RESUME_POLLING \
13445 do { if (polling_stopped_here) start_polling (); \
13446 polling_stopped_here = 0; } while (0)
13449 /* Perhaps in the future avoid recentering windows if it
13450 is not necessary; currently that causes some problems. */
13453 redisplay_internal (void)
13455 struct window
*w
= XWINDOW (selected_window
);
13459 bool must_finish
= 0, match_p
;
13460 struct text_pos tlbufpos
, tlendpos
;
13461 int number_of_visible_frames
;
13464 int polling_stopped_here
= 0;
13465 Lisp_Object tail
, frame
;
13467 /* True means redisplay has to consider all windows on all
13468 frames. False, only selected_window is considered. */
13469 bool consider_all_windows_p
;
13471 /* True means redisplay has to redisplay the miniwindow. */
13472 bool update_miniwindow_p
= false;
13474 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13476 /* No redisplay if running in batch mode or frame is not yet fully
13477 initialized, or redisplay is explicitly turned off by setting
13478 Vinhibit_redisplay. */
13479 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13480 || !NILP (Vinhibit_redisplay
))
13483 /* Don't examine these until after testing Vinhibit_redisplay.
13484 When Emacs is shutting down, perhaps because its connection to
13485 X has dropped, we should not look at them at all. */
13486 fr
= XFRAME (w
->frame
);
13487 sf
= SELECTED_FRAME ();
13489 if (!fr
->glyphs_initialized_p
)
13492 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13493 if (popup_activated ())
13497 /* I don't think this happens but let's be paranoid. */
13498 if (redisplaying_p
)
13501 /* Record a function that clears redisplaying_p
13502 when we leave this function. */
13503 count
= SPECPDL_INDEX ();
13504 record_unwind_protect_void (unwind_redisplay
);
13505 redisplaying_p
= 1;
13506 specbind (Qinhibit_free_realized_faces
, Qnil
);
13508 /* Record this function, so it appears on the profiler's backtraces. */
13509 record_in_backtrace (Qredisplay_internal
, &Qnil
, 0);
13511 FOR_EACH_FRAME (tail
, frame
)
13512 XFRAME (frame
)->already_hscrolled_p
= 0;
13515 /* Remember the currently selected window. */
13519 last_escape_glyph_frame
= NULL
;
13520 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13521 last_glyphless_glyph_frame
= NULL
;
13522 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13524 /* If face_change_count is non-zero, init_iterator will free all
13525 realized faces, which includes the faces referenced from current
13526 matrices. So, we can't reuse current matrices in this case. */
13527 if (face_change_count
)
13528 windows_or_buffers_changed
= 47;
13530 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13531 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13533 /* Since frames on a single ASCII terminal share the same
13534 display area, displaying a different frame means redisplay
13535 the whole thing. */
13536 SET_FRAME_GARBAGED (sf
);
13538 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13540 FRAME_TTY (sf
)->previous_frame
= sf
;
13543 /* Set the visible flags for all frames. Do this before checking for
13544 resized or garbaged frames; they want to know if their frames are
13545 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13546 number_of_visible_frames
= 0;
13548 FOR_EACH_FRAME (tail
, frame
)
13550 struct frame
*f
= XFRAME (frame
);
13552 if (FRAME_VISIBLE_P (f
))
13554 ++number_of_visible_frames
;
13555 /* Adjust matrices for visible frames only. */
13556 if (f
->fonts_changed
)
13558 adjust_frame_glyphs (f
);
13559 f
->fonts_changed
= 0;
13561 /* If cursor type has been changed on the frame
13562 other than selected, consider all frames. */
13563 if (f
!= sf
&& f
->cursor_type_changed
)
13564 update_mode_lines
= 31;
13566 clear_desired_matrices (f
);
13569 /* Notice any pending interrupt request to change frame size. */
13570 do_pending_window_change (1);
13572 /* do_pending_window_change could change the selected_window due to
13573 frame resizing which makes the selected window too small. */
13574 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13577 /* Clear frames marked as garbaged. */
13578 clear_garbaged_frames ();
13580 /* Build menubar and tool-bar items. */
13581 if (NILP (Vmemory_full
))
13582 prepare_menu_bars ();
13584 reconsider_clip_changes (w
);
13586 /* In most cases selected window displays current buffer. */
13587 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13590 /* Detect case that we need to write or remove a star in the mode line. */
13591 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13592 w
->update_mode_line
= 1;
13594 if (mode_line_update_needed (w
))
13595 w
->update_mode_line
= 1;
13597 /* If reconsider_clip_changes above decided that the narrowing
13598 in the current buffer changed, make sure all other windows
13599 showing that buffer will be redisplayed. */
13600 if (current_buffer
->clip_changed
)
13601 bset_update_mode_line (current_buffer
);
13604 /* Normally the message* functions will have already displayed and
13605 updated the echo area, but the frame may have been trashed, or
13606 the update may have been preempted, so display the echo area
13607 again here. Checking message_cleared_p captures the case that
13608 the echo area should be cleared. */
13609 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13610 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13611 || (message_cleared_p
13612 && minibuf_level
== 0
13613 /* If the mini-window is currently selected, this means the
13614 echo-area doesn't show through. */
13615 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13617 int window_height_changed_p
= echo_area_display (0);
13619 if (message_cleared_p
)
13620 update_miniwindow_p
= true;
13624 /* If we don't display the current message, don't clear the
13625 message_cleared_p flag, because, if we did, we wouldn't clear
13626 the echo area in the next redisplay which doesn't preserve
13628 if (!display_last_displayed_message_p
)
13629 message_cleared_p
= 0;
13631 if (window_height_changed_p
)
13633 windows_or_buffers_changed
= 50;
13635 /* If window configuration was changed, frames may have been
13636 marked garbaged. Clear them or we will experience
13637 surprises wrt scrolling. */
13638 clear_garbaged_frames ();
13641 else if (EQ (selected_window
, minibuf_window
)
13642 && (current_buffer
->clip_changed
|| window_outdated (w
))
13643 && resize_mini_window (w
, 0))
13645 /* Resized active mini-window to fit the size of what it is
13646 showing if its contents might have changed. */
13649 /* If window configuration was changed, frames may have been
13650 marked garbaged. Clear them or we will experience
13651 surprises wrt scrolling. */
13652 clear_garbaged_frames ();
13655 if (windows_or_buffers_changed
&& !update_mode_lines
)
13656 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13657 only the windows's contents needs to be refreshed, or whether the
13658 mode-lines also need a refresh. */
13659 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13660 ? REDISPLAY_SOME
: 32);
13662 /* If specs for an arrow have changed, do thorough redisplay
13663 to ensure we remove any arrow that should no longer exist. */
13664 if (overlay_arrows_changed_p ())
13665 /* Apparently, this is the only case where we update other windows,
13666 without updating other mode-lines. */
13667 windows_or_buffers_changed
= 49;
13669 consider_all_windows_p
= (update_mode_lines
13670 || windows_or_buffers_changed
);
13672 #define AINC(a,i) \
13673 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13674 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13676 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13677 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13679 /* Optimize the case that only the line containing the cursor in the
13680 selected window has changed. Variables starting with this_ are
13681 set in display_line and record information about the line
13682 containing the cursor. */
13683 tlbufpos
= this_line_start_pos
;
13684 tlendpos
= this_line_end_pos
;
13685 if (!consider_all_windows_p
13686 && CHARPOS (tlbufpos
) > 0
13687 && !w
->update_mode_line
13688 && !current_buffer
->clip_changed
13689 && !current_buffer
->prevent_redisplay_optimizations_p
13690 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13691 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13692 && !XFRAME (w
->frame
)->cursor_type_changed
13693 /* Make sure recorded data applies to current buffer, etc. */
13694 && this_line_buffer
== current_buffer
13697 && !w
->optional_new_start
13698 /* Point must be on the line that we have info recorded about. */
13699 && PT
>= CHARPOS (tlbufpos
)
13700 && PT
<= Z
- CHARPOS (tlendpos
)
13701 /* All text outside that line, including its final newline,
13702 must be unchanged. */
13703 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13704 CHARPOS (tlendpos
)))
13706 if (CHARPOS (tlbufpos
) > BEGV
13707 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13708 && (CHARPOS (tlbufpos
) == ZV
13709 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13710 /* Former continuation line has disappeared by becoming empty. */
13712 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13714 /* We have to handle the case of continuation around a
13715 wide-column character (see the comment in indent.c around
13718 For instance, in the following case:
13720 -------- Insert --------
13721 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13722 J_I_ ==> J_I_ `^^' are cursors.
13726 As we have to redraw the line above, we cannot use this
13730 int line_height_before
= this_line_pixel_height
;
13732 /* Note that start_display will handle the case that the
13733 line starting at tlbufpos is a continuation line. */
13734 start_display (&it
, w
, tlbufpos
);
13736 /* Implementation note: It this still necessary? */
13737 if (it
.current_x
!= this_line_start_x
)
13740 TRACE ((stderr
, "trying display optimization 1\n"));
13741 w
->cursor
.vpos
= -1;
13742 overlay_arrow_seen
= 0;
13743 it
.vpos
= this_line_vpos
;
13744 it
.current_y
= this_line_y
;
13745 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13746 display_line (&it
);
13748 /* If line contains point, is not continued,
13749 and ends at same distance from eob as before, we win. */
13750 if (w
->cursor
.vpos
>= 0
13751 /* Line is not continued, otherwise this_line_start_pos
13752 would have been set to 0 in display_line. */
13753 && CHARPOS (this_line_start_pos
)
13754 /* Line ends as before. */
13755 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13756 /* Line has same height as before. Otherwise other lines
13757 would have to be shifted up or down. */
13758 && this_line_pixel_height
== line_height_before
)
13760 /* If this is not the window's last line, we must adjust
13761 the charstarts of the lines below. */
13762 if (it
.current_y
< it
.last_visible_y
)
13764 struct glyph_row
*row
13765 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13766 ptrdiff_t delta
, delta_bytes
;
13768 /* We used to distinguish between two cases here,
13769 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13770 when the line ends in a newline or the end of the
13771 buffer's accessible portion. But both cases did
13772 the same, so they were collapsed. */
13774 - CHARPOS (tlendpos
)
13775 - MATRIX_ROW_START_CHARPOS (row
));
13776 delta_bytes
= (Z_BYTE
13777 - BYTEPOS (tlendpos
)
13778 - MATRIX_ROW_START_BYTEPOS (row
));
13780 increment_matrix_positions (w
->current_matrix
,
13781 this_line_vpos
+ 1,
13782 w
->current_matrix
->nrows
,
13783 delta
, delta_bytes
);
13786 /* If this row displays text now but previously didn't,
13787 or vice versa, w->window_end_vpos may have to be
13789 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13791 if (w
->window_end_vpos
< this_line_vpos
)
13792 w
->window_end_vpos
= this_line_vpos
;
13794 else if (w
->window_end_vpos
== this_line_vpos
13795 && this_line_vpos
> 0)
13796 w
->window_end_vpos
= this_line_vpos
- 1;
13797 w
->window_end_valid
= 0;
13799 /* Update hint: No need to try to scroll in update_window. */
13800 w
->desired_matrix
->no_scrolling_p
= 1;
13803 *w
->desired_matrix
->method
= 0;
13804 debug_method_add (w
, "optimization 1");
13806 #ifdef HAVE_WINDOW_SYSTEM
13807 update_window_fringes (w
, 0);
13814 else if (/* Cursor position hasn't changed. */
13815 PT
== w
->last_point
13816 /* Make sure the cursor was last displayed
13817 in this window. Otherwise we have to reposition it. */
13819 /* PXW: Must be converted to pixels, probably. */
13820 && 0 <= w
->cursor
.vpos
13821 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13825 do_pending_window_change (1);
13826 /* If selected_window changed, redisplay again. */
13827 if (WINDOWP (selected_window
)
13828 && (w
= XWINDOW (selected_window
)) != sw
)
13831 /* We used to always goto end_of_redisplay here, but this
13832 isn't enough if we have a blinking cursor. */
13833 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13834 goto end_of_redisplay
;
13838 /* If highlighting the region, or if the cursor is in the echo area,
13839 then we can't just move the cursor. */
13840 else if (NILP (Vshow_trailing_whitespace
)
13841 && !cursor_in_echo_area
)
13844 struct glyph_row
*row
;
13846 /* Skip from tlbufpos to PT and see where it is. Note that
13847 PT may be in invisible text. If so, we will end at the
13848 next visible position. */
13849 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13850 NULL
, DEFAULT_FACE_ID
);
13851 it
.current_x
= this_line_start_x
;
13852 it
.current_y
= this_line_y
;
13853 it
.vpos
= this_line_vpos
;
13855 /* The call to move_it_to stops in front of PT, but
13856 moves over before-strings. */
13857 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13859 if (it
.vpos
== this_line_vpos
13860 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13863 eassert (this_line_vpos
== it
.vpos
);
13864 eassert (this_line_y
== it
.current_y
);
13865 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13867 *w
->desired_matrix
->method
= 0;
13868 debug_method_add (w
, "optimization 3");
13877 /* Text changed drastically or point moved off of line. */
13878 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13881 CHARPOS (this_line_start_pos
) = 0;
13882 ++clear_face_cache_count
;
13883 #ifdef HAVE_WINDOW_SYSTEM
13884 ++clear_image_cache_count
;
13887 /* Build desired matrices, and update the display. If
13888 consider_all_windows_p is non-zero, do it for all windows on all
13889 frames. Otherwise do it for selected_window, only. */
13891 if (consider_all_windows_p
)
13893 FOR_EACH_FRAME (tail
, frame
)
13894 XFRAME (frame
)->updated_p
= 0;
13896 propagate_buffer_redisplay ();
13898 FOR_EACH_FRAME (tail
, frame
)
13900 struct frame
*f
= XFRAME (frame
);
13902 /* We don't have to do anything for unselected terminal
13904 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13905 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13910 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13913 /* Only GC scrollbars when we redisplay the whole frame. */
13914 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13915 /* Mark all the scroll bars to be removed; we'll redeem
13916 the ones we want when we redisplay their windows. */
13917 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13918 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13920 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13921 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13922 /* Remember that the invisible frames need to be redisplayed next
13923 time they're visible. */
13924 else if (!REDISPLAY_SOME_P ())
13925 f
->redisplay
= true;
13927 /* The X error handler may have deleted that frame. */
13928 if (!FRAME_LIVE_P (f
))
13931 /* Any scroll bars which redisplay_windows should have
13932 nuked should now go away. */
13933 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13934 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13936 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13938 /* If fonts changed on visible frame, display again. */
13939 if (f
->fonts_changed
)
13941 adjust_frame_glyphs (f
);
13942 f
->fonts_changed
= 0;
13946 /* See if we have to hscroll. */
13947 if (!f
->already_hscrolled_p
)
13949 f
->already_hscrolled_p
= 1;
13950 if (hscroll_windows (f
->root_window
))
13954 /* Prevent various kinds of signals during display
13955 update. stdio is not robust about handling
13956 signals, which can cause an apparent I/O error. */
13957 if (interrupt_input
)
13958 unrequest_sigio ();
13961 pending
|= update_frame (f
, 0, 0);
13962 f
->cursor_type_changed
= 0;
13968 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13972 /* Do the mark_window_display_accurate after all windows have
13973 been redisplayed because this call resets flags in buffers
13974 which are needed for proper redisplay. */
13975 FOR_EACH_FRAME (tail
, frame
)
13977 struct frame
*f
= XFRAME (frame
);
13980 f
->redisplay
= false;
13981 mark_window_display_accurate (f
->root_window
, 1);
13982 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13983 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13988 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13990 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13991 struct frame
*mini_frame
;
13993 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13994 /* Use list_of_error, not Qerror, so that
13995 we catch only errors and don't run the debugger. */
13996 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13998 redisplay_window_error
);
13999 if (update_miniwindow_p
)
14000 internal_condition_case_1 (redisplay_window_1
, mini_window
,
14002 redisplay_window_error
);
14004 /* Compare desired and current matrices, perform output. */
14007 /* If fonts changed, display again. */
14008 if (sf
->fonts_changed
)
14011 /* Prevent various kinds of signals during display update.
14012 stdio is not robust about handling signals,
14013 which can cause an apparent I/O error. */
14014 if (interrupt_input
)
14015 unrequest_sigio ();
14018 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
14020 if (hscroll_windows (selected_window
))
14023 XWINDOW (selected_window
)->must_be_updated_p
= true;
14024 pending
= update_frame (sf
, 0, 0);
14025 sf
->cursor_type_changed
= 0;
14028 /* We may have called echo_area_display at the top of this
14029 function. If the echo area is on another frame, that may
14030 have put text on a frame other than the selected one, so the
14031 above call to update_frame would not have caught it. Catch
14033 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
14034 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
14036 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
14038 XWINDOW (mini_window
)->must_be_updated_p
= true;
14039 pending
|= update_frame (mini_frame
, 0, 0);
14040 mini_frame
->cursor_type_changed
= 0;
14041 if (!pending
&& hscroll_windows (mini_window
))
14046 /* If display was paused because of pending input, make sure we do a
14047 thorough update the next time. */
14050 /* Prevent the optimization at the beginning of
14051 redisplay_internal that tries a single-line update of the
14052 line containing the cursor in the selected window. */
14053 CHARPOS (this_line_start_pos
) = 0;
14055 /* Let the overlay arrow be updated the next time. */
14056 update_overlay_arrows (0);
14058 /* If we pause after scrolling, some rows in the current
14059 matrices of some windows are not valid. */
14060 if (!WINDOW_FULL_WIDTH_P (w
)
14061 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
14062 update_mode_lines
= 36;
14066 if (!consider_all_windows_p
)
14068 /* This has already been done above if
14069 consider_all_windows_p is set. */
14070 if (XBUFFER (w
->contents
)->text
->redisplay
14071 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
14072 /* This can happen if b->text->redisplay was set during
14074 propagate_buffer_redisplay ();
14075 mark_window_display_accurate_1 (w
, 1);
14077 /* Say overlay arrows are up to date. */
14078 update_overlay_arrows (1);
14080 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
14081 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
14084 update_mode_lines
= 0;
14085 windows_or_buffers_changed
= 0;
14088 /* Start SIGIO interrupts coming again. Having them off during the
14089 code above makes it less likely one will discard output, but not
14090 impossible, since there might be stuff in the system buffer here.
14091 But it is much hairier to try to do anything about that. */
14092 if (interrupt_input
)
14096 /* If a frame has become visible which was not before, redisplay
14097 again, so that we display it. Expose events for such a frame
14098 (which it gets when becoming visible) don't call the parts of
14099 redisplay constructing glyphs, so simply exposing a frame won't
14100 display anything in this case. So, we have to display these
14101 frames here explicitly. */
14106 FOR_EACH_FRAME (tail
, frame
)
14108 if (XFRAME (frame
)->visible
)
14112 if (new_count
!= number_of_visible_frames
)
14113 windows_or_buffers_changed
= 52;
14116 /* Change frame size now if a change is pending. */
14117 do_pending_window_change (1);
14119 /* If we just did a pending size change, or have additional
14120 visible frames, or selected_window changed, redisplay again. */
14121 if ((windows_or_buffers_changed
&& !pending
)
14122 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14125 /* Clear the face and image caches.
14127 We used to do this only if consider_all_windows_p. But the cache
14128 needs to be cleared if a timer creates images in the current
14129 buffer (e.g. the test case in Bug#6230). */
14131 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14133 clear_face_cache (0);
14134 clear_face_cache_count
= 0;
14137 #ifdef HAVE_WINDOW_SYSTEM
14138 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14140 clear_image_caches (Qnil
);
14141 clear_image_cache_count
= 0;
14143 #endif /* HAVE_WINDOW_SYSTEM */
14147 ns_set_doc_edited ();
14149 if (interrupt_input
&& interrupts_deferred
)
14152 unbind_to (count
, Qnil
);
14157 /* Redisplay, but leave alone any recent echo area message unless
14158 another message has been requested in its place.
14160 This is useful in situations where you need to redisplay but no
14161 user action has occurred, making it inappropriate for the message
14162 area to be cleared. See tracking_off and
14163 wait_reading_process_output for examples of these situations.
14165 FROM_WHERE is an integer saying from where this function was
14166 called. This is useful for debugging. */
14169 redisplay_preserve_echo_area (int from_where
)
14171 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14173 if (!NILP (echo_area_buffer
[1]))
14175 /* We have a previously displayed message, but no current
14176 message. Redisplay the previous message. */
14177 display_last_displayed_message_p
= 1;
14178 redisplay_internal ();
14179 display_last_displayed_message_p
= 0;
14182 redisplay_internal ();
14184 flush_frame (SELECTED_FRAME ());
14188 /* Function registered with record_unwind_protect in redisplay_internal. */
14191 unwind_redisplay (void)
14193 redisplaying_p
= 0;
14197 /* Mark the display of leaf window W as accurate or inaccurate.
14198 If ACCURATE_P is non-zero mark display of W as accurate. If
14199 ACCURATE_P is zero, arrange for W to be redisplayed the next
14200 time redisplay_internal is called. */
14203 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
14205 struct buffer
*b
= XBUFFER (w
->contents
);
14207 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14208 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14209 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14213 b
->clip_changed
= false;
14214 b
->prevent_redisplay_optimizations_p
= false;
14215 eassert (buffer_window_count (b
) > 0);
14216 /* Resetting b->text->redisplay is problematic!
14217 In order to make it safer to do it here, redisplay_internal must
14218 have copied all b->text->redisplay to their respective windows. */
14219 b
->text
->redisplay
= false;
14221 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14222 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14223 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14224 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14226 w
->current_matrix
->buffer
= b
;
14227 w
->current_matrix
->begv
= BUF_BEGV (b
);
14228 w
->current_matrix
->zv
= BUF_ZV (b
);
14230 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14231 w
->last_cursor_off_p
= w
->cursor_off_p
;
14233 if (w
== XWINDOW (selected_window
))
14234 w
->last_point
= BUF_PT (b
);
14236 w
->last_point
= marker_position (w
->pointm
);
14238 w
->window_end_valid
= true;
14239 w
->update_mode_line
= false;
14242 w
->redisplay
= !accurate_p
;
14246 /* Mark the display of windows in the window tree rooted at WINDOW as
14247 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
14248 windows as accurate. If ACCURATE_P is zero, arrange for windows to
14249 be redisplayed the next time redisplay_internal is called. */
14252 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
14256 for (; !NILP (window
); window
= w
->next
)
14258 w
= XWINDOW (window
);
14259 if (WINDOWP (w
->contents
))
14260 mark_window_display_accurate (w
->contents
, accurate_p
);
14262 mark_window_display_accurate_1 (w
, accurate_p
);
14266 update_overlay_arrows (1);
14268 /* Force a thorough redisplay the next time by setting
14269 last_arrow_position and last_arrow_string to t, which is
14270 unequal to any useful value of Voverlay_arrow_... */
14271 update_overlay_arrows (-1);
14275 /* Return value in display table DP (Lisp_Char_Table *) for character
14276 C. Since a display table doesn't have any parent, we don't have to
14277 follow parent. Do not call this function directly but use the
14278 macro DISP_CHAR_VECTOR. */
14281 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14285 if (ASCII_CHAR_P (c
))
14288 if (SUB_CHAR_TABLE_P (val
))
14289 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14295 XSETCHAR_TABLE (table
, dp
);
14296 val
= char_table_ref (table
, c
);
14305 /***********************************************************************
14307 ***********************************************************************/
14309 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14312 redisplay_windows (Lisp_Object window
)
14314 while (!NILP (window
))
14316 struct window
*w
= XWINDOW (window
);
14318 if (WINDOWP (w
->contents
))
14319 redisplay_windows (w
->contents
);
14320 else if (BUFFERP (w
->contents
))
14322 displayed_buffer
= XBUFFER (w
->contents
);
14323 /* Use list_of_error, not Qerror, so that
14324 we catch only errors and don't run the debugger. */
14325 internal_condition_case_1 (redisplay_window_0
, window
,
14327 redisplay_window_error
);
14335 redisplay_window_error (Lisp_Object ignore
)
14337 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14342 redisplay_window_0 (Lisp_Object window
)
14344 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14345 redisplay_window (window
, false);
14350 redisplay_window_1 (Lisp_Object window
)
14352 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14353 redisplay_window (window
, true);
14358 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14359 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14360 which positions recorded in ROW differ from current buffer
14363 Return 0 if cursor is not on this row, 1 otherwise. */
14366 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14367 struct glyph_matrix
*matrix
,
14368 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14371 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14372 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14373 struct glyph
*cursor
= NULL
;
14374 /* The last known character position in row. */
14375 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14377 ptrdiff_t pt_old
= PT
- delta
;
14378 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14379 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14380 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14381 /* A glyph beyond the edge of TEXT_AREA which we should never
14383 struct glyph
*glyphs_end
= end
;
14384 /* Non-zero means we've found a match for cursor position, but that
14385 glyph has the avoid_cursor_p flag set. */
14386 int match_with_avoid_cursor
= 0;
14387 /* Non-zero means we've seen at least one glyph that came from a
14389 int string_seen
= 0;
14390 /* Largest and smallest buffer positions seen so far during scan of
14392 ptrdiff_t bpos_max
= pos_before
;
14393 ptrdiff_t bpos_min
= pos_after
;
14394 /* Last buffer position covered by an overlay string with an integer
14395 `cursor' property. */
14396 ptrdiff_t bpos_covered
= 0;
14397 /* Non-zero means the display string on which to display the cursor
14398 comes from a text property, not from an overlay. */
14399 int string_from_text_prop
= 0;
14401 /* Don't even try doing anything if called for a mode-line or
14402 header-line row, since the rest of the code isn't prepared to
14403 deal with such calamities. */
14404 eassert (!row
->mode_line_p
);
14405 if (row
->mode_line_p
)
14408 /* Skip over glyphs not having an object at the start and the end of
14409 the row. These are special glyphs like truncation marks on
14410 terminal frames. */
14411 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14413 if (!row
->reversed_p
)
14416 && INTEGERP (glyph
->object
)
14417 && glyph
->charpos
< 0)
14419 x
+= glyph
->pixel_width
;
14423 && INTEGERP ((end
- 1)->object
)
14424 /* CHARPOS is zero for blanks and stretch glyphs
14425 inserted by extend_face_to_end_of_line. */
14426 && (end
- 1)->charpos
<= 0)
14428 glyph_before
= glyph
- 1;
14435 /* If the glyph row is reversed, we need to process it from back
14436 to front, so swap the edge pointers. */
14437 glyphs_end
= end
= glyph
- 1;
14438 glyph
+= row
->used
[TEXT_AREA
] - 1;
14440 while (glyph
> end
+ 1
14441 && INTEGERP (glyph
->object
)
14442 && glyph
->charpos
< 0)
14445 x
-= glyph
->pixel_width
;
14447 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
14449 /* By default, in reversed rows we put the cursor on the
14450 rightmost (first in the reading order) glyph. */
14451 for (g
= end
+ 1; g
< glyph
; g
++)
14452 x
+= g
->pixel_width
;
14454 && INTEGERP ((end
+ 1)->object
)
14455 && (end
+ 1)->charpos
<= 0)
14457 glyph_before
= glyph
+ 1;
14461 else if (row
->reversed_p
)
14463 /* In R2L rows that don't display text, put the cursor on the
14464 rightmost glyph. Case in point: an empty last line that is
14465 part of an R2L paragraph. */
14467 /* Avoid placing the cursor on the last glyph of the row, where
14468 on terminal frames we hold the vertical border between
14469 adjacent windows. */
14470 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14471 && !WINDOW_RIGHTMOST_P (w
)
14472 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14474 x
= -1; /* will be computed below, at label compute_x */
14477 /* Step 1: Try to find the glyph whose character position
14478 corresponds to point. If that's not possible, find 2 glyphs
14479 whose character positions are the closest to point, one before
14480 point, the other after it. */
14481 if (!row
->reversed_p
)
14482 while (/* not marched to end of glyph row */
14484 /* glyph was not inserted by redisplay for internal purposes */
14485 && !INTEGERP (glyph
->object
))
14487 if (BUFFERP (glyph
->object
))
14489 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14491 if (glyph
->charpos
> bpos_max
)
14492 bpos_max
= glyph
->charpos
;
14493 if (glyph
->charpos
< bpos_min
)
14494 bpos_min
= glyph
->charpos
;
14495 if (!glyph
->avoid_cursor_p
)
14497 /* If we hit point, we've found the glyph on which to
14498 display the cursor. */
14501 match_with_avoid_cursor
= 0;
14504 /* See if we've found a better approximation to
14505 POS_BEFORE or to POS_AFTER. */
14506 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14508 pos_before
= glyph
->charpos
;
14509 glyph_before
= glyph
;
14511 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14513 pos_after
= glyph
->charpos
;
14514 glyph_after
= glyph
;
14517 else if (dpos
== 0)
14518 match_with_avoid_cursor
= 1;
14520 else if (STRINGP (glyph
->object
))
14522 Lisp_Object chprop
;
14523 ptrdiff_t glyph_pos
= glyph
->charpos
;
14525 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14527 if (!NILP (chprop
))
14529 /* If the string came from a `display' text property,
14530 look up the buffer position of that property and
14531 use that position to update bpos_max, as if we
14532 actually saw such a position in one of the row's
14533 glyphs. This helps with supporting integer values
14534 of `cursor' property on the display string in
14535 situations where most or all of the row's buffer
14536 text is completely covered by display properties,
14537 so that no glyph with valid buffer positions is
14538 ever seen in the row. */
14539 ptrdiff_t prop_pos
=
14540 string_buffer_position_lim (glyph
->object
, pos_before
,
14543 if (prop_pos
>= pos_before
)
14544 bpos_max
= prop_pos
;
14546 if (INTEGERP (chprop
))
14548 bpos_covered
= bpos_max
+ XINT (chprop
);
14549 /* If the `cursor' property covers buffer positions up
14550 to and including point, we should display cursor on
14551 this glyph. Note that, if a `cursor' property on one
14552 of the string's characters has an integer value, we
14553 will break out of the loop below _before_ we get to
14554 the position match above. IOW, integer values of
14555 the `cursor' property override the "exact match for
14556 point" strategy of positioning the cursor. */
14557 /* Implementation note: bpos_max == pt_old when, e.g.,
14558 we are in an empty line, where bpos_max is set to
14559 MATRIX_ROW_START_CHARPOS, see above. */
14560 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14569 x
+= glyph
->pixel_width
;
14572 else if (glyph
> end
) /* row is reversed */
14573 while (!INTEGERP (glyph
->object
))
14575 if (BUFFERP (glyph
->object
))
14577 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14579 if (glyph
->charpos
> bpos_max
)
14580 bpos_max
= glyph
->charpos
;
14581 if (glyph
->charpos
< bpos_min
)
14582 bpos_min
= glyph
->charpos
;
14583 if (!glyph
->avoid_cursor_p
)
14587 match_with_avoid_cursor
= 0;
14590 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14592 pos_before
= glyph
->charpos
;
14593 glyph_before
= glyph
;
14595 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14597 pos_after
= glyph
->charpos
;
14598 glyph_after
= glyph
;
14601 else if (dpos
== 0)
14602 match_with_avoid_cursor
= 1;
14604 else if (STRINGP (glyph
->object
))
14606 Lisp_Object chprop
;
14607 ptrdiff_t glyph_pos
= glyph
->charpos
;
14609 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14611 if (!NILP (chprop
))
14613 ptrdiff_t prop_pos
=
14614 string_buffer_position_lim (glyph
->object
, pos_before
,
14617 if (prop_pos
>= pos_before
)
14618 bpos_max
= prop_pos
;
14620 if (INTEGERP (chprop
))
14622 bpos_covered
= bpos_max
+ XINT (chprop
);
14623 /* If the `cursor' property covers buffer positions up
14624 to and including point, we should display cursor on
14626 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14635 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14637 x
--; /* can't use any pixel_width */
14640 x
-= glyph
->pixel_width
;
14643 /* Step 2: If we didn't find an exact match for point, we need to
14644 look for a proper place to put the cursor among glyphs between
14645 GLYPH_BEFORE and GLYPH_AFTER. */
14646 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14647 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14648 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14650 /* An empty line has a single glyph whose OBJECT is zero and
14651 whose CHARPOS is the position of a newline on that line.
14652 Note that on a TTY, there are more glyphs after that, which
14653 were produced by extend_face_to_end_of_line, but their
14654 CHARPOS is zero or negative. */
14656 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14657 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0
14658 /* On a TTY, continued and truncated rows also have a glyph at
14659 their end whose OBJECT is zero and whose CHARPOS is
14660 positive (the continuation and truncation glyphs), but such
14661 rows are obviously not "empty". */
14662 && !(row
->continued_p
|| row
->truncated_on_right_p
);
14664 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14666 ptrdiff_t ellipsis_pos
;
14668 /* Scan back over the ellipsis glyphs. */
14669 if (!row
->reversed_p
)
14671 ellipsis_pos
= (glyph
- 1)->charpos
;
14672 while (glyph
> row
->glyphs
[TEXT_AREA
]
14673 && (glyph
- 1)->charpos
== ellipsis_pos
)
14674 glyph
--, x
-= glyph
->pixel_width
;
14675 /* That loop always goes one position too far, including
14676 the glyph before the ellipsis. So scan forward over
14678 x
+= glyph
->pixel_width
;
14681 else /* row is reversed */
14683 ellipsis_pos
= (glyph
+ 1)->charpos
;
14684 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14685 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14686 glyph
++, x
+= glyph
->pixel_width
;
14687 x
-= glyph
->pixel_width
;
14691 else if (match_with_avoid_cursor
)
14693 cursor
= glyph_after
;
14696 else if (string_seen
)
14698 int incr
= row
->reversed_p
? -1 : +1;
14700 /* Need to find the glyph that came out of a string which is
14701 present at point. That glyph is somewhere between
14702 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14703 positioned between POS_BEFORE and POS_AFTER in the
14705 struct glyph
*start
, *stop
;
14706 ptrdiff_t pos
= pos_before
;
14710 /* If the row ends in a newline from a display string,
14711 reordering could have moved the glyphs belonging to the
14712 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14713 in this case we extend the search to the last glyph in
14714 the row that was not inserted by redisplay. */
14715 if (row
->ends_in_newline_from_string_p
)
14718 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14721 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14722 correspond to POS_BEFORE and POS_AFTER, respectively. We
14723 need START and STOP in the order that corresponds to the
14724 row's direction as given by its reversed_p flag. If the
14725 directionality of characters between POS_BEFORE and
14726 POS_AFTER is the opposite of the row's base direction,
14727 these characters will have been reordered for display,
14728 and we need to reverse START and STOP. */
14729 if (!row
->reversed_p
)
14731 start
= min (glyph_before
, glyph_after
);
14732 stop
= max (glyph_before
, glyph_after
);
14736 start
= max (glyph_before
, glyph_after
);
14737 stop
= min (glyph_before
, glyph_after
);
14739 for (glyph
= start
+ incr
;
14740 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14743 /* Any glyphs that come from the buffer are here because
14744 of bidi reordering. Skip them, and only pay
14745 attention to glyphs that came from some string. */
14746 if (STRINGP (glyph
->object
))
14750 /* If the display property covers the newline, we
14751 need to search for it one position farther. */
14752 ptrdiff_t lim
= pos_after
14753 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14755 string_from_text_prop
= 0;
14756 str
= glyph
->object
;
14757 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14758 if (tem
== 0 /* from overlay */
14761 /* If the string from which this glyph came is
14762 found in the buffer at point, or at position
14763 that is closer to point than pos_after, then
14764 we've found the glyph we've been looking for.
14765 If it comes from an overlay (tem == 0), and
14766 it has the `cursor' property on one of its
14767 glyphs, record that glyph as a candidate for
14768 displaying the cursor. (As in the
14769 unidirectional version, we will display the
14770 cursor on the last candidate we find.) */
14773 || (tem
- pt_old
> 0 && tem
< pos_after
))
14775 /* The glyphs from this string could have
14776 been reordered. Find the one with the
14777 smallest string position. Or there could
14778 be a character in the string with the
14779 `cursor' property, which means display
14780 cursor on that character's glyph. */
14781 ptrdiff_t strpos
= glyph
->charpos
;
14786 string_from_text_prop
= 1;
14789 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14790 && EQ (glyph
->object
, str
);
14794 ptrdiff_t gpos
= glyph
->charpos
;
14796 cprop
= Fget_char_property (make_number (gpos
),
14804 if (tem
&& glyph
->charpos
< strpos
)
14806 strpos
= glyph
->charpos
;
14812 || (tem
- pt_old
> 0 && tem
< pos_after
))
14816 pos
= tem
+ 1; /* don't find previous instances */
14818 /* This string is not what we want; skip all of the
14819 glyphs that came from it. */
14820 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14821 && EQ (glyph
->object
, str
))
14828 /* If we reached the end of the line, and END was from a string,
14829 the cursor is not on this line. */
14831 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14832 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14833 && STRINGP (end
->object
)
14834 && row
->continued_p
)
14837 /* A truncated row may not include PT among its character positions.
14838 Setting the cursor inside the scroll margin will trigger
14839 recalculation of hscroll in hscroll_window_tree. But if a
14840 display string covers point, defer to the string-handling
14841 code below to figure this out. */
14842 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14844 cursor
= glyph_before
;
14847 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14848 /* Zero-width characters produce no glyphs. */
14850 && (row
->reversed_p
14851 ? glyph_after
> glyphs_end
14852 : glyph_after
< glyphs_end
)))
14854 cursor
= glyph_after
;
14860 if (cursor
!= NULL
)
14862 else if (glyph
== glyphs_end
14863 && pos_before
== pos_after
14864 && STRINGP ((row
->reversed_p
14865 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14866 : row
->glyphs
[TEXT_AREA
])->object
))
14868 /* If all the glyphs of this row came from strings, put the
14869 cursor on the first glyph of the row. This avoids having the
14870 cursor outside of the text area in this very rare and hard
14874 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14875 : row
->glyphs
[TEXT_AREA
];
14881 /* Need to compute x that corresponds to GLYPH. */
14882 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14884 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14886 x
+= g
->pixel_width
;
14890 /* ROW could be part of a continued line, which, under bidi
14891 reordering, might have other rows whose start and end charpos
14892 occlude point. Only set w->cursor if we found a better
14893 approximation to the cursor position than we have from previously
14894 examined candidate rows belonging to the same continued line. */
14895 if (/* We already have a candidate row. */
14896 w
->cursor
.vpos
>= 0
14897 /* That candidate is not the row we are processing. */
14898 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14899 /* Make sure cursor.vpos specifies a row whose start and end
14900 charpos occlude point, and it is valid candidate for being a
14901 cursor-row. This is because some callers of this function
14902 leave cursor.vpos at the row where the cursor was displayed
14903 during the last redisplay cycle. */
14904 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14905 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14906 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14909 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14911 /* Don't consider glyphs that are outside TEXT_AREA. */
14912 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14914 /* Keep the candidate whose buffer position is the closest to
14915 point or has the `cursor' property. */
14916 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14917 w
->cursor
.hpos
>= 0
14918 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14919 && ((BUFFERP (g1
->object
)
14920 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14921 || (BUFFERP (glyph
->object
)
14922 && eabs (g1
->charpos
- pt_old
)
14923 < eabs (glyph
->charpos
- pt_old
))))
14924 /* Previous candidate is a glyph from a string that has
14925 a non-nil `cursor' property. */
14926 || (STRINGP (g1
->object
)
14927 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14928 Qcursor
, g1
->object
))
14929 /* Previous candidate is from the same display
14930 string as this one, and the display string
14931 came from a text property. */
14932 || (EQ (g1
->object
, glyph
->object
)
14933 && string_from_text_prop
)
14934 /* this candidate is from newline and its
14935 position is not an exact match */
14936 || (INTEGERP (glyph
->object
)
14937 && glyph
->charpos
!= pt_old
)))))
14939 /* If this candidate gives an exact match, use that. */
14940 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14941 /* If this candidate is a glyph created for the
14942 terminating newline of a line, and point is on that
14943 newline, it wins because it's an exact match. */
14944 || (!row
->continued_p
14945 && INTEGERP (glyph
->object
)
14946 && glyph
->charpos
== 0
14947 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14948 /* Otherwise, keep the candidate that comes from a row
14949 spanning less buffer positions. This may win when one or
14950 both candidate positions are on glyphs that came from
14951 display strings, for which we cannot compare buffer
14953 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14954 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14955 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14958 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14960 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14961 w
->cursor
.y
= row
->y
+ dy
;
14963 if (w
== XWINDOW (selected_window
))
14965 if (!row
->continued_p
14966 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14969 this_line_buffer
= XBUFFER (w
->contents
);
14971 CHARPOS (this_line_start_pos
)
14972 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14973 BYTEPOS (this_line_start_pos
)
14974 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14976 CHARPOS (this_line_end_pos
)
14977 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14978 BYTEPOS (this_line_end_pos
)
14979 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14981 this_line_y
= w
->cursor
.y
;
14982 this_line_pixel_height
= row
->height
;
14983 this_line_vpos
= w
->cursor
.vpos
;
14984 this_line_start_x
= row
->x
;
14987 CHARPOS (this_line_start_pos
) = 0;
14994 /* Run window scroll functions, if any, for WINDOW with new window
14995 start STARTP. Sets the window start of WINDOW to that position.
14997 We assume that the window's buffer is really current. */
14999 static struct text_pos
15000 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
15002 struct window
*w
= XWINDOW (window
);
15003 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
15005 eassert (current_buffer
== XBUFFER (w
->contents
));
15007 if (!NILP (Vwindow_scroll_functions
))
15009 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
15010 make_number (CHARPOS (startp
)));
15011 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15012 /* In case the hook functions switch buffers. */
15013 set_buffer_internal (XBUFFER (w
->contents
));
15020 /* Make sure the line containing the cursor is fully visible.
15021 A value of 1 means there is nothing to be done.
15022 (Either the line is fully visible, or it cannot be made so,
15023 or we cannot tell.)
15025 If FORCE_P is non-zero, return 0 even if partial visible cursor row
15026 is higher than window.
15028 If CURRENT_MATRIX_P is non-zero, use the information from the
15029 window's current glyph matrix; otherwise use the desired glyph
15032 A value of 0 means the caller should do scrolling
15033 as if point had gone off the screen. */
15036 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
15038 struct glyph_matrix
*matrix
;
15039 struct glyph_row
*row
;
15042 if (!make_cursor_line_fully_visible_p
)
15045 /* It's not always possible to find the cursor, e.g, when a window
15046 is full of overlay strings. Don't do anything in that case. */
15047 if (w
->cursor
.vpos
< 0)
15050 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
15051 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
15053 /* If the cursor row is not partially visible, there's nothing to do. */
15054 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
15057 /* If the row the cursor is in is taller than the window's height,
15058 it's not clear what to do, so do nothing. */
15059 window_height
= window_box_height (w
);
15060 if (row
->height
>= window_height
)
15062 if (!force_p
|| MINI_WINDOW_P (w
)
15063 || w
->vscroll
|| w
->cursor
.vpos
== 0)
15070 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
15071 non-zero means only WINDOW is redisplayed in redisplay_internal.
15072 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
15073 in redisplay_window to bring a partially visible line into view in
15074 the case that only the cursor has moved.
15076 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
15077 last screen line's vertical height extends past the end of the screen.
15081 1 if scrolling succeeded
15083 0 if scrolling didn't find point.
15085 -1 if new fonts have been loaded so that we must interrupt
15086 redisplay, adjust glyph matrices, and try again. */
15092 SCROLLING_NEED_LARGER_MATRICES
15095 /* If scroll-conservatively is more than this, never recenter.
15097 If you change this, don't forget to update the doc string of
15098 `scroll-conservatively' and the Emacs manual. */
15099 #define SCROLL_LIMIT 100
15102 try_scrolling (Lisp_Object window
, int just_this_one_p
,
15103 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15104 int temp_scroll_step
, int last_line_misfit
)
15106 struct window
*w
= XWINDOW (window
);
15107 struct frame
*f
= XFRAME (w
->frame
);
15108 struct text_pos pos
, startp
;
15110 int this_scroll_margin
, scroll_max
, rc
, height
;
15111 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
15112 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
15113 Lisp_Object aggressive
;
15114 /* We will never try scrolling more than this number of lines. */
15115 int scroll_limit
= SCROLL_LIMIT
;
15116 int frame_line_height
= default_line_pixel_height (w
);
15117 int window_total_lines
15118 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15121 debug_method_add (w
, "try_scrolling");
15124 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15126 /* Compute scroll margin height in pixels. We scroll when point is
15127 within this distance from the top or bottom of the window. */
15128 if (scroll_margin
> 0)
15129 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15130 * frame_line_height
;
15132 this_scroll_margin
= 0;
15134 /* Force arg_scroll_conservatively to have a reasonable value, to
15135 avoid scrolling too far away with slow move_it_* functions. Note
15136 that the user can supply scroll-conservatively equal to
15137 `most-positive-fixnum', which can be larger than INT_MAX. */
15138 if (arg_scroll_conservatively
> scroll_limit
)
15140 arg_scroll_conservatively
= scroll_limit
+ 1;
15141 scroll_max
= scroll_limit
* frame_line_height
;
15143 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15144 /* Compute how much we should try to scroll maximally to bring
15145 point into view. */
15146 scroll_max
= (max (scroll_step
,
15147 max (arg_scroll_conservatively
, temp_scroll_step
))
15148 * frame_line_height
);
15149 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15150 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15151 /* We're trying to scroll because of aggressive scrolling but no
15152 scroll_step is set. Choose an arbitrary one. */
15153 scroll_max
= 10 * frame_line_height
;
15159 /* Decide whether to scroll down. */
15160 if (PT
> CHARPOS (startp
))
15162 int scroll_margin_y
;
15164 /* Compute the pixel ypos of the scroll margin, then move IT to
15165 either that ypos or PT, whichever comes first. */
15166 start_display (&it
, w
, startp
);
15167 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15168 - frame_line_height
* extra_scroll_margin_lines
;
15169 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15170 (MOVE_TO_POS
| MOVE_TO_Y
));
15172 if (PT
> CHARPOS (it
.current
.pos
))
15174 int y0
= line_bottom_y (&it
);
15175 /* Compute how many pixels below window bottom to stop searching
15176 for PT. This avoids costly search for PT that is far away if
15177 the user limited scrolling by a small number of lines, but
15178 always finds PT if scroll_conservatively is set to a large
15179 number, such as most-positive-fixnum. */
15180 int slack
= max (scroll_max
, 10 * frame_line_height
);
15181 int y_to_move
= it
.last_visible_y
+ slack
;
15183 /* Compute the distance from the scroll margin to PT or to
15184 the scroll limit, whichever comes first. This should
15185 include the height of the cursor line, to make that line
15187 move_it_to (&it
, PT
, -1, y_to_move
,
15188 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15189 dy
= line_bottom_y (&it
) - y0
;
15191 if (dy
> scroll_max
)
15192 return SCROLLING_FAILED
;
15201 /* Point is in or below the bottom scroll margin, so move the
15202 window start down. If scrolling conservatively, move it just
15203 enough down to make point visible. If scroll_step is set,
15204 move it down by scroll_step. */
15205 if (arg_scroll_conservatively
)
15207 = min (max (dy
, frame_line_height
),
15208 frame_line_height
* arg_scroll_conservatively
);
15209 else if (scroll_step
|| temp_scroll_step
)
15210 amount_to_scroll
= scroll_max
;
15213 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15214 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15215 if (NUMBERP (aggressive
))
15217 double float_amount
= XFLOATINT (aggressive
) * height
;
15218 int aggressive_scroll
= float_amount
;
15219 if (aggressive_scroll
== 0 && float_amount
> 0)
15220 aggressive_scroll
= 1;
15221 /* Don't let point enter the scroll margin near top of
15222 the window. This could happen if the value of
15223 scroll_up_aggressively is too large and there are
15224 non-zero margins, because scroll_up_aggressively
15225 means put point that fraction of window height
15226 _from_the_bottom_margin_. */
15227 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15228 aggressive_scroll
= height
- 2*this_scroll_margin
;
15229 amount_to_scroll
= dy
+ aggressive_scroll
;
15233 if (amount_to_scroll
<= 0)
15234 return SCROLLING_FAILED
;
15236 start_display (&it
, w
, startp
);
15237 if (arg_scroll_conservatively
<= scroll_limit
)
15238 move_it_vertically (&it
, amount_to_scroll
);
15241 /* Extra precision for users who set scroll-conservatively
15242 to a large number: make sure the amount we scroll
15243 the window start is never less than amount_to_scroll,
15244 which was computed as distance from window bottom to
15245 point. This matters when lines at window top and lines
15246 below window bottom have different height. */
15248 void *it1data
= NULL
;
15249 /* We use a temporary it1 because line_bottom_y can modify
15250 its argument, if it moves one line down; see there. */
15253 SAVE_IT (it1
, it
, it1data
);
15254 start_y
= line_bottom_y (&it1
);
15256 RESTORE_IT (&it
, &it
, it1data
);
15257 move_it_by_lines (&it
, 1);
15258 SAVE_IT (it1
, it
, it1data
);
15259 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15262 /* If STARTP is unchanged, move it down another screen line. */
15263 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
15264 move_it_by_lines (&it
, 1);
15265 startp
= it
.current
.pos
;
15269 struct text_pos scroll_margin_pos
= startp
;
15272 /* See if point is inside the scroll margin at the top of the
15274 if (this_scroll_margin
)
15278 start_display (&it
, w
, startp
);
15279 y_start
= it
.current_y
;
15280 move_it_vertically (&it
, this_scroll_margin
);
15281 scroll_margin_pos
= it
.current
.pos
;
15282 /* If we didn't move enough before hitting ZV, request
15283 additional amount of scroll, to move point out of the
15285 if (IT_CHARPOS (it
) == ZV
15286 && it
.current_y
- y_start
< this_scroll_margin
)
15287 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15290 if (PT
< CHARPOS (scroll_margin_pos
))
15292 /* Point is in the scroll margin at the top of the window or
15293 above what is displayed in the window. */
15296 /* Compute the vertical distance from PT to the scroll
15297 margin position. Move as far as scroll_max allows, or
15298 one screenful, or 10 screen lines, whichever is largest.
15299 Give up if distance is greater than scroll_max or if we
15300 didn't reach the scroll margin position. */
15301 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15302 start_display (&it
, w
, pos
);
15304 y_to_move
= max (it
.last_visible_y
,
15305 max (scroll_max
, 10 * frame_line_height
));
15306 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15308 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15309 dy
= it
.current_y
- y0
;
15310 if (dy
> scroll_max
15311 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15312 return SCROLLING_FAILED
;
15314 /* Additional scroll for when ZV was too close to point. */
15317 /* Compute new window start. */
15318 start_display (&it
, w
, startp
);
15320 if (arg_scroll_conservatively
)
15321 amount_to_scroll
= max (dy
, frame_line_height
*
15322 max (scroll_step
, temp_scroll_step
));
15323 else if (scroll_step
|| temp_scroll_step
)
15324 amount_to_scroll
= scroll_max
;
15327 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15328 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15329 if (NUMBERP (aggressive
))
15331 double float_amount
= XFLOATINT (aggressive
) * height
;
15332 int aggressive_scroll
= float_amount
;
15333 if (aggressive_scroll
== 0 && float_amount
> 0)
15334 aggressive_scroll
= 1;
15335 /* Don't let point enter the scroll margin near
15336 bottom of the window, if the value of
15337 scroll_down_aggressively happens to be too
15339 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15340 aggressive_scroll
= height
- 2*this_scroll_margin
;
15341 amount_to_scroll
= dy
+ aggressive_scroll
;
15345 if (amount_to_scroll
<= 0)
15346 return SCROLLING_FAILED
;
15348 move_it_vertically_backward (&it
, amount_to_scroll
);
15349 startp
= it
.current
.pos
;
15353 /* Run window scroll functions. */
15354 startp
= run_window_scroll_functions (window
, startp
);
15356 /* Display the window. Give up if new fonts are loaded, or if point
15358 if (!try_window (window
, startp
, 0))
15359 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15360 else if (w
->cursor
.vpos
< 0)
15362 clear_glyph_matrix (w
->desired_matrix
);
15363 rc
= SCROLLING_FAILED
;
15367 /* Maybe forget recorded base line for line number display. */
15368 if (!just_this_one_p
15369 || current_buffer
->clip_changed
15370 || BEG_UNCHANGED
< CHARPOS (startp
))
15371 w
->base_line_number
= 0;
15373 /* If cursor ends up on a partially visible line,
15374 treat that as being off the bottom of the screen. */
15375 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
15376 /* It's possible that the cursor is on the first line of the
15377 buffer, which is partially obscured due to a vscroll
15378 (Bug#7537). In that case, avoid looping forever. */
15379 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15381 clear_glyph_matrix (w
->desired_matrix
);
15382 ++extra_scroll_margin_lines
;
15385 rc
= SCROLLING_SUCCESS
;
15392 /* Compute a suitable window start for window W if display of W starts
15393 on a continuation line. Value is non-zero if a new window start
15396 The new window start will be computed, based on W's width, starting
15397 from the start of the continued line. It is the start of the
15398 screen line with the minimum distance from the old start W->start. */
15401 compute_window_start_on_continuation_line (struct window
*w
)
15403 struct text_pos pos
, start_pos
;
15404 int window_start_changed_p
= 0;
15406 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15408 /* If window start is on a continuation line... Window start may be
15409 < BEGV in case there's invisible text at the start of the
15410 buffer (M-x rmail, for example). */
15411 if (CHARPOS (start_pos
) > BEGV
15412 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15415 struct glyph_row
*row
;
15417 /* Handle the case that the window start is out of range. */
15418 if (CHARPOS (start_pos
) < BEGV
)
15419 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15420 else if (CHARPOS (start_pos
) > ZV
)
15421 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15423 /* Find the start of the continued line. This should be fast
15424 because find_newline is fast (newline cache). */
15425 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
15426 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15427 row
, DEFAULT_FACE_ID
);
15428 reseat_at_previous_visible_line_start (&it
);
15430 /* If the line start is "too far" away from the window start,
15431 say it takes too much time to compute a new window start. */
15432 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15433 /* PXW: Do we need upper bounds here? */
15434 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15436 int min_distance
, distance
;
15438 /* Move forward by display lines to find the new window
15439 start. If window width was enlarged, the new start can
15440 be expected to be > the old start. If window width was
15441 decreased, the new window start will be < the old start.
15442 So, we're looking for the display line start with the
15443 minimum distance from the old window start. */
15444 pos
= it
.current
.pos
;
15445 min_distance
= INFINITY
;
15446 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15447 distance
< min_distance
)
15449 min_distance
= distance
;
15450 pos
= it
.current
.pos
;
15451 if (it
.line_wrap
== WORD_WRAP
)
15453 /* Under WORD_WRAP, move_it_by_lines is likely to
15454 overshoot and stop not at the first, but the
15455 second character from the left margin. So in
15456 that case, we need a more tight control on the X
15457 coordinate of the iterator than move_it_by_lines
15458 promises in its contract. The method is to first
15459 go to the last (rightmost) visible character of a
15460 line, then move to the leftmost character on the
15461 next line in a separate call. */
15462 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15463 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15464 move_it_to (&it
, ZV
, 0,
15465 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15466 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15469 move_it_by_lines (&it
, 1);
15472 /* Set the window start there. */
15473 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15474 window_start_changed_p
= 1;
15478 return window_start_changed_p
;
15482 /* Try cursor movement in case text has not changed in window WINDOW,
15483 with window start STARTP. Value is
15485 CURSOR_MOVEMENT_SUCCESS if successful
15487 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15489 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15490 display. *SCROLL_STEP is set to 1, under certain circumstances, if
15491 we want to scroll as if scroll-step were set to 1. See the code.
15493 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15494 which case we have to abort this redisplay, and adjust matrices
15499 CURSOR_MOVEMENT_SUCCESS
,
15500 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15501 CURSOR_MOVEMENT_MUST_SCROLL
,
15502 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15506 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
15508 struct window
*w
= XWINDOW (window
);
15509 struct frame
*f
= XFRAME (w
->frame
);
15510 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15513 if (inhibit_try_cursor_movement
)
15517 /* Previously, there was a check for Lisp integer in the
15518 if-statement below. Now, this field is converted to
15519 ptrdiff_t, thus zero means invalid position in a buffer. */
15520 eassert (w
->last_point
> 0);
15521 /* Likewise there was a check whether window_end_vpos is nil or larger
15522 than the window. Now window_end_vpos is int and so never nil, but
15523 let's leave eassert to check whether it fits in the window. */
15524 eassert (w
->window_end_vpos
< w
->current_matrix
->nrows
);
15526 /* Handle case where text has not changed, only point, and it has
15527 not moved off the frame. */
15528 if (/* Point may be in this window. */
15529 PT
>= CHARPOS (startp
)
15530 /* Selective display hasn't changed. */
15531 && !current_buffer
->clip_changed
15532 /* Function force-mode-line-update is used to force a thorough
15533 redisplay. It sets either windows_or_buffers_changed or
15534 update_mode_lines. So don't take a shortcut here for these
15536 && !update_mode_lines
15537 && !windows_or_buffers_changed
15538 && !f
->cursor_type_changed
15539 && NILP (Vshow_trailing_whitespace
)
15540 /* This code is not used for mini-buffer for the sake of the case
15541 of redisplaying to replace an echo area message; since in
15542 that case the mini-buffer contents per se are usually
15543 unchanged. This code is of no real use in the mini-buffer
15544 since the handling of this_line_start_pos, etc., in redisplay
15545 handles the same cases. */
15546 && !EQ (window
, minibuf_window
)
15547 && (FRAME_WINDOW_P (f
)
15548 || !overlay_arrow_in_current_buffer_p ()))
15550 int this_scroll_margin
, top_scroll_margin
;
15551 struct glyph_row
*row
= NULL
;
15552 int frame_line_height
= default_line_pixel_height (w
);
15553 int window_total_lines
15554 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15557 debug_method_add (w
, "cursor movement");
15560 /* Scroll if point within this distance from the top or bottom
15561 of the window. This is a pixel value. */
15562 if (scroll_margin
> 0)
15564 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15565 this_scroll_margin
*= frame_line_height
;
15568 this_scroll_margin
= 0;
15570 top_scroll_margin
= this_scroll_margin
;
15571 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15572 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15574 /* Start with the row the cursor was displayed during the last
15575 not paused redisplay. Give up if that row is not valid. */
15576 if (w
->last_cursor_vpos
< 0
15577 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15578 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15581 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15582 if (row
->mode_line_p
)
15584 if (!row
->enabled_p
)
15585 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15588 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15590 int scroll_p
= 0, must_scroll
= 0;
15591 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15593 if (PT
> w
->last_point
)
15595 /* Point has moved forward. */
15596 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15597 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15599 eassert (row
->enabled_p
);
15603 /* If the end position of a row equals the start
15604 position of the next row, and PT is at that position,
15605 we would rather display cursor in the next line. */
15606 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15607 && MATRIX_ROW_END_CHARPOS (row
) == PT
15608 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15609 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15610 && !cursor_row_p (row
))
15613 /* If within the scroll margin, scroll. Note that
15614 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15615 the next line would be drawn, and that
15616 this_scroll_margin can be zero. */
15617 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15618 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15619 /* Line is completely visible last line in window
15620 and PT is to be set in the next line. */
15621 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15622 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15623 && !row
->ends_at_zv_p
15624 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15627 else if (PT
< w
->last_point
)
15629 /* Cursor has to be moved backward. Note that PT >=
15630 CHARPOS (startp) because of the outer if-statement. */
15631 while (!row
->mode_line_p
15632 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15633 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15634 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15635 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15636 row
> w
->current_matrix
->rows
15637 && (row
-1)->ends_in_newline_from_string_p
))))
15638 && (row
->y
> top_scroll_margin
15639 || CHARPOS (startp
) == BEGV
))
15641 eassert (row
->enabled_p
);
15645 /* Consider the following case: Window starts at BEGV,
15646 there is invisible, intangible text at BEGV, so that
15647 display starts at some point START > BEGV. It can
15648 happen that we are called with PT somewhere between
15649 BEGV and START. Try to handle that case. */
15650 if (row
< w
->current_matrix
->rows
15651 || row
->mode_line_p
)
15653 row
= w
->current_matrix
->rows
;
15654 if (row
->mode_line_p
)
15658 /* Due to newlines in overlay strings, we may have to
15659 skip forward over overlay strings. */
15660 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15661 && MATRIX_ROW_END_CHARPOS (row
) == PT
15662 && !cursor_row_p (row
))
15665 /* If within the scroll margin, scroll. */
15666 if (row
->y
< top_scroll_margin
15667 && CHARPOS (startp
) != BEGV
)
15672 /* Cursor did not move. So don't scroll even if cursor line
15673 is partially visible, as it was so before. */
15674 rc
= CURSOR_MOVEMENT_SUCCESS
;
15677 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15678 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15680 /* if PT is not in the glyph row, give up. */
15681 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15684 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15685 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15687 struct glyph_row
*row1
;
15689 /* If rows are bidi-reordered and point moved, back up
15690 until we find a row that does not belong to a
15691 continuation line. This is because we must consider
15692 all rows of a continued line as candidates for the
15693 new cursor positioning, since row start and end
15694 positions change non-linearly with vertical position
15696 /* FIXME: Revisit this when glyph ``spilling'' in
15697 continuation lines' rows is implemented for
15698 bidi-reordered rows. */
15699 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15700 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15703 /* If we hit the beginning of the displayed portion
15704 without finding the first row of a continued
15708 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15711 eassert (row
->enabled_p
);
15716 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15717 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15718 /* Make sure this isn't a header line by any chance, since
15719 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15720 && !row
->mode_line_p
15721 && make_cursor_line_fully_visible_p
)
15723 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15724 && !row
->ends_at_zv_p
15725 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15726 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15727 else if (row
->height
> window_box_height (w
))
15729 /* If we end up in a partially visible line, let's
15730 make it fully visible, except when it's taller
15731 than the window, in which case we can't do much
15734 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15738 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15739 if (!cursor_row_fully_visible_p (w
, 0, 1))
15740 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15742 rc
= CURSOR_MOVEMENT_SUCCESS
;
15746 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15747 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15748 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15750 /* With bidi-reordered rows, there could be more than
15751 one candidate row whose start and end positions
15752 occlude point. We need to let set_cursor_from_row
15753 find the best candidate. */
15754 /* FIXME: Revisit this when glyph ``spilling'' in
15755 continuation lines' rows is implemented for
15756 bidi-reordered rows. */
15761 int at_zv_p
= 0, exact_match_p
= 0;
15763 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15764 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15765 && cursor_row_p (row
))
15766 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15768 /* As soon as we've found the exact match for point,
15769 or the first suitable row whose ends_at_zv_p flag
15770 is set, we are done. */
15773 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15774 w
->cursor
.vpos
)->ends_at_zv_p
;
15776 && w
->cursor
.hpos
>= 0
15777 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15780 struct glyph_row
*candidate
=
15781 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15783 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15784 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15787 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15788 || (INTEGERP (g
->object
)
15789 && (g
->charpos
== PT
15790 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15792 if (at_zv_p
|| exact_match_p
)
15794 rc
= CURSOR_MOVEMENT_SUCCESS
;
15798 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15802 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15803 || row
->continued_p
)
15804 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15805 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15806 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15807 /* If we didn't find any candidate rows, or exited the
15808 loop before all the candidates were examined, signal
15809 to the caller that this method failed. */
15810 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15812 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15813 && !row
->continued_p
))
15814 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15816 rc
= CURSOR_MOVEMENT_SUCCESS
;
15822 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15824 rc
= CURSOR_MOVEMENT_SUCCESS
;
15829 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15830 && MATRIX_ROW_START_CHARPOS (row
) == PT
15831 && cursor_row_p (row
));
15839 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15843 set_vertical_scroll_bar (struct window
*w
)
15845 ptrdiff_t start
, end
, whole
;
15847 /* Calculate the start and end positions for the current window.
15848 At some point, it would be nice to choose between scrollbars
15849 which reflect the whole buffer size, with special markers
15850 indicating narrowing, and scrollbars which reflect only the
15853 Note that mini-buffers sometimes aren't displaying any text. */
15854 if (!MINI_WINDOW_P (w
)
15855 || (w
== XWINDOW (minibuf_window
)
15856 && NILP (echo_area_buffer
[0])))
15858 struct buffer
*buf
= XBUFFER (w
->contents
);
15859 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15860 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15861 /* I don't think this is guaranteed to be right. For the
15862 moment, we'll pretend it is. */
15863 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15867 if (whole
< (end
- start
))
15868 whole
= end
- start
;
15871 start
= end
= whole
= 0;
15873 /* Indicate what this scroll bar ought to be displaying now. */
15874 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15875 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15876 (w
, end
- start
, whole
, start
);
15880 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15881 selected_window is redisplayed.
15883 We can return without actually redisplaying the window if fonts has been
15884 changed on window's frame. In that case, redisplay_internal will retry.
15886 As one of the important parts of redisplaying a window, we need to
15887 decide whether the previous window-start position (stored in the
15888 window's w->start marker position) is still valid, and if it isn't,
15889 recompute it. Some details about that:
15891 . The previous window-start could be in a continuation line, in
15892 which case we need to recompute it when the window width
15893 changes. See compute_window_start_on_continuation_line and its
15896 . The text that changed since last redisplay could include the
15897 previous window-start position. In that case, we try to salvage
15898 what we can from the current glyph matrix by calling
15899 try_scrolling, which see.
15901 . Some Emacs command could force us to use a specific window-start
15902 position by setting the window's force_start flag, or gently
15903 propose doing that by setting the window's optional_new_start
15904 flag. In these cases, we try using the specified start point if
15905 that succeeds (i.e. the window desired matrix is successfully
15906 recomputed, and point location is within the window). In case
15907 of optional_new_start, we first check if the specified start
15908 position is feasible, i.e. if it will allow point to be
15909 displayed in the window. If using the specified start point
15910 fails, e.g., if new fonts are needed to be loaded, we abort the
15911 redisplay cycle and leave it up to the next cycle to figure out
15914 . Note that the window's force_start flag is sometimes set by
15915 redisplay itself, when it decides that the previous window start
15916 point is fine and should be kept. Search for "goto force_start"
15917 below to see the details. Like the values of window-start
15918 specified outside of redisplay, these internally-deduced values
15919 are tested for feasibility, and ignored if found to be
15922 . Note that the function try_window, used to completely redisplay
15923 a window, accepts the window's start point as its argument.
15924 This is used several times in the redisplay code to control
15925 where the window start will be, according to user options such
15926 as scroll-conservatively, and also to ensure the screen line
15927 showing point will be fully (as opposed to partially) visible on
15931 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15933 struct window
*w
= XWINDOW (window
);
15934 struct frame
*f
= XFRAME (w
->frame
);
15935 struct buffer
*buffer
= XBUFFER (w
->contents
);
15936 struct buffer
*old
= current_buffer
;
15937 struct text_pos lpoint
, opoint
, startp
;
15938 int update_mode_line
;
15941 /* Record it now because it's overwritten. */
15942 bool current_matrix_up_to_date_p
= false;
15943 bool used_current_matrix_p
= false;
15944 /* This is less strict than current_matrix_up_to_date_p.
15945 It indicates that the buffer contents and narrowing are unchanged. */
15946 bool buffer_unchanged_p
= false;
15947 int temp_scroll_step
= 0;
15948 ptrdiff_t count
= SPECPDL_INDEX ();
15950 int centering_position
= -1;
15951 int last_line_misfit
= 0;
15952 ptrdiff_t beg_unchanged
, end_unchanged
;
15953 int frame_line_height
;
15955 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15959 *w
->desired_matrix
->method
= 0;
15962 if (!just_this_one_p
15963 && REDISPLAY_SOME_P ()
15966 && !buffer
->text
->redisplay
15967 && BUF_PT (buffer
) == w
->last_point
)
15970 /* Make sure that both W's markers are valid. */
15971 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15972 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15974 /* We come here again if we need to run window-text-change-functions
15977 reconsider_clip_changes (w
);
15978 frame_line_height
= default_line_pixel_height (w
);
15980 /* Has the mode line to be updated? */
15981 update_mode_line
= (w
->update_mode_line
15982 || update_mode_lines
15983 || buffer
->clip_changed
15984 || buffer
->prevent_redisplay_optimizations_p
);
15986 if (!just_this_one_p
)
15987 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15988 cleverly elsewhere. */
15989 w
->must_be_updated_p
= true;
15991 if (MINI_WINDOW_P (w
))
15993 if (w
== XWINDOW (echo_area_window
)
15994 && !NILP (echo_area_buffer
[0]))
15996 if (update_mode_line
)
15997 /* We may have to update a tty frame's menu bar or a
15998 tool-bar. Example `M-x C-h C-h C-g'. */
15999 goto finish_menu_bars
;
16001 /* We've already displayed the echo area glyphs in this window. */
16002 goto finish_scroll_bars
;
16004 else if ((w
!= XWINDOW (minibuf_window
)
16005 || minibuf_level
== 0)
16006 /* When buffer is nonempty, redisplay window normally. */
16007 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
16008 /* Quail displays non-mini buffers in minibuffer window.
16009 In that case, redisplay the window normally. */
16010 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
16012 /* W is a mini-buffer window, but it's not active, so clear
16014 int yb
= window_text_bottom_y (w
);
16015 struct glyph_row
*row
;
16018 for (y
= 0, row
= w
->desired_matrix
->rows
;
16020 y
+= row
->height
, ++row
)
16021 blank_row (w
, row
, y
);
16022 goto finish_scroll_bars
;
16025 clear_glyph_matrix (w
->desired_matrix
);
16028 /* Otherwise set up data on this window; select its buffer and point
16030 /* Really select the buffer, for the sake of buffer-local
16032 set_buffer_internal_1 (XBUFFER (w
->contents
));
16034 current_matrix_up_to_date_p
16035 = (w
->window_end_valid
16036 && !current_buffer
->clip_changed
16037 && !current_buffer
->prevent_redisplay_optimizations_p
16038 && !window_outdated (w
));
16040 /* Run the window-text-change-functions
16041 if it is possible that the text on the screen has changed
16042 (either due to modification of the text, or any other reason). */
16043 if (!current_matrix_up_to_date_p
16044 && !NILP (Vwindow_text_change_functions
))
16046 safe_run_hooks (Qwindow_text_change_functions
);
16050 beg_unchanged
= BEG_UNCHANGED
;
16051 end_unchanged
= END_UNCHANGED
;
16053 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16055 specbind (Qinhibit_point_motion_hooks
, Qt
);
16058 = (w
->window_end_valid
16059 && !current_buffer
->clip_changed
16060 && !window_outdated (w
));
16062 /* When windows_or_buffers_changed is non-zero, we can't rely
16063 on the window end being valid, so set it to zero there. */
16064 if (windows_or_buffers_changed
)
16066 /* If window starts on a continuation line, maybe adjust the
16067 window start in case the window's width changed. */
16068 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16069 compute_window_start_on_continuation_line (w
);
16071 w
->window_end_valid
= false;
16072 /* If so, we also can't rely on current matrix
16073 and should not fool try_cursor_movement below. */
16074 current_matrix_up_to_date_p
= false;
16077 /* Some sanity checks. */
16078 CHECK_WINDOW_END (w
);
16079 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16081 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16084 if (mode_line_update_needed (w
))
16085 update_mode_line
= 1;
16087 /* Point refers normally to the selected window. For any other
16088 window, set up appropriate value. */
16089 if (!EQ (window
, selected_window
))
16091 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16092 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16096 new_pt_byte
= BEGV_BYTE
;
16097 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16099 else if (new_pt
> (ZV
- 1))
16102 new_pt_byte
= ZV_BYTE
;
16103 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16106 /* We don't use SET_PT so that the point-motion hooks don't run. */
16107 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16110 /* If any of the character widths specified in the display table
16111 have changed, invalidate the width run cache. It's true that
16112 this may be a bit late to catch such changes, but the rest of
16113 redisplay goes (non-fatally) haywire when the display table is
16114 changed, so why should we worry about doing any better? */
16115 if (current_buffer
->width_run_cache
16116 || (current_buffer
->base_buffer
16117 && current_buffer
->base_buffer
->width_run_cache
))
16119 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16121 if (! disptab_matches_widthtab
16122 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16124 struct buffer
*buf
= current_buffer
;
16126 if (buf
->base_buffer
)
16127 buf
= buf
->base_buffer
;
16128 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16129 recompute_width_table (current_buffer
, disptab
);
16133 /* If window-start is screwed up, choose a new one. */
16134 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16137 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16139 /* If someone specified a new starting point but did not insist,
16140 check whether it can be used. */
16141 if ((w
->optional_new_start
|| window_frozen_p (w
))
16142 && CHARPOS (startp
) >= BEGV
16143 && CHARPOS (startp
) <= ZV
)
16145 ptrdiff_t it_charpos
;
16147 w
->optional_new_start
= 0;
16148 start_display (&it
, w
, startp
);
16149 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16150 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16151 /* Record IT's position now, since line_bottom_y might change
16153 it_charpos
= IT_CHARPOS (it
);
16154 /* Make sure we set the force_start flag only if the cursor row
16155 will be fully visible. Otherwise, the code under force_start
16156 label below will try to move point back into view, which is
16157 not what the code which sets optional_new_start wants. */
16158 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16159 && !w
->force_start
)
16161 if (it_charpos
== PT
)
16162 w
->force_start
= 1;
16163 /* IT may overshoot PT if text at PT is invisible. */
16164 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16165 w
->force_start
= 1;
16167 if (w
->force_start
)
16169 if (window_frozen_p (w
))
16170 debug_method_add (w
, "set force_start from frozen window start");
16172 debug_method_add (w
, "set force_start from optional_new_start");
16180 /* Handle case where place to start displaying has been specified,
16181 unless the specified location is outside the accessible range. */
16182 if (w
->force_start
)
16184 /* We set this later on if we have to adjust point. */
16187 w
->force_start
= 0;
16189 w
->window_end_valid
= 0;
16191 /* Forget any recorded base line for line number display. */
16192 if (!buffer_unchanged_p
)
16193 w
->base_line_number
= 0;
16195 /* Redisplay the mode line. Select the buffer properly for that.
16196 Also, run the hook window-scroll-functions
16197 because we have scrolled. */
16198 /* Note, we do this after clearing force_start because
16199 if there's an error, it is better to forget about force_start
16200 than to get into an infinite loop calling the hook functions
16201 and having them get more errors. */
16202 if (!update_mode_line
16203 || ! NILP (Vwindow_scroll_functions
))
16205 update_mode_line
= 1;
16206 w
->update_mode_line
= 1;
16207 startp
= run_window_scroll_functions (window
, startp
);
16210 if (CHARPOS (startp
) < BEGV
)
16211 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16212 else if (CHARPOS (startp
) > ZV
)
16213 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16215 /* Redisplay, then check if cursor has been set during the
16216 redisplay. Give up if new fonts were loaded. */
16217 /* We used to issue a CHECK_MARGINS argument to try_window here,
16218 but this causes scrolling to fail when point begins inside
16219 the scroll margin (bug#148) -- cyd */
16220 if (!try_window (window
, startp
, 0))
16222 w
->force_start
= 1;
16223 clear_glyph_matrix (w
->desired_matrix
);
16224 goto need_larger_matrices
;
16227 if (w
->cursor
.vpos
< 0)
16229 /* If point does not appear, try to move point so it does
16230 appear. The desired matrix has been built above, so we
16231 can use it here. */
16232 new_vpos
= window_box_height (w
) / 2;
16235 if (!cursor_row_fully_visible_p (w
, 0, 0))
16237 /* Point does appear, but on a line partly visible at end of window.
16238 Move it back to a fully-visible line. */
16239 new_vpos
= window_box_height (w
);
16240 /* But if window_box_height suggests a Y coordinate that is
16241 not less than we already have, that line will clearly not
16242 be fully visible, so give up and scroll the display.
16243 This can happen when the default face uses a font whose
16244 dimensions are different from the frame's default
16246 if (new_vpos
>= w
->cursor
.y
)
16248 w
->cursor
.vpos
= -1;
16249 clear_glyph_matrix (w
->desired_matrix
);
16250 goto try_to_scroll
;
16253 else if (w
->cursor
.vpos
>= 0)
16255 /* Some people insist on not letting point enter the scroll
16256 margin, even though this part handles windows that didn't
16258 int window_total_lines
16259 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16260 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16261 int pixel_margin
= margin
* frame_line_height
;
16262 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16264 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16265 below, which finds the row to move point to, advances by
16266 the Y coordinate of the _next_ row, see the definition of
16267 MATRIX_ROW_BOTTOM_Y. */
16268 if (w
->cursor
.vpos
< margin
+ header_line
)
16270 w
->cursor
.vpos
= -1;
16271 clear_glyph_matrix (w
->desired_matrix
);
16272 goto try_to_scroll
;
16276 int window_height
= window_box_height (w
);
16279 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16280 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16282 w
->cursor
.vpos
= -1;
16283 clear_glyph_matrix (w
->desired_matrix
);
16284 goto try_to_scroll
;
16289 /* If we need to move point for either of the above reasons,
16290 now actually do it. */
16293 struct glyph_row
*row
;
16295 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16296 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16299 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16300 MATRIX_ROW_START_BYTEPOS (row
));
16302 if (w
!= XWINDOW (selected_window
))
16303 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16304 else if (current_buffer
== old
)
16305 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16307 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16309 /* Re-run pre-redisplay-function so it can update the region
16310 according to the new position of point. */
16311 /* Other than the cursor, w's redisplay is done so we can set its
16312 redisplay to false. Also the buffer's redisplay can be set to
16313 false, since propagate_buffer_redisplay should have already
16314 propagated its info to `w' anyway. */
16315 w
->redisplay
= false;
16316 XBUFFER (w
->contents
)->text
->redisplay
= false;
16317 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16319 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16321 /* pre-redisplay-function made changes (e.g. move the region)
16322 that require another round of redisplay. */
16323 clear_glyph_matrix (w
->desired_matrix
);
16324 if (!try_window (window
, startp
, 0))
16325 goto need_larger_matrices
;
16328 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, 0, 0))
16330 clear_glyph_matrix (w
->desired_matrix
);
16331 goto try_to_scroll
;
16335 debug_method_add (w
, "forced window start");
16340 /* Handle case where text has not changed, only point, and it has
16341 not moved off the frame, and we are not retrying after hscroll.
16342 (current_matrix_up_to_date_p is nonzero when retrying.) */
16343 if (current_matrix_up_to_date_p
16344 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16345 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16349 case CURSOR_MOVEMENT_SUCCESS
:
16350 used_current_matrix_p
= 1;
16353 case CURSOR_MOVEMENT_MUST_SCROLL
:
16354 goto try_to_scroll
;
16360 /* If current starting point was originally the beginning of a line
16361 but no longer is, find a new starting point. */
16362 else if (w
->start_at_line_beg
16363 && !(CHARPOS (startp
) <= BEGV
16364 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16367 debug_method_add (w
, "recenter 1");
16372 /* Try scrolling with try_window_id. Value is > 0 if update has
16373 been done, it is -1 if we know that the same window start will
16374 not work. It is 0 if unsuccessful for some other reason. */
16375 else if ((tem
= try_window_id (w
)) != 0)
16378 debug_method_add (w
, "try_window_id %d", tem
);
16381 if (f
->fonts_changed
)
16382 goto need_larger_matrices
;
16386 /* Otherwise try_window_id has returned -1 which means that we
16387 don't want the alternative below this comment to execute. */
16389 else if (CHARPOS (startp
) >= BEGV
16390 && CHARPOS (startp
) <= ZV
16391 && PT
>= CHARPOS (startp
)
16392 && (CHARPOS (startp
) < ZV
16393 /* Avoid starting at end of buffer. */
16394 || CHARPOS (startp
) == BEGV
16395 || !window_outdated (w
)))
16397 int d1
, d2
, d5
, d6
;
16400 /* If first window line is a continuation line, and window start
16401 is inside the modified region, but the first change is before
16402 current window start, we must select a new window start.
16404 However, if this is the result of a down-mouse event (e.g. by
16405 extending the mouse-drag-overlay), we don't want to select a
16406 new window start, since that would change the position under
16407 the mouse, resulting in an unwanted mouse-movement rather
16408 than a simple mouse-click. */
16409 if (!w
->start_at_line_beg
16410 && NILP (do_mouse_tracking
)
16411 && CHARPOS (startp
) > BEGV
16412 && CHARPOS (startp
) > BEG
+ beg_unchanged
16413 && CHARPOS (startp
) <= Z
- end_unchanged
16414 /* Even if w->start_at_line_beg is nil, a new window may
16415 start at a line_beg, since that's how set_buffer_window
16416 sets it. So, we need to check the return value of
16417 compute_window_start_on_continuation_line. (See also
16419 && XMARKER (w
->start
)->buffer
== current_buffer
16420 && compute_window_start_on_continuation_line (w
)
16421 /* It doesn't make sense to force the window start like we
16422 do at label force_start if it is already known that point
16423 will not be fully visible in the resulting window, because
16424 doing so will move point from its correct position
16425 instead of scrolling the window to bring point into view.
16427 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16428 /* A very tall row could need more than the window height,
16429 in which case we accept that it is partially visible. */
16430 && (rtop
!= 0) == (rbot
!= 0))
16432 w
->force_start
= 1;
16433 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16435 debug_method_add (w
, "recomputed window start in continuation line");
16441 debug_method_add (w
, "same window start");
16444 /* Try to redisplay starting at same place as before.
16445 If point has not moved off frame, accept the results. */
16446 if (!current_matrix_up_to_date_p
16447 /* Don't use try_window_reusing_current_matrix in this case
16448 because a window scroll function can have changed the
16450 || !NILP (Vwindow_scroll_functions
)
16451 || MINI_WINDOW_P (w
)
16452 || !(used_current_matrix_p
16453 = try_window_reusing_current_matrix (w
)))
16455 IF_DEBUG (debug_method_add (w
, "1"));
16456 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16457 /* -1 means we need to scroll.
16458 0 means we need new matrices, but fonts_changed
16459 is set in that case, so we will detect it below. */
16460 goto try_to_scroll
;
16463 if (f
->fonts_changed
)
16464 goto need_larger_matrices
;
16466 if (w
->cursor
.vpos
>= 0)
16468 if (!just_this_one_p
16469 || current_buffer
->clip_changed
16470 || BEG_UNCHANGED
< CHARPOS (startp
))
16471 /* Forget any recorded base line for line number display. */
16472 w
->base_line_number
= 0;
16474 if (!cursor_row_fully_visible_p (w
, 1, 0))
16476 clear_glyph_matrix (w
->desired_matrix
);
16477 last_line_misfit
= 1;
16479 /* Drop through and scroll. */
16484 clear_glyph_matrix (w
->desired_matrix
);
16489 /* Redisplay the mode line. Select the buffer properly for that. */
16490 if (!update_mode_line
)
16492 update_mode_line
= 1;
16493 w
->update_mode_line
= 1;
16496 /* Try to scroll by specified few lines. */
16497 if ((scroll_conservatively
16498 || emacs_scroll_step
16499 || temp_scroll_step
16500 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16501 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16502 && CHARPOS (startp
) >= BEGV
16503 && CHARPOS (startp
) <= ZV
)
16505 /* The function returns -1 if new fonts were loaded, 1 if
16506 successful, 0 if not successful. */
16507 int ss
= try_scrolling (window
, just_this_one_p
,
16508 scroll_conservatively
,
16510 temp_scroll_step
, last_line_misfit
);
16513 case SCROLLING_SUCCESS
:
16516 case SCROLLING_NEED_LARGER_MATRICES
:
16517 goto need_larger_matrices
;
16519 case SCROLLING_FAILED
:
16527 /* Finally, just choose a place to start which positions point
16528 according to user preferences. */
16533 debug_method_add (w
, "recenter");
16536 /* Forget any previously recorded base line for line number display. */
16537 if (!buffer_unchanged_p
)
16538 w
->base_line_number
= 0;
16540 /* Determine the window start relative to point. */
16541 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16542 it
.current_y
= it
.last_visible_y
;
16543 if (centering_position
< 0)
16545 int window_total_lines
16546 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16549 ? min (scroll_margin
, window_total_lines
/ 4)
16551 ptrdiff_t margin_pos
= CHARPOS (startp
);
16552 Lisp_Object aggressive
;
16555 /* If there is a scroll margin at the top of the window, find
16556 its character position. */
16558 /* Cannot call start_display if startp is not in the
16559 accessible region of the buffer. This can happen when we
16560 have just switched to a different buffer and/or changed
16561 its restriction. In that case, startp is initialized to
16562 the character position 1 (BEGV) because we did not yet
16563 have chance to display the buffer even once. */
16564 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16567 void *it1data
= NULL
;
16569 SAVE_IT (it1
, it
, it1data
);
16570 start_display (&it1
, w
, startp
);
16571 move_it_vertically (&it1
, margin
* frame_line_height
);
16572 margin_pos
= IT_CHARPOS (it1
);
16573 RESTORE_IT (&it
, &it
, it1data
);
16575 scrolling_up
= PT
> margin_pos
;
16578 ? BVAR (current_buffer
, scroll_up_aggressively
)
16579 : BVAR (current_buffer
, scroll_down_aggressively
);
16581 if (!MINI_WINDOW_P (w
)
16582 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16586 /* Setting scroll-conservatively overrides
16587 scroll-*-aggressively. */
16588 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16590 double float_amount
= XFLOATINT (aggressive
);
16592 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16593 if (pt_offset
== 0 && float_amount
> 0)
16595 if (pt_offset
&& margin
> 0)
16598 /* Compute how much to move the window start backward from
16599 point so that point will be displayed where the user
16603 centering_position
= it
.last_visible_y
;
16605 centering_position
-= pt_offset
;
16606 centering_position
-=
16607 frame_line_height
* (1 + margin
+ (last_line_misfit
!= 0))
16608 + WINDOW_HEADER_LINE_HEIGHT (w
);
16609 /* Don't let point enter the scroll margin near top of
16611 if (centering_position
< margin
* frame_line_height
)
16612 centering_position
= margin
* frame_line_height
;
16615 centering_position
= margin
* frame_line_height
+ pt_offset
;
16618 /* Set the window start half the height of the window backward
16620 centering_position
= window_box_height (w
) / 2;
16622 move_it_vertically_backward (&it
, centering_position
);
16624 eassert (IT_CHARPOS (it
) >= BEGV
);
16626 /* The function move_it_vertically_backward may move over more
16627 than the specified y-distance. If it->w is small, e.g. a
16628 mini-buffer window, we may end up in front of the window's
16629 display area. Start displaying at the start of the line
16630 containing PT in this case. */
16631 if (it
.current_y
<= 0)
16633 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16634 move_it_vertically_backward (&it
, 0);
16638 it
.current_x
= it
.hpos
= 0;
16640 /* Set the window start position here explicitly, to avoid an
16641 infinite loop in case the functions in window-scroll-functions
16643 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16645 /* Run scroll hooks. */
16646 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16648 /* Redisplay the window. */
16649 if (!current_matrix_up_to_date_p
16650 || windows_or_buffers_changed
16651 || f
->cursor_type_changed
16652 /* Don't use try_window_reusing_current_matrix in this case
16653 because it can have changed the buffer. */
16654 || !NILP (Vwindow_scroll_functions
)
16655 || !just_this_one_p
16656 || MINI_WINDOW_P (w
)
16657 || !(used_current_matrix_p
16658 = try_window_reusing_current_matrix (w
)))
16659 try_window (window
, startp
, 0);
16661 /* If new fonts have been loaded (due to fontsets), give up. We
16662 have to start a new redisplay since we need to re-adjust glyph
16664 if (f
->fonts_changed
)
16665 goto need_larger_matrices
;
16667 /* If cursor did not appear assume that the middle of the window is
16668 in the first line of the window. Do it again with the next line.
16669 (Imagine a window of height 100, displaying two lines of height
16670 60. Moving back 50 from it->last_visible_y will end in the first
16672 if (w
->cursor
.vpos
< 0)
16674 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16676 clear_glyph_matrix (w
->desired_matrix
);
16677 move_it_by_lines (&it
, 1);
16678 try_window (window
, it
.current
.pos
, 0);
16680 else if (PT
< IT_CHARPOS (it
))
16682 clear_glyph_matrix (w
->desired_matrix
);
16683 move_it_by_lines (&it
, -1);
16684 try_window (window
, it
.current
.pos
, 0);
16688 /* Not much we can do about it. */
16692 /* Consider the following case: Window starts at BEGV, there is
16693 invisible, intangible text at BEGV, so that display starts at
16694 some point START > BEGV. It can happen that we are called with
16695 PT somewhere between BEGV and START. Try to handle that case,
16696 and similar ones. */
16697 if (w
->cursor
.vpos
< 0)
16699 /* First, try locating the proper glyph row for PT. */
16700 struct glyph_row
*row
=
16701 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16703 /* Sometimes point is at the beginning of invisible text that is
16704 before the 1st character displayed in the row. In that case,
16705 row_containing_pos fails to find the row, because no glyphs
16706 with appropriate buffer positions are present in the row.
16707 Therefore, we next try to find the row which shows the 1st
16708 position after the invisible text. */
16712 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16715 if (TEXT_PROP_MEANS_INVISIBLE (val
))
16718 Lisp_Object invis_end
=
16719 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16722 if (NATNUMP (invis_end
))
16723 alt_pos
= XFASTINT (invis_end
);
16726 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16730 /* Finally, fall back on the first row of the window after the
16731 header line (if any). This is slightly better than not
16732 displaying the cursor at all. */
16735 row
= w
->current_matrix
->rows
;
16736 if (row
->mode_line_p
)
16739 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16742 if (!cursor_row_fully_visible_p (w
, 0, 0))
16744 /* If vscroll is enabled, disable it and try again. */
16748 clear_glyph_matrix (w
->desired_matrix
);
16752 /* Users who set scroll-conservatively to a large number want
16753 point just above/below the scroll margin. If we ended up
16754 with point's row partially visible, move the window start to
16755 make that row fully visible and out of the margin. */
16756 if (scroll_conservatively
> SCROLL_LIMIT
)
16758 int window_total_lines
16759 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16762 ? min (scroll_margin
, window_total_lines
/ 4)
16764 int move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16766 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16767 clear_glyph_matrix (w
->desired_matrix
);
16768 if (1 == try_window (window
, it
.current
.pos
,
16769 TRY_WINDOW_CHECK_MARGINS
))
16773 /* If centering point failed to make the whole line visible,
16774 put point at the top instead. That has to make the whole line
16775 visible, if it can be done. */
16776 if (centering_position
== 0)
16779 clear_glyph_matrix (w
->desired_matrix
);
16780 centering_position
= 0;
16786 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16787 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16788 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16790 /* Display the mode line, if we must. */
16791 if ((update_mode_line
16792 /* If window not full width, must redo its mode line
16793 if (a) the window to its side is being redone and
16794 (b) we do a frame-based redisplay. This is a consequence
16795 of how inverted lines are drawn in frame-based redisplay. */
16796 || (!just_this_one_p
16797 && !FRAME_WINDOW_P (f
)
16798 && !WINDOW_FULL_WIDTH_P (w
))
16799 /* Line number to display. */
16800 || w
->base_line_pos
> 0
16801 /* Column number is displayed and different from the one displayed. */
16802 || (w
->column_number_displayed
!= -1
16803 && (w
->column_number_displayed
!= current_column ())))
16804 /* This means that the window has a mode line. */
16805 && (WINDOW_WANTS_MODELINE_P (w
)
16806 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16809 display_mode_lines (w
);
16811 /* If mode line height has changed, arrange for a thorough
16812 immediate redisplay using the correct mode line height. */
16813 if (WINDOW_WANTS_MODELINE_P (w
)
16814 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16816 f
->fonts_changed
= 1;
16817 w
->mode_line_height
= -1;
16818 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16819 = DESIRED_MODE_LINE_HEIGHT (w
);
16822 /* If header line height has changed, arrange for a thorough
16823 immediate redisplay using the correct header line height. */
16824 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16825 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16827 f
->fonts_changed
= 1;
16828 w
->header_line_height
= -1;
16829 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16830 = DESIRED_HEADER_LINE_HEIGHT (w
);
16833 if (f
->fonts_changed
)
16834 goto need_larger_matrices
;
16837 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16839 w
->base_line_pos
= 0;
16840 w
->base_line_number
= 0;
16845 /* When we reach a frame's selected window, redo the frame's menu bar. */
16846 if (update_mode_line
16847 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16849 int redisplay_menu_p
= 0;
16851 if (FRAME_WINDOW_P (f
))
16853 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16854 || defined (HAVE_NS) || defined (USE_GTK)
16855 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16857 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16861 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16863 if (redisplay_menu_p
)
16864 display_menu_bar (w
);
16866 #ifdef HAVE_WINDOW_SYSTEM
16867 if (FRAME_WINDOW_P (f
))
16869 #if defined (USE_GTK) || defined (HAVE_NS)
16870 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16871 redisplay_tool_bar (f
);
16873 if (WINDOWP (f
->tool_bar_window
)
16874 && (FRAME_TOOL_BAR_HEIGHT (f
) > 0
16875 || !NILP (Vauto_resize_tool_bars
))
16876 && redisplay_tool_bar (f
))
16877 ignore_mouse_drag_p
= 1;
16883 #ifdef HAVE_WINDOW_SYSTEM
16884 if (FRAME_WINDOW_P (f
)
16885 && update_window_fringes (w
, (just_this_one_p
16886 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16887 || w
->pseudo_window_p
)))
16891 if (draw_window_fringes (w
, 1))
16893 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16894 x_draw_right_divider (w
);
16896 x_draw_vertical_border (w
);
16902 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16903 x_draw_bottom_divider (w
);
16904 #endif /* HAVE_WINDOW_SYSTEM */
16906 /* We go to this label, with fonts_changed set, if it is
16907 necessary to try again using larger glyph matrices.
16908 We have to redeem the scroll bar even in this case,
16909 because the loop in redisplay_internal expects that. */
16910 need_larger_matrices
:
16912 finish_scroll_bars
:
16914 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16916 /* Set the thumb's position and size. */
16917 set_vertical_scroll_bar (w
);
16919 /* Note that we actually used the scroll bar attached to this
16920 window, so it shouldn't be deleted at the end of redisplay. */
16921 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16922 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16925 /* Restore current_buffer and value of point in it. The window
16926 update may have changed the buffer, so first make sure `opoint'
16927 is still valid (Bug#6177). */
16928 if (CHARPOS (opoint
) < BEGV
)
16929 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16930 else if (CHARPOS (opoint
) > ZV
)
16931 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16933 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16935 set_buffer_internal_1 (old
);
16936 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16937 shorter. This can be caused by log truncation in *Messages*. */
16938 if (CHARPOS (lpoint
) <= ZV
)
16939 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16941 unbind_to (count
, Qnil
);
16945 /* Build the complete desired matrix of WINDOW with a window start
16946 buffer position POS.
16948 Value is 1 if successful. It is zero if fonts were loaded during
16949 redisplay which makes re-adjusting glyph matrices necessary, and -1
16950 if point would appear in the scroll margins.
16951 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16952 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16956 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16958 struct window
*w
= XWINDOW (window
);
16960 struct glyph_row
*last_text_row
= NULL
;
16961 struct frame
*f
= XFRAME (w
->frame
);
16962 int frame_line_height
= default_line_pixel_height (w
);
16964 /* Make POS the new window start. */
16965 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16967 /* Mark cursor position as unknown. No overlay arrow seen. */
16968 w
->cursor
.vpos
= -1;
16969 overlay_arrow_seen
= 0;
16971 /* Initialize iterator and info to start at POS. */
16972 start_display (&it
, w
, pos
);
16974 /* Display all lines of W. */
16975 while (it
.current_y
< it
.last_visible_y
)
16977 if (display_line (&it
))
16978 last_text_row
= it
.glyph_row
- 1;
16979 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16983 /* Don't let the cursor end in the scroll margins. */
16984 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16985 && !MINI_WINDOW_P (w
))
16987 int this_scroll_margin
;
16988 int window_total_lines
16989 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16991 if (scroll_margin
> 0)
16993 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16994 this_scroll_margin
*= frame_line_height
;
16997 this_scroll_margin
= 0;
16999 if ((w
->cursor
.y
>= 0 /* not vscrolled */
17000 && w
->cursor
.y
< this_scroll_margin
17001 && CHARPOS (pos
) > BEGV
17002 && IT_CHARPOS (it
) < ZV
)
17003 /* rms: considering make_cursor_line_fully_visible_p here
17004 seems to give wrong results. We don't want to recenter
17005 when the last line is partly visible, we want to allow
17006 that case to be handled in the usual way. */
17007 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
17009 w
->cursor
.vpos
= -1;
17010 clear_glyph_matrix (w
->desired_matrix
);
17015 /* If bottom moved off end of frame, change mode line percentage. */
17016 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
17017 w
->update_mode_line
= 1;
17019 /* Set window_end_pos to the offset of the last character displayed
17020 on the window from the end of current_buffer. Set
17021 window_end_vpos to its row number. */
17024 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17025 adjust_window_ends (w
, last_text_row
, 0);
17027 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17028 w
->window_end_vpos
)));
17032 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17033 w
->window_end_pos
= Z
- ZV
;
17034 w
->window_end_vpos
= 0;
17037 /* But that is not valid info until redisplay finishes. */
17038 w
->window_end_valid
= 0;
17044 /************************************************************************
17045 Window redisplay reusing current matrix when buffer has not changed
17046 ************************************************************************/
17048 /* Try redisplay of window W showing an unchanged buffer with a
17049 different window start than the last time it was displayed by
17050 reusing its current matrix. Value is non-zero if successful.
17051 W->start is the new window start. */
17054 try_window_reusing_current_matrix (struct window
*w
)
17056 struct frame
*f
= XFRAME (w
->frame
);
17057 struct glyph_row
*bottom_row
;
17060 struct text_pos start
, new_start
;
17061 int nrows_scrolled
, i
;
17062 struct glyph_row
*last_text_row
;
17063 struct glyph_row
*last_reused_text_row
;
17064 struct glyph_row
*start_row
;
17065 int start_vpos
, min_y
, max_y
;
17068 if (inhibit_try_window_reusing
)
17072 if (/* This function doesn't handle terminal frames. */
17073 !FRAME_WINDOW_P (f
)
17074 /* Don't try to reuse the display if windows have been split
17076 || windows_or_buffers_changed
17077 || f
->cursor_type_changed
)
17080 /* Can't do this if showing trailing whitespace. */
17081 if (!NILP (Vshow_trailing_whitespace
))
17084 /* If top-line visibility has changed, give up. */
17085 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17086 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17089 /* Give up if old or new display is scrolled vertically. We could
17090 make this function handle this, but right now it doesn't. */
17091 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17092 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17095 /* The variable new_start now holds the new window start. The old
17096 start `start' can be determined from the current matrix. */
17097 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17098 start
= start_row
->minpos
;
17099 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17101 /* Clear the desired matrix for the display below. */
17102 clear_glyph_matrix (w
->desired_matrix
);
17104 if (CHARPOS (new_start
) <= CHARPOS (start
))
17106 /* Don't use this method if the display starts with an ellipsis
17107 displayed for invisible text. It's not easy to handle that case
17108 below, and it's certainly not worth the effort since this is
17109 not a frequent case. */
17110 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17113 IF_DEBUG (debug_method_add (w
, "twu1"));
17115 /* Display up to a row that can be reused. The variable
17116 last_text_row is set to the last row displayed that displays
17117 text. Note that it.vpos == 0 if or if not there is a
17118 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17119 start_display (&it
, w
, new_start
);
17120 w
->cursor
.vpos
= -1;
17121 last_text_row
= last_reused_text_row
= NULL
;
17123 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17125 /* If we have reached into the characters in the START row,
17126 that means the line boundaries have changed. So we
17127 can't start copying with the row START. Maybe it will
17128 work to start copying with the following row. */
17129 while (IT_CHARPOS (it
) > CHARPOS (start
))
17131 /* Advance to the next row as the "start". */
17133 start
= start_row
->minpos
;
17134 /* If there are no more rows to try, or just one, give up. */
17135 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17136 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17137 || CHARPOS (start
) == ZV
)
17139 clear_glyph_matrix (w
->desired_matrix
);
17143 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17145 /* If we have reached alignment, we can copy the rest of the
17147 if (IT_CHARPOS (it
) == CHARPOS (start
)
17148 /* Don't accept "alignment" inside a display vector,
17149 since start_row could have started in the middle of
17150 that same display vector (thus their character
17151 positions match), and we have no way of telling if
17152 that is the case. */
17153 && it
.current
.dpvec_index
< 0)
17156 if (display_line (&it
))
17157 last_text_row
= it
.glyph_row
- 1;
17161 /* A value of current_y < last_visible_y means that we stopped
17162 at the previous window start, which in turn means that we
17163 have at least one reusable row. */
17164 if (it
.current_y
< it
.last_visible_y
)
17166 struct glyph_row
*row
;
17168 /* IT.vpos always starts from 0; it counts text lines. */
17169 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17171 /* Find PT if not already found in the lines displayed. */
17172 if (w
->cursor
.vpos
< 0)
17174 int dy
= it
.current_y
- start_row
->y
;
17176 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17177 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17179 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17180 dy
, nrows_scrolled
);
17183 clear_glyph_matrix (w
->desired_matrix
);
17188 /* Scroll the display. Do it before the current matrix is
17189 changed. The problem here is that update has not yet
17190 run, i.e. part of the current matrix is not up to date.
17191 scroll_run_hook will clear the cursor, and use the
17192 current matrix to get the height of the row the cursor is
17194 run
.current_y
= start_row
->y
;
17195 run
.desired_y
= it
.current_y
;
17196 run
.height
= it
.last_visible_y
- it
.current_y
;
17198 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17201 FRAME_RIF (f
)->update_window_begin_hook (w
);
17202 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17203 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17204 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17208 /* Shift current matrix down by nrows_scrolled lines. */
17209 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17210 rotate_matrix (w
->current_matrix
,
17212 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17215 /* Disable lines that must be updated. */
17216 for (i
= 0; i
< nrows_scrolled
; ++i
)
17217 (start_row
+ i
)->enabled_p
= false;
17219 /* Re-compute Y positions. */
17220 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17221 max_y
= it
.last_visible_y
;
17222 for (row
= start_row
+ nrows_scrolled
;
17226 row
->y
= it
.current_y
;
17227 row
->visible_height
= row
->height
;
17229 if (row
->y
< min_y
)
17230 row
->visible_height
-= min_y
- row
->y
;
17231 if (row
->y
+ row
->height
> max_y
)
17232 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17233 if (row
->fringe_bitmap_periodic_p
)
17234 row
->redraw_fringe_bitmaps_p
= 1;
17236 it
.current_y
+= row
->height
;
17238 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17239 last_reused_text_row
= row
;
17240 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17244 /* Disable lines in the current matrix which are now
17245 below the window. */
17246 for (++row
; row
< bottom_row
; ++row
)
17247 row
->enabled_p
= row
->mode_line_p
= 0;
17250 /* Update window_end_pos etc.; last_reused_text_row is the last
17251 reused row from the current matrix containing text, if any.
17252 The value of last_text_row is the last displayed line
17253 containing text. */
17254 if (last_reused_text_row
)
17255 adjust_window_ends (w
, last_reused_text_row
, 1);
17256 else if (last_text_row
)
17257 adjust_window_ends (w
, last_text_row
, 0);
17260 /* This window must be completely empty. */
17261 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17262 w
->window_end_pos
= Z
- ZV
;
17263 w
->window_end_vpos
= 0;
17265 w
->window_end_valid
= 0;
17267 /* Update hint: don't try scrolling again in update_window. */
17268 w
->desired_matrix
->no_scrolling_p
= 1;
17271 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17275 else if (CHARPOS (new_start
) > CHARPOS (start
))
17277 struct glyph_row
*pt_row
, *row
;
17278 struct glyph_row
*first_reusable_row
;
17279 struct glyph_row
*first_row_to_display
;
17281 int yb
= window_text_bottom_y (w
);
17283 /* Find the row starting at new_start, if there is one. Don't
17284 reuse a partially visible line at the end. */
17285 first_reusable_row
= start_row
;
17286 while (first_reusable_row
->enabled_p
17287 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17288 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17289 < CHARPOS (new_start
)))
17290 ++first_reusable_row
;
17292 /* Give up if there is no row to reuse. */
17293 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17294 || !first_reusable_row
->enabled_p
17295 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17296 != CHARPOS (new_start
)))
17299 /* We can reuse fully visible rows beginning with
17300 first_reusable_row to the end of the window. Set
17301 first_row_to_display to the first row that cannot be reused.
17302 Set pt_row to the row containing point, if there is any. */
17304 for (first_row_to_display
= first_reusable_row
;
17305 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17306 ++first_row_to_display
)
17308 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17309 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17310 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17311 && first_row_to_display
->ends_at_zv_p
17312 && pt_row
== NULL
)))
17313 pt_row
= first_row_to_display
;
17316 /* Start displaying at the start of first_row_to_display. */
17317 eassert (first_row_to_display
->y
< yb
);
17318 init_to_row_start (&it
, w
, first_row_to_display
);
17320 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17322 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17324 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17325 + WINDOW_HEADER_LINE_HEIGHT (w
));
17327 /* Display lines beginning with first_row_to_display in the
17328 desired matrix. Set last_text_row to the last row displayed
17329 that displays text. */
17330 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17331 if (pt_row
== NULL
)
17332 w
->cursor
.vpos
= -1;
17333 last_text_row
= NULL
;
17334 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17335 if (display_line (&it
))
17336 last_text_row
= it
.glyph_row
- 1;
17338 /* If point is in a reused row, adjust y and vpos of the cursor
17342 w
->cursor
.vpos
-= nrows_scrolled
;
17343 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17346 /* Give up if point isn't in a row displayed or reused. (This
17347 also handles the case where w->cursor.vpos < nrows_scrolled
17348 after the calls to display_line, which can happen with scroll
17349 margins. See bug#1295.) */
17350 if (w
->cursor
.vpos
< 0)
17352 clear_glyph_matrix (w
->desired_matrix
);
17356 /* Scroll the display. */
17357 run
.current_y
= first_reusable_row
->y
;
17358 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17359 run
.height
= it
.last_visible_y
- run
.current_y
;
17360 dy
= run
.current_y
- run
.desired_y
;
17365 FRAME_RIF (f
)->update_window_begin_hook (w
);
17366 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17367 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17368 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17372 /* Adjust Y positions of reused rows. */
17373 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17374 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17375 max_y
= it
.last_visible_y
;
17376 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17379 row
->visible_height
= row
->height
;
17380 if (row
->y
< min_y
)
17381 row
->visible_height
-= min_y
- row
->y
;
17382 if (row
->y
+ row
->height
> max_y
)
17383 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17384 if (row
->fringe_bitmap_periodic_p
)
17385 row
->redraw_fringe_bitmaps_p
= 1;
17388 /* Scroll the current matrix. */
17389 eassert (nrows_scrolled
> 0);
17390 rotate_matrix (w
->current_matrix
,
17392 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17395 /* Disable rows not reused. */
17396 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17397 row
->enabled_p
= false;
17399 /* Point may have moved to a different line, so we cannot assume that
17400 the previous cursor position is valid; locate the correct row. */
17403 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17405 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17406 && !row
->ends_at_zv_p
;
17410 w
->cursor
.y
= row
->y
;
17412 if (row
< bottom_row
)
17414 /* Can't simply scan the row for point with
17415 bidi-reordered glyph rows. Let set_cursor_from_row
17416 figure out where to put the cursor, and if it fails,
17418 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17420 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17423 clear_glyph_matrix (w
->desired_matrix
);
17429 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17430 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17433 && (!BUFFERP (glyph
->object
)
17434 || glyph
->charpos
< PT
);
17438 w
->cursor
.x
+= glyph
->pixel_width
;
17444 /* Adjust window end. A null value of last_text_row means that
17445 the window end is in reused rows which in turn means that
17446 only its vpos can have changed. */
17448 adjust_window_ends (w
, last_text_row
, 0);
17450 w
->window_end_vpos
-= nrows_scrolled
;
17452 w
->window_end_valid
= 0;
17453 w
->desired_matrix
->no_scrolling_p
= 1;
17456 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17466 /************************************************************************
17467 Window redisplay reusing current matrix when buffer has changed
17468 ************************************************************************/
17470 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17471 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17472 ptrdiff_t *, ptrdiff_t *);
17473 static struct glyph_row
*
17474 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17475 struct glyph_row
*);
17478 /* Return the last row in MATRIX displaying text. If row START is
17479 non-null, start searching with that row. IT gives the dimensions
17480 of the display. Value is null if matrix is empty; otherwise it is
17481 a pointer to the row found. */
17483 static struct glyph_row
*
17484 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17485 struct glyph_row
*start
)
17487 struct glyph_row
*row
, *row_found
;
17489 /* Set row_found to the last row in IT->w's current matrix
17490 displaying text. The loop looks funny but think of partially
17493 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17494 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17496 eassert (row
->enabled_p
);
17498 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17507 /* Return the last row in the current matrix of W that is not affected
17508 by changes at the start of current_buffer that occurred since W's
17509 current matrix was built. Value is null if no such row exists.
17511 BEG_UNCHANGED us the number of characters unchanged at the start of
17512 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17513 first changed character in current_buffer. Characters at positions <
17514 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17515 when the current matrix was built. */
17517 static struct glyph_row
*
17518 find_last_unchanged_at_beg_row (struct window
*w
)
17520 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17521 struct glyph_row
*row
;
17522 struct glyph_row
*row_found
= NULL
;
17523 int yb
= window_text_bottom_y (w
);
17525 /* Find the last row displaying unchanged text. */
17526 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17527 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17528 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17531 if (/* If row ends before first_changed_pos, it is unchanged,
17532 except in some case. */
17533 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17534 /* When row ends in ZV and we write at ZV it is not
17536 && !row
->ends_at_zv_p
17537 /* When first_changed_pos is the end of a continued line,
17538 row is not unchanged because it may be no longer
17540 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17541 && (row
->continued_p
17542 || row
->exact_window_width_line_p
))
17543 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17544 needs to be recomputed, so don't consider this row as
17545 unchanged. This happens when the last line was
17546 bidi-reordered and was killed immediately before this
17547 redisplay cycle. In that case, ROW->end stores the
17548 buffer position of the first visual-order character of
17549 the killed text, which is now beyond ZV. */
17550 && CHARPOS (row
->end
.pos
) <= ZV
)
17553 /* Stop if last visible row. */
17554 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17562 /* Find the first glyph row in the current matrix of W that is not
17563 affected by changes at the end of current_buffer since the
17564 time W's current matrix was built.
17566 Return in *DELTA the number of chars by which buffer positions in
17567 unchanged text at the end of current_buffer must be adjusted.
17569 Return in *DELTA_BYTES the corresponding number of bytes.
17571 Value is null if no such row exists, i.e. all rows are affected by
17574 static struct glyph_row
*
17575 find_first_unchanged_at_end_row (struct window
*w
,
17576 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17578 struct glyph_row
*row
;
17579 struct glyph_row
*row_found
= NULL
;
17581 *delta
= *delta_bytes
= 0;
17583 /* Display must not have been paused, otherwise the current matrix
17584 is not up to date. */
17585 eassert (w
->window_end_valid
);
17587 /* A value of window_end_pos >= END_UNCHANGED means that the window
17588 end is in the range of changed text. If so, there is no
17589 unchanged row at the end of W's current matrix. */
17590 if (w
->window_end_pos
>= END_UNCHANGED
)
17593 /* Set row to the last row in W's current matrix displaying text. */
17594 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17596 /* If matrix is entirely empty, no unchanged row exists. */
17597 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17599 /* The value of row is the last glyph row in the matrix having a
17600 meaningful buffer position in it. The end position of row
17601 corresponds to window_end_pos. This allows us to translate
17602 buffer positions in the current matrix to current buffer
17603 positions for characters not in changed text. */
17605 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17606 ptrdiff_t Z_BYTE_old
=
17607 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17608 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17609 struct glyph_row
*first_text_row
17610 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17612 *delta
= Z
- Z_old
;
17613 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17615 /* Set last_unchanged_pos to the buffer position of the last
17616 character in the buffer that has not been changed. Z is the
17617 index + 1 of the last character in current_buffer, i.e. by
17618 subtracting END_UNCHANGED we get the index of the last
17619 unchanged character, and we have to add BEG to get its buffer
17621 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17622 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17624 /* Search backward from ROW for a row displaying a line that
17625 starts at a minimum position >= last_unchanged_pos_old. */
17626 for (; row
> first_text_row
; --row
)
17628 /* This used to abort, but it can happen.
17629 It is ok to just stop the search instead here. KFS. */
17630 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17633 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17638 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17644 /* Make sure that glyph rows in the current matrix of window W
17645 reference the same glyph memory as corresponding rows in the
17646 frame's frame matrix. This function is called after scrolling W's
17647 current matrix on a terminal frame in try_window_id and
17648 try_window_reusing_current_matrix. */
17651 sync_frame_with_window_matrix_rows (struct window
*w
)
17653 struct frame
*f
= XFRAME (w
->frame
);
17654 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17656 /* Preconditions: W must be a leaf window and full-width. Its frame
17657 must have a frame matrix. */
17658 eassert (BUFFERP (w
->contents
));
17659 eassert (WINDOW_FULL_WIDTH_P (w
));
17660 eassert (!FRAME_WINDOW_P (f
));
17662 /* If W is a full-width window, glyph pointers in W's current matrix
17663 have, by definition, to be the same as glyph pointers in the
17664 corresponding frame matrix. Note that frame matrices have no
17665 marginal areas (see build_frame_matrix). */
17666 window_row
= w
->current_matrix
->rows
;
17667 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17668 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17669 while (window_row
< window_row_end
)
17671 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17672 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17674 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17675 frame_row
->glyphs
[TEXT_AREA
] = start
;
17676 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17677 frame_row
->glyphs
[LAST_AREA
] = end
;
17679 /* Disable frame rows whose corresponding window rows have
17680 been disabled in try_window_id. */
17681 if (!window_row
->enabled_p
)
17682 frame_row
->enabled_p
= false;
17684 ++window_row
, ++frame_row
;
17689 /* Find the glyph row in window W containing CHARPOS. Consider all
17690 rows between START and END (not inclusive). END null means search
17691 all rows to the end of the display area of W. Value is the row
17692 containing CHARPOS or null. */
17695 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17696 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17698 struct glyph_row
*row
= start
;
17699 struct glyph_row
*best_row
= NULL
;
17700 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17703 /* If we happen to start on a header-line, skip that. */
17704 if (row
->mode_line_p
)
17707 if ((end
&& row
>= end
) || !row
->enabled_p
)
17710 last_y
= window_text_bottom_y (w
) - dy
;
17714 /* Give up if we have gone too far. */
17715 if (end
&& row
>= end
)
17717 /* This formerly returned if they were equal.
17718 I think that both quantities are of a "last plus one" type;
17719 if so, when they are equal, the row is within the screen. -- rms. */
17720 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17723 /* If it is in this row, return this row. */
17724 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17725 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17726 /* The end position of a row equals the start
17727 position of the next row. If CHARPOS is there, we
17728 would rather consider it displayed in the next
17729 line, except when this line ends in ZV. */
17730 && !row_for_charpos_p (row
, charpos
)))
17731 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17735 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17736 || (!best_row
&& !row
->continued_p
))
17738 /* In bidi-reordered rows, there could be several rows whose
17739 edges surround CHARPOS, all of these rows belonging to
17740 the same continued line. We need to find the row which
17741 fits CHARPOS the best. */
17742 for (g
= row
->glyphs
[TEXT_AREA
];
17743 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17746 if (!STRINGP (g
->object
))
17748 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17750 mindif
= eabs (g
->charpos
- charpos
);
17752 /* Exact match always wins. */
17759 else if (best_row
&& !row
->continued_p
)
17766 /* Try to redisplay window W by reusing its existing display. W's
17767 current matrix must be up to date when this function is called,
17768 i.e. window_end_valid must be nonzero.
17772 >= 1 if successful, i.e. display has been updated
17774 1 means the changes were in front of a newline that precedes
17775 the window start, and the whole current matrix was reused
17776 2 means the changes were after the last position displayed
17777 in the window, and the whole current matrix was reused
17778 3 means portions of the current matrix were reused, while
17779 some of the screen lines were redrawn
17780 -1 if redisplay with same window start is known not to succeed
17781 0 if otherwise unsuccessful
17783 The following steps are performed:
17785 1. Find the last row in the current matrix of W that is not
17786 affected by changes at the start of current_buffer. If no such row
17789 2. Find the first row in W's current matrix that is not affected by
17790 changes at the end of current_buffer. Maybe there is no such row.
17792 3. Display lines beginning with the row + 1 found in step 1 to the
17793 row found in step 2 or, if step 2 didn't find a row, to the end of
17796 4. If cursor is not known to appear on the window, give up.
17798 5. If display stopped at the row found in step 2, scroll the
17799 display and current matrix as needed.
17801 6. Maybe display some lines at the end of W, if we must. This can
17802 happen under various circumstances, like a partially visible line
17803 becoming fully visible, or because newly displayed lines are displayed
17804 in smaller font sizes.
17806 7. Update W's window end information. */
17809 try_window_id (struct window
*w
)
17811 struct frame
*f
= XFRAME (w
->frame
);
17812 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17813 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17814 struct glyph_row
*last_unchanged_at_beg_row
;
17815 struct glyph_row
*first_unchanged_at_end_row
;
17816 struct glyph_row
*row
;
17817 struct glyph_row
*bottom_row
;
17820 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17822 struct text_pos start_pos
;
17824 int first_unchanged_at_end_vpos
= 0;
17825 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17826 struct text_pos start
;
17827 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17830 if (inhibit_try_window_id
)
17834 /* This is handy for debugging. */
17836 #define GIVE_UP(X) \
17838 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17842 #define GIVE_UP(X) return 0
17845 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17847 /* Don't use this for mini-windows because these can show
17848 messages and mini-buffers, and we don't handle that here. */
17849 if (MINI_WINDOW_P (w
))
17852 /* This flag is used to prevent redisplay optimizations. */
17853 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17856 /* This function's optimizations cannot be used if overlays have
17857 changed in the buffer displayed by the window, so give up if they
17859 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17862 /* Verify that narrowing has not changed.
17863 Also verify that we were not told to prevent redisplay optimizations.
17864 It would be nice to further
17865 reduce the number of cases where this prevents try_window_id. */
17866 if (current_buffer
->clip_changed
17867 || current_buffer
->prevent_redisplay_optimizations_p
)
17870 /* Window must either use window-based redisplay or be full width. */
17871 if (!FRAME_WINDOW_P (f
)
17872 && (!FRAME_LINE_INS_DEL_OK (f
)
17873 || !WINDOW_FULL_WIDTH_P (w
)))
17876 /* Give up if point is known NOT to appear in W. */
17877 if (PT
< CHARPOS (start
))
17880 /* Another way to prevent redisplay optimizations. */
17881 if (w
->last_modified
== 0)
17884 /* Verify that window is not hscrolled. */
17885 if (w
->hscroll
!= 0)
17888 /* Verify that display wasn't paused. */
17889 if (!w
->window_end_valid
)
17892 /* Likewise if highlighting trailing whitespace. */
17893 if (!NILP (Vshow_trailing_whitespace
))
17896 /* Can't use this if overlay arrow position and/or string have
17898 if (overlay_arrows_changed_p ())
17901 /* When word-wrap is on, adding a space to the first word of a
17902 wrapped line can change the wrap position, altering the line
17903 above it. It might be worthwhile to handle this more
17904 intelligently, but for now just redisplay from scratch. */
17905 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17908 /* Under bidi reordering, adding or deleting a character in the
17909 beginning of a paragraph, before the first strong directional
17910 character, can change the base direction of the paragraph (unless
17911 the buffer specifies a fixed paragraph direction), which will
17912 require to redisplay the whole paragraph. It might be worthwhile
17913 to find the paragraph limits and widen the range of redisplayed
17914 lines to that, but for now just give up this optimization and
17915 redisplay from scratch. */
17916 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17917 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17920 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17921 only if buffer has really changed. The reason is that the gap is
17922 initially at Z for freshly visited files. The code below would
17923 set end_unchanged to 0 in that case. */
17924 if (MODIFF
> SAVE_MODIFF
17925 /* This seems to happen sometimes after saving a buffer. */
17926 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17928 if (GPT
- BEG
< BEG_UNCHANGED
)
17929 BEG_UNCHANGED
= GPT
- BEG
;
17930 if (Z
- GPT
< END_UNCHANGED
)
17931 END_UNCHANGED
= Z
- GPT
;
17934 /* The position of the first and last character that has been changed. */
17935 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17936 last_changed_charpos
= Z
- END_UNCHANGED
;
17938 /* If window starts after a line end, and the last change is in
17939 front of that newline, then changes don't affect the display.
17940 This case happens with stealth-fontification. Note that although
17941 the display is unchanged, glyph positions in the matrix have to
17942 be adjusted, of course. */
17943 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17944 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17945 && ((last_changed_charpos
< CHARPOS (start
)
17946 && CHARPOS (start
) == BEGV
)
17947 || (last_changed_charpos
< CHARPOS (start
) - 1
17948 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17950 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17951 struct glyph_row
*r0
;
17953 /* Compute how many chars/bytes have been added to or removed
17954 from the buffer. */
17955 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17956 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17957 Z_delta
= Z
- Z_old
;
17958 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17960 /* Give up if PT is not in the window. Note that it already has
17961 been checked at the start of try_window_id that PT is not in
17962 front of the window start. */
17963 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17966 /* If window start is unchanged, we can reuse the whole matrix
17967 as is, after adjusting glyph positions. No need to compute
17968 the window end again, since its offset from Z hasn't changed. */
17969 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17970 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17971 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17972 /* PT must not be in a partially visible line. */
17973 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17974 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17976 /* Adjust positions in the glyph matrix. */
17977 if (Z_delta
|| Z_delta_bytes
)
17979 struct glyph_row
*r1
17980 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17981 increment_matrix_positions (w
->current_matrix
,
17982 MATRIX_ROW_VPOS (r0
, current_matrix
),
17983 MATRIX_ROW_VPOS (r1
, current_matrix
),
17984 Z_delta
, Z_delta_bytes
);
17987 /* Set the cursor. */
17988 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17990 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17995 /* Handle the case that changes are all below what is displayed in
17996 the window, and that PT is in the window. This shortcut cannot
17997 be taken if ZV is visible in the window, and text has been added
17998 there that is visible in the window. */
17999 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
18000 /* ZV is not visible in the window, or there are no
18001 changes at ZV, actually. */
18002 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
18003 || first_changed_charpos
== last_changed_charpos
))
18005 struct glyph_row
*r0
;
18007 /* Give up if PT is not in the window. Note that it already has
18008 been checked at the start of try_window_id that PT is not in
18009 front of the window start. */
18010 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
18013 /* If window start is unchanged, we can reuse the whole matrix
18014 as is, without changing glyph positions since no text has
18015 been added/removed in front of the window end. */
18016 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18017 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
18018 /* PT must not be in a partially visible line. */
18019 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18020 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18022 /* We have to compute the window end anew since text
18023 could have been added/removed after it. */
18024 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18025 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18027 /* Set the cursor. */
18028 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18030 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18035 /* Give up if window start is in the changed area.
18037 The condition used to read
18039 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18041 but why that was tested escapes me at the moment. */
18042 if (CHARPOS (start
) >= first_changed_charpos
18043 && CHARPOS (start
) <= last_changed_charpos
)
18046 /* Check that window start agrees with the start of the first glyph
18047 row in its current matrix. Check this after we know the window
18048 start is not in changed text, otherwise positions would not be
18050 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18051 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18054 /* Give up if the window ends in strings. Overlay strings
18055 at the end are difficult to handle, so don't try. */
18056 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18057 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18060 /* Compute the position at which we have to start displaying new
18061 lines. Some of the lines at the top of the window might be
18062 reusable because they are not displaying changed text. Find the
18063 last row in W's current matrix not affected by changes at the
18064 start of current_buffer. Value is null if changes start in the
18065 first line of window. */
18066 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18067 if (last_unchanged_at_beg_row
)
18069 /* Avoid starting to display in the middle of a character, a TAB
18070 for instance. This is easier than to set up the iterator
18071 exactly, and it's not a frequent case, so the additional
18072 effort wouldn't really pay off. */
18073 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18074 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18075 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18076 --last_unchanged_at_beg_row
;
18078 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18081 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
18083 start_pos
= it
.current
.pos
;
18085 /* Start displaying new lines in the desired matrix at the same
18086 vpos we would use in the current matrix, i.e. below
18087 last_unchanged_at_beg_row. */
18088 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18090 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18091 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18093 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18097 /* There are no reusable lines at the start of the window.
18098 Start displaying in the first text line. */
18099 start_display (&it
, w
, start
);
18100 it
.vpos
= it
.first_vpos
;
18101 start_pos
= it
.current
.pos
;
18104 /* Find the first row that is not affected by changes at the end of
18105 the buffer. Value will be null if there is no unchanged row, in
18106 which case we must redisplay to the end of the window. delta
18107 will be set to the value by which buffer positions beginning with
18108 first_unchanged_at_end_row have to be adjusted due to text
18110 first_unchanged_at_end_row
18111 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18112 IF_DEBUG (debug_delta
= delta
);
18113 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18115 /* Set stop_pos to the buffer position up to which we will have to
18116 display new lines. If first_unchanged_at_end_row != NULL, this
18117 is the buffer position of the start of the line displayed in that
18118 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18119 that we don't stop at a buffer position. */
18121 if (first_unchanged_at_end_row
)
18123 eassert (last_unchanged_at_beg_row
== NULL
18124 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18126 /* If this is a continuation line, move forward to the next one
18127 that isn't. Changes in lines above affect this line.
18128 Caution: this may move first_unchanged_at_end_row to a row
18129 not displaying text. */
18130 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18131 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18132 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18133 < it
.last_visible_y
))
18134 ++first_unchanged_at_end_row
;
18136 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18137 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18138 >= it
.last_visible_y
))
18139 first_unchanged_at_end_row
= NULL
;
18142 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18144 first_unchanged_at_end_vpos
18145 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18146 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18149 else if (last_unchanged_at_beg_row
== NULL
)
18155 /* Either there is no unchanged row at the end, or the one we have
18156 now displays text. This is a necessary condition for the window
18157 end pos calculation at the end of this function. */
18158 eassert (first_unchanged_at_end_row
== NULL
18159 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18161 debug_last_unchanged_at_beg_vpos
18162 = (last_unchanged_at_beg_row
18163 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18165 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18167 #endif /* GLYPH_DEBUG */
18170 /* Display new lines. Set last_text_row to the last new line
18171 displayed which has text on it, i.e. might end up as being the
18172 line where the window_end_vpos is. */
18173 w
->cursor
.vpos
= -1;
18174 last_text_row
= NULL
;
18175 overlay_arrow_seen
= 0;
18176 while (it
.current_y
< it
.last_visible_y
18177 && !f
->fonts_changed
18178 && (first_unchanged_at_end_row
== NULL
18179 || IT_CHARPOS (it
) < stop_pos
))
18181 if (display_line (&it
))
18182 last_text_row
= it
.glyph_row
- 1;
18185 if (f
->fonts_changed
)
18189 /* Compute differences in buffer positions, y-positions etc. for
18190 lines reused at the bottom of the window. Compute what we can
18192 if (first_unchanged_at_end_row
18193 /* No lines reused because we displayed everything up to the
18194 bottom of the window. */
18195 && it
.current_y
< it
.last_visible_y
)
18198 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18200 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18201 run
.current_y
= first_unchanged_at_end_row
->y
;
18202 run
.desired_y
= run
.current_y
+ dy
;
18203 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18207 delta
= delta_bytes
= dvpos
= dy
18208 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18209 first_unchanged_at_end_row
= NULL
;
18211 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18214 /* Find the cursor if not already found. We have to decide whether
18215 PT will appear on this window (it sometimes doesn't, but this is
18216 not a very frequent case.) This decision has to be made before
18217 the current matrix is altered. A value of cursor.vpos < 0 means
18218 that PT is either in one of the lines beginning at
18219 first_unchanged_at_end_row or below the window. Don't care for
18220 lines that might be displayed later at the window end; as
18221 mentioned, this is not a frequent case. */
18222 if (w
->cursor
.vpos
< 0)
18224 /* Cursor in unchanged rows at the top? */
18225 if (PT
< CHARPOS (start_pos
)
18226 && last_unchanged_at_beg_row
)
18228 row
= row_containing_pos (w
, PT
,
18229 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18230 last_unchanged_at_beg_row
+ 1, 0);
18232 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18235 /* Start from first_unchanged_at_end_row looking for PT. */
18236 else if (first_unchanged_at_end_row
)
18238 row
= row_containing_pos (w
, PT
- delta
,
18239 first_unchanged_at_end_row
, NULL
, 0);
18241 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18242 delta_bytes
, dy
, dvpos
);
18245 /* Give up if cursor was not found. */
18246 if (w
->cursor
.vpos
< 0)
18248 clear_glyph_matrix (w
->desired_matrix
);
18253 /* Don't let the cursor end in the scroll margins. */
18255 int this_scroll_margin
, cursor_height
;
18256 int frame_line_height
= default_line_pixel_height (w
);
18257 int window_total_lines
18258 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18260 this_scroll_margin
=
18261 max (0, min (scroll_margin
, window_total_lines
/ 4));
18262 this_scroll_margin
*= frame_line_height
;
18263 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18265 if ((w
->cursor
.y
< this_scroll_margin
18266 && CHARPOS (start
) > BEGV
)
18267 /* Old redisplay didn't take scroll margin into account at the bottom,
18268 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18269 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18270 ? cursor_height
+ this_scroll_margin
18271 : 1)) > it
.last_visible_y
)
18273 w
->cursor
.vpos
= -1;
18274 clear_glyph_matrix (w
->desired_matrix
);
18279 /* Scroll the display. Do it before changing the current matrix so
18280 that xterm.c doesn't get confused about where the cursor glyph is
18282 if (dy
&& run
.height
)
18286 if (FRAME_WINDOW_P (f
))
18288 FRAME_RIF (f
)->update_window_begin_hook (w
);
18289 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18290 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18291 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
18295 /* Terminal frame. In this case, dvpos gives the number of
18296 lines to scroll by; dvpos < 0 means scroll up. */
18298 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18299 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18300 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18301 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
18302 + window_internal_height (w
));
18304 #if defined (HAVE_GPM) || defined (MSDOS)
18305 x_clear_window_mouse_face (w
);
18307 /* Perform the operation on the screen. */
18310 /* Scroll last_unchanged_at_beg_row to the end of the
18311 window down dvpos lines. */
18312 set_terminal_window (f
, end
);
18314 /* On dumb terminals delete dvpos lines at the end
18315 before inserting dvpos empty lines. */
18316 if (!FRAME_SCROLL_REGION_OK (f
))
18317 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18319 /* Insert dvpos empty lines in front of
18320 last_unchanged_at_beg_row. */
18321 ins_del_lines (f
, from
, dvpos
);
18323 else if (dvpos
< 0)
18325 /* Scroll up last_unchanged_at_beg_vpos to the end of
18326 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18327 set_terminal_window (f
, end
);
18329 /* Delete dvpos lines in front of
18330 last_unchanged_at_beg_vpos. ins_del_lines will set
18331 the cursor to the given vpos and emit |dvpos| delete
18333 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18335 /* On a dumb terminal insert dvpos empty lines at the
18337 if (!FRAME_SCROLL_REGION_OK (f
))
18338 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18341 set_terminal_window (f
, 0);
18347 /* Shift reused rows of the current matrix to the right position.
18348 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18350 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18351 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18354 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18355 bottom_vpos
, dvpos
);
18356 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18359 else if (dvpos
> 0)
18361 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18362 bottom_vpos
, dvpos
);
18363 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18364 first_unchanged_at_end_vpos
+ dvpos
);
18367 /* For frame-based redisplay, make sure that current frame and window
18368 matrix are in sync with respect to glyph memory. */
18369 if (!FRAME_WINDOW_P (f
))
18370 sync_frame_with_window_matrix_rows (w
);
18372 /* Adjust buffer positions in reused rows. */
18373 if (delta
|| delta_bytes
)
18374 increment_matrix_positions (current_matrix
,
18375 first_unchanged_at_end_vpos
+ dvpos
,
18376 bottom_vpos
, delta
, delta_bytes
);
18378 /* Adjust Y positions. */
18380 shift_glyph_matrix (w
, current_matrix
,
18381 first_unchanged_at_end_vpos
+ dvpos
,
18384 if (first_unchanged_at_end_row
)
18386 first_unchanged_at_end_row
+= dvpos
;
18387 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18388 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18389 first_unchanged_at_end_row
= NULL
;
18392 /* If scrolling up, there may be some lines to display at the end of
18394 last_text_row_at_end
= NULL
;
18397 /* Scrolling up can leave for example a partially visible line
18398 at the end of the window to be redisplayed. */
18399 /* Set last_row to the glyph row in the current matrix where the
18400 window end line is found. It has been moved up or down in
18401 the matrix by dvpos. */
18402 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18403 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18405 /* If last_row is the window end line, it should display text. */
18406 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18408 /* If window end line was partially visible before, begin
18409 displaying at that line. Otherwise begin displaying with the
18410 line following it. */
18411 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18413 init_to_row_start (&it
, w
, last_row
);
18414 it
.vpos
= last_vpos
;
18415 it
.current_y
= last_row
->y
;
18419 init_to_row_end (&it
, w
, last_row
);
18420 it
.vpos
= 1 + last_vpos
;
18421 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18425 /* We may start in a continuation line. If so, we have to
18426 get the right continuation_lines_width and current_x. */
18427 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18428 it
.hpos
= it
.current_x
= 0;
18430 /* Display the rest of the lines at the window end. */
18431 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18432 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18434 /* Is it always sure that the display agrees with lines in
18435 the current matrix? I don't think so, so we mark rows
18436 displayed invalid in the current matrix by setting their
18437 enabled_p flag to zero. */
18438 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18439 if (display_line (&it
))
18440 last_text_row_at_end
= it
.glyph_row
- 1;
18444 /* Update window_end_pos and window_end_vpos. */
18445 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18447 /* Window end line if one of the preserved rows from the current
18448 matrix. Set row to the last row displaying text in current
18449 matrix starting at first_unchanged_at_end_row, after
18451 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18452 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18453 first_unchanged_at_end_row
);
18454 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18455 adjust_window_ends (w
, row
, 1);
18456 eassert (w
->window_end_bytepos
>= 0);
18457 IF_DEBUG (debug_method_add (w
, "A"));
18459 else if (last_text_row_at_end
)
18461 adjust_window_ends (w
, last_text_row_at_end
, 0);
18462 eassert (w
->window_end_bytepos
>= 0);
18463 IF_DEBUG (debug_method_add (w
, "B"));
18465 else if (last_text_row
)
18467 /* We have displayed either to the end of the window or at the
18468 end of the window, i.e. the last row with text is to be found
18469 in the desired matrix. */
18470 adjust_window_ends (w
, last_text_row
, 0);
18471 eassert (w
->window_end_bytepos
>= 0);
18473 else if (first_unchanged_at_end_row
== NULL
18474 && last_text_row
== NULL
18475 && last_text_row_at_end
== NULL
)
18477 /* Displayed to end of window, but no line containing text was
18478 displayed. Lines were deleted at the end of the window. */
18479 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
18480 int vpos
= w
->window_end_vpos
;
18481 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18482 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18485 row
== NULL
&& vpos
>= first_vpos
;
18486 --vpos
, --current_row
, --desired_row
)
18488 if (desired_row
->enabled_p
)
18490 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18493 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18497 eassert (row
!= NULL
);
18498 w
->window_end_vpos
= vpos
+ 1;
18499 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18500 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18501 eassert (w
->window_end_bytepos
>= 0);
18502 IF_DEBUG (debug_method_add (w
, "C"));
18507 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18508 debug_end_vpos
= w
->window_end_vpos
));
18510 /* Record that display has not been completed. */
18511 w
->window_end_valid
= 0;
18512 w
->desired_matrix
->no_scrolling_p
= 1;
18520 /***********************************************************************
18521 More debugging support
18522 ***********************************************************************/
18526 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18527 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18528 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18531 /* Dump the contents of glyph matrix MATRIX on stderr.
18533 GLYPHS 0 means don't show glyph contents.
18534 GLYPHS 1 means show glyphs in short form
18535 GLYPHS > 1 means show glyphs in long form. */
18538 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18541 for (i
= 0; i
< matrix
->nrows
; ++i
)
18542 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18546 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18547 the glyph row and area where the glyph comes from. */
18550 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18552 if (glyph
->type
== CHAR_GLYPH
18553 || glyph
->type
== GLYPHLESS_GLYPH
)
18556 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18557 glyph
- row
->glyphs
[TEXT_AREA
],
18558 (glyph
->type
== CHAR_GLYPH
18562 (BUFFERP (glyph
->object
)
18564 : (STRINGP (glyph
->object
)
18566 : (INTEGERP (glyph
->object
)
18569 glyph
->pixel_width
,
18571 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18575 glyph
->left_box_line_p
,
18576 glyph
->right_box_line_p
);
18578 else if (glyph
->type
== STRETCH_GLYPH
)
18581 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18582 glyph
- row
->glyphs
[TEXT_AREA
],
18585 (BUFFERP (glyph
->object
)
18587 : (STRINGP (glyph
->object
)
18589 : (INTEGERP (glyph
->object
)
18592 glyph
->pixel_width
,
18596 glyph
->left_box_line_p
,
18597 glyph
->right_box_line_p
);
18599 else if (glyph
->type
== IMAGE_GLYPH
)
18602 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18603 glyph
- row
->glyphs
[TEXT_AREA
],
18606 (BUFFERP (glyph
->object
)
18608 : (STRINGP (glyph
->object
)
18610 : (INTEGERP (glyph
->object
)
18613 glyph
->pixel_width
,
18617 glyph
->left_box_line_p
,
18618 glyph
->right_box_line_p
);
18620 else if (glyph
->type
== COMPOSITE_GLYPH
)
18623 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18624 glyph
- row
->glyphs
[TEXT_AREA
],
18627 (BUFFERP (glyph
->object
)
18629 : (STRINGP (glyph
->object
)
18631 : (INTEGERP (glyph
->object
)
18634 glyph
->pixel_width
,
18636 if (glyph
->u
.cmp
.automatic
)
18639 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18640 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18642 glyph
->left_box_line_p
,
18643 glyph
->right_box_line_p
);
18648 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18649 GLYPHS 0 means don't show glyph contents.
18650 GLYPHS 1 means show glyphs in short form
18651 GLYPHS > 1 means show glyphs in long form. */
18654 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18658 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18659 fprintf (stderr
, "==============================================================================\n");
18661 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18662 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18664 MATRIX_ROW_START_CHARPOS (row
),
18665 MATRIX_ROW_END_CHARPOS (row
),
18666 row
->used
[TEXT_AREA
],
18667 row
->contains_overlapping_glyphs_p
,
18669 row
->truncated_on_left_p
,
18670 row
->truncated_on_right_p
,
18672 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18673 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18676 row
->ends_in_middle_of_char_p
,
18677 row
->starts_in_middle_of_char_p
,
18683 row
->visible_height
,
18686 /* The next 3 lines should align to "Start" in the header. */
18687 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18688 row
->end
.overlay_string_index
,
18689 row
->continuation_lines_width
);
18690 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18691 CHARPOS (row
->start
.string_pos
),
18692 CHARPOS (row
->end
.string_pos
));
18693 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18694 row
->end
.dpvec_index
);
18701 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18703 struct glyph
*glyph
= row
->glyphs
[area
];
18704 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18706 /* Glyph for a line end in text. */
18707 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18710 if (glyph
< glyph_end
)
18711 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18713 for (; glyph
< glyph_end
; ++glyph
)
18714 dump_glyph (row
, glyph
, area
);
18717 else if (glyphs
== 1)
18721 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18723 char *s
= alloca (row
->used
[area
] + 4);
18726 for (i
= 0; i
< row
->used
[area
]; ++i
)
18728 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18729 if (i
== row
->used
[area
] - 1
18730 && area
== TEXT_AREA
18731 && INTEGERP (glyph
->object
)
18732 && glyph
->type
== CHAR_GLYPH
18733 && glyph
->u
.ch
== ' ')
18735 strcpy (&s
[i
], "[\\n]");
18738 else if (glyph
->type
== CHAR_GLYPH
18739 && glyph
->u
.ch
< 0x80
18740 && glyph
->u
.ch
>= ' ')
18741 s
[i
] = glyph
->u
.ch
;
18747 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18753 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18754 Sdump_glyph_matrix
, 0, 1, "p",
18755 doc
: /* Dump the current matrix of the selected window to stderr.
18756 Shows contents of glyph row structures. With non-nil
18757 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18758 glyphs in short form, otherwise show glyphs in long form.
18760 Interactively, no argument means show glyphs in short form;
18761 with numeric argument, its value is passed as the GLYPHS flag. */)
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
: /* Dump the current glyph matrix of the selected frame to stderr.
18780 Only text-mode frames have frame glyph matrices. */)
18783 struct frame
*f
= XFRAME (selected_frame
);
18785 if (f
->current_matrix
)
18786 dump_glyph_matrix (f
->current_matrix
, 1);
18788 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
18793 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18794 doc
: /* Dump glyph row ROW to stderr.
18795 GLYPH 0 means don't dump glyphs.
18796 GLYPH 1 means dump glyphs in short form.
18797 GLYPH > 1 or omitted means dump glyphs in long form. */)
18798 (Lisp_Object row
, Lisp_Object glyphs
)
18800 struct glyph_matrix
*matrix
;
18803 CHECK_NUMBER (row
);
18804 matrix
= XWINDOW (selected_window
)->current_matrix
;
18806 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18807 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18809 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18814 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18815 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18816 GLYPH 0 means don't dump glyphs.
18817 GLYPH 1 means dump glyphs in short form.
18818 GLYPH > 1 or omitted means dump glyphs in long form.
18820 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18822 (Lisp_Object row
, Lisp_Object glyphs
)
18824 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18825 struct frame
*sf
= SELECTED_FRAME ();
18826 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18829 CHECK_NUMBER (row
);
18831 if (vpos
>= 0 && vpos
< m
->nrows
)
18832 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18833 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18839 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18840 doc
: /* Toggle tracing of redisplay.
18841 With ARG, turn tracing on if and only if ARG is positive. */)
18845 trace_redisplay_p
= !trace_redisplay_p
;
18848 arg
= Fprefix_numeric_value (arg
);
18849 trace_redisplay_p
= XINT (arg
) > 0;
18856 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18857 doc
: /* Like `format', but print result to stderr.
18858 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18859 (ptrdiff_t nargs
, Lisp_Object
*args
)
18861 Lisp_Object s
= Fformat (nargs
, args
);
18862 fprintf (stderr
, "%s", SDATA (s
));
18866 #endif /* GLYPH_DEBUG */
18870 /***********************************************************************
18871 Building Desired Matrix Rows
18872 ***********************************************************************/
18874 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18875 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18877 static struct glyph_row
*
18878 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18880 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18881 struct buffer
*buffer
= XBUFFER (w
->contents
);
18882 struct buffer
*old
= current_buffer
;
18883 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18884 int arrow_len
= SCHARS (overlay_arrow_string
);
18885 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18886 const unsigned char *p
;
18889 int n_glyphs_before
;
18891 set_buffer_temp (buffer
);
18892 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18893 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18894 SET_TEXT_POS (it
.position
, 0, 0);
18896 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18898 while (p
< arrow_end
)
18900 Lisp_Object face
, ilisp
;
18902 /* Get the next character. */
18904 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18907 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18908 if (! ASCII_CHAR_P (it
.c
))
18909 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18913 /* Get its face. */
18914 ilisp
= make_number (p
- arrow_string
);
18915 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18916 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18918 /* Compute its width, get its glyphs. */
18919 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18920 SET_TEXT_POS (it
.position
, -1, -1);
18921 PRODUCE_GLYPHS (&it
);
18923 /* If this character doesn't fit any more in the line, we have
18924 to remove some glyphs. */
18925 if (it
.current_x
> it
.last_visible_x
)
18927 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18932 set_buffer_temp (old
);
18933 return it
.glyph_row
;
18937 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18938 glyphs to insert is determined by produce_special_glyphs. */
18941 insert_left_trunc_glyphs (struct it
*it
)
18943 struct it truncate_it
;
18944 struct glyph
*from
, *end
, *to
, *toend
;
18946 eassert (!FRAME_WINDOW_P (it
->f
)
18947 || (!it
->glyph_row
->reversed_p
18948 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18949 || (it
->glyph_row
->reversed_p
18950 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18952 /* Get the truncation glyphs. */
18954 truncate_it
.current_x
= 0;
18955 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18956 truncate_it
.glyph_row
= &scratch_glyph_row
;
18957 truncate_it
.area
= TEXT_AREA
;
18958 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18959 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18960 truncate_it
.object
= make_number (0);
18961 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18963 /* Overwrite glyphs from IT with truncation glyphs. */
18964 if (!it
->glyph_row
->reversed_p
)
18966 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18968 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18969 end
= from
+ tused
;
18970 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18971 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18972 if (FRAME_WINDOW_P (it
->f
))
18974 /* On GUI frames, when variable-size fonts are displayed,
18975 the truncation glyphs may need more pixels than the row's
18976 glyphs they overwrite. We overwrite more glyphs to free
18977 enough screen real estate, and enlarge the stretch glyph
18978 on the right (see display_line), if there is one, to
18979 preserve the screen position of the truncation glyphs on
18982 struct glyph
*g
= to
;
18985 /* The first glyph could be partially visible, in which case
18986 it->glyph_row->x will be negative. But we want the left
18987 truncation glyphs to be aligned at the left margin of the
18988 window, so we override the x coordinate at which the row
18990 it
->glyph_row
->x
= 0;
18991 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18993 w
+= g
->pixel_width
;
18996 if (g
- to
- tused
> 0)
18998 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18999 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
19001 used
= it
->glyph_row
->used
[TEXT_AREA
];
19002 if (it
->glyph_row
->truncated_on_right_p
19003 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
19004 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
19007 int extra
= w
- it
->truncation_pixel_width
;
19009 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
19016 /* There may be padding glyphs left over. Overwrite them too. */
19017 if (!FRAME_WINDOW_P (it
->f
))
19019 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19021 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19028 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19032 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19034 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19035 that back to front. */
19036 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19037 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19038 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19039 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19040 if (FRAME_WINDOW_P (it
->f
))
19043 struct glyph
*g
= to
;
19045 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19047 w
+= g
->pixel_width
;
19050 if (to
- g
- tused
> 0)
19052 if (it
->glyph_row
->truncated_on_right_p
19053 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19054 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19056 int extra
= w
- it
->truncation_pixel_width
;
19058 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19062 while (from
>= end
&& to
>= toend
)
19064 if (!FRAME_WINDOW_P (it
->f
))
19066 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19069 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19070 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19071 while (from
>= end
&& to
>= toend
)
19077 /* Need to free some room before prepending additional
19079 int move_by
= from
- end
+ 1;
19080 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19081 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19083 for ( ; g
>= g0
; g
--)
19085 while (from
>= end
)
19087 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19092 /* Compute the hash code for ROW. */
19094 row_hash (struct glyph_row
*row
)
19097 unsigned hashval
= 0;
19099 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19100 for (k
= 0; k
< row
->used
[area
]; ++k
)
19101 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19102 + row
->glyphs
[area
][k
].u
.val
19103 + row
->glyphs
[area
][k
].face_id
19104 + row
->glyphs
[area
][k
].padding_p
19105 + (row
->glyphs
[area
][k
].type
<< 2));
19110 /* Compute the pixel height and width of IT->glyph_row.
19112 Most of the time, ascent and height of a display line will be equal
19113 to the max_ascent and max_height values of the display iterator
19114 structure. This is not the case if
19116 1. We hit ZV without displaying anything. In this case, max_ascent
19117 and max_height will be zero.
19119 2. We have some glyphs that don't contribute to the line height.
19120 (The glyph row flag contributes_to_line_height_p is for future
19121 pixmap extensions).
19123 The first case is easily covered by using default values because in
19124 these cases, the line height does not really matter, except that it
19125 must not be zero. */
19128 compute_line_metrics (struct it
*it
)
19130 struct glyph_row
*row
= it
->glyph_row
;
19132 if (FRAME_WINDOW_P (it
->f
))
19134 int i
, min_y
, max_y
;
19136 /* The line may consist of one space only, that was added to
19137 place the cursor on it. If so, the row's height hasn't been
19139 if (row
->height
== 0)
19141 if (it
->max_ascent
+ it
->max_descent
== 0)
19142 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19143 row
->ascent
= it
->max_ascent
;
19144 row
->height
= it
->max_ascent
+ it
->max_descent
;
19145 row
->phys_ascent
= it
->max_phys_ascent
;
19146 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19147 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19150 /* Compute the width of this line. */
19151 row
->pixel_width
= row
->x
;
19152 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19153 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19155 eassert (row
->pixel_width
>= 0);
19156 eassert (row
->ascent
>= 0 && row
->height
> 0);
19158 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19159 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19161 /* If first line's physical ascent is larger than its logical
19162 ascent, use the physical ascent, and make the row taller.
19163 This makes accented characters fully visible. */
19164 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19165 && row
->phys_ascent
> row
->ascent
)
19167 row
->height
+= row
->phys_ascent
- row
->ascent
;
19168 row
->ascent
= row
->phys_ascent
;
19171 /* Compute how much of the line is visible. */
19172 row
->visible_height
= row
->height
;
19174 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19175 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19177 if (row
->y
< min_y
)
19178 row
->visible_height
-= min_y
- row
->y
;
19179 if (row
->y
+ row
->height
> max_y
)
19180 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19184 row
->pixel_width
= row
->used
[TEXT_AREA
];
19185 if (row
->continued_p
)
19186 row
->pixel_width
-= it
->continuation_pixel_width
;
19187 else if (row
->truncated_on_right_p
)
19188 row
->pixel_width
-= it
->truncation_pixel_width
;
19189 row
->ascent
= row
->phys_ascent
= 0;
19190 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19191 row
->extra_line_spacing
= 0;
19194 /* Compute a hash code for this row. */
19195 row
->hash
= row_hash (row
);
19197 it
->max_ascent
= it
->max_descent
= 0;
19198 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19202 /* Append one space to the glyph row of iterator IT if doing a
19203 window-based redisplay. The space has the same face as
19204 IT->face_id. Value is non-zero if a space was added.
19206 This function is called to make sure that there is always one glyph
19207 at the end of a glyph row that the cursor can be set on under
19208 window-systems. (If there weren't such a glyph we would not know
19209 how wide and tall a box cursor should be displayed).
19211 At the same time this space let's a nicely handle clearing to the
19212 end of the line if the row ends in italic text. */
19215 append_space_for_newline (struct it
*it
, int default_face_p
)
19217 if (FRAME_WINDOW_P (it
->f
))
19219 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19221 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19222 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19224 /* Save some values that must not be changed.
19225 Must save IT->c and IT->len because otherwise
19226 ITERATOR_AT_END_P wouldn't work anymore after
19227 append_space_for_newline has been called. */
19228 enum display_element_type saved_what
= it
->what
;
19229 int saved_c
= it
->c
, saved_len
= it
->len
;
19230 int saved_char_to_display
= it
->char_to_display
;
19231 int saved_x
= it
->current_x
;
19232 int saved_face_id
= it
->face_id
;
19233 int saved_box_end
= it
->end_of_box_run_p
;
19234 struct text_pos saved_pos
;
19235 Lisp_Object saved_object
;
19238 saved_object
= it
->object
;
19239 saved_pos
= it
->position
;
19241 it
->what
= IT_CHARACTER
;
19242 memset (&it
->position
, 0, sizeof it
->position
);
19243 it
->object
= make_number (0);
19244 it
->c
= it
->char_to_display
= ' ';
19247 /* If the default face was remapped, be sure to use the
19248 remapped face for the appended newline. */
19249 if (default_face_p
)
19250 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19251 else if (it
->face_before_selective_p
)
19252 it
->face_id
= it
->saved_face_id
;
19253 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19254 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19255 /* In R2L rows, we will prepend a stretch glyph that will
19256 have the end_of_box_run_p flag set for it, so there's no
19257 need for the appended newline glyph to have that flag
19259 if (it
->glyph_row
->reversed_p
19260 /* But if the appended newline glyph goes all the way to
19261 the end of the row, there will be no stretch glyph,
19262 so leave the box flag set. */
19263 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19264 it
->end_of_box_run_p
= 0;
19266 PRODUCE_GLYPHS (it
);
19268 it
->override_ascent
= -1;
19269 it
->constrain_row_ascent_descent_p
= 0;
19270 it
->current_x
= saved_x
;
19271 it
->object
= saved_object
;
19272 it
->position
= saved_pos
;
19273 it
->what
= saved_what
;
19274 it
->face_id
= saved_face_id
;
19275 it
->len
= saved_len
;
19277 it
->char_to_display
= saved_char_to_display
;
19278 it
->end_of_box_run_p
= saved_box_end
;
19287 /* Extend the face of the last glyph in the text area of IT->glyph_row
19288 to the end of the display line. Called from display_line. If the
19289 glyph row is empty, add a space glyph to it so that we know the
19290 face to draw. Set the glyph row flag fill_line_p. If the glyph
19291 row is R2L, prepend a stretch glyph to cover the empty space to the
19292 left of the leftmost glyph. */
19295 extend_face_to_end_of_line (struct it
*it
)
19297 struct face
*face
, *default_face
;
19298 struct frame
*f
= it
->f
;
19300 /* If line is already filled, do nothing. Non window-system frames
19301 get a grace of one more ``pixel'' because their characters are
19302 1-``pixel'' wide, so they hit the equality too early. This grace
19303 is needed only for R2L rows that are not continued, to produce
19304 one extra blank where we could display the cursor. */
19305 if ((it
->current_x
>= it
->last_visible_x
19306 + (!FRAME_WINDOW_P (f
)
19307 && it
->glyph_row
->reversed_p
19308 && !it
->glyph_row
->continued_p
))
19309 /* If the window has display margins, we will need to extend
19310 their face even if the text area is filled. */
19311 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19312 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19315 /* The default face, possibly remapped. */
19316 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19318 /* Face extension extends the background and box of IT->face_id
19319 to the end of the line. If the background equals the background
19320 of the frame, we don't have to do anything. */
19321 if (it
->face_before_selective_p
)
19322 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19324 face
= FACE_FROM_ID (f
, it
->face_id
);
19326 if (FRAME_WINDOW_P (f
)
19327 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19328 && face
->box
== FACE_NO_BOX
19329 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19330 #ifdef HAVE_WINDOW_SYSTEM
19333 && !it
->glyph_row
->reversed_p
)
19336 /* Set the glyph row flag indicating that the face of the last glyph
19337 in the text area has to be drawn to the end of the text area. */
19338 it
->glyph_row
->fill_line_p
= 1;
19340 /* If current character of IT is not ASCII, make sure we have the
19341 ASCII face. This will be automatically undone the next time
19342 get_next_display_element returns a multibyte character. Note
19343 that the character will always be single byte in unibyte
19345 if (!ASCII_CHAR_P (it
->c
))
19347 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19350 if (FRAME_WINDOW_P (f
))
19352 /* If the row is empty, add a space with the current face of IT,
19353 so that we know which face to draw. */
19354 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19356 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19357 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19358 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19360 /* Mode line and the header line don't have margins, and
19361 likewise the frame's tool-bar window, if there is any. */
19362 if (!(it
->glyph_row
->mode_line_p
19363 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19364 || (WINDOWP (f
->tool_bar_window
)
19365 && it
->w
== XWINDOW (f
->tool_bar_window
))
19369 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19370 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19372 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19373 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19375 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19377 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19378 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19380 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19381 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19383 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19386 #ifdef HAVE_WINDOW_SYSTEM
19387 if (it
->glyph_row
->reversed_p
)
19389 /* Prepend a stretch glyph to the row, such that the
19390 rightmost glyph will be drawn flushed all the way to the
19391 right margin of the window. The stretch glyph that will
19392 occupy the empty space, if any, to the left of the
19394 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19395 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19396 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19398 int row_width
, stretch_ascent
, stretch_width
;
19399 struct text_pos saved_pos
;
19400 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
19402 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19403 row_width
+= g
->pixel_width
;
19405 /* FIXME: There are various minor display glitches in R2L
19406 rows when only one of the fringes is missing. The
19407 strange condition below produces the least bad effect. */
19408 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19409 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19410 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19411 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19413 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19414 stretch_width
-= row_width
;
19416 if (stretch_width
> 0)
19419 (((it
->ascent
+ it
->descent
)
19420 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19421 saved_pos
= it
->position
;
19422 memset (&it
->position
, 0, sizeof it
->position
);
19423 saved_avoid_cursor
= it
->avoid_cursor_p
;
19424 it
->avoid_cursor_p
= 1;
19425 saved_face_id
= it
->face_id
;
19426 saved_box_start
= it
->start_of_box_run_p
;
19427 /* The last row's stretch glyph should get the default
19428 face, to avoid painting the rest of the window with
19429 the region face, if the region ends at ZV. */
19430 if (it
->glyph_row
->ends_at_zv_p
)
19431 it
->face_id
= default_face
->id
;
19433 it
->face_id
= face
->id
;
19434 it
->start_of_box_run_p
= 0;
19435 append_stretch_glyph (it
, make_number (0), stretch_width
,
19436 it
->ascent
+ it
->descent
, stretch_ascent
);
19437 it
->position
= saved_pos
;
19438 it
->avoid_cursor_p
= saved_avoid_cursor
;
19439 it
->face_id
= saved_face_id
;
19440 it
->start_of_box_run_p
= saved_box_start
;
19442 /* If stretch_width comes out negative, it means that the
19443 last glyph is only partially visible. In R2L rows, we
19444 want the leftmost glyph to be partially visible, so we
19445 need to give the row the corresponding left offset. */
19446 if (stretch_width
< 0)
19447 it
->glyph_row
->x
= stretch_width
;
19449 #endif /* HAVE_WINDOW_SYSTEM */
19453 /* Save some values that must not be changed. */
19454 int saved_x
= it
->current_x
;
19455 struct text_pos saved_pos
;
19456 Lisp_Object saved_object
;
19457 enum display_element_type saved_what
= it
->what
;
19458 int saved_face_id
= it
->face_id
;
19460 saved_object
= it
->object
;
19461 saved_pos
= it
->position
;
19463 it
->what
= IT_CHARACTER
;
19464 memset (&it
->position
, 0, sizeof it
->position
);
19465 it
->object
= make_number (0);
19466 it
->c
= it
->char_to_display
= ' ';
19469 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19470 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19471 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19472 && !it
->glyph_row
->mode_line_p
19473 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19475 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19476 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19478 for (it
->current_x
= 0; g
< e
; g
++)
19479 it
->current_x
+= g
->pixel_width
;
19481 it
->area
= LEFT_MARGIN_AREA
;
19482 it
->face_id
= default_face
->id
;
19483 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19484 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19486 PRODUCE_GLYPHS (it
);
19487 /* term.c:produce_glyphs advances it->current_x only for
19489 it
->current_x
+= it
->pixel_width
;
19492 it
->current_x
= saved_x
;
19493 it
->area
= TEXT_AREA
;
19496 /* The last row's blank glyphs should get the default face, to
19497 avoid painting the rest of the window with the region face,
19498 if the region ends at ZV. */
19499 if (it
->glyph_row
->ends_at_zv_p
)
19500 it
->face_id
= default_face
->id
;
19502 it
->face_id
= face
->id
;
19503 PRODUCE_GLYPHS (it
);
19505 while (it
->current_x
<= it
->last_visible_x
)
19506 PRODUCE_GLYPHS (it
);
19508 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19509 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19510 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19511 && !it
->glyph_row
->mode_line_p
19512 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19514 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19515 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19517 for ( ; g
< e
; g
++)
19518 it
->current_x
+= g
->pixel_width
;
19520 it
->area
= RIGHT_MARGIN_AREA
;
19521 it
->face_id
= default_face
->id
;
19522 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19523 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19525 PRODUCE_GLYPHS (it
);
19526 it
->current_x
+= it
->pixel_width
;
19529 it
->area
= TEXT_AREA
;
19532 /* Don't count these blanks really. It would let us insert a left
19533 truncation glyph below and make us set the cursor on them, maybe. */
19534 it
->current_x
= saved_x
;
19535 it
->object
= saved_object
;
19536 it
->position
= saved_pos
;
19537 it
->what
= saved_what
;
19538 it
->face_id
= saved_face_id
;
19543 /* Value is non-zero if text starting at CHARPOS in current_buffer is
19544 trailing whitespace. */
19547 trailing_whitespace_p (ptrdiff_t charpos
)
19549 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19552 while (bytepos
< ZV_BYTE
19553 && (c
= FETCH_CHAR (bytepos
),
19554 c
== ' ' || c
== '\t'))
19557 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19559 if (bytepos
!= PT_BYTE
)
19566 /* Highlight trailing whitespace, if any, in ROW. */
19569 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19571 int used
= row
->used
[TEXT_AREA
];
19575 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19576 struct glyph
*glyph
= start
+ used
- 1;
19578 if (row
->reversed_p
)
19580 /* Right-to-left rows need to be processed in the opposite
19581 direction, so swap the edge pointers. */
19583 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19586 /* Skip over glyphs inserted to display the cursor at the
19587 end of a line, for extending the face of the last glyph
19588 to the end of the line on terminals, and for truncation
19589 and continuation glyphs. */
19590 if (!row
->reversed_p
)
19592 while (glyph
>= start
19593 && glyph
->type
== CHAR_GLYPH
19594 && INTEGERP (glyph
->object
))
19599 while (glyph
<= start
19600 && glyph
->type
== CHAR_GLYPH
19601 && INTEGERP (glyph
->object
))
19605 /* If last glyph is a space or stretch, and it's trailing
19606 whitespace, set the face of all trailing whitespace glyphs in
19607 IT->glyph_row to `trailing-whitespace'. */
19608 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19609 && BUFFERP (glyph
->object
)
19610 && (glyph
->type
== STRETCH_GLYPH
19611 || (glyph
->type
== CHAR_GLYPH
19612 && glyph
->u
.ch
== ' '))
19613 && trailing_whitespace_p (glyph
->charpos
))
19615 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
19619 if (!row
->reversed_p
)
19621 while (glyph
>= start
19622 && BUFFERP (glyph
->object
)
19623 && (glyph
->type
== STRETCH_GLYPH
19624 || (glyph
->type
== CHAR_GLYPH
19625 && glyph
->u
.ch
== ' ')))
19626 (glyph
--)->face_id
= face_id
;
19630 while (glyph
<= start
19631 && BUFFERP (glyph
->object
)
19632 && (glyph
->type
== STRETCH_GLYPH
19633 || (glyph
->type
== CHAR_GLYPH
19634 && glyph
->u
.ch
== ' ')))
19635 (glyph
++)->face_id
= face_id
;
19642 /* Value is non-zero if glyph row ROW should be
19643 considered to hold the buffer position CHARPOS. */
19646 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19650 if (charpos
== CHARPOS (row
->end
.pos
)
19651 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19653 /* Suppose the row ends on a string.
19654 Unless the row is continued, that means it ends on a newline
19655 in the string. If it's anything other than a display string
19656 (e.g., a before-string from an overlay), we don't want the
19657 cursor there. (This heuristic seems to give the optimal
19658 behavior for the various types of multi-line strings.)
19659 One exception: if the string has `cursor' property on one of
19660 its characters, we _do_ want the cursor there. */
19661 if (CHARPOS (row
->end
.string_pos
) >= 0)
19663 if (row
->continued_p
)
19667 /* Check for `display' property. */
19668 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19669 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19670 struct glyph
*glyph
;
19673 for (glyph
= end
; glyph
>= beg
; --glyph
)
19674 if (STRINGP (glyph
->object
))
19677 = Fget_char_property (make_number (charpos
),
19681 && display_prop_string_p (prop
, glyph
->object
));
19682 /* If there's a `cursor' property on one of the
19683 string's characters, this row is a cursor row,
19684 even though this is not a display string. */
19687 Lisp_Object s
= glyph
->object
;
19689 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19691 ptrdiff_t gpos
= glyph
->charpos
;
19693 if (!NILP (Fget_char_property (make_number (gpos
),
19705 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19707 /* If the row ends in middle of a real character,
19708 and the line is continued, we want the cursor here.
19709 That's because CHARPOS (ROW->end.pos) would equal
19710 PT if PT is before the character. */
19711 if (!row
->ends_in_ellipsis_p
)
19712 result
= row
->continued_p
;
19714 /* If the row ends in an ellipsis, then
19715 CHARPOS (ROW->end.pos) will equal point after the
19716 invisible text. We want that position to be displayed
19717 after the ellipsis. */
19720 /* If the row ends at ZV, display the cursor at the end of that
19721 row instead of at the start of the row below. */
19722 else if (row
->ends_at_zv_p
)
19731 /* Value is non-zero if glyph row ROW should be
19732 used to hold the cursor. */
19735 cursor_row_p (struct glyph_row
*row
)
19737 return row_for_charpos_p (row
, PT
);
19742 /* Push the property PROP so that it will be rendered at the current
19743 position in IT. Return 1 if PROP was successfully pushed, 0
19744 otherwise. Called from handle_line_prefix to handle the
19745 `line-prefix' and `wrap-prefix' properties. */
19748 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19750 struct text_pos pos
=
19751 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19753 eassert (it
->method
== GET_FROM_BUFFER
19754 || it
->method
== GET_FROM_DISPLAY_VECTOR
19755 || it
->method
== GET_FROM_STRING
);
19757 /* We need to save the current buffer/string position, so it will be
19758 restored by pop_it, because iterate_out_of_display_property
19759 depends on that being set correctly, but some situations leave
19760 it->position not yet set when this function is called. */
19761 push_it (it
, &pos
);
19763 if (STRINGP (prop
))
19765 if (SCHARS (prop
) == 0)
19772 it
->string_from_prefix_prop_p
= 1;
19773 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19774 it
->current
.overlay_string_index
= -1;
19775 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19776 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19777 it
->method
= GET_FROM_STRING
;
19778 it
->stop_charpos
= 0;
19780 it
->base_level_stop
= 0;
19782 /* Force paragraph direction to be that of the parent
19784 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19785 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19787 it
->paragraph_embedding
= L2R
;
19789 /* Set up the bidi iterator for this display string. */
19792 it
->bidi_it
.string
.lstring
= it
->string
;
19793 it
->bidi_it
.string
.s
= NULL
;
19794 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19795 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19796 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19797 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19798 it
->bidi_it
.w
= it
->w
;
19799 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19802 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19804 it
->method
= GET_FROM_STRETCH
;
19807 #ifdef HAVE_WINDOW_SYSTEM
19808 else if (IMAGEP (prop
))
19810 it
->what
= IT_IMAGE
;
19811 it
->image_id
= lookup_image (it
->f
, prop
);
19812 it
->method
= GET_FROM_IMAGE
;
19814 #endif /* HAVE_WINDOW_SYSTEM */
19817 pop_it (it
); /* bogus display property, give up */
19824 /* Return the character-property PROP at the current position in IT. */
19827 get_it_property (struct it
*it
, Lisp_Object prop
)
19829 Lisp_Object position
, object
= it
->object
;
19831 if (STRINGP (object
))
19832 position
= make_number (IT_STRING_CHARPOS (*it
));
19833 else if (BUFFERP (object
))
19835 position
= make_number (IT_CHARPOS (*it
));
19836 object
= it
->window
;
19841 return Fget_char_property (position
, prop
, object
);
19844 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19847 handle_line_prefix (struct it
*it
)
19849 Lisp_Object prefix
;
19851 if (it
->continuation_lines_width
> 0)
19853 prefix
= get_it_property (it
, Qwrap_prefix
);
19855 prefix
= Vwrap_prefix
;
19859 prefix
= get_it_property (it
, Qline_prefix
);
19861 prefix
= Vline_prefix
;
19863 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19865 /* If the prefix is wider than the window, and we try to wrap
19866 it, it would acquire its own wrap prefix, and so on till the
19867 iterator stack overflows. So, don't wrap the prefix. */
19868 it
->line_wrap
= TRUNCATE
;
19869 it
->avoid_cursor_p
= 1;
19875 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19876 only for R2L lines from display_line and display_string, when they
19877 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19878 the line/string needs to be continued on the next glyph row. */
19880 unproduce_glyphs (struct it
*it
, int n
)
19882 struct glyph
*glyph
, *end
;
19884 eassert (it
->glyph_row
);
19885 eassert (it
->glyph_row
->reversed_p
);
19886 eassert (it
->area
== TEXT_AREA
);
19887 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19889 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19890 n
= it
->glyph_row
->used
[TEXT_AREA
];
19891 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19892 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19893 for ( ; glyph
< end
; glyph
++)
19894 glyph
[-n
] = *glyph
;
19897 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19898 and ROW->maxpos. */
19900 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19901 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19902 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19904 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19905 lines' rows is implemented for bidi-reordered rows. */
19907 /* ROW->minpos is the value of min_pos, the minimal buffer position
19908 we have in ROW, or ROW->start.pos if that is smaller. */
19909 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19910 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19912 /* We didn't find buffer positions smaller than ROW->start, or
19913 didn't find _any_ valid buffer positions in any of the glyphs,
19914 so we must trust the iterator's computed positions. */
19915 row
->minpos
= row
->start
.pos
;
19918 max_pos
= CHARPOS (it
->current
.pos
);
19919 max_bpos
= BYTEPOS (it
->current
.pos
);
19922 /* Here are the various use-cases for ending the row, and the
19923 corresponding values for ROW->maxpos:
19925 Line ends in a newline from buffer eol_pos + 1
19926 Line is continued from buffer max_pos + 1
19927 Line is truncated on right it->current.pos
19928 Line ends in a newline from string max_pos + 1(*)
19929 (*) + 1 only when line ends in a forward scan
19930 Line is continued from string max_pos
19931 Line is continued from display vector max_pos
19932 Line is entirely from a string min_pos == max_pos
19933 Line is entirely from a display vector min_pos == max_pos
19934 Line that ends at ZV ZV
19936 If you discover other use-cases, please add them here as
19938 if (row
->ends_at_zv_p
)
19939 row
->maxpos
= it
->current
.pos
;
19940 else if (row
->used
[TEXT_AREA
])
19942 int seen_this_string
= 0;
19943 struct glyph_row
*r1
= row
- 1;
19945 /* Did we see the same display string on the previous row? */
19946 if (STRINGP (it
->object
)
19947 /* this is not the first row */
19948 && row
> it
->w
->desired_matrix
->rows
19949 /* previous row is not the header line */
19950 && !r1
->mode_line_p
19951 /* previous row also ends in a newline from a string */
19952 && r1
->ends_in_newline_from_string_p
)
19954 struct glyph
*start
, *end
;
19956 /* Search for the last glyph of the previous row that came
19957 from buffer or string. Depending on whether the row is
19958 L2R or R2L, we need to process it front to back or the
19959 other way round. */
19960 if (!r1
->reversed_p
)
19962 start
= r1
->glyphs
[TEXT_AREA
];
19963 end
= start
+ r1
->used
[TEXT_AREA
];
19964 /* Glyphs inserted by redisplay have an integer (zero)
19965 as their object. */
19967 && INTEGERP ((end
- 1)->object
)
19968 && (end
- 1)->charpos
<= 0)
19972 if (EQ ((end
- 1)->object
, it
->object
))
19973 seen_this_string
= 1;
19976 /* If all the glyphs of the previous row were inserted
19977 by redisplay, it means the previous row was
19978 produced from a single newline, which is only
19979 possible if that newline came from the same string
19980 as the one which produced this ROW. */
19981 seen_this_string
= 1;
19985 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19986 start
= end
+ r1
->used
[TEXT_AREA
];
19988 && INTEGERP ((end
+ 1)->object
)
19989 && (end
+ 1)->charpos
<= 0)
19993 if (EQ ((end
+ 1)->object
, it
->object
))
19994 seen_this_string
= 1;
19997 seen_this_string
= 1;
20000 /* Take note of each display string that covers a newline only
20001 once, the first time we see it. This is for when a display
20002 string includes more than one newline in it. */
20003 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20005 /* If we were scanning the buffer forward when we displayed
20006 the string, we want to account for at least one buffer
20007 position that belongs to this row (position covered by
20008 the display string), so that cursor positioning will
20009 consider this row as a candidate when point is at the end
20010 of the visual line represented by this row. This is not
20011 required when scanning back, because max_pos will already
20012 have a much larger value. */
20013 if (CHARPOS (row
->end
.pos
) > max_pos
)
20014 INC_BOTH (max_pos
, max_bpos
);
20015 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20017 else if (CHARPOS (it
->eol_pos
) > 0)
20018 SET_TEXT_POS (row
->maxpos
,
20019 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20020 else if (row
->continued_p
)
20022 /* If max_pos is different from IT's current position, it
20023 means IT->method does not belong to the display element
20024 at max_pos. However, it also means that the display
20025 element at max_pos was displayed in its entirety on this
20026 line, which is equivalent to saying that the next line
20027 starts at the next buffer position. */
20028 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20029 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20032 INC_BOTH (max_pos
, max_bpos
);
20033 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20036 else if (row
->truncated_on_right_p
)
20037 /* display_line already called reseat_at_next_visible_line_start,
20038 which puts the iterator at the beginning of the next line, in
20039 the logical order. */
20040 row
->maxpos
= it
->current
.pos
;
20041 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20042 /* A line that is entirely from a string/image/stretch... */
20043 row
->maxpos
= row
->minpos
;
20048 row
->maxpos
= it
->current
.pos
;
20051 /* Construct the glyph row IT->glyph_row in the desired matrix of
20052 IT->w from text at the current position of IT. See dispextern.h
20053 for an overview of struct it. Value is non-zero if
20054 IT->glyph_row displays text, as opposed to a line displaying ZV
20058 display_line (struct it
*it
)
20060 struct glyph_row
*row
= it
->glyph_row
;
20061 Lisp_Object overlay_arrow_string
;
20063 void *wrap_data
= NULL
;
20064 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
20065 int wrap_row_used
= -1;
20066 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20067 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20068 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20069 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20070 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20072 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20073 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20074 bool pending_handle_line_prefix
= false;
20076 /* We always start displaying at hpos zero even if hscrolled. */
20077 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20079 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20080 >= it
->w
->desired_matrix
->nrows
)
20082 it
->w
->nrows_scale_factor
++;
20083 it
->f
->fonts_changed
= 1;
20087 /* Clear the result glyph row and enable it. */
20088 prepare_desired_row (it
->w
, row
, false);
20090 row
->y
= it
->current_y
;
20091 row
->start
= it
->start
;
20092 row
->continuation_lines_width
= it
->continuation_lines_width
;
20093 row
->displays_text_p
= 1;
20094 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20095 it
->starts_in_middle_of_char_p
= 0;
20097 /* Arrange the overlays nicely for our purposes. Usually, we call
20098 display_line on only one line at a time, in which case this
20099 can't really hurt too much, or we call it on lines which appear
20100 one after another in the buffer, in which case all calls to
20101 recenter_overlay_lists but the first will be pretty cheap. */
20102 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20104 /* Move over display elements that are not visible because we are
20105 hscrolled. This may stop at an x-position < IT->first_visible_x
20106 if the first glyph is partially visible or if we hit a line end. */
20107 if (it
->current_x
< it
->first_visible_x
)
20109 enum move_it_result move_result
;
20111 this_line_min_pos
= row
->start
.pos
;
20112 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20113 MOVE_TO_POS
| MOVE_TO_X
);
20114 /* If we are under a large hscroll, move_it_in_display_line_to
20115 could hit the end of the line without reaching
20116 it->first_visible_x. Pretend that we did reach it. This is
20117 especially important on a TTY, where we will call
20118 extend_face_to_end_of_line, which needs to know how many
20119 blank glyphs to produce. */
20120 if (it
->current_x
< it
->first_visible_x
20121 && (move_result
== MOVE_NEWLINE_OR_CR
20122 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20123 it
->current_x
= it
->first_visible_x
;
20125 /* Record the smallest positions seen while we moved over
20126 display elements that are not visible. This is needed by
20127 redisplay_internal for optimizing the case where the cursor
20128 stays inside the same line. The rest of this function only
20129 considers positions that are actually displayed, so
20130 RECORD_MAX_MIN_POS will not otherwise record positions that
20131 are hscrolled to the left of the left edge of the window. */
20132 min_pos
= CHARPOS (this_line_min_pos
);
20133 min_bpos
= BYTEPOS (this_line_min_pos
);
20135 else if (it
->area
== TEXT_AREA
)
20137 /* We only do this when not calling move_it_in_display_line_to
20138 above, because that function calls itself handle_line_prefix. */
20139 handle_line_prefix (it
);
20143 /* Line-prefix and wrap-prefix are always displayed in the text
20144 area. But if this is the first call to display_line after
20145 init_iterator, the iterator might have been set up to write
20146 into a marginal area, e.g. if the line begins with some
20147 display property that writes to the margins. So we need to
20148 wait with the call to handle_line_prefix until whatever
20149 writes to the margin has done its job. */
20150 pending_handle_line_prefix
= true;
20153 /* Get the initial row height. This is either the height of the
20154 text hscrolled, if there is any, or zero. */
20155 row
->ascent
= it
->max_ascent
;
20156 row
->height
= it
->max_ascent
+ it
->max_descent
;
20157 row
->phys_ascent
= it
->max_phys_ascent
;
20158 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20159 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20161 /* Utility macro to record max and min buffer positions seen until now. */
20162 #define RECORD_MAX_MIN_POS(IT) \
20165 int composition_p = !STRINGP ((IT)->string) \
20166 && ((IT)->what == IT_COMPOSITION); \
20167 ptrdiff_t current_pos = \
20168 composition_p ? (IT)->cmp_it.charpos \
20169 : IT_CHARPOS (*(IT)); \
20170 ptrdiff_t current_bpos = \
20171 composition_p ? CHAR_TO_BYTE (current_pos) \
20172 : IT_BYTEPOS (*(IT)); \
20173 if (current_pos < min_pos) \
20175 min_pos = current_pos; \
20176 min_bpos = current_bpos; \
20178 if (IT_CHARPOS (*it) > max_pos) \
20180 max_pos = IT_CHARPOS (*it); \
20181 max_bpos = IT_BYTEPOS (*it); \
20186 /* Loop generating characters. The loop is left with IT on the next
20187 character to display. */
20190 int n_glyphs_before
, hpos_before
, x_before
;
20192 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20194 /* Retrieve the next thing to display. Value is zero if end of
20196 if (!get_next_display_element (it
))
20198 /* Maybe add a space at the end of this line that is used to
20199 display the cursor there under X. Set the charpos of the
20200 first glyph of blank lines not corresponding to any text
20202 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20203 row
->exact_window_width_line_p
= 1;
20204 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
20205 || row
->used
[TEXT_AREA
] == 0)
20207 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20208 row
->displays_text_p
= 0;
20210 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20211 && (!MINI_WINDOW_P (it
->w
)
20212 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20213 row
->indicate_empty_line_p
= 1;
20216 it
->continuation_lines_width
= 0;
20217 row
->ends_at_zv_p
= 1;
20218 /* A row that displays right-to-left text must always have
20219 its last face extended all the way to the end of line,
20220 even if this row ends in ZV, because we still write to
20221 the screen left to right. We also need to extend the
20222 last face if the default face is remapped to some
20223 different face, otherwise the functions that clear
20224 portions of the screen will clear with the default face's
20225 background color. */
20226 if (row
->reversed_p
20227 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20228 extend_face_to_end_of_line (it
);
20232 /* Now, get the metrics of what we want to display. This also
20233 generates glyphs in `row' (which is IT->glyph_row). */
20234 n_glyphs_before
= row
->used
[TEXT_AREA
];
20237 /* Remember the line height so far in case the next element doesn't
20238 fit on the line. */
20239 if (it
->line_wrap
!= TRUNCATE
)
20241 ascent
= it
->max_ascent
;
20242 descent
= it
->max_descent
;
20243 phys_ascent
= it
->max_phys_ascent
;
20244 phys_descent
= it
->max_phys_descent
;
20246 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20248 if (IT_DISPLAYING_WHITESPACE (it
))
20252 SAVE_IT (wrap_it
, *it
, wrap_data
);
20254 wrap_row_used
= row
->used
[TEXT_AREA
];
20255 wrap_row_ascent
= row
->ascent
;
20256 wrap_row_height
= row
->height
;
20257 wrap_row_phys_ascent
= row
->phys_ascent
;
20258 wrap_row_phys_height
= row
->phys_height
;
20259 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20260 wrap_row_min_pos
= min_pos
;
20261 wrap_row_min_bpos
= min_bpos
;
20262 wrap_row_max_pos
= max_pos
;
20263 wrap_row_max_bpos
= max_bpos
;
20269 PRODUCE_GLYPHS (it
);
20271 /* If this display element was in marginal areas, continue with
20273 if (it
->area
!= TEXT_AREA
)
20275 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20276 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20277 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20278 row
->phys_height
= max (row
->phys_height
,
20279 it
->max_phys_ascent
+ it
->max_phys_descent
);
20280 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20281 it
->max_extra_line_spacing
);
20282 set_iterator_to_next (it
, 1);
20283 /* If we didn't handle the line/wrap prefix above, and the
20284 call to set_iterator_to_next just switched to TEXT_AREA,
20285 process the prefix now. */
20286 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20288 pending_handle_line_prefix
= false;
20289 handle_line_prefix (it
);
20294 /* Does the display element fit on the line? If we truncate
20295 lines, we should draw past the right edge of the window. If
20296 we don't truncate, we want to stop so that we can display the
20297 continuation glyph before the right margin. If lines are
20298 continued, there are two possible strategies for characters
20299 resulting in more than 1 glyph (e.g. tabs): Display as many
20300 glyphs as possible in this line and leave the rest for the
20301 continuation line, or display the whole element in the next
20302 line. Original redisplay did the former, so we do it also. */
20303 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20304 hpos_before
= it
->hpos
;
20307 if (/* Not a newline. */
20309 /* Glyphs produced fit entirely in the line. */
20310 && it
->current_x
< it
->last_visible_x
)
20312 it
->hpos
+= nglyphs
;
20313 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20314 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20315 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20316 row
->phys_height
= max (row
->phys_height
,
20317 it
->max_phys_ascent
+ it
->max_phys_descent
);
20318 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20319 it
->max_extra_line_spacing
);
20320 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20321 /* In R2L rows, we arrange in extend_face_to_end_of_line
20322 to add a right offset to the line, by a suitable
20323 change to the stretch glyph that is the leftmost
20324 glyph of the line. */
20325 && !row
->reversed_p
)
20326 row
->x
= x
- it
->first_visible_x
;
20327 /* Record the maximum and minimum buffer positions seen so
20328 far in glyphs that will be displayed by this row. */
20330 RECORD_MAX_MIN_POS (it
);
20335 struct glyph
*glyph
;
20337 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20339 /* Identify the glyphs added by the last call to
20340 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20341 the previous glyphs. */
20342 if (!row
->reversed_p
)
20343 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20345 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20346 new_x
= x
+ glyph
->pixel_width
;
20348 if (/* Lines are continued. */
20349 it
->line_wrap
!= TRUNCATE
20350 && (/* Glyph doesn't fit on the line. */
20351 new_x
> it
->last_visible_x
20352 /* Or it fits exactly on a window system frame. */
20353 || (new_x
== it
->last_visible_x
20354 && FRAME_WINDOW_P (it
->f
)
20355 && (row
->reversed_p
20356 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20357 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20359 /* End of a continued line. */
20362 || (new_x
== it
->last_visible_x
20363 && FRAME_WINDOW_P (it
->f
)
20364 && (row
->reversed_p
20365 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20366 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20368 /* Current glyph is the only one on the line or
20369 fits exactly on the line. We must continue
20370 the line because we can't draw the cursor
20371 after the glyph. */
20372 row
->continued_p
= 1;
20373 it
->current_x
= new_x
;
20374 it
->continuation_lines_width
+= new_x
;
20376 if (i
== nglyphs
- 1)
20378 /* If line-wrap is on, check if a previous
20379 wrap point was found. */
20380 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
20381 && wrap_row_used
> 0
20382 /* Even if there is a previous wrap
20383 point, continue the line here as
20384 usual, if (i) the previous character
20385 was a space or tab AND (ii) the
20386 current character is not. */
20388 || IT_DISPLAYING_WHITESPACE (it
)))
20391 /* Record the maximum and minimum buffer
20392 positions seen so far in glyphs that will be
20393 displayed by this row. */
20395 RECORD_MAX_MIN_POS (it
);
20396 set_iterator_to_next (it
, 1);
20397 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20399 if (!get_next_display_element (it
))
20401 row
->exact_window_width_line_p
= 1;
20402 it
->continuation_lines_width
= 0;
20403 row
->continued_p
= 0;
20404 row
->ends_at_zv_p
= 1;
20406 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20408 row
->continued_p
= 0;
20409 row
->exact_window_width_line_p
= 1;
20411 /* If line-wrap is on, check if a
20412 previous wrap point was found. */
20413 else if (wrap_row_used
> 0
20414 /* Even if there is a previous wrap
20415 point, continue the line here as
20416 usual, if (i) the previous character
20417 was a space or tab AND (ii) the
20418 current character is not. */
20420 || IT_DISPLAYING_WHITESPACE (it
)))
20425 else if (it
->bidi_p
)
20426 RECORD_MAX_MIN_POS (it
);
20427 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20428 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20429 extend_face_to_end_of_line (it
);
20431 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20432 && !FRAME_WINDOW_P (it
->f
))
20434 /* A padding glyph that doesn't fit on this line.
20435 This means the whole character doesn't fit
20437 if (row
->reversed_p
)
20438 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20439 - n_glyphs_before
);
20440 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20442 /* Fill the rest of the row with continuation
20443 glyphs like in 20.x. */
20444 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20445 < row
->glyphs
[1 + TEXT_AREA
])
20446 produce_special_glyphs (it
, IT_CONTINUATION
);
20448 row
->continued_p
= 1;
20449 it
->current_x
= x_before
;
20450 it
->continuation_lines_width
+= x_before
;
20452 /* Restore the height to what it was before the
20453 element not fitting on the line. */
20454 it
->max_ascent
= ascent
;
20455 it
->max_descent
= descent
;
20456 it
->max_phys_ascent
= phys_ascent
;
20457 it
->max_phys_descent
= phys_descent
;
20458 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20459 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20460 extend_face_to_end_of_line (it
);
20462 else if (wrap_row_used
> 0)
20465 if (row
->reversed_p
)
20466 unproduce_glyphs (it
,
20467 row
->used
[TEXT_AREA
] - wrap_row_used
);
20468 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20469 it
->continuation_lines_width
+= wrap_x
;
20470 row
->used
[TEXT_AREA
] = wrap_row_used
;
20471 row
->ascent
= wrap_row_ascent
;
20472 row
->height
= wrap_row_height
;
20473 row
->phys_ascent
= wrap_row_phys_ascent
;
20474 row
->phys_height
= wrap_row_phys_height
;
20475 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20476 min_pos
= wrap_row_min_pos
;
20477 min_bpos
= wrap_row_min_bpos
;
20478 max_pos
= wrap_row_max_pos
;
20479 max_bpos
= wrap_row_max_bpos
;
20480 row
->continued_p
= 1;
20481 row
->ends_at_zv_p
= 0;
20482 row
->exact_window_width_line_p
= 0;
20483 it
->continuation_lines_width
+= x
;
20485 /* Make sure that a non-default face is extended
20486 up to the right margin of the window. */
20487 extend_face_to_end_of_line (it
);
20489 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20491 /* A TAB that extends past the right edge of the
20492 window. This produces a single glyph on
20493 window system frames. We leave the glyph in
20494 this row and let it fill the row, but don't
20495 consume the TAB. */
20496 if ((row
->reversed_p
20497 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20498 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20499 produce_special_glyphs (it
, IT_CONTINUATION
);
20500 it
->continuation_lines_width
+= it
->last_visible_x
;
20501 row
->ends_in_middle_of_char_p
= 1;
20502 row
->continued_p
= 1;
20503 glyph
->pixel_width
= it
->last_visible_x
- x
;
20504 it
->starts_in_middle_of_char_p
= 1;
20505 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20506 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20507 extend_face_to_end_of_line (it
);
20511 /* Something other than a TAB that draws past
20512 the right edge of the window. Restore
20513 positions to values before the element. */
20514 if (row
->reversed_p
)
20515 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20516 - (n_glyphs_before
+ i
));
20517 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20519 /* Display continuation glyphs. */
20520 it
->current_x
= x_before
;
20521 it
->continuation_lines_width
+= x
;
20522 if (!FRAME_WINDOW_P (it
->f
)
20523 || (row
->reversed_p
20524 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20525 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20526 produce_special_glyphs (it
, IT_CONTINUATION
);
20527 row
->continued_p
= 1;
20529 extend_face_to_end_of_line (it
);
20531 if (nglyphs
> 1 && i
> 0)
20533 row
->ends_in_middle_of_char_p
= 1;
20534 it
->starts_in_middle_of_char_p
= 1;
20537 /* Restore the height to what it was before the
20538 element not fitting on the line. */
20539 it
->max_ascent
= ascent
;
20540 it
->max_descent
= descent
;
20541 it
->max_phys_ascent
= phys_ascent
;
20542 it
->max_phys_descent
= phys_descent
;
20547 else if (new_x
> it
->first_visible_x
)
20549 /* Increment number of glyphs actually displayed. */
20552 /* Record the maximum and minimum buffer positions
20553 seen so far in glyphs that will be displayed by
20556 RECORD_MAX_MIN_POS (it
);
20558 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20559 /* Glyph is partially visible, i.e. row starts at
20560 negative X position. Don't do that in R2L
20561 rows, where we arrange to add a right offset to
20562 the line in extend_face_to_end_of_line, by a
20563 suitable change to the stretch glyph that is
20564 the leftmost glyph of the line. */
20565 row
->x
= x
- it
->first_visible_x
;
20566 /* When the last glyph of an R2L row only fits
20567 partially on the line, we need to set row->x to a
20568 negative offset, so that the leftmost glyph is
20569 the one that is partially visible. But if we are
20570 going to produce the truncation glyph, this will
20571 be taken care of in produce_special_glyphs. */
20572 if (row
->reversed_p
20573 && new_x
> it
->last_visible_x
20574 && !(it
->line_wrap
== TRUNCATE
20575 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20577 eassert (FRAME_WINDOW_P (it
->f
));
20578 row
->x
= it
->last_visible_x
- new_x
;
20583 /* Glyph is completely off the left margin of the
20584 window. This should not happen because of the
20585 move_it_in_display_line at the start of this
20586 function, unless the text display area of the
20587 window is empty. */
20588 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20591 /* Even if this display element produced no glyphs at all,
20592 we want to record its position. */
20593 if (it
->bidi_p
&& nglyphs
== 0)
20594 RECORD_MAX_MIN_POS (it
);
20596 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20597 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20598 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20599 row
->phys_height
= max (row
->phys_height
,
20600 it
->max_phys_ascent
+ it
->max_phys_descent
);
20601 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20602 it
->max_extra_line_spacing
);
20604 /* End of this display line if row is continued. */
20605 if (row
->continued_p
|| row
->ends_at_zv_p
)
20610 /* Is this a line end? If yes, we're also done, after making
20611 sure that a non-default face is extended up to the right
20612 margin of the window. */
20613 if (ITERATOR_AT_END_OF_LINE_P (it
))
20615 int used_before
= row
->used
[TEXT_AREA
];
20617 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20619 /* Add a space at the end of the line that is used to
20620 display the cursor there. */
20621 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20622 append_space_for_newline (it
, 0);
20624 /* Extend the face to the end of the line. */
20625 extend_face_to_end_of_line (it
);
20627 /* Make sure we have the position. */
20628 if (used_before
== 0)
20629 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20631 /* Record the position of the newline, for use in
20633 it
->eol_pos
= it
->current
.pos
;
20635 /* Consume the line end. This skips over invisible lines. */
20636 set_iterator_to_next (it
, 1);
20637 it
->continuation_lines_width
= 0;
20641 /* Proceed with next display element. Note that this skips
20642 over lines invisible because of selective display. */
20643 set_iterator_to_next (it
, 1);
20645 /* If we truncate lines, we are done when the last displayed
20646 glyphs reach past the right margin of the window. */
20647 if (it
->line_wrap
== TRUNCATE
20648 && ((FRAME_WINDOW_P (it
->f
)
20649 /* Images are preprocessed in produce_image_glyph such
20650 that they are cropped at the right edge of the
20651 window, so an image glyph will always end exactly at
20652 last_visible_x, even if there's no right fringe. */
20653 && ((row
->reversed_p
20654 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20655 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20656 || it
->what
== IT_IMAGE
))
20657 ? (it
->current_x
>= it
->last_visible_x
)
20658 : (it
->current_x
> it
->last_visible_x
)))
20660 /* Maybe add truncation glyphs. */
20661 if (!FRAME_WINDOW_P (it
->f
)
20662 || (row
->reversed_p
20663 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20664 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20668 if (!row
->reversed_p
)
20670 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20671 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20676 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20677 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20679 /* Remove any padding glyphs at the front of ROW, to
20680 make room for the truncation glyphs we will be
20681 adding below. The loop below always inserts at
20682 least one truncation glyph, so also remove the
20683 last glyph added to ROW. */
20684 unproduce_glyphs (it
, i
+ 1);
20685 /* Adjust i for the loop below. */
20686 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20689 /* produce_special_glyphs overwrites the last glyph, so
20690 we don't want that if we want to keep that last
20691 glyph, which means it's an image. */
20692 if (it
->current_x
> it
->last_visible_x
)
20694 it
->current_x
= x_before
;
20695 if (!FRAME_WINDOW_P (it
->f
))
20697 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20699 row
->used
[TEXT_AREA
] = i
;
20700 produce_special_glyphs (it
, IT_TRUNCATION
);
20705 row
->used
[TEXT_AREA
] = i
;
20706 produce_special_glyphs (it
, IT_TRUNCATION
);
20708 it
->hpos
= hpos_before
;
20711 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20713 /* Don't truncate if we can overflow newline into fringe. */
20714 if (!get_next_display_element (it
))
20716 it
->continuation_lines_width
= 0;
20717 row
->ends_at_zv_p
= 1;
20718 row
->exact_window_width_line_p
= 1;
20721 if (ITERATOR_AT_END_OF_LINE_P (it
))
20723 row
->exact_window_width_line_p
= 1;
20724 goto at_end_of_line
;
20726 it
->current_x
= x_before
;
20727 it
->hpos
= hpos_before
;
20730 row
->truncated_on_right_p
= 1;
20731 it
->continuation_lines_width
= 0;
20732 reseat_at_next_visible_line_start (it
, 0);
20733 /* We insist below that IT's position be at ZV because in
20734 bidi-reordered lines the character at visible line start
20735 might not be the character that follows the newline in
20736 the logical order. */
20737 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
20738 row
->ends_at_zv_p
=
20739 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
20741 row
->ends_at_zv_p
= false;
20747 bidi_unshelve_cache (wrap_data
, 1);
20749 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20750 at the left window margin. */
20751 if (it
->first_visible_x
20752 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20754 if (!FRAME_WINDOW_P (it
->f
)
20755 || (((row
->reversed_p
20756 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20757 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20758 /* Don't let insert_left_trunc_glyphs overwrite the
20759 first glyph of the row if it is an image. */
20760 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20761 insert_left_trunc_glyphs (it
);
20762 row
->truncated_on_left_p
= 1;
20765 /* Remember the position at which this line ends.
20767 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20768 cannot be before the call to find_row_edges below, since that is
20769 where these positions are determined. */
20770 row
->end
= it
->current
;
20773 row
->minpos
= row
->start
.pos
;
20774 row
->maxpos
= row
->end
.pos
;
20778 /* ROW->minpos and ROW->maxpos must be the smallest and
20779 `1 + the largest' buffer positions in ROW. But if ROW was
20780 bidi-reordered, these two positions can be anywhere in the
20781 row, so we must determine them now. */
20782 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20785 /* If the start of this line is the overlay arrow-position, then
20786 mark this glyph row as the one containing the overlay arrow.
20787 This is clearly a mess with variable size fonts. It would be
20788 better to let it be displayed like cursors under X. */
20789 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20790 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20791 !NILP (overlay_arrow_string
)))
20793 /* Overlay arrow in window redisplay is a fringe bitmap. */
20794 if (STRINGP (overlay_arrow_string
))
20796 struct glyph_row
*arrow_row
20797 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20798 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20799 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20800 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20801 struct glyph
*p2
, *end
;
20803 /* Copy the arrow glyphs. */
20804 while (glyph
< arrow_end
)
20807 /* Throw away padding glyphs. */
20809 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20810 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20816 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20821 eassert (INTEGERP (overlay_arrow_string
));
20822 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20824 overlay_arrow_seen
= 1;
20827 /* Highlight trailing whitespace. */
20828 if (!NILP (Vshow_trailing_whitespace
))
20829 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20831 /* Compute pixel dimensions of this line. */
20832 compute_line_metrics (it
);
20834 /* Implementation note: No changes in the glyphs of ROW or in their
20835 faces can be done past this point, because compute_line_metrics
20836 computes ROW's hash value and stores it within the glyph_row
20839 /* Record whether this row ends inside an ellipsis. */
20840 row
->ends_in_ellipsis_p
20841 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20842 && it
->ellipsis_p
);
20844 /* Save fringe bitmaps in this row. */
20845 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20846 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20847 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20848 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20850 it
->left_user_fringe_bitmap
= 0;
20851 it
->left_user_fringe_face_id
= 0;
20852 it
->right_user_fringe_bitmap
= 0;
20853 it
->right_user_fringe_face_id
= 0;
20855 /* Maybe set the cursor. */
20856 cvpos
= it
->w
->cursor
.vpos
;
20858 /* In bidi-reordered rows, keep checking for proper cursor
20859 position even if one has been found already, because buffer
20860 positions in such rows change non-linearly with ROW->VPOS,
20861 when a line is continued. One exception: when we are at ZV,
20862 display cursor on the first suitable glyph row, since all
20863 the empty rows after that also have their position set to ZV. */
20864 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20865 lines' rows is implemented for bidi-reordered rows. */
20867 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20868 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20869 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20870 && cursor_row_p (row
))
20871 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20873 /* Prepare for the next line. This line starts horizontally at (X
20874 HPOS) = (0 0). Vertical positions are incremented. As a
20875 convenience for the caller, IT->glyph_row is set to the next
20877 it
->current_x
= it
->hpos
= 0;
20878 it
->current_y
+= row
->height
;
20879 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20882 /* The next row should by default use the same value of the
20883 reversed_p flag as this one. set_iterator_to_next decides when
20884 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20885 the flag accordingly. */
20886 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20887 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20888 it
->start
= row
->end
;
20889 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20891 #undef RECORD_MAX_MIN_POS
20894 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20895 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20896 doc
: /* Return paragraph direction at point in BUFFER.
20897 Value is either `left-to-right' or `right-to-left'.
20898 If BUFFER is omitted or nil, it defaults to the current buffer.
20900 Paragraph direction determines how the text in the paragraph is displayed.
20901 In left-to-right paragraphs, text begins at the left margin of the window
20902 and the reading direction is generally left to right. In right-to-left
20903 paragraphs, text begins at the right margin and is read from right to left.
20905 See also `bidi-paragraph-direction'. */)
20906 (Lisp_Object buffer
)
20908 struct buffer
*buf
= current_buffer
;
20909 struct buffer
*old
= buf
;
20911 if (! NILP (buffer
))
20913 CHECK_BUFFER (buffer
);
20914 buf
= XBUFFER (buffer
);
20917 if (NILP (BVAR (buf
, bidi_display_reordering
))
20918 || NILP (BVAR (buf
, enable_multibyte_characters
))
20919 /* When we are loading loadup.el, the character property tables
20920 needed for bidi iteration are not yet available. */
20921 || !NILP (Vpurify_flag
))
20922 return Qleft_to_right
;
20923 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20924 return BVAR (buf
, bidi_paragraph_direction
);
20927 /* Determine the direction from buffer text. We could try to
20928 use current_matrix if it is up to date, but this seems fast
20929 enough as it is. */
20930 struct bidi_it itb
;
20931 ptrdiff_t pos
= BUF_PT (buf
);
20932 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20934 void *itb_data
= bidi_shelve_cache ();
20936 set_buffer_temp (buf
);
20937 /* bidi_paragraph_init finds the base direction of the paragraph
20938 by searching forward from paragraph start. We need the base
20939 direction of the current or _previous_ paragraph, so we need
20940 to make sure we are within that paragraph. To that end, find
20941 the previous non-empty line. */
20942 if (pos
>= ZV
&& pos
> BEGV
)
20943 DEC_BOTH (pos
, bytepos
);
20944 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20945 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20947 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20948 || c
== ' ' || c
== '\t' || c
== '\f')
20950 if (bytepos
<= BEGV_BYTE
)
20955 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20958 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20959 itb
.paragraph_dir
= NEUTRAL_DIR
;
20960 itb
.string
.s
= NULL
;
20961 itb
.string
.lstring
= Qnil
;
20962 itb
.string
.bufpos
= 0;
20963 itb
.string
.from_disp_str
= 0;
20964 itb
.string
.unibyte
= 0;
20965 /* We have no window to use here for ignoring window-specific
20966 overlays. Using NULL for window pointer will cause
20967 compute_display_string_pos to use the current buffer. */
20969 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20970 bidi_unshelve_cache (itb_data
, 0);
20971 set_buffer_temp (old
);
20972 switch (itb
.paragraph_dir
)
20975 return Qleft_to_right
;
20978 return Qright_to_left
;
20986 DEFUN ("move-point-visually", Fmove_point_visually
,
20987 Smove_point_visually
, 1, 1, 0,
20988 doc
: /* Move point in the visual order in the specified DIRECTION.
20989 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
20992 Value is the new character position of point. */)
20993 (Lisp_Object direction
)
20995 struct window
*w
= XWINDOW (selected_window
);
20996 struct buffer
*b
= XBUFFER (w
->contents
);
20997 struct glyph_row
*row
;
20999 Lisp_Object paragraph_dir
;
21001 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21002 (!(ROW)->continued_p \
21003 && INTEGERP ((GLYPH)->object) \
21004 && (GLYPH)->type == CHAR_GLYPH \
21005 && (GLYPH)->u.ch == ' ' \
21006 && (GLYPH)->charpos >= 0 \
21007 && !(GLYPH)->avoid_cursor_p)
21009 CHECK_NUMBER (direction
);
21010 dir
= XINT (direction
);
21016 /* If current matrix is up-to-date, we can use the information
21017 recorded in the glyphs, at least as long as the goal is on the
21019 if (w
->window_end_valid
21020 && !windows_or_buffers_changed
21022 && !b
->clip_changed
21023 && !b
->prevent_redisplay_optimizations_p
21024 && !window_outdated (w
)
21025 /* We rely below on the cursor coordinates to be up to date, but
21026 we cannot trust them if some command moved point since the
21027 last complete redisplay. */
21028 && w
->last_point
== BUF_PT (b
)
21029 && w
->cursor
.vpos
>= 0
21030 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21031 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21033 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21034 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21035 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21037 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21039 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21041 SET_PT (g
->charpos
);
21042 w
->cursor
.vpos
= -1;
21043 return make_number (PT
);
21045 else if (!INTEGERP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21049 if (BUFFERP (gpt
->object
))
21052 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21053 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21055 new_pos
-= (row
->reversed_p
? -dir
: dir
);;
21057 else if (BUFFERP (g
->object
))
21058 new_pos
= g
->charpos
;
21062 w
->cursor
.vpos
= -1;
21063 return make_number (PT
);
21065 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21067 /* Glyphs inserted at the end of a non-empty line for
21068 positioning the cursor have zero charpos, so we must
21069 deduce the value of point by other means. */
21070 if (g
->charpos
> 0)
21071 SET_PT (g
->charpos
);
21072 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21074 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21075 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21078 w
->cursor
.vpos
= -1;
21079 return make_number (PT
);
21082 if (g
== e
|| INTEGERP (g
->object
))
21084 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21085 goto simulate_display
;
21086 if (!row
->reversed_p
)
21090 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21091 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21092 goto simulate_display
;
21096 if (row
->reversed_p
&& !row
->continued_p
)
21098 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21099 w
->cursor
.vpos
= -1;
21100 return make_number (PT
);
21102 g
= row
->glyphs
[TEXT_AREA
];
21103 e
= g
+ row
->used
[TEXT_AREA
];
21104 for ( ; g
< e
; g
++)
21106 if (BUFFERP (g
->object
)
21107 /* Empty lines have only one glyph, which stands
21108 for the newline, and whose charpos is the
21109 buffer position of the newline. */
21110 || ROW_GLYPH_NEWLINE_P (row
, g
)
21111 /* When the buffer ends in a newline, the line at
21112 EOB also has one glyph, but its charpos is -1. */
21113 || (row
->ends_at_zv_p
21114 && !row
->reversed_p
21115 && INTEGERP (g
->object
)
21116 && g
->type
== CHAR_GLYPH
21117 && g
->u
.ch
== ' '))
21119 if (g
->charpos
> 0)
21120 SET_PT (g
->charpos
);
21121 else if (!row
->reversed_p
21122 && row
->ends_at_zv_p
21127 w
->cursor
.vpos
= -1;
21128 return make_number (PT
);
21134 if (!row
->reversed_p
&& !row
->continued_p
)
21136 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21137 w
->cursor
.vpos
= -1;
21138 return make_number (PT
);
21140 e
= row
->glyphs
[TEXT_AREA
];
21141 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21142 for ( ; g
>= e
; g
--)
21144 if (BUFFERP (g
->object
)
21145 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21147 /* Empty R2L lines on GUI frames have the buffer
21148 position of the newline stored in the stretch
21150 || g
->type
== STRETCH_GLYPH
21151 || (row
->ends_at_zv_p
21153 && INTEGERP (g
->object
)
21154 && g
->type
== CHAR_GLYPH
21155 && g
->u
.ch
== ' '))
21157 if (g
->charpos
> 0)
21158 SET_PT (g
->charpos
);
21159 else if (row
->reversed_p
21160 && row
->ends_at_zv_p
21165 w
->cursor
.vpos
= -1;
21166 return make_number (PT
);
21175 /* If we wind up here, we failed to move by using the glyphs, so we
21176 need to simulate display instead. */
21179 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21181 paragraph_dir
= Qleft_to_right
;
21182 if (EQ (paragraph_dir
, Qright_to_left
))
21184 if (PT
<= BEGV
&& dir
< 0)
21185 xsignal0 (Qbeginning_of_buffer
);
21186 else if (PT
>= ZV
&& dir
> 0)
21187 xsignal0 (Qend_of_buffer
);
21190 struct text_pos pt
;
21192 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21194 bool overshoot_expected
= false;
21195 bool target_is_eol_p
= false;
21197 /* Setup the arena. */
21198 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21199 start_display (&it
, w
, pt
);
21201 if (it
.cmp_it
.id
< 0
21202 && it
.method
== GET_FROM_STRING
21203 && it
.area
== TEXT_AREA
21204 && it
.string_from_display_prop_p
21205 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21206 overshoot_expected
= true;
21208 /* Find the X coordinate of point. We start from the beginning
21209 of this or previous line to make sure we are before point in
21210 the logical order (since the move_it_* functions can only
21213 reseat_at_previous_visible_line_start (&it
);
21214 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21215 if (IT_CHARPOS (it
) != PT
)
21217 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21218 -1, -1, -1, MOVE_TO_POS
);
21219 /* If we missed point because the character there is
21220 displayed out of a display vector that has more than one
21221 glyph, retry expecting overshoot. */
21222 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21223 && it
.current
.dpvec_index
> 0
21224 && !overshoot_expected
)
21226 overshoot_expected
= true;
21229 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21230 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21232 pt_x
= it
.current_x
;
21234 if (dir
> 0 || overshoot_expected
)
21236 struct glyph_row
*row
= it
.glyph_row
;
21238 /* When point is at beginning of line, we don't have
21239 information about the glyph there loaded into struct
21240 it. Calling get_next_display_element fixes that. */
21242 get_next_display_element (&it
);
21243 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21244 it
.glyph_row
= NULL
;
21245 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21246 it
.glyph_row
= row
;
21247 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21248 it, lest it will become out of sync with it's buffer
21250 it
.current_x
= pt_x
;
21253 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21254 pixel_width
= it
.pixel_width
;
21255 if (overshoot_expected
&& at_eol_p
)
21257 else if (pixel_width
<= 0)
21260 /* If there's a display string (or something similar) at point,
21261 we are actually at the glyph to the left of point, so we need
21262 to correct the X coordinate. */
21263 if (overshoot_expected
)
21266 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21268 pt_x
+= pixel_width
;
21271 /* Compute target X coordinate, either to the left or to the
21272 right of point. On TTY frames, all characters have the same
21273 pixel width of 1, so we can use that. On GUI frames we don't
21274 have an easy way of getting at the pixel width of the
21275 character to the left of point, so we use a different method
21276 of getting to that place. */
21278 target_x
= pt_x
+ pixel_width
;
21280 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21282 /* Target X coordinate could be one line above or below the line
21283 of point, in which case we need to adjust the target X
21284 coordinate. Also, if moving to the left, we need to begin at
21285 the left edge of the point's screen line. */
21290 start_display (&it
, w
, pt
);
21291 reseat_at_previous_visible_line_start (&it
);
21292 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21294 move_it_by_lines (&it
, pt_vpos
);
21298 move_it_by_lines (&it
, -1);
21299 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21300 target_is_eol_p
= true;
21301 /* Under word-wrap, we don't know the x coordinate of
21302 the last character displayed on the previous line,
21303 which immediately precedes the wrap point. To find
21304 out its x coordinate, we try moving to the right
21305 margin of the window, which will stop at the wrap
21306 point, and then reset target_x to point at the
21307 character that precedes the wrap point. This is not
21308 needed on GUI frames, because (see below) there we
21309 move from the left margin one grapheme cluster at a
21310 time, and stop when we hit the wrap point. */
21311 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21313 void *it_data
= NULL
;
21316 SAVE_IT (it2
, it
, it_data
);
21317 move_it_in_display_line_to (&it
, ZV
, target_x
,
21318 MOVE_TO_POS
| MOVE_TO_X
);
21319 /* If we arrived at target_x, that _is_ the last
21320 character on the previous line. */
21321 if (it
.current_x
!= target_x
)
21322 target_x
= it
.current_x
- 1;
21323 RESTORE_IT (&it
, &it2
, it_data
);
21330 || (target_x
>= it
.last_visible_x
21331 && it
.line_wrap
!= TRUNCATE
))
21334 move_it_by_lines (&it
, 0);
21335 move_it_by_lines (&it
, 1);
21340 /* Move to the target X coordinate. */
21341 #ifdef HAVE_WINDOW_SYSTEM
21342 /* On GUI frames, as we don't know the X coordinate of the
21343 character to the left of point, moving point to the left
21344 requires walking, one grapheme cluster at a time, until we
21345 find ourself at a place immediately to the left of the
21346 character at point. */
21347 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21349 struct text_pos new_pos
;
21350 enum move_it_result rc
= MOVE_X_REACHED
;
21352 if (it
.current_x
== 0)
21353 get_next_display_element (&it
);
21354 if (it
.what
== IT_COMPOSITION
)
21356 new_pos
.charpos
= it
.cmp_it
.charpos
;
21357 new_pos
.bytepos
= -1;
21360 new_pos
= it
.current
.pos
;
21362 while (it
.current_x
+ it
.pixel_width
<= target_x
21363 && (rc
== MOVE_X_REACHED
21364 /* Under word-wrap, move_it_in_display_line_to
21365 stops at correct coordinates, but sometimes
21366 returns MOVE_POS_MATCH_OR_ZV. */
21367 || (it
.line_wrap
== WORD_WRAP
21368 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21370 int new_x
= it
.current_x
+ it
.pixel_width
;
21372 /* For composed characters, we want the position of the
21373 first character in the grapheme cluster (usually, the
21374 composition's base character), whereas it.current
21375 might give us the position of the _last_ one, e.g. if
21376 the composition is rendered in reverse due to bidi
21378 if (it
.what
== IT_COMPOSITION
)
21380 new_pos
.charpos
= it
.cmp_it
.charpos
;
21381 new_pos
.bytepos
= -1;
21384 new_pos
= it
.current
.pos
;
21385 if (new_x
== it
.current_x
)
21387 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21388 MOVE_TO_POS
| MOVE_TO_X
);
21389 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21392 /* The previous position we saw in the loop is the one we
21394 if (new_pos
.bytepos
== -1)
21395 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21396 it
.current
.pos
= new_pos
;
21400 if (it
.current_x
!= target_x
)
21401 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21403 /* When lines are truncated, the above loop will stop at the
21404 window edge. But we want to get to the end of line, even if
21405 it is beyond the window edge; automatic hscroll will then
21406 scroll the window to show point as appropriate. */
21407 if (target_is_eol_p
&& it
.line_wrap
== TRUNCATE
21408 && get_next_display_element (&it
))
21410 struct text_pos new_pos
= it
.current
.pos
;
21412 while (!ITERATOR_AT_END_OF_LINE_P (&it
))
21414 set_iterator_to_next (&it
, 0);
21415 if (it
.method
== GET_FROM_BUFFER
)
21416 new_pos
= it
.current
.pos
;
21417 if (!get_next_display_element (&it
))
21421 it
.current
.pos
= new_pos
;
21424 /* If we ended up in a display string that covers point, move to
21425 buffer position to the right in the visual order. */
21428 while (IT_CHARPOS (it
) == PT
)
21430 set_iterator_to_next (&it
, 0);
21431 if (!get_next_display_element (&it
))
21436 /* Move point to that position. */
21437 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21440 return make_number (PT
);
21442 #undef ROW_GLYPH_NEWLINE_P
21446 /***********************************************************************
21448 ***********************************************************************/
21450 /* Redisplay the menu bar in the frame for window W.
21452 The menu bar of X frames that don't have X toolkit support is
21453 displayed in a special window W->frame->menu_bar_window.
21455 The menu bar of terminal frames is treated specially as far as
21456 glyph matrices are concerned. Menu bar lines are not part of
21457 windows, so the update is done directly on the frame matrix rows
21458 for the menu bar. */
21461 display_menu_bar (struct window
*w
)
21463 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21468 /* Don't do all this for graphical frames. */
21470 if (FRAME_W32_P (f
))
21473 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21479 if (FRAME_NS_P (f
))
21481 #endif /* HAVE_NS */
21483 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21484 eassert (!FRAME_WINDOW_P (f
));
21485 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21486 it
.first_visible_x
= 0;
21487 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21488 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21489 if (FRAME_WINDOW_P (f
))
21491 /* Menu bar lines are displayed in the desired matrix of the
21492 dummy window menu_bar_window. */
21493 struct window
*menu_w
;
21494 menu_w
= XWINDOW (f
->menu_bar_window
);
21495 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21497 it
.first_visible_x
= 0;
21498 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21501 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21503 /* This is a TTY frame, i.e. character hpos/vpos are used as
21505 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21507 it
.first_visible_x
= 0;
21508 it
.last_visible_x
= FRAME_COLS (f
);
21511 /* FIXME: This should be controlled by a user option. See the
21512 comments in redisplay_tool_bar and display_mode_line about
21514 it
.paragraph_embedding
= L2R
;
21516 /* Clear all rows of the menu bar. */
21517 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21519 struct glyph_row
*row
= it
.glyph_row
+ i
;
21520 clear_glyph_row (row
);
21521 row
->enabled_p
= true;
21522 row
->full_width_p
= 1;
21525 /* Display all items of the menu bar. */
21526 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21527 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21529 Lisp_Object string
;
21531 /* Stop at nil string. */
21532 string
= AREF (items
, i
+ 1);
21536 /* Remember where item was displayed. */
21537 ASET (items
, i
+ 3, make_number (it
.hpos
));
21539 /* Display the item, pad with one space. */
21540 if (it
.current_x
< it
.last_visible_x
)
21541 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21542 SCHARS (string
) + 1, 0, 0, -1);
21545 /* Fill out the line with spaces. */
21546 if (it
.current_x
< it
.last_visible_x
)
21547 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21549 /* Compute the total height of the lines. */
21550 compute_line_metrics (&it
);
21553 /* Deep copy of a glyph row, including the glyphs. */
21555 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21557 struct glyph
*pointers
[1 + LAST_AREA
];
21558 int to_used
= to
->used
[TEXT_AREA
];
21560 /* Save glyph pointers of TO. */
21561 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21563 /* Do a structure assignment. */
21566 /* Restore original glyph pointers of TO. */
21567 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21569 /* Copy the glyphs. */
21570 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21571 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21573 /* If we filled only part of the TO row, fill the rest with
21574 space_glyph (which will display as empty space). */
21575 if (to_used
> from
->used
[TEXT_AREA
])
21576 fill_up_frame_row_with_spaces (to
, to_used
);
21579 /* Display one menu item on a TTY, by overwriting the glyphs in the
21580 frame F's desired glyph matrix with glyphs produced from the menu
21581 item text. Called from term.c to display TTY drop-down menus one
21584 ITEM_TEXT is the menu item text as a C string.
21586 FACE_ID is the face ID to be used for this menu item. FACE_ID
21587 could specify one of 3 faces: a face for an enabled item, a face
21588 for a disabled item, or a face for a selected item.
21590 X and Y are coordinates of the first glyph in the frame's desired
21591 matrix to be overwritten by the menu item. Since this is a TTY, Y
21592 is the zero-based number of the glyph row and X is the zero-based
21593 glyph number in the row, starting from left, where to start
21594 displaying the item.
21596 SUBMENU non-zero means this menu item drops down a submenu, which
21597 should be indicated by displaying a proper visual cue after the
21601 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21602 int x
, int y
, int submenu
)
21605 struct frame
*f
= SELECTED_FRAME ();
21606 struct window
*w
= XWINDOW (f
->selected_window
);
21607 int saved_used
, saved_truncated
, saved_width
, saved_reversed
;
21608 struct glyph_row
*row
;
21609 size_t item_len
= strlen (item_text
);
21611 eassert (FRAME_TERMCAP_P (f
));
21613 /* Don't write beyond the matrix's last row. This can happen for
21614 TTY screens that are not high enough to show the entire menu.
21615 (This is actually a bit of defensive programming, as
21616 tty_menu_display already limits the number of menu items to one
21617 less than the number of screen lines.) */
21618 if (y
>= f
->desired_matrix
->nrows
)
21621 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21622 it
.first_visible_x
= 0;
21623 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21624 row
= it
.glyph_row
;
21625 /* Start with the row contents from the current matrix. */
21626 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21627 saved_width
= row
->full_width_p
;
21628 row
->full_width_p
= 1;
21629 saved_reversed
= row
->reversed_p
;
21630 row
->reversed_p
= 0;
21631 row
->enabled_p
= true;
21633 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21635 eassert (x
< f
->desired_matrix
->matrix_w
);
21636 it
.current_x
= it
.hpos
= x
;
21637 it
.current_y
= it
.vpos
= y
;
21638 saved_used
= row
->used
[TEXT_AREA
];
21639 saved_truncated
= row
->truncated_on_right_p
;
21640 row
->used
[TEXT_AREA
] = x
;
21641 it
.face_id
= face_id
;
21642 it
.line_wrap
= TRUNCATE
;
21644 /* FIXME: This should be controlled by a user option. See the
21645 comments in redisplay_tool_bar and display_mode_line about this.
21646 Also, if paragraph_embedding could ever be R2L, changes will be
21647 needed to avoid shifting to the right the row characters in
21648 term.c:append_glyph. */
21649 it
.paragraph_embedding
= L2R
;
21651 /* Pad with a space on the left. */
21652 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21654 /* Display the menu item, pad with spaces to WIDTH. */
21657 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21658 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21660 /* Indicate with " >" that there's a submenu. */
21661 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21662 FRAME_COLS (f
) - 1, -1);
21665 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21666 width
, 0, FRAME_COLS (f
) - 1, -1);
21668 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21669 row
->truncated_on_right_p
= saved_truncated
;
21670 row
->hash
= row_hash (row
);
21671 row
->full_width_p
= saved_width
;
21672 row
->reversed_p
= saved_reversed
;
21675 /***********************************************************************
21677 ***********************************************************************/
21679 /* Redisplay mode lines in the window tree whose root is WINDOW. If
21680 FORCE is non-zero, redisplay mode lines unconditionally.
21681 Otherwise, redisplay only mode lines that are garbaged. Value is
21682 the number of windows whose mode lines were redisplayed. */
21685 redisplay_mode_lines (Lisp_Object window
, bool force
)
21689 while (!NILP (window
))
21691 struct window
*w
= XWINDOW (window
);
21693 if (WINDOWP (w
->contents
))
21694 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
21696 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
21697 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
21699 struct text_pos lpoint
;
21700 struct buffer
*old
= current_buffer
;
21702 /* Set the window's buffer for the mode line display. */
21703 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
21704 set_buffer_internal_1 (XBUFFER (w
->contents
));
21706 /* Point refers normally to the selected window. For any
21707 other window, set up appropriate value. */
21708 if (!EQ (window
, selected_window
))
21710 struct text_pos pt
;
21712 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
21713 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
21716 /* Display mode lines. */
21717 clear_glyph_matrix (w
->desired_matrix
);
21718 if (display_mode_lines (w
))
21721 /* Restore old settings. */
21722 set_buffer_internal_1 (old
);
21723 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
21733 /* Display the mode and/or header line of window W. Value is the
21734 sum number of mode lines and header lines displayed. */
21737 display_mode_lines (struct window
*w
)
21739 Lisp_Object old_selected_window
= selected_window
;
21740 Lisp_Object old_selected_frame
= selected_frame
;
21741 Lisp_Object new_frame
= w
->frame
;
21742 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
21745 selected_frame
= new_frame
;
21746 /* FIXME: If we were to allow the mode-line's computation changing the buffer
21747 or window's point, then we'd need select_window_1 here as well. */
21748 XSETWINDOW (selected_window
, w
);
21749 XFRAME (new_frame
)->selected_window
= selected_window
;
21751 /* These will be set while the mode line specs are processed. */
21752 line_number_displayed
= 0;
21753 w
->column_number_displayed
= -1;
21755 if (WINDOW_WANTS_MODELINE_P (w
))
21757 struct window
*sel_w
= XWINDOW (old_selected_window
);
21759 /* Select mode line face based on the real selected window. */
21760 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
21761 BVAR (current_buffer
, mode_line_format
));
21765 if (WINDOW_WANTS_HEADER_LINE_P (w
))
21767 display_mode_line (w
, HEADER_LINE_FACE_ID
,
21768 BVAR (current_buffer
, header_line_format
));
21772 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
21773 selected_frame
= old_selected_frame
;
21774 selected_window
= old_selected_window
;
21776 w
->must_be_updated_p
= true;
21781 /* Display mode or header line of window W. FACE_ID specifies which
21782 line to display; it is either MODE_LINE_FACE_ID or
21783 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
21784 display. Value is the pixel height of the mode/header line
21788 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
21792 ptrdiff_t count
= SPECPDL_INDEX ();
21794 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21795 /* Don't extend on a previously drawn mode-line.
21796 This may happen if called from pos_visible_p. */
21797 it
.glyph_row
->enabled_p
= false;
21798 prepare_desired_row (w
, it
.glyph_row
, true);
21800 it
.glyph_row
->mode_line_p
= 1;
21802 /* FIXME: This should be controlled by a user option. But
21803 supporting such an option is not trivial, since the mode line is
21804 made up of many separate strings. */
21805 it
.paragraph_embedding
= L2R
;
21807 record_unwind_protect (unwind_format_mode_line
,
21808 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
21810 mode_line_target
= MODE_LINE_DISPLAY
;
21812 /* Temporarily make frame's keyboard the current kboard so that
21813 kboard-local variables in the mode_line_format will get the right
21815 push_kboard (FRAME_KBOARD (it
.f
));
21816 record_unwind_save_match_data ();
21817 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21820 unbind_to (count
, Qnil
);
21822 /* Fill up with spaces. */
21823 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
21825 compute_line_metrics (&it
);
21826 it
.glyph_row
->full_width_p
= 1;
21827 it
.glyph_row
->continued_p
= 0;
21828 it
.glyph_row
->truncated_on_left_p
= 0;
21829 it
.glyph_row
->truncated_on_right_p
= 0;
21831 /* Make a 3D mode-line have a shadow at its right end. */
21832 face
= FACE_FROM_ID (it
.f
, face_id
);
21833 extend_face_to_end_of_line (&it
);
21834 if (face
->box
!= FACE_NO_BOX
)
21836 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
21837 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
21838 last
->right_box_line_p
= 1;
21841 return it
.glyph_row
->height
;
21844 /* Move element ELT in LIST to the front of LIST.
21845 Return the updated list. */
21848 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
21850 register Lisp_Object tail
, prev
;
21851 register Lisp_Object tem
;
21855 while (CONSP (tail
))
21861 /* Splice out the link TAIL. */
21863 list
= XCDR (tail
);
21865 Fsetcdr (prev
, XCDR (tail
));
21867 /* Now make it the first. */
21868 Fsetcdr (tail
, list
);
21873 tail
= XCDR (tail
);
21877 /* Not found--return unchanged LIST. */
21881 /* Contribute ELT to the mode line for window IT->w. How it
21882 translates into text depends on its data type.
21884 IT describes the display environment in which we display, as usual.
21886 DEPTH is the depth in recursion. It is used to prevent
21887 infinite recursion here.
21889 FIELD_WIDTH is the number of characters the display of ELT should
21890 occupy in the mode line, and PRECISION is the maximum number of
21891 characters to display from ELT's representation. See
21892 display_string for details.
21894 Returns the hpos of the end of the text generated by ELT.
21896 PROPS is a property list to add to any string we encounter.
21898 If RISKY is nonzero, remove (disregard) any properties in any string
21899 we encounter, and ignore :eval and :propertize.
21901 The global variable `mode_line_target' determines whether the
21902 output is passed to `store_mode_line_noprop',
21903 `store_mode_line_string', or `display_string'. */
21906 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
21907 Lisp_Object elt
, Lisp_Object props
, int risky
)
21909 int n
= 0, field
, prec
;
21914 elt
= build_string ("*too-deep*");
21918 switch (XTYPE (elt
))
21922 /* A string: output it and check for %-constructs within it. */
21924 ptrdiff_t offset
= 0;
21926 if (SCHARS (elt
) > 0
21927 && (!NILP (props
) || risky
))
21929 Lisp_Object oprops
, aelt
;
21930 oprops
= Ftext_properties_at (make_number (0), elt
);
21932 /* If the starting string's properties are not what
21933 we want, translate the string. Also, if the string
21934 is risky, do that anyway. */
21936 if (NILP (Fequal (props
, oprops
)) || risky
)
21938 /* If the starting string has properties,
21939 merge the specified ones onto the existing ones. */
21940 if (! NILP (oprops
) && !risky
)
21944 oprops
= Fcopy_sequence (oprops
);
21946 while (CONSP (tem
))
21948 oprops
= Fplist_put (oprops
, XCAR (tem
),
21949 XCAR (XCDR (tem
)));
21950 tem
= XCDR (XCDR (tem
));
21955 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
21956 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
21958 /* AELT is what we want. Move it to the front
21959 without consing. */
21961 mode_line_proptrans_alist
21962 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
21968 /* If AELT has the wrong props, it is useless.
21969 so get rid of it. */
21971 mode_line_proptrans_alist
21972 = Fdelq (aelt
, mode_line_proptrans_alist
);
21974 elt
= Fcopy_sequence (elt
);
21975 Fset_text_properties (make_number (0), Flength (elt
),
21977 /* Add this item to mode_line_proptrans_alist. */
21978 mode_line_proptrans_alist
21979 = Fcons (Fcons (elt
, props
),
21980 mode_line_proptrans_alist
);
21981 /* Truncate mode_line_proptrans_alist
21982 to at most 50 elements. */
21983 tem
= Fnthcdr (make_number (50),
21984 mode_line_proptrans_alist
);
21986 XSETCDR (tem
, Qnil
);
21995 prec
= precision
- n
;
21996 switch (mode_line_target
)
21998 case MODE_LINE_NOPROP
:
21999 case MODE_LINE_TITLE
:
22000 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22002 case MODE_LINE_STRING
:
22003 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
22005 case MODE_LINE_DISPLAY
:
22006 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22007 0, prec
, 0, STRING_MULTIBYTE (elt
));
22014 /* Handle the non-literal case. */
22016 while ((precision
<= 0 || n
< precision
)
22017 && SREF (elt
, offset
) != 0
22018 && (mode_line_target
!= MODE_LINE_DISPLAY
22019 || it
->current_x
< it
->last_visible_x
))
22021 ptrdiff_t last_offset
= offset
;
22023 /* Advance to end of string or next format specifier. */
22024 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22027 if (offset
- 1 != last_offset
)
22029 ptrdiff_t nchars
, nbytes
;
22031 /* Output to end of string or up to '%'. Field width
22032 is length of string. Don't output more than
22033 PRECISION allows us. */
22036 prec
= c_string_width (SDATA (elt
) + last_offset
,
22037 offset
- last_offset
, precision
- n
,
22040 switch (mode_line_target
)
22042 case MODE_LINE_NOPROP
:
22043 case MODE_LINE_TITLE
:
22044 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22046 case MODE_LINE_STRING
:
22048 ptrdiff_t bytepos
= last_offset
;
22049 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22050 ptrdiff_t endpos
= (precision
<= 0
22051 ? string_byte_to_char (elt
, offset
)
22052 : charpos
+ nchars
);
22054 n
+= store_mode_line_string (NULL
,
22055 Fsubstring (elt
, make_number (charpos
),
22056 make_number (endpos
)),
22060 case MODE_LINE_DISPLAY
:
22062 ptrdiff_t bytepos
= last_offset
;
22063 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22065 if (precision
<= 0)
22066 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22067 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22069 STRING_MULTIBYTE (elt
));
22074 else /* c == '%' */
22076 ptrdiff_t percent_position
= offset
;
22078 /* Get the specified minimum width. Zero means
22081 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22082 field
= field
* 10 + c
- '0';
22084 /* Don't pad beyond the total padding allowed. */
22085 if (field_width
- n
> 0 && field
> field_width
- n
)
22086 field
= field_width
- n
;
22088 /* Note that either PRECISION <= 0 or N < PRECISION. */
22089 prec
= precision
- n
;
22092 n
+= display_mode_element (it
, depth
, field
, prec
,
22093 Vglobal_mode_string
, props
,
22098 ptrdiff_t bytepos
, charpos
;
22100 Lisp_Object string
;
22102 bytepos
= percent_position
;
22103 charpos
= (STRING_MULTIBYTE (elt
)
22104 ? string_byte_to_char (elt
, bytepos
)
22106 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22107 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22109 switch (mode_line_target
)
22111 case MODE_LINE_NOPROP
:
22112 case MODE_LINE_TITLE
:
22113 n
+= store_mode_line_noprop (spec
, field
, prec
);
22115 case MODE_LINE_STRING
:
22117 Lisp_Object tem
= build_string (spec
);
22118 props
= Ftext_properties_at (make_number (charpos
), elt
);
22119 /* Should only keep face property in props */
22120 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
22123 case MODE_LINE_DISPLAY
:
22125 int nglyphs_before
, nwritten
;
22127 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22128 nwritten
= display_string (spec
, string
, elt
,
22133 /* Assign to the glyphs written above the
22134 string where the `%x' came from, position
22138 struct glyph
*glyph
22139 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22143 for (i
= 0; i
< nwritten
; ++i
)
22145 glyph
[i
].object
= elt
;
22146 glyph
[i
].charpos
= charpos
;
22163 /* A symbol: process the value of the symbol recursively
22164 as if it appeared here directly. Avoid error if symbol void.
22165 Special case: if value of symbol is a string, output the string
22168 register Lisp_Object tem
;
22170 /* If the variable is not marked as risky to set
22171 then its contents are risky to use. */
22172 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22175 tem
= Fboundp (elt
);
22178 tem
= Fsymbol_value (elt
);
22179 /* If value is a string, output that string literally:
22180 don't check for % within it. */
22184 if (!EQ (tem
, elt
))
22186 /* Give up right away for nil or t. */
22196 register Lisp_Object car
, tem
;
22198 /* A cons cell: five distinct cases.
22199 If first element is :eval or :propertize, do something special.
22200 If first element is a string or a cons, process all the elements
22201 and effectively concatenate them.
22202 If first element is a negative number, truncate displaying cdr to
22203 at most that many characters. If positive, pad (with spaces)
22204 to at least that many characters.
22205 If first element is a symbol, process the cadr or caddr recursively
22206 according to whether the symbol's value is non-nil or nil. */
22208 if (EQ (car
, QCeval
))
22210 /* An element of the form (:eval FORM) means evaluate FORM
22211 and use the result as mode line elements. */
22216 if (CONSP (XCDR (elt
)))
22219 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22220 n
+= display_mode_element (it
, depth
, field_width
- n
,
22221 precision
- n
, spec
, props
,
22225 else if (EQ (car
, QCpropertize
))
22227 /* An element of the form (:propertize ELT PROPS...)
22228 means display ELT but applying properties PROPS. */
22233 if (CONSP (XCDR (elt
)))
22234 n
+= display_mode_element (it
, depth
, field_width
- n
,
22235 precision
- n
, XCAR (XCDR (elt
)),
22236 XCDR (XCDR (elt
)), risky
);
22238 else if (SYMBOLP (car
))
22240 tem
= Fboundp (car
);
22244 /* elt is now the cdr, and we know it is a cons cell.
22245 Use its car if CAR has a non-nil value. */
22248 tem
= Fsymbol_value (car
);
22255 /* Symbol's value is nil (or symbol is unbound)
22256 Get the cddr of the original list
22257 and if possible find the caddr and use that. */
22261 else if (!CONSP (elt
))
22266 else if (INTEGERP (car
))
22268 register int lim
= XINT (car
);
22272 /* Negative int means reduce maximum width. */
22273 if (precision
<= 0)
22276 precision
= min (precision
, -lim
);
22280 /* Padding specified. Don't let it be more than
22281 current maximum. */
22283 lim
= min (precision
, lim
);
22285 /* If that's more padding than already wanted, queue it.
22286 But don't reduce padding already specified even if
22287 that is beyond the current truncation point. */
22288 field_width
= max (lim
, field_width
);
22292 else if (STRINGP (car
) || CONSP (car
))
22294 Lisp_Object halftail
= elt
;
22298 && (precision
<= 0 || n
< precision
))
22300 n
+= display_mode_element (it
, depth
,
22301 /* Do padding only after the last
22302 element in the list. */
22303 (! CONSP (XCDR (elt
))
22306 precision
- n
, XCAR (elt
),
22310 if ((len
& 1) == 0)
22311 halftail
= XCDR (halftail
);
22312 /* Check for cycle. */
22313 if (EQ (halftail
, elt
))
22322 elt
= build_string ("*invalid*");
22326 /* Pad to FIELD_WIDTH. */
22327 if (field_width
> 0 && n
< field_width
)
22329 switch (mode_line_target
)
22331 case MODE_LINE_NOPROP
:
22332 case MODE_LINE_TITLE
:
22333 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22335 case MODE_LINE_STRING
:
22336 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
22338 case MODE_LINE_DISPLAY
:
22339 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22348 /* Store a mode-line string element in mode_line_string_list.
22350 If STRING is non-null, display that C string. Otherwise, the Lisp
22351 string LISP_STRING is displayed.
22353 FIELD_WIDTH is the minimum number of output glyphs to produce.
22354 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22355 with spaces. FIELD_WIDTH <= 0 means don't pad.
22357 PRECISION is the maximum number of characters to output from
22358 STRING. PRECISION <= 0 means don't truncate the string.
22360 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
22361 properties to the string.
22363 PROPS are the properties to add to the string.
22364 The mode_line_string_face face property is always added to the string.
22368 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
22369 int field_width
, int precision
, Lisp_Object props
)
22374 if (string
!= NULL
)
22376 len
= strlen (string
);
22377 if (precision
> 0 && len
> precision
)
22379 lisp_string
= make_string (string
, len
);
22381 props
= mode_line_string_face_prop
;
22382 else if (!NILP (mode_line_string_face
))
22384 Lisp_Object face
= Fplist_get (props
, Qface
);
22385 props
= Fcopy_sequence (props
);
22387 face
= mode_line_string_face
;
22389 face
= list2 (face
, mode_line_string_face
);
22390 props
= Fplist_put (props
, Qface
, face
);
22392 Fadd_text_properties (make_number (0), make_number (len
),
22393 props
, lisp_string
);
22397 len
= XFASTINT (Flength (lisp_string
));
22398 if (precision
> 0 && len
> precision
)
22401 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22404 if (!NILP (mode_line_string_face
))
22408 props
= Ftext_properties_at (make_number (0), lisp_string
);
22409 face
= Fplist_get (props
, Qface
);
22411 face
= mode_line_string_face
;
22413 face
= list2 (face
, mode_line_string_face
);
22414 props
= list2 (Qface
, face
);
22416 lisp_string
= Fcopy_sequence (lisp_string
);
22419 Fadd_text_properties (make_number (0), make_number (len
),
22420 props
, lisp_string
);
22425 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22429 if (field_width
> len
)
22431 field_width
-= len
;
22432 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22434 Fadd_text_properties (make_number (0), make_number (field_width
),
22435 props
, lisp_string
);
22436 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22444 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22446 doc
: /* Format a string out of a mode line format specification.
22447 First arg FORMAT specifies the mode line format (see `mode-line-format'
22448 for details) to use.
22450 By default, the format is evaluated for the currently selected window.
22452 Optional second arg FACE specifies the face property to put on all
22453 characters for which no face is specified. The value nil means the
22454 default face. The value t means whatever face the window's mode line
22455 currently uses (either `mode-line' or `mode-line-inactive',
22456 depending on whether the window is the selected window or not).
22457 An integer value means the value string has no text
22460 Optional third and fourth args WINDOW and BUFFER specify the window
22461 and buffer to use as the context for the formatting (defaults
22462 are the selected window and the WINDOW's buffer). */)
22463 (Lisp_Object format
, Lisp_Object face
,
22464 Lisp_Object window
, Lisp_Object buffer
)
22469 struct buffer
*old_buffer
= NULL
;
22471 int no_props
= INTEGERP (face
);
22472 ptrdiff_t count
= SPECPDL_INDEX ();
22474 int string_start
= 0;
22476 w
= decode_any_window (window
);
22477 XSETWINDOW (window
, w
);
22480 buffer
= w
->contents
;
22481 CHECK_BUFFER (buffer
);
22483 /* Make formatting the modeline a non-op when noninteractive, otherwise
22484 there will be problems later caused by a partially initialized frame. */
22485 if (NILP (format
) || noninteractive
)
22486 return empty_unibyte_string
;
22491 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22492 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22493 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22494 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22495 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22496 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22497 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22500 old_buffer
= current_buffer
;
22502 /* Save things including mode_line_proptrans_alist,
22503 and set that to nil so that we don't alter the outer value. */
22504 record_unwind_protect (unwind_format_mode_line
,
22505 format_mode_line_unwind_data
22506 (XFRAME (WINDOW_FRAME (w
)),
22507 old_buffer
, selected_window
, 1));
22508 mode_line_proptrans_alist
= Qnil
;
22510 Fselect_window (window
, Qt
);
22511 set_buffer_internal_1 (XBUFFER (buffer
));
22513 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22517 mode_line_target
= MODE_LINE_NOPROP
;
22518 mode_line_string_face_prop
= Qnil
;
22519 mode_line_string_list
= Qnil
;
22520 string_start
= MODE_LINE_NOPROP_LEN (0);
22524 mode_line_target
= MODE_LINE_STRING
;
22525 mode_line_string_list
= Qnil
;
22526 mode_line_string_face
= face
;
22527 mode_line_string_face_prop
22528 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22531 push_kboard (FRAME_KBOARD (it
.f
));
22532 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
22537 len
= MODE_LINE_NOPROP_LEN (string_start
);
22538 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22542 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22543 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
22544 empty_unibyte_string
);
22547 unbind_to (count
, Qnil
);
22551 /* Write a null-terminated, right justified decimal representation of
22552 the positive integer D to BUF using a minimal field width WIDTH. */
22555 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22557 register char *p
= buf
;
22565 *p
++ = d
% 10 + '0';
22570 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22581 /* Write a null-terminated, right justified decimal and "human
22582 readable" representation of the nonnegative integer D to BUF using
22583 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22585 static const char power_letter
[] =
22599 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22601 /* We aim to represent the nonnegative integer D as
22602 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22603 ptrdiff_t quotient
= d
;
22605 /* -1 means: do not use TENTHS. */
22609 /* Length of QUOTIENT.TENTHS as a string. */
22615 if (quotient
>= 1000)
22617 /* Scale to the appropriate EXPONENT. */
22620 remainder
= quotient
% 1000;
22624 while (quotient
>= 1000);
22626 /* Round to nearest and decide whether to use TENTHS or not. */
22629 tenths
= remainder
/ 100;
22630 if (remainder
% 100 >= 50)
22637 if (quotient
== 10)
22645 if (remainder
>= 500)
22647 if (quotient
< 999)
22658 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22659 if (tenths
== -1 && quotient
<= 99)
22666 p
= psuffix
= buf
+ max (width
, length
);
22668 /* Print EXPONENT. */
22669 *psuffix
++ = power_letter
[exponent
];
22672 /* Print TENTHS. */
22675 *--p
= '0' + tenths
;
22679 /* Print QUOTIENT. */
22682 int digit
= quotient
% 10;
22683 *--p
= '0' + digit
;
22685 while ((quotient
/= 10) != 0);
22687 /* Print leading spaces. */
22692 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22693 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
22694 type of CODING_SYSTEM. Return updated pointer into BUF. */
22696 static unsigned char invalid_eol_type
[] = "(*invalid*)";
22699 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
22702 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
22703 const unsigned char *eol_str
;
22705 /* The EOL conversion we are using. */
22706 Lisp_Object eoltype
;
22708 val
= CODING_SYSTEM_SPEC (coding_system
);
22711 if (!VECTORP (val
)) /* Not yet decided. */
22713 *buf
++ = multibyte
? '-' : ' ';
22715 eoltype
= eol_mnemonic_undecided
;
22716 /* Don't mention EOL conversion if it isn't decided. */
22721 Lisp_Object eolvalue
;
22723 attrs
= AREF (val
, 0);
22724 eolvalue
= AREF (val
, 2);
22727 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
22732 /* The EOL conversion that is normal on this system. */
22734 if (NILP (eolvalue
)) /* Not yet decided. */
22735 eoltype
= eol_mnemonic_undecided
;
22736 else if (VECTORP (eolvalue
)) /* Not yet decided. */
22737 eoltype
= eol_mnemonic_undecided
;
22738 else /* eolvalue is Qunix, Qdos, or Qmac. */
22739 eoltype
= (EQ (eolvalue
, Qunix
)
22740 ? eol_mnemonic_unix
22741 : (EQ (eolvalue
, Qdos
) == 1
22742 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
22748 /* Mention the EOL conversion if it is not the usual one. */
22749 if (STRINGP (eoltype
))
22751 eol_str
= SDATA (eoltype
);
22752 eol_str_len
= SBYTES (eoltype
);
22754 else if (CHARACTERP (eoltype
))
22756 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
22757 int c
= XFASTINT (eoltype
);
22758 eol_str_len
= CHAR_STRING (c
, tmp
);
22763 eol_str
= invalid_eol_type
;
22764 eol_str_len
= sizeof (invalid_eol_type
) - 1;
22766 memcpy (buf
, eol_str
, eol_str_len
);
22767 buf
+= eol_str_len
;
22773 /* Return a string for the output of a mode line %-spec for window W,
22774 generated by character C. FIELD_WIDTH > 0 means pad the string
22775 returned with spaces to that value. Return a Lisp string in
22776 *STRING if the resulting string is taken from that Lisp string.
22778 Note we operate on the current buffer for most purposes. */
22780 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
22782 static const char *
22783 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
22784 Lisp_Object
*string
)
22787 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22788 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
22789 /* We are going to use f->decode_mode_spec_buffer as the buffer to
22790 produce strings from numerical values, so limit preposterously
22791 large values of FIELD_WIDTH to avoid overrunning the buffer's
22792 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
22793 bytes plus the terminating null. */
22794 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
22795 struct buffer
*b
= current_buffer
;
22803 if (!NILP (BVAR (b
, read_only
)))
22805 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22810 /* This differs from %* only for a modified read-only buffer. */
22811 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22813 if (!NILP (BVAR (b
, read_only
)))
22818 /* This differs from %* in ignoring read-only-ness. */
22819 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22831 if (command_loop_level
> 5)
22833 p
= decode_mode_spec_buf
;
22834 for (i
= 0; i
< command_loop_level
; i
++)
22837 return decode_mode_spec_buf
;
22845 if (command_loop_level
> 5)
22847 p
= decode_mode_spec_buf
;
22848 for (i
= 0; i
< command_loop_level
; i
++)
22851 return decode_mode_spec_buf
;
22858 /* Let lots_of_dashes be a string of infinite length. */
22859 if (mode_line_target
== MODE_LINE_NOPROP
22860 || mode_line_target
== MODE_LINE_STRING
)
22862 if (field_width
<= 0
22863 || field_width
> sizeof (lots_of_dashes
))
22865 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
22866 decode_mode_spec_buf
[i
] = '-';
22867 decode_mode_spec_buf
[i
] = '\0';
22868 return decode_mode_spec_buf
;
22871 return lots_of_dashes
;
22875 obj
= BVAR (b
, name
);
22879 /* %c and %l are ignored in `frame-title-format'.
22880 (In redisplay_internal, the frame title is drawn _before_ the
22881 windows are updated, so the stuff which depends on actual
22882 window contents (such as %l) may fail to render properly, or
22883 even crash emacs.) */
22884 if (mode_line_target
== MODE_LINE_TITLE
)
22888 ptrdiff_t col
= current_column ();
22889 w
->column_number_displayed
= col
;
22890 pint2str (decode_mode_spec_buf
, width
, col
);
22891 return decode_mode_spec_buf
;
22895 #ifndef SYSTEM_MALLOC
22897 if (NILP (Vmemory_full
))
22900 return "!MEM FULL! ";
22907 /* %F displays the frame name. */
22908 if (!NILP (f
->title
))
22909 return SSDATA (f
->title
);
22910 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
22911 return SSDATA (f
->name
);
22915 obj
= BVAR (b
, filename
);
22920 ptrdiff_t size
= ZV
- BEGV
;
22921 pint2str (decode_mode_spec_buf
, width
, size
);
22922 return decode_mode_spec_buf
;
22927 ptrdiff_t size
= ZV
- BEGV
;
22928 pint2hrstr (decode_mode_spec_buf
, width
, size
);
22929 return decode_mode_spec_buf
;
22934 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
22935 ptrdiff_t topline
, nlines
, height
;
22938 /* %c and %l are ignored in `frame-title-format'. */
22939 if (mode_line_target
== MODE_LINE_TITLE
)
22942 startpos
= marker_position (w
->start
);
22943 startpos_byte
= marker_byte_position (w
->start
);
22944 height
= WINDOW_TOTAL_LINES (w
);
22946 /* If we decided that this buffer isn't suitable for line numbers,
22947 don't forget that too fast. */
22948 if (w
->base_line_pos
== -1)
22951 /* If the buffer is very big, don't waste time. */
22952 if (INTEGERP (Vline_number_display_limit
)
22953 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
22955 w
->base_line_pos
= 0;
22956 w
->base_line_number
= 0;
22960 if (w
->base_line_number
> 0
22961 && w
->base_line_pos
> 0
22962 && w
->base_line_pos
<= startpos
)
22964 line
= w
->base_line_number
;
22965 linepos
= w
->base_line_pos
;
22966 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
22971 linepos
= BUF_BEGV (b
);
22972 linepos_byte
= BUF_BEGV_BYTE (b
);
22975 /* Count lines from base line to window start position. */
22976 nlines
= display_count_lines (linepos_byte
,
22980 topline
= nlines
+ line
;
22982 /* Determine a new base line, if the old one is too close
22983 or too far away, or if we did not have one.
22984 "Too close" means it's plausible a scroll-down would
22985 go back past it. */
22986 if (startpos
== BUF_BEGV (b
))
22988 w
->base_line_number
= topline
;
22989 w
->base_line_pos
= BUF_BEGV (b
);
22991 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
22992 || linepos
== BUF_BEGV (b
))
22994 ptrdiff_t limit
= BUF_BEGV (b
);
22995 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
22996 ptrdiff_t position
;
22997 ptrdiff_t distance
=
22998 (height
* 2 + 30) * line_number_display_limit_width
;
23000 if (startpos
- distance
> limit
)
23002 limit
= startpos
- distance
;
23003 limit_byte
= CHAR_TO_BYTE (limit
);
23006 nlines
= display_count_lines (startpos_byte
,
23008 - (height
* 2 + 30),
23010 /* If we couldn't find the lines we wanted within
23011 line_number_display_limit_width chars per line,
23012 give up on line numbers for this window. */
23013 if (position
== limit_byte
&& limit
== startpos
- distance
)
23015 w
->base_line_pos
= -1;
23016 w
->base_line_number
= 0;
23020 w
->base_line_number
= topline
- nlines
;
23021 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23024 /* Now count lines from the start pos to point. */
23025 nlines
= display_count_lines (startpos_byte
,
23026 PT_BYTE
, PT
, &junk
);
23028 /* Record that we did display the line number. */
23029 line_number_displayed
= 1;
23031 /* Make the string to show. */
23032 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23033 return decode_mode_spec_buf
;
23036 char* p
= decode_mode_spec_buf
;
23037 int pad
= width
- 2;
23043 return decode_mode_spec_buf
;
23049 obj
= BVAR (b
, mode_name
);
23053 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23059 ptrdiff_t pos
= marker_position (w
->start
);
23060 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23062 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23064 if (pos
<= BUF_BEGV (b
))
23069 else if (pos
<= BUF_BEGV (b
))
23073 if (total
> 1000000)
23074 /* Do it differently for a large value, to avoid overflow. */
23075 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23077 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23078 /* We can't normally display a 3-digit number,
23079 so get us a 2-digit number that is close. */
23082 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23083 return decode_mode_spec_buf
;
23087 /* Display percentage of size above the bottom of the screen. */
23090 ptrdiff_t toppos
= marker_position (w
->start
);
23091 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23092 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23094 if (botpos
>= BUF_ZV (b
))
23096 if (toppos
<= BUF_BEGV (b
))
23103 if (total
> 1000000)
23104 /* Do it differently for a large value, to avoid overflow. */
23105 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23107 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23108 /* We can't normally display a 3-digit number,
23109 so get us a 2-digit number that is close. */
23112 if (toppos
<= BUF_BEGV (b
))
23113 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23115 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23116 return decode_mode_spec_buf
;
23121 /* status of process */
23122 obj
= Fget_buffer_process (Fcurrent_buffer ());
23124 return "no process";
23126 obj
= Fsymbol_name (Fprocess_status (obj
));
23132 ptrdiff_t count
= inhibit_garbage_collection ();
23133 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23134 Lisp_Object val
= Qnil
;
23136 if (STRINGP (curdir
))
23137 val
= call1 (intern ("file-remote-p"), curdir
);
23139 unbind_to (count
, Qnil
);
23148 /* coding-system (not including end-of-line format) */
23150 /* coding-system (including end-of-line type) */
23152 int eol_flag
= (c
== 'Z');
23153 char *p
= decode_mode_spec_buf
;
23155 if (! FRAME_WINDOW_P (f
))
23157 /* No need to mention EOL here--the terminal never needs
23158 to do EOL conversion. */
23159 p
= decode_mode_spec_coding (CODING_ID_NAME
23160 (FRAME_KEYBOARD_CODING (f
)->id
),
23162 p
= decode_mode_spec_coding (CODING_ID_NAME
23163 (FRAME_TERMINAL_CODING (f
)->id
),
23166 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23169 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
23170 #ifdef subprocesses
23171 obj
= Fget_buffer_process (Fcurrent_buffer ());
23172 if (PROCESSP (obj
))
23174 p
= decode_mode_spec_coding
23175 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23176 p
= decode_mode_spec_coding
23177 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23179 #endif /* subprocesses */
23182 return decode_mode_spec_buf
;
23189 return SSDATA (obj
);
23196 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23197 means count lines back from START_BYTE. But don't go beyond
23198 LIMIT_BYTE. Return the number of lines thus found (always
23201 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23202 either the position COUNT lines after/before START_BYTE, if we
23203 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23207 display_count_lines (ptrdiff_t start_byte
,
23208 ptrdiff_t limit_byte
, ptrdiff_t count
,
23209 ptrdiff_t *byte_pos_ptr
)
23211 register unsigned char *cursor
;
23212 unsigned char *base
;
23214 register ptrdiff_t ceiling
;
23215 register unsigned char *ceiling_addr
;
23216 ptrdiff_t orig_count
= count
;
23218 /* If we are not in selective display mode,
23219 check only for newlines. */
23220 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
23221 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23225 while (start_byte
< limit_byte
)
23227 ceiling
= BUFFER_CEILING_OF (start_byte
);
23228 ceiling
= min (limit_byte
- 1, ceiling
);
23229 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23230 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23234 if (selective_display
)
23236 while (*cursor
!= '\n' && *cursor
!= 015
23237 && ++cursor
!= ceiling_addr
)
23239 if (cursor
== ceiling_addr
)
23244 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23253 start_byte
+= cursor
- base
;
23254 *byte_pos_ptr
= start_byte
;
23258 while (cursor
< ceiling_addr
);
23260 start_byte
+= ceiling_addr
- base
;
23265 while (start_byte
> limit_byte
)
23267 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23268 ceiling
= max (limit_byte
, ceiling
);
23269 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23270 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23273 if (selective_display
)
23275 while (--cursor
>= ceiling_addr
23276 && *cursor
!= '\n' && *cursor
!= 015)
23278 if (cursor
< ceiling_addr
)
23283 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23290 start_byte
+= cursor
- base
+ 1;
23291 *byte_pos_ptr
= start_byte
;
23292 /* When scanning backwards, we should
23293 not count the newline posterior to which we stop. */
23294 return - orig_count
- 1;
23297 start_byte
+= ceiling_addr
- base
;
23301 *byte_pos_ptr
= limit_byte
;
23304 return - orig_count
+ count
;
23305 return orig_count
- count
;
23311 /***********************************************************************
23313 ***********************************************************************/
23315 /* Display a NUL-terminated string, starting with index START.
23317 If STRING is non-null, display that C string. Otherwise, the Lisp
23318 string LISP_STRING is displayed. There's a case that STRING is
23319 non-null and LISP_STRING is not nil. It means STRING is a string
23320 data of LISP_STRING. In that case, we display LISP_STRING while
23321 ignoring its text properties.
23323 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23324 FACE_STRING. Display STRING or LISP_STRING with the face at
23325 FACE_STRING_POS in FACE_STRING:
23327 Display the string in the environment given by IT, but use the
23328 standard display table, temporarily.
23330 FIELD_WIDTH is the minimum number of output glyphs to produce.
23331 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23332 with spaces. If STRING has more characters, more than FIELD_WIDTH
23333 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23335 PRECISION is the maximum number of characters to output from
23336 STRING. PRECISION < 0 means don't truncate the string.
23338 This is roughly equivalent to printf format specifiers:
23340 FIELD_WIDTH PRECISION PRINTF
23341 ----------------------------------------
23347 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23348 display them, and < 0 means obey the current buffer's value of
23349 enable_multibyte_characters.
23351 Value is the number of columns displayed. */
23354 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23355 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23356 int field_width
, int precision
, int max_x
, int multibyte
)
23358 int hpos_at_start
= it
->hpos
;
23359 int saved_face_id
= it
->face_id
;
23360 struct glyph_row
*row
= it
->glyph_row
;
23361 ptrdiff_t it_charpos
;
23363 /* Initialize the iterator IT for iteration over STRING beginning
23364 with index START. */
23365 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23366 precision
, field_width
, multibyte
);
23367 if (string
&& STRINGP (lisp_string
))
23368 /* LISP_STRING is the one returned by decode_mode_spec. We should
23369 ignore its text properties. */
23370 it
->stop_charpos
= it
->end_charpos
;
23372 /* If displaying STRING, set up the face of the iterator from
23373 FACE_STRING, if that's given. */
23374 if (STRINGP (face_string
))
23380 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23381 0, &endptr
, it
->base_face_id
, 0);
23382 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23383 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23386 /* Set max_x to the maximum allowed X position. Don't let it go
23387 beyond the right edge of the window. */
23389 max_x
= it
->last_visible_x
;
23391 max_x
= min (max_x
, it
->last_visible_x
);
23393 /* Skip over display elements that are not visible. because IT->w is
23395 if (it
->current_x
< it
->first_visible_x
)
23396 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23397 MOVE_TO_POS
| MOVE_TO_X
);
23399 row
->ascent
= it
->max_ascent
;
23400 row
->height
= it
->max_ascent
+ it
->max_descent
;
23401 row
->phys_ascent
= it
->max_phys_ascent
;
23402 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23403 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23405 if (STRINGP (it
->string
))
23406 it_charpos
= IT_STRING_CHARPOS (*it
);
23408 it_charpos
= IT_CHARPOS (*it
);
23410 /* This condition is for the case that we are called with current_x
23411 past last_visible_x. */
23412 while (it
->current_x
< max_x
)
23414 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23416 /* Get the next display element. */
23417 if (!get_next_display_element (it
))
23420 /* Produce glyphs. */
23421 x_before
= it
->current_x
;
23422 n_glyphs_before
= row
->used
[TEXT_AREA
];
23423 PRODUCE_GLYPHS (it
);
23425 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23428 while (i
< nglyphs
)
23430 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23432 if (it
->line_wrap
!= TRUNCATE
23433 && x
+ glyph
->pixel_width
> max_x
)
23435 /* End of continued line or max_x reached. */
23436 if (CHAR_GLYPH_PADDING_P (*glyph
))
23438 /* A wide character is unbreakable. */
23439 if (row
->reversed_p
)
23440 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23441 - n_glyphs_before
);
23442 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23443 it
->current_x
= x_before
;
23447 if (row
->reversed_p
)
23448 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23449 - (n_glyphs_before
+ i
));
23450 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23455 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23457 /* Glyph is at least partially visible. */
23459 if (x
< it
->first_visible_x
)
23460 row
->x
= x
- it
->first_visible_x
;
23464 /* Glyph is off the left margin of the display area.
23465 Should not happen. */
23469 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23470 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23471 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23472 row
->phys_height
= max (row
->phys_height
,
23473 it
->max_phys_ascent
+ it
->max_phys_descent
);
23474 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23475 it
->max_extra_line_spacing
);
23476 x
+= glyph
->pixel_width
;
23480 /* Stop if max_x reached. */
23484 /* Stop at line ends. */
23485 if (ITERATOR_AT_END_OF_LINE_P (it
))
23487 it
->continuation_lines_width
= 0;
23491 set_iterator_to_next (it
, 1);
23492 if (STRINGP (it
->string
))
23493 it_charpos
= IT_STRING_CHARPOS (*it
);
23495 it_charpos
= IT_CHARPOS (*it
);
23497 /* Stop if truncating at the right edge. */
23498 if (it
->line_wrap
== TRUNCATE
23499 && it
->current_x
>= it
->last_visible_x
)
23501 /* Add truncation mark, but don't do it if the line is
23502 truncated at a padding space. */
23503 if (it_charpos
< it
->string_nchars
)
23505 if (!FRAME_WINDOW_P (it
->f
))
23509 if (it
->current_x
> it
->last_visible_x
)
23511 if (!row
->reversed_p
)
23513 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23514 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23519 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23520 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23522 unproduce_glyphs (it
, ii
+ 1);
23523 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23525 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23527 row
->used
[TEXT_AREA
] = ii
;
23528 produce_special_glyphs (it
, IT_TRUNCATION
);
23531 produce_special_glyphs (it
, IT_TRUNCATION
);
23533 row
->truncated_on_right_p
= 1;
23539 /* Maybe insert a truncation at the left. */
23540 if (it
->first_visible_x
23543 if (!FRAME_WINDOW_P (it
->f
)
23544 || (row
->reversed_p
23545 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23546 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23547 insert_left_trunc_glyphs (it
);
23548 row
->truncated_on_left_p
= 1;
23551 it
->face_id
= saved_face_id
;
23553 /* Value is number of columns displayed. */
23554 return it
->hpos
- hpos_at_start
;
23559 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23560 appears as an element of LIST or as the car of an element of LIST.
23561 If PROPVAL is a list, compare each element against LIST in that
23562 way, and return 1/2 if any element of PROPVAL is found in LIST.
23563 Otherwise return 0. This function cannot quit.
23564 The return value is 2 if the text is invisible but with an ellipsis
23565 and 1 if it's invisible and without an ellipsis. */
23568 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
23570 register Lisp_Object tail
, proptail
;
23572 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23574 register Lisp_Object tem
;
23576 if (EQ (propval
, tem
))
23578 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23579 return NILP (XCDR (tem
)) ? 1 : 2;
23582 if (CONSP (propval
))
23584 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23586 Lisp_Object propelt
;
23587 propelt
= XCAR (proptail
);
23588 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23590 register Lisp_Object tem
;
23592 if (EQ (propelt
, tem
))
23594 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23595 return NILP (XCDR (tem
)) ? 1 : 2;
23603 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23604 doc
: /* Non-nil if the property makes the text invisible.
23605 POS-OR-PROP can be a marker or number, in which case it is taken to be
23606 a position in the current buffer and the value of the `invisible' property
23607 is checked; or it can be some other value, which is then presumed to be the
23608 value of the `invisible' property of the text of interest.
23609 The non-nil value returned can be t for truly invisible text or something
23610 else if the text is replaced by an ellipsis. */)
23611 (Lisp_Object pos_or_prop
)
23614 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23615 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23617 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23618 return (invis
== 0 ? Qnil
23620 : make_number (invis
));
23623 /* Calculate a width or height in pixels from a specification using
23624 the following elements:
23627 NUM - a (fractional) multiple of the default font width/height
23628 (NUM) - specifies exactly NUM pixels
23629 UNIT - a fixed number of pixels, see below.
23630 ELEMENT - size of a display element in pixels, see below.
23631 (NUM . SPEC) - equals NUM * SPEC
23632 (+ SPEC SPEC ...) - add pixel values
23633 (- SPEC SPEC ...) - subtract pixel values
23634 (- SPEC) - negate pixel value
23637 INT or FLOAT - a number constant
23638 SYMBOL - use symbol's (buffer local) variable binding.
23641 in - pixels per inch *)
23642 mm - pixels per 1/1000 meter *)
23643 cm - pixels per 1/100 meter *)
23644 width - width of current font in pixels.
23645 height - height of current font in pixels.
23647 *) using the ratio(s) defined in display-pixels-per-inch.
23651 left-fringe - left fringe width in pixels
23652 right-fringe - right fringe width in pixels
23654 left-margin - left margin width in pixels
23655 right-margin - right margin width in pixels
23657 scroll-bar - scroll-bar area width in pixels
23661 Pixels corresponding to 5 inches:
23664 Total width of non-text areas on left side of window (if scroll-bar is on left):
23665 '(space :width (+ left-fringe left-margin scroll-bar))
23667 Align to first text column (in header line):
23668 '(space :align-to 0)
23670 Align to middle of text area minus half the width of variable `my-image'
23671 containing a loaded image:
23672 '(space :align-to (0.5 . (- text my-image)))
23674 Width of left margin minus width of 1 character in the default font:
23675 '(space :width (- left-margin 1))
23677 Width of left margin minus width of 2 characters in the current font:
23678 '(space :width (- left-margin (2 . width)))
23680 Center 1 character over left-margin (in header line):
23681 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23683 Different ways to express width of left fringe plus left margin minus one pixel:
23684 '(space :width (- (+ left-fringe left-margin) (1)))
23685 '(space :width (+ left-fringe left-margin (- (1))))
23686 '(space :width (+ left-fringe left-margin (-1)))
23691 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
23692 struct font
*font
, int width_p
, int *align_to
)
23696 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
23697 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
23700 return OK_PIXELS (0);
23702 eassert (FRAME_LIVE_P (it
->f
));
23704 if (SYMBOLP (prop
))
23706 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
23708 char *unit
= SSDATA (SYMBOL_NAME (prop
));
23710 if (unit
[0] == 'i' && unit
[1] == 'n')
23712 else if (unit
[0] == 'm' && unit
[1] == 'm')
23714 else if (unit
[0] == 'c' && unit
[1] == 'm')
23720 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
23721 : FRAME_RES_Y (it
->f
));
23724 return OK_PIXELS (ppi
/ pixels
);
23729 #ifdef HAVE_WINDOW_SYSTEM
23730 if (EQ (prop
, Qheight
))
23731 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
23732 if (EQ (prop
, Qwidth
))
23733 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
23735 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
23736 return OK_PIXELS (1);
23739 if (EQ (prop
, Qtext
))
23740 return OK_PIXELS (width_p
23741 ? window_box_width (it
->w
, TEXT_AREA
)
23742 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
23744 if (align_to
&& *align_to
< 0)
23747 if (EQ (prop
, Qleft
))
23748 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
23749 if (EQ (prop
, Qright
))
23750 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
23751 if (EQ (prop
, Qcenter
))
23752 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
23753 + window_box_width (it
->w
, TEXT_AREA
) / 2);
23754 if (EQ (prop
, Qleft_fringe
))
23755 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23756 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
23757 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
23758 if (EQ (prop
, Qright_fringe
))
23759 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23760 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23761 : window_box_right_offset (it
->w
, TEXT_AREA
));
23762 if (EQ (prop
, Qleft_margin
))
23763 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
23764 if (EQ (prop
, Qright_margin
))
23765 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
23766 if (EQ (prop
, Qscroll_bar
))
23767 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
23769 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23770 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23771 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23776 if (EQ (prop
, Qleft_fringe
))
23777 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
23778 if (EQ (prop
, Qright_fringe
))
23779 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
23780 if (EQ (prop
, Qleft_margin
))
23781 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
23782 if (EQ (prop
, Qright_margin
))
23783 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
23784 if (EQ (prop
, Qscroll_bar
))
23785 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
23788 prop
= buffer_local_value_1 (prop
, it
->w
->contents
);
23789 if (EQ (prop
, Qunbound
))
23793 if (INTEGERP (prop
) || FLOATP (prop
))
23795 int base_unit
= (width_p
23796 ? FRAME_COLUMN_WIDTH (it
->f
)
23797 : FRAME_LINE_HEIGHT (it
->f
));
23798 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
23803 Lisp_Object car
= XCAR (prop
);
23804 Lisp_Object cdr
= XCDR (prop
);
23808 #ifdef HAVE_WINDOW_SYSTEM
23809 if (FRAME_WINDOW_P (it
->f
)
23810 && valid_image_p (prop
))
23812 ptrdiff_t id
= lookup_image (it
->f
, prop
);
23813 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
23815 return OK_PIXELS (width_p
? img
->width
: img
->height
);
23818 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
23824 while (CONSP (cdr
))
23826 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
23827 font
, width_p
, align_to
))
23830 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
23835 if (EQ (car
, Qminus
))
23837 return OK_PIXELS (pixels
);
23840 car
= buffer_local_value_1 (car
, it
->w
->contents
);
23841 if (EQ (car
, Qunbound
))
23845 if (INTEGERP (car
) || FLOATP (car
))
23848 pixels
= XFLOATINT (car
);
23850 return OK_PIXELS (pixels
);
23851 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
23852 font
, width_p
, align_to
))
23853 return OK_PIXELS (pixels
* fact
);
23864 /***********************************************************************
23866 ***********************************************************************/
23868 #ifdef HAVE_WINDOW_SYSTEM
23873 dump_glyph_string (struct glyph_string
*s
)
23875 fprintf (stderr
, "glyph string\n");
23876 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
23877 s
->x
, s
->y
, s
->width
, s
->height
);
23878 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
23879 fprintf (stderr
, " hl = %d\n", s
->hl
);
23880 fprintf (stderr
, " left overhang = %d, right = %d\n",
23881 s
->left_overhang
, s
->right_overhang
);
23882 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
23883 fprintf (stderr
, " extends to end of line = %d\n",
23884 s
->extends_to_end_of_line_p
);
23885 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
23886 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
23889 #endif /* GLYPH_DEBUG */
23891 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
23892 of XChar2b structures for S; it can't be allocated in
23893 init_glyph_string because it must be allocated via `alloca'. W
23894 is the window on which S is drawn. ROW and AREA are the glyph row
23895 and area within the row from which S is constructed. START is the
23896 index of the first glyph structure covered by S. HL is a
23897 face-override for drawing S. */
23900 #define OPTIONAL_HDC(hdc) HDC hdc,
23901 #define DECLARE_HDC(hdc) HDC hdc;
23902 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
23903 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
23906 #ifndef OPTIONAL_HDC
23907 #define OPTIONAL_HDC(hdc)
23908 #define DECLARE_HDC(hdc)
23909 #define ALLOCATE_HDC(hdc, f)
23910 #define RELEASE_HDC(hdc, f)
23914 init_glyph_string (struct glyph_string
*s
,
23916 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
23917 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
23919 memset (s
, 0, sizeof *s
);
23921 s
->f
= XFRAME (w
->frame
);
23925 s
->display
= FRAME_X_DISPLAY (s
->f
);
23926 s
->window
= FRAME_X_WINDOW (s
->f
);
23927 s
->char2b
= char2b
;
23931 s
->first_glyph
= row
->glyphs
[area
] + start
;
23932 s
->height
= row
->height
;
23933 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
23934 s
->ybase
= s
->y
+ row
->ascent
;
23938 /* Append the list of glyph strings with head H and tail T to the list
23939 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
23942 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23943 struct glyph_string
*h
, struct glyph_string
*t
)
23957 /* Prepend the list of glyph strings with head H and tail T to the
23958 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
23962 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23963 struct glyph_string
*h
, struct glyph_string
*t
)
23977 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
23978 Set *HEAD and *TAIL to the resulting list. */
23981 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
23982 struct glyph_string
*s
)
23984 s
->next
= s
->prev
= NULL
;
23985 append_glyph_string_lists (head
, tail
, s
, s
);
23989 /* Get face and two-byte form of character C in face FACE_ID on frame F.
23990 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
23991 make sure that X resources for the face returned are allocated.
23992 Value is a pointer to a realized face that is ready for display if
23993 DISPLAY_P is non-zero. */
23995 static struct face
*
23996 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
23997 XChar2b
*char2b
, int display_p
)
23999 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24004 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24006 if (code
== FONT_INVALID_CODE
)
24009 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24011 /* Make sure X resources of the face are allocated. */
24012 #ifdef HAVE_X_WINDOWS
24016 eassert (face
!= NULL
);
24017 PREPARE_FACE_FOR_DISPLAY (f
, face
);
24024 /* Get face and two-byte form of character glyph GLYPH on frame F.
24025 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24026 a pointer to a realized face that is ready for display. */
24028 static struct face
*
24029 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24030 XChar2b
*char2b
, int *two_byte_p
)
24035 eassert (glyph
->type
== CHAR_GLYPH
);
24036 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24038 /* Make sure X resources of the face are allocated. */
24039 eassert (face
!= NULL
);
24040 PREPARE_FACE_FOR_DISPLAY (f
, face
);
24047 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24048 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24050 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24052 if (code
== FONT_INVALID_CODE
)
24056 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24061 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24062 Return 1 if FONT has a glyph for C, otherwise return 0. */
24065 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24069 if (CHAR_BYTE8_P (c
))
24070 code
= CHAR_TO_BYTE8 (c
);
24072 code
= font
->driver
->encode_char (font
, c
);
24074 if (code
== FONT_INVALID_CODE
)
24076 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24081 /* Fill glyph string S with composition components specified by S->cmp.
24083 BASE_FACE is the base face of the composition.
24084 S->cmp_from is the index of the first component for S.
24086 OVERLAPS non-zero means S should draw the foreground only, and use
24087 its physical height for clipping. See also draw_glyphs.
24089 Value is the index of a component not in S. */
24092 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24096 /* For all glyphs of this composition, starting at the offset
24097 S->cmp_from, until we reach the end of the definition or encounter a
24098 glyph that requires the different face, add it to S. */
24103 s
->for_overlaps
= overlaps
;
24106 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24108 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24110 /* TAB in a composition means display glyphs with padding space
24111 on the left or right. */
24114 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24117 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24124 s
->font
= s
->face
->font
;
24126 else if (s
->face
!= face
)
24134 if (s
->face
== NULL
)
24136 s
->face
= base_face
->ascii_face
;
24137 s
->font
= s
->face
->font
;
24140 /* All glyph strings for the same composition has the same width,
24141 i.e. the width set for the first component of the composition. */
24142 s
->width
= s
->first_glyph
->pixel_width
;
24144 /* If the specified font could not be loaded, use the frame's
24145 default font, but record the fact that we couldn't load it in
24146 the glyph string so that we can draw rectangles for the
24147 characters of the glyph string. */
24148 if (s
->font
== NULL
)
24150 s
->font_not_found_p
= 1;
24151 s
->font
= FRAME_FONT (s
->f
);
24154 /* Adjust base line for subscript/superscript text. */
24155 s
->ybase
+= s
->first_glyph
->voffset
;
24157 /* This glyph string must always be drawn with 16-bit functions. */
24164 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24165 int start
, int end
, int overlaps
)
24167 struct glyph
*glyph
, *last
;
24168 Lisp_Object lgstring
;
24171 s
->for_overlaps
= overlaps
;
24172 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24173 last
= s
->row
->glyphs
[s
->area
] + end
;
24174 s
->cmp_id
= glyph
->u
.cmp
.id
;
24175 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24176 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24177 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24178 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24179 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24181 while (glyph
< last
24182 && glyph
->u
.cmp
.automatic
24183 && glyph
->u
.cmp
.id
== s
->cmp_id
24184 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24185 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24187 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24189 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24190 unsigned code
= LGLYPH_CODE (lglyph
);
24192 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24194 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24195 return glyph
- s
->row
->glyphs
[s
->area
];
24199 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24200 See the comment of fill_glyph_string for arguments.
24201 Value is the index of the first glyph not in S. */
24205 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24206 int start
, int end
, int overlaps
)
24208 struct glyph
*glyph
, *last
;
24211 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24212 s
->for_overlaps
= overlaps
;
24213 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24214 last
= s
->row
->glyphs
[s
->area
] + end
;
24215 voffset
= glyph
->voffset
;
24216 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24217 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24219 s
->width
= glyph
->pixel_width
;
24221 while (glyph
< last
24222 && glyph
->type
== GLYPHLESS_GLYPH
24223 && glyph
->voffset
== voffset
24224 && glyph
->face_id
== face_id
)
24227 s
->width
+= glyph
->pixel_width
;
24230 s
->ybase
+= voffset
;
24231 return glyph
- s
->row
->glyphs
[s
->area
];
24235 /* Fill glyph string S from a sequence of character glyphs.
24237 FACE_ID is the face id of the string. START is the index of the
24238 first glyph to consider, END is the index of the last + 1.
24239 OVERLAPS non-zero means S should draw the foreground only, and use
24240 its physical height for clipping. See also draw_glyphs.
24242 Value is the index of the first glyph not in S. */
24245 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24246 int start
, int end
, int overlaps
)
24248 struct glyph
*glyph
, *last
;
24250 int glyph_not_available_p
;
24252 eassert (s
->f
== XFRAME (s
->w
->frame
));
24253 eassert (s
->nchars
== 0);
24254 eassert (start
>= 0 && end
> start
);
24256 s
->for_overlaps
= overlaps
;
24257 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24258 last
= s
->row
->glyphs
[s
->area
] + end
;
24259 voffset
= glyph
->voffset
;
24260 s
->padding_p
= glyph
->padding_p
;
24261 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24263 while (glyph
< last
24264 && glyph
->type
== CHAR_GLYPH
24265 && glyph
->voffset
== voffset
24266 /* Same face id implies same font, nowadays. */
24267 && glyph
->face_id
== face_id
24268 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24272 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24273 s
->char2b
+ s
->nchars
,
24275 s
->two_byte_p
= two_byte_p
;
24277 eassert (s
->nchars
<= end
- start
);
24278 s
->width
+= glyph
->pixel_width
;
24279 if (glyph
++->padding_p
!= s
->padding_p
)
24283 s
->font
= s
->face
->font
;
24285 /* If the specified font could not be loaded, use the frame's font,
24286 but record the fact that we couldn't load it in
24287 S->font_not_found_p so that we can draw rectangles for the
24288 characters of the glyph string. */
24289 if (s
->font
== NULL
|| glyph_not_available_p
)
24291 s
->font_not_found_p
= 1;
24292 s
->font
= FRAME_FONT (s
->f
);
24295 /* Adjust base line for subscript/superscript text. */
24296 s
->ybase
+= voffset
;
24298 eassert (s
->face
&& s
->face
->gc
);
24299 return glyph
- s
->row
->glyphs
[s
->area
];
24303 /* Fill glyph string S from image glyph S->first_glyph. */
24306 fill_image_glyph_string (struct glyph_string
*s
)
24308 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24309 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24311 s
->slice
= s
->first_glyph
->slice
.img
;
24312 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24313 s
->font
= s
->face
->font
;
24314 s
->width
= s
->first_glyph
->pixel_width
;
24316 /* Adjust base line for subscript/superscript text. */
24317 s
->ybase
+= s
->first_glyph
->voffset
;
24321 /* Fill glyph string S from a sequence of stretch glyphs.
24323 START is the index of the first glyph to consider,
24324 END is the index of the last + 1.
24326 Value is the index of the first glyph not in S. */
24329 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24331 struct glyph
*glyph
, *last
;
24332 int voffset
, face_id
;
24334 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24336 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24337 last
= s
->row
->glyphs
[s
->area
] + end
;
24338 face_id
= glyph
->face_id
;
24339 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24340 s
->font
= s
->face
->font
;
24341 s
->width
= glyph
->pixel_width
;
24343 voffset
= glyph
->voffset
;
24347 && glyph
->type
== STRETCH_GLYPH
24348 && glyph
->voffset
== voffset
24349 && glyph
->face_id
== face_id
);
24351 s
->width
+= glyph
->pixel_width
;
24353 /* Adjust base line for subscript/superscript text. */
24354 s
->ybase
+= voffset
;
24356 /* The case that face->gc == 0 is handled when drawing the glyph
24357 string by calling PREPARE_FACE_FOR_DISPLAY. */
24359 return glyph
- s
->row
->glyphs
[s
->area
];
24362 static struct font_metrics
*
24363 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24365 static struct font_metrics metrics
;
24370 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24371 if (code
== FONT_INVALID_CODE
)
24373 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24378 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24379 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24380 assumed to be zero. */
24383 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24385 *left
= *right
= 0;
24387 if (glyph
->type
== CHAR_GLYPH
)
24391 struct font_metrics
*pcm
;
24393 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
24394 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
24396 if (pcm
->rbearing
> pcm
->width
)
24397 *right
= pcm
->rbearing
- pcm
->width
;
24398 if (pcm
->lbearing
< 0)
24399 *left
= -pcm
->lbearing
;
24402 else if (glyph
->type
== COMPOSITE_GLYPH
)
24404 if (! glyph
->u
.cmp
.automatic
)
24406 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24408 if (cmp
->rbearing
> cmp
->pixel_width
)
24409 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24410 if (cmp
->lbearing
< 0)
24411 *left
= - cmp
->lbearing
;
24415 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24416 struct font_metrics metrics
;
24418 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24419 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24420 if (metrics
.rbearing
> metrics
.width
)
24421 *right
= metrics
.rbearing
- metrics
.width
;
24422 if (metrics
.lbearing
< 0)
24423 *left
= - metrics
.lbearing
;
24429 /* Return the index of the first glyph preceding glyph string S that
24430 is overwritten by S because of S's left overhang. Value is -1
24431 if no glyphs are overwritten. */
24434 left_overwritten (struct glyph_string
*s
)
24438 if (s
->left_overhang
)
24441 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24442 int first
= s
->first_glyph
- glyphs
;
24444 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24445 x
-= glyphs
[i
].pixel_width
;
24456 /* Return the index of the first glyph preceding glyph string S that
24457 is overwriting S because of its right overhang. Value is -1 if no
24458 glyph in front of S overwrites S. */
24461 left_overwriting (struct glyph_string
*s
)
24464 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24465 int first
= s
->first_glyph
- glyphs
;
24469 for (i
= first
- 1; i
>= 0; --i
)
24472 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24475 x
-= glyphs
[i
].pixel_width
;
24482 /* Return the index of the last glyph following glyph string S that is
24483 overwritten by S because of S's right overhang. Value is -1 if
24484 no such glyph is found. */
24487 right_overwritten (struct glyph_string
*s
)
24491 if (s
->right_overhang
)
24494 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24495 int first
= (s
->first_glyph
- glyphs
24496 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24497 int end
= s
->row
->used
[s
->area
];
24499 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24500 x
+= glyphs
[i
].pixel_width
;
24509 /* Return the index of the last glyph following glyph string S that
24510 overwrites S because of its left overhang. Value is negative
24511 if no such glyph is found. */
24514 right_overwriting (struct glyph_string
*s
)
24517 int end
= s
->row
->used
[s
->area
];
24518 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24519 int first
= (s
->first_glyph
- glyphs
24520 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24524 for (i
= first
; i
< end
; ++i
)
24527 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24530 x
+= glyphs
[i
].pixel_width
;
24537 /* Set background width of glyph string S. START is the index of the
24538 first glyph following S. LAST_X is the right-most x-position + 1
24539 in the drawing area. */
24542 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24544 /* If the face of this glyph string has to be drawn to the end of
24545 the drawing area, set S->extends_to_end_of_line_p. */
24547 if (start
== s
->row
->used
[s
->area
]
24548 && ((s
->row
->fill_line_p
24549 && (s
->hl
== DRAW_NORMAL_TEXT
24550 || s
->hl
== DRAW_IMAGE_RAISED
24551 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24552 || s
->hl
== DRAW_MOUSE_FACE
))
24553 s
->extends_to_end_of_line_p
= 1;
24555 /* If S extends its face to the end of the line, set its
24556 background_width to the distance to the right edge of the drawing
24558 if (s
->extends_to_end_of_line_p
)
24559 s
->background_width
= last_x
- s
->x
+ 1;
24561 s
->background_width
= s
->width
;
24565 /* Compute overhangs and x-positions for glyph string S and its
24566 predecessors, or successors. X is the starting x-position for S.
24567 BACKWARD_P non-zero means process predecessors. */
24570 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
24576 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24577 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24587 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24588 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24598 /* The following macros are only called from draw_glyphs below.
24599 They reference the following parameters of that function directly:
24600 `w', `row', `area', and `overlap_p'
24601 as well as the following local variables:
24602 `s', `f', and `hdc' (in W32) */
24605 /* On W32, silently add local `hdc' variable to argument list of
24606 init_glyph_string. */
24607 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24608 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24610 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24611 init_glyph_string (s, char2b, w, row, area, start, hl)
24614 /* Add a glyph string for a stretch glyph to the list of strings
24615 between HEAD and TAIL. START is the index of the stretch glyph in
24616 row area AREA of glyph row ROW. END is the index of the last glyph
24617 in that glyph row area. X is the current output position assigned
24618 to the new glyph string constructed. HL overrides that face of the
24619 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24620 is the right-most x-position of the drawing area. */
24622 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24623 and below -- keep them on one line. */
24624 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24627 s = alloca (sizeof *s); \
24628 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24629 START = fill_stretch_glyph_string (s, START, END); \
24630 append_glyph_string (&HEAD, &TAIL, s); \
24636 /* Add a glyph string for an image glyph to the list of strings
24637 between HEAD and TAIL. START is the index of the image glyph in
24638 row area AREA of glyph row ROW. END is the index of the last glyph
24639 in that glyph row area. X is the current output position assigned
24640 to the new glyph string constructed. HL overrides that face of the
24641 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24642 is the right-most x-position of the drawing area. */
24644 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24647 s = alloca (sizeof *s); \
24648 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24649 fill_image_glyph_string (s); \
24650 append_glyph_string (&HEAD, &TAIL, s); \
24657 /* Add a glyph string for a sequence of character glyphs to the list
24658 of strings between HEAD and TAIL. START is the index of the first
24659 glyph in row area AREA of glyph row ROW that is part of the new
24660 glyph string. END is the index of the last glyph in that glyph row
24661 area. X is the current output position assigned to the new glyph
24662 string constructed. HL overrides that face of the glyph; e.g. it
24663 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24664 right-most x-position of the drawing area. */
24666 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24672 face_id = (row)->glyphs[area][START].face_id; \
24674 s = alloca (sizeof *s); \
24675 char2b = alloca ((END - START) * sizeof *char2b); \
24676 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24677 append_glyph_string (&HEAD, &TAIL, s); \
24679 START = fill_glyph_string (s, face_id, START, END, overlaps); \
24684 /* Add a glyph string for a composite sequence to the list of strings
24685 between HEAD and TAIL. START is the index of the first glyph in
24686 row area AREA of glyph row ROW that is part of the new glyph
24687 string. END is the index of the last glyph in that glyph row area.
24688 X is the current output position assigned to the new glyph string
24689 constructed. HL overrides that face of the glyph; e.g. it is
24690 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
24691 x-position of the drawing area. */
24693 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24695 int face_id = (row)->glyphs[area][START].face_id; \
24696 struct face *base_face = FACE_FROM_ID (f, face_id); \
24697 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
24698 struct composition *cmp = composition_table[cmp_id]; \
24700 struct glyph_string *first_s = NULL; \
24703 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
24705 /* Make glyph_strings for each glyph sequence that is drawable by \
24706 the same face, and append them to HEAD/TAIL. */ \
24707 for (n = 0; n < cmp->glyph_len;) \
24709 s = alloca (sizeof *s); \
24710 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24711 append_glyph_string (&(HEAD), &(TAIL), s); \
24717 n = fill_composite_glyph_string (s, base_face, overlaps); \
24725 /* Add a glyph string for a glyph-string sequence to the list of strings
24726 between HEAD and TAIL. */
24728 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24732 Lisp_Object gstring; \
24734 face_id = (row)->glyphs[area][START].face_id; \
24735 gstring = (composition_gstring_from_id \
24736 ((row)->glyphs[area][START].u.cmp.id)); \
24737 s = alloca (sizeof *s); \
24738 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
24739 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24740 append_glyph_string (&(HEAD), &(TAIL), s); \
24742 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
24746 /* Add a glyph string for a sequence of glyphless character's glyphs
24747 to the list of strings between HEAD and TAIL. The meanings of
24748 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
24750 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24755 face_id = (row)->glyphs[area][START].face_id; \
24757 s = alloca (sizeof *s); \
24758 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24759 append_glyph_string (&HEAD, &TAIL, s); \
24761 START = fill_glyphless_glyph_string (s, face_id, START, END, \
24767 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
24768 of AREA of glyph row ROW on window W between indices START and END.
24769 HL overrides the face for drawing glyph strings, e.g. it is
24770 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
24771 x-positions of the drawing area.
24773 This is an ugly monster macro construct because we must use alloca
24774 to allocate glyph strings (because draw_glyphs can be called
24775 asynchronously). */
24777 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24780 HEAD = TAIL = NULL; \
24781 while (START < END) \
24783 struct glyph *first_glyph = (row)->glyphs[area] + START; \
24784 switch (first_glyph->type) \
24787 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
24791 case COMPOSITE_GLYPH: \
24792 if (first_glyph->u.cmp.automatic) \
24793 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
24796 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
24800 case STRETCH_GLYPH: \
24801 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
24805 case IMAGE_GLYPH: \
24806 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
24810 case GLYPHLESS_GLYPH: \
24811 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
24821 set_glyph_string_background_width (s, START, LAST_X); \
24828 /* Draw glyphs between START and END in AREA of ROW on window W,
24829 starting at x-position X. X is relative to AREA in W. HL is a
24830 face-override with the following meaning:
24832 DRAW_NORMAL_TEXT draw normally
24833 DRAW_CURSOR draw in cursor face
24834 DRAW_MOUSE_FACE draw in mouse face.
24835 DRAW_INVERSE_VIDEO draw in mode line face
24836 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
24837 DRAW_IMAGE_RAISED draw an image with a raised relief around it
24839 If OVERLAPS is non-zero, draw only the foreground of characters and
24840 clip to the physical height of ROW. Non-zero value also defines
24841 the overlapping part to be drawn:
24843 OVERLAPS_PRED overlap with preceding rows
24844 OVERLAPS_SUCC overlap with succeeding rows
24845 OVERLAPS_BOTH overlap with both preceding/succeeding rows
24846 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
24848 Value is the x-position reached, relative to AREA of W. */
24851 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
24852 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
24853 enum draw_glyphs_face hl
, int overlaps
)
24855 struct glyph_string
*head
, *tail
;
24856 struct glyph_string
*s
;
24857 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
24858 int i
, j
, x_reached
, last_x
, area_left
= 0;
24859 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24862 ALLOCATE_HDC (hdc
, f
);
24864 /* Let's rather be paranoid than getting a SEGV. */
24865 end
= min (end
, row
->used
[area
]);
24866 start
= clip_to_bounds (0, start
, end
);
24868 /* Translate X to frame coordinates. Set last_x to the right
24869 end of the drawing area. */
24870 if (row
->full_width_p
)
24872 /* X is relative to the left edge of W, without scroll bars
24874 area_left
= WINDOW_LEFT_EDGE_X (w
);
24875 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
24876 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
24880 area_left
= window_box_left (w
, area
);
24881 last_x
= area_left
+ window_box_width (w
, area
);
24885 /* Build a doubly-linked list of glyph_string structures between
24886 head and tail from what we have to draw. Note that the macro
24887 BUILD_GLYPH_STRINGS will modify its start parameter. That's
24888 the reason we use a separate variable `i'. */
24890 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
24892 x_reached
= tail
->x
+ tail
->background_width
;
24896 /* If there are any glyphs with lbearing < 0 or rbearing > width in
24897 the row, redraw some glyphs in front or following the glyph
24898 strings built above. */
24899 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
24901 struct glyph_string
*h
, *t
;
24902 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24903 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
24904 int check_mouse_face
= 0;
24907 /* If mouse highlighting is on, we may need to draw adjacent
24908 glyphs using mouse-face highlighting. */
24909 if (area
== TEXT_AREA
&& row
->mouse_face_p
24910 && hlinfo
->mouse_face_beg_row
>= 0
24911 && hlinfo
->mouse_face_end_row
>= 0)
24913 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
24915 if (row_vpos
>= hlinfo
->mouse_face_beg_row
24916 && row_vpos
<= hlinfo
->mouse_face_end_row
)
24918 check_mouse_face
= 1;
24919 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
24920 ? hlinfo
->mouse_face_beg_col
: 0;
24921 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
24922 ? hlinfo
->mouse_face_end_col
24923 : row
->used
[TEXT_AREA
];
24927 /* Compute overhangs for all glyph strings. */
24928 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
24929 for (s
= head
; s
; s
= s
->next
)
24930 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
24932 /* Prepend glyph strings for glyphs in front of the first glyph
24933 string that are overwritten because of the first glyph
24934 string's left overhang. The background of all strings
24935 prepended must be drawn because the first glyph string
24937 i
= left_overwritten (head
);
24940 enum draw_glyphs_face overlap_hl
;
24942 /* If this row contains mouse highlighting, attempt to draw
24943 the overlapped glyphs with the correct highlight. This
24944 code fails if the overlap encompasses more than one glyph
24945 and mouse-highlight spans only some of these glyphs.
24946 However, making it work perfectly involves a lot more
24947 code, and I don't know if the pathological case occurs in
24948 practice, so we'll stick to this for now. --- cyd */
24949 if (check_mouse_face
24950 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24951 overlap_hl
= DRAW_MOUSE_FACE
;
24953 overlap_hl
= DRAW_NORMAL_TEXT
;
24955 if (hl
!= overlap_hl
)
24958 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
24959 overlap_hl
, dummy_x
, last_x
);
24961 compute_overhangs_and_x (t
, head
->x
, 1);
24962 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24963 if (clip_head
== NULL
)
24967 /* Prepend glyph strings for glyphs in front of the first glyph
24968 string that overwrite that glyph string because of their
24969 right overhang. For these strings, only the foreground must
24970 be drawn, because it draws over the glyph string at `head'.
24971 The background must not be drawn because this would overwrite
24972 right overhangs of preceding glyphs for which no glyph
24974 i
= left_overwriting (head
);
24977 enum draw_glyphs_face overlap_hl
;
24979 if (check_mouse_face
24980 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24981 overlap_hl
= DRAW_MOUSE_FACE
;
24983 overlap_hl
= DRAW_NORMAL_TEXT
;
24985 if (hl
== overlap_hl
|| clip_head
== NULL
)
24987 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
24988 overlap_hl
, dummy_x
, last_x
);
24989 for (s
= h
; s
; s
= s
->next
)
24990 s
->background_filled_p
= 1;
24991 compute_overhangs_and_x (t
, head
->x
, 1);
24992 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24995 /* Append glyphs strings for glyphs following the last glyph
24996 string tail that are overwritten by tail. The background of
24997 these strings has to be drawn because tail's foreground draws
24999 i
= right_overwritten (tail
);
25002 enum draw_glyphs_face overlap_hl
;
25004 if (check_mouse_face
25005 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25006 overlap_hl
= DRAW_MOUSE_FACE
;
25008 overlap_hl
= DRAW_NORMAL_TEXT
;
25010 if (hl
!= overlap_hl
)
25012 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25013 overlap_hl
, x
, last_x
);
25014 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25015 we don't have `end = i;' here. */
25016 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
25017 append_glyph_string_lists (&head
, &tail
, h
, t
);
25018 if (clip_tail
== NULL
)
25022 /* Append glyph strings for glyphs following the last glyph
25023 string tail that overwrite tail. The foreground of such
25024 glyphs has to be drawn because it writes into the background
25025 of tail. The background must not be drawn because it could
25026 paint over the foreground of following glyphs. */
25027 i
= right_overwriting (tail
);
25030 enum draw_glyphs_face overlap_hl
;
25031 if (check_mouse_face
25032 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25033 overlap_hl
= DRAW_MOUSE_FACE
;
25035 overlap_hl
= DRAW_NORMAL_TEXT
;
25037 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25039 i
++; /* We must include the Ith glyph. */
25040 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25041 overlap_hl
, x
, last_x
);
25042 for (s
= h
; s
; s
= s
->next
)
25043 s
->background_filled_p
= 1;
25044 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
25045 append_glyph_string_lists (&head
, &tail
, h
, t
);
25047 if (clip_head
|| clip_tail
)
25048 for (s
= head
; s
; s
= s
->next
)
25050 s
->clip_head
= clip_head
;
25051 s
->clip_tail
= clip_tail
;
25055 /* Draw all strings. */
25056 for (s
= head
; s
; s
= s
->next
)
25057 FRAME_RIF (f
)->draw_glyph_string (s
);
25060 /* When focus a sole frame and move horizontally, this sets on_p to 0
25061 causing a failure to erase prev cursor position. */
25062 if (area
== TEXT_AREA
25063 && !row
->full_width_p
25064 /* When drawing overlapping rows, only the glyph strings'
25065 foreground is drawn, which doesn't erase a cursor
25069 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25070 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25071 : (tail
? tail
->x
+ tail
->background_width
: x
));
25075 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25076 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25080 /* Value is the x-position up to which drawn, relative to AREA of W.
25081 This doesn't include parts drawn because of overhangs. */
25082 if (row
->full_width_p
)
25083 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25085 x_reached
-= area_left
;
25087 RELEASE_HDC (hdc
, f
);
25092 /* Expand row matrix if too narrow. Don't expand if area
25095 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25097 if (!it->f->fonts_changed \
25098 && (it->glyph_row->glyphs[area] \
25099 < it->glyph_row->glyphs[area + 1])) \
25101 it->w->ncols_scale_factor++; \
25102 it->f->fonts_changed = 1; \
25106 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25107 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25110 append_glyph (struct it
*it
)
25112 struct glyph
*glyph
;
25113 enum glyph_row_area area
= it
->area
;
25115 eassert (it
->glyph_row
);
25116 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25118 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25119 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25121 /* If the glyph row is reversed, we need to prepend the glyph
25122 rather than append it. */
25123 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25127 /* Make room for the additional glyph. */
25128 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25130 glyph
= it
->glyph_row
->glyphs
[area
];
25132 glyph
->charpos
= CHARPOS (it
->position
);
25133 glyph
->object
= it
->object
;
25134 if (it
->pixel_width
> 0)
25136 glyph
->pixel_width
= it
->pixel_width
;
25137 glyph
->padding_p
= 0;
25141 /* Assure at least 1-pixel width. Otherwise, cursor can't
25142 be displayed correctly. */
25143 glyph
->pixel_width
= 1;
25144 glyph
->padding_p
= 1;
25146 glyph
->ascent
= it
->ascent
;
25147 glyph
->descent
= it
->descent
;
25148 glyph
->voffset
= it
->voffset
;
25149 glyph
->type
= CHAR_GLYPH
;
25150 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25151 glyph
->multibyte_p
= it
->multibyte_p
;
25152 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25154 /* In R2L rows, the left and the right box edges need to be
25155 drawn in reverse direction. */
25156 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25157 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25161 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25162 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25164 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25165 || it
->phys_descent
> it
->descent
);
25166 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25167 glyph
->face_id
= it
->face_id
;
25168 glyph
->u
.ch
= it
->char_to_display
;
25169 glyph
->slice
.img
= null_glyph_slice
;
25170 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25173 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25174 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25176 glyph
->bidi_type
= it
->bidi_it
.type
;
25180 glyph
->resolved_level
= 0;
25181 glyph
->bidi_type
= UNKNOWN_BT
;
25183 ++it
->glyph_row
->used
[area
];
25186 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25189 /* Store one glyph for the composition IT->cmp_it.id in
25190 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25194 append_composite_glyph (struct it
*it
)
25196 struct glyph
*glyph
;
25197 enum glyph_row_area area
= it
->area
;
25199 eassert (it
->glyph_row
);
25201 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25202 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25204 /* If the glyph row is reversed, we need to prepend the glyph
25205 rather than append it. */
25206 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25210 /* Make room for the new glyph. */
25211 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25213 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25215 glyph
->charpos
= it
->cmp_it
.charpos
;
25216 glyph
->object
= it
->object
;
25217 glyph
->pixel_width
= it
->pixel_width
;
25218 glyph
->ascent
= it
->ascent
;
25219 glyph
->descent
= it
->descent
;
25220 glyph
->voffset
= it
->voffset
;
25221 glyph
->type
= COMPOSITE_GLYPH
;
25222 if (it
->cmp_it
.ch
< 0)
25224 glyph
->u
.cmp
.automatic
= 0;
25225 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25226 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25230 glyph
->u
.cmp
.automatic
= 1;
25231 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25232 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25233 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25235 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25236 glyph
->multibyte_p
= it
->multibyte_p
;
25237 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25239 /* In R2L rows, the left and the right box edges need to be
25240 drawn in reverse direction. */
25241 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25242 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25246 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25247 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25249 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25250 || it
->phys_descent
> it
->descent
);
25251 glyph
->padding_p
= 0;
25252 glyph
->glyph_not_available_p
= 0;
25253 glyph
->face_id
= it
->face_id
;
25254 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25257 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25258 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25260 glyph
->bidi_type
= it
->bidi_it
.type
;
25262 ++it
->glyph_row
->used
[area
];
25265 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25269 /* Change IT->ascent and IT->height according to the setting of
25273 take_vertical_position_into_account (struct it
*it
)
25277 if (it
->voffset
< 0)
25278 /* Increase the ascent so that we can display the text higher
25280 it
->ascent
-= it
->voffset
;
25282 /* Increase the descent so that we can display the text lower
25284 it
->descent
+= it
->voffset
;
25289 /* Produce glyphs/get display metrics for the image IT is loaded with.
25290 See the description of struct display_iterator in dispextern.h for
25291 an overview of struct display_iterator. */
25294 produce_image_glyph (struct it
*it
)
25298 int glyph_ascent
, crop
;
25299 struct glyph_slice slice
;
25301 eassert (it
->what
== IT_IMAGE
);
25303 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25305 /* Make sure X resources of the face is loaded. */
25306 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
25308 if (it
->image_id
< 0)
25310 /* Fringe bitmap. */
25311 it
->ascent
= it
->phys_ascent
= 0;
25312 it
->descent
= it
->phys_descent
= 0;
25313 it
->pixel_width
= 0;
25318 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25320 /* Make sure X resources of the image is loaded. */
25321 prepare_image_for_display (it
->f
, img
);
25323 slice
.x
= slice
.y
= 0;
25324 slice
.width
= img
->width
;
25325 slice
.height
= img
->height
;
25327 if (INTEGERP (it
->slice
.x
))
25328 slice
.x
= XINT (it
->slice
.x
);
25329 else if (FLOATP (it
->slice
.x
))
25330 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25332 if (INTEGERP (it
->slice
.y
))
25333 slice
.y
= XINT (it
->slice
.y
);
25334 else if (FLOATP (it
->slice
.y
))
25335 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25337 if (INTEGERP (it
->slice
.width
))
25338 slice
.width
= XINT (it
->slice
.width
);
25339 else if (FLOATP (it
->slice
.width
))
25340 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25342 if (INTEGERP (it
->slice
.height
))
25343 slice
.height
= XINT (it
->slice
.height
);
25344 else if (FLOATP (it
->slice
.height
))
25345 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25347 if (slice
.x
>= img
->width
)
25348 slice
.x
= img
->width
;
25349 if (slice
.y
>= img
->height
)
25350 slice
.y
= img
->height
;
25351 if (slice
.x
+ slice
.width
>= img
->width
)
25352 slice
.width
= img
->width
- slice
.x
;
25353 if (slice
.y
+ slice
.height
> img
->height
)
25354 slice
.height
= img
->height
- slice
.y
;
25356 if (slice
.width
== 0 || slice
.height
== 0)
25359 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25361 it
->descent
= slice
.height
- glyph_ascent
;
25363 it
->descent
+= img
->vmargin
;
25364 if (slice
.y
+ slice
.height
== img
->height
)
25365 it
->descent
+= img
->vmargin
;
25366 it
->phys_descent
= it
->descent
;
25368 it
->pixel_width
= slice
.width
;
25370 it
->pixel_width
+= img
->hmargin
;
25371 if (slice
.x
+ slice
.width
== img
->width
)
25372 it
->pixel_width
+= img
->hmargin
;
25374 /* It's quite possible for images to have an ascent greater than
25375 their height, so don't get confused in that case. */
25376 if (it
->descent
< 0)
25381 if (face
->box
!= FACE_NO_BOX
)
25383 if (face
->box_line_width
> 0)
25386 it
->ascent
+= face
->box_line_width
;
25387 if (slice
.y
+ slice
.height
== img
->height
)
25388 it
->descent
+= face
->box_line_width
;
25391 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25392 it
->pixel_width
+= eabs (face
->box_line_width
);
25393 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25394 it
->pixel_width
+= eabs (face
->box_line_width
);
25397 take_vertical_position_into_account (it
);
25399 /* Automatically crop wide image glyphs at right edge so we can
25400 draw the cursor on same display row. */
25401 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25402 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25404 it
->pixel_width
-= crop
;
25405 slice
.width
-= crop
;
25410 struct glyph
*glyph
;
25411 enum glyph_row_area area
= it
->area
;
25413 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25414 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25416 glyph
->charpos
= CHARPOS (it
->position
);
25417 glyph
->object
= it
->object
;
25418 glyph
->pixel_width
= it
->pixel_width
;
25419 glyph
->ascent
= glyph_ascent
;
25420 glyph
->descent
= it
->descent
;
25421 glyph
->voffset
= it
->voffset
;
25422 glyph
->type
= IMAGE_GLYPH
;
25423 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25424 glyph
->multibyte_p
= it
->multibyte_p
;
25425 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25427 /* In R2L rows, the left and the right box edges need to be
25428 drawn in reverse direction. */
25429 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25430 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25434 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25435 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25437 glyph
->overlaps_vertically_p
= 0;
25438 glyph
->padding_p
= 0;
25439 glyph
->glyph_not_available_p
= 0;
25440 glyph
->face_id
= it
->face_id
;
25441 glyph
->u
.img_id
= img
->id
;
25442 glyph
->slice
.img
= slice
;
25443 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25446 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25447 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25449 glyph
->bidi_type
= it
->bidi_it
.type
;
25451 ++it
->glyph_row
->used
[area
];
25454 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25459 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25460 of the glyph, WIDTH and HEIGHT are the width and height of the
25461 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25464 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25465 int width
, int height
, int ascent
)
25467 struct glyph
*glyph
;
25468 enum glyph_row_area area
= it
->area
;
25470 eassert (ascent
>= 0 && ascent
<= height
);
25472 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25473 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25475 /* If the glyph row is reversed, we need to prepend the glyph
25476 rather than append it. */
25477 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25481 /* Make room for the additional glyph. */
25482 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25484 glyph
= it
->glyph_row
->glyphs
[area
];
25486 /* Decrease the width of the first glyph of the row that
25487 begins before first_visible_x (e.g., due to hscroll).
25488 This is so the overall width of the row becomes smaller
25489 by the scroll amount, and the stretch glyph appended by
25490 extend_face_to_end_of_line will be wider, to shift the
25491 row glyphs to the right. (In L2R rows, the corresponding
25492 left-shift effect is accomplished by setting row->x to a
25493 negative value, which won't work with R2L rows.)
25495 This must leave us with a positive value of WIDTH, since
25496 otherwise the call to move_it_in_display_line_to at the
25497 beginning of display_line would have got past the entire
25498 first glyph, and then it->current_x would have been
25499 greater or equal to it->first_visible_x. */
25500 if (it
->current_x
< it
->first_visible_x
)
25501 width
-= it
->first_visible_x
- it
->current_x
;
25502 eassert (width
> 0);
25504 glyph
->charpos
= CHARPOS (it
->position
);
25505 glyph
->object
= object
;
25506 glyph
->pixel_width
= width
;
25507 glyph
->ascent
= ascent
;
25508 glyph
->descent
= height
- ascent
;
25509 glyph
->voffset
= it
->voffset
;
25510 glyph
->type
= STRETCH_GLYPH
;
25511 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25512 glyph
->multibyte_p
= it
->multibyte_p
;
25513 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25515 /* In R2L rows, the left and the right box edges need to be
25516 drawn in reverse direction. */
25517 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25518 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25522 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25523 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25525 glyph
->overlaps_vertically_p
= 0;
25526 glyph
->padding_p
= 0;
25527 glyph
->glyph_not_available_p
= 0;
25528 glyph
->face_id
= it
->face_id
;
25529 glyph
->u
.stretch
.ascent
= ascent
;
25530 glyph
->u
.stretch
.height
= height
;
25531 glyph
->slice
.img
= null_glyph_slice
;
25532 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25535 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25536 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25538 glyph
->bidi_type
= it
->bidi_it
.type
;
25542 glyph
->resolved_level
= 0;
25543 glyph
->bidi_type
= UNKNOWN_BT
;
25545 ++it
->glyph_row
->used
[area
];
25548 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25551 #endif /* HAVE_WINDOW_SYSTEM */
25553 /* Produce a stretch glyph for iterator IT. IT->object is the value
25554 of the glyph property displayed. The value must be a list
25555 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25558 1. `:width WIDTH' specifies that the space should be WIDTH *
25559 canonical char width wide. WIDTH may be an integer or floating
25562 2. `:relative-width FACTOR' specifies that the width of the stretch
25563 should be computed from the width of the first character having the
25564 `glyph' property, and should be FACTOR times that width.
25566 3. `:align-to HPOS' specifies that the space should be wide enough
25567 to reach HPOS, a value in canonical character units.
25569 Exactly one of the above pairs must be present.
25571 4. `:height HEIGHT' specifies that the height of the stretch produced
25572 should be HEIGHT, measured in canonical character units.
25574 5. `:relative-height FACTOR' specifies that the height of the
25575 stretch should be FACTOR times the height of the characters having
25576 the glyph property.
25578 Either none or exactly one of 4 or 5 must be present.
25580 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25581 of the stretch should be used for the ascent of the stretch.
25582 ASCENT must be in the range 0 <= ASCENT <= 100. */
25585 produce_stretch_glyph (struct it
*it
)
25587 /* (space :width WIDTH :height HEIGHT ...) */
25588 Lisp_Object prop
, plist
;
25589 int width
= 0, height
= 0, align_to
= -1;
25590 int zero_width_ok_p
= 0;
25592 struct font
*font
= NULL
;
25594 #ifdef HAVE_WINDOW_SYSTEM
25596 int zero_height_ok_p
= 0;
25598 if (FRAME_WINDOW_P (it
->f
))
25600 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25601 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25602 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
25606 /* List should start with `space'. */
25607 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
25608 plist
= XCDR (it
->object
);
25610 /* Compute the width of the stretch. */
25611 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
25612 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
25614 /* Absolute width `:width WIDTH' specified and valid. */
25615 zero_width_ok_p
= 1;
25618 #ifdef HAVE_WINDOW_SYSTEM
25619 else if (FRAME_WINDOW_P (it
->f
)
25620 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
25622 /* Relative width `:relative-width FACTOR' specified and valid.
25623 Compute the width of the characters having the `glyph'
25626 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
25629 if (it
->multibyte_p
)
25630 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
25633 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
25634 if (! ASCII_CHAR_P (it2
.c
))
25635 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
25638 it2
.glyph_row
= NULL
;
25639 it2
.what
= IT_CHARACTER
;
25640 x_produce_glyphs (&it2
);
25641 width
= NUMVAL (prop
) * it2
.pixel_width
;
25643 #endif /* HAVE_WINDOW_SYSTEM */
25644 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
25645 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
25647 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
25648 align_to
= (align_to
< 0
25650 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
25651 else if (align_to
< 0)
25652 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
25653 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
25654 zero_width_ok_p
= 1;
25657 /* Nothing specified -> width defaults to canonical char width. */
25658 width
= FRAME_COLUMN_WIDTH (it
->f
);
25660 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
25663 #ifdef HAVE_WINDOW_SYSTEM
25664 /* Compute height. */
25665 if (FRAME_WINDOW_P (it
->f
))
25667 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
25668 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25671 zero_height_ok_p
= 1;
25673 else if (prop
= Fplist_get (plist
, QCrelative_height
),
25675 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
25677 height
= FONT_HEIGHT (font
);
25679 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
25682 /* Compute percentage of height used for ascent. If
25683 `:ascent ASCENT' is present and valid, use that. Otherwise,
25684 derive the ascent from the font in use. */
25685 if (prop
= Fplist_get (plist
, QCascent
),
25686 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
25687 ascent
= height
* NUMVAL (prop
) / 100.0;
25688 else if (!NILP (prop
)
25689 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25690 ascent
= min (max (0, (int)tem
), height
);
25692 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
25695 #endif /* HAVE_WINDOW_SYSTEM */
25698 if (width
> 0 && it
->line_wrap
!= TRUNCATE
25699 && it
->current_x
+ width
> it
->last_visible_x
)
25701 width
= it
->last_visible_x
- it
->current_x
;
25702 #ifdef HAVE_WINDOW_SYSTEM
25703 /* Subtract one more pixel from the stretch width, but only on
25704 GUI frames, since on a TTY each glyph is one "pixel" wide. */
25705 width
-= FRAME_WINDOW_P (it
->f
);
25709 if (width
> 0 && height
> 0 && it
->glyph_row
)
25711 Lisp_Object o_object
= it
->object
;
25712 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
25715 if (!STRINGP (object
))
25716 object
= it
->w
->contents
;
25717 #ifdef HAVE_WINDOW_SYSTEM
25718 if (FRAME_WINDOW_P (it
->f
))
25719 append_stretch_glyph (it
, object
, width
, height
, ascent
);
25723 it
->object
= object
;
25724 it
->char_to_display
= ' ';
25725 it
->pixel_width
= it
->len
= 1;
25727 tty_append_glyph (it
);
25728 it
->object
= o_object
;
25732 it
->pixel_width
= width
;
25733 #ifdef HAVE_WINDOW_SYSTEM
25734 if (FRAME_WINDOW_P (it
->f
))
25736 it
->ascent
= it
->phys_ascent
= ascent
;
25737 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
25738 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
25739 take_vertical_position_into_account (it
);
25743 it
->nglyphs
= width
;
25746 /* Get information about special display element WHAT in an
25747 environment described by IT. WHAT is one of IT_TRUNCATION or
25748 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
25749 non-null glyph_row member. This function ensures that fields like
25750 face_id, c, len of IT are left untouched. */
25753 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
25760 temp_it
.object
= make_number (0);
25761 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
25763 if (what
== IT_CONTINUATION
)
25765 /* Continuation glyph. For R2L lines, we mirror it by hand. */
25766 if (it
->bidi_it
.paragraph_dir
== R2L
)
25767 SET_GLYPH_FROM_CHAR (glyph
, '/');
25769 SET_GLYPH_FROM_CHAR (glyph
, '\\');
25771 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25773 /* FIXME: Should we mirror GC for R2L lines? */
25774 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25775 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25778 else if (what
== IT_TRUNCATION
)
25780 /* Truncation glyph. */
25781 SET_GLYPH_FROM_CHAR (glyph
, '$');
25783 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25785 /* FIXME: Should we mirror GC for R2L lines? */
25786 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25787 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25793 #ifdef HAVE_WINDOW_SYSTEM
25794 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
25795 is turned off, we precede the truncation/continuation glyphs by a
25796 stretch glyph whose width is computed such that these special
25797 glyphs are aligned at the window margin, even when very different
25798 fonts are used in different glyph rows. */
25799 if (FRAME_WINDOW_P (temp_it
.f
)
25800 /* init_iterator calls this with it->glyph_row == NULL, and it
25801 wants only the pixel width of the truncation/continuation
25803 && temp_it
.glyph_row
25804 /* insert_left_trunc_glyphs calls us at the beginning of the
25805 row, and it has its own calculation of the stretch glyph
25807 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
25808 && (temp_it
.glyph_row
->reversed_p
25809 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
25810 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
25812 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
25814 if (stretch_width
> 0)
25816 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
25817 struct font
*font
=
25818 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
25819 int stretch_ascent
=
25820 (((temp_it
.ascent
+ temp_it
.descent
)
25821 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
25823 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
25824 temp_it
.ascent
+ temp_it
.descent
,
25831 temp_it
.what
= IT_CHARACTER
;
25832 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
25833 temp_it
.face_id
= GLYPH_FACE (glyph
);
25834 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
25836 PRODUCE_GLYPHS (&temp_it
);
25837 it
->pixel_width
= temp_it
.pixel_width
;
25838 it
->nglyphs
= temp_it
.nglyphs
;
25841 #ifdef HAVE_WINDOW_SYSTEM
25843 /* Calculate line-height and line-spacing properties.
25844 An integer value specifies explicit pixel value.
25845 A float value specifies relative value to current face height.
25846 A cons (float . face-name) specifies relative value to
25847 height of specified face font.
25849 Returns height in pixels, or nil. */
25853 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
25854 int boff
, int override
)
25856 Lisp_Object face_name
= Qnil
;
25857 int ascent
, descent
, height
;
25859 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
25864 face_name
= XCAR (val
);
25866 if (!NUMBERP (val
))
25867 val
= make_number (1);
25868 if (NILP (face_name
))
25870 height
= it
->ascent
+ it
->descent
;
25875 if (NILP (face_name
))
25877 font
= FRAME_FONT (it
->f
);
25878 boff
= FRAME_BASELINE_OFFSET (it
->f
);
25880 else if (EQ (face_name
, Qt
))
25889 face_id
= lookup_named_face (it
->f
, face_name
, 0);
25891 return make_number (-1);
25893 face
= FACE_FROM_ID (it
->f
, face_id
);
25896 return make_number (-1);
25897 boff
= font
->baseline_offset
;
25898 if (font
->vertical_centering
)
25899 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25902 ascent
= FONT_BASE (font
) + boff
;
25903 descent
= FONT_DESCENT (font
) - boff
;
25907 it
->override_ascent
= ascent
;
25908 it
->override_descent
= descent
;
25909 it
->override_boff
= boff
;
25912 height
= ascent
+ descent
;
25916 height
= (int)(XFLOAT_DATA (val
) * height
);
25917 else if (INTEGERP (val
))
25918 height
*= XINT (val
);
25920 return make_number (height
);
25924 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
25925 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
25926 and only if this is for a character for which no font was found.
25928 If the display method (it->glyphless_method) is
25929 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
25930 length of the acronym or the hexadecimal string, UPPER_XOFF and
25931 UPPER_YOFF are pixel offsets for the upper part of the string,
25932 LOWER_XOFF and LOWER_YOFF are for the lower part.
25934 For the other display methods, LEN through LOWER_YOFF are zero. */
25937 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
25938 short upper_xoff
, short upper_yoff
,
25939 short lower_xoff
, short lower_yoff
)
25941 struct glyph
*glyph
;
25942 enum glyph_row_area area
= it
->area
;
25944 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25945 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25947 /* If the glyph row is reversed, we need to prepend the glyph
25948 rather than append it. */
25949 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25953 /* Make room for the additional glyph. */
25954 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25956 glyph
= it
->glyph_row
->glyphs
[area
];
25958 glyph
->charpos
= CHARPOS (it
->position
);
25959 glyph
->object
= it
->object
;
25960 glyph
->pixel_width
= it
->pixel_width
;
25961 glyph
->ascent
= it
->ascent
;
25962 glyph
->descent
= it
->descent
;
25963 glyph
->voffset
= it
->voffset
;
25964 glyph
->type
= GLYPHLESS_GLYPH
;
25965 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
25966 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
25967 glyph
->u
.glyphless
.len
= len
;
25968 glyph
->u
.glyphless
.ch
= it
->c
;
25969 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
25970 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
25971 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
25972 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
25973 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25974 glyph
->multibyte_p
= it
->multibyte_p
;
25975 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25977 /* In R2L rows, the left and the right box edges need to be
25978 drawn in reverse direction. */
25979 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25980 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25984 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25985 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25987 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25988 || it
->phys_descent
> it
->descent
);
25989 glyph
->padding_p
= 0;
25990 glyph
->glyph_not_available_p
= 0;
25991 glyph
->face_id
= face_id
;
25992 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25995 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25996 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25998 glyph
->bidi_type
= it
->bidi_it
.type
;
26000 ++it
->glyph_row
->used
[area
];
26003 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26007 /* Produce a glyph for a glyphless character for iterator IT.
26008 IT->glyphless_method specifies which method to use for displaying
26009 the character. See the description of enum
26010 glyphless_display_method in dispextern.h for the detail.
26012 FOR_NO_FONT is nonzero if and only if this is for a character for
26013 which no font was found. ACRONYM, if non-nil, is an acronym string
26014 for the character. */
26017 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
26022 int base_width
, base_height
, width
, height
;
26023 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26026 /* Get the metrics of the base font. We always refer to the current
26028 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26029 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26030 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
26031 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
26032 base_height
= it
->ascent
+ it
->descent
;
26033 base_width
= font
->average_width
;
26035 face_id
= merge_glyphless_glyph_face (it
);
26037 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26039 it
->pixel_width
= THIN_SPACE_WIDTH
;
26041 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26043 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26045 width
= CHAR_WIDTH (it
->c
);
26048 else if (width
> 4)
26050 it
->pixel_width
= base_width
* width
;
26052 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26058 unsigned int code
[6];
26060 int ascent
, descent
;
26061 struct font_metrics metrics_upper
, metrics_lower
;
26063 face
= FACE_FROM_ID (it
->f
, face_id
);
26064 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26065 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
26067 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26069 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26070 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26071 if (CONSP (acronym
))
26072 acronym
= XCAR (acronym
);
26073 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26077 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26078 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
26081 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
26082 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26083 upper_len
= (len
+ 1) / 2;
26084 font
->driver
->text_extents (font
, code
, upper_len
,
26086 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26091 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26092 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26093 upper_xoff
= upper_yoff
= 2; /* the typical case */
26094 if (base_width
>= width
)
26096 /* Align the upper to the left, the lower to the right. */
26097 it
->pixel_width
= base_width
;
26098 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26102 /* Center the shorter one. */
26103 it
->pixel_width
= width
;
26104 if (metrics_upper
.width
>= metrics_lower
.width
)
26105 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26108 /* FIXME: This code doesn't look right. It formerly was
26109 missing the "lower_xoff = 0;", which couldn't have
26110 been right since it left lower_xoff uninitialized. */
26112 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26116 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26117 top, bottom, and between upper and lower strings. */
26118 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26119 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26120 /* Center vertically.
26121 H:base_height, D:base_descent
26122 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26124 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26125 descent = D - H/2 + h/2;
26126 lower_yoff = descent - 2 - ld;
26127 upper_yoff = lower_yoff - la - 1 - ud; */
26128 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26129 descent
= it
->descent
- (base_height
- height
) / 2;
26130 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26131 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26132 - metrics_upper
.descent
);
26133 /* Don't make the height shorter than the base height. */
26134 if (height
> base_height
)
26136 it
->ascent
= ascent
;
26137 it
->descent
= descent
;
26141 it
->phys_ascent
= it
->ascent
;
26142 it
->phys_descent
= it
->descent
;
26144 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26145 upper_xoff
, upper_yoff
,
26146 lower_xoff
, lower_yoff
);
26148 take_vertical_position_into_account (it
);
26153 Produce glyphs/get display metrics for the display element IT is
26154 loaded with. See the description of struct it in dispextern.h
26155 for an overview of struct it. */
26158 x_produce_glyphs (struct it
*it
)
26160 int extra_line_spacing
= it
->extra_line_spacing
;
26162 it
->glyph_not_available_p
= 0;
26164 if (it
->what
== IT_CHARACTER
)
26167 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26168 struct font
*font
= face
->font
;
26169 struct font_metrics
*pcm
= NULL
;
26170 int boff
; /* Baseline offset. */
26174 /* When no suitable font is found, display this character by
26175 the method specified in the first extra slot of
26176 Vglyphless_char_display. */
26177 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26179 eassert (it
->what
== IT_GLYPHLESS
);
26180 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
26184 boff
= font
->baseline_offset
;
26185 if (font
->vertical_centering
)
26186 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26188 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26194 if (it
->override_ascent
>= 0)
26196 it
->ascent
= it
->override_ascent
;
26197 it
->descent
= it
->override_descent
;
26198 boff
= it
->override_boff
;
26202 it
->ascent
= FONT_BASE (font
) + boff
;
26203 it
->descent
= FONT_DESCENT (font
) - boff
;
26206 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26208 pcm
= get_per_char_metric (font
, &char2b
);
26209 if (pcm
->width
== 0
26210 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26216 it
->phys_ascent
= pcm
->ascent
+ boff
;
26217 it
->phys_descent
= pcm
->descent
- boff
;
26218 it
->pixel_width
= pcm
->width
;
26222 it
->glyph_not_available_p
= 1;
26223 it
->phys_ascent
= it
->ascent
;
26224 it
->phys_descent
= it
->descent
;
26225 it
->pixel_width
= font
->space_width
;
26228 if (it
->constrain_row_ascent_descent_p
)
26230 if (it
->descent
> it
->max_descent
)
26232 it
->ascent
+= it
->descent
- it
->max_descent
;
26233 it
->descent
= it
->max_descent
;
26235 if (it
->ascent
> it
->max_ascent
)
26237 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26238 it
->ascent
= it
->max_ascent
;
26240 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26241 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26242 extra_line_spacing
= 0;
26245 /* If this is a space inside a region of text with
26246 `space-width' property, change its width. */
26247 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26249 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26251 /* If face has a box, add the box thickness to the character
26252 height. If character has a box line to the left and/or
26253 right, add the box line width to the character's width. */
26254 if (face
->box
!= FACE_NO_BOX
)
26256 int thick
= face
->box_line_width
;
26260 it
->ascent
+= thick
;
26261 it
->descent
+= thick
;
26266 if (it
->start_of_box_run_p
)
26267 it
->pixel_width
+= thick
;
26268 if (it
->end_of_box_run_p
)
26269 it
->pixel_width
+= thick
;
26272 /* If face has an overline, add the height of the overline
26273 (1 pixel) and a 1 pixel margin to the character height. */
26274 if (face
->overline_p
)
26275 it
->ascent
+= overline_margin
;
26277 if (it
->constrain_row_ascent_descent_p
)
26279 if (it
->ascent
> it
->max_ascent
)
26280 it
->ascent
= it
->max_ascent
;
26281 if (it
->descent
> it
->max_descent
)
26282 it
->descent
= it
->max_descent
;
26285 take_vertical_position_into_account (it
);
26287 /* If we have to actually produce glyphs, do it. */
26292 /* Translate a space with a `space-width' property
26293 into a stretch glyph. */
26294 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26295 / FONT_HEIGHT (font
));
26296 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26297 it
->ascent
+ it
->descent
, ascent
);
26302 /* If characters with lbearing or rbearing are displayed
26303 in this line, record that fact in a flag of the
26304 glyph row. This is used to optimize X output code. */
26305 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26306 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26308 if (! stretched_p
&& it
->pixel_width
== 0)
26309 /* We assure that all visible glyphs have at least 1-pixel
26311 it
->pixel_width
= 1;
26313 else if (it
->char_to_display
== '\n')
26315 /* A newline has no width, but we need the height of the
26316 line. But if previous part of the line sets a height,
26317 don't increase that height. */
26319 Lisp_Object height
;
26320 Lisp_Object total_height
= Qnil
;
26322 it
->override_ascent
= -1;
26323 it
->pixel_width
= 0;
26326 height
= get_it_property (it
, Qline_height
);
26327 /* Split (line-height total-height) list. */
26329 && CONSP (XCDR (height
))
26330 && NILP (XCDR (XCDR (height
))))
26332 total_height
= XCAR (XCDR (height
));
26333 height
= XCAR (height
);
26335 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
26337 if (it
->override_ascent
>= 0)
26339 it
->ascent
= it
->override_ascent
;
26340 it
->descent
= it
->override_descent
;
26341 boff
= it
->override_boff
;
26345 it
->ascent
= FONT_BASE (font
) + boff
;
26346 it
->descent
= FONT_DESCENT (font
) - boff
;
26349 if (EQ (height
, Qt
))
26351 if (it
->descent
> it
->max_descent
)
26353 it
->ascent
+= it
->descent
- it
->max_descent
;
26354 it
->descent
= it
->max_descent
;
26356 if (it
->ascent
> it
->max_ascent
)
26358 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26359 it
->ascent
= it
->max_ascent
;
26361 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26362 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26363 it
->constrain_row_ascent_descent_p
= 1;
26364 extra_line_spacing
= 0;
26368 Lisp_Object spacing
;
26370 it
->phys_ascent
= it
->ascent
;
26371 it
->phys_descent
= it
->descent
;
26373 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26374 && face
->box
!= FACE_NO_BOX
26375 && face
->box_line_width
> 0)
26377 it
->ascent
+= face
->box_line_width
;
26378 it
->descent
+= face
->box_line_width
;
26381 && XINT (height
) > it
->ascent
+ it
->descent
)
26382 it
->ascent
= XINT (height
) - it
->descent
;
26384 if (!NILP (total_height
))
26385 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
26388 spacing
= get_it_property (it
, Qline_spacing
);
26389 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
26391 if (INTEGERP (spacing
))
26393 extra_line_spacing
= XINT (spacing
);
26394 if (!NILP (total_height
))
26395 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26399 else /* i.e. (it->char_to_display == '\t') */
26401 if (font
->space_width
> 0)
26403 int tab_width
= it
->tab_width
* font
->space_width
;
26404 int x
= it
->current_x
+ it
->continuation_lines_width
;
26405 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26407 /* If the distance from the current position to the next tab
26408 stop is less than a space character width, use the
26409 tab stop after that. */
26410 if (next_tab_x
- x
< font
->space_width
)
26411 next_tab_x
+= tab_width
;
26413 it
->pixel_width
= next_tab_x
- x
;
26415 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
26416 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
26420 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26421 it
->ascent
+ it
->descent
, it
->ascent
);
26426 it
->pixel_width
= 0;
26431 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26433 /* A static composition.
26435 Note: A composition is represented as one glyph in the
26436 glyph matrix. There are no padding glyphs.
26438 Important note: pixel_width, ascent, and descent are the
26439 values of what is drawn by draw_glyphs (i.e. the values of
26440 the overall glyphs composed). */
26441 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26442 int boff
; /* baseline offset */
26443 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26444 int glyph_len
= cmp
->glyph_len
;
26445 struct font
*font
= face
->font
;
26449 /* If we have not yet calculated pixel size data of glyphs of
26450 the composition for the current face font, calculate them
26451 now. Theoretically, we have to check all fonts for the
26452 glyphs, but that requires much time and memory space. So,
26453 here we check only the font of the first glyph. This may
26454 lead to incorrect display, but it's very rare, and C-l
26455 (recenter-top-bottom) can correct the display anyway. */
26456 if (! cmp
->font
|| cmp
->font
!= font
)
26458 /* Ascent and descent of the font of the first character
26459 of this composition (adjusted by baseline offset).
26460 Ascent and descent of overall glyphs should not be less
26461 than these, respectively. */
26462 int font_ascent
, font_descent
, font_height
;
26463 /* Bounding box of the overall glyphs. */
26464 int leftmost
, rightmost
, lowest
, highest
;
26465 int lbearing
, rbearing
;
26466 int i
, width
, ascent
, descent
;
26467 int left_padded
= 0, right_padded
= 0;
26468 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26470 struct font_metrics
*pcm
;
26471 int font_not_found_p
;
26474 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26475 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26477 if (glyph_len
< cmp
->glyph_len
)
26479 for (i
= 0; i
< glyph_len
; i
++)
26481 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26483 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26488 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26489 : IT_CHARPOS (*it
));
26490 /* If no suitable font is found, use the default font. */
26491 font_not_found_p
= font
== NULL
;
26492 if (font_not_found_p
)
26494 face
= face
->ascii_face
;
26497 boff
= font
->baseline_offset
;
26498 if (font
->vertical_centering
)
26499 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26500 font_ascent
= FONT_BASE (font
) + boff
;
26501 font_descent
= FONT_DESCENT (font
) - boff
;
26502 font_height
= FONT_HEIGHT (font
);
26507 if (! font_not_found_p
)
26509 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26511 pcm
= get_per_char_metric (font
, &char2b
);
26514 /* Initialize the bounding box. */
26517 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26518 ascent
= pcm
->ascent
;
26519 descent
= pcm
->descent
;
26520 lbearing
= pcm
->lbearing
;
26521 rbearing
= pcm
->rbearing
;
26525 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26526 ascent
= FONT_BASE (font
);
26527 descent
= FONT_DESCENT (font
);
26534 lowest
= - descent
+ boff
;
26535 highest
= ascent
+ boff
;
26537 if (! font_not_found_p
26538 && font
->default_ascent
26539 && CHAR_TABLE_P (Vuse_default_ascent
)
26540 && !NILP (Faref (Vuse_default_ascent
,
26541 make_number (it
->char_to_display
))))
26542 highest
= font
->default_ascent
+ boff
;
26544 /* Draw the first glyph at the normal position. It may be
26545 shifted to right later if some other glyphs are drawn
26547 cmp
->offsets
[i
* 2] = 0;
26548 cmp
->offsets
[i
* 2 + 1] = boff
;
26549 cmp
->lbearing
= lbearing
;
26550 cmp
->rbearing
= rbearing
;
26552 /* Set cmp->offsets for the remaining glyphs. */
26553 for (i
++; i
< glyph_len
; i
++)
26555 int left
, right
, btm
, top
;
26556 int ch
= COMPOSITION_GLYPH (cmp
, i
);
26558 struct face
*this_face
;
26562 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
26563 this_face
= FACE_FROM_ID (it
->f
, face_id
);
26564 font
= this_face
->font
;
26570 get_char_face_and_encoding (it
->f
, ch
, face_id
,
26572 pcm
= get_per_char_metric (font
, &char2b
);
26575 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26578 width
= pcm
->width
;
26579 ascent
= pcm
->ascent
;
26580 descent
= pcm
->descent
;
26581 lbearing
= pcm
->lbearing
;
26582 rbearing
= pcm
->rbearing
;
26583 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
26585 /* Relative composition with or without
26586 alternate chars. */
26587 left
= (leftmost
+ rightmost
- width
) / 2;
26588 btm
= - descent
+ boff
;
26589 if (font
->relative_compose
26590 && (! CHAR_TABLE_P (Vignore_relative_composition
)
26591 || NILP (Faref (Vignore_relative_composition
,
26592 make_number (ch
)))))
26595 if (- descent
>= font
->relative_compose
)
26596 /* One extra pixel between two glyphs. */
26598 else if (ascent
<= 0)
26599 /* One extra pixel between two glyphs. */
26600 btm
= lowest
- 1 - ascent
- descent
;
26605 /* A composition rule is specified by an integer
26606 value that encodes global and new reference
26607 points (GREF and NREF). GREF and NREF are
26608 specified by numbers as below:
26610 0---1---2 -- ascent
26614 9--10--11 -- center
26616 ---3---4---5--- baseline
26618 6---7---8 -- descent
26620 int rule
= COMPOSITION_RULE (cmp
, i
);
26621 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
26623 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
26624 grefx
= gref
% 3, nrefx
= nref
% 3;
26625 grefy
= gref
/ 3, nrefy
= nref
/ 3;
26627 xoff
= font_height
* (xoff
- 128) / 256;
26629 yoff
= font_height
* (yoff
- 128) / 256;
26632 + grefx
* (rightmost
- leftmost
) / 2
26633 - nrefx
* width
/ 2
26636 btm
= ((grefy
== 0 ? highest
26638 : grefy
== 2 ? lowest
26639 : (highest
+ lowest
) / 2)
26640 - (nrefy
== 0 ? ascent
+ descent
26641 : nrefy
== 1 ? descent
- boff
26643 : (ascent
+ descent
) / 2)
26647 cmp
->offsets
[i
* 2] = left
;
26648 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
26650 /* Update the bounding box of the overall glyphs. */
26653 right
= left
+ width
;
26654 if (left
< leftmost
)
26656 if (right
> rightmost
)
26659 top
= btm
+ descent
+ ascent
;
26665 if (cmp
->lbearing
> left
+ lbearing
)
26666 cmp
->lbearing
= left
+ lbearing
;
26667 if (cmp
->rbearing
< left
+ rbearing
)
26668 cmp
->rbearing
= left
+ rbearing
;
26672 /* If there are glyphs whose x-offsets are negative,
26673 shift all glyphs to the right and make all x-offsets
26677 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26678 cmp
->offsets
[i
* 2] -= leftmost
;
26679 rightmost
-= leftmost
;
26680 cmp
->lbearing
-= leftmost
;
26681 cmp
->rbearing
-= leftmost
;
26684 if (left_padded
&& cmp
->lbearing
< 0)
26686 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26687 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
26688 rightmost
-= cmp
->lbearing
;
26689 cmp
->rbearing
-= cmp
->lbearing
;
26692 if (right_padded
&& rightmost
< cmp
->rbearing
)
26694 rightmost
= cmp
->rbearing
;
26697 cmp
->pixel_width
= rightmost
;
26698 cmp
->ascent
= highest
;
26699 cmp
->descent
= - lowest
;
26700 if (cmp
->ascent
< font_ascent
)
26701 cmp
->ascent
= font_ascent
;
26702 if (cmp
->descent
< font_descent
)
26703 cmp
->descent
= font_descent
;
26707 && (cmp
->lbearing
< 0
26708 || cmp
->rbearing
> cmp
->pixel_width
))
26709 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26711 it
->pixel_width
= cmp
->pixel_width
;
26712 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
26713 it
->descent
= it
->phys_descent
= cmp
->descent
;
26714 if (face
->box
!= FACE_NO_BOX
)
26716 int thick
= face
->box_line_width
;
26720 it
->ascent
+= thick
;
26721 it
->descent
+= thick
;
26726 if (it
->start_of_box_run_p
)
26727 it
->pixel_width
+= thick
;
26728 if (it
->end_of_box_run_p
)
26729 it
->pixel_width
+= thick
;
26732 /* If face has an overline, add the height of the overline
26733 (1 pixel) and a 1 pixel margin to the character height. */
26734 if (face
->overline_p
)
26735 it
->ascent
+= overline_margin
;
26737 take_vertical_position_into_account (it
);
26738 if (it
->ascent
< 0)
26740 if (it
->descent
< 0)
26743 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
26744 append_composite_glyph (it
);
26746 else if (it
->what
== IT_COMPOSITION
)
26748 /* A dynamic (automatic) composition. */
26749 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26750 Lisp_Object gstring
;
26751 struct font_metrics metrics
;
26755 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
26757 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
26760 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
26761 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26762 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
26763 it
->descent
= it
->phys_descent
= metrics
.descent
;
26764 if (face
->box
!= FACE_NO_BOX
)
26766 int thick
= face
->box_line_width
;
26770 it
->ascent
+= thick
;
26771 it
->descent
+= thick
;
26776 if (it
->start_of_box_run_p
)
26777 it
->pixel_width
+= thick
;
26778 if (it
->end_of_box_run_p
)
26779 it
->pixel_width
+= thick
;
26781 /* If face has an overline, add the height of the overline
26782 (1 pixel) and a 1 pixel margin to the character height. */
26783 if (face
->overline_p
)
26784 it
->ascent
+= overline_margin
;
26785 take_vertical_position_into_account (it
);
26786 if (it
->ascent
< 0)
26788 if (it
->descent
< 0)
26792 append_composite_glyph (it
);
26794 else if (it
->what
== IT_GLYPHLESS
)
26795 produce_glyphless_glyph (it
, 0, Qnil
);
26796 else if (it
->what
== IT_IMAGE
)
26797 produce_image_glyph (it
);
26798 else if (it
->what
== IT_STRETCH
)
26799 produce_stretch_glyph (it
);
26802 /* Accumulate dimensions. Note: can't assume that it->descent > 0
26803 because this isn't true for images with `:ascent 100'. */
26804 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
26805 if (it
->area
== TEXT_AREA
)
26806 it
->current_x
+= it
->pixel_width
;
26808 if (extra_line_spacing
> 0)
26810 it
->descent
+= extra_line_spacing
;
26811 if (extra_line_spacing
> it
->max_extra_line_spacing
)
26812 it
->max_extra_line_spacing
= extra_line_spacing
;
26815 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
26816 it
->max_descent
= max (it
->max_descent
, it
->descent
);
26817 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
26818 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
26822 Output LEN glyphs starting at START at the nominal cursor position.
26823 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
26824 being updated, and UPDATED_AREA is the area of that row being updated. */
26827 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26828 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26830 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
26832 eassert (updated_row
);
26833 /* When the window is hscrolled, cursor hpos can legitimately be out
26834 of bounds, but we draw the cursor at the corresponding window
26835 margin in that case. */
26836 if (!updated_row
->reversed_p
&& chpos
< 0)
26838 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
26839 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
26843 /* Write glyphs. */
26845 hpos
= start
- updated_row
->glyphs
[updated_area
];
26846 x
= draw_glyphs (w
, w
->output_cursor
.x
,
26847 updated_row
, updated_area
,
26849 DRAW_NORMAL_TEXT
, 0);
26851 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
26852 if (updated_area
== TEXT_AREA
26853 && w
->phys_cursor_on_p
26854 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
26856 && chpos
< hpos
+ len
)
26857 w
->phys_cursor_on_p
= 0;
26861 /* Advance the output cursor. */
26862 w
->output_cursor
.hpos
+= len
;
26863 w
->output_cursor
.x
= x
;
26868 Insert LEN glyphs from START at the nominal cursor position. */
26871 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26872 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26875 int line_height
, shift_by_width
, shifted_region_width
;
26876 struct glyph_row
*row
;
26877 struct glyph
*glyph
;
26878 int frame_x
, frame_y
;
26881 eassert (updated_row
);
26883 f
= XFRAME (WINDOW_FRAME (w
));
26885 /* Get the height of the line we are in. */
26887 line_height
= row
->height
;
26889 /* Get the width of the glyphs to insert. */
26890 shift_by_width
= 0;
26891 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
26892 shift_by_width
+= glyph
->pixel_width
;
26894 /* Get the width of the region to shift right. */
26895 shifted_region_width
= (window_box_width (w
, updated_area
)
26896 - w
->output_cursor
.x
26900 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
26901 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
26903 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
26904 line_height
, shift_by_width
);
26906 /* Write the glyphs. */
26907 hpos
= start
- row
->glyphs
[updated_area
];
26908 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
26910 DRAW_NORMAL_TEXT
, 0);
26912 /* Advance the output cursor. */
26913 w
->output_cursor
.hpos
+= len
;
26914 w
->output_cursor
.x
+= shift_by_width
;
26920 Erase the current text line from the nominal cursor position
26921 (inclusive) to pixel column TO_X (exclusive). The idea is that
26922 everything from TO_X onward is already erased.
26924 TO_X is a pixel position relative to UPDATED_AREA of currently
26925 updated window W. TO_X == -1 means clear to the end of this area. */
26928 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
26929 enum glyph_row_area updated_area
, int to_x
)
26932 int max_x
, min_y
, max_y
;
26933 int from_x
, from_y
, to_y
;
26935 eassert (updated_row
);
26936 f
= XFRAME (w
->frame
);
26938 if (updated_row
->full_width_p
)
26939 max_x
= (WINDOW_PIXEL_WIDTH (w
)
26940 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
26942 max_x
= window_box_width (w
, updated_area
);
26943 max_y
= window_text_bottom_y (w
);
26945 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
26946 of window. For TO_X > 0, truncate to end of drawing area. */
26952 to_x
= min (to_x
, max_x
);
26954 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
26956 /* Notice if the cursor will be cleared by this operation. */
26957 if (!updated_row
->full_width_p
)
26958 notice_overwritten_cursor (w
, updated_area
,
26959 w
->output_cursor
.x
, -1,
26961 MATRIX_ROW_BOTTOM_Y (updated_row
));
26963 from_x
= w
->output_cursor
.x
;
26965 /* Translate to frame coordinates. */
26966 if (updated_row
->full_width_p
)
26968 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
26969 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
26973 int area_left
= window_box_left (w
, updated_area
);
26974 from_x
+= area_left
;
26978 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
26979 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
26980 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
26982 /* Prevent inadvertently clearing to end of the X window. */
26983 if (to_x
> from_x
&& to_y
> from_y
)
26986 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
26987 to_x
- from_x
, to_y
- from_y
);
26992 #endif /* HAVE_WINDOW_SYSTEM */
26996 /***********************************************************************
26998 ***********************************************************************/
27000 /* Value is the internal representation of the specified cursor type
27001 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27002 of the bar cursor. */
27004 static enum text_cursor_kinds
27005 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27007 enum text_cursor_kinds type
;
27012 if (EQ (arg
, Qbox
))
27013 return FILLED_BOX_CURSOR
;
27015 if (EQ (arg
, Qhollow
))
27016 return HOLLOW_BOX_CURSOR
;
27018 if (EQ (arg
, Qbar
))
27025 && EQ (XCAR (arg
), Qbar
)
27026 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27028 *width
= XINT (XCDR (arg
));
27032 if (EQ (arg
, Qhbar
))
27035 return HBAR_CURSOR
;
27039 && EQ (XCAR (arg
), Qhbar
)
27040 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27042 *width
= XINT (XCDR (arg
));
27043 return HBAR_CURSOR
;
27046 /* Treat anything unknown as "hollow box cursor".
27047 It was bad to signal an error; people have trouble fixing
27048 .Xdefaults with Emacs, when it has something bad in it. */
27049 type
= HOLLOW_BOX_CURSOR
;
27054 /* Set the default cursor types for specified frame. */
27056 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27061 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27062 FRAME_CURSOR_WIDTH (f
) = width
;
27064 /* By default, set up the blink-off state depending on the on-state. */
27066 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27069 FRAME_BLINK_OFF_CURSOR (f
)
27070 = get_specified_cursor_type (XCDR (tem
), &width
);
27071 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27074 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27076 /* Make sure the cursor gets redrawn. */
27077 f
->cursor_type_changed
= 1;
27081 #ifdef HAVE_WINDOW_SYSTEM
27083 /* Return the cursor we want to be displayed in window W. Return
27084 width of bar/hbar cursor through WIDTH arg. Return with
27085 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
27086 (i.e. if the `system caret' should track this cursor).
27088 In a mini-buffer window, we want the cursor only to appear if we
27089 are reading input from this window. For the selected window, we
27090 want the cursor type given by the frame parameter or buffer local
27091 setting of cursor-type. If explicitly marked off, draw no cursor.
27092 In all other cases, we want a hollow box cursor. */
27094 static enum text_cursor_kinds
27095 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27096 int *active_cursor
)
27098 struct frame
*f
= XFRAME (w
->frame
);
27099 struct buffer
*b
= XBUFFER (w
->contents
);
27100 int cursor_type
= DEFAULT_CURSOR
;
27101 Lisp_Object alt_cursor
;
27102 int non_selected
= 0;
27104 *active_cursor
= 1;
27107 if (cursor_in_echo_area
27108 && FRAME_HAS_MINIBUF_P (f
)
27109 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27111 if (w
== XWINDOW (echo_area_window
))
27113 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27115 *width
= FRAME_CURSOR_WIDTH (f
);
27116 return FRAME_DESIRED_CURSOR (f
);
27119 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27122 *active_cursor
= 0;
27126 /* Detect a nonselected window or nonselected frame. */
27127 else if (w
!= XWINDOW (f
->selected_window
)
27128 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27130 *active_cursor
= 0;
27132 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27138 /* Never display a cursor in a window in which cursor-type is nil. */
27139 if (NILP (BVAR (b
, cursor_type
)))
27142 /* Get the normal cursor type for this window. */
27143 if (EQ (BVAR (b
, cursor_type
), Qt
))
27145 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27146 *width
= FRAME_CURSOR_WIDTH (f
);
27149 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27151 /* Use cursor-in-non-selected-windows instead
27152 for non-selected window or frame. */
27155 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27156 if (!EQ (Qt
, alt_cursor
))
27157 return get_specified_cursor_type (alt_cursor
, width
);
27158 /* t means modify the normal cursor type. */
27159 if (cursor_type
== FILLED_BOX_CURSOR
)
27160 cursor_type
= HOLLOW_BOX_CURSOR
;
27161 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27163 return cursor_type
;
27166 /* Use normal cursor if not blinked off. */
27167 if (!w
->cursor_off_p
)
27169 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27171 if (cursor_type
== FILLED_BOX_CURSOR
)
27173 /* Using a block cursor on large images can be very annoying.
27174 So use a hollow cursor for "large" images.
27175 If image is not transparent (no mask), also use hollow cursor. */
27176 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27177 if (img
!= NULL
&& IMAGEP (img
->spec
))
27179 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27180 where N = size of default frame font size.
27181 This should cover most of the "tiny" icons people may use. */
27183 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27184 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27185 cursor_type
= HOLLOW_BOX_CURSOR
;
27188 else if (cursor_type
!= NO_CURSOR
)
27190 /* Display current only supports BOX and HOLLOW cursors for images.
27191 So for now, unconditionally use a HOLLOW cursor when cursor is
27192 not a solid box cursor. */
27193 cursor_type
= HOLLOW_BOX_CURSOR
;
27196 return cursor_type
;
27199 /* Cursor is blinked off, so determine how to "toggle" it. */
27201 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27202 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
27203 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
27205 /* Then see if frame has specified a specific blink off cursor type. */
27206 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
27208 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
27209 return FRAME_BLINK_OFF_CURSOR (f
);
27213 /* Some people liked having a permanently visible blinking cursor,
27214 while others had very strong opinions against it. So it was
27215 decided to remove it. KFS 2003-09-03 */
27217 /* Finally perform built-in cursor blinking:
27218 filled box <-> hollow box
27219 wide [h]bar <-> narrow [h]bar
27220 narrow [h]bar <-> no cursor
27221 other type <-> no cursor */
27223 if (cursor_type
== FILLED_BOX_CURSOR
)
27224 return HOLLOW_BOX_CURSOR
;
27226 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
27229 return cursor_type
;
27237 /* Notice when the text cursor of window W has been completely
27238 overwritten by a drawing operation that outputs glyphs in AREA
27239 starting at X0 and ending at X1 in the line starting at Y0 and
27240 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27241 the rest of the line after X0 has been written. Y coordinates
27242 are window-relative. */
27245 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
27246 int x0
, int x1
, int y0
, int y1
)
27248 int cx0
, cx1
, cy0
, cy1
;
27249 struct glyph_row
*row
;
27251 if (!w
->phys_cursor_on_p
)
27253 if (area
!= TEXT_AREA
)
27256 if (w
->phys_cursor
.vpos
< 0
27257 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27258 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27259 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27262 if (row
->cursor_in_fringe_p
)
27264 row
->cursor_in_fringe_p
= 0;
27265 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27266 w
->phys_cursor_on_p
= 0;
27270 cx0
= w
->phys_cursor
.x
;
27271 cx1
= cx0
+ w
->phys_cursor_width
;
27272 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27275 /* The cursor image will be completely removed from the
27276 screen if the output area intersects the cursor area in
27277 y-direction. When we draw in [y0 y1[, and some part of
27278 the cursor is at y < y0, that part must have been drawn
27279 before. When scrolling, the cursor is erased before
27280 actually scrolling, so we don't come here. When not
27281 scrolling, the rows above the old cursor row must have
27282 changed, and in this case these rows must have written
27283 over the cursor image.
27285 Likewise if part of the cursor is below y1, with the
27286 exception of the cursor being in the first blank row at
27287 the buffer and window end because update_text_area
27288 doesn't draw that row. (Except when it does, but
27289 that's handled in update_text_area.) */
27291 cy0
= w
->phys_cursor
.y
;
27292 cy1
= cy0
+ w
->phys_cursor_height
;
27293 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27296 w
->phys_cursor_on_p
= 0;
27299 #endif /* HAVE_WINDOW_SYSTEM */
27302 /************************************************************************
27304 ************************************************************************/
27306 #ifdef HAVE_WINDOW_SYSTEM
27309 Fix the display of area AREA of overlapping row ROW in window W
27310 with respect to the overlapping part OVERLAPS. */
27313 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27314 enum glyph_row_area area
, int overlaps
)
27321 for (i
= 0; i
< row
->used
[area
];)
27323 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27325 int start
= i
, start_x
= x
;
27329 x
+= row
->glyphs
[area
][i
].pixel_width
;
27332 while (i
< row
->used
[area
]
27333 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27335 draw_glyphs (w
, start_x
, row
, area
,
27337 DRAW_NORMAL_TEXT
, overlaps
);
27341 x
+= row
->glyphs
[area
][i
].pixel_width
;
27351 Draw the cursor glyph of window W in glyph row ROW. See the
27352 comment of draw_glyphs for the meaning of HL. */
27355 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27356 enum draw_glyphs_face hl
)
27358 /* If cursor hpos is out of bounds, don't draw garbage. This can
27359 happen in mini-buffer windows when switching between echo area
27360 glyphs and mini-buffer. */
27361 if ((row
->reversed_p
27362 ? (w
->phys_cursor
.hpos
>= 0)
27363 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27365 int on_p
= w
->phys_cursor_on_p
;
27367 int hpos
= w
->phys_cursor
.hpos
;
27369 /* When the window is hscrolled, cursor hpos can legitimately be
27370 out of bounds, but we draw the cursor at the corresponding
27371 window margin in that case. */
27372 if (!row
->reversed_p
&& hpos
< 0)
27374 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27375 hpos
= row
->used
[TEXT_AREA
] - 1;
27377 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27379 w
->phys_cursor_on_p
= on_p
;
27381 if (hl
== DRAW_CURSOR
)
27382 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27383 /* When we erase the cursor, and ROW is overlapped by other
27384 rows, make sure that these overlapping parts of other rows
27386 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27388 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27390 if (row
> w
->current_matrix
->rows
27391 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27392 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27393 OVERLAPS_ERASED_CURSOR
);
27395 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27396 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27397 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27398 OVERLAPS_ERASED_CURSOR
);
27404 /* Erase the image of a cursor of window W from the screen. */
27410 erase_phys_cursor (struct window
*w
)
27412 struct frame
*f
= XFRAME (w
->frame
);
27413 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27414 int hpos
= w
->phys_cursor
.hpos
;
27415 int vpos
= w
->phys_cursor
.vpos
;
27416 int mouse_face_here_p
= 0;
27417 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27418 struct glyph_row
*cursor_row
;
27419 struct glyph
*cursor_glyph
;
27420 enum draw_glyphs_face hl
;
27422 /* No cursor displayed or row invalidated => nothing to do on the
27424 if (w
->phys_cursor_type
== NO_CURSOR
)
27425 goto mark_cursor_off
;
27427 /* VPOS >= active_glyphs->nrows means that window has been resized.
27428 Don't bother to erase the cursor. */
27429 if (vpos
>= active_glyphs
->nrows
)
27430 goto mark_cursor_off
;
27432 /* If row containing cursor is marked invalid, there is nothing we
27434 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27435 if (!cursor_row
->enabled_p
)
27436 goto mark_cursor_off
;
27438 /* If line spacing is > 0, old cursor may only be partially visible in
27439 window after split-window. So adjust visible height. */
27440 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27441 window_text_bottom_y (w
) - cursor_row
->y
);
27443 /* If row is completely invisible, don't attempt to delete a cursor which
27444 isn't there. This can happen if cursor is at top of a window, and
27445 we switch to a buffer with a header line in that window. */
27446 if (cursor_row
->visible_height
<= 0)
27447 goto mark_cursor_off
;
27449 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27450 if (cursor_row
->cursor_in_fringe_p
)
27452 cursor_row
->cursor_in_fringe_p
= 0;
27453 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27454 goto mark_cursor_off
;
27457 /* This can happen when the new row is shorter than the old one.
27458 In this case, either draw_glyphs or clear_end_of_line
27459 should have cleared the cursor. Note that we wouldn't be
27460 able to erase the cursor in this case because we don't have a
27461 cursor glyph at hand. */
27462 if ((cursor_row
->reversed_p
27463 ? (w
->phys_cursor
.hpos
< 0)
27464 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27465 goto mark_cursor_off
;
27467 /* When the window is hscrolled, cursor hpos can legitimately be out
27468 of bounds, but we draw the cursor at the corresponding window
27469 margin in that case. */
27470 if (!cursor_row
->reversed_p
&& hpos
< 0)
27472 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27473 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27475 /* If the cursor is in the mouse face area, redisplay that when
27476 we clear the cursor. */
27477 if (! NILP (hlinfo
->mouse_face_window
)
27478 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27479 /* Don't redraw the cursor's spot in mouse face if it is at the
27480 end of a line (on a newline). The cursor appears there, but
27481 mouse highlighting does not. */
27482 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27483 mouse_face_here_p
= 1;
27485 /* Maybe clear the display under the cursor. */
27486 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27489 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27492 cursor_glyph
= get_phys_cursor_glyph (w
);
27493 if (cursor_glyph
== NULL
)
27494 goto mark_cursor_off
;
27496 width
= cursor_glyph
->pixel_width
;
27497 x
= w
->phys_cursor
.x
;
27503 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27504 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27505 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
27508 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27511 /* Erase the cursor by redrawing the character underneath it. */
27512 if (mouse_face_here_p
)
27513 hl
= DRAW_MOUSE_FACE
;
27515 hl
= DRAW_NORMAL_TEXT
;
27516 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27519 w
->phys_cursor_on_p
= 0;
27520 w
->phys_cursor_type
= NO_CURSOR
;
27525 Display or clear cursor of window W. If ON is zero, clear the
27526 cursor. If it is non-zero, display the cursor. If ON is nonzero,
27527 where to put the cursor is specified by HPOS, VPOS, X and Y. */
27530 display_and_set_cursor (struct window
*w
, bool on
,
27531 int hpos
, int vpos
, int x
, int y
)
27533 struct frame
*f
= XFRAME (w
->frame
);
27534 int new_cursor_type
;
27535 int new_cursor_width
;
27537 struct glyph_row
*glyph_row
;
27538 struct glyph
*glyph
;
27540 /* This is pointless on invisible frames, and dangerous on garbaged
27541 windows and frames; in the latter case, the frame or window may
27542 be in the midst of changing its size, and x and y may be off the
27544 if (! FRAME_VISIBLE_P (f
)
27545 || FRAME_GARBAGED_P (f
)
27546 || vpos
>= w
->current_matrix
->nrows
27547 || hpos
>= w
->current_matrix
->matrix_w
)
27550 /* If cursor is off and we want it off, return quickly. */
27551 if (!on
&& !w
->phys_cursor_on_p
)
27554 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27555 /* If cursor row is not enabled, we don't really know where to
27556 display the cursor. */
27557 if (!glyph_row
->enabled_p
)
27559 w
->phys_cursor_on_p
= 0;
27564 if (!glyph_row
->exact_window_width_line_p
27565 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
27566 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
27568 eassert (input_blocked_p ());
27570 /* Set new_cursor_type to the cursor we want to be displayed. */
27571 new_cursor_type
= get_window_cursor_type (w
, glyph
,
27572 &new_cursor_width
, &active_cursor
);
27574 /* If cursor is currently being shown and we don't want it to be or
27575 it is in the wrong place, or the cursor type is not what we want,
27577 if (w
->phys_cursor_on_p
27579 || w
->phys_cursor
.x
!= x
27580 || w
->phys_cursor
.y
!= y
27581 /* HPOS can be negative in R2L rows whose
27582 exact_window_width_line_p flag is set (i.e. their newline
27583 would "overflow into the fringe"). */
27585 || new_cursor_type
!= w
->phys_cursor_type
27586 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
27587 && new_cursor_width
!= w
->phys_cursor_width
)))
27588 erase_phys_cursor (w
);
27590 /* Don't check phys_cursor_on_p here because that flag is only set
27591 to zero in some cases where we know that the cursor has been
27592 completely erased, to avoid the extra work of erasing the cursor
27593 twice. In other words, phys_cursor_on_p can be 1 and the cursor
27594 still not be visible, or it has only been partly erased. */
27597 w
->phys_cursor_ascent
= glyph_row
->ascent
;
27598 w
->phys_cursor_height
= glyph_row
->height
;
27600 /* Set phys_cursor_.* before x_draw_.* is called because some
27601 of them may need the information. */
27602 w
->phys_cursor
.x
= x
;
27603 w
->phys_cursor
.y
= glyph_row
->y
;
27604 w
->phys_cursor
.hpos
= hpos
;
27605 w
->phys_cursor
.vpos
= vpos
;
27608 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
27609 new_cursor_type
, new_cursor_width
,
27610 on
, active_cursor
);
27614 /* Switch the display of W's cursor on or off, according to the value
27618 update_window_cursor (struct window
*w
, bool on
)
27620 /* Don't update cursor in windows whose frame is in the process
27621 of being deleted. */
27622 if (w
->current_matrix
)
27624 int hpos
= w
->phys_cursor
.hpos
;
27625 int vpos
= w
->phys_cursor
.vpos
;
27626 struct glyph_row
*row
;
27628 if (vpos
>= w
->current_matrix
->nrows
27629 || hpos
>= w
->current_matrix
->matrix_w
)
27632 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27634 /* When the window is hscrolled, cursor hpos can legitimately be
27635 out of bounds, but we draw the cursor at the corresponding
27636 window margin in that case. */
27637 if (!row
->reversed_p
&& hpos
< 0)
27639 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27640 hpos
= row
->used
[TEXT_AREA
] - 1;
27643 display_and_set_cursor (w
, on
, hpos
, vpos
,
27644 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27650 /* Call update_window_cursor with parameter ON_P on all leaf windows
27651 in the window tree rooted at W. */
27654 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
27658 if (WINDOWP (w
->contents
))
27659 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
27661 update_window_cursor (w
, on_p
);
27663 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
27669 Display the cursor on window W, or clear it, according to ON_P.
27670 Don't change the cursor's position. */
27673 x_update_cursor (struct frame
*f
, bool on_p
)
27675 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
27680 Clear the cursor of window W to background color, and mark the
27681 cursor as not shown. This is used when the text where the cursor
27682 is about to be rewritten. */
27685 x_clear_cursor (struct window
*w
)
27687 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
27688 update_window_cursor (w
, 0);
27691 #endif /* HAVE_WINDOW_SYSTEM */
27693 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
27696 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
27697 int start_hpos
, int end_hpos
,
27698 enum draw_glyphs_face draw
)
27700 #ifdef HAVE_WINDOW_SYSTEM
27701 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
27703 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
27707 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
27708 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
27712 /* Display the active region described by mouse_face_* according to DRAW. */
27715 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
27717 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
27718 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27720 if (/* If window is in the process of being destroyed, don't bother
27722 w
->current_matrix
!= NULL
27723 /* Don't update mouse highlight if hidden. */
27724 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
27725 /* Recognize when we are called to operate on rows that don't exist
27726 anymore. This can happen when a window is split. */
27727 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
27729 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
27730 struct glyph_row
*row
, *first
, *last
;
27732 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
27733 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
27735 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
27737 int start_hpos
, end_hpos
, start_x
;
27739 /* For all but the first row, the highlight starts at column 0. */
27742 /* R2L rows have BEG and END in reversed order, but the
27743 screen drawing geometry is always left to right. So
27744 we need to mirror the beginning and end of the
27745 highlighted area in R2L rows. */
27746 if (!row
->reversed_p
)
27748 start_hpos
= hlinfo
->mouse_face_beg_col
;
27749 start_x
= hlinfo
->mouse_face_beg_x
;
27751 else if (row
== last
)
27753 start_hpos
= hlinfo
->mouse_face_end_col
;
27754 start_x
= hlinfo
->mouse_face_end_x
;
27762 else if (row
->reversed_p
&& row
== last
)
27764 start_hpos
= hlinfo
->mouse_face_end_col
;
27765 start_x
= hlinfo
->mouse_face_end_x
;
27775 if (!row
->reversed_p
)
27776 end_hpos
= hlinfo
->mouse_face_end_col
;
27777 else if (row
== first
)
27778 end_hpos
= hlinfo
->mouse_face_beg_col
;
27781 end_hpos
= row
->used
[TEXT_AREA
];
27782 if (draw
== DRAW_NORMAL_TEXT
)
27783 row
->fill_line_p
= 1; /* Clear to end of line */
27786 else if (row
->reversed_p
&& row
== first
)
27787 end_hpos
= hlinfo
->mouse_face_beg_col
;
27790 end_hpos
= row
->used
[TEXT_AREA
];
27791 if (draw
== DRAW_NORMAL_TEXT
)
27792 row
->fill_line_p
= 1; /* Clear to end of line */
27795 if (end_hpos
> start_hpos
)
27797 draw_row_with_mouse_face (w
, start_x
, row
,
27798 start_hpos
, end_hpos
, draw
);
27801 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
27805 #ifdef HAVE_WINDOW_SYSTEM
27806 /* When we've written over the cursor, arrange for it to
27807 be displayed again. */
27808 if (FRAME_WINDOW_P (f
)
27809 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
27811 int hpos
= w
->phys_cursor
.hpos
;
27813 /* When the window is hscrolled, cursor hpos can legitimately be
27814 out of bounds, but we draw the cursor at the corresponding
27815 window margin in that case. */
27816 if (!row
->reversed_p
&& hpos
< 0)
27818 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27819 hpos
= row
->used
[TEXT_AREA
] - 1;
27822 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
27823 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27826 #endif /* HAVE_WINDOW_SYSTEM */
27829 #ifdef HAVE_WINDOW_SYSTEM
27830 /* Change the mouse cursor. */
27831 if (FRAME_WINDOW_P (f
))
27833 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
27834 if (draw
== DRAW_NORMAL_TEXT
27835 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
27836 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
27839 if (draw
== DRAW_MOUSE_FACE
)
27840 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
27842 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
27844 #endif /* HAVE_WINDOW_SYSTEM */
27848 Clear out the mouse-highlighted active region.
27849 Redraw it un-highlighted first. Value is non-zero if mouse
27850 face was actually drawn unhighlighted. */
27853 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
27857 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
27859 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
27863 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27864 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27865 hlinfo
->mouse_face_window
= Qnil
;
27866 hlinfo
->mouse_face_overlay
= Qnil
;
27870 /* Return true if the coordinates HPOS and VPOS on windows W are
27871 within the mouse face on that window. */
27873 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
27875 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27877 /* Quickly resolve the easy cases. */
27878 if (!(WINDOWP (hlinfo
->mouse_face_window
)
27879 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
27881 if (vpos
< hlinfo
->mouse_face_beg_row
27882 || vpos
> hlinfo
->mouse_face_end_row
)
27884 if (vpos
> hlinfo
->mouse_face_beg_row
27885 && vpos
< hlinfo
->mouse_face_end_row
)
27888 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
27890 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27892 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
27895 else if ((vpos
== hlinfo
->mouse_face_beg_row
27896 && hpos
>= hlinfo
->mouse_face_beg_col
)
27897 || (vpos
== hlinfo
->mouse_face_end_row
27898 && hpos
< hlinfo
->mouse_face_end_col
))
27903 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27905 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
27908 else if ((vpos
== hlinfo
->mouse_face_beg_row
27909 && hpos
<= hlinfo
->mouse_face_beg_col
)
27910 || (vpos
== hlinfo
->mouse_face_end_row
27911 && hpos
> hlinfo
->mouse_face_end_col
))
27919 True if physical cursor of window W is within mouse face. */
27922 cursor_in_mouse_face_p (struct window
*w
)
27924 int hpos
= w
->phys_cursor
.hpos
;
27925 int vpos
= w
->phys_cursor
.vpos
;
27926 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27928 /* When the window is hscrolled, cursor hpos can legitimately be out
27929 of bounds, but we draw the cursor at the corresponding window
27930 margin in that case. */
27931 if (!row
->reversed_p
&& hpos
< 0)
27933 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27934 hpos
= row
->used
[TEXT_AREA
] - 1;
27936 return coords_in_mouse_face_p (w
, hpos
, vpos
);
27941 /* Find the glyph rows START_ROW and END_ROW of window W that display
27942 characters between buffer positions START_CHARPOS and END_CHARPOS
27943 (excluding END_CHARPOS). DISP_STRING is a display string that
27944 covers these buffer positions. This is similar to
27945 row_containing_pos, but is more accurate when bidi reordering makes
27946 buffer positions change non-linearly with glyph rows. */
27948 rows_from_pos_range (struct window
*w
,
27949 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
27950 Lisp_Object disp_string
,
27951 struct glyph_row
**start
, struct glyph_row
**end
)
27953 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27954 int last_y
= window_text_bottom_y (w
);
27955 struct glyph_row
*row
;
27960 while (!first
->enabled_p
27961 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
27964 /* Find the START row. */
27966 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
27969 /* A row can potentially be the START row if the range of the
27970 characters it displays intersects the range
27971 [START_CHARPOS..END_CHARPOS). */
27972 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
27973 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
27974 /* See the commentary in row_containing_pos, for the
27975 explanation of the complicated way to check whether
27976 some position is beyond the end of the characters
27977 displayed by a row. */
27978 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27979 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27980 && !row
->ends_at_zv_p
27981 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
27982 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27983 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27984 && !row
->ends_at_zv_p
27985 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
27987 /* Found a candidate row. Now make sure at least one of the
27988 glyphs it displays has a charpos from the range
27989 [START_CHARPOS..END_CHARPOS).
27991 This is not obvious because bidi reordering could make
27992 buffer positions of a row be 1,2,3,102,101,100, and if we
27993 want to highlight characters in [50..60), we don't want
27994 this row, even though [50..60) does intersect [1..103),
27995 the range of character positions given by the row's start
27996 and end positions. */
27997 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
27998 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28002 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
28003 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28004 /* A glyph that comes from DISP_STRING is by
28005 definition to be highlighted. */
28006 || EQ (g
->object
, disp_string
))
28015 /* Find the END row. */
28017 /* If the last row is partially visible, start looking for END
28018 from that row, instead of starting from FIRST. */
28019 && !(row
->enabled_p
28020 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28022 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28024 struct glyph_row
*next
= row
+ 1;
28025 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28027 if (!next
->enabled_p
28028 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28029 /* The first row >= START whose range of displayed characters
28030 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28031 is the row END + 1. */
28032 || (start_charpos
< next_start
28033 && end_charpos
< next_start
)
28034 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28035 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28036 && !next
->ends_at_zv_p
28037 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28038 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28039 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28040 && !next
->ends_at_zv_p
28041 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28048 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28049 but none of the characters it displays are in the range, it is
28051 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28052 struct glyph
*s
= g
;
28053 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28057 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
28058 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28059 /* If the buffer position of the first glyph in
28060 the row is equal to END_CHARPOS, it means
28061 the last character to be highlighted is the
28062 newline of ROW, and we must consider NEXT as
28064 || (((!next
->reversed_p
&& g
== s
)
28065 || (next
->reversed_p
&& g
== e
- 1))
28066 && (g
->charpos
== end_charpos
28067 /* Special case for when NEXT is an
28068 empty line at ZV. */
28069 || (g
->charpos
== -1
28070 && !row
->ends_at_zv_p
28071 && next_start
== end_charpos
)))))
28072 /* A glyph that comes from DISP_STRING is by
28073 definition to be highlighted. */
28074 || EQ (g
->object
, disp_string
))
28083 /* The first row that ends at ZV must be the last to be
28085 else if (next
->ends_at_zv_p
)
28094 /* This function sets the mouse_face_* elements of HLINFO, assuming
28095 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28096 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28097 for the overlay or run of text properties specifying the mouse
28098 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28099 before-string and after-string that must also be highlighted.
28100 DISP_STRING, if non-nil, is a display string that may cover some
28101 or all of the highlighted text. */
28104 mouse_face_from_buffer_pos (Lisp_Object window
,
28105 Mouse_HLInfo
*hlinfo
,
28106 ptrdiff_t mouse_charpos
,
28107 ptrdiff_t start_charpos
,
28108 ptrdiff_t end_charpos
,
28109 Lisp_Object before_string
,
28110 Lisp_Object after_string
,
28111 Lisp_Object disp_string
)
28113 struct window
*w
= XWINDOW (window
);
28114 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28115 struct glyph_row
*r1
, *r2
;
28116 struct glyph
*glyph
, *end
;
28117 ptrdiff_t ignore
, pos
;
28120 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28121 eassert (NILP (before_string
) || STRINGP (before_string
));
28122 eassert (NILP (after_string
) || STRINGP (after_string
));
28124 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28125 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28127 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28128 /* If the before-string or display-string contains newlines,
28129 rows_from_pos_range skips to its last row. Move back. */
28130 if (!NILP (before_string
) || !NILP (disp_string
))
28132 struct glyph_row
*prev
;
28133 while ((prev
= r1
- 1, prev
>= first
)
28134 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28135 && prev
->used
[TEXT_AREA
] > 0)
28137 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28138 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28139 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
28141 || !(EQ (glyph
->object
, before_string
)
28142 || EQ (glyph
->object
, disp_string
)))
28149 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28150 hlinfo
->mouse_face_past_end
= 1;
28152 else if (!NILP (after_string
))
28154 /* If the after-string has newlines, advance to its last row. */
28155 struct glyph_row
*next
;
28156 struct glyph_row
*last
28157 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28159 for (next
= r2
+ 1;
28161 && next
->used
[TEXT_AREA
] > 0
28162 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28166 /* The rest of the display engine assumes that mouse_face_beg_row is
28167 either above mouse_face_end_row or identical to it. But with
28168 bidi-reordered continued lines, the row for START_CHARPOS could
28169 be below the row for END_CHARPOS. If so, swap the rows and store
28170 them in correct order. */
28173 struct glyph_row
*tem
= r2
;
28179 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28180 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28182 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28183 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28184 could be anywhere in the row and in any order. The strategy
28185 below is to find the leftmost and the rightmost glyph that
28186 belongs to either of these 3 strings, or whose position is
28187 between START_CHARPOS and END_CHARPOS, and highlight all the
28188 glyphs between those two. This may cover more than just the text
28189 between START_CHARPOS and END_CHARPOS if the range of characters
28190 strides the bidi level boundary, e.g. if the beginning is in R2L
28191 text while the end is in L2R text or vice versa. */
28192 if (!r1
->reversed_p
)
28194 /* This row is in a left to right paragraph. Scan it left to
28196 glyph
= r1
->glyphs
[TEXT_AREA
];
28197 end
= glyph
+ r1
->used
[TEXT_AREA
];
28200 /* Skip truncation glyphs at the start of the glyph row. */
28201 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28203 && INTEGERP (glyph
->object
)
28204 && glyph
->charpos
< 0;
28206 x
+= glyph
->pixel_width
;
28208 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28209 or DISP_STRING, and the first glyph from buffer whose
28210 position is between START_CHARPOS and END_CHARPOS. */
28212 && !INTEGERP (glyph
->object
)
28213 && !EQ (glyph
->object
, disp_string
)
28214 && !(BUFFERP (glyph
->object
)
28215 && (glyph
->charpos
>= start_charpos
28216 && glyph
->charpos
< end_charpos
));
28219 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28220 are present at buffer positions between START_CHARPOS and
28221 END_CHARPOS, or if they come from an overlay. */
28222 if (EQ (glyph
->object
, before_string
))
28224 pos
= string_buffer_position (before_string
,
28226 /* If pos == 0, it means before_string came from an
28227 overlay, not from a buffer position. */
28228 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28231 else if (EQ (glyph
->object
, after_string
))
28233 pos
= string_buffer_position (after_string
, end_charpos
);
28234 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28237 x
+= glyph
->pixel_width
;
28239 hlinfo
->mouse_face_beg_x
= x
;
28240 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28244 /* This row is in a right to left paragraph. Scan it right to
28248 end
= r1
->glyphs
[TEXT_AREA
] - 1;
28249 glyph
= end
+ r1
->used
[TEXT_AREA
];
28251 /* Skip truncation glyphs at the start of the glyph row. */
28252 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28254 && INTEGERP (glyph
->object
)
28255 && glyph
->charpos
< 0;
28259 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28260 or DISP_STRING, and the first glyph from buffer whose
28261 position is between START_CHARPOS and END_CHARPOS. */
28263 && !INTEGERP (glyph
->object
)
28264 && !EQ (glyph
->object
, disp_string
)
28265 && !(BUFFERP (glyph
->object
)
28266 && (glyph
->charpos
>= start_charpos
28267 && glyph
->charpos
< end_charpos
));
28270 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28271 are present at buffer positions between START_CHARPOS and
28272 END_CHARPOS, or if they come from an overlay. */
28273 if (EQ (glyph
->object
, before_string
))
28275 pos
= string_buffer_position (before_string
, start_charpos
);
28276 /* If pos == 0, it means before_string came from an
28277 overlay, not from a buffer position. */
28278 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28281 else if (EQ (glyph
->object
, after_string
))
28283 pos
= string_buffer_position (after_string
, end_charpos
);
28284 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28289 glyph
++; /* first glyph to the right of the highlighted area */
28290 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28291 x
+= g
->pixel_width
;
28292 hlinfo
->mouse_face_beg_x
= x
;
28293 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28296 /* If the highlight ends in a different row, compute GLYPH and END
28297 for the end row. Otherwise, reuse the values computed above for
28298 the row where the highlight begins. */
28301 if (!r2
->reversed_p
)
28303 glyph
= r2
->glyphs
[TEXT_AREA
];
28304 end
= glyph
+ r2
->used
[TEXT_AREA
];
28309 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28310 glyph
= end
+ r2
->used
[TEXT_AREA
];
28314 if (!r2
->reversed_p
)
28316 /* Skip truncation and continuation glyphs near the end of the
28317 row, and also blanks and stretch glyphs inserted by
28318 extend_face_to_end_of_line. */
28320 && INTEGERP ((end
- 1)->object
))
28322 /* Scan the rest of the glyph row from the end, looking for the
28323 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28324 DISP_STRING, or whose position is between START_CHARPOS
28328 && !INTEGERP (end
->object
)
28329 && !EQ (end
->object
, disp_string
)
28330 && !(BUFFERP (end
->object
)
28331 && (end
->charpos
>= start_charpos
28332 && end
->charpos
< end_charpos
));
28335 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28336 are present at buffer positions between START_CHARPOS and
28337 END_CHARPOS, or if they come from an overlay. */
28338 if (EQ (end
->object
, before_string
))
28340 pos
= string_buffer_position (before_string
, start_charpos
);
28341 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28344 else if (EQ (end
->object
, after_string
))
28346 pos
= string_buffer_position (after_string
, end_charpos
);
28347 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28351 /* Find the X coordinate of the last glyph to be highlighted. */
28352 for (; glyph
<= end
; ++glyph
)
28353 x
+= glyph
->pixel_width
;
28355 hlinfo
->mouse_face_end_x
= x
;
28356 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28360 /* Skip truncation and continuation glyphs near the end of the
28361 row, and also blanks and stretch glyphs inserted by
28362 extend_face_to_end_of_line. */
28366 && INTEGERP (end
->object
))
28368 x
+= end
->pixel_width
;
28371 /* Scan the rest of the glyph row from the end, looking for the
28372 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28373 DISP_STRING, or whose position is between START_CHARPOS
28377 && !INTEGERP (end
->object
)
28378 && !EQ (end
->object
, disp_string
)
28379 && !(BUFFERP (end
->object
)
28380 && (end
->charpos
>= start_charpos
28381 && end
->charpos
< end_charpos
));
28384 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28385 are present at buffer positions between START_CHARPOS and
28386 END_CHARPOS, or if they come from an overlay. */
28387 if (EQ (end
->object
, before_string
))
28389 pos
= string_buffer_position (before_string
, start_charpos
);
28390 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28393 else if (EQ (end
->object
, after_string
))
28395 pos
= string_buffer_position (after_string
, end_charpos
);
28396 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28399 x
+= end
->pixel_width
;
28401 /* If we exited the above loop because we arrived at the last
28402 glyph of the row, and its buffer position is still not in
28403 range, it means the last character in range is the preceding
28404 newline. Bump the end column and x values to get past the
28407 && BUFFERP (end
->object
)
28408 && (end
->charpos
< start_charpos
28409 || end
->charpos
>= end_charpos
))
28411 x
+= end
->pixel_width
;
28414 hlinfo
->mouse_face_end_x
= x
;
28415 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28418 hlinfo
->mouse_face_window
= window
;
28419 hlinfo
->mouse_face_face_id
28420 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28422 !hlinfo
->mouse_face_hidden
, -1);
28423 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28426 /* The following function is not used anymore (replaced with
28427 mouse_face_from_string_pos), but I leave it here for the time
28428 being, in case someone would. */
28430 #if 0 /* not used */
28432 /* Find the position of the glyph for position POS in OBJECT in
28433 window W's current matrix, and return in *X, *Y the pixel
28434 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28436 RIGHT_P non-zero means return the position of the right edge of the
28437 glyph, RIGHT_P zero means return the left edge position.
28439 If no glyph for POS exists in the matrix, return the position of
28440 the glyph with the next smaller position that is in the matrix, if
28441 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
28442 exists in the matrix, return the position of the glyph with the
28443 next larger position in OBJECT.
28445 Value is non-zero if a glyph was found. */
28448 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28449 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
28451 int yb
= window_text_bottom_y (w
);
28452 struct glyph_row
*r
;
28453 struct glyph
*best_glyph
= NULL
;
28454 struct glyph_row
*best_row
= NULL
;
28457 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28458 r
->enabled_p
&& r
->y
< yb
;
28461 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28462 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28465 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28466 if (EQ (g
->object
, object
))
28468 if (g
->charpos
== pos
)
28475 else if (best_glyph
== NULL
28476 || ((eabs (g
->charpos
- pos
)
28477 < eabs (best_glyph
->charpos
- pos
))
28480 : g
->charpos
> pos
)))
28494 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28498 *x
+= best_glyph
->pixel_width
;
28503 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28506 return best_glyph
!= NULL
;
28508 #endif /* not used */
28510 /* Find the positions of the first and the last glyphs in window W's
28511 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28512 (assumed to be a string), and return in HLINFO's mouse_face_*
28513 members the pixel and column/row coordinates of those glyphs. */
28516 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28517 Lisp_Object object
,
28518 ptrdiff_t startpos
, ptrdiff_t endpos
)
28520 int yb
= window_text_bottom_y (w
);
28521 struct glyph_row
*r
;
28522 struct glyph
*g
, *e
;
28526 /* Find the glyph row with at least one position in the range
28527 [STARTPOS..ENDPOS), and the first glyph in that row whose
28528 position belongs to that range. */
28529 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28530 r
->enabled_p
&& r
->y
< yb
;
28533 if (!r
->reversed_p
)
28535 g
= r
->glyphs
[TEXT_AREA
];
28536 e
= g
+ r
->used
[TEXT_AREA
];
28537 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28538 if (EQ (g
->object
, object
)
28539 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28541 hlinfo
->mouse_face_beg_row
28542 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28543 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28544 hlinfo
->mouse_face_beg_x
= gx
;
28553 e
= r
->glyphs
[TEXT_AREA
];
28554 g
= e
+ r
->used
[TEXT_AREA
];
28555 for ( ; g
> e
; --g
)
28556 if (EQ ((g
-1)->object
, object
)
28557 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
28559 hlinfo
->mouse_face_beg_row
28560 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28561 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28562 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
28563 gx
+= g1
->pixel_width
;
28564 hlinfo
->mouse_face_beg_x
= gx
;
28576 /* Starting with the next row, look for the first row which does NOT
28577 include any glyphs whose positions are in the range. */
28578 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
28580 g
= r
->glyphs
[TEXT_AREA
];
28581 e
= g
+ r
->used
[TEXT_AREA
];
28583 for ( ; g
< e
; ++g
)
28584 if (EQ (g
->object
, object
)
28585 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28594 /* The highlighted region ends on the previous row. */
28597 /* Set the end row. */
28598 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28600 /* Compute and set the end column and the end column's horizontal
28601 pixel coordinate. */
28602 if (!r
->reversed_p
)
28604 g
= r
->glyphs
[TEXT_AREA
];
28605 e
= g
+ r
->used
[TEXT_AREA
];
28606 for ( ; e
> g
; --e
)
28607 if (EQ ((e
-1)->object
, object
)
28608 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
28610 hlinfo
->mouse_face_end_col
= e
- g
;
28612 for (gx
= r
->x
; g
< e
; ++g
)
28613 gx
+= g
->pixel_width
;
28614 hlinfo
->mouse_face_end_x
= gx
;
28618 e
= r
->glyphs
[TEXT_AREA
];
28619 g
= e
+ r
->used
[TEXT_AREA
];
28620 for (gx
= r
->x
; e
< g
; ++e
)
28622 if (EQ (e
->object
, object
)
28623 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
28625 gx
+= e
->pixel_width
;
28627 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
28628 hlinfo
->mouse_face_end_x
= gx
;
28632 #ifdef HAVE_WINDOW_SYSTEM
28634 /* See if position X, Y is within a hot-spot of an image. */
28637 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
28639 if (!CONSP (hot_spot
))
28642 if (EQ (XCAR (hot_spot
), Qrect
))
28644 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
28645 Lisp_Object rect
= XCDR (hot_spot
);
28649 if (!CONSP (XCAR (rect
)))
28651 if (!CONSP (XCDR (rect
)))
28653 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
28655 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
28657 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
28659 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
28663 else if (EQ (XCAR (hot_spot
), Qcircle
))
28665 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
28666 Lisp_Object circ
= XCDR (hot_spot
);
28667 Lisp_Object lr
, lx0
, ly0
;
28669 && CONSP (XCAR (circ
))
28670 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
28671 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
28672 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
28674 double r
= XFLOATINT (lr
);
28675 double dx
= XINT (lx0
) - x
;
28676 double dy
= XINT (ly0
) - y
;
28677 return (dx
* dx
+ dy
* dy
<= r
* r
);
28680 else if (EQ (XCAR (hot_spot
), Qpoly
))
28682 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
28683 if (VECTORP (XCDR (hot_spot
)))
28685 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
28686 Lisp_Object
*poly
= v
->contents
;
28687 ptrdiff_t n
= v
->header
.size
;
28690 Lisp_Object lx
, ly
;
28693 /* Need an even number of coordinates, and at least 3 edges. */
28694 if (n
< 6 || n
& 1)
28697 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
28698 If count is odd, we are inside polygon. Pixels on edges
28699 may or may not be included depending on actual geometry of the
28701 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
28702 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
28704 x0
= XINT (lx
), y0
= XINT (ly
);
28705 for (i
= 0; i
< n
; i
+= 2)
28707 int x1
= x0
, y1
= y0
;
28708 if ((lx
= poly
[i
], !INTEGERP (lx
))
28709 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
28711 x0
= XINT (lx
), y0
= XINT (ly
);
28713 /* Does this segment cross the X line? */
28721 if (y
> y0
&& y
> y1
)
28723 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
28733 find_hot_spot (Lisp_Object map
, int x
, int y
)
28735 while (CONSP (map
))
28737 if (CONSP (XCAR (map
))
28738 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
28746 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
28748 doc
: /* Lookup in image map MAP coordinates X and Y.
28749 An image map is an alist where each element has the format (AREA ID PLIST).
28750 An AREA is specified as either a rectangle, a circle, or a polygon:
28751 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
28752 pixel coordinates of the upper left and bottom right corners.
28753 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
28754 and the radius of the circle; r may be a float or integer.
28755 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
28756 vector describes one corner in the polygon.
28757 Returns the alist element for the first matching AREA in MAP. */)
28758 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
28766 return find_hot_spot (map
,
28767 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
28768 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
28772 /* Display frame CURSOR, optionally using shape defined by POINTER. */
28774 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
28776 /* Do not change cursor shape while dragging mouse. */
28777 if (!NILP (do_mouse_tracking
))
28780 if (!NILP (pointer
))
28782 if (EQ (pointer
, Qarrow
))
28783 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28784 else if (EQ (pointer
, Qhand
))
28785 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
28786 else if (EQ (pointer
, Qtext
))
28787 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
28788 else if (EQ (pointer
, intern ("hdrag")))
28789 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28790 else if (EQ (pointer
, intern ("nhdrag")))
28791 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
28792 #ifdef HAVE_X_WINDOWS
28793 else if (EQ (pointer
, intern ("vdrag")))
28794 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28796 else if (EQ (pointer
, intern ("hourglass")))
28797 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
28798 else if (EQ (pointer
, Qmodeline
))
28799 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
28801 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28804 if (cursor
!= No_Cursor
)
28805 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
28808 #endif /* HAVE_WINDOW_SYSTEM */
28810 /* Take proper action when mouse has moved to the mode or header line
28811 or marginal area AREA of window W, x-position X and y-position Y.
28812 X is relative to the start of the text display area of W, so the
28813 width of bitmap areas and scroll bars must be subtracted to get a
28814 position relative to the start of the mode line. */
28817 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
28818 enum window_part area
)
28820 struct window
*w
= XWINDOW (window
);
28821 struct frame
*f
= XFRAME (w
->frame
);
28822 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28823 #ifdef HAVE_WINDOW_SYSTEM
28824 Display_Info
*dpyinfo
;
28826 Cursor cursor
= No_Cursor
;
28827 Lisp_Object pointer
= Qnil
;
28828 int dx
, dy
, width
, height
;
28830 Lisp_Object string
, object
= Qnil
;
28831 Lisp_Object pos
IF_LINT (= Qnil
), help
;
28833 Lisp_Object mouse_face
;
28834 int original_x_pixel
= x
;
28835 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
28836 struct glyph_row
*row
IF_LINT (= 0);
28838 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
28843 /* Kludge alert: mode_line_string takes X/Y in pixels, but
28844 returns them in row/column units! */
28845 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
28846 &object
, &dx
, &dy
, &width
, &height
);
28848 row
= (area
== ON_MODE_LINE
28849 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
28850 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
28852 /* Find the glyph under the mouse pointer. */
28853 if (row
->mode_line_p
&& row
->enabled_p
)
28855 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
28856 end
= glyph
+ row
->used
[TEXT_AREA
];
28858 for (x0
= original_x_pixel
;
28859 glyph
< end
&& x0
>= glyph
->pixel_width
;
28861 x0
-= glyph
->pixel_width
;
28869 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
28870 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
28871 returns them in row/column units! */
28872 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
28873 &object
, &dx
, &dy
, &width
, &height
);
28878 #ifdef HAVE_WINDOW_SYSTEM
28879 if (IMAGEP (object
))
28881 Lisp_Object image_map
, hotspot
;
28882 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
28884 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
28886 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
28890 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
28891 If so, we could look for mouse-enter, mouse-leave
28892 properties in PLIST (and do something...). */
28893 hotspot
= XCDR (hotspot
);
28894 if (CONSP (hotspot
)
28895 && (plist
= XCAR (hotspot
), CONSP (plist
)))
28897 pointer
= Fplist_get (plist
, Qpointer
);
28898 if (NILP (pointer
))
28900 help
= Fplist_get (plist
, Qhelp_echo
);
28903 help_echo_string
= help
;
28904 XSETWINDOW (help_echo_window
, w
);
28905 help_echo_object
= w
->contents
;
28906 help_echo_pos
= charpos
;
28910 if (NILP (pointer
))
28911 pointer
= Fplist_get (XCDR (object
), QCpointer
);
28913 #endif /* HAVE_WINDOW_SYSTEM */
28915 if (STRINGP (string
))
28916 pos
= make_number (charpos
);
28918 /* Set the help text and mouse pointer. If the mouse is on a part
28919 of the mode line without any text (e.g. past the right edge of
28920 the mode line text), use the default help text and pointer. */
28921 if (STRINGP (string
) || area
== ON_MODE_LINE
)
28923 /* Arrange to display the help by setting the global variables
28924 help_echo_string, help_echo_object, and help_echo_pos. */
28927 if (STRINGP (string
))
28928 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
28932 help_echo_string
= help
;
28933 XSETWINDOW (help_echo_window
, w
);
28934 help_echo_object
= string
;
28935 help_echo_pos
= charpos
;
28937 else if (area
== ON_MODE_LINE
)
28939 Lisp_Object default_help
28940 = buffer_local_value_1 (Qmode_line_default_help_echo
,
28943 if (STRINGP (default_help
))
28945 help_echo_string
= default_help
;
28946 XSETWINDOW (help_echo_window
, w
);
28947 help_echo_object
= Qnil
;
28948 help_echo_pos
= -1;
28953 #ifdef HAVE_WINDOW_SYSTEM
28954 /* Change the mouse pointer according to what is under it. */
28955 if (FRAME_WINDOW_P (f
))
28957 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
28959 || NILP (Vresize_mini_windows
));
28961 dpyinfo
= FRAME_DISPLAY_INFO (f
);
28962 if (STRINGP (string
))
28964 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28966 if (NILP (pointer
))
28967 pointer
= Fget_text_property (pos
, Qpointer
, string
);
28969 /* Change the mouse pointer according to what is under X/Y. */
28971 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
28974 map
= Fget_text_property (pos
, Qlocal_map
, string
);
28975 if (!KEYMAPP (map
))
28976 map
= Fget_text_property (pos
, Qkeymap
, string
);
28977 if (!KEYMAPP (map
) && draggable
)
28978 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
28981 else if (draggable
)
28982 /* Default mode-line pointer. */
28983 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28988 /* Change the mouse face according to what is under X/Y. */
28989 if (STRINGP (string
))
28991 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
28992 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
28993 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
28998 struct glyph
* tmp_glyph
;
29002 int total_pixel_width
;
29003 ptrdiff_t begpos
, endpos
, ignore
;
29007 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29008 Qmouse_face
, string
, Qnil
);
29014 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29016 endpos
= SCHARS (string
);
29020 /* Calculate the glyph position GPOS of GLYPH in the
29021 displayed string, relative to the beginning of the
29022 highlighted part of the string.
29024 Note: GPOS is different from CHARPOS. CHARPOS is the
29025 position of GLYPH in the internal string object. A mode
29026 line string format has structures which are converted to
29027 a flattened string by the Emacs Lisp interpreter. The
29028 internal string is an element of those structures. The
29029 displayed string is the flattened string. */
29030 tmp_glyph
= row_start_glyph
;
29031 while (tmp_glyph
< glyph
29032 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29033 && begpos
<= tmp_glyph
->charpos
29034 && tmp_glyph
->charpos
< endpos
)))
29036 gpos
= glyph
- tmp_glyph
;
29038 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29039 the highlighted part of the displayed string to which
29040 GLYPH belongs. Note: GSEQ_LENGTH is different from
29041 SCHARS (STRING), because the latter returns the length of
29042 the internal string. */
29043 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29045 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29046 && begpos
<= tmp_glyph
->charpos
29047 && tmp_glyph
->charpos
< endpos
));
29050 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29052 /* Calculate the total pixel width of all the glyphs between
29053 the beginning of the highlighted area and GLYPH. */
29054 total_pixel_width
= 0;
29055 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29056 total_pixel_width
+= tmp_glyph
->pixel_width
;
29058 /* Pre calculation of re-rendering position. Note: X is in
29059 column units here, after the call to mode_line_string or
29060 marginal_area_string. */
29062 vpos
= (area
== ON_MODE_LINE
29063 ? (w
->current_matrix
)->nrows
- 1
29066 /* If GLYPH's position is included in the region that is
29067 already drawn in mouse face, we have nothing to do. */
29068 if ( EQ (window
, hlinfo
->mouse_face_window
)
29069 && (!row
->reversed_p
29070 ? (hlinfo
->mouse_face_beg_col
<= hpos
29071 && hpos
< hlinfo
->mouse_face_end_col
)
29072 /* In R2L rows we swap BEG and END, see below. */
29073 : (hlinfo
->mouse_face_end_col
<= hpos
29074 && hpos
< hlinfo
->mouse_face_beg_col
))
29075 && hlinfo
->mouse_face_beg_row
== vpos
)
29078 if (clear_mouse_face (hlinfo
))
29079 cursor
= No_Cursor
;
29081 if (!row
->reversed_p
)
29083 hlinfo
->mouse_face_beg_col
= hpos
;
29084 hlinfo
->mouse_face_beg_x
= original_x_pixel
29085 - (total_pixel_width
+ dx
);
29086 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29087 hlinfo
->mouse_face_end_x
= 0;
29091 /* In R2L rows, show_mouse_face expects BEG and END
29092 coordinates to be swapped. */
29093 hlinfo
->mouse_face_end_col
= hpos
;
29094 hlinfo
->mouse_face_end_x
= original_x_pixel
29095 - (total_pixel_width
+ dx
);
29096 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29097 hlinfo
->mouse_face_beg_x
= 0;
29100 hlinfo
->mouse_face_beg_row
= vpos
;
29101 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29102 hlinfo
->mouse_face_past_end
= 0;
29103 hlinfo
->mouse_face_window
= window
;
29105 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29110 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29112 if (NILP (pointer
))
29115 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29116 clear_mouse_face (hlinfo
);
29118 #ifdef HAVE_WINDOW_SYSTEM
29119 if (FRAME_WINDOW_P (f
))
29120 define_frame_cursor1 (f
, cursor
, pointer
);
29126 Take proper action when the mouse has moved to position X, Y on
29127 frame F with regards to highlighting portions of display that have
29128 mouse-face properties. Also de-highlight portions of display where
29129 the mouse was before, set the mouse pointer shape as appropriate
29130 for the mouse coordinates, and activate help echo (tooltips).
29131 X and Y can be negative or out of range. */
29134 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29136 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29137 enum window_part part
= ON_NOTHING
;
29138 Lisp_Object window
;
29140 Cursor cursor
= No_Cursor
;
29141 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29144 /* When a menu is active, don't highlight because this looks odd. */
29145 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29146 if (popup_activated ())
29150 if (!f
->glyphs_initialized_p
29151 || f
->pointer_invisible
)
29154 hlinfo
->mouse_face_mouse_x
= x
;
29155 hlinfo
->mouse_face_mouse_y
= y
;
29156 hlinfo
->mouse_face_mouse_frame
= f
;
29158 if (hlinfo
->mouse_face_defer
)
29161 /* Which window is that in? */
29162 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
29164 /* If displaying active text in another window, clear that. */
29165 if (! EQ (window
, hlinfo
->mouse_face_window
)
29166 /* Also clear if we move out of text area in same window. */
29167 || (!NILP (hlinfo
->mouse_face_window
)
29170 && part
!= ON_MODE_LINE
29171 && part
!= ON_HEADER_LINE
))
29172 clear_mouse_face (hlinfo
);
29174 /* Not on a window -> return. */
29175 if (!WINDOWP (window
))
29178 /* Reset help_echo_string. It will get recomputed below. */
29179 help_echo_string
= Qnil
;
29181 /* Convert to window-relative pixel coordinates. */
29182 w
= XWINDOW (window
);
29183 frame_to_window_pixel_xy (w
, &x
, &y
);
29185 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29186 /* Handle tool-bar window differently since it doesn't display a
29188 if (EQ (window
, f
->tool_bar_window
))
29190 note_tool_bar_highlight (f
, x
, y
);
29195 /* Mouse is on the mode, header line or margin? */
29196 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29197 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29199 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29201 #ifdef HAVE_WINDOW_SYSTEM
29202 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29204 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29205 /* Show non-text cursor (Bug#16647). */
29213 #ifdef HAVE_WINDOW_SYSTEM
29214 if (part
== ON_VERTICAL_BORDER
)
29216 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29217 help_echo_string
= build_string ("drag-mouse-1: resize");
29219 else if (part
== ON_RIGHT_DIVIDER
)
29221 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29222 help_echo_string
= build_string ("drag-mouse-1: resize");
29224 else if (part
== ON_BOTTOM_DIVIDER
)
29225 if (! WINDOW_BOTTOMMOST_P (w
)
29227 || NILP (Vresize_mini_windows
))
29229 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29230 help_echo_string
= build_string ("drag-mouse-1: resize");
29233 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29234 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
29235 || part
== ON_SCROLL_BAR
)
29236 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29238 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29241 /* Are we in a window whose display is up to date?
29242 And verify the buffer's text has not changed. */
29243 b
= XBUFFER (w
->contents
);
29244 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
29246 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
29248 struct glyph
*glyph
;
29249 Lisp_Object object
;
29250 Lisp_Object mouse_face
= Qnil
, position
;
29251 Lisp_Object
*overlay_vec
= NULL
;
29252 ptrdiff_t i
, noverlays
;
29253 struct buffer
*obuf
;
29254 ptrdiff_t obegv
, ozv
;
29257 /* Find the glyph under X/Y. */
29258 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
29260 #ifdef HAVE_WINDOW_SYSTEM
29261 /* Look for :pointer property on image. */
29262 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29264 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29265 if (img
!= NULL
&& IMAGEP (img
->spec
))
29267 Lisp_Object image_map
, hotspot
;
29268 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29270 && (hotspot
= find_hot_spot (image_map
,
29271 glyph
->slice
.img
.x
+ dx
,
29272 glyph
->slice
.img
.y
+ dy
),
29274 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29278 /* Could check XCAR (hotspot) to see if we enter/leave
29280 If so, we could look for mouse-enter, mouse-leave
29281 properties in PLIST (and do something...). */
29282 hotspot
= XCDR (hotspot
);
29283 if (CONSP (hotspot
)
29284 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29286 pointer
= Fplist_get (plist
, Qpointer
);
29287 if (NILP (pointer
))
29289 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29290 if (!NILP (help_echo_string
))
29292 help_echo_window
= window
;
29293 help_echo_object
= glyph
->object
;
29294 help_echo_pos
= glyph
->charpos
;
29298 if (NILP (pointer
))
29299 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29302 #endif /* HAVE_WINDOW_SYSTEM */
29304 /* Clear mouse face if X/Y not over text. */
29306 || area
!= TEXT_AREA
29307 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29308 /* Glyph's OBJECT is an integer for glyphs inserted by the
29309 display engine for its internal purposes, like truncation
29310 and continuation glyphs and blanks beyond the end of
29311 line's text on text terminals. If we are over such a
29312 glyph, we are not over any text. */
29313 || INTEGERP (glyph
->object
)
29314 /* R2L rows have a stretch glyph at their front, which
29315 stands for no text, whereas L2R rows have no glyphs at
29316 all beyond the end of text. Treat such stretch glyphs
29317 like we do with NULL glyphs in L2R rows. */
29318 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29319 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29320 && glyph
->type
== STRETCH_GLYPH
29321 && glyph
->avoid_cursor_p
))
29323 if (clear_mouse_face (hlinfo
))
29324 cursor
= No_Cursor
;
29325 #ifdef HAVE_WINDOW_SYSTEM
29326 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29328 if (area
!= TEXT_AREA
)
29329 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29331 pointer
= Vvoid_text_area_pointer
;
29337 pos
= glyph
->charpos
;
29338 object
= glyph
->object
;
29339 if (!STRINGP (object
) && !BUFFERP (object
))
29342 /* If we get an out-of-range value, return now; avoid an error. */
29343 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29346 /* Make the window's buffer temporarily current for
29347 overlays_at and compute_char_face. */
29348 obuf
= current_buffer
;
29349 current_buffer
= b
;
29355 /* Is this char mouse-active or does it have help-echo? */
29356 position
= make_number (pos
);
29358 if (BUFFERP (object
))
29360 /* Put all the overlays we want in a vector in overlay_vec. */
29361 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
29362 /* Sort overlays into increasing priority order. */
29363 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29368 if (NILP (Vmouse_highlight
))
29370 clear_mouse_face (hlinfo
);
29371 goto check_help_echo
;
29374 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29377 cursor
= No_Cursor
;
29379 /* Check mouse-face highlighting. */
29381 /* If there exists an overlay with mouse-face overlapping
29382 the one we are currently highlighting, we have to
29383 check if we enter the overlapping overlay, and then
29384 highlight only that. */
29385 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29386 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29388 /* Find the highest priority overlay with a mouse-face. */
29389 Lisp_Object overlay
= Qnil
;
29390 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29392 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29393 if (!NILP (mouse_face
))
29394 overlay
= overlay_vec
[i
];
29397 /* If we're highlighting the same overlay as before, there's
29398 no need to do that again. */
29399 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29400 goto check_help_echo
;
29401 hlinfo
->mouse_face_overlay
= overlay
;
29403 /* Clear the display of the old active region, if any. */
29404 if (clear_mouse_face (hlinfo
))
29405 cursor
= No_Cursor
;
29407 /* If no overlay applies, get a text property. */
29408 if (NILP (overlay
))
29409 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29411 /* Next, compute the bounds of the mouse highlighting and
29413 if (!NILP (mouse_face
) && STRINGP (object
))
29415 /* The mouse-highlighting comes from a display string
29416 with a mouse-face. */
29420 s
= Fprevious_single_property_change
29421 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29422 e
= Fnext_single_property_change
29423 (position
, Qmouse_face
, object
, Qnil
);
29425 s
= make_number (0);
29427 e
= make_number (SCHARS (object
));
29428 mouse_face_from_string_pos (w
, hlinfo
, object
,
29429 XINT (s
), XINT (e
));
29430 hlinfo
->mouse_face_past_end
= 0;
29431 hlinfo
->mouse_face_window
= window
;
29432 hlinfo
->mouse_face_face_id
29433 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29434 glyph
->face_id
, 1);
29435 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29436 cursor
= No_Cursor
;
29440 /* The mouse-highlighting, if any, comes from an overlay
29441 or text property in the buffer. */
29442 Lisp_Object buffer
IF_LINT (= Qnil
);
29443 Lisp_Object disp_string
IF_LINT (= Qnil
);
29445 if (STRINGP (object
))
29447 /* If we are on a display string with no mouse-face,
29448 check if the text under it has one. */
29449 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29450 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29451 pos
= string_buffer_position (object
, start
);
29454 mouse_face
= get_char_property_and_overlay
29455 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29456 buffer
= w
->contents
;
29457 disp_string
= object
;
29463 disp_string
= Qnil
;
29466 if (!NILP (mouse_face
))
29468 Lisp_Object before
, after
;
29469 Lisp_Object before_string
, after_string
;
29470 /* To correctly find the limits of mouse highlight
29471 in a bidi-reordered buffer, we must not use the
29472 optimization of limiting the search in
29473 previous-single-property-change and
29474 next-single-property-change, because
29475 rows_from_pos_range needs the real start and end
29476 positions to DTRT in this case. That's because
29477 the first row visible in a window does not
29478 necessarily display the character whose position
29479 is the smallest. */
29481 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29482 ? Fmarker_position (w
->start
)
29485 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29486 ? make_number (BUF_Z (XBUFFER (buffer
))
29487 - w
->window_end_pos
)
29490 if (NILP (overlay
))
29492 /* Handle the text property case. */
29493 before
= Fprevious_single_property_change
29494 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29495 after
= Fnext_single_property_change
29496 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29497 before_string
= after_string
= Qnil
;
29501 /* Handle the overlay case. */
29502 before
= Foverlay_start (overlay
);
29503 after
= Foverlay_end (overlay
);
29504 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29505 after_string
= Foverlay_get (overlay
, Qafter_string
);
29507 if (!STRINGP (before_string
)) before_string
= Qnil
;
29508 if (!STRINGP (after_string
)) after_string
= Qnil
;
29511 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29514 : XFASTINT (before
),
29516 ? BUF_Z (XBUFFER (buffer
))
29517 : XFASTINT (after
),
29518 before_string
, after_string
,
29520 cursor
= No_Cursor
;
29527 /* Look for a `help-echo' property. */
29528 if (NILP (help_echo_string
)) {
29529 Lisp_Object help
, overlay
;
29531 /* Check overlays first. */
29532 help
= overlay
= Qnil
;
29533 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29535 overlay
= overlay_vec
[i
];
29536 help
= Foverlay_get (overlay
, Qhelp_echo
);
29541 help_echo_string
= help
;
29542 help_echo_window
= window
;
29543 help_echo_object
= overlay
;
29544 help_echo_pos
= pos
;
29548 Lisp_Object obj
= glyph
->object
;
29549 ptrdiff_t charpos
= glyph
->charpos
;
29551 /* Try text properties. */
29554 && charpos
< SCHARS (obj
))
29556 help
= Fget_text_property (make_number (charpos
),
29560 /* If the string itself doesn't specify a help-echo,
29561 see if the buffer text ``under'' it does. */
29562 struct glyph_row
*r
29563 = MATRIX_ROW (w
->current_matrix
, vpos
);
29564 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29565 ptrdiff_t p
= string_buffer_position (obj
, start
);
29568 help
= Fget_char_property (make_number (p
),
29569 Qhelp_echo
, w
->contents
);
29578 else if (BUFFERP (obj
)
29581 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
29586 help_echo_string
= help
;
29587 help_echo_window
= window
;
29588 help_echo_object
= obj
;
29589 help_echo_pos
= charpos
;
29594 #ifdef HAVE_WINDOW_SYSTEM
29595 /* Look for a `pointer' property. */
29596 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29598 /* Check overlays first. */
29599 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
29600 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
29602 if (NILP (pointer
))
29604 Lisp_Object obj
= glyph
->object
;
29605 ptrdiff_t charpos
= glyph
->charpos
;
29607 /* Try text properties. */
29610 && charpos
< SCHARS (obj
))
29612 pointer
= Fget_text_property (make_number (charpos
),
29614 if (NILP (pointer
))
29616 /* If the string itself doesn't specify a pointer,
29617 see if the buffer text ``under'' it does. */
29618 struct glyph_row
*r
29619 = MATRIX_ROW (w
->current_matrix
, vpos
);
29620 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29621 ptrdiff_t p
= string_buffer_position (obj
, start
);
29623 pointer
= Fget_char_property (make_number (p
),
29624 Qpointer
, w
->contents
);
29627 else if (BUFFERP (obj
)
29630 pointer
= Fget_text_property (make_number (charpos
),
29634 #endif /* HAVE_WINDOW_SYSTEM */
29638 current_buffer
= obuf
;
29643 #ifdef HAVE_WINDOW_SYSTEM
29644 if (FRAME_WINDOW_P (f
))
29645 define_frame_cursor1 (f
, cursor
, pointer
);
29647 /* This is here to prevent a compiler error, about "label at end of
29648 compound statement". */
29655 Clear any mouse-face on window W. This function is part of the
29656 redisplay interface, and is called from try_window_id and similar
29657 functions to ensure the mouse-highlight is off. */
29660 x_clear_window_mouse_face (struct window
*w
)
29662 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
29663 Lisp_Object window
;
29666 XSETWINDOW (window
, w
);
29667 if (EQ (window
, hlinfo
->mouse_face_window
))
29668 clear_mouse_face (hlinfo
);
29674 Just discard the mouse face information for frame F, if any.
29675 This is used when the size of F is changed. */
29678 cancel_mouse_face (struct frame
*f
)
29680 Lisp_Object window
;
29681 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29683 window
= hlinfo
->mouse_face_window
;
29684 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
29685 reset_mouse_highlight (hlinfo
);
29690 /***********************************************************************
29692 ***********************************************************************/
29694 #ifdef HAVE_WINDOW_SYSTEM
29696 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
29697 which intersects rectangle R. R is in window-relative coordinates. */
29700 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
29701 enum glyph_row_area area
)
29703 struct glyph
*first
= row
->glyphs
[area
];
29704 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
29705 struct glyph
*last
;
29706 int first_x
, start_x
, x
;
29708 if (area
== TEXT_AREA
&& row
->fill_line_p
)
29709 /* If row extends face to end of line write the whole line. */
29710 draw_glyphs (w
, 0, row
, area
,
29711 0, row
->used
[area
],
29712 DRAW_NORMAL_TEXT
, 0);
29715 /* Set START_X to the window-relative start position for drawing glyphs of
29716 AREA. The first glyph of the text area can be partially visible.
29717 The first glyphs of other areas cannot. */
29718 start_x
= window_box_left_offset (w
, area
);
29720 if (area
== TEXT_AREA
)
29723 /* Find the first glyph that must be redrawn. */
29725 && x
+ first
->pixel_width
< r
->x
)
29727 x
+= first
->pixel_width
;
29731 /* Find the last one. */
29735 && x
< r
->x
+ r
->width
)
29737 x
+= last
->pixel_width
;
29743 draw_glyphs (w
, first_x
- start_x
, row
, area
,
29744 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
29745 DRAW_NORMAL_TEXT
, 0);
29750 /* Redraw the parts of the glyph row ROW on window W intersecting
29751 rectangle R. R is in window-relative coordinates. Value is
29752 non-zero if mouse-face was overwritten. */
29755 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
29757 eassert (row
->enabled_p
);
29759 if (row
->mode_line_p
|| w
->pseudo_window_p
)
29760 draw_glyphs (w
, 0, row
, TEXT_AREA
,
29761 0, row
->used
[TEXT_AREA
],
29762 DRAW_NORMAL_TEXT
, 0);
29765 if (row
->used
[LEFT_MARGIN_AREA
])
29766 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
29767 if (row
->used
[TEXT_AREA
])
29768 expose_area (w
, row
, r
, TEXT_AREA
);
29769 if (row
->used
[RIGHT_MARGIN_AREA
])
29770 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
29771 draw_row_fringe_bitmaps (w
, row
);
29774 return row
->mouse_face_p
;
29778 /* Redraw those parts of glyphs rows during expose event handling that
29779 overlap other rows. Redrawing of an exposed line writes over parts
29780 of lines overlapping that exposed line; this function fixes that.
29782 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
29783 row in W's current matrix that is exposed and overlaps other rows.
29784 LAST_OVERLAPPING_ROW is the last such row. */
29787 expose_overlaps (struct window
*w
,
29788 struct glyph_row
*first_overlapping_row
,
29789 struct glyph_row
*last_overlapping_row
,
29792 struct glyph_row
*row
;
29794 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
29795 if (row
->overlapping_p
)
29797 eassert (row
->enabled_p
&& !row
->mode_line_p
);
29800 if (row
->used
[LEFT_MARGIN_AREA
])
29801 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
29803 if (row
->used
[TEXT_AREA
])
29804 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
29806 if (row
->used
[RIGHT_MARGIN_AREA
])
29807 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
29813 /* Return non-zero if W's cursor intersects rectangle R. */
29816 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
29818 XRectangle cr
, result
;
29819 struct glyph
*cursor_glyph
;
29820 struct glyph_row
*row
;
29822 if (w
->phys_cursor
.vpos
>= 0
29823 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
29824 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
29826 && row
->cursor_in_fringe_p
)
29828 /* Cursor is in the fringe. */
29829 cr
.x
= window_box_right_offset (w
,
29830 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
29831 ? RIGHT_MARGIN_AREA
29834 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
29835 cr
.height
= row
->height
;
29836 return x_intersect_rectangles (&cr
, r
, &result
);
29839 cursor_glyph
= get_phys_cursor_glyph (w
);
29842 /* r is relative to W's box, but w->phys_cursor.x is relative
29843 to left edge of W's TEXT area. Adjust it. */
29844 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
29845 cr
.y
= w
->phys_cursor
.y
;
29846 cr
.width
= cursor_glyph
->pixel_width
;
29847 cr
.height
= w
->phys_cursor_height
;
29848 /* ++KFS: W32 version used W32-specific IntersectRect here, but
29849 I assume the effect is the same -- and this is portable. */
29850 return x_intersect_rectangles (&cr
, r
, &result
);
29852 /* If we don't understand the format, pretend we're not in the hot-spot. */
29858 Draw a vertical window border to the right of window W if W doesn't
29859 have vertical scroll bars. */
29862 x_draw_vertical_border (struct window
*w
)
29864 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29866 /* We could do better, if we knew what type of scroll-bar the adjacent
29867 windows (on either side) have... But we don't :-(
29868 However, I think this works ok. ++KFS 2003-04-25 */
29870 /* Redraw borders between horizontally adjacent windows. Don't
29871 do it for frames with vertical scroll bars because either the
29872 right scroll bar of a window, or the left scroll bar of its
29873 neighbor will suffice as a border. */
29874 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
29877 /* Note: It is necessary to redraw both the left and the right
29878 borders, for when only this single window W is being
29880 if (!WINDOW_RIGHTMOST_P (w
)
29881 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
29883 int x0
, x1
, y0
, y1
;
29885 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29888 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29891 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
29894 if (!WINDOW_LEFTMOST_P (w
)
29895 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
29897 int x0
, x1
, y0
, y1
;
29899 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29902 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29905 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
29910 /* Draw window dividers for window W. */
29913 x_draw_right_divider (struct window
*w
)
29915 struct frame
*f
= WINDOW_XFRAME (w
);
29917 if (w
->mini
|| w
->pseudo_window_p
)
29919 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
29921 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
29922 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29923 int y0
= WINDOW_TOP_EDGE_Y (w
);
29924 /* The bottom divider prevails. */
29925 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29927 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29932 x_draw_bottom_divider (struct window
*w
)
29934 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29936 if (w
->mini
|| w
->pseudo_window_p
)
29938 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
29940 int x0
= WINDOW_LEFT_EDGE_X (w
);
29941 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29942 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29943 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
29945 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29949 /* Redraw the part of window W intersection rectangle FR. Pixel
29950 coordinates in FR are frame-relative. Call this function with
29951 input blocked. Value is non-zero if the exposure overwrites
29955 expose_window (struct window
*w
, XRectangle
*fr
)
29957 struct frame
*f
= XFRAME (w
->frame
);
29959 int mouse_face_overwritten_p
= 0;
29961 /* If window is not yet fully initialized, do nothing. This can
29962 happen when toolkit scroll bars are used and a window is split.
29963 Reconfiguring the scroll bar will generate an expose for a newly
29965 if (w
->current_matrix
== NULL
)
29968 /* When we're currently updating the window, display and current
29969 matrix usually don't agree. Arrange for a thorough display
29971 if (w
->must_be_updated_p
)
29973 SET_FRAME_GARBAGED (f
);
29977 /* Frame-relative pixel rectangle of W. */
29978 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
29979 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
29980 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
29981 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
29983 if (x_intersect_rectangles (fr
, &wr
, &r
))
29985 int yb
= window_text_bottom_y (w
);
29986 struct glyph_row
*row
;
29987 int cursor_cleared_p
, phys_cursor_on_p
;
29988 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
29990 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
29991 r
.x
, r
.y
, r
.width
, r
.height
));
29993 /* Convert to window coordinates. */
29994 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
29995 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
29997 /* Turn off the cursor. */
29998 if (!w
->pseudo_window_p
29999 && phys_cursor_in_rect_p (w
, &r
))
30001 x_clear_cursor (w
);
30002 cursor_cleared_p
= 1;
30005 cursor_cleared_p
= 0;
30007 /* If the row containing the cursor extends face to end of line,
30008 then expose_area might overwrite the cursor outside the
30009 rectangle and thus notice_overwritten_cursor might clear
30010 w->phys_cursor_on_p. We remember the original value and
30011 check later if it is changed. */
30012 phys_cursor_on_p
= w
->phys_cursor_on_p
;
30014 /* Update lines intersecting rectangle R. */
30015 first_overlapping_row
= last_overlapping_row
= NULL
;
30016 for (row
= w
->current_matrix
->rows
;
30021 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30023 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
30024 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
30025 || (r
.y
>= y0
&& r
.y
< y1
)
30026 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
30028 /* A header line may be overlapping, but there is no need
30029 to fix overlapping areas for them. KFS 2005-02-12 */
30030 if (row
->overlapping_p
&& !row
->mode_line_p
)
30032 if (first_overlapping_row
== NULL
)
30033 first_overlapping_row
= row
;
30034 last_overlapping_row
= row
;
30038 if (expose_line (w
, row
, &r
))
30039 mouse_face_overwritten_p
= 1;
30042 else if (row
->overlapping_p
)
30044 /* We must redraw a row overlapping the exposed area. */
30046 ? y0
+ row
->phys_height
> r
.y
30047 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30049 if (first_overlapping_row
== NULL
)
30050 first_overlapping_row
= row
;
30051 last_overlapping_row
= row
;
30059 /* Display the mode line if there is one. */
30060 if (WINDOW_WANTS_MODELINE_P (w
)
30061 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30063 && row
->y
< r
.y
+ r
.height
)
30065 if (expose_line (w
, row
, &r
))
30066 mouse_face_overwritten_p
= 1;
30069 if (!w
->pseudo_window_p
)
30071 /* Fix the display of overlapping rows. */
30072 if (first_overlapping_row
)
30073 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30076 /* Draw border between windows. */
30077 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30078 x_draw_right_divider (w
);
30080 x_draw_vertical_border (w
);
30082 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30083 x_draw_bottom_divider (w
);
30085 /* Turn the cursor on again. */
30086 if (cursor_cleared_p
30087 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30088 update_window_cursor (w
, 1);
30092 return mouse_face_overwritten_p
;
30097 /* Redraw (parts) of all windows in the window tree rooted at W that
30098 intersect R. R contains frame pixel coordinates. Value is
30099 non-zero if the exposure overwrites mouse-face. */
30102 expose_window_tree (struct window
*w
, XRectangle
*r
)
30104 struct frame
*f
= XFRAME (w
->frame
);
30105 int mouse_face_overwritten_p
= 0;
30107 while (w
&& !FRAME_GARBAGED_P (f
))
30109 if (WINDOWP (w
->contents
))
30110 mouse_face_overwritten_p
30111 |= expose_window_tree (XWINDOW (w
->contents
), r
);
30113 mouse_face_overwritten_p
|= expose_window (w
, r
);
30115 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30118 return mouse_face_overwritten_p
;
30123 Redisplay an exposed area of frame F. X and Y are the upper-left
30124 corner of the exposed rectangle. W and H are width and height of
30125 the exposed area. All are pixel values. W or H zero means redraw
30126 the entire frame. */
30129 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30132 int mouse_face_overwritten_p
= 0;
30134 TRACE ((stderr
, "expose_frame "));
30136 /* No need to redraw if frame will be redrawn soon. */
30137 if (FRAME_GARBAGED_P (f
))
30139 TRACE ((stderr
, " garbaged\n"));
30143 /* If basic faces haven't been realized yet, there is no point in
30144 trying to redraw anything. This can happen when we get an expose
30145 event while Emacs is starting, e.g. by moving another window. */
30146 if (FRAME_FACE_CACHE (f
) == NULL
30147 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30149 TRACE ((stderr
, " no faces\n"));
30153 if (w
== 0 || h
== 0)
30156 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
30157 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
30167 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30168 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30170 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30171 if (WINDOWP (f
->tool_bar_window
))
30172 mouse_face_overwritten_p
30173 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30176 #ifdef HAVE_X_WINDOWS
30178 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30179 if (WINDOWP (f
->menu_bar_window
))
30180 mouse_face_overwritten_p
30181 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30182 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30186 /* Some window managers support a focus-follows-mouse style with
30187 delayed raising of frames. Imagine a partially obscured frame,
30188 and moving the mouse into partially obscured mouse-face on that
30189 frame. The visible part of the mouse-face will be highlighted,
30190 then the WM raises the obscured frame. With at least one WM, KDE
30191 2.1, Emacs is not getting any event for the raising of the frame
30192 (even tried with SubstructureRedirectMask), only Expose events.
30193 These expose events will draw text normally, i.e. not
30194 highlighted. Which means we must redo the highlight here.
30195 Subsume it under ``we love X''. --gerd 2001-08-15 */
30196 /* Included in Windows version because Windows most likely does not
30197 do the right thing if any third party tool offers
30198 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30199 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
30201 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30202 if (f
== hlinfo
->mouse_face_mouse_frame
)
30204 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
30205 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
30206 clear_mouse_face (hlinfo
);
30207 note_mouse_highlight (f
, mouse_x
, mouse_y
);
30214 Determine the intersection of two rectangles R1 and R2. Return
30215 the intersection in *RESULT. Value is non-zero if RESULT is not
30219 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
30221 XRectangle
*left
, *right
;
30222 XRectangle
*upper
, *lower
;
30223 int intersection_p
= 0;
30225 /* Rearrange so that R1 is the left-most rectangle. */
30227 left
= r1
, right
= r2
;
30229 left
= r2
, right
= r1
;
30231 /* X0 of the intersection is right.x0, if this is inside R1,
30232 otherwise there is no intersection. */
30233 if (right
->x
<= left
->x
+ left
->width
)
30235 result
->x
= right
->x
;
30237 /* The right end of the intersection is the minimum of
30238 the right ends of left and right. */
30239 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
30242 /* Same game for Y. */
30244 upper
= r1
, lower
= r2
;
30246 upper
= r2
, lower
= r1
;
30248 /* The upper end of the intersection is lower.y0, if this is inside
30249 of upper. Otherwise, there is no intersection. */
30250 if (lower
->y
<= upper
->y
+ upper
->height
)
30252 result
->y
= lower
->y
;
30254 /* The lower end of the intersection is the minimum of the lower
30255 ends of upper and lower. */
30256 result
->height
= (min (lower
->y
+ lower
->height
,
30257 upper
->y
+ upper
->height
)
30259 intersection_p
= 1;
30263 return intersection_p
;
30266 #endif /* HAVE_WINDOW_SYSTEM */
30269 /***********************************************************************
30271 ***********************************************************************/
30274 syms_of_xdisp (void)
30276 Vwith_echo_area_save_vector
= Qnil
;
30277 staticpro (&Vwith_echo_area_save_vector
);
30279 Vmessage_stack
= Qnil
;
30280 staticpro (&Vmessage_stack
);
30282 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30283 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30285 message_dolog_marker1
= Fmake_marker ();
30286 staticpro (&message_dolog_marker1
);
30287 message_dolog_marker2
= Fmake_marker ();
30288 staticpro (&message_dolog_marker2
);
30289 message_dolog_marker3
= Fmake_marker ();
30290 staticpro (&message_dolog_marker3
);
30293 defsubr (&Sdump_frame_glyph_matrix
);
30294 defsubr (&Sdump_glyph_matrix
);
30295 defsubr (&Sdump_glyph_row
);
30296 defsubr (&Sdump_tool_bar_row
);
30297 defsubr (&Strace_redisplay
);
30298 defsubr (&Strace_to_stderr
);
30300 #ifdef HAVE_WINDOW_SYSTEM
30301 defsubr (&Stool_bar_height
);
30302 defsubr (&Slookup_image_map
);
30304 defsubr (&Sline_pixel_height
);
30305 defsubr (&Sformat_mode_line
);
30306 defsubr (&Sinvisible_p
);
30307 defsubr (&Scurrent_bidi_paragraph_direction
);
30308 defsubr (&Swindow_text_pixel_size
);
30309 defsubr (&Smove_point_visually
);
30311 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30312 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30313 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30314 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30315 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30316 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30317 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30318 DEFSYM (Qeval
, "eval");
30319 DEFSYM (QCdata
, ":data");
30320 DEFSYM (Qdisplay
, "display");
30321 DEFSYM (Qspace_width
, "space-width");
30322 DEFSYM (Qraise
, "raise");
30323 DEFSYM (Qslice
, "slice");
30324 DEFSYM (Qspace
, "space");
30325 DEFSYM (Qmargin
, "margin");
30326 DEFSYM (Qpointer
, "pointer");
30327 DEFSYM (Qleft_margin
, "left-margin");
30328 DEFSYM (Qright_margin
, "right-margin");
30329 DEFSYM (Qcenter
, "center");
30330 DEFSYM (Qline_height
, "line-height");
30331 DEFSYM (QCalign_to
, ":align-to");
30332 DEFSYM (QCrelative_width
, ":relative-width");
30333 DEFSYM (QCrelative_height
, ":relative-height");
30334 DEFSYM (QCeval
, ":eval");
30335 DEFSYM (QCpropertize
, ":propertize");
30336 DEFSYM (QCfile
, ":file");
30337 DEFSYM (Qfontified
, "fontified");
30338 DEFSYM (Qfontification_functions
, "fontification-functions");
30339 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30340 DEFSYM (Qescape_glyph
, "escape-glyph");
30341 DEFSYM (Qnobreak_space
, "nobreak-space");
30342 DEFSYM (Qimage
, "image");
30343 DEFSYM (Qtext
, "text");
30344 DEFSYM (Qboth
, "both");
30345 DEFSYM (Qboth_horiz
, "both-horiz");
30346 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30347 DEFSYM (QCmap
, ":map");
30348 DEFSYM (QCpointer
, ":pointer");
30349 DEFSYM (Qrect
, "rect");
30350 DEFSYM (Qcircle
, "circle");
30351 DEFSYM (Qpoly
, "poly");
30352 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
30353 DEFSYM (Qgrow_only
, "grow-only");
30354 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30355 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30356 DEFSYM (Qposition
, "position");
30357 DEFSYM (Qbuffer_position
, "buffer-position");
30358 DEFSYM (Qobject
, "object");
30359 DEFSYM (Qbar
, "bar");
30360 DEFSYM (Qhbar
, "hbar");
30361 DEFSYM (Qbox
, "box");
30362 DEFSYM (Qhollow
, "hollow");
30363 DEFSYM (Qhand
, "hand");
30364 DEFSYM (Qarrow
, "arrow");
30365 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30367 list_of_error
= list1 (list2 (intern_c_string ("error"),
30368 intern_c_string ("void-variable")));
30369 staticpro (&list_of_error
);
30371 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30372 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30373 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30374 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30376 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30377 staticpro (&echo_buffer
[0]);
30378 staticpro (&echo_buffer
[1]);
30380 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30381 staticpro (&echo_area_buffer
[0]);
30382 staticpro (&echo_area_buffer
[1]);
30384 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30385 staticpro (&Vmessages_buffer_name
);
30387 mode_line_proptrans_alist
= Qnil
;
30388 staticpro (&mode_line_proptrans_alist
);
30389 mode_line_string_list
= Qnil
;
30390 staticpro (&mode_line_string_list
);
30391 mode_line_string_face
= Qnil
;
30392 staticpro (&mode_line_string_face
);
30393 mode_line_string_face_prop
= Qnil
;
30394 staticpro (&mode_line_string_face_prop
);
30395 Vmode_line_unwind_vector
= Qnil
;
30396 staticpro (&Vmode_line_unwind_vector
);
30398 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30400 help_echo_string
= Qnil
;
30401 staticpro (&help_echo_string
);
30402 help_echo_object
= Qnil
;
30403 staticpro (&help_echo_object
);
30404 help_echo_window
= Qnil
;
30405 staticpro (&help_echo_window
);
30406 previous_help_echo_string
= Qnil
;
30407 staticpro (&previous_help_echo_string
);
30408 help_echo_pos
= -1;
30410 DEFSYM (Qright_to_left
, "right-to-left");
30411 DEFSYM (Qleft_to_right
, "left-to-right");
30413 #ifdef HAVE_WINDOW_SYSTEM
30414 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30415 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30416 For example, if a block cursor is over a tab, it will be drawn as
30417 wide as that tab on the display. */);
30418 x_stretch_cursor_p
= 0;
30421 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30422 doc
: /* Non-nil means highlight trailing whitespace.
30423 The face used for trailing whitespace is `trailing-whitespace'. */);
30424 Vshow_trailing_whitespace
= Qnil
;
30426 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30427 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30428 If the value is t, Emacs highlights non-ASCII chars which have the
30429 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30430 or `escape-glyph' face respectively.
30432 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30433 U+2011 (non-breaking hyphen) are affected.
30435 Any other non-nil value means to display these characters as a escape
30436 glyph followed by an ordinary space or hyphen.
30438 A value of nil means no special handling of these characters. */);
30439 Vnobreak_char_display
= Qt
;
30441 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30442 doc
: /* The pointer shape to show in void text areas.
30443 A value of nil means to show the text pointer. Other options are `arrow',
30444 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
30445 Vvoid_text_area_pointer
= Qarrow
;
30447 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30448 doc
: /* Non-nil means don't actually do any redisplay.
30449 This is used for internal purposes. */);
30450 Vinhibit_redisplay
= Qnil
;
30452 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30453 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30454 Vglobal_mode_string
= Qnil
;
30456 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30457 doc
: /* Marker for where to display an arrow on top of the buffer text.
30458 This must be the beginning of a line in order to work.
30459 See also `overlay-arrow-string'. */);
30460 Voverlay_arrow_position
= Qnil
;
30462 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30463 doc
: /* String to display as an arrow in non-window frames.
30464 See also `overlay-arrow-position'. */);
30465 Voverlay_arrow_string
= build_pure_c_string ("=>");
30467 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30468 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30469 The symbols on this list are examined during redisplay to determine
30470 where to display overlay arrows. */);
30471 Voverlay_arrow_variable_list
30472 = list1 (intern_c_string ("overlay-arrow-position"));
30474 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30475 doc
: /* The number of lines to try scrolling a window by when point moves out.
30476 If that fails to bring point back on frame, point is centered instead.
30477 If this is zero, point is always centered after it moves off frame.
30478 If you want scrolling to always be a line at a time, you should set
30479 `scroll-conservatively' to a large value rather than set this to 1. */);
30481 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30482 doc
: /* Scroll up to this many lines, to bring point back on screen.
30483 If point moves off-screen, redisplay will scroll by up to
30484 `scroll-conservatively' lines in order to bring point just barely
30485 onto the screen again. If that cannot be done, then redisplay
30486 recenters point as usual.
30488 If the value is greater than 100, redisplay will never recenter point,
30489 but will always scroll just enough text to bring point into view, even
30490 if you move far away.
30492 A value of zero means always recenter point if it moves off screen. */);
30493 scroll_conservatively
= 0;
30495 DEFVAR_INT ("scroll-margin", scroll_margin
,
30496 doc
: /* Number of lines of margin at the top and bottom of a window.
30497 Recenter the window whenever point gets within this many lines
30498 of the top or bottom of the window. */);
30501 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
30502 doc
: /* Pixels per inch value for non-window system displays.
30503 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30504 Vdisplay_pixels_per_inch
= make_float (72.0);
30507 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
30510 DEFVAR_LISP ("truncate-partial-width-windows",
30511 Vtruncate_partial_width_windows
,
30512 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
30513 For an integer value, truncate lines in each window narrower than the
30514 full frame width, provided the window width is less than that integer;
30515 otherwise, respect the value of `truncate-lines'.
30517 For any other non-nil value, truncate lines in all windows that do
30518 not span the full frame width.
30520 A value of nil means to respect the value of `truncate-lines'.
30522 If `word-wrap' is enabled, you might want to reduce this. */);
30523 Vtruncate_partial_width_windows
= make_number (50);
30525 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
30526 doc
: /* Maximum buffer size for which line number should be displayed.
30527 If the buffer is bigger than this, the line number does not appear
30528 in the mode line. A value of nil means no limit. */);
30529 Vline_number_display_limit
= Qnil
;
30531 DEFVAR_INT ("line-number-display-limit-width",
30532 line_number_display_limit_width
,
30533 doc
: /* Maximum line width (in characters) for line number display.
30534 If the average length of the lines near point is bigger than this, then the
30535 line number may be omitted from the mode line. */);
30536 line_number_display_limit_width
= 200;
30538 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
30539 doc
: /* Non-nil means highlight region even in nonselected windows. */);
30540 highlight_nonselected_windows
= 0;
30542 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
30543 doc
: /* Non-nil if more than one frame is visible on this display.
30544 Minibuffer-only frames don't count, but iconified frames do.
30545 This variable is not guaranteed to be accurate except while processing
30546 `frame-title-format' and `icon-title-format'. */);
30548 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
30549 doc
: /* Template for displaying the title bar of visible frames.
30550 \(Assuming the window manager supports this feature.)
30552 This variable has the same structure as `mode-line-format', except that
30553 the %c and %l constructs are ignored. It is used only on frames for
30554 which no explicit name has been set \(see `modify-frame-parameters'). */);
30556 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
30557 doc
: /* Template for displaying the title bar of an iconified frame.
30558 \(Assuming the window manager supports this feature.)
30559 This variable has the same structure as `mode-line-format' (which see),
30560 and is used only on frames for which no explicit name has been set
30561 \(see `modify-frame-parameters'). */);
30563 = Vframe_title_format
30564 = listn (CONSTYPE_PURE
, 3,
30565 intern_c_string ("multiple-frames"),
30566 build_pure_c_string ("%b"),
30567 listn (CONSTYPE_PURE
, 4,
30568 empty_unibyte_string
,
30569 intern_c_string ("invocation-name"),
30570 build_pure_c_string ("@"),
30571 intern_c_string ("system-name")));
30573 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
30574 doc
: /* Maximum number of lines to keep in the message log buffer.
30575 If nil, disable message logging. If t, log messages but don't truncate
30576 the buffer when it becomes large. */);
30577 Vmessage_log_max
= make_number (1000);
30579 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
30580 doc
: /* Functions called before redisplay, if window sizes have changed.
30581 The value should be a list of functions that take one argument.
30582 Just before redisplay, for each frame, if any of its windows have changed
30583 size since the last redisplay, or have been split or deleted,
30584 all the functions in the list are called, with the frame as argument. */);
30585 Vwindow_size_change_functions
= Qnil
;
30587 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
30588 doc
: /* List of functions to call before redisplaying a window with scrolling.
30589 Each function is called with two arguments, the window and its new
30590 display-start position. Note that these functions are also called by
30591 `set-window-buffer'. Also note that the value of `window-end' is not
30592 valid when these functions are called.
30594 Warning: Do not use this feature to alter the way the window
30595 is scrolled. It is not designed for that, and such use probably won't
30597 Vwindow_scroll_functions
= Qnil
;
30599 DEFVAR_LISP ("window-text-change-functions",
30600 Vwindow_text_change_functions
,
30601 doc
: /* Functions to call in redisplay when text in the window might change. */);
30602 Vwindow_text_change_functions
= Qnil
;
30604 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
30605 doc
: /* Functions called when redisplay of a window reaches the end trigger.
30606 Each function is called with two arguments, the window and the end trigger value.
30607 See `set-window-redisplay-end-trigger'. */);
30608 Vredisplay_end_trigger_functions
= Qnil
;
30610 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
30611 doc
: /* Non-nil means autoselect window with mouse pointer.
30612 If nil, do not autoselect windows.
30613 A positive number means delay autoselection by that many seconds: a
30614 window is autoselected only after the mouse has remained in that
30615 window for the duration of the delay.
30616 A negative number has a similar effect, but causes windows to be
30617 autoselected only after the mouse has stopped moving. \(Because of
30618 the way Emacs compares mouse events, you will occasionally wait twice
30619 that time before the window gets selected.\)
30620 Any other value means to autoselect window instantaneously when the
30621 mouse pointer enters it.
30623 Autoselection selects the minibuffer only if it is active, and never
30624 unselects the minibuffer if it is active.
30626 When customizing this variable make sure that the actual value of
30627 `focus-follows-mouse' matches the behavior of your window manager. */);
30628 Vmouse_autoselect_window
= Qnil
;
30630 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
30631 doc
: /* Non-nil means automatically resize tool-bars.
30632 This dynamically changes the tool-bar's height to the minimum height
30633 that is needed to make all tool-bar items visible.
30634 If value is `grow-only', the tool-bar's height is only increased
30635 automatically; to decrease the tool-bar height, use \\[recenter]. */);
30636 Vauto_resize_tool_bars
= Qt
;
30638 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
30639 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
30640 auto_raise_tool_bar_buttons_p
= 1;
30642 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
30643 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
30644 make_cursor_line_fully_visible_p
= 1;
30646 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
30647 doc
: /* Border below tool-bar in pixels.
30648 If an integer, use it as the height of the border.
30649 If it is one of `internal-border-width' or `border-width', use the
30650 value of the corresponding frame parameter.
30651 Otherwise, no border is added below the tool-bar. */);
30652 Vtool_bar_border
= Qinternal_border_width
;
30654 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
30655 doc
: /* Margin around tool-bar buttons in pixels.
30656 If an integer, use that for both horizontal and vertical margins.
30657 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
30658 HORZ specifying the horizontal margin, and VERT specifying the
30659 vertical margin. */);
30660 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
30662 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
30663 doc
: /* Relief thickness of tool-bar buttons. */);
30664 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
30666 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
30667 doc
: /* Tool bar style to use.
30669 image - show images only
30670 text - show text only
30671 both - show both, text below image
30672 both-horiz - show text to the right of the image
30673 text-image-horiz - show text to the left of the image
30674 any other - use system default or image if no system default.
30676 This variable only affects the GTK+ toolkit version of Emacs. */);
30677 Vtool_bar_style
= Qnil
;
30679 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
30680 doc
: /* Maximum number of characters a label can have to be shown.
30681 The tool bar style must also show labels for this to have any effect, see
30682 `tool-bar-style'. */);
30683 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
30685 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
30686 doc
: /* List of functions to call to fontify regions of text.
30687 Each function is called with one argument POS. Functions must
30688 fontify a region starting at POS in the current buffer, and give
30689 fontified regions the property `fontified'. */);
30690 Vfontification_functions
= Qnil
;
30691 Fmake_variable_buffer_local (Qfontification_functions
);
30693 DEFVAR_BOOL ("unibyte-display-via-language-environment",
30694 unibyte_display_via_language_environment
,
30695 doc
: /* Non-nil means display unibyte text according to language environment.
30696 Specifically, this means that raw bytes in the range 160-255 decimal
30697 are displayed by converting them to the equivalent multibyte characters
30698 according to the current language environment. As a result, they are
30699 displayed according to the current fontset.
30701 Note that this variable affects only how these bytes are displayed,
30702 but does not change the fact they are interpreted as raw bytes. */);
30703 unibyte_display_via_language_environment
= 0;
30705 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
30706 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
30707 If a float, it specifies a fraction of the mini-window frame's height.
30708 If an integer, it specifies a number of lines. */);
30709 Vmax_mini_window_height
= make_float (0.25);
30711 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
30712 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
30713 A value of nil means don't automatically resize mini-windows.
30714 A value of t means resize them to fit the text displayed in them.
30715 A value of `grow-only', the default, means let mini-windows grow only;
30716 they return to their normal size when the minibuffer is closed, or the
30717 echo area becomes empty. */);
30718 Vresize_mini_windows
= Qgrow_only
;
30720 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
30721 doc
: /* Alist specifying how to blink the cursor off.
30722 Each element has the form (ON-STATE . OFF-STATE). Whenever the
30723 `cursor-type' frame-parameter or variable equals ON-STATE,
30724 comparing using `equal', Emacs uses OFF-STATE to specify
30725 how to blink it off. ON-STATE and OFF-STATE are values for
30726 the `cursor-type' frame parameter.
30728 If a frame's ON-STATE has no entry in this list,
30729 the frame's other specifications determine how to blink the cursor off. */);
30730 Vblink_cursor_alist
= Qnil
;
30732 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
30733 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
30734 If non-nil, windows are automatically scrolled horizontally to make
30735 point visible. */);
30736 automatic_hscrolling_p
= 1;
30737 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
30739 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
30740 doc
: /* How many columns away from the window edge point is allowed to get
30741 before automatic hscrolling will horizontally scroll the window. */);
30742 hscroll_margin
= 5;
30744 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
30745 doc
: /* How many columns to scroll the window when point gets too close to the edge.
30746 When point is less than `hscroll-margin' columns from the window
30747 edge, automatic hscrolling will scroll the window by the amount of columns
30748 determined by this variable. If its value is a positive integer, scroll that
30749 many columns. If it's a positive floating-point number, it specifies the
30750 fraction of the window's width to scroll. If it's nil or zero, point will be
30751 centered horizontally after the scroll. Any other value, including negative
30752 numbers, are treated as if the value were zero.
30754 Automatic hscrolling always moves point outside the scroll margin, so if
30755 point was more than scroll step columns inside the margin, the window will
30756 scroll more than the value given by the scroll step.
30758 Note that the lower bound for automatic hscrolling specified by `scroll-left'
30759 and `scroll-right' overrides this variable's effect. */);
30760 Vhscroll_step
= make_number (0);
30762 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
30763 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
30764 Bind this around calls to `message' to let it take effect. */);
30765 message_truncate_lines
= 0;
30767 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
30768 doc
: /* Normal hook run to update the menu bar definitions.
30769 Redisplay runs this hook before it redisplays the menu bar.
30770 This is used to update menus such as Buffers, whose contents depend on
30772 Vmenu_bar_update_hook
= Qnil
;
30774 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
30775 doc
: /* Frame for which we are updating a menu.
30776 The enable predicate for a menu binding should check this variable. */);
30777 Vmenu_updating_frame
= Qnil
;
30779 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
30780 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
30781 inhibit_menubar_update
= 0;
30783 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
30784 doc
: /* Prefix prepended to all continuation lines at display time.
30785 The value may be a string, an image, or a stretch-glyph; it is
30786 interpreted in the same way as the value of a `display' text property.
30788 This variable is overridden by any `wrap-prefix' text or overlay
30791 To add a prefix to non-continuation lines, use `line-prefix'. */);
30792 Vwrap_prefix
= Qnil
;
30793 DEFSYM (Qwrap_prefix
, "wrap-prefix");
30794 Fmake_variable_buffer_local (Qwrap_prefix
);
30796 DEFVAR_LISP ("line-prefix", Vline_prefix
,
30797 doc
: /* Prefix prepended to all non-continuation lines at display time.
30798 The value may be a string, an image, or a stretch-glyph; it is
30799 interpreted in the same way as the value of a `display' text property.
30801 This variable is overridden by any `line-prefix' text or overlay
30804 To add a prefix to continuation lines, use `wrap-prefix'. */);
30805 Vline_prefix
= Qnil
;
30806 DEFSYM (Qline_prefix
, "line-prefix");
30807 Fmake_variable_buffer_local (Qline_prefix
);
30809 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
30810 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
30811 inhibit_eval_during_redisplay
= 0;
30813 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
30814 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
30815 inhibit_free_realized_faces
= 0;
30818 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
30819 doc
: /* Inhibit try_window_id display optimization. */);
30820 inhibit_try_window_id
= 0;
30822 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
30823 doc
: /* Inhibit try_window_reusing display optimization. */);
30824 inhibit_try_window_reusing
= 0;
30826 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
30827 doc
: /* Inhibit try_cursor_movement display optimization. */);
30828 inhibit_try_cursor_movement
= 0;
30829 #endif /* GLYPH_DEBUG */
30831 DEFVAR_INT ("overline-margin", overline_margin
,
30832 doc
: /* Space between overline and text, in pixels.
30833 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
30834 margin to the character height. */);
30835 overline_margin
= 2;
30837 DEFVAR_INT ("underline-minimum-offset",
30838 underline_minimum_offset
,
30839 doc
: /* Minimum distance between baseline and underline.
30840 This can improve legibility of underlined text at small font sizes,
30841 particularly when using variable `x-use-underline-position-properties'
30842 with fonts that specify an UNDERLINE_POSITION relatively close to the
30843 baseline. The default value is 1. */);
30844 underline_minimum_offset
= 1;
30846 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
30847 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
30848 This feature only works when on a window system that can change
30849 cursor shapes. */);
30850 display_hourglass_p
= 1;
30852 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
30853 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
30854 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
30856 #ifdef HAVE_WINDOW_SYSTEM
30857 hourglass_atimer
= NULL
;
30858 hourglass_shown_p
= 0;
30859 #endif /* HAVE_WINDOW_SYSTEM */
30861 DEFSYM (Qglyphless_char
, "glyphless-char");
30862 DEFSYM (Qhex_code
, "hex-code");
30863 DEFSYM (Qempty_box
, "empty-box");
30864 DEFSYM (Qthin_space
, "thin-space");
30865 DEFSYM (Qzero_width
, "zero-width");
30867 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
30868 doc
: /* Function run just before redisplay.
30869 It is called with one argument, which is the set of windows that are to
30870 be redisplayed. This set can be nil (meaning, only the selected window),
30871 or t (meaning all windows). */);
30872 Vpre_redisplay_function
= intern ("ignore");
30874 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
30875 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
30877 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
30878 doc
: /* Char-table defining glyphless characters.
30879 Each element, if non-nil, should be one of the following:
30880 an ASCII acronym string: display this string in a box
30881 `hex-code': display the hexadecimal code of a character in a box
30882 `empty-box': display as an empty box
30883 `thin-space': display as 1-pixel width space
30884 `zero-width': don't display
30885 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
30886 display method for graphical terminals and text terminals respectively.
30887 GRAPHICAL and TEXT should each have one of the values listed above.
30889 The char-table has one extra slot to control the display of a character for
30890 which no font is found. This slot only takes effect on graphical terminals.
30891 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
30892 `thin-space'. The default is `empty-box'.
30894 If a character has a non-nil entry in an active display table, the
30895 display table takes effect; in this case, Emacs does not consult
30896 `glyphless-char-display' at all. */);
30897 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
30898 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
30901 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
30902 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
30903 Vdebug_on_message
= Qnil
;
30905 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
30907 Vredisplay__all_windows_cause
30908 = Fmake_vector (make_number (100), make_number (0));
30910 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
30912 Vredisplay__mode_lines_cause
30913 = Fmake_vector (make_number (100), make_number (0));
30917 /* Initialize this module when Emacs starts. */
30922 CHARPOS (this_line_start_pos
) = 0;
30924 if (!noninteractive
)
30926 struct window
*m
= XWINDOW (minibuf_window
);
30927 Lisp_Object frame
= m
->frame
;
30928 struct frame
*f
= XFRAME (frame
);
30929 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
30930 struct window
*r
= XWINDOW (root
);
30933 echo_area_window
= minibuf_window
;
30935 r
->top_line
= FRAME_TOP_MARGIN (f
);
30936 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
30937 r
->total_cols
= FRAME_COLS (f
);
30938 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30939 r
->total_lines
= FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
30940 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
30942 m
->top_line
= FRAME_LINES (f
) - 1;
30943 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
30944 m
->total_cols
= FRAME_COLS (f
);
30945 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30946 m
->total_lines
= 1;
30947 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
30949 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
30950 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
30951 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
30953 /* The default ellipsis glyphs `...'. */
30954 for (i
= 0; i
< 3; ++i
)
30955 default_invis_vector
[i
] = make_number ('.');
30959 /* Allocate the buffer for frame titles.
30960 Also used for `format-mode-line'. */
30962 mode_line_noprop_buf
= xmalloc (size
);
30963 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
30964 mode_line_noprop_ptr
= mode_line_noprop_buf
;
30965 mode_line_target
= MODE_LINE_DISPLAY
;
30968 help_echo_showing_p
= 0;
30971 #ifdef HAVE_WINDOW_SYSTEM
30973 /* Platform-independent portion of hourglass implementation. */
30975 /* Cancel a currently active hourglass timer, and start a new one. */
30977 start_hourglass (void)
30979 struct timespec delay
;
30981 cancel_hourglass ();
30983 if (INTEGERP (Vhourglass_delay
)
30984 && XINT (Vhourglass_delay
) > 0)
30985 delay
= make_timespec (min (XINT (Vhourglass_delay
),
30986 TYPE_MAXIMUM (time_t)),
30988 else if (FLOATP (Vhourglass_delay
)
30989 && XFLOAT_DATA (Vhourglass_delay
) > 0)
30990 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
30992 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
30996 extern void w32_note_current_window (void);
30997 w32_note_current_window ();
30999 #endif /* HAVE_NTGUI */
31001 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31002 show_hourglass
, NULL
);
31006 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31009 cancel_hourglass (void)
31011 if (hourglass_atimer
)
31013 cancel_atimer (hourglass_atimer
);
31014 hourglass_atimer
= NULL
;
31017 if (hourglass_shown_p
)
31021 #endif /* HAVE_WINDOW_SYSTEM */