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
;
3439 /* Use face of preceding text for ellipsis (if invisible) */
3440 if (it
->selective_display_ellipsis_p
)
3441 it
->saved_face_id
= it
->face_id
;
3443 /* Here's the description of the semantics of, and the logic behind,
3444 the various HANDLED_* statuses:
3446 HANDLED_NORMALLY means the handler did its job, and the loop
3447 should proceed to calling the next handler in order.
3449 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3450 change in the properties and overlays at current position, so the
3451 loop should be restarted, to re-invoke the handlers that were
3452 already called. This happens when fontification-functions were
3453 called by handle_fontified_prop, and actually fontified
3454 something. Another case where HANDLED_RECOMPUTE_PROPS is
3455 returned is when we discover overlay strings that need to be
3456 displayed right away. The loop below will continue for as long
3457 as the status is HANDLED_RECOMPUTE_PROPS.
3459 HANDLED_RETURN means return immediately to the caller, to
3460 continue iteration without calling any further handlers. This is
3461 used when we need to act on some property right away, for example
3462 when we need to display the ellipsis or a replacing display
3463 property, such as display string or image.
3465 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3466 consumed, and the handler switched to the next overlay string.
3467 This signals the loop below to refrain from looking for more
3468 overlays before all the overlay strings of the current overlay
3471 Some of the handlers called by the loop push the iterator state
3472 onto the stack (see 'push_it'), and arrange for the iteration to
3473 continue with another object, such as an image, a display string,
3474 or an overlay string. In most such cases, it->stop_charpos is
3475 set to the first character of the string, so that when the
3476 iteration resumes, this function will immediately be called
3477 again, to examine the properties at the beginning of the string.
3479 When a display or overlay string is exhausted, the iterator state
3480 is popped (see 'pop_it'), and iteration continues with the
3481 previous object. Again, in many such cases this function is
3482 called again to find the next position where properties might
3487 handled
= HANDLED_NORMALLY
;
3489 /* Call text property handlers. */
3490 for (p
= it_props
; p
->handler
; ++p
)
3492 handled
= p
->handler (it
);
3494 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3496 else if (handled
== HANDLED_RETURN
)
3498 /* We still want to show before and after strings from
3499 overlays even if the actual buffer text is replaced. */
3500 if (!handle_overlay_change_p
3502 /* Don't call get_overlay_strings_1 if we already
3503 have overlay strings loaded, because doing so
3504 will load them again and push the iterator state
3505 onto the stack one more time, which is not
3506 expected by the rest of the code that processes
3508 || (it
->current
.overlay_string_index
< 0
3509 ? !get_overlay_strings_1 (it
, 0, 0)
3513 setup_for_ellipsis (it
, 0);
3514 /* When handling a display spec, we might load an
3515 empty string. In that case, discard it here. We
3516 used to discard it in handle_single_display_spec,
3517 but that causes get_overlay_strings_1, above, to
3518 ignore overlay strings that we must check. */
3519 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3523 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3527 it
->string_from_display_prop_p
= 0;
3528 it
->from_disp_prop_p
= 0;
3529 handle_overlay_change_p
= 0;
3531 handled
= HANDLED_RECOMPUTE_PROPS
;
3534 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3535 handle_overlay_change_p
= 0;
3538 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3540 /* Don't check for overlay strings below when set to deliver
3541 characters from a display vector. */
3542 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3543 handle_overlay_change_p
= 0;
3545 /* Handle overlay changes.
3546 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3547 if it finds overlays. */
3548 if (handle_overlay_change_p
)
3549 handled
= handle_overlay_change (it
);
3554 setup_for_ellipsis (it
, 0);
3558 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3560 /* Determine where to stop next. */
3561 if (handled
== HANDLED_NORMALLY
)
3562 compute_stop_pos (it
);
3566 /* Compute IT->stop_charpos from text property and overlay change
3567 information for IT's current position. */
3570 compute_stop_pos (struct it
*it
)
3572 register INTERVAL iv
, next_iv
;
3573 Lisp_Object object
, limit
, position
;
3574 ptrdiff_t charpos
, bytepos
;
3576 if (STRINGP (it
->string
))
3578 /* Strings are usually short, so don't limit the search for
3580 it
->stop_charpos
= it
->end_charpos
;
3581 object
= it
->string
;
3583 charpos
= IT_STRING_CHARPOS (*it
);
3584 bytepos
= IT_STRING_BYTEPOS (*it
);
3590 /* If end_charpos is out of range for some reason, such as a
3591 misbehaving display function, rationalize it (Bug#5984). */
3592 if (it
->end_charpos
> ZV
)
3593 it
->end_charpos
= ZV
;
3594 it
->stop_charpos
= it
->end_charpos
;
3596 /* If next overlay change is in front of the current stop pos
3597 (which is IT->end_charpos), stop there. Note: value of
3598 next_overlay_change is point-max if no overlay change
3600 charpos
= IT_CHARPOS (*it
);
3601 bytepos
= IT_BYTEPOS (*it
);
3602 pos
= next_overlay_change (charpos
);
3603 if (pos
< it
->stop_charpos
)
3604 it
->stop_charpos
= pos
;
3606 /* Set up variables for computing the stop position from text
3607 property changes. */
3608 XSETBUFFER (object
, current_buffer
);
3609 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3612 /* Get the interval containing IT's position. Value is a null
3613 interval if there isn't such an interval. */
3614 position
= make_number (charpos
);
3615 iv
= validate_interval_range (object
, &position
, &position
, 0);
3618 Lisp_Object values_here
[LAST_PROP_IDX
];
3621 /* Get properties here. */
3622 for (p
= it_props
; p
->handler
; ++p
)
3623 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3625 /* Look for an interval following iv that has different
3627 for (next_iv
= next_interval (iv
);
3630 || XFASTINT (limit
) > next_iv
->position
));
3631 next_iv
= next_interval (next_iv
))
3633 for (p
= it_props
; p
->handler
; ++p
)
3635 Lisp_Object new_value
;
3637 new_value
= textget (next_iv
->plist
, *p
->name
);
3638 if (!EQ (values_here
[p
->idx
], new_value
))
3648 if (INTEGERP (limit
)
3649 && next_iv
->position
>= XFASTINT (limit
))
3650 /* No text property change up to limit. */
3651 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3653 /* Text properties change in next_iv. */
3654 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3658 if (it
->cmp_it
.id
< 0)
3660 ptrdiff_t stoppos
= it
->end_charpos
;
3662 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3664 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3665 stoppos
, it
->string
);
3668 eassert (STRINGP (it
->string
)
3669 || (it
->stop_charpos
>= BEGV
3670 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3674 /* Return the position of the next overlay change after POS in
3675 current_buffer. Value is point-max if no overlay change
3676 follows. This is like `next-overlay-change' but doesn't use
3680 next_overlay_change (ptrdiff_t pos
)
3682 ptrdiff_t i
, noverlays
;
3684 Lisp_Object
*overlays
;
3686 /* Get all overlays at the given position. */
3687 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3689 /* If any of these overlays ends before endpos,
3690 use its ending point instead. */
3691 for (i
= 0; i
< noverlays
; ++i
)
3696 oend
= OVERLAY_END (overlays
[i
]);
3697 oendpos
= OVERLAY_POSITION (oend
);
3698 endpos
= min (endpos
, oendpos
);
3704 /* How many characters forward to search for a display property or
3705 display string. Searching too far forward makes the bidi display
3706 sluggish, especially in small windows. */
3707 #define MAX_DISP_SCAN 250
3709 /* Return the character position of a display string at or after
3710 position specified by POSITION. If no display string exists at or
3711 after POSITION, return ZV. A display string is either an overlay
3712 with `display' property whose value is a string, or a `display'
3713 text property whose value is a string. STRING is data about the
3714 string to iterate; if STRING->lstring is nil, we are iterating a
3715 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3716 on a GUI frame. DISP_PROP is set to zero if we searched
3717 MAX_DISP_SCAN characters forward without finding any display
3718 strings, non-zero otherwise. It is set to 2 if the display string
3719 uses any kind of `(space ...)' spec that will produce a stretch of
3720 white space in the text area. */
3722 compute_display_string_pos (struct text_pos
*position
,
3723 struct bidi_string_data
*string
,
3725 int frame_window_p
, int *disp_prop
)
3727 /* OBJECT = nil means current buffer. */
3728 Lisp_Object object
, object1
;
3729 Lisp_Object pos
, spec
, limpos
;
3730 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3731 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3732 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3733 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3735 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3736 struct text_pos tpos
;
3739 if (string
&& STRINGP (string
->lstring
))
3740 object1
= object
= string
->lstring
;
3741 else if (w
&& !string_p
)
3743 XSETWINDOW (object
, w
);
3747 object1
= object
= Qnil
;
3752 /* We don't support display properties whose values are strings
3753 that have display string properties. */
3754 || string
->from_disp_str
3755 /* C strings cannot have display properties. */
3756 || (string
->s
&& !STRINGP (object
)))
3762 /* If the character at CHARPOS is where the display string begins,
3764 pos
= make_number (charpos
);
3765 if (STRINGP (object
))
3766 bufpos
= string
->bufpos
;
3770 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3772 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3775 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3783 /* Look forward for the first character with a `display' property
3784 that will replace the underlying text when displayed. */
3785 limpos
= make_number (lim
);
3787 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3788 CHARPOS (tpos
) = XFASTINT (pos
);
3789 if (CHARPOS (tpos
) >= lim
)
3794 if (STRINGP (object
))
3795 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3797 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3798 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3799 if (!STRINGP (object
))
3800 bufpos
= CHARPOS (tpos
);
3801 } while (NILP (spec
)
3802 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3803 bufpos
, frame_window_p
)));
3807 return CHARPOS (tpos
);
3810 /* Return the character position of the end of the display string that
3811 started at CHARPOS. If there's no display string at CHARPOS,
3812 return -1. A display string is either an overlay with `display'
3813 property whose value is a string or a `display' text property whose
3814 value is a string. */
3816 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3818 /* OBJECT = nil means current buffer. */
3819 Lisp_Object object
=
3820 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3821 Lisp_Object pos
= make_number (charpos
);
3823 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3825 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3828 /* It could happen that the display property or overlay was removed
3829 since we found it in compute_display_string_pos above. One way
3830 this can happen is if JIT font-lock was called (through
3831 handle_fontified_prop), and jit-lock-functions remove text
3832 properties or overlays from the portion of buffer that includes
3833 CHARPOS. Muse mode is known to do that, for example. In this
3834 case, we return -1 to the caller, to signal that no display
3835 string is actually present at CHARPOS. See bidi_fetch_char for
3836 how this is handled.
3838 An alternative would be to never look for display properties past
3839 it->stop_charpos. But neither compute_display_string_pos nor
3840 bidi_fetch_char that calls it know or care where the next
3842 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3845 /* Look forward for the first character where the `display' property
3847 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3849 return XFASTINT (pos
);
3854 /***********************************************************************
3856 ***********************************************************************/
3858 /* Handle changes in the `fontified' property of the current buffer by
3859 calling hook functions from Qfontification_functions to fontify
3862 static enum prop_handled
3863 handle_fontified_prop (struct it
*it
)
3865 Lisp_Object prop
, pos
;
3866 enum prop_handled handled
= HANDLED_NORMALLY
;
3868 if (!NILP (Vmemory_full
))
3871 /* Get the value of the `fontified' property at IT's current buffer
3872 position. (The `fontified' property doesn't have a special
3873 meaning in strings.) If the value is nil, call functions from
3874 Qfontification_functions. */
3875 if (!STRINGP (it
->string
)
3877 && !NILP (Vfontification_functions
)
3878 && !NILP (Vrun_hooks
)
3879 && (pos
= make_number (IT_CHARPOS (*it
)),
3880 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3881 /* Ignore the special cased nil value always present at EOB since
3882 no amount of fontifying will be able to change it. */
3883 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3885 ptrdiff_t count
= SPECPDL_INDEX ();
3887 struct buffer
*obuf
= current_buffer
;
3888 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3889 bool old_clip_changed
= current_buffer
->clip_changed
;
3891 val
= Vfontification_functions
;
3892 specbind (Qfontification_functions
, Qnil
);
3894 eassert (it
->end_charpos
== ZV
);
3896 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3897 safe_call1 (val
, pos
);
3900 Lisp_Object fns
, fn
;
3901 struct gcpro gcpro1
, gcpro2
;
3906 for (; CONSP (val
); val
= XCDR (val
))
3912 /* A value of t indicates this hook has a local
3913 binding; it means to run the global binding too.
3914 In a global value, t should not occur. If it
3915 does, we must ignore it to avoid an endless
3917 for (fns
= Fdefault_value (Qfontification_functions
);
3923 safe_call1 (fn
, pos
);
3927 safe_call1 (fn
, pos
);
3933 unbind_to (count
, Qnil
);
3935 /* Fontification functions routinely call `save-restriction'.
3936 Normally, this tags clip_changed, which can confuse redisplay
3937 (see discussion in Bug#6671). Since we don't perform any
3938 special handling of fontification changes in the case where
3939 `save-restriction' isn't called, there's no point doing so in
3940 this case either. So, if the buffer's restrictions are
3941 actually left unchanged, reset clip_changed. */
3942 if (obuf
== current_buffer
)
3944 if (begv
== BEGV
&& zv
== ZV
)
3945 current_buffer
->clip_changed
= old_clip_changed
;
3947 /* There isn't much we can reasonably do to protect against
3948 misbehaving fontification, but here's a fig leaf. */
3949 else if (BUFFER_LIVE_P (obuf
))
3950 set_buffer_internal_1 (obuf
);
3952 /* The fontification code may have added/removed text.
3953 It could do even a lot worse, but let's at least protect against
3954 the most obvious case where only the text past `pos' gets changed',
3955 as is/was done in grep.el where some escapes sequences are turned
3956 into face properties (bug#7876). */
3957 it
->end_charpos
= ZV
;
3959 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3960 something. This avoids an endless loop if they failed to
3961 fontify the text for which reason ever. */
3962 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3963 handled
= HANDLED_RECOMPUTE_PROPS
;
3971 /***********************************************************************
3973 ***********************************************************************/
3975 /* Set up iterator IT from face properties at its current position.
3976 Called from handle_stop. */
3978 static enum prop_handled
3979 handle_face_prop (struct it
*it
)
3982 ptrdiff_t next_stop
;
3984 if (!STRINGP (it
->string
))
3987 = face_at_buffer_position (it
->w
,
3991 + TEXT_PROP_DISTANCE_LIMIT
),
3992 0, it
->base_face_id
);
3994 /* Is this a start of a run of characters with box face?
3995 Caveat: this can be called for a freshly initialized
3996 iterator; face_id is -1 in this case. We know that the new
3997 face will not change until limit, i.e. if the new face has a
3998 box, all characters up to limit will have one. But, as
3999 usual, we don't know whether limit is really the end. */
4000 if (new_face_id
!= it
->face_id
)
4002 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
4003 /* If it->face_id is -1, old_face below will be NULL, see
4004 the definition of FACE_FROM_ID. This will happen if this
4005 is the initial call that gets the face. */
4006 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4008 /* If the value of face_id of the iterator is -1, we have to
4009 look in front of IT's position and see whether there is a
4010 face there that's different from new_face_id. */
4011 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
4013 int prev_face_id
= face_before_it_pos (it
);
4015 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
4018 /* If the new face has a box, but the old face does not,
4019 this is the start of a run of characters with box face,
4020 i.e. this character has a shadow on the left side. */
4021 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
4022 && (old_face
== NULL
|| !old_face
->box
));
4023 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4031 Lisp_Object from_overlay
4032 = (it
->current
.overlay_string_index
>= 0
4033 ? it
->string_overlays
[it
->current
.overlay_string_index
4034 % OVERLAY_STRING_CHUNK_SIZE
]
4037 /* See if we got to this string directly or indirectly from
4038 an overlay property. That includes the before-string or
4039 after-string of an overlay, strings in display properties
4040 provided by an overlay, their text properties, etc.
4042 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
4043 if (! NILP (from_overlay
))
4044 for (i
= it
->sp
- 1; i
>= 0; i
--)
4046 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
4048 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
4049 % OVERLAY_STRING_CHUNK_SIZE
];
4050 else if (! NILP (it
->stack
[i
].from_overlay
))
4051 from_overlay
= it
->stack
[i
].from_overlay
;
4053 if (!NILP (from_overlay
))
4057 if (! NILP (from_overlay
))
4059 bufpos
= IT_CHARPOS (*it
);
4060 /* For a string from an overlay, the base face depends
4061 only on text properties and ignores overlays. */
4063 = face_for_overlay_string (it
->w
,
4067 + TEXT_PROP_DISTANCE_LIMIT
),
4075 /* For strings from a `display' property, use the face at
4076 IT's current buffer position as the base face to merge
4077 with, so that overlay strings appear in the same face as
4078 surrounding text, unless they specify their own faces.
4079 For strings from wrap-prefix and line-prefix properties,
4080 use the default face, possibly remapped via
4081 Vface_remapping_alist. */
4082 /* Note that the fact that we use the face at _buffer_
4083 position means that a 'display' property on an overlay
4084 string will not inherit the face of that overlay string,
4085 but will instead revert to the face of buffer text
4086 covered by the overlay. This is visible, e.g., when the
4087 overlay specifies a box face, but neither the buffer nor
4088 the display string do. This sounds like a design bug,
4089 but Emacs always did that since v21.1, so changing that
4090 might be a big deal. */
4091 base_face_id
= it
->string_from_prefix_prop_p
4092 ? (!NILP (Vface_remapping_alist
)
4093 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
4095 : underlying_face_id (it
);
4098 new_face_id
= face_at_string_position (it
->w
,
4100 IT_STRING_CHARPOS (*it
),
4105 /* Is this a start of a run of characters with box? Caveat:
4106 this can be called for a freshly allocated iterator; face_id
4107 is -1 is this case. We know that the new face will not
4108 change until the next check pos, i.e. if the new face has a
4109 box, all characters up to that position will have a
4110 box. But, as usual, we don't know whether that position
4111 is really the end. */
4112 if (new_face_id
!= it
->face_id
)
4114 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
4115 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4117 /* If new face has a box but old face hasn't, this is the
4118 start of a run of characters with box, i.e. it has a
4119 shadow on the left side. */
4120 it
->start_of_box_run_p
4121 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
4122 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4126 it
->face_id
= new_face_id
;
4127 return HANDLED_NORMALLY
;
4131 /* Return the ID of the face ``underlying'' IT's current position,
4132 which is in a string. If the iterator is associated with a
4133 buffer, return the face at IT's current buffer position.
4134 Otherwise, use the iterator's base_face_id. */
4137 underlying_face_id (struct it
*it
)
4139 int face_id
= it
->base_face_id
, i
;
4141 eassert (STRINGP (it
->string
));
4143 for (i
= it
->sp
- 1; i
>= 0; --i
)
4144 if (NILP (it
->stack
[i
].string
))
4145 face_id
= it
->stack
[i
].face_id
;
4151 /* Compute the face one character before or after the current position
4152 of IT, in the visual order. BEFORE_P non-zero means get the face
4153 in front (to the left in L2R paragraphs, to the right in R2L
4154 paragraphs) of IT's screen position. Value is the ID of the face. */
4157 face_before_or_after_it_pos (struct it
*it
, int before_p
)
4160 ptrdiff_t next_check_charpos
;
4162 void *it_copy_data
= NULL
;
4164 eassert (it
->s
== NULL
);
4166 if (STRINGP (it
->string
))
4168 ptrdiff_t bufpos
, charpos
;
4171 /* No face change past the end of the string (for the case
4172 we are padding with spaces). No face change before the
4174 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4175 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4180 /* Set charpos to the position before or after IT's current
4181 position, in the logical order, which in the non-bidi
4182 case is the same as the visual order. */
4184 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4185 else if (it
->what
== IT_COMPOSITION
)
4186 /* For composition, we must check the character after the
4188 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4190 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4196 /* With bidi iteration, the character before the current
4197 in the visual order cannot be found by simple
4198 iteration, because "reverse" reordering is not
4199 supported. Instead, we need to use the move_it_*
4200 family of functions. */
4201 /* Ignore face changes before the first visible
4202 character on this display line. */
4203 if (it
->current_x
<= it
->first_visible_x
)
4205 SAVE_IT (it_copy
, *it
, it_copy_data
);
4206 /* Implementation note: Since move_it_in_display_line
4207 works in the iterator geometry, and thinks the first
4208 character is always the leftmost, even in R2L lines,
4209 we don't need to distinguish between the R2L and L2R
4211 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
4212 it_copy
.current_x
- 1, MOVE_TO_X
);
4213 charpos
= IT_STRING_CHARPOS (it_copy
);
4214 RESTORE_IT (it
, it
, it_copy_data
);
4218 /* Set charpos to the string position of the character
4219 that comes after IT's current position in the visual
4221 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4225 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4227 charpos
= it_copy
.bidi_it
.charpos
;
4230 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4232 if (it
->current
.overlay_string_index
>= 0)
4233 bufpos
= IT_CHARPOS (*it
);
4237 base_face_id
= underlying_face_id (it
);
4239 /* Get the face for ASCII, or unibyte. */
4240 face_id
= face_at_string_position (it
->w
,
4244 &next_check_charpos
,
4247 /* Correct the face for charsets different from ASCII. Do it
4248 for the multibyte case only. The face returned above is
4249 suitable for unibyte text if IT->string is unibyte. */
4250 if (STRING_MULTIBYTE (it
->string
))
4252 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4253 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4255 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4257 c
= string_char_and_length (p
, &len
);
4258 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4263 struct text_pos pos
;
4265 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4266 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4269 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4270 pos
= it
->current
.pos
;
4275 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4278 if (it
->what
== IT_COMPOSITION
)
4280 /* For composition, we must check the position after
4282 pos
.charpos
+= it
->cmp_it
.nchars
;
4283 pos
.bytepos
+= it
->len
;
4286 INC_TEXT_POS (pos
, it
->multibyte_p
);
4293 /* With bidi iteration, the character before the current
4294 in the visual order cannot be found by simple
4295 iteration, because "reverse" reordering is not
4296 supported. Instead, we need to use the move_it_*
4297 family of functions. */
4298 /* Ignore face changes before the first visible
4299 character on this display line. */
4300 if (it
->current_x
<= it
->first_visible_x
)
4302 SAVE_IT (it_copy
, *it
, it_copy_data
);
4303 /* Implementation note: Since move_it_in_display_line
4304 works in the iterator geometry, and thinks the first
4305 character is always the leftmost, even in R2L lines,
4306 we don't need to distinguish between the R2L and L2R
4308 move_it_in_display_line (&it_copy
, ZV
,
4309 it_copy
.current_x
- 1, MOVE_TO_X
);
4310 pos
= it_copy
.current
.pos
;
4311 RESTORE_IT (it
, it
, it_copy_data
);
4315 /* Set charpos to the buffer position of the character
4316 that comes after IT's current position in the visual
4318 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4322 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4325 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4328 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4330 /* Determine face for CHARSET_ASCII, or unibyte. */
4331 face_id
= face_at_buffer_position (it
->w
,
4333 &next_check_charpos
,
4336 /* Correct the face for charsets different from ASCII. Do it
4337 for the multibyte case only. The face returned above is
4338 suitable for unibyte text if current_buffer is unibyte. */
4339 if (it
->multibyte_p
)
4341 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4342 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4343 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4352 /***********************************************************************
4354 ***********************************************************************/
4356 /* Set up iterator IT from invisible properties at its current
4357 position. Called from handle_stop. */
4359 static enum prop_handled
4360 handle_invisible_prop (struct it
*it
)
4362 enum prop_handled handled
= HANDLED_NORMALLY
;
4366 if (STRINGP (it
->string
))
4368 Lisp_Object end_charpos
, limit
, charpos
;
4370 /* Get the value of the invisible text property at the
4371 current position. Value will be nil if there is no such
4373 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4374 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4375 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4377 if (invis_p
&& IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4379 /* Record whether we have to display an ellipsis for the
4381 int display_ellipsis_p
= (invis_p
== 2);
4382 ptrdiff_t len
, endpos
;
4384 handled
= HANDLED_RECOMPUTE_PROPS
;
4386 /* Get the position at which the next visible text can be
4387 found in IT->string, if any. */
4388 endpos
= len
= SCHARS (it
->string
);
4389 XSETINT (limit
, len
);
4392 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4394 if (INTEGERP (end_charpos
))
4396 endpos
= XFASTINT (end_charpos
);
4397 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4398 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4400 display_ellipsis_p
= true;
4403 while (invis_p
&& endpos
< len
);
4405 if (display_ellipsis_p
)
4406 it
->ellipsis_p
= true;
4410 /* Text at END_CHARPOS is visible. Move IT there. */
4411 struct text_pos old
;
4414 old
= it
->current
.string_pos
;
4415 oldpos
= CHARPOS (old
);
4418 if (it
->bidi_it
.first_elt
4419 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4420 bidi_paragraph_init (it
->paragraph_embedding
,
4422 /* Bidi-iterate out of the invisible text. */
4425 bidi_move_to_visually_next (&it
->bidi_it
);
4427 while (oldpos
<= it
->bidi_it
.charpos
4428 && it
->bidi_it
.charpos
< endpos
);
4430 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4431 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4432 if (IT_CHARPOS (*it
) >= endpos
)
4433 it
->prev_stop
= endpos
;
4437 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4438 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4443 /* The rest of the string is invisible. If this is an
4444 overlay string, proceed with the next overlay string
4445 or whatever comes and return a character from there. */
4446 if (it
->current
.overlay_string_index
>= 0
4447 && !display_ellipsis_p
)
4449 next_overlay_string (it
);
4450 /* Don't check for overlay strings when we just
4451 finished processing them. */
4452 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4456 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4457 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4464 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4465 Lisp_Object pos
, overlay
;
4467 /* First of all, is there invisible text at this position? */
4468 tem
= start_charpos
= IT_CHARPOS (*it
);
4469 pos
= make_number (tem
);
4470 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4472 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4474 /* If we are on invisible text, skip over it. */
4475 if (invis_p
&& start_charpos
< it
->end_charpos
)
4477 /* Record whether we have to display an ellipsis for the
4479 int display_ellipsis_p
= invis_p
== 2;
4481 handled
= HANDLED_RECOMPUTE_PROPS
;
4483 /* Loop skipping over invisible text. The loop is left at
4484 ZV or with IT on the first char being visible again. */
4487 /* Try to skip some invisible text. Return value is the
4488 position reached which can be equal to where we start
4489 if there is nothing invisible there. This skips both
4490 over invisible text properties and overlays with
4491 invisible property. */
4492 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4494 /* If we skipped nothing at all we weren't at invisible
4495 text in the first place. If everything to the end of
4496 the buffer was skipped, end the loop. */
4497 if (newpos
== tem
|| newpos
>= ZV
)
4501 /* We skipped some characters but not necessarily
4502 all there are. Check if we ended up on visible
4503 text. Fget_char_property returns the property of
4504 the char before the given position, i.e. if we
4505 get invis_p = 0, this means that the char at
4506 newpos is visible. */
4507 pos
= make_number (newpos
);
4508 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4509 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4512 /* If we ended up on invisible text, proceed to
4513 skip starting with next_stop. */
4517 /* If there are adjacent invisible texts, don't lose the
4518 second one's ellipsis. */
4520 display_ellipsis_p
= true;
4524 /* The position newpos is now either ZV or on visible text. */
4527 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4529 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4531 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4533 /* If the invisible text ends on a newline or on a
4534 character after a newline, we can avoid the costly,
4535 character by character, bidi iteration to NEWPOS, and
4536 instead simply reseat the iterator there. That's
4537 because all bidi reordering information is tossed at
4538 the newline. This is a big win for modes that hide
4539 complete lines, like Outline, Org, etc. */
4540 if (on_newline
|| after_newline
)
4542 struct text_pos tpos
;
4543 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4545 SET_TEXT_POS (tpos
, newpos
, bpos
);
4546 reseat_1 (it
, tpos
, 0);
4547 /* If we reseat on a newline/ZV, we need to prep the
4548 bidi iterator for advancing to the next character
4549 after the newline/EOB, keeping the current paragraph
4550 direction (so that PRODUCE_GLYPHS does TRT wrt
4551 prepending/appending glyphs to a glyph row). */
4554 it
->bidi_it
.first_elt
= 0;
4555 it
->bidi_it
.paragraph_dir
= pdir
;
4556 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4557 it
->bidi_it
.nchars
= 1;
4558 it
->bidi_it
.ch_len
= 1;
4561 else /* Must use the slow method. */
4563 /* With bidi iteration, the region of invisible text
4564 could start and/or end in the middle of a
4565 non-base embedding level. Therefore, we need to
4566 skip invisible text using the bidi iterator,
4567 starting at IT's current position, until we find
4568 ourselves outside of the invisible text.
4569 Skipping invisible text _after_ bidi iteration
4570 avoids affecting the visual order of the
4571 displayed text when invisible properties are
4572 added or removed. */
4573 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4575 /* If we were `reseat'ed to a new paragraph,
4576 determine the paragraph base direction. We
4577 need to do it now because
4578 next_element_from_buffer may not have a
4579 chance to do it, if we are going to skip any
4580 text at the beginning, which resets the
4582 bidi_paragraph_init (it
->paragraph_embedding
,
4587 bidi_move_to_visually_next (&it
->bidi_it
);
4589 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4590 && it
->bidi_it
.charpos
< newpos
);
4591 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4592 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4593 /* If we overstepped NEWPOS, record its position in
4594 the iterator, so that we skip invisible text if
4595 later the bidi iteration lands us in the
4596 invisible region again. */
4597 if (IT_CHARPOS (*it
) >= newpos
)
4598 it
->prev_stop
= newpos
;
4603 IT_CHARPOS (*it
) = newpos
;
4604 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4607 /* If there are before-strings at the start of invisible
4608 text, and the text is invisible because of a text
4609 property, arrange to show before-strings because 20.x did
4610 it that way. (If the text is invisible because of an
4611 overlay property instead of a text property, this is
4612 already handled in the overlay code.) */
4614 && get_overlay_strings (it
, it
->stop_charpos
))
4616 handled
= HANDLED_RECOMPUTE_PROPS
;
4619 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4620 /* The call to get_overlay_strings above recomputes
4621 it->stop_charpos, but it only considers changes
4622 in properties and overlays beyond iterator's
4623 current position. This causes us to miss changes
4624 that happen exactly where the invisible property
4625 ended. So we play it safe here and force the
4626 iterator to check for potential stop positions
4627 immediately after the invisible text. Note that
4628 if get_overlay_strings returns non-zero, it
4629 normally also pushed the iterator stack, so we
4630 need to update the stop position in the slot
4631 below the current one. */
4632 it
->stack
[it
->sp
- 1].stop_charpos
4633 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4636 else if (display_ellipsis_p
)
4638 /* Make sure that the glyphs of the ellipsis will get
4639 correct `charpos' values. If we would not update
4640 it->position here, the glyphs would belong to the
4641 last visible character _before_ the invisible
4642 text, which confuses `set_cursor_from_row'.
4644 We use the last invisible position instead of the
4645 first because this way the cursor is always drawn on
4646 the first "." of the ellipsis, whenever PT is inside
4647 the invisible text. Otherwise the cursor would be
4648 placed _after_ the ellipsis when the point is after the
4649 first invisible character. */
4650 if (!STRINGP (it
->object
))
4652 it
->position
.charpos
= newpos
- 1;
4653 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4655 it
->ellipsis_p
= true;
4656 /* Let the ellipsis display before
4657 considering any properties of the following char.
4658 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4659 handled
= HANDLED_RETURN
;
4668 /* Make iterator IT return `...' next.
4669 Replaces LEN characters from buffer. */
4672 setup_for_ellipsis (struct it
*it
, int len
)
4674 /* Use the display table definition for `...'. Invalid glyphs
4675 will be handled by the method returning elements from dpvec. */
4676 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4678 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4679 it
->dpvec
= v
->contents
;
4680 it
->dpend
= v
->contents
+ v
->header
.size
;
4684 /* Default `...'. */
4685 it
->dpvec
= default_invis_vector
;
4686 it
->dpend
= default_invis_vector
+ 3;
4689 it
->dpvec_char_len
= len
;
4690 it
->current
.dpvec_index
= 0;
4691 it
->dpvec_face_id
= -1;
4693 /* Remember the current face id in case glyphs specify faces.
4694 IT's face is restored in set_iterator_to_next.
4695 saved_face_id was set to preceding char's face in handle_stop. */
4696 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4697 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4699 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4700 it
->ellipsis_p
= true;
4705 /***********************************************************************
4707 ***********************************************************************/
4709 /* Set up iterator IT from `display' property at its current position.
4710 Called from handle_stop.
4711 We return HANDLED_RETURN if some part of the display property
4712 overrides the display of the buffer text itself.
4713 Otherwise we return HANDLED_NORMALLY. */
4715 static enum prop_handled
4716 handle_display_prop (struct it
*it
)
4718 Lisp_Object propval
, object
, overlay
;
4719 struct text_pos
*position
;
4721 /* Nonzero if some property replaces the display of the text itself. */
4722 int display_replaced_p
= 0;
4724 if (STRINGP (it
->string
))
4726 object
= it
->string
;
4727 position
= &it
->current
.string_pos
;
4728 bufpos
= CHARPOS (it
->current
.pos
);
4732 XSETWINDOW (object
, it
->w
);
4733 position
= &it
->current
.pos
;
4734 bufpos
= CHARPOS (*position
);
4737 /* Reset those iterator values set from display property values. */
4738 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4739 it
->space_width
= Qnil
;
4740 it
->font_height
= Qnil
;
4743 /* We don't support recursive `display' properties, i.e. string
4744 values that have a string `display' property, that have a string
4745 `display' property etc. */
4746 if (!it
->string_from_display_prop_p
)
4747 it
->area
= TEXT_AREA
;
4749 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4750 Qdisplay
, object
, &overlay
);
4752 return HANDLED_NORMALLY
;
4753 /* Now OVERLAY is the overlay that gave us this property, or nil
4754 if it was a text property. */
4756 if (!STRINGP (it
->string
))
4757 object
= it
->w
->contents
;
4759 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4761 FRAME_WINDOW_P (it
->f
));
4763 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4766 /* Subroutine of handle_display_prop. Returns non-zero if the display
4767 specification in SPEC is a replacing specification, i.e. it would
4768 replace the text covered by `display' property with something else,
4769 such as an image or a display string. If SPEC includes any kind or
4770 `(space ...) specification, the value is 2; this is used by
4771 compute_display_string_pos, which see.
4773 See handle_single_display_spec for documentation of arguments.
4774 frame_window_p is non-zero if the window being redisplayed is on a
4775 GUI frame; this argument is used only if IT is NULL, see below.
4777 IT can be NULL, if this is called by the bidi reordering code
4778 through compute_display_string_pos, which see. In that case, this
4779 function only examines SPEC, but does not otherwise "handle" it, in
4780 the sense that it doesn't set up members of IT from the display
4783 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4784 Lisp_Object overlay
, struct text_pos
*position
,
4785 ptrdiff_t bufpos
, int frame_window_p
)
4787 int replacing_p
= 0;
4791 /* Simple specifications. */
4792 && !EQ (XCAR (spec
), Qimage
)
4793 && !EQ (XCAR (spec
), Qspace
)
4794 && !EQ (XCAR (spec
), Qwhen
)
4795 && !EQ (XCAR (spec
), Qslice
)
4796 && !EQ (XCAR (spec
), Qspace_width
)
4797 && !EQ (XCAR (spec
), Qheight
)
4798 && !EQ (XCAR (spec
), Qraise
)
4799 /* Marginal area specifications. */
4800 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4801 && !EQ (XCAR (spec
), Qleft_fringe
)
4802 && !EQ (XCAR (spec
), Qright_fringe
)
4803 && !NILP (XCAR (spec
)))
4805 for (; CONSP (spec
); spec
= XCDR (spec
))
4807 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4808 overlay
, position
, bufpos
,
4809 replacing_p
, frame_window_p
)))
4812 /* If some text in a string is replaced, `position' no
4813 longer points to the position of `object'. */
4814 if (!it
|| STRINGP (object
))
4819 else if (VECTORP (spec
))
4822 for (i
= 0; i
< ASIZE (spec
); ++i
)
4823 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4824 overlay
, position
, bufpos
,
4825 replacing_p
, frame_window_p
)))
4828 /* If some text in a string is replaced, `position' no
4829 longer points to the position of `object'. */
4830 if (!it
|| STRINGP (object
))
4836 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4837 position
, bufpos
, 0,
4845 /* Value is the position of the end of the `display' property starting
4846 at START_POS in OBJECT. */
4848 static struct text_pos
4849 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4852 struct text_pos end_pos
;
4854 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4855 Qdisplay
, object
, Qnil
);
4856 CHARPOS (end_pos
) = XFASTINT (end
);
4857 if (STRINGP (object
))
4858 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4860 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4866 /* Set up IT from a single `display' property specification SPEC. OBJECT
4867 is the object in which the `display' property was found. *POSITION
4868 is the position in OBJECT at which the `display' property was found.
4869 BUFPOS is the buffer position of OBJECT (different from POSITION if
4870 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4871 previously saw a display specification which already replaced text
4872 display with something else, for example an image; we ignore such
4873 properties after the first one has been processed.
4875 OVERLAY is the overlay this `display' property came from,
4876 or nil if it was a text property.
4878 If SPEC is a `space' or `image' specification, and in some other
4879 cases too, set *POSITION to the position where the `display'
4882 If IT is NULL, only examine the property specification in SPEC, but
4883 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4884 is intended to be displayed in a window on a GUI frame.
4886 Value is non-zero if something was found which replaces the display
4887 of buffer or string text. */
4890 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4891 Lisp_Object overlay
, struct text_pos
*position
,
4892 ptrdiff_t bufpos
, int display_replaced_p
,
4896 Lisp_Object location
, value
;
4897 struct text_pos start_pos
= *position
;
4900 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4901 If the result is non-nil, use VALUE instead of SPEC. */
4903 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4912 if (!NILP (form
) && !EQ (form
, Qt
))
4914 ptrdiff_t count
= SPECPDL_INDEX ();
4915 struct gcpro gcpro1
;
4917 /* Bind `object' to the object having the `display' property, a
4918 buffer or string. Bind `position' to the position in the
4919 object where the property was found, and `buffer-position'
4920 to the current position in the buffer. */
4923 XSETBUFFER (object
, current_buffer
);
4924 specbind (Qobject
, object
);
4925 specbind (Qposition
, make_number (CHARPOS (*position
)));
4926 specbind (Qbuffer_position
, make_number (bufpos
));
4928 form
= safe_eval (form
);
4930 unbind_to (count
, Qnil
);
4936 /* Handle `(height HEIGHT)' specifications. */
4938 && EQ (XCAR (spec
), Qheight
)
4939 && CONSP (XCDR (spec
)))
4943 if (!FRAME_WINDOW_P (it
->f
))
4946 it
->font_height
= XCAR (XCDR (spec
));
4947 if (!NILP (it
->font_height
))
4949 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4950 int new_height
= -1;
4952 if (CONSP (it
->font_height
)
4953 && (EQ (XCAR (it
->font_height
), Qplus
)
4954 || EQ (XCAR (it
->font_height
), Qminus
))
4955 && CONSP (XCDR (it
->font_height
))
4956 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4958 /* `(+ N)' or `(- N)' where N is an integer. */
4959 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4960 if (EQ (XCAR (it
->font_height
), Qplus
))
4962 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4964 else if (FUNCTIONP (it
->font_height
))
4966 /* Call function with current height as argument.
4967 Value is the new height. */
4969 height
= safe_call1 (it
->font_height
,
4970 face
->lface
[LFACE_HEIGHT_INDEX
]);
4971 if (NUMBERP (height
))
4972 new_height
= XFLOATINT (height
);
4974 else if (NUMBERP (it
->font_height
))
4976 /* Value is a multiple of the canonical char height. */
4979 f
= FACE_FROM_ID (it
->f
,
4980 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4981 new_height
= (XFLOATINT (it
->font_height
)
4982 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4986 /* Evaluate IT->font_height with `height' bound to the
4987 current specified height to get the new height. */
4988 ptrdiff_t count
= SPECPDL_INDEX ();
4990 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4991 value
= safe_eval (it
->font_height
);
4992 unbind_to (count
, Qnil
);
4994 if (NUMBERP (value
))
4995 new_height
= XFLOATINT (value
);
4999 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
5006 /* Handle `(space-width WIDTH)'. */
5008 && EQ (XCAR (spec
), Qspace_width
)
5009 && CONSP (XCDR (spec
)))
5013 if (!FRAME_WINDOW_P (it
->f
))
5016 value
= XCAR (XCDR (spec
));
5017 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
5018 it
->space_width
= value
;
5024 /* Handle `(slice X Y WIDTH HEIGHT)'. */
5026 && EQ (XCAR (spec
), Qslice
))
5032 if (!FRAME_WINDOW_P (it
->f
))
5035 if (tem
= XCDR (spec
), CONSP (tem
))
5037 it
->slice
.x
= XCAR (tem
);
5038 if (tem
= XCDR (tem
), CONSP (tem
))
5040 it
->slice
.y
= XCAR (tem
);
5041 if (tem
= XCDR (tem
), CONSP (tem
))
5043 it
->slice
.width
= XCAR (tem
);
5044 if (tem
= XCDR (tem
), CONSP (tem
))
5045 it
->slice
.height
= XCAR (tem
);
5054 /* Handle `(raise FACTOR)'. */
5056 && EQ (XCAR (spec
), Qraise
)
5057 && CONSP (XCDR (spec
)))
5061 if (!FRAME_WINDOW_P (it
->f
))
5064 #ifdef HAVE_WINDOW_SYSTEM
5065 value
= XCAR (XCDR (spec
));
5066 if (NUMBERP (value
))
5068 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5069 it
->voffset
= - (XFLOATINT (value
)
5070 * (FONT_HEIGHT (face
->font
)));
5072 #endif /* HAVE_WINDOW_SYSTEM */
5078 /* Don't handle the other kinds of display specifications
5079 inside a string that we got from a `display' property. */
5080 if (it
&& it
->string_from_display_prop_p
)
5083 /* Characters having this form of property are not displayed, so
5084 we have to find the end of the property. */
5087 start_pos
= *position
;
5088 *position
= display_prop_end (it
, object
, start_pos
);
5092 /* Stop the scan at that end position--we assume that all
5093 text properties change there. */
5095 it
->stop_charpos
= position
->charpos
;
5097 /* Handle `(left-fringe BITMAP [FACE])'
5098 and `(right-fringe BITMAP [FACE])'. */
5100 && (EQ (XCAR (spec
), Qleft_fringe
)
5101 || EQ (XCAR (spec
), Qright_fringe
))
5102 && CONSP (XCDR (spec
)))
5108 if (!FRAME_WINDOW_P (it
->f
))
5109 /* If we return here, POSITION has been advanced
5110 across the text with this property. */
5112 /* Synchronize the bidi iterator with POSITION. This is
5113 needed because we are not going to push the iterator
5114 on behalf of this display property, so there will be
5115 no pop_it call to do this synchronization for us. */
5118 it
->position
= *position
;
5119 iterate_out_of_display_property (it
);
5120 *position
= it
->position
;
5125 else if (!frame_window_p
)
5128 #ifdef HAVE_WINDOW_SYSTEM
5129 value
= XCAR (XCDR (spec
));
5130 if (!SYMBOLP (value
)
5131 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
5132 /* If we return here, POSITION has been advanced
5133 across the text with this property. */
5135 if (it
&& it
->bidi_p
)
5137 it
->position
= *position
;
5138 iterate_out_of_display_property (it
);
5139 *position
= it
->position
;
5146 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
5148 if (CONSP (XCDR (XCDR (spec
))))
5150 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5151 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5157 /* Save current settings of IT so that we can restore them
5158 when we are finished with the glyph property value. */
5159 push_it (it
, position
);
5161 it
->area
= TEXT_AREA
;
5162 it
->what
= IT_IMAGE
;
5163 it
->image_id
= -1; /* no image */
5164 it
->position
= start_pos
;
5165 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5166 it
->method
= GET_FROM_IMAGE
;
5167 it
->from_overlay
= Qnil
;
5168 it
->face_id
= face_id
;
5169 it
->from_disp_prop_p
= true;
5171 /* Say that we haven't consumed the characters with
5172 `display' property yet. The call to pop_it in
5173 set_iterator_to_next will clean this up. */
5174 *position
= start_pos
;
5176 if (EQ (XCAR (spec
), Qleft_fringe
))
5178 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5179 it
->left_user_fringe_face_id
= face_id
;
5183 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5184 it
->right_user_fringe_face_id
= face_id
;
5187 #endif /* HAVE_WINDOW_SYSTEM */
5191 /* Prepare to handle `((margin left-margin) ...)',
5192 `((margin right-margin) ...)' and `((margin nil) ...)'
5193 prefixes for display specifications. */
5194 location
= Qunbound
;
5195 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5199 value
= XCDR (spec
);
5201 value
= XCAR (value
);
5204 if (EQ (XCAR (tem
), Qmargin
)
5205 && (tem
= XCDR (tem
),
5206 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5208 || EQ (tem
, Qleft_margin
)
5209 || EQ (tem
, Qright_margin
))))
5213 if (EQ (location
, Qunbound
))
5219 /* After this point, VALUE is the property after any
5220 margin prefix has been stripped. It must be a string,
5221 an image specification, or `(space ...)'.
5223 LOCATION specifies where to display: `left-margin',
5224 `right-margin' or nil. */
5226 valid_p
= (STRINGP (value
)
5227 #ifdef HAVE_WINDOW_SYSTEM
5228 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5229 && valid_image_p (value
))
5230 #endif /* not HAVE_WINDOW_SYSTEM */
5231 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
5233 if (valid_p
&& !display_replaced_p
)
5239 /* Callers need to know whether the display spec is any kind
5240 of `(space ...)' spec that is about to affect text-area
5242 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5247 /* Save current settings of IT so that we can restore them
5248 when we are finished with the glyph property value. */
5249 push_it (it
, position
);
5250 it
->from_overlay
= overlay
;
5251 it
->from_disp_prop_p
= true;
5253 if (NILP (location
))
5254 it
->area
= TEXT_AREA
;
5255 else if (EQ (location
, Qleft_margin
))
5256 it
->area
= LEFT_MARGIN_AREA
;
5258 it
->area
= RIGHT_MARGIN_AREA
;
5260 if (STRINGP (value
))
5263 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5264 it
->current
.overlay_string_index
= -1;
5265 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5266 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5267 it
->method
= GET_FROM_STRING
;
5268 it
->stop_charpos
= 0;
5270 it
->base_level_stop
= 0;
5271 it
->string_from_display_prop_p
= true;
5272 /* Say that we haven't consumed the characters with
5273 `display' property yet. The call to pop_it in
5274 set_iterator_to_next will clean this up. */
5275 if (BUFFERP (object
))
5276 *position
= start_pos
;
5278 /* Force paragraph direction to be that of the parent
5279 object. If the parent object's paragraph direction is
5280 not yet determined, default to L2R. */
5281 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5282 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5284 it
->paragraph_embedding
= L2R
;
5286 /* Set up the bidi iterator for this display string. */
5289 it
->bidi_it
.string
.lstring
= it
->string
;
5290 it
->bidi_it
.string
.s
= NULL
;
5291 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5292 it
->bidi_it
.string
.bufpos
= bufpos
;
5293 it
->bidi_it
.string
.from_disp_str
= 1;
5294 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5295 it
->bidi_it
.w
= it
->w
;
5296 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5299 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5301 it
->method
= GET_FROM_STRETCH
;
5303 *position
= it
->position
= start_pos
;
5304 retval
= 1 + (it
->area
== TEXT_AREA
);
5306 #ifdef HAVE_WINDOW_SYSTEM
5309 it
->what
= IT_IMAGE
;
5310 it
->image_id
= lookup_image (it
->f
, value
);
5311 it
->position
= start_pos
;
5312 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5313 it
->method
= GET_FROM_IMAGE
;
5315 /* Say that we haven't consumed the characters with
5316 `display' property yet. The call to pop_it in
5317 set_iterator_to_next will clean this up. */
5318 *position
= start_pos
;
5320 #endif /* HAVE_WINDOW_SYSTEM */
5325 /* Invalid property or property not supported. Restore
5326 POSITION to what it was before. */
5327 *position
= start_pos
;
5331 /* Check if PROP is a display property value whose text should be
5332 treated as intangible. OVERLAY is the overlay from which PROP
5333 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5334 specify the buffer position covered by PROP. */
5337 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5338 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5340 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5341 struct text_pos position
;
5343 SET_TEXT_POS (position
, charpos
, bytepos
);
5344 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5345 &position
, charpos
, frame_window_p
);
5349 /* Return 1 if PROP is a display sub-property value containing STRING.
5351 Implementation note: this and the following function are really
5352 special cases of handle_display_spec and
5353 handle_single_display_spec, and should ideally use the same code.
5354 Until they do, these two pairs must be consistent and must be
5355 modified in sync. */
5358 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5360 if (EQ (string
, prop
))
5363 /* Skip over `when FORM'. */
5364 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5369 /* Actually, the condition following `when' should be eval'ed,
5370 like handle_single_display_spec does, and we should return
5371 zero if it evaluates to nil. However, this function is
5372 called only when the buffer was already displayed and some
5373 glyph in the glyph matrix was found to come from a display
5374 string. Therefore, the condition was already evaluated, and
5375 the result was non-nil, otherwise the display string wouldn't
5376 have been displayed and we would have never been called for
5377 this property. Thus, we can skip the evaluation and assume
5378 its result is non-nil. */
5383 /* Skip over `margin LOCATION'. */
5384 if (EQ (XCAR (prop
), Qmargin
))
5395 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5399 /* Return 1 if STRING appears in the `display' property PROP. */
5402 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5405 && !EQ (XCAR (prop
), Qwhen
)
5406 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5408 /* A list of sub-properties. */
5409 while (CONSP (prop
))
5411 if (single_display_spec_string_p (XCAR (prop
), string
))
5416 else if (VECTORP (prop
))
5418 /* A vector of sub-properties. */
5420 for (i
= 0; i
< ASIZE (prop
); ++i
)
5421 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5425 return single_display_spec_string_p (prop
, string
);
5430 /* Look for STRING in overlays and text properties in the current
5431 buffer, between character positions FROM and TO (excluding TO).
5432 BACK_P non-zero means look back (in this case, TO is supposed to be
5434 Value is the first character position where STRING was found, or
5435 zero if it wasn't found before hitting TO.
5437 This function may only use code that doesn't eval because it is
5438 called asynchronously from note_mouse_highlight. */
5441 string_buffer_position_lim (Lisp_Object string
,
5442 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5444 Lisp_Object limit
, prop
, pos
;
5447 pos
= make_number (max (from
, BEGV
));
5449 if (!back_p
) /* looking forward */
5451 limit
= make_number (min (to
, ZV
));
5452 while (!found
&& !EQ (pos
, limit
))
5454 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5455 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5458 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5462 else /* looking back */
5464 limit
= make_number (max (to
, BEGV
));
5465 while (!found
&& !EQ (pos
, limit
))
5467 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5468 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5471 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5476 return found
? XINT (pos
) : 0;
5479 /* Determine which buffer position in current buffer STRING comes from.
5480 AROUND_CHARPOS is an approximate position where it could come from.
5481 Value is the buffer position or 0 if it couldn't be determined.
5483 This function is necessary because we don't record buffer positions
5484 in glyphs generated from strings (to keep struct glyph small).
5485 This function may only use code that doesn't eval because it is
5486 called asynchronously from note_mouse_highlight. */
5489 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5491 const int MAX_DISTANCE
= 1000;
5492 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5493 around_charpos
+ MAX_DISTANCE
,
5497 found
= string_buffer_position_lim (string
, around_charpos
,
5498 around_charpos
- MAX_DISTANCE
, 1);
5504 /***********************************************************************
5505 `composition' property
5506 ***********************************************************************/
5508 /* Set up iterator IT from `composition' property at its current
5509 position. Called from handle_stop. */
5511 static enum prop_handled
5512 handle_composition_prop (struct it
*it
)
5514 Lisp_Object prop
, string
;
5515 ptrdiff_t pos
, pos_byte
, start
, end
;
5517 if (STRINGP (it
->string
))
5521 pos
= IT_STRING_CHARPOS (*it
);
5522 pos_byte
= IT_STRING_BYTEPOS (*it
);
5523 string
= it
->string
;
5524 s
= SDATA (string
) + pos_byte
;
5525 it
->c
= STRING_CHAR (s
);
5529 pos
= IT_CHARPOS (*it
);
5530 pos_byte
= IT_BYTEPOS (*it
);
5532 it
->c
= FETCH_CHAR (pos_byte
);
5535 /* If there's a valid composition and point is not inside of the
5536 composition (in the case that the composition is from the current
5537 buffer), draw a glyph composed from the composition components. */
5538 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5539 && composition_valid_p (start
, end
, prop
)
5540 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5543 /* As we can't handle this situation (perhaps font-lock added
5544 a new composition), we just return here hoping that next
5545 redisplay will detect this composition much earlier. */
5546 return HANDLED_NORMALLY
;
5549 if (STRINGP (it
->string
))
5550 pos_byte
= string_char_to_byte (it
->string
, start
);
5552 pos_byte
= CHAR_TO_BYTE (start
);
5554 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5557 if (it
->cmp_it
.id
>= 0)
5560 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5561 it
->cmp_it
.nglyphs
= -1;
5565 return HANDLED_NORMALLY
;
5570 /***********************************************************************
5572 ***********************************************************************/
5574 /* The following structure is used to record overlay strings for
5575 later sorting in load_overlay_strings. */
5577 struct overlay_entry
5579 Lisp_Object overlay
;
5586 /* Set up iterator IT from overlay strings at its current position.
5587 Called from handle_stop. */
5589 static enum prop_handled
5590 handle_overlay_change (struct it
*it
)
5592 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5593 return HANDLED_RECOMPUTE_PROPS
;
5595 return HANDLED_NORMALLY
;
5599 /* Set up the next overlay string for delivery by IT, if there is an
5600 overlay string to deliver. Called by set_iterator_to_next when the
5601 end of the current overlay string is reached. If there are more
5602 overlay strings to display, IT->string and
5603 IT->current.overlay_string_index are set appropriately here.
5604 Otherwise IT->string is set to nil. */
5607 next_overlay_string (struct it
*it
)
5609 ++it
->current
.overlay_string_index
;
5610 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5612 /* No more overlay strings. Restore IT's settings to what
5613 they were before overlay strings were processed, and
5614 continue to deliver from current_buffer. */
5616 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5619 || (NILP (it
->string
)
5620 && it
->method
== GET_FROM_BUFFER
5621 && it
->stop_charpos
>= BEGV
5622 && it
->stop_charpos
<= it
->end_charpos
));
5623 it
->current
.overlay_string_index
= -1;
5624 it
->n_overlay_strings
= 0;
5625 it
->overlay_strings_charpos
= -1;
5626 /* If there's an empty display string on the stack, pop the
5627 stack, to resync the bidi iterator with IT's position. Such
5628 empty strings are pushed onto the stack in
5629 get_overlay_strings_1. */
5630 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5633 /* Since we've exhausted overlay strings at this buffer
5634 position, set the flag to ignore overlays until we move to
5635 another position. The flag is reset in
5636 next_element_from_buffer. */
5637 it
->ignore_overlay_strings_at_pos_p
= true;
5639 /* If we're at the end of the buffer, record that we have
5640 processed the overlay strings there already, so that
5641 next_element_from_buffer doesn't try it again. */
5642 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5643 it
->overlay_strings_at_end_processed_p
= true;
5647 /* There are more overlay strings to process. If
5648 IT->current.overlay_string_index has advanced to a position
5649 where we must load IT->overlay_strings with more strings, do
5650 it. We must load at the IT->overlay_strings_charpos where
5651 IT->n_overlay_strings was originally computed; when invisible
5652 text is present, this might not be IT_CHARPOS (Bug#7016). */
5653 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5655 if (it
->current
.overlay_string_index
&& i
== 0)
5656 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5658 /* Initialize IT to deliver display elements from the overlay
5660 it
->string
= it
->overlay_strings
[i
];
5661 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5662 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5663 it
->method
= GET_FROM_STRING
;
5664 it
->stop_charpos
= 0;
5665 it
->end_charpos
= SCHARS (it
->string
);
5666 if (it
->cmp_it
.stop_pos
>= 0)
5667 it
->cmp_it
.stop_pos
= 0;
5669 it
->base_level_stop
= 0;
5671 /* Set up the bidi iterator for this overlay string. */
5674 it
->bidi_it
.string
.lstring
= it
->string
;
5675 it
->bidi_it
.string
.s
= NULL
;
5676 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5677 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5678 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5679 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5680 it
->bidi_it
.w
= it
->w
;
5681 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5689 /* Compare two overlay_entry structures E1 and E2. Used as a
5690 comparison function for qsort in load_overlay_strings. Overlay
5691 strings for the same position are sorted so that
5693 1. All after-strings come in front of before-strings, except
5694 when they come from the same overlay.
5696 2. Within after-strings, strings are sorted so that overlay strings
5697 from overlays with higher priorities come first.
5699 2. Within before-strings, strings are sorted so that overlay
5700 strings from overlays with higher priorities come last.
5702 Value is analogous to strcmp. */
5706 compare_overlay_entries (const void *e1
, const void *e2
)
5708 struct overlay_entry
const *entry1
= e1
;
5709 struct overlay_entry
const *entry2
= e2
;
5712 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5714 /* Let after-strings appear in front of before-strings if
5715 they come from different overlays. */
5716 if (EQ (entry1
->overlay
, entry2
->overlay
))
5717 result
= entry1
->after_string_p
? 1 : -1;
5719 result
= entry1
->after_string_p
? -1 : 1;
5721 else if (entry1
->priority
!= entry2
->priority
)
5723 if (entry1
->after_string_p
)
5724 /* After-strings sorted in order of decreasing priority. */
5725 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5727 /* Before-strings sorted in order of increasing priority. */
5728 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5737 /* Load the vector IT->overlay_strings with overlay strings from IT's
5738 current buffer position, or from CHARPOS if that is > 0. Set
5739 IT->n_overlays to the total number of overlay strings found.
5741 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5742 a time. On entry into load_overlay_strings,
5743 IT->current.overlay_string_index gives the number of overlay
5744 strings that have already been loaded by previous calls to this
5747 IT->add_overlay_start contains an additional overlay start
5748 position to consider for taking overlay strings from, if non-zero.
5749 This position comes into play when the overlay has an `invisible'
5750 property, and both before and after-strings. When we've skipped to
5751 the end of the overlay, because of its `invisible' property, we
5752 nevertheless want its before-string to appear.
5753 IT->add_overlay_start will contain the overlay start position
5756 Overlay strings are sorted so that after-string strings come in
5757 front of before-string strings. Within before and after-strings,
5758 strings are sorted by overlay priority. See also function
5759 compare_overlay_entries. */
5762 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5764 Lisp_Object overlay
, window
, str
, invisible
;
5765 struct Lisp_Overlay
*ov
;
5766 ptrdiff_t start
, end
;
5767 ptrdiff_t size
= 20;
5768 ptrdiff_t n
= 0, i
, j
;
5770 struct overlay_entry
*entries
= alloca (size
* sizeof *entries
);
5774 charpos
= IT_CHARPOS (*it
);
5776 /* Append the overlay string STRING of overlay OVERLAY to vector
5777 `entries' which has size `size' and currently contains `n'
5778 elements. AFTER_P non-zero means STRING is an after-string of
5780 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5783 Lisp_Object priority; \
5787 struct overlay_entry *old = entries; \
5788 SAFE_NALLOCA (entries, 2, size); \
5789 memcpy (entries, old, size * sizeof *entries); \
5793 entries[n].string = (STRING); \
5794 entries[n].overlay = (OVERLAY); \
5795 priority = Foverlay_get ((OVERLAY), Qpriority); \
5796 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5797 entries[n].after_string_p = (AFTER_P); \
5802 /* Process overlay before the overlay center. */
5803 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5805 XSETMISC (overlay
, ov
);
5806 eassert (OVERLAYP (overlay
));
5807 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5808 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5813 /* Skip this overlay if it doesn't start or end at IT's current
5815 if (end
!= charpos
&& start
!= charpos
)
5818 /* Skip this overlay if it doesn't apply to IT->w. */
5819 window
= Foverlay_get (overlay
, Qwindow
);
5820 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5823 /* If the text ``under'' the overlay is invisible, both before-
5824 and after-strings from this overlay are visible; start and
5825 end position are indistinguishable. */
5826 invisible
= Foverlay_get (overlay
, Qinvisible
);
5827 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5829 /* If overlay has a non-empty before-string, record it. */
5830 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5831 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5833 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5835 /* If overlay has a non-empty after-string, record it. */
5836 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5837 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5839 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5842 /* Process overlays after the overlay center. */
5843 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5845 XSETMISC (overlay
, ov
);
5846 eassert (OVERLAYP (overlay
));
5847 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5848 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5850 if (start
> charpos
)
5853 /* Skip this overlay if it doesn't start or end at IT's current
5855 if (end
!= charpos
&& start
!= charpos
)
5858 /* Skip this overlay if it doesn't apply to IT->w. */
5859 window
= Foverlay_get (overlay
, Qwindow
);
5860 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5863 /* If the text ``under'' the overlay is invisible, it has a zero
5864 dimension, and both before- and after-strings apply. */
5865 invisible
= Foverlay_get (overlay
, Qinvisible
);
5866 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5868 /* If overlay has a non-empty before-string, record it. */
5869 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5870 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5872 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5874 /* If overlay has a non-empty after-string, record it. */
5875 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5876 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5878 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5881 #undef RECORD_OVERLAY_STRING
5885 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5887 /* Record number of overlay strings, and where we computed it. */
5888 it
->n_overlay_strings
= n
;
5889 it
->overlay_strings_charpos
= charpos
;
5891 /* IT->current.overlay_string_index is the number of overlay strings
5892 that have already been consumed by IT. Copy some of the
5893 remaining overlay strings to IT->overlay_strings. */
5895 j
= it
->current
.overlay_string_index
;
5896 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5898 it
->overlay_strings
[i
] = entries
[j
].string
;
5899 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5907 /* Get the first chunk of overlay strings at IT's current buffer
5908 position, or at CHARPOS if that is > 0. Value is non-zero if at
5909 least one overlay string was found. */
5912 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5914 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5915 process. This fills IT->overlay_strings with strings, and sets
5916 IT->n_overlay_strings to the total number of strings to process.
5917 IT->pos.overlay_string_index has to be set temporarily to zero
5918 because load_overlay_strings needs this; it must be set to -1
5919 when no overlay strings are found because a zero value would
5920 indicate a position in the first overlay string. */
5921 it
->current
.overlay_string_index
= 0;
5922 load_overlay_strings (it
, charpos
);
5924 /* If we found overlay strings, set up IT to deliver display
5925 elements from the first one. Otherwise set up IT to deliver
5926 from current_buffer. */
5927 if (it
->n_overlay_strings
)
5929 /* Make sure we know settings in current_buffer, so that we can
5930 restore meaningful values when we're done with the overlay
5933 compute_stop_pos (it
);
5934 eassert (it
->face_id
>= 0);
5936 /* Save IT's settings. They are restored after all overlay
5937 strings have been processed. */
5938 eassert (!compute_stop_p
|| it
->sp
== 0);
5940 /* When called from handle_stop, there might be an empty display
5941 string loaded. In that case, don't bother saving it. But
5942 don't use this optimization with the bidi iterator, since we
5943 need the corresponding pop_it call to resync the bidi
5944 iterator's position with IT's position, after we are done
5945 with the overlay strings. (The corresponding call to pop_it
5946 in case of an empty display string is in
5947 next_overlay_string.) */
5949 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5952 /* Set up IT to deliver display elements from the first overlay
5954 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5955 it
->string
= it
->overlay_strings
[0];
5956 it
->from_overlay
= Qnil
;
5957 it
->stop_charpos
= 0;
5958 eassert (STRINGP (it
->string
));
5959 it
->end_charpos
= SCHARS (it
->string
);
5961 it
->base_level_stop
= 0;
5962 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5963 it
->method
= GET_FROM_STRING
;
5964 it
->from_disp_prop_p
= 0;
5966 /* Force paragraph direction to be that of the parent
5968 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5969 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5971 it
->paragraph_embedding
= L2R
;
5973 /* Set up the bidi iterator for this overlay string. */
5976 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5978 it
->bidi_it
.string
.lstring
= it
->string
;
5979 it
->bidi_it
.string
.s
= NULL
;
5980 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5981 it
->bidi_it
.string
.bufpos
= pos
;
5982 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5983 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5984 it
->bidi_it
.w
= it
->w
;
5985 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5990 it
->current
.overlay_string_index
= -1;
5995 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5998 it
->method
= GET_FROM_BUFFER
;
6000 (void) get_overlay_strings_1 (it
, charpos
, 1);
6004 /* Value is non-zero if we found at least one overlay string. */
6005 return STRINGP (it
->string
);
6010 /***********************************************************************
6011 Saving and restoring state
6012 ***********************************************************************/
6014 /* Save current settings of IT on IT->stack. Called, for example,
6015 before setting up IT for an overlay string, to be able to restore
6016 IT's settings to what they were after the overlay string has been
6017 processed. If POSITION is non-NULL, it is the position to save on
6018 the stack instead of IT->position. */
6021 push_it (struct it
*it
, struct text_pos
*position
)
6023 struct iterator_stack_entry
*p
;
6025 eassert (it
->sp
< IT_STACK_SIZE
);
6026 p
= it
->stack
+ it
->sp
;
6028 p
->stop_charpos
= it
->stop_charpos
;
6029 p
->prev_stop
= it
->prev_stop
;
6030 p
->base_level_stop
= it
->base_level_stop
;
6031 p
->cmp_it
= it
->cmp_it
;
6032 eassert (it
->face_id
>= 0);
6033 p
->face_id
= it
->face_id
;
6034 p
->string
= it
->string
;
6035 p
->method
= it
->method
;
6036 p
->from_overlay
= it
->from_overlay
;
6039 case GET_FROM_IMAGE
:
6040 p
->u
.image
.object
= it
->object
;
6041 p
->u
.image
.image_id
= it
->image_id
;
6042 p
->u
.image
.slice
= it
->slice
;
6044 case GET_FROM_STRETCH
:
6045 p
->u
.stretch
.object
= it
->object
;
6048 p
->position
= position
? *position
: it
->position
;
6049 p
->current
= it
->current
;
6050 p
->end_charpos
= it
->end_charpos
;
6051 p
->string_nchars
= it
->string_nchars
;
6053 p
->multibyte_p
= it
->multibyte_p
;
6054 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
6055 p
->space_width
= it
->space_width
;
6056 p
->font_height
= it
->font_height
;
6057 p
->voffset
= it
->voffset
;
6058 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
6059 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
6060 p
->display_ellipsis_p
= 0;
6061 p
->line_wrap
= it
->line_wrap
;
6062 p
->bidi_p
= it
->bidi_p
;
6063 p
->paragraph_embedding
= it
->paragraph_embedding
;
6064 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
6067 /* Save the state of the bidi iterator as well. */
6069 bidi_push_it (&it
->bidi_it
);
6073 iterate_out_of_display_property (struct it
*it
)
6075 int buffer_p
= !STRINGP (it
->string
);
6076 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
6077 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
6079 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
6081 /* Maybe initialize paragraph direction. If we are at the beginning
6082 of a new paragraph, next_element_from_buffer may not have a
6083 chance to do that. */
6084 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
6085 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6086 /* prev_stop can be zero, so check against BEGV as well. */
6087 while (it
->bidi_it
.charpos
>= bob
6088 && it
->prev_stop
<= it
->bidi_it
.charpos
6089 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
6090 && it
->bidi_it
.charpos
< eob
)
6091 bidi_move_to_visually_next (&it
->bidi_it
);
6092 /* Record the stop_pos we just crossed, for when we cross it
6094 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
6095 it
->prev_stop
= CHARPOS (it
->position
);
6096 /* If we ended up not where pop_it put us, resync IT's
6097 positional members with the bidi iterator. */
6098 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
6099 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
6101 it
->current
.pos
= it
->position
;
6103 it
->current
.string_pos
= it
->position
;
6106 /* Restore IT's settings from IT->stack. Called, for example, when no
6107 more overlay strings must be processed, and we return to delivering
6108 display elements from a buffer, or when the end of a string from a
6109 `display' property is reached and we return to delivering display
6110 elements from an overlay string, or from a buffer. */
6113 pop_it (struct it
*it
)
6115 struct iterator_stack_entry
*p
;
6116 int from_display_prop
= it
->from_disp_prop_p
;
6118 eassert (it
->sp
> 0);
6120 p
= it
->stack
+ it
->sp
;
6121 it
->stop_charpos
= p
->stop_charpos
;
6122 it
->prev_stop
= p
->prev_stop
;
6123 it
->base_level_stop
= p
->base_level_stop
;
6124 it
->cmp_it
= p
->cmp_it
;
6125 it
->face_id
= p
->face_id
;
6126 it
->current
= p
->current
;
6127 it
->position
= p
->position
;
6128 it
->string
= p
->string
;
6129 it
->from_overlay
= p
->from_overlay
;
6130 if (NILP (it
->string
))
6131 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6132 it
->method
= p
->method
;
6135 case GET_FROM_IMAGE
:
6136 it
->image_id
= p
->u
.image
.image_id
;
6137 it
->object
= p
->u
.image
.object
;
6138 it
->slice
= p
->u
.image
.slice
;
6140 case GET_FROM_STRETCH
:
6141 it
->object
= p
->u
.stretch
.object
;
6143 case GET_FROM_BUFFER
:
6144 it
->object
= it
->w
->contents
;
6146 case GET_FROM_STRING
:
6148 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6150 /* Restore the face_box_p flag, since it could have been
6151 overwritten by the face of the object that we just finished
6154 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6155 it
->object
= it
->string
;
6158 case GET_FROM_DISPLAY_VECTOR
:
6160 it
->method
= GET_FROM_C_STRING
;
6161 else if (STRINGP (it
->string
))
6162 it
->method
= GET_FROM_STRING
;
6165 it
->method
= GET_FROM_BUFFER
;
6166 it
->object
= it
->w
->contents
;
6169 it
->end_charpos
= p
->end_charpos
;
6170 it
->string_nchars
= p
->string_nchars
;
6172 it
->multibyte_p
= p
->multibyte_p
;
6173 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6174 it
->space_width
= p
->space_width
;
6175 it
->font_height
= p
->font_height
;
6176 it
->voffset
= p
->voffset
;
6177 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6178 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6179 it
->line_wrap
= p
->line_wrap
;
6180 it
->bidi_p
= p
->bidi_p
;
6181 it
->paragraph_embedding
= p
->paragraph_embedding
;
6182 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6185 bidi_pop_it (&it
->bidi_it
);
6186 /* Bidi-iterate until we get out of the portion of text, if any,
6187 covered by a `display' text property or by an overlay with
6188 `display' property. (We cannot just jump there, because the
6189 internal coherency of the bidi iterator state can not be
6190 preserved across such jumps.) We also must determine the
6191 paragraph base direction if the overlay we just processed is
6192 at the beginning of a new paragraph. */
6193 if (from_display_prop
6194 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6195 iterate_out_of_display_property (it
);
6197 eassert ((BUFFERP (it
->object
)
6198 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6199 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6200 || (STRINGP (it
->object
)
6201 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6202 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6203 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6209 /***********************************************************************
6211 ***********************************************************************/
6213 /* Set IT's current position to the previous line start. */
6216 back_to_previous_line_start (struct it
*it
)
6218 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6221 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6225 /* Move IT to the next line start.
6227 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
6228 we skipped over part of the text (as opposed to moving the iterator
6229 continuously over the text). Otherwise, don't change the value
6232 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6233 iterator on the newline, if it was found.
6235 Newlines may come from buffer text, overlay strings, or strings
6236 displayed via the `display' property. That's the reason we can't
6237 simply use find_newline_no_quit.
6239 Note that this function may not skip over invisible text that is so
6240 because of text properties and immediately follows a newline. If
6241 it would, function reseat_at_next_visible_line_start, when called
6242 from set_iterator_to_next, would effectively make invisible
6243 characters following a newline part of the wrong glyph row, which
6244 leads to wrong cursor motion. */
6247 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
6248 struct bidi_it
*bidi_it_prev
)
6250 ptrdiff_t old_selective
;
6251 int newline_found_p
, n
;
6252 const int MAX_NEWLINE_DISTANCE
= 500;
6254 /* If already on a newline, just consume it to avoid unintended
6255 skipping over invisible text below. */
6256 if (it
->what
== IT_CHARACTER
6258 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6260 if (it
->bidi_p
&& bidi_it_prev
)
6261 *bidi_it_prev
= it
->bidi_it
;
6262 set_iterator_to_next (it
, 0);
6267 /* Don't handle selective display in the following. It's (a)
6268 unnecessary because it's done by the caller, and (b) leads to an
6269 infinite recursion because next_element_from_ellipsis indirectly
6270 calls this function. */
6271 old_selective
= it
->selective
;
6274 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6275 from buffer text. */
6276 for (n
= newline_found_p
= 0;
6277 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6278 n
+= STRINGP (it
->string
) ? 0 : 1)
6280 if (!get_next_display_element (it
))
6282 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6283 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6284 *bidi_it_prev
= it
->bidi_it
;
6285 set_iterator_to_next (it
, 0);
6288 /* If we didn't find a newline near enough, see if we can use a
6290 if (!newline_found_p
)
6292 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6293 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6297 eassert (!STRINGP (it
->string
));
6299 /* If there isn't any `display' property in sight, and no
6300 overlays, we can just use the position of the newline in
6302 if (it
->stop_charpos
>= limit
6303 || ((pos
= Fnext_single_property_change (make_number (start
),
6305 make_number (limit
)),
6307 && next_overlay_change (start
) == ZV
))
6311 IT_CHARPOS (*it
) = limit
;
6312 IT_BYTEPOS (*it
) = bytepos
;
6316 struct bidi_it bprev
;
6318 /* Help bidi.c avoid expensive searches for display
6319 properties and overlays, by telling it that there are
6320 none up to `limit'. */
6321 if (it
->bidi_it
.disp_pos
< limit
)
6323 it
->bidi_it
.disp_pos
= limit
;
6324 it
->bidi_it
.disp_prop
= 0;
6327 bprev
= it
->bidi_it
;
6328 bidi_move_to_visually_next (&it
->bidi_it
);
6329 } while (it
->bidi_it
.charpos
!= limit
);
6330 IT_CHARPOS (*it
) = limit
;
6331 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6333 *bidi_it_prev
= bprev
;
6335 *skipped_p
= newline_found_p
= true;
6339 while (get_next_display_element (it
)
6340 && !newline_found_p
)
6342 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6343 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6344 *bidi_it_prev
= it
->bidi_it
;
6345 set_iterator_to_next (it
, 0);
6350 it
->selective
= old_selective
;
6351 return newline_found_p
;
6355 /* Set IT's current position to the previous visible line start. Skip
6356 invisible text that is so either due to text properties or due to
6357 selective display. Caution: this does not change IT->current_x and
6361 back_to_previous_visible_line_start (struct it
*it
)
6363 while (IT_CHARPOS (*it
) > BEGV
)
6365 back_to_previous_line_start (it
);
6367 if (IT_CHARPOS (*it
) <= BEGV
)
6370 /* If selective > 0, then lines indented more than its value are
6372 if (it
->selective
> 0
6373 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6377 /* Check the newline before point for invisibility. */
6380 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6381 Qinvisible
, it
->window
);
6382 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6386 if (IT_CHARPOS (*it
) <= BEGV
)
6391 void *it2data
= NULL
;
6394 Lisp_Object val
, overlay
;
6396 SAVE_IT (it2
, *it
, it2data
);
6398 /* If newline is part of a composition, continue from start of composition */
6399 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6400 && beg
< IT_CHARPOS (*it
))
6403 /* If newline is replaced by a display property, find start of overlay
6404 or interval and continue search from that point. */
6405 pos
= --IT_CHARPOS (it2
);
6408 bidi_unshelve_cache (NULL
, 0);
6409 it2
.string_from_display_prop_p
= 0;
6410 it2
.from_disp_prop_p
= 0;
6411 if (handle_display_prop (&it2
) == HANDLED_RETURN
6412 && !NILP (val
= get_char_property_and_overlay
6413 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6414 && (OVERLAYP (overlay
)
6415 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6416 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6418 RESTORE_IT (it
, it
, it2data
);
6422 /* Newline is not replaced by anything -- so we are done. */
6423 RESTORE_IT (it
, it
, it2data
);
6429 IT_CHARPOS (*it
) = beg
;
6430 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6434 it
->continuation_lines_width
= 0;
6436 eassert (IT_CHARPOS (*it
) >= BEGV
);
6437 eassert (IT_CHARPOS (*it
) == BEGV
6438 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6443 /* Reseat iterator IT at the previous visible line start. Skip
6444 invisible text that is so either due to text properties or due to
6445 selective display. At the end, update IT's overlay information,
6446 face information etc. */
6449 reseat_at_previous_visible_line_start (struct it
*it
)
6451 back_to_previous_visible_line_start (it
);
6452 reseat (it
, it
->current
.pos
, 1);
6457 /* Reseat iterator IT on the next visible line start in the current
6458 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6459 preceding the line start. Skip over invisible text that is so
6460 because of selective display. Compute faces, overlays etc at the
6461 new position. Note that this function does not skip over text that
6462 is invisible because of text properties. */
6465 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6467 int newline_found_p
, skipped_p
= 0;
6468 struct bidi_it bidi_it_prev
;
6470 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6472 /* Skip over lines that are invisible because they are indented
6473 more than the value of IT->selective. */
6474 if (it
->selective
> 0)
6475 while (IT_CHARPOS (*it
) < ZV
6476 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6479 eassert (IT_BYTEPOS (*it
) == BEGV
6480 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6482 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6485 /* Position on the newline if that's what's requested. */
6486 if (on_newline_p
&& newline_found_p
)
6488 if (STRINGP (it
->string
))
6490 if (IT_STRING_CHARPOS (*it
) > 0)
6494 --IT_STRING_CHARPOS (*it
);
6495 --IT_STRING_BYTEPOS (*it
);
6499 /* We need to restore the bidi iterator to the state
6500 it had on the newline, and resync the IT's
6501 position with that. */
6502 it
->bidi_it
= bidi_it_prev
;
6503 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6504 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6508 else if (IT_CHARPOS (*it
) > BEGV
)
6517 /* We need to restore the bidi iterator to the state it
6518 had on the newline and resync IT with that. */
6519 it
->bidi_it
= bidi_it_prev
;
6520 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6521 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6523 reseat (it
, it
->current
.pos
, 0);
6527 reseat (it
, it
->current
.pos
, 0);
6534 /***********************************************************************
6535 Changing an iterator's position
6536 ***********************************************************************/
6538 /* Change IT's current position to POS in current_buffer. If FORCE_P
6539 is non-zero, always check for text properties at the new position.
6540 Otherwise, text properties are only looked up if POS >=
6541 IT->check_charpos of a property. */
6544 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6546 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6548 reseat_1 (it
, pos
, 0);
6550 /* Determine where to check text properties. Avoid doing it
6551 where possible because text property lookup is very expensive. */
6553 || CHARPOS (pos
) > it
->stop_charpos
6554 || CHARPOS (pos
) < original_pos
)
6558 /* For bidi iteration, we need to prime prev_stop and
6559 base_level_stop with our best estimations. */
6560 /* Implementation note: Of course, POS is not necessarily a
6561 stop position, so assigning prev_pos to it is a lie; we
6562 should have called compute_stop_backwards. However, if
6563 the current buffer does not include any R2L characters,
6564 that call would be a waste of cycles, because the
6565 iterator will never move back, and thus never cross this
6566 "fake" stop position. So we delay that backward search
6567 until the time we really need it, in next_element_from_buffer. */
6568 if (CHARPOS (pos
) != it
->prev_stop
)
6569 it
->prev_stop
= CHARPOS (pos
);
6570 if (CHARPOS (pos
) < it
->base_level_stop
)
6571 it
->base_level_stop
= 0; /* meaning it's unknown */
6577 it
->prev_stop
= it
->base_level_stop
= 0;
6586 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6587 IT->stop_pos to POS, also. */
6590 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6592 /* Don't call this function when scanning a C string. */
6593 eassert (it
->s
== NULL
);
6595 /* POS must be a reasonable value. */
6596 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6598 it
->current
.pos
= it
->position
= pos
;
6599 it
->end_charpos
= ZV
;
6601 it
->current
.dpvec_index
= -1;
6602 it
->current
.overlay_string_index
= -1;
6603 IT_STRING_CHARPOS (*it
) = -1;
6604 IT_STRING_BYTEPOS (*it
) = -1;
6606 it
->method
= GET_FROM_BUFFER
;
6607 it
->object
= it
->w
->contents
;
6608 it
->area
= TEXT_AREA
;
6609 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6611 it
->string_from_display_prop_p
= 0;
6612 it
->string_from_prefix_prop_p
= 0;
6614 it
->from_disp_prop_p
= 0;
6615 it
->face_before_selective_p
= 0;
6618 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6620 bidi_unshelve_cache (NULL
, 0);
6621 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6622 it
->bidi_it
.string
.s
= NULL
;
6623 it
->bidi_it
.string
.lstring
= Qnil
;
6624 it
->bidi_it
.string
.bufpos
= 0;
6625 it
->bidi_it
.string
.from_disp_str
= 0;
6626 it
->bidi_it
.string
.unibyte
= 0;
6627 it
->bidi_it
.w
= it
->w
;
6632 it
->stop_charpos
= CHARPOS (pos
);
6633 it
->base_level_stop
= CHARPOS (pos
);
6635 /* This make the information stored in it->cmp_it invalidate. */
6640 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6641 If S is non-null, it is a C string to iterate over. Otherwise,
6642 STRING gives a Lisp string to iterate over.
6644 If PRECISION > 0, don't return more then PRECISION number of
6645 characters from the string.
6647 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6648 characters have been returned. FIELD_WIDTH < 0 means an infinite
6651 MULTIBYTE = 0 means disable processing of multibyte characters,
6652 MULTIBYTE > 0 means enable it,
6653 MULTIBYTE < 0 means use IT->multibyte_p.
6655 IT must be initialized via a prior call to init_iterator before
6656 calling this function. */
6659 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6660 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6663 /* No text property checks performed by default, but see below. */
6664 it
->stop_charpos
= -1;
6666 /* Set iterator position and end position. */
6667 memset (&it
->current
, 0, sizeof it
->current
);
6668 it
->current
.overlay_string_index
= -1;
6669 it
->current
.dpvec_index
= -1;
6670 eassert (charpos
>= 0);
6672 /* If STRING is specified, use its multibyteness, otherwise use the
6673 setting of MULTIBYTE, if specified. */
6675 it
->multibyte_p
= multibyte
> 0;
6677 /* Bidirectional reordering of strings is controlled by the default
6678 value of bidi-display-reordering. Don't try to reorder while
6679 loading loadup.el, as the necessary character property tables are
6680 not yet available. */
6683 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6687 eassert (STRINGP (string
));
6688 it
->string
= string
;
6690 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6691 it
->method
= GET_FROM_STRING
;
6692 it
->current
.string_pos
= string_pos (charpos
, string
);
6696 it
->bidi_it
.string
.lstring
= string
;
6697 it
->bidi_it
.string
.s
= NULL
;
6698 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6699 it
->bidi_it
.string
.bufpos
= 0;
6700 it
->bidi_it
.string
.from_disp_str
= 0;
6701 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6702 it
->bidi_it
.w
= it
->w
;
6703 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6704 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6709 it
->s
= (const unsigned char *) s
;
6712 /* Note that we use IT->current.pos, not it->current.string_pos,
6713 for displaying C strings. */
6714 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6715 if (it
->multibyte_p
)
6717 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6718 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6722 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6723 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6728 it
->bidi_it
.string
.lstring
= Qnil
;
6729 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6730 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6731 it
->bidi_it
.string
.bufpos
= 0;
6732 it
->bidi_it
.string
.from_disp_str
= 0;
6733 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6734 it
->bidi_it
.w
= it
->w
;
6735 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6738 it
->method
= GET_FROM_C_STRING
;
6741 /* PRECISION > 0 means don't return more than PRECISION characters
6743 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6745 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6747 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6750 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6751 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6752 FIELD_WIDTH < 0 means infinite field width. This is useful for
6753 padding with `-' at the end of a mode line. */
6754 if (field_width
< 0)
6755 field_width
= INFINITY
;
6756 /* Implementation note: We deliberately don't enlarge
6757 it->bidi_it.string.schars here to fit it->end_charpos, because
6758 the bidi iterator cannot produce characters out of thin air. */
6759 if (field_width
> it
->end_charpos
- charpos
)
6760 it
->end_charpos
= charpos
+ field_width
;
6762 /* Use the standard display table for displaying strings. */
6763 if (DISP_TABLE_P (Vstandard_display_table
))
6764 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6766 it
->stop_charpos
= charpos
;
6767 it
->prev_stop
= charpos
;
6768 it
->base_level_stop
= 0;
6771 it
->bidi_it
.first_elt
= 1;
6772 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6773 it
->bidi_it
.disp_pos
= -1;
6775 if (s
== NULL
&& it
->multibyte_p
)
6777 ptrdiff_t endpos
= SCHARS (it
->string
);
6778 if (endpos
> it
->end_charpos
)
6779 endpos
= it
->end_charpos
;
6780 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6788 /***********************************************************************
6790 ***********************************************************************/
6792 /* Map enum it_method value to corresponding next_element_from_* function. */
6794 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6796 next_element_from_buffer
,
6797 next_element_from_display_vector
,
6798 next_element_from_string
,
6799 next_element_from_c_string
,
6800 next_element_from_image
,
6801 next_element_from_stretch
6804 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6807 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6808 (possibly with the following characters). */
6810 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6811 ((IT)->cmp_it.id >= 0 \
6812 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6813 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6814 END_CHARPOS, (IT)->w, \
6815 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6819 /* Lookup the char-table Vglyphless_char_display for character C (-1
6820 if we want information for no-font case), and return the display
6821 method symbol. By side-effect, update it->what and
6822 it->glyphless_method. This function is called from
6823 get_next_display_element for each character element, and from
6824 x_produce_glyphs when no suitable font was found. */
6827 lookup_glyphless_char_display (int c
, struct it
*it
)
6829 Lisp_Object glyphless_method
= Qnil
;
6831 if (CHAR_TABLE_P (Vglyphless_char_display
)
6832 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6836 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6837 if (CONSP (glyphless_method
))
6838 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6839 ? XCAR (glyphless_method
)
6840 : XCDR (glyphless_method
);
6843 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6847 if (NILP (glyphless_method
))
6850 /* The default is to display the character by a proper font. */
6852 /* The default for the no-font case is to display an empty box. */
6853 glyphless_method
= Qempty_box
;
6855 if (EQ (glyphless_method
, Qzero_width
))
6858 return glyphless_method
;
6859 /* This method can't be used for the no-font case. */
6860 glyphless_method
= Qempty_box
;
6862 if (EQ (glyphless_method
, Qthin_space
))
6863 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6864 else if (EQ (glyphless_method
, Qempty_box
))
6865 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6866 else if (EQ (glyphless_method
, Qhex_code
))
6867 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6868 else if (STRINGP (glyphless_method
))
6869 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6872 /* Invalid value. We use the default method. */
6873 glyphless_method
= Qnil
;
6876 it
->what
= IT_GLYPHLESS
;
6877 return glyphless_method
;
6880 /* Merge escape glyph face and cache the result. */
6882 static struct frame
*last_escape_glyph_frame
= NULL
;
6883 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6884 static int last_escape_glyph_merged_face_id
= 0;
6887 merge_escape_glyph_face (struct it
*it
)
6891 if (it
->f
== last_escape_glyph_frame
6892 && it
->face_id
== last_escape_glyph_face_id
)
6893 face_id
= last_escape_glyph_merged_face_id
;
6896 /* Merge the `escape-glyph' face into the current face. */
6897 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6898 last_escape_glyph_frame
= it
->f
;
6899 last_escape_glyph_face_id
= it
->face_id
;
6900 last_escape_glyph_merged_face_id
= face_id
;
6905 /* Likewise for glyphless glyph face. */
6907 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6908 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6909 static int last_glyphless_glyph_merged_face_id
= 0;
6912 merge_glyphless_glyph_face (struct it
*it
)
6916 if (it
->f
== last_glyphless_glyph_frame
6917 && it
->face_id
== last_glyphless_glyph_face_id
)
6918 face_id
= last_glyphless_glyph_merged_face_id
;
6921 /* Merge the `glyphless-char' face into the current face. */
6922 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6923 last_glyphless_glyph_frame
= it
->f
;
6924 last_glyphless_glyph_face_id
= it
->face_id
;
6925 last_glyphless_glyph_merged_face_id
= face_id
;
6930 /* Load IT's display element fields with information about the next
6931 display element from the current position of IT. Value is zero if
6932 end of buffer (or C string) is reached. */
6935 get_next_display_element (struct it
*it
)
6937 /* Non-zero means that we found a display element. Zero means that
6938 we hit the end of what we iterate over. Performance note: the
6939 function pointer `method' used here turns out to be faster than
6940 using a sequence of if-statements. */
6944 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6946 if (it
->what
== IT_CHARACTER
)
6948 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6949 and only if (a) the resolved directionality of that character
6951 /* FIXME: Do we need an exception for characters from display
6953 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6954 it
->c
= bidi_mirror_char (it
->c
);
6955 /* Map via display table or translate control characters.
6956 IT->c, IT->len etc. have been set to the next character by
6957 the function call above. If we have a display table, and it
6958 contains an entry for IT->c, translate it. Don't do this if
6959 IT->c itself comes from a display table, otherwise we could
6960 end up in an infinite recursion. (An alternative could be to
6961 count the recursion depth of this function and signal an
6962 error when a certain maximum depth is reached.) Is it worth
6964 if (success_p
&& it
->dpvec
== NULL
)
6967 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6968 int nonascii_space_p
= 0;
6969 int nonascii_hyphen_p
= 0;
6970 int c
= it
->c
; /* This is the character to display. */
6972 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6974 eassert (SINGLE_BYTE_CHAR_P (c
));
6975 if (unibyte_display_via_language_environment
)
6977 c
= DECODE_CHAR (unibyte
, c
);
6979 c
= BYTE8_TO_CHAR (it
->c
);
6982 c
= BYTE8_TO_CHAR (it
->c
);
6986 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6989 struct Lisp_Vector
*v
= XVECTOR (dv
);
6991 /* Return the first character from the display table
6992 entry, if not empty. If empty, don't display the
6993 current character. */
6996 it
->dpvec_char_len
= it
->len
;
6997 it
->dpvec
= v
->contents
;
6998 it
->dpend
= v
->contents
+ v
->header
.size
;
6999 it
->current
.dpvec_index
= 0;
7000 it
->dpvec_face_id
= -1;
7001 it
->saved_face_id
= it
->face_id
;
7002 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7007 set_iterator_to_next (it
, 0);
7012 if (! NILP (lookup_glyphless_char_display (c
, it
)))
7014 if (it
->what
== IT_GLYPHLESS
)
7016 /* Don't display this character. */
7017 set_iterator_to_next (it
, 0);
7021 /* If `nobreak-char-display' is non-nil, we display
7022 non-ASCII spaces and hyphens specially. */
7023 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
7026 nonascii_space_p
= true;
7027 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
7028 nonascii_hyphen_p
= true;
7031 /* Translate control characters into `\003' or `^C' form.
7032 Control characters coming from a display table entry are
7033 currently not translated because we use IT->dpvec to hold
7034 the translation. This could easily be changed but I
7035 don't believe that it is worth doing.
7037 The characters handled by `nobreak-char-display' must be
7040 Non-printable characters and raw-byte characters are also
7041 translated to octal form. */
7042 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
7043 ? (it
->area
!= TEXT_AREA
7044 /* In mode line, treat \n, \t like other crl chars. */
7047 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
7048 || (c
!= '\n' && c
!= '\t'))
7050 || nonascii_hyphen_p
7052 || ! CHAR_PRINTABLE_P (c
))))
7054 /* C is a control character, non-ASCII space/hyphen,
7055 raw-byte, or a non-printable character which must be
7056 displayed either as '\003' or as `^C' where the '\\'
7057 and '^' can be defined in the display table. Fill
7058 IT->ctl_chars with glyphs for what we have to
7059 display. Then, set IT->dpvec to these glyphs. */
7066 /* Handle control characters with ^. */
7068 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
7072 g
= '^'; /* default glyph for Control */
7073 /* Set IT->ctl_chars[0] to the glyph for `^'. */
7075 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7077 g
= GLYPH_CODE_CHAR (gc
);
7078 lface_id
= GLYPH_CODE_FACE (gc
);
7082 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7083 : merge_escape_glyph_face (it
));
7085 XSETINT (it
->ctl_chars
[0], g
);
7086 XSETINT (it
->ctl_chars
[1], c
^ 0100);
7088 goto display_control
;
7091 /* Handle non-ascii space in the mode where it only gets
7094 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7096 /* Merge `nobreak-space' into the current face. */
7097 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7099 XSETINT (it
->ctl_chars
[0], ' ');
7101 goto display_control
;
7104 /* Handle sequences that start with the "escape glyph". */
7106 /* the default escape glyph is \. */
7107 escape_glyph
= '\\';
7110 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7112 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7113 lface_id
= GLYPH_CODE_FACE (gc
);
7117 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7118 : merge_escape_glyph_face (it
));
7120 /* Draw non-ASCII hyphen with just highlighting: */
7122 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7124 XSETINT (it
->ctl_chars
[0], '-');
7126 goto display_control
;
7129 /* Draw non-ASCII space/hyphen with escape glyph: */
7131 if (nonascii_space_p
|| nonascii_hyphen_p
)
7133 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7134 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7136 goto display_control
;
7143 if (CHAR_BYTE8_P (c
))
7144 /* Display \200 instead of \17777600. */
7145 c
= CHAR_TO_BYTE8 (c
);
7146 len
= sprintf (str
, "%03o", c
);
7148 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7149 for (i
= 0; i
< len
; i
++)
7150 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7155 /* Set up IT->dpvec and return first character from it. */
7156 it
->dpvec_char_len
= it
->len
;
7157 it
->dpvec
= it
->ctl_chars
;
7158 it
->dpend
= it
->dpvec
+ ctl_len
;
7159 it
->current
.dpvec_index
= 0;
7160 it
->dpvec_face_id
= face_id
;
7161 it
->saved_face_id
= it
->face_id
;
7162 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7166 it
->char_to_display
= c
;
7170 it
->char_to_display
= it
->c
;
7174 #ifdef HAVE_WINDOW_SYSTEM
7175 /* Adjust face id for a multibyte character. There are no multibyte
7176 character in unibyte text. */
7177 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7180 && FRAME_WINDOW_P (it
->f
))
7182 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7184 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7186 /* Automatic composition with glyph-string. */
7187 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7189 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7193 ptrdiff_t pos
= (it
->s
? -1
7194 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7195 : IT_CHARPOS (*it
));
7198 if (it
->what
== IT_CHARACTER
)
7199 c
= it
->char_to_display
;
7202 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7206 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7207 /* TAB in a composition means display glyphs with
7208 padding space on the left or right. */
7209 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7212 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7215 #endif /* HAVE_WINDOW_SYSTEM */
7218 /* Is this character the last one of a run of characters with
7219 box? If yes, set IT->end_of_box_run_p to 1. */
7223 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7225 int face_id
= underlying_face_id (it
);
7226 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7230 if (face
->box
== FACE_NO_BOX
)
7232 /* If the box comes from face properties in a
7233 display string, check faces in that string. */
7234 int string_face_id
= face_after_it_pos (it
);
7235 it
->end_of_box_run_p
7236 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7239 /* Otherwise, the box comes from the underlying face.
7240 If this is the last string character displayed, check
7241 the next buffer location. */
7242 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7243 /* n_overlay_strings is unreliable unless
7244 overlay_string_index is non-negative. */
7245 && ((it
->current
.overlay_string_index
>= 0
7246 && (it
->current
.overlay_string_index
7247 == it
->n_overlay_strings
- 1))
7248 /* A string from display property. */
7249 || it
->from_disp_prop_p
))
7253 struct text_pos pos
= it
->current
.pos
;
7255 /* For a string from a display property, the next
7256 buffer position is stored in the 'position'
7257 member of the iteration stack slot below the
7258 current one, see handle_single_display_spec. By
7259 contrast, it->current.pos was is not yet updated
7260 to point to that buffer position; that will
7261 happen in pop_it, after we finish displaying the
7262 current string. Note that we already checked
7263 above that it->sp is positive, so subtracting one
7265 if (it
->from_disp_prop_p
)
7266 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7268 INC_TEXT_POS (pos
, it
->multibyte_p
);
7270 if (CHARPOS (pos
) >= ZV
)
7271 it
->end_of_box_run_p
= true;
7274 next_face_id
= face_at_buffer_position
7275 (it
->w
, CHARPOS (pos
), &ignore
,
7276 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, 0, -1);
7277 it
->end_of_box_run_p
7278 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7284 /* next_element_from_display_vector sets this flag according to
7285 faces of the display vector glyphs, see there. */
7286 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7288 int face_id
= face_after_it_pos (it
);
7289 it
->end_of_box_run_p
7290 = (face_id
!= it
->face_id
7291 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7294 /* If we reached the end of the object we've been iterating (e.g., a
7295 display string or an overlay string), and there's something on
7296 IT->stack, proceed with what's on the stack. It doesn't make
7297 sense to return zero if there's unprocessed stuff on the stack,
7298 because otherwise that stuff will never be displayed. */
7299 if (!success_p
&& it
->sp
> 0)
7301 set_iterator_to_next (it
, 0);
7302 success_p
= get_next_display_element (it
);
7305 /* Value is 0 if end of buffer or string reached. */
7310 /* Move IT to the next display element.
7312 RESEAT_P non-zero means if called on a newline in buffer text,
7313 skip to the next visible line start.
7315 Functions get_next_display_element and set_iterator_to_next are
7316 separate because I find this arrangement easier to handle than a
7317 get_next_display_element function that also increments IT's
7318 position. The way it is we can first look at an iterator's current
7319 display element, decide whether it fits on a line, and if it does,
7320 increment the iterator position. The other way around we probably
7321 would either need a flag indicating whether the iterator has to be
7322 incremented the next time, or we would have to implement a
7323 decrement position function which would not be easy to write. */
7326 set_iterator_to_next (struct it
*it
, int reseat_p
)
7328 /* Reset flags indicating start and end of a sequence of characters
7329 with box. Reset them at the start of this function because
7330 moving the iterator to a new position might set them. */
7331 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
7335 case GET_FROM_BUFFER
:
7336 /* The current display element of IT is a character from
7337 current_buffer. Advance in the buffer, and maybe skip over
7338 invisible lines that are so because of selective display. */
7339 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7340 reseat_at_next_visible_line_start (it
, 0);
7341 else if (it
->cmp_it
.id
>= 0)
7343 /* We are currently getting glyphs from a composition. */
7346 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7347 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7353 /* Update IT's char/byte positions to point to the first
7354 character of the next grapheme cluster, or to the
7355 character visually after the current composition. */
7356 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7357 bidi_move_to_visually_next (&it
->bidi_it
);
7358 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7359 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7362 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7363 && it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7365 /* Composition created while scanning forward. Proceed
7366 to the next grapheme cluster. */
7367 it
->cmp_it
.from
= it
->cmp_it
.to
;
7369 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7370 && it
->cmp_it
.from
> 0)
7372 /* Composition created while scanning backward. Proceed
7373 to the previous grapheme cluster. */
7374 it
->cmp_it
.to
= it
->cmp_it
.from
;
7378 /* No more grapheme clusters in this composition.
7379 Find the next stop position. */
7380 ptrdiff_t stop
= it
->end_charpos
;
7382 if (it
->bidi_it
.scan_dir
< 0)
7383 /* Now we are scanning backward and don't know
7386 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7387 IT_BYTEPOS (*it
), stop
, Qnil
);
7392 eassert (it
->len
!= 0);
7396 IT_BYTEPOS (*it
) += it
->len
;
7397 IT_CHARPOS (*it
) += 1;
7401 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7402 /* If this is a new paragraph, determine its base
7403 direction (a.k.a. its base embedding level). */
7404 if (it
->bidi_it
.new_paragraph
)
7405 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7406 bidi_move_to_visually_next (&it
->bidi_it
);
7407 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7408 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7409 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7411 /* As the scan direction was changed, we must
7412 re-compute the stop position for composition. */
7413 ptrdiff_t stop
= it
->end_charpos
;
7414 if (it
->bidi_it
.scan_dir
< 0)
7416 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7417 IT_BYTEPOS (*it
), stop
, Qnil
);
7420 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7424 case GET_FROM_C_STRING
:
7425 /* Current display element of IT is from a C string. */
7427 /* If the string position is beyond string's end, it means
7428 next_element_from_c_string is padding the string with
7429 blanks, in which case we bypass the bidi iterator,
7430 because it cannot deal with such virtual characters. */
7431 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7433 IT_BYTEPOS (*it
) += it
->len
;
7434 IT_CHARPOS (*it
) += 1;
7438 bidi_move_to_visually_next (&it
->bidi_it
);
7439 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7440 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7444 case GET_FROM_DISPLAY_VECTOR
:
7445 /* Current display element of IT is from a display table entry.
7446 Advance in the display table definition. Reset it to null if
7447 end reached, and continue with characters from buffers/
7449 ++it
->current
.dpvec_index
;
7451 /* Restore face of the iterator to what they were before the
7452 display vector entry (these entries may contain faces). */
7453 it
->face_id
= it
->saved_face_id
;
7455 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7457 int recheck_faces
= it
->ellipsis_p
;
7460 it
->method
= GET_FROM_C_STRING
;
7461 else if (STRINGP (it
->string
))
7462 it
->method
= GET_FROM_STRING
;
7465 it
->method
= GET_FROM_BUFFER
;
7466 it
->object
= it
->w
->contents
;
7470 it
->current
.dpvec_index
= -1;
7472 /* Skip over characters which were displayed via IT->dpvec. */
7473 if (it
->dpvec_char_len
< 0)
7474 reseat_at_next_visible_line_start (it
, 1);
7475 else if (it
->dpvec_char_len
> 0)
7477 it
->len
= it
->dpvec_char_len
;
7478 set_iterator_to_next (it
, reseat_p
);
7481 /* Maybe recheck faces after display vector. */
7484 if (it
->method
== GET_FROM_STRING
)
7485 it
->stop_charpos
= IT_STRING_CHARPOS (*it
);
7487 it
->stop_charpos
= IT_CHARPOS (*it
);
7492 case GET_FROM_STRING
:
7493 /* Current display element is a character from a Lisp string. */
7494 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7495 /* Don't advance past string end. These conditions are true
7496 when set_iterator_to_next is called at the end of
7497 get_next_display_element, in which case the Lisp string is
7498 already exhausted, and all we want is pop the iterator
7500 if (it
->current
.overlay_string_index
>= 0)
7502 /* This is an overlay string, so there's no padding with
7503 spaces, and the number of characters in the string is
7504 where the string ends. */
7505 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7506 goto consider_string_end
;
7510 /* Not an overlay string. There could be padding, so test
7511 against it->end_charpos. */
7512 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7513 goto consider_string_end
;
7515 if (it
->cmp_it
.id
>= 0)
7517 /* We are delivering display elements from a composition.
7518 Update the string position past the grapheme cluster
7519 we've just processed. */
7522 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7523 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7529 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7530 bidi_move_to_visually_next (&it
->bidi_it
);
7531 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7532 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7535 /* Did we exhaust all the grapheme clusters of this
7537 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7538 && (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
))
7540 /* Not all the grapheme clusters were processed yet;
7541 advance to the next cluster. */
7542 it
->cmp_it
.from
= it
->cmp_it
.to
;
7544 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7545 && it
->cmp_it
.from
> 0)
7547 /* Likewise: advance to the next cluster, but going in
7548 the reverse direction. */
7549 it
->cmp_it
.to
= it
->cmp_it
.from
;
7553 /* This composition was fully processed; find the next
7554 candidate place for checking for composed
7556 /* Always limit string searches to the string length;
7557 any padding spaces are not part of the string, and
7558 there cannot be any compositions in that padding. */
7559 ptrdiff_t stop
= SCHARS (it
->string
);
7561 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
7563 else if (it
->end_charpos
< stop
)
7565 /* Cf. PRECISION in reseat_to_string: we might be
7566 limited in how many of the string characters we
7568 stop
= it
->end_charpos
;
7570 composition_compute_stop_pos (&it
->cmp_it
,
7571 IT_STRING_CHARPOS (*it
),
7572 IT_STRING_BYTEPOS (*it
), stop
,
7579 /* If the string position is beyond string's end, it
7580 means next_element_from_string is padding the string
7581 with blanks, in which case we bypass the bidi
7582 iterator, because it cannot deal with such virtual
7584 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7586 IT_STRING_BYTEPOS (*it
) += it
->len
;
7587 IT_STRING_CHARPOS (*it
) += 1;
7591 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7593 bidi_move_to_visually_next (&it
->bidi_it
);
7594 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7595 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7596 /* If the scan direction changes, we may need to update
7597 the place where to check for composed characters. */
7598 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7600 ptrdiff_t stop
= SCHARS (it
->string
);
7602 if (it
->bidi_it
.scan_dir
< 0)
7604 else if (it
->end_charpos
< stop
)
7605 stop
= it
->end_charpos
;
7607 composition_compute_stop_pos (&it
->cmp_it
,
7608 IT_STRING_CHARPOS (*it
),
7609 IT_STRING_BYTEPOS (*it
), stop
,
7615 consider_string_end
:
7617 if (it
->current
.overlay_string_index
>= 0)
7619 /* IT->string is an overlay string. Advance to the
7620 next, if there is one. */
7621 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7624 next_overlay_string (it
);
7626 setup_for_ellipsis (it
, 0);
7631 /* IT->string is not an overlay string. If we reached
7632 its end, and there is something on IT->stack, proceed
7633 with what is on the stack. This can be either another
7634 string, this time an overlay string, or a buffer. */
7635 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7639 if (it
->method
== GET_FROM_STRING
)
7640 goto consider_string_end
;
7645 case GET_FROM_IMAGE
:
7646 case GET_FROM_STRETCH
:
7647 /* The position etc with which we have to proceed are on
7648 the stack. The position may be at the end of a string,
7649 if the `display' property takes up the whole string. */
7650 eassert (it
->sp
> 0);
7652 if (it
->method
== GET_FROM_STRING
)
7653 goto consider_string_end
;
7657 /* There are no other methods defined, so this should be a bug. */
7661 eassert (it
->method
!= GET_FROM_STRING
7662 || (STRINGP (it
->string
)
7663 && IT_STRING_CHARPOS (*it
) >= 0));
7666 /* Load IT's display element fields with information about the next
7667 display element which comes from a display table entry or from the
7668 result of translating a control character to one of the forms `^C'
7671 IT->dpvec holds the glyphs to return as characters.
7672 IT->saved_face_id holds the face id before the display vector--it
7673 is restored into IT->face_id in set_iterator_to_next. */
7676 next_element_from_display_vector (struct it
*it
)
7679 int prev_face_id
= it
->face_id
;
7683 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7685 it
->face_id
= it
->saved_face_id
;
7687 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7688 That seemed totally bogus - so I changed it... */
7689 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7691 if (GLYPH_CODE_P (gc
))
7693 struct face
*this_face
, *prev_face
, *next_face
;
7695 it
->c
= GLYPH_CODE_CHAR (gc
);
7696 it
->len
= CHAR_BYTES (it
->c
);
7698 /* The entry may contain a face id to use. Such a face id is
7699 the id of a Lisp face, not a realized face. A face id of
7700 zero means no face is specified. */
7701 if (it
->dpvec_face_id
>= 0)
7702 it
->face_id
= it
->dpvec_face_id
;
7705 int lface_id
= GLYPH_CODE_FACE (gc
);
7707 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7711 /* Glyphs in the display vector could have the box face, so we
7712 need to set the related flags in the iterator, as
7714 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7715 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7717 /* Is this character the first character of a box-face run? */
7718 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7720 || prev_face
->box
== FACE_NO_BOX
));
7722 /* For the last character of the box-face run, we need to look
7723 either at the next glyph from the display vector, or at the
7724 face we saw before the display vector. */
7725 next_face_id
= it
->saved_face_id
;
7726 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7728 if (it
->dpvec_face_id
>= 0)
7729 next_face_id
= it
->dpvec_face_id
;
7733 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7736 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7740 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7741 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7743 || next_face
->box
== FACE_NO_BOX
));
7744 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7747 /* Display table entry is invalid. Return a space. */
7748 it
->c
= ' ', it
->len
= 1;
7750 /* Don't change position and object of the iterator here. They are
7751 still the values of the character that had this display table
7752 entry or was translated, and that's what we want. */
7753 it
->what
= IT_CHARACTER
;
7757 /* Get the first element of string/buffer in the visual order, after
7758 being reseated to a new position in a string or a buffer. */
7760 get_visually_first_element (struct it
*it
)
7762 int string_p
= STRINGP (it
->string
) || it
->s
;
7763 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7764 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7766 if (STRINGP (it
->string
))
7768 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7769 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7773 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7774 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7777 if (it
->bidi_it
.charpos
== eob
)
7779 /* Nothing to do, but reset the FIRST_ELT flag, like
7780 bidi_paragraph_init does, because we are not going to
7782 it
->bidi_it
.first_elt
= 0;
7784 else if (it
->bidi_it
.charpos
== bob
7786 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7787 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7789 /* If we are at the beginning of a line/string, we can produce
7790 the next element right away. */
7791 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7792 bidi_move_to_visually_next (&it
->bidi_it
);
7796 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7798 /* We need to prime the bidi iterator starting at the line's or
7799 string's beginning, before we will be able to produce the
7802 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7804 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7805 IT_BYTEPOS (*it
), -1,
7806 &it
->bidi_it
.bytepos
);
7807 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7810 /* Now return to buffer/string position where we were asked
7811 to get the next display element, and produce that. */
7812 bidi_move_to_visually_next (&it
->bidi_it
);
7814 while (it
->bidi_it
.bytepos
!= orig_bytepos
7815 && it
->bidi_it
.charpos
< eob
);
7818 /* Adjust IT's position information to where we ended up. */
7819 if (STRINGP (it
->string
))
7821 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7822 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7826 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7827 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7830 if (STRINGP (it
->string
) || !it
->s
)
7832 ptrdiff_t stop
, charpos
, bytepos
;
7834 if (STRINGP (it
->string
))
7837 stop
= SCHARS (it
->string
);
7838 if (stop
> it
->end_charpos
)
7839 stop
= it
->end_charpos
;
7840 charpos
= IT_STRING_CHARPOS (*it
);
7841 bytepos
= IT_STRING_BYTEPOS (*it
);
7845 stop
= it
->end_charpos
;
7846 charpos
= IT_CHARPOS (*it
);
7847 bytepos
= IT_BYTEPOS (*it
);
7849 if (it
->bidi_it
.scan_dir
< 0)
7851 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7856 /* Load IT with the next display element from Lisp string IT->string.
7857 IT->current.string_pos is the current position within the string.
7858 If IT->current.overlay_string_index >= 0, the Lisp string is an
7862 next_element_from_string (struct it
*it
)
7864 struct text_pos position
;
7866 eassert (STRINGP (it
->string
));
7867 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7868 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7869 position
= it
->current
.string_pos
;
7871 /* With bidi reordering, the character to display might not be the
7872 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7873 that we were reseat()ed to a new string, whose paragraph
7874 direction is not known. */
7875 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7877 get_visually_first_element (it
);
7878 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7881 /* Time to check for invisible text? */
7882 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7884 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7887 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7888 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7890 /* With bidi non-linear iteration, we could find
7891 ourselves far beyond the last computed stop_charpos,
7892 with several other stop positions in between that we
7893 missed. Scan them all now, in buffer's logical
7894 order, until we find and handle the last stop_charpos
7895 that precedes our current position. */
7896 handle_stop_backwards (it
, it
->stop_charpos
);
7897 return GET_NEXT_DISPLAY_ELEMENT (it
);
7903 /* Take note of the stop position we just moved
7904 across, for when we will move back across it. */
7905 it
->prev_stop
= it
->stop_charpos
;
7906 /* If we are at base paragraph embedding level, take
7907 note of the last stop position seen at this
7909 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7910 it
->base_level_stop
= it
->stop_charpos
;
7914 /* Since a handler may have changed IT->method, we must
7916 return GET_NEXT_DISPLAY_ELEMENT (it
);
7920 /* If we are before prev_stop, we may have overstepped
7921 on our way backwards a stop_pos, and if so, we need
7922 to handle that stop_pos. */
7923 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7924 /* We can sometimes back up for reasons that have nothing
7925 to do with bidi reordering. E.g., compositions. The
7926 code below is only needed when we are above the base
7927 embedding level, so test for that explicitly. */
7928 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7930 /* If we lost track of base_level_stop, we have no better
7931 place for handle_stop_backwards to start from than string
7932 beginning. This happens, e.g., when we were reseated to
7933 the previous screenful of text by vertical-motion. */
7934 if (it
->base_level_stop
<= 0
7935 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7936 it
->base_level_stop
= 0;
7937 handle_stop_backwards (it
, it
->base_level_stop
);
7938 return GET_NEXT_DISPLAY_ELEMENT (it
);
7942 if (it
->current
.overlay_string_index
>= 0)
7944 /* Get the next character from an overlay string. In overlay
7945 strings, there is no field width or padding with spaces to
7947 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7952 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7953 IT_STRING_BYTEPOS (*it
),
7954 it
->bidi_it
.scan_dir
< 0
7956 : SCHARS (it
->string
))
7957 && next_element_from_composition (it
))
7961 else if (STRING_MULTIBYTE (it
->string
))
7963 const unsigned char *s
= (SDATA (it
->string
)
7964 + IT_STRING_BYTEPOS (*it
));
7965 it
->c
= string_char_and_length (s
, &it
->len
);
7969 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7975 /* Get the next character from a Lisp string that is not an
7976 overlay string. Such strings come from the mode line, for
7977 example. We may have to pad with spaces, or truncate the
7978 string. See also next_element_from_c_string. */
7979 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7984 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7986 /* Pad with spaces. */
7987 it
->c
= ' ', it
->len
= 1;
7988 CHARPOS (position
) = BYTEPOS (position
) = -1;
7990 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7991 IT_STRING_BYTEPOS (*it
),
7992 it
->bidi_it
.scan_dir
< 0
7994 : it
->string_nchars
)
7995 && next_element_from_composition (it
))
7999 else if (STRING_MULTIBYTE (it
->string
))
8001 const unsigned char *s
= (SDATA (it
->string
)
8002 + IT_STRING_BYTEPOS (*it
));
8003 it
->c
= string_char_and_length (s
, &it
->len
);
8007 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
8012 /* Record what we have and where it came from. */
8013 it
->what
= IT_CHARACTER
;
8014 it
->object
= it
->string
;
8015 it
->position
= position
;
8020 /* Load IT with next display element from C string IT->s.
8021 IT->string_nchars is the maximum number of characters to return
8022 from the string. IT->end_charpos may be greater than
8023 IT->string_nchars when this function is called, in which case we
8024 may have to return padding spaces. Value is zero if end of string
8025 reached, including padding spaces. */
8028 next_element_from_c_string (struct it
*it
)
8030 bool success_p
= true;
8033 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
8034 it
->what
= IT_CHARACTER
;
8035 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
8038 /* With bidi reordering, the character to display might not be the
8039 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8040 we were reseated to a new string, whose paragraph direction is
8042 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8043 get_visually_first_element (it
);
8045 /* IT's position can be greater than IT->string_nchars in case a
8046 field width or precision has been specified when the iterator was
8048 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8050 /* End of the game. */
8054 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
8056 /* Pad with spaces. */
8057 it
->c
= ' ', it
->len
= 1;
8058 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
8060 else if (it
->multibyte_p
)
8061 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
8063 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
8069 /* Set up IT to return characters from an ellipsis, if appropriate.
8070 The definition of the ellipsis glyphs may come from a display table
8071 entry. This function fills IT with the first glyph from the
8072 ellipsis if an ellipsis is to be displayed. */
8075 next_element_from_ellipsis (struct it
*it
)
8077 if (it
->selective_display_ellipsis_p
)
8078 setup_for_ellipsis (it
, it
->len
);
8081 /* The face at the current position may be different from the
8082 face we find after the invisible text. Remember what it
8083 was in IT->saved_face_id, and signal that it's there by
8084 setting face_before_selective_p. */
8085 it
->saved_face_id
= it
->face_id
;
8086 it
->method
= GET_FROM_BUFFER
;
8087 it
->object
= it
->w
->contents
;
8088 reseat_at_next_visible_line_start (it
, 1);
8089 it
->face_before_selective_p
= true;
8092 return GET_NEXT_DISPLAY_ELEMENT (it
);
8096 /* Deliver an image display element. The iterator IT is already
8097 filled with image information (done in handle_display_prop). Value
8102 next_element_from_image (struct it
*it
)
8104 it
->what
= IT_IMAGE
;
8109 /* Fill iterator IT with next display element from a stretch glyph
8110 property. IT->object is the value of the text property. Value is
8114 next_element_from_stretch (struct it
*it
)
8116 it
->what
= IT_STRETCH
;
8120 /* Scan backwards from IT's current position until we find a stop
8121 position, or until BEGV. This is called when we find ourself
8122 before both the last known prev_stop and base_level_stop while
8123 reordering bidirectional text. */
8126 compute_stop_pos_backwards (struct it
*it
)
8128 const int SCAN_BACK_LIMIT
= 1000;
8129 struct text_pos pos
;
8130 struct display_pos save_current
= it
->current
;
8131 struct text_pos save_position
= it
->position
;
8132 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8133 ptrdiff_t where_we_are
= charpos
;
8134 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8135 ptrdiff_t save_end_pos
= it
->end_charpos
;
8137 eassert (NILP (it
->string
) && !it
->s
);
8138 eassert (it
->bidi_p
);
8142 it
->end_charpos
= min (charpos
+ 1, ZV
);
8143 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8144 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8145 reseat_1 (it
, pos
, 0);
8146 compute_stop_pos (it
);
8147 /* We must advance forward, right? */
8148 if (it
->stop_charpos
<= charpos
)
8151 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8153 if (it
->stop_charpos
<= where_we_are
)
8154 it
->prev_stop
= it
->stop_charpos
;
8156 it
->prev_stop
= BEGV
;
8158 it
->current
= save_current
;
8159 it
->position
= save_position
;
8160 it
->stop_charpos
= save_stop_pos
;
8161 it
->end_charpos
= save_end_pos
;
8164 /* Scan forward from CHARPOS in the current buffer/string, until we
8165 find a stop position > current IT's position. Then handle the stop
8166 position before that. This is called when we bump into a stop
8167 position while reordering bidirectional text. CHARPOS should be
8168 the last previously processed stop_pos (or BEGV/0, if none were
8169 processed yet) whose position is less that IT's current
8173 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8175 int bufp
= !STRINGP (it
->string
);
8176 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8177 struct display_pos save_current
= it
->current
;
8178 struct text_pos save_position
= it
->position
;
8179 struct text_pos pos1
;
8180 ptrdiff_t next_stop
;
8182 /* Scan in strict logical order. */
8183 eassert (it
->bidi_p
);
8187 it
->prev_stop
= charpos
;
8190 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8191 reseat_1 (it
, pos1
, 0);
8194 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8195 compute_stop_pos (it
);
8196 /* We must advance forward, right? */
8197 if (it
->stop_charpos
<= it
->prev_stop
)
8199 charpos
= it
->stop_charpos
;
8201 while (charpos
<= where_we_are
);
8204 it
->current
= save_current
;
8205 it
->position
= save_position
;
8206 next_stop
= it
->stop_charpos
;
8207 it
->stop_charpos
= it
->prev_stop
;
8209 it
->stop_charpos
= next_stop
;
8212 /* Load IT with the next display element from current_buffer. Value
8213 is zero if end of buffer reached. IT->stop_charpos is the next
8214 position at which to stop and check for text properties or buffer
8218 next_element_from_buffer (struct it
*it
)
8220 bool success_p
= true;
8222 eassert (IT_CHARPOS (*it
) >= BEGV
);
8223 eassert (NILP (it
->string
) && !it
->s
);
8224 eassert (!it
->bidi_p
8225 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8226 && it
->bidi_it
.string
.s
== NULL
));
8228 /* With bidi reordering, the character to display might not be the
8229 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8230 we were reseat()ed to a new buffer position, which is potentially
8231 a different paragraph. */
8232 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8234 get_visually_first_element (it
);
8235 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8238 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8240 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8242 int overlay_strings_follow_p
;
8244 /* End of the game, except when overlay strings follow that
8245 haven't been returned yet. */
8246 if (it
->overlay_strings_at_end_processed_p
)
8247 overlay_strings_follow_p
= 0;
8250 it
->overlay_strings_at_end_processed_p
= true;
8251 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8254 if (overlay_strings_follow_p
)
8255 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8259 it
->position
= it
->current
.pos
;
8263 else if (!(!it
->bidi_p
8264 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8265 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8267 /* With bidi non-linear iteration, we could find ourselves
8268 far beyond the last computed stop_charpos, with several
8269 other stop positions in between that we missed. Scan
8270 them all now, in buffer's logical order, until we find
8271 and handle the last stop_charpos that precedes our
8272 current position. */
8273 handle_stop_backwards (it
, it
->stop_charpos
);
8274 it
->ignore_overlay_strings_at_pos_p
= false;
8275 return GET_NEXT_DISPLAY_ELEMENT (it
);
8281 /* Take note of the stop position we just moved across,
8282 for when we will move back across it. */
8283 it
->prev_stop
= it
->stop_charpos
;
8284 /* If we are at base paragraph embedding level, take
8285 note of the last stop position seen at this
8287 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8288 it
->base_level_stop
= it
->stop_charpos
;
8291 it
->ignore_overlay_strings_at_pos_p
= false;
8292 return GET_NEXT_DISPLAY_ELEMENT (it
);
8296 /* If we are before prev_stop, we may have overstepped on
8297 our way backwards a stop_pos, and if so, we need to
8298 handle that stop_pos. */
8299 && IT_CHARPOS (*it
) < it
->prev_stop
8300 /* We can sometimes back up for reasons that have nothing
8301 to do with bidi reordering. E.g., compositions. The
8302 code below is only needed when we are above the base
8303 embedding level, so test for that explicitly. */
8304 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8306 if (it
->base_level_stop
<= 0
8307 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8309 /* If we lost track of base_level_stop, we need to find
8310 prev_stop by looking backwards. This happens, e.g., when
8311 we were reseated to the previous screenful of text by
8313 it
->base_level_stop
= BEGV
;
8314 compute_stop_pos_backwards (it
);
8315 handle_stop_backwards (it
, it
->prev_stop
);
8318 handle_stop_backwards (it
, it
->base_level_stop
);
8319 it
->ignore_overlay_strings_at_pos_p
= false;
8320 return GET_NEXT_DISPLAY_ELEMENT (it
);
8324 /* No face changes, overlays etc. in sight, so just return a
8325 character from current_buffer. */
8329 /* We moved to the next buffer position, so any info about
8330 previously seen overlays is no longer valid. */
8331 it
->ignore_overlay_strings_at_pos_p
= false;
8333 /* Maybe run the redisplay end trigger hook. Performance note:
8334 This doesn't seem to cost measurable time. */
8335 if (it
->redisplay_end_trigger_charpos
8337 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8338 run_redisplay_end_trigger_hook (it
);
8340 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8341 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8343 && next_element_from_composition (it
))
8348 /* Get the next character, maybe multibyte. */
8349 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8350 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
8351 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8353 it
->c
= *p
, it
->len
= 1;
8355 /* Record what we have and where it came from. */
8356 it
->what
= IT_CHARACTER
;
8357 it
->object
= it
->w
->contents
;
8358 it
->position
= it
->current
.pos
;
8360 /* Normally we return the character found above, except when we
8361 really want to return an ellipsis for selective display. */
8366 /* A value of selective > 0 means hide lines indented more
8367 than that number of columns. */
8368 if (it
->selective
> 0
8369 && IT_CHARPOS (*it
) + 1 < ZV
8370 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8371 IT_BYTEPOS (*it
) + 1,
8374 success_p
= next_element_from_ellipsis (it
);
8375 it
->dpvec_char_len
= -1;
8378 else if (it
->c
== '\r' && it
->selective
== -1)
8380 /* A value of selective == -1 means that everything from the
8381 CR to the end of the line is invisible, with maybe an
8382 ellipsis displayed for it. */
8383 success_p
= next_element_from_ellipsis (it
);
8384 it
->dpvec_char_len
= -1;
8389 /* Value is zero if end of buffer reached. */
8390 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8395 /* Run the redisplay end trigger hook for IT. */
8398 run_redisplay_end_trigger_hook (struct it
*it
)
8400 Lisp_Object args
[3];
8402 /* IT->glyph_row should be non-null, i.e. we should be actually
8403 displaying something, or otherwise we should not run the hook. */
8404 eassert (it
->glyph_row
);
8406 /* Set up hook arguments. */
8407 args
[0] = Qredisplay_end_trigger_functions
;
8408 args
[1] = it
->window
;
8409 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8410 it
->redisplay_end_trigger_charpos
= 0;
8412 /* Since we are *trying* to run these functions, don't try to run
8413 them again, even if they get an error. */
8414 wset_redisplay_end_trigger (it
->w
, Qnil
);
8415 Frun_hook_with_args (3, args
);
8417 /* Notice if it changed the face of the character we are on. */
8418 handle_face_prop (it
);
8422 /* Deliver a composition display element. Unlike the other
8423 next_element_from_XXX, this function is not registered in the array
8424 get_next_element[]. It is called from next_element_from_buffer and
8425 next_element_from_string when necessary. */
8428 next_element_from_composition (struct it
*it
)
8430 it
->what
= IT_COMPOSITION
;
8431 it
->len
= it
->cmp_it
.nbytes
;
8432 if (STRINGP (it
->string
))
8436 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8437 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8440 it
->position
= it
->current
.string_pos
;
8441 it
->object
= it
->string
;
8442 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8443 IT_STRING_BYTEPOS (*it
), it
->string
);
8449 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8450 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8453 if (it
->bidi_it
.new_paragraph
)
8454 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8455 /* Resync the bidi iterator with IT's new position.
8456 FIXME: this doesn't support bidirectional text. */
8457 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8458 bidi_move_to_visually_next (&it
->bidi_it
);
8462 it
->position
= it
->current
.pos
;
8463 it
->object
= it
->w
->contents
;
8464 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8465 IT_BYTEPOS (*it
), Qnil
);
8472 /***********************************************************************
8473 Moving an iterator without producing glyphs
8474 ***********************************************************************/
8476 /* Check if iterator is at a position corresponding to a valid buffer
8477 position after some move_it_ call. */
8479 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8480 ((it)->method == GET_FROM_STRING \
8481 ? IT_STRING_CHARPOS (*it) == 0 \
8485 /* Move iterator IT to a specified buffer or X position within one
8486 line on the display without producing glyphs.
8488 OP should be a bit mask including some or all of these bits:
8489 MOVE_TO_X: Stop upon reaching x-position TO_X.
8490 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8491 Regardless of OP's value, stop upon reaching the end of the display line.
8493 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8494 This means, in particular, that TO_X includes window's horizontal
8497 The return value has several possible values that
8498 say what condition caused the scan to stop:
8500 MOVE_POS_MATCH_OR_ZV
8501 - when TO_POS or ZV was reached.
8504 -when TO_X was reached before TO_POS or ZV were reached.
8507 - when we reached the end of the display area and the line must
8511 - when we reached the end of the display area and the line is
8515 - when we stopped at a line end, i.e. a newline or a CR and selective
8518 static enum move_it_result
8519 move_it_in_display_line_to (struct it
*it
,
8520 ptrdiff_t to_charpos
, int to_x
,
8521 enum move_operation_enum op
)
8523 enum move_it_result result
= MOVE_UNDEFINED
;
8524 struct glyph_row
*saved_glyph_row
;
8525 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8526 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8527 void *ppos_data
= NULL
;
8529 enum it_method prev_method
= it
->method
;
8530 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8531 int saw_smaller_pos
= prev_pos
< to_charpos
;
8533 /* Don't produce glyphs in produce_glyphs. */
8534 saved_glyph_row
= it
->glyph_row
;
8535 it
->glyph_row
= NULL
;
8537 /* Use wrap_it to save a copy of IT wherever a word wrap could
8538 occur. Use atpos_it to save a copy of IT at the desired buffer
8539 position, if found, so that we can scan ahead and check if the
8540 word later overshoots the window edge. Use atx_it similarly, for
8546 /* Use ppos_it under bidi reordering to save a copy of IT for the
8547 initial position. We restore that position in IT when we have
8548 scanned the entire display line without finding a match for
8549 TO_CHARPOS and all the character positions are greater than
8550 TO_CHARPOS. We then restart the scan from the initial position,
8551 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8552 the closest to TO_CHARPOS. */
8555 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8557 SAVE_IT (ppos_it
, *it
, ppos_data
);
8558 closest_pos
= IT_CHARPOS (*it
);
8564 #define BUFFER_POS_REACHED_P() \
8565 ((op & MOVE_TO_POS) != 0 \
8566 && BUFFERP (it->object) \
8567 && (IT_CHARPOS (*it) == to_charpos \
8569 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8570 && IT_CHARPOS (*it) > to_charpos) \
8571 || (it->what == IT_COMPOSITION \
8572 && ((IT_CHARPOS (*it) > to_charpos \
8573 && to_charpos >= it->cmp_it.charpos) \
8574 || (IT_CHARPOS (*it) < to_charpos \
8575 && to_charpos <= it->cmp_it.charpos)))) \
8576 && (it->method == GET_FROM_BUFFER \
8577 || (it->method == GET_FROM_DISPLAY_VECTOR \
8578 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8580 /* If there's a line-/wrap-prefix, handle it. */
8581 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8582 && it
->current_y
< it
->last_visible_y
)
8583 handle_line_prefix (it
);
8585 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8586 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8590 int x
, i
, ascent
= 0, descent
= 0;
8592 /* Utility macro to reset an iterator with x, ascent, and descent. */
8593 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8594 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8595 (IT)->max_descent = descent)
8597 /* Stop if we move beyond TO_CHARPOS (after an image or a
8598 display string or stretch glyph). */
8599 if ((op
& MOVE_TO_POS
) != 0
8600 && BUFFERP (it
->object
)
8601 && it
->method
== GET_FROM_BUFFER
8603 /* When the iterator is at base embedding level, we
8604 are guaranteed that characters are delivered for
8605 display in strictly increasing order of their
8606 buffer positions. */
8607 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8608 && IT_CHARPOS (*it
) > to_charpos
)
8610 && (prev_method
== GET_FROM_IMAGE
8611 || prev_method
== GET_FROM_STRETCH
8612 || prev_method
== GET_FROM_STRING
)
8613 /* Passed TO_CHARPOS from left to right. */
8614 && ((prev_pos
< to_charpos
8615 && IT_CHARPOS (*it
) > to_charpos
)
8616 /* Passed TO_CHARPOS from right to left. */
8617 || (prev_pos
> to_charpos
8618 && IT_CHARPOS (*it
) < to_charpos
)))))
8620 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8622 result
= MOVE_POS_MATCH_OR_ZV
;
8625 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8626 /* If wrap_it is valid, the current position might be in a
8627 word that is wrapped. So, save the iterator in
8628 atpos_it and continue to see if wrapping happens. */
8629 SAVE_IT (atpos_it
, *it
, atpos_data
);
8632 /* Stop when ZV reached.
8633 We used to stop here when TO_CHARPOS reached as well, but that is
8634 too soon if this glyph does not fit on this line. So we handle it
8635 explicitly below. */
8636 if (!get_next_display_element (it
))
8638 result
= MOVE_POS_MATCH_OR_ZV
;
8642 if (it
->line_wrap
== TRUNCATE
)
8644 if (BUFFER_POS_REACHED_P ())
8646 result
= MOVE_POS_MATCH_OR_ZV
;
8652 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8654 if (IT_DISPLAYING_WHITESPACE (it
))
8658 /* We have reached a glyph that follows one or more
8659 whitespace characters. If the position is
8660 already found, we are done. */
8661 if (atpos_it
.sp
>= 0)
8663 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8664 result
= MOVE_POS_MATCH_OR_ZV
;
8669 RESTORE_IT (it
, &atx_it
, atx_data
);
8670 result
= MOVE_X_REACHED
;
8673 /* Otherwise, we can wrap here. */
8674 SAVE_IT (wrap_it
, *it
, wrap_data
);
8680 /* Remember the line height for the current line, in case
8681 the next element doesn't fit on the line. */
8682 ascent
= it
->max_ascent
;
8683 descent
= it
->max_descent
;
8685 /* The call to produce_glyphs will get the metrics of the
8686 display element IT is loaded with. Record the x-position
8687 before this display element, in case it doesn't fit on the
8691 PRODUCE_GLYPHS (it
);
8693 if (it
->area
!= TEXT_AREA
)
8695 prev_method
= it
->method
;
8696 if (it
->method
== GET_FROM_BUFFER
)
8697 prev_pos
= IT_CHARPOS (*it
);
8698 set_iterator_to_next (it
, 1);
8699 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8700 SET_TEXT_POS (this_line_min_pos
,
8701 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8703 && (op
& MOVE_TO_POS
)
8704 && IT_CHARPOS (*it
) > to_charpos
8705 && IT_CHARPOS (*it
) < closest_pos
)
8706 closest_pos
= IT_CHARPOS (*it
);
8710 /* The number of glyphs we get back in IT->nglyphs will normally
8711 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8712 character on a terminal frame, or (iii) a line end. For the
8713 second case, IT->nglyphs - 1 padding glyphs will be present.
8714 (On X frames, there is only one glyph produced for a
8715 composite character.)
8717 The behavior implemented below means, for continuation lines,
8718 that as many spaces of a TAB as fit on the current line are
8719 displayed there. For terminal frames, as many glyphs of a
8720 multi-glyph character are displayed in the current line, too.
8721 This is what the old redisplay code did, and we keep it that
8722 way. Under X, the whole shape of a complex character must
8723 fit on the line or it will be completely displayed in the
8726 Note that both for tabs and padding glyphs, all glyphs have
8730 /* More than one glyph or glyph doesn't fit on line. All
8731 glyphs have the same width. */
8732 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8734 int x_before_this_char
= x
;
8735 int hpos_before_this_char
= it
->hpos
;
8737 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8739 new_x
= x
+ single_glyph_width
;
8741 /* We want to leave anything reaching TO_X to the caller. */
8742 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8744 if (BUFFER_POS_REACHED_P ())
8746 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8747 goto buffer_pos_reached
;
8748 if (atpos_it
.sp
< 0)
8750 SAVE_IT (atpos_it
, *it
, atpos_data
);
8751 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8756 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8759 result
= MOVE_X_REACHED
;
8764 SAVE_IT (atx_it
, *it
, atx_data
);
8765 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8770 if (/* Lines are continued. */
8771 it
->line_wrap
!= TRUNCATE
8772 && (/* And glyph doesn't fit on the line. */
8773 new_x
> it
->last_visible_x
8774 /* Or it fits exactly and we're on a window
8776 || (new_x
== it
->last_visible_x
8777 && FRAME_WINDOW_P (it
->f
)
8778 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8779 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8780 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8782 if (/* IT->hpos == 0 means the very first glyph
8783 doesn't fit on the line, e.g. a wide image. */
8785 || (new_x
== it
->last_visible_x
8786 && FRAME_WINDOW_P (it
->f
)))
8789 it
->current_x
= new_x
;
8791 /* The character's last glyph just barely fits
8793 if (i
== it
->nglyphs
- 1)
8795 /* If this is the destination position,
8796 return a position *before* it in this row,
8797 now that we know it fits in this row. */
8798 if (BUFFER_POS_REACHED_P ())
8800 if (it
->line_wrap
!= WORD_WRAP
8803 it
->hpos
= hpos_before_this_char
;
8804 it
->current_x
= x_before_this_char
;
8805 result
= MOVE_POS_MATCH_OR_ZV
;
8808 if (it
->line_wrap
== WORD_WRAP
8811 SAVE_IT (atpos_it
, *it
, atpos_data
);
8812 atpos_it
.current_x
= x_before_this_char
;
8813 atpos_it
.hpos
= hpos_before_this_char
;
8817 prev_method
= it
->method
;
8818 if (it
->method
== GET_FROM_BUFFER
)
8819 prev_pos
= IT_CHARPOS (*it
);
8820 set_iterator_to_next (it
, 1);
8821 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8822 SET_TEXT_POS (this_line_min_pos
,
8823 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8824 /* On graphical terminals, newlines may
8825 "overflow" into the fringe if
8826 overflow-newline-into-fringe is non-nil.
8827 On text terminals, and on graphical
8828 terminals with no right margin, newlines
8829 may overflow into the last glyph on the
8831 if (!FRAME_WINDOW_P (it
->f
)
8833 && it
->bidi_it
.paragraph_dir
== R2L
)
8834 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8835 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8836 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8838 if (!get_next_display_element (it
))
8840 result
= MOVE_POS_MATCH_OR_ZV
;
8843 if (BUFFER_POS_REACHED_P ())
8845 if (ITERATOR_AT_END_OF_LINE_P (it
))
8846 result
= MOVE_POS_MATCH_OR_ZV
;
8848 result
= MOVE_LINE_CONTINUED
;
8851 if (ITERATOR_AT_END_OF_LINE_P (it
)
8852 && (it
->line_wrap
!= WORD_WRAP
8854 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8856 result
= MOVE_NEWLINE_OR_CR
;
8863 IT_RESET_X_ASCENT_DESCENT (it
);
8865 if (wrap_it
.sp
>= 0)
8867 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8872 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8874 result
= MOVE_LINE_CONTINUED
;
8878 if (BUFFER_POS_REACHED_P ())
8880 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8881 goto buffer_pos_reached
;
8882 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8884 SAVE_IT (atpos_it
, *it
, atpos_data
);
8885 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8889 if (new_x
> it
->first_visible_x
)
8891 /* Glyph is visible. Increment number of glyphs that
8892 would be displayed. */
8897 if (result
!= MOVE_UNDEFINED
)
8900 else if (BUFFER_POS_REACHED_P ())
8903 IT_RESET_X_ASCENT_DESCENT (it
);
8904 result
= MOVE_POS_MATCH_OR_ZV
;
8907 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8909 /* Stop when TO_X specified and reached. This check is
8910 necessary here because of lines consisting of a line end,
8911 only. The line end will not produce any glyphs and we
8912 would never get MOVE_X_REACHED. */
8913 eassert (it
->nglyphs
== 0);
8914 result
= MOVE_X_REACHED
;
8918 /* Is this a line end? If yes, we're done. */
8919 if (ITERATOR_AT_END_OF_LINE_P (it
))
8921 /* If we are past TO_CHARPOS, but never saw any character
8922 positions smaller than TO_CHARPOS, return
8923 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8925 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8927 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8929 if (closest_pos
< ZV
)
8931 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8932 /* Don't recurse if closest_pos is equal to
8933 to_charpos, since we have just tried that. */
8934 if (closest_pos
!= to_charpos
)
8935 move_it_in_display_line_to (it
, closest_pos
, -1,
8937 result
= MOVE_POS_MATCH_OR_ZV
;
8940 goto buffer_pos_reached
;
8942 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8943 && IT_CHARPOS (*it
) > to_charpos
)
8944 goto buffer_pos_reached
;
8946 result
= MOVE_NEWLINE_OR_CR
;
8949 result
= MOVE_NEWLINE_OR_CR
;
8953 prev_method
= it
->method
;
8954 if (it
->method
== GET_FROM_BUFFER
)
8955 prev_pos
= IT_CHARPOS (*it
);
8956 /* The current display element has been consumed. Advance
8958 set_iterator_to_next (it
, 1);
8959 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8960 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8961 if (IT_CHARPOS (*it
) < to_charpos
)
8962 saw_smaller_pos
= 1;
8964 && (op
& MOVE_TO_POS
)
8965 && IT_CHARPOS (*it
) >= to_charpos
8966 && IT_CHARPOS (*it
) < closest_pos
)
8967 closest_pos
= IT_CHARPOS (*it
);
8969 /* Stop if lines are truncated and IT's current x-position is
8970 past the right edge of the window now. */
8971 if (it
->line_wrap
== TRUNCATE
8972 && it
->current_x
>= it
->last_visible_x
)
8974 if (!FRAME_WINDOW_P (it
->f
)
8975 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8976 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8977 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8978 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8982 if ((at_eob_p
= !get_next_display_element (it
))
8983 || BUFFER_POS_REACHED_P ()
8984 /* If we are past TO_CHARPOS, but never saw any
8985 character positions smaller than TO_CHARPOS,
8986 return MOVE_POS_MATCH_OR_ZV, like the
8987 unidirectional display did. */
8988 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8990 && IT_CHARPOS (*it
) > to_charpos
))
8993 && !BUFFER_POS_REACHED_P ()
8994 && !at_eob_p
&& closest_pos
< ZV
)
8996 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8997 if (closest_pos
!= to_charpos
)
8998 move_it_in_display_line_to (it
, closest_pos
, -1,
9001 result
= MOVE_POS_MATCH_OR_ZV
;
9004 if (ITERATOR_AT_END_OF_LINE_P (it
))
9006 result
= MOVE_NEWLINE_OR_CR
;
9010 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
9012 && IT_CHARPOS (*it
) > to_charpos
)
9014 if (closest_pos
< ZV
)
9016 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9017 if (closest_pos
!= to_charpos
)
9018 move_it_in_display_line_to (it
, closest_pos
, -1,
9021 result
= MOVE_POS_MATCH_OR_ZV
;
9024 result
= MOVE_LINE_TRUNCATED
;
9027 #undef IT_RESET_X_ASCENT_DESCENT
9030 #undef BUFFER_POS_REACHED_P
9032 /* If we scanned beyond to_pos and didn't find a point to wrap at,
9033 restore the saved iterator. */
9034 if (atpos_it
.sp
>= 0)
9035 RESTORE_IT (it
, &atpos_it
, atpos_data
);
9036 else if (atx_it
.sp
>= 0)
9037 RESTORE_IT (it
, &atx_it
, atx_data
);
9042 bidi_unshelve_cache (atpos_data
, 1);
9044 bidi_unshelve_cache (atx_data
, 1);
9046 bidi_unshelve_cache (wrap_data
, 1);
9048 bidi_unshelve_cache (ppos_data
, 1);
9050 /* Restore the iterator settings altered at the beginning of this
9052 it
->glyph_row
= saved_glyph_row
;
9056 /* For external use. */
9058 move_it_in_display_line (struct it
*it
,
9059 ptrdiff_t to_charpos
, int to_x
,
9060 enum move_operation_enum op
)
9062 if (it
->line_wrap
== WORD_WRAP
9063 && (op
& MOVE_TO_X
))
9066 void *save_data
= NULL
;
9069 SAVE_IT (save_it
, *it
, save_data
);
9070 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9071 /* When word-wrap is on, TO_X may lie past the end
9072 of a wrapped line. Then it->current is the
9073 character on the next line, so backtrack to the
9074 space before the wrap point. */
9075 if (skip
== MOVE_LINE_CONTINUED
)
9077 int prev_x
= max (it
->current_x
- 1, 0);
9078 RESTORE_IT (it
, &save_it
, save_data
);
9079 move_it_in_display_line_to
9080 (it
, -1, prev_x
, MOVE_TO_X
);
9083 bidi_unshelve_cache (save_data
, 1);
9086 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9090 /* Move IT forward until it satisfies one or more of the criteria in
9091 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9093 OP is a bit-mask that specifies where to stop, and in particular,
9094 which of those four position arguments makes a difference. See the
9095 description of enum move_operation_enum.
9097 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9098 screen line, this function will set IT to the next position that is
9099 displayed to the right of TO_CHARPOS on the screen.
9101 Return the maximum pixel length of any line scanned but never more
9102 than it.last_visible_x. */
9105 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9107 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9108 int line_height
, line_start_x
= 0, reached
= 0;
9109 int max_current_x
= 0;
9110 void *backup_data
= NULL
;
9114 if (op
& MOVE_TO_VPOS
)
9116 /* If no TO_CHARPOS and no TO_X specified, stop at the
9117 start of the line TO_VPOS. */
9118 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9120 if (it
->vpos
== to_vpos
)
9126 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9130 /* TO_VPOS >= 0 means stop at TO_X in the line at
9131 TO_VPOS, or at TO_POS, whichever comes first. */
9132 if (it
->vpos
== to_vpos
)
9138 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9140 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9145 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9147 /* We have reached TO_X but not in the line we want. */
9148 skip
= move_it_in_display_line_to (it
, to_charpos
,
9150 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9158 else if (op
& MOVE_TO_Y
)
9160 struct it it_backup
;
9162 if (it
->line_wrap
== WORD_WRAP
)
9163 SAVE_IT (it_backup
, *it
, backup_data
);
9165 /* TO_Y specified means stop at TO_X in the line containing
9166 TO_Y---or at TO_CHARPOS if this is reached first. The
9167 problem is that we can't really tell whether the line
9168 contains TO_Y before we have completely scanned it, and
9169 this may skip past TO_X. What we do is to first scan to
9172 If TO_X is not specified, use a TO_X of zero. The reason
9173 is to make the outcome of this function more predictable.
9174 If we didn't use TO_X == 0, we would stop at the end of
9175 the line which is probably not what a caller would expect
9177 skip
= move_it_in_display_line_to
9178 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9179 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9181 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9182 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9184 else if (skip
== MOVE_X_REACHED
)
9186 /* If TO_X was reached, we want to know whether TO_Y is
9187 in the line. We know this is the case if the already
9188 scanned glyphs make the line tall enough. Otherwise,
9189 we must check by scanning the rest of the line. */
9190 line_height
= it
->max_ascent
+ it
->max_descent
;
9191 if (to_y
>= it
->current_y
9192 && to_y
< it
->current_y
+ line_height
)
9197 SAVE_IT (it_backup
, *it
, backup_data
);
9198 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9199 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9201 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9202 line_height
= it
->max_ascent
+ it
->max_descent
;
9203 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9205 if (to_y
>= it
->current_y
9206 && to_y
< it
->current_y
+ line_height
)
9208 /* If TO_Y is in this line and TO_X was reached
9209 above, we scanned too far. We have to restore
9210 IT's settings to the ones before skipping. But
9211 keep the more accurate values of max_ascent and
9212 max_descent we've found while skipping the rest
9213 of the line, for the sake of callers, such as
9214 pos_visible_p, that need to know the line
9216 int max_ascent
= it
->max_ascent
;
9217 int max_descent
= it
->max_descent
;
9219 RESTORE_IT (it
, &it_backup
, backup_data
);
9220 it
->max_ascent
= max_ascent
;
9221 it
->max_descent
= max_descent
;
9227 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9233 /* Check whether TO_Y is in this line. */
9234 line_height
= it
->max_ascent
+ it
->max_descent
;
9235 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9237 if (to_y
>= it
->current_y
9238 && to_y
< it
->current_y
+ line_height
)
9240 if (to_y
> it
->current_y
)
9241 max_current_x
= max (it
->current_x
, max_current_x
);
9243 /* When word-wrap is on, TO_X may lie past the end
9244 of a wrapped line. Then it->current is the
9245 character on the next line, so backtrack to the
9246 space before the wrap point. */
9247 if (skip
== MOVE_LINE_CONTINUED
9248 && it
->line_wrap
== WORD_WRAP
)
9250 int prev_x
= max (it
->current_x
- 1, 0);
9251 RESTORE_IT (it
, &it_backup
, backup_data
);
9252 skip
= move_it_in_display_line_to
9253 (it
, -1, prev_x
, MOVE_TO_X
);
9262 max_current_x
= max (it
->current_x
, max_current_x
);
9266 else if (BUFFERP (it
->object
)
9267 && (it
->method
== GET_FROM_BUFFER
9268 || it
->method
== GET_FROM_STRETCH
)
9269 && IT_CHARPOS (*it
) >= to_charpos
9270 /* Under bidi iteration, a call to set_iterator_to_next
9271 can scan far beyond to_charpos if the initial
9272 portion of the next line needs to be reordered. In
9273 that case, give move_it_in_display_line_to another
9276 && it
->bidi_it
.scan_dir
== -1))
9277 skip
= MOVE_POS_MATCH_OR_ZV
;
9279 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9283 case MOVE_POS_MATCH_OR_ZV
:
9284 max_current_x
= max (it
->current_x
, max_current_x
);
9288 case MOVE_NEWLINE_OR_CR
:
9289 max_current_x
= max (it
->current_x
, max_current_x
);
9290 set_iterator_to_next (it
, 1);
9291 it
->continuation_lines_width
= 0;
9294 case MOVE_LINE_TRUNCATED
:
9295 max_current_x
= it
->last_visible_x
;
9296 it
->continuation_lines_width
= 0;
9297 reseat_at_next_visible_line_start (it
, 0);
9298 if ((op
& MOVE_TO_POS
) != 0
9299 && IT_CHARPOS (*it
) > to_charpos
)
9306 case MOVE_LINE_CONTINUED
:
9307 max_current_x
= it
->last_visible_x
;
9308 /* For continued lines ending in a tab, some of the glyphs
9309 associated with the tab are displayed on the current
9310 line. Since it->current_x does not include these glyphs,
9311 we use it->last_visible_x instead. */
9314 it
->continuation_lines_width
+= it
->last_visible_x
;
9315 /* When moving by vpos, ensure that the iterator really
9316 advances to the next line (bug#847, bug#969). Fixme:
9317 do we need to do this in other circumstances? */
9318 if (it
->current_x
!= it
->last_visible_x
9319 && (op
& MOVE_TO_VPOS
)
9320 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9322 line_start_x
= it
->current_x
+ it
->pixel_width
9323 - it
->last_visible_x
;
9324 if (FRAME_WINDOW_P (it
->f
))
9326 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9327 struct font
*face_font
= face
->font
;
9329 /* When display_line produces a continued line
9330 that ends in a TAB, it skips a tab stop that
9331 is closer than the font's space character
9332 width (see x_produce_glyphs where it produces
9333 the stretch glyph which represents a TAB).
9334 We need to reproduce the same logic here. */
9335 eassert (face_font
);
9338 if (line_start_x
< face_font
->space_width
)
9340 += it
->tab_width
* face_font
->space_width
;
9343 set_iterator_to_next (it
, 0);
9347 it
->continuation_lines_width
+= it
->current_x
;
9354 /* Reset/increment for the next run. */
9355 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9356 it
->current_x
= line_start_x
;
9359 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9361 last_height
= it
->max_ascent
+ it
->max_descent
;
9362 it
->max_ascent
= it
->max_descent
= 0;
9367 /* On text terminals, we may stop at the end of a line in the middle
9368 of a multi-character glyph. If the glyph itself is continued,
9369 i.e. it is actually displayed on the next line, don't treat this
9370 stopping point as valid; move to the next line instead (unless
9371 that brings us offscreen). */
9372 if (!FRAME_WINDOW_P (it
->f
)
9374 && IT_CHARPOS (*it
) == to_charpos
9375 && it
->what
== IT_CHARACTER
9377 && it
->line_wrap
== WINDOW_WRAP
9378 && it
->current_x
== it
->last_visible_x
- 1
9381 && it
->w
->window_end_valid
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_valid
15525 || w
->window_end_vpos
< w
->current_matrix
->nrows
);
15527 /* Handle case where text has not changed, only point, and it has
15528 not moved off the frame. */
15529 if (/* Point may be in this window. */
15530 PT
>= CHARPOS (startp
)
15531 /* Selective display hasn't changed. */
15532 && !current_buffer
->clip_changed
15533 /* Function force-mode-line-update is used to force a thorough
15534 redisplay. It sets either windows_or_buffers_changed or
15535 update_mode_lines. So don't take a shortcut here for these
15537 && !update_mode_lines
15538 && !windows_or_buffers_changed
15539 && !f
->cursor_type_changed
15540 && NILP (Vshow_trailing_whitespace
)
15541 /* This code is not used for mini-buffer for the sake of the case
15542 of redisplaying to replace an echo area message; since in
15543 that case the mini-buffer contents per se are usually
15544 unchanged. This code is of no real use in the mini-buffer
15545 since the handling of this_line_start_pos, etc., in redisplay
15546 handles the same cases. */
15547 && !EQ (window
, minibuf_window
)
15548 && (FRAME_WINDOW_P (f
)
15549 || !overlay_arrow_in_current_buffer_p ()))
15551 int this_scroll_margin
, top_scroll_margin
;
15552 struct glyph_row
*row
= NULL
;
15553 int frame_line_height
= default_line_pixel_height (w
);
15554 int window_total_lines
15555 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15558 debug_method_add (w
, "cursor movement");
15561 /* Scroll if point within this distance from the top or bottom
15562 of the window. This is a pixel value. */
15563 if (scroll_margin
> 0)
15565 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15566 this_scroll_margin
*= frame_line_height
;
15569 this_scroll_margin
= 0;
15571 top_scroll_margin
= this_scroll_margin
;
15572 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15573 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15575 /* Start with the row the cursor was displayed during the last
15576 not paused redisplay. Give up if that row is not valid. */
15577 if (w
->last_cursor_vpos
< 0
15578 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15579 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15582 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15583 if (row
->mode_line_p
)
15585 if (!row
->enabled_p
)
15586 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15589 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15591 int scroll_p
= 0, must_scroll
= 0;
15592 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15594 if (PT
> w
->last_point
)
15596 /* Point has moved forward. */
15597 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15598 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15600 eassert (row
->enabled_p
);
15604 /* If the end position of a row equals the start
15605 position of the next row, and PT is at that position,
15606 we would rather display cursor in the next line. */
15607 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15608 && MATRIX_ROW_END_CHARPOS (row
) == PT
15609 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15610 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15611 && !cursor_row_p (row
))
15614 /* If within the scroll margin, scroll. Note that
15615 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15616 the next line would be drawn, and that
15617 this_scroll_margin can be zero. */
15618 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15619 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15620 /* Line is completely visible last line in window
15621 and PT is to be set in the next line. */
15622 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15623 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15624 && !row
->ends_at_zv_p
15625 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15628 else if (PT
< w
->last_point
)
15630 /* Cursor has to be moved backward. Note that PT >=
15631 CHARPOS (startp) because of the outer if-statement. */
15632 while (!row
->mode_line_p
15633 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15634 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15635 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15636 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15637 row
> w
->current_matrix
->rows
15638 && (row
-1)->ends_in_newline_from_string_p
))))
15639 && (row
->y
> top_scroll_margin
15640 || CHARPOS (startp
) == BEGV
))
15642 eassert (row
->enabled_p
);
15646 /* Consider the following case: Window starts at BEGV,
15647 there is invisible, intangible text at BEGV, so that
15648 display starts at some point START > BEGV. It can
15649 happen that we are called with PT somewhere between
15650 BEGV and START. Try to handle that case. */
15651 if (row
< w
->current_matrix
->rows
15652 || row
->mode_line_p
)
15654 row
= w
->current_matrix
->rows
;
15655 if (row
->mode_line_p
)
15659 /* Due to newlines in overlay strings, we may have to
15660 skip forward over overlay strings. */
15661 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15662 && MATRIX_ROW_END_CHARPOS (row
) == PT
15663 && !cursor_row_p (row
))
15666 /* If within the scroll margin, scroll. */
15667 if (row
->y
< top_scroll_margin
15668 && CHARPOS (startp
) != BEGV
)
15673 /* Cursor did not move. So don't scroll even if cursor line
15674 is partially visible, as it was so before. */
15675 rc
= CURSOR_MOVEMENT_SUCCESS
;
15678 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15679 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15681 /* if PT is not in the glyph row, give up. */
15682 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15685 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15686 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15688 struct glyph_row
*row1
;
15690 /* If rows are bidi-reordered and point moved, back up
15691 until we find a row that does not belong to a
15692 continuation line. This is because we must consider
15693 all rows of a continued line as candidates for the
15694 new cursor positioning, since row start and end
15695 positions change non-linearly with vertical position
15697 /* FIXME: Revisit this when glyph ``spilling'' in
15698 continuation lines' rows is implemented for
15699 bidi-reordered rows. */
15700 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15701 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15704 /* If we hit the beginning of the displayed portion
15705 without finding the first row of a continued
15709 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15712 eassert (row
->enabled_p
);
15717 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15718 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15719 /* Make sure this isn't a header line by any chance, since
15720 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15721 && !row
->mode_line_p
15722 && make_cursor_line_fully_visible_p
)
15724 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15725 && !row
->ends_at_zv_p
15726 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15727 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15728 else if (row
->height
> window_box_height (w
))
15730 /* If we end up in a partially visible line, let's
15731 make it fully visible, except when it's taller
15732 than the window, in which case we can't do much
15735 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15739 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15740 if (!cursor_row_fully_visible_p (w
, 0, 1))
15741 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15743 rc
= CURSOR_MOVEMENT_SUCCESS
;
15747 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15748 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15749 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15751 /* With bidi-reordered rows, there could be more than
15752 one candidate row whose start and end positions
15753 occlude point. We need to let set_cursor_from_row
15754 find the best candidate. */
15755 /* FIXME: Revisit this when glyph ``spilling'' in
15756 continuation lines' rows is implemented for
15757 bidi-reordered rows. */
15762 int at_zv_p
= 0, exact_match_p
= 0;
15764 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15765 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15766 && cursor_row_p (row
))
15767 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15769 /* As soon as we've found the exact match for point,
15770 or the first suitable row whose ends_at_zv_p flag
15771 is set, we are done. */
15774 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15775 w
->cursor
.vpos
)->ends_at_zv_p
;
15777 && w
->cursor
.hpos
>= 0
15778 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15781 struct glyph_row
*candidate
=
15782 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15784 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15785 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15788 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15789 || (INTEGERP (g
->object
)
15790 && (g
->charpos
== PT
15791 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15793 if (at_zv_p
|| exact_match_p
)
15795 rc
= CURSOR_MOVEMENT_SUCCESS
;
15799 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15803 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15804 || row
->continued_p
)
15805 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15806 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15807 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15808 /* If we didn't find any candidate rows, or exited the
15809 loop before all the candidates were examined, signal
15810 to the caller that this method failed. */
15811 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15813 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15814 && !row
->continued_p
))
15815 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15817 rc
= CURSOR_MOVEMENT_SUCCESS
;
15823 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15825 rc
= CURSOR_MOVEMENT_SUCCESS
;
15830 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15831 && MATRIX_ROW_START_CHARPOS (row
) == PT
15832 && cursor_row_p (row
));
15840 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15844 set_vertical_scroll_bar (struct window
*w
)
15846 ptrdiff_t start
, end
, whole
;
15848 /* Calculate the start and end positions for the current window.
15849 At some point, it would be nice to choose between scrollbars
15850 which reflect the whole buffer size, with special markers
15851 indicating narrowing, and scrollbars which reflect only the
15854 Note that mini-buffers sometimes aren't displaying any text. */
15855 if (!MINI_WINDOW_P (w
)
15856 || (w
== XWINDOW (minibuf_window
)
15857 && NILP (echo_area_buffer
[0])))
15859 struct buffer
*buf
= XBUFFER (w
->contents
);
15860 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15861 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15862 /* I don't think this is guaranteed to be right. For the
15863 moment, we'll pretend it is. */
15864 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15868 if (whole
< (end
- start
))
15869 whole
= end
- start
;
15872 start
= end
= whole
= 0;
15874 /* Indicate what this scroll bar ought to be displaying now. */
15875 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15876 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15877 (w
, end
- start
, whole
, start
);
15881 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15882 selected_window is redisplayed.
15884 We can return without actually redisplaying the window if fonts has been
15885 changed on window's frame. In that case, redisplay_internal will retry.
15887 As one of the important parts of redisplaying a window, we need to
15888 decide whether the previous window-start position (stored in the
15889 window's w->start marker position) is still valid, and if it isn't,
15890 recompute it. Some details about that:
15892 . The previous window-start could be in a continuation line, in
15893 which case we need to recompute it when the window width
15894 changes. See compute_window_start_on_continuation_line and its
15897 . The text that changed since last redisplay could include the
15898 previous window-start position. In that case, we try to salvage
15899 what we can from the current glyph matrix by calling
15900 try_scrolling, which see.
15902 . Some Emacs command could force us to use a specific window-start
15903 position by setting the window's force_start flag, or gently
15904 propose doing that by setting the window's optional_new_start
15905 flag. In these cases, we try using the specified start point if
15906 that succeeds (i.e. the window desired matrix is successfully
15907 recomputed, and point location is within the window). In case
15908 of optional_new_start, we first check if the specified start
15909 position is feasible, i.e. if it will allow point to be
15910 displayed in the window. If using the specified start point
15911 fails, e.g., if new fonts are needed to be loaded, we abort the
15912 redisplay cycle and leave it up to the next cycle to figure out
15915 . Note that the window's force_start flag is sometimes set by
15916 redisplay itself, when it decides that the previous window start
15917 point is fine and should be kept. Search for "goto force_start"
15918 below to see the details. Like the values of window-start
15919 specified outside of redisplay, these internally-deduced values
15920 are tested for feasibility, and ignored if found to be
15923 . Note that the function try_window, used to completely redisplay
15924 a window, accepts the window's start point as its argument.
15925 This is used several times in the redisplay code to control
15926 where the window start will be, according to user options such
15927 as scroll-conservatively, and also to ensure the screen line
15928 showing point will be fully (as opposed to partially) visible on
15932 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15934 struct window
*w
= XWINDOW (window
);
15935 struct frame
*f
= XFRAME (w
->frame
);
15936 struct buffer
*buffer
= XBUFFER (w
->contents
);
15937 struct buffer
*old
= current_buffer
;
15938 struct text_pos lpoint
, opoint
, startp
;
15939 int update_mode_line
;
15942 /* Record it now because it's overwritten. */
15943 bool current_matrix_up_to_date_p
= false;
15944 bool used_current_matrix_p
= false;
15945 /* This is less strict than current_matrix_up_to_date_p.
15946 It indicates that the buffer contents and narrowing are unchanged. */
15947 bool buffer_unchanged_p
= false;
15948 int temp_scroll_step
= 0;
15949 ptrdiff_t count
= SPECPDL_INDEX ();
15951 int centering_position
= -1;
15952 int last_line_misfit
= 0;
15953 ptrdiff_t beg_unchanged
, end_unchanged
;
15954 int frame_line_height
;
15956 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15960 *w
->desired_matrix
->method
= 0;
15963 if (!just_this_one_p
15964 && REDISPLAY_SOME_P ()
15966 && !w
->update_mode_line
15968 && !buffer
->text
->redisplay
15969 && BUF_PT (buffer
) == w
->last_point
)
15972 /* Make sure that both W's markers are valid. */
15973 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15974 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15976 /* We come here again if we need to run window-text-change-functions
15979 reconsider_clip_changes (w
);
15980 frame_line_height
= default_line_pixel_height (w
);
15982 /* Has the mode line to be updated? */
15983 update_mode_line
= (w
->update_mode_line
15984 || update_mode_lines
15985 || buffer
->clip_changed
15986 || buffer
->prevent_redisplay_optimizations_p
);
15988 if (!just_this_one_p
)
15989 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15990 cleverly elsewhere. */
15991 w
->must_be_updated_p
= true;
15993 if (MINI_WINDOW_P (w
))
15995 if (w
== XWINDOW (echo_area_window
)
15996 && !NILP (echo_area_buffer
[0]))
15998 if (update_mode_line
)
15999 /* We may have to update a tty frame's menu bar or a
16000 tool-bar. Example `M-x C-h C-h C-g'. */
16001 goto finish_menu_bars
;
16003 /* We've already displayed the echo area glyphs in this window. */
16004 goto finish_scroll_bars
;
16006 else if ((w
!= XWINDOW (minibuf_window
)
16007 || minibuf_level
== 0)
16008 /* When buffer is nonempty, redisplay window normally. */
16009 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
16010 /* Quail displays non-mini buffers in minibuffer window.
16011 In that case, redisplay the window normally. */
16012 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
16014 /* W is a mini-buffer window, but it's not active, so clear
16016 int yb
= window_text_bottom_y (w
);
16017 struct glyph_row
*row
;
16020 for (y
= 0, row
= w
->desired_matrix
->rows
;
16022 y
+= row
->height
, ++row
)
16023 blank_row (w
, row
, y
);
16024 goto finish_scroll_bars
;
16027 clear_glyph_matrix (w
->desired_matrix
);
16030 /* Otherwise set up data on this window; select its buffer and point
16032 /* Really select the buffer, for the sake of buffer-local
16034 set_buffer_internal_1 (XBUFFER (w
->contents
));
16036 current_matrix_up_to_date_p
16037 = (w
->window_end_valid
16038 && !current_buffer
->clip_changed
16039 && !current_buffer
->prevent_redisplay_optimizations_p
16040 && !window_outdated (w
));
16042 /* Run the window-text-change-functions
16043 if it is possible that the text on the screen has changed
16044 (either due to modification of the text, or any other reason). */
16045 if (!current_matrix_up_to_date_p
16046 && !NILP (Vwindow_text_change_functions
))
16048 safe_run_hooks (Qwindow_text_change_functions
);
16052 beg_unchanged
= BEG_UNCHANGED
;
16053 end_unchanged
= END_UNCHANGED
;
16055 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16057 specbind (Qinhibit_point_motion_hooks
, Qt
);
16060 = (w
->window_end_valid
16061 && !current_buffer
->clip_changed
16062 && !window_outdated (w
));
16064 /* When windows_or_buffers_changed is non-zero, we can't rely
16065 on the window end being valid, so set it to zero there. */
16066 if (windows_or_buffers_changed
)
16068 /* If window starts on a continuation line, maybe adjust the
16069 window start in case the window's width changed. */
16070 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16071 compute_window_start_on_continuation_line (w
);
16073 w
->window_end_valid
= false;
16074 /* If so, we also can't rely on current matrix
16075 and should not fool try_cursor_movement below. */
16076 current_matrix_up_to_date_p
= false;
16079 /* Some sanity checks. */
16080 CHECK_WINDOW_END (w
);
16081 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16083 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16086 if (mode_line_update_needed (w
))
16087 update_mode_line
= 1;
16089 /* Point refers normally to the selected window. For any other
16090 window, set up appropriate value. */
16091 if (!EQ (window
, selected_window
))
16093 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16094 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16098 new_pt_byte
= BEGV_BYTE
;
16099 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16101 else if (new_pt
> (ZV
- 1))
16104 new_pt_byte
= ZV_BYTE
;
16105 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16108 /* We don't use SET_PT so that the point-motion hooks don't run. */
16109 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16112 /* If any of the character widths specified in the display table
16113 have changed, invalidate the width run cache. It's true that
16114 this may be a bit late to catch such changes, but the rest of
16115 redisplay goes (non-fatally) haywire when the display table is
16116 changed, so why should we worry about doing any better? */
16117 if (current_buffer
->width_run_cache
16118 || (current_buffer
->base_buffer
16119 && current_buffer
->base_buffer
->width_run_cache
))
16121 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16123 if (! disptab_matches_widthtab
16124 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16126 struct buffer
*buf
= current_buffer
;
16128 if (buf
->base_buffer
)
16129 buf
= buf
->base_buffer
;
16130 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16131 recompute_width_table (current_buffer
, disptab
);
16135 /* If window-start is screwed up, choose a new one. */
16136 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16139 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16141 /* If someone specified a new starting point but did not insist,
16142 check whether it can be used. */
16143 if ((w
->optional_new_start
|| window_frozen_p (w
))
16144 && CHARPOS (startp
) >= BEGV
16145 && CHARPOS (startp
) <= ZV
)
16147 ptrdiff_t it_charpos
;
16149 w
->optional_new_start
= 0;
16150 start_display (&it
, w
, startp
);
16151 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16152 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16153 /* Record IT's position now, since line_bottom_y might change
16155 it_charpos
= IT_CHARPOS (it
);
16156 /* Make sure we set the force_start flag only if the cursor row
16157 will be fully visible. Otherwise, the code under force_start
16158 label below will try to move point back into view, which is
16159 not what the code which sets optional_new_start wants. */
16160 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16161 && !w
->force_start
)
16163 if (it_charpos
== PT
)
16164 w
->force_start
= 1;
16165 /* IT may overshoot PT if text at PT is invisible. */
16166 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16167 w
->force_start
= 1;
16169 if (w
->force_start
)
16171 if (window_frozen_p (w
))
16172 debug_method_add (w
, "set force_start from frozen window start");
16174 debug_method_add (w
, "set force_start from optional_new_start");
16182 /* Handle case where place to start displaying has been specified,
16183 unless the specified location is outside the accessible range. */
16184 if (w
->force_start
)
16186 /* We set this later on if we have to adjust point. */
16189 w
->force_start
= 0;
16191 w
->window_end_valid
= 0;
16193 /* Forget any recorded base line for line number display. */
16194 if (!buffer_unchanged_p
)
16195 w
->base_line_number
= 0;
16197 /* Redisplay the mode line. Select the buffer properly for that.
16198 Also, run the hook window-scroll-functions
16199 because we have scrolled. */
16200 /* Note, we do this after clearing force_start because
16201 if there's an error, it is better to forget about force_start
16202 than to get into an infinite loop calling the hook functions
16203 and having them get more errors. */
16204 if (!update_mode_line
16205 || ! NILP (Vwindow_scroll_functions
))
16207 update_mode_line
= 1;
16208 w
->update_mode_line
= 1;
16209 startp
= run_window_scroll_functions (window
, startp
);
16212 if (CHARPOS (startp
) < BEGV
)
16213 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16214 else if (CHARPOS (startp
) > ZV
)
16215 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16217 /* Redisplay, then check if cursor has been set during the
16218 redisplay. Give up if new fonts were loaded. */
16219 /* We used to issue a CHECK_MARGINS argument to try_window here,
16220 but this causes scrolling to fail when point begins inside
16221 the scroll margin (bug#148) -- cyd */
16222 if (!try_window (window
, startp
, 0))
16224 w
->force_start
= 1;
16225 clear_glyph_matrix (w
->desired_matrix
);
16226 goto need_larger_matrices
;
16229 if (w
->cursor
.vpos
< 0)
16231 /* If point does not appear, try to move point so it does
16232 appear. The desired matrix has been built above, so we
16233 can use it here. */
16234 new_vpos
= window_box_height (w
) / 2;
16237 if (!cursor_row_fully_visible_p (w
, 0, 0))
16239 /* Point does appear, but on a line partly visible at end of window.
16240 Move it back to a fully-visible line. */
16241 new_vpos
= window_box_height (w
);
16242 /* But if window_box_height suggests a Y coordinate that is
16243 not less than we already have, that line will clearly not
16244 be fully visible, so give up and scroll the display.
16245 This can happen when the default face uses a font whose
16246 dimensions are different from the frame's default
16248 if (new_vpos
>= w
->cursor
.y
)
16250 w
->cursor
.vpos
= -1;
16251 clear_glyph_matrix (w
->desired_matrix
);
16252 goto try_to_scroll
;
16255 else if (w
->cursor
.vpos
>= 0)
16257 /* Some people insist on not letting point enter the scroll
16258 margin, even though this part handles windows that didn't
16260 int window_total_lines
16261 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16262 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16263 int pixel_margin
= margin
* frame_line_height
;
16264 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16266 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16267 below, which finds the row to move point to, advances by
16268 the Y coordinate of the _next_ row, see the definition of
16269 MATRIX_ROW_BOTTOM_Y. */
16270 if (w
->cursor
.vpos
< margin
+ header_line
)
16272 w
->cursor
.vpos
= -1;
16273 clear_glyph_matrix (w
->desired_matrix
);
16274 goto try_to_scroll
;
16278 int window_height
= window_box_height (w
);
16281 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16282 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16284 w
->cursor
.vpos
= -1;
16285 clear_glyph_matrix (w
->desired_matrix
);
16286 goto try_to_scroll
;
16291 /* If we need to move point for either of the above reasons,
16292 now actually do it. */
16295 struct glyph_row
*row
;
16297 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16298 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16301 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16302 MATRIX_ROW_START_BYTEPOS (row
));
16304 if (w
!= XWINDOW (selected_window
))
16305 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16306 else if (current_buffer
== old
)
16307 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16309 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16311 /* Re-run pre-redisplay-function so it can update the region
16312 according to the new position of point. */
16313 /* Other than the cursor, w's redisplay is done so we can set its
16314 redisplay to false. Also the buffer's redisplay can be set to
16315 false, since propagate_buffer_redisplay should have already
16316 propagated its info to `w' anyway. */
16317 w
->redisplay
= false;
16318 XBUFFER (w
->contents
)->text
->redisplay
= false;
16319 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16321 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16323 /* pre-redisplay-function made changes (e.g. move the region)
16324 that require another round of redisplay. */
16325 clear_glyph_matrix (w
->desired_matrix
);
16326 if (!try_window (window
, startp
, 0))
16327 goto need_larger_matrices
;
16330 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, 0, 0))
16332 clear_glyph_matrix (w
->desired_matrix
);
16333 goto try_to_scroll
;
16337 debug_method_add (w
, "forced window start");
16342 /* Handle case where text has not changed, only point, and it has
16343 not moved off the frame, and we are not retrying after hscroll.
16344 (current_matrix_up_to_date_p is nonzero when retrying.) */
16345 if (current_matrix_up_to_date_p
16346 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16347 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16351 case CURSOR_MOVEMENT_SUCCESS
:
16352 used_current_matrix_p
= 1;
16355 case CURSOR_MOVEMENT_MUST_SCROLL
:
16356 goto try_to_scroll
;
16362 /* If current starting point was originally the beginning of a line
16363 but no longer is, find a new starting point. */
16364 else if (w
->start_at_line_beg
16365 && !(CHARPOS (startp
) <= BEGV
16366 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16369 debug_method_add (w
, "recenter 1");
16374 /* Try scrolling with try_window_id. Value is > 0 if update has
16375 been done, it is -1 if we know that the same window start will
16376 not work. It is 0 if unsuccessful for some other reason. */
16377 else if ((tem
= try_window_id (w
)) != 0)
16380 debug_method_add (w
, "try_window_id %d", tem
);
16383 if (f
->fonts_changed
)
16384 goto need_larger_matrices
;
16388 /* Otherwise try_window_id has returned -1 which means that we
16389 don't want the alternative below this comment to execute. */
16391 else if (CHARPOS (startp
) >= BEGV
16392 && CHARPOS (startp
) <= ZV
16393 && PT
>= CHARPOS (startp
)
16394 && (CHARPOS (startp
) < ZV
16395 /* Avoid starting at end of buffer. */
16396 || CHARPOS (startp
) == BEGV
16397 || !window_outdated (w
)))
16399 int d1
, d2
, d5
, d6
;
16402 /* If first window line is a continuation line, and window start
16403 is inside the modified region, but the first change is before
16404 current window start, we must select a new window start.
16406 However, if this is the result of a down-mouse event (e.g. by
16407 extending the mouse-drag-overlay), we don't want to select a
16408 new window start, since that would change the position under
16409 the mouse, resulting in an unwanted mouse-movement rather
16410 than a simple mouse-click. */
16411 if (!w
->start_at_line_beg
16412 && NILP (do_mouse_tracking
)
16413 && CHARPOS (startp
) > BEGV
16414 && CHARPOS (startp
) > BEG
+ beg_unchanged
16415 && CHARPOS (startp
) <= Z
- end_unchanged
16416 /* Even if w->start_at_line_beg is nil, a new window may
16417 start at a line_beg, since that's how set_buffer_window
16418 sets it. So, we need to check the return value of
16419 compute_window_start_on_continuation_line. (See also
16421 && XMARKER (w
->start
)->buffer
== current_buffer
16422 && compute_window_start_on_continuation_line (w
)
16423 /* It doesn't make sense to force the window start like we
16424 do at label force_start if it is already known that point
16425 will not be fully visible in the resulting window, because
16426 doing so will move point from its correct position
16427 instead of scrolling the window to bring point into view.
16429 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16430 /* A very tall row could need more than the window height,
16431 in which case we accept that it is partially visible. */
16432 && (rtop
!= 0) == (rbot
!= 0))
16434 w
->force_start
= 1;
16435 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16437 debug_method_add (w
, "recomputed window start in continuation line");
16443 debug_method_add (w
, "same window start");
16446 /* Try to redisplay starting at same place as before.
16447 If point has not moved off frame, accept the results. */
16448 if (!current_matrix_up_to_date_p
16449 /* Don't use try_window_reusing_current_matrix in this case
16450 because a window scroll function can have changed the
16452 || !NILP (Vwindow_scroll_functions
)
16453 || MINI_WINDOW_P (w
)
16454 || !(used_current_matrix_p
16455 = try_window_reusing_current_matrix (w
)))
16457 IF_DEBUG (debug_method_add (w
, "1"));
16458 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16459 /* -1 means we need to scroll.
16460 0 means we need new matrices, but fonts_changed
16461 is set in that case, so we will detect it below. */
16462 goto try_to_scroll
;
16465 if (f
->fonts_changed
)
16466 goto need_larger_matrices
;
16468 if (w
->cursor
.vpos
>= 0)
16470 if (!just_this_one_p
16471 || current_buffer
->clip_changed
16472 || BEG_UNCHANGED
< CHARPOS (startp
))
16473 /* Forget any recorded base line for line number display. */
16474 w
->base_line_number
= 0;
16476 if (!cursor_row_fully_visible_p (w
, 1, 0))
16478 clear_glyph_matrix (w
->desired_matrix
);
16479 last_line_misfit
= 1;
16481 /* Drop through and scroll. */
16486 clear_glyph_matrix (w
->desired_matrix
);
16491 /* Redisplay the mode line. Select the buffer properly for that. */
16492 if (!update_mode_line
)
16494 update_mode_line
= 1;
16495 w
->update_mode_line
= 1;
16498 /* Try to scroll by specified few lines. */
16499 if ((scroll_conservatively
16500 || emacs_scroll_step
16501 || temp_scroll_step
16502 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16503 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16504 && CHARPOS (startp
) >= BEGV
16505 && CHARPOS (startp
) <= ZV
)
16507 /* The function returns -1 if new fonts were loaded, 1 if
16508 successful, 0 if not successful. */
16509 int ss
= try_scrolling (window
, just_this_one_p
,
16510 scroll_conservatively
,
16512 temp_scroll_step
, last_line_misfit
);
16515 case SCROLLING_SUCCESS
:
16518 case SCROLLING_NEED_LARGER_MATRICES
:
16519 goto need_larger_matrices
;
16521 case SCROLLING_FAILED
:
16529 /* Finally, just choose a place to start which positions point
16530 according to user preferences. */
16535 debug_method_add (w
, "recenter");
16538 /* Forget any previously recorded base line for line number display. */
16539 if (!buffer_unchanged_p
)
16540 w
->base_line_number
= 0;
16542 /* Determine the window start relative to point. */
16543 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16544 it
.current_y
= it
.last_visible_y
;
16545 if (centering_position
< 0)
16547 int window_total_lines
16548 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16551 ? min (scroll_margin
, window_total_lines
/ 4)
16553 ptrdiff_t margin_pos
= CHARPOS (startp
);
16554 Lisp_Object aggressive
;
16557 /* If there is a scroll margin at the top of the window, find
16558 its character position. */
16560 /* Cannot call start_display if startp is not in the
16561 accessible region of the buffer. This can happen when we
16562 have just switched to a different buffer and/or changed
16563 its restriction. In that case, startp is initialized to
16564 the character position 1 (BEGV) because we did not yet
16565 have chance to display the buffer even once. */
16566 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16569 void *it1data
= NULL
;
16571 SAVE_IT (it1
, it
, it1data
);
16572 start_display (&it1
, w
, startp
);
16573 move_it_vertically (&it1
, margin
* frame_line_height
);
16574 margin_pos
= IT_CHARPOS (it1
);
16575 RESTORE_IT (&it
, &it
, it1data
);
16577 scrolling_up
= PT
> margin_pos
;
16580 ? BVAR (current_buffer
, scroll_up_aggressively
)
16581 : BVAR (current_buffer
, scroll_down_aggressively
);
16583 if (!MINI_WINDOW_P (w
)
16584 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16588 /* Setting scroll-conservatively overrides
16589 scroll-*-aggressively. */
16590 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16592 double float_amount
= XFLOATINT (aggressive
);
16594 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16595 if (pt_offset
== 0 && float_amount
> 0)
16597 if (pt_offset
&& margin
> 0)
16600 /* Compute how much to move the window start backward from
16601 point so that point will be displayed where the user
16605 centering_position
= it
.last_visible_y
;
16607 centering_position
-= pt_offset
;
16608 centering_position
-=
16609 frame_line_height
* (1 + margin
+ (last_line_misfit
!= 0))
16610 + WINDOW_HEADER_LINE_HEIGHT (w
);
16611 /* Don't let point enter the scroll margin near top of
16613 if (centering_position
< margin
* frame_line_height
)
16614 centering_position
= margin
* frame_line_height
;
16617 centering_position
= margin
* frame_line_height
+ pt_offset
;
16620 /* Set the window start half the height of the window backward
16622 centering_position
= window_box_height (w
) / 2;
16624 move_it_vertically_backward (&it
, centering_position
);
16626 eassert (IT_CHARPOS (it
) >= BEGV
);
16628 /* The function move_it_vertically_backward may move over more
16629 than the specified y-distance. If it->w is small, e.g. a
16630 mini-buffer window, we may end up in front of the window's
16631 display area. Start displaying at the start of the line
16632 containing PT in this case. */
16633 if (it
.current_y
<= 0)
16635 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16636 move_it_vertically_backward (&it
, 0);
16640 it
.current_x
= it
.hpos
= 0;
16642 /* Set the window start position here explicitly, to avoid an
16643 infinite loop in case the functions in window-scroll-functions
16645 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16647 /* Run scroll hooks. */
16648 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16650 /* Redisplay the window. */
16651 if (!current_matrix_up_to_date_p
16652 || windows_or_buffers_changed
16653 || f
->cursor_type_changed
16654 /* Don't use try_window_reusing_current_matrix in this case
16655 because it can have changed the buffer. */
16656 || !NILP (Vwindow_scroll_functions
)
16657 || !just_this_one_p
16658 || MINI_WINDOW_P (w
)
16659 || !(used_current_matrix_p
16660 = try_window_reusing_current_matrix (w
)))
16661 try_window (window
, startp
, 0);
16663 /* If new fonts have been loaded (due to fontsets), give up. We
16664 have to start a new redisplay since we need to re-adjust glyph
16666 if (f
->fonts_changed
)
16667 goto need_larger_matrices
;
16669 /* If cursor did not appear assume that the middle of the window is
16670 in the first line of the window. Do it again with the next line.
16671 (Imagine a window of height 100, displaying two lines of height
16672 60. Moving back 50 from it->last_visible_y will end in the first
16674 if (w
->cursor
.vpos
< 0)
16676 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16678 clear_glyph_matrix (w
->desired_matrix
);
16679 move_it_by_lines (&it
, 1);
16680 try_window (window
, it
.current
.pos
, 0);
16682 else if (PT
< IT_CHARPOS (it
))
16684 clear_glyph_matrix (w
->desired_matrix
);
16685 move_it_by_lines (&it
, -1);
16686 try_window (window
, it
.current
.pos
, 0);
16690 /* Not much we can do about it. */
16694 /* Consider the following case: Window starts at BEGV, there is
16695 invisible, intangible text at BEGV, so that display starts at
16696 some point START > BEGV. It can happen that we are called with
16697 PT somewhere between BEGV and START. Try to handle that case,
16698 and similar ones. */
16699 if (w
->cursor
.vpos
< 0)
16701 /* First, try locating the proper glyph row for PT. */
16702 struct glyph_row
*row
=
16703 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16705 /* Sometimes point is at the beginning of invisible text that is
16706 before the 1st character displayed in the row. In that case,
16707 row_containing_pos fails to find the row, because no glyphs
16708 with appropriate buffer positions are present in the row.
16709 Therefore, we next try to find the row which shows the 1st
16710 position after the invisible text. */
16714 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16717 if (TEXT_PROP_MEANS_INVISIBLE (val
))
16720 Lisp_Object invis_end
=
16721 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16724 if (NATNUMP (invis_end
))
16725 alt_pos
= XFASTINT (invis_end
);
16728 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16732 /* Finally, fall back on the first row of the window after the
16733 header line (if any). This is slightly better than not
16734 displaying the cursor at all. */
16737 row
= w
->current_matrix
->rows
;
16738 if (row
->mode_line_p
)
16741 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16744 if (!cursor_row_fully_visible_p (w
, 0, 0))
16746 /* If vscroll is enabled, disable it and try again. */
16750 clear_glyph_matrix (w
->desired_matrix
);
16754 /* Users who set scroll-conservatively to a large number want
16755 point just above/below the scroll margin. If we ended up
16756 with point's row partially visible, move the window start to
16757 make that row fully visible and out of the margin. */
16758 if (scroll_conservatively
> SCROLL_LIMIT
)
16760 int window_total_lines
16761 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16764 ? min (scroll_margin
, window_total_lines
/ 4)
16766 int move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16768 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16769 clear_glyph_matrix (w
->desired_matrix
);
16770 if (1 == try_window (window
, it
.current
.pos
,
16771 TRY_WINDOW_CHECK_MARGINS
))
16775 /* If centering point failed to make the whole line visible,
16776 put point at the top instead. That has to make the whole line
16777 visible, if it can be done. */
16778 if (centering_position
== 0)
16781 clear_glyph_matrix (w
->desired_matrix
);
16782 centering_position
= 0;
16788 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16789 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16790 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16792 /* Display the mode line, if we must. */
16793 if ((update_mode_line
16794 /* If window not full width, must redo its mode line
16795 if (a) the window to its side is being redone and
16796 (b) we do a frame-based redisplay. This is a consequence
16797 of how inverted lines are drawn in frame-based redisplay. */
16798 || (!just_this_one_p
16799 && !FRAME_WINDOW_P (f
)
16800 && !WINDOW_FULL_WIDTH_P (w
))
16801 /* Line number to display. */
16802 || w
->base_line_pos
> 0
16803 /* Column number is displayed and different from the one displayed. */
16804 || (w
->column_number_displayed
!= -1
16805 && (w
->column_number_displayed
!= current_column ())))
16806 /* This means that the window has a mode line. */
16807 && (WINDOW_WANTS_MODELINE_P (w
)
16808 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16811 display_mode_lines (w
);
16813 /* If mode line height has changed, arrange for a thorough
16814 immediate redisplay using the correct mode line height. */
16815 if (WINDOW_WANTS_MODELINE_P (w
)
16816 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16818 f
->fonts_changed
= 1;
16819 w
->mode_line_height
= -1;
16820 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16821 = DESIRED_MODE_LINE_HEIGHT (w
);
16824 /* If header line height has changed, arrange for a thorough
16825 immediate redisplay using the correct header line height. */
16826 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16827 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16829 f
->fonts_changed
= 1;
16830 w
->header_line_height
= -1;
16831 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16832 = DESIRED_HEADER_LINE_HEIGHT (w
);
16835 if (f
->fonts_changed
)
16836 goto need_larger_matrices
;
16839 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16841 w
->base_line_pos
= 0;
16842 w
->base_line_number
= 0;
16847 /* When we reach a frame's selected window, redo the frame's menu bar. */
16848 if (update_mode_line
16849 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16851 int redisplay_menu_p
= 0;
16853 if (FRAME_WINDOW_P (f
))
16855 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16856 || defined (HAVE_NS) || defined (USE_GTK)
16857 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16859 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16863 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16865 if (redisplay_menu_p
)
16866 display_menu_bar (w
);
16868 #ifdef HAVE_WINDOW_SYSTEM
16869 if (FRAME_WINDOW_P (f
))
16871 #if defined (USE_GTK) || defined (HAVE_NS)
16872 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16873 redisplay_tool_bar (f
);
16875 if (WINDOWP (f
->tool_bar_window
)
16876 && (FRAME_TOOL_BAR_HEIGHT (f
) > 0
16877 || !NILP (Vauto_resize_tool_bars
))
16878 && redisplay_tool_bar (f
))
16879 ignore_mouse_drag_p
= 1;
16885 #ifdef HAVE_WINDOW_SYSTEM
16886 if (FRAME_WINDOW_P (f
)
16887 && update_window_fringes (w
, (just_this_one_p
16888 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16889 || w
->pseudo_window_p
)))
16893 if (draw_window_fringes (w
, 1))
16895 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16896 x_draw_right_divider (w
);
16898 x_draw_vertical_border (w
);
16904 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16905 x_draw_bottom_divider (w
);
16906 #endif /* HAVE_WINDOW_SYSTEM */
16908 /* We go to this label, with fonts_changed set, if it is
16909 necessary to try again using larger glyph matrices.
16910 We have to redeem the scroll bar even in this case,
16911 because the loop in redisplay_internal expects that. */
16912 need_larger_matrices
:
16914 finish_scroll_bars
:
16916 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16918 /* Set the thumb's position and size. */
16919 set_vertical_scroll_bar (w
);
16921 /* Note that we actually used the scroll bar attached to this
16922 window, so it shouldn't be deleted at the end of redisplay. */
16923 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16924 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16927 /* Restore current_buffer and value of point in it. The window
16928 update may have changed the buffer, so first make sure `opoint'
16929 is still valid (Bug#6177). */
16930 if (CHARPOS (opoint
) < BEGV
)
16931 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16932 else if (CHARPOS (opoint
) > ZV
)
16933 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16935 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16937 set_buffer_internal_1 (old
);
16938 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16939 shorter. This can be caused by log truncation in *Messages*. */
16940 if (CHARPOS (lpoint
) <= ZV
)
16941 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16943 unbind_to (count
, Qnil
);
16947 /* Build the complete desired matrix of WINDOW with a window start
16948 buffer position POS.
16950 Value is 1 if successful. It is zero if fonts were loaded during
16951 redisplay which makes re-adjusting glyph matrices necessary, and -1
16952 if point would appear in the scroll margins.
16953 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16954 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16958 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16960 struct window
*w
= XWINDOW (window
);
16962 struct glyph_row
*last_text_row
= NULL
;
16963 struct frame
*f
= XFRAME (w
->frame
);
16964 int frame_line_height
= default_line_pixel_height (w
);
16966 /* Make POS the new window start. */
16967 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16969 /* Mark cursor position as unknown. No overlay arrow seen. */
16970 w
->cursor
.vpos
= -1;
16971 overlay_arrow_seen
= 0;
16973 /* Initialize iterator and info to start at POS. */
16974 start_display (&it
, w
, pos
);
16976 /* Display all lines of W. */
16977 while (it
.current_y
< it
.last_visible_y
)
16979 if (display_line (&it
))
16980 last_text_row
= it
.glyph_row
- 1;
16981 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16985 /* Don't let the cursor end in the scroll margins. */
16986 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16987 && !MINI_WINDOW_P (w
))
16989 int this_scroll_margin
;
16990 int window_total_lines
16991 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16993 if (scroll_margin
> 0)
16995 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16996 this_scroll_margin
*= frame_line_height
;
16999 this_scroll_margin
= 0;
17001 if ((w
->cursor
.y
>= 0 /* not vscrolled */
17002 && w
->cursor
.y
< this_scroll_margin
17003 && CHARPOS (pos
) > BEGV
17004 && IT_CHARPOS (it
) < ZV
)
17005 /* rms: considering make_cursor_line_fully_visible_p here
17006 seems to give wrong results. We don't want to recenter
17007 when the last line is partly visible, we want to allow
17008 that case to be handled in the usual way. */
17009 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
17011 w
->cursor
.vpos
= -1;
17012 clear_glyph_matrix (w
->desired_matrix
);
17017 /* If bottom moved off end of frame, change mode line percentage. */
17018 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
17019 w
->update_mode_line
= 1;
17021 /* Set window_end_pos to the offset of the last character displayed
17022 on the window from the end of current_buffer. Set
17023 window_end_vpos to its row number. */
17026 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17027 adjust_window_ends (w
, last_text_row
, 0);
17029 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17030 w
->window_end_vpos
)));
17034 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17035 w
->window_end_pos
= Z
- ZV
;
17036 w
->window_end_vpos
= 0;
17039 /* But that is not valid info until redisplay finishes. */
17040 w
->window_end_valid
= 0;
17046 /************************************************************************
17047 Window redisplay reusing current matrix when buffer has not changed
17048 ************************************************************************/
17050 /* Try redisplay of window W showing an unchanged buffer with a
17051 different window start than the last time it was displayed by
17052 reusing its current matrix. Value is non-zero if successful.
17053 W->start is the new window start. */
17056 try_window_reusing_current_matrix (struct window
*w
)
17058 struct frame
*f
= XFRAME (w
->frame
);
17059 struct glyph_row
*bottom_row
;
17062 struct text_pos start
, new_start
;
17063 int nrows_scrolled
, i
;
17064 struct glyph_row
*last_text_row
;
17065 struct glyph_row
*last_reused_text_row
;
17066 struct glyph_row
*start_row
;
17067 int start_vpos
, min_y
, max_y
;
17070 if (inhibit_try_window_reusing
)
17074 if (/* This function doesn't handle terminal frames. */
17075 !FRAME_WINDOW_P (f
)
17076 /* Don't try to reuse the display if windows have been split
17078 || windows_or_buffers_changed
17079 || f
->cursor_type_changed
)
17082 /* Can't do this if showing trailing whitespace. */
17083 if (!NILP (Vshow_trailing_whitespace
))
17086 /* If top-line visibility has changed, give up. */
17087 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17088 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17091 /* Give up if old or new display is scrolled vertically. We could
17092 make this function handle this, but right now it doesn't. */
17093 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17094 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17097 /* The variable new_start now holds the new window start. The old
17098 start `start' can be determined from the current matrix. */
17099 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17100 start
= start_row
->minpos
;
17101 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17103 /* Clear the desired matrix for the display below. */
17104 clear_glyph_matrix (w
->desired_matrix
);
17106 if (CHARPOS (new_start
) <= CHARPOS (start
))
17108 /* Don't use this method if the display starts with an ellipsis
17109 displayed for invisible text. It's not easy to handle that case
17110 below, and it's certainly not worth the effort since this is
17111 not a frequent case. */
17112 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17115 IF_DEBUG (debug_method_add (w
, "twu1"));
17117 /* Display up to a row that can be reused. The variable
17118 last_text_row is set to the last row displayed that displays
17119 text. Note that it.vpos == 0 if or if not there is a
17120 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17121 start_display (&it
, w
, new_start
);
17122 w
->cursor
.vpos
= -1;
17123 last_text_row
= last_reused_text_row
= NULL
;
17125 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17127 /* If we have reached into the characters in the START row,
17128 that means the line boundaries have changed. So we
17129 can't start copying with the row START. Maybe it will
17130 work to start copying with the following row. */
17131 while (IT_CHARPOS (it
) > CHARPOS (start
))
17133 /* Advance to the next row as the "start". */
17135 start
= start_row
->minpos
;
17136 /* If there are no more rows to try, or just one, give up. */
17137 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17138 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17139 || CHARPOS (start
) == ZV
)
17141 clear_glyph_matrix (w
->desired_matrix
);
17145 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17147 /* If we have reached alignment, we can copy the rest of the
17149 if (IT_CHARPOS (it
) == CHARPOS (start
)
17150 /* Don't accept "alignment" inside a display vector,
17151 since start_row could have started in the middle of
17152 that same display vector (thus their character
17153 positions match), and we have no way of telling if
17154 that is the case. */
17155 && it
.current
.dpvec_index
< 0)
17158 if (display_line (&it
))
17159 last_text_row
= it
.glyph_row
- 1;
17163 /* A value of current_y < last_visible_y means that we stopped
17164 at the previous window start, which in turn means that we
17165 have at least one reusable row. */
17166 if (it
.current_y
< it
.last_visible_y
)
17168 struct glyph_row
*row
;
17170 /* IT.vpos always starts from 0; it counts text lines. */
17171 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17173 /* Find PT if not already found in the lines displayed. */
17174 if (w
->cursor
.vpos
< 0)
17176 int dy
= it
.current_y
- start_row
->y
;
17178 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17179 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17181 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17182 dy
, nrows_scrolled
);
17185 clear_glyph_matrix (w
->desired_matrix
);
17190 /* Scroll the display. Do it before the current matrix is
17191 changed. The problem here is that update has not yet
17192 run, i.e. part of the current matrix is not up to date.
17193 scroll_run_hook will clear the cursor, and use the
17194 current matrix to get the height of the row the cursor is
17196 run
.current_y
= start_row
->y
;
17197 run
.desired_y
= it
.current_y
;
17198 run
.height
= it
.last_visible_y
- it
.current_y
;
17200 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17203 FRAME_RIF (f
)->update_window_begin_hook (w
);
17204 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17205 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17206 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17210 /* Shift current matrix down by nrows_scrolled lines. */
17211 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17212 rotate_matrix (w
->current_matrix
,
17214 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17217 /* Disable lines that must be updated. */
17218 for (i
= 0; i
< nrows_scrolled
; ++i
)
17219 (start_row
+ i
)->enabled_p
= false;
17221 /* Re-compute Y positions. */
17222 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17223 max_y
= it
.last_visible_y
;
17224 for (row
= start_row
+ nrows_scrolled
;
17228 row
->y
= it
.current_y
;
17229 row
->visible_height
= row
->height
;
17231 if (row
->y
< min_y
)
17232 row
->visible_height
-= min_y
- row
->y
;
17233 if (row
->y
+ row
->height
> max_y
)
17234 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17235 if (row
->fringe_bitmap_periodic_p
)
17236 row
->redraw_fringe_bitmaps_p
= 1;
17238 it
.current_y
+= row
->height
;
17240 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17241 last_reused_text_row
= row
;
17242 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17246 /* Disable lines in the current matrix which are now
17247 below the window. */
17248 for (++row
; row
< bottom_row
; ++row
)
17249 row
->enabled_p
= row
->mode_line_p
= 0;
17252 /* Update window_end_pos etc.; last_reused_text_row is the last
17253 reused row from the current matrix containing text, if any.
17254 The value of last_text_row is the last displayed line
17255 containing text. */
17256 if (last_reused_text_row
)
17257 adjust_window_ends (w
, last_reused_text_row
, 1);
17258 else if (last_text_row
)
17259 adjust_window_ends (w
, last_text_row
, 0);
17262 /* This window must be completely empty. */
17263 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17264 w
->window_end_pos
= Z
- ZV
;
17265 w
->window_end_vpos
= 0;
17267 w
->window_end_valid
= 0;
17269 /* Update hint: don't try scrolling again in update_window. */
17270 w
->desired_matrix
->no_scrolling_p
= 1;
17273 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17277 else if (CHARPOS (new_start
) > CHARPOS (start
))
17279 struct glyph_row
*pt_row
, *row
;
17280 struct glyph_row
*first_reusable_row
;
17281 struct glyph_row
*first_row_to_display
;
17283 int yb
= window_text_bottom_y (w
);
17285 /* Find the row starting at new_start, if there is one. Don't
17286 reuse a partially visible line at the end. */
17287 first_reusable_row
= start_row
;
17288 while (first_reusable_row
->enabled_p
17289 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17290 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17291 < CHARPOS (new_start
)))
17292 ++first_reusable_row
;
17294 /* Give up if there is no row to reuse. */
17295 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17296 || !first_reusable_row
->enabled_p
17297 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17298 != CHARPOS (new_start
)))
17301 /* We can reuse fully visible rows beginning with
17302 first_reusable_row to the end of the window. Set
17303 first_row_to_display to the first row that cannot be reused.
17304 Set pt_row to the row containing point, if there is any. */
17306 for (first_row_to_display
= first_reusable_row
;
17307 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17308 ++first_row_to_display
)
17310 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17311 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17312 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17313 && first_row_to_display
->ends_at_zv_p
17314 && pt_row
== NULL
)))
17315 pt_row
= first_row_to_display
;
17318 /* Start displaying at the start of first_row_to_display. */
17319 eassert (first_row_to_display
->y
< yb
);
17320 init_to_row_start (&it
, w
, first_row_to_display
);
17322 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17324 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17326 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17327 + WINDOW_HEADER_LINE_HEIGHT (w
));
17329 /* Display lines beginning with first_row_to_display in the
17330 desired matrix. Set last_text_row to the last row displayed
17331 that displays text. */
17332 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17333 if (pt_row
== NULL
)
17334 w
->cursor
.vpos
= -1;
17335 last_text_row
= NULL
;
17336 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17337 if (display_line (&it
))
17338 last_text_row
= it
.glyph_row
- 1;
17340 /* If point is in a reused row, adjust y and vpos of the cursor
17344 w
->cursor
.vpos
-= nrows_scrolled
;
17345 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17348 /* Give up if point isn't in a row displayed or reused. (This
17349 also handles the case where w->cursor.vpos < nrows_scrolled
17350 after the calls to display_line, which can happen with scroll
17351 margins. See bug#1295.) */
17352 if (w
->cursor
.vpos
< 0)
17354 clear_glyph_matrix (w
->desired_matrix
);
17358 /* Scroll the display. */
17359 run
.current_y
= first_reusable_row
->y
;
17360 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17361 run
.height
= it
.last_visible_y
- run
.current_y
;
17362 dy
= run
.current_y
- run
.desired_y
;
17367 FRAME_RIF (f
)->update_window_begin_hook (w
);
17368 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17369 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17370 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17374 /* Adjust Y positions of reused rows. */
17375 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17376 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17377 max_y
= it
.last_visible_y
;
17378 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17381 row
->visible_height
= row
->height
;
17382 if (row
->y
< min_y
)
17383 row
->visible_height
-= min_y
- row
->y
;
17384 if (row
->y
+ row
->height
> max_y
)
17385 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17386 if (row
->fringe_bitmap_periodic_p
)
17387 row
->redraw_fringe_bitmaps_p
= 1;
17390 /* Scroll the current matrix. */
17391 eassert (nrows_scrolled
> 0);
17392 rotate_matrix (w
->current_matrix
,
17394 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17397 /* Disable rows not reused. */
17398 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17399 row
->enabled_p
= false;
17401 /* Point may have moved to a different line, so we cannot assume that
17402 the previous cursor position is valid; locate the correct row. */
17405 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17407 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17408 && !row
->ends_at_zv_p
;
17412 w
->cursor
.y
= row
->y
;
17414 if (row
< bottom_row
)
17416 /* Can't simply scan the row for point with
17417 bidi-reordered glyph rows. Let set_cursor_from_row
17418 figure out where to put the cursor, and if it fails,
17420 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17422 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17425 clear_glyph_matrix (w
->desired_matrix
);
17431 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17432 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17435 && (!BUFFERP (glyph
->object
)
17436 || glyph
->charpos
< PT
);
17440 w
->cursor
.x
+= glyph
->pixel_width
;
17446 /* Adjust window end. A null value of last_text_row means that
17447 the window end is in reused rows which in turn means that
17448 only its vpos can have changed. */
17450 adjust_window_ends (w
, last_text_row
, 0);
17452 w
->window_end_vpos
-= nrows_scrolled
;
17454 w
->window_end_valid
= 0;
17455 w
->desired_matrix
->no_scrolling_p
= 1;
17458 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17468 /************************************************************************
17469 Window redisplay reusing current matrix when buffer has changed
17470 ************************************************************************/
17472 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17473 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17474 ptrdiff_t *, ptrdiff_t *);
17475 static struct glyph_row
*
17476 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17477 struct glyph_row
*);
17480 /* Return the last row in MATRIX displaying text. If row START is
17481 non-null, start searching with that row. IT gives the dimensions
17482 of the display. Value is null if matrix is empty; otherwise it is
17483 a pointer to the row found. */
17485 static struct glyph_row
*
17486 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17487 struct glyph_row
*start
)
17489 struct glyph_row
*row
, *row_found
;
17491 /* Set row_found to the last row in IT->w's current matrix
17492 displaying text. The loop looks funny but think of partially
17495 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17496 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17498 eassert (row
->enabled_p
);
17500 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17509 /* Return the last row in the current matrix of W that is not affected
17510 by changes at the start of current_buffer that occurred since W's
17511 current matrix was built. Value is null if no such row exists.
17513 BEG_UNCHANGED us the number of characters unchanged at the start of
17514 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17515 first changed character in current_buffer. Characters at positions <
17516 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17517 when the current matrix was built. */
17519 static struct glyph_row
*
17520 find_last_unchanged_at_beg_row (struct window
*w
)
17522 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17523 struct glyph_row
*row
;
17524 struct glyph_row
*row_found
= NULL
;
17525 int yb
= window_text_bottom_y (w
);
17527 /* Find the last row displaying unchanged text. */
17528 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17529 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17530 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17533 if (/* If row ends before first_changed_pos, it is unchanged,
17534 except in some case. */
17535 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17536 /* When row ends in ZV and we write at ZV it is not
17538 && !row
->ends_at_zv_p
17539 /* When first_changed_pos is the end of a continued line,
17540 row is not unchanged because it may be no longer
17542 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17543 && (row
->continued_p
17544 || row
->exact_window_width_line_p
))
17545 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17546 needs to be recomputed, so don't consider this row as
17547 unchanged. This happens when the last line was
17548 bidi-reordered and was killed immediately before this
17549 redisplay cycle. In that case, ROW->end stores the
17550 buffer position of the first visual-order character of
17551 the killed text, which is now beyond ZV. */
17552 && CHARPOS (row
->end
.pos
) <= ZV
)
17555 /* Stop if last visible row. */
17556 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17564 /* Find the first glyph row in the current matrix of W that is not
17565 affected by changes at the end of current_buffer since the
17566 time W's current matrix was built.
17568 Return in *DELTA the number of chars by which buffer positions in
17569 unchanged text at the end of current_buffer must be adjusted.
17571 Return in *DELTA_BYTES the corresponding number of bytes.
17573 Value is null if no such row exists, i.e. all rows are affected by
17576 static struct glyph_row
*
17577 find_first_unchanged_at_end_row (struct window
*w
,
17578 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17580 struct glyph_row
*row
;
17581 struct glyph_row
*row_found
= NULL
;
17583 *delta
= *delta_bytes
= 0;
17585 /* Display must not have been paused, otherwise the current matrix
17586 is not up to date. */
17587 eassert (w
->window_end_valid
);
17589 /* A value of window_end_pos >= END_UNCHANGED means that the window
17590 end is in the range of changed text. If so, there is no
17591 unchanged row at the end of W's current matrix. */
17592 if (w
->window_end_pos
>= END_UNCHANGED
)
17595 /* Set row to the last row in W's current matrix displaying text. */
17596 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17598 /* If matrix is entirely empty, no unchanged row exists. */
17599 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17601 /* The value of row is the last glyph row in the matrix having a
17602 meaningful buffer position in it. The end position of row
17603 corresponds to window_end_pos. This allows us to translate
17604 buffer positions in the current matrix to current buffer
17605 positions for characters not in changed text. */
17607 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17608 ptrdiff_t Z_BYTE_old
=
17609 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17610 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17611 struct glyph_row
*first_text_row
17612 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17614 *delta
= Z
- Z_old
;
17615 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17617 /* Set last_unchanged_pos to the buffer position of the last
17618 character in the buffer that has not been changed. Z is the
17619 index + 1 of the last character in current_buffer, i.e. by
17620 subtracting END_UNCHANGED we get the index of the last
17621 unchanged character, and we have to add BEG to get its buffer
17623 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17624 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17626 /* Search backward from ROW for a row displaying a line that
17627 starts at a minimum position >= last_unchanged_pos_old. */
17628 for (; row
> first_text_row
; --row
)
17630 /* This used to abort, but it can happen.
17631 It is ok to just stop the search instead here. KFS. */
17632 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17635 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17640 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17646 /* Make sure that glyph rows in the current matrix of window W
17647 reference the same glyph memory as corresponding rows in the
17648 frame's frame matrix. This function is called after scrolling W's
17649 current matrix on a terminal frame in try_window_id and
17650 try_window_reusing_current_matrix. */
17653 sync_frame_with_window_matrix_rows (struct window
*w
)
17655 struct frame
*f
= XFRAME (w
->frame
);
17656 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17658 /* Preconditions: W must be a leaf window and full-width. Its frame
17659 must have a frame matrix. */
17660 eassert (BUFFERP (w
->contents
));
17661 eassert (WINDOW_FULL_WIDTH_P (w
));
17662 eassert (!FRAME_WINDOW_P (f
));
17664 /* If W is a full-width window, glyph pointers in W's current matrix
17665 have, by definition, to be the same as glyph pointers in the
17666 corresponding frame matrix. Note that frame matrices have no
17667 marginal areas (see build_frame_matrix). */
17668 window_row
= w
->current_matrix
->rows
;
17669 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17670 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17671 while (window_row
< window_row_end
)
17673 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17674 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17676 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17677 frame_row
->glyphs
[TEXT_AREA
] = start
;
17678 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17679 frame_row
->glyphs
[LAST_AREA
] = end
;
17681 /* Disable frame rows whose corresponding window rows have
17682 been disabled in try_window_id. */
17683 if (!window_row
->enabled_p
)
17684 frame_row
->enabled_p
= false;
17686 ++window_row
, ++frame_row
;
17691 /* Find the glyph row in window W containing CHARPOS. Consider all
17692 rows between START and END (not inclusive). END null means search
17693 all rows to the end of the display area of W. Value is the row
17694 containing CHARPOS or null. */
17697 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17698 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17700 struct glyph_row
*row
= start
;
17701 struct glyph_row
*best_row
= NULL
;
17702 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17705 /* If we happen to start on a header-line, skip that. */
17706 if (row
->mode_line_p
)
17709 if ((end
&& row
>= end
) || !row
->enabled_p
)
17712 last_y
= window_text_bottom_y (w
) - dy
;
17716 /* Give up if we have gone too far. */
17717 if (end
&& row
>= end
)
17719 /* This formerly returned if they were equal.
17720 I think that both quantities are of a "last plus one" type;
17721 if so, when they are equal, the row is within the screen. -- rms. */
17722 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17725 /* If it is in this row, return this row. */
17726 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17727 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17728 /* The end position of a row equals the start
17729 position of the next row. If CHARPOS is there, we
17730 would rather consider it displayed in the next
17731 line, except when this line ends in ZV. */
17732 && !row_for_charpos_p (row
, charpos
)))
17733 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17737 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17738 || (!best_row
&& !row
->continued_p
))
17740 /* In bidi-reordered rows, there could be several rows whose
17741 edges surround CHARPOS, all of these rows belonging to
17742 the same continued line. We need to find the row which
17743 fits CHARPOS the best. */
17744 for (g
= row
->glyphs
[TEXT_AREA
];
17745 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17748 if (!STRINGP (g
->object
))
17750 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17752 mindif
= eabs (g
->charpos
- charpos
);
17754 /* Exact match always wins. */
17761 else if (best_row
&& !row
->continued_p
)
17768 /* Try to redisplay window W by reusing its existing display. W's
17769 current matrix must be up to date when this function is called,
17770 i.e. window_end_valid must be nonzero.
17774 >= 1 if successful, i.e. display has been updated
17776 1 means the changes were in front of a newline that precedes
17777 the window start, and the whole current matrix was reused
17778 2 means the changes were after the last position displayed
17779 in the window, and the whole current matrix was reused
17780 3 means portions of the current matrix were reused, while
17781 some of the screen lines were redrawn
17782 -1 if redisplay with same window start is known not to succeed
17783 0 if otherwise unsuccessful
17785 The following steps are performed:
17787 1. Find the last row in the current matrix of W that is not
17788 affected by changes at the start of current_buffer. If no such row
17791 2. Find the first row in W's current matrix that is not affected by
17792 changes at the end of current_buffer. Maybe there is no such row.
17794 3. Display lines beginning with the row + 1 found in step 1 to the
17795 row found in step 2 or, if step 2 didn't find a row, to the end of
17798 4. If cursor is not known to appear on the window, give up.
17800 5. If display stopped at the row found in step 2, scroll the
17801 display and current matrix as needed.
17803 6. Maybe display some lines at the end of W, if we must. This can
17804 happen under various circumstances, like a partially visible line
17805 becoming fully visible, or because newly displayed lines are displayed
17806 in smaller font sizes.
17808 7. Update W's window end information. */
17811 try_window_id (struct window
*w
)
17813 struct frame
*f
= XFRAME (w
->frame
);
17814 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17815 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17816 struct glyph_row
*last_unchanged_at_beg_row
;
17817 struct glyph_row
*first_unchanged_at_end_row
;
17818 struct glyph_row
*row
;
17819 struct glyph_row
*bottom_row
;
17822 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17824 struct text_pos start_pos
;
17826 int first_unchanged_at_end_vpos
= 0;
17827 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17828 struct text_pos start
;
17829 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17832 if (inhibit_try_window_id
)
17836 /* This is handy for debugging. */
17838 #define GIVE_UP(X) \
17840 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17844 #define GIVE_UP(X) return 0
17847 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17849 /* Don't use this for mini-windows because these can show
17850 messages and mini-buffers, and we don't handle that here. */
17851 if (MINI_WINDOW_P (w
))
17854 /* This flag is used to prevent redisplay optimizations. */
17855 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17858 /* This function's optimizations cannot be used if overlays have
17859 changed in the buffer displayed by the window, so give up if they
17861 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17864 /* Verify that narrowing has not changed.
17865 Also verify that we were not told to prevent redisplay optimizations.
17866 It would be nice to further
17867 reduce the number of cases where this prevents try_window_id. */
17868 if (current_buffer
->clip_changed
17869 || current_buffer
->prevent_redisplay_optimizations_p
)
17872 /* Window must either use window-based redisplay or be full width. */
17873 if (!FRAME_WINDOW_P (f
)
17874 && (!FRAME_LINE_INS_DEL_OK (f
)
17875 || !WINDOW_FULL_WIDTH_P (w
)))
17878 /* Give up if point is known NOT to appear in W. */
17879 if (PT
< CHARPOS (start
))
17882 /* Another way to prevent redisplay optimizations. */
17883 if (w
->last_modified
== 0)
17886 /* Verify that window is not hscrolled. */
17887 if (w
->hscroll
!= 0)
17890 /* Verify that display wasn't paused. */
17891 if (!w
->window_end_valid
)
17894 /* Likewise if highlighting trailing whitespace. */
17895 if (!NILP (Vshow_trailing_whitespace
))
17898 /* Can't use this if overlay arrow position and/or string have
17900 if (overlay_arrows_changed_p ())
17903 /* When word-wrap is on, adding a space to the first word of a
17904 wrapped line can change the wrap position, altering the line
17905 above it. It might be worthwhile to handle this more
17906 intelligently, but for now just redisplay from scratch. */
17907 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17910 /* Under bidi reordering, adding or deleting a character in the
17911 beginning of a paragraph, before the first strong directional
17912 character, can change the base direction of the paragraph (unless
17913 the buffer specifies a fixed paragraph direction), which will
17914 require to redisplay the whole paragraph. It might be worthwhile
17915 to find the paragraph limits and widen the range of redisplayed
17916 lines to that, but for now just give up this optimization and
17917 redisplay from scratch. */
17918 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17919 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17922 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17923 only if buffer has really changed. The reason is that the gap is
17924 initially at Z for freshly visited files. The code below would
17925 set end_unchanged to 0 in that case. */
17926 if (MODIFF
> SAVE_MODIFF
17927 /* This seems to happen sometimes after saving a buffer. */
17928 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17930 if (GPT
- BEG
< BEG_UNCHANGED
)
17931 BEG_UNCHANGED
= GPT
- BEG
;
17932 if (Z
- GPT
< END_UNCHANGED
)
17933 END_UNCHANGED
= Z
- GPT
;
17936 /* The position of the first and last character that has been changed. */
17937 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17938 last_changed_charpos
= Z
- END_UNCHANGED
;
17940 /* If window starts after a line end, and the last change is in
17941 front of that newline, then changes don't affect the display.
17942 This case happens with stealth-fontification. Note that although
17943 the display is unchanged, glyph positions in the matrix have to
17944 be adjusted, of course. */
17945 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17946 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17947 && ((last_changed_charpos
< CHARPOS (start
)
17948 && CHARPOS (start
) == BEGV
)
17949 || (last_changed_charpos
< CHARPOS (start
) - 1
17950 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17952 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17953 struct glyph_row
*r0
;
17955 /* Compute how many chars/bytes have been added to or removed
17956 from the buffer. */
17957 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17958 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17959 Z_delta
= Z
- Z_old
;
17960 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17962 /* Give up if PT is not in the window. Note that it already has
17963 been checked at the start of try_window_id that PT is not in
17964 front of the window start. */
17965 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17968 /* If window start is unchanged, we can reuse the whole matrix
17969 as is, after adjusting glyph positions. No need to compute
17970 the window end again, since its offset from Z hasn't changed. */
17971 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17972 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17973 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17974 /* PT must not be in a partially visible line. */
17975 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17976 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17978 /* Adjust positions in the glyph matrix. */
17979 if (Z_delta
|| Z_delta_bytes
)
17981 struct glyph_row
*r1
17982 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17983 increment_matrix_positions (w
->current_matrix
,
17984 MATRIX_ROW_VPOS (r0
, current_matrix
),
17985 MATRIX_ROW_VPOS (r1
, current_matrix
),
17986 Z_delta
, Z_delta_bytes
);
17989 /* Set the cursor. */
17990 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17992 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17997 /* Handle the case that changes are all below what is displayed in
17998 the window, and that PT is in the window. This shortcut cannot
17999 be taken if ZV is visible in the window, and text has been added
18000 there that is visible in the window. */
18001 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
18002 /* ZV is not visible in the window, or there are no
18003 changes at ZV, actually. */
18004 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
18005 || first_changed_charpos
== last_changed_charpos
))
18007 struct glyph_row
*r0
;
18009 /* Give up if PT is not in the window. Note that it already has
18010 been checked at the start of try_window_id that PT is not in
18011 front of the window start. */
18012 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
18015 /* If window start is unchanged, we can reuse the whole matrix
18016 as is, without changing glyph positions since no text has
18017 been added/removed in front of the window end. */
18018 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18019 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
18020 /* PT must not be in a partially visible line. */
18021 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18022 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18024 /* We have to compute the window end anew since text
18025 could have been added/removed after it. */
18026 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18027 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18029 /* Set the cursor. */
18030 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18032 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18037 /* Give up if window start is in the changed area.
18039 The condition used to read
18041 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18043 but why that was tested escapes me at the moment. */
18044 if (CHARPOS (start
) >= first_changed_charpos
18045 && CHARPOS (start
) <= last_changed_charpos
)
18048 /* Check that window start agrees with the start of the first glyph
18049 row in its current matrix. Check this after we know the window
18050 start is not in changed text, otherwise positions would not be
18052 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18053 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18056 /* Give up if the window ends in strings. Overlay strings
18057 at the end are difficult to handle, so don't try. */
18058 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18059 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18062 /* Compute the position at which we have to start displaying new
18063 lines. Some of the lines at the top of the window might be
18064 reusable because they are not displaying changed text. Find the
18065 last row in W's current matrix not affected by changes at the
18066 start of current_buffer. Value is null if changes start in the
18067 first line of window. */
18068 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18069 if (last_unchanged_at_beg_row
)
18071 /* Avoid starting to display in the middle of a character, a TAB
18072 for instance. This is easier than to set up the iterator
18073 exactly, and it's not a frequent case, so the additional
18074 effort wouldn't really pay off. */
18075 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18076 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18077 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18078 --last_unchanged_at_beg_row
;
18080 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18083 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
18085 start_pos
= it
.current
.pos
;
18087 /* Start displaying new lines in the desired matrix at the same
18088 vpos we would use in the current matrix, i.e. below
18089 last_unchanged_at_beg_row. */
18090 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18092 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18093 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18095 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18099 /* There are no reusable lines at the start of the window.
18100 Start displaying in the first text line. */
18101 start_display (&it
, w
, start
);
18102 it
.vpos
= it
.first_vpos
;
18103 start_pos
= it
.current
.pos
;
18106 /* Find the first row that is not affected by changes at the end of
18107 the buffer. Value will be null if there is no unchanged row, in
18108 which case we must redisplay to the end of the window. delta
18109 will be set to the value by which buffer positions beginning with
18110 first_unchanged_at_end_row have to be adjusted due to text
18112 first_unchanged_at_end_row
18113 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18114 IF_DEBUG (debug_delta
= delta
);
18115 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18117 /* Set stop_pos to the buffer position up to which we will have to
18118 display new lines. If first_unchanged_at_end_row != NULL, this
18119 is the buffer position of the start of the line displayed in that
18120 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18121 that we don't stop at a buffer position. */
18123 if (first_unchanged_at_end_row
)
18125 eassert (last_unchanged_at_beg_row
== NULL
18126 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18128 /* If this is a continuation line, move forward to the next one
18129 that isn't. Changes in lines above affect this line.
18130 Caution: this may move first_unchanged_at_end_row to a row
18131 not displaying text. */
18132 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18133 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18134 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18135 < it
.last_visible_y
))
18136 ++first_unchanged_at_end_row
;
18138 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18139 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18140 >= it
.last_visible_y
))
18141 first_unchanged_at_end_row
= NULL
;
18144 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18146 first_unchanged_at_end_vpos
18147 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18148 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18151 else if (last_unchanged_at_beg_row
== NULL
)
18157 /* Either there is no unchanged row at the end, or the one we have
18158 now displays text. This is a necessary condition for the window
18159 end pos calculation at the end of this function. */
18160 eassert (first_unchanged_at_end_row
== NULL
18161 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18163 debug_last_unchanged_at_beg_vpos
18164 = (last_unchanged_at_beg_row
18165 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18167 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18169 #endif /* GLYPH_DEBUG */
18172 /* Display new lines. Set last_text_row to the last new line
18173 displayed which has text on it, i.e. might end up as being the
18174 line where the window_end_vpos is. */
18175 w
->cursor
.vpos
= -1;
18176 last_text_row
= NULL
;
18177 overlay_arrow_seen
= 0;
18178 while (it
.current_y
< it
.last_visible_y
18179 && !f
->fonts_changed
18180 && (first_unchanged_at_end_row
== NULL
18181 || IT_CHARPOS (it
) < stop_pos
))
18183 if (display_line (&it
))
18184 last_text_row
= it
.glyph_row
- 1;
18187 if (f
->fonts_changed
)
18190 /* The redisplay iterations in display_line above could have
18191 triggered font-lock, which could have done something that
18192 invalidates IT->w window's end-point information, on which we
18193 rely below. E.g., one package, which will remain unnamed, used
18194 to install a font-lock-fontify-region-function that called
18195 bury-buffer, whose side effect is to switch the buffer displayed
18196 by IT->w, and that predictably resets IT->w's window_end_valid
18197 flag, which we already tested at the entry to this function.
18198 Amply punish such packages/modes by giving up on this
18199 optimization in those cases. */
18200 if (!w
->window_end_valid
)
18202 clear_glyph_matrix (w
->desired_matrix
);
18206 /* Compute differences in buffer positions, y-positions etc. for
18207 lines reused at the bottom of the window. Compute what we can
18209 if (first_unchanged_at_end_row
18210 /* No lines reused because we displayed everything up to the
18211 bottom of the window. */
18212 && it
.current_y
< it
.last_visible_y
)
18215 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18217 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18218 run
.current_y
= first_unchanged_at_end_row
->y
;
18219 run
.desired_y
= run
.current_y
+ dy
;
18220 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18224 delta
= delta_bytes
= dvpos
= dy
18225 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18226 first_unchanged_at_end_row
= NULL
;
18228 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18231 /* Find the cursor if not already found. We have to decide whether
18232 PT will appear on this window (it sometimes doesn't, but this is
18233 not a very frequent case.) This decision has to be made before
18234 the current matrix is altered. A value of cursor.vpos < 0 means
18235 that PT is either in one of the lines beginning at
18236 first_unchanged_at_end_row or below the window. Don't care for
18237 lines that might be displayed later at the window end; as
18238 mentioned, this is not a frequent case. */
18239 if (w
->cursor
.vpos
< 0)
18241 /* Cursor in unchanged rows at the top? */
18242 if (PT
< CHARPOS (start_pos
)
18243 && last_unchanged_at_beg_row
)
18245 row
= row_containing_pos (w
, PT
,
18246 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18247 last_unchanged_at_beg_row
+ 1, 0);
18249 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18252 /* Start from first_unchanged_at_end_row looking for PT. */
18253 else if (first_unchanged_at_end_row
)
18255 row
= row_containing_pos (w
, PT
- delta
,
18256 first_unchanged_at_end_row
, NULL
, 0);
18258 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18259 delta_bytes
, dy
, dvpos
);
18262 /* Give up if cursor was not found. */
18263 if (w
->cursor
.vpos
< 0)
18265 clear_glyph_matrix (w
->desired_matrix
);
18270 /* Don't let the cursor end in the scroll margins. */
18272 int this_scroll_margin
, cursor_height
;
18273 int frame_line_height
= default_line_pixel_height (w
);
18274 int window_total_lines
18275 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18277 this_scroll_margin
=
18278 max (0, min (scroll_margin
, window_total_lines
/ 4));
18279 this_scroll_margin
*= frame_line_height
;
18280 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18282 if ((w
->cursor
.y
< this_scroll_margin
18283 && CHARPOS (start
) > BEGV
)
18284 /* Old redisplay didn't take scroll margin into account at the bottom,
18285 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18286 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18287 ? cursor_height
+ this_scroll_margin
18288 : 1)) > it
.last_visible_y
)
18290 w
->cursor
.vpos
= -1;
18291 clear_glyph_matrix (w
->desired_matrix
);
18296 /* Scroll the display. Do it before changing the current matrix so
18297 that xterm.c doesn't get confused about where the cursor glyph is
18299 if (dy
&& run
.height
)
18303 if (FRAME_WINDOW_P (f
))
18305 FRAME_RIF (f
)->update_window_begin_hook (w
);
18306 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18307 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18308 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
18312 /* Terminal frame. In this case, dvpos gives the number of
18313 lines to scroll by; dvpos < 0 means scroll up. */
18315 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18316 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18317 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18318 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
18319 + window_internal_height (w
));
18321 #if defined (HAVE_GPM) || defined (MSDOS)
18322 x_clear_window_mouse_face (w
);
18324 /* Perform the operation on the screen. */
18327 /* Scroll last_unchanged_at_beg_row to the end of the
18328 window down dvpos lines. */
18329 set_terminal_window (f
, end
);
18331 /* On dumb terminals delete dvpos lines at the end
18332 before inserting dvpos empty lines. */
18333 if (!FRAME_SCROLL_REGION_OK (f
))
18334 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18336 /* Insert dvpos empty lines in front of
18337 last_unchanged_at_beg_row. */
18338 ins_del_lines (f
, from
, dvpos
);
18340 else if (dvpos
< 0)
18342 /* Scroll up last_unchanged_at_beg_vpos to the end of
18343 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18344 set_terminal_window (f
, end
);
18346 /* Delete dvpos lines in front of
18347 last_unchanged_at_beg_vpos. ins_del_lines will set
18348 the cursor to the given vpos and emit |dvpos| delete
18350 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18352 /* On a dumb terminal insert dvpos empty lines at the
18354 if (!FRAME_SCROLL_REGION_OK (f
))
18355 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18358 set_terminal_window (f
, 0);
18364 /* Shift reused rows of the current matrix to the right position.
18365 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18367 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18368 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18371 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18372 bottom_vpos
, dvpos
);
18373 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18376 else if (dvpos
> 0)
18378 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18379 bottom_vpos
, dvpos
);
18380 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18381 first_unchanged_at_end_vpos
+ dvpos
);
18384 /* For frame-based redisplay, make sure that current frame and window
18385 matrix are in sync with respect to glyph memory. */
18386 if (!FRAME_WINDOW_P (f
))
18387 sync_frame_with_window_matrix_rows (w
);
18389 /* Adjust buffer positions in reused rows. */
18390 if (delta
|| delta_bytes
)
18391 increment_matrix_positions (current_matrix
,
18392 first_unchanged_at_end_vpos
+ dvpos
,
18393 bottom_vpos
, delta
, delta_bytes
);
18395 /* Adjust Y positions. */
18397 shift_glyph_matrix (w
, current_matrix
,
18398 first_unchanged_at_end_vpos
+ dvpos
,
18401 if (first_unchanged_at_end_row
)
18403 first_unchanged_at_end_row
+= dvpos
;
18404 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18405 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18406 first_unchanged_at_end_row
= NULL
;
18409 /* If scrolling up, there may be some lines to display at the end of
18411 last_text_row_at_end
= NULL
;
18414 /* Scrolling up can leave for example a partially visible line
18415 at the end of the window to be redisplayed. */
18416 /* Set last_row to the glyph row in the current matrix where the
18417 window end line is found. It has been moved up or down in
18418 the matrix by dvpos. */
18419 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18420 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18422 /* If last_row is the window end line, it should display text. */
18423 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18425 /* If window end line was partially visible before, begin
18426 displaying at that line. Otherwise begin displaying with the
18427 line following it. */
18428 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18430 init_to_row_start (&it
, w
, last_row
);
18431 it
.vpos
= last_vpos
;
18432 it
.current_y
= last_row
->y
;
18436 init_to_row_end (&it
, w
, last_row
);
18437 it
.vpos
= 1 + last_vpos
;
18438 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18442 /* We may start in a continuation line. If so, we have to
18443 get the right continuation_lines_width and current_x. */
18444 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18445 it
.hpos
= it
.current_x
= 0;
18447 /* Display the rest of the lines at the window end. */
18448 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18449 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18451 /* Is it always sure that the display agrees with lines in
18452 the current matrix? I don't think so, so we mark rows
18453 displayed invalid in the current matrix by setting their
18454 enabled_p flag to zero. */
18455 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18456 if (display_line (&it
))
18457 last_text_row_at_end
= it
.glyph_row
- 1;
18461 /* Update window_end_pos and window_end_vpos. */
18462 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18464 /* Window end line if one of the preserved rows from the current
18465 matrix. Set row to the last row displaying text in current
18466 matrix starting at first_unchanged_at_end_row, after
18468 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18469 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18470 first_unchanged_at_end_row
);
18471 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18472 adjust_window_ends (w
, row
, 1);
18473 eassert (w
->window_end_bytepos
>= 0);
18474 IF_DEBUG (debug_method_add (w
, "A"));
18476 else if (last_text_row_at_end
)
18478 adjust_window_ends (w
, last_text_row_at_end
, 0);
18479 eassert (w
->window_end_bytepos
>= 0);
18480 IF_DEBUG (debug_method_add (w
, "B"));
18482 else if (last_text_row
)
18484 /* We have displayed either to the end of the window or at the
18485 end of the window, i.e. the last row with text is to be found
18486 in the desired matrix. */
18487 adjust_window_ends (w
, last_text_row
, 0);
18488 eassert (w
->window_end_bytepos
>= 0);
18490 else if (first_unchanged_at_end_row
== NULL
18491 && last_text_row
== NULL
18492 && last_text_row_at_end
== NULL
)
18494 /* Displayed to end of window, but no line containing text was
18495 displayed. Lines were deleted at the end of the window. */
18496 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
18497 int vpos
= w
->window_end_vpos
;
18498 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18499 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18502 row
== NULL
&& vpos
>= first_vpos
;
18503 --vpos
, --current_row
, --desired_row
)
18505 if (desired_row
->enabled_p
)
18507 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18510 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18514 eassert (row
!= NULL
);
18515 w
->window_end_vpos
= vpos
+ 1;
18516 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18517 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18518 eassert (w
->window_end_bytepos
>= 0);
18519 IF_DEBUG (debug_method_add (w
, "C"));
18524 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18525 debug_end_vpos
= w
->window_end_vpos
));
18527 /* Record that display has not been completed. */
18528 w
->window_end_valid
= 0;
18529 w
->desired_matrix
->no_scrolling_p
= 1;
18537 /***********************************************************************
18538 More debugging support
18539 ***********************************************************************/
18543 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18544 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18545 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18548 /* Dump the contents of glyph matrix MATRIX on stderr.
18550 GLYPHS 0 means don't show glyph contents.
18551 GLYPHS 1 means show glyphs in short form
18552 GLYPHS > 1 means show glyphs in long form. */
18555 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18558 for (i
= 0; i
< matrix
->nrows
; ++i
)
18559 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18563 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18564 the glyph row and area where the glyph comes from. */
18567 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18569 if (glyph
->type
== CHAR_GLYPH
18570 || glyph
->type
== GLYPHLESS_GLYPH
)
18573 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18574 glyph
- row
->glyphs
[TEXT_AREA
],
18575 (glyph
->type
== CHAR_GLYPH
18579 (BUFFERP (glyph
->object
)
18581 : (STRINGP (glyph
->object
)
18583 : (INTEGERP (glyph
->object
)
18586 glyph
->pixel_width
,
18588 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18592 glyph
->left_box_line_p
,
18593 glyph
->right_box_line_p
);
18595 else if (glyph
->type
== STRETCH_GLYPH
)
18598 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18599 glyph
- row
->glyphs
[TEXT_AREA
],
18602 (BUFFERP (glyph
->object
)
18604 : (STRINGP (glyph
->object
)
18606 : (INTEGERP (glyph
->object
)
18609 glyph
->pixel_width
,
18613 glyph
->left_box_line_p
,
18614 glyph
->right_box_line_p
);
18616 else if (glyph
->type
== IMAGE_GLYPH
)
18619 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18620 glyph
- row
->glyphs
[TEXT_AREA
],
18623 (BUFFERP (glyph
->object
)
18625 : (STRINGP (glyph
->object
)
18627 : (INTEGERP (glyph
->object
)
18630 glyph
->pixel_width
,
18634 glyph
->left_box_line_p
,
18635 glyph
->right_box_line_p
);
18637 else if (glyph
->type
== COMPOSITE_GLYPH
)
18640 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18641 glyph
- row
->glyphs
[TEXT_AREA
],
18644 (BUFFERP (glyph
->object
)
18646 : (STRINGP (glyph
->object
)
18648 : (INTEGERP (glyph
->object
)
18651 glyph
->pixel_width
,
18653 if (glyph
->u
.cmp
.automatic
)
18656 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18657 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18659 glyph
->left_box_line_p
,
18660 glyph
->right_box_line_p
);
18665 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18666 GLYPHS 0 means don't show glyph contents.
18667 GLYPHS 1 means show glyphs in short form
18668 GLYPHS > 1 means show glyphs in long form. */
18671 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18675 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18676 fprintf (stderr
, "==============================================================================\n");
18678 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18679 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18681 MATRIX_ROW_START_CHARPOS (row
),
18682 MATRIX_ROW_END_CHARPOS (row
),
18683 row
->used
[TEXT_AREA
],
18684 row
->contains_overlapping_glyphs_p
,
18686 row
->truncated_on_left_p
,
18687 row
->truncated_on_right_p
,
18689 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18690 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18693 row
->ends_in_middle_of_char_p
,
18694 row
->starts_in_middle_of_char_p
,
18700 row
->visible_height
,
18703 /* The next 3 lines should align to "Start" in the header. */
18704 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18705 row
->end
.overlay_string_index
,
18706 row
->continuation_lines_width
);
18707 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18708 CHARPOS (row
->start
.string_pos
),
18709 CHARPOS (row
->end
.string_pos
));
18710 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18711 row
->end
.dpvec_index
);
18718 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18720 struct glyph
*glyph
= row
->glyphs
[area
];
18721 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18723 /* Glyph for a line end in text. */
18724 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18727 if (glyph
< glyph_end
)
18728 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18730 for (; glyph
< glyph_end
; ++glyph
)
18731 dump_glyph (row
, glyph
, area
);
18734 else if (glyphs
== 1)
18738 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18740 char *s
= alloca (row
->used
[area
] + 4);
18743 for (i
= 0; i
< row
->used
[area
]; ++i
)
18745 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18746 if (i
== row
->used
[area
] - 1
18747 && area
== TEXT_AREA
18748 && INTEGERP (glyph
->object
)
18749 && glyph
->type
== CHAR_GLYPH
18750 && glyph
->u
.ch
== ' ')
18752 strcpy (&s
[i
], "[\\n]");
18755 else if (glyph
->type
== CHAR_GLYPH
18756 && glyph
->u
.ch
< 0x80
18757 && glyph
->u
.ch
>= ' ')
18758 s
[i
] = glyph
->u
.ch
;
18764 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18770 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18771 Sdump_glyph_matrix
, 0, 1, "p",
18772 doc
: /* Dump the current matrix of the selected window to stderr.
18773 Shows contents of glyph row structures. With non-nil
18774 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18775 glyphs in short form, otherwise show glyphs in long form.
18777 Interactively, no argument means show glyphs in short form;
18778 with numeric argument, its value is passed as the GLYPHS flag. */)
18779 (Lisp_Object glyphs
)
18781 struct window
*w
= XWINDOW (selected_window
);
18782 struct buffer
*buffer
= XBUFFER (w
->contents
);
18784 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18785 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18786 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18787 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18788 fprintf (stderr
, "=============================================\n");
18789 dump_glyph_matrix (w
->current_matrix
,
18790 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18795 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18796 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
18797 Only text-mode frames have frame glyph matrices. */)
18800 struct frame
*f
= XFRAME (selected_frame
);
18802 if (f
->current_matrix
)
18803 dump_glyph_matrix (f
->current_matrix
, 1);
18805 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
18810 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18811 doc
: /* Dump glyph row ROW to stderr.
18812 GLYPH 0 means don't dump glyphs.
18813 GLYPH 1 means dump glyphs in short form.
18814 GLYPH > 1 or omitted means dump glyphs in long form. */)
18815 (Lisp_Object row
, Lisp_Object glyphs
)
18817 struct glyph_matrix
*matrix
;
18820 CHECK_NUMBER (row
);
18821 matrix
= XWINDOW (selected_window
)->current_matrix
;
18823 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18824 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18826 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18831 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18832 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18833 GLYPH 0 means don't dump glyphs.
18834 GLYPH 1 means dump glyphs in short form.
18835 GLYPH > 1 or omitted means dump glyphs in long form.
18837 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18839 (Lisp_Object row
, Lisp_Object glyphs
)
18841 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18842 struct frame
*sf
= SELECTED_FRAME ();
18843 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18846 CHECK_NUMBER (row
);
18848 if (vpos
>= 0 && vpos
< m
->nrows
)
18849 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18850 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18856 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18857 doc
: /* Toggle tracing of redisplay.
18858 With ARG, turn tracing on if and only if ARG is positive. */)
18862 trace_redisplay_p
= !trace_redisplay_p
;
18865 arg
= Fprefix_numeric_value (arg
);
18866 trace_redisplay_p
= XINT (arg
) > 0;
18873 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18874 doc
: /* Like `format', but print result to stderr.
18875 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18876 (ptrdiff_t nargs
, Lisp_Object
*args
)
18878 Lisp_Object s
= Fformat (nargs
, args
);
18879 fprintf (stderr
, "%s", SDATA (s
));
18883 #endif /* GLYPH_DEBUG */
18887 /***********************************************************************
18888 Building Desired Matrix Rows
18889 ***********************************************************************/
18891 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18892 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18894 static struct glyph_row
*
18895 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18897 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18898 struct buffer
*buffer
= XBUFFER (w
->contents
);
18899 struct buffer
*old
= current_buffer
;
18900 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18901 int arrow_len
= SCHARS (overlay_arrow_string
);
18902 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18903 const unsigned char *p
;
18906 int n_glyphs_before
;
18908 set_buffer_temp (buffer
);
18909 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18910 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18911 SET_TEXT_POS (it
.position
, 0, 0);
18913 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18915 while (p
< arrow_end
)
18917 Lisp_Object face
, ilisp
;
18919 /* Get the next character. */
18921 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18924 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18925 if (! ASCII_CHAR_P (it
.c
))
18926 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18930 /* Get its face. */
18931 ilisp
= make_number (p
- arrow_string
);
18932 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18933 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18935 /* Compute its width, get its glyphs. */
18936 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18937 SET_TEXT_POS (it
.position
, -1, -1);
18938 PRODUCE_GLYPHS (&it
);
18940 /* If this character doesn't fit any more in the line, we have
18941 to remove some glyphs. */
18942 if (it
.current_x
> it
.last_visible_x
)
18944 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18949 set_buffer_temp (old
);
18950 return it
.glyph_row
;
18954 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18955 glyphs to insert is determined by produce_special_glyphs. */
18958 insert_left_trunc_glyphs (struct it
*it
)
18960 struct it truncate_it
;
18961 struct glyph
*from
, *end
, *to
, *toend
;
18963 eassert (!FRAME_WINDOW_P (it
->f
)
18964 || (!it
->glyph_row
->reversed_p
18965 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18966 || (it
->glyph_row
->reversed_p
18967 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18969 /* Get the truncation glyphs. */
18971 truncate_it
.current_x
= 0;
18972 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18973 truncate_it
.glyph_row
= &scratch_glyph_row
;
18974 truncate_it
.area
= TEXT_AREA
;
18975 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18976 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18977 truncate_it
.object
= make_number (0);
18978 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18980 /* Overwrite glyphs from IT with truncation glyphs. */
18981 if (!it
->glyph_row
->reversed_p
)
18983 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18985 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18986 end
= from
+ tused
;
18987 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18988 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18989 if (FRAME_WINDOW_P (it
->f
))
18991 /* On GUI frames, when variable-size fonts are displayed,
18992 the truncation glyphs may need more pixels than the row's
18993 glyphs they overwrite. We overwrite more glyphs to free
18994 enough screen real estate, and enlarge the stretch glyph
18995 on the right (see display_line), if there is one, to
18996 preserve the screen position of the truncation glyphs on
18999 struct glyph
*g
= to
;
19002 /* The first glyph could be partially visible, in which case
19003 it->glyph_row->x will be negative. But we want the left
19004 truncation glyphs to be aligned at the left margin of the
19005 window, so we override the x coordinate at which the row
19007 it
->glyph_row
->x
= 0;
19008 while (g
< toend
&& w
< it
->truncation_pixel_width
)
19010 w
+= g
->pixel_width
;
19013 if (g
- to
- tused
> 0)
19015 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
19016 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
19018 used
= it
->glyph_row
->used
[TEXT_AREA
];
19019 if (it
->glyph_row
->truncated_on_right_p
19020 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
19021 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
19024 int extra
= w
- it
->truncation_pixel_width
;
19026 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
19033 /* There may be padding glyphs left over. Overwrite them too. */
19034 if (!FRAME_WINDOW_P (it
->f
))
19036 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19038 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19045 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19049 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19051 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19052 that back to front. */
19053 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19054 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19055 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19056 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19057 if (FRAME_WINDOW_P (it
->f
))
19060 struct glyph
*g
= to
;
19062 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19064 w
+= g
->pixel_width
;
19067 if (to
- g
- tused
> 0)
19069 if (it
->glyph_row
->truncated_on_right_p
19070 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19071 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19073 int extra
= w
- it
->truncation_pixel_width
;
19075 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19079 while (from
>= end
&& to
>= toend
)
19081 if (!FRAME_WINDOW_P (it
->f
))
19083 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19086 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19087 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19088 while (from
>= end
&& to
>= toend
)
19094 /* Need to free some room before prepending additional
19096 int move_by
= from
- end
+ 1;
19097 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19098 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19100 for ( ; g
>= g0
; g
--)
19102 while (from
>= end
)
19104 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19109 /* Compute the hash code for ROW. */
19111 row_hash (struct glyph_row
*row
)
19114 unsigned hashval
= 0;
19116 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19117 for (k
= 0; k
< row
->used
[area
]; ++k
)
19118 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19119 + row
->glyphs
[area
][k
].u
.val
19120 + row
->glyphs
[area
][k
].face_id
19121 + row
->glyphs
[area
][k
].padding_p
19122 + (row
->glyphs
[area
][k
].type
<< 2));
19127 /* Compute the pixel height and width of IT->glyph_row.
19129 Most of the time, ascent and height of a display line will be equal
19130 to the max_ascent and max_height values of the display iterator
19131 structure. This is not the case if
19133 1. We hit ZV without displaying anything. In this case, max_ascent
19134 and max_height will be zero.
19136 2. We have some glyphs that don't contribute to the line height.
19137 (The glyph row flag contributes_to_line_height_p is for future
19138 pixmap extensions).
19140 The first case is easily covered by using default values because in
19141 these cases, the line height does not really matter, except that it
19142 must not be zero. */
19145 compute_line_metrics (struct it
*it
)
19147 struct glyph_row
*row
= it
->glyph_row
;
19149 if (FRAME_WINDOW_P (it
->f
))
19151 int i
, min_y
, max_y
;
19153 /* The line may consist of one space only, that was added to
19154 place the cursor on it. If so, the row's height hasn't been
19156 if (row
->height
== 0)
19158 if (it
->max_ascent
+ it
->max_descent
== 0)
19159 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19160 row
->ascent
= it
->max_ascent
;
19161 row
->height
= it
->max_ascent
+ it
->max_descent
;
19162 row
->phys_ascent
= it
->max_phys_ascent
;
19163 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19164 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19167 /* Compute the width of this line. */
19168 row
->pixel_width
= row
->x
;
19169 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19170 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19172 eassert (row
->pixel_width
>= 0);
19173 eassert (row
->ascent
>= 0 && row
->height
> 0);
19175 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19176 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19178 /* If first line's physical ascent is larger than its logical
19179 ascent, use the physical ascent, and make the row taller.
19180 This makes accented characters fully visible. */
19181 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19182 && row
->phys_ascent
> row
->ascent
)
19184 row
->height
+= row
->phys_ascent
- row
->ascent
;
19185 row
->ascent
= row
->phys_ascent
;
19188 /* Compute how much of the line is visible. */
19189 row
->visible_height
= row
->height
;
19191 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19192 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19194 if (row
->y
< min_y
)
19195 row
->visible_height
-= min_y
- row
->y
;
19196 if (row
->y
+ row
->height
> max_y
)
19197 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19201 row
->pixel_width
= row
->used
[TEXT_AREA
];
19202 if (row
->continued_p
)
19203 row
->pixel_width
-= it
->continuation_pixel_width
;
19204 else if (row
->truncated_on_right_p
)
19205 row
->pixel_width
-= it
->truncation_pixel_width
;
19206 row
->ascent
= row
->phys_ascent
= 0;
19207 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19208 row
->extra_line_spacing
= 0;
19211 /* Compute a hash code for this row. */
19212 row
->hash
= row_hash (row
);
19214 it
->max_ascent
= it
->max_descent
= 0;
19215 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19219 /* Append one space to the glyph row of iterator IT if doing a
19220 window-based redisplay. The space has the same face as
19221 IT->face_id. Value is non-zero if a space was added.
19223 This function is called to make sure that there is always one glyph
19224 at the end of a glyph row that the cursor can be set on under
19225 window-systems. (If there weren't such a glyph we would not know
19226 how wide and tall a box cursor should be displayed).
19228 At the same time this space let's a nicely handle clearing to the
19229 end of the line if the row ends in italic text. */
19232 append_space_for_newline (struct it
*it
, int default_face_p
)
19234 if (FRAME_WINDOW_P (it
->f
))
19236 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19238 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19239 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19241 /* Save some values that must not be changed.
19242 Must save IT->c and IT->len because otherwise
19243 ITERATOR_AT_END_P wouldn't work anymore after
19244 append_space_for_newline has been called. */
19245 enum display_element_type saved_what
= it
->what
;
19246 int saved_c
= it
->c
, saved_len
= it
->len
;
19247 int saved_char_to_display
= it
->char_to_display
;
19248 int saved_x
= it
->current_x
;
19249 int saved_face_id
= it
->face_id
;
19250 int saved_box_end
= it
->end_of_box_run_p
;
19251 struct text_pos saved_pos
;
19252 Lisp_Object saved_object
;
19255 saved_object
= it
->object
;
19256 saved_pos
= it
->position
;
19258 it
->what
= IT_CHARACTER
;
19259 memset (&it
->position
, 0, sizeof it
->position
);
19260 it
->object
= make_number (0);
19261 it
->c
= it
->char_to_display
= ' ';
19264 /* If the default face was remapped, be sure to use the
19265 remapped face for the appended newline. */
19266 if (default_face_p
)
19267 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19268 else if (it
->face_before_selective_p
)
19269 it
->face_id
= it
->saved_face_id
;
19270 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19271 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19272 /* In R2L rows, we will prepend a stretch glyph that will
19273 have the end_of_box_run_p flag set for it, so there's no
19274 need for the appended newline glyph to have that flag
19276 if (it
->glyph_row
->reversed_p
19277 /* But if the appended newline glyph goes all the way to
19278 the end of the row, there will be no stretch glyph,
19279 so leave the box flag set. */
19280 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19281 it
->end_of_box_run_p
= 0;
19283 PRODUCE_GLYPHS (it
);
19285 it
->override_ascent
= -1;
19286 it
->constrain_row_ascent_descent_p
= 0;
19287 it
->current_x
= saved_x
;
19288 it
->object
= saved_object
;
19289 it
->position
= saved_pos
;
19290 it
->what
= saved_what
;
19291 it
->face_id
= saved_face_id
;
19292 it
->len
= saved_len
;
19294 it
->char_to_display
= saved_char_to_display
;
19295 it
->end_of_box_run_p
= saved_box_end
;
19304 /* Extend the face of the last glyph in the text area of IT->glyph_row
19305 to the end of the display line. Called from display_line. If the
19306 glyph row is empty, add a space glyph to it so that we know the
19307 face to draw. Set the glyph row flag fill_line_p. If the glyph
19308 row is R2L, prepend a stretch glyph to cover the empty space to the
19309 left of the leftmost glyph. */
19312 extend_face_to_end_of_line (struct it
*it
)
19314 struct face
*face
, *default_face
;
19315 struct frame
*f
= it
->f
;
19317 /* If line is already filled, do nothing. Non window-system frames
19318 get a grace of one more ``pixel'' because their characters are
19319 1-``pixel'' wide, so they hit the equality too early. This grace
19320 is needed only for R2L rows that are not continued, to produce
19321 one extra blank where we could display the cursor. */
19322 if ((it
->current_x
>= it
->last_visible_x
19323 + (!FRAME_WINDOW_P (f
)
19324 && it
->glyph_row
->reversed_p
19325 && !it
->glyph_row
->continued_p
))
19326 /* If the window has display margins, we will need to extend
19327 their face even if the text area is filled. */
19328 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19329 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19332 /* The default face, possibly remapped. */
19333 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19335 /* Face extension extends the background and box of IT->face_id
19336 to the end of the line. If the background equals the background
19337 of the frame, we don't have to do anything. */
19338 if (it
->face_before_selective_p
)
19339 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19341 face
= FACE_FROM_ID (f
, it
->face_id
);
19343 if (FRAME_WINDOW_P (f
)
19344 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19345 && face
->box
== FACE_NO_BOX
19346 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19347 #ifdef HAVE_WINDOW_SYSTEM
19350 && !it
->glyph_row
->reversed_p
)
19353 /* Set the glyph row flag indicating that the face of the last glyph
19354 in the text area has to be drawn to the end of the text area. */
19355 it
->glyph_row
->fill_line_p
= 1;
19357 /* If current character of IT is not ASCII, make sure we have the
19358 ASCII face. This will be automatically undone the next time
19359 get_next_display_element returns a multibyte character. Note
19360 that the character will always be single byte in unibyte
19362 if (!ASCII_CHAR_P (it
->c
))
19364 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19367 if (FRAME_WINDOW_P (f
))
19369 /* If the row is empty, add a space with the current face of IT,
19370 so that we know which face to draw. */
19371 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19373 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19374 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19375 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19377 /* Mode line and the header line don't have margins, and
19378 likewise the frame's tool-bar window, if there is any. */
19379 if (!(it
->glyph_row
->mode_line_p
19380 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19381 || (WINDOWP (f
->tool_bar_window
)
19382 && it
->w
== XWINDOW (f
->tool_bar_window
))
19386 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19387 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19389 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19390 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19392 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19394 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19395 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19397 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19398 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19400 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19403 #ifdef HAVE_WINDOW_SYSTEM
19404 if (it
->glyph_row
->reversed_p
)
19406 /* Prepend a stretch glyph to the row, such that the
19407 rightmost glyph will be drawn flushed all the way to the
19408 right margin of the window. The stretch glyph that will
19409 occupy the empty space, if any, to the left of the
19411 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19412 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19413 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19415 int row_width
, stretch_ascent
, stretch_width
;
19416 struct text_pos saved_pos
;
19417 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
19419 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19420 row_width
+= g
->pixel_width
;
19422 /* FIXME: There are various minor display glitches in R2L
19423 rows when only one of the fringes is missing. The
19424 strange condition below produces the least bad effect. */
19425 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19426 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19427 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19428 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19430 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19431 stretch_width
-= row_width
;
19433 if (stretch_width
> 0)
19436 (((it
->ascent
+ it
->descent
)
19437 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19438 saved_pos
= it
->position
;
19439 memset (&it
->position
, 0, sizeof it
->position
);
19440 saved_avoid_cursor
= it
->avoid_cursor_p
;
19441 it
->avoid_cursor_p
= 1;
19442 saved_face_id
= it
->face_id
;
19443 saved_box_start
= it
->start_of_box_run_p
;
19444 /* The last row's stretch glyph should get the default
19445 face, to avoid painting the rest of the window with
19446 the region face, if the region ends at ZV. */
19447 if (it
->glyph_row
->ends_at_zv_p
)
19448 it
->face_id
= default_face
->id
;
19450 it
->face_id
= face
->id
;
19451 it
->start_of_box_run_p
= 0;
19452 append_stretch_glyph (it
, make_number (0), stretch_width
,
19453 it
->ascent
+ it
->descent
, stretch_ascent
);
19454 it
->position
= saved_pos
;
19455 it
->avoid_cursor_p
= saved_avoid_cursor
;
19456 it
->face_id
= saved_face_id
;
19457 it
->start_of_box_run_p
= saved_box_start
;
19459 /* If stretch_width comes out negative, it means that the
19460 last glyph is only partially visible. In R2L rows, we
19461 want the leftmost glyph to be partially visible, so we
19462 need to give the row the corresponding left offset. */
19463 if (stretch_width
< 0)
19464 it
->glyph_row
->x
= stretch_width
;
19466 #endif /* HAVE_WINDOW_SYSTEM */
19470 /* Save some values that must not be changed. */
19471 int saved_x
= it
->current_x
;
19472 struct text_pos saved_pos
;
19473 Lisp_Object saved_object
;
19474 enum display_element_type saved_what
= it
->what
;
19475 int saved_face_id
= it
->face_id
;
19477 saved_object
= it
->object
;
19478 saved_pos
= it
->position
;
19480 it
->what
= IT_CHARACTER
;
19481 memset (&it
->position
, 0, sizeof it
->position
);
19482 it
->object
= make_number (0);
19483 it
->c
= it
->char_to_display
= ' ';
19486 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19487 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19488 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19489 && !it
->glyph_row
->mode_line_p
19490 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19492 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19493 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19495 for (it
->current_x
= 0; g
< e
; g
++)
19496 it
->current_x
+= g
->pixel_width
;
19498 it
->area
= LEFT_MARGIN_AREA
;
19499 it
->face_id
= default_face
->id
;
19500 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19501 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19503 PRODUCE_GLYPHS (it
);
19504 /* term.c:produce_glyphs advances it->current_x only for
19506 it
->current_x
+= it
->pixel_width
;
19509 it
->current_x
= saved_x
;
19510 it
->area
= TEXT_AREA
;
19513 /* The last row's blank glyphs should get the default face, to
19514 avoid painting the rest of the window with the region face,
19515 if the region ends at ZV. */
19516 if (it
->glyph_row
->ends_at_zv_p
)
19517 it
->face_id
= default_face
->id
;
19519 it
->face_id
= face
->id
;
19520 PRODUCE_GLYPHS (it
);
19522 while (it
->current_x
<= it
->last_visible_x
)
19523 PRODUCE_GLYPHS (it
);
19525 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19526 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19527 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19528 && !it
->glyph_row
->mode_line_p
19529 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19531 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19532 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19534 for ( ; g
< e
; g
++)
19535 it
->current_x
+= g
->pixel_width
;
19537 it
->area
= RIGHT_MARGIN_AREA
;
19538 it
->face_id
= default_face
->id
;
19539 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19540 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19542 PRODUCE_GLYPHS (it
);
19543 it
->current_x
+= it
->pixel_width
;
19546 it
->area
= TEXT_AREA
;
19549 /* Don't count these blanks really. It would let us insert a left
19550 truncation glyph below and make us set the cursor on them, maybe. */
19551 it
->current_x
= saved_x
;
19552 it
->object
= saved_object
;
19553 it
->position
= saved_pos
;
19554 it
->what
= saved_what
;
19555 it
->face_id
= saved_face_id
;
19560 /* Value is non-zero if text starting at CHARPOS in current_buffer is
19561 trailing whitespace. */
19564 trailing_whitespace_p (ptrdiff_t charpos
)
19566 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19569 while (bytepos
< ZV_BYTE
19570 && (c
= FETCH_CHAR (bytepos
),
19571 c
== ' ' || c
== '\t'))
19574 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19576 if (bytepos
!= PT_BYTE
)
19583 /* Highlight trailing whitespace, if any, in ROW. */
19586 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19588 int used
= row
->used
[TEXT_AREA
];
19592 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19593 struct glyph
*glyph
= start
+ used
- 1;
19595 if (row
->reversed_p
)
19597 /* Right-to-left rows need to be processed in the opposite
19598 direction, so swap the edge pointers. */
19600 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19603 /* Skip over glyphs inserted to display the cursor at the
19604 end of a line, for extending the face of the last glyph
19605 to the end of the line on terminals, and for truncation
19606 and continuation glyphs. */
19607 if (!row
->reversed_p
)
19609 while (glyph
>= start
19610 && glyph
->type
== CHAR_GLYPH
19611 && INTEGERP (glyph
->object
))
19616 while (glyph
<= start
19617 && glyph
->type
== CHAR_GLYPH
19618 && INTEGERP (glyph
->object
))
19622 /* If last glyph is a space or stretch, and it's trailing
19623 whitespace, set the face of all trailing whitespace glyphs in
19624 IT->glyph_row to `trailing-whitespace'. */
19625 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19626 && BUFFERP (glyph
->object
)
19627 && (glyph
->type
== STRETCH_GLYPH
19628 || (glyph
->type
== CHAR_GLYPH
19629 && glyph
->u
.ch
== ' '))
19630 && trailing_whitespace_p (glyph
->charpos
))
19632 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
19636 if (!row
->reversed_p
)
19638 while (glyph
>= start
19639 && BUFFERP (glyph
->object
)
19640 && (glyph
->type
== STRETCH_GLYPH
19641 || (glyph
->type
== CHAR_GLYPH
19642 && glyph
->u
.ch
== ' ')))
19643 (glyph
--)->face_id
= face_id
;
19647 while (glyph
<= start
19648 && BUFFERP (glyph
->object
)
19649 && (glyph
->type
== STRETCH_GLYPH
19650 || (glyph
->type
== CHAR_GLYPH
19651 && glyph
->u
.ch
== ' ')))
19652 (glyph
++)->face_id
= face_id
;
19659 /* Value is non-zero if glyph row ROW should be
19660 considered to hold the buffer position CHARPOS. */
19663 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19667 if (charpos
== CHARPOS (row
->end
.pos
)
19668 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19670 /* Suppose the row ends on a string.
19671 Unless the row is continued, that means it ends on a newline
19672 in the string. If it's anything other than a display string
19673 (e.g., a before-string from an overlay), we don't want the
19674 cursor there. (This heuristic seems to give the optimal
19675 behavior for the various types of multi-line strings.)
19676 One exception: if the string has `cursor' property on one of
19677 its characters, we _do_ want the cursor there. */
19678 if (CHARPOS (row
->end
.string_pos
) >= 0)
19680 if (row
->continued_p
)
19684 /* Check for `display' property. */
19685 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19686 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19687 struct glyph
*glyph
;
19690 for (glyph
= end
; glyph
>= beg
; --glyph
)
19691 if (STRINGP (glyph
->object
))
19694 = Fget_char_property (make_number (charpos
),
19698 && display_prop_string_p (prop
, glyph
->object
));
19699 /* If there's a `cursor' property on one of the
19700 string's characters, this row is a cursor row,
19701 even though this is not a display string. */
19704 Lisp_Object s
= glyph
->object
;
19706 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19708 ptrdiff_t gpos
= glyph
->charpos
;
19710 if (!NILP (Fget_char_property (make_number (gpos
),
19722 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19724 /* If the row ends in middle of a real character,
19725 and the line is continued, we want the cursor here.
19726 That's because CHARPOS (ROW->end.pos) would equal
19727 PT if PT is before the character. */
19728 if (!row
->ends_in_ellipsis_p
)
19729 result
= row
->continued_p
;
19731 /* If the row ends in an ellipsis, then
19732 CHARPOS (ROW->end.pos) will equal point after the
19733 invisible text. We want that position to be displayed
19734 after the ellipsis. */
19737 /* If the row ends at ZV, display the cursor at the end of that
19738 row instead of at the start of the row below. */
19739 else if (row
->ends_at_zv_p
)
19748 /* Value is non-zero if glyph row ROW should be
19749 used to hold the cursor. */
19752 cursor_row_p (struct glyph_row
*row
)
19754 return row_for_charpos_p (row
, PT
);
19759 /* Push the property PROP so that it will be rendered at the current
19760 position in IT. Return 1 if PROP was successfully pushed, 0
19761 otherwise. Called from handle_line_prefix to handle the
19762 `line-prefix' and `wrap-prefix' properties. */
19765 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19767 struct text_pos pos
=
19768 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19770 eassert (it
->method
== GET_FROM_BUFFER
19771 || it
->method
== GET_FROM_DISPLAY_VECTOR
19772 || it
->method
== GET_FROM_STRING
);
19774 /* We need to save the current buffer/string position, so it will be
19775 restored by pop_it, because iterate_out_of_display_property
19776 depends on that being set correctly, but some situations leave
19777 it->position not yet set when this function is called. */
19778 push_it (it
, &pos
);
19780 if (STRINGP (prop
))
19782 if (SCHARS (prop
) == 0)
19789 it
->string_from_prefix_prop_p
= 1;
19790 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19791 it
->current
.overlay_string_index
= -1;
19792 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19793 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19794 it
->method
= GET_FROM_STRING
;
19795 it
->stop_charpos
= 0;
19797 it
->base_level_stop
= 0;
19799 /* Force paragraph direction to be that of the parent
19801 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19802 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19804 it
->paragraph_embedding
= L2R
;
19806 /* Set up the bidi iterator for this display string. */
19809 it
->bidi_it
.string
.lstring
= it
->string
;
19810 it
->bidi_it
.string
.s
= NULL
;
19811 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19812 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19813 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19814 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19815 it
->bidi_it
.w
= it
->w
;
19816 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19819 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19821 it
->method
= GET_FROM_STRETCH
;
19824 #ifdef HAVE_WINDOW_SYSTEM
19825 else if (IMAGEP (prop
))
19827 it
->what
= IT_IMAGE
;
19828 it
->image_id
= lookup_image (it
->f
, prop
);
19829 it
->method
= GET_FROM_IMAGE
;
19831 #endif /* HAVE_WINDOW_SYSTEM */
19834 pop_it (it
); /* bogus display property, give up */
19841 /* Return the character-property PROP at the current position in IT. */
19844 get_it_property (struct it
*it
, Lisp_Object prop
)
19846 Lisp_Object position
, object
= it
->object
;
19848 if (STRINGP (object
))
19849 position
= make_number (IT_STRING_CHARPOS (*it
));
19850 else if (BUFFERP (object
))
19852 position
= make_number (IT_CHARPOS (*it
));
19853 object
= it
->window
;
19858 return Fget_char_property (position
, prop
, object
);
19861 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19864 handle_line_prefix (struct it
*it
)
19866 Lisp_Object prefix
;
19868 if (it
->continuation_lines_width
> 0)
19870 prefix
= get_it_property (it
, Qwrap_prefix
);
19872 prefix
= Vwrap_prefix
;
19876 prefix
= get_it_property (it
, Qline_prefix
);
19878 prefix
= Vline_prefix
;
19880 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19882 /* If the prefix is wider than the window, and we try to wrap
19883 it, it would acquire its own wrap prefix, and so on till the
19884 iterator stack overflows. So, don't wrap the prefix. */
19885 it
->line_wrap
= TRUNCATE
;
19886 it
->avoid_cursor_p
= 1;
19892 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19893 only for R2L lines from display_line and display_string, when they
19894 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19895 the line/string needs to be continued on the next glyph row. */
19897 unproduce_glyphs (struct it
*it
, int n
)
19899 struct glyph
*glyph
, *end
;
19901 eassert (it
->glyph_row
);
19902 eassert (it
->glyph_row
->reversed_p
);
19903 eassert (it
->area
== TEXT_AREA
);
19904 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19906 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19907 n
= it
->glyph_row
->used
[TEXT_AREA
];
19908 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19909 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19910 for ( ; glyph
< end
; glyph
++)
19911 glyph
[-n
] = *glyph
;
19914 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19915 and ROW->maxpos. */
19917 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19918 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19919 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19921 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19922 lines' rows is implemented for bidi-reordered rows. */
19924 /* ROW->minpos is the value of min_pos, the minimal buffer position
19925 we have in ROW, or ROW->start.pos if that is smaller. */
19926 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19927 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19929 /* We didn't find buffer positions smaller than ROW->start, or
19930 didn't find _any_ valid buffer positions in any of the glyphs,
19931 so we must trust the iterator's computed positions. */
19932 row
->minpos
= row
->start
.pos
;
19935 max_pos
= CHARPOS (it
->current
.pos
);
19936 max_bpos
= BYTEPOS (it
->current
.pos
);
19939 /* Here are the various use-cases for ending the row, and the
19940 corresponding values for ROW->maxpos:
19942 Line ends in a newline from buffer eol_pos + 1
19943 Line is continued from buffer max_pos + 1
19944 Line is truncated on right it->current.pos
19945 Line ends in a newline from string max_pos + 1(*)
19946 (*) + 1 only when line ends in a forward scan
19947 Line is continued from string max_pos
19948 Line is continued from display vector max_pos
19949 Line is entirely from a string min_pos == max_pos
19950 Line is entirely from a display vector min_pos == max_pos
19951 Line that ends at ZV ZV
19953 If you discover other use-cases, please add them here as
19955 if (row
->ends_at_zv_p
)
19956 row
->maxpos
= it
->current
.pos
;
19957 else if (row
->used
[TEXT_AREA
])
19959 int seen_this_string
= 0;
19960 struct glyph_row
*r1
= row
- 1;
19962 /* Did we see the same display string on the previous row? */
19963 if (STRINGP (it
->object
)
19964 /* this is not the first row */
19965 && row
> it
->w
->desired_matrix
->rows
19966 /* previous row is not the header line */
19967 && !r1
->mode_line_p
19968 /* previous row also ends in a newline from a string */
19969 && r1
->ends_in_newline_from_string_p
)
19971 struct glyph
*start
, *end
;
19973 /* Search for the last glyph of the previous row that came
19974 from buffer or string. Depending on whether the row is
19975 L2R or R2L, we need to process it front to back or the
19976 other way round. */
19977 if (!r1
->reversed_p
)
19979 start
= r1
->glyphs
[TEXT_AREA
];
19980 end
= start
+ r1
->used
[TEXT_AREA
];
19981 /* Glyphs inserted by redisplay have an integer (zero)
19982 as their object. */
19984 && INTEGERP ((end
- 1)->object
)
19985 && (end
- 1)->charpos
<= 0)
19989 if (EQ ((end
- 1)->object
, it
->object
))
19990 seen_this_string
= 1;
19993 /* If all the glyphs of the previous row were inserted
19994 by redisplay, it means the previous row was
19995 produced from a single newline, which is only
19996 possible if that newline came from the same string
19997 as the one which produced this ROW. */
19998 seen_this_string
= 1;
20002 end
= r1
->glyphs
[TEXT_AREA
] - 1;
20003 start
= end
+ r1
->used
[TEXT_AREA
];
20005 && INTEGERP ((end
+ 1)->object
)
20006 && (end
+ 1)->charpos
<= 0)
20010 if (EQ ((end
+ 1)->object
, it
->object
))
20011 seen_this_string
= 1;
20014 seen_this_string
= 1;
20017 /* Take note of each display string that covers a newline only
20018 once, the first time we see it. This is for when a display
20019 string includes more than one newline in it. */
20020 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20022 /* If we were scanning the buffer forward when we displayed
20023 the string, we want to account for at least one buffer
20024 position that belongs to this row (position covered by
20025 the display string), so that cursor positioning will
20026 consider this row as a candidate when point is at the end
20027 of the visual line represented by this row. This is not
20028 required when scanning back, because max_pos will already
20029 have a much larger value. */
20030 if (CHARPOS (row
->end
.pos
) > max_pos
)
20031 INC_BOTH (max_pos
, max_bpos
);
20032 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20034 else if (CHARPOS (it
->eol_pos
) > 0)
20035 SET_TEXT_POS (row
->maxpos
,
20036 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20037 else if (row
->continued_p
)
20039 /* If max_pos is different from IT's current position, it
20040 means IT->method does not belong to the display element
20041 at max_pos. However, it also means that the display
20042 element at max_pos was displayed in its entirety on this
20043 line, which is equivalent to saying that the next line
20044 starts at the next buffer position. */
20045 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20046 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20049 INC_BOTH (max_pos
, max_bpos
);
20050 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20053 else if (row
->truncated_on_right_p
)
20054 /* display_line already called reseat_at_next_visible_line_start,
20055 which puts the iterator at the beginning of the next line, in
20056 the logical order. */
20057 row
->maxpos
= it
->current
.pos
;
20058 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20059 /* A line that is entirely from a string/image/stretch... */
20060 row
->maxpos
= row
->minpos
;
20065 row
->maxpos
= it
->current
.pos
;
20068 /* Construct the glyph row IT->glyph_row in the desired matrix of
20069 IT->w from text at the current position of IT. See dispextern.h
20070 for an overview of struct it. Value is non-zero if
20071 IT->glyph_row displays text, as opposed to a line displaying ZV
20075 display_line (struct it
*it
)
20077 struct glyph_row
*row
= it
->glyph_row
;
20078 Lisp_Object overlay_arrow_string
;
20080 void *wrap_data
= NULL
;
20081 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
20082 int wrap_row_used
= -1;
20083 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20084 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20085 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20086 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20087 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20089 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20090 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20091 bool pending_handle_line_prefix
= false;
20093 /* We always start displaying at hpos zero even if hscrolled. */
20094 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20096 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20097 >= it
->w
->desired_matrix
->nrows
)
20099 it
->w
->nrows_scale_factor
++;
20100 it
->f
->fonts_changed
= 1;
20104 /* Clear the result glyph row and enable it. */
20105 prepare_desired_row (it
->w
, row
, false);
20107 row
->y
= it
->current_y
;
20108 row
->start
= it
->start
;
20109 row
->continuation_lines_width
= it
->continuation_lines_width
;
20110 row
->displays_text_p
= 1;
20111 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20112 it
->starts_in_middle_of_char_p
= 0;
20114 /* Arrange the overlays nicely for our purposes. Usually, we call
20115 display_line on only one line at a time, in which case this
20116 can't really hurt too much, or we call it on lines which appear
20117 one after another in the buffer, in which case all calls to
20118 recenter_overlay_lists but the first will be pretty cheap. */
20119 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20121 /* Move over display elements that are not visible because we are
20122 hscrolled. This may stop at an x-position < IT->first_visible_x
20123 if the first glyph is partially visible or if we hit a line end. */
20124 if (it
->current_x
< it
->first_visible_x
)
20126 enum move_it_result move_result
;
20128 this_line_min_pos
= row
->start
.pos
;
20129 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20130 MOVE_TO_POS
| MOVE_TO_X
);
20131 /* If we are under a large hscroll, move_it_in_display_line_to
20132 could hit the end of the line without reaching
20133 it->first_visible_x. Pretend that we did reach it. This is
20134 especially important on a TTY, where we will call
20135 extend_face_to_end_of_line, which needs to know how many
20136 blank glyphs to produce. */
20137 if (it
->current_x
< it
->first_visible_x
20138 && (move_result
== MOVE_NEWLINE_OR_CR
20139 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20140 it
->current_x
= it
->first_visible_x
;
20142 /* Record the smallest positions seen while we moved over
20143 display elements that are not visible. This is needed by
20144 redisplay_internal for optimizing the case where the cursor
20145 stays inside the same line. The rest of this function only
20146 considers positions that are actually displayed, so
20147 RECORD_MAX_MIN_POS will not otherwise record positions that
20148 are hscrolled to the left of the left edge of the window. */
20149 min_pos
= CHARPOS (this_line_min_pos
);
20150 min_bpos
= BYTEPOS (this_line_min_pos
);
20152 else if (it
->area
== TEXT_AREA
)
20154 /* We only do this when not calling move_it_in_display_line_to
20155 above, because that function calls itself handle_line_prefix. */
20156 handle_line_prefix (it
);
20160 /* Line-prefix and wrap-prefix are always displayed in the text
20161 area. But if this is the first call to display_line after
20162 init_iterator, the iterator might have been set up to write
20163 into a marginal area, e.g. if the line begins with some
20164 display property that writes to the margins. So we need to
20165 wait with the call to handle_line_prefix until whatever
20166 writes to the margin has done its job. */
20167 pending_handle_line_prefix
= true;
20170 /* Get the initial row height. This is either the height of the
20171 text hscrolled, if there is any, or zero. */
20172 row
->ascent
= it
->max_ascent
;
20173 row
->height
= it
->max_ascent
+ it
->max_descent
;
20174 row
->phys_ascent
= it
->max_phys_ascent
;
20175 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20176 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20178 /* Utility macro to record max and min buffer positions seen until now. */
20179 #define RECORD_MAX_MIN_POS(IT) \
20182 int composition_p = !STRINGP ((IT)->string) \
20183 && ((IT)->what == IT_COMPOSITION); \
20184 ptrdiff_t current_pos = \
20185 composition_p ? (IT)->cmp_it.charpos \
20186 : IT_CHARPOS (*(IT)); \
20187 ptrdiff_t current_bpos = \
20188 composition_p ? CHAR_TO_BYTE (current_pos) \
20189 : IT_BYTEPOS (*(IT)); \
20190 if (current_pos < min_pos) \
20192 min_pos = current_pos; \
20193 min_bpos = current_bpos; \
20195 if (IT_CHARPOS (*it) > max_pos) \
20197 max_pos = IT_CHARPOS (*it); \
20198 max_bpos = IT_BYTEPOS (*it); \
20203 /* Loop generating characters. The loop is left with IT on the next
20204 character to display. */
20207 int n_glyphs_before
, hpos_before
, x_before
;
20209 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20211 /* Retrieve the next thing to display. Value is zero if end of
20213 if (!get_next_display_element (it
))
20215 /* Maybe add a space at the end of this line that is used to
20216 display the cursor there under X. Set the charpos of the
20217 first glyph of blank lines not corresponding to any text
20219 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20220 row
->exact_window_width_line_p
= 1;
20221 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
20222 || row
->used
[TEXT_AREA
] == 0)
20224 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20225 row
->displays_text_p
= 0;
20227 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20228 && (!MINI_WINDOW_P (it
->w
)
20229 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20230 row
->indicate_empty_line_p
= 1;
20233 it
->continuation_lines_width
= 0;
20234 row
->ends_at_zv_p
= 1;
20235 /* A row that displays right-to-left text must always have
20236 its last face extended all the way to the end of line,
20237 even if this row ends in ZV, because we still write to
20238 the screen left to right. We also need to extend the
20239 last face if the default face is remapped to some
20240 different face, otherwise the functions that clear
20241 portions of the screen will clear with the default face's
20242 background color. */
20243 if (row
->reversed_p
20244 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20245 extend_face_to_end_of_line (it
);
20249 /* Now, get the metrics of what we want to display. This also
20250 generates glyphs in `row' (which is IT->glyph_row). */
20251 n_glyphs_before
= row
->used
[TEXT_AREA
];
20254 /* Remember the line height so far in case the next element doesn't
20255 fit on the line. */
20256 if (it
->line_wrap
!= TRUNCATE
)
20258 ascent
= it
->max_ascent
;
20259 descent
= it
->max_descent
;
20260 phys_ascent
= it
->max_phys_ascent
;
20261 phys_descent
= it
->max_phys_descent
;
20263 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20265 if (IT_DISPLAYING_WHITESPACE (it
))
20269 SAVE_IT (wrap_it
, *it
, wrap_data
);
20271 wrap_row_used
= row
->used
[TEXT_AREA
];
20272 wrap_row_ascent
= row
->ascent
;
20273 wrap_row_height
= row
->height
;
20274 wrap_row_phys_ascent
= row
->phys_ascent
;
20275 wrap_row_phys_height
= row
->phys_height
;
20276 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20277 wrap_row_min_pos
= min_pos
;
20278 wrap_row_min_bpos
= min_bpos
;
20279 wrap_row_max_pos
= max_pos
;
20280 wrap_row_max_bpos
= max_bpos
;
20286 PRODUCE_GLYPHS (it
);
20288 /* If this display element was in marginal areas, continue with
20290 if (it
->area
!= TEXT_AREA
)
20292 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20293 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20294 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20295 row
->phys_height
= max (row
->phys_height
,
20296 it
->max_phys_ascent
+ it
->max_phys_descent
);
20297 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20298 it
->max_extra_line_spacing
);
20299 set_iterator_to_next (it
, 1);
20300 /* If we didn't handle the line/wrap prefix above, and the
20301 call to set_iterator_to_next just switched to TEXT_AREA,
20302 process the prefix now. */
20303 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20305 pending_handle_line_prefix
= false;
20306 handle_line_prefix (it
);
20311 /* Does the display element fit on the line? If we truncate
20312 lines, we should draw past the right edge of the window. If
20313 we don't truncate, we want to stop so that we can display the
20314 continuation glyph before the right margin. If lines are
20315 continued, there are two possible strategies for characters
20316 resulting in more than 1 glyph (e.g. tabs): Display as many
20317 glyphs as possible in this line and leave the rest for the
20318 continuation line, or display the whole element in the next
20319 line. Original redisplay did the former, so we do it also. */
20320 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20321 hpos_before
= it
->hpos
;
20324 if (/* Not a newline. */
20326 /* Glyphs produced fit entirely in the line. */
20327 && it
->current_x
< it
->last_visible_x
)
20329 it
->hpos
+= nglyphs
;
20330 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20331 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20332 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20333 row
->phys_height
= max (row
->phys_height
,
20334 it
->max_phys_ascent
+ it
->max_phys_descent
);
20335 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20336 it
->max_extra_line_spacing
);
20337 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20338 /* In R2L rows, we arrange in extend_face_to_end_of_line
20339 to add a right offset to the line, by a suitable
20340 change to the stretch glyph that is the leftmost
20341 glyph of the line. */
20342 && !row
->reversed_p
)
20343 row
->x
= x
- it
->first_visible_x
;
20344 /* Record the maximum and minimum buffer positions seen so
20345 far in glyphs that will be displayed by this row. */
20347 RECORD_MAX_MIN_POS (it
);
20352 struct glyph
*glyph
;
20354 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20356 /* Identify the glyphs added by the last call to
20357 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20358 the previous glyphs. */
20359 if (!row
->reversed_p
)
20360 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20362 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20363 new_x
= x
+ glyph
->pixel_width
;
20365 if (/* Lines are continued. */
20366 it
->line_wrap
!= TRUNCATE
20367 && (/* Glyph doesn't fit on the line. */
20368 new_x
> it
->last_visible_x
20369 /* Or it fits exactly on a window system frame. */
20370 || (new_x
== it
->last_visible_x
20371 && FRAME_WINDOW_P (it
->f
)
20372 && (row
->reversed_p
20373 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20374 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20376 /* End of a continued line. */
20379 || (new_x
== it
->last_visible_x
20380 && FRAME_WINDOW_P (it
->f
)
20381 && (row
->reversed_p
20382 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20383 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20385 /* Current glyph is the only one on the line or
20386 fits exactly on the line. We must continue
20387 the line because we can't draw the cursor
20388 after the glyph. */
20389 row
->continued_p
= 1;
20390 it
->current_x
= new_x
;
20391 it
->continuation_lines_width
+= new_x
;
20393 if (i
== nglyphs
- 1)
20395 /* If line-wrap is on, check if a previous
20396 wrap point was found. */
20397 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
20398 && wrap_row_used
> 0
20399 /* Even if there is a previous wrap
20400 point, continue the line here as
20401 usual, if (i) the previous character
20402 was a space or tab AND (ii) the
20403 current character is not. */
20405 || IT_DISPLAYING_WHITESPACE (it
)))
20408 /* Record the maximum and minimum buffer
20409 positions seen so far in glyphs that will be
20410 displayed by this row. */
20412 RECORD_MAX_MIN_POS (it
);
20413 set_iterator_to_next (it
, 1);
20414 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20416 if (!get_next_display_element (it
))
20418 row
->exact_window_width_line_p
= 1;
20419 it
->continuation_lines_width
= 0;
20420 row
->continued_p
= 0;
20421 row
->ends_at_zv_p
= 1;
20423 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20425 row
->continued_p
= 0;
20426 row
->exact_window_width_line_p
= 1;
20428 /* If line-wrap is on, check if a
20429 previous wrap point was found. */
20430 else if (wrap_row_used
> 0
20431 /* Even if there is a previous wrap
20432 point, continue the line here as
20433 usual, if (i) the previous character
20434 was a space or tab AND (ii) the
20435 current character is not. */
20437 || IT_DISPLAYING_WHITESPACE (it
)))
20442 else if (it
->bidi_p
)
20443 RECORD_MAX_MIN_POS (it
);
20444 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20445 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20446 extend_face_to_end_of_line (it
);
20448 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20449 && !FRAME_WINDOW_P (it
->f
))
20451 /* A padding glyph that doesn't fit on this line.
20452 This means the whole character doesn't fit
20454 if (row
->reversed_p
)
20455 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20456 - n_glyphs_before
);
20457 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20459 /* Fill the rest of the row with continuation
20460 glyphs like in 20.x. */
20461 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20462 < row
->glyphs
[1 + TEXT_AREA
])
20463 produce_special_glyphs (it
, IT_CONTINUATION
);
20465 row
->continued_p
= 1;
20466 it
->current_x
= x_before
;
20467 it
->continuation_lines_width
+= x_before
;
20469 /* Restore the height to what it was before the
20470 element not fitting on the line. */
20471 it
->max_ascent
= ascent
;
20472 it
->max_descent
= descent
;
20473 it
->max_phys_ascent
= phys_ascent
;
20474 it
->max_phys_descent
= phys_descent
;
20475 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20476 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20477 extend_face_to_end_of_line (it
);
20479 else if (wrap_row_used
> 0)
20482 if (row
->reversed_p
)
20483 unproduce_glyphs (it
,
20484 row
->used
[TEXT_AREA
] - wrap_row_used
);
20485 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20486 it
->continuation_lines_width
+= wrap_x
;
20487 row
->used
[TEXT_AREA
] = wrap_row_used
;
20488 row
->ascent
= wrap_row_ascent
;
20489 row
->height
= wrap_row_height
;
20490 row
->phys_ascent
= wrap_row_phys_ascent
;
20491 row
->phys_height
= wrap_row_phys_height
;
20492 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20493 min_pos
= wrap_row_min_pos
;
20494 min_bpos
= wrap_row_min_bpos
;
20495 max_pos
= wrap_row_max_pos
;
20496 max_bpos
= wrap_row_max_bpos
;
20497 row
->continued_p
= 1;
20498 row
->ends_at_zv_p
= 0;
20499 row
->exact_window_width_line_p
= 0;
20500 it
->continuation_lines_width
+= x
;
20502 /* Make sure that a non-default face is extended
20503 up to the right margin of the window. */
20504 extend_face_to_end_of_line (it
);
20506 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20508 /* A TAB that extends past the right edge of the
20509 window. This produces a single glyph on
20510 window system frames. We leave the glyph in
20511 this row and let it fill the row, but don't
20512 consume the TAB. */
20513 if ((row
->reversed_p
20514 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20515 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20516 produce_special_glyphs (it
, IT_CONTINUATION
);
20517 it
->continuation_lines_width
+= it
->last_visible_x
;
20518 row
->ends_in_middle_of_char_p
= 1;
20519 row
->continued_p
= 1;
20520 glyph
->pixel_width
= it
->last_visible_x
- x
;
20521 it
->starts_in_middle_of_char_p
= 1;
20522 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20523 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20524 extend_face_to_end_of_line (it
);
20528 /* Something other than a TAB that draws past
20529 the right edge of the window. Restore
20530 positions to values before the element. */
20531 if (row
->reversed_p
)
20532 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20533 - (n_glyphs_before
+ i
));
20534 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20536 /* Display continuation glyphs. */
20537 it
->current_x
= x_before
;
20538 it
->continuation_lines_width
+= x
;
20539 if (!FRAME_WINDOW_P (it
->f
)
20540 || (row
->reversed_p
20541 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20542 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20543 produce_special_glyphs (it
, IT_CONTINUATION
);
20544 row
->continued_p
= 1;
20546 extend_face_to_end_of_line (it
);
20548 if (nglyphs
> 1 && i
> 0)
20550 row
->ends_in_middle_of_char_p
= 1;
20551 it
->starts_in_middle_of_char_p
= 1;
20554 /* Restore the height to what it was before the
20555 element not fitting on the line. */
20556 it
->max_ascent
= ascent
;
20557 it
->max_descent
= descent
;
20558 it
->max_phys_ascent
= phys_ascent
;
20559 it
->max_phys_descent
= phys_descent
;
20564 else if (new_x
> it
->first_visible_x
)
20566 /* Increment number of glyphs actually displayed. */
20569 /* Record the maximum and minimum buffer positions
20570 seen so far in glyphs that will be displayed by
20573 RECORD_MAX_MIN_POS (it
);
20575 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20576 /* Glyph is partially visible, i.e. row starts at
20577 negative X position. Don't do that in R2L
20578 rows, where we arrange to add a right offset to
20579 the line in extend_face_to_end_of_line, by a
20580 suitable change to the stretch glyph that is
20581 the leftmost glyph of the line. */
20582 row
->x
= x
- it
->first_visible_x
;
20583 /* When the last glyph of an R2L row only fits
20584 partially on the line, we need to set row->x to a
20585 negative offset, so that the leftmost glyph is
20586 the one that is partially visible. But if we are
20587 going to produce the truncation glyph, this will
20588 be taken care of in produce_special_glyphs. */
20589 if (row
->reversed_p
20590 && new_x
> it
->last_visible_x
20591 && !(it
->line_wrap
== TRUNCATE
20592 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20594 eassert (FRAME_WINDOW_P (it
->f
));
20595 row
->x
= it
->last_visible_x
- new_x
;
20600 /* Glyph is completely off the left margin of the
20601 window. This should not happen because of the
20602 move_it_in_display_line at the start of this
20603 function, unless the text display area of the
20604 window is empty. */
20605 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20608 /* Even if this display element produced no glyphs at all,
20609 we want to record its position. */
20610 if (it
->bidi_p
&& nglyphs
== 0)
20611 RECORD_MAX_MIN_POS (it
);
20613 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20614 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20615 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20616 row
->phys_height
= max (row
->phys_height
,
20617 it
->max_phys_ascent
+ it
->max_phys_descent
);
20618 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20619 it
->max_extra_line_spacing
);
20621 /* End of this display line if row is continued. */
20622 if (row
->continued_p
|| row
->ends_at_zv_p
)
20627 /* Is this a line end? If yes, we're also done, after making
20628 sure that a non-default face is extended up to the right
20629 margin of the window. */
20630 if (ITERATOR_AT_END_OF_LINE_P (it
))
20632 int used_before
= row
->used
[TEXT_AREA
];
20634 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20636 /* Add a space at the end of the line that is used to
20637 display the cursor there. */
20638 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20639 append_space_for_newline (it
, 0);
20641 /* Extend the face to the end of the line. */
20642 extend_face_to_end_of_line (it
);
20644 /* Make sure we have the position. */
20645 if (used_before
== 0)
20646 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20648 /* Record the position of the newline, for use in
20650 it
->eol_pos
= it
->current
.pos
;
20652 /* Consume the line end. This skips over invisible lines. */
20653 set_iterator_to_next (it
, 1);
20654 it
->continuation_lines_width
= 0;
20658 /* Proceed with next display element. Note that this skips
20659 over lines invisible because of selective display. */
20660 set_iterator_to_next (it
, 1);
20662 /* If we truncate lines, we are done when the last displayed
20663 glyphs reach past the right margin of the window. */
20664 if (it
->line_wrap
== TRUNCATE
20665 && ((FRAME_WINDOW_P (it
->f
)
20666 /* Images are preprocessed in produce_image_glyph such
20667 that they are cropped at the right edge of the
20668 window, so an image glyph will always end exactly at
20669 last_visible_x, even if there's no right fringe. */
20670 && ((row
->reversed_p
20671 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20672 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20673 || it
->what
== IT_IMAGE
))
20674 ? (it
->current_x
>= it
->last_visible_x
)
20675 : (it
->current_x
> it
->last_visible_x
)))
20677 /* Maybe add truncation glyphs. */
20678 if (!FRAME_WINDOW_P (it
->f
)
20679 || (row
->reversed_p
20680 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20681 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20685 if (!row
->reversed_p
)
20687 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20688 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20693 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20694 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20696 /* Remove any padding glyphs at the front of ROW, to
20697 make room for the truncation glyphs we will be
20698 adding below. The loop below always inserts at
20699 least one truncation glyph, so also remove the
20700 last glyph added to ROW. */
20701 unproduce_glyphs (it
, i
+ 1);
20702 /* Adjust i for the loop below. */
20703 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20706 /* produce_special_glyphs overwrites the last glyph, so
20707 we don't want that if we want to keep that last
20708 glyph, which means it's an image. */
20709 if (it
->current_x
> it
->last_visible_x
)
20711 it
->current_x
= x_before
;
20712 if (!FRAME_WINDOW_P (it
->f
))
20714 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20716 row
->used
[TEXT_AREA
] = i
;
20717 produce_special_glyphs (it
, IT_TRUNCATION
);
20722 row
->used
[TEXT_AREA
] = i
;
20723 produce_special_glyphs (it
, IT_TRUNCATION
);
20725 it
->hpos
= hpos_before
;
20728 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20730 /* Don't truncate if we can overflow newline into fringe. */
20731 if (!get_next_display_element (it
))
20733 it
->continuation_lines_width
= 0;
20734 row
->ends_at_zv_p
= 1;
20735 row
->exact_window_width_line_p
= 1;
20738 if (ITERATOR_AT_END_OF_LINE_P (it
))
20740 row
->exact_window_width_line_p
= 1;
20741 goto at_end_of_line
;
20743 it
->current_x
= x_before
;
20744 it
->hpos
= hpos_before
;
20747 row
->truncated_on_right_p
= 1;
20748 it
->continuation_lines_width
= 0;
20749 reseat_at_next_visible_line_start (it
, 0);
20750 /* We insist below that IT's position be at ZV because in
20751 bidi-reordered lines the character at visible line start
20752 might not be the character that follows the newline in
20753 the logical order. */
20754 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
20755 row
->ends_at_zv_p
=
20756 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
20758 row
->ends_at_zv_p
= false;
20764 bidi_unshelve_cache (wrap_data
, 1);
20766 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20767 at the left window margin. */
20768 if (it
->first_visible_x
20769 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20771 if (!FRAME_WINDOW_P (it
->f
)
20772 || (((row
->reversed_p
20773 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20774 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20775 /* Don't let insert_left_trunc_glyphs overwrite the
20776 first glyph of the row if it is an image. */
20777 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20778 insert_left_trunc_glyphs (it
);
20779 row
->truncated_on_left_p
= 1;
20782 /* Remember the position at which this line ends.
20784 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20785 cannot be before the call to find_row_edges below, since that is
20786 where these positions are determined. */
20787 row
->end
= it
->current
;
20790 row
->minpos
= row
->start
.pos
;
20791 row
->maxpos
= row
->end
.pos
;
20795 /* ROW->minpos and ROW->maxpos must be the smallest and
20796 `1 + the largest' buffer positions in ROW. But if ROW was
20797 bidi-reordered, these two positions can be anywhere in the
20798 row, so we must determine them now. */
20799 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20802 /* If the start of this line is the overlay arrow-position, then
20803 mark this glyph row as the one containing the overlay arrow.
20804 This is clearly a mess with variable size fonts. It would be
20805 better to let it be displayed like cursors under X. */
20806 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20807 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20808 !NILP (overlay_arrow_string
)))
20810 /* Overlay arrow in window redisplay is a fringe bitmap. */
20811 if (STRINGP (overlay_arrow_string
))
20813 struct glyph_row
*arrow_row
20814 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20815 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20816 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20817 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20818 struct glyph
*p2
, *end
;
20820 /* Copy the arrow glyphs. */
20821 while (glyph
< arrow_end
)
20824 /* Throw away padding glyphs. */
20826 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20827 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20833 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20838 eassert (INTEGERP (overlay_arrow_string
));
20839 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20841 overlay_arrow_seen
= 1;
20844 /* Highlight trailing whitespace. */
20845 if (!NILP (Vshow_trailing_whitespace
))
20846 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20848 /* Compute pixel dimensions of this line. */
20849 compute_line_metrics (it
);
20851 /* Implementation note: No changes in the glyphs of ROW or in their
20852 faces can be done past this point, because compute_line_metrics
20853 computes ROW's hash value and stores it within the glyph_row
20856 /* Record whether this row ends inside an ellipsis. */
20857 row
->ends_in_ellipsis_p
20858 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20859 && it
->ellipsis_p
);
20861 /* Save fringe bitmaps in this row. */
20862 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20863 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20864 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20865 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20867 it
->left_user_fringe_bitmap
= 0;
20868 it
->left_user_fringe_face_id
= 0;
20869 it
->right_user_fringe_bitmap
= 0;
20870 it
->right_user_fringe_face_id
= 0;
20872 /* Maybe set the cursor. */
20873 cvpos
= it
->w
->cursor
.vpos
;
20875 /* In bidi-reordered rows, keep checking for proper cursor
20876 position even if one has been found already, because buffer
20877 positions in such rows change non-linearly with ROW->VPOS,
20878 when a line is continued. One exception: when we are at ZV,
20879 display cursor on the first suitable glyph row, since all
20880 the empty rows after that also have their position set to ZV. */
20881 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20882 lines' rows is implemented for bidi-reordered rows. */
20884 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20885 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20886 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20887 && cursor_row_p (row
))
20888 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20890 /* Prepare for the next line. This line starts horizontally at (X
20891 HPOS) = (0 0). Vertical positions are incremented. As a
20892 convenience for the caller, IT->glyph_row is set to the next
20894 it
->current_x
= it
->hpos
= 0;
20895 it
->current_y
+= row
->height
;
20896 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20899 /* The next row should by default use the same value of the
20900 reversed_p flag as this one. set_iterator_to_next decides when
20901 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20902 the flag accordingly. */
20903 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20904 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20905 it
->start
= row
->end
;
20906 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20908 #undef RECORD_MAX_MIN_POS
20911 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20912 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20913 doc
: /* Return paragraph direction at point in BUFFER.
20914 Value is either `left-to-right' or `right-to-left'.
20915 If BUFFER is omitted or nil, it defaults to the current buffer.
20917 Paragraph direction determines how the text in the paragraph is displayed.
20918 In left-to-right paragraphs, text begins at the left margin of the window
20919 and the reading direction is generally left to right. In right-to-left
20920 paragraphs, text begins at the right margin and is read from right to left.
20922 See also `bidi-paragraph-direction'. */)
20923 (Lisp_Object buffer
)
20925 struct buffer
*buf
= current_buffer
;
20926 struct buffer
*old
= buf
;
20928 if (! NILP (buffer
))
20930 CHECK_BUFFER (buffer
);
20931 buf
= XBUFFER (buffer
);
20934 if (NILP (BVAR (buf
, bidi_display_reordering
))
20935 || NILP (BVAR (buf
, enable_multibyte_characters
))
20936 /* When we are loading loadup.el, the character property tables
20937 needed for bidi iteration are not yet available. */
20938 || !NILP (Vpurify_flag
))
20939 return Qleft_to_right
;
20940 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20941 return BVAR (buf
, bidi_paragraph_direction
);
20944 /* Determine the direction from buffer text. We could try to
20945 use current_matrix if it is up to date, but this seems fast
20946 enough as it is. */
20947 struct bidi_it itb
;
20948 ptrdiff_t pos
= BUF_PT (buf
);
20949 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20951 void *itb_data
= bidi_shelve_cache ();
20953 set_buffer_temp (buf
);
20954 /* bidi_paragraph_init finds the base direction of the paragraph
20955 by searching forward from paragraph start. We need the base
20956 direction of the current or _previous_ paragraph, so we need
20957 to make sure we are within that paragraph. To that end, find
20958 the previous non-empty line. */
20959 if (pos
>= ZV
&& pos
> BEGV
)
20960 DEC_BOTH (pos
, bytepos
);
20961 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20962 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20964 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20965 || c
== ' ' || c
== '\t' || c
== '\f')
20967 if (bytepos
<= BEGV_BYTE
)
20972 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20975 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20976 itb
.paragraph_dir
= NEUTRAL_DIR
;
20977 itb
.string
.s
= NULL
;
20978 itb
.string
.lstring
= Qnil
;
20979 itb
.string
.bufpos
= 0;
20980 itb
.string
.from_disp_str
= 0;
20981 itb
.string
.unibyte
= 0;
20982 /* We have no window to use here for ignoring window-specific
20983 overlays. Using NULL for window pointer will cause
20984 compute_display_string_pos to use the current buffer. */
20986 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20987 bidi_unshelve_cache (itb_data
, 0);
20988 set_buffer_temp (old
);
20989 switch (itb
.paragraph_dir
)
20992 return Qleft_to_right
;
20995 return Qright_to_left
;
21003 DEFUN ("move-point-visually", Fmove_point_visually
,
21004 Smove_point_visually
, 1, 1, 0,
21005 doc
: /* Move point in the visual order in the specified DIRECTION.
21006 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21009 Value is the new character position of point. */)
21010 (Lisp_Object direction
)
21012 struct window
*w
= XWINDOW (selected_window
);
21013 struct buffer
*b
= XBUFFER (w
->contents
);
21014 struct glyph_row
*row
;
21016 Lisp_Object paragraph_dir
;
21018 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21019 (!(ROW)->continued_p \
21020 && INTEGERP ((GLYPH)->object) \
21021 && (GLYPH)->type == CHAR_GLYPH \
21022 && (GLYPH)->u.ch == ' ' \
21023 && (GLYPH)->charpos >= 0 \
21024 && !(GLYPH)->avoid_cursor_p)
21026 CHECK_NUMBER (direction
);
21027 dir
= XINT (direction
);
21033 /* If current matrix is up-to-date, we can use the information
21034 recorded in the glyphs, at least as long as the goal is on the
21036 if (w
->window_end_valid
21037 && !windows_or_buffers_changed
21039 && !b
->clip_changed
21040 && !b
->prevent_redisplay_optimizations_p
21041 && !window_outdated (w
)
21042 /* We rely below on the cursor coordinates to be up to date, but
21043 we cannot trust them if some command moved point since the
21044 last complete redisplay. */
21045 && w
->last_point
== BUF_PT (b
)
21046 && w
->cursor
.vpos
>= 0
21047 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21048 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21050 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21051 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21052 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21054 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21056 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21058 SET_PT (g
->charpos
);
21059 w
->cursor
.vpos
= -1;
21060 return make_number (PT
);
21062 else if (!INTEGERP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21066 if (BUFFERP (gpt
->object
))
21069 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21070 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21072 new_pos
-= (row
->reversed_p
? -dir
: dir
);;
21074 else if (BUFFERP (g
->object
))
21075 new_pos
= g
->charpos
;
21079 w
->cursor
.vpos
= -1;
21080 return make_number (PT
);
21082 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21084 /* Glyphs inserted at the end of a non-empty line for
21085 positioning the cursor have zero charpos, so we must
21086 deduce the value of point by other means. */
21087 if (g
->charpos
> 0)
21088 SET_PT (g
->charpos
);
21089 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21091 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21092 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21095 w
->cursor
.vpos
= -1;
21096 return make_number (PT
);
21099 if (g
== e
|| INTEGERP (g
->object
))
21101 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21102 goto simulate_display
;
21103 if (!row
->reversed_p
)
21107 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21108 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21109 goto simulate_display
;
21113 if (row
->reversed_p
&& !row
->continued_p
)
21115 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21116 w
->cursor
.vpos
= -1;
21117 return make_number (PT
);
21119 g
= row
->glyphs
[TEXT_AREA
];
21120 e
= g
+ row
->used
[TEXT_AREA
];
21121 for ( ; g
< e
; g
++)
21123 if (BUFFERP (g
->object
)
21124 /* Empty lines have only one glyph, which stands
21125 for the newline, and whose charpos is the
21126 buffer position of the newline. */
21127 || ROW_GLYPH_NEWLINE_P (row
, g
)
21128 /* When the buffer ends in a newline, the line at
21129 EOB also has one glyph, but its charpos is -1. */
21130 || (row
->ends_at_zv_p
21131 && !row
->reversed_p
21132 && INTEGERP (g
->object
)
21133 && g
->type
== CHAR_GLYPH
21134 && g
->u
.ch
== ' '))
21136 if (g
->charpos
> 0)
21137 SET_PT (g
->charpos
);
21138 else if (!row
->reversed_p
21139 && row
->ends_at_zv_p
21144 w
->cursor
.vpos
= -1;
21145 return make_number (PT
);
21151 if (!row
->reversed_p
&& !row
->continued_p
)
21153 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21154 w
->cursor
.vpos
= -1;
21155 return make_number (PT
);
21157 e
= row
->glyphs
[TEXT_AREA
];
21158 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21159 for ( ; g
>= e
; g
--)
21161 if (BUFFERP (g
->object
)
21162 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21164 /* Empty R2L lines on GUI frames have the buffer
21165 position of the newline stored in the stretch
21167 || g
->type
== STRETCH_GLYPH
21168 || (row
->ends_at_zv_p
21170 && INTEGERP (g
->object
)
21171 && g
->type
== CHAR_GLYPH
21172 && g
->u
.ch
== ' '))
21174 if (g
->charpos
> 0)
21175 SET_PT (g
->charpos
);
21176 else if (row
->reversed_p
21177 && row
->ends_at_zv_p
21182 w
->cursor
.vpos
= -1;
21183 return make_number (PT
);
21192 /* If we wind up here, we failed to move by using the glyphs, so we
21193 need to simulate display instead. */
21196 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21198 paragraph_dir
= Qleft_to_right
;
21199 if (EQ (paragraph_dir
, Qright_to_left
))
21201 if (PT
<= BEGV
&& dir
< 0)
21202 xsignal0 (Qbeginning_of_buffer
);
21203 else if (PT
>= ZV
&& dir
> 0)
21204 xsignal0 (Qend_of_buffer
);
21207 struct text_pos pt
;
21209 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21211 bool overshoot_expected
= false;
21212 bool target_is_eol_p
= false;
21214 /* Setup the arena. */
21215 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21216 start_display (&it
, w
, pt
);
21218 if (it
.cmp_it
.id
< 0
21219 && it
.method
== GET_FROM_STRING
21220 && it
.area
== TEXT_AREA
21221 && it
.string_from_display_prop_p
21222 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21223 overshoot_expected
= true;
21225 /* Find the X coordinate of point. We start from the beginning
21226 of this or previous line to make sure we are before point in
21227 the logical order (since the move_it_* functions can only
21230 reseat_at_previous_visible_line_start (&it
);
21231 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21232 if (IT_CHARPOS (it
) != PT
)
21234 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21235 -1, -1, -1, MOVE_TO_POS
);
21236 /* If we missed point because the character there is
21237 displayed out of a display vector that has more than one
21238 glyph, retry expecting overshoot. */
21239 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21240 && it
.current
.dpvec_index
> 0
21241 && !overshoot_expected
)
21243 overshoot_expected
= true;
21246 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21247 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21249 pt_x
= it
.current_x
;
21251 if (dir
> 0 || overshoot_expected
)
21253 struct glyph_row
*row
= it
.glyph_row
;
21255 /* When point is at beginning of line, we don't have
21256 information about the glyph there loaded into struct
21257 it. Calling get_next_display_element fixes that. */
21259 get_next_display_element (&it
);
21260 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21261 it
.glyph_row
= NULL
;
21262 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21263 it
.glyph_row
= row
;
21264 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21265 it, lest it will become out of sync with it's buffer
21267 it
.current_x
= pt_x
;
21270 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21271 pixel_width
= it
.pixel_width
;
21272 if (overshoot_expected
&& at_eol_p
)
21274 else if (pixel_width
<= 0)
21277 /* If there's a display string (or something similar) at point,
21278 we are actually at the glyph to the left of point, so we need
21279 to correct the X coordinate. */
21280 if (overshoot_expected
)
21283 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21285 pt_x
+= pixel_width
;
21288 /* Compute target X coordinate, either to the left or to the
21289 right of point. On TTY frames, all characters have the same
21290 pixel width of 1, so we can use that. On GUI frames we don't
21291 have an easy way of getting at the pixel width of the
21292 character to the left of point, so we use a different method
21293 of getting to that place. */
21295 target_x
= pt_x
+ pixel_width
;
21297 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21299 /* Target X coordinate could be one line above or below the line
21300 of point, in which case we need to adjust the target X
21301 coordinate. Also, if moving to the left, we need to begin at
21302 the left edge of the point's screen line. */
21307 start_display (&it
, w
, pt
);
21308 reseat_at_previous_visible_line_start (&it
);
21309 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21311 move_it_by_lines (&it
, pt_vpos
);
21315 move_it_by_lines (&it
, -1);
21316 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21317 target_is_eol_p
= true;
21318 /* Under word-wrap, we don't know the x coordinate of
21319 the last character displayed on the previous line,
21320 which immediately precedes the wrap point. To find
21321 out its x coordinate, we try moving to the right
21322 margin of the window, which will stop at the wrap
21323 point, and then reset target_x to point at the
21324 character that precedes the wrap point. This is not
21325 needed on GUI frames, because (see below) there we
21326 move from the left margin one grapheme cluster at a
21327 time, and stop when we hit the wrap point. */
21328 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21330 void *it_data
= NULL
;
21333 SAVE_IT (it2
, it
, it_data
);
21334 move_it_in_display_line_to (&it
, ZV
, target_x
,
21335 MOVE_TO_POS
| MOVE_TO_X
);
21336 /* If we arrived at target_x, that _is_ the last
21337 character on the previous line. */
21338 if (it
.current_x
!= target_x
)
21339 target_x
= it
.current_x
- 1;
21340 RESTORE_IT (&it
, &it2
, it_data
);
21347 || (target_x
>= it
.last_visible_x
21348 && it
.line_wrap
!= TRUNCATE
))
21351 move_it_by_lines (&it
, 0);
21352 move_it_by_lines (&it
, 1);
21357 /* Move to the target X coordinate. */
21358 #ifdef HAVE_WINDOW_SYSTEM
21359 /* On GUI frames, as we don't know the X coordinate of the
21360 character to the left of point, moving point to the left
21361 requires walking, one grapheme cluster at a time, until we
21362 find ourself at a place immediately to the left of the
21363 character at point. */
21364 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21366 struct text_pos new_pos
;
21367 enum move_it_result rc
= MOVE_X_REACHED
;
21369 if (it
.current_x
== 0)
21370 get_next_display_element (&it
);
21371 if (it
.what
== IT_COMPOSITION
)
21373 new_pos
.charpos
= it
.cmp_it
.charpos
;
21374 new_pos
.bytepos
= -1;
21377 new_pos
= it
.current
.pos
;
21379 while (it
.current_x
+ it
.pixel_width
<= target_x
21380 && (rc
== MOVE_X_REACHED
21381 /* Under word-wrap, move_it_in_display_line_to
21382 stops at correct coordinates, but sometimes
21383 returns MOVE_POS_MATCH_OR_ZV. */
21384 || (it
.line_wrap
== WORD_WRAP
21385 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21387 int new_x
= it
.current_x
+ it
.pixel_width
;
21389 /* For composed characters, we want the position of the
21390 first character in the grapheme cluster (usually, the
21391 composition's base character), whereas it.current
21392 might give us the position of the _last_ one, e.g. if
21393 the composition is rendered in reverse due to bidi
21395 if (it
.what
== IT_COMPOSITION
)
21397 new_pos
.charpos
= it
.cmp_it
.charpos
;
21398 new_pos
.bytepos
= -1;
21401 new_pos
= it
.current
.pos
;
21402 if (new_x
== it
.current_x
)
21404 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21405 MOVE_TO_POS
| MOVE_TO_X
);
21406 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21409 /* The previous position we saw in the loop is the one we
21411 if (new_pos
.bytepos
== -1)
21412 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21413 it
.current
.pos
= new_pos
;
21417 if (it
.current_x
!= target_x
)
21418 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21420 /* When lines are truncated, the above loop will stop at the
21421 window edge. But we want to get to the end of line, even if
21422 it is beyond the window edge; automatic hscroll will then
21423 scroll the window to show point as appropriate. */
21424 if (target_is_eol_p
&& it
.line_wrap
== TRUNCATE
21425 && get_next_display_element (&it
))
21427 struct text_pos new_pos
= it
.current
.pos
;
21429 while (!ITERATOR_AT_END_OF_LINE_P (&it
))
21431 set_iterator_to_next (&it
, 0);
21432 if (it
.method
== GET_FROM_BUFFER
)
21433 new_pos
= it
.current
.pos
;
21434 if (!get_next_display_element (&it
))
21438 it
.current
.pos
= new_pos
;
21441 /* If we ended up in a display string that covers point, move to
21442 buffer position to the right in the visual order. */
21445 while (IT_CHARPOS (it
) == PT
)
21447 set_iterator_to_next (&it
, 0);
21448 if (!get_next_display_element (&it
))
21453 /* Move point to that position. */
21454 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21457 return make_number (PT
);
21459 #undef ROW_GLYPH_NEWLINE_P
21463 /***********************************************************************
21465 ***********************************************************************/
21467 /* Redisplay the menu bar in the frame for window W.
21469 The menu bar of X frames that don't have X toolkit support is
21470 displayed in a special window W->frame->menu_bar_window.
21472 The menu bar of terminal frames is treated specially as far as
21473 glyph matrices are concerned. Menu bar lines are not part of
21474 windows, so the update is done directly on the frame matrix rows
21475 for the menu bar. */
21478 display_menu_bar (struct window
*w
)
21480 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21485 /* Don't do all this for graphical frames. */
21487 if (FRAME_W32_P (f
))
21490 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21496 if (FRAME_NS_P (f
))
21498 #endif /* HAVE_NS */
21500 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21501 eassert (!FRAME_WINDOW_P (f
));
21502 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21503 it
.first_visible_x
= 0;
21504 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21505 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21506 if (FRAME_WINDOW_P (f
))
21508 /* Menu bar lines are displayed in the desired matrix of the
21509 dummy window menu_bar_window. */
21510 struct window
*menu_w
;
21511 menu_w
= XWINDOW (f
->menu_bar_window
);
21512 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21514 it
.first_visible_x
= 0;
21515 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21518 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21520 /* This is a TTY frame, i.e. character hpos/vpos are used as
21522 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21524 it
.first_visible_x
= 0;
21525 it
.last_visible_x
= FRAME_COLS (f
);
21528 /* FIXME: This should be controlled by a user option. See the
21529 comments in redisplay_tool_bar and display_mode_line about
21531 it
.paragraph_embedding
= L2R
;
21533 /* Clear all rows of the menu bar. */
21534 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21536 struct glyph_row
*row
= it
.glyph_row
+ i
;
21537 clear_glyph_row (row
);
21538 row
->enabled_p
= true;
21539 row
->full_width_p
= 1;
21542 /* Display all items of the menu bar. */
21543 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21544 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21546 Lisp_Object string
;
21548 /* Stop at nil string. */
21549 string
= AREF (items
, i
+ 1);
21553 /* Remember where item was displayed. */
21554 ASET (items
, i
+ 3, make_number (it
.hpos
));
21556 /* Display the item, pad with one space. */
21557 if (it
.current_x
< it
.last_visible_x
)
21558 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21559 SCHARS (string
) + 1, 0, 0, -1);
21562 /* Fill out the line with spaces. */
21563 if (it
.current_x
< it
.last_visible_x
)
21564 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21566 /* Compute the total height of the lines. */
21567 compute_line_metrics (&it
);
21570 /* Deep copy of a glyph row, including the glyphs. */
21572 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21574 struct glyph
*pointers
[1 + LAST_AREA
];
21575 int to_used
= to
->used
[TEXT_AREA
];
21577 /* Save glyph pointers of TO. */
21578 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21580 /* Do a structure assignment. */
21583 /* Restore original glyph pointers of TO. */
21584 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21586 /* Copy the glyphs. */
21587 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21588 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21590 /* If we filled only part of the TO row, fill the rest with
21591 space_glyph (which will display as empty space). */
21592 if (to_used
> from
->used
[TEXT_AREA
])
21593 fill_up_frame_row_with_spaces (to
, to_used
);
21596 /* Display one menu item on a TTY, by overwriting the glyphs in the
21597 frame F's desired glyph matrix with glyphs produced from the menu
21598 item text. Called from term.c to display TTY drop-down menus one
21601 ITEM_TEXT is the menu item text as a C string.
21603 FACE_ID is the face ID to be used for this menu item. FACE_ID
21604 could specify one of 3 faces: a face for an enabled item, a face
21605 for a disabled item, or a face for a selected item.
21607 X and Y are coordinates of the first glyph in the frame's desired
21608 matrix to be overwritten by the menu item. Since this is a TTY, Y
21609 is the zero-based number of the glyph row and X is the zero-based
21610 glyph number in the row, starting from left, where to start
21611 displaying the item.
21613 SUBMENU non-zero means this menu item drops down a submenu, which
21614 should be indicated by displaying a proper visual cue after the
21618 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21619 int x
, int y
, int submenu
)
21622 struct frame
*f
= SELECTED_FRAME ();
21623 struct window
*w
= XWINDOW (f
->selected_window
);
21624 int saved_used
, saved_truncated
, saved_width
, saved_reversed
;
21625 struct glyph_row
*row
;
21626 size_t item_len
= strlen (item_text
);
21628 eassert (FRAME_TERMCAP_P (f
));
21630 /* Don't write beyond the matrix's last row. This can happen for
21631 TTY screens that are not high enough to show the entire menu.
21632 (This is actually a bit of defensive programming, as
21633 tty_menu_display already limits the number of menu items to one
21634 less than the number of screen lines.) */
21635 if (y
>= f
->desired_matrix
->nrows
)
21638 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21639 it
.first_visible_x
= 0;
21640 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21641 row
= it
.glyph_row
;
21642 /* Start with the row contents from the current matrix. */
21643 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21644 saved_width
= row
->full_width_p
;
21645 row
->full_width_p
= 1;
21646 saved_reversed
= row
->reversed_p
;
21647 row
->reversed_p
= 0;
21648 row
->enabled_p
= true;
21650 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21652 eassert (x
< f
->desired_matrix
->matrix_w
);
21653 it
.current_x
= it
.hpos
= x
;
21654 it
.current_y
= it
.vpos
= y
;
21655 saved_used
= row
->used
[TEXT_AREA
];
21656 saved_truncated
= row
->truncated_on_right_p
;
21657 row
->used
[TEXT_AREA
] = x
;
21658 it
.face_id
= face_id
;
21659 it
.line_wrap
= TRUNCATE
;
21661 /* FIXME: This should be controlled by a user option. See the
21662 comments in redisplay_tool_bar and display_mode_line about this.
21663 Also, if paragraph_embedding could ever be R2L, changes will be
21664 needed to avoid shifting to the right the row characters in
21665 term.c:append_glyph. */
21666 it
.paragraph_embedding
= L2R
;
21668 /* Pad with a space on the left. */
21669 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21671 /* Display the menu item, pad with spaces to WIDTH. */
21674 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21675 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21677 /* Indicate with " >" that there's a submenu. */
21678 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21679 FRAME_COLS (f
) - 1, -1);
21682 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21683 width
, 0, FRAME_COLS (f
) - 1, -1);
21685 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21686 row
->truncated_on_right_p
= saved_truncated
;
21687 row
->hash
= row_hash (row
);
21688 row
->full_width_p
= saved_width
;
21689 row
->reversed_p
= saved_reversed
;
21692 /***********************************************************************
21694 ***********************************************************************/
21696 /* Redisplay mode lines in the window tree whose root is WINDOW. If
21697 FORCE is non-zero, redisplay mode lines unconditionally.
21698 Otherwise, redisplay only mode lines that are garbaged. Value is
21699 the number of windows whose mode lines were redisplayed. */
21702 redisplay_mode_lines (Lisp_Object window
, bool force
)
21706 while (!NILP (window
))
21708 struct window
*w
= XWINDOW (window
);
21710 if (WINDOWP (w
->contents
))
21711 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
21713 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
21714 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
21716 struct text_pos lpoint
;
21717 struct buffer
*old
= current_buffer
;
21719 /* Set the window's buffer for the mode line display. */
21720 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
21721 set_buffer_internal_1 (XBUFFER (w
->contents
));
21723 /* Point refers normally to the selected window. For any
21724 other window, set up appropriate value. */
21725 if (!EQ (window
, selected_window
))
21727 struct text_pos pt
;
21729 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
21730 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
21733 /* Display mode lines. */
21734 clear_glyph_matrix (w
->desired_matrix
);
21735 if (display_mode_lines (w
))
21738 /* Restore old settings. */
21739 set_buffer_internal_1 (old
);
21740 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
21750 /* Display the mode and/or header line of window W. Value is the
21751 sum number of mode lines and header lines displayed. */
21754 display_mode_lines (struct window
*w
)
21756 Lisp_Object old_selected_window
= selected_window
;
21757 Lisp_Object old_selected_frame
= selected_frame
;
21758 Lisp_Object new_frame
= w
->frame
;
21759 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
21762 selected_frame
= new_frame
;
21763 /* FIXME: If we were to allow the mode-line's computation changing the buffer
21764 or window's point, then we'd need select_window_1 here as well. */
21765 XSETWINDOW (selected_window
, w
);
21766 XFRAME (new_frame
)->selected_window
= selected_window
;
21768 /* These will be set while the mode line specs are processed. */
21769 line_number_displayed
= 0;
21770 w
->column_number_displayed
= -1;
21772 if (WINDOW_WANTS_MODELINE_P (w
))
21774 struct window
*sel_w
= XWINDOW (old_selected_window
);
21776 /* Select mode line face based on the real selected window. */
21777 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
21778 BVAR (current_buffer
, mode_line_format
));
21782 if (WINDOW_WANTS_HEADER_LINE_P (w
))
21784 display_mode_line (w
, HEADER_LINE_FACE_ID
,
21785 BVAR (current_buffer
, header_line_format
));
21789 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
21790 selected_frame
= old_selected_frame
;
21791 selected_window
= old_selected_window
;
21793 w
->must_be_updated_p
= true;
21798 /* Display mode or header line of window W. FACE_ID specifies which
21799 line to display; it is either MODE_LINE_FACE_ID or
21800 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
21801 display. Value is the pixel height of the mode/header line
21805 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
21809 ptrdiff_t count
= SPECPDL_INDEX ();
21811 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21812 /* Don't extend on a previously drawn mode-line.
21813 This may happen if called from pos_visible_p. */
21814 it
.glyph_row
->enabled_p
= false;
21815 prepare_desired_row (w
, it
.glyph_row
, true);
21817 it
.glyph_row
->mode_line_p
= 1;
21819 /* FIXME: This should be controlled by a user option. But
21820 supporting such an option is not trivial, since the mode line is
21821 made up of many separate strings. */
21822 it
.paragraph_embedding
= L2R
;
21824 record_unwind_protect (unwind_format_mode_line
,
21825 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
21827 mode_line_target
= MODE_LINE_DISPLAY
;
21829 /* Temporarily make frame's keyboard the current kboard so that
21830 kboard-local variables in the mode_line_format will get the right
21832 push_kboard (FRAME_KBOARD (it
.f
));
21833 record_unwind_save_match_data ();
21834 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21837 unbind_to (count
, Qnil
);
21839 /* Fill up with spaces. */
21840 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
21842 compute_line_metrics (&it
);
21843 it
.glyph_row
->full_width_p
= 1;
21844 it
.glyph_row
->continued_p
= 0;
21845 it
.glyph_row
->truncated_on_left_p
= 0;
21846 it
.glyph_row
->truncated_on_right_p
= 0;
21848 /* Make a 3D mode-line have a shadow at its right end. */
21849 face
= FACE_FROM_ID (it
.f
, face_id
);
21850 extend_face_to_end_of_line (&it
);
21851 if (face
->box
!= FACE_NO_BOX
)
21853 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
21854 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
21855 last
->right_box_line_p
= 1;
21858 return it
.glyph_row
->height
;
21861 /* Move element ELT in LIST to the front of LIST.
21862 Return the updated list. */
21865 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
21867 register Lisp_Object tail
, prev
;
21868 register Lisp_Object tem
;
21872 while (CONSP (tail
))
21878 /* Splice out the link TAIL. */
21880 list
= XCDR (tail
);
21882 Fsetcdr (prev
, XCDR (tail
));
21884 /* Now make it the first. */
21885 Fsetcdr (tail
, list
);
21890 tail
= XCDR (tail
);
21894 /* Not found--return unchanged LIST. */
21898 /* Contribute ELT to the mode line for window IT->w. How it
21899 translates into text depends on its data type.
21901 IT describes the display environment in which we display, as usual.
21903 DEPTH is the depth in recursion. It is used to prevent
21904 infinite recursion here.
21906 FIELD_WIDTH is the number of characters the display of ELT should
21907 occupy in the mode line, and PRECISION is the maximum number of
21908 characters to display from ELT's representation. See
21909 display_string for details.
21911 Returns the hpos of the end of the text generated by ELT.
21913 PROPS is a property list to add to any string we encounter.
21915 If RISKY is nonzero, remove (disregard) any properties in any string
21916 we encounter, and ignore :eval and :propertize.
21918 The global variable `mode_line_target' determines whether the
21919 output is passed to `store_mode_line_noprop',
21920 `store_mode_line_string', or `display_string'. */
21923 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
21924 Lisp_Object elt
, Lisp_Object props
, int risky
)
21926 int n
= 0, field
, prec
;
21931 elt
= build_string ("*too-deep*");
21935 switch (XTYPE (elt
))
21939 /* A string: output it and check for %-constructs within it. */
21941 ptrdiff_t offset
= 0;
21943 if (SCHARS (elt
) > 0
21944 && (!NILP (props
) || risky
))
21946 Lisp_Object oprops
, aelt
;
21947 oprops
= Ftext_properties_at (make_number (0), elt
);
21949 /* If the starting string's properties are not what
21950 we want, translate the string. Also, if the string
21951 is risky, do that anyway. */
21953 if (NILP (Fequal (props
, oprops
)) || risky
)
21955 /* If the starting string has properties,
21956 merge the specified ones onto the existing ones. */
21957 if (! NILP (oprops
) && !risky
)
21961 oprops
= Fcopy_sequence (oprops
);
21963 while (CONSP (tem
))
21965 oprops
= Fplist_put (oprops
, XCAR (tem
),
21966 XCAR (XCDR (tem
)));
21967 tem
= XCDR (XCDR (tem
));
21972 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
21973 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
21975 /* AELT is what we want. Move it to the front
21976 without consing. */
21978 mode_line_proptrans_alist
21979 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
21985 /* If AELT has the wrong props, it is useless.
21986 so get rid of it. */
21988 mode_line_proptrans_alist
21989 = Fdelq (aelt
, mode_line_proptrans_alist
);
21991 elt
= Fcopy_sequence (elt
);
21992 Fset_text_properties (make_number (0), Flength (elt
),
21994 /* Add this item to mode_line_proptrans_alist. */
21995 mode_line_proptrans_alist
21996 = Fcons (Fcons (elt
, props
),
21997 mode_line_proptrans_alist
);
21998 /* Truncate mode_line_proptrans_alist
21999 to at most 50 elements. */
22000 tem
= Fnthcdr (make_number (50),
22001 mode_line_proptrans_alist
);
22003 XSETCDR (tem
, Qnil
);
22012 prec
= precision
- n
;
22013 switch (mode_line_target
)
22015 case MODE_LINE_NOPROP
:
22016 case MODE_LINE_TITLE
:
22017 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22019 case MODE_LINE_STRING
:
22020 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
22022 case MODE_LINE_DISPLAY
:
22023 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22024 0, prec
, 0, STRING_MULTIBYTE (elt
));
22031 /* Handle the non-literal case. */
22033 while ((precision
<= 0 || n
< precision
)
22034 && SREF (elt
, offset
) != 0
22035 && (mode_line_target
!= MODE_LINE_DISPLAY
22036 || it
->current_x
< it
->last_visible_x
))
22038 ptrdiff_t last_offset
= offset
;
22040 /* Advance to end of string or next format specifier. */
22041 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22044 if (offset
- 1 != last_offset
)
22046 ptrdiff_t nchars
, nbytes
;
22048 /* Output to end of string or up to '%'. Field width
22049 is length of string. Don't output more than
22050 PRECISION allows us. */
22053 prec
= c_string_width (SDATA (elt
) + last_offset
,
22054 offset
- last_offset
, precision
- n
,
22057 switch (mode_line_target
)
22059 case MODE_LINE_NOPROP
:
22060 case MODE_LINE_TITLE
:
22061 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22063 case MODE_LINE_STRING
:
22065 ptrdiff_t bytepos
= last_offset
;
22066 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22067 ptrdiff_t endpos
= (precision
<= 0
22068 ? string_byte_to_char (elt
, offset
)
22069 : charpos
+ nchars
);
22071 n
+= store_mode_line_string (NULL
,
22072 Fsubstring (elt
, make_number (charpos
),
22073 make_number (endpos
)),
22077 case MODE_LINE_DISPLAY
:
22079 ptrdiff_t bytepos
= last_offset
;
22080 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22082 if (precision
<= 0)
22083 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22084 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22086 STRING_MULTIBYTE (elt
));
22091 else /* c == '%' */
22093 ptrdiff_t percent_position
= offset
;
22095 /* Get the specified minimum width. Zero means
22098 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22099 field
= field
* 10 + c
- '0';
22101 /* Don't pad beyond the total padding allowed. */
22102 if (field_width
- n
> 0 && field
> field_width
- n
)
22103 field
= field_width
- n
;
22105 /* Note that either PRECISION <= 0 or N < PRECISION. */
22106 prec
= precision
- n
;
22109 n
+= display_mode_element (it
, depth
, field
, prec
,
22110 Vglobal_mode_string
, props
,
22115 ptrdiff_t bytepos
, charpos
;
22117 Lisp_Object string
;
22119 bytepos
= percent_position
;
22120 charpos
= (STRING_MULTIBYTE (elt
)
22121 ? string_byte_to_char (elt
, bytepos
)
22123 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22124 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22126 switch (mode_line_target
)
22128 case MODE_LINE_NOPROP
:
22129 case MODE_LINE_TITLE
:
22130 n
+= store_mode_line_noprop (spec
, field
, prec
);
22132 case MODE_LINE_STRING
:
22134 Lisp_Object tem
= build_string (spec
);
22135 props
= Ftext_properties_at (make_number (charpos
), elt
);
22136 /* Should only keep face property in props */
22137 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
22140 case MODE_LINE_DISPLAY
:
22142 int nglyphs_before
, nwritten
;
22144 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22145 nwritten
= display_string (spec
, string
, elt
,
22150 /* Assign to the glyphs written above the
22151 string where the `%x' came from, position
22155 struct glyph
*glyph
22156 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22160 for (i
= 0; i
< nwritten
; ++i
)
22162 glyph
[i
].object
= elt
;
22163 glyph
[i
].charpos
= charpos
;
22180 /* A symbol: process the value of the symbol recursively
22181 as if it appeared here directly. Avoid error if symbol void.
22182 Special case: if value of symbol is a string, output the string
22185 register Lisp_Object tem
;
22187 /* If the variable is not marked as risky to set
22188 then its contents are risky to use. */
22189 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22192 tem
= Fboundp (elt
);
22195 tem
= Fsymbol_value (elt
);
22196 /* If value is a string, output that string literally:
22197 don't check for % within it. */
22201 if (!EQ (tem
, elt
))
22203 /* Give up right away for nil or t. */
22213 register Lisp_Object car
, tem
;
22215 /* A cons cell: five distinct cases.
22216 If first element is :eval or :propertize, do something special.
22217 If first element is a string or a cons, process all the elements
22218 and effectively concatenate them.
22219 If first element is a negative number, truncate displaying cdr to
22220 at most that many characters. If positive, pad (with spaces)
22221 to at least that many characters.
22222 If first element is a symbol, process the cadr or caddr recursively
22223 according to whether the symbol's value is non-nil or nil. */
22225 if (EQ (car
, QCeval
))
22227 /* An element of the form (:eval FORM) means evaluate FORM
22228 and use the result as mode line elements. */
22233 if (CONSP (XCDR (elt
)))
22236 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22237 n
+= display_mode_element (it
, depth
, field_width
- n
,
22238 precision
- n
, spec
, props
,
22242 else if (EQ (car
, QCpropertize
))
22244 /* An element of the form (:propertize ELT PROPS...)
22245 means display ELT but applying properties PROPS. */
22250 if (CONSP (XCDR (elt
)))
22251 n
+= display_mode_element (it
, depth
, field_width
- n
,
22252 precision
- n
, XCAR (XCDR (elt
)),
22253 XCDR (XCDR (elt
)), risky
);
22255 else if (SYMBOLP (car
))
22257 tem
= Fboundp (car
);
22261 /* elt is now the cdr, and we know it is a cons cell.
22262 Use its car if CAR has a non-nil value. */
22265 tem
= Fsymbol_value (car
);
22272 /* Symbol's value is nil (or symbol is unbound)
22273 Get the cddr of the original list
22274 and if possible find the caddr and use that. */
22278 else if (!CONSP (elt
))
22283 else if (INTEGERP (car
))
22285 register int lim
= XINT (car
);
22289 /* Negative int means reduce maximum width. */
22290 if (precision
<= 0)
22293 precision
= min (precision
, -lim
);
22297 /* Padding specified. Don't let it be more than
22298 current maximum. */
22300 lim
= min (precision
, lim
);
22302 /* If that's more padding than already wanted, queue it.
22303 But don't reduce padding already specified even if
22304 that is beyond the current truncation point. */
22305 field_width
= max (lim
, field_width
);
22309 else if (STRINGP (car
) || CONSP (car
))
22311 Lisp_Object halftail
= elt
;
22315 && (precision
<= 0 || n
< precision
))
22317 n
+= display_mode_element (it
, depth
,
22318 /* Do padding only after the last
22319 element in the list. */
22320 (! CONSP (XCDR (elt
))
22323 precision
- n
, XCAR (elt
),
22327 if ((len
& 1) == 0)
22328 halftail
= XCDR (halftail
);
22329 /* Check for cycle. */
22330 if (EQ (halftail
, elt
))
22339 elt
= build_string ("*invalid*");
22343 /* Pad to FIELD_WIDTH. */
22344 if (field_width
> 0 && n
< field_width
)
22346 switch (mode_line_target
)
22348 case MODE_LINE_NOPROP
:
22349 case MODE_LINE_TITLE
:
22350 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22352 case MODE_LINE_STRING
:
22353 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
22355 case MODE_LINE_DISPLAY
:
22356 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22365 /* Store a mode-line string element in mode_line_string_list.
22367 If STRING is non-null, display that C string. Otherwise, the Lisp
22368 string LISP_STRING is displayed.
22370 FIELD_WIDTH is the minimum number of output glyphs to produce.
22371 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22372 with spaces. FIELD_WIDTH <= 0 means don't pad.
22374 PRECISION is the maximum number of characters to output from
22375 STRING. PRECISION <= 0 means don't truncate the string.
22377 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
22378 properties to the string.
22380 PROPS are the properties to add to the string.
22381 The mode_line_string_face face property is always added to the string.
22385 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
22386 int field_width
, int precision
, Lisp_Object props
)
22391 if (string
!= NULL
)
22393 len
= strlen (string
);
22394 if (precision
> 0 && len
> precision
)
22396 lisp_string
= make_string (string
, len
);
22398 props
= mode_line_string_face_prop
;
22399 else if (!NILP (mode_line_string_face
))
22401 Lisp_Object face
= Fplist_get (props
, Qface
);
22402 props
= Fcopy_sequence (props
);
22404 face
= mode_line_string_face
;
22406 face
= list2 (face
, mode_line_string_face
);
22407 props
= Fplist_put (props
, Qface
, face
);
22409 Fadd_text_properties (make_number (0), make_number (len
),
22410 props
, lisp_string
);
22414 len
= XFASTINT (Flength (lisp_string
));
22415 if (precision
> 0 && len
> precision
)
22418 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22421 if (!NILP (mode_line_string_face
))
22425 props
= Ftext_properties_at (make_number (0), lisp_string
);
22426 face
= Fplist_get (props
, Qface
);
22428 face
= mode_line_string_face
;
22430 face
= list2 (face
, mode_line_string_face
);
22431 props
= list2 (Qface
, face
);
22433 lisp_string
= Fcopy_sequence (lisp_string
);
22436 Fadd_text_properties (make_number (0), make_number (len
),
22437 props
, lisp_string
);
22442 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22446 if (field_width
> len
)
22448 field_width
-= len
;
22449 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22451 Fadd_text_properties (make_number (0), make_number (field_width
),
22452 props
, lisp_string
);
22453 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22461 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22463 doc
: /* Format a string out of a mode line format specification.
22464 First arg FORMAT specifies the mode line format (see `mode-line-format'
22465 for details) to use.
22467 By default, the format is evaluated for the currently selected window.
22469 Optional second arg FACE specifies the face property to put on all
22470 characters for which no face is specified. The value nil means the
22471 default face. The value t means whatever face the window's mode line
22472 currently uses (either `mode-line' or `mode-line-inactive',
22473 depending on whether the window is the selected window or not).
22474 An integer value means the value string has no text
22477 Optional third and fourth args WINDOW and BUFFER specify the window
22478 and buffer to use as the context for the formatting (defaults
22479 are the selected window and the WINDOW's buffer). */)
22480 (Lisp_Object format
, Lisp_Object face
,
22481 Lisp_Object window
, Lisp_Object buffer
)
22486 struct buffer
*old_buffer
= NULL
;
22488 int no_props
= INTEGERP (face
);
22489 ptrdiff_t count
= SPECPDL_INDEX ();
22491 int string_start
= 0;
22493 w
= decode_any_window (window
);
22494 XSETWINDOW (window
, w
);
22497 buffer
= w
->contents
;
22498 CHECK_BUFFER (buffer
);
22500 /* Make formatting the modeline a non-op when noninteractive, otherwise
22501 there will be problems later caused by a partially initialized frame. */
22502 if (NILP (format
) || noninteractive
)
22503 return empty_unibyte_string
;
22508 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22509 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22510 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22511 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22512 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22513 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22514 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22517 old_buffer
= current_buffer
;
22519 /* Save things including mode_line_proptrans_alist,
22520 and set that to nil so that we don't alter the outer value. */
22521 record_unwind_protect (unwind_format_mode_line
,
22522 format_mode_line_unwind_data
22523 (XFRAME (WINDOW_FRAME (w
)),
22524 old_buffer
, selected_window
, 1));
22525 mode_line_proptrans_alist
= Qnil
;
22527 Fselect_window (window
, Qt
);
22528 set_buffer_internal_1 (XBUFFER (buffer
));
22530 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22534 mode_line_target
= MODE_LINE_NOPROP
;
22535 mode_line_string_face_prop
= Qnil
;
22536 mode_line_string_list
= Qnil
;
22537 string_start
= MODE_LINE_NOPROP_LEN (0);
22541 mode_line_target
= MODE_LINE_STRING
;
22542 mode_line_string_list
= Qnil
;
22543 mode_line_string_face
= face
;
22544 mode_line_string_face_prop
22545 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22548 push_kboard (FRAME_KBOARD (it
.f
));
22549 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
22554 len
= MODE_LINE_NOPROP_LEN (string_start
);
22555 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22559 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22560 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
22561 empty_unibyte_string
);
22564 unbind_to (count
, Qnil
);
22568 /* Write a null-terminated, right justified decimal representation of
22569 the positive integer D to BUF using a minimal field width WIDTH. */
22572 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22574 register char *p
= buf
;
22582 *p
++ = d
% 10 + '0';
22587 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22598 /* Write a null-terminated, right justified decimal and "human
22599 readable" representation of the nonnegative integer D to BUF using
22600 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22602 static const char power_letter
[] =
22616 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22618 /* We aim to represent the nonnegative integer D as
22619 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22620 ptrdiff_t quotient
= d
;
22622 /* -1 means: do not use TENTHS. */
22626 /* Length of QUOTIENT.TENTHS as a string. */
22632 if (quotient
>= 1000)
22634 /* Scale to the appropriate EXPONENT. */
22637 remainder
= quotient
% 1000;
22641 while (quotient
>= 1000);
22643 /* Round to nearest and decide whether to use TENTHS or not. */
22646 tenths
= remainder
/ 100;
22647 if (remainder
% 100 >= 50)
22654 if (quotient
== 10)
22662 if (remainder
>= 500)
22664 if (quotient
< 999)
22675 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22676 if (tenths
== -1 && quotient
<= 99)
22683 p
= psuffix
= buf
+ max (width
, length
);
22685 /* Print EXPONENT. */
22686 *psuffix
++ = power_letter
[exponent
];
22689 /* Print TENTHS. */
22692 *--p
= '0' + tenths
;
22696 /* Print QUOTIENT. */
22699 int digit
= quotient
% 10;
22700 *--p
= '0' + digit
;
22702 while ((quotient
/= 10) != 0);
22704 /* Print leading spaces. */
22709 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22710 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
22711 type of CODING_SYSTEM. Return updated pointer into BUF. */
22713 static unsigned char invalid_eol_type
[] = "(*invalid*)";
22716 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
22719 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
22720 const unsigned char *eol_str
;
22722 /* The EOL conversion we are using. */
22723 Lisp_Object eoltype
;
22725 val
= CODING_SYSTEM_SPEC (coding_system
);
22728 if (!VECTORP (val
)) /* Not yet decided. */
22730 *buf
++ = multibyte
? '-' : ' ';
22732 eoltype
= eol_mnemonic_undecided
;
22733 /* Don't mention EOL conversion if it isn't decided. */
22738 Lisp_Object eolvalue
;
22740 attrs
= AREF (val
, 0);
22741 eolvalue
= AREF (val
, 2);
22744 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
22749 /* The EOL conversion that is normal on this system. */
22751 if (NILP (eolvalue
)) /* Not yet decided. */
22752 eoltype
= eol_mnemonic_undecided
;
22753 else if (VECTORP (eolvalue
)) /* Not yet decided. */
22754 eoltype
= eol_mnemonic_undecided
;
22755 else /* eolvalue is Qunix, Qdos, or Qmac. */
22756 eoltype
= (EQ (eolvalue
, Qunix
)
22757 ? eol_mnemonic_unix
22758 : (EQ (eolvalue
, Qdos
) == 1
22759 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
22765 /* Mention the EOL conversion if it is not the usual one. */
22766 if (STRINGP (eoltype
))
22768 eol_str
= SDATA (eoltype
);
22769 eol_str_len
= SBYTES (eoltype
);
22771 else if (CHARACTERP (eoltype
))
22773 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
22774 int c
= XFASTINT (eoltype
);
22775 eol_str_len
= CHAR_STRING (c
, tmp
);
22780 eol_str
= invalid_eol_type
;
22781 eol_str_len
= sizeof (invalid_eol_type
) - 1;
22783 memcpy (buf
, eol_str
, eol_str_len
);
22784 buf
+= eol_str_len
;
22790 /* Return a string for the output of a mode line %-spec for window W,
22791 generated by character C. FIELD_WIDTH > 0 means pad the string
22792 returned with spaces to that value. Return a Lisp string in
22793 *STRING if the resulting string is taken from that Lisp string.
22795 Note we operate on the current buffer for most purposes. */
22797 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
22799 static const char *
22800 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
22801 Lisp_Object
*string
)
22804 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22805 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
22806 /* We are going to use f->decode_mode_spec_buffer as the buffer to
22807 produce strings from numerical values, so limit preposterously
22808 large values of FIELD_WIDTH to avoid overrunning the buffer's
22809 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
22810 bytes plus the terminating null. */
22811 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
22812 struct buffer
*b
= current_buffer
;
22820 if (!NILP (BVAR (b
, read_only
)))
22822 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22827 /* This differs from %* only for a modified read-only buffer. */
22828 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22830 if (!NILP (BVAR (b
, read_only
)))
22835 /* This differs from %* in ignoring read-only-ness. */
22836 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22848 if (command_loop_level
> 5)
22850 p
= decode_mode_spec_buf
;
22851 for (i
= 0; i
< command_loop_level
; i
++)
22854 return decode_mode_spec_buf
;
22862 if (command_loop_level
> 5)
22864 p
= decode_mode_spec_buf
;
22865 for (i
= 0; i
< command_loop_level
; i
++)
22868 return decode_mode_spec_buf
;
22875 /* Let lots_of_dashes be a string of infinite length. */
22876 if (mode_line_target
== MODE_LINE_NOPROP
22877 || mode_line_target
== MODE_LINE_STRING
)
22879 if (field_width
<= 0
22880 || field_width
> sizeof (lots_of_dashes
))
22882 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
22883 decode_mode_spec_buf
[i
] = '-';
22884 decode_mode_spec_buf
[i
] = '\0';
22885 return decode_mode_spec_buf
;
22888 return lots_of_dashes
;
22892 obj
= BVAR (b
, name
);
22896 /* %c and %l are ignored in `frame-title-format'.
22897 (In redisplay_internal, the frame title is drawn _before_ the
22898 windows are updated, so the stuff which depends on actual
22899 window contents (such as %l) may fail to render properly, or
22900 even crash emacs.) */
22901 if (mode_line_target
== MODE_LINE_TITLE
)
22905 ptrdiff_t col
= current_column ();
22906 w
->column_number_displayed
= col
;
22907 pint2str (decode_mode_spec_buf
, width
, col
);
22908 return decode_mode_spec_buf
;
22912 #ifndef SYSTEM_MALLOC
22914 if (NILP (Vmemory_full
))
22917 return "!MEM FULL! ";
22924 /* %F displays the frame name. */
22925 if (!NILP (f
->title
))
22926 return SSDATA (f
->title
);
22927 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
22928 return SSDATA (f
->name
);
22932 obj
= BVAR (b
, filename
);
22937 ptrdiff_t size
= ZV
- BEGV
;
22938 pint2str (decode_mode_spec_buf
, width
, size
);
22939 return decode_mode_spec_buf
;
22944 ptrdiff_t size
= ZV
- BEGV
;
22945 pint2hrstr (decode_mode_spec_buf
, width
, size
);
22946 return decode_mode_spec_buf
;
22951 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
22952 ptrdiff_t topline
, nlines
, height
;
22955 /* %c and %l are ignored in `frame-title-format'. */
22956 if (mode_line_target
== MODE_LINE_TITLE
)
22959 startpos
= marker_position (w
->start
);
22960 startpos_byte
= marker_byte_position (w
->start
);
22961 height
= WINDOW_TOTAL_LINES (w
);
22963 /* If we decided that this buffer isn't suitable for line numbers,
22964 don't forget that too fast. */
22965 if (w
->base_line_pos
== -1)
22968 /* If the buffer is very big, don't waste time. */
22969 if (INTEGERP (Vline_number_display_limit
)
22970 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
22972 w
->base_line_pos
= 0;
22973 w
->base_line_number
= 0;
22977 if (w
->base_line_number
> 0
22978 && w
->base_line_pos
> 0
22979 && w
->base_line_pos
<= startpos
)
22981 line
= w
->base_line_number
;
22982 linepos
= w
->base_line_pos
;
22983 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
22988 linepos
= BUF_BEGV (b
);
22989 linepos_byte
= BUF_BEGV_BYTE (b
);
22992 /* Count lines from base line to window start position. */
22993 nlines
= display_count_lines (linepos_byte
,
22997 topline
= nlines
+ line
;
22999 /* Determine a new base line, if the old one is too close
23000 or too far away, or if we did not have one.
23001 "Too close" means it's plausible a scroll-down would
23002 go back past it. */
23003 if (startpos
== BUF_BEGV (b
))
23005 w
->base_line_number
= topline
;
23006 w
->base_line_pos
= BUF_BEGV (b
);
23008 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23009 || linepos
== BUF_BEGV (b
))
23011 ptrdiff_t limit
= BUF_BEGV (b
);
23012 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23013 ptrdiff_t position
;
23014 ptrdiff_t distance
=
23015 (height
* 2 + 30) * line_number_display_limit_width
;
23017 if (startpos
- distance
> limit
)
23019 limit
= startpos
- distance
;
23020 limit_byte
= CHAR_TO_BYTE (limit
);
23023 nlines
= display_count_lines (startpos_byte
,
23025 - (height
* 2 + 30),
23027 /* If we couldn't find the lines we wanted within
23028 line_number_display_limit_width chars per line,
23029 give up on line numbers for this window. */
23030 if (position
== limit_byte
&& limit
== startpos
- distance
)
23032 w
->base_line_pos
= -1;
23033 w
->base_line_number
= 0;
23037 w
->base_line_number
= topline
- nlines
;
23038 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23041 /* Now count lines from the start pos to point. */
23042 nlines
= display_count_lines (startpos_byte
,
23043 PT_BYTE
, PT
, &junk
);
23045 /* Record that we did display the line number. */
23046 line_number_displayed
= 1;
23048 /* Make the string to show. */
23049 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23050 return decode_mode_spec_buf
;
23053 char* p
= decode_mode_spec_buf
;
23054 int pad
= width
- 2;
23060 return decode_mode_spec_buf
;
23066 obj
= BVAR (b
, mode_name
);
23070 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23076 ptrdiff_t pos
= marker_position (w
->start
);
23077 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23079 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23081 if (pos
<= BUF_BEGV (b
))
23086 else if (pos
<= BUF_BEGV (b
))
23090 if (total
> 1000000)
23091 /* Do it differently for a large value, to avoid overflow. */
23092 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23094 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23095 /* We can't normally display a 3-digit number,
23096 so get us a 2-digit number that is close. */
23099 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23100 return decode_mode_spec_buf
;
23104 /* Display percentage of size above the bottom of the screen. */
23107 ptrdiff_t toppos
= marker_position (w
->start
);
23108 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23109 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23111 if (botpos
>= BUF_ZV (b
))
23113 if (toppos
<= BUF_BEGV (b
))
23120 if (total
> 1000000)
23121 /* Do it differently for a large value, to avoid overflow. */
23122 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23124 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23125 /* We can't normally display a 3-digit number,
23126 so get us a 2-digit number that is close. */
23129 if (toppos
<= BUF_BEGV (b
))
23130 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23132 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23133 return decode_mode_spec_buf
;
23138 /* status of process */
23139 obj
= Fget_buffer_process (Fcurrent_buffer ());
23141 return "no process";
23143 obj
= Fsymbol_name (Fprocess_status (obj
));
23149 ptrdiff_t count
= inhibit_garbage_collection ();
23150 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23151 Lisp_Object val
= Qnil
;
23153 if (STRINGP (curdir
))
23154 val
= call1 (intern ("file-remote-p"), curdir
);
23156 unbind_to (count
, Qnil
);
23165 /* coding-system (not including end-of-line format) */
23167 /* coding-system (including end-of-line type) */
23169 int eol_flag
= (c
== 'Z');
23170 char *p
= decode_mode_spec_buf
;
23172 if (! FRAME_WINDOW_P (f
))
23174 /* No need to mention EOL here--the terminal never needs
23175 to do EOL conversion. */
23176 p
= decode_mode_spec_coding (CODING_ID_NAME
23177 (FRAME_KEYBOARD_CODING (f
)->id
),
23179 p
= decode_mode_spec_coding (CODING_ID_NAME
23180 (FRAME_TERMINAL_CODING (f
)->id
),
23183 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23186 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
23187 #ifdef subprocesses
23188 obj
= Fget_buffer_process (Fcurrent_buffer ());
23189 if (PROCESSP (obj
))
23191 p
= decode_mode_spec_coding
23192 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23193 p
= decode_mode_spec_coding
23194 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23196 #endif /* subprocesses */
23199 return decode_mode_spec_buf
;
23206 return SSDATA (obj
);
23213 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23214 means count lines back from START_BYTE. But don't go beyond
23215 LIMIT_BYTE. Return the number of lines thus found (always
23218 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23219 either the position COUNT lines after/before START_BYTE, if we
23220 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23224 display_count_lines (ptrdiff_t start_byte
,
23225 ptrdiff_t limit_byte
, ptrdiff_t count
,
23226 ptrdiff_t *byte_pos_ptr
)
23228 register unsigned char *cursor
;
23229 unsigned char *base
;
23231 register ptrdiff_t ceiling
;
23232 register unsigned char *ceiling_addr
;
23233 ptrdiff_t orig_count
= count
;
23235 /* If we are not in selective display mode,
23236 check only for newlines. */
23237 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
23238 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23242 while (start_byte
< limit_byte
)
23244 ceiling
= BUFFER_CEILING_OF (start_byte
);
23245 ceiling
= min (limit_byte
- 1, ceiling
);
23246 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23247 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23251 if (selective_display
)
23253 while (*cursor
!= '\n' && *cursor
!= 015
23254 && ++cursor
!= ceiling_addr
)
23256 if (cursor
== ceiling_addr
)
23261 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23270 start_byte
+= cursor
- base
;
23271 *byte_pos_ptr
= start_byte
;
23275 while (cursor
< ceiling_addr
);
23277 start_byte
+= ceiling_addr
- base
;
23282 while (start_byte
> limit_byte
)
23284 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23285 ceiling
= max (limit_byte
, ceiling
);
23286 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23287 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23290 if (selective_display
)
23292 while (--cursor
>= ceiling_addr
23293 && *cursor
!= '\n' && *cursor
!= 015)
23295 if (cursor
< ceiling_addr
)
23300 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23307 start_byte
+= cursor
- base
+ 1;
23308 *byte_pos_ptr
= start_byte
;
23309 /* When scanning backwards, we should
23310 not count the newline posterior to which we stop. */
23311 return - orig_count
- 1;
23314 start_byte
+= ceiling_addr
- base
;
23318 *byte_pos_ptr
= limit_byte
;
23321 return - orig_count
+ count
;
23322 return orig_count
- count
;
23328 /***********************************************************************
23330 ***********************************************************************/
23332 /* Display a NUL-terminated string, starting with index START.
23334 If STRING is non-null, display that C string. Otherwise, the Lisp
23335 string LISP_STRING is displayed. There's a case that STRING is
23336 non-null and LISP_STRING is not nil. It means STRING is a string
23337 data of LISP_STRING. In that case, we display LISP_STRING while
23338 ignoring its text properties.
23340 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23341 FACE_STRING. Display STRING or LISP_STRING with the face at
23342 FACE_STRING_POS in FACE_STRING:
23344 Display the string in the environment given by IT, but use the
23345 standard display table, temporarily.
23347 FIELD_WIDTH is the minimum number of output glyphs to produce.
23348 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23349 with spaces. If STRING has more characters, more than FIELD_WIDTH
23350 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23352 PRECISION is the maximum number of characters to output from
23353 STRING. PRECISION < 0 means don't truncate the string.
23355 This is roughly equivalent to printf format specifiers:
23357 FIELD_WIDTH PRECISION PRINTF
23358 ----------------------------------------
23364 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23365 display them, and < 0 means obey the current buffer's value of
23366 enable_multibyte_characters.
23368 Value is the number of columns displayed. */
23371 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23372 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23373 int field_width
, int precision
, int max_x
, int multibyte
)
23375 int hpos_at_start
= it
->hpos
;
23376 int saved_face_id
= it
->face_id
;
23377 struct glyph_row
*row
= it
->glyph_row
;
23378 ptrdiff_t it_charpos
;
23380 /* Initialize the iterator IT for iteration over STRING beginning
23381 with index START. */
23382 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23383 precision
, field_width
, multibyte
);
23384 if (string
&& STRINGP (lisp_string
))
23385 /* LISP_STRING is the one returned by decode_mode_spec. We should
23386 ignore its text properties. */
23387 it
->stop_charpos
= it
->end_charpos
;
23389 /* If displaying STRING, set up the face of the iterator from
23390 FACE_STRING, if that's given. */
23391 if (STRINGP (face_string
))
23397 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23398 0, &endptr
, it
->base_face_id
, 0);
23399 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23400 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23403 /* Set max_x to the maximum allowed X position. Don't let it go
23404 beyond the right edge of the window. */
23406 max_x
= it
->last_visible_x
;
23408 max_x
= min (max_x
, it
->last_visible_x
);
23410 /* Skip over display elements that are not visible. because IT->w is
23412 if (it
->current_x
< it
->first_visible_x
)
23413 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23414 MOVE_TO_POS
| MOVE_TO_X
);
23416 row
->ascent
= it
->max_ascent
;
23417 row
->height
= it
->max_ascent
+ it
->max_descent
;
23418 row
->phys_ascent
= it
->max_phys_ascent
;
23419 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23420 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23422 if (STRINGP (it
->string
))
23423 it_charpos
= IT_STRING_CHARPOS (*it
);
23425 it_charpos
= IT_CHARPOS (*it
);
23427 /* This condition is for the case that we are called with current_x
23428 past last_visible_x. */
23429 while (it
->current_x
< max_x
)
23431 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23433 /* Get the next display element. */
23434 if (!get_next_display_element (it
))
23437 /* Produce glyphs. */
23438 x_before
= it
->current_x
;
23439 n_glyphs_before
= row
->used
[TEXT_AREA
];
23440 PRODUCE_GLYPHS (it
);
23442 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23445 while (i
< nglyphs
)
23447 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23449 if (it
->line_wrap
!= TRUNCATE
23450 && x
+ glyph
->pixel_width
> max_x
)
23452 /* End of continued line or max_x reached. */
23453 if (CHAR_GLYPH_PADDING_P (*glyph
))
23455 /* A wide character is unbreakable. */
23456 if (row
->reversed_p
)
23457 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23458 - n_glyphs_before
);
23459 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23460 it
->current_x
= x_before
;
23464 if (row
->reversed_p
)
23465 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23466 - (n_glyphs_before
+ i
));
23467 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23472 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23474 /* Glyph is at least partially visible. */
23476 if (x
< it
->first_visible_x
)
23477 row
->x
= x
- it
->first_visible_x
;
23481 /* Glyph is off the left margin of the display area.
23482 Should not happen. */
23486 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23487 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23488 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23489 row
->phys_height
= max (row
->phys_height
,
23490 it
->max_phys_ascent
+ it
->max_phys_descent
);
23491 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23492 it
->max_extra_line_spacing
);
23493 x
+= glyph
->pixel_width
;
23497 /* Stop if max_x reached. */
23501 /* Stop at line ends. */
23502 if (ITERATOR_AT_END_OF_LINE_P (it
))
23504 it
->continuation_lines_width
= 0;
23508 set_iterator_to_next (it
, 1);
23509 if (STRINGP (it
->string
))
23510 it_charpos
= IT_STRING_CHARPOS (*it
);
23512 it_charpos
= IT_CHARPOS (*it
);
23514 /* Stop if truncating at the right edge. */
23515 if (it
->line_wrap
== TRUNCATE
23516 && it
->current_x
>= it
->last_visible_x
)
23518 /* Add truncation mark, but don't do it if the line is
23519 truncated at a padding space. */
23520 if (it_charpos
< it
->string_nchars
)
23522 if (!FRAME_WINDOW_P (it
->f
))
23526 if (it
->current_x
> it
->last_visible_x
)
23528 if (!row
->reversed_p
)
23530 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23531 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23536 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23537 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23539 unproduce_glyphs (it
, ii
+ 1);
23540 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23542 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23544 row
->used
[TEXT_AREA
] = ii
;
23545 produce_special_glyphs (it
, IT_TRUNCATION
);
23548 produce_special_glyphs (it
, IT_TRUNCATION
);
23550 row
->truncated_on_right_p
= 1;
23556 /* Maybe insert a truncation at the left. */
23557 if (it
->first_visible_x
23560 if (!FRAME_WINDOW_P (it
->f
)
23561 || (row
->reversed_p
23562 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23563 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23564 insert_left_trunc_glyphs (it
);
23565 row
->truncated_on_left_p
= 1;
23568 it
->face_id
= saved_face_id
;
23570 /* Value is number of columns displayed. */
23571 return it
->hpos
- hpos_at_start
;
23576 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23577 appears as an element of LIST or as the car of an element of LIST.
23578 If PROPVAL is a list, compare each element against LIST in that
23579 way, and return 1/2 if any element of PROPVAL is found in LIST.
23580 Otherwise return 0. This function cannot quit.
23581 The return value is 2 if the text is invisible but with an ellipsis
23582 and 1 if it's invisible and without an ellipsis. */
23585 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
23587 register Lisp_Object tail
, proptail
;
23589 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23591 register Lisp_Object tem
;
23593 if (EQ (propval
, tem
))
23595 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23596 return NILP (XCDR (tem
)) ? 1 : 2;
23599 if (CONSP (propval
))
23601 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23603 Lisp_Object propelt
;
23604 propelt
= XCAR (proptail
);
23605 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23607 register Lisp_Object tem
;
23609 if (EQ (propelt
, tem
))
23611 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23612 return NILP (XCDR (tem
)) ? 1 : 2;
23620 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23621 doc
: /* Non-nil if the property makes the text invisible.
23622 POS-OR-PROP can be a marker or number, in which case it is taken to be
23623 a position in the current buffer and the value of the `invisible' property
23624 is checked; or it can be some other value, which is then presumed to be the
23625 value of the `invisible' property of the text of interest.
23626 The non-nil value returned can be t for truly invisible text or something
23627 else if the text is replaced by an ellipsis. */)
23628 (Lisp_Object pos_or_prop
)
23631 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23632 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23634 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23635 return (invis
== 0 ? Qnil
23637 : make_number (invis
));
23640 /* Calculate a width or height in pixels from a specification using
23641 the following elements:
23644 NUM - a (fractional) multiple of the default font width/height
23645 (NUM) - specifies exactly NUM pixels
23646 UNIT - a fixed number of pixels, see below.
23647 ELEMENT - size of a display element in pixels, see below.
23648 (NUM . SPEC) - equals NUM * SPEC
23649 (+ SPEC SPEC ...) - add pixel values
23650 (- SPEC SPEC ...) - subtract pixel values
23651 (- SPEC) - negate pixel value
23654 INT or FLOAT - a number constant
23655 SYMBOL - use symbol's (buffer local) variable binding.
23658 in - pixels per inch *)
23659 mm - pixels per 1/1000 meter *)
23660 cm - pixels per 1/100 meter *)
23661 width - width of current font in pixels.
23662 height - height of current font in pixels.
23664 *) using the ratio(s) defined in display-pixels-per-inch.
23668 left-fringe - left fringe width in pixels
23669 right-fringe - right fringe width in pixels
23671 left-margin - left margin width in pixels
23672 right-margin - right margin width in pixels
23674 scroll-bar - scroll-bar area width in pixels
23678 Pixels corresponding to 5 inches:
23681 Total width of non-text areas on left side of window (if scroll-bar is on left):
23682 '(space :width (+ left-fringe left-margin scroll-bar))
23684 Align to first text column (in header line):
23685 '(space :align-to 0)
23687 Align to middle of text area minus half the width of variable `my-image'
23688 containing a loaded image:
23689 '(space :align-to (0.5 . (- text my-image)))
23691 Width of left margin minus width of 1 character in the default font:
23692 '(space :width (- left-margin 1))
23694 Width of left margin minus width of 2 characters in the current font:
23695 '(space :width (- left-margin (2 . width)))
23697 Center 1 character over left-margin (in header line):
23698 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23700 Different ways to express width of left fringe plus left margin minus one pixel:
23701 '(space :width (- (+ left-fringe left-margin) (1)))
23702 '(space :width (+ left-fringe left-margin (- (1))))
23703 '(space :width (+ left-fringe left-margin (-1)))
23708 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
23709 struct font
*font
, int width_p
, int *align_to
)
23713 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
23714 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
23717 return OK_PIXELS (0);
23719 eassert (FRAME_LIVE_P (it
->f
));
23721 if (SYMBOLP (prop
))
23723 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
23725 char *unit
= SSDATA (SYMBOL_NAME (prop
));
23727 if (unit
[0] == 'i' && unit
[1] == 'n')
23729 else if (unit
[0] == 'm' && unit
[1] == 'm')
23731 else if (unit
[0] == 'c' && unit
[1] == 'm')
23737 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
23738 : FRAME_RES_Y (it
->f
));
23741 return OK_PIXELS (ppi
/ pixels
);
23746 #ifdef HAVE_WINDOW_SYSTEM
23747 if (EQ (prop
, Qheight
))
23748 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
23749 if (EQ (prop
, Qwidth
))
23750 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
23752 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
23753 return OK_PIXELS (1);
23756 if (EQ (prop
, Qtext
))
23757 return OK_PIXELS (width_p
23758 ? window_box_width (it
->w
, TEXT_AREA
)
23759 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
23761 if (align_to
&& *align_to
< 0)
23764 if (EQ (prop
, Qleft
))
23765 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
23766 if (EQ (prop
, Qright
))
23767 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
23768 if (EQ (prop
, Qcenter
))
23769 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
23770 + window_box_width (it
->w
, TEXT_AREA
) / 2);
23771 if (EQ (prop
, Qleft_fringe
))
23772 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23773 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
23774 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
23775 if (EQ (prop
, Qright_fringe
))
23776 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23777 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23778 : window_box_right_offset (it
->w
, TEXT_AREA
));
23779 if (EQ (prop
, Qleft_margin
))
23780 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
23781 if (EQ (prop
, Qright_margin
))
23782 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
23783 if (EQ (prop
, Qscroll_bar
))
23784 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
23786 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23787 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23788 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23793 if (EQ (prop
, Qleft_fringe
))
23794 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
23795 if (EQ (prop
, Qright_fringe
))
23796 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
23797 if (EQ (prop
, Qleft_margin
))
23798 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
23799 if (EQ (prop
, Qright_margin
))
23800 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
23801 if (EQ (prop
, Qscroll_bar
))
23802 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
23805 prop
= buffer_local_value_1 (prop
, it
->w
->contents
);
23806 if (EQ (prop
, Qunbound
))
23810 if (INTEGERP (prop
) || FLOATP (prop
))
23812 int base_unit
= (width_p
23813 ? FRAME_COLUMN_WIDTH (it
->f
)
23814 : FRAME_LINE_HEIGHT (it
->f
));
23815 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
23820 Lisp_Object car
= XCAR (prop
);
23821 Lisp_Object cdr
= XCDR (prop
);
23825 #ifdef HAVE_WINDOW_SYSTEM
23826 if (FRAME_WINDOW_P (it
->f
)
23827 && valid_image_p (prop
))
23829 ptrdiff_t id
= lookup_image (it
->f
, prop
);
23830 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
23832 return OK_PIXELS (width_p
? img
->width
: img
->height
);
23835 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
23841 while (CONSP (cdr
))
23843 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
23844 font
, width_p
, align_to
))
23847 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
23852 if (EQ (car
, Qminus
))
23854 return OK_PIXELS (pixels
);
23857 car
= buffer_local_value_1 (car
, it
->w
->contents
);
23858 if (EQ (car
, Qunbound
))
23862 if (INTEGERP (car
) || FLOATP (car
))
23865 pixels
= XFLOATINT (car
);
23867 return OK_PIXELS (pixels
);
23868 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
23869 font
, width_p
, align_to
))
23870 return OK_PIXELS (pixels
* fact
);
23881 /***********************************************************************
23883 ***********************************************************************/
23885 #ifdef HAVE_WINDOW_SYSTEM
23890 dump_glyph_string (struct glyph_string
*s
)
23892 fprintf (stderr
, "glyph string\n");
23893 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
23894 s
->x
, s
->y
, s
->width
, s
->height
);
23895 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
23896 fprintf (stderr
, " hl = %d\n", s
->hl
);
23897 fprintf (stderr
, " left overhang = %d, right = %d\n",
23898 s
->left_overhang
, s
->right_overhang
);
23899 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
23900 fprintf (stderr
, " extends to end of line = %d\n",
23901 s
->extends_to_end_of_line_p
);
23902 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
23903 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
23906 #endif /* GLYPH_DEBUG */
23908 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
23909 of XChar2b structures for S; it can't be allocated in
23910 init_glyph_string because it must be allocated via `alloca'. W
23911 is the window on which S is drawn. ROW and AREA are the glyph row
23912 and area within the row from which S is constructed. START is the
23913 index of the first glyph structure covered by S. HL is a
23914 face-override for drawing S. */
23917 #define OPTIONAL_HDC(hdc) HDC hdc,
23918 #define DECLARE_HDC(hdc) HDC hdc;
23919 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
23920 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
23923 #ifndef OPTIONAL_HDC
23924 #define OPTIONAL_HDC(hdc)
23925 #define DECLARE_HDC(hdc)
23926 #define ALLOCATE_HDC(hdc, f)
23927 #define RELEASE_HDC(hdc, f)
23931 init_glyph_string (struct glyph_string
*s
,
23933 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
23934 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
23936 memset (s
, 0, sizeof *s
);
23938 s
->f
= XFRAME (w
->frame
);
23942 s
->display
= FRAME_X_DISPLAY (s
->f
);
23943 s
->window
= FRAME_X_WINDOW (s
->f
);
23944 s
->char2b
= char2b
;
23948 s
->first_glyph
= row
->glyphs
[area
] + start
;
23949 s
->height
= row
->height
;
23950 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
23951 s
->ybase
= s
->y
+ row
->ascent
;
23955 /* Append the list of glyph strings with head H and tail T to the list
23956 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
23959 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23960 struct glyph_string
*h
, struct glyph_string
*t
)
23974 /* Prepend the list of glyph strings with head H and tail T to the
23975 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
23979 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23980 struct glyph_string
*h
, struct glyph_string
*t
)
23994 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
23995 Set *HEAD and *TAIL to the resulting list. */
23998 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
23999 struct glyph_string
*s
)
24001 s
->next
= s
->prev
= NULL
;
24002 append_glyph_string_lists (head
, tail
, s
, s
);
24006 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24007 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
24008 make sure that X resources for the face returned are allocated.
24009 Value is a pointer to a realized face that is ready for display if
24010 DISPLAY_P is non-zero. */
24012 static struct face
*
24013 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24014 XChar2b
*char2b
, int display_p
)
24016 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24021 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24023 if (code
== FONT_INVALID_CODE
)
24026 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24028 /* Make sure X resources of the face are allocated. */
24029 #ifdef HAVE_X_WINDOWS
24033 eassert (face
!= NULL
);
24034 PREPARE_FACE_FOR_DISPLAY (f
, face
);
24041 /* Get face and two-byte form of character glyph GLYPH on frame F.
24042 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24043 a pointer to a realized face that is ready for display. */
24045 static struct face
*
24046 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24047 XChar2b
*char2b
, int *two_byte_p
)
24052 eassert (glyph
->type
== CHAR_GLYPH
);
24053 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24055 /* Make sure X resources of the face are allocated. */
24056 eassert (face
!= NULL
);
24057 PREPARE_FACE_FOR_DISPLAY (f
, face
);
24064 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24065 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24067 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24069 if (code
== FONT_INVALID_CODE
)
24073 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24078 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24079 Return 1 if FONT has a glyph for C, otherwise return 0. */
24082 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24086 if (CHAR_BYTE8_P (c
))
24087 code
= CHAR_TO_BYTE8 (c
);
24089 code
= font
->driver
->encode_char (font
, c
);
24091 if (code
== FONT_INVALID_CODE
)
24093 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24098 /* Fill glyph string S with composition components specified by S->cmp.
24100 BASE_FACE is the base face of the composition.
24101 S->cmp_from is the index of the first component for S.
24103 OVERLAPS non-zero means S should draw the foreground only, and use
24104 its physical height for clipping. See also draw_glyphs.
24106 Value is the index of a component not in S. */
24109 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24113 /* For all glyphs of this composition, starting at the offset
24114 S->cmp_from, until we reach the end of the definition or encounter a
24115 glyph that requires the different face, add it to S. */
24120 s
->for_overlaps
= overlaps
;
24123 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24125 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24127 /* TAB in a composition means display glyphs with padding space
24128 on the left or right. */
24131 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24134 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24141 s
->font
= s
->face
->font
;
24143 else if (s
->face
!= face
)
24151 if (s
->face
== NULL
)
24153 s
->face
= base_face
->ascii_face
;
24154 s
->font
= s
->face
->font
;
24157 /* All glyph strings for the same composition has the same width,
24158 i.e. the width set for the first component of the composition. */
24159 s
->width
= s
->first_glyph
->pixel_width
;
24161 /* If the specified font could not be loaded, use the frame's
24162 default font, but record the fact that we couldn't load it in
24163 the glyph string so that we can draw rectangles for the
24164 characters of the glyph string. */
24165 if (s
->font
== NULL
)
24167 s
->font_not_found_p
= 1;
24168 s
->font
= FRAME_FONT (s
->f
);
24171 /* Adjust base line for subscript/superscript text. */
24172 s
->ybase
+= s
->first_glyph
->voffset
;
24174 /* This glyph string must always be drawn with 16-bit functions. */
24181 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24182 int start
, int end
, int overlaps
)
24184 struct glyph
*glyph
, *last
;
24185 Lisp_Object lgstring
;
24188 s
->for_overlaps
= overlaps
;
24189 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24190 last
= s
->row
->glyphs
[s
->area
] + end
;
24191 s
->cmp_id
= glyph
->u
.cmp
.id
;
24192 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24193 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24194 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24195 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24196 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24198 while (glyph
< last
24199 && glyph
->u
.cmp
.automatic
24200 && glyph
->u
.cmp
.id
== s
->cmp_id
24201 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24202 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24204 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24206 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24207 unsigned code
= LGLYPH_CODE (lglyph
);
24209 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24211 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24212 return glyph
- s
->row
->glyphs
[s
->area
];
24216 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24217 See the comment of fill_glyph_string for arguments.
24218 Value is the index of the first glyph not in S. */
24222 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24223 int start
, int end
, int overlaps
)
24225 struct glyph
*glyph
, *last
;
24228 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24229 s
->for_overlaps
= overlaps
;
24230 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24231 last
= s
->row
->glyphs
[s
->area
] + end
;
24232 voffset
= glyph
->voffset
;
24233 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24234 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24236 s
->width
= glyph
->pixel_width
;
24238 while (glyph
< last
24239 && glyph
->type
== GLYPHLESS_GLYPH
24240 && glyph
->voffset
== voffset
24241 && glyph
->face_id
== face_id
)
24244 s
->width
+= glyph
->pixel_width
;
24247 s
->ybase
+= voffset
;
24248 return glyph
- s
->row
->glyphs
[s
->area
];
24252 /* Fill glyph string S from a sequence of character glyphs.
24254 FACE_ID is the face id of the string. START is the index of the
24255 first glyph to consider, END is the index of the last + 1.
24256 OVERLAPS non-zero means S should draw the foreground only, and use
24257 its physical height for clipping. See also draw_glyphs.
24259 Value is the index of the first glyph not in S. */
24262 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24263 int start
, int end
, int overlaps
)
24265 struct glyph
*glyph
, *last
;
24267 int glyph_not_available_p
;
24269 eassert (s
->f
== XFRAME (s
->w
->frame
));
24270 eassert (s
->nchars
== 0);
24271 eassert (start
>= 0 && end
> start
);
24273 s
->for_overlaps
= overlaps
;
24274 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24275 last
= s
->row
->glyphs
[s
->area
] + end
;
24276 voffset
= glyph
->voffset
;
24277 s
->padding_p
= glyph
->padding_p
;
24278 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24280 while (glyph
< last
24281 && glyph
->type
== CHAR_GLYPH
24282 && glyph
->voffset
== voffset
24283 /* Same face id implies same font, nowadays. */
24284 && glyph
->face_id
== face_id
24285 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24289 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24290 s
->char2b
+ s
->nchars
,
24292 s
->two_byte_p
= two_byte_p
;
24294 eassert (s
->nchars
<= end
- start
);
24295 s
->width
+= glyph
->pixel_width
;
24296 if (glyph
++->padding_p
!= s
->padding_p
)
24300 s
->font
= s
->face
->font
;
24302 /* If the specified font could not be loaded, use the frame's font,
24303 but record the fact that we couldn't load it in
24304 S->font_not_found_p so that we can draw rectangles for the
24305 characters of the glyph string. */
24306 if (s
->font
== NULL
|| glyph_not_available_p
)
24308 s
->font_not_found_p
= 1;
24309 s
->font
= FRAME_FONT (s
->f
);
24312 /* Adjust base line for subscript/superscript text. */
24313 s
->ybase
+= voffset
;
24315 eassert (s
->face
&& s
->face
->gc
);
24316 return glyph
- s
->row
->glyphs
[s
->area
];
24320 /* Fill glyph string S from image glyph S->first_glyph. */
24323 fill_image_glyph_string (struct glyph_string
*s
)
24325 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24326 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24328 s
->slice
= s
->first_glyph
->slice
.img
;
24329 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24330 s
->font
= s
->face
->font
;
24331 s
->width
= s
->first_glyph
->pixel_width
;
24333 /* Adjust base line for subscript/superscript text. */
24334 s
->ybase
+= s
->first_glyph
->voffset
;
24338 /* Fill glyph string S from a sequence of stretch glyphs.
24340 START is the index of the first glyph to consider,
24341 END is the index of the last + 1.
24343 Value is the index of the first glyph not in S. */
24346 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24348 struct glyph
*glyph
, *last
;
24349 int voffset
, face_id
;
24351 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24353 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24354 last
= s
->row
->glyphs
[s
->area
] + end
;
24355 face_id
= glyph
->face_id
;
24356 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24357 s
->font
= s
->face
->font
;
24358 s
->width
= glyph
->pixel_width
;
24360 voffset
= glyph
->voffset
;
24364 && glyph
->type
== STRETCH_GLYPH
24365 && glyph
->voffset
== voffset
24366 && glyph
->face_id
== face_id
);
24368 s
->width
+= glyph
->pixel_width
;
24370 /* Adjust base line for subscript/superscript text. */
24371 s
->ybase
+= voffset
;
24373 /* The case that face->gc == 0 is handled when drawing the glyph
24374 string by calling PREPARE_FACE_FOR_DISPLAY. */
24376 return glyph
- s
->row
->glyphs
[s
->area
];
24379 static struct font_metrics
*
24380 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24382 static struct font_metrics metrics
;
24387 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24388 if (code
== FONT_INVALID_CODE
)
24390 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24395 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24396 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24397 assumed to be zero. */
24400 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24402 *left
= *right
= 0;
24404 if (glyph
->type
== CHAR_GLYPH
)
24408 struct font_metrics
*pcm
;
24410 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
24411 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
24413 if (pcm
->rbearing
> pcm
->width
)
24414 *right
= pcm
->rbearing
- pcm
->width
;
24415 if (pcm
->lbearing
< 0)
24416 *left
= -pcm
->lbearing
;
24419 else if (glyph
->type
== COMPOSITE_GLYPH
)
24421 if (! glyph
->u
.cmp
.automatic
)
24423 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24425 if (cmp
->rbearing
> cmp
->pixel_width
)
24426 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24427 if (cmp
->lbearing
< 0)
24428 *left
= - cmp
->lbearing
;
24432 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24433 struct font_metrics metrics
;
24435 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24436 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24437 if (metrics
.rbearing
> metrics
.width
)
24438 *right
= metrics
.rbearing
- metrics
.width
;
24439 if (metrics
.lbearing
< 0)
24440 *left
= - metrics
.lbearing
;
24446 /* Return the index of the first glyph preceding glyph string S that
24447 is overwritten by S because of S's left overhang. Value is -1
24448 if no glyphs are overwritten. */
24451 left_overwritten (struct glyph_string
*s
)
24455 if (s
->left_overhang
)
24458 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24459 int first
= s
->first_glyph
- glyphs
;
24461 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24462 x
-= glyphs
[i
].pixel_width
;
24473 /* Return the index of the first glyph preceding glyph string S that
24474 is overwriting S because of its right overhang. Value is -1 if no
24475 glyph in front of S overwrites S. */
24478 left_overwriting (struct glyph_string
*s
)
24481 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24482 int first
= s
->first_glyph
- glyphs
;
24486 for (i
= first
- 1; i
>= 0; --i
)
24489 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24492 x
-= glyphs
[i
].pixel_width
;
24499 /* Return the index of the last glyph following glyph string S that is
24500 overwritten by S because of S's right overhang. Value is -1 if
24501 no such glyph is found. */
24504 right_overwritten (struct glyph_string
*s
)
24508 if (s
->right_overhang
)
24511 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24512 int first
= (s
->first_glyph
- glyphs
24513 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24514 int end
= s
->row
->used
[s
->area
];
24516 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24517 x
+= glyphs
[i
].pixel_width
;
24526 /* Return the index of the last glyph following glyph string S that
24527 overwrites S because of its left overhang. Value is negative
24528 if no such glyph is found. */
24531 right_overwriting (struct glyph_string
*s
)
24534 int end
= s
->row
->used
[s
->area
];
24535 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24536 int first
= (s
->first_glyph
- glyphs
24537 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24541 for (i
= first
; i
< end
; ++i
)
24544 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24547 x
+= glyphs
[i
].pixel_width
;
24554 /* Set background width of glyph string S. START is the index of the
24555 first glyph following S. LAST_X is the right-most x-position + 1
24556 in the drawing area. */
24559 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24561 /* If the face of this glyph string has to be drawn to the end of
24562 the drawing area, set S->extends_to_end_of_line_p. */
24564 if (start
== s
->row
->used
[s
->area
]
24565 && ((s
->row
->fill_line_p
24566 && (s
->hl
== DRAW_NORMAL_TEXT
24567 || s
->hl
== DRAW_IMAGE_RAISED
24568 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24569 || s
->hl
== DRAW_MOUSE_FACE
))
24570 s
->extends_to_end_of_line_p
= 1;
24572 /* If S extends its face to the end of the line, set its
24573 background_width to the distance to the right edge of the drawing
24575 if (s
->extends_to_end_of_line_p
)
24576 s
->background_width
= last_x
- s
->x
+ 1;
24578 s
->background_width
= s
->width
;
24582 /* Compute overhangs and x-positions for glyph string S and its
24583 predecessors, or successors. X is the starting x-position for S.
24584 BACKWARD_P non-zero means process predecessors. */
24587 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
24593 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24594 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24604 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24605 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24615 /* The following macros are only called from draw_glyphs below.
24616 They reference the following parameters of that function directly:
24617 `w', `row', `area', and `overlap_p'
24618 as well as the following local variables:
24619 `s', `f', and `hdc' (in W32) */
24622 /* On W32, silently add local `hdc' variable to argument list of
24623 init_glyph_string. */
24624 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24625 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24627 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24628 init_glyph_string (s, char2b, w, row, area, start, hl)
24631 /* Add a glyph string for a stretch glyph to the list of strings
24632 between HEAD and TAIL. START is the index of the stretch glyph in
24633 row area AREA of glyph row ROW. END is the index of the last glyph
24634 in that glyph row area. X is the current output position assigned
24635 to the new glyph string constructed. HL overrides that face of the
24636 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24637 is the right-most x-position of the drawing area. */
24639 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24640 and below -- keep them on one line. */
24641 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24644 s = alloca (sizeof *s); \
24645 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24646 START = fill_stretch_glyph_string (s, START, END); \
24647 append_glyph_string (&HEAD, &TAIL, s); \
24653 /* Add a glyph string for an image glyph to the list of strings
24654 between HEAD and TAIL. START is the index of the image glyph in
24655 row area AREA of glyph row ROW. END is the index of the last glyph
24656 in that glyph row area. X is the current output position assigned
24657 to the new glyph string constructed. HL overrides that face of the
24658 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24659 is the right-most x-position of the drawing area. */
24661 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24664 s = alloca (sizeof *s); \
24665 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24666 fill_image_glyph_string (s); \
24667 append_glyph_string (&HEAD, &TAIL, s); \
24674 /* Add a glyph string for a sequence of character glyphs to the list
24675 of strings between HEAD and TAIL. START is the index of the first
24676 glyph in row area AREA of glyph row ROW that is part of the new
24677 glyph string. END is the index of the last glyph in that glyph row
24678 area. X is the current output position assigned to the new glyph
24679 string constructed. HL overrides that face of the glyph; e.g. it
24680 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24681 right-most x-position of the drawing area. */
24683 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24689 face_id = (row)->glyphs[area][START].face_id; \
24691 s = alloca (sizeof *s); \
24692 char2b = alloca ((END - START) * sizeof *char2b); \
24693 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24694 append_glyph_string (&HEAD, &TAIL, s); \
24696 START = fill_glyph_string (s, face_id, START, END, overlaps); \
24701 /* Add a glyph string for a composite sequence to the list of strings
24702 between HEAD and TAIL. START is the index of the first glyph in
24703 row area AREA of glyph row ROW that is part of the new glyph
24704 string. END is the index of the last glyph in that glyph row area.
24705 X is the current output position assigned to the new glyph string
24706 constructed. HL overrides that face of the glyph; e.g. it is
24707 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
24708 x-position of the drawing area. */
24710 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24712 int face_id = (row)->glyphs[area][START].face_id; \
24713 struct face *base_face = FACE_FROM_ID (f, face_id); \
24714 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
24715 struct composition *cmp = composition_table[cmp_id]; \
24717 struct glyph_string *first_s = NULL; \
24720 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
24722 /* Make glyph_strings for each glyph sequence that is drawable by \
24723 the same face, and append them to HEAD/TAIL. */ \
24724 for (n = 0; n < cmp->glyph_len;) \
24726 s = alloca (sizeof *s); \
24727 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24728 append_glyph_string (&(HEAD), &(TAIL), s); \
24734 n = fill_composite_glyph_string (s, base_face, overlaps); \
24742 /* Add a glyph string for a glyph-string sequence to the list of strings
24743 between HEAD and TAIL. */
24745 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24749 Lisp_Object gstring; \
24751 face_id = (row)->glyphs[area][START].face_id; \
24752 gstring = (composition_gstring_from_id \
24753 ((row)->glyphs[area][START].u.cmp.id)); \
24754 s = alloca (sizeof *s); \
24755 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
24756 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24757 append_glyph_string (&(HEAD), &(TAIL), s); \
24759 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
24763 /* Add a glyph string for a sequence of glyphless character's glyphs
24764 to the list of strings between HEAD and TAIL. The meanings of
24765 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
24767 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24772 face_id = (row)->glyphs[area][START].face_id; \
24774 s = alloca (sizeof *s); \
24775 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24776 append_glyph_string (&HEAD, &TAIL, s); \
24778 START = fill_glyphless_glyph_string (s, face_id, START, END, \
24784 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
24785 of AREA of glyph row ROW on window W between indices START and END.
24786 HL overrides the face for drawing glyph strings, e.g. it is
24787 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
24788 x-positions of the drawing area.
24790 This is an ugly monster macro construct because we must use alloca
24791 to allocate glyph strings (because draw_glyphs can be called
24792 asynchronously). */
24794 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24797 HEAD = TAIL = NULL; \
24798 while (START < END) \
24800 struct glyph *first_glyph = (row)->glyphs[area] + START; \
24801 switch (first_glyph->type) \
24804 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
24808 case COMPOSITE_GLYPH: \
24809 if (first_glyph->u.cmp.automatic) \
24810 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
24813 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
24817 case STRETCH_GLYPH: \
24818 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
24822 case IMAGE_GLYPH: \
24823 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
24827 case GLYPHLESS_GLYPH: \
24828 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
24838 set_glyph_string_background_width (s, START, LAST_X); \
24845 /* Draw glyphs between START and END in AREA of ROW on window W,
24846 starting at x-position X. X is relative to AREA in W. HL is a
24847 face-override with the following meaning:
24849 DRAW_NORMAL_TEXT draw normally
24850 DRAW_CURSOR draw in cursor face
24851 DRAW_MOUSE_FACE draw in mouse face.
24852 DRAW_INVERSE_VIDEO draw in mode line face
24853 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
24854 DRAW_IMAGE_RAISED draw an image with a raised relief around it
24856 If OVERLAPS is non-zero, draw only the foreground of characters and
24857 clip to the physical height of ROW. Non-zero value also defines
24858 the overlapping part to be drawn:
24860 OVERLAPS_PRED overlap with preceding rows
24861 OVERLAPS_SUCC overlap with succeeding rows
24862 OVERLAPS_BOTH overlap with both preceding/succeeding rows
24863 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
24865 Value is the x-position reached, relative to AREA of W. */
24868 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
24869 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
24870 enum draw_glyphs_face hl
, int overlaps
)
24872 struct glyph_string
*head
, *tail
;
24873 struct glyph_string
*s
;
24874 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
24875 int i
, j
, x_reached
, last_x
, area_left
= 0;
24876 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24879 ALLOCATE_HDC (hdc
, f
);
24881 /* Let's rather be paranoid than getting a SEGV. */
24882 end
= min (end
, row
->used
[area
]);
24883 start
= clip_to_bounds (0, start
, end
);
24885 /* Translate X to frame coordinates. Set last_x to the right
24886 end of the drawing area. */
24887 if (row
->full_width_p
)
24889 /* X is relative to the left edge of W, without scroll bars
24891 area_left
= WINDOW_LEFT_EDGE_X (w
);
24892 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
24893 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
24897 area_left
= window_box_left (w
, area
);
24898 last_x
= area_left
+ window_box_width (w
, area
);
24902 /* Build a doubly-linked list of glyph_string structures between
24903 head and tail from what we have to draw. Note that the macro
24904 BUILD_GLYPH_STRINGS will modify its start parameter. That's
24905 the reason we use a separate variable `i'. */
24907 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
24909 x_reached
= tail
->x
+ tail
->background_width
;
24913 /* If there are any glyphs with lbearing < 0 or rbearing > width in
24914 the row, redraw some glyphs in front or following the glyph
24915 strings built above. */
24916 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
24918 struct glyph_string
*h
, *t
;
24919 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24920 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
24921 int check_mouse_face
= 0;
24924 /* If mouse highlighting is on, we may need to draw adjacent
24925 glyphs using mouse-face highlighting. */
24926 if (area
== TEXT_AREA
&& row
->mouse_face_p
24927 && hlinfo
->mouse_face_beg_row
>= 0
24928 && hlinfo
->mouse_face_end_row
>= 0)
24930 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
24932 if (row_vpos
>= hlinfo
->mouse_face_beg_row
24933 && row_vpos
<= hlinfo
->mouse_face_end_row
)
24935 check_mouse_face
= 1;
24936 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
24937 ? hlinfo
->mouse_face_beg_col
: 0;
24938 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
24939 ? hlinfo
->mouse_face_end_col
24940 : row
->used
[TEXT_AREA
];
24944 /* Compute overhangs for all glyph strings. */
24945 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
24946 for (s
= head
; s
; s
= s
->next
)
24947 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
24949 /* Prepend glyph strings for glyphs in front of the first glyph
24950 string that are overwritten because of the first glyph
24951 string's left overhang. The background of all strings
24952 prepended must be drawn because the first glyph string
24954 i
= left_overwritten (head
);
24957 enum draw_glyphs_face overlap_hl
;
24959 /* If this row contains mouse highlighting, attempt to draw
24960 the overlapped glyphs with the correct highlight. This
24961 code fails if the overlap encompasses more than one glyph
24962 and mouse-highlight spans only some of these glyphs.
24963 However, making it work perfectly involves a lot more
24964 code, and I don't know if the pathological case occurs in
24965 practice, so we'll stick to this for now. --- cyd */
24966 if (check_mouse_face
24967 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24968 overlap_hl
= DRAW_MOUSE_FACE
;
24970 overlap_hl
= DRAW_NORMAL_TEXT
;
24972 if (hl
!= overlap_hl
)
24975 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
24976 overlap_hl
, dummy_x
, last_x
);
24978 compute_overhangs_and_x (t
, head
->x
, 1);
24979 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24980 if (clip_head
== NULL
)
24984 /* Prepend glyph strings for glyphs in front of the first glyph
24985 string that overwrite that glyph string because of their
24986 right overhang. For these strings, only the foreground must
24987 be drawn, because it draws over the glyph string at `head'.
24988 The background must not be drawn because this would overwrite
24989 right overhangs of preceding glyphs for which no glyph
24991 i
= left_overwriting (head
);
24994 enum draw_glyphs_face overlap_hl
;
24996 if (check_mouse_face
24997 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24998 overlap_hl
= DRAW_MOUSE_FACE
;
25000 overlap_hl
= DRAW_NORMAL_TEXT
;
25002 if (hl
== overlap_hl
|| clip_head
== NULL
)
25004 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25005 overlap_hl
, dummy_x
, last_x
);
25006 for (s
= h
; s
; s
= s
->next
)
25007 s
->background_filled_p
= 1;
25008 compute_overhangs_and_x (t
, head
->x
, 1);
25009 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25012 /* Append glyphs strings for glyphs following the last glyph
25013 string tail that are overwritten by tail. The background of
25014 these strings has to be drawn because tail's foreground draws
25016 i
= right_overwritten (tail
);
25019 enum draw_glyphs_face overlap_hl
;
25021 if (check_mouse_face
25022 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25023 overlap_hl
= DRAW_MOUSE_FACE
;
25025 overlap_hl
= DRAW_NORMAL_TEXT
;
25027 if (hl
!= overlap_hl
)
25029 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25030 overlap_hl
, x
, last_x
);
25031 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25032 we don't have `end = i;' here. */
25033 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
25034 append_glyph_string_lists (&head
, &tail
, h
, t
);
25035 if (clip_tail
== NULL
)
25039 /* Append glyph strings for glyphs following the last glyph
25040 string tail that overwrite tail. The foreground of such
25041 glyphs has to be drawn because it writes into the background
25042 of tail. The background must not be drawn because it could
25043 paint over the foreground of following glyphs. */
25044 i
= right_overwriting (tail
);
25047 enum draw_glyphs_face overlap_hl
;
25048 if (check_mouse_face
25049 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25050 overlap_hl
= DRAW_MOUSE_FACE
;
25052 overlap_hl
= DRAW_NORMAL_TEXT
;
25054 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25056 i
++; /* We must include the Ith glyph. */
25057 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25058 overlap_hl
, x
, last_x
);
25059 for (s
= h
; s
; s
= s
->next
)
25060 s
->background_filled_p
= 1;
25061 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
25062 append_glyph_string_lists (&head
, &tail
, h
, t
);
25064 if (clip_head
|| clip_tail
)
25065 for (s
= head
; s
; s
= s
->next
)
25067 s
->clip_head
= clip_head
;
25068 s
->clip_tail
= clip_tail
;
25072 /* Draw all strings. */
25073 for (s
= head
; s
; s
= s
->next
)
25074 FRAME_RIF (f
)->draw_glyph_string (s
);
25077 /* When focus a sole frame and move horizontally, this sets on_p to 0
25078 causing a failure to erase prev cursor position. */
25079 if (area
== TEXT_AREA
25080 && !row
->full_width_p
25081 /* When drawing overlapping rows, only the glyph strings'
25082 foreground is drawn, which doesn't erase a cursor
25086 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25087 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25088 : (tail
? tail
->x
+ tail
->background_width
: x
));
25092 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25093 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25097 /* Value is the x-position up to which drawn, relative to AREA of W.
25098 This doesn't include parts drawn because of overhangs. */
25099 if (row
->full_width_p
)
25100 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25102 x_reached
-= area_left
;
25104 RELEASE_HDC (hdc
, f
);
25109 /* Expand row matrix if too narrow. Don't expand if area
25112 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25114 if (!it->f->fonts_changed \
25115 && (it->glyph_row->glyphs[area] \
25116 < it->glyph_row->glyphs[area + 1])) \
25118 it->w->ncols_scale_factor++; \
25119 it->f->fonts_changed = 1; \
25123 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25124 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25127 append_glyph (struct it
*it
)
25129 struct glyph
*glyph
;
25130 enum glyph_row_area area
= it
->area
;
25132 eassert (it
->glyph_row
);
25133 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25135 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25136 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25138 /* If the glyph row is reversed, we need to prepend the glyph
25139 rather than append it. */
25140 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25144 /* Make room for the additional glyph. */
25145 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25147 glyph
= it
->glyph_row
->glyphs
[area
];
25149 glyph
->charpos
= CHARPOS (it
->position
);
25150 glyph
->object
= it
->object
;
25151 if (it
->pixel_width
> 0)
25153 glyph
->pixel_width
= it
->pixel_width
;
25154 glyph
->padding_p
= 0;
25158 /* Assure at least 1-pixel width. Otherwise, cursor can't
25159 be displayed correctly. */
25160 glyph
->pixel_width
= 1;
25161 glyph
->padding_p
= 1;
25163 glyph
->ascent
= it
->ascent
;
25164 glyph
->descent
= it
->descent
;
25165 glyph
->voffset
= it
->voffset
;
25166 glyph
->type
= CHAR_GLYPH
;
25167 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25168 glyph
->multibyte_p
= it
->multibyte_p
;
25169 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25171 /* In R2L rows, the left and the right box edges need to be
25172 drawn in reverse direction. */
25173 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25174 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25178 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25179 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25181 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25182 || it
->phys_descent
> it
->descent
);
25183 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25184 glyph
->face_id
= it
->face_id
;
25185 glyph
->u
.ch
= it
->char_to_display
;
25186 glyph
->slice
.img
= null_glyph_slice
;
25187 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25190 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25191 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25193 glyph
->bidi_type
= it
->bidi_it
.type
;
25197 glyph
->resolved_level
= 0;
25198 glyph
->bidi_type
= UNKNOWN_BT
;
25200 ++it
->glyph_row
->used
[area
];
25203 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25206 /* Store one glyph for the composition IT->cmp_it.id in
25207 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25211 append_composite_glyph (struct it
*it
)
25213 struct glyph
*glyph
;
25214 enum glyph_row_area area
= it
->area
;
25216 eassert (it
->glyph_row
);
25218 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25219 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25221 /* If the glyph row is reversed, we need to prepend the glyph
25222 rather than append it. */
25223 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25227 /* Make room for the new glyph. */
25228 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25230 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25232 glyph
->charpos
= it
->cmp_it
.charpos
;
25233 glyph
->object
= it
->object
;
25234 glyph
->pixel_width
= it
->pixel_width
;
25235 glyph
->ascent
= it
->ascent
;
25236 glyph
->descent
= it
->descent
;
25237 glyph
->voffset
= it
->voffset
;
25238 glyph
->type
= COMPOSITE_GLYPH
;
25239 if (it
->cmp_it
.ch
< 0)
25241 glyph
->u
.cmp
.automatic
= 0;
25242 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25243 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25247 glyph
->u
.cmp
.automatic
= 1;
25248 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25249 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25250 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25252 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25253 glyph
->multibyte_p
= it
->multibyte_p
;
25254 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25256 /* In R2L rows, the left and the right box edges need to be
25257 drawn in reverse direction. */
25258 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25259 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25263 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25264 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25266 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25267 || it
->phys_descent
> it
->descent
);
25268 glyph
->padding_p
= 0;
25269 glyph
->glyph_not_available_p
= 0;
25270 glyph
->face_id
= it
->face_id
;
25271 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25274 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25275 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25277 glyph
->bidi_type
= it
->bidi_it
.type
;
25279 ++it
->glyph_row
->used
[area
];
25282 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25286 /* Change IT->ascent and IT->height according to the setting of
25290 take_vertical_position_into_account (struct it
*it
)
25294 if (it
->voffset
< 0)
25295 /* Increase the ascent so that we can display the text higher
25297 it
->ascent
-= it
->voffset
;
25299 /* Increase the descent so that we can display the text lower
25301 it
->descent
+= it
->voffset
;
25306 /* Produce glyphs/get display metrics for the image IT is loaded with.
25307 See the description of struct display_iterator in dispextern.h for
25308 an overview of struct display_iterator. */
25311 produce_image_glyph (struct it
*it
)
25315 int glyph_ascent
, crop
;
25316 struct glyph_slice slice
;
25318 eassert (it
->what
== IT_IMAGE
);
25320 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25322 /* Make sure X resources of the face is loaded. */
25323 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
25325 if (it
->image_id
< 0)
25327 /* Fringe bitmap. */
25328 it
->ascent
= it
->phys_ascent
= 0;
25329 it
->descent
= it
->phys_descent
= 0;
25330 it
->pixel_width
= 0;
25335 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25337 /* Make sure X resources of the image is loaded. */
25338 prepare_image_for_display (it
->f
, img
);
25340 slice
.x
= slice
.y
= 0;
25341 slice
.width
= img
->width
;
25342 slice
.height
= img
->height
;
25344 if (INTEGERP (it
->slice
.x
))
25345 slice
.x
= XINT (it
->slice
.x
);
25346 else if (FLOATP (it
->slice
.x
))
25347 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25349 if (INTEGERP (it
->slice
.y
))
25350 slice
.y
= XINT (it
->slice
.y
);
25351 else if (FLOATP (it
->slice
.y
))
25352 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25354 if (INTEGERP (it
->slice
.width
))
25355 slice
.width
= XINT (it
->slice
.width
);
25356 else if (FLOATP (it
->slice
.width
))
25357 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25359 if (INTEGERP (it
->slice
.height
))
25360 slice
.height
= XINT (it
->slice
.height
);
25361 else if (FLOATP (it
->slice
.height
))
25362 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25364 if (slice
.x
>= img
->width
)
25365 slice
.x
= img
->width
;
25366 if (slice
.y
>= img
->height
)
25367 slice
.y
= img
->height
;
25368 if (slice
.x
+ slice
.width
>= img
->width
)
25369 slice
.width
= img
->width
- slice
.x
;
25370 if (slice
.y
+ slice
.height
> img
->height
)
25371 slice
.height
= img
->height
- slice
.y
;
25373 if (slice
.width
== 0 || slice
.height
== 0)
25376 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25378 it
->descent
= slice
.height
- glyph_ascent
;
25380 it
->descent
+= img
->vmargin
;
25381 if (slice
.y
+ slice
.height
== img
->height
)
25382 it
->descent
+= img
->vmargin
;
25383 it
->phys_descent
= it
->descent
;
25385 it
->pixel_width
= slice
.width
;
25387 it
->pixel_width
+= img
->hmargin
;
25388 if (slice
.x
+ slice
.width
== img
->width
)
25389 it
->pixel_width
+= img
->hmargin
;
25391 /* It's quite possible for images to have an ascent greater than
25392 their height, so don't get confused in that case. */
25393 if (it
->descent
< 0)
25398 if (face
->box
!= FACE_NO_BOX
)
25400 if (face
->box_line_width
> 0)
25403 it
->ascent
+= face
->box_line_width
;
25404 if (slice
.y
+ slice
.height
== img
->height
)
25405 it
->descent
+= face
->box_line_width
;
25408 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25409 it
->pixel_width
+= eabs (face
->box_line_width
);
25410 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25411 it
->pixel_width
+= eabs (face
->box_line_width
);
25414 take_vertical_position_into_account (it
);
25416 /* Automatically crop wide image glyphs at right edge so we can
25417 draw the cursor on same display row. */
25418 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25419 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25421 it
->pixel_width
-= crop
;
25422 slice
.width
-= crop
;
25427 struct glyph
*glyph
;
25428 enum glyph_row_area area
= it
->area
;
25430 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25431 if (it
->glyph_row
->reversed_p
)
25435 /* Make room for the new glyph. */
25436 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25438 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25440 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25442 glyph
->charpos
= CHARPOS (it
->position
);
25443 glyph
->object
= it
->object
;
25444 glyph
->pixel_width
= it
->pixel_width
;
25445 glyph
->ascent
= glyph_ascent
;
25446 glyph
->descent
= it
->descent
;
25447 glyph
->voffset
= it
->voffset
;
25448 glyph
->type
= IMAGE_GLYPH
;
25449 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25450 glyph
->multibyte_p
= it
->multibyte_p
;
25451 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25453 /* In R2L rows, the left and the right box edges need to be
25454 drawn in reverse direction. */
25455 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25456 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25460 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25461 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25463 glyph
->overlaps_vertically_p
= 0;
25464 glyph
->padding_p
= 0;
25465 glyph
->glyph_not_available_p
= 0;
25466 glyph
->face_id
= it
->face_id
;
25467 glyph
->u
.img_id
= img
->id
;
25468 glyph
->slice
.img
= slice
;
25469 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25472 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25473 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25475 glyph
->bidi_type
= it
->bidi_it
.type
;
25477 ++it
->glyph_row
->used
[area
];
25480 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25485 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25486 of the glyph, WIDTH and HEIGHT are the width and height of the
25487 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25490 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25491 int width
, int height
, int ascent
)
25493 struct glyph
*glyph
;
25494 enum glyph_row_area area
= it
->area
;
25496 eassert (ascent
>= 0 && ascent
<= height
);
25498 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25499 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25501 /* If the glyph row is reversed, we need to prepend the glyph
25502 rather than append it. */
25503 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25507 /* Make room for the additional glyph. */
25508 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25510 glyph
= it
->glyph_row
->glyphs
[area
];
25512 /* Decrease the width of the first glyph of the row that
25513 begins before first_visible_x (e.g., due to hscroll).
25514 This is so the overall width of the row becomes smaller
25515 by the scroll amount, and the stretch glyph appended by
25516 extend_face_to_end_of_line will be wider, to shift the
25517 row glyphs to the right. (In L2R rows, the corresponding
25518 left-shift effect is accomplished by setting row->x to a
25519 negative value, which won't work with R2L rows.)
25521 This must leave us with a positive value of WIDTH, since
25522 otherwise the call to move_it_in_display_line_to at the
25523 beginning of display_line would have got past the entire
25524 first glyph, and then it->current_x would have been
25525 greater or equal to it->first_visible_x. */
25526 if (it
->current_x
< it
->first_visible_x
)
25527 width
-= it
->first_visible_x
- it
->current_x
;
25528 eassert (width
> 0);
25530 glyph
->charpos
= CHARPOS (it
->position
);
25531 glyph
->object
= object
;
25532 glyph
->pixel_width
= width
;
25533 glyph
->ascent
= ascent
;
25534 glyph
->descent
= height
- ascent
;
25535 glyph
->voffset
= it
->voffset
;
25536 glyph
->type
= STRETCH_GLYPH
;
25537 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25538 glyph
->multibyte_p
= it
->multibyte_p
;
25539 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25541 /* In R2L rows, the left and the right box edges need to be
25542 drawn in reverse direction. */
25543 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25544 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25548 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25549 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25551 glyph
->overlaps_vertically_p
= 0;
25552 glyph
->padding_p
= 0;
25553 glyph
->glyph_not_available_p
= 0;
25554 glyph
->face_id
= it
->face_id
;
25555 glyph
->u
.stretch
.ascent
= ascent
;
25556 glyph
->u
.stretch
.height
= height
;
25557 glyph
->slice
.img
= null_glyph_slice
;
25558 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25561 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25562 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25564 glyph
->bidi_type
= it
->bidi_it
.type
;
25568 glyph
->resolved_level
= 0;
25569 glyph
->bidi_type
= UNKNOWN_BT
;
25571 ++it
->glyph_row
->used
[area
];
25574 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25577 #endif /* HAVE_WINDOW_SYSTEM */
25579 /* Produce a stretch glyph for iterator IT. IT->object is the value
25580 of the glyph property displayed. The value must be a list
25581 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25584 1. `:width WIDTH' specifies that the space should be WIDTH *
25585 canonical char width wide. WIDTH may be an integer or floating
25588 2. `:relative-width FACTOR' specifies that the width of the stretch
25589 should be computed from the width of the first character having the
25590 `glyph' property, and should be FACTOR times that width.
25592 3. `:align-to HPOS' specifies that the space should be wide enough
25593 to reach HPOS, a value in canonical character units.
25595 Exactly one of the above pairs must be present.
25597 4. `:height HEIGHT' specifies that the height of the stretch produced
25598 should be HEIGHT, measured in canonical character units.
25600 5. `:relative-height FACTOR' specifies that the height of the
25601 stretch should be FACTOR times the height of the characters having
25602 the glyph property.
25604 Either none or exactly one of 4 or 5 must be present.
25606 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25607 of the stretch should be used for the ascent of the stretch.
25608 ASCENT must be in the range 0 <= ASCENT <= 100. */
25611 produce_stretch_glyph (struct it
*it
)
25613 /* (space :width WIDTH :height HEIGHT ...) */
25614 Lisp_Object prop
, plist
;
25615 int width
= 0, height
= 0, align_to
= -1;
25616 int zero_width_ok_p
= 0;
25618 struct font
*font
= NULL
;
25620 #ifdef HAVE_WINDOW_SYSTEM
25622 int zero_height_ok_p
= 0;
25624 if (FRAME_WINDOW_P (it
->f
))
25626 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25627 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25628 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
25632 /* List should start with `space'. */
25633 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
25634 plist
= XCDR (it
->object
);
25636 /* Compute the width of the stretch. */
25637 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
25638 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
25640 /* Absolute width `:width WIDTH' specified and valid. */
25641 zero_width_ok_p
= 1;
25644 #ifdef HAVE_WINDOW_SYSTEM
25645 else if (FRAME_WINDOW_P (it
->f
)
25646 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
25648 /* Relative width `:relative-width FACTOR' specified and valid.
25649 Compute the width of the characters having the `glyph'
25652 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
25655 if (it
->multibyte_p
)
25656 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
25659 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
25660 if (! ASCII_CHAR_P (it2
.c
))
25661 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
25664 it2
.glyph_row
= NULL
;
25665 it2
.what
= IT_CHARACTER
;
25666 x_produce_glyphs (&it2
);
25667 width
= NUMVAL (prop
) * it2
.pixel_width
;
25669 #endif /* HAVE_WINDOW_SYSTEM */
25670 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
25671 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
25673 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
25674 align_to
= (align_to
< 0
25676 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
25677 else if (align_to
< 0)
25678 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
25679 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
25680 zero_width_ok_p
= 1;
25683 /* Nothing specified -> width defaults to canonical char width. */
25684 width
= FRAME_COLUMN_WIDTH (it
->f
);
25686 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
25689 #ifdef HAVE_WINDOW_SYSTEM
25690 /* Compute height. */
25691 if (FRAME_WINDOW_P (it
->f
))
25693 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
25694 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25697 zero_height_ok_p
= 1;
25699 else if (prop
= Fplist_get (plist
, QCrelative_height
),
25701 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
25703 height
= FONT_HEIGHT (font
);
25705 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
25708 /* Compute percentage of height used for ascent. If
25709 `:ascent ASCENT' is present and valid, use that. Otherwise,
25710 derive the ascent from the font in use. */
25711 if (prop
= Fplist_get (plist
, QCascent
),
25712 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
25713 ascent
= height
* NUMVAL (prop
) / 100.0;
25714 else if (!NILP (prop
)
25715 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25716 ascent
= min (max (0, (int)tem
), height
);
25718 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
25721 #endif /* HAVE_WINDOW_SYSTEM */
25724 if (width
> 0 && it
->line_wrap
!= TRUNCATE
25725 && it
->current_x
+ width
> it
->last_visible_x
)
25727 width
= it
->last_visible_x
- it
->current_x
;
25728 #ifdef HAVE_WINDOW_SYSTEM
25729 /* Subtract one more pixel from the stretch width, but only on
25730 GUI frames, since on a TTY each glyph is one "pixel" wide. */
25731 width
-= FRAME_WINDOW_P (it
->f
);
25735 if (width
> 0 && height
> 0 && it
->glyph_row
)
25737 Lisp_Object o_object
= it
->object
;
25738 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
25741 if (!STRINGP (object
))
25742 object
= it
->w
->contents
;
25743 #ifdef HAVE_WINDOW_SYSTEM
25744 if (FRAME_WINDOW_P (it
->f
))
25745 append_stretch_glyph (it
, object
, width
, height
, ascent
);
25749 it
->object
= object
;
25750 it
->char_to_display
= ' ';
25751 it
->pixel_width
= it
->len
= 1;
25753 tty_append_glyph (it
);
25754 it
->object
= o_object
;
25758 it
->pixel_width
= width
;
25759 #ifdef HAVE_WINDOW_SYSTEM
25760 if (FRAME_WINDOW_P (it
->f
))
25762 it
->ascent
= it
->phys_ascent
= ascent
;
25763 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
25764 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
25765 take_vertical_position_into_account (it
);
25769 it
->nglyphs
= width
;
25772 /* Get information about special display element WHAT in an
25773 environment described by IT. WHAT is one of IT_TRUNCATION or
25774 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
25775 non-null glyph_row member. This function ensures that fields like
25776 face_id, c, len of IT are left untouched. */
25779 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
25786 temp_it
.object
= make_number (0);
25787 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
25789 if (what
== IT_CONTINUATION
)
25791 /* Continuation glyph. For R2L lines, we mirror it by hand. */
25792 if (it
->bidi_it
.paragraph_dir
== R2L
)
25793 SET_GLYPH_FROM_CHAR (glyph
, '/');
25795 SET_GLYPH_FROM_CHAR (glyph
, '\\');
25797 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25799 /* FIXME: Should we mirror GC for R2L lines? */
25800 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25801 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25804 else if (what
== IT_TRUNCATION
)
25806 /* Truncation glyph. */
25807 SET_GLYPH_FROM_CHAR (glyph
, '$');
25809 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25811 /* FIXME: Should we mirror GC for R2L lines? */
25812 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25813 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25819 #ifdef HAVE_WINDOW_SYSTEM
25820 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
25821 is turned off, we precede the truncation/continuation glyphs by a
25822 stretch glyph whose width is computed such that these special
25823 glyphs are aligned at the window margin, even when very different
25824 fonts are used in different glyph rows. */
25825 if (FRAME_WINDOW_P (temp_it
.f
)
25826 /* init_iterator calls this with it->glyph_row == NULL, and it
25827 wants only the pixel width of the truncation/continuation
25829 && temp_it
.glyph_row
25830 /* insert_left_trunc_glyphs calls us at the beginning of the
25831 row, and it has its own calculation of the stretch glyph
25833 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
25834 && (temp_it
.glyph_row
->reversed_p
25835 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
25836 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
25838 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
25840 if (stretch_width
> 0)
25842 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
25843 struct font
*font
=
25844 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
25845 int stretch_ascent
=
25846 (((temp_it
.ascent
+ temp_it
.descent
)
25847 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
25849 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
25850 temp_it
.ascent
+ temp_it
.descent
,
25857 temp_it
.what
= IT_CHARACTER
;
25858 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
25859 temp_it
.face_id
= GLYPH_FACE (glyph
);
25860 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
25862 PRODUCE_GLYPHS (&temp_it
);
25863 it
->pixel_width
= temp_it
.pixel_width
;
25864 it
->nglyphs
= temp_it
.nglyphs
;
25867 #ifdef HAVE_WINDOW_SYSTEM
25869 /* Calculate line-height and line-spacing properties.
25870 An integer value specifies explicit pixel value.
25871 A float value specifies relative value to current face height.
25872 A cons (float . face-name) specifies relative value to
25873 height of specified face font.
25875 Returns height in pixels, or nil. */
25879 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
25880 int boff
, int override
)
25882 Lisp_Object face_name
= Qnil
;
25883 int ascent
, descent
, height
;
25885 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
25890 face_name
= XCAR (val
);
25892 if (!NUMBERP (val
))
25893 val
= make_number (1);
25894 if (NILP (face_name
))
25896 height
= it
->ascent
+ it
->descent
;
25901 if (NILP (face_name
))
25903 font
= FRAME_FONT (it
->f
);
25904 boff
= FRAME_BASELINE_OFFSET (it
->f
);
25906 else if (EQ (face_name
, Qt
))
25915 face_id
= lookup_named_face (it
->f
, face_name
, 0);
25917 return make_number (-1);
25919 face
= FACE_FROM_ID (it
->f
, face_id
);
25922 return make_number (-1);
25923 boff
= font
->baseline_offset
;
25924 if (font
->vertical_centering
)
25925 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25928 ascent
= FONT_BASE (font
) + boff
;
25929 descent
= FONT_DESCENT (font
) - boff
;
25933 it
->override_ascent
= ascent
;
25934 it
->override_descent
= descent
;
25935 it
->override_boff
= boff
;
25938 height
= ascent
+ descent
;
25942 height
= (int)(XFLOAT_DATA (val
) * height
);
25943 else if (INTEGERP (val
))
25944 height
*= XINT (val
);
25946 return make_number (height
);
25950 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
25951 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
25952 and only if this is for a character for which no font was found.
25954 If the display method (it->glyphless_method) is
25955 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
25956 length of the acronym or the hexadecimal string, UPPER_XOFF and
25957 UPPER_YOFF are pixel offsets for the upper part of the string,
25958 LOWER_XOFF and LOWER_YOFF are for the lower part.
25960 For the other display methods, LEN through LOWER_YOFF are zero. */
25963 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
25964 short upper_xoff
, short upper_yoff
,
25965 short lower_xoff
, short lower_yoff
)
25967 struct glyph
*glyph
;
25968 enum glyph_row_area area
= it
->area
;
25970 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25971 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25973 /* If the glyph row is reversed, we need to prepend the glyph
25974 rather than append it. */
25975 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25979 /* Make room for the additional glyph. */
25980 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25982 glyph
= it
->glyph_row
->glyphs
[area
];
25984 glyph
->charpos
= CHARPOS (it
->position
);
25985 glyph
->object
= it
->object
;
25986 glyph
->pixel_width
= it
->pixel_width
;
25987 glyph
->ascent
= it
->ascent
;
25988 glyph
->descent
= it
->descent
;
25989 glyph
->voffset
= it
->voffset
;
25990 glyph
->type
= GLYPHLESS_GLYPH
;
25991 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
25992 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
25993 glyph
->u
.glyphless
.len
= len
;
25994 glyph
->u
.glyphless
.ch
= it
->c
;
25995 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
25996 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
25997 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
25998 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
25999 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26000 glyph
->multibyte_p
= it
->multibyte_p
;
26001 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26003 /* In R2L rows, the left and the right box edges need to be
26004 drawn in reverse direction. */
26005 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26006 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26010 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26011 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26013 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26014 || it
->phys_descent
> it
->descent
);
26015 glyph
->padding_p
= 0;
26016 glyph
->glyph_not_available_p
= 0;
26017 glyph
->face_id
= face_id
;
26018 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26021 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26022 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
26024 glyph
->bidi_type
= it
->bidi_it
.type
;
26026 ++it
->glyph_row
->used
[area
];
26029 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26033 /* Produce a glyph for a glyphless character for iterator IT.
26034 IT->glyphless_method specifies which method to use for displaying
26035 the character. See the description of enum
26036 glyphless_display_method in dispextern.h for the detail.
26038 FOR_NO_FONT is nonzero if and only if this is for a character for
26039 which no font was found. ACRONYM, if non-nil, is an acronym string
26040 for the character. */
26043 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
26048 int base_width
, base_height
, width
, height
;
26049 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26052 /* Get the metrics of the base font. We always refer to the current
26054 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26055 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26056 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
26057 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
26058 base_height
= it
->ascent
+ it
->descent
;
26059 base_width
= font
->average_width
;
26061 face_id
= merge_glyphless_glyph_face (it
);
26063 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26065 it
->pixel_width
= THIN_SPACE_WIDTH
;
26067 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26069 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26071 width
= CHAR_WIDTH (it
->c
);
26074 else if (width
> 4)
26076 it
->pixel_width
= base_width
* width
;
26078 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26084 unsigned int code
[6];
26086 int ascent
, descent
;
26087 struct font_metrics metrics_upper
, metrics_lower
;
26089 face
= FACE_FROM_ID (it
->f
, face_id
);
26090 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26091 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
26093 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26095 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26096 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26097 if (CONSP (acronym
))
26098 acronym
= XCAR (acronym
);
26099 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26103 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26104 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
26107 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
26108 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26109 upper_len
= (len
+ 1) / 2;
26110 font
->driver
->text_extents (font
, code
, upper_len
,
26112 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26117 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26118 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26119 upper_xoff
= upper_yoff
= 2; /* the typical case */
26120 if (base_width
>= width
)
26122 /* Align the upper to the left, the lower to the right. */
26123 it
->pixel_width
= base_width
;
26124 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26128 /* Center the shorter one. */
26129 it
->pixel_width
= width
;
26130 if (metrics_upper
.width
>= metrics_lower
.width
)
26131 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26134 /* FIXME: This code doesn't look right. It formerly was
26135 missing the "lower_xoff = 0;", which couldn't have
26136 been right since it left lower_xoff uninitialized. */
26138 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26142 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26143 top, bottom, and between upper and lower strings. */
26144 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26145 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26146 /* Center vertically.
26147 H:base_height, D:base_descent
26148 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26150 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26151 descent = D - H/2 + h/2;
26152 lower_yoff = descent - 2 - ld;
26153 upper_yoff = lower_yoff - la - 1 - ud; */
26154 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26155 descent
= it
->descent
- (base_height
- height
) / 2;
26156 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26157 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26158 - metrics_upper
.descent
);
26159 /* Don't make the height shorter than the base height. */
26160 if (height
> base_height
)
26162 it
->ascent
= ascent
;
26163 it
->descent
= descent
;
26167 it
->phys_ascent
= it
->ascent
;
26168 it
->phys_descent
= it
->descent
;
26170 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26171 upper_xoff
, upper_yoff
,
26172 lower_xoff
, lower_yoff
);
26174 take_vertical_position_into_account (it
);
26179 Produce glyphs/get display metrics for the display element IT is
26180 loaded with. See the description of struct it in dispextern.h
26181 for an overview of struct it. */
26184 x_produce_glyphs (struct it
*it
)
26186 int extra_line_spacing
= it
->extra_line_spacing
;
26188 it
->glyph_not_available_p
= 0;
26190 if (it
->what
== IT_CHARACTER
)
26193 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26194 struct font
*font
= face
->font
;
26195 struct font_metrics
*pcm
= NULL
;
26196 int boff
; /* Baseline offset. */
26200 /* When no suitable font is found, display this character by
26201 the method specified in the first extra slot of
26202 Vglyphless_char_display. */
26203 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26205 eassert (it
->what
== IT_GLYPHLESS
);
26206 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
26210 boff
= font
->baseline_offset
;
26211 if (font
->vertical_centering
)
26212 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26214 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26220 if (it
->override_ascent
>= 0)
26222 it
->ascent
= it
->override_ascent
;
26223 it
->descent
= it
->override_descent
;
26224 boff
= it
->override_boff
;
26228 it
->ascent
= FONT_BASE (font
) + boff
;
26229 it
->descent
= FONT_DESCENT (font
) - boff
;
26232 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26234 pcm
= get_per_char_metric (font
, &char2b
);
26235 if (pcm
->width
== 0
26236 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26242 it
->phys_ascent
= pcm
->ascent
+ boff
;
26243 it
->phys_descent
= pcm
->descent
- boff
;
26244 it
->pixel_width
= pcm
->width
;
26248 it
->glyph_not_available_p
= 1;
26249 it
->phys_ascent
= it
->ascent
;
26250 it
->phys_descent
= it
->descent
;
26251 it
->pixel_width
= font
->space_width
;
26254 if (it
->constrain_row_ascent_descent_p
)
26256 if (it
->descent
> it
->max_descent
)
26258 it
->ascent
+= it
->descent
- it
->max_descent
;
26259 it
->descent
= it
->max_descent
;
26261 if (it
->ascent
> it
->max_ascent
)
26263 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26264 it
->ascent
= it
->max_ascent
;
26266 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26267 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26268 extra_line_spacing
= 0;
26271 /* If this is a space inside a region of text with
26272 `space-width' property, change its width. */
26273 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26275 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26277 /* If face has a box, add the box thickness to the character
26278 height. If character has a box line to the left and/or
26279 right, add the box line width to the character's width. */
26280 if (face
->box
!= FACE_NO_BOX
)
26282 int thick
= face
->box_line_width
;
26286 it
->ascent
+= thick
;
26287 it
->descent
+= thick
;
26292 if (it
->start_of_box_run_p
)
26293 it
->pixel_width
+= thick
;
26294 if (it
->end_of_box_run_p
)
26295 it
->pixel_width
+= thick
;
26298 /* If face has an overline, add the height of the overline
26299 (1 pixel) and a 1 pixel margin to the character height. */
26300 if (face
->overline_p
)
26301 it
->ascent
+= overline_margin
;
26303 if (it
->constrain_row_ascent_descent_p
)
26305 if (it
->ascent
> it
->max_ascent
)
26306 it
->ascent
= it
->max_ascent
;
26307 if (it
->descent
> it
->max_descent
)
26308 it
->descent
= it
->max_descent
;
26311 take_vertical_position_into_account (it
);
26313 /* If we have to actually produce glyphs, do it. */
26318 /* Translate a space with a `space-width' property
26319 into a stretch glyph. */
26320 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26321 / FONT_HEIGHT (font
));
26322 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26323 it
->ascent
+ it
->descent
, ascent
);
26328 /* If characters with lbearing or rbearing are displayed
26329 in this line, record that fact in a flag of the
26330 glyph row. This is used to optimize X output code. */
26331 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26332 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26334 if (! stretched_p
&& it
->pixel_width
== 0)
26335 /* We assure that all visible glyphs have at least 1-pixel
26337 it
->pixel_width
= 1;
26339 else if (it
->char_to_display
== '\n')
26341 /* A newline has no width, but we need the height of the
26342 line. But if previous part of the line sets a height,
26343 don't increase that height. */
26345 Lisp_Object height
;
26346 Lisp_Object total_height
= Qnil
;
26348 it
->override_ascent
= -1;
26349 it
->pixel_width
= 0;
26352 height
= get_it_property (it
, Qline_height
);
26353 /* Split (line-height total-height) list. */
26355 && CONSP (XCDR (height
))
26356 && NILP (XCDR (XCDR (height
))))
26358 total_height
= XCAR (XCDR (height
));
26359 height
= XCAR (height
);
26361 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
26363 if (it
->override_ascent
>= 0)
26365 it
->ascent
= it
->override_ascent
;
26366 it
->descent
= it
->override_descent
;
26367 boff
= it
->override_boff
;
26371 it
->ascent
= FONT_BASE (font
) + boff
;
26372 it
->descent
= FONT_DESCENT (font
) - boff
;
26375 if (EQ (height
, Qt
))
26377 if (it
->descent
> it
->max_descent
)
26379 it
->ascent
+= it
->descent
- it
->max_descent
;
26380 it
->descent
= it
->max_descent
;
26382 if (it
->ascent
> it
->max_ascent
)
26384 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26385 it
->ascent
= it
->max_ascent
;
26387 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26388 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26389 it
->constrain_row_ascent_descent_p
= 1;
26390 extra_line_spacing
= 0;
26394 Lisp_Object spacing
;
26396 it
->phys_ascent
= it
->ascent
;
26397 it
->phys_descent
= it
->descent
;
26399 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26400 && face
->box
!= FACE_NO_BOX
26401 && face
->box_line_width
> 0)
26403 it
->ascent
+= face
->box_line_width
;
26404 it
->descent
+= face
->box_line_width
;
26407 && XINT (height
) > it
->ascent
+ it
->descent
)
26408 it
->ascent
= XINT (height
) - it
->descent
;
26410 if (!NILP (total_height
))
26411 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
26414 spacing
= get_it_property (it
, Qline_spacing
);
26415 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
26417 if (INTEGERP (spacing
))
26419 extra_line_spacing
= XINT (spacing
);
26420 if (!NILP (total_height
))
26421 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26425 else /* i.e. (it->char_to_display == '\t') */
26427 if (font
->space_width
> 0)
26429 int tab_width
= it
->tab_width
* font
->space_width
;
26430 int x
= it
->current_x
+ it
->continuation_lines_width
;
26431 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26433 /* If the distance from the current position to the next tab
26434 stop is less than a space character width, use the
26435 tab stop after that. */
26436 if (next_tab_x
- x
< font
->space_width
)
26437 next_tab_x
+= tab_width
;
26439 it
->pixel_width
= next_tab_x
- x
;
26441 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
26442 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
26446 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26447 it
->ascent
+ it
->descent
, it
->ascent
);
26452 it
->pixel_width
= 0;
26457 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26459 /* A static composition.
26461 Note: A composition is represented as one glyph in the
26462 glyph matrix. There are no padding glyphs.
26464 Important note: pixel_width, ascent, and descent are the
26465 values of what is drawn by draw_glyphs (i.e. the values of
26466 the overall glyphs composed). */
26467 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26468 int boff
; /* baseline offset */
26469 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26470 int glyph_len
= cmp
->glyph_len
;
26471 struct font
*font
= face
->font
;
26475 /* If we have not yet calculated pixel size data of glyphs of
26476 the composition for the current face font, calculate them
26477 now. Theoretically, we have to check all fonts for the
26478 glyphs, but that requires much time and memory space. So,
26479 here we check only the font of the first glyph. This may
26480 lead to incorrect display, but it's very rare, and C-l
26481 (recenter-top-bottom) can correct the display anyway. */
26482 if (! cmp
->font
|| cmp
->font
!= font
)
26484 /* Ascent and descent of the font of the first character
26485 of this composition (adjusted by baseline offset).
26486 Ascent and descent of overall glyphs should not be less
26487 than these, respectively. */
26488 int font_ascent
, font_descent
, font_height
;
26489 /* Bounding box of the overall glyphs. */
26490 int leftmost
, rightmost
, lowest
, highest
;
26491 int lbearing
, rbearing
;
26492 int i
, width
, ascent
, descent
;
26493 int left_padded
= 0, right_padded
= 0;
26494 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26496 struct font_metrics
*pcm
;
26497 int font_not_found_p
;
26500 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26501 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26503 if (glyph_len
< cmp
->glyph_len
)
26505 for (i
= 0; i
< glyph_len
; i
++)
26507 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26509 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26514 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26515 : IT_CHARPOS (*it
));
26516 /* If no suitable font is found, use the default font. */
26517 font_not_found_p
= font
== NULL
;
26518 if (font_not_found_p
)
26520 face
= face
->ascii_face
;
26523 boff
= font
->baseline_offset
;
26524 if (font
->vertical_centering
)
26525 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26526 font_ascent
= FONT_BASE (font
) + boff
;
26527 font_descent
= FONT_DESCENT (font
) - boff
;
26528 font_height
= FONT_HEIGHT (font
);
26533 if (! font_not_found_p
)
26535 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26537 pcm
= get_per_char_metric (font
, &char2b
);
26540 /* Initialize the bounding box. */
26543 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26544 ascent
= pcm
->ascent
;
26545 descent
= pcm
->descent
;
26546 lbearing
= pcm
->lbearing
;
26547 rbearing
= pcm
->rbearing
;
26551 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26552 ascent
= FONT_BASE (font
);
26553 descent
= FONT_DESCENT (font
);
26560 lowest
= - descent
+ boff
;
26561 highest
= ascent
+ boff
;
26563 if (! font_not_found_p
26564 && font
->default_ascent
26565 && CHAR_TABLE_P (Vuse_default_ascent
)
26566 && !NILP (Faref (Vuse_default_ascent
,
26567 make_number (it
->char_to_display
))))
26568 highest
= font
->default_ascent
+ boff
;
26570 /* Draw the first glyph at the normal position. It may be
26571 shifted to right later if some other glyphs are drawn
26573 cmp
->offsets
[i
* 2] = 0;
26574 cmp
->offsets
[i
* 2 + 1] = boff
;
26575 cmp
->lbearing
= lbearing
;
26576 cmp
->rbearing
= rbearing
;
26578 /* Set cmp->offsets for the remaining glyphs. */
26579 for (i
++; i
< glyph_len
; i
++)
26581 int left
, right
, btm
, top
;
26582 int ch
= COMPOSITION_GLYPH (cmp
, i
);
26584 struct face
*this_face
;
26588 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
26589 this_face
= FACE_FROM_ID (it
->f
, face_id
);
26590 font
= this_face
->font
;
26596 get_char_face_and_encoding (it
->f
, ch
, face_id
,
26598 pcm
= get_per_char_metric (font
, &char2b
);
26601 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26604 width
= pcm
->width
;
26605 ascent
= pcm
->ascent
;
26606 descent
= pcm
->descent
;
26607 lbearing
= pcm
->lbearing
;
26608 rbearing
= pcm
->rbearing
;
26609 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
26611 /* Relative composition with or without
26612 alternate chars. */
26613 left
= (leftmost
+ rightmost
- width
) / 2;
26614 btm
= - descent
+ boff
;
26615 if (font
->relative_compose
26616 && (! CHAR_TABLE_P (Vignore_relative_composition
)
26617 || NILP (Faref (Vignore_relative_composition
,
26618 make_number (ch
)))))
26621 if (- descent
>= font
->relative_compose
)
26622 /* One extra pixel between two glyphs. */
26624 else if (ascent
<= 0)
26625 /* One extra pixel between two glyphs. */
26626 btm
= lowest
- 1 - ascent
- descent
;
26631 /* A composition rule is specified by an integer
26632 value that encodes global and new reference
26633 points (GREF and NREF). GREF and NREF are
26634 specified by numbers as below:
26636 0---1---2 -- ascent
26640 9--10--11 -- center
26642 ---3---4---5--- baseline
26644 6---7---8 -- descent
26646 int rule
= COMPOSITION_RULE (cmp
, i
);
26647 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
26649 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
26650 grefx
= gref
% 3, nrefx
= nref
% 3;
26651 grefy
= gref
/ 3, nrefy
= nref
/ 3;
26653 xoff
= font_height
* (xoff
- 128) / 256;
26655 yoff
= font_height
* (yoff
- 128) / 256;
26658 + grefx
* (rightmost
- leftmost
) / 2
26659 - nrefx
* width
/ 2
26662 btm
= ((grefy
== 0 ? highest
26664 : grefy
== 2 ? lowest
26665 : (highest
+ lowest
) / 2)
26666 - (nrefy
== 0 ? ascent
+ descent
26667 : nrefy
== 1 ? descent
- boff
26669 : (ascent
+ descent
) / 2)
26673 cmp
->offsets
[i
* 2] = left
;
26674 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
26676 /* Update the bounding box of the overall glyphs. */
26679 right
= left
+ width
;
26680 if (left
< leftmost
)
26682 if (right
> rightmost
)
26685 top
= btm
+ descent
+ ascent
;
26691 if (cmp
->lbearing
> left
+ lbearing
)
26692 cmp
->lbearing
= left
+ lbearing
;
26693 if (cmp
->rbearing
< left
+ rbearing
)
26694 cmp
->rbearing
= left
+ rbearing
;
26698 /* If there are glyphs whose x-offsets are negative,
26699 shift all glyphs to the right and make all x-offsets
26703 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26704 cmp
->offsets
[i
* 2] -= leftmost
;
26705 rightmost
-= leftmost
;
26706 cmp
->lbearing
-= leftmost
;
26707 cmp
->rbearing
-= leftmost
;
26710 if (left_padded
&& cmp
->lbearing
< 0)
26712 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26713 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
26714 rightmost
-= cmp
->lbearing
;
26715 cmp
->rbearing
-= cmp
->lbearing
;
26718 if (right_padded
&& rightmost
< cmp
->rbearing
)
26720 rightmost
= cmp
->rbearing
;
26723 cmp
->pixel_width
= rightmost
;
26724 cmp
->ascent
= highest
;
26725 cmp
->descent
= - lowest
;
26726 if (cmp
->ascent
< font_ascent
)
26727 cmp
->ascent
= font_ascent
;
26728 if (cmp
->descent
< font_descent
)
26729 cmp
->descent
= font_descent
;
26733 && (cmp
->lbearing
< 0
26734 || cmp
->rbearing
> cmp
->pixel_width
))
26735 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26737 it
->pixel_width
= cmp
->pixel_width
;
26738 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
26739 it
->descent
= it
->phys_descent
= cmp
->descent
;
26740 if (face
->box
!= FACE_NO_BOX
)
26742 int thick
= face
->box_line_width
;
26746 it
->ascent
+= thick
;
26747 it
->descent
+= thick
;
26752 if (it
->start_of_box_run_p
)
26753 it
->pixel_width
+= thick
;
26754 if (it
->end_of_box_run_p
)
26755 it
->pixel_width
+= thick
;
26758 /* If face has an overline, add the height of the overline
26759 (1 pixel) and a 1 pixel margin to the character height. */
26760 if (face
->overline_p
)
26761 it
->ascent
+= overline_margin
;
26763 take_vertical_position_into_account (it
);
26764 if (it
->ascent
< 0)
26766 if (it
->descent
< 0)
26769 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
26770 append_composite_glyph (it
);
26772 else if (it
->what
== IT_COMPOSITION
)
26774 /* A dynamic (automatic) composition. */
26775 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26776 Lisp_Object gstring
;
26777 struct font_metrics metrics
;
26781 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
26783 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
26786 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
26787 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26788 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
26789 it
->descent
= it
->phys_descent
= metrics
.descent
;
26790 if (face
->box
!= FACE_NO_BOX
)
26792 int thick
= face
->box_line_width
;
26796 it
->ascent
+= thick
;
26797 it
->descent
+= thick
;
26802 if (it
->start_of_box_run_p
)
26803 it
->pixel_width
+= thick
;
26804 if (it
->end_of_box_run_p
)
26805 it
->pixel_width
+= thick
;
26807 /* If face has an overline, add the height of the overline
26808 (1 pixel) and a 1 pixel margin to the character height. */
26809 if (face
->overline_p
)
26810 it
->ascent
+= overline_margin
;
26811 take_vertical_position_into_account (it
);
26812 if (it
->ascent
< 0)
26814 if (it
->descent
< 0)
26818 append_composite_glyph (it
);
26820 else if (it
->what
== IT_GLYPHLESS
)
26821 produce_glyphless_glyph (it
, 0, Qnil
);
26822 else if (it
->what
== IT_IMAGE
)
26823 produce_image_glyph (it
);
26824 else if (it
->what
== IT_STRETCH
)
26825 produce_stretch_glyph (it
);
26828 /* Accumulate dimensions. Note: can't assume that it->descent > 0
26829 because this isn't true for images with `:ascent 100'. */
26830 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
26831 if (it
->area
== TEXT_AREA
)
26832 it
->current_x
+= it
->pixel_width
;
26834 if (extra_line_spacing
> 0)
26836 it
->descent
+= extra_line_spacing
;
26837 if (extra_line_spacing
> it
->max_extra_line_spacing
)
26838 it
->max_extra_line_spacing
= extra_line_spacing
;
26841 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
26842 it
->max_descent
= max (it
->max_descent
, it
->descent
);
26843 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
26844 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
26848 Output LEN glyphs starting at START at the nominal cursor position.
26849 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
26850 being updated, and UPDATED_AREA is the area of that row being updated. */
26853 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26854 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26856 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
26858 eassert (updated_row
);
26859 /* When the window is hscrolled, cursor hpos can legitimately be out
26860 of bounds, but we draw the cursor at the corresponding window
26861 margin in that case. */
26862 if (!updated_row
->reversed_p
&& chpos
< 0)
26864 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
26865 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
26869 /* Write glyphs. */
26871 hpos
= start
- updated_row
->glyphs
[updated_area
];
26872 x
= draw_glyphs (w
, w
->output_cursor
.x
,
26873 updated_row
, updated_area
,
26875 DRAW_NORMAL_TEXT
, 0);
26877 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
26878 if (updated_area
== TEXT_AREA
26879 && w
->phys_cursor_on_p
26880 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
26882 && chpos
< hpos
+ len
)
26883 w
->phys_cursor_on_p
= 0;
26887 /* Advance the output cursor. */
26888 w
->output_cursor
.hpos
+= len
;
26889 w
->output_cursor
.x
= x
;
26894 Insert LEN glyphs from START at the nominal cursor position. */
26897 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26898 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26901 int line_height
, shift_by_width
, shifted_region_width
;
26902 struct glyph_row
*row
;
26903 struct glyph
*glyph
;
26904 int frame_x
, frame_y
;
26907 eassert (updated_row
);
26909 f
= XFRAME (WINDOW_FRAME (w
));
26911 /* Get the height of the line we are in. */
26913 line_height
= row
->height
;
26915 /* Get the width of the glyphs to insert. */
26916 shift_by_width
= 0;
26917 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
26918 shift_by_width
+= glyph
->pixel_width
;
26920 /* Get the width of the region to shift right. */
26921 shifted_region_width
= (window_box_width (w
, updated_area
)
26922 - w
->output_cursor
.x
26926 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
26927 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
26929 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
26930 line_height
, shift_by_width
);
26932 /* Write the glyphs. */
26933 hpos
= start
- row
->glyphs
[updated_area
];
26934 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
26936 DRAW_NORMAL_TEXT
, 0);
26938 /* Advance the output cursor. */
26939 w
->output_cursor
.hpos
+= len
;
26940 w
->output_cursor
.x
+= shift_by_width
;
26946 Erase the current text line from the nominal cursor position
26947 (inclusive) to pixel column TO_X (exclusive). The idea is that
26948 everything from TO_X onward is already erased.
26950 TO_X is a pixel position relative to UPDATED_AREA of currently
26951 updated window W. TO_X == -1 means clear to the end of this area. */
26954 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
26955 enum glyph_row_area updated_area
, int to_x
)
26958 int max_x
, min_y
, max_y
;
26959 int from_x
, from_y
, to_y
;
26961 eassert (updated_row
);
26962 f
= XFRAME (w
->frame
);
26964 if (updated_row
->full_width_p
)
26965 max_x
= (WINDOW_PIXEL_WIDTH (w
)
26966 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
26968 max_x
= window_box_width (w
, updated_area
);
26969 max_y
= window_text_bottom_y (w
);
26971 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
26972 of window. For TO_X > 0, truncate to end of drawing area. */
26978 to_x
= min (to_x
, max_x
);
26980 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
26982 /* Notice if the cursor will be cleared by this operation. */
26983 if (!updated_row
->full_width_p
)
26984 notice_overwritten_cursor (w
, updated_area
,
26985 w
->output_cursor
.x
, -1,
26987 MATRIX_ROW_BOTTOM_Y (updated_row
));
26989 from_x
= w
->output_cursor
.x
;
26991 /* Translate to frame coordinates. */
26992 if (updated_row
->full_width_p
)
26994 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
26995 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
26999 int area_left
= window_box_left (w
, updated_area
);
27000 from_x
+= area_left
;
27004 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27005 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27006 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27008 /* Prevent inadvertently clearing to end of the X window. */
27009 if (to_x
> from_x
&& to_y
> from_y
)
27012 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27013 to_x
- from_x
, to_y
- from_y
);
27018 #endif /* HAVE_WINDOW_SYSTEM */
27022 /***********************************************************************
27024 ***********************************************************************/
27026 /* Value is the internal representation of the specified cursor type
27027 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27028 of the bar cursor. */
27030 static enum text_cursor_kinds
27031 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27033 enum text_cursor_kinds type
;
27038 if (EQ (arg
, Qbox
))
27039 return FILLED_BOX_CURSOR
;
27041 if (EQ (arg
, Qhollow
))
27042 return HOLLOW_BOX_CURSOR
;
27044 if (EQ (arg
, Qbar
))
27051 && EQ (XCAR (arg
), Qbar
)
27052 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27054 *width
= XINT (XCDR (arg
));
27058 if (EQ (arg
, Qhbar
))
27061 return HBAR_CURSOR
;
27065 && EQ (XCAR (arg
), Qhbar
)
27066 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27068 *width
= XINT (XCDR (arg
));
27069 return HBAR_CURSOR
;
27072 /* Treat anything unknown as "hollow box cursor".
27073 It was bad to signal an error; people have trouble fixing
27074 .Xdefaults with Emacs, when it has something bad in it. */
27075 type
= HOLLOW_BOX_CURSOR
;
27080 /* Set the default cursor types for specified frame. */
27082 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27087 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27088 FRAME_CURSOR_WIDTH (f
) = width
;
27090 /* By default, set up the blink-off state depending on the on-state. */
27092 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27095 FRAME_BLINK_OFF_CURSOR (f
)
27096 = get_specified_cursor_type (XCDR (tem
), &width
);
27097 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27100 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27102 /* Make sure the cursor gets redrawn. */
27103 f
->cursor_type_changed
= 1;
27107 #ifdef HAVE_WINDOW_SYSTEM
27109 /* Return the cursor we want to be displayed in window W. Return
27110 width of bar/hbar cursor through WIDTH arg. Return with
27111 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
27112 (i.e. if the `system caret' should track this cursor).
27114 In a mini-buffer window, we want the cursor only to appear if we
27115 are reading input from this window. For the selected window, we
27116 want the cursor type given by the frame parameter or buffer local
27117 setting of cursor-type. If explicitly marked off, draw no cursor.
27118 In all other cases, we want a hollow box cursor. */
27120 static enum text_cursor_kinds
27121 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27122 int *active_cursor
)
27124 struct frame
*f
= XFRAME (w
->frame
);
27125 struct buffer
*b
= XBUFFER (w
->contents
);
27126 int cursor_type
= DEFAULT_CURSOR
;
27127 Lisp_Object alt_cursor
;
27128 int non_selected
= 0;
27130 *active_cursor
= 1;
27133 if (cursor_in_echo_area
27134 && FRAME_HAS_MINIBUF_P (f
)
27135 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27137 if (w
== XWINDOW (echo_area_window
))
27139 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27141 *width
= FRAME_CURSOR_WIDTH (f
);
27142 return FRAME_DESIRED_CURSOR (f
);
27145 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27148 *active_cursor
= 0;
27152 /* Detect a nonselected window or nonselected frame. */
27153 else if (w
!= XWINDOW (f
->selected_window
)
27154 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27156 *active_cursor
= 0;
27158 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27164 /* Never display a cursor in a window in which cursor-type is nil. */
27165 if (NILP (BVAR (b
, cursor_type
)))
27168 /* Get the normal cursor type for this window. */
27169 if (EQ (BVAR (b
, cursor_type
), Qt
))
27171 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27172 *width
= FRAME_CURSOR_WIDTH (f
);
27175 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27177 /* Use cursor-in-non-selected-windows instead
27178 for non-selected window or frame. */
27181 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27182 if (!EQ (Qt
, alt_cursor
))
27183 return get_specified_cursor_type (alt_cursor
, width
);
27184 /* t means modify the normal cursor type. */
27185 if (cursor_type
== FILLED_BOX_CURSOR
)
27186 cursor_type
= HOLLOW_BOX_CURSOR
;
27187 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27189 return cursor_type
;
27192 /* Use normal cursor if not blinked off. */
27193 if (!w
->cursor_off_p
)
27195 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27197 if (cursor_type
== FILLED_BOX_CURSOR
)
27199 /* Using a block cursor on large images can be very annoying.
27200 So use a hollow cursor for "large" images.
27201 If image is not transparent (no mask), also use hollow cursor. */
27202 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27203 if (img
!= NULL
&& IMAGEP (img
->spec
))
27205 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27206 where N = size of default frame font size.
27207 This should cover most of the "tiny" icons people may use. */
27209 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27210 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27211 cursor_type
= HOLLOW_BOX_CURSOR
;
27214 else if (cursor_type
!= NO_CURSOR
)
27216 /* Display current only supports BOX and HOLLOW cursors for images.
27217 So for now, unconditionally use a HOLLOW cursor when cursor is
27218 not a solid box cursor. */
27219 cursor_type
= HOLLOW_BOX_CURSOR
;
27222 return cursor_type
;
27225 /* Cursor is blinked off, so determine how to "toggle" it. */
27227 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27228 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
27229 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
27231 /* Then see if frame has specified a specific blink off cursor type. */
27232 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
27234 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
27235 return FRAME_BLINK_OFF_CURSOR (f
);
27239 /* Some people liked having a permanently visible blinking cursor,
27240 while others had very strong opinions against it. So it was
27241 decided to remove it. KFS 2003-09-03 */
27243 /* Finally perform built-in cursor blinking:
27244 filled box <-> hollow box
27245 wide [h]bar <-> narrow [h]bar
27246 narrow [h]bar <-> no cursor
27247 other type <-> no cursor */
27249 if (cursor_type
== FILLED_BOX_CURSOR
)
27250 return HOLLOW_BOX_CURSOR
;
27252 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
27255 return cursor_type
;
27263 /* Notice when the text cursor of window W has been completely
27264 overwritten by a drawing operation that outputs glyphs in AREA
27265 starting at X0 and ending at X1 in the line starting at Y0 and
27266 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27267 the rest of the line after X0 has been written. Y coordinates
27268 are window-relative. */
27271 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
27272 int x0
, int x1
, int y0
, int y1
)
27274 int cx0
, cx1
, cy0
, cy1
;
27275 struct glyph_row
*row
;
27277 if (!w
->phys_cursor_on_p
)
27279 if (area
!= TEXT_AREA
)
27282 if (w
->phys_cursor
.vpos
< 0
27283 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27284 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27285 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27288 if (row
->cursor_in_fringe_p
)
27290 row
->cursor_in_fringe_p
= 0;
27291 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27292 w
->phys_cursor_on_p
= 0;
27296 cx0
= w
->phys_cursor
.x
;
27297 cx1
= cx0
+ w
->phys_cursor_width
;
27298 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27301 /* The cursor image will be completely removed from the
27302 screen if the output area intersects the cursor area in
27303 y-direction. When we draw in [y0 y1[, and some part of
27304 the cursor is at y < y0, that part must have been drawn
27305 before. When scrolling, the cursor is erased before
27306 actually scrolling, so we don't come here. When not
27307 scrolling, the rows above the old cursor row must have
27308 changed, and in this case these rows must have written
27309 over the cursor image.
27311 Likewise if part of the cursor is below y1, with the
27312 exception of the cursor being in the first blank row at
27313 the buffer and window end because update_text_area
27314 doesn't draw that row. (Except when it does, but
27315 that's handled in update_text_area.) */
27317 cy0
= w
->phys_cursor
.y
;
27318 cy1
= cy0
+ w
->phys_cursor_height
;
27319 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27322 w
->phys_cursor_on_p
= 0;
27325 #endif /* HAVE_WINDOW_SYSTEM */
27328 /************************************************************************
27330 ************************************************************************/
27332 #ifdef HAVE_WINDOW_SYSTEM
27335 Fix the display of area AREA of overlapping row ROW in window W
27336 with respect to the overlapping part OVERLAPS. */
27339 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27340 enum glyph_row_area area
, int overlaps
)
27347 for (i
= 0; i
< row
->used
[area
];)
27349 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27351 int start
= i
, start_x
= x
;
27355 x
+= row
->glyphs
[area
][i
].pixel_width
;
27358 while (i
< row
->used
[area
]
27359 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27361 draw_glyphs (w
, start_x
, row
, area
,
27363 DRAW_NORMAL_TEXT
, overlaps
);
27367 x
+= row
->glyphs
[area
][i
].pixel_width
;
27377 Draw the cursor glyph of window W in glyph row ROW. See the
27378 comment of draw_glyphs for the meaning of HL. */
27381 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27382 enum draw_glyphs_face hl
)
27384 /* If cursor hpos is out of bounds, don't draw garbage. This can
27385 happen in mini-buffer windows when switching between echo area
27386 glyphs and mini-buffer. */
27387 if ((row
->reversed_p
27388 ? (w
->phys_cursor
.hpos
>= 0)
27389 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27391 int on_p
= w
->phys_cursor_on_p
;
27393 int hpos
= w
->phys_cursor
.hpos
;
27395 /* When the window is hscrolled, cursor hpos can legitimately be
27396 out of bounds, but we draw the cursor at the corresponding
27397 window margin in that case. */
27398 if (!row
->reversed_p
&& hpos
< 0)
27400 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27401 hpos
= row
->used
[TEXT_AREA
] - 1;
27403 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27405 w
->phys_cursor_on_p
= on_p
;
27407 if (hl
== DRAW_CURSOR
)
27408 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27409 /* When we erase the cursor, and ROW is overlapped by other
27410 rows, make sure that these overlapping parts of other rows
27412 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27414 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27416 if (row
> w
->current_matrix
->rows
27417 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27418 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27419 OVERLAPS_ERASED_CURSOR
);
27421 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27422 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27423 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27424 OVERLAPS_ERASED_CURSOR
);
27430 /* Erase the image of a cursor of window W from the screen. */
27436 erase_phys_cursor (struct window
*w
)
27438 struct frame
*f
= XFRAME (w
->frame
);
27439 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27440 int hpos
= w
->phys_cursor
.hpos
;
27441 int vpos
= w
->phys_cursor
.vpos
;
27442 int mouse_face_here_p
= 0;
27443 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27444 struct glyph_row
*cursor_row
;
27445 struct glyph
*cursor_glyph
;
27446 enum draw_glyphs_face hl
;
27448 /* No cursor displayed or row invalidated => nothing to do on the
27450 if (w
->phys_cursor_type
== NO_CURSOR
)
27451 goto mark_cursor_off
;
27453 /* VPOS >= active_glyphs->nrows means that window has been resized.
27454 Don't bother to erase the cursor. */
27455 if (vpos
>= active_glyphs
->nrows
)
27456 goto mark_cursor_off
;
27458 /* If row containing cursor is marked invalid, there is nothing we
27460 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27461 if (!cursor_row
->enabled_p
)
27462 goto mark_cursor_off
;
27464 /* If line spacing is > 0, old cursor may only be partially visible in
27465 window after split-window. So adjust visible height. */
27466 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27467 window_text_bottom_y (w
) - cursor_row
->y
);
27469 /* If row is completely invisible, don't attempt to delete a cursor which
27470 isn't there. This can happen if cursor is at top of a window, and
27471 we switch to a buffer with a header line in that window. */
27472 if (cursor_row
->visible_height
<= 0)
27473 goto mark_cursor_off
;
27475 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27476 if (cursor_row
->cursor_in_fringe_p
)
27478 cursor_row
->cursor_in_fringe_p
= 0;
27479 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27480 goto mark_cursor_off
;
27483 /* This can happen when the new row is shorter than the old one.
27484 In this case, either draw_glyphs or clear_end_of_line
27485 should have cleared the cursor. Note that we wouldn't be
27486 able to erase the cursor in this case because we don't have a
27487 cursor glyph at hand. */
27488 if ((cursor_row
->reversed_p
27489 ? (w
->phys_cursor
.hpos
< 0)
27490 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27491 goto mark_cursor_off
;
27493 /* When the window is hscrolled, cursor hpos can legitimately be out
27494 of bounds, but we draw the cursor at the corresponding window
27495 margin in that case. */
27496 if (!cursor_row
->reversed_p
&& hpos
< 0)
27498 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27499 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27501 /* If the cursor is in the mouse face area, redisplay that when
27502 we clear the cursor. */
27503 if (! NILP (hlinfo
->mouse_face_window
)
27504 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27505 /* Don't redraw the cursor's spot in mouse face if it is at the
27506 end of a line (on a newline). The cursor appears there, but
27507 mouse highlighting does not. */
27508 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27509 mouse_face_here_p
= 1;
27511 /* Maybe clear the display under the cursor. */
27512 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27515 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27518 cursor_glyph
= get_phys_cursor_glyph (w
);
27519 if (cursor_glyph
== NULL
)
27520 goto mark_cursor_off
;
27522 width
= cursor_glyph
->pixel_width
;
27523 x
= w
->phys_cursor
.x
;
27529 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27530 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27531 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
27534 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27537 /* Erase the cursor by redrawing the character underneath it. */
27538 if (mouse_face_here_p
)
27539 hl
= DRAW_MOUSE_FACE
;
27541 hl
= DRAW_NORMAL_TEXT
;
27542 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27545 w
->phys_cursor_on_p
= 0;
27546 w
->phys_cursor_type
= NO_CURSOR
;
27551 Display or clear cursor of window W. If ON is zero, clear the
27552 cursor. If it is non-zero, display the cursor. If ON is nonzero,
27553 where to put the cursor is specified by HPOS, VPOS, X and Y. */
27556 display_and_set_cursor (struct window
*w
, bool on
,
27557 int hpos
, int vpos
, int x
, int y
)
27559 struct frame
*f
= XFRAME (w
->frame
);
27560 int new_cursor_type
;
27561 int new_cursor_width
;
27563 struct glyph_row
*glyph_row
;
27564 struct glyph
*glyph
;
27566 /* This is pointless on invisible frames, and dangerous on garbaged
27567 windows and frames; in the latter case, the frame or window may
27568 be in the midst of changing its size, and x and y may be off the
27570 if (! FRAME_VISIBLE_P (f
)
27571 || FRAME_GARBAGED_P (f
)
27572 || vpos
>= w
->current_matrix
->nrows
27573 || hpos
>= w
->current_matrix
->matrix_w
)
27576 /* If cursor is off and we want it off, return quickly. */
27577 if (!on
&& !w
->phys_cursor_on_p
)
27580 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27581 /* If cursor row is not enabled, we don't really know where to
27582 display the cursor. */
27583 if (!glyph_row
->enabled_p
)
27585 w
->phys_cursor_on_p
= 0;
27590 if (!glyph_row
->exact_window_width_line_p
27591 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
27592 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
27594 eassert (input_blocked_p ());
27596 /* Set new_cursor_type to the cursor we want to be displayed. */
27597 new_cursor_type
= get_window_cursor_type (w
, glyph
,
27598 &new_cursor_width
, &active_cursor
);
27600 /* If cursor is currently being shown and we don't want it to be or
27601 it is in the wrong place, or the cursor type is not what we want,
27603 if (w
->phys_cursor_on_p
27605 || w
->phys_cursor
.x
!= x
27606 || w
->phys_cursor
.y
!= y
27607 /* HPOS can be negative in R2L rows whose
27608 exact_window_width_line_p flag is set (i.e. their newline
27609 would "overflow into the fringe"). */
27611 || new_cursor_type
!= w
->phys_cursor_type
27612 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
27613 && new_cursor_width
!= w
->phys_cursor_width
)))
27614 erase_phys_cursor (w
);
27616 /* Don't check phys_cursor_on_p here because that flag is only set
27617 to zero in some cases where we know that the cursor has been
27618 completely erased, to avoid the extra work of erasing the cursor
27619 twice. In other words, phys_cursor_on_p can be 1 and the cursor
27620 still not be visible, or it has only been partly erased. */
27623 w
->phys_cursor_ascent
= glyph_row
->ascent
;
27624 w
->phys_cursor_height
= glyph_row
->height
;
27626 /* Set phys_cursor_.* before x_draw_.* is called because some
27627 of them may need the information. */
27628 w
->phys_cursor
.x
= x
;
27629 w
->phys_cursor
.y
= glyph_row
->y
;
27630 w
->phys_cursor
.hpos
= hpos
;
27631 w
->phys_cursor
.vpos
= vpos
;
27634 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
27635 new_cursor_type
, new_cursor_width
,
27636 on
, active_cursor
);
27640 /* Switch the display of W's cursor on or off, according to the value
27644 update_window_cursor (struct window
*w
, bool on
)
27646 /* Don't update cursor in windows whose frame is in the process
27647 of being deleted. */
27648 if (w
->current_matrix
)
27650 int hpos
= w
->phys_cursor
.hpos
;
27651 int vpos
= w
->phys_cursor
.vpos
;
27652 struct glyph_row
*row
;
27654 if (vpos
>= w
->current_matrix
->nrows
27655 || hpos
>= w
->current_matrix
->matrix_w
)
27658 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27660 /* When the window is hscrolled, cursor hpos can legitimately be
27661 out of bounds, but we draw the cursor at the corresponding
27662 window margin in that case. */
27663 if (!row
->reversed_p
&& hpos
< 0)
27665 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27666 hpos
= row
->used
[TEXT_AREA
] - 1;
27669 display_and_set_cursor (w
, on
, hpos
, vpos
,
27670 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27676 /* Call update_window_cursor with parameter ON_P on all leaf windows
27677 in the window tree rooted at W. */
27680 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
27684 if (WINDOWP (w
->contents
))
27685 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
27687 update_window_cursor (w
, on_p
);
27689 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
27695 Display the cursor on window W, or clear it, according to ON_P.
27696 Don't change the cursor's position. */
27699 x_update_cursor (struct frame
*f
, bool on_p
)
27701 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
27706 Clear the cursor of window W to background color, and mark the
27707 cursor as not shown. This is used when the text where the cursor
27708 is about to be rewritten. */
27711 x_clear_cursor (struct window
*w
)
27713 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
27714 update_window_cursor (w
, 0);
27717 #endif /* HAVE_WINDOW_SYSTEM */
27719 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
27722 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
27723 int start_hpos
, int end_hpos
,
27724 enum draw_glyphs_face draw
)
27726 #ifdef HAVE_WINDOW_SYSTEM
27727 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
27729 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
27733 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
27734 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
27738 /* Display the active region described by mouse_face_* according to DRAW. */
27741 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
27743 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
27744 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27746 if (/* If window is in the process of being destroyed, don't bother
27748 w
->current_matrix
!= NULL
27749 /* Don't update mouse highlight if hidden. */
27750 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
27751 /* Recognize when we are called to operate on rows that don't exist
27752 anymore. This can happen when a window is split. */
27753 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
27755 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
27756 struct glyph_row
*row
, *first
, *last
;
27758 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
27759 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
27761 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
27763 int start_hpos
, end_hpos
, start_x
;
27765 /* For all but the first row, the highlight starts at column 0. */
27768 /* R2L rows have BEG and END in reversed order, but the
27769 screen drawing geometry is always left to right. So
27770 we need to mirror the beginning and end of the
27771 highlighted area in R2L rows. */
27772 if (!row
->reversed_p
)
27774 start_hpos
= hlinfo
->mouse_face_beg_col
;
27775 start_x
= hlinfo
->mouse_face_beg_x
;
27777 else if (row
== last
)
27779 start_hpos
= hlinfo
->mouse_face_end_col
;
27780 start_x
= hlinfo
->mouse_face_end_x
;
27788 else if (row
->reversed_p
&& row
== last
)
27790 start_hpos
= hlinfo
->mouse_face_end_col
;
27791 start_x
= hlinfo
->mouse_face_end_x
;
27801 if (!row
->reversed_p
)
27802 end_hpos
= hlinfo
->mouse_face_end_col
;
27803 else if (row
== first
)
27804 end_hpos
= hlinfo
->mouse_face_beg_col
;
27807 end_hpos
= row
->used
[TEXT_AREA
];
27808 if (draw
== DRAW_NORMAL_TEXT
)
27809 row
->fill_line_p
= 1; /* Clear to end of line */
27812 else if (row
->reversed_p
&& row
== first
)
27813 end_hpos
= hlinfo
->mouse_face_beg_col
;
27816 end_hpos
= row
->used
[TEXT_AREA
];
27817 if (draw
== DRAW_NORMAL_TEXT
)
27818 row
->fill_line_p
= 1; /* Clear to end of line */
27821 if (end_hpos
> start_hpos
)
27823 draw_row_with_mouse_face (w
, start_x
, row
,
27824 start_hpos
, end_hpos
, draw
);
27827 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
27831 #ifdef HAVE_WINDOW_SYSTEM
27832 /* When we've written over the cursor, arrange for it to
27833 be displayed again. */
27834 if (FRAME_WINDOW_P (f
)
27835 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
27837 int hpos
= w
->phys_cursor
.hpos
;
27839 /* When the window is hscrolled, cursor hpos can legitimately be
27840 out of bounds, but we draw the cursor at the corresponding
27841 window margin in that case. */
27842 if (!row
->reversed_p
&& hpos
< 0)
27844 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27845 hpos
= row
->used
[TEXT_AREA
] - 1;
27848 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
27849 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27852 #endif /* HAVE_WINDOW_SYSTEM */
27855 #ifdef HAVE_WINDOW_SYSTEM
27856 /* Change the mouse cursor. */
27857 if (FRAME_WINDOW_P (f
))
27859 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
27860 if (draw
== DRAW_NORMAL_TEXT
27861 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
27862 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
27865 if (draw
== DRAW_MOUSE_FACE
)
27866 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
27868 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
27870 #endif /* HAVE_WINDOW_SYSTEM */
27874 Clear out the mouse-highlighted active region.
27875 Redraw it un-highlighted first. Value is non-zero if mouse
27876 face was actually drawn unhighlighted. */
27879 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
27883 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
27885 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
27889 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27890 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27891 hlinfo
->mouse_face_window
= Qnil
;
27892 hlinfo
->mouse_face_overlay
= Qnil
;
27896 /* Return true if the coordinates HPOS and VPOS on windows W are
27897 within the mouse face on that window. */
27899 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
27901 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27903 /* Quickly resolve the easy cases. */
27904 if (!(WINDOWP (hlinfo
->mouse_face_window
)
27905 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
27907 if (vpos
< hlinfo
->mouse_face_beg_row
27908 || vpos
> hlinfo
->mouse_face_end_row
)
27910 if (vpos
> hlinfo
->mouse_face_beg_row
27911 && vpos
< hlinfo
->mouse_face_end_row
)
27914 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
27916 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27918 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
27921 else if ((vpos
== hlinfo
->mouse_face_beg_row
27922 && hpos
>= hlinfo
->mouse_face_beg_col
)
27923 || (vpos
== hlinfo
->mouse_face_end_row
27924 && hpos
< hlinfo
->mouse_face_end_col
))
27929 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27931 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
27934 else if ((vpos
== hlinfo
->mouse_face_beg_row
27935 && hpos
<= hlinfo
->mouse_face_beg_col
)
27936 || (vpos
== hlinfo
->mouse_face_end_row
27937 && hpos
> hlinfo
->mouse_face_end_col
))
27945 True if physical cursor of window W is within mouse face. */
27948 cursor_in_mouse_face_p (struct window
*w
)
27950 int hpos
= w
->phys_cursor
.hpos
;
27951 int vpos
= w
->phys_cursor
.vpos
;
27952 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27954 /* When the window is hscrolled, cursor hpos can legitimately be out
27955 of bounds, but we draw the cursor at the corresponding window
27956 margin in that case. */
27957 if (!row
->reversed_p
&& hpos
< 0)
27959 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27960 hpos
= row
->used
[TEXT_AREA
] - 1;
27962 return coords_in_mouse_face_p (w
, hpos
, vpos
);
27967 /* Find the glyph rows START_ROW and END_ROW of window W that display
27968 characters between buffer positions START_CHARPOS and END_CHARPOS
27969 (excluding END_CHARPOS). DISP_STRING is a display string that
27970 covers these buffer positions. This is similar to
27971 row_containing_pos, but is more accurate when bidi reordering makes
27972 buffer positions change non-linearly with glyph rows. */
27974 rows_from_pos_range (struct window
*w
,
27975 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
27976 Lisp_Object disp_string
,
27977 struct glyph_row
**start
, struct glyph_row
**end
)
27979 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27980 int last_y
= window_text_bottom_y (w
);
27981 struct glyph_row
*row
;
27986 while (!first
->enabled_p
27987 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
27990 /* Find the START row. */
27992 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
27995 /* A row can potentially be the START row if the range of the
27996 characters it displays intersects the range
27997 [START_CHARPOS..END_CHARPOS). */
27998 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
27999 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28000 /* See the commentary in row_containing_pos, for the
28001 explanation of the complicated way to check whether
28002 some position is beyond the end of the characters
28003 displayed by a row. */
28004 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28005 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28006 && !row
->ends_at_zv_p
28007 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28008 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28009 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28010 && !row
->ends_at_zv_p
28011 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28013 /* Found a candidate row. Now make sure at least one of the
28014 glyphs it displays has a charpos from the range
28015 [START_CHARPOS..END_CHARPOS).
28017 This is not obvious because bidi reordering could make
28018 buffer positions of a row be 1,2,3,102,101,100, and if we
28019 want to highlight characters in [50..60), we don't want
28020 this row, even though [50..60) does intersect [1..103),
28021 the range of character positions given by the row's start
28022 and end positions. */
28023 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
28024 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28028 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
28029 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28030 /* A glyph that comes from DISP_STRING is by
28031 definition to be highlighted. */
28032 || EQ (g
->object
, disp_string
))
28041 /* Find the END row. */
28043 /* If the last row is partially visible, start looking for END
28044 from that row, instead of starting from FIRST. */
28045 && !(row
->enabled_p
28046 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28048 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28050 struct glyph_row
*next
= row
+ 1;
28051 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28053 if (!next
->enabled_p
28054 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28055 /* The first row >= START whose range of displayed characters
28056 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28057 is the row END + 1. */
28058 || (start_charpos
< next_start
28059 && end_charpos
< next_start
)
28060 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28061 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28062 && !next
->ends_at_zv_p
28063 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28064 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28065 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28066 && !next
->ends_at_zv_p
28067 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28074 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28075 but none of the characters it displays are in the range, it is
28077 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28078 struct glyph
*s
= g
;
28079 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28083 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
28084 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28085 /* If the buffer position of the first glyph in
28086 the row is equal to END_CHARPOS, it means
28087 the last character to be highlighted is the
28088 newline of ROW, and we must consider NEXT as
28090 || (((!next
->reversed_p
&& g
== s
)
28091 || (next
->reversed_p
&& g
== e
- 1))
28092 && (g
->charpos
== end_charpos
28093 /* Special case for when NEXT is an
28094 empty line at ZV. */
28095 || (g
->charpos
== -1
28096 && !row
->ends_at_zv_p
28097 && next_start
== end_charpos
)))))
28098 /* A glyph that comes from DISP_STRING is by
28099 definition to be highlighted. */
28100 || EQ (g
->object
, disp_string
))
28109 /* The first row that ends at ZV must be the last to be
28111 else if (next
->ends_at_zv_p
)
28120 /* This function sets the mouse_face_* elements of HLINFO, assuming
28121 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28122 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28123 for the overlay or run of text properties specifying the mouse
28124 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28125 before-string and after-string that must also be highlighted.
28126 DISP_STRING, if non-nil, is a display string that may cover some
28127 or all of the highlighted text. */
28130 mouse_face_from_buffer_pos (Lisp_Object window
,
28131 Mouse_HLInfo
*hlinfo
,
28132 ptrdiff_t mouse_charpos
,
28133 ptrdiff_t start_charpos
,
28134 ptrdiff_t end_charpos
,
28135 Lisp_Object before_string
,
28136 Lisp_Object after_string
,
28137 Lisp_Object disp_string
)
28139 struct window
*w
= XWINDOW (window
);
28140 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28141 struct glyph_row
*r1
, *r2
;
28142 struct glyph
*glyph
, *end
;
28143 ptrdiff_t ignore
, pos
;
28146 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28147 eassert (NILP (before_string
) || STRINGP (before_string
));
28148 eassert (NILP (after_string
) || STRINGP (after_string
));
28150 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28151 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28153 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28154 /* If the before-string or display-string contains newlines,
28155 rows_from_pos_range skips to its last row. Move back. */
28156 if (!NILP (before_string
) || !NILP (disp_string
))
28158 struct glyph_row
*prev
;
28159 while ((prev
= r1
- 1, prev
>= first
)
28160 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28161 && prev
->used
[TEXT_AREA
] > 0)
28163 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28164 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28165 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
28167 || !(EQ (glyph
->object
, before_string
)
28168 || EQ (glyph
->object
, disp_string
)))
28175 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28176 hlinfo
->mouse_face_past_end
= 1;
28178 else if (!NILP (after_string
))
28180 /* If the after-string has newlines, advance to its last row. */
28181 struct glyph_row
*next
;
28182 struct glyph_row
*last
28183 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28185 for (next
= r2
+ 1;
28187 && next
->used
[TEXT_AREA
] > 0
28188 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28192 /* The rest of the display engine assumes that mouse_face_beg_row is
28193 either above mouse_face_end_row or identical to it. But with
28194 bidi-reordered continued lines, the row for START_CHARPOS could
28195 be below the row for END_CHARPOS. If so, swap the rows and store
28196 them in correct order. */
28199 struct glyph_row
*tem
= r2
;
28205 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28206 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28208 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28209 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28210 could be anywhere in the row and in any order. The strategy
28211 below is to find the leftmost and the rightmost glyph that
28212 belongs to either of these 3 strings, or whose position is
28213 between START_CHARPOS and END_CHARPOS, and highlight all the
28214 glyphs between those two. This may cover more than just the text
28215 between START_CHARPOS and END_CHARPOS if the range of characters
28216 strides the bidi level boundary, e.g. if the beginning is in R2L
28217 text while the end is in L2R text or vice versa. */
28218 if (!r1
->reversed_p
)
28220 /* This row is in a left to right paragraph. Scan it left to
28222 glyph
= r1
->glyphs
[TEXT_AREA
];
28223 end
= glyph
+ r1
->used
[TEXT_AREA
];
28226 /* Skip truncation glyphs at the start of the glyph row. */
28227 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28229 && INTEGERP (glyph
->object
)
28230 && glyph
->charpos
< 0;
28232 x
+= glyph
->pixel_width
;
28234 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28235 or DISP_STRING, and the first glyph from buffer whose
28236 position is between START_CHARPOS and END_CHARPOS. */
28238 && !INTEGERP (glyph
->object
)
28239 && !EQ (glyph
->object
, disp_string
)
28240 && !(BUFFERP (glyph
->object
)
28241 && (glyph
->charpos
>= start_charpos
28242 && glyph
->charpos
< end_charpos
));
28245 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28246 are present at buffer positions between START_CHARPOS and
28247 END_CHARPOS, or if they come from an overlay. */
28248 if (EQ (glyph
->object
, before_string
))
28250 pos
= string_buffer_position (before_string
,
28252 /* If pos == 0, it means before_string came from an
28253 overlay, not from a buffer position. */
28254 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28257 else if (EQ (glyph
->object
, after_string
))
28259 pos
= string_buffer_position (after_string
, end_charpos
);
28260 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28263 x
+= glyph
->pixel_width
;
28265 hlinfo
->mouse_face_beg_x
= x
;
28266 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28270 /* This row is in a right to left paragraph. Scan it right to
28274 end
= r1
->glyphs
[TEXT_AREA
] - 1;
28275 glyph
= end
+ r1
->used
[TEXT_AREA
];
28277 /* Skip truncation glyphs at the start of the glyph row. */
28278 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28280 && INTEGERP (glyph
->object
)
28281 && glyph
->charpos
< 0;
28285 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28286 or DISP_STRING, and the first glyph from buffer whose
28287 position is between START_CHARPOS and END_CHARPOS. */
28289 && !INTEGERP (glyph
->object
)
28290 && !EQ (glyph
->object
, disp_string
)
28291 && !(BUFFERP (glyph
->object
)
28292 && (glyph
->charpos
>= start_charpos
28293 && glyph
->charpos
< end_charpos
));
28296 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28297 are present at buffer positions between START_CHARPOS and
28298 END_CHARPOS, or if they come from an overlay. */
28299 if (EQ (glyph
->object
, before_string
))
28301 pos
= string_buffer_position (before_string
, start_charpos
);
28302 /* If pos == 0, it means before_string came from an
28303 overlay, not from a buffer position. */
28304 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28307 else if (EQ (glyph
->object
, after_string
))
28309 pos
= string_buffer_position (after_string
, end_charpos
);
28310 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28315 glyph
++; /* first glyph to the right of the highlighted area */
28316 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28317 x
+= g
->pixel_width
;
28318 hlinfo
->mouse_face_beg_x
= x
;
28319 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28322 /* If the highlight ends in a different row, compute GLYPH and END
28323 for the end row. Otherwise, reuse the values computed above for
28324 the row where the highlight begins. */
28327 if (!r2
->reversed_p
)
28329 glyph
= r2
->glyphs
[TEXT_AREA
];
28330 end
= glyph
+ r2
->used
[TEXT_AREA
];
28335 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28336 glyph
= end
+ r2
->used
[TEXT_AREA
];
28340 if (!r2
->reversed_p
)
28342 /* Skip truncation and continuation glyphs near the end of the
28343 row, and also blanks and stretch glyphs inserted by
28344 extend_face_to_end_of_line. */
28346 && INTEGERP ((end
- 1)->object
))
28348 /* Scan the rest of the glyph row from the end, looking for the
28349 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28350 DISP_STRING, or whose position is between START_CHARPOS
28354 && !INTEGERP (end
->object
)
28355 && !EQ (end
->object
, disp_string
)
28356 && !(BUFFERP (end
->object
)
28357 && (end
->charpos
>= start_charpos
28358 && end
->charpos
< end_charpos
));
28361 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28362 are present at buffer positions between START_CHARPOS and
28363 END_CHARPOS, or if they come from an overlay. */
28364 if (EQ (end
->object
, before_string
))
28366 pos
= string_buffer_position (before_string
, start_charpos
);
28367 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28370 else if (EQ (end
->object
, after_string
))
28372 pos
= string_buffer_position (after_string
, end_charpos
);
28373 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28377 /* Find the X coordinate of the last glyph to be highlighted. */
28378 for (; glyph
<= end
; ++glyph
)
28379 x
+= glyph
->pixel_width
;
28381 hlinfo
->mouse_face_end_x
= x
;
28382 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28386 /* Skip truncation and continuation glyphs near the end of the
28387 row, and also blanks and stretch glyphs inserted by
28388 extend_face_to_end_of_line. */
28392 && INTEGERP (end
->object
))
28394 x
+= end
->pixel_width
;
28397 /* Scan the rest of the glyph row from the end, looking for the
28398 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28399 DISP_STRING, or whose position is between START_CHARPOS
28403 && !INTEGERP (end
->object
)
28404 && !EQ (end
->object
, disp_string
)
28405 && !(BUFFERP (end
->object
)
28406 && (end
->charpos
>= start_charpos
28407 && end
->charpos
< end_charpos
));
28410 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28411 are present at buffer positions between START_CHARPOS and
28412 END_CHARPOS, or if they come from an overlay. */
28413 if (EQ (end
->object
, before_string
))
28415 pos
= string_buffer_position (before_string
, start_charpos
);
28416 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28419 else if (EQ (end
->object
, after_string
))
28421 pos
= string_buffer_position (after_string
, end_charpos
);
28422 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28425 x
+= end
->pixel_width
;
28427 /* If we exited the above loop because we arrived at the last
28428 glyph of the row, and its buffer position is still not in
28429 range, it means the last character in range is the preceding
28430 newline. Bump the end column and x values to get past the
28433 && BUFFERP (end
->object
)
28434 && (end
->charpos
< start_charpos
28435 || end
->charpos
>= end_charpos
))
28437 x
+= end
->pixel_width
;
28440 hlinfo
->mouse_face_end_x
= x
;
28441 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28444 hlinfo
->mouse_face_window
= window
;
28445 hlinfo
->mouse_face_face_id
28446 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28448 !hlinfo
->mouse_face_hidden
, -1);
28449 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28452 /* The following function is not used anymore (replaced with
28453 mouse_face_from_string_pos), but I leave it here for the time
28454 being, in case someone would. */
28456 #if 0 /* not used */
28458 /* Find the position of the glyph for position POS in OBJECT in
28459 window W's current matrix, and return in *X, *Y the pixel
28460 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28462 RIGHT_P non-zero means return the position of the right edge of the
28463 glyph, RIGHT_P zero means return the left edge position.
28465 If no glyph for POS exists in the matrix, return the position of
28466 the glyph with the next smaller position that is in the matrix, if
28467 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
28468 exists in the matrix, return the position of the glyph with the
28469 next larger position in OBJECT.
28471 Value is non-zero if a glyph was found. */
28474 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28475 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
28477 int yb
= window_text_bottom_y (w
);
28478 struct glyph_row
*r
;
28479 struct glyph
*best_glyph
= NULL
;
28480 struct glyph_row
*best_row
= NULL
;
28483 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28484 r
->enabled_p
&& r
->y
< yb
;
28487 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28488 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28491 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28492 if (EQ (g
->object
, object
))
28494 if (g
->charpos
== pos
)
28501 else if (best_glyph
== NULL
28502 || ((eabs (g
->charpos
- pos
)
28503 < eabs (best_glyph
->charpos
- pos
))
28506 : g
->charpos
> pos
)))
28520 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28524 *x
+= best_glyph
->pixel_width
;
28529 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28532 return best_glyph
!= NULL
;
28534 #endif /* not used */
28536 /* Find the positions of the first and the last glyphs in window W's
28537 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28538 (assumed to be a string), and return in HLINFO's mouse_face_*
28539 members the pixel and column/row coordinates of those glyphs. */
28542 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28543 Lisp_Object object
,
28544 ptrdiff_t startpos
, ptrdiff_t endpos
)
28546 int yb
= window_text_bottom_y (w
);
28547 struct glyph_row
*r
;
28548 struct glyph
*g
, *e
;
28552 /* Find the glyph row with at least one position in the range
28553 [STARTPOS..ENDPOS), and the first glyph in that row whose
28554 position belongs to that range. */
28555 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28556 r
->enabled_p
&& r
->y
< yb
;
28559 if (!r
->reversed_p
)
28561 g
= r
->glyphs
[TEXT_AREA
];
28562 e
= g
+ r
->used
[TEXT_AREA
];
28563 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28564 if (EQ (g
->object
, object
)
28565 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28567 hlinfo
->mouse_face_beg_row
28568 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28569 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28570 hlinfo
->mouse_face_beg_x
= gx
;
28579 e
= r
->glyphs
[TEXT_AREA
];
28580 g
= e
+ r
->used
[TEXT_AREA
];
28581 for ( ; g
> e
; --g
)
28582 if (EQ ((g
-1)->object
, object
)
28583 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
28585 hlinfo
->mouse_face_beg_row
28586 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28587 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28588 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
28589 gx
+= g1
->pixel_width
;
28590 hlinfo
->mouse_face_beg_x
= gx
;
28602 /* Starting with the next row, look for the first row which does NOT
28603 include any glyphs whose positions are in the range. */
28604 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
28606 g
= r
->glyphs
[TEXT_AREA
];
28607 e
= g
+ r
->used
[TEXT_AREA
];
28609 for ( ; g
< e
; ++g
)
28610 if (EQ (g
->object
, object
)
28611 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28620 /* The highlighted region ends on the previous row. */
28623 /* Set the end row. */
28624 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28626 /* Compute and set the end column and the end column's horizontal
28627 pixel coordinate. */
28628 if (!r
->reversed_p
)
28630 g
= r
->glyphs
[TEXT_AREA
];
28631 e
= g
+ r
->used
[TEXT_AREA
];
28632 for ( ; e
> g
; --e
)
28633 if (EQ ((e
-1)->object
, object
)
28634 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
28636 hlinfo
->mouse_face_end_col
= e
- g
;
28638 for (gx
= r
->x
; g
< e
; ++g
)
28639 gx
+= g
->pixel_width
;
28640 hlinfo
->mouse_face_end_x
= gx
;
28644 e
= r
->glyphs
[TEXT_AREA
];
28645 g
= e
+ r
->used
[TEXT_AREA
];
28646 for (gx
= r
->x
; e
< g
; ++e
)
28648 if (EQ (e
->object
, object
)
28649 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
28651 gx
+= e
->pixel_width
;
28653 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
28654 hlinfo
->mouse_face_end_x
= gx
;
28658 #ifdef HAVE_WINDOW_SYSTEM
28660 /* See if position X, Y is within a hot-spot of an image. */
28663 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
28665 if (!CONSP (hot_spot
))
28668 if (EQ (XCAR (hot_spot
), Qrect
))
28670 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
28671 Lisp_Object rect
= XCDR (hot_spot
);
28675 if (!CONSP (XCAR (rect
)))
28677 if (!CONSP (XCDR (rect
)))
28679 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
28681 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
28683 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
28685 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
28689 else if (EQ (XCAR (hot_spot
), Qcircle
))
28691 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
28692 Lisp_Object circ
= XCDR (hot_spot
);
28693 Lisp_Object lr
, lx0
, ly0
;
28695 && CONSP (XCAR (circ
))
28696 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
28697 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
28698 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
28700 double r
= XFLOATINT (lr
);
28701 double dx
= XINT (lx0
) - x
;
28702 double dy
= XINT (ly0
) - y
;
28703 return (dx
* dx
+ dy
* dy
<= r
* r
);
28706 else if (EQ (XCAR (hot_spot
), Qpoly
))
28708 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
28709 if (VECTORP (XCDR (hot_spot
)))
28711 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
28712 Lisp_Object
*poly
= v
->contents
;
28713 ptrdiff_t n
= v
->header
.size
;
28716 Lisp_Object lx
, ly
;
28719 /* Need an even number of coordinates, and at least 3 edges. */
28720 if (n
< 6 || n
& 1)
28723 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
28724 If count is odd, we are inside polygon. Pixels on edges
28725 may or may not be included depending on actual geometry of the
28727 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
28728 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
28730 x0
= XINT (lx
), y0
= XINT (ly
);
28731 for (i
= 0; i
< n
; i
+= 2)
28733 int x1
= x0
, y1
= y0
;
28734 if ((lx
= poly
[i
], !INTEGERP (lx
))
28735 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
28737 x0
= XINT (lx
), y0
= XINT (ly
);
28739 /* Does this segment cross the X line? */
28747 if (y
> y0
&& y
> y1
)
28749 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
28759 find_hot_spot (Lisp_Object map
, int x
, int y
)
28761 while (CONSP (map
))
28763 if (CONSP (XCAR (map
))
28764 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
28772 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
28774 doc
: /* Lookup in image map MAP coordinates X and Y.
28775 An image map is an alist where each element has the format (AREA ID PLIST).
28776 An AREA is specified as either a rectangle, a circle, or a polygon:
28777 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
28778 pixel coordinates of the upper left and bottom right corners.
28779 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
28780 and the radius of the circle; r may be a float or integer.
28781 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
28782 vector describes one corner in the polygon.
28783 Returns the alist element for the first matching AREA in MAP. */)
28784 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
28792 return find_hot_spot (map
,
28793 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
28794 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
28798 /* Display frame CURSOR, optionally using shape defined by POINTER. */
28800 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
28802 /* Do not change cursor shape while dragging mouse. */
28803 if (!NILP (do_mouse_tracking
))
28806 if (!NILP (pointer
))
28808 if (EQ (pointer
, Qarrow
))
28809 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28810 else if (EQ (pointer
, Qhand
))
28811 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
28812 else if (EQ (pointer
, Qtext
))
28813 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
28814 else if (EQ (pointer
, intern ("hdrag")))
28815 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28816 else if (EQ (pointer
, intern ("nhdrag")))
28817 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
28818 #ifdef HAVE_X_WINDOWS
28819 else if (EQ (pointer
, intern ("vdrag")))
28820 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28822 else if (EQ (pointer
, intern ("hourglass")))
28823 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
28824 else if (EQ (pointer
, Qmodeline
))
28825 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
28827 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28830 if (cursor
!= No_Cursor
)
28831 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
28834 #endif /* HAVE_WINDOW_SYSTEM */
28836 /* Take proper action when mouse has moved to the mode or header line
28837 or marginal area AREA of window W, x-position X and y-position Y.
28838 X is relative to the start of the text display area of W, so the
28839 width of bitmap areas and scroll bars must be subtracted to get a
28840 position relative to the start of the mode line. */
28843 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
28844 enum window_part area
)
28846 struct window
*w
= XWINDOW (window
);
28847 struct frame
*f
= XFRAME (w
->frame
);
28848 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28849 #ifdef HAVE_WINDOW_SYSTEM
28850 Display_Info
*dpyinfo
;
28852 Cursor cursor
= No_Cursor
;
28853 Lisp_Object pointer
= Qnil
;
28854 int dx
, dy
, width
, height
;
28856 Lisp_Object string
, object
= Qnil
;
28857 Lisp_Object pos
IF_LINT (= Qnil
), help
;
28859 Lisp_Object mouse_face
;
28860 int original_x_pixel
= x
;
28861 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
28862 struct glyph_row
*row
IF_LINT (= 0);
28864 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
28869 /* Kludge alert: mode_line_string takes X/Y in pixels, but
28870 returns them in row/column units! */
28871 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
28872 &object
, &dx
, &dy
, &width
, &height
);
28874 row
= (area
== ON_MODE_LINE
28875 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
28876 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
28878 /* Find the glyph under the mouse pointer. */
28879 if (row
->mode_line_p
&& row
->enabled_p
)
28881 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
28882 end
= glyph
+ row
->used
[TEXT_AREA
];
28884 for (x0
= original_x_pixel
;
28885 glyph
< end
&& x0
>= glyph
->pixel_width
;
28887 x0
-= glyph
->pixel_width
;
28895 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
28896 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
28897 returns them in row/column units! */
28898 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
28899 &object
, &dx
, &dy
, &width
, &height
);
28904 #ifdef HAVE_WINDOW_SYSTEM
28905 if (IMAGEP (object
))
28907 Lisp_Object image_map
, hotspot
;
28908 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
28910 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
28912 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
28916 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
28917 If so, we could look for mouse-enter, mouse-leave
28918 properties in PLIST (and do something...). */
28919 hotspot
= XCDR (hotspot
);
28920 if (CONSP (hotspot
)
28921 && (plist
= XCAR (hotspot
), CONSP (plist
)))
28923 pointer
= Fplist_get (plist
, Qpointer
);
28924 if (NILP (pointer
))
28926 help
= Fplist_get (plist
, Qhelp_echo
);
28929 help_echo_string
= help
;
28930 XSETWINDOW (help_echo_window
, w
);
28931 help_echo_object
= w
->contents
;
28932 help_echo_pos
= charpos
;
28936 if (NILP (pointer
))
28937 pointer
= Fplist_get (XCDR (object
), QCpointer
);
28939 #endif /* HAVE_WINDOW_SYSTEM */
28941 if (STRINGP (string
))
28942 pos
= make_number (charpos
);
28944 /* Set the help text and mouse pointer. If the mouse is on a part
28945 of the mode line without any text (e.g. past the right edge of
28946 the mode line text), use the default help text and pointer. */
28947 if (STRINGP (string
) || area
== ON_MODE_LINE
)
28949 /* Arrange to display the help by setting the global variables
28950 help_echo_string, help_echo_object, and help_echo_pos. */
28953 if (STRINGP (string
))
28954 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
28958 help_echo_string
= help
;
28959 XSETWINDOW (help_echo_window
, w
);
28960 help_echo_object
= string
;
28961 help_echo_pos
= charpos
;
28963 else if (area
== ON_MODE_LINE
)
28965 Lisp_Object default_help
28966 = buffer_local_value_1 (Qmode_line_default_help_echo
,
28969 if (STRINGP (default_help
))
28971 help_echo_string
= default_help
;
28972 XSETWINDOW (help_echo_window
, w
);
28973 help_echo_object
= Qnil
;
28974 help_echo_pos
= -1;
28979 #ifdef HAVE_WINDOW_SYSTEM
28980 /* Change the mouse pointer according to what is under it. */
28981 if (FRAME_WINDOW_P (f
))
28983 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
28985 || NILP (Vresize_mini_windows
));
28987 dpyinfo
= FRAME_DISPLAY_INFO (f
);
28988 if (STRINGP (string
))
28990 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28992 if (NILP (pointer
))
28993 pointer
= Fget_text_property (pos
, Qpointer
, string
);
28995 /* Change the mouse pointer according to what is under X/Y. */
28997 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29000 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29001 if (!KEYMAPP (map
))
29002 map
= Fget_text_property (pos
, Qkeymap
, string
);
29003 if (!KEYMAPP (map
) && draggable
)
29004 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29007 else if (draggable
)
29008 /* Default mode-line pointer. */
29009 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29014 /* Change the mouse face according to what is under X/Y. */
29015 if (STRINGP (string
))
29017 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29018 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29019 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29024 struct glyph
* tmp_glyph
;
29028 int total_pixel_width
;
29029 ptrdiff_t begpos
, endpos
, ignore
;
29033 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29034 Qmouse_face
, string
, Qnil
);
29040 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29042 endpos
= SCHARS (string
);
29046 /* Calculate the glyph position GPOS of GLYPH in the
29047 displayed string, relative to the beginning of the
29048 highlighted part of the string.
29050 Note: GPOS is different from CHARPOS. CHARPOS is the
29051 position of GLYPH in the internal string object. A mode
29052 line string format has structures which are converted to
29053 a flattened string by the Emacs Lisp interpreter. The
29054 internal string is an element of those structures. The
29055 displayed string is the flattened string. */
29056 tmp_glyph
= row_start_glyph
;
29057 while (tmp_glyph
< glyph
29058 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29059 && begpos
<= tmp_glyph
->charpos
29060 && tmp_glyph
->charpos
< endpos
)))
29062 gpos
= glyph
- tmp_glyph
;
29064 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29065 the highlighted part of the displayed string to which
29066 GLYPH belongs. Note: GSEQ_LENGTH is different from
29067 SCHARS (STRING), because the latter returns the length of
29068 the internal string. */
29069 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29071 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29072 && begpos
<= tmp_glyph
->charpos
29073 && tmp_glyph
->charpos
< endpos
));
29076 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29078 /* Calculate the total pixel width of all the glyphs between
29079 the beginning of the highlighted area and GLYPH. */
29080 total_pixel_width
= 0;
29081 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29082 total_pixel_width
+= tmp_glyph
->pixel_width
;
29084 /* Pre calculation of re-rendering position. Note: X is in
29085 column units here, after the call to mode_line_string or
29086 marginal_area_string. */
29088 vpos
= (area
== ON_MODE_LINE
29089 ? (w
->current_matrix
)->nrows
- 1
29092 /* If GLYPH's position is included in the region that is
29093 already drawn in mouse face, we have nothing to do. */
29094 if ( EQ (window
, hlinfo
->mouse_face_window
)
29095 && (!row
->reversed_p
29096 ? (hlinfo
->mouse_face_beg_col
<= hpos
29097 && hpos
< hlinfo
->mouse_face_end_col
)
29098 /* In R2L rows we swap BEG and END, see below. */
29099 : (hlinfo
->mouse_face_end_col
<= hpos
29100 && hpos
< hlinfo
->mouse_face_beg_col
))
29101 && hlinfo
->mouse_face_beg_row
== vpos
)
29104 if (clear_mouse_face (hlinfo
))
29105 cursor
= No_Cursor
;
29107 if (!row
->reversed_p
)
29109 hlinfo
->mouse_face_beg_col
= hpos
;
29110 hlinfo
->mouse_face_beg_x
= original_x_pixel
29111 - (total_pixel_width
+ dx
);
29112 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29113 hlinfo
->mouse_face_end_x
= 0;
29117 /* In R2L rows, show_mouse_face expects BEG and END
29118 coordinates to be swapped. */
29119 hlinfo
->mouse_face_end_col
= hpos
;
29120 hlinfo
->mouse_face_end_x
= original_x_pixel
29121 - (total_pixel_width
+ dx
);
29122 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29123 hlinfo
->mouse_face_beg_x
= 0;
29126 hlinfo
->mouse_face_beg_row
= vpos
;
29127 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29128 hlinfo
->mouse_face_past_end
= 0;
29129 hlinfo
->mouse_face_window
= window
;
29131 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29136 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29138 if (NILP (pointer
))
29141 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29142 clear_mouse_face (hlinfo
);
29144 #ifdef HAVE_WINDOW_SYSTEM
29145 if (FRAME_WINDOW_P (f
))
29146 define_frame_cursor1 (f
, cursor
, pointer
);
29152 Take proper action when the mouse has moved to position X, Y on
29153 frame F with regards to highlighting portions of display that have
29154 mouse-face properties. Also de-highlight portions of display where
29155 the mouse was before, set the mouse pointer shape as appropriate
29156 for the mouse coordinates, and activate help echo (tooltips).
29157 X and Y can be negative or out of range. */
29160 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29162 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29163 enum window_part part
= ON_NOTHING
;
29164 Lisp_Object window
;
29166 Cursor cursor
= No_Cursor
;
29167 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29170 /* When a menu is active, don't highlight because this looks odd. */
29171 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29172 if (popup_activated ())
29176 if (!f
->glyphs_initialized_p
29177 || f
->pointer_invisible
)
29180 hlinfo
->mouse_face_mouse_x
= x
;
29181 hlinfo
->mouse_face_mouse_y
= y
;
29182 hlinfo
->mouse_face_mouse_frame
= f
;
29184 if (hlinfo
->mouse_face_defer
)
29187 /* Which window is that in? */
29188 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
29190 /* If displaying active text in another window, clear that. */
29191 if (! EQ (window
, hlinfo
->mouse_face_window
)
29192 /* Also clear if we move out of text area in same window. */
29193 || (!NILP (hlinfo
->mouse_face_window
)
29196 && part
!= ON_MODE_LINE
29197 && part
!= ON_HEADER_LINE
))
29198 clear_mouse_face (hlinfo
);
29200 /* Not on a window -> return. */
29201 if (!WINDOWP (window
))
29204 /* Reset help_echo_string. It will get recomputed below. */
29205 help_echo_string
= Qnil
;
29207 /* Convert to window-relative pixel coordinates. */
29208 w
= XWINDOW (window
);
29209 frame_to_window_pixel_xy (w
, &x
, &y
);
29211 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29212 /* Handle tool-bar window differently since it doesn't display a
29214 if (EQ (window
, f
->tool_bar_window
))
29216 note_tool_bar_highlight (f
, x
, y
);
29221 /* Mouse is on the mode, header line or margin? */
29222 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29223 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29225 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29227 #ifdef HAVE_WINDOW_SYSTEM
29228 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29230 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29231 /* Show non-text cursor (Bug#16647). */
29239 #ifdef HAVE_WINDOW_SYSTEM
29240 if (part
== ON_VERTICAL_BORDER
)
29242 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29243 help_echo_string
= build_string ("drag-mouse-1: resize");
29245 else if (part
== ON_RIGHT_DIVIDER
)
29247 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29248 help_echo_string
= build_string ("drag-mouse-1: resize");
29250 else if (part
== ON_BOTTOM_DIVIDER
)
29251 if (! WINDOW_BOTTOMMOST_P (w
)
29253 || NILP (Vresize_mini_windows
))
29255 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29256 help_echo_string
= build_string ("drag-mouse-1: resize");
29259 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29260 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
29261 || part
== ON_SCROLL_BAR
)
29262 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29264 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29267 /* Are we in a window whose display is up to date?
29268 And verify the buffer's text has not changed. */
29269 b
= XBUFFER (w
->contents
);
29270 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
29272 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
29274 struct glyph
*glyph
;
29275 Lisp_Object object
;
29276 Lisp_Object mouse_face
= Qnil
, position
;
29277 Lisp_Object
*overlay_vec
= NULL
;
29278 ptrdiff_t i
, noverlays
;
29279 struct buffer
*obuf
;
29280 ptrdiff_t obegv
, ozv
;
29283 /* Find the glyph under X/Y. */
29284 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
29286 #ifdef HAVE_WINDOW_SYSTEM
29287 /* Look for :pointer property on image. */
29288 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29290 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29291 if (img
!= NULL
&& IMAGEP (img
->spec
))
29293 Lisp_Object image_map
, hotspot
;
29294 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29296 && (hotspot
= find_hot_spot (image_map
,
29297 glyph
->slice
.img
.x
+ dx
,
29298 glyph
->slice
.img
.y
+ dy
),
29300 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29304 /* Could check XCAR (hotspot) to see if we enter/leave
29306 If so, we could look for mouse-enter, mouse-leave
29307 properties in PLIST (and do something...). */
29308 hotspot
= XCDR (hotspot
);
29309 if (CONSP (hotspot
)
29310 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29312 pointer
= Fplist_get (plist
, Qpointer
);
29313 if (NILP (pointer
))
29315 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29316 if (!NILP (help_echo_string
))
29318 help_echo_window
= window
;
29319 help_echo_object
= glyph
->object
;
29320 help_echo_pos
= glyph
->charpos
;
29324 if (NILP (pointer
))
29325 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29328 #endif /* HAVE_WINDOW_SYSTEM */
29330 /* Clear mouse face if X/Y not over text. */
29332 || area
!= TEXT_AREA
29333 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29334 /* Glyph's OBJECT is an integer for glyphs inserted by the
29335 display engine for its internal purposes, like truncation
29336 and continuation glyphs and blanks beyond the end of
29337 line's text on text terminals. If we are over such a
29338 glyph, we are not over any text. */
29339 || INTEGERP (glyph
->object
)
29340 /* R2L rows have a stretch glyph at their front, which
29341 stands for no text, whereas L2R rows have no glyphs at
29342 all beyond the end of text. Treat such stretch glyphs
29343 like we do with NULL glyphs in L2R rows. */
29344 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29345 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29346 && glyph
->type
== STRETCH_GLYPH
29347 && glyph
->avoid_cursor_p
))
29349 if (clear_mouse_face (hlinfo
))
29350 cursor
= No_Cursor
;
29351 #ifdef HAVE_WINDOW_SYSTEM
29352 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29354 if (area
!= TEXT_AREA
)
29355 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29357 pointer
= Vvoid_text_area_pointer
;
29363 pos
= glyph
->charpos
;
29364 object
= glyph
->object
;
29365 if (!STRINGP (object
) && !BUFFERP (object
))
29368 /* If we get an out-of-range value, return now; avoid an error. */
29369 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29372 /* Make the window's buffer temporarily current for
29373 overlays_at and compute_char_face. */
29374 obuf
= current_buffer
;
29375 current_buffer
= b
;
29381 /* Is this char mouse-active or does it have help-echo? */
29382 position
= make_number (pos
);
29384 if (BUFFERP (object
))
29386 /* Put all the overlays we want in a vector in overlay_vec. */
29387 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
29388 /* Sort overlays into increasing priority order. */
29389 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29394 if (NILP (Vmouse_highlight
))
29396 clear_mouse_face (hlinfo
);
29397 goto check_help_echo
;
29400 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29403 cursor
= No_Cursor
;
29405 /* Check mouse-face highlighting. */
29407 /* If there exists an overlay with mouse-face overlapping
29408 the one we are currently highlighting, we have to
29409 check if we enter the overlapping overlay, and then
29410 highlight only that. */
29411 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29412 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29414 /* Find the highest priority overlay with a mouse-face. */
29415 Lisp_Object overlay
= Qnil
;
29416 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29418 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29419 if (!NILP (mouse_face
))
29420 overlay
= overlay_vec
[i
];
29423 /* If we're highlighting the same overlay as before, there's
29424 no need to do that again. */
29425 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29426 goto check_help_echo
;
29427 hlinfo
->mouse_face_overlay
= overlay
;
29429 /* Clear the display of the old active region, if any. */
29430 if (clear_mouse_face (hlinfo
))
29431 cursor
= No_Cursor
;
29433 /* If no overlay applies, get a text property. */
29434 if (NILP (overlay
))
29435 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29437 /* Next, compute the bounds of the mouse highlighting and
29439 if (!NILP (mouse_face
) && STRINGP (object
))
29441 /* The mouse-highlighting comes from a display string
29442 with a mouse-face. */
29446 s
= Fprevious_single_property_change
29447 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29448 e
= Fnext_single_property_change
29449 (position
, Qmouse_face
, object
, Qnil
);
29451 s
= make_number (0);
29453 e
= make_number (SCHARS (object
));
29454 mouse_face_from_string_pos (w
, hlinfo
, object
,
29455 XINT (s
), XINT (e
));
29456 hlinfo
->mouse_face_past_end
= 0;
29457 hlinfo
->mouse_face_window
= window
;
29458 hlinfo
->mouse_face_face_id
29459 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29460 glyph
->face_id
, 1);
29461 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29462 cursor
= No_Cursor
;
29466 /* The mouse-highlighting, if any, comes from an overlay
29467 or text property in the buffer. */
29468 Lisp_Object buffer
IF_LINT (= Qnil
);
29469 Lisp_Object disp_string
IF_LINT (= Qnil
);
29471 if (STRINGP (object
))
29473 /* If we are on a display string with no mouse-face,
29474 check if the text under it has one. */
29475 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29476 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29477 pos
= string_buffer_position (object
, start
);
29480 mouse_face
= get_char_property_and_overlay
29481 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29482 buffer
= w
->contents
;
29483 disp_string
= object
;
29489 disp_string
= Qnil
;
29492 if (!NILP (mouse_face
))
29494 Lisp_Object before
, after
;
29495 Lisp_Object before_string
, after_string
;
29496 /* To correctly find the limits of mouse highlight
29497 in a bidi-reordered buffer, we must not use the
29498 optimization of limiting the search in
29499 previous-single-property-change and
29500 next-single-property-change, because
29501 rows_from_pos_range needs the real start and end
29502 positions to DTRT in this case. That's because
29503 the first row visible in a window does not
29504 necessarily display the character whose position
29505 is the smallest. */
29507 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29508 ? Fmarker_position (w
->start
)
29511 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29512 ? make_number (BUF_Z (XBUFFER (buffer
))
29513 - w
->window_end_pos
)
29516 if (NILP (overlay
))
29518 /* Handle the text property case. */
29519 before
= Fprevious_single_property_change
29520 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29521 after
= Fnext_single_property_change
29522 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29523 before_string
= after_string
= Qnil
;
29527 /* Handle the overlay case. */
29528 before
= Foverlay_start (overlay
);
29529 after
= Foverlay_end (overlay
);
29530 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29531 after_string
= Foverlay_get (overlay
, Qafter_string
);
29533 if (!STRINGP (before_string
)) before_string
= Qnil
;
29534 if (!STRINGP (after_string
)) after_string
= Qnil
;
29537 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29540 : XFASTINT (before
),
29542 ? BUF_Z (XBUFFER (buffer
))
29543 : XFASTINT (after
),
29544 before_string
, after_string
,
29546 cursor
= No_Cursor
;
29553 /* Look for a `help-echo' property. */
29554 if (NILP (help_echo_string
)) {
29555 Lisp_Object help
, overlay
;
29557 /* Check overlays first. */
29558 help
= overlay
= Qnil
;
29559 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29561 overlay
= overlay_vec
[i
];
29562 help
= Foverlay_get (overlay
, Qhelp_echo
);
29567 help_echo_string
= help
;
29568 help_echo_window
= window
;
29569 help_echo_object
= overlay
;
29570 help_echo_pos
= pos
;
29574 Lisp_Object obj
= glyph
->object
;
29575 ptrdiff_t charpos
= glyph
->charpos
;
29577 /* Try text properties. */
29580 && charpos
< SCHARS (obj
))
29582 help
= Fget_text_property (make_number (charpos
),
29586 /* If the string itself doesn't specify a help-echo,
29587 see if the buffer text ``under'' it does. */
29588 struct glyph_row
*r
29589 = MATRIX_ROW (w
->current_matrix
, vpos
);
29590 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29591 ptrdiff_t p
= string_buffer_position (obj
, start
);
29594 help
= Fget_char_property (make_number (p
),
29595 Qhelp_echo
, w
->contents
);
29604 else if (BUFFERP (obj
)
29607 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
29612 help_echo_string
= help
;
29613 help_echo_window
= window
;
29614 help_echo_object
= obj
;
29615 help_echo_pos
= charpos
;
29620 #ifdef HAVE_WINDOW_SYSTEM
29621 /* Look for a `pointer' property. */
29622 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29624 /* Check overlays first. */
29625 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
29626 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
29628 if (NILP (pointer
))
29630 Lisp_Object obj
= glyph
->object
;
29631 ptrdiff_t charpos
= glyph
->charpos
;
29633 /* Try text properties. */
29636 && charpos
< SCHARS (obj
))
29638 pointer
= Fget_text_property (make_number (charpos
),
29640 if (NILP (pointer
))
29642 /* If the string itself doesn't specify a pointer,
29643 see if the buffer text ``under'' it does. */
29644 struct glyph_row
*r
29645 = MATRIX_ROW (w
->current_matrix
, vpos
);
29646 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29647 ptrdiff_t p
= string_buffer_position (obj
, start
);
29649 pointer
= Fget_char_property (make_number (p
),
29650 Qpointer
, w
->contents
);
29653 else if (BUFFERP (obj
)
29656 pointer
= Fget_text_property (make_number (charpos
),
29660 #endif /* HAVE_WINDOW_SYSTEM */
29664 current_buffer
= obuf
;
29669 #ifdef HAVE_WINDOW_SYSTEM
29670 if (FRAME_WINDOW_P (f
))
29671 define_frame_cursor1 (f
, cursor
, pointer
);
29673 /* This is here to prevent a compiler error, about "label at end of
29674 compound statement". */
29681 Clear any mouse-face on window W. This function is part of the
29682 redisplay interface, and is called from try_window_id and similar
29683 functions to ensure the mouse-highlight is off. */
29686 x_clear_window_mouse_face (struct window
*w
)
29688 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
29689 Lisp_Object window
;
29692 XSETWINDOW (window
, w
);
29693 if (EQ (window
, hlinfo
->mouse_face_window
))
29694 clear_mouse_face (hlinfo
);
29700 Just discard the mouse face information for frame F, if any.
29701 This is used when the size of F is changed. */
29704 cancel_mouse_face (struct frame
*f
)
29706 Lisp_Object window
;
29707 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29709 window
= hlinfo
->mouse_face_window
;
29710 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
29711 reset_mouse_highlight (hlinfo
);
29716 /***********************************************************************
29718 ***********************************************************************/
29720 #ifdef HAVE_WINDOW_SYSTEM
29722 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
29723 which intersects rectangle R. R is in window-relative coordinates. */
29726 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
29727 enum glyph_row_area area
)
29729 struct glyph
*first
= row
->glyphs
[area
];
29730 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
29731 struct glyph
*last
;
29732 int first_x
, start_x
, x
;
29734 if (area
== TEXT_AREA
&& row
->fill_line_p
)
29735 /* If row extends face to end of line write the whole line. */
29736 draw_glyphs (w
, 0, row
, area
,
29737 0, row
->used
[area
],
29738 DRAW_NORMAL_TEXT
, 0);
29741 /* Set START_X to the window-relative start position for drawing glyphs of
29742 AREA. The first glyph of the text area can be partially visible.
29743 The first glyphs of other areas cannot. */
29744 start_x
= window_box_left_offset (w
, area
);
29746 if (area
== TEXT_AREA
)
29749 /* Find the first glyph that must be redrawn. */
29751 && x
+ first
->pixel_width
< r
->x
)
29753 x
+= first
->pixel_width
;
29757 /* Find the last one. */
29761 && x
< r
->x
+ r
->width
)
29763 x
+= last
->pixel_width
;
29769 draw_glyphs (w
, first_x
- start_x
, row
, area
,
29770 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
29771 DRAW_NORMAL_TEXT
, 0);
29776 /* Redraw the parts of the glyph row ROW on window W intersecting
29777 rectangle R. R is in window-relative coordinates. Value is
29778 non-zero if mouse-face was overwritten. */
29781 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
29783 eassert (row
->enabled_p
);
29785 if (row
->mode_line_p
|| w
->pseudo_window_p
)
29786 draw_glyphs (w
, 0, row
, TEXT_AREA
,
29787 0, row
->used
[TEXT_AREA
],
29788 DRAW_NORMAL_TEXT
, 0);
29791 if (row
->used
[LEFT_MARGIN_AREA
])
29792 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
29793 if (row
->used
[TEXT_AREA
])
29794 expose_area (w
, row
, r
, TEXT_AREA
);
29795 if (row
->used
[RIGHT_MARGIN_AREA
])
29796 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
29797 draw_row_fringe_bitmaps (w
, row
);
29800 return row
->mouse_face_p
;
29804 /* Redraw those parts of glyphs rows during expose event handling that
29805 overlap other rows. Redrawing of an exposed line writes over parts
29806 of lines overlapping that exposed line; this function fixes that.
29808 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
29809 row in W's current matrix that is exposed and overlaps other rows.
29810 LAST_OVERLAPPING_ROW is the last such row. */
29813 expose_overlaps (struct window
*w
,
29814 struct glyph_row
*first_overlapping_row
,
29815 struct glyph_row
*last_overlapping_row
,
29818 struct glyph_row
*row
;
29820 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
29821 if (row
->overlapping_p
)
29823 eassert (row
->enabled_p
&& !row
->mode_line_p
);
29826 if (row
->used
[LEFT_MARGIN_AREA
])
29827 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
29829 if (row
->used
[TEXT_AREA
])
29830 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
29832 if (row
->used
[RIGHT_MARGIN_AREA
])
29833 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
29839 /* Return non-zero if W's cursor intersects rectangle R. */
29842 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
29844 XRectangle cr
, result
;
29845 struct glyph
*cursor_glyph
;
29846 struct glyph_row
*row
;
29848 if (w
->phys_cursor
.vpos
>= 0
29849 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
29850 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
29852 && row
->cursor_in_fringe_p
)
29854 /* Cursor is in the fringe. */
29855 cr
.x
= window_box_right_offset (w
,
29856 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
29857 ? RIGHT_MARGIN_AREA
29860 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
29861 cr
.height
= row
->height
;
29862 return x_intersect_rectangles (&cr
, r
, &result
);
29865 cursor_glyph
= get_phys_cursor_glyph (w
);
29868 /* r is relative to W's box, but w->phys_cursor.x is relative
29869 to left edge of W's TEXT area. Adjust it. */
29870 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
29871 cr
.y
= w
->phys_cursor
.y
;
29872 cr
.width
= cursor_glyph
->pixel_width
;
29873 cr
.height
= w
->phys_cursor_height
;
29874 /* ++KFS: W32 version used W32-specific IntersectRect here, but
29875 I assume the effect is the same -- and this is portable. */
29876 return x_intersect_rectangles (&cr
, r
, &result
);
29878 /* If we don't understand the format, pretend we're not in the hot-spot. */
29884 Draw a vertical window border to the right of window W if W doesn't
29885 have vertical scroll bars. */
29888 x_draw_vertical_border (struct window
*w
)
29890 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29892 /* We could do better, if we knew what type of scroll-bar the adjacent
29893 windows (on either side) have... But we don't :-(
29894 However, I think this works ok. ++KFS 2003-04-25 */
29896 /* Redraw borders between horizontally adjacent windows. Don't
29897 do it for frames with vertical scroll bars because either the
29898 right scroll bar of a window, or the left scroll bar of its
29899 neighbor will suffice as a border. */
29900 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
29903 /* Note: It is necessary to redraw both the left and the right
29904 borders, for when only this single window W is being
29906 if (!WINDOW_RIGHTMOST_P (w
)
29907 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
29909 int x0
, x1
, y0
, y1
;
29911 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29914 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29917 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
29920 if (!WINDOW_LEFTMOST_P (w
)
29921 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
29923 int x0
, x1
, y0
, y1
;
29925 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29928 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29931 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
29936 /* Draw window dividers for window W. */
29939 x_draw_right_divider (struct window
*w
)
29941 struct frame
*f
= WINDOW_XFRAME (w
);
29943 if (w
->mini
|| w
->pseudo_window_p
)
29945 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
29947 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
29948 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29949 int y0
= WINDOW_TOP_EDGE_Y (w
);
29950 /* The bottom divider prevails. */
29951 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29953 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29958 x_draw_bottom_divider (struct window
*w
)
29960 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29962 if (w
->mini
|| w
->pseudo_window_p
)
29964 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
29966 int x0
= WINDOW_LEFT_EDGE_X (w
);
29967 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29968 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29969 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
29971 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29975 /* Redraw the part of window W intersection rectangle FR. Pixel
29976 coordinates in FR are frame-relative. Call this function with
29977 input blocked. Value is non-zero if the exposure overwrites
29981 expose_window (struct window
*w
, XRectangle
*fr
)
29983 struct frame
*f
= XFRAME (w
->frame
);
29985 int mouse_face_overwritten_p
= 0;
29987 /* If window is not yet fully initialized, do nothing. This can
29988 happen when toolkit scroll bars are used and a window is split.
29989 Reconfiguring the scroll bar will generate an expose for a newly
29991 if (w
->current_matrix
== NULL
)
29994 /* When we're currently updating the window, display and current
29995 matrix usually don't agree. Arrange for a thorough display
29997 if (w
->must_be_updated_p
)
29999 SET_FRAME_GARBAGED (f
);
30003 /* Frame-relative pixel rectangle of W. */
30004 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30005 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30006 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30007 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30009 if (x_intersect_rectangles (fr
, &wr
, &r
))
30011 int yb
= window_text_bottom_y (w
);
30012 struct glyph_row
*row
;
30013 int cursor_cleared_p
, phys_cursor_on_p
;
30014 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30016 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30017 r
.x
, r
.y
, r
.width
, r
.height
));
30019 /* Convert to window coordinates. */
30020 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
30021 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
30023 /* Turn off the cursor. */
30024 if (!w
->pseudo_window_p
30025 && phys_cursor_in_rect_p (w
, &r
))
30027 x_clear_cursor (w
);
30028 cursor_cleared_p
= 1;
30031 cursor_cleared_p
= 0;
30033 /* If the row containing the cursor extends face to end of line,
30034 then expose_area might overwrite the cursor outside the
30035 rectangle and thus notice_overwritten_cursor might clear
30036 w->phys_cursor_on_p. We remember the original value and
30037 check later if it is changed. */
30038 phys_cursor_on_p
= w
->phys_cursor_on_p
;
30040 /* Update lines intersecting rectangle R. */
30041 first_overlapping_row
= last_overlapping_row
= NULL
;
30042 for (row
= w
->current_matrix
->rows
;
30047 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30049 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
30050 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
30051 || (r
.y
>= y0
&& r
.y
< y1
)
30052 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
30054 /* A header line may be overlapping, but there is no need
30055 to fix overlapping areas for them. KFS 2005-02-12 */
30056 if (row
->overlapping_p
&& !row
->mode_line_p
)
30058 if (first_overlapping_row
== NULL
)
30059 first_overlapping_row
= row
;
30060 last_overlapping_row
= row
;
30064 if (expose_line (w
, row
, &r
))
30065 mouse_face_overwritten_p
= 1;
30068 else if (row
->overlapping_p
)
30070 /* We must redraw a row overlapping the exposed area. */
30072 ? y0
+ row
->phys_height
> r
.y
30073 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30075 if (first_overlapping_row
== NULL
)
30076 first_overlapping_row
= row
;
30077 last_overlapping_row
= row
;
30085 /* Display the mode line if there is one. */
30086 if (WINDOW_WANTS_MODELINE_P (w
)
30087 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30089 && row
->y
< r
.y
+ r
.height
)
30091 if (expose_line (w
, row
, &r
))
30092 mouse_face_overwritten_p
= 1;
30095 if (!w
->pseudo_window_p
)
30097 /* Fix the display of overlapping rows. */
30098 if (first_overlapping_row
)
30099 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30102 /* Draw border between windows. */
30103 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30104 x_draw_right_divider (w
);
30106 x_draw_vertical_border (w
);
30108 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30109 x_draw_bottom_divider (w
);
30111 /* Turn the cursor on again. */
30112 if (cursor_cleared_p
30113 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30114 update_window_cursor (w
, 1);
30118 return mouse_face_overwritten_p
;
30123 /* Redraw (parts) of all windows in the window tree rooted at W that
30124 intersect R. R contains frame pixel coordinates. Value is
30125 non-zero if the exposure overwrites mouse-face. */
30128 expose_window_tree (struct window
*w
, XRectangle
*r
)
30130 struct frame
*f
= XFRAME (w
->frame
);
30131 int mouse_face_overwritten_p
= 0;
30133 while (w
&& !FRAME_GARBAGED_P (f
))
30135 if (WINDOWP (w
->contents
))
30136 mouse_face_overwritten_p
30137 |= expose_window_tree (XWINDOW (w
->contents
), r
);
30139 mouse_face_overwritten_p
|= expose_window (w
, r
);
30141 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30144 return mouse_face_overwritten_p
;
30149 Redisplay an exposed area of frame F. X and Y are the upper-left
30150 corner of the exposed rectangle. W and H are width and height of
30151 the exposed area. All are pixel values. W or H zero means redraw
30152 the entire frame. */
30155 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30158 int mouse_face_overwritten_p
= 0;
30160 TRACE ((stderr
, "expose_frame "));
30162 /* No need to redraw if frame will be redrawn soon. */
30163 if (FRAME_GARBAGED_P (f
))
30165 TRACE ((stderr
, " garbaged\n"));
30169 /* If basic faces haven't been realized yet, there is no point in
30170 trying to redraw anything. This can happen when we get an expose
30171 event while Emacs is starting, e.g. by moving another window. */
30172 if (FRAME_FACE_CACHE (f
) == NULL
30173 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30175 TRACE ((stderr
, " no faces\n"));
30179 if (w
== 0 || h
== 0)
30182 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
30183 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
30193 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30194 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30196 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30197 if (WINDOWP (f
->tool_bar_window
))
30198 mouse_face_overwritten_p
30199 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30202 #ifdef HAVE_X_WINDOWS
30204 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30205 if (WINDOWP (f
->menu_bar_window
))
30206 mouse_face_overwritten_p
30207 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30208 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30212 /* Some window managers support a focus-follows-mouse style with
30213 delayed raising of frames. Imagine a partially obscured frame,
30214 and moving the mouse into partially obscured mouse-face on that
30215 frame. The visible part of the mouse-face will be highlighted,
30216 then the WM raises the obscured frame. With at least one WM, KDE
30217 2.1, Emacs is not getting any event for the raising of the frame
30218 (even tried with SubstructureRedirectMask), only Expose events.
30219 These expose events will draw text normally, i.e. not
30220 highlighted. Which means we must redo the highlight here.
30221 Subsume it under ``we love X''. --gerd 2001-08-15 */
30222 /* Included in Windows version because Windows most likely does not
30223 do the right thing if any third party tool offers
30224 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30225 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
30227 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30228 if (f
== hlinfo
->mouse_face_mouse_frame
)
30230 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
30231 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
30232 clear_mouse_face (hlinfo
);
30233 note_mouse_highlight (f
, mouse_x
, mouse_y
);
30240 Determine the intersection of two rectangles R1 and R2. Return
30241 the intersection in *RESULT. Value is non-zero if RESULT is not
30245 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
30247 XRectangle
*left
, *right
;
30248 XRectangle
*upper
, *lower
;
30249 int intersection_p
= 0;
30251 /* Rearrange so that R1 is the left-most rectangle. */
30253 left
= r1
, right
= r2
;
30255 left
= r2
, right
= r1
;
30257 /* X0 of the intersection is right.x0, if this is inside R1,
30258 otherwise there is no intersection. */
30259 if (right
->x
<= left
->x
+ left
->width
)
30261 result
->x
= right
->x
;
30263 /* The right end of the intersection is the minimum of
30264 the right ends of left and right. */
30265 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
30268 /* Same game for Y. */
30270 upper
= r1
, lower
= r2
;
30272 upper
= r2
, lower
= r1
;
30274 /* The upper end of the intersection is lower.y0, if this is inside
30275 of upper. Otherwise, there is no intersection. */
30276 if (lower
->y
<= upper
->y
+ upper
->height
)
30278 result
->y
= lower
->y
;
30280 /* The lower end of the intersection is the minimum of the lower
30281 ends of upper and lower. */
30282 result
->height
= (min (lower
->y
+ lower
->height
,
30283 upper
->y
+ upper
->height
)
30285 intersection_p
= 1;
30289 return intersection_p
;
30292 #endif /* HAVE_WINDOW_SYSTEM */
30295 /***********************************************************************
30297 ***********************************************************************/
30300 syms_of_xdisp (void)
30302 Vwith_echo_area_save_vector
= Qnil
;
30303 staticpro (&Vwith_echo_area_save_vector
);
30305 Vmessage_stack
= Qnil
;
30306 staticpro (&Vmessage_stack
);
30308 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30309 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30311 message_dolog_marker1
= Fmake_marker ();
30312 staticpro (&message_dolog_marker1
);
30313 message_dolog_marker2
= Fmake_marker ();
30314 staticpro (&message_dolog_marker2
);
30315 message_dolog_marker3
= Fmake_marker ();
30316 staticpro (&message_dolog_marker3
);
30319 defsubr (&Sdump_frame_glyph_matrix
);
30320 defsubr (&Sdump_glyph_matrix
);
30321 defsubr (&Sdump_glyph_row
);
30322 defsubr (&Sdump_tool_bar_row
);
30323 defsubr (&Strace_redisplay
);
30324 defsubr (&Strace_to_stderr
);
30326 #ifdef HAVE_WINDOW_SYSTEM
30327 defsubr (&Stool_bar_height
);
30328 defsubr (&Slookup_image_map
);
30330 defsubr (&Sline_pixel_height
);
30331 defsubr (&Sformat_mode_line
);
30332 defsubr (&Sinvisible_p
);
30333 defsubr (&Scurrent_bidi_paragraph_direction
);
30334 defsubr (&Swindow_text_pixel_size
);
30335 defsubr (&Smove_point_visually
);
30337 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30338 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30339 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30340 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30341 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30342 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30343 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30344 DEFSYM (Qeval
, "eval");
30345 DEFSYM (QCdata
, ":data");
30346 DEFSYM (Qdisplay
, "display");
30347 DEFSYM (Qspace_width
, "space-width");
30348 DEFSYM (Qraise
, "raise");
30349 DEFSYM (Qslice
, "slice");
30350 DEFSYM (Qspace
, "space");
30351 DEFSYM (Qmargin
, "margin");
30352 DEFSYM (Qpointer
, "pointer");
30353 DEFSYM (Qleft_margin
, "left-margin");
30354 DEFSYM (Qright_margin
, "right-margin");
30355 DEFSYM (Qcenter
, "center");
30356 DEFSYM (Qline_height
, "line-height");
30357 DEFSYM (QCalign_to
, ":align-to");
30358 DEFSYM (QCrelative_width
, ":relative-width");
30359 DEFSYM (QCrelative_height
, ":relative-height");
30360 DEFSYM (QCeval
, ":eval");
30361 DEFSYM (QCpropertize
, ":propertize");
30362 DEFSYM (QCfile
, ":file");
30363 DEFSYM (Qfontified
, "fontified");
30364 DEFSYM (Qfontification_functions
, "fontification-functions");
30365 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30366 DEFSYM (Qescape_glyph
, "escape-glyph");
30367 DEFSYM (Qnobreak_space
, "nobreak-space");
30368 DEFSYM (Qimage
, "image");
30369 DEFSYM (Qtext
, "text");
30370 DEFSYM (Qboth
, "both");
30371 DEFSYM (Qboth_horiz
, "both-horiz");
30372 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30373 DEFSYM (QCmap
, ":map");
30374 DEFSYM (QCpointer
, ":pointer");
30375 DEFSYM (Qrect
, "rect");
30376 DEFSYM (Qcircle
, "circle");
30377 DEFSYM (Qpoly
, "poly");
30378 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
30379 DEFSYM (Qgrow_only
, "grow-only");
30380 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30381 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30382 DEFSYM (Qposition
, "position");
30383 DEFSYM (Qbuffer_position
, "buffer-position");
30384 DEFSYM (Qobject
, "object");
30385 DEFSYM (Qbar
, "bar");
30386 DEFSYM (Qhbar
, "hbar");
30387 DEFSYM (Qbox
, "box");
30388 DEFSYM (Qhollow
, "hollow");
30389 DEFSYM (Qhand
, "hand");
30390 DEFSYM (Qarrow
, "arrow");
30391 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30393 list_of_error
= list1 (list2 (intern_c_string ("error"),
30394 intern_c_string ("void-variable")));
30395 staticpro (&list_of_error
);
30397 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30398 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30399 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30400 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30402 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30403 staticpro (&echo_buffer
[0]);
30404 staticpro (&echo_buffer
[1]);
30406 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30407 staticpro (&echo_area_buffer
[0]);
30408 staticpro (&echo_area_buffer
[1]);
30410 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30411 staticpro (&Vmessages_buffer_name
);
30413 mode_line_proptrans_alist
= Qnil
;
30414 staticpro (&mode_line_proptrans_alist
);
30415 mode_line_string_list
= Qnil
;
30416 staticpro (&mode_line_string_list
);
30417 mode_line_string_face
= Qnil
;
30418 staticpro (&mode_line_string_face
);
30419 mode_line_string_face_prop
= Qnil
;
30420 staticpro (&mode_line_string_face_prop
);
30421 Vmode_line_unwind_vector
= Qnil
;
30422 staticpro (&Vmode_line_unwind_vector
);
30424 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30426 help_echo_string
= Qnil
;
30427 staticpro (&help_echo_string
);
30428 help_echo_object
= Qnil
;
30429 staticpro (&help_echo_object
);
30430 help_echo_window
= Qnil
;
30431 staticpro (&help_echo_window
);
30432 previous_help_echo_string
= Qnil
;
30433 staticpro (&previous_help_echo_string
);
30434 help_echo_pos
= -1;
30436 DEFSYM (Qright_to_left
, "right-to-left");
30437 DEFSYM (Qleft_to_right
, "left-to-right");
30439 #ifdef HAVE_WINDOW_SYSTEM
30440 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30441 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30442 For example, if a block cursor is over a tab, it will be drawn as
30443 wide as that tab on the display. */);
30444 x_stretch_cursor_p
= 0;
30447 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30448 doc
: /* Non-nil means highlight trailing whitespace.
30449 The face used for trailing whitespace is `trailing-whitespace'. */);
30450 Vshow_trailing_whitespace
= Qnil
;
30452 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30453 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30454 If the value is t, Emacs highlights non-ASCII chars which have the
30455 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30456 or `escape-glyph' face respectively.
30458 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30459 U+2011 (non-breaking hyphen) are affected.
30461 Any other non-nil value means to display these characters as a escape
30462 glyph followed by an ordinary space or hyphen.
30464 A value of nil means no special handling of these characters. */);
30465 Vnobreak_char_display
= Qt
;
30467 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30468 doc
: /* The pointer shape to show in void text areas.
30469 A value of nil means to show the text pointer. Other options are `arrow',
30470 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
30471 Vvoid_text_area_pointer
= Qarrow
;
30473 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30474 doc
: /* Non-nil means don't actually do any redisplay.
30475 This is used for internal purposes. */);
30476 Vinhibit_redisplay
= Qnil
;
30478 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30479 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30480 Vglobal_mode_string
= Qnil
;
30482 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30483 doc
: /* Marker for where to display an arrow on top of the buffer text.
30484 This must be the beginning of a line in order to work.
30485 See also `overlay-arrow-string'. */);
30486 Voverlay_arrow_position
= Qnil
;
30488 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30489 doc
: /* String to display as an arrow in non-window frames.
30490 See also `overlay-arrow-position'. */);
30491 Voverlay_arrow_string
= build_pure_c_string ("=>");
30493 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30494 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30495 The symbols on this list are examined during redisplay to determine
30496 where to display overlay arrows. */);
30497 Voverlay_arrow_variable_list
30498 = list1 (intern_c_string ("overlay-arrow-position"));
30500 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30501 doc
: /* The number of lines to try scrolling a window by when point moves out.
30502 If that fails to bring point back on frame, point is centered instead.
30503 If this is zero, point is always centered after it moves off frame.
30504 If you want scrolling to always be a line at a time, you should set
30505 `scroll-conservatively' to a large value rather than set this to 1. */);
30507 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30508 doc
: /* Scroll up to this many lines, to bring point back on screen.
30509 If point moves off-screen, redisplay will scroll by up to
30510 `scroll-conservatively' lines in order to bring point just barely
30511 onto the screen again. If that cannot be done, then redisplay
30512 recenters point as usual.
30514 If the value is greater than 100, redisplay will never recenter point,
30515 but will always scroll just enough text to bring point into view, even
30516 if you move far away.
30518 A value of zero means always recenter point if it moves off screen. */);
30519 scroll_conservatively
= 0;
30521 DEFVAR_INT ("scroll-margin", scroll_margin
,
30522 doc
: /* Number of lines of margin at the top and bottom of a window.
30523 Recenter the window whenever point gets within this many lines
30524 of the top or bottom of the window. */);
30527 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
30528 doc
: /* Pixels per inch value for non-window system displays.
30529 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30530 Vdisplay_pixels_per_inch
= make_float (72.0);
30533 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
30536 DEFVAR_LISP ("truncate-partial-width-windows",
30537 Vtruncate_partial_width_windows
,
30538 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
30539 For an integer value, truncate lines in each window narrower than the
30540 full frame width, provided the window width is less than that integer;
30541 otherwise, respect the value of `truncate-lines'.
30543 For any other non-nil value, truncate lines in all windows that do
30544 not span the full frame width.
30546 A value of nil means to respect the value of `truncate-lines'.
30548 If `word-wrap' is enabled, you might want to reduce this. */);
30549 Vtruncate_partial_width_windows
= make_number (50);
30551 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
30552 doc
: /* Maximum buffer size for which line number should be displayed.
30553 If the buffer is bigger than this, the line number does not appear
30554 in the mode line. A value of nil means no limit. */);
30555 Vline_number_display_limit
= Qnil
;
30557 DEFVAR_INT ("line-number-display-limit-width",
30558 line_number_display_limit_width
,
30559 doc
: /* Maximum line width (in characters) for line number display.
30560 If the average length of the lines near point is bigger than this, then the
30561 line number may be omitted from the mode line. */);
30562 line_number_display_limit_width
= 200;
30564 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
30565 doc
: /* Non-nil means highlight region even in nonselected windows. */);
30566 highlight_nonselected_windows
= 0;
30568 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
30569 doc
: /* Non-nil if more than one frame is visible on this display.
30570 Minibuffer-only frames don't count, but iconified frames do.
30571 This variable is not guaranteed to be accurate except while processing
30572 `frame-title-format' and `icon-title-format'. */);
30574 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
30575 doc
: /* Template for displaying the title bar of visible frames.
30576 \(Assuming the window manager supports this feature.)
30578 This variable has the same structure as `mode-line-format', except that
30579 the %c and %l constructs are ignored. It is used only on frames for
30580 which no explicit name has been set \(see `modify-frame-parameters'). */);
30582 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
30583 doc
: /* Template for displaying the title bar of an iconified frame.
30584 \(Assuming the window manager supports this feature.)
30585 This variable has the same structure as `mode-line-format' (which see),
30586 and is used only on frames for which no explicit name has been set
30587 \(see `modify-frame-parameters'). */);
30589 = Vframe_title_format
30590 = listn (CONSTYPE_PURE
, 3,
30591 intern_c_string ("multiple-frames"),
30592 build_pure_c_string ("%b"),
30593 listn (CONSTYPE_PURE
, 4,
30594 empty_unibyte_string
,
30595 intern_c_string ("invocation-name"),
30596 build_pure_c_string ("@"),
30597 intern_c_string ("system-name")));
30599 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
30600 doc
: /* Maximum number of lines to keep in the message log buffer.
30601 If nil, disable message logging. If t, log messages but don't truncate
30602 the buffer when it becomes large. */);
30603 Vmessage_log_max
= make_number (1000);
30605 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
30606 doc
: /* Functions called before redisplay, if window sizes have changed.
30607 The value should be a list of functions that take one argument.
30608 Just before redisplay, for each frame, if any of its windows have changed
30609 size since the last redisplay, or have been split or deleted,
30610 all the functions in the list are called, with the frame as argument. */);
30611 Vwindow_size_change_functions
= Qnil
;
30613 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
30614 doc
: /* List of functions to call before redisplaying a window with scrolling.
30615 Each function is called with two arguments, the window and its new
30616 display-start position. Note that these functions are also called by
30617 `set-window-buffer'. Also note that the value of `window-end' is not
30618 valid when these functions are called.
30620 Warning: Do not use this feature to alter the way the window
30621 is scrolled. It is not designed for that, and such use probably won't
30623 Vwindow_scroll_functions
= Qnil
;
30625 DEFVAR_LISP ("window-text-change-functions",
30626 Vwindow_text_change_functions
,
30627 doc
: /* Functions to call in redisplay when text in the window might change. */);
30628 Vwindow_text_change_functions
= Qnil
;
30630 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
30631 doc
: /* Functions called when redisplay of a window reaches the end trigger.
30632 Each function is called with two arguments, the window and the end trigger value.
30633 See `set-window-redisplay-end-trigger'. */);
30634 Vredisplay_end_trigger_functions
= Qnil
;
30636 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
30637 doc
: /* Non-nil means autoselect window with mouse pointer.
30638 If nil, do not autoselect windows.
30639 A positive number means delay autoselection by that many seconds: a
30640 window is autoselected only after the mouse has remained in that
30641 window for the duration of the delay.
30642 A negative number has a similar effect, but causes windows to be
30643 autoselected only after the mouse has stopped moving. \(Because of
30644 the way Emacs compares mouse events, you will occasionally wait twice
30645 that time before the window gets selected.\)
30646 Any other value means to autoselect window instantaneously when the
30647 mouse pointer enters it.
30649 Autoselection selects the minibuffer only if it is active, and never
30650 unselects the minibuffer if it is active.
30652 When customizing this variable make sure that the actual value of
30653 `focus-follows-mouse' matches the behavior of your window manager. */);
30654 Vmouse_autoselect_window
= Qnil
;
30656 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
30657 doc
: /* Non-nil means automatically resize tool-bars.
30658 This dynamically changes the tool-bar's height to the minimum height
30659 that is needed to make all tool-bar items visible.
30660 If value is `grow-only', the tool-bar's height is only increased
30661 automatically; to decrease the tool-bar height, use \\[recenter]. */);
30662 Vauto_resize_tool_bars
= Qt
;
30664 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
30665 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
30666 auto_raise_tool_bar_buttons_p
= 1;
30668 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
30669 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
30670 make_cursor_line_fully_visible_p
= 1;
30672 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
30673 doc
: /* Border below tool-bar in pixels.
30674 If an integer, use it as the height of the border.
30675 If it is one of `internal-border-width' or `border-width', use the
30676 value of the corresponding frame parameter.
30677 Otherwise, no border is added below the tool-bar. */);
30678 Vtool_bar_border
= Qinternal_border_width
;
30680 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
30681 doc
: /* Margin around tool-bar buttons in pixels.
30682 If an integer, use that for both horizontal and vertical margins.
30683 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
30684 HORZ specifying the horizontal margin, and VERT specifying the
30685 vertical margin. */);
30686 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
30688 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
30689 doc
: /* Relief thickness of tool-bar buttons. */);
30690 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
30692 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
30693 doc
: /* Tool bar style to use.
30695 image - show images only
30696 text - show text only
30697 both - show both, text below image
30698 both-horiz - show text to the right of the image
30699 text-image-horiz - show text to the left of the image
30700 any other - use system default or image if no system default.
30702 This variable only affects the GTK+ toolkit version of Emacs. */);
30703 Vtool_bar_style
= Qnil
;
30705 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
30706 doc
: /* Maximum number of characters a label can have to be shown.
30707 The tool bar style must also show labels for this to have any effect, see
30708 `tool-bar-style'. */);
30709 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
30711 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
30712 doc
: /* List of functions to call to fontify regions of text.
30713 Each function is called with one argument POS. Functions must
30714 fontify a region starting at POS in the current buffer, and give
30715 fontified regions the property `fontified'. */);
30716 Vfontification_functions
= Qnil
;
30717 Fmake_variable_buffer_local (Qfontification_functions
);
30719 DEFVAR_BOOL ("unibyte-display-via-language-environment",
30720 unibyte_display_via_language_environment
,
30721 doc
: /* Non-nil means display unibyte text according to language environment.
30722 Specifically, this means that raw bytes in the range 160-255 decimal
30723 are displayed by converting them to the equivalent multibyte characters
30724 according to the current language environment. As a result, they are
30725 displayed according to the current fontset.
30727 Note that this variable affects only how these bytes are displayed,
30728 but does not change the fact they are interpreted as raw bytes. */);
30729 unibyte_display_via_language_environment
= 0;
30731 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
30732 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
30733 If a float, it specifies a fraction of the mini-window frame's height.
30734 If an integer, it specifies a number of lines. */);
30735 Vmax_mini_window_height
= make_float (0.25);
30737 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
30738 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
30739 A value of nil means don't automatically resize mini-windows.
30740 A value of t means resize them to fit the text displayed in them.
30741 A value of `grow-only', the default, means let mini-windows grow only;
30742 they return to their normal size when the minibuffer is closed, or the
30743 echo area becomes empty. */);
30744 Vresize_mini_windows
= Qgrow_only
;
30746 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
30747 doc
: /* Alist specifying how to blink the cursor off.
30748 Each element has the form (ON-STATE . OFF-STATE). Whenever the
30749 `cursor-type' frame-parameter or variable equals ON-STATE,
30750 comparing using `equal', Emacs uses OFF-STATE to specify
30751 how to blink it off. ON-STATE and OFF-STATE are values for
30752 the `cursor-type' frame parameter.
30754 If a frame's ON-STATE has no entry in this list,
30755 the frame's other specifications determine how to blink the cursor off. */);
30756 Vblink_cursor_alist
= Qnil
;
30758 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
30759 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
30760 If non-nil, windows are automatically scrolled horizontally to make
30761 point visible. */);
30762 automatic_hscrolling_p
= 1;
30763 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
30765 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
30766 doc
: /* How many columns away from the window edge point is allowed to get
30767 before automatic hscrolling will horizontally scroll the window. */);
30768 hscroll_margin
= 5;
30770 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
30771 doc
: /* How many columns to scroll the window when point gets too close to the edge.
30772 When point is less than `hscroll-margin' columns from the window
30773 edge, automatic hscrolling will scroll the window by the amount of columns
30774 determined by this variable. If its value is a positive integer, scroll that
30775 many columns. If it's a positive floating-point number, it specifies the
30776 fraction of the window's width to scroll. If it's nil or zero, point will be
30777 centered horizontally after the scroll. Any other value, including negative
30778 numbers, are treated as if the value were zero.
30780 Automatic hscrolling always moves point outside the scroll margin, so if
30781 point was more than scroll step columns inside the margin, the window will
30782 scroll more than the value given by the scroll step.
30784 Note that the lower bound for automatic hscrolling specified by `scroll-left'
30785 and `scroll-right' overrides this variable's effect. */);
30786 Vhscroll_step
= make_number (0);
30788 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
30789 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
30790 Bind this around calls to `message' to let it take effect. */);
30791 message_truncate_lines
= 0;
30793 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
30794 doc
: /* Normal hook run to update the menu bar definitions.
30795 Redisplay runs this hook before it redisplays the menu bar.
30796 This is used to update menus such as Buffers, whose contents depend on
30798 Vmenu_bar_update_hook
= Qnil
;
30800 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
30801 doc
: /* Frame for which we are updating a menu.
30802 The enable predicate for a menu binding should check this variable. */);
30803 Vmenu_updating_frame
= Qnil
;
30805 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
30806 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
30807 inhibit_menubar_update
= 0;
30809 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
30810 doc
: /* Prefix prepended to all continuation lines at display time.
30811 The value may be a string, an image, or a stretch-glyph; it is
30812 interpreted in the same way as the value of a `display' text property.
30814 This variable is overridden by any `wrap-prefix' text or overlay
30817 To add a prefix to non-continuation lines, use `line-prefix'. */);
30818 Vwrap_prefix
= Qnil
;
30819 DEFSYM (Qwrap_prefix
, "wrap-prefix");
30820 Fmake_variable_buffer_local (Qwrap_prefix
);
30822 DEFVAR_LISP ("line-prefix", Vline_prefix
,
30823 doc
: /* Prefix prepended to all non-continuation lines at display time.
30824 The value may be a string, an image, or a stretch-glyph; it is
30825 interpreted in the same way as the value of a `display' text property.
30827 This variable is overridden by any `line-prefix' text or overlay
30830 To add a prefix to continuation lines, use `wrap-prefix'. */);
30831 Vline_prefix
= Qnil
;
30832 DEFSYM (Qline_prefix
, "line-prefix");
30833 Fmake_variable_buffer_local (Qline_prefix
);
30835 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
30836 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
30837 inhibit_eval_during_redisplay
= 0;
30839 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
30840 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
30841 inhibit_free_realized_faces
= 0;
30844 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
30845 doc
: /* Inhibit try_window_id display optimization. */);
30846 inhibit_try_window_id
= 0;
30848 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
30849 doc
: /* Inhibit try_window_reusing display optimization. */);
30850 inhibit_try_window_reusing
= 0;
30852 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
30853 doc
: /* Inhibit try_cursor_movement display optimization. */);
30854 inhibit_try_cursor_movement
= 0;
30855 #endif /* GLYPH_DEBUG */
30857 DEFVAR_INT ("overline-margin", overline_margin
,
30858 doc
: /* Space between overline and text, in pixels.
30859 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
30860 margin to the character height. */);
30861 overline_margin
= 2;
30863 DEFVAR_INT ("underline-minimum-offset",
30864 underline_minimum_offset
,
30865 doc
: /* Minimum distance between baseline and underline.
30866 This can improve legibility of underlined text at small font sizes,
30867 particularly when using variable `x-use-underline-position-properties'
30868 with fonts that specify an UNDERLINE_POSITION relatively close to the
30869 baseline. The default value is 1. */);
30870 underline_minimum_offset
= 1;
30872 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
30873 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
30874 This feature only works when on a window system that can change
30875 cursor shapes. */);
30876 display_hourglass_p
= 1;
30878 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
30879 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
30880 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
30882 #ifdef HAVE_WINDOW_SYSTEM
30883 hourglass_atimer
= NULL
;
30884 hourglass_shown_p
= 0;
30885 #endif /* HAVE_WINDOW_SYSTEM */
30887 DEFSYM (Qglyphless_char
, "glyphless-char");
30888 DEFSYM (Qhex_code
, "hex-code");
30889 DEFSYM (Qempty_box
, "empty-box");
30890 DEFSYM (Qthin_space
, "thin-space");
30891 DEFSYM (Qzero_width
, "zero-width");
30893 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
30894 doc
: /* Function run just before redisplay.
30895 It is called with one argument, which is the set of windows that are to
30896 be redisplayed. This set can be nil (meaning, only the selected window),
30897 or t (meaning all windows). */);
30898 Vpre_redisplay_function
= intern ("ignore");
30900 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
30901 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
30903 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
30904 doc
: /* Char-table defining glyphless characters.
30905 Each element, if non-nil, should be one of the following:
30906 an ASCII acronym string: display this string in a box
30907 `hex-code': display the hexadecimal code of a character in a box
30908 `empty-box': display as an empty box
30909 `thin-space': display as 1-pixel width space
30910 `zero-width': don't display
30911 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
30912 display method for graphical terminals and text terminals respectively.
30913 GRAPHICAL and TEXT should each have one of the values listed above.
30915 The char-table has one extra slot to control the display of a character for
30916 which no font is found. This slot only takes effect on graphical terminals.
30917 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
30918 `thin-space'. The default is `empty-box'.
30920 If a character has a non-nil entry in an active display table, the
30921 display table takes effect; in this case, Emacs does not consult
30922 `glyphless-char-display' at all. */);
30923 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
30924 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
30927 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
30928 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
30929 Vdebug_on_message
= Qnil
;
30931 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
30933 Vredisplay__all_windows_cause
30934 = Fmake_vector (make_number (100), make_number (0));
30936 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
30938 Vredisplay__mode_lines_cause
30939 = Fmake_vector (make_number (100), make_number (0));
30943 /* Initialize this module when Emacs starts. */
30948 CHARPOS (this_line_start_pos
) = 0;
30950 if (!noninteractive
)
30952 struct window
*m
= XWINDOW (minibuf_window
);
30953 Lisp_Object frame
= m
->frame
;
30954 struct frame
*f
= XFRAME (frame
);
30955 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
30956 struct window
*r
= XWINDOW (root
);
30959 echo_area_window
= minibuf_window
;
30961 r
->top_line
= FRAME_TOP_MARGIN (f
);
30962 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
30963 r
->total_cols
= FRAME_COLS (f
);
30964 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30965 r
->total_lines
= FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
30966 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
30968 m
->top_line
= FRAME_LINES (f
) - 1;
30969 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
30970 m
->total_cols
= FRAME_COLS (f
);
30971 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30972 m
->total_lines
= 1;
30973 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
30975 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
30976 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
30977 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
30979 /* The default ellipsis glyphs `...'. */
30980 for (i
= 0; i
< 3; ++i
)
30981 default_invis_vector
[i
] = make_number ('.');
30985 /* Allocate the buffer for frame titles.
30986 Also used for `format-mode-line'. */
30988 mode_line_noprop_buf
= xmalloc (size
);
30989 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
30990 mode_line_noprop_ptr
= mode_line_noprop_buf
;
30991 mode_line_target
= MODE_LINE_DISPLAY
;
30994 help_echo_showing_p
= 0;
30997 #ifdef HAVE_WINDOW_SYSTEM
30999 /* Platform-independent portion of hourglass implementation. */
31001 /* Cancel a currently active hourglass timer, and start a new one. */
31003 start_hourglass (void)
31005 struct timespec delay
;
31007 cancel_hourglass ();
31009 if (INTEGERP (Vhourglass_delay
)
31010 && XINT (Vhourglass_delay
) > 0)
31011 delay
= make_timespec (min (XINT (Vhourglass_delay
),
31012 TYPE_MAXIMUM (time_t)),
31014 else if (FLOATP (Vhourglass_delay
)
31015 && XFLOAT_DATA (Vhourglass_delay
) > 0)
31016 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
31018 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
31022 extern void w32_note_current_window (void);
31023 w32_note_current_window ();
31025 #endif /* HAVE_NTGUI */
31027 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31028 show_hourglass
, NULL
);
31032 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31035 cancel_hourglass (void)
31037 if (hourglass_atimer
)
31039 cancel_atimer (hourglass_atimer
);
31040 hourglass_atimer
= NULL
;
31043 if (hourglass_shown_p
)
31047 #endif /* HAVE_WINDOW_SYSTEM */