1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2014 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
25 Emacs separates the task of updating the display from code
26 modifying global state, e.g. buffer text. This way functions
27 operating on buffers don't also have to be concerned with updating
30 Updating the display is triggered by the Lisp interpreter when it
31 decides it's time to do it. This is done either automatically for
32 you as part of the interpreter's command loop or as the result of
33 calling Lisp functions like `sit-for'. The C function `redisplay'
34 in xdisp.c is the only entry into the inner redisplay code.
36 The following diagram shows how redisplay code is invoked. As you
37 can see, Lisp calls redisplay and vice versa. Under window systems
38 like X, some portions of the redisplay code are also called
39 asynchronously during mouse movement or expose events. It is very
40 important that these code parts do NOT use the C library (malloc,
41 free) because many C libraries under Unix are not reentrant. They
42 may also NOT call functions of the Lisp interpreter which could
43 change the interpreter's state. If you don't follow these rules,
44 you will encounter bugs which are very hard to explain.
46 +--------------+ redisplay +----------------+
47 | Lisp machine |---------------->| Redisplay code |<--+
48 +--------------+ (xdisp.c) +----------------+ |
50 +----------------------------------+ |
51 Don't use this path when called |
54 expose_window (asynchronous) |
56 X expose events -----+
58 What does redisplay do? Obviously, it has to figure out somehow what
59 has been changed since the last time the display has been updated,
60 and to make these changes visible. Preferably it would do that in
61 a moderately intelligent way, i.e. fast.
63 Changes in buffer text can be deduced from window and buffer
64 structures, and from some global variables like `beg_unchanged' and
65 `end_unchanged'. The contents of the display are additionally
66 recorded in a `glyph matrix', a two-dimensional matrix of glyph
67 structures. Each row in such a matrix corresponds to a line on the
68 display, and each glyph in a row corresponds to a column displaying
69 a character, an image, or what else. This matrix is called the
70 `current glyph matrix' or `current matrix' in redisplay
73 For buffer parts that have been changed since the last update, a
74 second glyph matrix is constructed, the so called `desired glyph
75 matrix' or short `desired matrix'. Current and desired matrix are
76 then compared to find a cheap way to update the display, e.g. by
77 reusing part of the display by scrolling lines.
79 You will find a lot of redisplay optimizations when you start
80 looking at the innards of redisplay. The overall goal of all these
81 optimizations is to make redisplay fast because it is done
82 frequently. Some of these optimizations are implemented by the
87 This function tries to update the display if the text in the
88 window did not change and did not scroll, only point moved, and
89 it did not move off the displayed portion of the text.
91 . try_window_reusing_current_matrix
93 This function reuses the current matrix of a window when text
94 has not changed, but the window start changed (e.g., due to
99 This function attempts to redisplay a window by reusing parts of
100 its existing display. It finds and reuses the part that was not
101 changed, and redraws the rest. (The "id" part in the function's
102 name stands for "insert/delete", not for "identification" or
107 This function performs the full redisplay of a single window
108 assuming that its fonts were not changed and that the cursor
109 will not end up in the scroll margins. (Loading fonts requires
110 re-adjustment of dimensions of glyph matrices, which makes this
111 method impossible to use.)
113 These optimizations are tried in sequence (some can be skipped if
114 it is known that they are not applicable). If none of the
115 optimizations were successful, redisplay calls redisplay_windows,
116 which performs a full redisplay of all windows.
118 Note that there's one more important optimization up Emacs's
119 sleeve, but it is related to actually redrawing the potentially
120 changed portions of the window/frame, not to reproducing the
121 desired matrices of those potentially changed portions. Namely,
122 the function update_frame and its subroutines, which you will find
123 in dispnew.c, compare the desired matrices with the current
124 matrices, and only redraw the portions that changed. So it could
125 happen that the functions in this file for some reason decide that
126 the entire desired matrix needs to be regenerated from scratch, and
127 still only parts of the Emacs display, or even nothing at all, will
128 be actually delivered to the glass, because update_frame has found
129 that the new and the old screen contents are similar or identical.
133 Desired matrices are always built per Emacs window. The function
134 `display_line' is the central function to look at if you are
135 interested. It constructs one row in a desired matrix given an
136 iterator structure containing both a buffer position and a
137 description of the environment in which the text is to be
138 displayed. But this is too early, read on.
140 Characters and pixmaps displayed for a range of buffer text depend
141 on various settings of buffers and windows, on overlays and text
142 properties, on display tables, on selective display. The good news
143 is that all this hairy stuff is hidden behind a small set of
144 interface functions taking an iterator structure (struct it)
147 Iteration over things to be displayed is then simple. It is
148 started by initializing an iterator with a call to init_iterator,
149 passing it the buffer position where to start iteration. For
150 iteration over strings, pass -1 as the position to init_iterator,
151 and call reseat_to_string when the string is ready, to initialize
152 the iterator for that string. Thereafter, calls to
153 get_next_display_element fill the iterator structure with relevant
154 information about the next thing to display. Calls to
155 set_iterator_to_next move the iterator to the next thing.
157 Besides this, an iterator also contains information about the
158 display environment in which glyphs for display elements are to be
159 produced. It has fields for the width and height of the display,
160 the information whether long lines are truncated or continued, a
161 current X and Y position, and lots of other stuff you can better
164 Glyphs in a desired matrix are normally constructed in a loop
165 calling get_next_display_element and then PRODUCE_GLYPHS. The call
166 to PRODUCE_GLYPHS will fill the iterator structure with pixel
167 information about the element being displayed and at the same time
168 produce glyphs for it. If the display element fits on the line
169 being displayed, set_iterator_to_next is called next, otherwise the
170 glyphs produced are discarded. The function display_line is the
171 workhorse of filling glyph rows in the desired matrix with glyphs.
172 In addition to producing glyphs, it also handles line truncation
173 and continuation, word wrap, and cursor positioning (for the
174 latter, see also set_cursor_from_row).
178 That just couldn't be all, could it? What about terminal types not
179 supporting operations on sub-windows of the screen? To update the
180 display on such a terminal, window-based glyph matrices are not
181 well suited. To be able to reuse part of the display (scrolling
182 lines up and down), we must instead have a view of the whole
183 screen. This is what `frame matrices' are for. They are a trick.
185 Frames on terminals like above have a glyph pool. Windows on such
186 a frame sub-allocate their glyph memory from their frame's glyph
187 pool. The frame itself is given its own glyph matrices. By
188 coincidence---or maybe something else---rows in window glyph
189 matrices are slices of corresponding rows in frame matrices. Thus
190 writing to window matrices implicitly updates a frame matrix which
191 provides us with the view of the whole screen that we originally
192 wanted to have without having to move many bytes around. To be
193 honest, there is a little bit more done, but not much more. If you
194 plan to extend that code, take a look at dispnew.c. The function
195 build_frame_matrix is a good starting point.
197 Bidirectional display.
199 Bidirectional display adds quite some hair to this already complex
200 design. The good news are that a large portion of that hairy stuff
201 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
202 reordering engine which is called by set_iterator_to_next and
203 returns the next character to display in the visual order. See
204 commentary on bidi.c for more details. As far as redisplay is
205 concerned, the effect of calling bidi_move_to_visually_next, the
206 main interface of the reordering engine, is that the iterator gets
207 magically placed on the buffer or string position that is to be
208 displayed next. In other words, a linear iteration through the
209 buffer/string is replaced with a non-linear one. All the rest of
210 the redisplay is oblivious to the bidi reordering.
212 Well, almost oblivious---there are still complications, most of
213 them due to the fact that buffer and string positions no longer
214 change monotonously with glyph indices in a glyph row. Moreover,
215 for continued lines, the buffer positions may not even be
216 monotonously changing with vertical positions. Also, accounting
217 for face changes, overlays, etc. becomes more complex because
218 non-linear iteration could potentially skip many positions with
219 changes, and then cross them again on the way back...
221 One other prominent effect of bidirectional display is that some
222 paragraphs of text need to be displayed starting at the right
223 margin of the window---the so-called right-to-left, or R2L
224 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
225 which have their reversed_p flag set. The bidi reordering engine
226 produces characters in such rows starting from the character which
227 should be the rightmost on display. PRODUCE_GLYPHS then reverses
228 the order, when it fills up the glyph row whose reversed_p flag is
229 set, by prepending each new glyph to what is already there, instead
230 of appending it. When the glyph row is complete, the function
231 extend_face_to_end_of_line fills the empty space to the left of the
232 leftmost character with special glyphs, which will display as,
233 well, empty. On text terminals, these special glyphs are simply
234 blank characters. On graphics terminals, there's a single stretch
235 glyph of a suitably computed width. Both the blanks and the
236 stretch glyph are given the face of the background of the line.
237 This way, the terminal-specific back-end can still draw the glyphs
238 left to right, even for R2L lines.
240 Bidirectional display and character compositions
242 Some scripts cannot be displayed by drawing each character
243 individually, because adjacent characters change each other's shape
244 on display. For example, Arabic and Indic scripts belong to this
247 Emacs display supports this by providing "character compositions",
248 most of which is implemented in composite.c. During the buffer
249 scan that delivers characters to PRODUCE_GLYPHS, if the next
250 character to be delivered is a composed character, the iteration
251 calls composition_reseat_it and next_element_from_composition. If
252 they succeed to compose the character with one or more of the
253 following characters, the whole sequence of characters that where
254 composed is recorded in the `struct composition_it' object that is
255 part of the buffer iterator. The composed sequence could produce
256 one or more font glyphs (called "grapheme clusters") on the screen.
257 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
258 in the direction corresponding to the current bidi scan direction
259 (recorded in the scan_dir member of the `struct bidi_it' object
260 that is part of the buffer iterator). In particular, if the bidi
261 iterator currently scans the buffer backwards, the grapheme
262 clusters are delivered back to front. This reorders the grapheme
263 clusters as appropriate for the current bidi context. Note that
264 this means that the grapheme clusters are always stored in the
265 LGSTRING object (see composite.c) in the logical order.
267 Moving an iterator in bidirectional text
268 without producing glyphs
270 Note one important detail mentioned above: that the bidi reordering
271 engine, driven by the iterator, produces characters in R2L rows
272 starting at the character that will be the rightmost on display.
273 As far as the iterator is concerned, the geometry of such rows is
274 still left to right, i.e. the iterator "thinks" the first character
275 is at the leftmost pixel position. The iterator does not know that
276 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
277 delivers. This is important when functions from the move_it_*
278 family are used to get to certain screen position or to match
279 screen coordinates with buffer coordinates: these functions use the
280 iterator geometry, which is left to right even in R2L paragraphs.
281 This works well with most callers of move_it_*, because they need
282 to get to a specific column, and columns are still numbered in the
283 reading order, i.e. the rightmost character in a R2L paragraph is
284 still column zero. But some callers do not get well with this; a
285 notable example is mouse clicks that need to find the character
286 that corresponds to certain pixel coordinates. See
287 buffer_posn_from_coords in dispnew.c for how this is handled. */
295 #include "keyboard.h"
298 #include "termchar.h"
299 #include "dispextern.h"
300 #include "character.h"
304 #include "commands.h"
308 #include "termhooks.h"
309 #include "termopts.h"
310 #include "intervals.h"
313 #include "region-cache.h"
316 #include "blockinput.h"
317 #ifdef HAVE_WINDOW_SYSTEM
319 #endif /* HAVE_WINDOW_SYSTEM */
321 #ifndef FRAME_X_OUTPUT
322 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
325 #define INFINITY 10000000
327 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
328 Lisp_Object Qwindow_scroll_functions
;
329 static Lisp_Object Qwindow_text_change_functions
;
330 static Lisp_Object Qredisplay_end_trigger_functions
;
331 Lisp_Object Qinhibit_point_motion_hooks
;
332 static Lisp_Object QCeval
, QCpropertize
;
333 Lisp_Object QCfile
, QCdata
;
334 static Lisp_Object Qfontified
;
335 static Lisp_Object Qgrow_only
;
336 static Lisp_Object Qinhibit_eval_during_redisplay
;
337 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
338 static Lisp_Object Qright_to_left
, Qleft_to_right
;
341 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
343 /* Pointer shapes. */
344 static Lisp_Object Qarrow
, Qhand
;
347 /* Holds the list (error). */
348 static Lisp_Object list_of_error
;
350 static Lisp_Object Qfontification_functions
;
352 static Lisp_Object Qwrap_prefix
;
353 static Lisp_Object Qline_prefix
;
354 static Lisp_Object Qredisplay_internal
;
356 /* Non-nil means don't actually do any redisplay. */
358 Lisp_Object Qinhibit_redisplay
;
360 /* Names of text properties relevant for redisplay. */
362 Lisp_Object Qdisplay
;
364 Lisp_Object Qspace
, QCalign_to
;
365 static Lisp_Object QCrelative_width
, QCrelative_height
;
366 Lisp_Object Qleft_margin
, Qright_margin
;
367 static Lisp_Object Qspace_width
, Qraise
;
368 static Lisp_Object Qslice
;
370 static Lisp_Object Qmargin
, Qpointer
;
371 static Lisp_Object Qline_height
;
373 #ifdef HAVE_WINDOW_SYSTEM
375 /* Test if overflow newline into fringe. Called with iterator IT
376 at or past right window margin, and with IT->current_x set. */
378 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
379 (!NILP (Voverflow_newline_into_fringe) \
380 && FRAME_WINDOW_P ((IT)->f) \
381 && ((IT)->bidi_it.paragraph_dir == R2L \
382 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
383 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
384 && (IT)->current_x == (IT)->last_visible_x)
386 #else /* !HAVE_WINDOW_SYSTEM */
387 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
388 #endif /* HAVE_WINDOW_SYSTEM */
390 /* Test if the display element loaded in IT, or the underlying buffer
391 or string character, is a space or a TAB character. This is used
392 to determine where word wrapping can occur. */
394 #define IT_DISPLAYING_WHITESPACE(it) \
395 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
396 || ((STRINGP (it->string) \
397 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
398 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
400 && (it->s[IT_BYTEPOS (*it)] == ' ' \
401 || it->s[IT_BYTEPOS (*it)] == '\t')) \
402 || (IT_BYTEPOS (*it) < ZV_BYTE \
403 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
404 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
406 /* Name of the face used to highlight trailing whitespace. */
408 static Lisp_Object Qtrailing_whitespace
;
410 /* Name and number of the face used to highlight escape glyphs. */
412 static Lisp_Object Qescape_glyph
;
414 /* Name and number of the face used to highlight non-breaking spaces. */
416 static Lisp_Object Qnobreak_space
;
418 /* The symbol `image' which is the car of the lists used to represent
419 images in Lisp. Also a tool bar style. */
423 /* The image map types. */
425 static Lisp_Object QCpointer
;
426 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
428 /* Tool bar styles */
429 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
431 /* Non-zero means print newline to stdout before next mini-buffer
434 bool noninteractive_need_newline
;
436 /* Non-zero means print newline to message log before next message. */
438 static bool message_log_need_newline
;
440 /* Three markers that message_dolog uses.
441 It could allocate them itself, but that causes trouble
442 in handling memory-full errors. */
443 static Lisp_Object message_dolog_marker1
;
444 static Lisp_Object message_dolog_marker2
;
445 static Lisp_Object message_dolog_marker3
;
447 /* The buffer position of the first character appearing entirely or
448 partially on the line of the selected window which contains the
449 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
450 redisplay optimization in redisplay_internal. */
452 static struct text_pos this_line_start_pos
;
454 /* Number of characters past the end of the line above, including the
455 terminating newline. */
457 static struct text_pos this_line_end_pos
;
459 /* The vertical positions and the height of this line. */
461 static int this_line_vpos
;
462 static int this_line_y
;
463 static int this_line_pixel_height
;
465 /* X position at which this display line starts. Usually zero;
466 negative if first character is partially visible. */
468 static int this_line_start_x
;
470 /* The smallest character position seen by move_it_* functions as they
471 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
472 hscrolled lines, see display_line. */
474 static struct text_pos this_line_min_pos
;
476 /* Buffer that this_line_.* variables are referring to. */
478 static struct buffer
*this_line_buffer
;
481 /* Values of those variables at last redisplay are stored as
482 properties on `overlay-arrow-position' symbol. However, if
483 Voverlay_arrow_position is a marker, last-arrow-position is its
484 numerical position. */
486 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
488 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
489 properties on a symbol in overlay-arrow-variable-list. */
491 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
493 Lisp_Object Qmenu_bar_update_hook
;
495 /* Nonzero if an overlay arrow has been displayed in this window. */
497 static bool overlay_arrow_seen
;
499 /* Vector containing glyphs for an ellipsis `...'. */
501 static Lisp_Object default_invis_vector
[3];
503 /* This is the window where the echo area message was displayed. It
504 is always a mini-buffer window, but it may not be the same window
505 currently active as a mini-buffer. */
507 Lisp_Object echo_area_window
;
509 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
510 pushes the current message and the value of
511 message_enable_multibyte on the stack, the function restore_message
512 pops the stack and displays MESSAGE again. */
514 static Lisp_Object Vmessage_stack
;
516 /* Nonzero means multibyte characters were enabled when the echo area
517 message was specified. */
519 static bool message_enable_multibyte
;
521 /* Nonzero if we should redraw the mode lines on the next redisplay.
522 If it has value REDISPLAY_SOME, then only redisplay the mode lines where
523 the `redisplay' bit has been set. Otherwise, redisplay all mode lines
524 (the number used is then only used to track down the cause for this
527 int update_mode_lines
;
529 /* Nonzero if window sizes or contents other than selected-window have changed
530 since last redisplay that finished.
531 If it has value REDISPLAY_SOME, then only redisplay the windows where
532 the `redisplay' bit has been set. Otherwise, redisplay all windows
533 (the number used is then only used to track down the cause for this
536 int windows_or_buffers_changed
;
538 /* Nonzero after display_mode_line if %l was used and it displayed a
541 static bool line_number_displayed
;
543 /* The name of the *Messages* buffer, a string. */
545 static Lisp_Object Vmessages_buffer_name
;
547 /* Current, index 0, and last displayed echo area message. Either
548 buffers from echo_buffers, or nil to indicate no message. */
550 Lisp_Object echo_area_buffer
[2];
552 /* The buffers referenced from echo_area_buffer. */
554 static Lisp_Object echo_buffer
[2];
556 /* A vector saved used in with_area_buffer to reduce consing. */
558 static Lisp_Object Vwith_echo_area_save_vector
;
560 /* Non-zero means display_echo_area should display the last echo area
561 message again. Set by redisplay_preserve_echo_area. */
563 static bool display_last_displayed_message_p
;
565 /* Nonzero if echo area is being used by print; zero if being used by
568 static bool message_buf_print
;
570 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
572 static Lisp_Object Qinhibit_menubar_update
;
573 static Lisp_Object Qmessage_truncate_lines
;
575 /* Set to 1 in clear_message to make redisplay_internal aware
576 of an emptied echo area. */
578 static bool message_cleared_p
;
580 /* A scratch glyph row with contents used for generating truncation
581 glyphs. Also used in direct_output_for_insert. */
583 #define MAX_SCRATCH_GLYPHS 100
584 static struct glyph_row scratch_glyph_row
;
585 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
587 /* Ascent and height of the last line processed by move_it_to. */
589 static int last_height
;
591 /* Non-zero if there's a help-echo in the echo area. */
593 bool help_echo_showing_p
;
595 /* The maximum distance to look ahead for text properties. Values
596 that are too small let us call compute_char_face and similar
597 functions too often which is expensive. Values that are too large
598 let us call compute_char_face and alike too often because we
599 might not be interested in text properties that far away. */
601 #define TEXT_PROP_DISTANCE_LIMIT 100
603 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
604 iterator state and later restore it. This is needed because the
605 bidi iterator on bidi.c keeps a stacked cache of its states, which
606 is really a singleton. When we use scratch iterator objects to
607 move around the buffer, we can cause the bidi cache to be pushed or
608 popped, and therefore we need to restore the cache state when we
609 return to the original iterator. */
610 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
613 bidi_unshelve_cache (CACHE, 1); \
615 CACHE = bidi_shelve_cache (); \
618 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
620 if (pITORIG != pITCOPY) \
621 *(pITORIG) = *(pITCOPY); \
622 bidi_unshelve_cache (CACHE, 0); \
626 /* Functions to mark elements as needing redisplay. */
627 enum { REDISPLAY_SOME
= 2}; /* Arbitrary choice. */
630 redisplay_other_windows (void)
632 if (!windows_or_buffers_changed
)
633 windows_or_buffers_changed
= REDISPLAY_SOME
;
637 wset_redisplay (struct window
*w
)
639 /* Beware: selected_window can be nil during early stages. */
640 if (!EQ (make_lisp_ptr (w
, Lisp_Vectorlike
), selected_window
))
641 redisplay_other_windows ();
646 fset_redisplay (struct frame
*f
)
648 redisplay_other_windows ();
653 bset_redisplay (struct buffer
*b
)
655 int count
= buffer_window_count (b
);
658 /* ... it's visible in other window than selected, */
659 if (count
> 1 || b
!= XBUFFER (XWINDOW (selected_window
)->contents
))
660 redisplay_other_windows ();
661 /* Even if we don't set windows_or_buffers_changed, do set `redisplay'
662 so that if we later set windows_or_buffers_changed, this buffer will
664 b
->text
->redisplay
= true;
669 bset_update_mode_line (struct buffer
*b
)
671 if (!update_mode_lines
)
672 update_mode_lines
= REDISPLAY_SOME
;
673 b
->text
->redisplay
= true;
678 /* Non-zero means print traces of redisplay if compiled with
679 GLYPH_DEBUG defined. */
681 bool trace_redisplay_p
;
683 #endif /* GLYPH_DEBUG */
685 #ifdef DEBUG_TRACE_MOVE
686 /* Non-zero means trace with TRACE_MOVE to stderr. */
689 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
691 #define TRACE_MOVE(x) (void) 0
694 static Lisp_Object Qauto_hscroll_mode
;
696 /* Buffer being redisplayed -- for redisplay_window_error. */
698 static struct buffer
*displayed_buffer
;
700 /* Value returned from text property handlers (see below). */
705 HANDLED_RECOMPUTE_PROPS
,
706 HANDLED_OVERLAY_STRING_CONSUMED
,
710 /* A description of text properties that redisplay is interested
715 /* The name of the property. */
718 /* A unique index for the property. */
721 /* A handler function called to set up iterator IT from the property
722 at IT's current position. Value is used to steer handle_stop. */
723 enum prop_handled (*handler
) (struct it
*it
);
726 static enum prop_handled
handle_face_prop (struct it
*);
727 static enum prop_handled
handle_invisible_prop (struct it
*);
728 static enum prop_handled
handle_display_prop (struct it
*);
729 static enum prop_handled
handle_composition_prop (struct it
*);
730 static enum prop_handled
handle_overlay_change (struct it
*);
731 static enum prop_handled
handle_fontified_prop (struct it
*);
733 /* Properties handled by iterators. */
735 static struct props it_props
[] =
737 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
738 /* Handle `face' before `display' because some sub-properties of
739 `display' need to know the face. */
740 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
741 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
742 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
743 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
747 /* Value is the position described by X. If X is a marker, value is
748 the marker_position of X. Otherwise, value is X. */
750 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
752 /* Enumeration returned by some move_it_.* functions internally. */
756 /* Not used. Undefined value. */
759 /* Move ended at the requested buffer position or ZV. */
760 MOVE_POS_MATCH_OR_ZV
,
762 /* Move ended at the requested X pixel position. */
765 /* Move within a line ended at the end of a line that must be
769 /* Move within a line ended at the end of a line that would
770 be displayed truncated. */
773 /* Move within a line ended at a line end. */
777 /* This counter is used to clear the face cache every once in a while
778 in redisplay_internal. It is incremented for each redisplay.
779 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
782 #define CLEAR_FACE_CACHE_COUNT 500
783 static int clear_face_cache_count
;
785 /* Similarly for the image cache. */
787 #ifdef HAVE_WINDOW_SYSTEM
788 #define CLEAR_IMAGE_CACHE_COUNT 101
789 static int clear_image_cache_count
;
791 /* Null glyph slice */
792 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
795 /* True while redisplay_internal is in progress. */
799 static Lisp_Object Qinhibit_free_realized_faces
;
800 static Lisp_Object Qmode_line_default_help_echo
;
802 /* If a string, XTread_socket generates an event to display that string.
803 (The display is done in read_char.) */
805 Lisp_Object help_echo_string
;
806 Lisp_Object help_echo_window
;
807 Lisp_Object help_echo_object
;
808 ptrdiff_t help_echo_pos
;
810 /* Temporary variable for XTread_socket. */
812 Lisp_Object previous_help_echo_string
;
814 /* Platform-independent portion of hourglass implementation. */
816 #ifdef HAVE_WINDOW_SYSTEM
818 /* Non-zero means an hourglass cursor is currently shown. */
819 bool hourglass_shown_p
;
821 /* If non-null, an asynchronous timer that, when it expires, displays
822 an hourglass cursor on all frames. */
823 struct atimer
*hourglass_atimer
;
825 #endif /* HAVE_WINDOW_SYSTEM */
827 /* Name of the face used to display glyphless characters. */
828 static Lisp_Object Qglyphless_char
;
830 /* Symbol for the purpose of Vglyphless_char_display. */
831 static Lisp_Object Qglyphless_char_display
;
833 /* Method symbols for Vglyphless_char_display. */
834 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
836 /* Default number of seconds to wait before displaying an hourglass
838 #define DEFAULT_HOURGLASS_DELAY 1
840 #ifdef HAVE_WINDOW_SYSTEM
842 /* Default pixel width of `thin-space' display method. */
843 #define THIN_SPACE_WIDTH 1
845 #endif /* HAVE_WINDOW_SYSTEM */
847 /* Function prototypes. */
849 static void setup_for_ellipsis (struct it
*, int);
850 static void set_iterator_to_next (struct it
*, int);
851 static void mark_window_display_accurate_1 (struct window
*, int);
852 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
853 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
854 static int row_for_charpos_p (struct glyph_row
*, ptrdiff_t);
855 static int cursor_row_p (struct glyph_row
*);
856 static int redisplay_mode_lines (Lisp_Object
, bool);
857 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
859 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
861 static void handle_line_prefix (struct it
*);
863 static void pint2str (char *, int, ptrdiff_t);
864 static void pint2hrstr (char *, int, ptrdiff_t);
865 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
867 static int text_outside_line_unchanged_p (struct window
*,
868 ptrdiff_t, ptrdiff_t);
869 static void store_mode_line_noprop_char (char);
870 static int store_mode_line_noprop (const char *, int, int);
871 static void handle_stop (struct it
*);
872 static void handle_stop_backwards (struct it
*, ptrdiff_t);
873 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
874 static void ensure_echo_area_buffers (void);
875 static void unwind_with_echo_area_buffer (Lisp_Object
);
876 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
877 static int with_echo_area_buffer (struct window
*, int,
878 int (*) (ptrdiff_t, Lisp_Object
),
879 ptrdiff_t, Lisp_Object
);
880 static void clear_garbaged_frames (void);
881 static int current_message_1 (ptrdiff_t, Lisp_Object
);
882 static int truncate_message_1 (ptrdiff_t, Lisp_Object
);
883 static void set_message (Lisp_Object
);
884 static int set_message_1 (ptrdiff_t, Lisp_Object
);
885 static int display_echo_area (struct window
*);
886 static int display_echo_area_1 (ptrdiff_t, Lisp_Object
);
887 static int resize_mini_window_1 (ptrdiff_t, Lisp_Object
);
888 static void unwind_redisplay (void);
889 static int string_char_and_length (const unsigned char *, int *);
890 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
892 static int compute_window_start_on_continuation_line (struct window
*);
893 static void insert_left_trunc_glyphs (struct it
*);
894 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
896 static void extend_face_to_end_of_line (struct it
*);
897 static int append_space_for_newline (struct it
*, int);
898 static int cursor_row_fully_visible_p (struct window
*, int, int);
899 static int try_scrolling (Lisp_Object
, int, ptrdiff_t, ptrdiff_t, int, int);
900 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
901 static int trailing_whitespace_p (ptrdiff_t);
902 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
903 static void push_it (struct it
*, struct text_pos
*);
904 static void iterate_out_of_display_property (struct it
*);
905 static void pop_it (struct it
*);
906 static void sync_frame_with_window_matrix_rows (struct window
*);
907 static void redisplay_internal (void);
908 static int echo_area_display (int);
909 static void redisplay_windows (Lisp_Object
);
910 static void redisplay_window (Lisp_Object
, bool);
911 static Lisp_Object
redisplay_window_error (Lisp_Object
);
912 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
913 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
914 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
915 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
917 static int update_menu_bar (struct frame
*, int, int);
918 static int try_window_reusing_current_matrix (struct window
*);
919 static int try_window_id (struct window
*);
920 static int display_line (struct it
*);
921 static int display_mode_lines (struct window
*);
922 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
923 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
924 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
925 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
926 static void display_menu_bar (struct window
*);
927 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
929 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
930 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
931 static void compute_line_metrics (struct it
*);
932 static void run_redisplay_end_trigger_hook (struct it
*);
933 static int get_overlay_strings (struct it
*, ptrdiff_t);
934 static int get_overlay_strings_1 (struct it
*, ptrdiff_t, int);
935 static void next_overlay_string (struct it
*);
936 static void reseat (struct it
*, struct text_pos
, int);
937 static void reseat_1 (struct it
*, struct text_pos
, int);
938 static void back_to_previous_visible_line_start (struct it
*);
939 static void reseat_at_next_visible_line_start (struct it
*, int);
940 static int next_element_from_ellipsis (struct it
*);
941 static int next_element_from_display_vector (struct it
*);
942 static int next_element_from_string (struct it
*);
943 static int next_element_from_c_string (struct it
*);
944 static int next_element_from_buffer (struct it
*);
945 static int next_element_from_composition (struct it
*);
946 static int next_element_from_image (struct it
*);
947 static int next_element_from_stretch (struct it
*);
948 static void load_overlay_strings (struct it
*, ptrdiff_t);
949 static int init_from_display_pos (struct it
*, struct window
*,
950 struct display_pos
*);
951 static void reseat_to_string (struct it
*, const char *,
952 Lisp_Object
, ptrdiff_t, ptrdiff_t, int, int);
953 static int get_next_display_element (struct it
*);
954 static enum move_it_result
955 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
956 enum move_operation_enum
);
957 static void get_visually_first_element (struct it
*);
958 static void init_to_row_start (struct it
*, struct window
*,
960 static int init_to_row_end (struct it
*, struct window
*,
962 static void back_to_previous_line_start (struct it
*);
963 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
964 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
965 Lisp_Object
, ptrdiff_t);
966 static struct text_pos
string_pos (ptrdiff_t, Lisp_Object
);
967 static struct text_pos
c_string_pos (ptrdiff_t, const char *, bool);
968 static ptrdiff_t number_of_chars (const char *, bool);
969 static void compute_stop_pos (struct it
*);
970 static void compute_string_pos (struct text_pos
*, struct text_pos
,
972 static int face_before_or_after_it_pos (struct it
*, int);
973 static ptrdiff_t next_overlay_change (ptrdiff_t);
974 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
975 Lisp_Object
, struct text_pos
*, ptrdiff_t, int);
976 static int handle_single_display_spec (struct it
*, Lisp_Object
,
977 Lisp_Object
, Lisp_Object
,
978 struct text_pos
*, ptrdiff_t, int, int);
979 static int underlying_face_id (struct it
*);
980 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
983 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
984 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
986 #ifdef HAVE_WINDOW_SYSTEM
988 static void x_consider_frame_title (Lisp_Object
);
989 static void update_tool_bar (struct frame
*, int);
990 static int redisplay_tool_bar (struct frame
*);
991 static void x_draw_bottom_divider (struct window
*w
);
992 static void notice_overwritten_cursor (struct window
*,
995 static void append_stretch_glyph (struct it
*, Lisp_Object
,
999 #endif /* HAVE_WINDOW_SYSTEM */
1001 static void produce_special_glyphs (struct it
*, enum display_element_type
);
1002 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
1003 static bool coords_in_mouse_face_p (struct window
*, int, int);
1007 /***********************************************************************
1008 Window display dimensions
1009 ***********************************************************************/
1011 /* Return the bottom boundary y-position for text lines in window W.
1012 This is the first y position at which a line cannot start.
1013 It is relative to the top of the window.
1015 This is the height of W minus the height of a mode line, if any. */
1018 window_text_bottom_y (struct window
*w
)
1020 int height
= WINDOW_PIXEL_HEIGHT (w
);
1022 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
1024 if (WINDOW_WANTS_MODELINE_P (w
))
1025 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1030 /* Return the pixel width of display area AREA of window W.
1031 ANY_AREA means return the total width of W, not including
1032 fringes to the left and right of the window. */
1035 window_box_width (struct window
*w
, enum glyph_row_area area
)
1037 int width
= w
->pixel_width
;
1039 if (!w
->pseudo_window_p
)
1041 width
-= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
1042 width
-= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
1044 if (area
== TEXT_AREA
)
1045 width
-= (WINDOW_MARGINS_WIDTH (w
)
1046 + WINDOW_FRINGES_WIDTH (w
));
1047 else if (area
== LEFT_MARGIN_AREA
)
1048 width
= WINDOW_LEFT_MARGIN_WIDTH (w
);
1049 else if (area
== RIGHT_MARGIN_AREA
)
1050 width
= WINDOW_RIGHT_MARGIN_WIDTH (w
);
1053 /* With wide margins, fringes, etc. we might end up with a negative
1054 width, correct that here. */
1055 return max (0, width
);
1059 /* Return the pixel height of the display area of window W, not
1060 including mode lines of W, if any. */
1063 window_box_height (struct window
*w
)
1065 struct frame
*f
= XFRAME (w
->frame
);
1066 int height
= WINDOW_PIXEL_HEIGHT (w
);
1068 eassert (height
>= 0);
1070 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
1072 /* Note: the code below that determines the mode-line/header-line
1073 height is essentially the same as that contained in the macro
1074 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1075 the appropriate glyph row has its `mode_line_p' flag set,
1076 and if it doesn't, uses estimate_mode_line_height instead. */
1078 if (WINDOW_WANTS_MODELINE_P (w
))
1080 struct glyph_row
*ml_row
1081 = (w
->current_matrix
&& w
->current_matrix
->rows
1082 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1084 if (ml_row
&& ml_row
->mode_line_p
)
1085 height
-= ml_row
->height
;
1087 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1090 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1092 struct glyph_row
*hl_row
1093 = (w
->current_matrix
&& w
->current_matrix
->rows
1094 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1096 if (hl_row
&& hl_row
->mode_line_p
)
1097 height
-= hl_row
->height
;
1099 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1102 /* With a very small font and a mode-line that's taller than
1103 default, we might end up with a negative height. */
1104 return max (0, height
);
1107 /* Return the window-relative coordinate of the left edge of display
1108 area AREA of window W. ANY_AREA means return the left edge of the
1109 whole window, to the right of the left fringe of W. */
1112 window_box_left_offset (struct window
*w
, enum glyph_row_area area
)
1116 if (w
->pseudo_window_p
)
1119 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1121 if (area
== TEXT_AREA
)
1122 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1123 + window_box_width (w
, LEFT_MARGIN_AREA
));
1124 else if (area
== RIGHT_MARGIN_AREA
)
1125 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1126 + window_box_width (w
, LEFT_MARGIN_AREA
)
1127 + window_box_width (w
, TEXT_AREA
)
1128 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1130 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1131 else if (area
== LEFT_MARGIN_AREA
1132 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1133 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1135 /* Don't return more than the window's pixel width. */
1136 return min (x
, w
->pixel_width
);
1140 /* Return the window-relative coordinate of the right edge of display
1141 area AREA of window W. ANY_AREA means return the right edge of the
1142 whole window, to the left of the right fringe of W. */
1145 window_box_right_offset (struct window
*w
, enum glyph_row_area area
)
1147 /* Don't return more than the window's pixel width. */
1148 return min (window_box_left_offset (w
, area
) + window_box_width (w
, area
),
1152 /* Return the frame-relative coordinate of the left edge of display
1153 area AREA of window W. ANY_AREA means return the left edge of the
1154 whole window, to the right of the left fringe of W. */
1157 window_box_left (struct window
*w
, enum glyph_row_area area
)
1159 struct frame
*f
= XFRAME (w
->frame
);
1162 if (w
->pseudo_window_p
)
1163 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1165 x
= (WINDOW_LEFT_EDGE_X (w
)
1166 + window_box_left_offset (w
, area
));
1172 /* Return the frame-relative coordinate of the right edge of display
1173 area AREA of window W. ANY_AREA means return the right edge of the
1174 whole window, to the left of the right fringe of W. */
1177 window_box_right (struct window
*w
, enum glyph_row_area area
)
1179 return window_box_left (w
, area
) + window_box_width (w
, area
);
1182 /* Get the bounding box of the display area AREA of window W, without
1183 mode lines, in frame-relative coordinates. ANY_AREA means the
1184 whole window, not including the left and right fringes of
1185 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1186 coordinates of the upper-left corner of the box. Return in
1187 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1190 window_box (struct window
*w
, enum glyph_row_area area
, int *box_x
,
1191 int *box_y
, int *box_width
, int *box_height
)
1194 *box_width
= window_box_width (w
, area
);
1196 *box_height
= window_box_height (w
);
1198 *box_x
= window_box_left (w
, area
);
1201 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1202 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1203 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1207 #ifdef HAVE_WINDOW_SYSTEM
1209 /* Get the bounding box of the display area AREA of window W, without
1210 mode lines and both fringes of the window. Return in *TOP_LEFT_X
1211 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1212 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1213 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1217 window_box_edges (struct window
*w
, int *top_left_x
, int *top_left_y
,
1218 int *bottom_right_x
, int *bottom_right_y
)
1220 window_box (w
, ANY_AREA
, top_left_x
, top_left_y
,
1221 bottom_right_x
, bottom_right_y
);
1222 *bottom_right_x
+= *top_left_x
;
1223 *bottom_right_y
+= *top_left_y
;
1226 #endif /* HAVE_WINDOW_SYSTEM */
1228 /***********************************************************************
1230 ***********************************************************************/
1232 /* Return the bottom y-position of the line the iterator IT is in.
1233 This can modify IT's settings. */
1236 line_bottom_y (struct it
*it
)
1238 int line_height
= it
->max_ascent
+ it
->max_descent
;
1239 int line_top_y
= it
->current_y
;
1241 if (line_height
== 0)
1244 line_height
= last_height
;
1245 else if (IT_CHARPOS (*it
) < ZV
)
1247 move_it_by_lines (it
, 1);
1248 line_height
= (it
->max_ascent
|| it
->max_descent
1249 ? it
->max_ascent
+ it
->max_descent
1254 struct glyph_row
*row
= it
->glyph_row
;
1256 /* Use the default character height. */
1257 it
->glyph_row
= NULL
;
1258 it
->what
= IT_CHARACTER
;
1261 PRODUCE_GLYPHS (it
);
1262 line_height
= it
->ascent
+ it
->descent
;
1263 it
->glyph_row
= row
;
1267 return line_top_y
+ line_height
;
1270 DEFUN ("line-pixel-height", Fline_pixel_height
,
1271 Sline_pixel_height
, 0, 0, 0,
1272 doc
: /* Return height in pixels of text line in the selected window.
1274 Value is the height in pixels of the line at point. */)
1279 struct window
*w
= XWINDOW (selected_window
);
1280 struct buffer
*old_buffer
= NULL
;
1283 if (XBUFFER (w
->contents
) != current_buffer
)
1285 old_buffer
= current_buffer
;
1286 set_buffer_internal_1 (XBUFFER (w
->contents
));
1288 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
1289 start_display (&it
, w
, pt
);
1290 it
.vpos
= it
.current_y
= 0;
1292 result
= make_number (line_bottom_y (&it
));
1294 set_buffer_internal_1 (old_buffer
);
1299 /* Return the default pixel height of text lines in window W. The
1300 value is the canonical height of the W frame's default font, plus
1301 any extra space required by the line-spacing variable or frame
1304 Implementation note: this ignores any line-spacing text properties
1305 put on the newline characters. This is because those properties
1306 only affect the _screen_ line ending in the newline (i.e., in a
1307 continued line, only the last screen line will be affected), which
1308 means only a small number of lines in a buffer can ever use this
1309 feature. Since this function is used to compute the default pixel
1310 equivalent of text lines in a window, we can safely ignore those
1311 few lines. For the same reasons, we ignore the line-height
1314 default_line_pixel_height (struct window
*w
)
1316 struct frame
*f
= WINDOW_XFRAME (w
);
1317 int height
= FRAME_LINE_HEIGHT (f
);
1319 if (!FRAME_INITIAL_P (f
) && BUFFERP (w
->contents
))
1321 struct buffer
*b
= XBUFFER (w
->contents
);
1322 Lisp_Object val
= BVAR (b
, extra_line_spacing
);
1325 val
= BVAR (&buffer_defaults
, extra_line_spacing
);
1328 if (RANGED_INTEGERP (0, val
, INT_MAX
))
1329 height
+= XFASTINT (val
);
1330 else if (FLOATP (val
))
1332 int addon
= XFLOAT_DATA (val
) * height
+ 0.5;
1339 height
+= f
->extra_line_spacing
;
1345 /* Subroutine of pos_visible_p below. Extracts a display string, if
1346 any, from the display spec given as its argument. */
1348 string_from_display_spec (Lisp_Object spec
)
1352 while (CONSP (spec
))
1354 if (STRINGP (XCAR (spec
)))
1359 else if (VECTORP (spec
))
1363 for (i
= 0; i
< ASIZE (spec
); i
++)
1365 if (STRINGP (AREF (spec
, i
)))
1366 return AREF (spec
, i
);
1375 /* Limit insanely large values of W->hscroll on frame F to the largest
1376 value that will still prevent first_visible_x and last_visible_x of
1377 'struct it' from overflowing an int. */
1379 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1381 ptrdiff_t window_hscroll
= w
->hscroll
;
1382 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1383 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1385 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1386 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1388 return window_hscroll
;
1391 /* Return 1 if position CHARPOS is visible in window W.
1392 CHARPOS < 0 means return info about WINDOW_END position.
1393 If visible, set *X and *Y to pixel coordinates of top left corner.
1394 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1395 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1398 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1399 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1402 void *itdata
= bidi_shelve_cache ();
1403 struct text_pos top
;
1405 struct buffer
*old_buffer
= NULL
;
1407 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1410 if (XBUFFER (w
->contents
) != current_buffer
)
1412 old_buffer
= current_buffer
;
1413 set_buffer_internal_1 (XBUFFER (w
->contents
));
1416 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1417 /* Scrolling a minibuffer window via scroll bar when the echo area
1418 shows long text sometimes resets the minibuffer contents behind
1420 if (CHARPOS (top
) > ZV
)
1421 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1423 /* Compute exact mode line heights. */
1424 if (WINDOW_WANTS_MODELINE_P (w
))
1426 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1427 BVAR (current_buffer
, mode_line_format
));
1429 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1430 w
->header_line_height
1431 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1432 BVAR (current_buffer
, header_line_format
));
1434 start_display (&it
, w
, top
);
1435 move_it_to (&it
, charpos
, -1, it
.last_visible_y
- 1, -1,
1436 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1439 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
!= -1)
1440 && IT_CHARPOS (it
) >= charpos
)
1441 /* When scanning backwards under bidi iteration, move_it_to
1442 stops at or _before_ CHARPOS, because it stops at or to
1443 the _right_ of the character at CHARPOS. */
1444 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1445 && IT_CHARPOS (it
) <= charpos
)))
1447 /* We have reached CHARPOS, or passed it. How the call to
1448 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1449 or covered by a display property, move_it_to stops at the end
1450 of the invisible text, to the right of CHARPOS. (ii) If
1451 CHARPOS is in a display vector, move_it_to stops on its last
1453 int top_x
= it
.current_x
;
1454 int top_y
= it
.current_y
;
1455 /* Calling line_bottom_y may change it.method, it.position, etc. */
1456 enum it_method it_method
= it
.method
;
1457 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1458 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1460 if (top_y
< window_top_y
)
1461 visible_p
= bottom_y
> window_top_y
;
1462 else if (top_y
< it
.last_visible_y
)
1464 if (bottom_y
>= it
.last_visible_y
1465 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1466 && IT_CHARPOS (it
) < charpos
)
1468 /* When the last line of the window is scanned backwards
1469 under bidi iteration, we could be duped into thinking
1470 that we have passed CHARPOS, when in fact move_it_to
1471 simply stopped short of CHARPOS because it reached
1472 last_visible_y. To see if that's what happened, we call
1473 move_it_to again with a slightly larger vertical limit,
1474 and see if it actually moved vertically; if it did, we
1475 didn't really reach CHARPOS, which is beyond window end. */
1476 struct it save_it
= it
;
1477 /* Why 10? because we don't know how many canonical lines
1478 will the height of the next line(s) be. So we guess. */
1479 int ten_more_lines
= 10 * default_line_pixel_height (w
);
1481 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1482 MOVE_TO_POS
| MOVE_TO_Y
);
1483 if (it
.current_y
> top_y
)
1490 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1492 /* We stopped on the last glyph of a display vector.
1493 Try and recompute. Hack alert! */
1494 if (charpos
< 2 || top
.charpos
>= charpos
)
1495 top_x
= it
.glyph_row
->x
;
1498 struct it it2
, it2_prev
;
1499 /* The idea is to get to the previous buffer
1500 position, consume the character there, and use
1501 the pixel coordinates we get after that. But if
1502 the previous buffer position is also displayed
1503 from a display vector, we need to consume all of
1504 the glyphs from that display vector. */
1505 start_display (&it2
, w
, top
);
1506 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1507 /* If we didn't get to CHARPOS - 1, there's some
1508 replacing display property at that position, and
1509 we stopped after it. That is exactly the place
1510 whose coordinates we want. */
1511 if (IT_CHARPOS (it2
) != charpos
- 1)
1515 /* Iterate until we get out of the display
1516 vector that displays the character at
1519 get_next_display_element (&it2
);
1520 PRODUCE_GLYPHS (&it2
);
1522 set_iterator_to_next (&it2
, 1);
1523 } while (it2
.method
== GET_FROM_DISPLAY_VECTOR
1524 && IT_CHARPOS (it2
) < charpos
);
1526 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev
)
1527 || it2_prev
.current_x
> it2_prev
.last_visible_x
)
1528 top_x
= it
.glyph_row
->x
;
1531 top_x
= it2_prev
.current_x
;
1532 top_y
= it2_prev
.current_y
;
1536 else if (IT_CHARPOS (it
) != charpos
)
1538 Lisp_Object cpos
= make_number (charpos
);
1539 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1540 Lisp_Object string
= string_from_display_spec (spec
);
1541 struct text_pos tpos
;
1542 int replacing_spec_p
;
1543 bool newline_in_string
1545 && memchr (SDATA (string
), '\n', SBYTES (string
)));
1547 SET_TEXT_POS (tpos
, charpos
, CHAR_TO_BYTE (charpos
));
1550 && handle_display_spec (NULL
, spec
, Qnil
, Qnil
, &tpos
,
1551 charpos
, FRAME_WINDOW_P (it
.f
)));
1552 /* The tricky code below is needed because there's a
1553 discrepancy between move_it_to and how we set cursor
1554 when PT is at the beginning of a portion of text
1555 covered by a display property or an overlay with a
1556 display property, or the display line ends in a
1557 newline from a display string. move_it_to will stop
1558 _after_ such display strings, whereas
1559 set_cursor_from_row conspires with cursor_row_p to
1560 place the cursor on the first glyph produced from the
1563 /* We have overshoot PT because it is covered by a
1564 display property that replaces the text it covers.
1565 If the string includes embedded newlines, we are also
1566 in the wrong display line. Backtrack to the correct
1567 line, where the display property begins. */
1568 if (replacing_spec_p
)
1570 Lisp_Object startpos
, endpos
;
1571 EMACS_INT start
, end
;
1575 /* Find the first and the last buffer positions
1576 covered by the display string. */
1578 Fnext_single_char_property_change (cpos
, Qdisplay
,
1581 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1583 start
= XFASTINT (startpos
);
1584 end
= XFASTINT (endpos
);
1585 /* Move to the last buffer position before the
1586 display property. */
1587 start_display (&it3
, w
, top
);
1588 if (start
> CHARPOS (top
))
1589 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1590 /* Move forward one more line if the position before
1591 the display string is a newline or if it is the
1592 rightmost character on a line that is
1593 continued or word-wrapped. */
1594 if (it3
.method
== GET_FROM_BUFFER
1596 || FETCH_BYTE (IT_BYTEPOS (it3
)) == '\n'))
1597 move_it_by_lines (&it3
, 1);
1598 else if (move_it_in_display_line_to (&it3
, -1,
1602 == MOVE_LINE_CONTINUED
)
1604 move_it_by_lines (&it3
, 1);
1605 /* When we are under word-wrap, the #$@%!
1606 move_it_by_lines moves 2 lines, so we need to
1608 if (it3
.line_wrap
== WORD_WRAP
)
1609 move_it_by_lines (&it3
, -1);
1612 /* Record the vertical coordinate of the display
1613 line where we wound up. */
1614 top_y
= it3
.current_y
;
1617 /* When characters are reordered for display,
1618 the character displayed to the left of the
1619 display string could be _after_ the display
1620 property in the logical order. Use the
1621 smallest vertical position of these two. */
1622 start_display (&it3
, w
, top
);
1623 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1624 if (it3
.current_y
< top_y
)
1625 top_y
= it3
.current_y
;
1627 /* Move from the top of the window to the beginning
1628 of the display line where the display string
1630 start_display (&it3
, w
, top
);
1631 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1632 /* If it3_moved stays zero after the 'while' loop
1633 below, that means we already were at a newline
1634 before the loop (e.g., the display string begins
1635 with a newline), so we don't need to (and cannot)
1636 inspect the glyphs of it3.glyph_row, because
1637 PRODUCE_GLYPHS will not produce anything for a
1638 newline, and thus it3.glyph_row stays at its
1639 stale content it got at top of the window. */
1641 /* Finally, advance the iterator until we hit the
1642 first display element whose character position is
1643 CHARPOS, or until the first newline from the
1644 display string, which signals the end of the
1646 while (get_next_display_element (&it3
))
1648 PRODUCE_GLYPHS (&it3
);
1649 if (IT_CHARPOS (it3
) == charpos
1650 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1653 set_iterator_to_next (&it3
, 0);
1655 top_x
= it3
.current_x
- it3
.pixel_width
;
1656 /* Normally, we would exit the above loop because we
1657 found the display element whose character
1658 position is CHARPOS. For the contingency that we
1659 didn't, and stopped at the first newline from the
1660 display string, move back over the glyphs
1661 produced from the string, until we find the
1662 rightmost glyph not from the string. */
1664 && newline_in_string
1665 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1667 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1668 + it3
.glyph_row
->used
[TEXT_AREA
];
1670 while (EQ ((g
- 1)->object
, string
))
1673 top_x
-= g
->pixel_width
;
1675 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1676 + it3
.glyph_row
->used
[TEXT_AREA
]);
1682 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1683 *rtop
= max (0, window_top_y
- top_y
);
1684 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1685 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1686 - max (top_y
, window_top_y
)));
1692 /* Either we were asked to provide info about WINDOW_END, or
1693 CHARPOS is in the partially visible glyph row at end of
1696 void *it2data
= NULL
;
1698 SAVE_IT (it2
, it
, it2data
);
1699 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1700 move_it_by_lines (&it
, 1);
1701 if (charpos
< IT_CHARPOS (it
)
1702 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1705 RESTORE_IT (&it2
, &it2
, it2data
);
1706 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1708 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1709 *rtop
= max (0, -it2
.current_y
);
1710 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1711 - it
.last_visible_y
));
1712 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1714 - max (it2
.current_y
,
1715 WINDOW_HEADER_LINE_HEIGHT (w
))));
1719 bidi_unshelve_cache (it2data
, 1);
1721 bidi_unshelve_cache (itdata
, 0);
1724 set_buffer_internal_1 (old_buffer
);
1726 if (visible_p
&& w
->hscroll
> 0)
1728 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1729 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1732 /* Debugging code. */
1734 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1735 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1737 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1744 /* Return the next character from STR. Return in *LEN the length of
1745 the character. This is like STRING_CHAR_AND_LENGTH but never
1746 returns an invalid character. If we find one, we return a `?', but
1747 with the length of the invalid character. */
1750 string_char_and_length (const unsigned char *str
, int *len
)
1754 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1755 if (!CHAR_VALID_P (c
))
1756 /* We may not change the length here because other places in Emacs
1757 don't use this function, i.e. they silently accept invalid
1766 /* Given a position POS containing a valid character and byte position
1767 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1769 static struct text_pos
1770 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1772 eassert (STRINGP (string
) && nchars
>= 0);
1774 if (STRING_MULTIBYTE (string
))
1776 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1781 string_char_and_length (p
, &len
);
1784 BYTEPOS (pos
) += len
;
1788 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1794 /* Value is the text position, i.e. character and byte position,
1795 for character position CHARPOS in STRING. */
1797 static struct text_pos
1798 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1800 struct text_pos pos
;
1801 eassert (STRINGP (string
));
1802 eassert (charpos
>= 0);
1803 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1808 /* Value is a text position, i.e. character and byte position, for
1809 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1810 means recognize multibyte characters. */
1812 static struct text_pos
1813 c_string_pos (ptrdiff_t charpos
, const char *s
, bool multibyte_p
)
1815 struct text_pos pos
;
1817 eassert (s
!= NULL
);
1818 eassert (charpos
>= 0);
1824 SET_TEXT_POS (pos
, 0, 0);
1827 string_char_and_length ((const unsigned char *) s
, &len
);
1830 BYTEPOS (pos
) += len
;
1834 SET_TEXT_POS (pos
, charpos
, charpos
);
1840 /* Value is the number of characters in C string S. MULTIBYTE_P
1841 non-zero means recognize multibyte characters. */
1844 number_of_chars (const char *s
, bool multibyte_p
)
1850 ptrdiff_t rest
= strlen (s
);
1852 const unsigned char *p
= (const unsigned char *) s
;
1854 for (nchars
= 0; rest
> 0; ++nchars
)
1856 string_char_and_length (p
, &len
);
1857 rest
-= len
, p
+= len
;
1861 nchars
= strlen (s
);
1867 /* Compute byte position NEWPOS->bytepos corresponding to
1868 NEWPOS->charpos. POS is a known position in string STRING.
1869 NEWPOS->charpos must be >= POS.charpos. */
1872 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1874 eassert (STRINGP (string
));
1875 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1877 if (STRING_MULTIBYTE (string
))
1878 *newpos
= string_pos_nchars_ahead (pos
, string
,
1879 CHARPOS (*newpos
) - CHARPOS (pos
));
1881 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1885 Return an estimation of the pixel height of mode or header lines on
1886 frame F. FACE_ID specifies what line's height to estimate. */
1889 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1891 #ifdef HAVE_WINDOW_SYSTEM
1892 if (FRAME_WINDOW_P (f
))
1894 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1896 /* This function is called so early when Emacs starts that the face
1897 cache and mode line face are not yet initialized. */
1898 if (FRAME_FACE_CACHE (f
))
1900 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1904 height
= FONT_HEIGHT (face
->font
);
1905 if (face
->box_line_width
> 0)
1906 height
+= 2 * face
->box_line_width
;
1917 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1918 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1919 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1920 not force the value into range. */
1923 pixel_to_glyph_coords (struct frame
*f
, register int pix_x
, register int pix_y
,
1924 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1927 #ifdef HAVE_WINDOW_SYSTEM
1928 if (FRAME_WINDOW_P (f
))
1930 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1931 even for negative values. */
1933 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1935 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1937 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1938 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1941 STORE_NATIVE_RECT (*bounds
,
1942 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1943 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1944 FRAME_COLUMN_WIDTH (f
) - 1,
1945 FRAME_LINE_HEIGHT (f
) - 1);
1947 /* PXW: Should we clip pixels before converting to columns/lines? */
1952 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1953 pix_x
= FRAME_TOTAL_COLS (f
);
1957 else if (pix_y
> FRAME_LINES (f
))
1958 pix_y
= FRAME_LINES (f
);
1968 /* Find the glyph under window-relative coordinates X/Y in window W.
1969 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1970 strings. Return in *HPOS and *VPOS the row and column number of
1971 the glyph found. Return in *AREA the glyph area containing X.
1972 Value is a pointer to the glyph found or null if X/Y is not on
1973 text, or we can't tell because W's current matrix is not up to
1976 static struct glyph
*
1977 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1978 int *dx
, int *dy
, int *area
)
1980 struct glyph
*glyph
, *end
;
1981 struct glyph_row
*row
= NULL
;
1984 /* Find row containing Y. Give up if some row is not enabled. */
1985 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1987 row
= MATRIX_ROW (w
->current_matrix
, i
);
1988 if (!row
->enabled_p
)
1990 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1997 /* Give up if Y is not in the window. */
1998 if (i
== w
->current_matrix
->nrows
)
2001 /* Get the glyph area containing X. */
2002 if (w
->pseudo_window_p
)
2009 if (x
< window_box_left_offset (w
, TEXT_AREA
))
2011 *area
= LEFT_MARGIN_AREA
;
2012 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
2014 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
2017 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
2021 *area
= RIGHT_MARGIN_AREA
;
2022 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
2026 /* Find glyph containing X. */
2027 glyph
= row
->glyphs
[*area
];
2028 end
= glyph
+ row
->used
[*area
];
2030 while (glyph
< end
&& x
>= glyph
->pixel_width
)
2032 x
-= glyph
->pixel_width
;
2042 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
2045 *hpos
= glyph
- row
->glyphs
[*area
];
2049 /* Convert frame-relative x/y to coordinates relative to window W.
2050 Takes pseudo-windows into account. */
2053 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
2055 if (w
->pseudo_window_p
)
2057 /* A pseudo-window is always full-width, and starts at the
2058 left edge of the frame, plus a frame border. */
2059 struct frame
*f
= XFRAME (w
->frame
);
2060 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
2061 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
2065 *x
-= WINDOW_LEFT_EDGE_X (w
);
2066 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
2070 #ifdef HAVE_WINDOW_SYSTEM
2073 Return in RECTS[] at most N clipping rectangles for glyph string S.
2074 Return the number of stored rectangles. */
2077 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
2084 if (s
->row
->full_width_p
)
2086 /* Draw full-width. X coordinates are relative to S->w->left_col. */
2087 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
2088 if (s
->row
->mode_line_p
)
2089 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
) - WINDOW_RIGHT_DIVIDER_WIDTH (s
->w
);
2091 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
);
2093 /* Unless displaying a mode or menu bar line, which are always
2094 fully visible, clip to the visible part of the row. */
2095 if (s
->w
->pseudo_window_p
)
2096 r
.height
= s
->row
->visible_height
;
2098 r
.height
= s
->height
;
2102 /* This is a text line that may be partially visible. */
2103 r
.x
= window_box_left (s
->w
, s
->area
);
2104 r
.width
= window_box_width (s
->w
, s
->area
);
2105 r
.height
= s
->row
->visible_height
;
2109 if (r
.x
< s
->clip_head
->x
)
2111 if (r
.width
>= s
->clip_head
->x
- r
.x
)
2112 r
.width
-= s
->clip_head
->x
- r
.x
;
2115 r
.x
= s
->clip_head
->x
;
2118 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
2120 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
2121 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
2126 /* If S draws overlapping rows, it's sufficient to use the top and
2127 bottom of the window for clipping because this glyph string
2128 intentionally draws over other lines. */
2129 if (s
->for_overlaps
)
2131 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2132 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2134 /* Alas, the above simple strategy does not work for the
2135 environments with anti-aliased text: if the same text is
2136 drawn onto the same place multiple times, it gets thicker.
2137 If the overlap we are processing is for the erased cursor, we
2138 take the intersection with the rectangle of the cursor. */
2139 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2141 XRectangle rc
, r_save
= r
;
2143 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2144 rc
.y
= s
->w
->phys_cursor
.y
;
2145 rc
.width
= s
->w
->phys_cursor_width
;
2146 rc
.height
= s
->w
->phys_cursor_height
;
2148 x_intersect_rectangles (&r_save
, &rc
, &r
);
2153 /* Don't use S->y for clipping because it doesn't take partially
2154 visible lines into account. For example, it can be negative for
2155 partially visible lines at the top of a window. */
2156 if (!s
->row
->full_width_p
2157 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2158 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2160 r
.y
= max (0, s
->row
->y
);
2163 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2165 /* If drawing the cursor, don't let glyph draw outside its
2166 advertised boundaries. Cleartype does this under some circumstances. */
2167 if (s
->hl
== DRAW_CURSOR
)
2169 struct glyph
*glyph
= s
->first_glyph
;
2174 r
.width
-= s
->x
- r
.x
;
2177 r
.width
= min (r
.width
, glyph
->pixel_width
);
2179 /* If r.y is below window bottom, ensure that we still see a cursor. */
2180 height
= min (glyph
->ascent
+ glyph
->descent
,
2181 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2182 max_y
= window_text_bottom_y (s
->w
) - height
;
2183 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2184 if (s
->ybase
- glyph
->ascent
> max_y
)
2191 /* Don't draw cursor glyph taller than our actual glyph. */
2192 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2193 if (height
< r
.height
)
2195 max_y
= r
.y
+ r
.height
;
2196 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2197 r
.height
= min (max_y
- r
.y
, height
);
2204 XRectangle r_save
= r
;
2206 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2210 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2211 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2213 #ifdef CONVERT_FROM_XRECT
2214 CONVERT_FROM_XRECT (r
, *rects
);
2222 /* If we are processing overlapping and allowed to return
2223 multiple clipping rectangles, we exclude the row of the glyph
2224 string from the clipping rectangle. This is to avoid drawing
2225 the same text on the environment with anti-aliasing. */
2226 #ifdef CONVERT_FROM_XRECT
2229 XRectangle
*rs
= rects
;
2231 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2233 if (s
->for_overlaps
& OVERLAPS_PRED
)
2236 if (r
.y
+ r
.height
> row_y
)
2239 rs
[i
].height
= row_y
- r
.y
;
2245 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2248 if (r
.y
< row_y
+ s
->row
->visible_height
)
2250 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2252 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2253 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2262 #ifdef CONVERT_FROM_XRECT
2263 for (i
= 0; i
< n
; i
++)
2264 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2271 Return in *NR the clipping rectangle for glyph string S. */
2274 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2276 get_glyph_string_clip_rects (s
, nr
, 1);
2281 Return the position and height of the phys cursor in window W.
2282 Set w->phys_cursor_width to width of phys cursor.
2286 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2287 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2289 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2290 int x
, y
, wd
, h
, h0
, y0
;
2292 /* Compute the width of the rectangle to draw. If on a stretch
2293 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2294 rectangle as wide as the glyph, but use a canonical character
2296 wd
= glyph
->pixel_width
- 1;
2297 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2301 x
= w
->phys_cursor
.x
;
2308 if (glyph
->type
== STRETCH_GLYPH
2309 && !x_stretch_cursor_p
)
2310 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2311 w
->phys_cursor_width
= wd
;
2313 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2315 /* If y is below window bottom, ensure that we still see a cursor. */
2316 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2318 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2319 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2321 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2324 h
= max (h
- (y0
- y
) + 1, h0
);
2329 y0
= window_text_bottom_y (w
) - h0
;
2337 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2338 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2343 * Remember which glyph the mouse is over.
2347 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2351 struct glyph_row
*r
, *gr
, *end_row
;
2352 enum window_part part
;
2353 enum glyph_row_area area
;
2354 int x
, y
, width
, height
;
2356 /* Try to determine frame pixel position and size of the glyph under
2357 frame pixel coordinates X/Y on frame F. */
2359 if (window_resize_pixelwise
)
2364 else if (!f
->glyphs_initialized_p
2365 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2368 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2369 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2373 w
= XWINDOW (window
);
2374 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2375 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2377 x
= window_relative_x_coord (w
, part
, gx
);
2378 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2380 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2381 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2383 if (w
->pseudo_window_p
)
2386 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2392 case ON_LEFT_MARGIN
:
2393 area
= LEFT_MARGIN_AREA
;
2396 case ON_RIGHT_MARGIN
:
2397 area
= RIGHT_MARGIN_AREA
;
2400 case ON_HEADER_LINE
:
2402 gr
= (part
== ON_HEADER_LINE
2403 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2404 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2407 goto text_glyph_row_found
;
2414 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2415 if (r
->y
+ r
->height
> y
)
2421 text_glyph_row_found
:
2424 struct glyph
*g
= gr
->glyphs
[area
];
2425 struct glyph
*end
= g
+ gr
->used
[area
];
2427 height
= gr
->height
;
2428 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2429 if (gx
+ g
->pixel_width
> x
)
2434 if (g
->type
== IMAGE_GLYPH
)
2436 /* Don't remember when mouse is over image, as
2437 image may have hot-spots. */
2438 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2441 width
= g
->pixel_width
;
2445 /* Use nominal char spacing at end of line. */
2447 gx
+= (x
/ width
) * width
;
2450 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2452 gx
+= window_box_left_offset (w
, area
);
2453 /* Don't expand over the modeline to make sure the vertical
2454 drag cursor is shown early enough. */
2455 height
= min (height
,
2456 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2461 /* Use nominal line height at end of window. */
2462 gx
= (x
/ width
) * width
;
2464 gy
+= (y
/ height
) * height
;
2465 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2466 /* See comment above. */
2467 height
= min (height
,
2468 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2472 case ON_LEFT_FRINGE
:
2473 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2474 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2475 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2476 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2479 case ON_RIGHT_FRINGE
:
2480 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2481 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2482 : window_box_right_offset (w
, TEXT_AREA
));
2483 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0
2484 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
2485 && !WINDOW_RIGHTMOST_P (w
))
2486 if (gx
< WINDOW_PIXEL_WIDTH (w
) - width
)
2487 /* Make sure the vertical border can get her own glyph to the
2488 right of the one we build here. */
2489 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
) - width
;
2491 width
= WINDOW_PIXEL_WIDTH (w
) - gx
;
2493 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2497 case ON_VERTICAL_BORDER
:
2498 gx
= WINDOW_PIXEL_WIDTH (w
) - width
;
2502 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2504 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2505 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2506 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2508 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2512 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2513 if (r
->y
+ r
->height
> y
)
2520 height
= gr
->height
;
2523 /* Use nominal line height at end of window. */
2525 gy
+= (y
/ height
) * height
;
2529 case ON_RIGHT_DIVIDER
:
2530 gx
= WINDOW_PIXEL_WIDTH (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2531 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2533 /* The bottom divider prevails. */
2534 height
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2537 case ON_BOTTOM_DIVIDER
:
2539 width
= WINDOW_PIXEL_WIDTH (w
);
2540 gy
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2541 height
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2547 /* If there is no glyph under the mouse, then we divide the screen
2548 into a grid of the smallest glyph in the frame, and use that
2551 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2552 round down even for negative values. */
2558 gx
= (gx
/ width
) * width
;
2559 gy
= (gy
/ height
) * height
;
2565 gx
+= WINDOW_LEFT_EDGE_X (w
);
2566 gy
+= WINDOW_TOP_EDGE_Y (w
);
2569 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2571 /* Visible feedback for debugging. */
2574 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2575 f
->output_data
.x
->normal_gc
,
2576 gx
, gy
, width
, height
);
2582 #endif /* HAVE_WINDOW_SYSTEM */
2585 adjust_window_ends (struct window
*w
, struct glyph_row
*row
, bool current
)
2588 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
2589 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
2591 = MATRIX_ROW_VPOS (row
, current
? w
->current_matrix
: w
->desired_matrix
);
2594 /***********************************************************************
2595 Lisp form evaluation
2596 ***********************************************************************/
2598 /* Error handler for safe_eval and safe_call. */
2601 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2603 add_to_log ("Error during redisplay: %S signaled %S",
2604 Flist (nargs
, args
), arg
);
2608 /* Call function FUNC with the rest of NARGS - 1 arguments
2609 following. Return the result, or nil if something went
2610 wrong. Prevent redisplay during the evaluation. */
2613 safe__call (bool inhibit_quit
, ptrdiff_t nargs
, Lisp_Object func
, va_list ap
)
2617 if (inhibit_eval_during_redisplay
)
2622 ptrdiff_t count
= SPECPDL_INDEX ();
2623 struct gcpro gcpro1
;
2624 Lisp_Object
*args
= alloca (nargs
* word_size
);
2627 for (i
= 1; i
< nargs
; i
++)
2628 args
[i
] = va_arg (ap
, Lisp_Object
);
2631 gcpro1
.nvars
= nargs
;
2632 specbind (Qinhibit_redisplay
, Qt
);
2634 specbind (Qinhibit_quit
, Qt
);
2635 /* Use Qt to ensure debugger does not run,
2636 so there is no possibility of wanting to redisplay. */
2637 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2640 val
= unbind_to (count
, val
);
2647 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2652 va_start (ap
, func
);
2653 retval
= safe__call (false, nargs
, func
, ap
);
2658 /* Call function FN with one argument ARG.
2659 Return the result, or nil if something went wrong. */
2662 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2664 return safe_call (2, fn
, arg
);
2668 safe__call1 (bool inhibit_quit
, Lisp_Object fn
, ...)
2674 retval
= safe__call (inhibit_quit
, 2, fn
, ap
);
2679 static Lisp_Object Qeval
;
2682 safe_eval (Lisp_Object sexpr
)
2684 return safe__call1 (false, Qeval
, sexpr
);
2688 safe__eval (bool inhibit_quit
, Lisp_Object sexpr
)
2690 return safe__call1 (inhibit_quit
, Qeval
, sexpr
);
2693 /* Call function FN with two arguments ARG1 and ARG2.
2694 Return the result, or nil if something went wrong. */
2697 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2699 return safe_call (3, fn
, arg1
, arg2
);
2704 /***********************************************************************
2706 ***********************************************************************/
2710 /* Define CHECK_IT to perform sanity checks on iterators.
2711 This is for debugging. It is too slow to do unconditionally. */
2714 check_it (struct it
*it
)
2716 if (it
->method
== GET_FROM_STRING
)
2718 eassert (STRINGP (it
->string
));
2719 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2723 eassert (IT_STRING_CHARPOS (*it
) < 0);
2724 if (it
->method
== GET_FROM_BUFFER
)
2726 /* Check that character and byte positions agree. */
2727 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2732 eassert (it
->current
.dpvec_index
>= 0);
2734 eassert (it
->current
.dpvec_index
< 0);
2737 #define CHECK_IT(IT) check_it ((IT))
2741 #define CHECK_IT(IT) (void) 0
2746 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2748 /* Check that the window end of window W is what we expect it
2749 to be---the last row in the current matrix displaying text. */
2752 check_window_end (struct window
*w
)
2754 if (!MINI_WINDOW_P (w
) && w
->window_end_valid
)
2756 struct glyph_row
*row
;
2757 eassert ((row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
),
2759 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2760 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2764 #define CHECK_WINDOW_END(W) check_window_end ((W))
2768 #define CHECK_WINDOW_END(W) (void) 0
2770 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
2772 /***********************************************************************
2773 Iterator initialization
2774 ***********************************************************************/
2776 /* Initialize IT for displaying current_buffer in window W, starting
2777 at character position CHARPOS. CHARPOS < 0 means that no buffer
2778 position is specified which is useful when the iterator is assigned
2779 a position later. BYTEPOS is the byte position corresponding to
2782 If ROW is not null, calls to produce_glyphs with IT as parameter
2783 will produce glyphs in that row.
2785 BASE_FACE_ID is the id of a base face to use. It must be one of
2786 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2787 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2788 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2790 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2791 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2792 will be initialized to use the corresponding mode line glyph row of
2793 the desired matrix of W. */
2796 init_iterator (struct it
*it
, struct window
*w
,
2797 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2798 struct glyph_row
*row
, enum face_id base_face_id
)
2800 enum face_id remapped_base_face_id
= base_face_id
;
2802 /* Some precondition checks. */
2803 eassert (w
!= NULL
&& it
!= NULL
);
2804 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2807 /* If face attributes have been changed since the last redisplay,
2808 free realized faces now because they depend on face definitions
2809 that might have changed. Don't free faces while there might be
2810 desired matrices pending which reference these faces. */
2811 if (face_change_count
&& !inhibit_free_realized_faces
)
2813 face_change_count
= 0;
2814 free_all_realized_faces (Qnil
);
2817 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2818 if (! NILP (Vface_remapping_alist
))
2819 remapped_base_face_id
2820 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2822 /* Use one of the mode line rows of W's desired matrix if
2826 if (base_face_id
== MODE_LINE_FACE_ID
2827 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2828 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2829 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2830 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2834 memset (it
, 0, sizeof *it
);
2835 it
->current
.overlay_string_index
= -1;
2836 it
->current
.dpvec_index
= -1;
2837 it
->base_face_id
= remapped_base_face_id
;
2839 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2840 it
->paragraph_embedding
= L2R
;
2841 it
->bidi_it
.string
.lstring
= Qnil
;
2842 it
->bidi_it
.string
.s
= NULL
;
2843 it
->bidi_it
.string
.bufpos
= 0;
2846 /* The window in which we iterate over current_buffer: */
2847 XSETWINDOW (it
->window
, w
);
2849 it
->f
= XFRAME (w
->frame
);
2853 /* Extra space between lines (on window systems only). */
2854 if (base_face_id
== DEFAULT_FACE_ID
2855 && FRAME_WINDOW_P (it
->f
))
2857 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2858 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2859 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2860 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2861 * FRAME_LINE_HEIGHT (it
->f
));
2862 else if (it
->f
->extra_line_spacing
> 0)
2863 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2864 it
->max_extra_line_spacing
= 0;
2867 /* If realized faces have been removed, e.g. because of face
2868 attribute changes of named faces, recompute them. When running
2869 in batch mode, the face cache of the initial frame is null. If
2870 we happen to get called, make a dummy face cache. */
2871 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2872 init_frame_faces (it
->f
);
2873 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2874 recompute_basic_faces (it
->f
);
2876 /* Current value of the `slice', `space-width', and 'height' properties. */
2877 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2878 it
->space_width
= Qnil
;
2879 it
->font_height
= Qnil
;
2880 it
->override_ascent
= -1;
2882 /* Are control characters displayed as `^C'? */
2883 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2885 /* -1 means everything between a CR and the following line end
2886 is invisible. >0 means lines indented more than this value are
2888 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2890 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2892 : (!NILP (BVAR (current_buffer
, selective_display
))
2894 it
->selective_display_ellipsis_p
2895 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2897 /* Display table to use. */
2898 it
->dp
= window_display_table (w
);
2900 /* Are multibyte characters enabled in current_buffer? */
2901 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2903 /* Get the position at which the redisplay_end_trigger hook should
2904 be run, if it is to be run at all. */
2905 if (MARKERP (w
->redisplay_end_trigger
)
2906 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2907 it
->redisplay_end_trigger_charpos
2908 = marker_position (w
->redisplay_end_trigger
);
2909 else if (INTEGERP (w
->redisplay_end_trigger
))
2910 it
->redisplay_end_trigger_charpos
2911 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2914 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2916 /* Are lines in the display truncated? */
2917 if (base_face_id
!= DEFAULT_FACE_ID
2919 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2920 && ((!NILP (Vtruncate_partial_width_windows
)
2921 && !INTEGERP (Vtruncate_partial_width_windows
))
2922 || (INTEGERP (Vtruncate_partial_width_windows
)
2923 /* PXW: Shall we do something about this? */
2924 && (WINDOW_TOTAL_COLS (it
->w
)
2925 < XINT (Vtruncate_partial_width_windows
))))))
2926 it
->line_wrap
= TRUNCATE
;
2927 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2928 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2929 ? WINDOW_WRAP
: WORD_WRAP
;
2931 it
->line_wrap
= TRUNCATE
;
2933 /* Get dimensions of truncation and continuation glyphs. These are
2934 displayed as fringe bitmaps under X, but we need them for such
2935 frames when the fringes are turned off. But leave the dimensions
2936 zero for tooltip frames, as these glyphs look ugly there and also
2937 sabotage calculations of tooltip dimensions in x-show-tip. */
2938 #ifdef HAVE_WINDOW_SYSTEM
2939 if (!(FRAME_WINDOW_P (it
->f
)
2940 && FRAMEP (tip_frame
)
2941 && it
->f
== XFRAME (tip_frame
)))
2944 if (it
->line_wrap
== TRUNCATE
)
2946 /* We will need the truncation glyph. */
2947 eassert (it
->glyph_row
== NULL
);
2948 produce_special_glyphs (it
, IT_TRUNCATION
);
2949 it
->truncation_pixel_width
= it
->pixel_width
;
2953 /* We will need the continuation glyph. */
2954 eassert (it
->glyph_row
== NULL
);
2955 produce_special_glyphs (it
, IT_CONTINUATION
);
2956 it
->continuation_pixel_width
= it
->pixel_width
;
2960 /* Reset these values to zero because the produce_special_glyphs
2961 above has changed them. */
2962 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2963 it
->phys_ascent
= it
->phys_descent
= 0;
2965 /* Set this after getting the dimensions of truncation and
2966 continuation glyphs, so that we don't produce glyphs when calling
2967 produce_special_glyphs, above. */
2968 it
->glyph_row
= row
;
2969 it
->area
= TEXT_AREA
;
2971 /* Forget any previous info about this row being reversed. */
2973 it
->glyph_row
->reversed_p
= 0;
2975 /* Get the dimensions of the display area. The display area
2976 consists of the visible window area plus a horizontally scrolled
2977 part to the left of the window. All x-values are relative to the
2978 start of this total display area. */
2979 if (base_face_id
!= DEFAULT_FACE_ID
)
2981 /* Mode lines, menu bar in terminal frames. */
2982 it
->first_visible_x
= 0;
2983 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2988 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2989 it
->last_visible_x
= (it
->first_visible_x
2990 + window_box_width (w
, TEXT_AREA
));
2992 /* If we truncate lines, leave room for the truncation glyph(s) at
2993 the right margin. Otherwise, leave room for the continuation
2994 glyph(s). Done only if the window has no fringes. Since we
2995 don't know at this point whether there will be any R2L lines in
2996 the window, we reserve space for truncation/continuation glyphs
2997 even if only one of the fringes is absent. */
2998 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
2999 || (it
->bidi_p
&& WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
3001 if (it
->line_wrap
== TRUNCATE
)
3002 it
->last_visible_x
-= it
->truncation_pixel_width
;
3004 it
->last_visible_x
-= it
->continuation_pixel_width
;
3007 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
3008 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
3011 /* Leave room for a border glyph. */
3012 if (!FRAME_WINDOW_P (it
->f
)
3013 && !WINDOW_RIGHTMOST_P (it
->w
))
3014 it
->last_visible_x
-= 1;
3016 it
->last_visible_y
= window_text_bottom_y (w
);
3018 /* For mode lines and alike, arrange for the first glyph having a
3019 left box line if the face specifies a box. */
3020 if (base_face_id
!= DEFAULT_FACE_ID
)
3024 it
->face_id
= remapped_base_face_id
;
3026 /* If we have a boxed mode line, make the first character appear
3027 with a left box line. */
3028 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
3029 if (face
&& face
->box
!= FACE_NO_BOX
)
3030 it
->start_of_box_run_p
= true;
3033 /* If a buffer position was specified, set the iterator there,
3034 getting overlays and face properties from that position. */
3035 if (charpos
>= BUF_BEG (current_buffer
))
3037 it
->end_charpos
= ZV
;
3038 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
3039 IT_CHARPOS (*it
) = charpos
;
3040 IT_BYTEPOS (*it
) = bytepos
;
3042 /* We will rely on `reseat' to set this up properly, via
3043 handle_face_prop. */
3044 it
->face_id
= it
->base_face_id
;
3046 it
->start
= it
->current
;
3047 /* Do we need to reorder bidirectional text? Not if this is a
3048 unibyte buffer: by definition, none of the single-byte
3049 characters are strong R2L, so no reordering is needed. And
3050 bidi.c doesn't support unibyte buffers anyway. Also, don't
3051 reorder while we are loading loadup.el, since the tables of
3052 character properties needed for reordering are not yet
3056 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
3059 /* If we are to reorder bidirectional text, init the bidi
3063 /* Note the paragraph direction that this buffer wants to
3065 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
3067 it
->paragraph_embedding
= L2R
;
3068 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
3070 it
->paragraph_embedding
= R2L
;
3072 it
->paragraph_embedding
= NEUTRAL_DIR
;
3073 bidi_unshelve_cache (NULL
, 0);
3074 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
3078 /* Compute faces etc. */
3079 reseat (it
, it
->current
.pos
, 1);
3086 /* Initialize IT for the display of window W with window start POS. */
3089 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
3091 struct glyph_row
*row
;
3092 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
3094 row
= w
->desired_matrix
->rows
+ first_vpos
;
3095 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
3096 it
->first_vpos
= first_vpos
;
3098 /* Don't reseat to previous visible line start if current start
3099 position is in a string or image. */
3100 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
3102 int start_at_line_beg_p
;
3103 int first_y
= it
->current_y
;
3105 /* If window start is not at a line start, skip forward to POS to
3106 get the correct continuation lines width. */
3107 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
3108 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
3109 if (!start_at_line_beg_p
)
3113 reseat_at_previous_visible_line_start (it
);
3114 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
3116 new_x
= it
->current_x
+ it
->pixel_width
;
3118 /* If lines are continued, this line may end in the middle
3119 of a multi-glyph character (e.g. a control character
3120 displayed as \003, or in the middle of an overlay
3121 string). In this case move_it_to above will not have
3122 taken us to the start of the continuation line but to the
3123 end of the continued line. */
3124 if (it
->current_x
> 0
3125 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
3126 && (/* And glyph doesn't fit on the line. */
3127 new_x
> it
->last_visible_x
3128 /* Or it fits exactly and we're on a window
3130 || (new_x
== it
->last_visible_x
3131 && FRAME_WINDOW_P (it
->f
)
3132 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
3133 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
3134 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
3136 if ((it
->current
.dpvec_index
>= 0
3137 || it
->current
.overlay_string_index
>= 0)
3138 /* If we are on a newline from a display vector or
3139 overlay string, then we are already at the end of
3140 a screen line; no need to go to the next line in
3141 that case, as this line is not really continued.
3142 (If we do go to the next line, C-e will not DTRT.) */
3145 set_iterator_to_next (it
, 1);
3146 move_it_in_display_line_to (it
, -1, -1, 0);
3149 it
->continuation_lines_width
+= it
->current_x
;
3151 /* If the character at POS is displayed via a display
3152 vector, move_it_to above stops at the final glyph of
3153 IT->dpvec. To make the caller redisplay that character
3154 again (a.k.a. start at POS), we need to reset the
3155 dpvec_index to the beginning of IT->dpvec. */
3156 else if (it
->current
.dpvec_index
>= 0)
3157 it
->current
.dpvec_index
= 0;
3159 /* We're starting a new display line, not affected by the
3160 height of the continued line, so clear the appropriate
3161 fields in the iterator structure. */
3162 it
->max_ascent
= it
->max_descent
= 0;
3163 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3165 it
->current_y
= first_y
;
3167 it
->current_x
= it
->hpos
= 0;
3173 /* Return 1 if POS is a position in ellipses displayed for invisible
3174 text. W is the window we display, for text property lookup. */
3177 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3179 Lisp_Object prop
, window
;
3181 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3183 /* If POS specifies a position in a display vector, this might
3184 be for an ellipsis displayed for invisible text. We won't
3185 get the iterator set up for delivering that ellipsis unless
3186 we make sure that it gets aware of the invisible text. */
3187 if (pos
->dpvec_index
>= 0
3188 && pos
->overlay_string_index
< 0
3189 && CHARPOS (pos
->string_pos
) < 0
3191 && (XSETWINDOW (window
, w
),
3192 prop
= Fget_char_property (make_number (charpos
),
3193 Qinvisible
, window
),
3194 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
3196 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3198 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3205 /* Initialize IT for stepping through current_buffer in window W,
3206 starting at position POS that includes overlay string and display
3207 vector/ control character translation position information. Value
3208 is zero if there are overlay strings with newlines at POS. */
3211 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3213 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3214 int i
, overlay_strings_with_newlines
= 0;
3216 /* If POS specifies a position in a display vector, this might
3217 be for an ellipsis displayed for invisible text. We won't
3218 get the iterator set up for delivering that ellipsis unless
3219 we make sure that it gets aware of the invisible text. */
3220 if (in_ellipses_for_invisible_text_p (pos
, w
))
3226 /* Keep in mind: the call to reseat in init_iterator skips invisible
3227 text, so we might end up at a position different from POS. This
3228 is only a problem when POS is a row start after a newline and an
3229 overlay starts there with an after-string, and the overlay has an
3230 invisible property. Since we don't skip invisible text in
3231 display_line and elsewhere immediately after consuming the
3232 newline before the row start, such a POS will not be in a string,
3233 but the call to init_iterator below will move us to the
3235 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3237 /* This only scans the current chunk -- it should scan all chunks.
3238 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3239 to 16 in 22.1 to make this a lesser problem. */
3240 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3242 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3243 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3245 while (s
< e
&& *s
!= '\n')
3250 overlay_strings_with_newlines
= 1;
3255 /* If position is within an overlay string, set up IT to the right
3257 if (pos
->overlay_string_index
>= 0)
3261 /* If the first overlay string happens to have a `display'
3262 property for an image, the iterator will be set up for that
3263 image, and we have to undo that setup first before we can
3264 correct the overlay string index. */
3265 if (it
->method
== GET_FROM_IMAGE
)
3268 /* We already have the first chunk of overlay strings in
3269 IT->overlay_strings. Load more until the one for
3270 pos->overlay_string_index is in IT->overlay_strings. */
3271 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3273 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3274 it
->current
.overlay_string_index
= 0;
3277 load_overlay_strings (it
, 0);
3278 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3282 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3283 relative_index
= (it
->current
.overlay_string_index
3284 % OVERLAY_STRING_CHUNK_SIZE
);
3285 it
->string
= it
->overlay_strings
[relative_index
];
3286 eassert (STRINGP (it
->string
));
3287 it
->current
.string_pos
= pos
->string_pos
;
3288 it
->method
= GET_FROM_STRING
;
3289 it
->end_charpos
= SCHARS (it
->string
);
3290 /* Set up the bidi iterator for this overlay string. */
3293 it
->bidi_it
.string
.lstring
= it
->string
;
3294 it
->bidi_it
.string
.s
= NULL
;
3295 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3296 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3297 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3298 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3299 it
->bidi_it
.w
= it
->w
;
3300 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3301 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3303 /* Synchronize the state of the bidi iterator with
3304 pos->string_pos. For any string position other than
3305 zero, this will be done automagically when we resume
3306 iteration over the string and get_visually_first_element
3307 is called. But if string_pos is zero, and the string is
3308 to be reordered for display, we need to resync manually,
3309 since it could be that the iteration state recorded in
3310 pos ended at string_pos of 0 moving backwards in string. */
3311 if (CHARPOS (pos
->string_pos
) == 0)
3313 get_visually_first_element (it
);
3314 if (IT_STRING_CHARPOS (*it
) != 0)
3317 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3318 bidi_move_to_visually_next (&it
->bidi_it
);
3319 } while (it
->bidi_it
.charpos
!= 0);
3321 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3322 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3326 if (CHARPOS (pos
->string_pos
) >= 0)
3328 /* Recorded position is not in an overlay string, but in another
3329 string. This can only be a string from a `display' property.
3330 IT should already be filled with that string. */
3331 it
->current
.string_pos
= pos
->string_pos
;
3332 eassert (STRINGP (it
->string
));
3334 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3335 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3338 /* Restore position in display vector translations, control
3339 character translations or ellipses. */
3340 if (pos
->dpvec_index
>= 0)
3342 if (it
->dpvec
== NULL
)
3343 get_next_display_element (it
);
3344 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3345 it
->current
.dpvec_index
= pos
->dpvec_index
;
3349 return !overlay_strings_with_newlines
;
3353 /* Initialize IT for stepping through current_buffer in window W
3354 starting at ROW->start. */
3357 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3359 init_from_display_pos (it
, w
, &row
->start
);
3360 it
->start
= row
->start
;
3361 it
->continuation_lines_width
= row
->continuation_lines_width
;
3366 /* Initialize IT for stepping through current_buffer in window W
3367 starting in the line following ROW, i.e. starting at ROW->end.
3368 Value is zero if there are overlay strings with newlines at ROW's
3372 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3376 if (init_from_display_pos (it
, w
, &row
->end
))
3378 if (row
->continued_p
)
3379 it
->continuation_lines_width
3380 = row
->continuation_lines_width
+ row
->pixel_width
;
3391 /***********************************************************************
3393 ***********************************************************************/
3395 /* Called when IT reaches IT->stop_charpos. Handle text property and
3396 overlay changes. Set IT->stop_charpos to the next position where
3400 handle_stop (struct it
*it
)
3402 enum prop_handled handled
;
3403 int handle_overlay_change_p
;
3407 it
->current
.dpvec_index
= -1;
3408 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3409 it
->ignore_overlay_strings_at_pos_p
= 0;
3412 /* Use face of preceding text for ellipsis (if invisible) */
3413 if (it
->selective_display_ellipsis_p
)
3414 it
->saved_face_id
= it
->face_id
;
3418 handled
= HANDLED_NORMALLY
;
3420 /* Call text property handlers. */
3421 for (p
= it_props
; p
->handler
; ++p
)
3423 handled
= p
->handler (it
);
3425 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3427 else if (handled
== HANDLED_RETURN
)
3429 /* We still want to show before and after strings from
3430 overlays even if the actual buffer text is replaced. */
3431 if (!handle_overlay_change_p
3433 /* Don't call get_overlay_strings_1 if we already
3434 have overlay strings loaded, because doing so
3435 will load them again and push the iterator state
3436 onto the stack one more time, which is not
3437 expected by the rest of the code that processes
3439 || (it
->current
.overlay_string_index
< 0
3440 ? !get_overlay_strings_1 (it
, 0, 0)
3444 setup_for_ellipsis (it
, 0);
3445 /* When handling a display spec, we might load an
3446 empty string. In that case, discard it here. We
3447 used to discard it in handle_single_display_spec,
3448 but that causes get_overlay_strings_1, above, to
3449 ignore overlay strings that we must check. */
3450 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3454 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3458 it
->ignore_overlay_strings_at_pos_p
= true;
3459 it
->string_from_display_prop_p
= 0;
3460 it
->from_disp_prop_p
= 0;
3461 handle_overlay_change_p
= 0;
3463 handled
= HANDLED_RECOMPUTE_PROPS
;
3466 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3467 handle_overlay_change_p
= 0;
3470 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3472 /* Don't check for overlay strings below when set to deliver
3473 characters from a display vector. */
3474 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3475 handle_overlay_change_p
= 0;
3477 /* Handle overlay changes.
3478 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3479 if it finds overlays. */
3480 if (handle_overlay_change_p
)
3481 handled
= handle_overlay_change (it
);
3486 setup_for_ellipsis (it
, 0);
3490 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3492 /* Determine where to stop next. */
3493 if (handled
== HANDLED_NORMALLY
)
3494 compute_stop_pos (it
);
3498 /* Compute IT->stop_charpos from text property and overlay change
3499 information for IT's current position. */
3502 compute_stop_pos (struct it
*it
)
3504 register INTERVAL iv
, next_iv
;
3505 Lisp_Object object
, limit
, position
;
3506 ptrdiff_t charpos
, bytepos
;
3508 if (STRINGP (it
->string
))
3510 /* Strings are usually short, so don't limit the search for
3512 it
->stop_charpos
= it
->end_charpos
;
3513 object
= it
->string
;
3515 charpos
= IT_STRING_CHARPOS (*it
);
3516 bytepos
= IT_STRING_BYTEPOS (*it
);
3522 /* If end_charpos is out of range for some reason, such as a
3523 misbehaving display function, rationalize it (Bug#5984). */
3524 if (it
->end_charpos
> ZV
)
3525 it
->end_charpos
= ZV
;
3526 it
->stop_charpos
= it
->end_charpos
;
3528 /* If next overlay change is in front of the current stop pos
3529 (which is IT->end_charpos), stop there. Note: value of
3530 next_overlay_change is point-max if no overlay change
3532 charpos
= IT_CHARPOS (*it
);
3533 bytepos
= IT_BYTEPOS (*it
);
3534 pos
= next_overlay_change (charpos
);
3535 if (pos
< it
->stop_charpos
)
3536 it
->stop_charpos
= pos
;
3538 /* Set up variables for computing the stop position from text
3539 property changes. */
3540 XSETBUFFER (object
, current_buffer
);
3541 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3544 /* Get the interval containing IT's position. Value is a null
3545 interval if there isn't such an interval. */
3546 position
= make_number (charpos
);
3547 iv
= validate_interval_range (object
, &position
, &position
, 0);
3550 Lisp_Object values_here
[LAST_PROP_IDX
];
3553 /* Get properties here. */
3554 for (p
= it_props
; p
->handler
; ++p
)
3555 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3557 /* Look for an interval following iv that has different
3559 for (next_iv
= next_interval (iv
);
3562 || XFASTINT (limit
) > next_iv
->position
));
3563 next_iv
= next_interval (next_iv
))
3565 for (p
= it_props
; p
->handler
; ++p
)
3567 Lisp_Object new_value
;
3569 new_value
= textget (next_iv
->plist
, *p
->name
);
3570 if (!EQ (values_here
[p
->idx
], new_value
))
3580 if (INTEGERP (limit
)
3581 && next_iv
->position
>= XFASTINT (limit
))
3582 /* No text property change up to limit. */
3583 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3585 /* Text properties change in next_iv. */
3586 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3590 if (it
->cmp_it
.id
< 0)
3592 ptrdiff_t stoppos
= it
->end_charpos
;
3594 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3596 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3597 stoppos
, it
->string
);
3600 eassert (STRINGP (it
->string
)
3601 || (it
->stop_charpos
>= BEGV
3602 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3606 /* Return the position of the next overlay change after POS in
3607 current_buffer. Value is point-max if no overlay change
3608 follows. This is like `next-overlay-change' but doesn't use
3612 next_overlay_change (ptrdiff_t pos
)
3614 ptrdiff_t i
, noverlays
;
3616 Lisp_Object
*overlays
;
3618 /* Get all overlays at the given position. */
3619 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3621 /* If any of these overlays ends before endpos,
3622 use its ending point instead. */
3623 for (i
= 0; i
< noverlays
; ++i
)
3628 oend
= OVERLAY_END (overlays
[i
]);
3629 oendpos
= OVERLAY_POSITION (oend
);
3630 endpos
= min (endpos
, oendpos
);
3636 /* How many characters forward to search for a display property or
3637 display string. Searching too far forward makes the bidi display
3638 sluggish, especially in small windows. */
3639 #define MAX_DISP_SCAN 250
3641 /* Return the character position of a display string at or after
3642 position specified by POSITION. If no display string exists at or
3643 after POSITION, return ZV. A display string is either an overlay
3644 with `display' property whose value is a string, or a `display'
3645 text property whose value is a string. STRING is data about the
3646 string to iterate; if STRING->lstring is nil, we are iterating a
3647 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3648 on a GUI frame. DISP_PROP is set to zero if we searched
3649 MAX_DISP_SCAN characters forward without finding any display
3650 strings, non-zero otherwise. It is set to 2 if the display string
3651 uses any kind of `(space ...)' spec that will produce a stretch of
3652 white space in the text area. */
3654 compute_display_string_pos (struct text_pos
*position
,
3655 struct bidi_string_data
*string
,
3657 int frame_window_p
, int *disp_prop
)
3659 /* OBJECT = nil means current buffer. */
3660 Lisp_Object object
, object1
;
3661 Lisp_Object pos
, spec
, limpos
;
3662 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3663 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3664 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3665 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3667 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3668 struct text_pos tpos
;
3671 if (string
&& STRINGP (string
->lstring
))
3672 object1
= object
= string
->lstring
;
3673 else if (w
&& !string_p
)
3675 XSETWINDOW (object
, w
);
3679 object1
= object
= Qnil
;
3684 /* We don't support display properties whose values are strings
3685 that have display string properties. */
3686 || string
->from_disp_str
3687 /* C strings cannot have display properties. */
3688 || (string
->s
&& !STRINGP (object
)))
3694 /* If the character at CHARPOS is where the display string begins,
3696 pos
= make_number (charpos
);
3697 if (STRINGP (object
))
3698 bufpos
= string
->bufpos
;
3702 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3704 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3707 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3715 /* Look forward for the first character with a `display' property
3716 that will replace the underlying text when displayed. */
3717 limpos
= make_number (lim
);
3719 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3720 CHARPOS (tpos
) = XFASTINT (pos
);
3721 if (CHARPOS (tpos
) >= lim
)
3726 if (STRINGP (object
))
3727 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3729 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3730 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3731 if (!STRINGP (object
))
3732 bufpos
= CHARPOS (tpos
);
3733 } while (NILP (spec
)
3734 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3735 bufpos
, frame_window_p
)));
3739 return CHARPOS (tpos
);
3742 /* Return the character position of the end of the display string that
3743 started at CHARPOS. If there's no display string at CHARPOS,
3744 return -1. A display string is either an overlay with `display'
3745 property whose value is a string or a `display' text property whose
3746 value is a string. */
3748 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3750 /* OBJECT = nil means current buffer. */
3751 Lisp_Object object
=
3752 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3753 Lisp_Object pos
= make_number (charpos
);
3755 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3757 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3760 /* It could happen that the display property or overlay was removed
3761 since we found it in compute_display_string_pos above. One way
3762 this can happen is if JIT font-lock was called (through
3763 handle_fontified_prop), and jit-lock-functions remove text
3764 properties or overlays from the portion of buffer that includes
3765 CHARPOS. Muse mode is known to do that, for example. In this
3766 case, we return -1 to the caller, to signal that no display
3767 string is actually present at CHARPOS. See bidi_fetch_char for
3768 how this is handled.
3770 An alternative would be to never look for display properties past
3771 it->stop_charpos. But neither compute_display_string_pos nor
3772 bidi_fetch_char that calls it know or care where the next
3774 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3777 /* Look forward for the first character where the `display' property
3779 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3781 return XFASTINT (pos
);
3786 /***********************************************************************
3788 ***********************************************************************/
3790 /* Handle changes in the `fontified' property of the current buffer by
3791 calling hook functions from Qfontification_functions to fontify
3794 static enum prop_handled
3795 handle_fontified_prop (struct it
*it
)
3797 Lisp_Object prop
, pos
;
3798 enum prop_handled handled
= HANDLED_NORMALLY
;
3800 if (!NILP (Vmemory_full
))
3803 /* Get the value of the `fontified' property at IT's current buffer
3804 position. (The `fontified' property doesn't have a special
3805 meaning in strings.) If the value is nil, call functions from
3806 Qfontification_functions. */
3807 if (!STRINGP (it
->string
)
3809 && !NILP (Vfontification_functions
)
3810 && !NILP (Vrun_hooks
)
3811 && (pos
= make_number (IT_CHARPOS (*it
)),
3812 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3813 /* Ignore the special cased nil value always present at EOB since
3814 no amount of fontifying will be able to change it. */
3815 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3817 ptrdiff_t count
= SPECPDL_INDEX ();
3819 struct buffer
*obuf
= current_buffer
;
3820 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3821 bool old_clip_changed
= current_buffer
->clip_changed
;
3823 val
= Vfontification_functions
;
3824 specbind (Qfontification_functions
, Qnil
);
3826 eassert (it
->end_charpos
== ZV
);
3828 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3829 safe_call1 (val
, pos
);
3832 Lisp_Object fns
, fn
;
3833 struct gcpro gcpro1
, gcpro2
;
3838 for (; CONSP (val
); val
= XCDR (val
))
3844 /* A value of t indicates this hook has a local
3845 binding; it means to run the global binding too.
3846 In a global value, t should not occur. If it
3847 does, we must ignore it to avoid an endless
3849 for (fns
= Fdefault_value (Qfontification_functions
);
3855 safe_call1 (fn
, pos
);
3859 safe_call1 (fn
, pos
);
3865 unbind_to (count
, Qnil
);
3867 /* Fontification functions routinely call `save-restriction'.
3868 Normally, this tags clip_changed, which can confuse redisplay
3869 (see discussion in Bug#6671). Since we don't perform any
3870 special handling of fontification changes in the case where
3871 `save-restriction' isn't called, there's no point doing so in
3872 this case either. So, if the buffer's restrictions are
3873 actually left unchanged, reset clip_changed. */
3874 if (obuf
== current_buffer
)
3876 if (begv
== BEGV
&& zv
== ZV
)
3877 current_buffer
->clip_changed
= old_clip_changed
;
3879 /* There isn't much we can reasonably do to protect against
3880 misbehaving fontification, but here's a fig leaf. */
3881 else if (BUFFER_LIVE_P (obuf
))
3882 set_buffer_internal_1 (obuf
);
3884 /* The fontification code may have added/removed text.
3885 It could do even a lot worse, but let's at least protect against
3886 the most obvious case where only the text past `pos' gets changed',
3887 as is/was done in grep.el where some escapes sequences are turned
3888 into face properties (bug#7876). */
3889 it
->end_charpos
= ZV
;
3891 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3892 something. This avoids an endless loop if they failed to
3893 fontify the text for which reason ever. */
3894 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3895 handled
= HANDLED_RECOMPUTE_PROPS
;
3903 /***********************************************************************
3905 ***********************************************************************/
3907 /* Set up iterator IT from face properties at its current position.
3908 Called from handle_stop. */
3910 static enum prop_handled
3911 handle_face_prop (struct it
*it
)
3914 ptrdiff_t next_stop
;
3916 if (!STRINGP (it
->string
))
3919 = face_at_buffer_position (it
->w
,
3923 + TEXT_PROP_DISTANCE_LIMIT
),
3924 0, it
->base_face_id
);
3926 /* Is this a start of a run of characters with box face?
3927 Caveat: this can be called for a freshly initialized
3928 iterator; face_id is -1 in this case. We know that the new
3929 face will not change until limit, i.e. if the new face has a
3930 box, all characters up to limit will have one. But, as
3931 usual, we don't know whether limit is really the end. */
3932 if (new_face_id
!= it
->face_id
)
3934 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3935 /* If it->face_id is -1, old_face below will be NULL, see
3936 the definition of FACE_FROM_ID. This will happen if this
3937 is the initial call that gets the face. */
3938 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3940 /* If the value of face_id of the iterator is -1, we have to
3941 look in front of IT's position and see whether there is a
3942 face there that's different from new_face_id. */
3943 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3945 int prev_face_id
= face_before_it_pos (it
);
3947 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3950 /* If the new face has a box, but the old face does not,
3951 this is the start of a run of characters with box face,
3952 i.e. this character has a shadow on the left side. */
3953 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3954 && (old_face
== NULL
|| !old_face
->box
));
3955 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3963 Lisp_Object from_overlay
3964 = (it
->current
.overlay_string_index
>= 0
3965 ? it
->string_overlays
[it
->current
.overlay_string_index
3966 % OVERLAY_STRING_CHUNK_SIZE
]
3969 /* See if we got to this string directly or indirectly from
3970 an overlay property. That includes the before-string or
3971 after-string of an overlay, strings in display properties
3972 provided by an overlay, their text properties, etc.
3974 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3975 if (! NILP (from_overlay
))
3976 for (i
= it
->sp
- 1; i
>= 0; i
--)
3978 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3980 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3981 % OVERLAY_STRING_CHUNK_SIZE
];
3982 else if (! NILP (it
->stack
[i
].from_overlay
))
3983 from_overlay
= it
->stack
[i
].from_overlay
;
3985 if (!NILP (from_overlay
))
3989 if (! NILP (from_overlay
))
3991 bufpos
= IT_CHARPOS (*it
);
3992 /* For a string from an overlay, the base face depends
3993 only on text properties and ignores overlays. */
3995 = face_for_overlay_string (it
->w
,
3999 + TEXT_PROP_DISTANCE_LIMIT
),
4007 /* For strings from a `display' property, use the face at
4008 IT's current buffer position as the base face to merge
4009 with, so that overlay strings appear in the same face as
4010 surrounding text, unless they specify their own faces.
4011 For strings from wrap-prefix and line-prefix properties,
4012 use the default face, possibly remapped via
4013 Vface_remapping_alist. */
4014 /* Note that the fact that we use the face at _buffer_
4015 position means that a 'display' property on an overlay
4016 string will not inherit the face of that overlay string,
4017 but will instead revert to the face of buffer text
4018 covered by the overlay. This is visible, e.g., when the
4019 overlay specifies a box face, but neither the buffer nor
4020 the display string do. This sounds like a design bug,
4021 but Emacs always did that since v21.1, so changing that
4022 might be a big deal. */
4023 base_face_id
= it
->string_from_prefix_prop_p
4024 ? (!NILP (Vface_remapping_alist
)
4025 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
4027 : underlying_face_id (it
);
4030 new_face_id
= face_at_string_position (it
->w
,
4032 IT_STRING_CHARPOS (*it
),
4037 /* Is this a start of a run of characters with box? Caveat:
4038 this can be called for a freshly allocated iterator; face_id
4039 is -1 is this case. We know that the new face will not
4040 change until the next check pos, i.e. if the new face has a
4041 box, all characters up to that position will have a
4042 box. But, as usual, we don't know whether that position
4043 is really the end. */
4044 if (new_face_id
!= it
->face_id
)
4046 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
4047 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4049 /* If new face has a box but old face hasn't, this is the
4050 start of a run of characters with box, i.e. it has a
4051 shadow on the left side. */
4052 it
->start_of_box_run_p
4053 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
4054 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4058 it
->face_id
= new_face_id
;
4059 return HANDLED_NORMALLY
;
4063 /* Return the ID of the face ``underlying'' IT's current position,
4064 which is in a string. If the iterator is associated with a
4065 buffer, return the face at IT's current buffer position.
4066 Otherwise, use the iterator's base_face_id. */
4069 underlying_face_id (struct it
*it
)
4071 int face_id
= it
->base_face_id
, i
;
4073 eassert (STRINGP (it
->string
));
4075 for (i
= it
->sp
- 1; i
>= 0; --i
)
4076 if (NILP (it
->stack
[i
].string
))
4077 face_id
= it
->stack
[i
].face_id
;
4083 /* Compute the face one character before or after the current position
4084 of IT, in the visual order. BEFORE_P non-zero means get the face
4085 in front (to the left in L2R paragraphs, to the right in R2L
4086 paragraphs) of IT's screen position. Value is the ID of the face. */
4089 face_before_or_after_it_pos (struct it
*it
, int before_p
)
4092 ptrdiff_t next_check_charpos
;
4094 void *it_copy_data
= NULL
;
4096 eassert (it
->s
== NULL
);
4098 if (STRINGP (it
->string
))
4100 ptrdiff_t bufpos
, charpos
;
4103 /* No face change past the end of the string (for the case
4104 we are padding with spaces). No face change before the
4106 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4107 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4112 /* Set charpos to the position before or after IT's current
4113 position, in the logical order, which in the non-bidi
4114 case is the same as the visual order. */
4116 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4117 else if (it
->what
== IT_COMPOSITION
)
4118 /* For composition, we must check the character after the
4120 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4122 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4128 /* With bidi iteration, the character before the current
4129 in the visual order cannot be found by simple
4130 iteration, because "reverse" reordering is not
4131 supported. Instead, we need to use the move_it_*
4132 family of functions. */
4133 /* Ignore face changes before the first visible
4134 character on this display line. */
4135 if (it
->current_x
<= it
->first_visible_x
)
4137 SAVE_IT (it_copy
, *it
, it_copy_data
);
4138 /* Implementation note: Since move_it_in_display_line
4139 works in the iterator geometry, and thinks the first
4140 character is always the leftmost, even in R2L lines,
4141 we don't need to distinguish between the R2L and L2R
4143 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
4144 it_copy
.current_x
- 1, MOVE_TO_X
);
4145 charpos
= IT_STRING_CHARPOS (it_copy
);
4146 RESTORE_IT (it
, it
, it_copy_data
);
4150 /* Set charpos to the string position of the character
4151 that comes after IT's current position in the visual
4153 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4157 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4159 charpos
= it_copy
.bidi_it
.charpos
;
4162 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4164 if (it
->current
.overlay_string_index
>= 0)
4165 bufpos
= IT_CHARPOS (*it
);
4169 base_face_id
= underlying_face_id (it
);
4171 /* Get the face for ASCII, or unibyte. */
4172 face_id
= face_at_string_position (it
->w
,
4176 &next_check_charpos
,
4179 /* Correct the face for charsets different from ASCII. Do it
4180 for the multibyte case only. The face returned above is
4181 suitable for unibyte text if IT->string is unibyte. */
4182 if (STRING_MULTIBYTE (it
->string
))
4184 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4185 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4187 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4189 c
= string_char_and_length (p
, &len
);
4190 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4195 struct text_pos pos
;
4197 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4198 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4201 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4202 pos
= it
->current
.pos
;
4207 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4210 if (it
->what
== IT_COMPOSITION
)
4212 /* For composition, we must check the position after
4214 pos
.charpos
+= it
->cmp_it
.nchars
;
4215 pos
.bytepos
+= it
->len
;
4218 INC_TEXT_POS (pos
, it
->multibyte_p
);
4225 /* With bidi iteration, the character before the current
4226 in the visual order cannot be found by simple
4227 iteration, because "reverse" reordering is not
4228 supported. Instead, we need to use the move_it_*
4229 family of functions. */
4230 /* Ignore face changes before the first visible
4231 character on this display line. */
4232 if (it
->current_x
<= it
->first_visible_x
)
4234 SAVE_IT (it_copy
, *it
, it_copy_data
);
4235 /* Implementation note: Since move_it_in_display_line
4236 works in the iterator geometry, and thinks the first
4237 character is always the leftmost, even in R2L lines,
4238 we don't need to distinguish between the R2L and L2R
4240 move_it_in_display_line (&it_copy
, ZV
,
4241 it_copy
.current_x
- 1, MOVE_TO_X
);
4242 pos
= it_copy
.current
.pos
;
4243 RESTORE_IT (it
, it
, it_copy_data
);
4247 /* Set charpos to the buffer position of the character
4248 that comes after IT's current position in the visual
4250 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4254 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4257 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4260 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4262 /* Determine face for CHARSET_ASCII, or unibyte. */
4263 face_id
= face_at_buffer_position (it
->w
,
4265 &next_check_charpos
,
4268 /* Correct the face for charsets different from ASCII. Do it
4269 for the multibyte case only. The face returned above is
4270 suitable for unibyte text if current_buffer is unibyte. */
4271 if (it
->multibyte_p
)
4273 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4274 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4275 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4284 /***********************************************************************
4286 ***********************************************************************/
4288 /* Set up iterator IT from invisible properties at its current
4289 position. Called from handle_stop. */
4291 static enum prop_handled
4292 handle_invisible_prop (struct it
*it
)
4294 enum prop_handled handled
= HANDLED_NORMALLY
;
4298 if (STRINGP (it
->string
))
4300 Lisp_Object end_charpos
, limit
, charpos
;
4302 /* Get the value of the invisible text property at the
4303 current position. Value will be nil if there is no such
4305 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4306 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4307 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4309 if (invis_p
&& IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4311 /* Record whether we have to display an ellipsis for the
4313 int display_ellipsis_p
= (invis_p
== 2);
4314 ptrdiff_t len
, endpos
;
4316 handled
= HANDLED_RECOMPUTE_PROPS
;
4318 /* Get the position at which the next visible text can be
4319 found in IT->string, if any. */
4320 endpos
= len
= SCHARS (it
->string
);
4321 XSETINT (limit
, len
);
4324 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4326 if (INTEGERP (end_charpos
))
4328 endpos
= XFASTINT (end_charpos
);
4329 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4330 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4332 display_ellipsis_p
= true;
4335 while (invis_p
&& endpos
< len
);
4337 if (display_ellipsis_p
)
4338 it
->ellipsis_p
= true;
4342 /* Text at END_CHARPOS is visible. Move IT there. */
4343 struct text_pos old
;
4346 old
= it
->current
.string_pos
;
4347 oldpos
= CHARPOS (old
);
4350 if (it
->bidi_it
.first_elt
4351 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4352 bidi_paragraph_init (it
->paragraph_embedding
,
4354 /* Bidi-iterate out of the invisible text. */
4357 bidi_move_to_visually_next (&it
->bidi_it
);
4359 while (oldpos
<= it
->bidi_it
.charpos
4360 && it
->bidi_it
.charpos
< endpos
);
4362 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4363 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4364 if (IT_CHARPOS (*it
) >= endpos
)
4365 it
->prev_stop
= endpos
;
4369 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4370 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4375 /* The rest of the string is invisible. If this is an
4376 overlay string, proceed with the next overlay string
4377 or whatever comes and return a character from there. */
4378 if (it
->current
.overlay_string_index
>= 0
4379 && !display_ellipsis_p
)
4381 next_overlay_string (it
);
4382 /* Don't check for overlay strings when we just
4383 finished processing them. */
4384 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4388 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4389 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4396 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4397 Lisp_Object pos
, overlay
;
4399 /* First of all, is there invisible text at this position? */
4400 tem
= start_charpos
= IT_CHARPOS (*it
);
4401 pos
= make_number (tem
);
4402 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4404 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4406 /* If we are on invisible text, skip over it. */
4407 if (invis_p
&& start_charpos
< it
->end_charpos
)
4409 /* Record whether we have to display an ellipsis for the
4411 int display_ellipsis_p
= invis_p
== 2;
4413 handled
= HANDLED_RECOMPUTE_PROPS
;
4415 /* Loop skipping over invisible text. The loop is left at
4416 ZV or with IT on the first char being visible again. */
4419 /* Try to skip some invisible text. Return value is the
4420 position reached which can be equal to where we start
4421 if there is nothing invisible there. This skips both
4422 over invisible text properties and overlays with
4423 invisible property. */
4424 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4426 /* If we skipped nothing at all we weren't at invisible
4427 text in the first place. If everything to the end of
4428 the buffer was skipped, end the loop. */
4429 if (newpos
== tem
|| newpos
>= ZV
)
4433 /* We skipped some characters but not necessarily
4434 all there are. Check if we ended up on visible
4435 text. Fget_char_property returns the property of
4436 the char before the given position, i.e. if we
4437 get invis_p = 0, this means that the char at
4438 newpos is visible. */
4439 pos
= make_number (newpos
);
4440 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4441 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4444 /* If we ended up on invisible text, proceed to
4445 skip starting with next_stop. */
4449 /* If there are adjacent invisible texts, don't lose the
4450 second one's ellipsis. */
4452 display_ellipsis_p
= true;
4456 /* The position newpos is now either ZV or on visible text. */
4459 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4461 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4463 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4465 /* If the invisible text ends on a newline or on a
4466 character after a newline, we can avoid the costly,
4467 character by character, bidi iteration to NEWPOS, and
4468 instead simply reseat the iterator there. That's
4469 because all bidi reordering information is tossed at
4470 the newline. This is a big win for modes that hide
4471 complete lines, like Outline, Org, etc. */
4472 if (on_newline
|| after_newline
)
4474 struct text_pos tpos
;
4475 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4477 SET_TEXT_POS (tpos
, newpos
, bpos
);
4478 reseat_1 (it
, tpos
, 0);
4479 /* If we reseat on a newline/ZV, we need to prep the
4480 bidi iterator for advancing to the next character
4481 after the newline/EOB, keeping the current paragraph
4482 direction (so that PRODUCE_GLYPHS does TRT wrt
4483 prepending/appending glyphs to a glyph row). */
4486 it
->bidi_it
.first_elt
= 0;
4487 it
->bidi_it
.paragraph_dir
= pdir
;
4488 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4489 it
->bidi_it
.nchars
= 1;
4490 it
->bidi_it
.ch_len
= 1;
4493 else /* Must use the slow method. */
4495 /* With bidi iteration, the region of invisible text
4496 could start and/or end in the middle of a
4497 non-base embedding level. Therefore, we need to
4498 skip invisible text using the bidi iterator,
4499 starting at IT's current position, until we find
4500 ourselves outside of the invisible text.
4501 Skipping invisible text _after_ bidi iteration
4502 avoids affecting the visual order of the
4503 displayed text when invisible properties are
4504 added or removed. */
4505 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4507 /* If we were `reseat'ed to a new paragraph,
4508 determine the paragraph base direction. We
4509 need to do it now because
4510 next_element_from_buffer may not have a
4511 chance to do it, if we are going to skip any
4512 text at the beginning, which resets the
4514 bidi_paragraph_init (it
->paragraph_embedding
,
4519 bidi_move_to_visually_next (&it
->bidi_it
);
4521 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4522 && it
->bidi_it
.charpos
< newpos
);
4523 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4524 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4525 /* If we overstepped NEWPOS, record its position in
4526 the iterator, so that we skip invisible text if
4527 later the bidi iteration lands us in the
4528 invisible region again. */
4529 if (IT_CHARPOS (*it
) >= newpos
)
4530 it
->prev_stop
= newpos
;
4535 IT_CHARPOS (*it
) = newpos
;
4536 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4539 /* If there are before-strings at the start of invisible
4540 text, and the text is invisible because of a text
4541 property, arrange to show before-strings because 20.x did
4542 it that way. (If the text is invisible because of an
4543 overlay property instead of a text property, this is
4544 already handled in the overlay code.) */
4546 && get_overlay_strings (it
, it
->stop_charpos
))
4548 handled
= HANDLED_RECOMPUTE_PROPS
;
4549 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4551 else if (display_ellipsis_p
)
4553 /* Make sure that the glyphs of the ellipsis will get
4554 correct `charpos' values. If we would not update
4555 it->position here, the glyphs would belong to the
4556 last visible character _before_ the invisible
4557 text, which confuses `set_cursor_from_row'.
4559 We use the last invisible position instead of the
4560 first because this way the cursor is always drawn on
4561 the first "." of the ellipsis, whenever PT is inside
4562 the invisible text. Otherwise the cursor would be
4563 placed _after_ the ellipsis when the point is after the
4564 first invisible character. */
4565 if (!STRINGP (it
->object
))
4567 it
->position
.charpos
= newpos
- 1;
4568 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4570 it
->ellipsis_p
= true;
4571 /* Let the ellipsis display before
4572 considering any properties of the following char.
4573 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4574 handled
= HANDLED_RETURN
;
4583 /* Make iterator IT return `...' next.
4584 Replaces LEN characters from buffer. */
4587 setup_for_ellipsis (struct it
*it
, int len
)
4589 /* Use the display table definition for `...'. Invalid glyphs
4590 will be handled by the method returning elements from dpvec. */
4591 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4593 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4594 it
->dpvec
= v
->contents
;
4595 it
->dpend
= v
->contents
+ v
->header
.size
;
4599 /* Default `...'. */
4600 it
->dpvec
= default_invis_vector
;
4601 it
->dpend
= default_invis_vector
+ 3;
4604 it
->dpvec_char_len
= len
;
4605 it
->current
.dpvec_index
= 0;
4606 it
->dpvec_face_id
= -1;
4608 /* Remember the current face id in case glyphs specify faces.
4609 IT's face is restored in set_iterator_to_next.
4610 saved_face_id was set to preceding char's face in handle_stop. */
4611 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4612 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4614 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4615 it
->ellipsis_p
= true;
4620 /***********************************************************************
4622 ***********************************************************************/
4624 /* Set up iterator IT from `display' property at its current position.
4625 Called from handle_stop.
4626 We return HANDLED_RETURN if some part of the display property
4627 overrides the display of the buffer text itself.
4628 Otherwise we return HANDLED_NORMALLY. */
4630 static enum prop_handled
4631 handle_display_prop (struct it
*it
)
4633 Lisp_Object propval
, object
, overlay
;
4634 struct text_pos
*position
;
4636 /* Nonzero if some property replaces the display of the text itself. */
4637 int display_replaced_p
= 0;
4639 if (STRINGP (it
->string
))
4641 object
= it
->string
;
4642 position
= &it
->current
.string_pos
;
4643 bufpos
= CHARPOS (it
->current
.pos
);
4647 XSETWINDOW (object
, it
->w
);
4648 position
= &it
->current
.pos
;
4649 bufpos
= CHARPOS (*position
);
4652 /* Reset those iterator values set from display property values. */
4653 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4654 it
->space_width
= Qnil
;
4655 it
->font_height
= Qnil
;
4658 /* We don't support recursive `display' properties, i.e. string
4659 values that have a string `display' property, that have a string
4660 `display' property etc. */
4661 if (!it
->string_from_display_prop_p
)
4662 it
->area
= TEXT_AREA
;
4664 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4665 Qdisplay
, object
, &overlay
);
4667 return HANDLED_NORMALLY
;
4668 /* Now OVERLAY is the overlay that gave us this property, or nil
4669 if it was a text property. */
4671 if (!STRINGP (it
->string
))
4672 object
= it
->w
->contents
;
4674 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4676 FRAME_WINDOW_P (it
->f
));
4678 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4681 /* Subroutine of handle_display_prop. Returns non-zero if the display
4682 specification in SPEC is a replacing specification, i.e. it would
4683 replace the text covered by `display' property with something else,
4684 such as an image or a display string. If SPEC includes any kind or
4685 `(space ...) specification, the value is 2; this is used by
4686 compute_display_string_pos, which see.
4688 See handle_single_display_spec for documentation of arguments.
4689 frame_window_p is non-zero if the window being redisplayed is on a
4690 GUI frame; this argument is used only if IT is NULL, see below.
4692 IT can be NULL, if this is called by the bidi reordering code
4693 through compute_display_string_pos, which see. In that case, this
4694 function only examines SPEC, but does not otherwise "handle" it, in
4695 the sense that it doesn't set up members of IT from the display
4698 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4699 Lisp_Object overlay
, struct text_pos
*position
,
4700 ptrdiff_t bufpos
, int frame_window_p
)
4702 int replacing_p
= 0;
4706 /* Simple specifications. */
4707 && !EQ (XCAR (spec
), Qimage
)
4708 && !EQ (XCAR (spec
), Qspace
)
4709 && !EQ (XCAR (spec
), Qwhen
)
4710 && !EQ (XCAR (spec
), Qslice
)
4711 && !EQ (XCAR (spec
), Qspace_width
)
4712 && !EQ (XCAR (spec
), Qheight
)
4713 && !EQ (XCAR (spec
), Qraise
)
4714 /* Marginal area specifications. */
4715 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4716 && !EQ (XCAR (spec
), Qleft_fringe
)
4717 && !EQ (XCAR (spec
), Qright_fringe
)
4718 && !NILP (XCAR (spec
)))
4720 for (; CONSP (spec
); spec
= XCDR (spec
))
4722 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4723 overlay
, position
, bufpos
,
4724 replacing_p
, frame_window_p
)))
4727 /* If some text in a string is replaced, `position' no
4728 longer points to the position of `object'. */
4729 if (!it
|| STRINGP (object
))
4734 else if (VECTORP (spec
))
4737 for (i
= 0; i
< ASIZE (spec
); ++i
)
4738 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4739 overlay
, position
, bufpos
,
4740 replacing_p
, frame_window_p
)))
4743 /* If some text in a string is replaced, `position' no
4744 longer points to the position of `object'. */
4745 if (!it
|| STRINGP (object
))
4751 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4752 position
, bufpos
, 0,
4760 /* Value is the position of the end of the `display' property starting
4761 at START_POS in OBJECT. */
4763 static struct text_pos
4764 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4767 struct text_pos end_pos
;
4769 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4770 Qdisplay
, object
, Qnil
);
4771 CHARPOS (end_pos
) = XFASTINT (end
);
4772 if (STRINGP (object
))
4773 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4775 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4781 /* Set up IT from a single `display' property specification SPEC. OBJECT
4782 is the object in which the `display' property was found. *POSITION
4783 is the position in OBJECT at which the `display' property was found.
4784 BUFPOS is the buffer position of OBJECT (different from POSITION if
4785 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4786 previously saw a display specification which already replaced text
4787 display with something else, for example an image; we ignore such
4788 properties after the first one has been processed.
4790 OVERLAY is the overlay this `display' property came from,
4791 or nil if it was a text property.
4793 If SPEC is a `space' or `image' specification, and in some other
4794 cases too, set *POSITION to the position where the `display'
4797 If IT is NULL, only examine the property specification in SPEC, but
4798 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4799 is intended to be displayed in a window on a GUI frame.
4801 Value is non-zero if something was found which replaces the display
4802 of buffer or string text. */
4805 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4806 Lisp_Object overlay
, struct text_pos
*position
,
4807 ptrdiff_t bufpos
, int display_replaced_p
,
4811 Lisp_Object location
, value
;
4812 struct text_pos start_pos
= *position
;
4815 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4816 If the result is non-nil, use VALUE instead of SPEC. */
4818 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4827 if (!NILP (form
) && !EQ (form
, Qt
))
4829 ptrdiff_t count
= SPECPDL_INDEX ();
4830 struct gcpro gcpro1
;
4832 /* Bind `object' to the object having the `display' property, a
4833 buffer or string. Bind `position' to the position in the
4834 object where the property was found, and `buffer-position'
4835 to the current position in the buffer. */
4838 XSETBUFFER (object
, current_buffer
);
4839 specbind (Qobject
, object
);
4840 specbind (Qposition
, make_number (CHARPOS (*position
)));
4841 specbind (Qbuffer_position
, make_number (bufpos
));
4843 form
= safe_eval (form
);
4845 unbind_to (count
, Qnil
);
4851 /* Handle `(height HEIGHT)' specifications. */
4853 && EQ (XCAR (spec
), Qheight
)
4854 && CONSP (XCDR (spec
)))
4858 if (!FRAME_WINDOW_P (it
->f
))
4861 it
->font_height
= XCAR (XCDR (spec
));
4862 if (!NILP (it
->font_height
))
4864 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4865 int new_height
= -1;
4867 if (CONSP (it
->font_height
)
4868 && (EQ (XCAR (it
->font_height
), Qplus
)
4869 || EQ (XCAR (it
->font_height
), Qminus
))
4870 && CONSP (XCDR (it
->font_height
))
4871 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4873 /* `(+ N)' or `(- N)' where N is an integer. */
4874 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4875 if (EQ (XCAR (it
->font_height
), Qplus
))
4877 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4879 else if (FUNCTIONP (it
->font_height
))
4881 /* Call function with current height as argument.
4882 Value is the new height. */
4884 height
= safe_call1 (it
->font_height
,
4885 face
->lface
[LFACE_HEIGHT_INDEX
]);
4886 if (NUMBERP (height
))
4887 new_height
= XFLOATINT (height
);
4889 else if (NUMBERP (it
->font_height
))
4891 /* Value is a multiple of the canonical char height. */
4894 f
= FACE_FROM_ID (it
->f
,
4895 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4896 new_height
= (XFLOATINT (it
->font_height
)
4897 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4901 /* Evaluate IT->font_height with `height' bound to the
4902 current specified height to get the new height. */
4903 ptrdiff_t count
= SPECPDL_INDEX ();
4905 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4906 value
= safe_eval (it
->font_height
);
4907 unbind_to (count
, Qnil
);
4909 if (NUMBERP (value
))
4910 new_height
= XFLOATINT (value
);
4914 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4921 /* Handle `(space-width WIDTH)'. */
4923 && EQ (XCAR (spec
), Qspace_width
)
4924 && CONSP (XCDR (spec
)))
4928 if (!FRAME_WINDOW_P (it
->f
))
4931 value
= XCAR (XCDR (spec
));
4932 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4933 it
->space_width
= value
;
4939 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4941 && EQ (XCAR (spec
), Qslice
))
4947 if (!FRAME_WINDOW_P (it
->f
))
4950 if (tem
= XCDR (spec
), CONSP (tem
))
4952 it
->slice
.x
= XCAR (tem
);
4953 if (tem
= XCDR (tem
), CONSP (tem
))
4955 it
->slice
.y
= XCAR (tem
);
4956 if (tem
= XCDR (tem
), CONSP (tem
))
4958 it
->slice
.width
= XCAR (tem
);
4959 if (tem
= XCDR (tem
), CONSP (tem
))
4960 it
->slice
.height
= XCAR (tem
);
4969 /* Handle `(raise FACTOR)'. */
4971 && EQ (XCAR (spec
), Qraise
)
4972 && CONSP (XCDR (spec
)))
4976 if (!FRAME_WINDOW_P (it
->f
))
4979 #ifdef HAVE_WINDOW_SYSTEM
4980 value
= XCAR (XCDR (spec
));
4981 if (NUMBERP (value
))
4983 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4984 it
->voffset
= - (XFLOATINT (value
)
4985 * (FONT_HEIGHT (face
->font
)));
4987 #endif /* HAVE_WINDOW_SYSTEM */
4993 /* Don't handle the other kinds of display specifications
4994 inside a string that we got from a `display' property. */
4995 if (it
&& it
->string_from_display_prop_p
)
4998 /* Characters having this form of property are not displayed, so
4999 we have to find the end of the property. */
5002 start_pos
= *position
;
5003 *position
= display_prop_end (it
, object
, start_pos
);
5007 /* Stop the scan at that end position--we assume that all
5008 text properties change there. */
5010 it
->stop_charpos
= position
->charpos
;
5012 /* Handle `(left-fringe BITMAP [FACE])'
5013 and `(right-fringe BITMAP [FACE])'. */
5015 && (EQ (XCAR (spec
), Qleft_fringe
)
5016 || EQ (XCAR (spec
), Qright_fringe
))
5017 && CONSP (XCDR (spec
)))
5023 if (!FRAME_WINDOW_P (it
->f
))
5024 /* If we return here, POSITION has been advanced
5025 across the text with this property. */
5027 /* Synchronize the bidi iterator with POSITION. This is
5028 needed because we are not going to push the iterator
5029 on behalf of this display property, so there will be
5030 no pop_it call to do this synchronization for us. */
5033 it
->position
= *position
;
5034 iterate_out_of_display_property (it
);
5035 *position
= it
->position
;
5040 else if (!frame_window_p
)
5043 #ifdef HAVE_WINDOW_SYSTEM
5044 value
= XCAR (XCDR (spec
));
5045 if (!SYMBOLP (value
)
5046 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
5047 /* If we return here, POSITION has been advanced
5048 across the text with this property. */
5050 if (it
&& it
->bidi_p
)
5052 it
->position
= *position
;
5053 iterate_out_of_display_property (it
);
5054 *position
= it
->position
;
5061 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
5063 if (CONSP (XCDR (XCDR (spec
))))
5065 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5066 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5072 /* Save current settings of IT so that we can restore them
5073 when we are finished with the glyph property value. */
5074 push_it (it
, position
);
5076 it
->area
= TEXT_AREA
;
5077 it
->what
= IT_IMAGE
;
5078 it
->image_id
= -1; /* no image */
5079 it
->position
= start_pos
;
5080 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5081 it
->method
= GET_FROM_IMAGE
;
5082 it
->from_overlay
= Qnil
;
5083 it
->face_id
= face_id
;
5084 it
->from_disp_prop_p
= true;
5086 /* Say that we haven't consumed the characters with
5087 `display' property yet. The call to pop_it in
5088 set_iterator_to_next will clean this up. */
5089 *position
= start_pos
;
5091 if (EQ (XCAR (spec
), Qleft_fringe
))
5093 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5094 it
->left_user_fringe_face_id
= face_id
;
5098 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5099 it
->right_user_fringe_face_id
= face_id
;
5102 #endif /* HAVE_WINDOW_SYSTEM */
5106 /* Prepare to handle `((margin left-margin) ...)',
5107 `((margin right-margin) ...)' and `((margin nil) ...)'
5108 prefixes for display specifications. */
5109 location
= Qunbound
;
5110 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5114 value
= XCDR (spec
);
5116 value
= XCAR (value
);
5119 if (EQ (XCAR (tem
), Qmargin
)
5120 && (tem
= XCDR (tem
),
5121 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5123 || EQ (tem
, Qleft_margin
)
5124 || EQ (tem
, Qright_margin
))))
5128 if (EQ (location
, Qunbound
))
5134 /* After this point, VALUE is the property after any
5135 margin prefix has been stripped. It must be a string,
5136 an image specification, or `(space ...)'.
5138 LOCATION specifies where to display: `left-margin',
5139 `right-margin' or nil. */
5141 valid_p
= (STRINGP (value
)
5142 #ifdef HAVE_WINDOW_SYSTEM
5143 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5144 && valid_image_p (value
))
5145 #endif /* not HAVE_WINDOW_SYSTEM */
5146 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
5148 if (valid_p
&& !display_replaced_p
)
5154 /* Callers need to know whether the display spec is any kind
5155 of `(space ...)' spec that is about to affect text-area
5157 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5162 /* Save current settings of IT so that we can restore them
5163 when we are finished with the glyph property value. */
5164 push_it (it
, position
);
5165 it
->from_overlay
= overlay
;
5166 it
->from_disp_prop_p
= true;
5168 if (NILP (location
))
5169 it
->area
= TEXT_AREA
;
5170 else if (EQ (location
, Qleft_margin
))
5171 it
->area
= LEFT_MARGIN_AREA
;
5173 it
->area
= RIGHT_MARGIN_AREA
;
5175 if (STRINGP (value
))
5178 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5179 it
->current
.overlay_string_index
= -1;
5180 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5181 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5182 it
->method
= GET_FROM_STRING
;
5183 it
->stop_charpos
= 0;
5185 it
->base_level_stop
= 0;
5186 it
->string_from_display_prop_p
= true;
5187 /* Say that we haven't consumed the characters with
5188 `display' property yet. The call to pop_it in
5189 set_iterator_to_next will clean this up. */
5190 if (BUFFERP (object
))
5191 *position
= start_pos
;
5193 /* Force paragraph direction to be that of the parent
5194 object. If the parent object's paragraph direction is
5195 not yet determined, default to L2R. */
5196 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5197 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5199 it
->paragraph_embedding
= L2R
;
5201 /* Set up the bidi iterator for this display string. */
5204 it
->bidi_it
.string
.lstring
= it
->string
;
5205 it
->bidi_it
.string
.s
= NULL
;
5206 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5207 it
->bidi_it
.string
.bufpos
= bufpos
;
5208 it
->bidi_it
.string
.from_disp_str
= 1;
5209 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5210 it
->bidi_it
.w
= it
->w
;
5211 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5214 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5216 it
->method
= GET_FROM_STRETCH
;
5218 *position
= it
->position
= start_pos
;
5219 retval
= 1 + (it
->area
== TEXT_AREA
);
5221 #ifdef HAVE_WINDOW_SYSTEM
5224 it
->what
= IT_IMAGE
;
5225 it
->image_id
= lookup_image (it
->f
, value
);
5226 it
->position
= start_pos
;
5227 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5228 it
->method
= GET_FROM_IMAGE
;
5230 /* Say that we haven't consumed the characters with
5231 `display' property yet. The call to pop_it in
5232 set_iterator_to_next will clean this up. */
5233 *position
= start_pos
;
5235 #endif /* HAVE_WINDOW_SYSTEM */
5240 /* Invalid property or property not supported. Restore
5241 POSITION to what it was before. */
5242 *position
= start_pos
;
5246 /* Check if PROP is a display property value whose text should be
5247 treated as intangible. OVERLAY is the overlay from which PROP
5248 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5249 specify the buffer position covered by PROP. */
5252 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5253 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5255 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5256 struct text_pos position
;
5258 SET_TEXT_POS (position
, charpos
, bytepos
);
5259 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5260 &position
, charpos
, frame_window_p
);
5264 /* Return 1 if PROP is a display sub-property value containing STRING.
5266 Implementation note: this and the following function are really
5267 special cases of handle_display_spec and
5268 handle_single_display_spec, and should ideally use the same code.
5269 Until they do, these two pairs must be consistent and must be
5270 modified in sync. */
5273 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5275 if (EQ (string
, prop
))
5278 /* Skip over `when FORM'. */
5279 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5284 /* Actually, the condition following `when' should be eval'ed,
5285 like handle_single_display_spec does, and we should return
5286 zero if it evaluates to nil. However, this function is
5287 called only when the buffer was already displayed and some
5288 glyph in the glyph matrix was found to come from a display
5289 string. Therefore, the condition was already evaluated, and
5290 the result was non-nil, otherwise the display string wouldn't
5291 have been displayed and we would have never been called for
5292 this property. Thus, we can skip the evaluation and assume
5293 its result is non-nil. */
5298 /* Skip over `margin LOCATION'. */
5299 if (EQ (XCAR (prop
), Qmargin
))
5310 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5314 /* Return 1 if STRING appears in the `display' property PROP. */
5317 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5320 && !EQ (XCAR (prop
), Qwhen
)
5321 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5323 /* A list of sub-properties. */
5324 while (CONSP (prop
))
5326 if (single_display_spec_string_p (XCAR (prop
), string
))
5331 else if (VECTORP (prop
))
5333 /* A vector of sub-properties. */
5335 for (i
= 0; i
< ASIZE (prop
); ++i
)
5336 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5340 return single_display_spec_string_p (prop
, string
);
5345 /* Look for STRING in overlays and text properties in the current
5346 buffer, between character positions FROM and TO (excluding TO).
5347 BACK_P non-zero means look back (in this case, TO is supposed to be
5349 Value is the first character position where STRING was found, or
5350 zero if it wasn't found before hitting TO.
5352 This function may only use code that doesn't eval because it is
5353 called asynchronously from note_mouse_highlight. */
5356 string_buffer_position_lim (Lisp_Object string
,
5357 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5359 Lisp_Object limit
, prop
, pos
;
5362 pos
= make_number (max (from
, BEGV
));
5364 if (!back_p
) /* looking forward */
5366 limit
= make_number (min (to
, ZV
));
5367 while (!found
&& !EQ (pos
, limit
))
5369 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5370 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5373 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5377 else /* looking back */
5379 limit
= make_number (max (to
, BEGV
));
5380 while (!found
&& !EQ (pos
, limit
))
5382 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5383 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5386 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5391 return found
? XINT (pos
) : 0;
5394 /* Determine which buffer position in current buffer STRING comes from.
5395 AROUND_CHARPOS is an approximate position where it could come from.
5396 Value is the buffer position or 0 if it couldn't be determined.
5398 This function is necessary because we don't record buffer positions
5399 in glyphs generated from strings (to keep struct glyph small).
5400 This function may only use code that doesn't eval because it is
5401 called asynchronously from note_mouse_highlight. */
5404 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5406 const int MAX_DISTANCE
= 1000;
5407 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5408 around_charpos
+ MAX_DISTANCE
,
5412 found
= string_buffer_position_lim (string
, around_charpos
,
5413 around_charpos
- MAX_DISTANCE
, 1);
5419 /***********************************************************************
5420 `composition' property
5421 ***********************************************************************/
5423 /* Set up iterator IT from `composition' property at its current
5424 position. Called from handle_stop. */
5426 static enum prop_handled
5427 handle_composition_prop (struct it
*it
)
5429 Lisp_Object prop
, string
;
5430 ptrdiff_t pos
, pos_byte
, start
, end
;
5432 if (STRINGP (it
->string
))
5436 pos
= IT_STRING_CHARPOS (*it
);
5437 pos_byte
= IT_STRING_BYTEPOS (*it
);
5438 string
= it
->string
;
5439 s
= SDATA (string
) + pos_byte
;
5440 it
->c
= STRING_CHAR (s
);
5444 pos
= IT_CHARPOS (*it
);
5445 pos_byte
= IT_BYTEPOS (*it
);
5447 it
->c
= FETCH_CHAR (pos_byte
);
5450 /* If there's a valid composition and point is not inside of the
5451 composition (in the case that the composition is from the current
5452 buffer), draw a glyph composed from the composition components. */
5453 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5454 && composition_valid_p (start
, end
, prop
)
5455 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5458 /* As we can't handle this situation (perhaps font-lock added
5459 a new composition), we just return here hoping that next
5460 redisplay will detect this composition much earlier. */
5461 return HANDLED_NORMALLY
;
5464 if (STRINGP (it
->string
))
5465 pos_byte
= string_char_to_byte (it
->string
, start
);
5467 pos_byte
= CHAR_TO_BYTE (start
);
5469 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5472 if (it
->cmp_it
.id
>= 0)
5475 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5476 it
->cmp_it
.nglyphs
= -1;
5480 return HANDLED_NORMALLY
;
5485 /***********************************************************************
5487 ***********************************************************************/
5489 /* The following structure is used to record overlay strings for
5490 later sorting in load_overlay_strings. */
5492 struct overlay_entry
5494 Lisp_Object overlay
;
5501 /* Set up iterator IT from overlay strings at its current position.
5502 Called from handle_stop. */
5504 static enum prop_handled
5505 handle_overlay_change (struct it
*it
)
5507 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5508 return HANDLED_RECOMPUTE_PROPS
;
5510 return HANDLED_NORMALLY
;
5514 /* Set up the next overlay string for delivery by IT, if there is an
5515 overlay string to deliver. Called by set_iterator_to_next when the
5516 end of the current overlay string is reached. If there are more
5517 overlay strings to display, IT->string and
5518 IT->current.overlay_string_index are set appropriately here.
5519 Otherwise IT->string is set to nil. */
5522 next_overlay_string (struct it
*it
)
5524 ++it
->current
.overlay_string_index
;
5525 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5527 /* No more overlay strings. Restore IT's settings to what
5528 they were before overlay strings were processed, and
5529 continue to deliver from current_buffer. */
5531 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5534 || (NILP (it
->string
)
5535 && it
->method
== GET_FROM_BUFFER
5536 && it
->stop_charpos
>= BEGV
5537 && it
->stop_charpos
<= it
->end_charpos
));
5538 it
->current
.overlay_string_index
= -1;
5539 it
->n_overlay_strings
= 0;
5540 it
->overlay_strings_charpos
= -1;
5541 /* If there's an empty display string on the stack, pop the
5542 stack, to resync the bidi iterator with IT's position. Such
5543 empty strings are pushed onto the stack in
5544 get_overlay_strings_1. */
5545 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5548 /* If we're at the end of the buffer, record that we have
5549 processed the overlay strings there already, so that
5550 next_element_from_buffer doesn't try it again. */
5551 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5552 it
->overlay_strings_at_end_processed_p
= true;
5556 /* There are more overlay strings to process. If
5557 IT->current.overlay_string_index has advanced to a position
5558 where we must load IT->overlay_strings with more strings, do
5559 it. We must load at the IT->overlay_strings_charpos where
5560 IT->n_overlay_strings was originally computed; when invisible
5561 text is present, this might not be IT_CHARPOS (Bug#7016). */
5562 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5564 if (it
->current
.overlay_string_index
&& i
== 0)
5565 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5567 /* Initialize IT to deliver display elements from the overlay
5569 it
->string
= it
->overlay_strings
[i
];
5570 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5571 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5572 it
->method
= GET_FROM_STRING
;
5573 it
->stop_charpos
= 0;
5574 it
->end_charpos
= SCHARS (it
->string
);
5575 if (it
->cmp_it
.stop_pos
>= 0)
5576 it
->cmp_it
.stop_pos
= 0;
5578 it
->base_level_stop
= 0;
5580 /* Set up the bidi iterator for this overlay string. */
5583 it
->bidi_it
.string
.lstring
= it
->string
;
5584 it
->bidi_it
.string
.s
= NULL
;
5585 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5586 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5587 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5588 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5589 it
->bidi_it
.w
= it
->w
;
5590 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5598 /* Compare two overlay_entry structures E1 and E2. Used as a
5599 comparison function for qsort in load_overlay_strings. Overlay
5600 strings for the same position are sorted so that
5602 1. All after-strings come in front of before-strings, except
5603 when they come from the same overlay.
5605 2. Within after-strings, strings are sorted so that overlay strings
5606 from overlays with higher priorities come first.
5608 2. Within before-strings, strings are sorted so that overlay
5609 strings from overlays with higher priorities come last.
5611 Value is analogous to strcmp. */
5615 compare_overlay_entries (const void *e1
, const void *e2
)
5617 struct overlay_entry
const *entry1
= e1
;
5618 struct overlay_entry
const *entry2
= e2
;
5621 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5623 /* Let after-strings appear in front of before-strings if
5624 they come from different overlays. */
5625 if (EQ (entry1
->overlay
, entry2
->overlay
))
5626 result
= entry1
->after_string_p
? 1 : -1;
5628 result
= entry1
->after_string_p
? -1 : 1;
5630 else if (entry1
->priority
!= entry2
->priority
)
5632 if (entry1
->after_string_p
)
5633 /* After-strings sorted in order of decreasing priority. */
5634 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5636 /* Before-strings sorted in order of increasing priority. */
5637 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5646 /* Load the vector IT->overlay_strings with overlay strings from IT's
5647 current buffer position, or from CHARPOS if that is > 0. Set
5648 IT->n_overlays to the total number of overlay strings found.
5650 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5651 a time. On entry into load_overlay_strings,
5652 IT->current.overlay_string_index gives the number of overlay
5653 strings that have already been loaded by previous calls to this
5656 IT->add_overlay_start contains an additional overlay start
5657 position to consider for taking overlay strings from, if non-zero.
5658 This position comes into play when the overlay has an `invisible'
5659 property, and both before and after-strings. When we've skipped to
5660 the end of the overlay, because of its `invisible' property, we
5661 nevertheless want its before-string to appear.
5662 IT->add_overlay_start will contain the overlay start position
5665 Overlay strings are sorted so that after-string strings come in
5666 front of before-string strings. Within before and after-strings,
5667 strings are sorted by overlay priority. See also function
5668 compare_overlay_entries. */
5671 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5673 Lisp_Object overlay
, window
, str
, invisible
;
5674 struct Lisp_Overlay
*ov
;
5675 ptrdiff_t start
, end
;
5676 ptrdiff_t size
= 20;
5677 ptrdiff_t n
= 0, i
, j
;
5679 struct overlay_entry
*entries
= alloca (size
* sizeof *entries
);
5683 charpos
= IT_CHARPOS (*it
);
5685 /* Append the overlay string STRING of overlay OVERLAY to vector
5686 `entries' which has size `size' and currently contains `n'
5687 elements. AFTER_P non-zero means STRING is an after-string of
5689 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5692 Lisp_Object priority; \
5696 struct overlay_entry *old = entries; \
5697 SAFE_NALLOCA (entries, 2, size); \
5698 memcpy (entries, old, size * sizeof *entries); \
5702 entries[n].string = (STRING); \
5703 entries[n].overlay = (OVERLAY); \
5704 priority = Foverlay_get ((OVERLAY), Qpriority); \
5705 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5706 entries[n].after_string_p = (AFTER_P); \
5711 /* Process overlay before the overlay center. */
5712 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5714 XSETMISC (overlay
, ov
);
5715 eassert (OVERLAYP (overlay
));
5716 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5717 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5722 /* Skip this overlay if it doesn't start or end at IT's current
5724 if (end
!= charpos
&& start
!= charpos
)
5727 /* Skip this overlay if it doesn't apply to IT->w. */
5728 window
= Foverlay_get (overlay
, Qwindow
);
5729 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5732 /* If the text ``under'' the overlay is invisible, both before-
5733 and after-strings from this overlay are visible; start and
5734 end position are indistinguishable. */
5735 invisible
= Foverlay_get (overlay
, Qinvisible
);
5736 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5738 /* If overlay has a non-empty before-string, record it. */
5739 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5740 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5742 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5744 /* If overlay has a non-empty after-string, record it. */
5745 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5746 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5748 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5751 /* Process overlays after the overlay center. */
5752 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5754 XSETMISC (overlay
, ov
);
5755 eassert (OVERLAYP (overlay
));
5756 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5757 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5759 if (start
> charpos
)
5762 /* Skip this overlay if it doesn't start or end at IT's current
5764 if (end
!= charpos
&& start
!= charpos
)
5767 /* Skip this overlay if it doesn't apply to IT->w. */
5768 window
= Foverlay_get (overlay
, Qwindow
);
5769 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5772 /* If the text ``under'' the overlay is invisible, it has a zero
5773 dimension, and both before- and after-strings apply. */
5774 invisible
= Foverlay_get (overlay
, Qinvisible
);
5775 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5777 /* If overlay has a non-empty before-string, record it. */
5778 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5779 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5781 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5783 /* If overlay has a non-empty after-string, record it. */
5784 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5785 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5787 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5790 #undef RECORD_OVERLAY_STRING
5794 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5796 /* Record number of overlay strings, and where we computed it. */
5797 it
->n_overlay_strings
= n
;
5798 it
->overlay_strings_charpos
= charpos
;
5800 /* IT->current.overlay_string_index is the number of overlay strings
5801 that have already been consumed by IT. Copy some of the
5802 remaining overlay strings to IT->overlay_strings. */
5804 j
= it
->current
.overlay_string_index
;
5805 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5807 it
->overlay_strings
[i
] = entries
[j
].string
;
5808 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5816 /* Get the first chunk of overlay strings at IT's current buffer
5817 position, or at CHARPOS if that is > 0. Value is non-zero if at
5818 least one overlay string was found. */
5821 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5823 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5824 process. This fills IT->overlay_strings with strings, and sets
5825 IT->n_overlay_strings to the total number of strings to process.
5826 IT->pos.overlay_string_index has to be set temporarily to zero
5827 because load_overlay_strings needs this; it must be set to -1
5828 when no overlay strings are found because a zero value would
5829 indicate a position in the first overlay string. */
5830 it
->current
.overlay_string_index
= 0;
5831 load_overlay_strings (it
, charpos
);
5833 /* If we found overlay strings, set up IT to deliver display
5834 elements from the first one. Otherwise set up IT to deliver
5835 from current_buffer. */
5836 if (it
->n_overlay_strings
)
5838 /* Make sure we know settings in current_buffer, so that we can
5839 restore meaningful values when we're done with the overlay
5842 compute_stop_pos (it
);
5843 eassert (it
->face_id
>= 0);
5845 /* Save IT's settings. They are restored after all overlay
5846 strings have been processed. */
5847 eassert (!compute_stop_p
|| it
->sp
== 0);
5849 /* When called from handle_stop, there might be an empty display
5850 string loaded. In that case, don't bother saving it. But
5851 don't use this optimization with the bidi iterator, since we
5852 need the corresponding pop_it call to resync the bidi
5853 iterator's position with IT's position, after we are done
5854 with the overlay strings. (The corresponding call to pop_it
5855 in case of an empty display string is in
5856 next_overlay_string.) */
5858 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5861 /* Set up IT to deliver display elements from the first overlay
5863 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5864 it
->string
= it
->overlay_strings
[0];
5865 it
->from_overlay
= Qnil
;
5866 it
->stop_charpos
= 0;
5867 eassert (STRINGP (it
->string
));
5868 it
->end_charpos
= SCHARS (it
->string
);
5870 it
->base_level_stop
= 0;
5871 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5872 it
->method
= GET_FROM_STRING
;
5873 it
->from_disp_prop_p
= 0;
5875 /* Force paragraph direction to be that of the parent
5877 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5878 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5880 it
->paragraph_embedding
= L2R
;
5882 /* Set up the bidi iterator for this overlay string. */
5885 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5887 it
->bidi_it
.string
.lstring
= it
->string
;
5888 it
->bidi_it
.string
.s
= NULL
;
5889 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5890 it
->bidi_it
.string
.bufpos
= pos
;
5891 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5892 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5893 it
->bidi_it
.w
= it
->w
;
5894 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5899 it
->current
.overlay_string_index
= -1;
5904 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5907 it
->method
= GET_FROM_BUFFER
;
5909 (void) get_overlay_strings_1 (it
, charpos
, 1);
5913 /* Value is non-zero if we found at least one overlay string. */
5914 return STRINGP (it
->string
);
5919 /***********************************************************************
5920 Saving and restoring state
5921 ***********************************************************************/
5923 /* Save current settings of IT on IT->stack. Called, for example,
5924 before setting up IT for an overlay string, to be able to restore
5925 IT's settings to what they were after the overlay string has been
5926 processed. If POSITION is non-NULL, it is the position to save on
5927 the stack instead of IT->position. */
5930 push_it (struct it
*it
, struct text_pos
*position
)
5932 struct iterator_stack_entry
*p
;
5934 eassert (it
->sp
< IT_STACK_SIZE
);
5935 p
= it
->stack
+ it
->sp
;
5937 p
->stop_charpos
= it
->stop_charpos
;
5938 p
->prev_stop
= it
->prev_stop
;
5939 p
->base_level_stop
= it
->base_level_stop
;
5940 p
->cmp_it
= it
->cmp_it
;
5941 eassert (it
->face_id
>= 0);
5942 p
->face_id
= it
->face_id
;
5943 p
->string
= it
->string
;
5944 p
->method
= it
->method
;
5945 p
->from_overlay
= it
->from_overlay
;
5948 case GET_FROM_IMAGE
:
5949 p
->u
.image
.object
= it
->object
;
5950 p
->u
.image
.image_id
= it
->image_id
;
5951 p
->u
.image
.slice
= it
->slice
;
5953 case GET_FROM_STRETCH
:
5954 p
->u
.stretch
.object
= it
->object
;
5957 p
->position
= position
? *position
: it
->position
;
5958 p
->current
= it
->current
;
5959 p
->end_charpos
= it
->end_charpos
;
5960 p
->string_nchars
= it
->string_nchars
;
5962 p
->multibyte_p
= it
->multibyte_p
;
5963 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5964 p
->space_width
= it
->space_width
;
5965 p
->font_height
= it
->font_height
;
5966 p
->voffset
= it
->voffset
;
5967 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5968 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5969 p
->display_ellipsis_p
= 0;
5970 p
->line_wrap
= it
->line_wrap
;
5971 p
->bidi_p
= it
->bidi_p
;
5972 p
->paragraph_embedding
= it
->paragraph_embedding
;
5973 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5976 /* Save the state of the bidi iterator as well. */
5978 bidi_push_it (&it
->bidi_it
);
5982 iterate_out_of_display_property (struct it
*it
)
5984 int buffer_p
= !STRINGP (it
->string
);
5985 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5986 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
5988 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5990 /* Maybe initialize paragraph direction. If we are at the beginning
5991 of a new paragraph, next_element_from_buffer may not have a
5992 chance to do that. */
5993 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5994 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5995 /* prev_stop can be zero, so check against BEGV as well. */
5996 while (it
->bidi_it
.charpos
>= bob
5997 && it
->prev_stop
<= it
->bidi_it
.charpos
5998 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5999 && it
->bidi_it
.charpos
< eob
)
6000 bidi_move_to_visually_next (&it
->bidi_it
);
6001 /* Record the stop_pos we just crossed, for when we cross it
6003 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
6004 it
->prev_stop
= CHARPOS (it
->position
);
6005 /* If we ended up not where pop_it put us, resync IT's
6006 positional members with the bidi iterator. */
6007 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
6008 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
6010 it
->current
.pos
= it
->position
;
6012 it
->current
.string_pos
= it
->position
;
6015 /* Restore IT's settings from IT->stack. Called, for example, when no
6016 more overlay strings must be processed, and we return to delivering
6017 display elements from a buffer, or when the end of a string from a
6018 `display' property is reached and we return to delivering display
6019 elements from an overlay string, or from a buffer. */
6022 pop_it (struct it
*it
)
6024 struct iterator_stack_entry
*p
;
6025 int from_display_prop
= it
->from_disp_prop_p
;
6027 eassert (it
->sp
> 0);
6029 p
= it
->stack
+ it
->sp
;
6030 it
->stop_charpos
= p
->stop_charpos
;
6031 it
->prev_stop
= p
->prev_stop
;
6032 it
->base_level_stop
= p
->base_level_stop
;
6033 it
->cmp_it
= p
->cmp_it
;
6034 it
->face_id
= p
->face_id
;
6035 it
->current
= p
->current
;
6036 it
->position
= p
->position
;
6037 it
->string
= p
->string
;
6038 it
->from_overlay
= p
->from_overlay
;
6039 if (NILP (it
->string
))
6040 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6041 it
->method
= p
->method
;
6044 case GET_FROM_IMAGE
:
6045 it
->image_id
= p
->u
.image
.image_id
;
6046 it
->object
= p
->u
.image
.object
;
6047 it
->slice
= p
->u
.image
.slice
;
6049 case GET_FROM_STRETCH
:
6050 it
->object
= p
->u
.stretch
.object
;
6052 case GET_FROM_BUFFER
:
6053 it
->object
= it
->w
->contents
;
6055 case GET_FROM_STRING
:
6057 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6059 /* Restore the face_box_p flag, since it could have been
6060 overwritten by the face of the object that we just finished
6063 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6064 it
->object
= it
->string
;
6067 case GET_FROM_DISPLAY_VECTOR
:
6069 it
->method
= GET_FROM_C_STRING
;
6070 else if (STRINGP (it
->string
))
6071 it
->method
= GET_FROM_STRING
;
6074 it
->method
= GET_FROM_BUFFER
;
6075 it
->object
= it
->w
->contents
;
6078 it
->end_charpos
= p
->end_charpos
;
6079 it
->string_nchars
= p
->string_nchars
;
6081 it
->multibyte_p
= p
->multibyte_p
;
6082 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6083 it
->space_width
= p
->space_width
;
6084 it
->font_height
= p
->font_height
;
6085 it
->voffset
= p
->voffset
;
6086 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6087 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6088 it
->line_wrap
= p
->line_wrap
;
6089 it
->bidi_p
= p
->bidi_p
;
6090 it
->paragraph_embedding
= p
->paragraph_embedding
;
6091 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6094 bidi_pop_it (&it
->bidi_it
);
6095 /* Bidi-iterate until we get out of the portion of text, if any,
6096 covered by a `display' text property or by an overlay with
6097 `display' property. (We cannot just jump there, because the
6098 internal coherency of the bidi iterator state can not be
6099 preserved across such jumps.) We also must determine the
6100 paragraph base direction if the overlay we just processed is
6101 at the beginning of a new paragraph. */
6102 if (from_display_prop
6103 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6104 iterate_out_of_display_property (it
);
6106 eassert ((BUFFERP (it
->object
)
6107 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6108 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6109 || (STRINGP (it
->object
)
6110 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6111 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6112 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6118 /***********************************************************************
6120 ***********************************************************************/
6122 /* Set IT's current position to the previous line start. */
6125 back_to_previous_line_start (struct it
*it
)
6127 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6130 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6134 /* Move IT to the next line start.
6136 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
6137 we skipped over part of the text (as opposed to moving the iterator
6138 continuously over the text). Otherwise, don't change the value
6141 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6142 iterator on the newline, if it was found.
6144 Newlines may come from buffer text, overlay strings, or strings
6145 displayed via the `display' property. That's the reason we can't
6146 simply use find_newline_no_quit.
6148 Note that this function may not skip over invisible text that is so
6149 because of text properties and immediately follows a newline. If
6150 it would, function reseat_at_next_visible_line_start, when called
6151 from set_iterator_to_next, would effectively make invisible
6152 characters following a newline part of the wrong glyph row, which
6153 leads to wrong cursor motion. */
6156 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
6157 struct bidi_it
*bidi_it_prev
)
6159 ptrdiff_t old_selective
;
6160 int newline_found_p
, n
;
6161 const int MAX_NEWLINE_DISTANCE
= 500;
6163 /* If already on a newline, just consume it to avoid unintended
6164 skipping over invisible text below. */
6165 if (it
->what
== IT_CHARACTER
6167 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6169 if (it
->bidi_p
&& bidi_it_prev
)
6170 *bidi_it_prev
= it
->bidi_it
;
6171 set_iterator_to_next (it
, 0);
6176 /* Don't handle selective display in the following. It's (a)
6177 unnecessary because it's done by the caller, and (b) leads to an
6178 infinite recursion because next_element_from_ellipsis indirectly
6179 calls this function. */
6180 old_selective
= it
->selective
;
6183 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6184 from buffer text. */
6185 for (n
= newline_found_p
= 0;
6186 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6187 n
+= STRINGP (it
->string
) ? 0 : 1)
6189 if (!get_next_display_element (it
))
6191 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6192 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6193 *bidi_it_prev
= it
->bidi_it
;
6194 set_iterator_to_next (it
, 0);
6197 /* If we didn't find a newline near enough, see if we can use a
6199 if (!newline_found_p
)
6201 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6202 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6206 eassert (!STRINGP (it
->string
));
6208 /* If there isn't any `display' property in sight, and no
6209 overlays, we can just use the position of the newline in
6211 if (it
->stop_charpos
>= limit
6212 || ((pos
= Fnext_single_property_change (make_number (start
),
6214 make_number (limit
)),
6216 && next_overlay_change (start
) == ZV
))
6220 IT_CHARPOS (*it
) = limit
;
6221 IT_BYTEPOS (*it
) = bytepos
;
6225 struct bidi_it bprev
;
6227 /* Help bidi.c avoid expensive searches for display
6228 properties and overlays, by telling it that there are
6229 none up to `limit'. */
6230 if (it
->bidi_it
.disp_pos
< limit
)
6232 it
->bidi_it
.disp_pos
= limit
;
6233 it
->bidi_it
.disp_prop
= 0;
6236 bprev
= it
->bidi_it
;
6237 bidi_move_to_visually_next (&it
->bidi_it
);
6238 } while (it
->bidi_it
.charpos
!= limit
);
6239 IT_CHARPOS (*it
) = limit
;
6240 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6242 *bidi_it_prev
= bprev
;
6244 *skipped_p
= newline_found_p
= true;
6248 while (get_next_display_element (it
)
6249 && !newline_found_p
)
6251 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6252 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6253 *bidi_it_prev
= it
->bidi_it
;
6254 set_iterator_to_next (it
, 0);
6259 it
->selective
= old_selective
;
6260 return newline_found_p
;
6264 /* Set IT's current position to the previous visible line start. Skip
6265 invisible text that is so either due to text properties or due to
6266 selective display. Caution: this does not change IT->current_x and
6270 back_to_previous_visible_line_start (struct it
*it
)
6272 while (IT_CHARPOS (*it
) > BEGV
)
6274 back_to_previous_line_start (it
);
6276 if (IT_CHARPOS (*it
) <= BEGV
)
6279 /* If selective > 0, then lines indented more than its value are
6281 if (it
->selective
> 0
6282 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6286 /* Check the newline before point for invisibility. */
6289 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6290 Qinvisible
, it
->window
);
6291 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6295 if (IT_CHARPOS (*it
) <= BEGV
)
6300 void *it2data
= NULL
;
6303 Lisp_Object val
, overlay
;
6305 SAVE_IT (it2
, *it
, it2data
);
6307 /* If newline is part of a composition, continue from start of composition */
6308 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6309 && beg
< IT_CHARPOS (*it
))
6312 /* If newline is replaced by a display property, find start of overlay
6313 or interval and continue search from that point. */
6314 pos
= --IT_CHARPOS (it2
);
6317 bidi_unshelve_cache (NULL
, 0);
6318 it2
.string_from_display_prop_p
= 0;
6319 it2
.from_disp_prop_p
= 0;
6320 if (handle_display_prop (&it2
) == HANDLED_RETURN
6321 && !NILP (val
= get_char_property_and_overlay
6322 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6323 && (OVERLAYP (overlay
)
6324 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6325 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6327 RESTORE_IT (it
, it
, it2data
);
6331 /* Newline is not replaced by anything -- so we are done. */
6332 RESTORE_IT (it
, it
, it2data
);
6338 IT_CHARPOS (*it
) = beg
;
6339 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6343 it
->continuation_lines_width
= 0;
6345 eassert (IT_CHARPOS (*it
) >= BEGV
);
6346 eassert (IT_CHARPOS (*it
) == BEGV
6347 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6352 /* Reseat iterator IT at the previous visible line start. Skip
6353 invisible text that is so either due to text properties or due to
6354 selective display. At the end, update IT's overlay information,
6355 face information etc. */
6358 reseat_at_previous_visible_line_start (struct it
*it
)
6360 back_to_previous_visible_line_start (it
);
6361 reseat (it
, it
->current
.pos
, 1);
6366 /* Reseat iterator IT on the next visible line start in the current
6367 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6368 preceding the line start. Skip over invisible text that is so
6369 because of selective display. Compute faces, overlays etc at the
6370 new position. Note that this function does not skip over text that
6371 is invisible because of text properties. */
6374 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6376 int newline_found_p
, skipped_p
= 0;
6377 struct bidi_it bidi_it_prev
;
6379 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6381 /* Skip over lines that are invisible because they are indented
6382 more than the value of IT->selective. */
6383 if (it
->selective
> 0)
6384 while (IT_CHARPOS (*it
) < ZV
6385 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6388 eassert (IT_BYTEPOS (*it
) == BEGV
6389 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6391 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6394 /* Position on the newline if that's what's requested. */
6395 if (on_newline_p
&& newline_found_p
)
6397 if (STRINGP (it
->string
))
6399 if (IT_STRING_CHARPOS (*it
) > 0)
6403 --IT_STRING_CHARPOS (*it
);
6404 --IT_STRING_BYTEPOS (*it
);
6408 /* We need to restore the bidi iterator to the state
6409 it had on the newline, and resync the IT's
6410 position with that. */
6411 it
->bidi_it
= bidi_it_prev
;
6412 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6413 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6417 else if (IT_CHARPOS (*it
) > BEGV
)
6426 /* We need to restore the bidi iterator to the state it
6427 had on the newline and resync IT with that. */
6428 it
->bidi_it
= bidi_it_prev
;
6429 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6430 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6432 reseat (it
, it
->current
.pos
, 0);
6436 reseat (it
, it
->current
.pos
, 0);
6443 /***********************************************************************
6444 Changing an iterator's position
6445 ***********************************************************************/
6447 /* Change IT's current position to POS in current_buffer. If FORCE_P
6448 is non-zero, always check for text properties at the new position.
6449 Otherwise, text properties are only looked up if POS >=
6450 IT->check_charpos of a property. */
6453 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6455 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6457 reseat_1 (it
, pos
, 0);
6459 /* Determine where to check text properties. Avoid doing it
6460 where possible because text property lookup is very expensive. */
6462 || CHARPOS (pos
) > it
->stop_charpos
6463 || CHARPOS (pos
) < original_pos
)
6467 /* For bidi iteration, we need to prime prev_stop and
6468 base_level_stop with our best estimations. */
6469 /* Implementation note: Of course, POS is not necessarily a
6470 stop position, so assigning prev_pos to it is a lie; we
6471 should have called compute_stop_backwards. However, if
6472 the current buffer does not include any R2L characters,
6473 that call would be a waste of cycles, because the
6474 iterator will never move back, and thus never cross this
6475 "fake" stop position. So we delay that backward search
6476 until the time we really need it, in next_element_from_buffer. */
6477 if (CHARPOS (pos
) != it
->prev_stop
)
6478 it
->prev_stop
= CHARPOS (pos
);
6479 if (CHARPOS (pos
) < it
->base_level_stop
)
6480 it
->base_level_stop
= 0; /* meaning it's unknown */
6486 it
->prev_stop
= it
->base_level_stop
= 0;
6495 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6496 IT->stop_pos to POS, also. */
6499 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6501 /* Don't call this function when scanning a C string. */
6502 eassert (it
->s
== NULL
);
6504 /* POS must be a reasonable value. */
6505 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6507 it
->current
.pos
= it
->position
= pos
;
6508 it
->end_charpos
= ZV
;
6510 it
->current
.dpvec_index
= -1;
6511 it
->current
.overlay_string_index
= -1;
6512 IT_STRING_CHARPOS (*it
) = -1;
6513 IT_STRING_BYTEPOS (*it
) = -1;
6515 it
->method
= GET_FROM_BUFFER
;
6516 it
->object
= it
->w
->contents
;
6517 it
->area
= TEXT_AREA
;
6518 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6520 it
->string_from_display_prop_p
= 0;
6521 it
->string_from_prefix_prop_p
= 0;
6523 it
->from_disp_prop_p
= 0;
6524 it
->face_before_selective_p
= 0;
6527 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6529 bidi_unshelve_cache (NULL
, 0);
6530 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6531 it
->bidi_it
.string
.s
= NULL
;
6532 it
->bidi_it
.string
.lstring
= Qnil
;
6533 it
->bidi_it
.string
.bufpos
= 0;
6534 it
->bidi_it
.string
.from_disp_str
= 0;
6535 it
->bidi_it
.string
.unibyte
= 0;
6536 it
->bidi_it
.w
= it
->w
;
6541 it
->stop_charpos
= CHARPOS (pos
);
6542 it
->base_level_stop
= CHARPOS (pos
);
6544 /* This make the information stored in it->cmp_it invalidate. */
6549 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6550 If S is non-null, it is a C string to iterate over. Otherwise,
6551 STRING gives a Lisp string to iterate over.
6553 If PRECISION > 0, don't return more then PRECISION number of
6554 characters from the string.
6556 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6557 characters have been returned. FIELD_WIDTH < 0 means an infinite
6560 MULTIBYTE = 0 means disable processing of multibyte characters,
6561 MULTIBYTE > 0 means enable it,
6562 MULTIBYTE < 0 means use IT->multibyte_p.
6564 IT must be initialized via a prior call to init_iterator before
6565 calling this function. */
6568 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6569 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6572 /* No text property checks performed by default, but see below. */
6573 it
->stop_charpos
= -1;
6575 /* Set iterator position and end position. */
6576 memset (&it
->current
, 0, sizeof it
->current
);
6577 it
->current
.overlay_string_index
= -1;
6578 it
->current
.dpvec_index
= -1;
6579 eassert (charpos
>= 0);
6581 /* If STRING is specified, use its multibyteness, otherwise use the
6582 setting of MULTIBYTE, if specified. */
6584 it
->multibyte_p
= multibyte
> 0;
6586 /* Bidirectional reordering of strings is controlled by the default
6587 value of bidi-display-reordering. Don't try to reorder while
6588 loading loadup.el, as the necessary character property tables are
6589 not yet available. */
6592 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6596 eassert (STRINGP (string
));
6597 it
->string
= string
;
6599 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6600 it
->method
= GET_FROM_STRING
;
6601 it
->current
.string_pos
= string_pos (charpos
, string
);
6605 it
->bidi_it
.string
.lstring
= string
;
6606 it
->bidi_it
.string
.s
= NULL
;
6607 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6608 it
->bidi_it
.string
.bufpos
= 0;
6609 it
->bidi_it
.string
.from_disp_str
= 0;
6610 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6611 it
->bidi_it
.w
= it
->w
;
6612 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6613 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6618 it
->s
= (const unsigned char *) s
;
6621 /* Note that we use IT->current.pos, not it->current.string_pos,
6622 for displaying C strings. */
6623 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6624 if (it
->multibyte_p
)
6626 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6627 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6631 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6632 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6637 it
->bidi_it
.string
.lstring
= Qnil
;
6638 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6639 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6640 it
->bidi_it
.string
.bufpos
= 0;
6641 it
->bidi_it
.string
.from_disp_str
= 0;
6642 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6643 it
->bidi_it
.w
= it
->w
;
6644 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6647 it
->method
= GET_FROM_C_STRING
;
6650 /* PRECISION > 0 means don't return more than PRECISION characters
6652 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6654 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6656 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6659 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6660 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6661 FIELD_WIDTH < 0 means infinite field width. This is useful for
6662 padding with `-' at the end of a mode line. */
6663 if (field_width
< 0)
6664 field_width
= INFINITY
;
6665 /* Implementation note: We deliberately don't enlarge
6666 it->bidi_it.string.schars here to fit it->end_charpos, because
6667 the bidi iterator cannot produce characters out of thin air. */
6668 if (field_width
> it
->end_charpos
- charpos
)
6669 it
->end_charpos
= charpos
+ field_width
;
6671 /* Use the standard display table for displaying strings. */
6672 if (DISP_TABLE_P (Vstandard_display_table
))
6673 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6675 it
->stop_charpos
= charpos
;
6676 it
->prev_stop
= charpos
;
6677 it
->base_level_stop
= 0;
6680 it
->bidi_it
.first_elt
= 1;
6681 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6682 it
->bidi_it
.disp_pos
= -1;
6684 if (s
== NULL
&& it
->multibyte_p
)
6686 ptrdiff_t endpos
= SCHARS (it
->string
);
6687 if (endpos
> it
->end_charpos
)
6688 endpos
= it
->end_charpos
;
6689 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6697 /***********************************************************************
6699 ***********************************************************************/
6701 /* Map enum it_method value to corresponding next_element_from_* function. */
6703 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6705 next_element_from_buffer
,
6706 next_element_from_display_vector
,
6707 next_element_from_string
,
6708 next_element_from_c_string
,
6709 next_element_from_image
,
6710 next_element_from_stretch
6713 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6716 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6717 (possibly with the following characters). */
6719 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6720 ((IT)->cmp_it.id >= 0 \
6721 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6722 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6723 END_CHARPOS, (IT)->w, \
6724 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6728 /* Lookup the char-table Vglyphless_char_display for character C (-1
6729 if we want information for no-font case), and return the display
6730 method symbol. By side-effect, update it->what and
6731 it->glyphless_method. This function is called from
6732 get_next_display_element for each character element, and from
6733 x_produce_glyphs when no suitable font was found. */
6736 lookup_glyphless_char_display (int c
, struct it
*it
)
6738 Lisp_Object glyphless_method
= Qnil
;
6740 if (CHAR_TABLE_P (Vglyphless_char_display
)
6741 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6745 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6746 if (CONSP (glyphless_method
))
6747 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6748 ? XCAR (glyphless_method
)
6749 : XCDR (glyphless_method
);
6752 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6756 if (NILP (glyphless_method
))
6759 /* The default is to display the character by a proper font. */
6761 /* The default for the no-font case is to display an empty box. */
6762 glyphless_method
= Qempty_box
;
6764 if (EQ (glyphless_method
, Qzero_width
))
6767 return glyphless_method
;
6768 /* This method can't be used for the no-font case. */
6769 glyphless_method
= Qempty_box
;
6771 if (EQ (glyphless_method
, Qthin_space
))
6772 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6773 else if (EQ (glyphless_method
, Qempty_box
))
6774 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6775 else if (EQ (glyphless_method
, Qhex_code
))
6776 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6777 else if (STRINGP (glyphless_method
))
6778 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6781 /* Invalid value. We use the default method. */
6782 glyphless_method
= Qnil
;
6785 it
->what
= IT_GLYPHLESS
;
6786 return glyphless_method
;
6789 /* Merge escape glyph face and cache the result. */
6791 static struct frame
*last_escape_glyph_frame
= NULL
;
6792 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6793 static int last_escape_glyph_merged_face_id
= 0;
6796 merge_escape_glyph_face (struct it
*it
)
6800 if (it
->f
== last_escape_glyph_frame
6801 && it
->face_id
== last_escape_glyph_face_id
)
6802 face_id
= last_escape_glyph_merged_face_id
;
6805 /* Merge the `escape-glyph' face into the current face. */
6806 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6807 last_escape_glyph_frame
= it
->f
;
6808 last_escape_glyph_face_id
= it
->face_id
;
6809 last_escape_glyph_merged_face_id
= face_id
;
6814 /* Likewise for glyphless glyph face. */
6816 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6817 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6818 static int last_glyphless_glyph_merged_face_id
= 0;
6821 merge_glyphless_glyph_face (struct it
*it
)
6825 if (it
->f
== last_glyphless_glyph_frame
6826 && it
->face_id
== last_glyphless_glyph_face_id
)
6827 face_id
= last_glyphless_glyph_merged_face_id
;
6830 /* Merge the `glyphless-char' face into the current face. */
6831 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6832 last_glyphless_glyph_frame
= it
->f
;
6833 last_glyphless_glyph_face_id
= it
->face_id
;
6834 last_glyphless_glyph_merged_face_id
= face_id
;
6839 /* Load IT's display element fields with information about the next
6840 display element from the current position of IT. Value is zero if
6841 end of buffer (or C string) is reached. */
6844 get_next_display_element (struct it
*it
)
6846 /* Non-zero means that we found a display element. Zero means that
6847 we hit the end of what we iterate over. Performance note: the
6848 function pointer `method' used here turns out to be faster than
6849 using a sequence of if-statements. */
6853 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6855 if (it
->what
== IT_CHARACTER
)
6857 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6858 and only if (a) the resolved directionality of that character
6860 /* FIXME: Do we need an exception for characters from display
6862 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6863 it
->c
= bidi_mirror_char (it
->c
);
6864 /* Map via display table or translate control characters.
6865 IT->c, IT->len etc. have been set to the next character by
6866 the function call above. If we have a display table, and it
6867 contains an entry for IT->c, translate it. Don't do this if
6868 IT->c itself comes from a display table, otherwise we could
6869 end up in an infinite recursion. (An alternative could be to
6870 count the recursion depth of this function and signal an
6871 error when a certain maximum depth is reached.) Is it worth
6873 if (success_p
&& it
->dpvec
== NULL
)
6876 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6877 int nonascii_space_p
= 0;
6878 int nonascii_hyphen_p
= 0;
6879 int c
= it
->c
; /* This is the character to display. */
6881 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6883 eassert (SINGLE_BYTE_CHAR_P (c
));
6884 if (unibyte_display_via_language_environment
)
6886 c
= DECODE_CHAR (unibyte
, c
);
6888 c
= BYTE8_TO_CHAR (it
->c
);
6891 c
= BYTE8_TO_CHAR (it
->c
);
6895 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6898 struct Lisp_Vector
*v
= XVECTOR (dv
);
6900 /* Return the first character from the display table
6901 entry, if not empty. If empty, don't display the
6902 current character. */
6905 it
->dpvec_char_len
= it
->len
;
6906 it
->dpvec
= v
->contents
;
6907 it
->dpend
= v
->contents
+ v
->header
.size
;
6908 it
->current
.dpvec_index
= 0;
6909 it
->dpvec_face_id
= -1;
6910 it
->saved_face_id
= it
->face_id
;
6911 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6916 set_iterator_to_next (it
, 0);
6921 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6923 if (it
->what
== IT_GLYPHLESS
)
6925 /* Don't display this character. */
6926 set_iterator_to_next (it
, 0);
6930 /* If `nobreak-char-display' is non-nil, we display
6931 non-ASCII spaces and hyphens specially. */
6932 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6935 nonascii_space_p
= true;
6936 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6937 nonascii_hyphen_p
= true;
6940 /* Translate control characters into `\003' or `^C' form.
6941 Control characters coming from a display table entry are
6942 currently not translated because we use IT->dpvec to hold
6943 the translation. This could easily be changed but I
6944 don't believe that it is worth doing.
6946 The characters handled by `nobreak-char-display' must be
6949 Non-printable characters and raw-byte characters are also
6950 translated to octal form. */
6951 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
6952 ? (it
->area
!= TEXT_AREA
6953 /* In mode line, treat \n, \t like other crl chars. */
6956 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6957 || (c
!= '\n' && c
!= '\t'))
6959 || nonascii_hyphen_p
6961 || ! CHAR_PRINTABLE_P (c
))))
6963 /* C is a control character, non-ASCII space/hyphen,
6964 raw-byte, or a non-printable character which must be
6965 displayed either as '\003' or as `^C' where the '\\'
6966 and '^' can be defined in the display table. Fill
6967 IT->ctl_chars with glyphs for what we have to
6968 display. Then, set IT->dpvec to these glyphs. */
6975 /* Handle control characters with ^. */
6977 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6981 g
= '^'; /* default glyph for Control */
6982 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6984 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6986 g
= GLYPH_CODE_CHAR (gc
);
6987 lface_id
= GLYPH_CODE_FACE (gc
);
6991 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
6992 : merge_escape_glyph_face (it
));
6994 XSETINT (it
->ctl_chars
[0], g
);
6995 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6997 goto display_control
;
7000 /* Handle non-ascii space in the mode where it only gets
7003 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7005 /* Merge `nobreak-space' into the current face. */
7006 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7008 XSETINT (it
->ctl_chars
[0], ' ');
7010 goto display_control
;
7013 /* Handle sequences that start with the "escape glyph". */
7015 /* the default escape glyph is \. */
7016 escape_glyph
= '\\';
7019 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7021 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7022 lface_id
= GLYPH_CODE_FACE (gc
);
7026 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7027 : merge_escape_glyph_face (it
));
7029 /* Draw non-ASCII hyphen with just highlighting: */
7031 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7033 XSETINT (it
->ctl_chars
[0], '-');
7035 goto display_control
;
7038 /* Draw non-ASCII space/hyphen with escape glyph: */
7040 if (nonascii_space_p
|| nonascii_hyphen_p
)
7042 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7043 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7045 goto display_control
;
7052 if (CHAR_BYTE8_P (c
))
7053 /* Display \200 instead of \17777600. */
7054 c
= CHAR_TO_BYTE8 (c
);
7055 len
= sprintf (str
, "%03o", c
);
7057 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7058 for (i
= 0; i
< len
; i
++)
7059 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7064 /* Set up IT->dpvec and return first character from it. */
7065 it
->dpvec_char_len
= it
->len
;
7066 it
->dpvec
= it
->ctl_chars
;
7067 it
->dpend
= it
->dpvec
+ ctl_len
;
7068 it
->current
.dpvec_index
= 0;
7069 it
->dpvec_face_id
= face_id
;
7070 it
->saved_face_id
= it
->face_id
;
7071 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7075 it
->char_to_display
= c
;
7079 it
->char_to_display
= it
->c
;
7083 #ifdef HAVE_WINDOW_SYSTEM
7084 /* Adjust face id for a multibyte character. There are no multibyte
7085 character in unibyte text. */
7086 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7089 && FRAME_WINDOW_P (it
->f
))
7091 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7093 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7095 /* Automatic composition with glyph-string. */
7096 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7098 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7102 ptrdiff_t pos
= (it
->s
? -1
7103 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7104 : IT_CHARPOS (*it
));
7107 if (it
->what
== IT_CHARACTER
)
7108 c
= it
->char_to_display
;
7111 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7115 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7116 /* TAB in a composition means display glyphs with
7117 padding space on the left or right. */
7118 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7121 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7124 #endif /* HAVE_WINDOW_SYSTEM */
7127 /* Is this character the last one of a run of characters with
7128 box? If yes, set IT->end_of_box_run_p to 1. */
7132 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7134 int face_id
= underlying_face_id (it
);
7135 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7139 if (face
->box
== FACE_NO_BOX
)
7141 /* If the box comes from face properties in a
7142 display string, check faces in that string. */
7143 int string_face_id
= face_after_it_pos (it
);
7144 it
->end_of_box_run_p
7145 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7148 /* Otherwise, the box comes from the underlying face.
7149 If this is the last string character displayed, check
7150 the next buffer location. */
7151 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7152 /* n_overlay_strings is unreliable unless
7153 overlay_string_index is non-negative. */
7154 && ((it
->current
.overlay_string_index
>= 0
7155 && (it
->current
.overlay_string_index
7156 == it
->n_overlay_strings
- 1))
7157 /* A string from display property. */
7158 || it
->from_disp_prop_p
))
7162 struct text_pos pos
= it
->current
.pos
;
7164 /* For a string from a display property, the next
7165 buffer position is stored in the 'position'
7166 member of the iteration stack slot below the
7167 current one, see handle_single_display_spec. By
7168 contrast, it->current.pos was is not yet updated
7169 to point to that buffer position; that will
7170 happen in pop_it, after we finish displaying the
7171 current string. Note that we already checked
7172 above that it->sp is positive, so subtracting one
7174 if (it
->from_disp_prop_p
)
7175 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7177 INC_TEXT_POS (pos
, it
->multibyte_p
);
7179 if (CHARPOS (pos
) >= ZV
)
7180 it
->end_of_box_run_p
= true;
7183 next_face_id
= face_at_buffer_position
7184 (it
->w
, CHARPOS (pos
), &ignore
,
7185 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, 0, -1);
7186 it
->end_of_box_run_p
7187 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7193 /* next_element_from_display_vector sets this flag according to
7194 faces of the display vector glyphs, see there. */
7195 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7197 int face_id
= face_after_it_pos (it
);
7198 it
->end_of_box_run_p
7199 = (face_id
!= it
->face_id
7200 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7203 /* If we reached the end of the object we've been iterating (e.g., a
7204 display string or an overlay string), and there's something on
7205 IT->stack, proceed with what's on the stack. It doesn't make
7206 sense to return zero if there's unprocessed stuff on the stack,
7207 because otherwise that stuff will never be displayed. */
7208 if (!success_p
&& it
->sp
> 0)
7210 set_iterator_to_next (it
, 0);
7211 success_p
= get_next_display_element (it
);
7214 /* Value is 0 if end of buffer or string reached. */
7219 /* Move IT to the next display element.
7221 RESEAT_P non-zero means if called on a newline in buffer text,
7222 skip to the next visible line start.
7224 Functions get_next_display_element and set_iterator_to_next are
7225 separate because I find this arrangement easier to handle than a
7226 get_next_display_element function that also increments IT's
7227 position. The way it is we can first look at an iterator's current
7228 display element, decide whether it fits on a line, and if it does,
7229 increment the iterator position. The other way around we probably
7230 would either need a flag indicating whether the iterator has to be
7231 incremented the next time, or we would have to implement a
7232 decrement position function which would not be easy to write. */
7235 set_iterator_to_next (struct it
*it
, int reseat_p
)
7237 /* Reset flags indicating start and end of a sequence of characters
7238 with box. Reset them at the start of this function because
7239 moving the iterator to a new position might set them. */
7240 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
7244 case GET_FROM_BUFFER
:
7245 /* The current display element of IT is a character from
7246 current_buffer. Advance in the buffer, and maybe skip over
7247 invisible lines that are so because of selective display. */
7248 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7249 reseat_at_next_visible_line_start (it
, 0);
7250 else if (it
->cmp_it
.id
>= 0)
7252 /* We are currently getting glyphs from a composition. */
7257 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7258 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7259 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7261 it
->cmp_it
.from
= it
->cmp_it
.to
;
7266 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7268 it
->end_charpos
, Qnil
);
7271 else if (! it
->cmp_it
.reversed_p
)
7273 /* Composition created while scanning forward. */
7274 /* Update IT's char/byte positions to point to the first
7275 character of the next grapheme cluster, or to the
7276 character visually after the current composition. */
7277 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7278 bidi_move_to_visually_next (&it
->bidi_it
);
7279 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7280 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7282 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7284 /* Proceed to the next grapheme cluster. */
7285 it
->cmp_it
.from
= it
->cmp_it
.to
;
7289 /* No more grapheme clusters in this composition.
7290 Find the next stop position. */
7291 ptrdiff_t stop
= it
->end_charpos
;
7292 if (it
->bidi_it
.scan_dir
< 0)
7293 /* Now we are scanning backward and don't know
7296 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7297 IT_BYTEPOS (*it
), stop
, Qnil
);
7302 /* Composition created while scanning backward. */
7303 /* Update IT's char/byte positions to point to the last
7304 character of the previous grapheme cluster, or the
7305 character visually after the current composition. */
7306 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7307 bidi_move_to_visually_next (&it
->bidi_it
);
7308 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7309 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7310 if (it
->cmp_it
.from
> 0)
7312 /* Proceed to the previous grapheme cluster. */
7313 it
->cmp_it
.to
= it
->cmp_it
.from
;
7317 /* No more grapheme clusters in this composition.
7318 Find the next stop position. */
7319 ptrdiff_t stop
= it
->end_charpos
;
7320 if (it
->bidi_it
.scan_dir
< 0)
7321 /* Now we are scanning backward and don't know
7324 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7325 IT_BYTEPOS (*it
), stop
, Qnil
);
7331 eassert (it
->len
!= 0);
7335 IT_BYTEPOS (*it
) += it
->len
;
7336 IT_CHARPOS (*it
) += 1;
7340 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7341 /* If this is a new paragraph, determine its base
7342 direction (a.k.a. its base embedding level). */
7343 if (it
->bidi_it
.new_paragraph
)
7344 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7345 bidi_move_to_visually_next (&it
->bidi_it
);
7346 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7347 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7348 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7350 /* As the scan direction was changed, we must
7351 re-compute the stop position for composition. */
7352 ptrdiff_t stop
= it
->end_charpos
;
7353 if (it
->bidi_it
.scan_dir
< 0)
7355 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7356 IT_BYTEPOS (*it
), stop
, Qnil
);
7359 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7363 case GET_FROM_C_STRING
:
7364 /* Current display element of IT is from a C string. */
7366 /* If the string position is beyond string's end, it means
7367 next_element_from_c_string is padding the string with
7368 blanks, in which case we bypass the bidi iterator,
7369 because it cannot deal with such virtual characters. */
7370 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7372 IT_BYTEPOS (*it
) += it
->len
;
7373 IT_CHARPOS (*it
) += 1;
7377 bidi_move_to_visually_next (&it
->bidi_it
);
7378 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7379 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7383 case GET_FROM_DISPLAY_VECTOR
:
7384 /* Current display element of IT is from a display table entry.
7385 Advance in the display table definition. Reset it to null if
7386 end reached, and continue with characters from buffers/
7388 ++it
->current
.dpvec_index
;
7390 /* Restore face of the iterator to what they were before the
7391 display vector entry (these entries may contain faces). */
7392 it
->face_id
= it
->saved_face_id
;
7394 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7396 int recheck_faces
= it
->ellipsis_p
;
7399 it
->method
= GET_FROM_C_STRING
;
7400 else if (STRINGP (it
->string
))
7401 it
->method
= GET_FROM_STRING
;
7404 it
->method
= GET_FROM_BUFFER
;
7405 it
->object
= it
->w
->contents
;
7409 it
->current
.dpvec_index
= -1;
7411 /* Skip over characters which were displayed via IT->dpvec. */
7412 if (it
->dpvec_char_len
< 0)
7413 reseat_at_next_visible_line_start (it
, 1);
7414 else if (it
->dpvec_char_len
> 0)
7416 if (it
->method
== GET_FROM_STRING
7417 && it
->current
.overlay_string_index
>= 0
7418 && it
->n_overlay_strings
> 0)
7419 it
->ignore_overlay_strings_at_pos_p
= true;
7420 it
->len
= it
->dpvec_char_len
;
7421 set_iterator_to_next (it
, reseat_p
);
7424 /* Maybe recheck faces after display vector. */
7426 it
->stop_charpos
= IT_CHARPOS (*it
);
7430 case GET_FROM_STRING
:
7431 /* Current display element is a character from a Lisp string. */
7432 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7433 /* Don't advance past string end. These conditions are true
7434 when set_iterator_to_next is called at the end of
7435 get_next_display_element, in which case the Lisp string is
7436 already exhausted, and all we want is pop the iterator
7438 if (it
->current
.overlay_string_index
>= 0)
7440 /* This is an overlay string, so there's no padding with
7441 spaces, and the number of characters in the string is
7442 where the string ends. */
7443 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7444 goto consider_string_end
;
7448 /* Not an overlay string. There could be padding, so test
7449 against it->end_charpos. */
7450 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7451 goto consider_string_end
;
7453 if (it
->cmp_it
.id
>= 0)
7459 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7460 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7461 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7462 it
->cmp_it
.from
= it
->cmp_it
.to
;
7466 composition_compute_stop_pos (&it
->cmp_it
,
7467 IT_STRING_CHARPOS (*it
),
7468 IT_STRING_BYTEPOS (*it
),
7469 it
->end_charpos
, it
->string
);
7472 else if (! it
->cmp_it
.reversed_p
)
7474 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7475 bidi_move_to_visually_next (&it
->bidi_it
);
7476 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7477 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7479 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7480 it
->cmp_it
.from
= it
->cmp_it
.to
;
7483 ptrdiff_t stop
= it
->end_charpos
;
7484 if (it
->bidi_it
.scan_dir
< 0)
7486 composition_compute_stop_pos (&it
->cmp_it
,
7487 IT_STRING_CHARPOS (*it
),
7488 IT_STRING_BYTEPOS (*it
), stop
,
7494 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7495 bidi_move_to_visually_next (&it
->bidi_it
);
7496 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7497 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7498 if (it
->cmp_it
.from
> 0)
7499 it
->cmp_it
.to
= it
->cmp_it
.from
;
7502 ptrdiff_t stop
= it
->end_charpos
;
7503 if (it
->bidi_it
.scan_dir
< 0)
7505 composition_compute_stop_pos (&it
->cmp_it
,
7506 IT_STRING_CHARPOS (*it
),
7507 IT_STRING_BYTEPOS (*it
), stop
,
7515 /* If the string position is beyond string's end, it
7516 means next_element_from_string is padding the string
7517 with blanks, in which case we bypass the bidi
7518 iterator, because it cannot deal with such virtual
7520 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7522 IT_STRING_BYTEPOS (*it
) += it
->len
;
7523 IT_STRING_CHARPOS (*it
) += 1;
7527 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7529 bidi_move_to_visually_next (&it
->bidi_it
);
7530 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7531 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7532 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7534 ptrdiff_t stop
= it
->end_charpos
;
7536 if (it
->bidi_it
.scan_dir
< 0)
7538 composition_compute_stop_pos (&it
->cmp_it
,
7539 IT_STRING_CHARPOS (*it
),
7540 IT_STRING_BYTEPOS (*it
), stop
,
7546 consider_string_end
:
7548 if (it
->current
.overlay_string_index
>= 0)
7550 /* IT->string is an overlay string. Advance to the
7551 next, if there is one. */
7552 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7555 next_overlay_string (it
);
7557 setup_for_ellipsis (it
, 0);
7562 /* IT->string is not an overlay string. If we reached
7563 its end, and there is something on IT->stack, proceed
7564 with what is on the stack. This can be either another
7565 string, this time an overlay string, or a buffer. */
7566 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7570 if (it
->method
== GET_FROM_STRING
)
7571 goto consider_string_end
;
7576 case GET_FROM_IMAGE
:
7577 case GET_FROM_STRETCH
:
7578 /* The position etc with which we have to proceed are on
7579 the stack. The position may be at the end of a string,
7580 if the `display' property takes up the whole string. */
7581 eassert (it
->sp
> 0);
7583 if (it
->method
== GET_FROM_STRING
)
7584 goto consider_string_end
;
7588 /* There are no other methods defined, so this should be a bug. */
7592 eassert (it
->method
!= GET_FROM_STRING
7593 || (STRINGP (it
->string
)
7594 && IT_STRING_CHARPOS (*it
) >= 0));
7597 /* Load IT's display element fields with information about the next
7598 display element which comes from a display table entry or from the
7599 result of translating a control character to one of the forms `^C'
7602 IT->dpvec holds the glyphs to return as characters.
7603 IT->saved_face_id holds the face id before the display vector--it
7604 is restored into IT->face_id in set_iterator_to_next. */
7607 next_element_from_display_vector (struct it
*it
)
7610 int prev_face_id
= it
->face_id
;
7614 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7616 it
->face_id
= it
->saved_face_id
;
7618 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7619 That seemed totally bogus - so I changed it... */
7620 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7622 if (GLYPH_CODE_P (gc
))
7624 struct face
*this_face
, *prev_face
, *next_face
;
7626 it
->c
= GLYPH_CODE_CHAR (gc
);
7627 it
->len
= CHAR_BYTES (it
->c
);
7629 /* The entry may contain a face id to use. Such a face id is
7630 the id of a Lisp face, not a realized face. A face id of
7631 zero means no face is specified. */
7632 if (it
->dpvec_face_id
>= 0)
7633 it
->face_id
= it
->dpvec_face_id
;
7636 int lface_id
= GLYPH_CODE_FACE (gc
);
7638 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7642 /* Glyphs in the display vector could have the box face, so we
7643 need to set the related flags in the iterator, as
7645 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7646 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7648 /* Is this character the first character of a box-face run? */
7649 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7651 || prev_face
->box
== FACE_NO_BOX
));
7653 /* For the last character of the box-face run, we need to look
7654 either at the next glyph from the display vector, or at the
7655 face we saw before the display vector. */
7656 next_face_id
= it
->saved_face_id
;
7657 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7659 if (it
->dpvec_face_id
>= 0)
7660 next_face_id
= it
->dpvec_face_id
;
7664 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7667 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7671 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7672 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7674 || next_face
->box
== FACE_NO_BOX
));
7675 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7678 /* Display table entry is invalid. Return a space. */
7679 it
->c
= ' ', it
->len
= 1;
7681 /* Don't change position and object of the iterator here. They are
7682 still the values of the character that had this display table
7683 entry or was translated, and that's what we want. */
7684 it
->what
= IT_CHARACTER
;
7688 /* Get the first element of string/buffer in the visual order, after
7689 being reseated to a new position in a string or a buffer. */
7691 get_visually_first_element (struct it
*it
)
7693 int string_p
= STRINGP (it
->string
) || it
->s
;
7694 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7695 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7697 if (STRINGP (it
->string
))
7699 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7700 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7704 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7705 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7708 if (it
->bidi_it
.charpos
== eob
)
7710 /* Nothing to do, but reset the FIRST_ELT flag, like
7711 bidi_paragraph_init does, because we are not going to
7713 it
->bidi_it
.first_elt
= 0;
7715 else if (it
->bidi_it
.charpos
== bob
7717 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7718 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7720 /* If we are at the beginning of a line/string, we can produce
7721 the next element right away. */
7722 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7723 bidi_move_to_visually_next (&it
->bidi_it
);
7727 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7729 /* We need to prime the bidi iterator starting at the line's or
7730 string's beginning, before we will be able to produce the
7733 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7735 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7736 IT_BYTEPOS (*it
), -1,
7737 &it
->bidi_it
.bytepos
);
7738 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7741 /* Now return to buffer/string position where we were asked
7742 to get the next display element, and produce that. */
7743 bidi_move_to_visually_next (&it
->bidi_it
);
7745 while (it
->bidi_it
.bytepos
!= orig_bytepos
7746 && it
->bidi_it
.charpos
< eob
);
7749 /* Adjust IT's position information to where we ended up. */
7750 if (STRINGP (it
->string
))
7752 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7753 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7757 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7758 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7761 if (STRINGP (it
->string
) || !it
->s
)
7763 ptrdiff_t stop
, charpos
, bytepos
;
7765 if (STRINGP (it
->string
))
7768 stop
= SCHARS (it
->string
);
7769 if (stop
> it
->end_charpos
)
7770 stop
= it
->end_charpos
;
7771 charpos
= IT_STRING_CHARPOS (*it
);
7772 bytepos
= IT_STRING_BYTEPOS (*it
);
7776 stop
= it
->end_charpos
;
7777 charpos
= IT_CHARPOS (*it
);
7778 bytepos
= IT_BYTEPOS (*it
);
7780 if (it
->bidi_it
.scan_dir
< 0)
7782 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7787 /* Load IT with the next display element from Lisp string IT->string.
7788 IT->current.string_pos is the current position within the string.
7789 If IT->current.overlay_string_index >= 0, the Lisp string is an
7793 next_element_from_string (struct it
*it
)
7795 struct text_pos position
;
7797 eassert (STRINGP (it
->string
));
7798 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7799 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7800 position
= it
->current
.string_pos
;
7802 /* With bidi reordering, the character to display might not be the
7803 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7804 that we were reseat()ed to a new string, whose paragraph
7805 direction is not known. */
7806 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7808 get_visually_first_element (it
);
7809 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7812 /* Time to check for invisible text? */
7813 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7815 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7818 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7819 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7821 /* With bidi non-linear iteration, we could find
7822 ourselves far beyond the last computed stop_charpos,
7823 with several other stop positions in between that we
7824 missed. Scan them all now, in buffer's logical
7825 order, until we find and handle the last stop_charpos
7826 that precedes our current position. */
7827 handle_stop_backwards (it
, it
->stop_charpos
);
7828 return GET_NEXT_DISPLAY_ELEMENT (it
);
7834 /* Take note of the stop position we just moved
7835 across, for when we will move back across it. */
7836 it
->prev_stop
= it
->stop_charpos
;
7837 /* If we are at base paragraph embedding level, take
7838 note of the last stop position seen at this
7840 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7841 it
->base_level_stop
= it
->stop_charpos
;
7845 /* Since a handler may have changed IT->method, we must
7847 return GET_NEXT_DISPLAY_ELEMENT (it
);
7851 /* If we are before prev_stop, we may have overstepped
7852 on our way backwards a stop_pos, and if so, we need
7853 to handle that stop_pos. */
7854 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7855 /* We can sometimes back up for reasons that have nothing
7856 to do with bidi reordering. E.g., compositions. The
7857 code below is only needed when we are above the base
7858 embedding level, so test for that explicitly. */
7859 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7861 /* If we lost track of base_level_stop, we have no better
7862 place for handle_stop_backwards to start from than string
7863 beginning. This happens, e.g., when we were reseated to
7864 the previous screenful of text by vertical-motion. */
7865 if (it
->base_level_stop
<= 0
7866 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7867 it
->base_level_stop
= 0;
7868 handle_stop_backwards (it
, it
->base_level_stop
);
7869 return GET_NEXT_DISPLAY_ELEMENT (it
);
7873 if (it
->current
.overlay_string_index
>= 0)
7875 /* Get the next character from an overlay string. In overlay
7876 strings, there is no field width or padding with spaces to
7878 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7883 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7884 IT_STRING_BYTEPOS (*it
),
7885 it
->bidi_it
.scan_dir
< 0
7887 : SCHARS (it
->string
))
7888 && next_element_from_composition (it
))
7892 else if (STRING_MULTIBYTE (it
->string
))
7894 const unsigned char *s
= (SDATA (it
->string
)
7895 + IT_STRING_BYTEPOS (*it
));
7896 it
->c
= string_char_and_length (s
, &it
->len
);
7900 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7906 /* Get the next character from a Lisp string that is not an
7907 overlay string. Such strings come from the mode line, for
7908 example. We may have to pad with spaces, or truncate the
7909 string. See also next_element_from_c_string. */
7910 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7915 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7917 /* Pad with spaces. */
7918 it
->c
= ' ', it
->len
= 1;
7919 CHARPOS (position
) = BYTEPOS (position
) = -1;
7921 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7922 IT_STRING_BYTEPOS (*it
),
7923 it
->bidi_it
.scan_dir
< 0
7925 : it
->string_nchars
)
7926 && next_element_from_composition (it
))
7930 else if (STRING_MULTIBYTE (it
->string
))
7932 const unsigned char *s
= (SDATA (it
->string
)
7933 + IT_STRING_BYTEPOS (*it
));
7934 it
->c
= string_char_and_length (s
, &it
->len
);
7938 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7943 /* Record what we have and where it came from. */
7944 it
->what
= IT_CHARACTER
;
7945 it
->object
= it
->string
;
7946 it
->position
= position
;
7951 /* Load IT with next display element from C string IT->s.
7952 IT->string_nchars is the maximum number of characters to return
7953 from the string. IT->end_charpos may be greater than
7954 IT->string_nchars when this function is called, in which case we
7955 may have to return padding spaces. Value is zero if end of string
7956 reached, including padding spaces. */
7959 next_element_from_c_string (struct it
*it
)
7961 bool success_p
= true;
7964 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7965 it
->what
= IT_CHARACTER
;
7966 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7969 /* With bidi reordering, the character to display might not be the
7970 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7971 we were reseated to a new string, whose paragraph direction is
7973 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7974 get_visually_first_element (it
);
7976 /* IT's position can be greater than IT->string_nchars in case a
7977 field width or precision has been specified when the iterator was
7979 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7981 /* End of the game. */
7985 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7987 /* Pad with spaces. */
7988 it
->c
= ' ', it
->len
= 1;
7989 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7991 else if (it
->multibyte_p
)
7992 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7994 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
8000 /* Set up IT to return characters from an ellipsis, if appropriate.
8001 The definition of the ellipsis glyphs may come from a display table
8002 entry. This function fills IT with the first glyph from the
8003 ellipsis if an ellipsis is to be displayed. */
8006 next_element_from_ellipsis (struct it
*it
)
8008 if (it
->selective_display_ellipsis_p
)
8009 setup_for_ellipsis (it
, it
->len
);
8012 /* The face at the current position may be different from the
8013 face we find after the invisible text. Remember what it
8014 was in IT->saved_face_id, and signal that it's there by
8015 setting face_before_selective_p. */
8016 it
->saved_face_id
= it
->face_id
;
8017 it
->method
= GET_FROM_BUFFER
;
8018 it
->object
= it
->w
->contents
;
8019 reseat_at_next_visible_line_start (it
, 1);
8020 it
->face_before_selective_p
= true;
8023 return GET_NEXT_DISPLAY_ELEMENT (it
);
8027 /* Deliver an image display element. The iterator IT is already
8028 filled with image information (done in handle_display_prop). Value
8033 next_element_from_image (struct it
*it
)
8035 it
->what
= IT_IMAGE
;
8036 it
->ignore_overlay_strings_at_pos_p
= 0;
8041 /* Fill iterator IT with next display element from a stretch glyph
8042 property. IT->object is the value of the text property. Value is
8046 next_element_from_stretch (struct it
*it
)
8048 it
->what
= IT_STRETCH
;
8052 /* Scan backwards from IT's current position until we find a stop
8053 position, or until BEGV. This is called when we find ourself
8054 before both the last known prev_stop and base_level_stop while
8055 reordering bidirectional text. */
8058 compute_stop_pos_backwards (struct it
*it
)
8060 const int SCAN_BACK_LIMIT
= 1000;
8061 struct text_pos pos
;
8062 struct display_pos save_current
= it
->current
;
8063 struct text_pos save_position
= it
->position
;
8064 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8065 ptrdiff_t where_we_are
= charpos
;
8066 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8067 ptrdiff_t save_end_pos
= it
->end_charpos
;
8069 eassert (NILP (it
->string
) && !it
->s
);
8070 eassert (it
->bidi_p
);
8074 it
->end_charpos
= min (charpos
+ 1, ZV
);
8075 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8076 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8077 reseat_1 (it
, pos
, 0);
8078 compute_stop_pos (it
);
8079 /* We must advance forward, right? */
8080 if (it
->stop_charpos
<= charpos
)
8083 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8085 if (it
->stop_charpos
<= where_we_are
)
8086 it
->prev_stop
= it
->stop_charpos
;
8088 it
->prev_stop
= BEGV
;
8090 it
->current
= save_current
;
8091 it
->position
= save_position
;
8092 it
->stop_charpos
= save_stop_pos
;
8093 it
->end_charpos
= save_end_pos
;
8096 /* Scan forward from CHARPOS in the current buffer/string, until we
8097 find a stop position > current IT's position. Then handle the stop
8098 position before that. This is called when we bump into a stop
8099 position while reordering bidirectional text. CHARPOS should be
8100 the last previously processed stop_pos (or BEGV/0, if none were
8101 processed yet) whose position is less that IT's current
8105 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8107 int bufp
= !STRINGP (it
->string
);
8108 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8109 struct display_pos save_current
= it
->current
;
8110 struct text_pos save_position
= it
->position
;
8111 struct text_pos pos1
;
8112 ptrdiff_t next_stop
;
8114 /* Scan in strict logical order. */
8115 eassert (it
->bidi_p
);
8119 it
->prev_stop
= charpos
;
8122 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8123 reseat_1 (it
, pos1
, 0);
8126 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8127 compute_stop_pos (it
);
8128 /* We must advance forward, right? */
8129 if (it
->stop_charpos
<= it
->prev_stop
)
8131 charpos
= it
->stop_charpos
;
8133 while (charpos
<= where_we_are
);
8136 it
->current
= save_current
;
8137 it
->position
= save_position
;
8138 next_stop
= it
->stop_charpos
;
8139 it
->stop_charpos
= it
->prev_stop
;
8141 it
->stop_charpos
= next_stop
;
8144 /* Load IT with the next display element from current_buffer. Value
8145 is zero if end of buffer reached. IT->stop_charpos is the next
8146 position at which to stop and check for text properties or buffer
8150 next_element_from_buffer (struct it
*it
)
8152 bool success_p
= true;
8154 eassert (IT_CHARPOS (*it
) >= BEGV
);
8155 eassert (NILP (it
->string
) && !it
->s
);
8156 eassert (!it
->bidi_p
8157 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8158 && it
->bidi_it
.string
.s
== NULL
));
8160 /* With bidi reordering, the character to display might not be the
8161 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8162 we were reseat()ed to a new buffer position, which is potentially
8163 a different paragraph. */
8164 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8166 get_visually_first_element (it
);
8167 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8170 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8172 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8174 int overlay_strings_follow_p
;
8176 /* End of the game, except when overlay strings follow that
8177 haven't been returned yet. */
8178 if (it
->overlay_strings_at_end_processed_p
)
8179 overlay_strings_follow_p
= 0;
8182 it
->overlay_strings_at_end_processed_p
= true;
8183 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8186 if (overlay_strings_follow_p
)
8187 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8191 it
->position
= it
->current
.pos
;
8195 else if (!(!it
->bidi_p
8196 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8197 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8199 /* With bidi non-linear iteration, we could find ourselves
8200 far beyond the last computed stop_charpos, with several
8201 other stop positions in between that we missed. Scan
8202 them all now, in buffer's logical order, until we find
8203 and handle the last stop_charpos that precedes our
8204 current position. */
8205 handle_stop_backwards (it
, it
->stop_charpos
);
8206 return GET_NEXT_DISPLAY_ELEMENT (it
);
8212 /* Take note of the stop position we just moved across,
8213 for when we will move back across it. */
8214 it
->prev_stop
= it
->stop_charpos
;
8215 /* If we are at base paragraph embedding level, take
8216 note of the last stop position seen at this
8218 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8219 it
->base_level_stop
= it
->stop_charpos
;
8222 return GET_NEXT_DISPLAY_ELEMENT (it
);
8226 /* If we are before prev_stop, we may have overstepped on
8227 our way backwards a stop_pos, and if so, we need to
8228 handle that stop_pos. */
8229 && IT_CHARPOS (*it
) < it
->prev_stop
8230 /* We can sometimes back up for reasons that have nothing
8231 to do with bidi reordering. E.g., compositions. The
8232 code below is only needed when we are above the base
8233 embedding level, so test for that explicitly. */
8234 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8236 if (it
->base_level_stop
<= 0
8237 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8239 /* If we lost track of base_level_stop, we need to find
8240 prev_stop by looking backwards. This happens, e.g., when
8241 we were reseated to the previous screenful of text by
8243 it
->base_level_stop
= BEGV
;
8244 compute_stop_pos_backwards (it
);
8245 handle_stop_backwards (it
, it
->prev_stop
);
8248 handle_stop_backwards (it
, it
->base_level_stop
);
8249 return GET_NEXT_DISPLAY_ELEMENT (it
);
8253 /* No face changes, overlays etc. in sight, so just return a
8254 character from current_buffer. */
8258 /* Maybe run the redisplay end trigger hook. Performance note:
8259 This doesn't seem to cost measurable time. */
8260 if (it
->redisplay_end_trigger_charpos
8262 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8263 run_redisplay_end_trigger_hook (it
);
8265 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8266 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8268 && next_element_from_composition (it
))
8273 /* Get the next character, maybe multibyte. */
8274 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8275 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
8276 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8278 it
->c
= *p
, it
->len
= 1;
8280 /* Record what we have and where it came from. */
8281 it
->what
= IT_CHARACTER
;
8282 it
->object
= it
->w
->contents
;
8283 it
->position
= it
->current
.pos
;
8285 /* Normally we return the character found above, except when we
8286 really want to return an ellipsis for selective display. */
8291 /* A value of selective > 0 means hide lines indented more
8292 than that number of columns. */
8293 if (it
->selective
> 0
8294 && IT_CHARPOS (*it
) + 1 < ZV
8295 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8296 IT_BYTEPOS (*it
) + 1,
8299 success_p
= next_element_from_ellipsis (it
);
8300 it
->dpvec_char_len
= -1;
8303 else if (it
->c
== '\r' && it
->selective
== -1)
8305 /* A value of selective == -1 means that everything from the
8306 CR to the end of the line is invisible, with maybe an
8307 ellipsis displayed for it. */
8308 success_p
= next_element_from_ellipsis (it
);
8309 it
->dpvec_char_len
= -1;
8314 /* Value is zero if end of buffer reached. */
8315 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8320 /* Run the redisplay end trigger hook for IT. */
8323 run_redisplay_end_trigger_hook (struct it
*it
)
8325 Lisp_Object args
[3];
8327 /* IT->glyph_row should be non-null, i.e. we should be actually
8328 displaying something, or otherwise we should not run the hook. */
8329 eassert (it
->glyph_row
);
8331 /* Set up hook arguments. */
8332 args
[0] = Qredisplay_end_trigger_functions
;
8333 args
[1] = it
->window
;
8334 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8335 it
->redisplay_end_trigger_charpos
= 0;
8337 /* Since we are *trying* to run these functions, don't try to run
8338 them again, even if they get an error. */
8339 wset_redisplay_end_trigger (it
->w
, Qnil
);
8340 Frun_hook_with_args (3, args
);
8342 /* Notice if it changed the face of the character we are on. */
8343 handle_face_prop (it
);
8347 /* Deliver a composition display element. Unlike the other
8348 next_element_from_XXX, this function is not registered in the array
8349 get_next_element[]. It is called from next_element_from_buffer and
8350 next_element_from_string when necessary. */
8353 next_element_from_composition (struct it
*it
)
8355 it
->what
= IT_COMPOSITION
;
8356 it
->len
= it
->cmp_it
.nbytes
;
8357 if (STRINGP (it
->string
))
8361 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8362 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8365 it
->position
= it
->current
.string_pos
;
8366 it
->object
= it
->string
;
8367 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8368 IT_STRING_BYTEPOS (*it
), it
->string
);
8374 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8375 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8378 if (it
->bidi_it
.new_paragraph
)
8379 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8380 /* Resync the bidi iterator with IT's new position.
8381 FIXME: this doesn't support bidirectional text. */
8382 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8383 bidi_move_to_visually_next (&it
->bidi_it
);
8387 it
->position
= it
->current
.pos
;
8388 it
->object
= it
->w
->contents
;
8389 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8390 IT_BYTEPOS (*it
), Qnil
);
8397 /***********************************************************************
8398 Moving an iterator without producing glyphs
8399 ***********************************************************************/
8401 /* Check if iterator is at a position corresponding to a valid buffer
8402 position after some move_it_ call. */
8404 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8405 ((it)->method == GET_FROM_STRING \
8406 ? IT_STRING_CHARPOS (*it) == 0 \
8410 /* Move iterator IT to a specified buffer or X position within one
8411 line on the display without producing glyphs.
8413 OP should be a bit mask including some or all of these bits:
8414 MOVE_TO_X: Stop upon reaching x-position TO_X.
8415 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8416 Regardless of OP's value, stop upon reaching the end of the display line.
8418 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8419 This means, in particular, that TO_X includes window's horizontal
8422 The return value has several possible values that
8423 say what condition caused the scan to stop:
8425 MOVE_POS_MATCH_OR_ZV
8426 - when TO_POS or ZV was reached.
8429 -when TO_X was reached before TO_POS or ZV were reached.
8432 - when we reached the end of the display area and the line must
8436 - when we reached the end of the display area and the line is
8440 - when we stopped at a line end, i.e. a newline or a CR and selective
8443 static enum move_it_result
8444 move_it_in_display_line_to (struct it
*it
,
8445 ptrdiff_t to_charpos
, int to_x
,
8446 enum move_operation_enum op
)
8448 enum move_it_result result
= MOVE_UNDEFINED
;
8449 struct glyph_row
*saved_glyph_row
;
8450 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8451 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8452 void *ppos_data
= NULL
;
8454 enum it_method prev_method
= it
->method
;
8455 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8456 int saw_smaller_pos
= prev_pos
< to_charpos
;
8458 /* Don't produce glyphs in produce_glyphs. */
8459 saved_glyph_row
= it
->glyph_row
;
8460 it
->glyph_row
= NULL
;
8462 /* Use wrap_it to save a copy of IT wherever a word wrap could
8463 occur. Use atpos_it to save a copy of IT at the desired buffer
8464 position, if found, so that we can scan ahead and check if the
8465 word later overshoots the window edge. Use atx_it similarly, for
8471 /* Use ppos_it under bidi reordering to save a copy of IT for the
8472 initial position. We restore that position in IT when we have
8473 scanned the entire display line without finding a match for
8474 TO_CHARPOS and all the character positions are greater than
8475 TO_CHARPOS. We then restart the scan from the initial position,
8476 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8477 the closest to TO_CHARPOS. */
8480 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8482 SAVE_IT (ppos_it
, *it
, ppos_data
);
8483 closest_pos
= IT_CHARPOS (*it
);
8489 #define BUFFER_POS_REACHED_P() \
8490 ((op & MOVE_TO_POS) != 0 \
8491 && BUFFERP (it->object) \
8492 && (IT_CHARPOS (*it) == to_charpos \
8494 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8495 && IT_CHARPOS (*it) > to_charpos) \
8496 || (it->what == IT_COMPOSITION \
8497 && ((IT_CHARPOS (*it) > to_charpos \
8498 && to_charpos >= it->cmp_it.charpos) \
8499 || (IT_CHARPOS (*it) < to_charpos \
8500 && to_charpos <= it->cmp_it.charpos)))) \
8501 && (it->method == GET_FROM_BUFFER \
8502 || (it->method == GET_FROM_DISPLAY_VECTOR \
8503 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8505 /* If there's a line-/wrap-prefix, handle it. */
8506 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8507 && it
->current_y
< it
->last_visible_y
)
8508 handle_line_prefix (it
);
8510 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8511 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8515 int x
, i
, ascent
= 0, descent
= 0;
8517 /* Utility macro to reset an iterator with x, ascent, and descent. */
8518 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8519 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8520 (IT)->max_descent = descent)
8522 /* Stop if we move beyond TO_CHARPOS (after an image or a
8523 display string or stretch glyph). */
8524 if ((op
& MOVE_TO_POS
) != 0
8525 && BUFFERP (it
->object
)
8526 && it
->method
== GET_FROM_BUFFER
8528 /* When the iterator is at base embedding level, we
8529 are guaranteed that characters are delivered for
8530 display in strictly increasing order of their
8531 buffer positions. */
8532 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8533 && IT_CHARPOS (*it
) > to_charpos
)
8535 && (prev_method
== GET_FROM_IMAGE
8536 || prev_method
== GET_FROM_STRETCH
8537 || prev_method
== GET_FROM_STRING
)
8538 /* Passed TO_CHARPOS from left to right. */
8539 && ((prev_pos
< to_charpos
8540 && IT_CHARPOS (*it
) > to_charpos
)
8541 /* Passed TO_CHARPOS from right to left. */
8542 || (prev_pos
> to_charpos
8543 && IT_CHARPOS (*it
) < to_charpos
)))))
8545 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8547 result
= MOVE_POS_MATCH_OR_ZV
;
8550 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8551 /* If wrap_it is valid, the current position might be in a
8552 word that is wrapped. So, save the iterator in
8553 atpos_it and continue to see if wrapping happens. */
8554 SAVE_IT (atpos_it
, *it
, atpos_data
);
8557 /* Stop when ZV reached.
8558 We used to stop here when TO_CHARPOS reached as well, but that is
8559 too soon if this glyph does not fit on this line. So we handle it
8560 explicitly below. */
8561 if (!get_next_display_element (it
))
8563 result
= MOVE_POS_MATCH_OR_ZV
;
8567 if (it
->line_wrap
== TRUNCATE
)
8569 if (BUFFER_POS_REACHED_P ())
8571 result
= MOVE_POS_MATCH_OR_ZV
;
8577 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8579 if (IT_DISPLAYING_WHITESPACE (it
))
8583 /* We have reached a glyph that follows one or more
8584 whitespace characters. If the position is
8585 already found, we are done. */
8586 if (atpos_it
.sp
>= 0)
8588 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8589 result
= MOVE_POS_MATCH_OR_ZV
;
8594 RESTORE_IT (it
, &atx_it
, atx_data
);
8595 result
= MOVE_X_REACHED
;
8598 /* Otherwise, we can wrap here. */
8599 SAVE_IT (wrap_it
, *it
, wrap_data
);
8605 /* Remember the line height for the current line, in case
8606 the next element doesn't fit on the line. */
8607 ascent
= it
->max_ascent
;
8608 descent
= it
->max_descent
;
8610 /* The call to produce_glyphs will get the metrics of the
8611 display element IT is loaded with. Record the x-position
8612 before this display element, in case it doesn't fit on the
8616 PRODUCE_GLYPHS (it
);
8618 if (it
->area
!= TEXT_AREA
)
8620 prev_method
= it
->method
;
8621 if (it
->method
== GET_FROM_BUFFER
)
8622 prev_pos
= IT_CHARPOS (*it
);
8623 set_iterator_to_next (it
, 1);
8624 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8625 SET_TEXT_POS (this_line_min_pos
,
8626 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8628 && (op
& MOVE_TO_POS
)
8629 && IT_CHARPOS (*it
) > to_charpos
8630 && IT_CHARPOS (*it
) < closest_pos
)
8631 closest_pos
= IT_CHARPOS (*it
);
8635 /* The number of glyphs we get back in IT->nglyphs will normally
8636 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8637 character on a terminal frame, or (iii) a line end. For the
8638 second case, IT->nglyphs - 1 padding glyphs will be present.
8639 (On X frames, there is only one glyph produced for a
8640 composite character.)
8642 The behavior implemented below means, for continuation lines,
8643 that as many spaces of a TAB as fit on the current line are
8644 displayed there. For terminal frames, as many glyphs of a
8645 multi-glyph character are displayed in the current line, too.
8646 This is what the old redisplay code did, and we keep it that
8647 way. Under X, the whole shape of a complex character must
8648 fit on the line or it will be completely displayed in the
8651 Note that both for tabs and padding glyphs, all glyphs have
8655 /* More than one glyph or glyph doesn't fit on line. All
8656 glyphs have the same width. */
8657 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8659 int x_before_this_char
= x
;
8660 int hpos_before_this_char
= it
->hpos
;
8662 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8664 new_x
= x
+ single_glyph_width
;
8666 /* We want to leave anything reaching TO_X to the caller. */
8667 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8669 if (BUFFER_POS_REACHED_P ())
8671 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8672 goto buffer_pos_reached
;
8673 if (atpos_it
.sp
< 0)
8675 SAVE_IT (atpos_it
, *it
, atpos_data
);
8676 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8681 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8684 result
= MOVE_X_REACHED
;
8689 SAVE_IT (atx_it
, *it
, atx_data
);
8690 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8695 if (/* Lines are continued. */
8696 it
->line_wrap
!= TRUNCATE
8697 && (/* And glyph doesn't fit on the line. */
8698 new_x
> it
->last_visible_x
8699 /* Or it fits exactly and we're on a window
8701 || (new_x
== it
->last_visible_x
8702 && FRAME_WINDOW_P (it
->f
)
8703 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8704 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8705 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8707 if (/* IT->hpos == 0 means the very first glyph
8708 doesn't fit on the line, e.g. a wide image. */
8710 || (new_x
== it
->last_visible_x
8711 && FRAME_WINDOW_P (it
->f
)
8712 /* When word-wrap is ON and we have a valid
8713 wrap point, we don't allow the last glyph
8714 to "just barely fit" on the line. */
8715 && (it
->line_wrap
!= WORD_WRAP
8716 || wrap_it
.sp
< 0)))
8719 it
->current_x
= new_x
;
8721 /* The character's last glyph just barely fits
8723 if (i
== it
->nglyphs
- 1)
8725 /* If this is the destination position,
8726 return a position *before* it in this row,
8727 now that we know it fits in this row. */
8728 if (BUFFER_POS_REACHED_P ())
8730 if (it
->line_wrap
!= WORD_WRAP
8733 it
->hpos
= hpos_before_this_char
;
8734 it
->current_x
= x_before_this_char
;
8735 result
= MOVE_POS_MATCH_OR_ZV
;
8738 if (it
->line_wrap
== WORD_WRAP
8741 SAVE_IT (atpos_it
, *it
, atpos_data
);
8742 atpos_it
.current_x
= x_before_this_char
;
8743 atpos_it
.hpos
= hpos_before_this_char
;
8747 prev_method
= it
->method
;
8748 if (it
->method
== GET_FROM_BUFFER
)
8749 prev_pos
= IT_CHARPOS (*it
);
8750 set_iterator_to_next (it
, 1);
8751 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8752 SET_TEXT_POS (this_line_min_pos
,
8753 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8754 /* On graphical terminals, newlines may
8755 "overflow" into the fringe if
8756 overflow-newline-into-fringe is non-nil.
8757 On text terminals, and on graphical
8758 terminals with no right margin, newlines
8759 may overflow into the last glyph on the
8761 if (!FRAME_WINDOW_P (it
->f
)
8763 && it
->bidi_it
.paragraph_dir
== R2L
)
8764 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8765 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8766 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8768 if (!get_next_display_element (it
))
8770 result
= MOVE_POS_MATCH_OR_ZV
;
8773 if (BUFFER_POS_REACHED_P ())
8775 if (ITERATOR_AT_END_OF_LINE_P (it
))
8776 result
= MOVE_POS_MATCH_OR_ZV
;
8778 result
= MOVE_LINE_CONTINUED
;
8781 if (ITERATOR_AT_END_OF_LINE_P (it
)
8782 && (it
->line_wrap
!= WORD_WRAP
8785 result
= MOVE_NEWLINE_OR_CR
;
8792 IT_RESET_X_ASCENT_DESCENT (it
);
8794 if (wrap_it
.sp
>= 0)
8796 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8801 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8803 result
= MOVE_LINE_CONTINUED
;
8807 if (BUFFER_POS_REACHED_P ())
8809 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8810 goto buffer_pos_reached
;
8811 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8813 SAVE_IT (atpos_it
, *it
, atpos_data
);
8814 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8818 if (new_x
> it
->first_visible_x
)
8820 /* Glyph is visible. Increment number of glyphs that
8821 would be displayed. */
8826 if (result
!= MOVE_UNDEFINED
)
8829 else if (BUFFER_POS_REACHED_P ())
8832 IT_RESET_X_ASCENT_DESCENT (it
);
8833 result
= MOVE_POS_MATCH_OR_ZV
;
8836 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8838 /* Stop when TO_X specified and reached. This check is
8839 necessary here because of lines consisting of a line end,
8840 only. The line end will not produce any glyphs and we
8841 would never get MOVE_X_REACHED. */
8842 eassert (it
->nglyphs
== 0);
8843 result
= MOVE_X_REACHED
;
8847 /* Is this a line end? If yes, we're done. */
8848 if (ITERATOR_AT_END_OF_LINE_P (it
))
8850 /* If we are past TO_CHARPOS, but never saw any character
8851 positions smaller than TO_CHARPOS, return
8852 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8854 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8856 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8858 if (closest_pos
< ZV
)
8860 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8861 /* Don't recurse if closest_pos is equal to
8862 to_charpos, since we have just tried that. */
8863 if (closest_pos
!= to_charpos
)
8864 move_it_in_display_line_to (it
, closest_pos
, -1,
8866 result
= MOVE_POS_MATCH_OR_ZV
;
8869 goto buffer_pos_reached
;
8871 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8872 && IT_CHARPOS (*it
) > to_charpos
)
8873 goto buffer_pos_reached
;
8875 result
= MOVE_NEWLINE_OR_CR
;
8878 result
= MOVE_NEWLINE_OR_CR
;
8882 prev_method
= it
->method
;
8883 if (it
->method
== GET_FROM_BUFFER
)
8884 prev_pos
= IT_CHARPOS (*it
);
8885 /* The current display element has been consumed. Advance
8887 set_iterator_to_next (it
, 1);
8888 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8889 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8890 if (IT_CHARPOS (*it
) < to_charpos
)
8891 saw_smaller_pos
= 1;
8893 && (op
& MOVE_TO_POS
)
8894 && IT_CHARPOS (*it
) >= to_charpos
8895 && IT_CHARPOS (*it
) < closest_pos
)
8896 closest_pos
= IT_CHARPOS (*it
);
8898 /* Stop if lines are truncated and IT's current x-position is
8899 past the right edge of the window now. */
8900 if (it
->line_wrap
== TRUNCATE
8901 && it
->current_x
>= it
->last_visible_x
)
8903 if (!FRAME_WINDOW_P (it
->f
)
8904 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8905 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8906 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8907 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8911 if ((at_eob_p
= !get_next_display_element (it
))
8912 || BUFFER_POS_REACHED_P ()
8913 /* If we are past TO_CHARPOS, but never saw any
8914 character positions smaller than TO_CHARPOS,
8915 return MOVE_POS_MATCH_OR_ZV, like the
8916 unidirectional display did. */
8917 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8919 && IT_CHARPOS (*it
) > to_charpos
))
8922 && !BUFFER_POS_REACHED_P ()
8923 && !at_eob_p
&& closest_pos
< ZV
)
8925 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8926 if (closest_pos
!= to_charpos
)
8927 move_it_in_display_line_to (it
, closest_pos
, -1,
8930 result
= MOVE_POS_MATCH_OR_ZV
;
8933 if (ITERATOR_AT_END_OF_LINE_P (it
))
8935 result
= MOVE_NEWLINE_OR_CR
;
8939 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8941 && IT_CHARPOS (*it
) > to_charpos
)
8943 if (closest_pos
< ZV
)
8945 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8946 if (closest_pos
!= to_charpos
)
8947 move_it_in_display_line_to (it
, closest_pos
, -1,
8950 result
= MOVE_POS_MATCH_OR_ZV
;
8953 result
= MOVE_LINE_TRUNCATED
;
8956 #undef IT_RESET_X_ASCENT_DESCENT
8959 #undef BUFFER_POS_REACHED_P
8961 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8962 restore the saved iterator. */
8963 if (atpos_it
.sp
>= 0)
8964 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8965 else if (atx_it
.sp
>= 0)
8966 RESTORE_IT (it
, &atx_it
, atx_data
);
8971 bidi_unshelve_cache (atpos_data
, 1);
8973 bidi_unshelve_cache (atx_data
, 1);
8975 bidi_unshelve_cache (wrap_data
, 1);
8977 bidi_unshelve_cache (ppos_data
, 1);
8979 /* Restore the iterator settings altered at the beginning of this
8981 it
->glyph_row
= saved_glyph_row
;
8985 /* For external use. */
8987 move_it_in_display_line (struct it
*it
,
8988 ptrdiff_t to_charpos
, int to_x
,
8989 enum move_operation_enum op
)
8991 if (it
->line_wrap
== WORD_WRAP
8992 && (op
& MOVE_TO_X
))
8995 void *save_data
= NULL
;
8998 SAVE_IT (save_it
, *it
, save_data
);
8999 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9000 /* When word-wrap is on, TO_X may lie past the end
9001 of a wrapped line. Then it->current is the
9002 character on the next line, so backtrack to the
9003 space before the wrap point. */
9004 if (skip
== MOVE_LINE_CONTINUED
)
9006 int prev_x
= max (it
->current_x
- 1, 0);
9007 RESTORE_IT (it
, &save_it
, save_data
);
9008 move_it_in_display_line_to
9009 (it
, -1, prev_x
, MOVE_TO_X
);
9012 bidi_unshelve_cache (save_data
, 1);
9015 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9019 /* Move IT forward until it satisfies one or more of the criteria in
9020 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9022 OP is a bit-mask that specifies where to stop, and in particular,
9023 which of those four position arguments makes a difference. See the
9024 description of enum move_operation_enum.
9026 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9027 screen line, this function will set IT to the next position that is
9028 displayed to the right of TO_CHARPOS on the screen.
9030 Return the maximum pixel length of any line scanned but never more
9031 than it.last_visible_x. */
9034 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9036 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9037 int line_height
, line_start_x
= 0, reached
= 0;
9038 int max_current_x
= 0;
9039 void *backup_data
= NULL
;
9043 if (op
& MOVE_TO_VPOS
)
9045 /* If no TO_CHARPOS and no TO_X specified, stop at the
9046 start of the line TO_VPOS. */
9047 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9049 if (it
->vpos
== to_vpos
)
9055 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9059 /* TO_VPOS >= 0 means stop at TO_X in the line at
9060 TO_VPOS, or at TO_POS, whichever comes first. */
9061 if (it
->vpos
== to_vpos
)
9067 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9069 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9074 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9076 /* We have reached TO_X but not in the line we want. */
9077 skip
= move_it_in_display_line_to (it
, to_charpos
,
9079 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9087 else if (op
& MOVE_TO_Y
)
9089 struct it it_backup
;
9091 if (it
->line_wrap
== WORD_WRAP
)
9092 SAVE_IT (it_backup
, *it
, backup_data
);
9094 /* TO_Y specified means stop at TO_X in the line containing
9095 TO_Y---or at TO_CHARPOS if this is reached first. The
9096 problem is that we can't really tell whether the line
9097 contains TO_Y before we have completely scanned it, and
9098 this may skip past TO_X. What we do is to first scan to
9101 If TO_X is not specified, use a TO_X of zero. The reason
9102 is to make the outcome of this function more predictable.
9103 If we didn't use TO_X == 0, we would stop at the end of
9104 the line which is probably not what a caller would expect
9106 skip
= move_it_in_display_line_to
9107 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9108 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9110 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9111 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9113 else if (skip
== MOVE_X_REACHED
)
9115 /* If TO_X was reached, we want to know whether TO_Y is
9116 in the line. We know this is the case if the already
9117 scanned glyphs make the line tall enough. Otherwise,
9118 we must check by scanning the rest of the line. */
9119 line_height
= it
->max_ascent
+ it
->max_descent
;
9120 if (to_y
>= it
->current_y
9121 && to_y
< it
->current_y
+ line_height
)
9126 SAVE_IT (it_backup
, *it
, backup_data
);
9127 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9128 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9130 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9131 line_height
= it
->max_ascent
+ it
->max_descent
;
9132 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9134 if (to_y
>= it
->current_y
9135 && to_y
< it
->current_y
+ line_height
)
9137 /* If TO_Y is in this line and TO_X was reached
9138 above, we scanned too far. We have to restore
9139 IT's settings to the ones before skipping. But
9140 keep the more accurate values of max_ascent and
9141 max_descent we've found while skipping the rest
9142 of the line, for the sake of callers, such as
9143 pos_visible_p, that need to know the line
9145 int max_ascent
= it
->max_ascent
;
9146 int max_descent
= it
->max_descent
;
9148 RESTORE_IT (it
, &it_backup
, backup_data
);
9149 it
->max_ascent
= max_ascent
;
9150 it
->max_descent
= max_descent
;
9156 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9162 /* Check whether TO_Y is in this line. */
9163 line_height
= it
->max_ascent
+ it
->max_descent
;
9164 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9166 if (to_y
>= it
->current_y
9167 && to_y
< it
->current_y
+ line_height
)
9169 if (to_y
> it
->current_y
)
9170 max_current_x
= max (it
->current_x
, max_current_x
);
9172 /* When word-wrap is on, TO_X may lie past the end
9173 of a wrapped line. Then it->current is the
9174 character on the next line, so backtrack to the
9175 space before the wrap point. */
9176 if (skip
== MOVE_LINE_CONTINUED
9177 && it
->line_wrap
== WORD_WRAP
)
9179 int prev_x
= max (it
->current_x
- 1, 0);
9180 RESTORE_IT (it
, &it_backup
, backup_data
);
9181 skip
= move_it_in_display_line_to
9182 (it
, -1, prev_x
, MOVE_TO_X
);
9191 max_current_x
= max (it
->current_x
, max_current_x
);
9195 else if (BUFFERP (it
->object
)
9196 && (it
->method
== GET_FROM_BUFFER
9197 || it
->method
== GET_FROM_STRETCH
)
9198 && IT_CHARPOS (*it
) >= to_charpos
9199 /* Under bidi iteration, a call to set_iterator_to_next
9200 can scan far beyond to_charpos if the initial
9201 portion of the next line needs to be reordered. In
9202 that case, give move_it_in_display_line_to another
9205 && it
->bidi_it
.scan_dir
== -1))
9206 skip
= MOVE_POS_MATCH_OR_ZV
;
9208 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9212 case MOVE_POS_MATCH_OR_ZV
:
9213 max_current_x
= max (it
->current_x
, max_current_x
);
9217 case MOVE_NEWLINE_OR_CR
:
9218 max_current_x
= max (it
->current_x
, max_current_x
);
9219 set_iterator_to_next (it
, 1);
9220 it
->continuation_lines_width
= 0;
9223 case MOVE_LINE_TRUNCATED
:
9224 max_current_x
= it
->last_visible_x
;
9225 it
->continuation_lines_width
= 0;
9226 reseat_at_next_visible_line_start (it
, 0);
9227 if ((op
& MOVE_TO_POS
) != 0
9228 && IT_CHARPOS (*it
) > to_charpos
)
9235 case MOVE_LINE_CONTINUED
:
9236 max_current_x
= it
->last_visible_x
;
9237 /* For continued lines ending in a tab, some of the glyphs
9238 associated with the tab are displayed on the current
9239 line. Since it->current_x does not include these glyphs,
9240 we use it->last_visible_x instead. */
9243 it
->continuation_lines_width
+= it
->last_visible_x
;
9244 /* When moving by vpos, ensure that the iterator really
9245 advances to the next line (bug#847, bug#969). Fixme:
9246 do we need to do this in other circumstances? */
9247 if (it
->current_x
!= it
->last_visible_x
9248 && (op
& MOVE_TO_VPOS
)
9249 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9251 line_start_x
= it
->current_x
+ it
->pixel_width
9252 - it
->last_visible_x
;
9253 if (FRAME_WINDOW_P (it
->f
))
9255 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9256 struct font
*face_font
= face
->font
;
9258 /* When display_line produces a continued line
9259 that ends in a TAB, it skips a tab stop that
9260 is closer than the font's space character
9261 width (see x_produce_glyphs where it produces
9262 the stretch glyph which represents a TAB).
9263 We need to reproduce the same logic here. */
9264 eassert (face_font
);
9267 if (line_start_x
< face_font
->space_width
)
9269 += it
->tab_width
* face_font
->space_width
;
9272 set_iterator_to_next (it
, 0);
9276 it
->continuation_lines_width
+= it
->current_x
;
9283 /* Reset/increment for the next run. */
9284 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9285 it
->current_x
= line_start_x
;
9288 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9290 last_height
= it
->max_ascent
+ it
->max_descent
;
9291 it
->max_ascent
= it
->max_descent
= 0;
9296 /* On text terminals, we may stop at the end of a line in the middle
9297 of a multi-character glyph. If the glyph itself is continued,
9298 i.e. it is actually displayed on the next line, don't treat this
9299 stopping point as valid; move to the next line instead (unless
9300 that brings us offscreen). */
9301 if (!FRAME_WINDOW_P (it
->f
)
9303 && IT_CHARPOS (*it
) == to_charpos
9304 && it
->what
== IT_CHARACTER
9306 && it
->line_wrap
== WINDOW_WRAP
9307 && it
->current_x
== it
->last_visible_x
- 1
9310 && it
->vpos
< it
->w
->window_end_vpos
)
9312 it
->continuation_lines_width
+= it
->current_x
;
9313 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9314 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9316 last_height
= it
->max_ascent
+ it
->max_descent
;
9320 bidi_unshelve_cache (backup_data
, 1);
9322 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9324 return max_current_x
;
9328 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9330 If DY > 0, move IT backward at least that many pixels. DY = 0
9331 means move IT backward to the preceding line start or BEGV. This
9332 function may move over more than DY pixels if IT->current_y - DY
9333 ends up in the middle of a line; in this case IT->current_y will be
9334 set to the top of the line moved to. */
9337 move_it_vertically_backward (struct it
*it
, int dy
)
9341 void *it2data
= NULL
, *it3data
= NULL
;
9342 ptrdiff_t start_pos
;
9344 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9345 ptrdiff_t pos_limit
;
9350 start_pos
= IT_CHARPOS (*it
);
9352 /* Estimate how many newlines we must move back. */
9353 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9354 if (it
->line_wrap
== TRUNCATE
)
9357 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9359 /* Set the iterator's position that many lines back. But don't go
9360 back more than NLINES full screen lines -- this wins a day with
9361 buffers which have very long lines. */
9362 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9363 back_to_previous_visible_line_start (it
);
9365 /* Reseat the iterator here. When moving backward, we don't want
9366 reseat to skip forward over invisible text, set up the iterator
9367 to deliver from overlay strings at the new position etc. So,
9368 use reseat_1 here. */
9369 reseat_1 (it
, it
->current
.pos
, 1);
9371 /* We are now surely at a line start. */
9372 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9373 reordering is in effect. */
9374 it
->continuation_lines_width
= 0;
9376 /* Move forward and see what y-distance we moved. First move to the
9377 start of the next line so that we get its height. We need this
9378 height to be able to tell whether we reached the specified
9380 SAVE_IT (it2
, *it
, it2data
);
9381 it2
.max_ascent
= it2
.max_descent
= 0;
9384 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9385 MOVE_TO_POS
| MOVE_TO_VPOS
);
9387 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9388 /* If we are in a display string which starts at START_POS,
9389 and that display string includes a newline, and we are
9390 right after that newline (i.e. at the beginning of a
9391 display line), exit the loop, because otherwise we will
9392 infloop, since move_it_to will see that it is already at
9393 START_POS and will not move. */
9394 || (it2
.method
== GET_FROM_STRING
9395 && IT_CHARPOS (it2
) == start_pos
9396 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9397 eassert (IT_CHARPOS (*it
) >= BEGV
);
9398 SAVE_IT (it3
, it2
, it3data
);
9400 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9401 eassert (IT_CHARPOS (*it
) >= BEGV
);
9402 /* H is the actual vertical distance from the position in *IT
9403 and the starting position. */
9404 h
= it2
.current_y
- it
->current_y
;
9405 /* NLINES is the distance in number of lines. */
9406 nlines
= it2
.vpos
- it
->vpos
;
9408 /* Correct IT's y and vpos position
9409 so that they are relative to the starting point. */
9415 /* DY == 0 means move to the start of the screen line. The
9416 value of nlines is > 0 if continuation lines were involved,
9417 or if the original IT position was at start of a line. */
9418 RESTORE_IT (it
, it
, it2data
);
9420 move_it_by_lines (it
, nlines
);
9421 /* The above code moves us to some position NLINES down,
9422 usually to its first glyph (leftmost in an L2R line), but
9423 that's not necessarily the start of the line, under bidi
9424 reordering. We want to get to the character position
9425 that is immediately after the newline of the previous
9428 && !it
->continuation_lines_width
9429 && !STRINGP (it
->string
)
9430 && IT_CHARPOS (*it
) > BEGV
9431 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9433 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9436 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9437 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9439 bidi_unshelve_cache (it3data
, 1);
9443 /* The y-position we try to reach, relative to *IT.
9444 Note that H has been subtracted in front of the if-statement. */
9445 int target_y
= it
->current_y
+ h
- dy
;
9446 int y0
= it3
.current_y
;
9450 RESTORE_IT (&it3
, &it3
, it3data
);
9451 y1
= line_bottom_y (&it3
);
9452 line_height
= y1
- y0
;
9453 RESTORE_IT (it
, it
, it2data
);
9454 /* If we did not reach target_y, try to move further backward if
9455 we can. If we moved too far backward, try to move forward. */
9456 if (target_y
< it
->current_y
9457 /* This is heuristic. In a window that's 3 lines high, with
9458 a line height of 13 pixels each, recentering with point
9459 on the bottom line will try to move -39/2 = 19 pixels
9460 backward. Try to avoid moving into the first line. */
9461 && (it
->current_y
- target_y
9462 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9463 && IT_CHARPOS (*it
) > BEGV
)
9465 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9466 target_y
- it
->current_y
));
9467 dy
= it
->current_y
- target_y
;
9468 goto move_further_back
;
9470 else if (target_y
>= it
->current_y
+ line_height
9471 && IT_CHARPOS (*it
) < ZV
)
9473 /* Should move forward by at least one line, maybe more.
9475 Note: Calling move_it_by_lines can be expensive on
9476 terminal frames, where compute_motion is used (via
9477 vmotion) to do the job, when there are very long lines
9478 and truncate-lines is nil. That's the reason for
9479 treating terminal frames specially here. */
9481 if (!FRAME_WINDOW_P (it
->f
))
9482 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9487 move_it_by_lines (it
, 1);
9489 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9496 /* Move IT by a specified amount of pixel lines DY. DY negative means
9497 move backwards. DY = 0 means move to start of screen line. At the
9498 end, IT will be on the start of a screen line. */
9501 move_it_vertically (struct it
*it
, int dy
)
9504 move_it_vertically_backward (it
, -dy
);
9507 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9508 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9509 MOVE_TO_POS
| MOVE_TO_Y
);
9510 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9512 /* If buffer ends in ZV without a newline, move to the start of
9513 the line to satisfy the post-condition. */
9514 if (IT_CHARPOS (*it
) == ZV
9516 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9517 move_it_by_lines (it
, 0);
9522 /* Move iterator IT past the end of the text line it is in. */
9525 move_it_past_eol (struct it
*it
)
9527 enum move_it_result rc
;
9529 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9530 if (rc
== MOVE_NEWLINE_OR_CR
)
9531 set_iterator_to_next (it
, 0);
9535 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9536 negative means move up. DVPOS == 0 means move to the start of the
9539 Optimization idea: If we would know that IT->f doesn't use
9540 a face with proportional font, we could be faster for
9541 truncate-lines nil. */
9544 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9547 /* The commented-out optimization uses vmotion on terminals. This
9548 gives bad results, because elements like it->what, on which
9549 callers such as pos_visible_p rely, aren't updated. */
9550 /* struct position pos;
9551 if (!FRAME_WINDOW_P (it->f))
9553 struct text_pos textpos;
9555 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9556 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9557 reseat (it, textpos, 1);
9558 it->vpos += pos.vpos;
9559 it->current_y += pos.vpos;
9565 /* DVPOS == 0 means move to the start of the screen line. */
9566 move_it_vertically_backward (it
, 0);
9567 /* Let next call to line_bottom_y calculate real line height. */
9572 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9573 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9575 /* Only move to the next buffer position if we ended up in a
9576 string from display property, not in an overlay string
9577 (before-string or after-string). That is because the
9578 latter don't conceal the underlying buffer position, so
9579 we can ask to move the iterator to the exact position we
9580 are interested in. Note that, even if we are already at
9581 IT_CHARPOS (*it), the call below is not a no-op, as it
9582 will detect that we are at the end of the string, pop the
9583 iterator, and compute it->current_x and it->hpos
9585 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9586 -1, -1, -1, MOVE_TO_POS
);
9592 void *it2data
= NULL
;
9593 ptrdiff_t start_charpos
, i
;
9595 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9596 bool hit_pos_limit
= false;
9597 ptrdiff_t pos_limit
;
9599 /* Start at the beginning of the screen line containing IT's
9600 position. This may actually move vertically backwards,
9601 in case of overlays, so adjust dvpos accordingly. */
9603 move_it_vertically_backward (it
, 0);
9606 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9607 screen lines, and reseat the iterator there. */
9608 start_charpos
= IT_CHARPOS (*it
);
9609 if (it
->line_wrap
== TRUNCATE
)
9612 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9614 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9615 back_to_previous_visible_line_start (it
);
9616 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9617 hit_pos_limit
= true;
9618 reseat (it
, it
->current
.pos
, 1);
9620 /* Move further back if we end up in a string or an image. */
9621 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9623 /* First try to move to start of display line. */
9625 move_it_vertically_backward (it
, 0);
9627 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9629 /* If start of line is still in string or image,
9630 move further back. */
9631 back_to_previous_visible_line_start (it
);
9632 reseat (it
, it
->current
.pos
, 1);
9636 it
->current_x
= it
->hpos
= 0;
9638 /* Above call may have moved too far if continuation lines
9639 are involved. Scan forward and see if it did. */
9640 SAVE_IT (it2
, *it
, it2data
);
9641 it2
.vpos
= it2
.current_y
= 0;
9642 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9643 it
->vpos
-= it2
.vpos
;
9644 it
->current_y
-= it2
.current_y
;
9645 it
->current_x
= it
->hpos
= 0;
9647 /* If we moved too far back, move IT some lines forward. */
9648 if (it2
.vpos
> -dvpos
)
9650 int delta
= it2
.vpos
+ dvpos
;
9652 RESTORE_IT (&it2
, &it2
, it2data
);
9653 SAVE_IT (it2
, *it
, it2data
);
9654 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9655 /* Move back again if we got too far ahead. */
9656 if (IT_CHARPOS (*it
) >= start_charpos
)
9657 RESTORE_IT (it
, &it2
, it2data
);
9659 bidi_unshelve_cache (it2data
, 1);
9661 else if (hit_pos_limit
&& pos_limit
> BEGV
9662 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9664 /* If we hit the limit, but still didn't make it far enough
9665 back, that means there's a display string with a newline
9666 covering a large chunk of text, and that caused
9667 back_to_previous_visible_line_start try to go too far.
9668 Punish those who commit such atrocities by going back
9669 until we've reached DVPOS, after lifting the limit, which
9670 could make it slow for very long lines. "If it hurts,
9673 RESTORE_IT (it
, it
, it2data
);
9674 for (i
= -dvpos
; i
> 0; --i
)
9676 back_to_previous_visible_line_start (it
);
9681 RESTORE_IT (it
, it
, it2data
);
9685 /* Return true if IT points into the middle of a display vector. */
9688 in_display_vector_p (struct it
*it
)
9690 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9691 && it
->current
.dpvec_index
> 0
9692 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9695 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9696 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9697 WINDOW must be a live window and defaults to the selected one. The
9698 return value is a cons of the maximum pixel-width of any text line and
9699 the maximum pixel-height of all text lines.
9701 The optional argument FROM, if non-nil, specifies the first text
9702 position and defaults to the minimum accessible position of the buffer.
9703 If FROM is t, use the minimum accessible position that is not a newline
9704 character. TO, if non-nil, specifies the last text position and
9705 defaults to the maximum accessible position of the buffer. If TO is t,
9706 use the maximum accessible position that is not a newline character.
9708 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9709 width that can be returned. X-LIMIT nil or omitted, means to use the
9710 pixel-width of WINDOW's body; use this if you do not intend to change
9711 the width of WINDOW. Use the maximum width WINDOW may assume if you
9712 intend to change WINDOW's width. In any case, text whose x-coordinate
9713 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9714 can take some time, it's always a good idea to make this argument as
9715 small as possible; in particular, if the buffer contains long lines that
9716 shall be truncated anyway.
9718 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9719 height that can be returned. Text lines whose y-coordinate is beyond
9720 Y-LIMIT are ignored. Since calculating the text height of a large
9721 buffer can take some time, it makes sense to specify this argument if
9722 the size of the buffer is unknown.
9724 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9725 include the height of the mode- or header-line of WINDOW in the return
9726 value. If it is either the symbol `mode-line' or `header-line', include
9727 only the height of that line, if present, in the return value. If t,
9728 include the height of both, if present, in the return value. */)
9729 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
, Lisp_Object y_limit
,
9730 Lisp_Object mode_and_header_line
)
9732 struct window
*w
= decode_live_window (window
);
9736 struct buffer
*old_buffer
= NULL
;
9737 ptrdiff_t start
, end
, pos
;
9738 struct text_pos startp
;
9739 void *itdata
= NULL
;
9740 int c
, max_y
= -1, x
= 0, y
= 0;
9746 if (b
!= current_buffer
)
9748 old_buffer
= current_buffer
;
9749 set_buffer_internal (b
);
9754 else if (EQ (from
, Qt
))
9757 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9758 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9760 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9765 CHECK_NUMBER_COERCE_MARKER (from
);
9766 start
= min (max (XINT (from
), BEGV
), ZV
);
9771 else if (EQ (to
, Qt
))
9774 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9775 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9777 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9782 CHECK_NUMBER_COERCE_MARKER (to
);
9783 end
= max (start
, min (XINT (to
), ZV
));
9786 if (!NILP (y_limit
))
9788 CHECK_NUMBER (y_limit
);
9789 max_y
= min (XINT (y_limit
), INT_MAX
);
9792 itdata
= bidi_shelve_cache ();
9793 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9794 start_display (&it
, w
, startp
);
9797 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9800 CHECK_NUMBER (x_limit
);
9801 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9802 /* Actually, we never want move_it_to stop at to_x. But to make
9803 sure that move_it_in_display_line_to always moves far enough,
9804 we set it to INT_MAX and specify MOVE_TO_X. */
9805 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9806 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9809 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9811 if (!EQ (mode_and_header_line
, Qheader_line
)
9812 && !EQ (mode_and_header_line
, Qt
))
9813 /* Do not count the header-line which was counted automatically by
9815 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9817 if (EQ (mode_and_header_line
, Qmode_line
)
9818 || EQ (mode_and_header_line
, Qt
))
9819 /* Do count the mode-line which is not included automatically by
9821 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9823 bidi_unshelve_cache (itdata
, 0);
9826 set_buffer_internal (old_buffer
);
9828 return Fcons (make_number (x
), make_number (y
));
9831 /***********************************************************************
9833 ***********************************************************************/
9836 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9840 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9842 Lisp_Object args
[3];
9843 Lisp_Object msg
, fmt
;
9846 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9850 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9852 args
[0] = fmt
= build_string (format
);
9855 msg
= Fformat (3, args
);
9857 len
= SBYTES (msg
) + 1;
9858 buffer
= SAFE_ALLOCA (len
);
9859 memcpy (buffer
, SDATA (msg
), len
);
9861 message_dolog (buffer
, len
- 1, 1, 0);
9868 /* Output a newline in the *Messages* buffer if "needs" one. */
9871 message_log_maybe_newline (void)
9873 if (message_log_need_newline
)
9874 message_dolog ("", 0, 1, 0);
9878 /* Add a string M of length NBYTES to the message log, optionally
9879 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9880 true, means interpret the contents of M as multibyte. This
9881 function calls low-level routines in order to bypass text property
9882 hooks, etc. which might not be safe to run.
9884 This may GC (insert may run before/after change hooks),
9885 so the buffer M must NOT point to a Lisp string. */
9888 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9890 const unsigned char *msg
= (const unsigned char *) m
;
9892 if (!NILP (Vmemory_full
))
9895 if (!NILP (Vmessage_log_max
))
9897 struct buffer
*oldbuf
;
9898 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9899 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9900 ptrdiff_t point_at_end
= 0;
9901 ptrdiff_t zv_at_end
= 0;
9902 Lisp_Object old_deactivate_mark
;
9903 struct gcpro gcpro1
;
9905 old_deactivate_mark
= Vdeactivate_mark
;
9906 oldbuf
= current_buffer
;
9908 /* Ensure the Messages buffer exists, and switch to it.
9909 If we created it, set the major-mode. */
9912 if (NILP (Fget_buffer (Vmessages_buffer_name
))) newbuffer
= 1;
9914 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9917 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9918 call0 (intern ("messages-buffer-mode"));
9921 bset_undo_list (current_buffer
, Qt
);
9922 bset_cache_long_scans (current_buffer
, Qnil
);
9924 oldpoint
= message_dolog_marker1
;
9925 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9926 oldbegv
= message_dolog_marker2
;
9927 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
9928 oldzv
= message_dolog_marker3
;
9929 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
9930 GCPRO1 (old_deactivate_mark
);
9938 BEGV_BYTE
= BEG_BYTE
;
9941 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9943 /* Insert the string--maybe converting multibyte to single byte
9944 or vice versa, so that all the text fits the buffer. */
9946 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9952 /* Convert a multibyte string to single-byte
9953 for the *Message* buffer. */
9954 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9956 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9957 work
[0] = (ASCII_CHAR_P (c
)
9959 : multibyte_char_to_unibyte (c
));
9960 insert_1_both (work
, 1, 1, 1, 0, 0);
9963 else if (! multibyte
9964 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9968 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9969 /* Convert a single-byte string to multibyte
9970 for the *Message* buffer. */
9971 for (i
= 0; i
< nbytes
; i
++)
9974 MAKE_CHAR_MULTIBYTE (c
);
9975 char_bytes
= CHAR_STRING (c
, str
);
9976 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9980 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
, 1, 0, 0);
9984 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9987 insert_1_both ("\n", 1, 1, 1, 0, 0);
9989 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9991 this_bol_byte
= PT_BYTE
;
9993 /* See if this line duplicates the previous one.
9994 If so, combine duplicates. */
9997 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9999 prev_bol_byte
= PT_BYTE
;
10001 dups
= message_log_check_duplicate (prev_bol_byte
,
10005 del_range_both (prev_bol
, prev_bol_byte
,
10006 this_bol
, this_bol_byte
, 0);
10009 char dupstr
[sizeof " [ times]"
10010 + INT_STRLEN_BOUND (printmax_t
)];
10012 /* If you change this format, don't forget to also
10013 change message_log_check_duplicate. */
10014 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10015 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10016 insert_1_both (dupstr
, duplen
, duplen
, 1, 0, 1);
10021 /* If we have more than the desired maximum number of lines
10022 in the *Messages* buffer now, delete the oldest ones.
10023 This is safe because we don't have undo in this buffer. */
10025 if (NATNUMP (Vmessage_log_max
))
10027 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10028 -XFASTINT (Vmessage_log_max
) - 1, 0);
10029 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
10032 BEGV
= marker_position (oldbegv
);
10033 BEGV_BYTE
= marker_byte_position (oldbegv
);
10042 ZV
= marker_position (oldzv
);
10043 ZV_BYTE
= marker_byte_position (oldzv
);
10047 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10049 /* We can't do Fgoto_char (oldpoint) because it will run some
10051 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10052 marker_byte_position (oldpoint
));
10055 unchain_marker (XMARKER (oldpoint
));
10056 unchain_marker (XMARKER (oldbegv
));
10057 unchain_marker (XMARKER (oldzv
));
10059 /* We called insert_1_both above with its 5th argument (PREPARE)
10060 zero, which prevents insert_1_both from calling
10061 prepare_to_modify_buffer, which in turns prevents us from
10062 incrementing windows_or_buffers_changed even if *Messages* is
10063 shown in some window. So we must manually set
10064 windows_or_buffers_changed here to make up for that. */
10065 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10066 bset_redisplay (current_buffer
);
10068 set_buffer_internal (oldbuf
);
10070 message_log_need_newline
= !nlflag
;
10071 Vdeactivate_mark
= old_deactivate_mark
;
10076 /* We are at the end of the buffer after just having inserted a newline.
10077 (Note: We depend on the fact we won't be crossing the gap.)
10078 Check to see if the most recent message looks a lot like the previous one.
10079 Return 0 if different, 1 if the new one should just replace it, or a
10080 value N > 1 if we should also append " [N times]". */
10083 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10086 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10088 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10089 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10091 for (i
= 0; i
< len
; i
++)
10093 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10095 if (p1
[i
] != p2
[i
])
10101 if (*p1
++ == ' ' && *p1
++ == '[')
10104 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10105 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10112 /* Display an echo area message M with a specified length of NBYTES
10113 bytes. The string may include null characters. If M is not a
10114 string, clear out any existing message, and let the mini-buffer
10117 This function cancels echoing. */
10120 message3 (Lisp_Object m
)
10122 struct gcpro gcpro1
;
10125 clear_message (true, true);
10128 /* First flush out any partial line written with print. */
10129 message_log_maybe_newline ();
10132 ptrdiff_t nbytes
= SBYTES (m
);
10133 bool multibyte
= STRING_MULTIBYTE (m
);
10135 char *buffer
= SAFE_ALLOCA (nbytes
);
10136 memcpy (buffer
, SDATA (m
), nbytes
);
10137 message_dolog (buffer
, nbytes
, 1, multibyte
);
10140 message3_nolog (m
);
10146 /* The non-logging version of message3.
10147 This does not cancel echoing, because it is used for echoing.
10148 Perhaps we need to make a separate function for echoing
10149 and make this cancel echoing. */
10152 message3_nolog (Lisp_Object m
)
10154 struct frame
*sf
= SELECTED_FRAME ();
10156 if (FRAME_INITIAL_P (sf
))
10158 if (noninteractive_need_newline
)
10159 putc ('\n', stderr
);
10160 noninteractive_need_newline
= 0;
10163 Lisp_Object s
= ENCODE_SYSTEM (m
);
10165 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10167 if (cursor_in_echo_area
== 0)
10168 fprintf (stderr
, "\n");
10171 /* Error messages get reported properly by cmd_error, so this must be just an
10172 informative message; if the frame hasn't really been initialized yet, just
10174 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10176 /* Get the frame containing the mini-buffer
10177 that the selected frame is using. */
10178 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10179 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10180 struct frame
*f
= XFRAME (frame
);
10182 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10183 Fmake_frame_visible (frame
);
10185 if (STRINGP (m
) && SCHARS (m
) > 0)
10188 if (minibuffer_auto_raise
)
10189 Fraise_frame (frame
);
10190 /* Assume we are not echoing.
10191 (If we are, echo_now will override this.) */
10192 echo_message_buffer
= Qnil
;
10195 clear_message (true, true);
10197 do_pending_window_change (0);
10198 echo_area_display (1);
10199 do_pending_window_change (0);
10200 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10201 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10206 /* Display a null-terminated echo area message M. If M is 0, clear
10207 out any existing message, and let the mini-buffer text show through.
10209 The buffer M must continue to exist until after the echo area gets
10210 cleared or some other message gets displayed there. Do not pass
10211 text that is stored in a Lisp string. Do not pass text in a buffer
10212 that was alloca'd. */
10215 message1 (const char *m
)
10217 message3 (m
? build_unibyte_string (m
) : Qnil
);
10221 /* The non-logging counterpart of message1. */
10224 message1_nolog (const char *m
)
10226 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10229 /* Display a message M which contains a single %s
10230 which gets replaced with STRING. */
10233 message_with_string (const char *m
, Lisp_Object string
, int log
)
10235 CHECK_STRING (string
);
10237 if (noninteractive
)
10241 /* ENCODE_SYSTEM below can GC and/or relocate the Lisp
10242 String whose data pointer might be passed to us in M. So
10243 we use a local copy. */
10244 char *fmt
= xstrdup (m
);
10246 if (noninteractive_need_newline
)
10247 putc ('\n', stderr
);
10248 noninteractive_need_newline
= 0;
10249 fprintf (stderr
, fmt
, SDATA (ENCODE_SYSTEM (string
)));
10250 if (!cursor_in_echo_area
)
10251 fprintf (stderr
, "\n");
10256 else if (INTERACTIVE
)
10258 /* The frame whose minibuffer we're going to display the message on.
10259 It may be larger than the selected frame, so we need
10260 to use its buffer, not the selected frame's buffer. */
10261 Lisp_Object mini_window
;
10262 struct frame
*f
, *sf
= SELECTED_FRAME ();
10264 /* Get the frame containing the minibuffer
10265 that the selected frame is using. */
10266 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10267 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10269 /* Error messages get reported properly by cmd_error, so this must be
10270 just an informative message; if the frame hasn't really been
10271 initialized yet, just toss it. */
10272 if (f
->glyphs_initialized_p
)
10274 Lisp_Object args
[2], msg
;
10275 struct gcpro gcpro1
, gcpro2
;
10277 args
[0] = build_string (m
);
10278 args
[1] = msg
= string
;
10279 GCPRO2 (args
[0], msg
);
10282 msg
= Fformat (2, args
);
10287 message3_nolog (msg
);
10291 /* Print should start at the beginning of the message
10292 buffer next time. */
10293 message_buf_print
= 0;
10299 /* Dump an informative message to the minibuf. If M is 0, clear out
10300 any existing message, and let the mini-buffer text show through. */
10303 vmessage (const char *m
, va_list ap
)
10305 if (noninteractive
)
10309 if (noninteractive_need_newline
)
10310 putc ('\n', stderr
);
10311 noninteractive_need_newline
= 0;
10312 vfprintf (stderr
, m
, ap
);
10313 if (cursor_in_echo_area
== 0)
10314 fprintf (stderr
, "\n");
10318 else if (INTERACTIVE
)
10320 /* The frame whose mini-buffer we're going to display the message
10321 on. It may be larger than the selected frame, so we need to
10322 use its buffer, not the selected frame's buffer. */
10323 Lisp_Object mini_window
;
10324 struct frame
*f
, *sf
= SELECTED_FRAME ();
10326 /* Get the frame containing the mini-buffer
10327 that the selected frame is using. */
10328 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10329 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10331 /* Error messages get reported properly by cmd_error, so this must be
10332 just an informative message; if the frame hasn't really been
10333 initialized yet, just toss it. */
10334 if (f
->glyphs_initialized_p
)
10339 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10340 char *message_buf
= alloca (maxsize
+ 1);
10342 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10344 message3 (make_string (message_buf
, len
));
10349 /* Print should start at the beginning of the message
10350 buffer next time. */
10351 message_buf_print
= 0;
10357 message (const char *m
, ...)
10367 /* The non-logging version of message. */
10370 message_nolog (const char *m
, ...)
10372 Lisp_Object old_log_max
;
10375 old_log_max
= Vmessage_log_max
;
10376 Vmessage_log_max
= Qnil
;
10378 Vmessage_log_max
= old_log_max
;
10384 /* Display the current message in the current mini-buffer. This is
10385 only called from error handlers in process.c, and is not time
10389 update_echo_area (void)
10391 if (!NILP (echo_area_buffer
[0]))
10393 Lisp_Object string
;
10394 string
= Fcurrent_message ();
10400 /* Make sure echo area buffers in `echo_buffers' are live.
10401 If they aren't, make new ones. */
10404 ensure_echo_area_buffers (void)
10408 for (i
= 0; i
< 2; ++i
)
10409 if (!BUFFERP (echo_buffer
[i
])
10410 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10413 Lisp_Object old_buffer
;
10416 old_buffer
= echo_buffer
[i
];
10417 echo_buffer
[i
] = Fget_buffer_create
10418 (make_formatted_string (name
, " *Echo Area %d*", i
));
10419 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10420 /* to force word wrap in echo area -
10421 it was decided to postpone this*/
10422 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10424 for (j
= 0; j
< 2; ++j
)
10425 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10426 echo_area_buffer
[j
] = echo_buffer
[i
];
10431 /* Call FN with args A1..A2 with either the current or last displayed
10432 echo_area_buffer as current buffer.
10434 WHICH zero means use the current message buffer
10435 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10436 from echo_buffer[] and clear it.
10438 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10439 suitable buffer from echo_buffer[] and clear it.
10441 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10442 that the current message becomes the last displayed one, make
10443 choose a suitable buffer for echo_area_buffer[0], and clear it.
10445 Value is what FN returns. */
10448 with_echo_area_buffer (struct window
*w
, int which
,
10449 int (*fn
) (ptrdiff_t, Lisp_Object
),
10450 ptrdiff_t a1
, Lisp_Object a2
)
10452 Lisp_Object buffer
;
10453 int this_one
, the_other
, clear_buffer_p
, rc
;
10454 ptrdiff_t count
= SPECPDL_INDEX ();
10456 /* If buffers aren't live, make new ones. */
10457 ensure_echo_area_buffers ();
10459 clear_buffer_p
= 0;
10462 this_one
= 0, the_other
= 1;
10463 else if (which
> 0)
10464 this_one
= 1, the_other
= 0;
10467 this_one
= 0, the_other
= 1;
10468 clear_buffer_p
= true;
10470 /* We need a fresh one in case the current echo buffer equals
10471 the one containing the last displayed echo area message. */
10472 if (!NILP (echo_area_buffer
[this_one
])
10473 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10474 echo_area_buffer
[this_one
] = Qnil
;
10477 /* Choose a suitable buffer from echo_buffer[] is we don't
10479 if (NILP (echo_area_buffer
[this_one
]))
10481 echo_area_buffer
[this_one
]
10482 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10483 ? echo_buffer
[the_other
]
10484 : echo_buffer
[this_one
]);
10485 clear_buffer_p
= true;
10488 buffer
= echo_area_buffer
[this_one
];
10490 /* Don't get confused by reusing the buffer used for echoing
10491 for a different purpose. */
10492 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10495 record_unwind_protect (unwind_with_echo_area_buffer
,
10496 with_echo_area_buffer_unwind_data (w
));
10498 /* Make the echo area buffer current. Note that for display
10499 purposes, it is not necessary that the displayed window's buffer
10500 == current_buffer, except for text property lookup. So, let's
10501 only set that buffer temporarily here without doing a full
10502 Fset_window_buffer. We must also change w->pointm, though,
10503 because otherwise an assertions in unshow_buffer fails, and Emacs
10505 set_buffer_internal_1 (XBUFFER (buffer
));
10508 wset_buffer (w
, buffer
);
10509 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10512 bset_undo_list (current_buffer
, Qt
);
10513 bset_read_only (current_buffer
, Qnil
);
10514 specbind (Qinhibit_read_only
, Qt
);
10515 specbind (Qinhibit_modification_hooks
, Qt
);
10517 if (clear_buffer_p
&& Z
> BEG
)
10518 del_range (BEG
, Z
);
10520 eassert (BEGV
>= BEG
);
10521 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10525 eassert (BEGV
>= BEG
);
10526 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10528 unbind_to (count
, Qnil
);
10533 /* Save state that should be preserved around the call to the function
10534 FN called in with_echo_area_buffer. */
10537 with_echo_area_buffer_unwind_data (struct window
*w
)
10540 Lisp_Object vector
, tmp
;
10542 /* Reduce consing by keeping one vector in
10543 Vwith_echo_area_save_vector. */
10544 vector
= Vwith_echo_area_save_vector
;
10545 Vwith_echo_area_save_vector
= Qnil
;
10548 vector
= Fmake_vector (make_number (9), Qnil
);
10550 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10551 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10552 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10556 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10557 ASET (vector
, i
, w
->contents
); ++i
;
10558 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10559 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10560 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10561 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10566 for (; i
< end
; ++i
)
10567 ASET (vector
, i
, Qnil
);
10570 eassert (i
== ASIZE (vector
));
10575 /* Restore global state from VECTOR which was created by
10576 with_echo_area_buffer_unwind_data. */
10579 unwind_with_echo_area_buffer (Lisp_Object vector
)
10581 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10582 Vdeactivate_mark
= AREF (vector
, 1);
10583 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10585 if (WINDOWP (AREF (vector
, 3)))
10588 Lisp_Object buffer
;
10590 w
= XWINDOW (AREF (vector
, 3));
10591 buffer
= AREF (vector
, 4);
10593 wset_buffer (w
, buffer
);
10594 set_marker_both (w
->pointm
, buffer
,
10595 XFASTINT (AREF (vector
, 5)),
10596 XFASTINT (AREF (vector
, 6)));
10597 set_marker_both (w
->start
, buffer
,
10598 XFASTINT (AREF (vector
, 7)),
10599 XFASTINT (AREF (vector
, 8)));
10602 Vwith_echo_area_save_vector
= vector
;
10606 /* Set up the echo area for use by print functions. MULTIBYTE_P
10607 non-zero means we will print multibyte. */
10610 setup_echo_area_for_printing (int multibyte_p
)
10612 /* If we can't find an echo area any more, exit. */
10613 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10614 Fkill_emacs (Qnil
);
10616 ensure_echo_area_buffers ();
10618 if (!message_buf_print
)
10620 /* A message has been output since the last time we printed.
10621 Choose a fresh echo area buffer. */
10622 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10623 echo_area_buffer
[0] = echo_buffer
[1];
10625 echo_area_buffer
[0] = echo_buffer
[0];
10627 /* Switch to that buffer and clear it. */
10628 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10629 bset_truncate_lines (current_buffer
, Qnil
);
10633 ptrdiff_t count
= SPECPDL_INDEX ();
10634 specbind (Qinhibit_read_only
, Qt
);
10635 /* Note that undo recording is always disabled. */
10636 del_range (BEG
, Z
);
10637 unbind_to (count
, Qnil
);
10639 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10641 /* Set up the buffer for the multibyteness we need. */
10643 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10644 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10646 /* Raise the frame containing the echo area. */
10647 if (minibuffer_auto_raise
)
10649 struct frame
*sf
= SELECTED_FRAME ();
10650 Lisp_Object mini_window
;
10651 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10652 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10655 message_log_maybe_newline ();
10656 message_buf_print
= 1;
10660 if (NILP (echo_area_buffer
[0]))
10662 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10663 echo_area_buffer
[0] = echo_buffer
[1];
10665 echo_area_buffer
[0] = echo_buffer
[0];
10668 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10670 /* Someone switched buffers between print requests. */
10671 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10672 bset_truncate_lines (current_buffer
, Qnil
);
10678 /* Display an echo area message in window W. Value is non-zero if W's
10679 height is changed. If display_last_displayed_message_p is
10680 non-zero, display the message that was last displayed, otherwise
10681 display the current message. */
10684 display_echo_area (struct window
*w
)
10686 int i
, no_message_p
, window_height_changed_p
;
10688 /* Temporarily disable garbage collections while displaying the echo
10689 area. This is done because a GC can print a message itself.
10690 That message would modify the echo area buffer's contents while a
10691 redisplay of the buffer is going on, and seriously confuse
10693 ptrdiff_t count
= inhibit_garbage_collection ();
10695 /* If there is no message, we must call display_echo_area_1
10696 nevertheless because it resizes the window. But we will have to
10697 reset the echo_area_buffer in question to nil at the end because
10698 with_echo_area_buffer will sets it to an empty buffer. */
10699 i
= display_last_displayed_message_p
? 1 : 0;
10700 no_message_p
= NILP (echo_area_buffer
[i
]);
10702 window_height_changed_p
10703 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10704 display_echo_area_1
,
10705 (intptr_t) w
, Qnil
);
10708 echo_area_buffer
[i
] = Qnil
;
10710 unbind_to (count
, Qnil
);
10711 return window_height_changed_p
;
10715 /* Helper for display_echo_area. Display the current buffer which
10716 contains the current echo area message in window W, a mini-window,
10717 a pointer to which is passed in A1. A2..A4 are currently not used.
10718 Change the height of W so that all of the message is displayed.
10719 Value is non-zero if height of W was changed. */
10722 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10725 struct window
*w
= (struct window
*) i1
;
10726 Lisp_Object window
;
10727 struct text_pos start
;
10728 int window_height_changed_p
= 0;
10730 /* Do this before displaying, so that we have a large enough glyph
10731 matrix for the display. If we can't get enough space for the
10732 whole text, display the last N lines. That works by setting w->start. */
10733 window_height_changed_p
= resize_mini_window (w
, 0);
10735 /* Use the starting position chosen by resize_mini_window. */
10736 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10739 clear_glyph_matrix (w
->desired_matrix
);
10740 XSETWINDOW (window
, w
);
10741 try_window (window
, start
, 0);
10743 return window_height_changed_p
;
10747 /* Resize the echo area window to exactly the size needed for the
10748 currently displayed message, if there is one. If a mini-buffer
10749 is active, don't shrink it. */
10752 resize_echo_area_exactly (void)
10754 if (BUFFERP (echo_area_buffer
[0])
10755 && WINDOWP (echo_area_window
))
10757 struct window
*w
= XWINDOW (echo_area_window
);
10758 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10759 int resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10760 (intptr_t) w
, resize_exactly
);
10763 windows_or_buffers_changed
= 42;
10764 update_mode_lines
= 30;
10765 redisplay_internal ();
10771 /* Callback function for with_echo_area_buffer, when used from
10772 resize_echo_area_exactly. A1 contains a pointer to the window to
10773 resize, EXACTLY non-nil means resize the mini-window exactly to the
10774 size of the text displayed. A3 and A4 are not used. Value is what
10775 resize_mini_window returns. */
10778 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10781 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10785 /* Resize mini-window W to fit the size of its contents. EXACT_P
10786 means size the window exactly to the size needed. Otherwise, it's
10787 only enlarged until W's buffer is empty.
10789 Set W->start to the right place to begin display. If the whole
10790 contents fit, start at the beginning. Otherwise, start so as
10791 to make the end of the contents appear. This is particularly
10792 important for y-or-n-p, but seems desirable generally.
10794 Value is non-zero if the window height has been changed. */
10797 resize_mini_window (struct window
*w
, int exact_p
)
10799 struct frame
*f
= XFRAME (w
->frame
);
10800 int window_height_changed_p
= 0;
10802 eassert (MINI_WINDOW_P (w
));
10804 /* By default, start display at the beginning. */
10805 set_marker_both (w
->start
, w
->contents
,
10806 BUF_BEGV (XBUFFER (w
->contents
)),
10807 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10809 /* Don't resize windows while redisplaying a window; it would
10810 confuse redisplay functions when the size of the window they are
10811 displaying changes from under them. Such a resizing can happen,
10812 for instance, when which-func prints a long message while
10813 we are running fontification-functions. We're running these
10814 functions with safe_call which binds inhibit-redisplay to t. */
10815 if (!NILP (Vinhibit_redisplay
))
10818 /* Nil means don't try to resize. */
10819 if (NILP (Vresize_mini_windows
)
10820 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10823 if (!FRAME_MINIBUF_ONLY_P (f
))
10826 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10827 + WINDOW_PIXEL_HEIGHT (w
));
10828 int unit
= FRAME_LINE_HEIGHT (f
);
10829 int height
, max_height
;
10830 struct text_pos start
;
10831 struct buffer
*old_current_buffer
= NULL
;
10833 if (current_buffer
!= XBUFFER (w
->contents
))
10835 old_current_buffer
= current_buffer
;
10836 set_buffer_internal (XBUFFER (w
->contents
));
10839 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10841 /* Compute the max. number of lines specified by the user. */
10842 if (FLOATP (Vmax_mini_window_height
))
10843 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10844 else if (INTEGERP (Vmax_mini_window_height
))
10845 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10847 max_height
= total_height
/ 4;
10849 /* Correct that max. height if it's bogus. */
10850 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10852 /* Find out the height of the text in the window. */
10853 if (it
.line_wrap
== TRUNCATE
)
10858 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10859 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10860 height
= it
.current_y
+ last_height
;
10862 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10863 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10866 /* Compute a suitable window start. */
10867 if (height
> max_height
)
10869 height
= (max_height
/ unit
) * unit
;
10870 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10871 move_it_vertically_backward (&it
, height
- unit
);
10872 start
= it
.current
.pos
;
10875 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10876 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10878 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10880 /* Let it grow only, until we display an empty message, in which
10881 case the window shrinks again. */
10882 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10884 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10886 FRAME_WINDOWS_FROZEN (f
) = 1;
10887 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10888 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10890 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10891 && (exact_p
|| BEGV
== ZV
))
10893 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10895 FRAME_WINDOWS_FROZEN (f
) = 0;
10896 shrink_mini_window (w
, 1);
10897 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10902 /* Always resize to exact size needed. */
10903 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10905 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10907 FRAME_WINDOWS_FROZEN (f
) = 1;
10908 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10909 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10911 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10913 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10915 FRAME_WINDOWS_FROZEN (f
) = 0;
10916 shrink_mini_window (w
, 1);
10920 FRAME_WINDOWS_FROZEN (f
) = 1;
10921 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10924 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10928 if (old_current_buffer
)
10929 set_buffer_internal (old_current_buffer
);
10932 return window_height_changed_p
;
10936 /* Value is the current message, a string, or nil if there is no
10937 current message. */
10940 current_message (void)
10944 if (!BUFFERP (echo_area_buffer
[0]))
10948 with_echo_area_buffer (0, 0, current_message_1
,
10949 (intptr_t) &msg
, Qnil
);
10951 echo_area_buffer
[0] = Qnil
;
10959 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
10962 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10965 *msg
= make_buffer_string (BEG
, Z
, 1);
10972 /* Push the current message on Vmessage_stack for later restoration
10973 by restore_message. Value is non-zero if the current message isn't
10974 empty. This is a relatively infrequent operation, so it's not
10975 worth optimizing. */
10978 push_message (void)
10980 Lisp_Object msg
= current_message ();
10981 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10982 return STRINGP (msg
);
10986 /* Restore message display from the top of Vmessage_stack. */
10989 restore_message (void)
10991 eassert (CONSP (Vmessage_stack
));
10992 message3_nolog (XCAR (Vmessage_stack
));
10996 /* Handler for unwind-protect calling pop_message. */
10999 pop_message_unwind (void)
11001 /* Pop the top-most entry off Vmessage_stack. */
11002 eassert (CONSP (Vmessage_stack
));
11003 Vmessage_stack
= XCDR (Vmessage_stack
);
11007 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11008 exits. If the stack is not empty, we have a missing pop_message
11012 check_message_stack (void)
11014 if (!NILP (Vmessage_stack
))
11019 /* Truncate to NCHARS what will be displayed in the echo area the next
11020 time we display it---but don't redisplay it now. */
11023 truncate_echo_area (ptrdiff_t nchars
)
11026 echo_area_buffer
[0] = Qnil
;
11027 else if (!noninteractive
11029 && !NILP (echo_area_buffer
[0]))
11031 struct frame
*sf
= SELECTED_FRAME ();
11032 /* Error messages get reported properly by cmd_error, so this must be
11033 just an informative message; if the frame hasn't really been
11034 initialized yet, just toss it. */
11035 if (sf
->glyphs_initialized_p
)
11036 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11041 /* Helper function for truncate_echo_area. Truncate the current
11042 message to at most NCHARS characters. */
11045 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11047 if (BEG
+ nchars
< Z
)
11048 del_range (BEG
+ nchars
, Z
);
11050 echo_area_buffer
[0] = Qnil
;
11054 /* Set the current message to STRING. */
11057 set_message (Lisp_Object string
)
11059 eassert (STRINGP (string
));
11061 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11063 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11064 message_buf_print
= 0;
11065 help_echo_showing_p
= 0;
11067 if (STRINGP (Vdebug_on_message
)
11068 && STRINGP (string
)
11069 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11070 call_debugger (list2 (Qerror
, string
));
11074 /* Helper function for set_message. First argument is ignored and second
11075 argument has the same meaning as for set_message.
11076 This function is called with the echo area buffer being current. */
11079 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11081 eassert (STRINGP (string
));
11083 /* Change multibyteness of the echo buffer appropriately. */
11084 if (message_enable_multibyte
11085 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11086 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11088 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11089 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11090 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11092 /* Insert new message at BEG. */
11093 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11095 /* This function takes care of single/multibyte conversion.
11096 We just have to ensure that the echo area buffer has the right
11097 setting of enable_multibyte_characters. */
11098 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), 1);
11104 /* Clear messages. CURRENT_P non-zero means clear the current
11105 message. LAST_DISPLAYED_P non-zero means clear the message
11109 clear_message (bool current_p
, bool last_displayed_p
)
11113 echo_area_buffer
[0] = Qnil
;
11114 message_cleared_p
= true;
11117 if (last_displayed_p
)
11118 echo_area_buffer
[1] = Qnil
;
11120 message_buf_print
= 0;
11123 /* Clear garbaged frames.
11125 This function is used where the old redisplay called
11126 redraw_garbaged_frames which in turn called redraw_frame which in
11127 turn called clear_frame. The call to clear_frame was a source of
11128 flickering. I believe a clear_frame is not necessary. It should
11129 suffice in the new redisplay to invalidate all current matrices,
11130 and ensure a complete redisplay of all windows. */
11133 clear_garbaged_frames (void)
11135 if (frame_garbaged
)
11137 Lisp_Object tail
, frame
;
11139 FOR_EACH_FRAME (tail
, frame
)
11141 struct frame
*f
= XFRAME (frame
);
11143 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11148 clear_current_matrices (f
);
11149 fset_redisplay (f
);
11150 f
->garbaged
= false;
11151 f
->resized_p
= false;
11155 frame_garbaged
= false;
11160 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
11161 is non-zero update selected_frame. Value is non-zero if the
11162 mini-windows height has been changed. */
11165 echo_area_display (int update_frame_p
)
11167 Lisp_Object mini_window
;
11170 int window_height_changed_p
= 0;
11171 struct frame
*sf
= SELECTED_FRAME ();
11173 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11174 w
= XWINDOW (mini_window
);
11175 f
= XFRAME (WINDOW_FRAME (w
));
11177 /* Don't display if frame is invisible or not yet initialized. */
11178 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11181 #ifdef HAVE_WINDOW_SYSTEM
11182 /* When Emacs starts, selected_frame may be the initial terminal
11183 frame. If we let this through, a message would be displayed on
11185 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11187 #endif /* HAVE_WINDOW_SYSTEM */
11189 /* Redraw garbaged frames. */
11190 clear_garbaged_frames ();
11192 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11194 echo_area_window
= mini_window
;
11195 window_height_changed_p
= display_echo_area (w
);
11196 w
->must_be_updated_p
= true;
11198 /* Update the display, unless called from redisplay_internal.
11199 Also don't update the screen during redisplay itself. The
11200 update will happen at the end of redisplay, and an update
11201 here could cause confusion. */
11202 if (update_frame_p
&& !redisplaying_p
)
11206 /* If the display update has been interrupted by pending
11207 input, update mode lines in the frame. Due to the
11208 pending input, it might have been that redisplay hasn't
11209 been called, so that mode lines above the echo area are
11210 garbaged. This looks odd, so we prevent it here. */
11211 if (!display_completed
)
11212 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11214 if (window_height_changed_p
11215 /* Don't do this if Emacs is shutting down. Redisplay
11216 needs to run hooks. */
11217 && !NILP (Vrun_hooks
))
11219 /* Must update other windows. Likewise as in other
11220 cases, don't let this update be interrupted by
11222 ptrdiff_t count
= SPECPDL_INDEX ();
11223 specbind (Qredisplay_dont_pause
, Qt
);
11224 windows_or_buffers_changed
= 44;
11225 redisplay_internal ();
11226 unbind_to (count
, Qnil
);
11228 else if (FRAME_WINDOW_P (f
) && n
== 0)
11230 /* Window configuration is the same as before.
11231 Can do with a display update of the echo area,
11232 unless we displayed some mode lines. */
11233 update_single_window (w
, 1);
11237 update_frame (f
, 1, 1);
11239 /* If cursor is in the echo area, make sure that the next
11240 redisplay displays the minibuffer, so that the cursor will
11241 be replaced with what the minibuffer wants. */
11242 if (cursor_in_echo_area
)
11243 wset_redisplay (XWINDOW (mini_window
));
11246 else if (!EQ (mini_window
, selected_window
))
11247 wset_redisplay (XWINDOW (mini_window
));
11249 /* Last displayed message is now the current message. */
11250 echo_area_buffer
[1] = echo_area_buffer
[0];
11251 /* Inform read_char that we're not echoing. */
11252 echo_message_buffer
= Qnil
;
11254 /* Prevent redisplay optimization in redisplay_internal by resetting
11255 this_line_start_pos. This is done because the mini-buffer now
11256 displays the message instead of its buffer text. */
11257 if (EQ (mini_window
, selected_window
))
11258 CHARPOS (this_line_start_pos
) = 0;
11260 return window_height_changed_p
;
11263 /* Nonzero if W's buffer was changed but not saved. */
11266 window_buffer_changed (struct window
*w
)
11268 struct buffer
*b
= XBUFFER (w
->contents
);
11270 eassert (BUFFER_LIVE_P (b
));
11272 return (((BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
));
11275 /* Nonzero if W has %c in its mode line and mode line should be updated. */
11278 mode_line_update_needed (struct window
*w
)
11280 return (w
->column_number_displayed
!= -1
11281 && !(PT
== w
->last_point
&& !window_outdated (w
))
11282 && (w
->column_number_displayed
!= current_column ()));
11285 /* Nonzero if window start of W is frozen and may not be changed during
11289 window_frozen_p (struct window
*w
)
11291 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11293 Lisp_Object window
;
11295 XSETWINDOW (window
, w
);
11296 if (MINI_WINDOW_P (w
))
11298 else if (EQ (window
, selected_window
))
11300 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11301 && EQ (window
, Vminibuf_scroll_window
))
11302 /* This special window can't be frozen too. */
11310 /***********************************************************************
11311 Mode Lines and Frame Titles
11312 ***********************************************************************/
11314 /* A buffer for constructing non-propertized mode-line strings and
11315 frame titles in it; allocated from the heap in init_xdisp and
11316 resized as needed in store_mode_line_noprop_char. */
11318 static char *mode_line_noprop_buf
;
11320 /* The buffer's end, and a current output position in it. */
11322 static char *mode_line_noprop_buf_end
;
11323 static char *mode_line_noprop_ptr
;
11325 #define MODE_LINE_NOPROP_LEN(start) \
11326 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11329 MODE_LINE_DISPLAY
= 0,
11333 } mode_line_target
;
11335 /* Alist that caches the results of :propertize.
11336 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11337 static Lisp_Object mode_line_proptrans_alist
;
11339 /* List of strings making up the mode-line. */
11340 static Lisp_Object mode_line_string_list
;
11342 /* Base face property when building propertized mode line string. */
11343 static Lisp_Object mode_line_string_face
;
11344 static Lisp_Object mode_line_string_face_prop
;
11347 /* Unwind data for mode line strings */
11349 static Lisp_Object Vmode_line_unwind_vector
;
11352 format_mode_line_unwind_data (struct frame
*target_frame
,
11353 struct buffer
*obuf
,
11355 int save_proptrans
)
11357 Lisp_Object vector
, tmp
;
11359 /* Reduce consing by keeping one vector in
11360 Vwith_echo_area_save_vector. */
11361 vector
= Vmode_line_unwind_vector
;
11362 Vmode_line_unwind_vector
= Qnil
;
11365 vector
= Fmake_vector (make_number (10), Qnil
);
11367 ASET (vector
, 0, make_number (mode_line_target
));
11368 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11369 ASET (vector
, 2, mode_line_string_list
);
11370 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11371 ASET (vector
, 4, mode_line_string_face
);
11372 ASET (vector
, 5, mode_line_string_face_prop
);
11375 XSETBUFFER (tmp
, obuf
);
11378 ASET (vector
, 6, tmp
);
11379 ASET (vector
, 7, owin
);
11382 /* Similarly to `with-selected-window', if the operation selects
11383 a window on another frame, we must restore that frame's
11384 selected window, and (for a tty) the top-frame. */
11385 ASET (vector
, 8, target_frame
->selected_window
);
11386 if (FRAME_TERMCAP_P (target_frame
))
11387 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11394 unwind_format_mode_line (Lisp_Object vector
)
11396 Lisp_Object old_window
= AREF (vector
, 7);
11397 Lisp_Object target_frame_window
= AREF (vector
, 8);
11398 Lisp_Object old_top_frame
= AREF (vector
, 9);
11400 mode_line_target
= XINT (AREF (vector
, 0));
11401 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11402 mode_line_string_list
= AREF (vector
, 2);
11403 if (! EQ (AREF (vector
, 3), Qt
))
11404 mode_line_proptrans_alist
= AREF (vector
, 3);
11405 mode_line_string_face
= AREF (vector
, 4);
11406 mode_line_string_face_prop
= AREF (vector
, 5);
11408 /* Select window before buffer, since it may change the buffer. */
11409 if (!NILP (old_window
))
11411 /* If the operation that we are unwinding had selected a window
11412 on a different frame, reset its frame-selected-window. For a
11413 text terminal, reset its top-frame if necessary. */
11414 if (!NILP (target_frame_window
))
11417 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11419 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11420 Fselect_window (target_frame_window
, Qt
);
11422 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11423 Fselect_frame (old_top_frame
, Qt
);
11426 Fselect_window (old_window
, Qt
);
11429 if (!NILP (AREF (vector
, 6)))
11431 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11432 ASET (vector
, 6, Qnil
);
11435 Vmode_line_unwind_vector
= vector
;
11439 /* Store a single character C for the frame title in mode_line_noprop_buf.
11440 Re-allocate mode_line_noprop_buf if necessary. */
11443 store_mode_line_noprop_char (char c
)
11445 /* If output position has reached the end of the allocated buffer,
11446 increase the buffer's size. */
11447 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11449 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11450 ptrdiff_t size
= len
;
11451 mode_line_noprop_buf
=
11452 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11453 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11454 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11457 *mode_line_noprop_ptr
++ = c
;
11461 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11462 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11463 characters that yield more columns than PRECISION; PRECISION <= 0
11464 means copy the whole string. Pad with spaces until FIELD_WIDTH
11465 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11466 pad. Called from display_mode_element when it is used to build a
11470 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11472 const unsigned char *str
= (const unsigned char *) string
;
11474 ptrdiff_t dummy
, nbytes
;
11476 /* Copy at most PRECISION chars from STR. */
11477 nbytes
= strlen (string
);
11478 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11480 store_mode_line_noprop_char (*str
++);
11482 /* Fill up with spaces until FIELD_WIDTH reached. */
11483 while (field_width
> 0
11484 && n
< field_width
)
11486 store_mode_line_noprop_char (' ');
11493 /***********************************************************************
11495 ***********************************************************************/
11497 #ifdef HAVE_WINDOW_SYSTEM
11499 /* Set the title of FRAME, if it has changed. The title format is
11500 Vicon_title_format if FRAME is iconified, otherwise it is
11501 frame_title_format. */
11504 x_consider_frame_title (Lisp_Object frame
)
11506 struct frame
*f
= XFRAME (frame
);
11508 if (FRAME_WINDOW_P (f
)
11509 || FRAME_MINIBUF_ONLY_P (f
)
11510 || f
->explicit_name
)
11512 /* Do we have more than one visible frame on this X display? */
11513 Lisp_Object tail
, other_frame
, fmt
;
11514 ptrdiff_t title_start
;
11518 ptrdiff_t count
= SPECPDL_INDEX ();
11520 FOR_EACH_FRAME (tail
, other_frame
)
11522 struct frame
*tf
= XFRAME (other_frame
);
11525 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11526 && !FRAME_MINIBUF_ONLY_P (tf
)
11527 && !EQ (other_frame
, tip_frame
)
11528 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11532 /* Set global variable indicating that multiple frames exist. */
11533 multiple_frames
= CONSP (tail
);
11535 /* Switch to the buffer of selected window of the frame. Set up
11536 mode_line_target so that display_mode_element will output into
11537 mode_line_noprop_buf; then display the title. */
11538 record_unwind_protect (unwind_format_mode_line
,
11539 format_mode_line_unwind_data
11540 (f
, current_buffer
, selected_window
, 0));
11542 Fselect_window (f
->selected_window
, Qt
);
11543 set_buffer_internal_1
11544 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11545 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11547 mode_line_target
= MODE_LINE_TITLE
;
11548 title_start
= MODE_LINE_NOPROP_LEN (0);
11549 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11550 NULL
, DEFAULT_FACE_ID
);
11551 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11552 len
= MODE_LINE_NOPROP_LEN (title_start
);
11553 title
= mode_line_noprop_buf
+ title_start
;
11554 unbind_to (count
, Qnil
);
11556 /* Set the title only if it's changed. This avoids consing in
11557 the common case where it hasn't. (If it turns out that we've
11558 already wasted too much time by walking through the list with
11559 display_mode_element, then we might need to optimize at a
11560 higher level than this.) */
11561 if (! STRINGP (f
->name
)
11562 || SBYTES (f
->name
) != len
11563 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11564 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11568 #endif /* not HAVE_WINDOW_SYSTEM */
11571 /***********************************************************************
11573 ***********************************************************************/
11575 /* Non-zero if we will not redisplay all visible windows. */
11576 #define REDISPLAY_SOME_P() \
11577 ((windows_or_buffers_changed == 0 \
11578 || windows_or_buffers_changed == REDISPLAY_SOME) \
11579 && (update_mode_lines == 0 \
11580 || update_mode_lines == REDISPLAY_SOME))
11582 /* Prepare for redisplay by updating menu-bar item lists when
11583 appropriate. This can call eval. */
11586 prepare_menu_bars (void)
11588 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11589 bool some_windows
= REDISPLAY_SOME_P ();
11590 struct gcpro gcpro1
, gcpro2
;
11591 Lisp_Object tooltip_frame
;
11593 #ifdef HAVE_WINDOW_SYSTEM
11594 tooltip_frame
= tip_frame
;
11596 tooltip_frame
= Qnil
;
11599 if (FUNCTIONP (Vpre_redisplay_function
))
11601 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11602 if (all_windows
&& some_windows
)
11604 Lisp_Object ws
= window_list ();
11605 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11607 Lisp_Object
this = XCAR (ws
);
11608 struct window
*w
= XWINDOW (this);
11610 || XFRAME (w
->frame
)->redisplay
11611 || XBUFFER (w
->contents
)->text
->redisplay
)
11613 windows
= Fcons (this, windows
);
11617 safe__call1 (true, Vpre_redisplay_function
, windows
);
11620 /* Update all frame titles based on their buffer names, etc. We do
11621 this before the menu bars so that the buffer-menu will show the
11622 up-to-date frame titles. */
11623 #ifdef HAVE_WINDOW_SYSTEM
11626 Lisp_Object tail
, frame
;
11628 FOR_EACH_FRAME (tail
, frame
)
11630 struct frame
*f
= XFRAME (frame
);
11631 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11635 && !XBUFFER (w
->contents
)->text
->redisplay
)
11638 if (!EQ (frame
, tooltip_frame
)
11639 && (FRAME_ICONIFIED_P (f
)
11640 || FRAME_VISIBLE_P (f
) == 1
11641 /* Exclude TTY frames that are obscured because they
11642 are not the top frame on their console. This is
11643 because x_consider_frame_title actually switches
11644 to the frame, which for TTY frames means it is
11645 marked as garbaged, and will be completely
11646 redrawn on the next redisplay cycle. This causes
11647 TTY frames to be completely redrawn, when there
11648 are more than one of them, even though nothing
11649 should be changed on display. */
11650 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11651 x_consider_frame_title (frame
);
11654 #endif /* HAVE_WINDOW_SYSTEM */
11656 /* Update the menu bar item lists, if appropriate. This has to be
11657 done before any actual redisplay or generation of display lines. */
11661 Lisp_Object tail
, frame
;
11662 ptrdiff_t count
= SPECPDL_INDEX ();
11663 /* 1 means that update_menu_bar has run its hooks
11664 so any further calls to update_menu_bar shouldn't do so again. */
11665 int menu_bar_hooks_run
= 0;
11667 record_unwind_save_match_data ();
11669 FOR_EACH_FRAME (tail
, frame
)
11671 struct frame
*f
= XFRAME (frame
);
11672 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11674 /* Ignore tooltip frame. */
11675 if (EQ (frame
, tooltip_frame
))
11681 && !XBUFFER (w
->contents
)->text
->redisplay
)
11684 /* If a window on this frame changed size, report that to
11685 the user and clear the size-change flag. */
11686 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11688 Lisp_Object functions
;
11690 /* Clear flag first in case we get an error below. */
11691 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11692 functions
= Vwindow_size_change_functions
;
11693 GCPRO2 (tail
, functions
);
11695 while (CONSP (functions
))
11697 if (!EQ (XCAR (functions
), Qt
))
11698 call1 (XCAR (functions
), frame
);
11699 functions
= XCDR (functions
);
11705 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11706 #ifdef HAVE_WINDOW_SYSTEM
11707 update_tool_bar (f
, 0);
11710 if (windows_or_buffers_changed
11713 (f
, Fbuffer_modified_p (XWINDOW (f
->selected_window
)->contents
));
11718 unbind_to (count
, Qnil
);
11722 struct frame
*sf
= SELECTED_FRAME ();
11723 update_menu_bar (sf
, 1, 0);
11724 #ifdef HAVE_WINDOW_SYSTEM
11725 update_tool_bar (sf
, 1);
11731 /* Update the menu bar item list for frame F. This has to be done
11732 before we start to fill in any display lines, because it can call
11735 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11737 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11738 already ran the menu bar hooks for this redisplay, so there
11739 is no need to run them again. The return value is the
11740 updated value of this flag, to pass to the next call. */
11743 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11745 Lisp_Object window
;
11746 register struct window
*w
;
11748 /* If called recursively during a menu update, do nothing. This can
11749 happen when, for instance, an activate-menubar-hook causes a
11751 if (inhibit_menubar_update
)
11754 window
= FRAME_SELECTED_WINDOW (f
);
11755 w
= XWINDOW (window
);
11757 if (FRAME_WINDOW_P (f
)
11759 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11760 || defined (HAVE_NS) || defined (USE_GTK)
11761 FRAME_EXTERNAL_MENU_BAR (f
)
11763 FRAME_MENU_BAR_LINES (f
) > 0
11765 : FRAME_MENU_BAR_LINES (f
) > 0)
11767 /* If the user has switched buffers or windows, we need to
11768 recompute to reflect the new bindings. But we'll
11769 recompute when update_mode_lines is set too; that means
11770 that people can use force-mode-line-update to request
11771 that the menu bar be recomputed. The adverse effect on
11772 the rest of the redisplay algorithm is about the same as
11773 windows_or_buffers_changed anyway. */
11774 if (windows_or_buffers_changed
11775 /* This used to test w->update_mode_line, but we believe
11776 there is no need to recompute the menu in that case. */
11777 || update_mode_lines
11778 || window_buffer_changed (w
))
11780 struct buffer
*prev
= current_buffer
;
11781 ptrdiff_t count
= SPECPDL_INDEX ();
11783 specbind (Qinhibit_menubar_update
, Qt
);
11785 set_buffer_internal_1 (XBUFFER (w
->contents
));
11786 if (save_match_data
)
11787 record_unwind_save_match_data ();
11788 if (NILP (Voverriding_local_map_menu_flag
))
11790 specbind (Qoverriding_terminal_local_map
, Qnil
);
11791 specbind (Qoverriding_local_map
, Qnil
);
11796 /* Run the Lucid hook. */
11797 safe_run_hooks (Qactivate_menubar_hook
);
11799 /* If it has changed current-menubar from previous value,
11800 really recompute the menu-bar from the value. */
11801 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11802 call0 (Qrecompute_lucid_menubar
);
11804 safe_run_hooks (Qmenu_bar_update_hook
);
11809 XSETFRAME (Vmenu_updating_frame
, f
);
11810 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11812 /* Redisplay the menu bar in case we changed it. */
11813 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11814 || defined (HAVE_NS) || defined (USE_GTK)
11815 if (FRAME_WINDOW_P (f
))
11817 #if defined (HAVE_NS)
11818 /* All frames on Mac OS share the same menubar. So only
11819 the selected frame should be allowed to set it. */
11820 if (f
== SELECTED_FRAME ())
11822 set_frame_menubar (f
, 0, 0);
11825 /* On a terminal screen, the menu bar is an ordinary screen
11826 line, and this makes it get updated. */
11827 w
->update_mode_line
= 1;
11828 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11829 /* In the non-toolkit version, the menu bar is an ordinary screen
11830 line, and this makes it get updated. */
11831 w
->update_mode_line
= 1;
11832 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11834 unbind_to (count
, Qnil
);
11835 set_buffer_internal_1 (prev
);
11842 /***********************************************************************
11844 ***********************************************************************/
11846 #ifdef HAVE_WINDOW_SYSTEM
11848 /* Tool-bar item index of the item on which a mouse button was pressed
11851 int last_tool_bar_item
;
11853 /* Select `frame' temporarily without running all the code in
11855 FIXME: Maybe do_switch_frame should be trimmed down similarly
11856 when `norecord' is set. */
11858 fast_set_selected_frame (Lisp_Object frame
)
11860 if (!EQ (selected_frame
, frame
))
11862 selected_frame
= frame
;
11863 selected_window
= XFRAME (frame
)->selected_window
;
11867 /* Update the tool-bar item list for frame F. This has to be done
11868 before we start to fill in any display lines. Called from
11869 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11870 and restore it here. */
11873 update_tool_bar (struct frame
*f
, int save_match_data
)
11875 #if defined (USE_GTK) || defined (HAVE_NS)
11876 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11878 int do_update
= (WINDOWP (f
->tool_bar_window
)
11879 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0);
11884 Lisp_Object window
;
11887 window
= FRAME_SELECTED_WINDOW (f
);
11888 w
= XWINDOW (window
);
11890 /* If the user has switched buffers or windows, we need to
11891 recompute to reflect the new bindings. But we'll
11892 recompute when update_mode_lines is set too; that means
11893 that people can use force-mode-line-update to request
11894 that the menu bar be recomputed. The adverse effect on
11895 the rest of the redisplay algorithm is about the same as
11896 windows_or_buffers_changed anyway. */
11897 if (windows_or_buffers_changed
11898 || w
->update_mode_line
11899 || update_mode_lines
11900 || window_buffer_changed (w
))
11902 struct buffer
*prev
= current_buffer
;
11903 ptrdiff_t count
= SPECPDL_INDEX ();
11904 Lisp_Object frame
, new_tool_bar
;
11905 int new_n_tool_bar
;
11906 struct gcpro gcpro1
;
11908 /* Set current_buffer to the buffer of the selected
11909 window of the frame, so that we get the right local
11911 set_buffer_internal_1 (XBUFFER (w
->contents
));
11913 /* Save match data, if we must. */
11914 if (save_match_data
)
11915 record_unwind_save_match_data ();
11917 /* Make sure that we don't accidentally use bogus keymaps. */
11918 if (NILP (Voverriding_local_map_menu_flag
))
11920 specbind (Qoverriding_terminal_local_map
, Qnil
);
11921 specbind (Qoverriding_local_map
, Qnil
);
11924 GCPRO1 (new_tool_bar
);
11926 /* We must temporarily set the selected frame to this frame
11927 before calling tool_bar_items, because the calculation of
11928 the tool-bar keymap uses the selected frame (see
11929 `tool-bar-make-keymap' in tool-bar.el). */
11930 eassert (EQ (selected_window
,
11931 /* Since we only explicitly preserve selected_frame,
11932 check that selected_window would be redundant. */
11933 XFRAME (selected_frame
)->selected_window
));
11934 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11935 XSETFRAME (frame
, f
);
11936 fast_set_selected_frame (frame
);
11938 /* Build desired tool-bar items from keymaps. */
11940 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11943 /* Redisplay the tool-bar if we changed it. */
11944 if (new_n_tool_bar
!= f
->n_tool_bar_items
11945 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11947 /* Redisplay that happens asynchronously due to an expose event
11948 may access f->tool_bar_items. Make sure we update both
11949 variables within BLOCK_INPUT so no such event interrupts. */
11951 fset_tool_bar_items (f
, new_tool_bar
);
11952 f
->n_tool_bar_items
= new_n_tool_bar
;
11953 w
->update_mode_line
= 1;
11959 unbind_to (count
, Qnil
);
11960 set_buffer_internal_1 (prev
);
11965 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
11967 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11968 F's desired tool-bar contents. F->tool_bar_items must have
11969 been set up previously by calling prepare_menu_bars. */
11972 build_desired_tool_bar_string (struct frame
*f
)
11974 int i
, size
, size_needed
;
11975 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11976 Lisp_Object image
, plist
, props
;
11978 image
= plist
= props
= Qnil
;
11979 GCPRO3 (image
, plist
, props
);
11981 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11982 Otherwise, make a new string. */
11984 /* The size of the string we might be able to reuse. */
11985 size
= (STRINGP (f
->desired_tool_bar_string
)
11986 ? SCHARS (f
->desired_tool_bar_string
)
11989 /* We need one space in the string for each image. */
11990 size_needed
= f
->n_tool_bar_items
;
11992 /* Reuse f->desired_tool_bar_string, if possible. */
11993 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11994 fset_desired_tool_bar_string
11995 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11998 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11999 Fremove_text_properties (make_number (0), make_number (size
),
12000 props
, f
->desired_tool_bar_string
);
12003 /* Put a `display' property on the string for the images to display,
12004 put a `menu_item' property on tool-bar items with a value that
12005 is the index of the item in F's tool-bar item vector. */
12006 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
12008 #define PROP(IDX) \
12009 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12011 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
12012 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
12013 int hmargin
, vmargin
, relief
, idx
, end
;
12015 /* If image is a vector, choose the image according to the
12017 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
12018 if (VECTORP (image
))
12022 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12023 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12026 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12027 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12029 eassert (ASIZE (image
) >= idx
);
12030 image
= AREF (image
, idx
);
12035 /* Ignore invalid image specifications. */
12036 if (!valid_image_p (image
))
12039 /* Display the tool-bar button pressed, or depressed. */
12040 plist
= Fcopy_sequence (XCDR (image
));
12042 /* Compute margin and relief to draw. */
12043 relief
= (tool_bar_button_relief
>= 0
12044 ? tool_bar_button_relief
12045 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12046 hmargin
= vmargin
= relief
;
12048 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12049 INT_MAX
- max (hmargin
, vmargin
)))
12051 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12052 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12054 else if (CONSP (Vtool_bar_button_margin
))
12056 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12057 INT_MAX
- hmargin
))
12058 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12060 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12061 INT_MAX
- vmargin
))
12062 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12065 if (auto_raise_tool_bar_buttons_p
)
12067 /* Add a `:relief' property to the image spec if the item is
12071 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12078 /* If image is selected, display it pressed, i.e. with a
12079 negative relief. If it's not selected, display it with a
12081 plist
= Fplist_put (plist
, QCrelief
,
12083 ? make_number (-relief
)
12084 : make_number (relief
)));
12089 /* Put a margin around the image. */
12090 if (hmargin
|| vmargin
)
12092 if (hmargin
== vmargin
)
12093 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12095 plist
= Fplist_put (plist
, QCmargin
,
12096 Fcons (make_number (hmargin
),
12097 make_number (vmargin
)));
12100 /* If button is not enabled, and we don't have special images
12101 for the disabled state, make the image appear disabled by
12102 applying an appropriate algorithm to it. */
12103 if (!enabled_p
&& idx
< 0)
12104 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12106 /* Put a `display' text property on the string for the image to
12107 display. Put a `menu-item' property on the string that gives
12108 the start of this item's properties in the tool-bar items
12110 image
= Fcons (Qimage
, plist
);
12111 props
= list4 (Qdisplay
, image
,
12112 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12114 /* Let the last image hide all remaining spaces in the tool bar
12115 string. The string can be longer than needed when we reuse a
12116 previous string. */
12117 if (i
+ 1 == f
->n_tool_bar_items
)
12118 end
= SCHARS (f
->desired_tool_bar_string
);
12121 Fadd_text_properties (make_number (i
), make_number (end
),
12122 props
, f
->desired_tool_bar_string
);
12130 /* Display one line of the tool-bar of frame IT->f.
12132 HEIGHT specifies the desired height of the tool-bar line.
12133 If the actual height of the glyph row is less than HEIGHT, the
12134 row's height is increased to HEIGHT, and the icons are centered
12135 vertically in the new height.
12137 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12138 count a final empty row in case the tool-bar width exactly matches
12143 display_tool_bar_line (struct it
*it
, int height
)
12145 struct glyph_row
*row
= it
->glyph_row
;
12146 int max_x
= it
->last_visible_x
;
12147 struct glyph
*last
;
12149 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12150 clear_glyph_row (row
);
12151 row
->enabled_p
= true;
12152 row
->y
= it
->current_y
;
12154 /* Note that this isn't made use of if the face hasn't a box,
12155 so there's no need to check the face here. */
12156 it
->start_of_box_run_p
= 1;
12158 while (it
->current_x
< max_x
)
12160 int x
, n_glyphs_before
, i
, nglyphs
;
12161 struct it it_before
;
12163 /* Get the next display element. */
12164 if (!get_next_display_element (it
))
12166 /* Don't count empty row if we are counting needed tool-bar lines. */
12167 if (height
< 0 && !it
->hpos
)
12172 /* Produce glyphs. */
12173 n_glyphs_before
= row
->used
[TEXT_AREA
];
12176 PRODUCE_GLYPHS (it
);
12178 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12180 x
= it_before
.current_x
;
12181 while (i
< nglyphs
)
12183 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12185 if (x
+ glyph
->pixel_width
> max_x
)
12187 /* Glyph doesn't fit on line. Backtrack. */
12188 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12190 /* If this is the only glyph on this line, it will never fit on the
12191 tool-bar, so skip it. But ensure there is at least one glyph,
12192 so we don't accidentally disable the tool-bar. */
12193 if (n_glyphs_before
== 0
12194 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12200 x
+= glyph
->pixel_width
;
12204 /* Stop at line end. */
12205 if (ITERATOR_AT_END_OF_LINE_P (it
))
12208 set_iterator_to_next (it
, 1);
12213 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12215 /* Use default face for the border below the tool bar.
12217 FIXME: When auto-resize-tool-bars is grow-only, there is
12218 no additional border below the possibly empty tool-bar lines.
12219 So to make the extra empty lines look "normal", we have to
12220 use the tool-bar face for the border too. */
12221 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12222 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12223 it
->face_id
= DEFAULT_FACE_ID
;
12225 extend_face_to_end_of_line (it
);
12226 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12227 last
->right_box_line_p
= 1;
12228 if (last
== row
->glyphs
[TEXT_AREA
])
12229 last
->left_box_line_p
= 1;
12231 /* Make line the desired height and center it vertically. */
12232 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12234 /* Don't add more than one line height. */
12235 height
%= FRAME_LINE_HEIGHT (it
->f
);
12236 it
->max_ascent
+= height
/ 2;
12237 it
->max_descent
+= (height
+ 1) / 2;
12240 compute_line_metrics (it
);
12242 /* If line is empty, make it occupy the rest of the tool-bar. */
12243 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12245 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12246 row
->visible_height
= row
->height
;
12247 row
->ascent
= row
->phys_ascent
= 0;
12248 row
->extra_line_spacing
= 0;
12251 row
->full_width_p
= 1;
12252 row
->continued_p
= 0;
12253 row
->truncated_on_left_p
= 0;
12254 row
->truncated_on_right_p
= 0;
12256 it
->current_x
= it
->hpos
= 0;
12257 it
->current_y
+= row
->height
;
12263 /* Max tool-bar height. Basically, this is what makes all other windows
12264 disappear when the frame gets too small. Rethink this! */
12266 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
12267 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
12269 /* Value is the number of pixels needed to make all tool-bar items of
12270 frame F visible. The actual number of glyph rows needed is
12271 returned in *N_ROWS if non-NULL. */
12274 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12276 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12278 /* tool_bar_height is called from redisplay_tool_bar after building
12279 the desired matrix, so use (unused) mode-line row as temporary row to
12280 avoid destroying the first tool-bar row. */
12281 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12283 /* Initialize an iterator for iteration over
12284 F->desired_tool_bar_string in the tool-bar window of frame F. */
12285 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12286 it
.first_visible_x
= 0;
12287 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12288 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12289 it
.paragraph_embedding
= L2R
;
12291 while (!ITERATOR_AT_END_P (&it
))
12293 clear_glyph_row (temp_row
);
12294 it
.glyph_row
= temp_row
;
12295 display_tool_bar_line (&it
, -1);
12297 clear_glyph_row (temp_row
);
12299 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12301 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12304 return it
.current_y
;
12306 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12309 #endif /* !USE_GTK && !HAVE_NS */
12311 #if defined USE_GTK || defined HAVE_NS
12312 EXFUN (Ftool_bar_height
, 2) ATTRIBUTE_CONST
;
12313 EXFUN (Ftool_bar_lines_needed
, 1) ATTRIBUTE_CONST
;
12316 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12318 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12319 If FRAME is nil or omitted, use the selected frame. Optional argument
12320 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12321 (Lisp_Object frame
, Lisp_Object pixelwise
)
12325 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12326 struct frame
*f
= decode_any_frame (frame
);
12328 if (WINDOWP (f
->tool_bar_window
)
12329 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12331 update_tool_bar (f
, 1);
12332 if (f
->n_tool_bar_items
)
12334 build_desired_tool_bar_string (f
);
12335 height
= tool_bar_height (f
, NULL
, NILP (pixelwise
) ? 0 : 1);
12340 return make_number (height
);
12344 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
12345 height should be changed. */
12348 redisplay_tool_bar (struct frame
*f
)
12350 #if defined (USE_GTK) || defined (HAVE_NS)
12352 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12353 update_frame_tool_bar (f
);
12356 #else /* !USE_GTK && !HAVE_NS */
12360 struct glyph_row
*row
;
12362 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12363 do anything. This means you must start with tool-bar-lines
12364 non-zero to get the auto-sizing effect. Or in other words, you
12365 can turn off tool-bars by specifying tool-bar-lines zero. */
12366 if (!WINDOWP (f
->tool_bar_window
)
12367 || (w
= XWINDOW (f
->tool_bar_window
),
12368 WINDOW_PIXEL_HEIGHT (w
) == 0))
12371 /* Set up an iterator for the tool-bar window. */
12372 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12373 it
.first_visible_x
= 0;
12374 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12375 row
= it
.glyph_row
;
12377 /* Build a string that represents the contents of the tool-bar. */
12378 build_desired_tool_bar_string (f
);
12379 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12380 /* FIXME: This should be controlled by a user option. But it
12381 doesn't make sense to have an R2L tool bar if the menu bar cannot
12382 be drawn also R2L, and making the menu bar R2L is tricky due
12383 toolkit-specific code that implements it. If an R2L tool bar is
12384 ever supported, display_tool_bar_line should also be augmented to
12385 call unproduce_glyphs like display_line and display_string
12387 it
.paragraph_embedding
= L2R
;
12389 if (f
->n_tool_bar_rows
== 0)
12391 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, 1);
12393 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12396 int new_lines
= ((new_height
+ FRAME_LINE_HEIGHT (f
) - 1)
12397 / FRAME_LINE_HEIGHT (f
));
12399 XSETFRAME (frame
, f
);
12400 Fmodify_frame_parameters (frame
,
12401 list1 (Fcons (Qtool_bar_lines
,
12402 make_number (new_lines
))));
12403 /* Always do that now. */
12404 clear_glyph_matrix (w
->desired_matrix
);
12405 f
->fonts_changed
= 1;
12410 /* Display as many lines as needed to display all tool-bar items. */
12412 if (f
->n_tool_bar_rows
> 0)
12414 int border
, rows
, height
, extra
;
12416 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12417 border
= XINT (Vtool_bar_border
);
12418 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12419 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12420 else if (EQ (Vtool_bar_border
, Qborder_width
))
12421 border
= f
->border_width
;
12427 rows
= f
->n_tool_bar_rows
;
12428 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12429 extra
= it
.last_visible_y
- border
- height
* rows
;
12431 while (it
.current_y
< it
.last_visible_y
)
12434 if (extra
> 0 && rows
-- > 0)
12436 h
= (extra
+ rows
- 1) / rows
;
12439 display_tool_bar_line (&it
, height
+ h
);
12444 while (it
.current_y
< it
.last_visible_y
)
12445 display_tool_bar_line (&it
, 0);
12448 /* It doesn't make much sense to try scrolling in the tool-bar
12449 window, so don't do it. */
12450 w
->desired_matrix
->no_scrolling_p
= 1;
12451 w
->must_be_updated_p
= 1;
12453 if (!NILP (Vauto_resize_tool_bars
))
12455 /* Do we really allow the toolbar to occupy the whole frame? */
12456 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
12457 int change_height_p
= 0;
12459 /* If we couldn't display everything, change the tool-bar's
12460 height if there is room for more. */
12461 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
12462 && it
.current_y
< max_tool_bar_height
)
12463 change_height_p
= 1;
12465 /* We subtract 1 because display_tool_bar_line advances the
12466 glyph_row pointer before returning to its caller. We want to
12467 examine the last glyph row produced by
12468 display_tool_bar_line. */
12469 row
= it
.glyph_row
- 1;
12471 /* If there are blank lines at the end, except for a partially
12472 visible blank line at the end that is smaller than
12473 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12474 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12475 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12476 change_height_p
= 1;
12478 /* If row displays tool-bar items, but is partially visible,
12479 change the tool-bar's height. */
12480 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12481 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
12482 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
12483 change_height_p
= 1;
12485 /* Resize windows as needed by changing the `tool-bar-lines'
12486 frame parameter. */
12487 if (change_height_p
)
12491 int new_height
= tool_bar_height (f
, &nrows
, 1);
12493 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12494 && !f
->minimize_tool_bar_window_p
)
12495 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12496 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12497 f
->minimize_tool_bar_window_p
= 0;
12499 if (change_height_p
)
12501 /* Current size of the tool-bar window in canonical line
12503 int old_lines
= WINDOW_TOTAL_LINES (w
);
12504 /* Required size of the tool-bar window in canonical
12506 int new_lines
= ((new_height
+ FRAME_LINE_HEIGHT (f
) - 1)
12507 / FRAME_LINE_HEIGHT (f
));
12508 /* Maximum size of the tool-bar window in canonical line
12509 units that this frame can allow. */
12511 WINDOW_TOTAL_LINES (XWINDOW (FRAME_ROOT_WINDOW (f
))) - 1;
12513 /* Don't try to change the tool-bar window size and set
12514 the fonts_changed flag unless really necessary. That
12515 flag causes redisplay to give up and retry
12516 redisplaying the frame from scratch, so setting it
12517 unnecessarily can lead to nasty redisplay loops. */
12518 if (new_lines
<= max_lines
12519 && eabs (new_lines
- old_lines
) >= 1)
12521 XSETFRAME (frame
, f
);
12522 Fmodify_frame_parameters (frame
,
12523 list1 (Fcons (Qtool_bar_lines
,
12524 make_number (new_lines
))));
12525 clear_glyph_matrix (w
->desired_matrix
);
12526 f
->n_tool_bar_rows
= nrows
;
12527 f
->fonts_changed
= 1;
12534 f
->minimize_tool_bar_window_p
= 0;
12537 #endif /* USE_GTK || HAVE_NS */
12540 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12542 /* Get information about the tool-bar item which is displayed in GLYPH
12543 on frame F. Return in *PROP_IDX the index where tool-bar item
12544 properties start in F->tool_bar_items. Value is zero if
12545 GLYPH doesn't display a tool-bar item. */
12548 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12554 /* This function can be called asynchronously, which means we must
12555 exclude any possibility that Fget_text_property signals an
12557 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12558 charpos
= max (0, charpos
);
12560 /* Get the text property `menu-item' at pos. The value of that
12561 property is the start index of this item's properties in
12562 F->tool_bar_items. */
12563 prop
= Fget_text_property (make_number (charpos
),
12564 Qmenu_item
, f
->current_tool_bar_string
);
12565 if (INTEGERP (prop
))
12567 *prop_idx
= XINT (prop
);
12577 /* Get information about the tool-bar item at position X/Y on frame F.
12578 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12579 the current matrix of the tool-bar window of F, or NULL if not
12580 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12581 item in F->tool_bar_items. Value is
12583 -1 if X/Y is not on a tool-bar item
12584 0 if X/Y is on the same item that was highlighted before.
12588 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12589 int *hpos
, int *vpos
, int *prop_idx
)
12591 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12592 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12595 /* Find the glyph under X/Y. */
12596 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12597 if (*glyph
== NULL
)
12600 /* Get the start of this tool-bar item's properties in
12601 f->tool_bar_items. */
12602 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12605 /* Is mouse on the highlighted item? */
12606 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12607 && *vpos
>= hlinfo
->mouse_face_beg_row
12608 && *vpos
<= hlinfo
->mouse_face_end_row
12609 && (*vpos
> hlinfo
->mouse_face_beg_row
12610 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12611 && (*vpos
< hlinfo
->mouse_face_end_row
12612 || *hpos
< hlinfo
->mouse_face_end_col
12613 || hlinfo
->mouse_face_past_end
))
12621 Handle mouse button event on the tool-bar of frame F, at
12622 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12623 0 for button release. MODIFIERS is event modifiers for button
12627 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12630 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12631 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12632 int hpos
, vpos
, prop_idx
;
12633 struct glyph
*glyph
;
12634 Lisp_Object enabled_p
;
12637 /* If not on the highlighted tool-bar item, and mouse-highlight is
12638 non-nil, return. This is so we generate the tool-bar button
12639 click only when the mouse button is released on the same item as
12640 where it was pressed. However, when mouse-highlight is disabled,
12641 generate the click when the button is released regardless of the
12642 highlight, since tool-bar items are not highlighted in that
12644 frame_to_window_pixel_xy (w
, &x
, &y
);
12645 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12647 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12650 /* When mouse-highlight is off, generate the click for the item
12651 where the button was pressed, disregarding where it was
12653 if (NILP (Vmouse_highlight
) && !down_p
)
12654 prop_idx
= last_tool_bar_item
;
12656 /* If item is disabled, do nothing. */
12657 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12658 if (NILP (enabled_p
))
12663 /* Show item in pressed state. */
12664 if (!NILP (Vmouse_highlight
))
12665 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12666 last_tool_bar_item
= prop_idx
;
12670 Lisp_Object key
, frame
;
12671 struct input_event event
;
12672 EVENT_INIT (event
);
12674 /* Show item in released state. */
12675 if (!NILP (Vmouse_highlight
))
12676 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12678 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12680 XSETFRAME (frame
, f
);
12681 event
.kind
= TOOL_BAR_EVENT
;
12682 event
.frame_or_window
= frame
;
12684 kbd_buffer_store_event (&event
);
12686 event
.kind
= TOOL_BAR_EVENT
;
12687 event
.frame_or_window
= frame
;
12689 event
.modifiers
= modifiers
;
12690 kbd_buffer_store_event (&event
);
12691 last_tool_bar_item
= -1;
12696 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12697 tool-bar window-relative coordinates X/Y. Called from
12698 note_mouse_highlight. */
12701 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12703 Lisp_Object window
= f
->tool_bar_window
;
12704 struct window
*w
= XWINDOW (window
);
12705 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12706 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12708 struct glyph
*glyph
;
12709 struct glyph_row
*row
;
12711 Lisp_Object enabled_p
;
12713 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12714 int mouse_down_p
, rc
;
12716 /* Function note_mouse_highlight is called with negative X/Y
12717 values when mouse moves outside of the frame. */
12718 if (x
<= 0 || y
<= 0)
12720 clear_mouse_face (hlinfo
);
12724 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12727 /* Not on tool-bar item. */
12728 clear_mouse_face (hlinfo
);
12732 /* On same tool-bar item as before. */
12733 goto set_help_echo
;
12735 clear_mouse_face (hlinfo
);
12737 /* Mouse is down, but on different tool-bar item? */
12738 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12739 && f
== dpyinfo
->last_mouse_frame
);
12742 && last_tool_bar_item
!= prop_idx
)
12745 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12747 /* If tool-bar item is not enabled, don't highlight it. */
12748 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12749 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12751 /* Compute the x-position of the glyph. In front and past the
12752 image is a space. We include this in the highlighted area. */
12753 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12754 for (i
= x
= 0; i
< hpos
; ++i
)
12755 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12757 /* Record this as the current active region. */
12758 hlinfo
->mouse_face_beg_col
= hpos
;
12759 hlinfo
->mouse_face_beg_row
= vpos
;
12760 hlinfo
->mouse_face_beg_x
= x
;
12761 hlinfo
->mouse_face_past_end
= 0;
12763 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12764 hlinfo
->mouse_face_end_row
= vpos
;
12765 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12766 hlinfo
->mouse_face_window
= window
;
12767 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12769 /* Display it as active. */
12770 show_mouse_face (hlinfo
, draw
);
12775 /* Set help_echo_string to a help string to display for this tool-bar item.
12776 XTread_socket does the rest. */
12777 help_echo_object
= help_echo_window
= Qnil
;
12778 help_echo_pos
= -1;
12779 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12780 if (NILP (help_echo_string
))
12781 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12784 #endif /* !USE_GTK && !HAVE_NS */
12786 #endif /* HAVE_WINDOW_SYSTEM */
12790 /************************************************************************
12791 Horizontal scrolling
12792 ************************************************************************/
12794 static int hscroll_window_tree (Lisp_Object
);
12795 static int hscroll_windows (Lisp_Object
);
12797 /* For all leaf windows in the window tree rooted at WINDOW, set their
12798 hscroll value so that PT is (i) visible in the window, and (ii) so
12799 that it is not within a certain margin at the window's left and
12800 right border. Value is non-zero if any window's hscroll has been
12804 hscroll_window_tree (Lisp_Object window
)
12806 int hscrolled_p
= 0;
12807 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12808 int hscroll_step_abs
= 0;
12809 double hscroll_step_rel
= 0;
12811 if (hscroll_relative_p
)
12813 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12814 if (hscroll_step_rel
< 0)
12816 hscroll_relative_p
= 0;
12817 hscroll_step_abs
= 0;
12820 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12822 hscroll_step_abs
= XINT (Vhscroll_step
);
12823 if (hscroll_step_abs
< 0)
12824 hscroll_step_abs
= 0;
12827 hscroll_step_abs
= 0;
12829 while (WINDOWP (window
))
12831 struct window
*w
= XWINDOW (window
);
12833 if (WINDOWP (w
->contents
))
12834 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12835 else if (w
->cursor
.vpos
>= 0)
12838 int text_area_width
;
12839 struct glyph_row
*cursor_row
;
12840 struct glyph_row
*bottom_row
;
12843 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12844 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12845 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12847 cursor_row
= bottom_row
- 1;
12849 if (!cursor_row
->enabled_p
)
12851 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12852 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12853 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12855 cursor_row
= bottom_row
- 1;
12857 row_r2l_p
= cursor_row
->reversed_p
;
12859 text_area_width
= window_box_width (w
, TEXT_AREA
);
12861 /* Scroll when cursor is inside this scroll margin. */
12862 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12864 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12865 /* For left-to-right rows, hscroll when cursor is either
12866 (i) inside the right hscroll margin, or (ii) if it is
12867 inside the left margin and the window is already
12871 && w
->cursor
.x
<= h_margin
)
12872 || (cursor_row
->enabled_p
12873 && cursor_row
->truncated_on_right_p
12874 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12875 /* For right-to-left rows, the logic is similar,
12876 except that rules for scrolling to left and right
12877 are reversed. E.g., if cursor.x <= h_margin, we
12878 need to hscroll "to the right" unconditionally,
12879 and that will scroll the screen to the left so as
12880 to reveal the next portion of the row. */
12882 && ((cursor_row
->enabled_p
12883 /* FIXME: It is confusing to set the
12884 truncated_on_right_p flag when R2L rows
12885 are actually truncated on the left. */
12886 && cursor_row
->truncated_on_right_p
12887 && w
->cursor
.x
<= h_margin
)
12889 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12893 struct buffer
*saved_current_buffer
;
12897 /* Find point in a display of infinite width. */
12898 saved_current_buffer
= current_buffer
;
12899 current_buffer
= XBUFFER (w
->contents
);
12901 if (w
== XWINDOW (selected_window
))
12904 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12906 /* Move iterator to pt starting at cursor_row->start in
12907 a line with infinite width. */
12908 init_to_row_start (&it
, w
, cursor_row
);
12909 it
.last_visible_x
= INFINITY
;
12910 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12911 current_buffer
= saved_current_buffer
;
12913 /* Position cursor in window. */
12914 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12915 hscroll
= max (0, (it
.current_x
12916 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12917 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12918 : (text_area_width
/ 2))))
12919 / FRAME_COLUMN_WIDTH (it
.f
);
12920 else if ((!row_r2l_p
12921 && w
->cursor
.x
>= text_area_width
- h_margin
)
12922 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12924 if (hscroll_relative_p
)
12925 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12928 wanted_x
= text_area_width
12929 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12932 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12936 if (hscroll_relative_p
)
12937 wanted_x
= text_area_width
* hscroll_step_rel
12940 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12943 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12945 hscroll
= max (hscroll
, w
->min_hscroll
);
12947 /* Don't prevent redisplay optimizations if hscroll
12948 hasn't changed, as it will unnecessarily slow down
12950 if (w
->hscroll
!= hscroll
)
12952 XBUFFER (w
->contents
)->prevent_redisplay_optimizations_p
= 1;
12953 w
->hscroll
= hscroll
;
12962 /* Value is non-zero if hscroll of any leaf window has been changed. */
12963 return hscrolled_p
;
12967 /* Set hscroll so that cursor is visible and not inside horizontal
12968 scroll margins for all windows in the tree rooted at WINDOW. See
12969 also hscroll_window_tree above. Value is non-zero if any window's
12970 hscroll has been changed. If it has, desired matrices on the frame
12971 of WINDOW are cleared. */
12974 hscroll_windows (Lisp_Object window
)
12976 int hscrolled_p
= hscroll_window_tree (window
);
12978 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12979 return hscrolled_p
;
12984 /************************************************************************
12986 ************************************************************************/
12988 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12989 to a non-zero value. This is sometimes handy to have in a debugger
12994 /* First and last unchanged row for try_window_id. */
12996 static int debug_first_unchanged_at_end_vpos
;
12997 static int debug_last_unchanged_at_beg_vpos
;
12999 /* Delta vpos and y. */
13001 static int debug_dvpos
, debug_dy
;
13003 /* Delta in characters and bytes for try_window_id. */
13005 static ptrdiff_t debug_delta
, debug_delta_bytes
;
13007 /* Values of window_end_pos and window_end_vpos at the end of
13010 static ptrdiff_t debug_end_vpos
;
13012 /* Append a string to W->desired_matrix->method. FMT is a printf
13013 format string. If trace_redisplay_p is true also printf the
13014 resulting string to stderr. */
13016 static void debug_method_add (struct window
*, char const *, ...)
13017 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13020 debug_method_add (struct window
*w
, char const *fmt
, ...)
13023 char *method
= w
->desired_matrix
->method
;
13024 int len
= strlen (method
);
13025 int size
= sizeof w
->desired_matrix
->method
;
13026 int remaining
= size
- len
- 1;
13029 if (len
&& remaining
)
13032 --remaining
, ++len
;
13035 va_start (ap
, fmt
);
13036 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13039 if (trace_redisplay_p
)
13040 fprintf (stderr
, "%p (%s): %s\n",
13042 ((BUFFERP (w
->contents
)
13043 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13044 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13049 #endif /* GLYPH_DEBUG */
13052 /* Value is non-zero if all changes in window W, which displays
13053 current_buffer, are in the text between START and END. START is a
13054 buffer position, END is given as a distance from Z. Used in
13055 redisplay_internal for display optimization. */
13058 text_outside_line_unchanged_p (struct window
*w
,
13059 ptrdiff_t start
, ptrdiff_t end
)
13061 int unchanged_p
= 1;
13063 /* If text or overlays have changed, see where. */
13064 if (window_outdated (w
))
13066 /* Gap in the line? */
13067 if (GPT
< start
|| Z
- GPT
< end
)
13070 /* Changes start in front of the line, or end after it? */
13072 && (BEG_UNCHANGED
< start
- 1
13073 || END_UNCHANGED
< end
))
13076 /* If selective display, can't optimize if changes start at the
13077 beginning of the line. */
13079 && INTEGERP (BVAR (current_buffer
, selective_display
))
13080 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13081 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13084 /* If there are overlays at the start or end of the line, these
13085 may have overlay strings with newlines in them. A change at
13086 START, for instance, may actually concern the display of such
13087 overlay strings as well, and they are displayed on different
13088 lines. So, quickly rule out this case. (For the future, it
13089 might be desirable to implement something more telling than
13090 just BEG/END_UNCHANGED.) */
13093 if (BEG
+ BEG_UNCHANGED
== start
13094 && overlay_touches_p (start
))
13096 if (END_UNCHANGED
== end
13097 && overlay_touches_p (Z
- end
))
13101 /* Under bidi reordering, adding or deleting a character in the
13102 beginning of a paragraph, before the first strong directional
13103 character, can change the base direction of the paragraph (unless
13104 the buffer specifies a fixed paragraph direction), which will
13105 require to redisplay the whole paragraph. It might be worthwhile
13106 to find the paragraph limits and widen the range of redisplayed
13107 lines to that, but for now just give up this optimization. */
13108 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13109 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13113 return unchanged_p
;
13117 /* Do a frame update, taking possible shortcuts into account. This is
13118 the main external entry point for redisplay.
13120 If the last redisplay displayed an echo area message and that message
13121 is no longer requested, we clear the echo area or bring back the
13122 mini-buffer if that is in use. */
13127 redisplay_internal ();
13132 overlay_arrow_string_or_property (Lisp_Object var
)
13136 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13139 return Voverlay_arrow_string
;
13142 /* Return 1 if there are any overlay-arrows in current_buffer. */
13144 overlay_arrow_in_current_buffer_p (void)
13148 for (vlist
= Voverlay_arrow_variable_list
;
13150 vlist
= XCDR (vlist
))
13152 Lisp_Object var
= XCAR (vlist
);
13155 if (!SYMBOLP (var
))
13157 val
= find_symbol_value (var
);
13159 && current_buffer
== XMARKER (val
)->buffer
)
13166 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
13170 overlay_arrows_changed_p (void)
13174 for (vlist
= Voverlay_arrow_variable_list
;
13176 vlist
= XCDR (vlist
))
13178 Lisp_Object var
= XCAR (vlist
);
13179 Lisp_Object val
, pstr
;
13181 if (!SYMBOLP (var
))
13183 val
= find_symbol_value (var
);
13184 if (!MARKERP (val
))
13186 if (! EQ (COERCE_MARKER (val
),
13187 Fget (var
, Qlast_arrow_position
))
13188 || ! (pstr
= overlay_arrow_string_or_property (var
),
13189 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13195 /* Mark overlay arrows to be updated on next redisplay. */
13198 update_overlay_arrows (int up_to_date
)
13202 for (vlist
= Voverlay_arrow_variable_list
;
13204 vlist
= XCDR (vlist
))
13206 Lisp_Object var
= XCAR (vlist
);
13208 if (!SYMBOLP (var
))
13211 if (up_to_date
> 0)
13213 Lisp_Object val
= find_symbol_value (var
);
13214 Fput (var
, Qlast_arrow_position
,
13215 COERCE_MARKER (val
));
13216 Fput (var
, Qlast_arrow_string
,
13217 overlay_arrow_string_or_property (var
));
13219 else if (up_to_date
< 0
13220 || !NILP (Fget (var
, Qlast_arrow_position
)))
13222 Fput (var
, Qlast_arrow_position
, Qt
);
13223 Fput (var
, Qlast_arrow_string
, Qt
);
13229 /* Return overlay arrow string to display at row.
13230 Return integer (bitmap number) for arrow bitmap in left fringe.
13231 Return nil if no overlay arrow. */
13234 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13238 for (vlist
= Voverlay_arrow_variable_list
;
13240 vlist
= XCDR (vlist
))
13242 Lisp_Object var
= XCAR (vlist
);
13245 if (!SYMBOLP (var
))
13248 val
= find_symbol_value (var
);
13251 && current_buffer
== XMARKER (val
)->buffer
13252 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13254 if (FRAME_WINDOW_P (it
->f
)
13255 /* FIXME: if ROW->reversed_p is set, this should test
13256 the right fringe, not the left one. */
13257 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13259 #ifdef HAVE_WINDOW_SYSTEM
13260 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13263 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
13264 return make_number (fringe_bitmap
);
13267 return make_number (-1); /* Use default arrow bitmap. */
13269 return overlay_arrow_string_or_property (var
);
13276 /* Return 1 if point moved out of or into a composition. Otherwise
13277 return 0. PREV_BUF and PREV_PT are the last point buffer and
13278 position. BUF and PT are the current point buffer and position. */
13281 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13282 struct buffer
*buf
, ptrdiff_t pt
)
13284 ptrdiff_t start
, end
;
13286 Lisp_Object buffer
;
13288 XSETBUFFER (buffer
, buf
);
13289 /* Check a composition at the last point if point moved within the
13291 if (prev_buf
== buf
)
13294 /* Point didn't move. */
13297 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13298 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13299 && composition_valid_p (start
, end
, prop
)
13300 && start
< prev_pt
&& end
> prev_pt
)
13301 /* The last point was within the composition. Return 1 iff
13302 point moved out of the composition. */
13303 return (pt
<= start
|| pt
>= end
);
13306 /* Check a composition at the current point. */
13307 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13308 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13309 && composition_valid_p (start
, end
, prop
)
13310 && start
< pt
&& end
> pt
);
13313 /* Reconsider the clip changes of buffer which is displayed in W. */
13316 reconsider_clip_changes (struct window
*w
)
13318 struct buffer
*b
= XBUFFER (w
->contents
);
13320 if (b
->clip_changed
13321 && w
->window_end_valid
13322 && w
->current_matrix
->buffer
== b
13323 && w
->current_matrix
->zv
== BUF_ZV (b
)
13324 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13325 b
->clip_changed
= 0;
13327 /* If display wasn't paused, and W is not a tool bar window, see if
13328 point has been moved into or out of a composition. In that case,
13329 we set b->clip_changed to 1 to force updating the screen. If
13330 b->clip_changed has already been set to 1, we can skip this
13332 if (!b
->clip_changed
&& w
->window_end_valid
)
13334 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13335 ? PT
: marker_position (w
->pointm
));
13337 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13338 && check_point_in_composition (w
->current_matrix
->buffer
,
13339 w
->last_point
, b
, pt
))
13340 b
->clip_changed
= 1;
13345 propagate_buffer_redisplay (void)
13346 { /* Resetting b->text->redisplay is problematic!
13347 We can't just reset it in the case that some window that displays
13348 it has not been redisplayed; and such a window can stay
13349 unredisplayed for a long time if it's currently invisible.
13350 But we do want to reset it at the end of redisplay otherwise
13351 its displayed windows will keep being redisplayed over and over
13353 So we copy all b->text->redisplay flags up to their windows here,
13354 such that mark_window_display_accurate can safely reset
13355 b->text->redisplay. */
13356 Lisp_Object ws
= window_list ();
13357 for (; CONSP (ws
); ws
= XCDR (ws
))
13359 struct window
*thisw
= XWINDOW (XCAR (ws
));
13360 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13361 if (thisb
->text
->redisplay
)
13362 thisw
->redisplay
= true;
13366 #define STOP_POLLING \
13367 do { if (! polling_stopped_here) stop_polling (); \
13368 polling_stopped_here = 1; } while (0)
13370 #define RESUME_POLLING \
13371 do { if (polling_stopped_here) start_polling (); \
13372 polling_stopped_here = 0; } while (0)
13375 /* Perhaps in the future avoid recentering windows if it
13376 is not necessary; currently that causes some problems. */
13379 redisplay_internal (void)
13381 struct window
*w
= XWINDOW (selected_window
);
13385 bool must_finish
= 0, match_p
;
13386 struct text_pos tlbufpos
, tlendpos
;
13387 int number_of_visible_frames
;
13390 int polling_stopped_here
= 0;
13391 Lisp_Object tail
, frame
;
13393 /* True means redisplay has to consider all windows on all
13394 frames. False, only selected_window is considered. */
13395 bool consider_all_windows_p
;
13397 /* True means redisplay has to redisplay the miniwindow. */
13398 bool update_miniwindow_p
= false;
13400 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13402 /* No redisplay if running in batch mode or frame is not yet fully
13403 initialized, or redisplay is explicitly turned off by setting
13404 Vinhibit_redisplay. */
13405 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13406 || !NILP (Vinhibit_redisplay
))
13409 /* Don't examine these until after testing Vinhibit_redisplay.
13410 When Emacs is shutting down, perhaps because its connection to
13411 X has dropped, we should not look at them at all. */
13412 fr
= XFRAME (w
->frame
);
13413 sf
= SELECTED_FRAME ();
13415 if (!fr
->glyphs_initialized_p
)
13418 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13419 if (popup_activated ())
13423 /* I don't think this happens but let's be paranoid. */
13424 if (redisplaying_p
)
13427 /* Record a function that clears redisplaying_p
13428 when we leave this function. */
13429 count
= SPECPDL_INDEX ();
13430 record_unwind_protect_void (unwind_redisplay
);
13431 redisplaying_p
= 1;
13432 specbind (Qinhibit_free_realized_faces
, Qnil
);
13434 /* Record this function, so it appears on the profiler's backtraces. */
13435 record_in_backtrace (Qredisplay_internal
, &Qnil
, 0);
13437 FOR_EACH_FRAME (tail
, frame
)
13438 XFRAME (frame
)->already_hscrolled_p
= 0;
13441 /* Remember the currently selected window. */
13445 last_escape_glyph_frame
= NULL
;
13446 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13447 last_glyphless_glyph_frame
= NULL
;
13448 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13450 /* If face_change_count is non-zero, init_iterator will free all
13451 realized faces, which includes the faces referenced from current
13452 matrices. So, we can't reuse current matrices in this case. */
13453 if (face_change_count
)
13454 windows_or_buffers_changed
= 47;
13456 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13457 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13459 /* Since frames on a single ASCII terminal share the same
13460 display area, displaying a different frame means redisplay
13461 the whole thing. */
13462 SET_FRAME_GARBAGED (sf
);
13464 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13466 FRAME_TTY (sf
)->previous_frame
= sf
;
13469 /* Set the visible flags for all frames. Do this before checking for
13470 resized or garbaged frames; they want to know if their frames are
13471 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13472 number_of_visible_frames
= 0;
13474 FOR_EACH_FRAME (tail
, frame
)
13476 struct frame
*f
= XFRAME (frame
);
13478 if (FRAME_VISIBLE_P (f
))
13480 ++number_of_visible_frames
;
13481 /* Adjust matrices for visible frames only. */
13482 if (f
->fonts_changed
)
13484 adjust_frame_glyphs (f
);
13485 f
->fonts_changed
= 0;
13487 /* If cursor type has been changed on the frame
13488 other than selected, consider all frames. */
13489 if (f
!= sf
&& f
->cursor_type_changed
)
13490 update_mode_lines
= 31;
13492 clear_desired_matrices (f
);
13495 /* Notice any pending interrupt request to change frame size. */
13496 do_pending_window_change (1);
13498 /* do_pending_window_change could change the selected_window due to
13499 frame resizing which makes the selected window too small. */
13500 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13503 /* Clear frames marked as garbaged. */
13504 clear_garbaged_frames ();
13506 /* Build menubar and tool-bar items. */
13507 if (NILP (Vmemory_full
))
13508 prepare_menu_bars ();
13510 reconsider_clip_changes (w
);
13512 /* In most cases selected window displays current buffer. */
13513 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13516 /* Detect case that we need to write or remove a star in the mode line. */
13517 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13518 w
->update_mode_line
= 1;
13520 if (mode_line_update_needed (w
))
13521 w
->update_mode_line
= 1;
13524 /* Normally the message* functions will have already displayed and
13525 updated the echo area, but the frame may have been trashed, or
13526 the update may have been preempted, so display the echo area
13527 again here. Checking message_cleared_p captures the case that
13528 the echo area should be cleared. */
13529 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13530 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13531 || (message_cleared_p
13532 && minibuf_level
== 0
13533 /* If the mini-window is currently selected, this means the
13534 echo-area doesn't show through. */
13535 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13537 int window_height_changed_p
= echo_area_display (0);
13539 if (message_cleared_p
)
13540 update_miniwindow_p
= true;
13544 /* If we don't display the current message, don't clear the
13545 message_cleared_p flag, because, if we did, we wouldn't clear
13546 the echo area in the next redisplay which doesn't preserve
13548 if (!display_last_displayed_message_p
)
13549 message_cleared_p
= 0;
13551 if (window_height_changed_p
)
13553 windows_or_buffers_changed
= 50;
13555 /* If window configuration was changed, frames may have been
13556 marked garbaged. Clear them or we will experience
13557 surprises wrt scrolling. */
13558 clear_garbaged_frames ();
13561 else if (EQ (selected_window
, minibuf_window
)
13562 && (current_buffer
->clip_changed
|| window_outdated (w
))
13563 && resize_mini_window (w
, 0))
13565 /* Resized active mini-window to fit the size of what it is
13566 showing if its contents might have changed. */
13569 /* If window configuration was changed, frames may have been
13570 marked garbaged. Clear them or we will experience
13571 surprises wrt scrolling. */
13572 clear_garbaged_frames ();
13575 if (windows_or_buffers_changed
&& !update_mode_lines
)
13576 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13577 only the windows's contents needs to be refreshed, or whether the
13578 mode-lines also need a refresh. */
13579 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13580 ? REDISPLAY_SOME
: 32);
13582 /* If specs for an arrow have changed, do thorough redisplay
13583 to ensure we remove any arrow that should no longer exist. */
13584 if (overlay_arrows_changed_p ())
13585 /* Apparently, this is the only case where we update other windows,
13586 without updating other mode-lines. */
13587 windows_or_buffers_changed
= 49;
13589 consider_all_windows_p
= (update_mode_lines
13590 || windows_or_buffers_changed
);
13592 #define AINC(a,i) \
13593 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13594 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13596 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13597 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13599 /* Optimize the case that only the line containing the cursor in the
13600 selected window has changed. Variables starting with this_ are
13601 set in display_line and record information about the line
13602 containing the cursor. */
13603 tlbufpos
= this_line_start_pos
;
13604 tlendpos
= this_line_end_pos
;
13605 if (!consider_all_windows_p
13606 && CHARPOS (tlbufpos
) > 0
13607 && !w
->update_mode_line
13608 && !current_buffer
->clip_changed
13609 && !current_buffer
->prevent_redisplay_optimizations_p
13610 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13611 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13612 && !XFRAME (w
->frame
)->cursor_type_changed
13613 /* Make sure recorded data applies to current buffer, etc. */
13614 && this_line_buffer
== current_buffer
13617 && !w
->optional_new_start
13618 /* Point must be on the line that we have info recorded about. */
13619 && PT
>= CHARPOS (tlbufpos
)
13620 && PT
<= Z
- CHARPOS (tlendpos
)
13621 /* All text outside that line, including its final newline,
13622 must be unchanged. */
13623 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13624 CHARPOS (tlendpos
)))
13626 if (CHARPOS (tlbufpos
) > BEGV
13627 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13628 && (CHARPOS (tlbufpos
) == ZV
13629 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13630 /* Former continuation line has disappeared by becoming empty. */
13632 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13634 /* We have to handle the case of continuation around a
13635 wide-column character (see the comment in indent.c around
13638 For instance, in the following case:
13640 -------- Insert --------
13641 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13642 J_I_ ==> J_I_ `^^' are cursors.
13646 As we have to redraw the line above, we cannot use this
13650 int line_height_before
= this_line_pixel_height
;
13652 /* Note that start_display will handle the case that the
13653 line starting at tlbufpos is a continuation line. */
13654 start_display (&it
, w
, tlbufpos
);
13656 /* Implementation note: It this still necessary? */
13657 if (it
.current_x
!= this_line_start_x
)
13660 TRACE ((stderr
, "trying display optimization 1\n"));
13661 w
->cursor
.vpos
= -1;
13662 overlay_arrow_seen
= 0;
13663 it
.vpos
= this_line_vpos
;
13664 it
.current_y
= this_line_y
;
13665 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13666 display_line (&it
);
13668 /* If line contains point, is not continued,
13669 and ends at same distance from eob as before, we win. */
13670 if (w
->cursor
.vpos
>= 0
13671 /* Line is not continued, otherwise this_line_start_pos
13672 would have been set to 0 in display_line. */
13673 && CHARPOS (this_line_start_pos
)
13674 /* Line ends as before. */
13675 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13676 /* Line has same height as before. Otherwise other lines
13677 would have to be shifted up or down. */
13678 && this_line_pixel_height
== line_height_before
)
13680 /* If this is not the window's last line, we must adjust
13681 the charstarts of the lines below. */
13682 if (it
.current_y
< it
.last_visible_y
)
13684 struct glyph_row
*row
13685 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13686 ptrdiff_t delta
, delta_bytes
;
13688 /* We used to distinguish between two cases here,
13689 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13690 when the line ends in a newline or the end of the
13691 buffer's accessible portion. But both cases did
13692 the same, so they were collapsed. */
13694 - CHARPOS (tlendpos
)
13695 - MATRIX_ROW_START_CHARPOS (row
));
13696 delta_bytes
= (Z_BYTE
13697 - BYTEPOS (tlendpos
)
13698 - MATRIX_ROW_START_BYTEPOS (row
));
13700 increment_matrix_positions (w
->current_matrix
,
13701 this_line_vpos
+ 1,
13702 w
->current_matrix
->nrows
,
13703 delta
, delta_bytes
);
13706 /* If this row displays text now but previously didn't,
13707 or vice versa, w->window_end_vpos may have to be
13709 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13711 if (w
->window_end_vpos
< this_line_vpos
)
13712 w
->window_end_vpos
= this_line_vpos
;
13714 else if (w
->window_end_vpos
== this_line_vpos
13715 && this_line_vpos
> 0)
13716 w
->window_end_vpos
= this_line_vpos
- 1;
13717 w
->window_end_valid
= 0;
13719 /* Update hint: No need to try to scroll in update_window. */
13720 w
->desired_matrix
->no_scrolling_p
= 1;
13723 *w
->desired_matrix
->method
= 0;
13724 debug_method_add (w
, "optimization 1");
13726 #ifdef HAVE_WINDOW_SYSTEM
13727 update_window_fringes (w
, 0);
13734 else if (/* Cursor position hasn't changed. */
13735 PT
== w
->last_point
13736 /* Make sure the cursor was last displayed
13737 in this window. Otherwise we have to reposition it. */
13739 /* PXW: Must be converted to pixels, probably. */
13740 && 0 <= w
->cursor
.vpos
13741 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13745 do_pending_window_change (1);
13746 /* If selected_window changed, redisplay again. */
13747 if (WINDOWP (selected_window
)
13748 && (w
= XWINDOW (selected_window
)) != sw
)
13751 /* We used to always goto end_of_redisplay here, but this
13752 isn't enough if we have a blinking cursor. */
13753 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13754 goto end_of_redisplay
;
13758 /* If highlighting the region, or if the cursor is in the echo area,
13759 then we can't just move the cursor. */
13760 else if (NILP (Vshow_trailing_whitespace
)
13761 && !cursor_in_echo_area
)
13764 struct glyph_row
*row
;
13766 /* Skip from tlbufpos to PT and see where it is. Note that
13767 PT may be in invisible text. If so, we will end at the
13768 next visible position. */
13769 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13770 NULL
, DEFAULT_FACE_ID
);
13771 it
.current_x
= this_line_start_x
;
13772 it
.current_y
= this_line_y
;
13773 it
.vpos
= this_line_vpos
;
13775 /* The call to move_it_to stops in front of PT, but
13776 moves over before-strings. */
13777 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13779 if (it
.vpos
== this_line_vpos
13780 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13783 eassert (this_line_vpos
== it
.vpos
);
13784 eassert (this_line_y
== it
.current_y
);
13785 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13787 *w
->desired_matrix
->method
= 0;
13788 debug_method_add (w
, "optimization 3");
13797 /* Text changed drastically or point moved off of line. */
13798 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13801 CHARPOS (this_line_start_pos
) = 0;
13802 ++clear_face_cache_count
;
13803 #ifdef HAVE_WINDOW_SYSTEM
13804 ++clear_image_cache_count
;
13807 /* Build desired matrices, and update the display. If
13808 consider_all_windows_p is non-zero, do it for all windows on all
13809 frames. Otherwise do it for selected_window, only. */
13811 if (consider_all_windows_p
)
13813 FOR_EACH_FRAME (tail
, frame
)
13814 XFRAME (frame
)->updated_p
= 0;
13816 propagate_buffer_redisplay ();
13818 FOR_EACH_FRAME (tail
, frame
)
13820 struct frame
*f
= XFRAME (frame
);
13822 /* We don't have to do anything for unselected terminal
13824 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13825 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13830 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13833 /* Only GC scrollbars when we redisplay the whole frame. */
13834 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13835 /* Mark all the scroll bars to be removed; we'll redeem
13836 the ones we want when we redisplay their windows. */
13837 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13838 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13840 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13841 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13842 /* Remember that the invisible frames need to be redisplayed next
13843 time they're visible. */
13844 else if (!REDISPLAY_SOME_P ())
13845 f
->redisplay
= true;
13847 /* The X error handler may have deleted that frame. */
13848 if (!FRAME_LIVE_P (f
))
13851 /* Any scroll bars which redisplay_windows should have
13852 nuked should now go away. */
13853 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13854 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13856 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13858 /* If fonts changed on visible frame, display again. */
13859 if (f
->fonts_changed
)
13861 adjust_frame_glyphs (f
);
13862 f
->fonts_changed
= 0;
13866 /* See if we have to hscroll. */
13867 if (!f
->already_hscrolled_p
)
13869 f
->already_hscrolled_p
= 1;
13870 if (hscroll_windows (f
->root_window
))
13874 /* Prevent various kinds of signals during display
13875 update. stdio is not robust about handling
13876 signals, which can cause an apparent I/O error. */
13877 if (interrupt_input
)
13878 unrequest_sigio ();
13881 pending
|= update_frame (f
, 0, 0);
13882 f
->cursor_type_changed
= 0;
13888 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13892 /* Do the mark_window_display_accurate after all windows have
13893 been redisplayed because this call resets flags in buffers
13894 which are needed for proper redisplay. */
13895 FOR_EACH_FRAME (tail
, frame
)
13897 struct frame
*f
= XFRAME (frame
);
13900 f
->redisplay
= false;
13901 mark_window_display_accurate (f
->root_window
, 1);
13902 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13903 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13908 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13910 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13911 struct frame
*mini_frame
;
13913 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13914 /* Use list_of_error, not Qerror, so that
13915 we catch only errors and don't run the debugger. */
13916 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13918 redisplay_window_error
);
13919 if (update_miniwindow_p
)
13920 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13922 redisplay_window_error
);
13924 /* Compare desired and current matrices, perform output. */
13927 /* If fonts changed, display again. */
13928 if (sf
->fonts_changed
)
13931 /* Prevent various kinds of signals during display update.
13932 stdio is not robust about handling signals,
13933 which can cause an apparent I/O error. */
13934 if (interrupt_input
)
13935 unrequest_sigio ();
13938 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13940 if (hscroll_windows (selected_window
))
13943 XWINDOW (selected_window
)->must_be_updated_p
= true;
13944 pending
= update_frame (sf
, 0, 0);
13945 sf
->cursor_type_changed
= 0;
13948 /* We may have called echo_area_display at the top of this
13949 function. If the echo area is on another frame, that may
13950 have put text on a frame other than the selected one, so the
13951 above call to update_frame would not have caught it. Catch
13953 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13954 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13956 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13958 XWINDOW (mini_window
)->must_be_updated_p
= true;
13959 pending
|= update_frame (mini_frame
, 0, 0);
13960 mini_frame
->cursor_type_changed
= 0;
13961 if (!pending
&& hscroll_windows (mini_window
))
13966 /* If display was paused because of pending input, make sure we do a
13967 thorough update the next time. */
13970 /* Prevent the optimization at the beginning of
13971 redisplay_internal that tries a single-line update of the
13972 line containing the cursor in the selected window. */
13973 CHARPOS (this_line_start_pos
) = 0;
13975 /* Let the overlay arrow be updated the next time. */
13976 update_overlay_arrows (0);
13978 /* If we pause after scrolling, some rows in the current
13979 matrices of some windows are not valid. */
13980 if (!WINDOW_FULL_WIDTH_P (w
)
13981 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13982 update_mode_lines
= 36;
13986 if (!consider_all_windows_p
)
13988 /* This has already been done above if
13989 consider_all_windows_p is set. */
13990 if (XBUFFER (w
->contents
)->text
->redisplay
13991 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
13992 /* This can happen if b->text->redisplay was set during
13994 propagate_buffer_redisplay ();
13995 mark_window_display_accurate_1 (w
, 1);
13997 /* Say overlay arrows are up to date. */
13998 update_overlay_arrows (1);
14000 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
14001 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
14004 update_mode_lines
= 0;
14005 windows_or_buffers_changed
= 0;
14008 /* Start SIGIO interrupts coming again. Having them off during the
14009 code above makes it less likely one will discard output, but not
14010 impossible, since there might be stuff in the system buffer here.
14011 But it is much hairier to try to do anything about that. */
14012 if (interrupt_input
)
14016 /* If a frame has become visible which was not before, redisplay
14017 again, so that we display it. Expose events for such a frame
14018 (which it gets when becoming visible) don't call the parts of
14019 redisplay constructing glyphs, so simply exposing a frame won't
14020 display anything in this case. So, we have to display these
14021 frames here explicitly. */
14026 FOR_EACH_FRAME (tail
, frame
)
14028 if (XFRAME (frame
)->visible
)
14032 if (new_count
!= number_of_visible_frames
)
14033 windows_or_buffers_changed
= 52;
14036 /* Change frame size now if a change is pending. */
14037 do_pending_window_change (1);
14039 /* If we just did a pending size change, or have additional
14040 visible frames, or selected_window changed, redisplay again. */
14041 if ((windows_or_buffers_changed
&& !pending
)
14042 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14045 /* Clear the face and image caches.
14047 We used to do this only if consider_all_windows_p. But the cache
14048 needs to be cleared if a timer creates images in the current
14049 buffer (e.g. the test case in Bug#6230). */
14051 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14053 clear_face_cache (0);
14054 clear_face_cache_count
= 0;
14057 #ifdef HAVE_WINDOW_SYSTEM
14058 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14060 clear_image_caches (Qnil
);
14061 clear_image_cache_count
= 0;
14063 #endif /* HAVE_WINDOW_SYSTEM */
14066 if (interrupt_input
&& interrupts_deferred
)
14069 unbind_to (count
, Qnil
);
14074 /* Redisplay, but leave alone any recent echo area message unless
14075 another message has been requested in its place.
14077 This is useful in situations where you need to redisplay but no
14078 user action has occurred, making it inappropriate for the message
14079 area to be cleared. See tracking_off and
14080 wait_reading_process_output for examples of these situations.
14082 FROM_WHERE is an integer saying from where this function was
14083 called. This is useful for debugging. */
14086 redisplay_preserve_echo_area (int from_where
)
14088 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14090 if (!NILP (echo_area_buffer
[1]))
14092 /* We have a previously displayed message, but no current
14093 message. Redisplay the previous message. */
14094 display_last_displayed_message_p
= 1;
14095 redisplay_internal ();
14096 display_last_displayed_message_p
= 0;
14099 redisplay_internal ();
14101 flush_frame (SELECTED_FRAME ());
14105 /* Function registered with record_unwind_protect in redisplay_internal. */
14108 unwind_redisplay (void)
14110 redisplaying_p
= 0;
14114 /* Mark the display of leaf window W as accurate or inaccurate.
14115 If ACCURATE_P is non-zero mark display of W as accurate. If
14116 ACCURATE_P is zero, arrange for W to be redisplayed the next
14117 time redisplay_internal is called. */
14120 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
14122 struct buffer
*b
= XBUFFER (w
->contents
);
14124 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14125 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14126 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14130 b
->clip_changed
= false;
14131 b
->prevent_redisplay_optimizations_p
= false;
14132 eassert (buffer_window_count (b
) > 0);
14133 /* Resetting b->text->redisplay is problematic!
14134 In order to make it safer to do it here, redisplay_internal must
14135 have copied all b->text->redisplay to their respective windows. */
14136 b
->text
->redisplay
= false;
14138 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14139 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14140 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14141 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14143 w
->current_matrix
->buffer
= b
;
14144 w
->current_matrix
->begv
= BUF_BEGV (b
);
14145 w
->current_matrix
->zv
= BUF_ZV (b
);
14147 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14148 w
->last_cursor_off_p
= w
->cursor_off_p
;
14150 if (w
== XWINDOW (selected_window
))
14151 w
->last_point
= BUF_PT (b
);
14153 w
->last_point
= marker_position (w
->pointm
);
14155 w
->window_end_valid
= true;
14156 w
->update_mode_line
= false;
14159 w
->redisplay
= !accurate_p
;
14163 /* Mark the display of windows in the window tree rooted at WINDOW as
14164 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
14165 windows as accurate. If ACCURATE_P is zero, arrange for windows to
14166 be redisplayed the next time redisplay_internal is called. */
14169 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
14173 for (; !NILP (window
); window
= w
->next
)
14175 w
= XWINDOW (window
);
14176 if (WINDOWP (w
->contents
))
14177 mark_window_display_accurate (w
->contents
, accurate_p
);
14179 mark_window_display_accurate_1 (w
, accurate_p
);
14183 update_overlay_arrows (1);
14185 /* Force a thorough redisplay the next time by setting
14186 last_arrow_position and last_arrow_string to t, which is
14187 unequal to any useful value of Voverlay_arrow_... */
14188 update_overlay_arrows (-1);
14192 /* Return value in display table DP (Lisp_Char_Table *) for character
14193 C. Since a display table doesn't have any parent, we don't have to
14194 follow parent. Do not call this function directly but use the
14195 macro DISP_CHAR_VECTOR. */
14198 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14202 if (ASCII_CHAR_P (c
))
14205 if (SUB_CHAR_TABLE_P (val
))
14206 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14212 XSETCHAR_TABLE (table
, dp
);
14213 val
= char_table_ref (table
, c
);
14222 /***********************************************************************
14224 ***********************************************************************/
14226 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14229 redisplay_windows (Lisp_Object window
)
14231 while (!NILP (window
))
14233 struct window
*w
= XWINDOW (window
);
14235 if (WINDOWP (w
->contents
))
14236 redisplay_windows (w
->contents
);
14237 else if (BUFFERP (w
->contents
))
14239 displayed_buffer
= XBUFFER (w
->contents
);
14240 /* Use list_of_error, not Qerror, so that
14241 we catch only errors and don't run the debugger. */
14242 internal_condition_case_1 (redisplay_window_0
, window
,
14244 redisplay_window_error
);
14252 redisplay_window_error (Lisp_Object ignore
)
14254 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14259 redisplay_window_0 (Lisp_Object window
)
14261 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14262 redisplay_window (window
, false);
14267 redisplay_window_1 (Lisp_Object window
)
14269 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14270 redisplay_window (window
, true);
14275 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14276 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14277 which positions recorded in ROW differ from current buffer
14280 Return 0 if cursor is not on this row, 1 otherwise. */
14283 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14284 struct glyph_matrix
*matrix
,
14285 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14288 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14289 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14290 struct glyph
*cursor
= NULL
;
14291 /* The last known character position in row. */
14292 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14294 ptrdiff_t pt_old
= PT
- delta
;
14295 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14296 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14297 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14298 /* A glyph beyond the edge of TEXT_AREA which we should never
14300 struct glyph
*glyphs_end
= end
;
14301 /* Non-zero means we've found a match for cursor position, but that
14302 glyph has the avoid_cursor_p flag set. */
14303 int match_with_avoid_cursor
= 0;
14304 /* Non-zero means we've seen at least one glyph that came from a
14306 int string_seen
= 0;
14307 /* Largest and smallest buffer positions seen so far during scan of
14309 ptrdiff_t bpos_max
= pos_before
;
14310 ptrdiff_t bpos_min
= pos_after
;
14311 /* Last buffer position covered by an overlay string with an integer
14312 `cursor' property. */
14313 ptrdiff_t bpos_covered
= 0;
14314 /* Non-zero means the display string on which to display the cursor
14315 comes from a text property, not from an overlay. */
14316 int string_from_text_prop
= 0;
14318 /* Don't even try doing anything if called for a mode-line or
14319 header-line row, since the rest of the code isn't prepared to
14320 deal with such calamities. */
14321 eassert (!row
->mode_line_p
);
14322 if (row
->mode_line_p
)
14325 /* Skip over glyphs not having an object at the start and the end of
14326 the row. These are special glyphs like truncation marks on
14327 terminal frames. */
14328 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14330 if (!row
->reversed_p
)
14333 && INTEGERP (glyph
->object
)
14334 && glyph
->charpos
< 0)
14336 x
+= glyph
->pixel_width
;
14340 && INTEGERP ((end
- 1)->object
)
14341 /* CHARPOS is zero for blanks and stretch glyphs
14342 inserted by extend_face_to_end_of_line. */
14343 && (end
- 1)->charpos
<= 0)
14345 glyph_before
= glyph
- 1;
14352 /* If the glyph row is reversed, we need to process it from back
14353 to front, so swap the edge pointers. */
14354 glyphs_end
= end
= glyph
- 1;
14355 glyph
+= row
->used
[TEXT_AREA
] - 1;
14357 while (glyph
> end
+ 1
14358 && INTEGERP (glyph
->object
)
14359 && glyph
->charpos
< 0)
14362 x
-= glyph
->pixel_width
;
14364 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
14366 /* By default, in reversed rows we put the cursor on the
14367 rightmost (first in the reading order) glyph. */
14368 for (g
= end
+ 1; g
< glyph
; g
++)
14369 x
+= g
->pixel_width
;
14371 && INTEGERP ((end
+ 1)->object
)
14372 && (end
+ 1)->charpos
<= 0)
14374 glyph_before
= glyph
+ 1;
14378 else if (row
->reversed_p
)
14380 /* In R2L rows that don't display text, put the cursor on the
14381 rightmost glyph. Case in point: an empty last line that is
14382 part of an R2L paragraph. */
14384 /* Avoid placing the cursor on the last glyph of the row, where
14385 on terminal frames we hold the vertical border between
14386 adjacent windows. */
14387 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14388 && !WINDOW_RIGHTMOST_P (w
)
14389 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14391 x
= -1; /* will be computed below, at label compute_x */
14394 /* Step 1: Try to find the glyph whose character position
14395 corresponds to point. If that's not possible, find 2 glyphs
14396 whose character positions are the closest to point, one before
14397 point, the other after it. */
14398 if (!row
->reversed_p
)
14399 while (/* not marched to end of glyph row */
14401 /* glyph was not inserted by redisplay for internal purposes */
14402 && !INTEGERP (glyph
->object
))
14404 if (BUFFERP (glyph
->object
))
14406 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14408 if (glyph
->charpos
> bpos_max
)
14409 bpos_max
= glyph
->charpos
;
14410 if (glyph
->charpos
< bpos_min
)
14411 bpos_min
= glyph
->charpos
;
14412 if (!glyph
->avoid_cursor_p
)
14414 /* If we hit point, we've found the glyph on which to
14415 display the cursor. */
14418 match_with_avoid_cursor
= 0;
14421 /* See if we've found a better approximation to
14422 POS_BEFORE or to POS_AFTER. */
14423 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14425 pos_before
= glyph
->charpos
;
14426 glyph_before
= glyph
;
14428 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14430 pos_after
= glyph
->charpos
;
14431 glyph_after
= glyph
;
14434 else if (dpos
== 0)
14435 match_with_avoid_cursor
= 1;
14437 else if (STRINGP (glyph
->object
))
14439 Lisp_Object chprop
;
14440 ptrdiff_t glyph_pos
= glyph
->charpos
;
14442 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14444 if (!NILP (chprop
))
14446 /* If the string came from a `display' text property,
14447 look up the buffer position of that property and
14448 use that position to update bpos_max, as if we
14449 actually saw such a position in one of the row's
14450 glyphs. This helps with supporting integer values
14451 of `cursor' property on the display string in
14452 situations where most or all of the row's buffer
14453 text is completely covered by display properties,
14454 so that no glyph with valid buffer positions is
14455 ever seen in the row. */
14456 ptrdiff_t prop_pos
=
14457 string_buffer_position_lim (glyph
->object
, pos_before
,
14460 if (prop_pos
>= pos_before
)
14461 bpos_max
= prop_pos
;
14463 if (INTEGERP (chprop
))
14465 bpos_covered
= bpos_max
+ XINT (chprop
);
14466 /* If the `cursor' property covers buffer positions up
14467 to and including point, we should display cursor on
14468 this glyph. Note that, if a `cursor' property on one
14469 of the string's characters has an integer value, we
14470 will break out of the loop below _before_ we get to
14471 the position match above. IOW, integer values of
14472 the `cursor' property override the "exact match for
14473 point" strategy of positioning the cursor. */
14474 /* Implementation note: bpos_max == pt_old when, e.g.,
14475 we are in an empty line, where bpos_max is set to
14476 MATRIX_ROW_START_CHARPOS, see above. */
14477 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14486 x
+= glyph
->pixel_width
;
14489 else if (glyph
> end
) /* row is reversed */
14490 while (!INTEGERP (glyph
->object
))
14492 if (BUFFERP (glyph
->object
))
14494 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14496 if (glyph
->charpos
> bpos_max
)
14497 bpos_max
= glyph
->charpos
;
14498 if (glyph
->charpos
< bpos_min
)
14499 bpos_min
= glyph
->charpos
;
14500 if (!glyph
->avoid_cursor_p
)
14504 match_with_avoid_cursor
= 0;
14507 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14509 pos_before
= glyph
->charpos
;
14510 glyph_before
= glyph
;
14512 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14514 pos_after
= glyph
->charpos
;
14515 glyph_after
= glyph
;
14518 else if (dpos
== 0)
14519 match_with_avoid_cursor
= 1;
14521 else if (STRINGP (glyph
->object
))
14523 Lisp_Object chprop
;
14524 ptrdiff_t glyph_pos
= glyph
->charpos
;
14526 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14528 if (!NILP (chprop
))
14530 ptrdiff_t prop_pos
=
14531 string_buffer_position_lim (glyph
->object
, pos_before
,
14534 if (prop_pos
>= pos_before
)
14535 bpos_max
= prop_pos
;
14537 if (INTEGERP (chprop
))
14539 bpos_covered
= bpos_max
+ XINT (chprop
);
14540 /* If the `cursor' property covers buffer positions up
14541 to and including point, we should display cursor on
14543 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14552 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14554 x
--; /* can't use any pixel_width */
14557 x
-= glyph
->pixel_width
;
14560 /* Step 2: If we didn't find an exact match for point, we need to
14561 look for a proper place to put the cursor among glyphs between
14562 GLYPH_BEFORE and GLYPH_AFTER. */
14563 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14564 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14565 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14567 /* An empty line has a single glyph whose OBJECT is zero and
14568 whose CHARPOS is the position of a newline on that line.
14569 Note that on a TTY, there are more glyphs after that, which
14570 were produced by extend_face_to_end_of_line, but their
14571 CHARPOS is zero or negative. */
14573 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14574 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0
14575 /* On a TTY, continued and truncated rows also have a glyph at
14576 their end whose OBJECT is zero and whose CHARPOS is
14577 positive (the continuation and truncation glyphs), but such
14578 rows are obviously not "empty". */
14579 && !(row
->continued_p
|| row
->truncated_on_right_p
);
14581 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14583 ptrdiff_t ellipsis_pos
;
14585 /* Scan back over the ellipsis glyphs. */
14586 if (!row
->reversed_p
)
14588 ellipsis_pos
= (glyph
- 1)->charpos
;
14589 while (glyph
> row
->glyphs
[TEXT_AREA
]
14590 && (glyph
- 1)->charpos
== ellipsis_pos
)
14591 glyph
--, x
-= glyph
->pixel_width
;
14592 /* That loop always goes one position too far, including
14593 the glyph before the ellipsis. So scan forward over
14595 x
+= glyph
->pixel_width
;
14598 else /* row is reversed */
14600 ellipsis_pos
= (glyph
+ 1)->charpos
;
14601 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14602 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14603 glyph
++, x
+= glyph
->pixel_width
;
14604 x
-= glyph
->pixel_width
;
14608 else if (match_with_avoid_cursor
)
14610 cursor
= glyph_after
;
14613 else if (string_seen
)
14615 int incr
= row
->reversed_p
? -1 : +1;
14617 /* Need to find the glyph that came out of a string which is
14618 present at point. That glyph is somewhere between
14619 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14620 positioned between POS_BEFORE and POS_AFTER in the
14622 struct glyph
*start
, *stop
;
14623 ptrdiff_t pos
= pos_before
;
14627 /* If the row ends in a newline from a display string,
14628 reordering could have moved the glyphs belonging to the
14629 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14630 in this case we extend the search to the last glyph in
14631 the row that was not inserted by redisplay. */
14632 if (row
->ends_in_newline_from_string_p
)
14635 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14638 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14639 correspond to POS_BEFORE and POS_AFTER, respectively. We
14640 need START and STOP in the order that corresponds to the
14641 row's direction as given by its reversed_p flag. If the
14642 directionality of characters between POS_BEFORE and
14643 POS_AFTER is the opposite of the row's base direction,
14644 these characters will have been reordered for display,
14645 and we need to reverse START and STOP. */
14646 if (!row
->reversed_p
)
14648 start
= min (glyph_before
, glyph_after
);
14649 stop
= max (glyph_before
, glyph_after
);
14653 start
= max (glyph_before
, glyph_after
);
14654 stop
= min (glyph_before
, glyph_after
);
14656 for (glyph
= start
+ incr
;
14657 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14660 /* Any glyphs that come from the buffer are here because
14661 of bidi reordering. Skip them, and only pay
14662 attention to glyphs that came from some string. */
14663 if (STRINGP (glyph
->object
))
14667 /* If the display property covers the newline, we
14668 need to search for it one position farther. */
14669 ptrdiff_t lim
= pos_after
14670 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14672 string_from_text_prop
= 0;
14673 str
= glyph
->object
;
14674 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14675 if (tem
== 0 /* from overlay */
14678 /* If the string from which this glyph came is
14679 found in the buffer at point, or at position
14680 that is closer to point than pos_after, then
14681 we've found the glyph we've been looking for.
14682 If it comes from an overlay (tem == 0), and
14683 it has the `cursor' property on one of its
14684 glyphs, record that glyph as a candidate for
14685 displaying the cursor. (As in the
14686 unidirectional version, we will display the
14687 cursor on the last candidate we find.) */
14690 || (tem
- pt_old
> 0 && tem
< pos_after
))
14692 /* The glyphs from this string could have
14693 been reordered. Find the one with the
14694 smallest string position. Or there could
14695 be a character in the string with the
14696 `cursor' property, which means display
14697 cursor on that character's glyph. */
14698 ptrdiff_t strpos
= glyph
->charpos
;
14703 string_from_text_prop
= 1;
14706 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14707 && EQ (glyph
->object
, str
);
14711 ptrdiff_t gpos
= glyph
->charpos
;
14713 cprop
= Fget_char_property (make_number (gpos
),
14721 if (tem
&& glyph
->charpos
< strpos
)
14723 strpos
= glyph
->charpos
;
14729 || (tem
- pt_old
> 0 && tem
< pos_after
))
14733 pos
= tem
+ 1; /* don't find previous instances */
14735 /* This string is not what we want; skip all of the
14736 glyphs that came from it. */
14737 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14738 && EQ (glyph
->object
, str
))
14745 /* If we reached the end of the line, and END was from a string,
14746 the cursor is not on this line. */
14748 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14749 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14750 && STRINGP (end
->object
)
14751 && row
->continued_p
)
14754 /* A truncated row may not include PT among its character positions.
14755 Setting the cursor inside the scroll margin will trigger
14756 recalculation of hscroll in hscroll_window_tree. But if a
14757 display string covers point, defer to the string-handling
14758 code below to figure this out. */
14759 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14761 cursor
= glyph_before
;
14764 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14765 /* Zero-width characters produce no glyphs. */
14767 && (row
->reversed_p
14768 ? glyph_after
> glyphs_end
14769 : glyph_after
< glyphs_end
)))
14771 cursor
= glyph_after
;
14777 if (cursor
!= NULL
)
14779 else if (glyph
== glyphs_end
14780 && pos_before
== pos_after
14781 && STRINGP ((row
->reversed_p
14782 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14783 : row
->glyphs
[TEXT_AREA
])->object
))
14785 /* If all the glyphs of this row came from strings, put the
14786 cursor on the first glyph of the row. This avoids having the
14787 cursor outside of the text area in this very rare and hard
14791 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14792 : row
->glyphs
[TEXT_AREA
];
14798 /* Need to compute x that corresponds to GLYPH. */
14799 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14801 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14803 x
+= g
->pixel_width
;
14807 /* ROW could be part of a continued line, which, under bidi
14808 reordering, might have other rows whose start and end charpos
14809 occlude point. Only set w->cursor if we found a better
14810 approximation to the cursor position than we have from previously
14811 examined candidate rows belonging to the same continued line. */
14812 if (/* We already have a candidate row. */
14813 w
->cursor
.vpos
>= 0
14814 /* That candidate is not the row we are processing. */
14815 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14816 /* Make sure cursor.vpos specifies a row whose start and end
14817 charpos occlude point, and it is valid candidate for being a
14818 cursor-row. This is because some callers of this function
14819 leave cursor.vpos at the row where the cursor was displayed
14820 during the last redisplay cycle. */
14821 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14822 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14823 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14826 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14828 /* Don't consider glyphs that are outside TEXT_AREA. */
14829 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14831 /* Keep the candidate whose buffer position is the closest to
14832 point or has the `cursor' property. */
14833 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14834 w
->cursor
.hpos
>= 0
14835 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14836 && ((BUFFERP (g1
->object
)
14837 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14838 || (BUFFERP (glyph
->object
)
14839 && eabs (g1
->charpos
- pt_old
)
14840 < eabs (glyph
->charpos
- pt_old
))))
14841 /* Previous candidate is a glyph from a string that has
14842 a non-nil `cursor' property. */
14843 || (STRINGP (g1
->object
)
14844 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14845 Qcursor
, g1
->object
))
14846 /* Previous candidate is from the same display
14847 string as this one, and the display string
14848 came from a text property. */
14849 || (EQ (g1
->object
, glyph
->object
)
14850 && string_from_text_prop
)
14851 /* this candidate is from newline and its
14852 position is not an exact match */
14853 || (INTEGERP (glyph
->object
)
14854 && glyph
->charpos
!= pt_old
)))))
14856 /* If this candidate gives an exact match, use that. */
14857 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14858 /* If this candidate is a glyph created for the
14859 terminating newline of a line, and point is on that
14860 newline, it wins because it's an exact match. */
14861 || (!row
->continued_p
14862 && INTEGERP (glyph
->object
)
14863 && glyph
->charpos
== 0
14864 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14865 /* Otherwise, keep the candidate that comes from a row
14866 spanning less buffer positions. This may win when one or
14867 both candidate positions are on glyphs that came from
14868 display strings, for which we cannot compare buffer
14870 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14871 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14872 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14875 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14877 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14878 w
->cursor
.y
= row
->y
+ dy
;
14880 if (w
== XWINDOW (selected_window
))
14882 if (!row
->continued_p
14883 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14886 this_line_buffer
= XBUFFER (w
->contents
);
14888 CHARPOS (this_line_start_pos
)
14889 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14890 BYTEPOS (this_line_start_pos
)
14891 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14893 CHARPOS (this_line_end_pos
)
14894 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14895 BYTEPOS (this_line_end_pos
)
14896 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14898 this_line_y
= w
->cursor
.y
;
14899 this_line_pixel_height
= row
->height
;
14900 this_line_vpos
= w
->cursor
.vpos
;
14901 this_line_start_x
= row
->x
;
14904 CHARPOS (this_line_start_pos
) = 0;
14911 /* Run window scroll functions, if any, for WINDOW with new window
14912 start STARTP. Sets the window start of WINDOW to that position.
14914 We assume that the window's buffer is really current. */
14916 static struct text_pos
14917 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14919 struct window
*w
= XWINDOW (window
);
14920 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14922 eassert (current_buffer
== XBUFFER (w
->contents
));
14924 if (!NILP (Vwindow_scroll_functions
))
14926 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14927 make_number (CHARPOS (startp
)));
14928 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14929 /* In case the hook functions switch buffers. */
14930 set_buffer_internal (XBUFFER (w
->contents
));
14937 /* Make sure the line containing the cursor is fully visible.
14938 A value of 1 means there is nothing to be done.
14939 (Either the line is fully visible, or it cannot be made so,
14940 or we cannot tell.)
14942 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14943 is higher than window.
14945 A value of 0 means the caller should do scrolling
14946 as if point had gone off the screen. */
14949 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14951 struct glyph_matrix
*matrix
;
14952 struct glyph_row
*row
;
14955 if (!make_cursor_line_fully_visible_p
)
14958 /* It's not always possible to find the cursor, e.g, when a window
14959 is full of overlay strings. Don't do anything in that case. */
14960 if (w
->cursor
.vpos
< 0)
14963 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14964 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14966 /* If the cursor row is not partially visible, there's nothing to do. */
14967 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14970 /* If the row the cursor is in is taller than the window's height,
14971 it's not clear what to do, so do nothing. */
14972 window_height
= window_box_height (w
);
14973 if (row
->height
>= window_height
)
14975 if (!force_p
|| MINI_WINDOW_P (w
)
14976 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14983 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14984 non-zero means only WINDOW is redisplayed in redisplay_internal.
14985 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14986 in redisplay_window to bring a partially visible line into view in
14987 the case that only the cursor has moved.
14989 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14990 last screen line's vertical height extends past the end of the screen.
14994 1 if scrolling succeeded
14996 0 if scrolling didn't find point.
14998 -1 if new fonts have been loaded so that we must interrupt
14999 redisplay, adjust glyph matrices, and try again. */
15005 SCROLLING_NEED_LARGER_MATRICES
15008 /* If scroll-conservatively is more than this, never recenter.
15010 If you change this, don't forget to update the doc string of
15011 `scroll-conservatively' and the Emacs manual. */
15012 #define SCROLL_LIMIT 100
15015 try_scrolling (Lisp_Object window
, int just_this_one_p
,
15016 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15017 int temp_scroll_step
, int last_line_misfit
)
15019 struct window
*w
= XWINDOW (window
);
15020 struct frame
*f
= XFRAME (w
->frame
);
15021 struct text_pos pos
, startp
;
15023 int this_scroll_margin
, scroll_max
, rc
, height
;
15024 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
15025 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
15026 Lisp_Object aggressive
;
15027 /* We will never try scrolling more than this number of lines. */
15028 int scroll_limit
= SCROLL_LIMIT
;
15029 int frame_line_height
= default_line_pixel_height (w
);
15030 int window_total_lines
15031 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15034 debug_method_add (w
, "try_scrolling");
15037 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15039 /* Compute scroll margin height in pixels. We scroll when point is
15040 within this distance from the top or bottom of the window. */
15041 if (scroll_margin
> 0)
15042 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15043 * frame_line_height
;
15045 this_scroll_margin
= 0;
15047 /* Force arg_scroll_conservatively to have a reasonable value, to
15048 avoid scrolling too far away with slow move_it_* functions. Note
15049 that the user can supply scroll-conservatively equal to
15050 `most-positive-fixnum', which can be larger than INT_MAX. */
15051 if (arg_scroll_conservatively
> scroll_limit
)
15053 arg_scroll_conservatively
= scroll_limit
+ 1;
15054 scroll_max
= scroll_limit
* frame_line_height
;
15056 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15057 /* Compute how much we should try to scroll maximally to bring
15058 point into view. */
15059 scroll_max
= (max (scroll_step
,
15060 max (arg_scroll_conservatively
, temp_scroll_step
))
15061 * frame_line_height
);
15062 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15063 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15064 /* We're trying to scroll because of aggressive scrolling but no
15065 scroll_step is set. Choose an arbitrary one. */
15066 scroll_max
= 10 * frame_line_height
;
15072 /* Decide whether to scroll down. */
15073 if (PT
> CHARPOS (startp
))
15075 int scroll_margin_y
;
15077 /* Compute the pixel ypos of the scroll margin, then move IT to
15078 either that ypos or PT, whichever comes first. */
15079 start_display (&it
, w
, startp
);
15080 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15081 - frame_line_height
* extra_scroll_margin_lines
;
15082 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15083 (MOVE_TO_POS
| MOVE_TO_Y
));
15085 if (PT
> CHARPOS (it
.current
.pos
))
15087 int y0
= line_bottom_y (&it
);
15088 /* Compute how many pixels below window bottom to stop searching
15089 for PT. This avoids costly search for PT that is far away if
15090 the user limited scrolling by a small number of lines, but
15091 always finds PT if scroll_conservatively is set to a large
15092 number, such as most-positive-fixnum. */
15093 int slack
= max (scroll_max
, 10 * frame_line_height
);
15094 int y_to_move
= it
.last_visible_y
+ slack
;
15096 /* Compute the distance from the scroll margin to PT or to
15097 the scroll limit, whichever comes first. This should
15098 include the height of the cursor line, to make that line
15100 move_it_to (&it
, PT
, -1, y_to_move
,
15101 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15102 dy
= line_bottom_y (&it
) - y0
;
15104 if (dy
> scroll_max
)
15105 return SCROLLING_FAILED
;
15114 /* Point is in or below the bottom scroll margin, so move the
15115 window start down. If scrolling conservatively, move it just
15116 enough down to make point visible. If scroll_step is set,
15117 move it down by scroll_step. */
15118 if (arg_scroll_conservatively
)
15120 = min (max (dy
, frame_line_height
),
15121 frame_line_height
* arg_scroll_conservatively
);
15122 else if (scroll_step
|| temp_scroll_step
)
15123 amount_to_scroll
= scroll_max
;
15126 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15127 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15128 if (NUMBERP (aggressive
))
15130 double float_amount
= XFLOATINT (aggressive
) * height
;
15131 int aggressive_scroll
= float_amount
;
15132 if (aggressive_scroll
== 0 && float_amount
> 0)
15133 aggressive_scroll
= 1;
15134 /* Don't let point enter the scroll margin near top of
15135 the window. This could happen if the value of
15136 scroll_up_aggressively is too large and there are
15137 non-zero margins, because scroll_up_aggressively
15138 means put point that fraction of window height
15139 _from_the_bottom_margin_. */
15140 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15141 aggressive_scroll
= height
- 2*this_scroll_margin
;
15142 amount_to_scroll
= dy
+ aggressive_scroll
;
15146 if (amount_to_scroll
<= 0)
15147 return SCROLLING_FAILED
;
15149 start_display (&it
, w
, startp
);
15150 if (arg_scroll_conservatively
<= scroll_limit
)
15151 move_it_vertically (&it
, amount_to_scroll
);
15154 /* Extra precision for users who set scroll-conservatively
15155 to a large number: make sure the amount we scroll
15156 the window start is never less than amount_to_scroll,
15157 which was computed as distance from window bottom to
15158 point. This matters when lines at window top and lines
15159 below window bottom have different height. */
15161 void *it1data
= NULL
;
15162 /* We use a temporary it1 because line_bottom_y can modify
15163 its argument, if it moves one line down; see there. */
15166 SAVE_IT (it1
, it
, it1data
);
15167 start_y
= line_bottom_y (&it1
);
15169 RESTORE_IT (&it
, &it
, it1data
);
15170 move_it_by_lines (&it
, 1);
15171 SAVE_IT (it1
, it
, it1data
);
15172 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15175 /* If STARTP is unchanged, move it down another screen line. */
15176 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
15177 move_it_by_lines (&it
, 1);
15178 startp
= it
.current
.pos
;
15182 struct text_pos scroll_margin_pos
= startp
;
15185 /* See if point is inside the scroll margin at the top of the
15187 if (this_scroll_margin
)
15191 start_display (&it
, w
, startp
);
15192 y_start
= it
.current_y
;
15193 move_it_vertically (&it
, this_scroll_margin
);
15194 scroll_margin_pos
= it
.current
.pos
;
15195 /* If we didn't move enough before hitting ZV, request
15196 additional amount of scroll, to move point out of the
15198 if (IT_CHARPOS (it
) == ZV
15199 && it
.current_y
- y_start
< this_scroll_margin
)
15200 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15203 if (PT
< CHARPOS (scroll_margin_pos
))
15205 /* Point is in the scroll margin at the top of the window or
15206 above what is displayed in the window. */
15209 /* Compute the vertical distance from PT to the scroll
15210 margin position. Move as far as scroll_max allows, or
15211 one screenful, or 10 screen lines, whichever is largest.
15212 Give up if distance is greater than scroll_max or if we
15213 didn't reach the scroll margin position. */
15214 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15215 start_display (&it
, w
, pos
);
15217 y_to_move
= max (it
.last_visible_y
,
15218 max (scroll_max
, 10 * frame_line_height
));
15219 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15221 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15222 dy
= it
.current_y
- y0
;
15223 if (dy
> scroll_max
15224 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15225 return SCROLLING_FAILED
;
15227 /* Additional scroll for when ZV was too close to point. */
15230 /* Compute new window start. */
15231 start_display (&it
, w
, startp
);
15233 if (arg_scroll_conservatively
)
15234 amount_to_scroll
= max (dy
, frame_line_height
*
15235 max (scroll_step
, temp_scroll_step
));
15236 else if (scroll_step
|| temp_scroll_step
)
15237 amount_to_scroll
= scroll_max
;
15240 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15241 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15242 if (NUMBERP (aggressive
))
15244 double float_amount
= XFLOATINT (aggressive
) * height
;
15245 int aggressive_scroll
= float_amount
;
15246 if (aggressive_scroll
== 0 && float_amount
> 0)
15247 aggressive_scroll
= 1;
15248 /* Don't let point enter the scroll margin near
15249 bottom of the window, if the value of
15250 scroll_down_aggressively happens to be too
15252 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15253 aggressive_scroll
= height
- 2*this_scroll_margin
;
15254 amount_to_scroll
= dy
+ aggressive_scroll
;
15258 if (amount_to_scroll
<= 0)
15259 return SCROLLING_FAILED
;
15261 move_it_vertically_backward (&it
, amount_to_scroll
);
15262 startp
= it
.current
.pos
;
15266 /* Run window scroll functions. */
15267 startp
= run_window_scroll_functions (window
, startp
);
15269 /* Display the window. Give up if new fonts are loaded, or if point
15271 if (!try_window (window
, startp
, 0))
15272 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15273 else if (w
->cursor
.vpos
< 0)
15275 clear_glyph_matrix (w
->desired_matrix
);
15276 rc
= SCROLLING_FAILED
;
15280 /* Maybe forget recorded base line for line number display. */
15281 if (!just_this_one_p
15282 || current_buffer
->clip_changed
15283 || BEG_UNCHANGED
< CHARPOS (startp
))
15284 w
->base_line_number
= 0;
15286 /* If cursor ends up on a partially visible line,
15287 treat that as being off the bottom of the screen. */
15288 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
15289 /* It's possible that the cursor is on the first line of the
15290 buffer, which is partially obscured due to a vscroll
15291 (Bug#7537). In that case, avoid looping forever. */
15292 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15294 clear_glyph_matrix (w
->desired_matrix
);
15295 ++extra_scroll_margin_lines
;
15298 rc
= SCROLLING_SUCCESS
;
15305 /* Compute a suitable window start for window W if display of W starts
15306 on a continuation line. Value is non-zero if a new window start
15309 The new window start will be computed, based on W's width, starting
15310 from the start of the continued line. It is the start of the
15311 screen line with the minimum distance from the old start W->start. */
15314 compute_window_start_on_continuation_line (struct window
*w
)
15316 struct text_pos pos
, start_pos
;
15317 int window_start_changed_p
= 0;
15319 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15321 /* If window start is on a continuation line... Window start may be
15322 < BEGV in case there's invisible text at the start of the
15323 buffer (M-x rmail, for example). */
15324 if (CHARPOS (start_pos
) > BEGV
15325 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15328 struct glyph_row
*row
;
15330 /* Handle the case that the window start is out of range. */
15331 if (CHARPOS (start_pos
) < BEGV
)
15332 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15333 else if (CHARPOS (start_pos
) > ZV
)
15334 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15336 /* Find the start of the continued line. This should be fast
15337 because find_newline is fast (newline cache). */
15338 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
15339 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15340 row
, DEFAULT_FACE_ID
);
15341 reseat_at_previous_visible_line_start (&it
);
15343 /* If the line start is "too far" away from the window start,
15344 say it takes too much time to compute a new window start. */
15345 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15346 /* PXW: Do we need upper bounds here? */
15347 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15349 int min_distance
, distance
;
15351 /* Move forward by display lines to find the new window
15352 start. If window width was enlarged, the new start can
15353 be expected to be > the old start. If window width was
15354 decreased, the new window start will be < the old start.
15355 So, we're looking for the display line start with the
15356 minimum distance from the old window start. */
15357 pos
= it
.current
.pos
;
15358 min_distance
= INFINITY
;
15359 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15360 distance
< min_distance
)
15362 min_distance
= distance
;
15363 pos
= it
.current
.pos
;
15364 if (it
.line_wrap
== WORD_WRAP
)
15366 /* Under WORD_WRAP, move_it_by_lines is likely to
15367 overshoot and stop not at the first, but the
15368 second character from the left margin. So in
15369 that case, we need a more tight control on the X
15370 coordinate of the iterator than move_it_by_lines
15371 promises in its contract. The method is to first
15372 go to the last (rightmost) visible character of a
15373 line, then move to the leftmost character on the
15374 next line in a separate call. */
15375 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15376 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15377 move_it_to (&it
, ZV
, 0,
15378 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15379 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15382 move_it_by_lines (&it
, 1);
15385 /* Set the window start there. */
15386 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15387 window_start_changed_p
= 1;
15391 return window_start_changed_p
;
15395 /* Try cursor movement in case text has not changed in window WINDOW,
15396 with window start STARTP. Value is
15398 CURSOR_MOVEMENT_SUCCESS if successful
15400 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15402 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15403 display. *SCROLL_STEP is set to 1, under certain circumstances, if
15404 we want to scroll as if scroll-step were set to 1. See the code.
15406 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15407 which case we have to abort this redisplay, and adjust matrices
15412 CURSOR_MOVEMENT_SUCCESS
,
15413 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15414 CURSOR_MOVEMENT_MUST_SCROLL
,
15415 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15419 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
15421 struct window
*w
= XWINDOW (window
);
15422 struct frame
*f
= XFRAME (w
->frame
);
15423 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15426 if (inhibit_try_cursor_movement
)
15430 /* Previously, there was a check for Lisp integer in the
15431 if-statement below. Now, this field is converted to
15432 ptrdiff_t, thus zero means invalid position in a buffer. */
15433 eassert (w
->last_point
> 0);
15434 /* Likewise there was a check whether window_end_vpos is nil or larger
15435 than the window. Now window_end_vpos is int and so never nil, but
15436 let's leave eassert to check whether it fits in the window. */
15437 eassert (w
->window_end_vpos
< w
->current_matrix
->nrows
);
15439 /* Handle case where text has not changed, only point, and it has
15440 not moved off the frame. */
15441 if (/* Point may be in this window. */
15442 PT
>= CHARPOS (startp
)
15443 /* Selective display hasn't changed. */
15444 && !current_buffer
->clip_changed
15445 /* Function force-mode-line-update is used to force a thorough
15446 redisplay. It sets either windows_or_buffers_changed or
15447 update_mode_lines. So don't take a shortcut here for these
15449 && !update_mode_lines
15450 && !windows_or_buffers_changed
15451 && !f
->cursor_type_changed
15452 && NILP (Vshow_trailing_whitespace
)
15453 /* This code is not used for mini-buffer for the sake of the case
15454 of redisplaying to replace an echo area message; since in
15455 that case the mini-buffer contents per se are usually
15456 unchanged. This code is of no real use in the mini-buffer
15457 since the handling of this_line_start_pos, etc., in redisplay
15458 handles the same cases. */
15459 && !EQ (window
, minibuf_window
)
15460 && (FRAME_WINDOW_P (f
)
15461 || !overlay_arrow_in_current_buffer_p ()))
15463 int this_scroll_margin
, top_scroll_margin
;
15464 struct glyph_row
*row
= NULL
;
15465 int frame_line_height
= default_line_pixel_height (w
);
15466 int window_total_lines
15467 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15470 debug_method_add (w
, "cursor movement");
15473 /* Scroll if point within this distance from the top or bottom
15474 of the window. This is a pixel value. */
15475 if (scroll_margin
> 0)
15477 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15478 this_scroll_margin
*= frame_line_height
;
15481 this_scroll_margin
= 0;
15483 top_scroll_margin
= this_scroll_margin
;
15484 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15485 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15487 /* Start with the row the cursor was displayed during the last
15488 not paused redisplay. Give up if that row is not valid. */
15489 if (w
->last_cursor_vpos
< 0
15490 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15491 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15494 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15495 if (row
->mode_line_p
)
15497 if (!row
->enabled_p
)
15498 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15501 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15503 int scroll_p
= 0, must_scroll
= 0;
15504 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15506 if (PT
> w
->last_point
)
15508 /* Point has moved forward. */
15509 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15510 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15512 eassert (row
->enabled_p
);
15516 /* If the end position of a row equals the start
15517 position of the next row, and PT is at that position,
15518 we would rather display cursor in the next line. */
15519 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15520 && MATRIX_ROW_END_CHARPOS (row
) == PT
15521 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15522 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15523 && !cursor_row_p (row
))
15526 /* If within the scroll margin, scroll. Note that
15527 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15528 the next line would be drawn, and that
15529 this_scroll_margin can be zero. */
15530 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15531 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15532 /* Line is completely visible last line in window
15533 and PT is to be set in the next line. */
15534 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15535 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15536 && !row
->ends_at_zv_p
15537 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15540 else if (PT
< w
->last_point
)
15542 /* Cursor has to be moved backward. Note that PT >=
15543 CHARPOS (startp) because of the outer if-statement. */
15544 while (!row
->mode_line_p
15545 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15546 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15547 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15548 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15549 row
> w
->current_matrix
->rows
15550 && (row
-1)->ends_in_newline_from_string_p
))))
15551 && (row
->y
> top_scroll_margin
15552 || CHARPOS (startp
) == BEGV
))
15554 eassert (row
->enabled_p
);
15558 /* Consider the following case: Window starts at BEGV,
15559 there is invisible, intangible text at BEGV, so that
15560 display starts at some point START > BEGV. It can
15561 happen that we are called with PT somewhere between
15562 BEGV and START. Try to handle that case. */
15563 if (row
< w
->current_matrix
->rows
15564 || row
->mode_line_p
)
15566 row
= w
->current_matrix
->rows
;
15567 if (row
->mode_line_p
)
15571 /* Due to newlines in overlay strings, we may have to
15572 skip forward over overlay strings. */
15573 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15574 && MATRIX_ROW_END_CHARPOS (row
) == PT
15575 && !cursor_row_p (row
))
15578 /* If within the scroll margin, scroll. */
15579 if (row
->y
< top_scroll_margin
15580 && CHARPOS (startp
) != BEGV
)
15585 /* Cursor did not move. So don't scroll even if cursor line
15586 is partially visible, as it was so before. */
15587 rc
= CURSOR_MOVEMENT_SUCCESS
;
15590 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15591 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15593 /* if PT is not in the glyph row, give up. */
15594 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15597 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15598 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15600 struct glyph_row
*row1
;
15602 /* If rows are bidi-reordered and point moved, back up
15603 until we find a row that does not belong to a
15604 continuation line. This is because we must consider
15605 all rows of a continued line as candidates for the
15606 new cursor positioning, since row start and end
15607 positions change non-linearly with vertical position
15609 /* FIXME: Revisit this when glyph ``spilling'' in
15610 continuation lines' rows is implemented for
15611 bidi-reordered rows. */
15612 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15613 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15616 /* If we hit the beginning of the displayed portion
15617 without finding the first row of a continued
15621 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15624 eassert (row
->enabled_p
);
15629 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15630 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15631 /* Make sure this isn't a header line by any chance, since
15632 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15633 && !row
->mode_line_p
15634 && make_cursor_line_fully_visible_p
)
15636 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15637 && !row
->ends_at_zv_p
15638 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15639 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15640 else if (row
->height
> window_box_height (w
))
15642 /* If we end up in a partially visible line, let's
15643 make it fully visible, except when it's taller
15644 than the window, in which case we can't do much
15647 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15651 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15652 if (!cursor_row_fully_visible_p (w
, 0, 1))
15653 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15655 rc
= CURSOR_MOVEMENT_SUCCESS
;
15659 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15660 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15661 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15663 /* With bidi-reordered rows, there could be more than
15664 one candidate row whose start and end positions
15665 occlude point. We need to let set_cursor_from_row
15666 find the best candidate. */
15667 /* FIXME: Revisit this when glyph ``spilling'' in
15668 continuation lines' rows is implemented for
15669 bidi-reordered rows. */
15674 int at_zv_p
= 0, exact_match_p
= 0;
15676 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15677 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15678 && cursor_row_p (row
))
15679 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15681 /* As soon as we've found the exact match for point,
15682 or the first suitable row whose ends_at_zv_p flag
15683 is set, we are done. */
15686 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15687 w
->cursor
.vpos
)->ends_at_zv_p
;
15689 && w
->cursor
.hpos
>= 0
15690 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15693 struct glyph_row
*candidate
=
15694 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15696 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15697 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15700 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15701 || (INTEGERP (g
->object
)
15702 && (g
->charpos
== PT
15703 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15705 if (at_zv_p
|| exact_match_p
)
15707 rc
= CURSOR_MOVEMENT_SUCCESS
;
15711 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15715 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15716 || row
->continued_p
)
15717 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15718 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15719 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15720 /* If we didn't find any candidate rows, or exited the
15721 loop before all the candidates were examined, signal
15722 to the caller that this method failed. */
15723 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15725 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15726 && !row
->continued_p
))
15727 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15729 rc
= CURSOR_MOVEMENT_SUCCESS
;
15735 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15737 rc
= CURSOR_MOVEMENT_SUCCESS
;
15742 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15743 && MATRIX_ROW_START_CHARPOS (row
) == PT
15744 && cursor_row_p (row
));
15752 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15756 set_vertical_scroll_bar (struct window
*w
)
15758 ptrdiff_t start
, end
, whole
;
15760 /* Calculate the start and end positions for the current window.
15761 At some point, it would be nice to choose between scrollbars
15762 which reflect the whole buffer size, with special markers
15763 indicating narrowing, and scrollbars which reflect only the
15766 Note that mini-buffers sometimes aren't displaying any text. */
15767 if (!MINI_WINDOW_P (w
)
15768 || (w
== XWINDOW (minibuf_window
)
15769 && NILP (echo_area_buffer
[0])))
15771 struct buffer
*buf
= XBUFFER (w
->contents
);
15772 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15773 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15774 /* I don't think this is guaranteed to be right. For the
15775 moment, we'll pretend it is. */
15776 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15780 if (whole
< (end
- start
))
15781 whole
= end
- start
;
15784 start
= end
= whole
= 0;
15786 /* Indicate what this scroll bar ought to be displaying now. */
15787 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15788 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15789 (w
, end
- start
, whole
, start
);
15793 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15794 selected_window is redisplayed.
15796 We can return without actually redisplaying the window if fonts has been
15797 changed on window's frame. In that case, redisplay_internal will retry.
15799 As one of the important parts of redisplaying a window, we need to
15800 decide whether the previous window-start position (stored in the
15801 window's w->start marker position) is still valid, and if it isn't,
15802 recompute it. Some details about that:
15804 . The previous window-start could be in a continuation line, in
15805 which case we need to recompute it when the window width
15806 changes. See compute_window_start_on_continuation_line and its
15809 . The text that changed since last redisplay could include the
15810 previous window-start position. In that case, we try to salvage
15811 what we can from the current glyph matrix by calling
15812 try_scrolling, which see.
15814 . Some Emacs command could force us to use a specific window-start
15815 position by setting the window's force_start flag, or gently
15816 propose doing that by setting the window's optional_new_start
15817 flag. In these cases, we try using the specified start point if
15818 that succeeds (i.e. the window desired matrix is successfully
15819 recomputed, and point location is within the window). In case
15820 of optional_new_start, we first check if the specified start
15821 position is feasible, i.e. if it will allow point to be
15822 displayed in the window. If using the specified start point
15823 fails, e.g., if new fonts are needed to be loaded, we abort the
15824 redisplay cycle and leave it up to the next cycle to figure out
15827 . Note that the window's force_start flag is sometimes set by
15828 redisplay itself, when it decides that the previous window start
15829 point is fine and should be kept. Search for "goto force_start"
15830 below to see the details. Like the values of window-start
15831 specified outside of redisplay, these internally-deduced values
15832 are tested for feasibility, and ignored if found to be
15835 . Note that the function try_window, used to completely redisplay
15836 a window, accepts the window's start point as its argument.
15837 This is used several times in the redisplay code to control
15838 where the window start will be, according to user options such
15839 as scroll-conservatively, and also to ensure the screen line
15840 showing point will be fully (as opposed to partially) visible on
15844 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15846 struct window
*w
= XWINDOW (window
);
15847 struct frame
*f
= XFRAME (w
->frame
);
15848 struct buffer
*buffer
= XBUFFER (w
->contents
);
15849 struct buffer
*old
= current_buffer
;
15850 struct text_pos lpoint
, opoint
, startp
;
15851 int update_mode_line
;
15854 /* Record it now because it's overwritten. */
15855 bool current_matrix_up_to_date_p
= false;
15856 bool used_current_matrix_p
= false;
15857 /* This is less strict than current_matrix_up_to_date_p.
15858 It indicates that the buffer contents and narrowing are unchanged. */
15859 bool buffer_unchanged_p
= false;
15860 int temp_scroll_step
= 0;
15861 ptrdiff_t count
= SPECPDL_INDEX ();
15863 int centering_position
= -1;
15864 int last_line_misfit
= 0;
15865 ptrdiff_t beg_unchanged
, end_unchanged
;
15866 int frame_line_height
;
15868 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15872 *w
->desired_matrix
->method
= 0;
15875 if (!just_this_one_p
15876 && REDISPLAY_SOME_P ()
15879 && !buffer
->text
->redisplay
15880 && BUF_PT (buffer
) == w
->last_point
)
15883 /* Make sure that both W's markers are valid. */
15884 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15885 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15887 /* We come here again if we need to run window-text-change-functions
15890 reconsider_clip_changes (w
);
15891 frame_line_height
= default_line_pixel_height (w
);
15893 /* Has the mode line to be updated? */
15894 update_mode_line
= (w
->update_mode_line
15895 || update_mode_lines
15896 || buffer
->clip_changed
15897 || buffer
->prevent_redisplay_optimizations_p
);
15899 if (!just_this_one_p
)
15900 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15901 cleverly elsewhere. */
15902 w
->must_be_updated_p
= true;
15904 if (MINI_WINDOW_P (w
))
15906 if (w
== XWINDOW (echo_area_window
)
15907 && !NILP (echo_area_buffer
[0]))
15909 if (update_mode_line
)
15910 /* We may have to update a tty frame's menu bar or a
15911 tool-bar. Example `M-x C-h C-h C-g'. */
15912 goto finish_menu_bars
;
15914 /* We've already displayed the echo area glyphs in this window. */
15915 goto finish_scroll_bars
;
15917 else if ((w
!= XWINDOW (minibuf_window
)
15918 || minibuf_level
== 0)
15919 /* When buffer is nonempty, redisplay window normally. */
15920 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
15921 /* Quail displays non-mini buffers in minibuffer window.
15922 In that case, redisplay the window normally. */
15923 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
15925 /* W is a mini-buffer window, but it's not active, so clear
15927 int yb
= window_text_bottom_y (w
);
15928 struct glyph_row
*row
;
15931 for (y
= 0, row
= w
->desired_matrix
->rows
;
15933 y
+= row
->height
, ++row
)
15934 blank_row (w
, row
, y
);
15935 goto finish_scroll_bars
;
15938 clear_glyph_matrix (w
->desired_matrix
);
15941 /* Otherwise set up data on this window; select its buffer and point
15943 /* Really select the buffer, for the sake of buffer-local
15945 set_buffer_internal_1 (XBUFFER (w
->contents
));
15947 current_matrix_up_to_date_p
15948 = (w
->window_end_valid
15949 && !current_buffer
->clip_changed
15950 && !current_buffer
->prevent_redisplay_optimizations_p
15951 && !window_outdated (w
));
15953 /* Run the window-text-change-functions
15954 if it is possible that the text on the screen has changed
15955 (either due to modification of the text, or any other reason). */
15956 if (!current_matrix_up_to_date_p
15957 && !NILP (Vwindow_text_change_functions
))
15959 safe_run_hooks (Qwindow_text_change_functions
);
15963 beg_unchanged
= BEG_UNCHANGED
;
15964 end_unchanged
= END_UNCHANGED
;
15966 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15968 specbind (Qinhibit_point_motion_hooks
, Qt
);
15971 = (w
->window_end_valid
15972 && !current_buffer
->clip_changed
15973 && !window_outdated (w
));
15975 /* When windows_or_buffers_changed is non-zero, we can't rely
15976 on the window end being valid, so set it to zero there. */
15977 if (windows_or_buffers_changed
)
15979 /* If window starts on a continuation line, maybe adjust the
15980 window start in case the window's width changed. */
15981 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15982 compute_window_start_on_continuation_line (w
);
15984 w
->window_end_valid
= false;
15985 /* If so, we also can't rely on current matrix
15986 and should not fool try_cursor_movement below. */
15987 current_matrix_up_to_date_p
= false;
15990 /* Some sanity checks. */
15991 CHECK_WINDOW_END (w
);
15992 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15994 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15997 if (mode_line_update_needed (w
))
15998 update_mode_line
= 1;
16000 /* Point refers normally to the selected window. For any other
16001 window, set up appropriate value. */
16002 if (!EQ (window
, selected_window
))
16004 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16005 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16009 new_pt_byte
= BEGV_BYTE
;
16010 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16012 else if (new_pt
> (ZV
- 1))
16015 new_pt_byte
= ZV_BYTE
;
16016 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16019 /* We don't use SET_PT so that the point-motion hooks don't run. */
16020 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16023 /* If any of the character widths specified in the display table
16024 have changed, invalidate the width run cache. It's true that
16025 this may be a bit late to catch such changes, but the rest of
16026 redisplay goes (non-fatally) haywire when the display table is
16027 changed, so why should we worry about doing any better? */
16028 if (current_buffer
->width_run_cache
16029 || (current_buffer
->base_buffer
16030 && current_buffer
->base_buffer
->width_run_cache
))
16032 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16034 if (! disptab_matches_widthtab
16035 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16037 struct buffer
*buf
= current_buffer
;
16039 if (buf
->base_buffer
)
16040 buf
= buf
->base_buffer
;
16041 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16042 recompute_width_table (current_buffer
, disptab
);
16046 /* If window-start is screwed up, choose a new one. */
16047 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16050 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16052 /* If someone specified a new starting point but did not insist,
16053 check whether it can be used. */
16054 if (w
->optional_new_start
16055 && CHARPOS (startp
) >= BEGV
16056 && CHARPOS (startp
) <= ZV
)
16058 w
->optional_new_start
= 0;
16059 start_display (&it
, w
, startp
);
16060 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16061 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16062 if (IT_CHARPOS (it
) == PT
)
16063 w
->force_start
= 1;
16064 /* IT may overshoot PT if text at PT is invisible. */
16065 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
16066 w
->force_start
= 1;
16071 /* Handle case where place to start displaying has been specified,
16072 unless the specified location is outside the accessible range. */
16073 if (w
->force_start
|| window_frozen_p (w
))
16075 /* We set this later on if we have to adjust point. */
16078 w
->force_start
= 0;
16080 w
->window_end_valid
= 0;
16082 /* Forget any recorded base line for line number display. */
16083 if (!buffer_unchanged_p
)
16084 w
->base_line_number
= 0;
16086 /* Redisplay the mode line. Select the buffer properly for that.
16087 Also, run the hook window-scroll-functions
16088 because we have scrolled. */
16089 /* Note, we do this after clearing force_start because
16090 if there's an error, it is better to forget about force_start
16091 than to get into an infinite loop calling the hook functions
16092 and having them get more errors. */
16093 if (!update_mode_line
16094 || ! NILP (Vwindow_scroll_functions
))
16096 update_mode_line
= 1;
16097 w
->update_mode_line
= 1;
16098 startp
= run_window_scroll_functions (window
, startp
);
16101 if (CHARPOS (startp
) < BEGV
)
16102 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16103 else if (CHARPOS (startp
) > ZV
)
16104 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16106 /* Redisplay, then check if cursor has been set during the
16107 redisplay. Give up if new fonts were loaded. */
16108 /* We used to issue a CHECK_MARGINS argument to try_window here,
16109 but this causes scrolling to fail when point begins inside
16110 the scroll margin (bug#148) -- cyd */
16111 if (!try_window (window
, startp
, 0))
16113 w
->force_start
= 1;
16114 clear_glyph_matrix (w
->desired_matrix
);
16115 goto need_larger_matrices
;
16118 if (w
->cursor
.vpos
< 0 && !window_frozen_p (w
))
16120 /* If point does not appear, try to move point so it does
16121 appear. The desired matrix has been built above, so we
16122 can use it here. */
16123 new_vpos
= window_box_height (w
) / 2;
16126 if (!cursor_row_fully_visible_p (w
, 0, 0))
16128 /* Point does appear, but on a line partly visible at end of window.
16129 Move it back to a fully-visible line. */
16130 new_vpos
= window_box_height (w
);
16131 /* But if window_box_height suggests a Y coordinate that is
16132 not less than we already have, that line will clearly not
16133 be fully visible, so give up and scroll the display.
16134 This can happen when the default face uses a font whose
16135 dimensions are different from the frame's default
16137 if (new_vpos
>= w
->cursor
.y
)
16139 w
->cursor
.vpos
= -1;
16140 clear_glyph_matrix (w
->desired_matrix
);
16141 goto try_to_scroll
;
16144 else if (w
->cursor
.vpos
>= 0)
16146 /* Some people insist on not letting point enter the scroll
16147 margin, even though this part handles windows that didn't
16149 int window_total_lines
16150 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16151 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16152 int pixel_margin
= margin
* frame_line_height
;
16153 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16155 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16156 below, which finds the row to move point to, advances by
16157 the Y coordinate of the _next_ row, see the definition of
16158 MATRIX_ROW_BOTTOM_Y. */
16159 if (w
->cursor
.vpos
< margin
+ header_line
)
16161 w
->cursor
.vpos
= -1;
16162 clear_glyph_matrix (w
->desired_matrix
);
16163 goto try_to_scroll
;
16167 int window_height
= window_box_height (w
);
16170 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16171 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16173 w
->cursor
.vpos
= -1;
16174 clear_glyph_matrix (w
->desired_matrix
);
16175 goto try_to_scroll
;
16180 /* If we need to move point for either of the above reasons,
16181 now actually do it. */
16184 struct glyph_row
*row
;
16186 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16187 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16190 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16191 MATRIX_ROW_START_BYTEPOS (row
));
16193 if (w
!= XWINDOW (selected_window
))
16194 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16195 else if (current_buffer
== old
)
16196 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16198 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16200 /* If we are highlighting the region, then we just changed
16201 the region, so redisplay to show it. */
16202 /* FIXME: We need to (re)run pre-redisplay-function! */
16203 /* if (markpos_of_region () >= 0)
16205 clear_glyph_matrix (w->desired_matrix);
16206 if (!try_window (window, startp, 0))
16207 goto need_larger_matrices;
16213 debug_method_add (w
, "forced window start");
16218 /* Handle case where text has not changed, only point, and it has
16219 not moved off the frame, and we are not retrying after hscroll.
16220 (current_matrix_up_to_date_p is nonzero when retrying.) */
16221 if (current_matrix_up_to_date_p
16222 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16223 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16227 case CURSOR_MOVEMENT_SUCCESS
:
16228 used_current_matrix_p
= 1;
16231 case CURSOR_MOVEMENT_MUST_SCROLL
:
16232 goto try_to_scroll
;
16238 /* If current starting point was originally the beginning of a line
16239 but no longer is, find a new starting point. */
16240 else if (w
->start_at_line_beg
16241 && !(CHARPOS (startp
) <= BEGV
16242 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16245 debug_method_add (w
, "recenter 1");
16250 /* Try scrolling with try_window_id. Value is > 0 if update has
16251 been done, it is -1 if we know that the same window start will
16252 not work. It is 0 if unsuccessful for some other reason. */
16253 else if ((tem
= try_window_id (w
)) != 0)
16256 debug_method_add (w
, "try_window_id %d", tem
);
16259 if (f
->fonts_changed
)
16260 goto need_larger_matrices
;
16264 /* Otherwise try_window_id has returned -1 which means that we
16265 don't want the alternative below this comment to execute. */
16267 else if (CHARPOS (startp
) >= BEGV
16268 && CHARPOS (startp
) <= ZV
16269 && PT
>= CHARPOS (startp
)
16270 && (CHARPOS (startp
) < ZV
16271 /* Avoid starting at end of buffer. */
16272 || CHARPOS (startp
) == BEGV
16273 || !window_outdated (w
)))
16275 int d1
, d2
, d3
, d4
, d5
, d6
;
16277 /* If first window line is a continuation line, and window start
16278 is inside the modified region, but the first change is before
16279 current window start, we must select a new window start.
16281 However, if this is the result of a down-mouse event (e.g. by
16282 extending the mouse-drag-overlay), we don't want to select a
16283 new window start, since that would change the position under
16284 the mouse, resulting in an unwanted mouse-movement rather
16285 than a simple mouse-click. */
16286 if (!w
->start_at_line_beg
16287 && NILP (do_mouse_tracking
)
16288 && CHARPOS (startp
) > BEGV
16289 && CHARPOS (startp
) > BEG
+ beg_unchanged
16290 && CHARPOS (startp
) <= Z
- end_unchanged
16291 /* Even if w->start_at_line_beg is nil, a new window may
16292 start at a line_beg, since that's how set_buffer_window
16293 sets it. So, we need to check the return value of
16294 compute_window_start_on_continuation_line. (See also
16296 && XMARKER (w
->start
)->buffer
== current_buffer
16297 && compute_window_start_on_continuation_line (w
)
16298 /* It doesn't make sense to force the window start like we
16299 do at label force_start if it is already known that point
16300 will not be visible in the resulting window, because
16301 doing so will move point from its correct position
16302 instead of scrolling the window to bring point into view.
16304 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
16306 w
->force_start
= 1;
16307 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16312 debug_method_add (w
, "same window start");
16315 /* Try to redisplay starting at same place as before.
16316 If point has not moved off frame, accept the results. */
16317 if (!current_matrix_up_to_date_p
16318 /* Don't use try_window_reusing_current_matrix in this case
16319 because a window scroll function can have changed the
16321 || !NILP (Vwindow_scroll_functions
)
16322 || MINI_WINDOW_P (w
)
16323 || !(used_current_matrix_p
16324 = try_window_reusing_current_matrix (w
)))
16326 IF_DEBUG (debug_method_add (w
, "1"));
16327 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16328 /* -1 means we need to scroll.
16329 0 means we need new matrices, but fonts_changed
16330 is set in that case, so we will detect it below. */
16331 goto try_to_scroll
;
16334 if (f
->fonts_changed
)
16335 goto need_larger_matrices
;
16337 if (w
->cursor
.vpos
>= 0)
16339 if (!just_this_one_p
16340 || current_buffer
->clip_changed
16341 || BEG_UNCHANGED
< CHARPOS (startp
))
16342 /* Forget any recorded base line for line number display. */
16343 w
->base_line_number
= 0;
16345 if (!cursor_row_fully_visible_p (w
, 1, 0))
16347 clear_glyph_matrix (w
->desired_matrix
);
16348 last_line_misfit
= 1;
16350 /* Drop through and scroll. */
16355 clear_glyph_matrix (w
->desired_matrix
);
16360 /* Redisplay the mode line. Select the buffer properly for that. */
16361 if (!update_mode_line
)
16363 update_mode_line
= 1;
16364 w
->update_mode_line
= 1;
16367 /* Try to scroll by specified few lines. */
16368 if ((scroll_conservatively
16369 || emacs_scroll_step
16370 || temp_scroll_step
16371 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16372 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16373 && CHARPOS (startp
) >= BEGV
16374 && CHARPOS (startp
) <= ZV
)
16376 /* The function returns -1 if new fonts were loaded, 1 if
16377 successful, 0 if not successful. */
16378 int ss
= try_scrolling (window
, just_this_one_p
,
16379 scroll_conservatively
,
16381 temp_scroll_step
, last_line_misfit
);
16384 case SCROLLING_SUCCESS
:
16387 case SCROLLING_NEED_LARGER_MATRICES
:
16388 goto need_larger_matrices
;
16390 case SCROLLING_FAILED
:
16398 /* Finally, just choose a place to start which positions point
16399 according to user preferences. */
16404 debug_method_add (w
, "recenter");
16407 /* Forget any previously recorded base line for line number display. */
16408 if (!buffer_unchanged_p
)
16409 w
->base_line_number
= 0;
16411 /* Determine the window start relative to point. */
16412 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16413 it
.current_y
= it
.last_visible_y
;
16414 if (centering_position
< 0)
16416 int window_total_lines
16417 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16420 ? min (scroll_margin
, window_total_lines
/ 4)
16422 ptrdiff_t margin_pos
= CHARPOS (startp
);
16423 Lisp_Object aggressive
;
16426 /* If there is a scroll margin at the top of the window, find
16427 its character position. */
16429 /* Cannot call start_display if startp is not in the
16430 accessible region of the buffer. This can happen when we
16431 have just switched to a different buffer and/or changed
16432 its restriction. In that case, startp is initialized to
16433 the character position 1 (BEGV) because we did not yet
16434 have chance to display the buffer even once. */
16435 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16438 void *it1data
= NULL
;
16440 SAVE_IT (it1
, it
, it1data
);
16441 start_display (&it1
, w
, startp
);
16442 move_it_vertically (&it1
, margin
* frame_line_height
);
16443 margin_pos
= IT_CHARPOS (it1
);
16444 RESTORE_IT (&it
, &it
, it1data
);
16446 scrolling_up
= PT
> margin_pos
;
16449 ? BVAR (current_buffer
, scroll_up_aggressively
)
16450 : BVAR (current_buffer
, scroll_down_aggressively
);
16452 if (!MINI_WINDOW_P (w
)
16453 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16457 /* Setting scroll-conservatively overrides
16458 scroll-*-aggressively. */
16459 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16461 double float_amount
= XFLOATINT (aggressive
);
16463 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16464 if (pt_offset
== 0 && float_amount
> 0)
16466 if (pt_offset
&& margin
> 0)
16469 /* Compute how much to move the window start backward from
16470 point so that point will be displayed where the user
16474 centering_position
= it
.last_visible_y
;
16476 centering_position
-= pt_offset
;
16477 centering_position
-=
16478 frame_line_height
* (1 + margin
+ (last_line_misfit
!= 0))
16479 + WINDOW_HEADER_LINE_HEIGHT (w
);
16480 /* Don't let point enter the scroll margin near top of
16482 if (centering_position
< margin
* frame_line_height
)
16483 centering_position
= margin
* frame_line_height
;
16486 centering_position
= margin
* frame_line_height
+ pt_offset
;
16489 /* Set the window start half the height of the window backward
16491 centering_position
= window_box_height (w
) / 2;
16493 move_it_vertically_backward (&it
, centering_position
);
16495 eassert (IT_CHARPOS (it
) >= BEGV
);
16497 /* The function move_it_vertically_backward may move over more
16498 than the specified y-distance. If it->w is small, e.g. a
16499 mini-buffer window, we may end up in front of the window's
16500 display area. Start displaying at the start of the line
16501 containing PT in this case. */
16502 if (it
.current_y
<= 0)
16504 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16505 move_it_vertically_backward (&it
, 0);
16509 it
.current_x
= it
.hpos
= 0;
16511 /* Set the window start position here explicitly, to avoid an
16512 infinite loop in case the functions in window-scroll-functions
16514 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16516 /* Run scroll hooks. */
16517 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16519 /* Redisplay the window. */
16520 if (!current_matrix_up_to_date_p
16521 || windows_or_buffers_changed
16522 || f
->cursor_type_changed
16523 /* Don't use try_window_reusing_current_matrix in this case
16524 because it can have changed the buffer. */
16525 || !NILP (Vwindow_scroll_functions
)
16526 || !just_this_one_p
16527 || MINI_WINDOW_P (w
)
16528 || !(used_current_matrix_p
16529 = try_window_reusing_current_matrix (w
)))
16530 try_window (window
, startp
, 0);
16532 /* If new fonts have been loaded (due to fontsets), give up. We
16533 have to start a new redisplay since we need to re-adjust glyph
16535 if (f
->fonts_changed
)
16536 goto need_larger_matrices
;
16538 /* If cursor did not appear assume that the middle of the window is
16539 in the first line of the window. Do it again with the next line.
16540 (Imagine a window of height 100, displaying two lines of height
16541 60. Moving back 50 from it->last_visible_y will end in the first
16543 if (w
->cursor
.vpos
< 0)
16545 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16547 clear_glyph_matrix (w
->desired_matrix
);
16548 move_it_by_lines (&it
, 1);
16549 try_window (window
, it
.current
.pos
, 0);
16551 else if (PT
< IT_CHARPOS (it
))
16553 clear_glyph_matrix (w
->desired_matrix
);
16554 move_it_by_lines (&it
, -1);
16555 try_window (window
, it
.current
.pos
, 0);
16559 /* Not much we can do about it. */
16563 /* Consider the following case: Window starts at BEGV, there is
16564 invisible, intangible text at BEGV, so that display starts at
16565 some point START > BEGV. It can happen that we are called with
16566 PT somewhere between BEGV and START. Try to handle that case,
16567 and similar ones. */
16568 if (w
->cursor
.vpos
< 0)
16570 /* First, try locating the proper glyph row for PT. */
16571 struct glyph_row
*row
=
16572 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16574 /* Sometimes point is at the beginning of invisible text that is
16575 before the 1st character displayed in the row. In that case,
16576 row_containing_pos fails to find the row, because no glyphs
16577 with appropriate buffer positions are present in the row.
16578 Therefore, we next try to find the row which shows the 1st
16579 position after the invisible text. */
16583 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16586 if (TEXT_PROP_MEANS_INVISIBLE (val
))
16589 Lisp_Object invis_end
=
16590 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16593 if (NATNUMP (invis_end
))
16594 alt_pos
= XFASTINT (invis_end
);
16597 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16601 /* Finally, fall back on the first row of the window after the
16602 header line (if any). This is slightly better than not
16603 displaying the cursor at all. */
16606 row
= w
->current_matrix
->rows
;
16607 if (row
->mode_line_p
)
16610 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16613 if (!cursor_row_fully_visible_p (w
, 0, 0))
16615 /* If vscroll is enabled, disable it and try again. */
16619 clear_glyph_matrix (w
->desired_matrix
);
16623 /* Users who set scroll-conservatively to a large number want
16624 point just above/below the scroll margin. If we ended up
16625 with point's row partially visible, move the window start to
16626 make that row fully visible and out of the margin. */
16627 if (scroll_conservatively
> SCROLL_LIMIT
)
16629 int window_total_lines
16630 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16633 ? min (scroll_margin
, window_total_lines
/ 4)
16635 int move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16637 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16638 clear_glyph_matrix (w
->desired_matrix
);
16639 if (1 == try_window (window
, it
.current
.pos
,
16640 TRY_WINDOW_CHECK_MARGINS
))
16644 /* If centering point failed to make the whole line visible,
16645 put point at the top instead. That has to make the whole line
16646 visible, if it can be done. */
16647 if (centering_position
== 0)
16650 clear_glyph_matrix (w
->desired_matrix
);
16651 centering_position
= 0;
16657 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16658 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16659 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16661 /* Display the mode line, if we must. */
16662 if ((update_mode_line
16663 /* If window not full width, must redo its mode line
16664 if (a) the window to its side is being redone and
16665 (b) we do a frame-based redisplay. This is a consequence
16666 of how inverted lines are drawn in frame-based redisplay. */
16667 || (!just_this_one_p
16668 && !FRAME_WINDOW_P (f
)
16669 && !WINDOW_FULL_WIDTH_P (w
))
16670 /* Line number to display. */
16671 || w
->base_line_pos
> 0
16672 /* Column number is displayed and different from the one displayed. */
16673 || (w
->column_number_displayed
!= -1
16674 && (w
->column_number_displayed
!= current_column ())))
16675 /* This means that the window has a mode line. */
16676 && (WINDOW_WANTS_MODELINE_P (w
)
16677 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16680 display_mode_lines (w
);
16682 /* If mode line height has changed, arrange for a thorough
16683 immediate redisplay using the correct mode line height. */
16684 if (WINDOW_WANTS_MODELINE_P (w
)
16685 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16687 f
->fonts_changed
= 1;
16688 w
->mode_line_height
= -1;
16689 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16690 = DESIRED_MODE_LINE_HEIGHT (w
);
16693 /* If header line height has changed, arrange for a thorough
16694 immediate redisplay using the correct header line height. */
16695 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16696 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16698 f
->fonts_changed
= 1;
16699 w
->header_line_height
= -1;
16700 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16701 = DESIRED_HEADER_LINE_HEIGHT (w
);
16704 if (f
->fonts_changed
)
16705 goto need_larger_matrices
;
16708 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16710 w
->base_line_pos
= 0;
16711 w
->base_line_number
= 0;
16716 /* When we reach a frame's selected window, redo the frame's menu bar. */
16717 if (update_mode_line
16718 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16720 int redisplay_menu_p
= 0;
16722 if (FRAME_WINDOW_P (f
))
16724 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16725 || defined (HAVE_NS) || defined (USE_GTK)
16726 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16728 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16732 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16734 if (redisplay_menu_p
)
16735 display_menu_bar (w
);
16737 #ifdef HAVE_WINDOW_SYSTEM
16738 if (FRAME_WINDOW_P (f
))
16740 #if defined (USE_GTK) || defined (HAVE_NS)
16741 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16742 redisplay_tool_bar (f
);
16744 if (WINDOWP (f
->tool_bar_window
)
16745 && (FRAME_TOOL_BAR_HEIGHT (f
) > 0
16746 || !NILP (Vauto_resize_tool_bars
))
16747 && redisplay_tool_bar (f
))
16748 ignore_mouse_drag_p
= 1;
16754 #ifdef HAVE_WINDOW_SYSTEM
16755 if (FRAME_WINDOW_P (f
)
16756 && update_window_fringes (w
, (just_this_one_p
16757 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16758 || w
->pseudo_window_p
)))
16762 if (draw_window_fringes (w
, 1))
16764 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16765 x_draw_right_divider (w
);
16767 x_draw_vertical_border (w
);
16773 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16774 x_draw_bottom_divider (w
);
16775 #endif /* HAVE_WINDOW_SYSTEM */
16777 /* We go to this label, with fonts_changed set, if it is
16778 necessary to try again using larger glyph matrices.
16779 We have to redeem the scroll bar even in this case,
16780 because the loop in redisplay_internal expects that. */
16781 need_larger_matrices
:
16783 finish_scroll_bars
:
16785 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16787 /* Set the thumb's position and size. */
16788 set_vertical_scroll_bar (w
);
16790 /* Note that we actually used the scroll bar attached to this
16791 window, so it shouldn't be deleted at the end of redisplay. */
16792 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16793 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16796 /* Restore current_buffer and value of point in it. The window
16797 update may have changed the buffer, so first make sure `opoint'
16798 is still valid (Bug#6177). */
16799 if (CHARPOS (opoint
) < BEGV
)
16800 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16801 else if (CHARPOS (opoint
) > ZV
)
16802 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16804 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16806 set_buffer_internal_1 (old
);
16807 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16808 shorter. This can be caused by log truncation in *Messages*. */
16809 if (CHARPOS (lpoint
) <= ZV
)
16810 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16812 unbind_to (count
, Qnil
);
16816 /* Build the complete desired matrix of WINDOW with a window start
16817 buffer position POS.
16819 Value is 1 if successful. It is zero if fonts were loaded during
16820 redisplay which makes re-adjusting glyph matrices necessary, and -1
16821 if point would appear in the scroll margins.
16822 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16823 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16827 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16829 struct window
*w
= XWINDOW (window
);
16831 struct glyph_row
*last_text_row
= NULL
;
16832 struct frame
*f
= XFRAME (w
->frame
);
16833 int frame_line_height
= default_line_pixel_height (w
);
16835 /* Make POS the new window start. */
16836 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16838 /* Mark cursor position as unknown. No overlay arrow seen. */
16839 w
->cursor
.vpos
= -1;
16840 overlay_arrow_seen
= 0;
16842 /* Initialize iterator and info to start at POS. */
16843 start_display (&it
, w
, pos
);
16845 /* Display all lines of W. */
16846 while (it
.current_y
< it
.last_visible_y
)
16848 if (display_line (&it
))
16849 last_text_row
= it
.glyph_row
- 1;
16850 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16854 /* Don't let the cursor end in the scroll margins. */
16855 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16856 && !MINI_WINDOW_P (w
))
16858 int this_scroll_margin
;
16859 int window_total_lines
16860 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16862 if (scroll_margin
> 0)
16864 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16865 this_scroll_margin
*= frame_line_height
;
16868 this_scroll_margin
= 0;
16870 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16871 && w
->cursor
.y
< this_scroll_margin
16872 && CHARPOS (pos
) > BEGV
16873 && IT_CHARPOS (it
) < ZV
)
16874 /* rms: considering make_cursor_line_fully_visible_p here
16875 seems to give wrong results. We don't want to recenter
16876 when the last line is partly visible, we want to allow
16877 that case to be handled in the usual way. */
16878 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16880 w
->cursor
.vpos
= -1;
16881 clear_glyph_matrix (w
->desired_matrix
);
16886 /* If bottom moved off end of frame, change mode line percentage. */
16887 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
16888 w
->update_mode_line
= 1;
16890 /* Set window_end_pos to the offset of the last character displayed
16891 on the window from the end of current_buffer. Set
16892 window_end_vpos to its row number. */
16895 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16896 adjust_window_ends (w
, last_text_row
, 0);
16898 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
16899 w
->window_end_vpos
)));
16903 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16904 w
->window_end_pos
= Z
- ZV
;
16905 w
->window_end_vpos
= 0;
16908 /* But that is not valid info until redisplay finishes. */
16909 w
->window_end_valid
= 0;
16915 /************************************************************************
16916 Window redisplay reusing current matrix when buffer has not changed
16917 ************************************************************************/
16919 /* Try redisplay of window W showing an unchanged buffer with a
16920 different window start than the last time it was displayed by
16921 reusing its current matrix. Value is non-zero if successful.
16922 W->start is the new window start. */
16925 try_window_reusing_current_matrix (struct window
*w
)
16927 struct frame
*f
= XFRAME (w
->frame
);
16928 struct glyph_row
*bottom_row
;
16931 struct text_pos start
, new_start
;
16932 int nrows_scrolled
, i
;
16933 struct glyph_row
*last_text_row
;
16934 struct glyph_row
*last_reused_text_row
;
16935 struct glyph_row
*start_row
;
16936 int start_vpos
, min_y
, max_y
;
16939 if (inhibit_try_window_reusing
)
16943 if (/* This function doesn't handle terminal frames. */
16944 !FRAME_WINDOW_P (f
)
16945 /* Don't try to reuse the display if windows have been split
16947 || windows_or_buffers_changed
16948 || f
->cursor_type_changed
)
16951 /* Can't do this if showing trailing whitespace. */
16952 if (!NILP (Vshow_trailing_whitespace
))
16955 /* If top-line visibility has changed, give up. */
16956 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16957 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16960 /* Give up if old or new display is scrolled vertically. We could
16961 make this function handle this, but right now it doesn't. */
16962 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16963 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16966 /* The variable new_start now holds the new window start. The old
16967 start `start' can be determined from the current matrix. */
16968 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16969 start
= start_row
->minpos
;
16970 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16972 /* Clear the desired matrix for the display below. */
16973 clear_glyph_matrix (w
->desired_matrix
);
16975 if (CHARPOS (new_start
) <= CHARPOS (start
))
16977 /* Don't use this method if the display starts with an ellipsis
16978 displayed for invisible text. It's not easy to handle that case
16979 below, and it's certainly not worth the effort since this is
16980 not a frequent case. */
16981 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16984 IF_DEBUG (debug_method_add (w
, "twu1"));
16986 /* Display up to a row that can be reused. The variable
16987 last_text_row is set to the last row displayed that displays
16988 text. Note that it.vpos == 0 if or if not there is a
16989 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16990 start_display (&it
, w
, new_start
);
16991 w
->cursor
.vpos
= -1;
16992 last_text_row
= last_reused_text_row
= NULL
;
16994 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
16996 /* If we have reached into the characters in the START row,
16997 that means the line boundaries have changed. So we
16998 can't start copying with the row START. Maybe it will
16999 work to start copying with the following row. */
17000 while (IT_CHARPOS (it
) > CHARPOS (start
))
17002 /* Advance to the next row as the "start". */
17004 start
= start_row
->minpos
;
17005 /* If there are no more rows to try, or just one, give up. */
17006 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17007 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17008 || CHARPOS (start
) == ZV
)
17010 clear_glyph_matrix (w
->desired_matrix
);
17014 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17016 /* If we have reached alignment, we can copy the rest of the
17018 if (IT_CHARPOS (it
) == CHARPOS (start
)
17019 /* Don't accept "alignment" inside a display vector,
17020 since start_row could have started in the middle of
17021 that same display vector (thus their character
17022 positions match), and we have no way of telling if
17023 that is the case. */
17024 && it
.current
.dpvec_index
< 0)
17027 if (display_line (&it
))
17028 last_text_row
= it
.glyph_row
- 1;
17032 /* A value of current_y < last_visible_y means that we stopped
17033 at the previous window start, which in turn means that we
17034 have at least one reusable row. */
17035 if (it
.current_y
< it
.last_visible_y
)
17037 struct glyph_row
*row
;
17039 /* IT.vpos always starts from 0; it counts text lines. */
17040 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17042 /* Find PT if not already found in the lines displayed. */
17043 if (w
->cursor
.vpos
< 0)
17045 int dy
= it
.current_y
- start_row
->y
;
17047 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17048 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17050 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17051 dy
, nrows_scrolled
);
17054 clear_glyph_matrix (w
->desired_matrix
);
17059 /* Scroll the display. Do it before the current matrix is
17060 changed. The problem here is that update has not yet
17061 run, i.e. part of the current matrix is not up to date.
17062 scroll_run_hook will clear the cursor, and use the
17063 current matrix to get the height of the row the cursor is
17065 run
.current_y
= start_row
->y
;
17066 run
.desired_y
= it
.current_y
;
17067 run
.height
= it
.last_visible_y
- it
.current_y
;
17069 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17072 FRAME_RIF (f
)->update_window_begin_hook (w
);
17073 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17074 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17075 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17079 /* Shift current matrix down by nrows_scrolled lines. */
17080 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17081 rotate_matrix (w
->current_matrix
,
17083 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17086 /* Disable lines that must be updated. */
17087 for (i
= 0; i
< nrows_scrolled
; ++i
)
17088 (start_row
+ i
)->enabled_p
= false;
17090 /* Re-compute Y positions. */
17091 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17092 max_y
= it
.last_visible_y
;
17093 for (row
= start_row
+ nrows_scrolled
;
17097 row
->y
= it
.current_y
;
17098 row
->visible_height
= row
->height
;
17100 if (row
->y
< min_y
)
17101 row
->visible_height
-= min_y
- row
->y
;
17102 if (row
->y
+ row
->height
> max_y
)
17103 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17104 if (row
->fringe_bitmap_periodic_p
)
17105 row
->redraw_fringe_bitmaps_p
= 1;
17107 it
.current_y
+= row
->height
;
17109 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17110 last_reused_text_row
= row
;
17111 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17115 /* Disable lines in the current matrix which are now
17116 below the window. */
17117 for (++row
; row
< bottom_row
; ++row
)
17118 row
->enabled_p
= row
->mode_line_p
= 0;
17121 /* Update window_end_pos etc.; last_reused_text_row is the last
17122 reused row from the current matrix containing text, if any.
17123 The value of last_text_row is the last displayed line
17124 containing text. */
17125 if (last_reused_text_row
)
17126 adjust_window_ends (w
, last_reused_text_row
, 1);
17127 else if (last_text_row
)
17128 adjust_window_ends (w
, last_text_row
, 0);
17131 /* This window must be completely empty. */
17132 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17133 w
->window_end_pos
= Z
- ZV
;
17134 w
->window_end_vpos
= 0;
17136 w
->window_end_valid
= 0;
17138 /* Update hint: don't try scrolling again in update_window. */
17139 w
->desired_matrix
->no_scrolling_p
= 1;
17142 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17146 else if (CHARPOS (new_start
) > CHARPOS (start
))
17148 struct glyph_row
*pt_row
, *row
;
17149 struct glyph_row
*first_reusable_row
;
17150 struct glyph_row
*first_row_to_display
;
17152 int yb
= window_text_bottom_y (w
);
17154 /* Find the row starting at new_start, if there is one. Don't
17155 reuse a partially visible line at the end. */
17156 first_reusable_row
= start_row
;
17157 while (first_reusable_row
->enabled_p
17158 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17159 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17160 < CHARPOS (new_start
)))
17161 ++first_reusable_row
;
17163 /* Give up if there is no row to reuse. */
17164 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17165 || !first_reusable_row
->enabled_p
17166 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17167 != CHARPOS (new_start
)))
17170 /* We can reuse fully visible rows beginning with
17171 first_reusable_row to the end of the window. Set
17172 first_row_to_display to the first row that cannot be reused.
17173 Set pt_row to the row containing point, if there is any. */
17175 for (first_row_to_display
= first_reusable_row
;
17176 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17177 ++first_row_to_display
)
17179 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17180 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17181 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17182 && first_row_to_display
->ends_at_zv_p
17183 && pt_row
== NULL
)))
17184 pt_row
= first_row_to_display
;
17187 /* Start displaying at the start of first_row_to_display. */
17188 eassert (first_row_to_display
->y
< yb
);
17189 init_to_row_start (&it
, w
, first_row_to_display
);
17191 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17193 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17195 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17196 + WINDOW_HEADER_LINE_HEIGHT (w
));
17198 /* Display lines beginning with first_row_to_display in the
17199 desired matrix. Set last_text_row to the last row displayed
17200 that displays text. */
17201 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17202 if (pt_row
== NULL
)
17203 w
->cursor
.vpos
= -1;
17204 last_text_row
= NULL
;
17205 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17206 if (display_line (&it
))
17207 last_text_row
= it
.glyph_row
- 1;
17209 /* If point is in a reused row, adjust y and vpos of the cursor
17213 w
->cursor
.vpos
-= nrows_scrolled
;
17214 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17217 /* Give up if point isn't in a row displayed or reused. (This
17218 also handles the case where w->cursor.vpos < nrows_scrolled
17219 after the calls to display_line, which can happen with scroll
17220 margins. See bug#1295.) */
17221 if (w
->cursor
.vpos
< 0)
17223 clear_glyph_matrix (w
->desired_matrix
);
17227 /* Scroll the display. */
17228 run
.current_y
= first_reusable_row
->y
;
17229 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17230 run
.height
= it
.last_visible_y
- run
.current_y
;
17231 dy
= run
.current_y
- run
.desired_y
;
17236 FRAME_RIF (f
)->update_window_begin_hook (w
);
17237 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17238 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17239 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17243 /* Adjust Y positions of reused rows. */
17244 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17245 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17246 max_y
= it
.last_visible_y
;
17247 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17250 row
->visible_height
= row
->height
;
17251 if (row
->y
< min_y
)
17252 row
->visible_height
-= min_y
- row
->y
;
17253 if (row
->y
+ row
->height
> max_y
)
17254 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17255 if (row
->fringe_bitmap_periodic_p
)
17256 row
->redraw_fringe_bitmaps_p
= 1;
17259 /* Scroll the current matrix. */
17260 eassert (nrows_scrolled
> 0);
17261 rotate_matrix (w
->current_matrix
,
17263 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17266 /* Disable rows not reused. */
17267 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17268 row
->enabled_p
= false;
17270 /* Point may have moved to a different line, so we cannot assume that
17271 the previous cursor position is valid; locate the correct row. */
17274 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17276 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17277 && !row
->ends_at_zv_p
;
17281 w
->cursor
.y
= row
->y
;
17283 if (row
< bottom_row
)
17285 /* Can't simply scan the row for point with
17286 bidi-reordered glyph rows. Let set_cursor_from_row
17287 figure out where to put the cursor, and if it fails,
17289 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17291 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17294 clear_glyph_matrix (w
->desired_matrix
);
17300 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17301 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17304 && (!BUFFERP (glyph
->object
)
17305 || glyph
->charpos
< PT
);
17309 w
->cursor
.x
+= glyph
->pixel_width
;
17315 /* Adjust window end. A null value of last_text_row means that
17316 the window end is in reused rows which in turn means that
17317 only its vpos can have changed. */
17319 adjust_window_ends (w
, last_text_row
, 0);
17321 w
->window_end_vpos
-= nrows_scrolled
;
17323 w
->window_end_valid
= 0;
17324 w
->desired_matrix
->no_scrolling_p
= 1;
17327 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17337 /************************************************************************
17338 Window redisplay reusing current matrix when buffer has changed
17339 ************************************************************************/
17341 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17342 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17343 ptrdiff_t *, ptrdiff_t *);
17344 static struct glyph_row
*
17345 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17346 struct glyph_row
*);
17349 /* Return the last row in MATRIX displaying text. If row START is
17350 non-null, start searching with that row. IT gives the dimensions
17351 of the display. Value is null if matrix is empty; otherwise it is
17352 a pointer to the row found. */
17354 static struct glyph_row
*
17355 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17356 struct glyph_row
*start
)
17358 struct glyph_row
*row
, *row_found
;
17360 /* Set row_found to the last row in IT->w's current matrix
17361 displaying text. The loop looks funny but think of partially
17364 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17365 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17367 eassert (row
->enabled_p
);
17369 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17378 /* Return the last row in the current matrix of W that is not affected
17379 by changes at the start of current_buffer that occurred since W's
17380 current matrix was built. Value is null if no such row exists.
17382 BEG_UNCHANGED us the number of characters unchanged at the start of
17383 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17384 first changed character in current_buffer. Characters at positions <
17385 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17386 when the current matrix was built. */
17388 static struct glyph_row
*
17389 find_last_unchanged_at_beg_row (struct window
*w
)
17391 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17392 struct glyph_row
*row
;
17393 struct glyph_row
*row_found
= NULL
;
17394 int yb
= window_text_bottom_y (w
);
17396 /* Find the last row displaying unchanged text. */
17397 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17398 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17399 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17402 if (/* If row ends before first_changed_pos, it is unchanged,
17403 except in some case. */
17404 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17405 /* When row ends in ZV and we write at ZV it is not
17407 && !row
->ends_at_zv_p
17408 /* When first_changed_pos is the end of a continued line,
17409 row is not unchanged because it may be no longer
17411 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17412 && (row
->continued_p
17413 || row
->exact_window_width_line_p
))
17414 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17415 needs to be recomputed, so don't consider this row as
17416 unchanged. This happens when the last line was
17417 bidi-reordered and was killed immediately before this
17418 redisplay cycle. In that case, ROW->end stores the
17419 buffer position of the first visual-order character of
17420 the killed text, which is now beyond ZV. */
17421 && CHARPOS (row
->end
.pos
) <= ZV
)
17424 /* Stop if last visible row. */
17425 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17433 /* Find the first glyph row in the current matrix of W that is not
17434 affected by changes at the end of current_buffer since the
17435 time W's current matrix was built.
17437 Return in *DELTA the number of chars by which buffer positions in
17438 unchanged text at the end of current_buffer must be adjusted.
17440 Return in *DELTA_BYTES the corresponding number of bytes.
17442 Value is null if no such row exists, i.e. all rows are affected by
17445 static struct glyph_row
*
17446 find_first_unchanged_at_end_row (struct window
*w
,
17447 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17449 struct glyph_row
*row
;
17450 struct glyph_row
*row_found
= NULL
;
17452 *delta
= *delta_bytes
= 0;
17454 /* Display must not have been paused, otherwise the current matrix
17455 is not up to date. */
17456 eassert (w
->window_end_valid
);
17458 /* A value of window_end_pos >= END_UNCHANGED means that the window
17459 end is in the range of changed text. If so, there is no
17460 unchanged row at the end of W's current matrix. */
17461 if (w
->window_end_pos
>= END_UNCHANGED
)
17464 /* Set row to the last row in W's current matrix displaying text. */
17465 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17467 /* If matrix is entirely empty, no unchanged row exists. */
17468 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17470 /* The value of row is the last glyph row in the matrix having a
17471 meaningful buffer position in it. The end position of row
17472 corresponds to window_end_pos. This allows us to translate
17473 buffer positions in the current matrix to current buffer
17474 positions for characters not in changed text. */
17476 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17477 ptrdiff_t Z_BYTE_old
=
17478 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17479 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17480 struct glyph_row
*first_text_row
17481 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17483 *delta
= Z
- Z_old
;
17484 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17486 /* Set last_unchanged_pos to the buffer position of the last
17487 character in the buffer that has not been changed. Z is the
17488 index + 1 of the last character in current_buffer, i.e. by
17489 subtracting END_UNCHANGED we get the index of the last
17490 unchanged character, and we have to add BEG to get its buffer
17492 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17493 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17495 /* Search backward from ROW for a row displaying a line that
17496 starts at a minimum position >= last_unchanged_pos_old. */
17497 for (; row
> first_text_row
; --row
)
17499 /* This used to abort, but it can happen.
17500 It is ok to just stop the search instead here. KFS. */
17501 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17504 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17509 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17515 /* Make sure that glyph rows in the current matrix of window W
17516 reference the same glyph memory as corresponding rows in the
17517 frame's frame matrix. This function is called after scrolling W's
17518 current matrix on a terminal frame in try_window_id and
17519 try_window_reusing_current_matrix. */
17522 sync_frame_with_window_matrix_rows (struct window
*w
)
17524 struct frame
*f
= XFRAME (w
->frame
);
17525 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17527 /* Preconditions: W must be a leaf window and full-width. Its frame
17528 must have a frame matrix. */
17529 eassert (BUFFERP (w
->contents
));
17530 eassert (WINDOW_FULL_WIDTH_P (w
));
17531 eassert (!FRAME_WINDOW_P (f
));
17533 /* If W is a full-width window, glyph pointers in W's current matrix
17534 have, by definition, to be the same as glyph pointers in the
17535 corresponding frame matrix. Note that frame matrices have no
17536 marginal areas (see build_frame_matrix). */
17537 window_row
= w
->current_matrix
->rows
;
17538 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17539 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17540 while (window_row
< window_row_end
)
17542 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17543 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17545 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17546 frame_row
->glyphs
[TEXT_AREA
] = start
;
17547 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17548 frame_row
->glyphs
[LAST_AREA
] = end
;
17550 /* Disable frame rows whose corresponding window rows have
17551 been disabled in try_window_id. */
17552 if (!window_row
->enabled_p
)
17553 frame_row
->enabled_p
= false;
17555 ++window_row
, ++frame_row
;
17560 /* Find the glyph row in window W containing CHARPOS. Consider all
17561 rows between START and END (not inclusive). END null means search
17562 all rows to the end of the display area of W. Value is the row
17563 containing CHARPOS or null. */
17566 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17567 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17569 struct glyph_row
*row
= start
;
17570 struct glyph_row
*best_row
= NULL
;
17571 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17574 /* If we happen to start on a header-line, skip that. */
17575 if (row
->mode_line_p
)
17578 if ((end
&& row
>= end
) || !row
->enabled_p
)
17581 last_y
= window_text_bottom_y (w
) - dy
;
17585 /* Give up if we have gone too far. */
17586 if (end
&& row
>= end
)
17588 /* This formerly returned if they were equal.
17589 I think that both quantities are of a "last plus one" type;
17590 if so, when they are equal, the row is within the screen. -- rms. */
17591 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17594 /* If it is in this row, return this row. */
17595 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17596 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17597 /* The end position of a row equals the start
17598 position of the next row. If CHARPOS is there, we
17599 would rather consider it displayed in the next
17600 line, except when this line ends in ZV. */
17601 && !row_for_charpos_p (row
, charpos
)))
17602 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17606 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17607 || (!best_row
&& !row
->continued_p
))
17609 /* In bidi-reordered rows, there could be several rows whose
17610 edges surround CHARPOS, all of these rows belonging to
17611 the same continued line. We need to find the row which
17612 fits CHARPOS the best. */
17613 for (g
= row
->glyphs
[TEXT_AREA
];
17614 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17617 if (!STRINGP (g
->object
))
17619 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17621 mindif
= eabs (g
->charpos
- charpos
);
17623 /* Exact match always wins. */
17630 else if (best_row
&& !row
->continued_p
)
17637 /* Try to redisplay window W by reusing its existing display. W's
17638 current matrix must be up to date when this function is called,
17639 i.e. window_end_valid must be nonzero.
17643 >= 1 if successful, i.e. display has been updated
17645 1 means the changes were in front of a newline that precedes
17646 the window start, and the whole current matrix was reused
17647 2 means the changes were after the last position displayed
17648 in the window, and the whole current matrix was reused
17649 3 means portions of the current matrix were reused, while
17650 some of the screen lines were redrawn
17651 -1 if redisplay with same window start is known not to succeed
17652 0 if otherwise unsuccessful
17654 The following steps are performed:
17656 1. Find the last row in the current matrix of W that is not
17657 affected by changes at the start of current_buffer. If no such row
17660 2. Find the first row in W's current matrix that is not affected by
17661 changes at the end of current_buffer. Maybe there is no such row.
17663 3. Display lines beginning with the row + 1 found in step 1 to the
17664 row found in step 2 or, if step 2 didn't find a row, to the end of
17667 4. If cursor is not known to appear on the window, give up.
17669 5. If display stopped at the row found in step 2, scroll the
17670 display and current matrix as needed.
17672 6. Maybe display some lines at the end of W, if we must. This can
17673 happen under various circumstances, like a partially visible line
17674 becoming fully visible, or because newly displayed lines are displayed
17675 in smaller font sizes.
17677 7. Update W's window end information. */
17680 try_window_id (struct window
*w
)
17682 struct frame
*f
= XFRAME (w
->frame
);
17683 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17684 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17685 struct glyph_row
*last_unchanged_at_beg_row
;
17686 struct glyph_row
*first_unchanged_at_end_row
;
17687 struct glyph_row
*row
;
17688 struct glyph_row
*bottom_row
;
17691 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17693 struct text_pos start_pos
;
17695 int first_unchanged_at_end_vpos
= 0;
17696 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17697 struct text_pos start
;
17698 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17701 if (inhibit_try_window_id
)
17705 /* This is handy for debugging. */
17707 #define GIVE_UP(X) \
17709 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17713 #define GIVE_UP(X) return 0
17716 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17718 /* Don't use this for mini-windows because these can show
17719 messages and mini-buffers, and we don't handle that here. */
17720 if (MINI_WINDOW_P (w
))
17723 /* This flag is used to prevent redisplay optimizations. */
17724 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17727 /* This function's optimizations cannot be used if overlays have
17728 changed in the buffer displayed by the window, so give up if they
17730 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17733 /* Verify that narrowing has not changed.
17734 Also verify that we were not told to prevent redisplay optimizations.
17735 It would be nice to further
17736 reduce the number of cases where this prevents try_window_id. */
17737 if (current_buffer
->clip_changed
17738 || current_buffer
->prevent_redisplay_optimizations_p
)
17741 /* Window must either use window-based redisplay or be full width. */
17742 if (!FRAME_WINDOW_P (f
)
17743 && (!FRAME_LINE_INS_DEL_OK (f
)
17744 || !WINDOW_FULL_WIDTH_P (w
)))
17747 /* Give up if point is known NOT to appear in W. */
17748 if (PT
< CHARPOS (start
))
17751 /* Another way to prevent redisplay optimizations. */
17752 if (w
->last_modified
== 0)
17755 /* Verify that window is not hscrolled. */
17756 if (w
->hscroll
!= 0)
17759 /* Verify that display wasn't paused. */
17760 if (!w
->window_end_valid
)
17763 /* Likewise if highlighting trailing whitespace. */
17764 if (!NILP (Vshow_trailing_whitespace
))
17767 /* Can't use this if overlay arrow position and/or string have
17769 if (overlay_arrows_changed_p ())
17772 /* When word-wrap is on, adding a space to the first word of a
17773 wrapped line can change the wrap position, altering the line
17774 above it. It might be worthwhile to handle this more
17775 intelligently, but for now just redisplay from scratch. */
17776 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17779 /* Under bidi reordering, adding or deleting a character in the
17780 beginning of a paragraph, before the first strong directional
17781 character, can change the base direction of the paragraph (unless
17782 the buffer specifies a fixed paragraph direction), which will
17783 require to redisplay the whole paragraph. It might be worthwhile
17784 to find the paragraph limits and widen the range of redisplayed
17785 lines to that, but for now just give up this optimization and
17786 redisplay from scratch. */
17787 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17788 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17791 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17792 only if buffer has really changed. The reason is that the gap is
17793 initially at Z for freshly visited files. The code below would
17794 set end_unchanged to 0 in that case. */
17795 if (MODIFF
> SAVE_MODIFF
17796 /* This seems to happen sometimes after saving a buffer. */
17797 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17799 if (GPT
- BEG
< BEG_UNCHANGED
)
17800 BEG_UNCHANGED
= GPT
- BEG
;
17801 if (Z
- GPT
< END_UNCHANGED
)
17802 END_UNCHANGED
= Z
- GPT
;
17805 /* The position of the first and last character that has been changed. */
17806 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17807 last_changed_charpos
= Z
- END_UNCHANGED
;
17809 /* If window starts after a line end, and the last change is in
17810 front of that newline, then changes don't affect the display.
17811 This case happens with stealth-fontification. Note that although
17812 the display is unchanged, glyph positions in the matrix have to
17813 be adjusted, of course. */
17814 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17815 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17816 && ((last_changed_charpos
< CHARPOS (start
)
17817 && CHARPOS (start
) == BEGV
)
17818 || (last_changed_charpos
< CHARPOS (start
) - 1
17819 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17821 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17822 struct glyph_row
*r0
;
17824 /* Compute how many chars/bytes have been added to or removed
17825 from the buffer. */
17826 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17827 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17828 Z_delta
= Z
- Z_old
;
17829 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17831 /* Give up if PT is not in the window. Note that it already has
17832 been checked at the start of try_window_id that PT is not in
17833 front of the window start. */
17834 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17837 /* If window start is unchanged, we can reuse the whole matrix
17838 as is, after adjusting glyph positions. No need to compute
17839 the window end again, since its offset from Z hasn't changed. */
17840 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17841 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17842 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17843 /* PT must not be in a partially visible line. */
17844 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17845 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17847 /* Adjust positions in the glyph matrix. */
17848 if (Z_delta
|| Z_delta_bytes
)
17850 struct glyph_row
*r1
17851 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17852 increment_matrix_positions (w
->current_matrix
,
17853 MATRIX_ROW_VPOS (r0
, current_matrix
),
17854 MATRIX_ROW_VPOS (r1
, current_matrix
),
17855 Z_delta
, Z_delta_bytes
);
17858 /* Set the cursor. */
17859 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17861 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17866 /* Handle the case that changes are all below what is displayed in
17867 the window, and that PT is in the window. This shortcut cannot
17868 be taken if ZV is visible in the window, and text has been added
17869 there that is visible in the window. */
17870 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17871 /* ZV is not visible in the window, or there are no
17872 changes at ZV, actually. */
17873 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17874 || first_changed_charpos
== last_changed_charpos
))
17876 struct glyph_row
*r0
;
17878 /* Give up if PT is not in the window. Note that it already has
17879 been checked at the start of try_window_id that PT is not in
17880 front of the window start. */
17881 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17884 /* If window start is unchanged, we can reuse the whole matrix
17885 as is, without changing glyph positions since no text has
17886 been added/removed in front of the window end. */
17887 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17888 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17889 /* PT must not be in a partially visible line. */
17890 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17891 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17893 /* We have to compute the window end anew since text
17894 could have been added/removed after it. */
17895 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
17896 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17898 /* Set the cursor. */
17899 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17901 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17906 /* Give up if window start is in the changed area.
17908 The condition used to read
17910 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17912 but why that was tested escapes me at the moment. */
17913 if (CHARPOS (start
) >= first_changed_charpos
17914 && CHARPOS (start
) <= last_changed_charpos
)
17917 /* Check that window start agrees with the start of the first glyph
17918 row in its current matrix. Check this after we know the window
17919 start is not in changed text, otherwise positions would not be
17921 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17922 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17925 /* Give up if the window ends in strings. Overlay strings
17926 at the end are difficult to handle, so don't try. */
17927 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
17928 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17931 /* Compute the position at which we have to start displaying new
17932 lines. Some of the lines at the top of the window might be
17933 reusable because they are not displaying changed text. Find the
17934 last row in W's current matrix not affected by changes at the
17935 start of current_buffer. Value is null if changes start in the
17936 first line of window. */
17937 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17938 if (last_unchanged_at_beg_row
)
17940 /* Avoid starting to display in the middle of a character, a TAB
17941 for instance. This is easier than to set up the iterator
17942 exactly, and it's not a frequent case, so the additional
17943 effort wouldn't really pay off. */
17944 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17945 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17946 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17947 --last_unchanged_at_beg_row
;
17949 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17952 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17954 start_pos
= it
.current
.pos
;
17956 /* Start displaying new lines in the desired matrix at the same
17957 vpos we would use in the current matrix, i.e. below
17958 last_unchanged_at_beg_row. */
17959 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17961 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17962 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17964 eassert (it
.hpos
== 0 && it
.current_x
== 0);
17968 /* There are no reusable lines at the start of the window.
17969 Start displaying in the first text line. */
17970 start_display (&it
, w
, start
);
17971 it
.vpos
= it
.first_vpos
;
17972 start_pos
= it
.current
.pos
;
17975 /* Find the first row that is not affected by changes at the end of
17976 the buffer. Value will be null if there is no unchanged row, in
17977 which case we must redisplay to the end of the window. delta
17978 will be set to the value by which buffer positions beginning with
17979 first_unchanged_at_end_row have to be adjusted due to text
17981 first_unchanged_at_end_row
17982 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17983 IF_DEBUG (debug_delta
= delta
);
17984 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17986 /* Set stop_pos to the buffer position up to which we will have to
17987 display new lines. If first_unchanged_at_end_row != NULL, this
17988 is the buffer position of the start of the line displayed in that
17989 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17990 that we don't stop at a buffer position. */
17992 if (first_unchanged_at_end_row
)
17994 eassert (last_unchanged_at_beg_row
== NULL
17995 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17997 /* If this is a continuation line, move forward to the next one
17998 that isn't. Changes in lines above affect this line.
17999 Caution: this may move first_unchanged_at_end_row to a row
18000 not displaying text. */
18001 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18002 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18003 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18004 < it
.last_visible_y
))
18005 ++first_unchanged_at_end_row
;
18007 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18008 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18009 >= it
.last_visible_y
))
18010 first_unchanged_at_end_row
= NULL
;
18013 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18015 first_unchanged_at_end_vpos
18016 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18017 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18020 else if (last_unchanged_at_beg_row
== NULL
)
18026 /* Either there is no unchanged row at the end, or the one we have
18027 now displays text. This is a necessary condition for the window
18028 end pos calculation at the end of this function. */
18029 eassert (first_unchanged_at_end_row
== NULL
18030 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18032 debug_last_unchanged_at_beg_vpos
18033 = (last_unchanged_at_beg_row
18034 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18036 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18038 #endif /* GLYPH_DEBUG */
18041 /* Display new lines. Set last_text_row to the last new line
18042 displayed which has text on it, i.e. might end up as being the
18043 line where the window_end_vpos is. */
18044 w
->cursor
.vpos
= -1;
18045 last_text_row
= NULL
;
18046 overlay_arrow_seen
= 0;
18047 while (it
.current_y
< it
.last_visible_y
18048 && !f
->fonts_changed
18049 && (first_unchanged_at_end_row
== NULL
18050 || IT_CHARPOS (it
) < stop_pos
))
18052 if (display_line (&it
))
18053 last_text_row
= it
.glyph_row
- 1;
18056 if (f
->fonts_changed
)
18060 /* Compute differences in buffer positions, y-positions etc. for
18061 lines reused at the bottom of the window. Compute what we can
18063 if (first_unchanged_at_end_row
18064 /* No lines reused because we displayed everything up to the
18065 bottom of the window. */
18066 && it
.current_y
< it
.last_visible_y
)
18069 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18071 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18072 run
.current_y
= first_unchanged_at_end_row
->y
;
18073 run
.desired_y
= run
.current_y
+ dy
;
18074 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18078 delta
= delta_bytes
= dvpos
= dy
18079 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18080 first_unchanged_at_end_row
= NULL
;
18082 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18085 /* Find the cursor if not already found. We have to decide whether
18086 PT will appear on this window (it sometimes doesn't, but this is
18087 not a very frequent case.) This decision has to be made before
18088 the current matrix is altered. A value of cursor.vpos < 0 means
18089 that PT is either in one of the lines beginning at
18090 first_unchanged_at_end_row or below the window. Don't care for
18091 lines that might be displayed later at the window end; as
18092 mentioned, this is not a frequent case. */
18093 if (w
->cursor
.vpos
< 0)
18095 /* Cursor in unchanged rows at the top? */
18096 if (PT
< CHARPOS (start_pos
)
18097 && last_unchanged_at_beg_row
)
18099 row
= row_containing_pos (w
, PT
,
18100 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18101 last_unchanged_at_beg_row
+ 1, 0);
18103 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18106 /* Start from first_unchanged_at_end_row looking for PT. */
18107 else if (first_unchanged_at_end_row
)
18109 row
= row_containing_pos (w
, PT
- delta
,
18110 first_unchanged_at_end_row
, NULL
, 0);
18112 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18113 delta_bytes
, dy
, dvpos
);
18116 /* Give up if cursor was not found. */
18117 if (w
->cursor
.vpos
< 0)
18119 clear_glyph_matrix (w
->desired_matrix
);
18124 /* Don't let the cursor end in the scroll margins. */
18126 int this_scroll_margin
, cursor_height
;
18127 int frame_line_height
= default_line_pixel_height (w
);
18128 int window_total_lines
18129 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18131 this_scroll_margin
=
18132 max (0, min (scroll_margin
, window_total_lines
/ 4));
18133 this_scroll_margin
*= frame_line_height
;
18134 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18136 if ((w
->cursor
.y
< this_scroll_margin
18137 && CHARPOS (start
) > BEGV
)
18138 /* Old redisplay didn't take scroll margin into account at the bottom,
18139 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18140 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18141 ? cursor_height
+ this_scroll_margin
18142 : 1)) > it
.last_visible_y
)
18144 w
->cursor
.vpos
= -1;
18145 clear_glyph_matrix (w
->desired_matrix
);
18150 /* Scroll the display. Do it before changing the current matrix so
18151 that xterm.c doesn't get confused about where the cursor glyph is
18153 if (dy
&& run
.height
)
18157 if (FRAME_WINDOW_P (f
))
18159 FRAME_RIF (f
)->update_window_begin_hook (w
);
18160 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18161 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18162 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
18166 /* Terminal frame. In this case, dvpos gives the number of
18167 lines to scroll by; dvpos < 0 means scroll up. */
18169 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18170 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18171 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18172 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
18173 + window_internal_height (w
));
18175 #if defined (HAVE_GPM) || defined (MSDOS)
18176 x_clear_window_mouse_face (w
);
18178 /* Perform the operation on the screen. */
18181 /* Scroll last_unchanged_at_beg_row to the end of the
18182 window down dvpos lines. */
18183 set_terminal_window (f
, end
);
18185 /* On dumb terminals delete dvpos lines at the end
18186 before inserting dvpos empty lines. */
18187 if (!FRAME_SCROLL_REGION_OK (f
))
18188 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18190 /* Insert dvpos empty lines in front of
18191 last_unchanged_at_beg_row. */
18192 ins_del_lines (f
, from
, dvpos
);
18194 else if (dvpos
< 0)
18196 /* Scroll up last_unchanged_at_beg_vpos to the end of
18197 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18198 set_terminal_window (f
, end
);
18200 /* Delete dvpos lines in front of
18201 last_unchanged_at_beg_vpos. ins_del_lines will set
18202 the cursor to the given vpos and emit |dvpos| delete
18204 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18206 /* On a dumb terminal insert dvpos empty lines at the
18208 if (!FRAME_SCROLL_REGION_OK (f
))
18209 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18212 set_terminal_window (f
, 0);
18218 /* Shift reused rows of the current matrix to the right position.
18219 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18221 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18222 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18225 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18226 bottom_vpos
, dvpos
);
18227 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18230 else if (dvpos
> 0)
18232 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18233 bottom_vpos
, dvpos
);
18234 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18235 first_unchanged_at_end_vpos
+ dvpos
);
18238 /* For frame-based redisplay, make sure that current frame and window
18239 matrix are in sync with respect to glyph memory. */
18240 if (!FRAME_WINDOW_P (f
))
18241 sync_frame_with_window_matrix_rows (w
);
18243 /* Adjust buffer positions in reused rows. */
18244 if (delta
|| delta_bytes
)
18245 increment_matrix_positions (current_matrix
,
18246 first_unchanged_at_end_vpos
+ dvpos
,
18247 bottom_vpos
, delta
, delta_bytes
);
18249 /* Adjust Y positions. */
18251 shift_glyph_matrix (w
, current_matrix
,
18252 first_unchanged_at_end_vpos
+ dvpos
,
18255 if (first_unchanged_at_end_row
)
18257 first_unchanged_at_end_row
+= dvpos
;
18258 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18259 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18260 first_unchanged_at_end_row
= NULL
;
18263 /* If scrolling up, there may be some lines to display at the end of
18265 last_text_row_at_end
= NULL
;
18268 /* Scrolling up can leave for example a partially visible line
18269 at the end of the window to be redisplayed. */
18270 /* Set last_row to the glyph row in the current matrix where the
18271 window end line is found. It has been moved up or down in
18272 the matrix by dvpos. */
18273 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18274 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18276 /* If last_row is the window end line, it should display text. */
18277 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18279 /* If window end line was partially visible before, begin
18280 displaying at that line. Otherwise begin displaying with the
18281 line following it. */
18282 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18284 init_to_row_start (&it
, w
, last_row
);
18285 it
.vpos
= last_vpos
;
18286 it
.current_y
= last_row
->y
;
18290 init_to_row_end (&it
, w
, last_row
);
18291 it
.vpos
= 1 + last_vpos
;
18292 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18296 /* We may start in a continuation line. If so, we have to
18297 get the right continuation_lines_width and current_x. */
18298 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18299 it
.hpos
= it
.current_x
= 0;
18301 /* Display the rest of the lines at the window end. */
18302 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18303 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18305 /* Is it always sure that the display agrees with lines in
18306 the current matrix? I don't think so, so we mark rows
18307 displayed invalid in the current matrix by setting their
18308 enabled_p flag to zero. */
18309 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18310 if (display_line (&it
))
18311 last_text_row_at_end
= it
.glyph_row
- 1;
18315 /* Update window_end_pos and window_end_vpos. */
18316 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18318 /* Window end line if one of the preserved rows from the current
18319 matrix. Set row to the last row displaying text in current
18320 matrix starting at first_unchanged_at_end_row, after
18322 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18323 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18324 first_unchanged_at_end_row
);
18325 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18326 adjust_window_ends (w
, row
, 1);
18327 eassert (w
->window_end_bytepos
>= 0);
18328 IF_DEBUG (debug_method_add (w
, "A"));
18330 else if (last_text_row_at_end
)
18332 adjust_window_ends (w
, last_text_row_at_end
, 0);
18333 eassert (w
->window_end_bytepos
>= 0);
18334 IF_DEBUG (debug_method_add (w
, "B"));
18336 else if (last_text_row
)
18338 /* We have displayed either to the end of the window or at the
18339 end of the window, i.e. the last row with text is to be found
18340 in the desired matrix. */
18341 adjust_window_ends (w
, last_text_row
, 0);
18342 eassert (w
->window_end_bytepos
>= 0);
18344 else if (first_unchanged_at_end_row
== NULL
18345 && last_text_row
== NULL
18346 && last_text_row_at_end
== NULL
)
18348 /* Displayed to end of window, but no line containing text was
18349 displayed. Lines were deleted at the end of the window. */
18350 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
18351 int vpos
= w
->window_end_vpos
;
18352 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18353 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18356 row
== NULL
&& vpos
>= first_vpos
;
18357 --vpos
, --current_row
, --desired_row
)
18359 if (desired_row
->enabled_p
)
18361 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18364 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18368 eassert (row
!= NULL
);
18369 w
->window_end_vpos
= vpos
+ 1;
18370 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18371 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18372 eassert (w
->window_end_bytepos
>= 0);
18373 IF_DEBUG (debug_method_add (w
, "C"));
18378 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18379 debug_end_vpos
= w
->window_end_vpos
));
18381 /* Record that display has not been completed. */
18382 w
->window_end_valid
= 0;
18383 w
->desired_matrix
->no_scrolling_p
= 1;
18391 /***********************************************************************
18392 More debugging support
18393 ***********************************************************************/
18397 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18398 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18399 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18402 /* Dump the contents of glyph matrix MATRIX on stderr.
18404 GLYPHS 0 means don't show glyph contents.
18405 GLYPHS 1 means show glyphs in short form
18406 GLYPHS > 1 means show glyphs in long form. */
18409 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18412 for (i
= 0; i
< matrix
->nrows
; ++i
)
18413 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18417 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18418 the glyph row and area where the glyph comes from. */
18421 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18423 if (glyph
->type
== CHAR_GLYPH
18424 || glyph
->type
== GLYPHLESS_GLYPH
)
18427 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18428 glyph
- row
->glyphs
[TEXT_AREA
],
18429 (glyph
->type
== CHAR_GLYPH
18433 (BUFFERP (glyph
->object
)
18435 : (STRINGP (glyph
->object
)
18437 : (INTEGERP (glyph
->object
)
18440 glyph
->pixel_width
,
18442 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18446 glyph
->left_box_line_p
,
18447 glyph
->right_box_line_p
);
18449 else if (glyph
->type
== STRETCH_GLYPH
)
18452 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18453 glyph
- row
->glyphs
[TEXT_AREA
],
18456 (BUFFERP (glyph
->object
)
18458 : (STRINGP (glyph
->object
)
18460 : (INTEGERP (glyph
->object
)
18463 glyph
->pixel_width
,
18467 glyph
->left_box_line_p
,
18468 glyph
->right_box_line_p
);
18470 else if (glyph
->type
== IMAGE_GLYPH
)
18473 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18474 glyph
- row
->glyphs
[TEXT_AREA
],
18477 (BUFFERP (glyph
->object
)
18479 : (STRINGP (glyph
->object
)
18481 : (INTEGERP (glyph
->object
)
18484 glyph
->pixel_width
,
18488 glyph
->left_box_line_p
,
18489 glyph
->right_box_line_p
);
18491 else if (glyph
->type
== COMPOSITE_GLYPH
)
18494 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18495 glyph
- row
->glyphs
[TEXT_AREA
],
18498 (BUFFERP (glyph
->object
)
18500 : (STRINGP (glyph
->object
)
18502 : (INTEGERP (glyph
->object
)
18505 glyph
->pixel_width
,
18507 if (glyph
->u
.cmp
.automatic
)
18510 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18511 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18513 glyph
->left_box_line_p
,
18514 glyph
->right_box_line_p
);
18519 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18520 GLYPHS 0 means don't show glyph contents.
18521 GLYPHS 1 means show glyphs in short form
18522 GLYPHS > 1 means show glyphs in long form. */
18525 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18529 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18530 fprintf (stderr
, "==============================================================================\n");
18532 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18533 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18535 MATRIX_ROW_START_CHARPOS (row
),
18536 MATRIX_ROW_END_CHARPOS (row
),
18537 row
->used
[TEXT_AREA
],
18538 row
->contains_overlapping_glyphs_p
,
18540 row
->truncated_on_left_p
,
18541 row
->truncated_on_right_p
,
18543 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18544 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18547 row
->ends_in_middle_of_char_p
,
18548 row
->starts_in_middle_of_char_p
,
18554 row
->visible_height
,
18557 /* The next 3 lines should align to "Start" in the header. */
18558 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18559 row
->end
.overlay_string_index
,
18560 row
->continuation_lines_width
);
18561 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18562 CHARPOS (row
->start
.string_pos
),
18563 CHARPOS (row
->end
.string_pos
));
18564 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18565 row
->end
.dpvec_index
);
18572 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18574 struct glyph
*glyph
= row
->glyphs
[area
];
18575 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18577 /* Glyph for a line end in text. */
18578 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18581 if (glyph
< glyph_end
)
18582 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18584 for (; glyph
< glyph_end
; ++glyph
)
18585 dump_glyph (row
, glyph
, area
);
18588 else if (glyphs
== 1)
18592 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18594 char *s
= alloca (row
->used
[area
] + 4);
18597 for (i
= 0; i
< row
->used
[area
]; ++i
)
18599 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18600 if (i
== row
->used
[area
] - 1
18601 && area
== TEXT_AREA
18602 && INTEGERP (glyph
->object
)
18603 && glyph
->type
== CHAR_GLYPH
18604 && glyph
->u
.ch
== ' ')
18606 strcpy (&s
[i
], "[\\n]");
18609 else if (glyph
->type
== CHAR_GLYPH
18610 && glyph
->u
.ch
< 0x80
18611 && glyph
->u
.ch
>= ' ')
18612 s
[i
] = glyph
->u
.ch
;
18618 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18624 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18625 Sdump_glyph_matrix
, 0, 1, "p",
18626 doc
: /* Dump the current matrix of the selected window to stderr.
18627 Shows contents of glyph row structures. With non-nil
18628 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18629 glyphs in short form, otherwise show glyphs in long form. */)
18630 (Lisp_Object glyphs
)
18632 struct window
*w
= XWINDOW (selected_window
);
18633 struct buffer
*buffer
= XBUFFER (w
->contents
);
18635 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18636 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18637 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18638 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18639 fprintf (stderr
, "=============================================\n");
18640 dump_glyph_matrix (w
->current_matrix
,
18641 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18646 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18647 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
18650 struct frame
*f
= XFRAME (selected_frame
);
18651 dump_glyph_matrix (f
->current_matrix
, 1);
18656 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18657 doc
: /* Dump glyph row ROW to stderr.
18658 GLYPH 0 means don't dump glyphs.
18659 GLYPH 1 means dump glyphs in short form.
18660 GLYPH > 1 or omitted means dump glyphs in long form. */)
18661 (Lisp_Object row
, Lisp_Object glyphs
)
18663 struct glyph_matrix
*matrix
;
18666 CHECK_NUMBER (row
);
18667 matrix
= XWINDOW (selected_window
)->current_matrix
;
18669 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18670 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18672 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18677 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18678 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18679 GLYPH 0 means don't dump glyphs.
18680 GLYPH 1 means dump glyphs in short form.
18681 GLYPH > 1 or omitted means dump glyphs in long form.
18683 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18685 (Lisp_Object row
, Lisp_Object glyphs
)
18687 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18688 struct frame
*sf
= SELECTED_FRAME ();
18689 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18692 CHECK_NUMBER (row
);
18694 if (vpos
>= 0 && vpos
< m
->nrows
)
18695 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18696 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18702 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18703 doc
: /* Toggle tracing of redisplay.
18704 With ARG, turn tracing on if and only if ARG is positive. */)
18708 trace_redisplay_p
= !trace_redisplay_p
;
18711 arg
= Fprefix_numeric_value (arg
);
18712 trace_redisplay_p
= XINT (arg
) > 0;
18719 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18720 doc
: /* Like `format', but print result to stderr.
18721 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18722 (ptrdiff_t nargs
, Lisp_Object
*args
)
18724 Lisp_Object s
= Fformat (nargs
, args
);
18725 fprintf (stderr
, "%s", SDATA (s
));
18729 #endif /* GLYPH_DEBUG */
18733 /***********************************************************************
18734 Building Desired Matrix Rows
18735 ***********************************************************************/
18737 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18738 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18740 static struct glyph_row
*
18741 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18743 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18744 struct buffer
*buffer
= XBUFFER (w
->contents
);
18745 struct buffer
*old
= current_buffer
;
18746 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18747 int arrow_len
= SCHARS (overlay_arrow_string
);
18748 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18749 const unsigned char *p
;
18752 int n_glyphs_before
;
18754 set_buffer_temp (buffer
);
18755 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18756 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18757 SET_TEXT_POS (it
.position
, 0, 0);
18759 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18761 while (p
< arrow_end
)
18763 Lisp_Object face
, ilisp
;
18765 /* Get the next character. */
18767 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18770 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18771 if (! ASCII_CHAR_P (it
.c
))
18772 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18776 /* Get its face. */
18777 ilisp
= make_number (p
- arrow_string
);
18778 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18779 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18781 /* Compute its width, get its glyphs. */
18782 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18783 SET_TEXT_POS (it
.position
, -1, -1);
18784 PRODUCE_GLYPHS (&it
);
18786 /* If this character doesn't fit any more in the line, we have
18787 to remove some glyphs. */
18788 if (it
.current_x
> it
.last_visible_x
)
18790 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18795 set_buffer_temp (old
);
18796 return it
.glyph_row
;
18800 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18801 glyphs to insert is determined by produce_special_glyphs. */
18804 insert_left_trunc_glyphs (struct it
*it
)
18806 struct it truncate_it
;
18807 struct glyph
*from
, *end
, *to
, *toend
;
18809 eassert (!FRAME_WINDOW_P (it
->f
)
18810 || (!it
->glyph_row
->reversed_p
18811 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18812 || (it
->glyph_row
->reversed_p
18813 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18815 /* Get the truncation glyphs. */
18817 truncate_it
.current_x
= 0;
18818 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18819 truncate_it
.glyph_row
= &scratch_glyph_row
;
18820 truncate_it
.area
= TEXT_AREA
;
18821 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18822 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18823 truncate_it
.object
= make_number (0);
18824 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18826 /* Overwrite glyphs from IT with truncation glyphs. */
18827 if (!it
->glyph_row
->reversed_p
)
18829 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18831 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18832 end
= from
+ tused
;
18833 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18834 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18835 if (FRAME_WINDOW_P (it
->f
))
18837 /* On GUI frames, when variable-size fonts are displayed,
18838 the truncation glyphs may need more pixels than the row's
18839 glyphs they overwrite. We overwrite more glyphs to free
18840 enough screen real estate, and enlarge the stretch glyph
18841 on the right (see display_line), if there is one, to
18842 preserve the screen position of the truncation glyphs on
18845 struct glyph
*g
= to
;
18848 /* The first glyph could be partially visible, in which case
18849 it->glyph_row->x will be negative. But we want the left
18850 truncation glyphs to be aligned at the left margin of the
18851 window, so we override the x coordinate at which the row
18853 it
->glyph_row
->x
= 0;
18854 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18856 w
+= g
->pixel_width
;
18859 if (g
- to
- tused
> 0)
18861 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18862 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18864 used
= it
->glyph_row
->used
[TEXT_AREA
];
18865 if (it
->glyph_row
->truncated_on_right_p
18866 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18867 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18870 int extra
= w
- it
->truncation_pixel_width
;
18872 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18879 /* There may be padding glyphs left over. Overwrite them too. */
18880 if (!FRAME_WINDOW_P (it
->f
))
18882 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18884 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18891 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18895 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18897 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18898 that back to front. */
18899 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18900 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18901 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18902 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18903 if (FRAME_WINDOW_P (it
->f
))
18906 struct glyph
*g
= to
;
18908 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
18910 w
+= g
->pixel_width
;
18913 if (to
- g
- tused
> 0)
18915 if (it
->glyph_row
->truncated_on_right_p
18916 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
18917 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
18919 int extra
= w
- it
->truncation_pixel_width
;
18921 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
18925 while (from
>= end
&& to
>= toend
)
18927 if (!FRAME_WINDOW_P (it
->f
))
18929 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18932 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18933 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18934 while (from
>= end
&& to
>= toend
)
18940 /* Need to free some room before prepending additional
18942 int move_by
= from
- end
+ 1;
18943 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18944 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18946 for ( ; g
>= g0
; g
--)
18948 while (from
>= end
)
18950 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18955 /* Compute the hash code for ROW. */
18957 row_hash (struct glyph_row
*row
)
18960 unsigned hashval
= 0;
18962 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18963 for (k
= 0; k
< row
->used
[area
]; ++k
)
18964 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18965 + row
->glyphs
[area
][k
].u
.val
18966 + row
->glyphs
[area
][k
].face_id
18967 + row
->glyphs
[area
][k
].padding_p
18968 + (row
->glyphs
[area
][k
].type
<< 2));
18973 /* Compute the pixel height and width of IT->glyph_row.
18975 Most of the time, ascent and height of a display line will be equal
18976 to the max_ascent and max_height values of the display iterator
18977 structure. This is not the case if
18979 1. We hit ZV without displaying anything. In this case, max_ascent
18980 and max_height will be zero.
18982 2. We have some glyphs that don't contribute to the line height.
18983 (The glyph row flag contributes_to_line_height_p is for future
18984 pixmap extensions).
18986 The first case is easily covered by using default values because in
18987 these cases, the line height does not really matter, except that it
18988 must not be zero. */
18991 compute_line_metrics (struct it
*it
)
18993 struct glyph_row
*row
= it
->glyph_row
;
18995 if (FRAME_WINDOW_P (it
->f
))
18997 int i
, min_y
, max_y
;
18999 /* The line may consist of one space only, that was added to
19000 place the cursor on it. If so, the row's height hasn't been
19002 if (row
->height
== 0)
19004 if (it
->max_ascent
+ it
->max_descent
== 0)
19005 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19006 row
->ascent
= it
->max_ascent
;
19007 row
->height
= it
->max_ascent
+ it
->max_descent
;
19008 row
->phys_ascent
= it
->max_phys_ascent
;
19009 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19010 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19013 /* Compute the width of this line. */
19014 row
->pixel_width
= row
->x
;
19015 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19016 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19018 eassert (row
->pixel_width
>= 0);
19019 eassert (row
->ascent
>= 0 && row
->height
> 0);
19021 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19022 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19024 /* If first line's physical ascent is larger than its logical
19025 ascent, use the physical ascent, and make the row taller.
19026 This makes accented characters fully visible. */
19027 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19028 && row
->phys_ascent
> row
->ascent
)
19030 row
->height
+= row
->phys_ascent
- row
->ascent
;
19031 row
->ascent
= row
->phys_ascent
;
19034 /* Compute how much of the line is visible. */
19035 row
->visible_height
= row
->height
;
19037 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19038 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19040 if (row
->y
< min_y
)
19041 row
->visible_height
-= min_y
- row
->y
;
19042 if (row
->y
+ row
->height
> max_y
)
19043 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19047 row
->pixel_width
= row
->used
[TEXT_AREA
];
19048 if (row
->continued_p
)
19049 row
->pixel_width
-= it
->continuation_pixel_width
;
19050 else if (row
->truncated_on_right_p
)
19051 row
->pixel_width
-= it
->truncation_pixel_width
;
19052 row
->ascent
= row
->phys_ascent
= 0;
19053 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19054 row
->extra_line_spacing
= 0;
19057 /* Compute a hash code for this row. */
19058 row
->hash
= row_hash (row
);
19060 it
->max_ascent
= it
->max_descent
= 0;
19061 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19065 /* Append one space to the glyph row of iterator IT if doing a
19066 window-based redisplay. The space has the same face as
19067 IT->face_id. Value is non-zero if a space was added.
19069 This function is called to make sure that there is always one glyph
19070 at the end of a glyph row that the cursor can be set on under
19071 window-systems. (If there weren't such a glyph we would not know
19072 how wide and tall a box cursor should be displayed).
19074 At the same time this space let's a nicely handle clearing to the
19075 end of the line if the row ends in italic text. */
19078 append_space_for_newline (struct it
*it
, int default_face_p
)
19080 if (FRAME_WINDOW_P (it
->f
))
19082 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19084 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19085 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19087 /* Save some values that must not be changed.
19088 Must save IT->c and IT->len because otherwise
19089 ITERATOR_AT_END_P wouldn't work anymore after
19090 append_space_for_newline has been called. */
19091 enum display_element_type saved_what
= it
->what
;
19092 int saved_c
= it
->c
, saved_len
= it
->len
;
19093 int saved_char_to_display
= it
->char_to_display
;
19094 int saved_x
= it
->current_x
;
19095 int saved_face_id
= it
->face_id
;
19096 int saved_box_end
= it
->end_of_box_run_p
;
19097 struct text_pos saved_pos
;
19098 Lisp_Object saved_object
;
19101 saved_object
= it
->object
;
19102 saved_pos
= it
->position
;
19104 it
->what
= IT_CHARACTER
;
19105 memset (&it
->position
, 0, sizeof it
->position
);
19106 it
->object
= make_number (0);
19107 it
->c
= it
->char_to_display
= ' ';
19110 /* If the default face was remapped, be sure to use the
19111 remapped face for the appended newline. */
19112 if (default_face_p
)
19113 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19114 else if (it
->face_before_selective_p
)
19115 it
->face_id
= it
->saved_face_id
;
19116 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19117 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19118 /* In R2L rows, we will prepend a stretch glyph that will
19119 have the end_of_box_run_p flag set for it, so there's no
19120 need for the appended newline glyph to have that flag
19122 if (it
->glyph_row
->reversed_p
19123 /* But if the appended newline glyph goes all the way to
19124 the end of the row, there will be no stretch glyph,
19125 so leave the box flag set. */
19126 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19127 it
->end_of_box_run_p
= 0;
19129 PRODUCE_GLYPHS (it
);
19131 it
->override_ascent
= -1;
19132 it
->constrain_row_ascent_descent_p
= 0;
19133 it
->current_x
= saved_x
;
19134 it
->object
= saved_object
;
19135 it
->position
= saved_pos
;
19136 it
->what
= saved_what
;
19137 it
->face_id
= saved_face_id
;
19138 it
->len
= saved_len
;
19140 it
->char_to_display
= saved_char_to_display
;
19141 it
->end_of_box_run_p
= saved_box_end
;
19150 /* Extend the face of the last glyph in the text area of IT->glyph_row
19151 to the end of the display line. Called from display_line. If the
19152 glyph row is empty, add a space glyph to it so that we know the
19153 face to draw. Set the glyph row flag fill_line_p. If the glyph
19154 row is R2L, prepend a stretch glyph to cover the empty space to the
19155 left of the leftmost glyph. */
19158 extend_face_to_end_of_line (struct it
*it
)
19160 struct face
*face
, *default_face
;
19161 struct frame
*f
= it
->f
;
19163 /* If line is already filled, do nothing. Non window-system frames
19164 get a grace of one more ``pixel'' because their characters are
19165 1-``pixel'' wide, so they hit the equality too early. This grace
19166 is needed only for R2L rows that are not continued, to produce
19167 one extra blank where we could display the cursor. */
19168 if ((it
->current_x
>= it
->last_visible_x
19169 + (!FRAME_WINDOW_P (f
)
19170 && it
->glyph_row
->reversed_p
19171 && !it
->glyph_row
->continued_p
))
19172 /* If the window has display margins, we will need to extend
19173 their face even if the text area is filled. */
19174 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19175 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19178 /* The default face, possibly remapped. */
19179 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19181 /* Face extension extends the background and box of IT->face_id
19182 to the end of the line. If the background equals the background
19183 of the frame, we don't have to do anything. */
19184 if (it
->face_before_selective_p
)
19185 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19187 face
= FACE_FROM_ID (f
, it
->face_id
);
19189 if (FRAME_WINDOW_P (f
)
19190 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19191 && face
->box
== FACE_NO_BOX
19192 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19193 #ifdef HAVE_WINDOW_SYSTEM
19196 && !it
->glyph_row
->reversed_p
)
19199 /* Set the glyph row flag indicating that the face of the last glyph
19200 in the text area has to be drawn to the end of the text area. */
19201 it
->glyph_row
->fill_line_p
= 1;
19203 /* If current character of IT is not ASCII, make sure we have the
19204 ASCII face. This will be automatically undone the next time
19205 get_next_display_element returns a multibyte character. Note
19206 that the character will always be single byte in unibyte
19208 if (!ASCII_CHAR_P (it
->c
))
19210 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19213 if (FRAME_WINDOW_P (f
))
19215 /* If the row is empty, add a space with the current face of IT,
19216 so that we know which face to draw. */
19217 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19219 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19220 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19221 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19223 /* Mode line and the header line don't have margins, and
19224 likewise the frame's tool-bar window, if there is any. */
19225 if (!(it
->glyph_row
->mode_line_p
19226 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19227 || (WINDOWP (f
->tool_bar_window
)
19228 && it
->w
== XWINDOW (f
->tool_bar_window
))
19232 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19233 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19235 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19236 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19238 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19240 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19241 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19243 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19244 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19246 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19249 #ifdef HAVE_WINDOW_SYSTEM
19250 if (it
->glyph_row
->reversed_p
)
19252 /* Prepend a stretch glyph to the row, such that the
19253 rightmost glyph will be drawn flushed all the way to the
19254 right margin of the window. The stretch glyph that will
19255 occupy the empty space, if any, to the left of the
19257 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19258 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19259 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19261 int row_width
, stretch_ascent
, stretch_width
;
19262 struct text_pos saved_pos
;
19263 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
19265 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19266 row_width
+= g
->pixel_width
;
19267 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
19268 if (stretch_width
> 0)
19271 (((it
->ascent
+ it
->descent
)
19272 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19273 saved_pos
= it
->position
;
19274 memset (&it
->position
, 0, sizeof it
->position
);
19275 saved_avoid_cursor
= it
->avoid_cursor_p
;
19276 it
->avoid_cursor_p
= 1;
19277 saved_face_id
= it
->face_id
;
19278 saved_box_start
= it
->start_of_box_run_p
;
19279 /* The last row's stretch glyph should get the default
19280 face, to avoid painting the rest of the window with
19281 the region face, if the region ends at ZV. */
19282 if (it
->glyph_row
->ends_at_zv_p
)
19283 it
->face_id
= default_face
->id
;
19285 it
->face_id
= face
->id
;
19286 it
->start_of_box_run_p
= 0;
19287 append_stretch_glyph (it
, make_number (0), stretch_width
,
19288 it
->ascent
+ it
->descent
, stretch_ascent
);
19289 it
->position
= saved_pos
;
19290 it
->avoid_cursor_p
= saved_avoid_cursor
;
19291 it
->face_id
= saved_face_id
;
19292 it
->start_of_box_run_p
= saved_box_start
;
19295 #endif /* HAVE_WINDOW_SYSTEM */
19299 /* Save some values that must not be changed. */
19300 int saved_x
= it
->current_x
;
19301 struct text_pos saved_pos
;
19302 Lisp_Object saved_object
;
19303 enum display_element_type saved_what
= it
->what
;
19304 int saved_face_id
= it
->face_id
;
19306 saved_object
= it
->object
;
19307 saved_pos
= it
->position
;
19309 it
->what
= IT_CHARACTER
;
19310 memset (&it
->position
, 0, sizeof it
->position
);
19311 it
->object
= make_number (0);
19312 it
->c
= it
->char_to_display
= ' ';
19315 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19316 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19317 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19318 && !it
->glyph_row
->mode_line_p
19319 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19321 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19322 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19324 for (it
->current_x
= 0; g
< e
; g
++)
19325 it
->current_x
+= g
->pixel_width
;
19327 it
->area
= LEFT_MARGIN_AREA
;
19328 it
->face_id
= default_face
->id
;
19329 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19330 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19332 PRODUCE_GLYPHS (it
);
19333 /* term.c:produce_glyphs advances it->current_x only for
19335 it
->current_x
+= it
->pixel_width
;
19338 it
->current_x
= saved_x
;
19339 it
->area
= TEXT_AREA
;
19342 /* The last row's blank glyphs should get the default face, to
19343 avoid painting the rest of the window with the region face,
19344 if the region ends at ZV. */
19345 if (it
->glyph_row
->ends_at_zv_p
)
19346 it
->face_id
= default_face
->id
;
19348 it
->face_id
= face
->id
;
19349 PRODUCE_GLYPHS (it
);
19351 while (it
->current_x
<= it
->last_visible_x
)
19352 PRODUCE_GLYPHS (it
);
19354 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19355 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19356 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19357 && !it
->glyph_row
->mode_line_p
19358 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19360 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19361 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19363 for ( ; g
< e
; g
++)
19364 it
->current_x
+= g
->pixel_width
;
19366 it
->area
= RIGHT_MARGIN_AREA
;
19367 it
->face_id
= default_face
->id
;
19368 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19369 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19371 PRODUCE_GLYPHS (it
);
19372 it
->current_x
+= it
->pixel_width
;
19375 it
->area
= TEXT_AREA
;
19378 /* Don't count these blanks really. It would let us insert a left
19379 truncation glyph below and make us set the cursor on them, maybe. */
19380 it
->current_x
= saved_x
;
19381 it
->object
= saved_object
;
19382 it
->position
= saved_pos
;
19383 it
->what
= saved_what
;
19384 it
->face_id
= saved_face_id
;
19389 /* Value is non-zero if text starting at CHARPOS in current_buffer is
19390 trailing whitespace. */
19393 trailing_whitespace_p (ptrdiff_t charpos
)
19395 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19398 while (bytepos
< ZV_BYTE
19399 && (c
= FETCH_CHAR (bytepos
),
19400 c
== ' ' || c
== '\t'))
19403 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19405 if (bytepos
!= PT_BYTE
)
19412 /* Highlight trailing whitespace, if any, in ROW. */
19415 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19417 int used
= row
->used
[TEXT_AREA
];
19421 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19422 struct glyph
*glyph
= start
+ used
- 1;
19424 if (row
->reversed_p
)
19426 /* Right-to-left rows need to be processed in the opposite
19427 direction, so swap the edge pointers. */
19429 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19432 /* Skip over glyphs inserted to display the cursor at the
19433 end of a line, for extending the face of the last glyph
19434 to the end of the line on terminals, and for truncation
19435 and continuation glyphs. */
19436 if (!row
->reversed_p
)
19438 while (glyph
>= start
19439 && glyph
->type
== CHAR_GLYPH
19440 && INTEGERP (glyph
->object
))
19445 while (glyph
<= start
19446 && glyph
->type
== CHAR_GLYPH
19447 && INTEGERP (glyph
->object
))
19451 /* If last glyph is a space or stretch, and it's trailing
19452 whitespace, set the face of all trailing whitespace glyphs in
19453 IT->glyph_row to `trailing-whitespace'. */
19454 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19455 && BUFFERP (glyph
->object
)
19456 && (glyph
->type
== STRETCH_GLYPH
19457 || (glyph
->type
== CHAR_GLYPH
19458 && glyph
->u
.ch
== ' '))
19459 && trailing_whitespace_p (glyph
->charpos
))
19461 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
19465 if (!row
->reversed_p
)
19467 while (glyph
>= start
19468 && BUFFERP (glyph
->object
)
19469 && (glyph
->type
== STRETCH_GLYPH
19470 || (glyph
->type
== CHAR_GLYPH
19471 && glyph
->u
.ch
== ' ')))
19472 (glyph
--)->face_id
= face_id
;
19476 while (glyph
<= start
19477 && BUFFERP (glyph
->object
)
19478 && (glyph
->type
== STRETCH_GLYPH
19479 || (glyph
->type
== CHAR_GLYPH
19480 && glyph
->u
.ch
== ' ')))
19481 (glyph
++)->face_id
= face_id
;
19488 /* Value is non-zero if glyph row ROW should be
19489 considered to hold the buffer position CHARPOS. */
19492 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19496 if (charpos
== CHARPOS (row
->end
.pos
)
19497 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19499 /* Suppose the row ends on a string.
19500 Unless the row is continued, that means it ends on a newline
19501 in the string. If it's anything other than a display string
19502 (e.g., a before-string from an overlay), we don't want the
19503 cursor there. (This heuristic seems to give the optimal
19504 behavior for the various types of multi-line strings.)
19505 One exception: if the string has `cursor' property on one of
19506 its characters, we _do_ want the cursor there. */
19507 if (CHARPOS (row
->end
.string_pos
) >= 0)
19509 if (row
->continued_p
)
19513 /* Check for `display' property. */
19514 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19515 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19516 struct glyph
*glyph
;
19519 for (glyph
= end
; glyph
>= beg
; --glyph
)
19520 if (STRINGP (glyph
->object
))
19523 = Fget_char_property (make_number (charpos
),
19527 && display_prop_string_p (prop
, glyph
->object
));
19528 /* If there's a `cursor' property on one of the
19529 string's characters, this row is a cursor row,
19530 even though this is not a display string. */
19533 Lisp_Object s
= glyph
->object
;
19535 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19537 ptrdiff_t gpos
= glyph
->charpos
;
19539 if (!NILP (Fget_char_property (make_number (gpos
),
19551 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19553 /* If the row ends in middle of a real character,
19554 and the line is continued, we want the cursor here.
19555 That's because CHARPOS (ROW->end.pos) would equal
19556 PT if PT is before the character. */
19557 if (!row
->ends_in_ellipsis_p
)
19558 result
= row
->continued_p
;
19560 /* If the row ends in an ellipsis, then
19561 CHARPOS (ROW->end.pos) will equal point after the
19562 invisible text. We want that position to be displayed
19563 after the ellipsis. */
19566 /* If the row ends at ZV, display the cursor at the end of that
19567 row instead of at the start of the row below. */
19568 else if (row
->ends_at_zv_p
)
19577 /* Value is non-zero if glyph row ROW should be
19578 used to hold the cursor. */
19581 cursor_row_p (struct glyph_row
*row
)
19583 return row_for_charpos_p (row
, PT
);
19588 /* Push the property PROP so that it will be rendered at the current
19589 position in IT. Return 1 if PROP was successfully pushed, 0
19590 otherwise. Called from handle_line_prefix to handle the
19591 `line-prefix' and `wrap-prefix' properties. */
19594 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19596 struct text_pos pos
=
19597 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19599 eassert (it
->method
== GET_FROM_BUFFER
19600 || it
->method
== GET_FROM_DISPLAY_VECTOR
19601 || it
->method
== GET_FROM_STRING
);
19603 /* We need to save the current buffer/string position, so it will be
19604 restored by pop_it, because iterate_out_of_display_property
19605 depends on that being set correctly, but some situations leave
19606 it->position not yet set when this function is called. */
19607 push_it (it
, &pos
);
19609 if (STRINGP (prop
))
19611 if (SCHARS (prop
) == 0)
19618 it
->string_from_prefix_prop_p
= 1;
19619 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19620 it
->current
.overlay_string_index
= -1;
19621 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19622 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19623 it
->method
= GET_FROM_STRING
;
19624 it
->stop_charpos
= 0;
19626 it
->base_level_stop
= 0;
19628 /* Force paragraph direction to be that of the parent
19630 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19631 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19633 it
->paragraph_embedding
= L2R
;
19635 /* Set up the bidi iterator for this display string. */
19638 it
->bidi_it
.string
.lstring
= it
->string
;
19639 it
->bidi_it
.string
.s
= NULL
;
19640 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19641 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19642 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19643 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19644 it
->bidi_it
.w
= it
->w
;
19645 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19648 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19650 it
->method
= GET_FROM_STRETCH
;
19653 #ifdef HAVE_WINDOW_SYSTEM
19654 else if (IMAGEP (prop
))
19656 it
->what
= IT_IMAGE
;
19657 it
->image_id
= lookup_image (it
->f
, prop
);
19658 it
->method
= GET_FROM_IMAGE
;
19660 #endif /* HAVE_WINDOW_SYSTEM */
19663 pop_it (it
); /* bogus display property, give up */
19670 /* Return the character-property PROP at the current position in IT. */
19673 get_it_property (struct it
*it
, Lisp_Object prop
)
19675 Lisp_Object position
, object
= it
->object
;
19677 if (STRINGP (object
))
19678 position
= make_number (IT_STRING_CHARPOS (*it
));
19679 else if (BUFFERP (object
))
19681 position
= make_number (IT_CHARPOS (*it
));
19682 object
= it
->window
;
19687 return Fget_char_property (position
, prop
, object
);
19690 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19693 handle_line_prefix (struct it
*it
)
19695 Lisp_Object prefix
;
19697 if (it
->continuation_lines_width
> 0)
19699 prefix
= get_it_property (it
, Qwrap_prefix
);
19701 prefix
= Vwrap_prefix
;
19705 prefix
= get_it_property (it
, Qline_prefix
);
19707 prefix
= Vline_prefix
;
19709 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19711 /* If the prefix is wider than the window, and we try to wrap
19712 it, it would acquire its own wrap prefix, and so on till the
19713 iterator stack overflows. So, don't wrap the prefix. */
19714 it
->line_wrap
= TRUNCATE
;
19715 it
->avoid_cursor_p
= 1;
19721 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19722 only for R2L lines from display_line and display_string, when they
19723 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19724 the line/string needs to be continued on the next glyph row. */
19726 unproduce_glyphs (struct it
*it
, int n
)
19728 struct glyph
*glyph
, *end
;
19730 eassert (it
->glyph_row
);
19731 eassert (it
->glyph_row
->reversed_p
);
19732 eassert (it
->area
== TEXT_AREA
);
19733 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19735 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19736 n
= it
->glyph_row
->used
[TEXT_AREA
];
19737 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19738 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19739 for ( ; glyph
< end
; glyph
++)
19740 glyph
[-n
] = *glyph
;
19743 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19744 and ROW->maxpos. */
19746 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19747 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19748 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19750 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19751 lines' rows is implemented for bidi-reordered rows. */
19753 /* ROW->minpos is the value of min_pos, the minimal buffer position
19754 we have in ROW, or ROW->start.pos if that is smaller. */
19755 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19756 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19758 /* We didn't find buffer positions smaller than ROW->start, or
19759 didn't find _any_ valid buffer positions in any of the glyphs,
19760 so we must trust the iterator's computed positions. */
19761 row
->minpos
= row
->start
.pos
;
19764 max_pos
= CHARPOS (it
->current
.pos
);
19765 max_bpos
= BYTEPOS (it
->current
.pos
);
19768 /* Here are the various use-cases for ending the row, and the
19769 corresponding values for ROW->maxpos:
19771 Line ends in a newline from buffer eol_pos + 1
19772 Line is continued from buffer max_pos + 1
19773 Line is truncated on right it->current.pos
19774 Line ends in a newline from string max_pos + 1(*)
19775 (*) + 1 only when line ends in a forward scan
19776 Line is continued from string max_pos
19777 Line is continued from display vector max_pos
19778 Line is entirely from a string min_pos == max_pos
19779 Line is entirely from a display vector min_pos == max_pos
19780 Line that ends at ZV ZV
19782 If you discover other use-cases, please add them here as
19784 if (row
->ends_at_zv_p
)
19785 row
->maxpos
= it
->current
.pos
;
19786 else if (row
->used
[TEXT_AREA
])
19788 int seen_this_string
= 0;
19789 struct glyph_row
*r1
= row
- 1;
19791 /* Did we see the same display string on the previous row? */
19792 if (STRINGP (it
->object
)
19793 /* this is not the first row */
19794 && row
> it
->w
->desired_matrix
->rows
19795 /* previous row is not the header line */
19796 && !r1
->mode_line_p
19797 /* previous row also ends in a newline from a string */
19798 && r1
->ends_in_newline_from_string_p
)
19800 struct glyph
*start
, *end
;
19802 /* Search for the last glyph of the previous row that came
19803 from buffer or string. Depending on whether the row is
19804 L2R or R2L, we need to process it front to back or the
19805 other way round. */
19806 if (!r1
->reversed_p
)
19808 start
= r1
->glyphs
[TEXT_AREA
];
19809 end
= start
+ r1
->used
[TEXT_AREA
];
19810 /* Glyphs inserted by redisplay have an integer (zero)
19811 as their object. */
19813 && INTEGERP ((end
- 1)->object
)
19814 && (end
- 1)->charpos
<= 0)
19818 if (EQ ((end
- 1)->object
, it
->object
))
19819 seen_this_string
= 1;
19822 /* If all the glyphs of the previous row were inserted
19823 by redisplay, it means the previous row was
19824 produced from a single newline, which is only
19825 possible if that newline came from the same string
19826 as the one which produced this ROW. */
19827 seen_this_string
= 1;
19831 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19832 start
= end
+ r1
->used
[TEXT_AREA
];
19834 && INTEGERP ((end
+ 1)->object
)
19835 && (end
+ 1)->charpos
<= 0)
19839 if (EQ ((end
+ 1)->object
, it
->object
))
19840 seen_this_string
= 1;
19843 seen_this_string
= 1;
19846 /* Take note of each display string that covers a newline only
19847 once, the first time we see it. This is for when a display
19848 string includes more than one newline in it. */
19849 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
19851 /* If we were scanning the buffer forward when we displayed
19852 the string, we want to account for at least one buffer
19853 position that belongs to this row (position covered by
19854 the display string), so that cursor positioning will
19855 consider this row as a candidate when point is at the end
19856 of the visual line represented by this row. This is not
19857 required when scanning back, because max_pos will already
19858 have a much larger value. */
19859 if (CHARPOS (row
->end
.pos
) > max_pos
)
19860 INC_BOTH (max_pos
, max_bpos
);
19861 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19863 else if (CHARPOS (it
->eol_pos
) > 0)
19864 SET_TEXT_POS (row
->maxpos
,
19865 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
19866 else if (row
->continued_p
)
19868 /* If max_pos is different from IT's current position, it
19869 means IT->method does not belong to the display element
19870 at max_pos. However, it also means that the display
19871 element at max_pos was displayed in its entirety on this
19872 line, which is equivalent to saying that the next line
19873 starts at the next buffer position. */
19874 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
19875 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19878 INC_BOTH (max_pos
, max_bpos
);
19879 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19882 else if (row
->truncated_on_right_p
)
19883 /* display_line already called reseat_at_next_visible_line_start,
19884 which puts the iterator at the beginning of the next line, in
19885 the logical order. */
19886 row
->maxpos
= it
->current
.pos
;
19887 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
19888 /* A line that is entirely from a string/image/stretch... */
19889 row
->maxpos
= row
->minpos
;
19894 row
->maxpos
= it
->current
.pos
;
19897 /* Construct the glyph row IT->glyph_row in the desired matrix of
19898 IT->w from text at the current position of IT. See dispextern.h
19899 for an overview of struct it. Value is non-zero if
19900 IT->glyph_row displays text, as opposed to a line displaying ZV
19904 display_line (struct it
*it
)
19906 struct glyph_row
*row
= it
->glyph_row
;
19907 Lisp_Object overlay_arrow_string
;
19909 void *wrap_data
= NULL
;
19910 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
19911 int wrap_row_used
= -1;
19912 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
19913 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
19914 int wrap_row_extra_line_spacing
IF_LINT (= 0);
19915 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
19916 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
19918 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
19919 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
19921 /* We always start displaying at hpos zero even if hscrolled. */
19922 eassert (it
->hpos
== 0 && it
->current_x
== 0);
19924 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
19925 >= it
->w
->desired_matrix
->nrows
)
19927 it
->w
->nrows_scale_factor
++;
19928 it
->f
->fonts_changed
= 1;
19932 /* Clear the result glyph row and enable it. */
19933 prepare_desired_row (it
->w
, row
, false);
19935 row
->y
= it
->current_y
;
19936 row
->start
= it
->start
;
19937 row
->continuation_lines_width
= it
->continuation_lines_width
;
19938 row
->displays_text_p
= 1;
19939 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
19940 it
->starts_in_middle_of_char_p
= 0;
19942 /* Arrange the overlays nicely for our purposes. Usually, we call
19943 display_line on only one line at a time, in which case this
19944 can't really hurt too much, or we call it on lines which appear
19945 one after another in the buffer, in which case all calls to
19946 recenter_overlay_lists but the first will be pretty cheap. */
19947 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
19949 /* Move over display elements that are not visible because we are
19950 hscrolled. This may stop at an x-position < IT->first_visible_x
19951 if the first glyph is partially visible or if we hit a line end. */
19952 if (it
->current_x
< it
->first_visible_x
)
19954 enum move_it_result move_result
;
19956 this_line_min_pos
= row
->start
.pos
;
19957 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
19958 MOVE_TO_POS
| MOVE_TO_X
);
19959 /* If we are under a large hscroll, move_it_in_display_line_to
19960 could hit the end of the line without reaching
19961 it->first_visible_x. Pretend that we did reach it. This is
19962 especially important on a TTY, where we will call
19963 extend_face_to_end_of_line, which needs to know how many
19964 blank glyphs to produce. */
19965 if (it
->current_x
< it
->first_visible_x
19966 && (move_result
== MOVE_NEWLINE_OR_CR
19967 || move_result
== MOVE_POS_MATCH_OR_ZV
))
19968 it
->current_x
= it
->first_visible_x
;
19970 /* Record the smallest positions seen while we moved over
19971 display elements that are not visible. This is needed by
19972 redisplay_internal for optimizing the case where the cursor
19973 stays inside the same line. The rest of this function only
19974 considers positions that are actually displayed, so
19975 RECORD_MAX_MIN_POS will not otherwise record positions that
19976 are hscrolled to the left of the left edge of the window. */
19977 min_pos
= CHARPOS (this_line_min_pos
);
19978 min_bpos
= BYTEPOS (this_line_min_pos
);
19982 /* We only do this when not calling `move_it_in_display_line_to'
19983 above, because move_it_in_display_line_to calls
19984 handle_line_prefix itself. */
19985 handle_line_prefix (it
);
19988 /* Get the initial row height. This is either the height of the
19989 text hscrolled, if there is any, or zero. */
19990 row
->ascent
= it
->max_ascent
;
19991 row
->height
= it
->max_ascent
+ it
->max_descent
;
19992 row
->phys_ascent
= it
->max_phys_ascent
;
19993 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19994 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19996 /* Utility macro to record max and min buffer positions seen until now. */
19997 #define RECORD_MAX_MIN_POS(IT) \
20000 int composition_p = !STRINGP ((IT)->string) \
20001 && ((IT)->what == IT_COMPOSITION); \
20002 ptrdiff_t current_pos = \
20003 composition_p ? (IT)->cmp_it.charpos \
20004 : IT_CHARPOS (*(IT)); \
20005 ptrdiff_t current_bpos = \
20006 composition_p ? CHAR_TO_BYTE (current_pos) \
20007 : IT_BYTEPOS (*(IT)); \
20008 if (current_pos < min_pos) \
20010 min_pos = current_pos; \
20011 min_bpos = current_bpos; \
20013 if (IT_CHARPOS (*it) > max_pos) \
20015 max_pos = IT_CHARPOS (*it); \
20016 max_bpos = IT_BYTEPOS (*it); \
20021 /* Loop generating characters. The loop is left with IT on the next
20022 character to display. */
20025 int n_glyphs_before
, hpos_before
, x_before
;
20027 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20029 /* Retrieve the next thing to display. Value is zero if end of
20031 if (!get_next_display_element (it
))
20033 /* Maybe add a space at the end of this line that is used to
20034 display the cursor there under X. Set the charpos of the
20035 first glyph of blank lines not corresponding to any text
20037 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20038 row
->exact_window_width_line_p
= 1;
20039 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
20040 || row
->used
[TEXT_AREA
] == 0)
20042 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20043 row
->displays_text_p
= 0;
20045 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20046 && (!MINI_WINDOW_P (it
->w
)
20047 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20048 row
->indicate_empty_line_p
= 1;
20051 it
->continuation_lines_width
= 0;
20052 row
->ends_at_zv_p
= 1;
20053 /* A row that displays right-to-left text must always have
20054 its last face extended all the way to the end of line,
20055 even if this row ends in ZV, because we still write to
20056 the screen left to right. We also need to extend the
20057 last face if the default face is remapped to some
20058 different face, otherwise the functions that clear
20059 portions of the screen will clear with the default face's
20060 background color. */
20061 if (row
->reversed_p
20062 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20063 extend_face_to_end_of_line (it
);
20067 /* Now, get the metrics of what we want to display. This also
20068 generates glyphs in `row' (which is IT->glyph_row). */
20069 n_glyphs_before
= row
->used
[TEXT_AREA
];
20072 /* Remember the line height so far in case the next element doesn't
20073 fit on the line. */
20074 if (it
->line_wrap
!= TRUNCATE
)
20076 ascent
= it
->max_ascent
;
20077 descent
= it
->max_descent
;
20078 phys_ascent
= it
->max_phys_ascent
;
20079 phys_descent
= it
->max_phys_descent
;
20081 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20083 if (IT_DISPLAYING_WHITESPACE (it
))
20087 SAVE_IT (wrap_it
, *it
, wrap_data
);
20089 wrap_row_used
= row
->used
[TEXT_AREA
];
20090 wrap_row_ascent
= row
->ascent
;
20091 wrap_row_height
= row
->height
;
20092 wrap_row_phys_ascent
= row
->phys_ascent
;
20093 wrap_row_phys_height
= row
->phys_height
;
20094 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20095 wrap_row_min_pos
= min_pos
;
20096 wrap_row_min_bpos
= min_bpos
;
20097 wrap_row_max_pos
= max_pos
;
20098 wrap_row_max_bpos
= max_bpos
;
20104 PRODUCE_GLYPHS (it
);
20106 /* If this display element was in marginal areas, continue with
20108 if (it
->area
!= TEXT_AREA
)
20110 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20111 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20112 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20113 row
->phys_height
= max (row
->phys_height
,
20114 it
->max_phys_ascent
+ it
->max_phys_descent
);
20115 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20116 it
->max_extra_line_spacing
);
20117 set_iterator_to_next (it
, 1);
20121 /* Does the display element fit on the line? If we truncate
20122 lines, we should draw past the right edge of the window. If
20123 we don't truncate, we want to stop so that we can display the
20124 continuation glyph before the right margin. If lines are
20125 continued, there are two possible strategies for characters
20126 resulting in more than 1 glyph (e.g. tabs): Display as many
20127 glyphs as possible in this line and leave the rest for the
20128 continuation line, or display the whole element in the next
20129 line. Original redisplay did the former, so we do it also. */
20130 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20131 hpos_before
= it
->hpos
;
20134 if (/* Not a newline. */
20136 /* Glyphs produced fit entirely in the line. */
20137 && it
->current_x
< it
->last_visible_x
)
20139 it
->hpos
+= nglyphs
;
20140 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20141 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20142 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20143 row
->phys_height
= max (row
->phys_height
,
20144 it
->max_phys_ascent
+ it
->max_phys_descent
);
20145 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20146 it
->max_extra_line_spacing
);
20147 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
20148 row
->x
= x
- it
->first_visible_x
;
20149 /* Record the maximum and minimum buffer positions seen so
20150 far in glyphs that will be displayed by this row. */
20152 RECORD_MAX_MIN_POS (it
);
20157 struct glyph
*glyph
;
20159 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20161 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20162 new_x
= x
+ glyph
->pixel_width
;
20164 if (/* Lines are continued. */
20165 it
->line_wrap
!= TRUNCATE
20166 && (/* Glyph doesn't fit on the line. */
20167 new_x
> it
->last_visible_x
20168 /* Or it fits exactly on a window system frame. */
20169 || (new_x
== it
->last_visible_x
20170 && FRAME_WINDOW_P (it
->f
)
20171 && (row
->reversed_p
20172 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20173 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20175 /* End of a continued line. */
20178 || (new_x
== it
->last_visible_x
20179 && FRAME_WINDOW_P (it
->f
)
20180 && (row
->reversed_p
20181 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20182 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20184 /* Current glyph is the only one on the line or
20185 fits exactly on the line. We must continue
20186 the line because we can't draw the cursor
20187 after the glyph. */
20188 row
->continued_p
= 1;
20189 it
->current_x
= new_x
;
20190 it
->continuation_lines_width
+= new_x
;
20192 if (i
== nglyphs
- 1)
20194 /* If line-wrap is on, check if a previous
20195 wrap point was found. */
20196 if (wrap_row_used
> 0
20197 /* Even if there is a previous wrap
20198 point, continue the line here as
20199 usual, if (i) the previous character
20200 was a space or tab AND (ii) the
20201 current character is not. */
20203 || IT_DISPLAYING_WHITESPACE (it
)))
20206 /* Record the maximum and minimum buffer
20207 positions seen so far in glyphs that will be
20208 displayed by this row. */
20210 RECORD_MAX_MIN_POS (it
);
20211 set_iterator_to_next (it
, 1);
20212 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20214 if (!get_next_display_element (it
))
20216 row
->exact_window_width_line_p
= 1;
20217 it
->continuation_lines_width
= 0;
20218 row
->continued_p
= 0;
20219 row
->ends_at_zv_p
= 1;
20221 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20223 row
->continued_p
= 0;
20224 row
->exact_window_width_line_p
= 1;
20228 else if (it
->bidi_p
)
20229 RECORD_MAX_MIN_POS (it
);
20230 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20231 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20232 extend_face_to_end_of_line (it
);
20234 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20235 && !FRAME_WINDOW_P (it
->f
))
20237 /* A padding glyph that doesn't fit on this line.
20238 This means the whole character doesn't fit
20240 if (row
->reversed_p
)
20241 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20242 - n_glyphs_before
);
20243 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20245 /* Fill the rest of the row with continuation
20246 glyphs like in 20.x. */
20247 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20248 < row
->glyphs
[1 + TEXT_AREA
])
20249 produce_special_glyphs (it
, IT_CONTINUATION
);
20251 row
->continued_p
= 1;
20252 it
->current_x
= x_before
;
20253 it
->continuation_lines_width
+= x_before
;
20255 /* Restore the height to what it was before the
20256 element not fitting on the line. */
20257 it
->max_ascent
= ascent
;
20258 it
->max_descent
= descent
;
20259 it
->max_phys_ascent
= phys_ascent
;
20260 it
->max_phys_descent
= phys_descent
;
20261 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20262 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20263 extend_face_to_end_of_line (it
);
20265 else if (wrap_row_used
> 0)
20268 if (row
->reversed_p
)
20269 unproduce_glyphs (it
,
20270 row
->used
[TEXT_AREA
] - wrap_row_used
);
20271 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20272 it
->continuation_lines_width
+= wrap_x
;
20273 row
->used
[TEXT_AREA
] = wrap_row_used
;
20274 row
->ascent
= wrap_row_ascent
;
20275 row
->height
= wrap_row_height
;
20276 row
->phys_ascent
= wrap_row_phys_ascent
;
20277 row
->phys_height
= wrap_row_phys_height
;
20278 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20279 min_pos
= wrap_row_min_pos
;
20280 min_bpos
= wrap_row_min_bpos
;
20281 max_pos
= wrap_row_max_pos
;
20282 max_bpos
= wrap_row_max_bpos
;
20283 row
->continued_p
= 1;
20284 row
->ends_at_zv_p
= 0;
20285 row
->exact_window_width_line_p
= 0;
20286 it
->continuation_lines_width
+= x
;
20288 /* Make sure that a non-default face is extended
20289 up to the right margin of the window. */
20290 extend_face_to_end_of_line (it
);
20292 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20294 /* A TAB that extends past the right edge of the
20295 window. This produces a single glyph on
20296 window system frames. We leave the glyph in
20297 this row and let it fill the row, but don't
20298 consume the TAB. */
20299 if ((row
->reversed_p
20300 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20301 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20302 produce_special_glyphs (it
, IT_CONTINUATION
);
20303 it
->continuation_lines_width
+= it
->last_visible_x
;
20304 row
->ends_in_middle_of_char_p
= 1;
20305 row
->continued_p
= 1;
20306 glyph
->pixel_width
= it
->last_visible_x
- x
;
20307 it
->starts_in_middle_of_char_p
= 1;
20308 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20309 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20310 extend_face_to_end_of_line (it
);
20314 /* Something other than a TAB that draws past
20315 the right edge of the window. Restore
20316 positions to values before the element. */
20317 if (row
->reversed_p
)
20318 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20319 - (n_glyphs_before
+ i
));
20320 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20322 /* Display continuation glyphs. */
20323 it
->current_x
= x_before
;
20324 it
->continuation_lines_width
+= x
;
20325 if (!FRAME_WINDOW_P (it
->f
)
20326 || (row
->reversed_p
20327 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20328 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20329 produce_special_glyphs (it
, IT_CONTINUATION
);
20330 row
->continued_p
= 1;
20332 extend_face_to_end_of_line (it
);
20334 if (nglyphs
> 1 && i
> 0)
20336 row
->ends_in_middle_of_char_p
= 1;
20337 it
->starts_in_middle_of_char_p
= 1;
20340 /* Restore the height to what it was before the
20341 element not fitting on the line. */
20342 it
->max_ascent
= ascent
;
20343 it
->max_descent
= descent
;
20344 it
->max_phys_ascent
= phys_ascent
;
20345 it
->max_phys_descent
= phys_descent
;
20350 else if (new_x
> it
->first_visible_x
)
20352 /* Increment number of glyphs actually displayed. */
20355 /* Record the maximum and minimum buffer positions
20356 seen so far in glyphs that will be displayed by
20359 RECORD_MAX_MIN_POS (it
);
20361 if (x
< it
->first_visible_x
)
20362 /* Glyph is partially visible, i.e. row starts at
20363 negative X position. */
20364 row
->x
= x
- it
->first_visible_x
;
20368 /* Glyph is completely off the left margin of the
20369 window. This should not happen because of the
20370 move_it_in_display_line at the start of this
20371 function, unless the text display area of the
20372 window is empty. */
20373 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20376 /* Even if this display element produced no glyphs at all,
20377 we want to record its position. */
20378 if (it
->bidi_p
&& nglyphs
== 0)
20379 RECORD_MAX_MIN_POS (it
);
20381 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20382 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20383 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20384 row
->phys_height
= max (row
->phys_height
,
20385 it
->max_phys_ascent
+ it
->max_phys_descent
);
20386 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20387 it
->max_extra_line_spacing
);
20389 /* End of this display line if row is continued. */
20390 if (row
->continued_p
|| row
->ends_at_zv_p
)
20395 /* Is this a line end? If yes, we're also done, after making
20396 sure that a non-default face is extended up to the right
20397 margin of the window. */
20398 if (ITERATOR_AT_END_OF_LINE_P (it
))
20400 int used_before
= row
->used
[TEXT_AREA
];
20402 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20404 /* Add a space at the end of the line that is used to
20405 display the cursor there. */
20406 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20407 append_space_for_newline (it
, 0);
20409 /* Extend the face to the end of the line. */
20410 extend_face_to_end_of_line (it
);
20412 /* Make sure we have the position. */
20413 if (used_before
== 0)
20414 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20416 /* Record the position of the newline, for use in
20418 it
->eol_pos
= it
->current
.pos
;
20420 /* Consume the line end. This skips over invisible lines. */
20421 set_iterator_to_next (it
, 1);
20422 it
->continuation_lines_width
= 0;
20426 /* Proceed with next display element. Note that this skips
20427 over lines invisible because of selective display. */
20428 set_iterator_to_next (it
, 1);
20430 /* If we truncate lines, we are done when the last displayed
20431 glyphs reach past the right margin of the window. */
20432 if (it
->line_wrap
== TRUNCATE
20433 && ((FRAME_WINDOW_P (it
->f
)
20434 /* Images are preprocessed in produce_image_glyph such
20435 that they are cropped at the right edge of the
20436 window, so an image glyph will always end exactly at
20437 last_visible_x, even if there's no right fringe. */
20438 && (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) || it
->what
== IT_IMAGE
))
20439 ? (it
->current_x
>= it
->last_visible_x
)
20440 : (it
->current_x
> it
->last_visible_x
)))
20442 /* Maybe add truncation glyphs. */
20443 if (!FRAME_WINDOW_P (it
->f
)
20444 || (row
->reversed_p
20445 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20446 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20450 if (!row
->reversed_p
)
20452 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20453 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20458 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20459 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20461 /* Remove any padding glyphs at the front of ROW, to
20462 make room for the truncation glyphs we will be
20463 adding below. The loop below always inserts at
20464 least one truncation glyph, so also remove the
20465 last glyph added to ROW. */
20466 unproduce_glyphs (it
, i
+ 1);
20467 /* Adjust i for the loop below. */
20468 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20471 /* produce_special_glyphs overwrites the last glyph, so
20472 we don't want that if we want to keep that last
20473 glyph, which means it's an image. */
20474 if (it
->current_x
> it
->last_visible_x
)
20476 it
->current_x
= x_before
;
20477 if (!FRAME_WINDOW_P (it
->f
))
20479 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20481 row
->used
[TEXT_AREA
] = i
;
20482 produce_special_glyphs (it
, IT_TRUNCATION
);
20487 row
->used
[TEXT_AREA
] = i
;
20488 produce_special_glyphs (it
, IT_TRUNCATION
);
20490 it
->hpos
= hpos_before
;
20493 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20495 /* Don't truncate if we can overflow newline into fringe. */
20496 if (!get_next_display_element (it
))
20498 it
->continuation_lines_width
= 0;
20499 row
->ends_at_zv_p
= 1;
20500 row
->exact_window_width_line_p
= 1;
20503 if (ITERATOR_AT_END_OF_LINE_P (it
))
20505 row
->exact_window_width_line_p
= 1;
20506 goto at_end_of_line
;
20508 it
->current_x
= x_before
;
20509 it
->hpos
= hpos_before
;
20512 row
->truncated_on_right_p
= 1;
20513 it
->continuation_lines_width
= 0;
20514 reseat_at_next_visible_line_start (it
, 0);
20515 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
20521 bidi_unshelve_cache (wrap_data
, 1);
20523 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20524 at the left window margin. */
20525 if (it
->first_visible_x
20526 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20528 if (!FRAME_WINDOW_P (it
->f
)
20529 || (((row
->reversed_p
20530 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20531 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20532 /* Don't let insert_left_trunc_glyphs overwrite the
20533 first glyph of the row if it is an image. */
20534 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20535 insert_left_trunc_glyphs (it
);
20536 row
->truncated_on_left_p
= 1;
20539 /* Remember the position at which this line ends.
20541 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20542 cannot be before the call to find_row_edges below, since that is
20543 where these positions are determined. */
20544 row
->end
= it
->current
;
20547 row
->minpos
= row
->start
.pos
;
20548 row
->maxpos
= row
->end
.pos
;
20552 /* ROW->minpos and ROW->maxpos must be the smallest and
20553 `1 + the largest' buffer positions in ROW. But if ROW was
20554 bidi-reordered, these two positions can be anywhere in the
20555 row, so we must determine them now. */
20556 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20559 /* If the start of this line is the overlay arrow-position, then
20560 mark this glyph row as the one containing the overlay arrow.
20561 This is clearly a mess with variable size fonts. It would be
20562 better to let it be displayed like cursors under X. */
20563 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20564 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20565 !NILP (overlay_arrow_string
)))
20567 /* Overlay arrow in window redisplay is a fringe bitmap. */
20568 if (STRINGP (overlay_arrow_string
))
20570 struct glyph_row
*arrow_row
20571 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20572 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20573 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20574 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20575 struct glyph
*p2
, *end
;
20577 /* Copy the arrow glyphs. */
20578 while (glyph
< arrow_end
)
20581 /* Throw away padding glyphs. */
20583 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20584 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20590 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20595 eassert (INTEGERP (overlay_arrow_string
));
20596 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20598 overlay_arrow_seen
= 1;
20601 /* Highlight trailing whitespace. */
20602 if (!NILP (Vshow_trailing_whitespace
))
20603 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20605 /* Compute pixel dimensions of this line. */
20606 compute_line_metrics (it
);
20608 /* Implementation note: No changes in the glyphs of ROW or in their
20609 faces can be done past this point, because compute_line_metrics
20610 computes ROW's hash value and stores it within the glyph_row
20613 /* Record whether this row ends inside an ellipsis. */
20614 row
->ends_in_ellipsis_p
20615 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20616 && it
->ellipsis_p
);
20618 /* Save fringe bitmaps in this row. */
20619 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20620 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20621 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20622 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20624 it
->left_user_fringe_bitmap
= 0;
20625 it
->left_user_fringe_face_id
= 0;
20626 it
->right_user_fringe_bitmap
= 0;
20627 it
->right_user_fringe_face_id
= 0;
20629 /* Maybe set the cursor. */
20630 cvpos
= it
->w
->cursor
.vpos
;
20632 /* In bidi-reordered rows, keep checking for proper cursor
20633 position even if one has been found already, because buffer
20634 positions in such rows change non-linearly with ROW->VPOS,
20635 when a line is continued. One exception: when we are at ZV,
20636 display cursor on the first suitable glyph row, since all
20637 the empty rows after that also have their position set to ZV. */
20638 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20639 lines' rows is implemented for bidi-reordered rows. */
20641 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20642 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20643 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20644 && cursor_row_p (row
))
20645 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20647 /* Prepare for the next line. This line starts horizontally at (X
20648 HPOS) = (0 0). Vertical positions are incremented. As a
20649 convenience for the caller, IT->glyph_row is set to the next
20651 it
->current_x
= it
->hpos
= 0;
20652 it
->current_y
+= row
->height
;
20653 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20656 /* The next row should by default use the same value of the
20657 reversed_p flag as this one. set_iterator_to_next decides when
20658 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20659 the flag accordingly. */
20660 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20661 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20662 it
->start
= row
->end
;
20663 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20665 #undef RECORD_MAX_MIN_POS
20668 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20669 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20670 doc
: /* Return paragraph direction at point in BUFFER.
20671 Value is either `left-to-right' or `right-to-left'.
20672 If BUFFER is omitted or nil, it defaults to the current buffer.
20674 Paragraph direction determines how the text in the paragraph is displayed.
20675 In left-to-right paragraphs, text begins at the left margin of the window
20676 and the reading direction is generally left to right. In right-to-left
20677 paragraphs, text begins at the right margin and is read from right to left.
20679 See also `bidi-paragraph-direction'. */)
20680 (Lisp_Object buffer
)
20682 struct buffer
*buf
= current_buffer
;
20683 struct buffer
*old
= buf
;
20685 if (! NILP (buffer
))
20687 CHECK_BUFFER (buffer
);
20688 buf
= XBUFFER (buffer
);
20691 if (NILP (BVAR (buf
, bidi_display_reordering
))
20692 || NILP (BVAR (buf
, enable_multibyte_characters
))
20693 /* When we are loading loadup.el, the character property tables
20694 needed for bidi iteration are not yet available. */
20695 || !NILP (Vpurify_flag
))
20696 return Qleft_to_right
;
20697 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20698 return BVAR (buf
, bidi_paragraph_direction
);
20701 /* Determine the direction from buffer text. We could try to
20702 use current_matrix if it is up to date, but this seems fast
20703 enough as it is. */
20704 struct bidi_it itb
;
20705 ptrdiff_t pos
= BUF_PT (buf
);
20706 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20708 void *itb_data
= bidi_shelve_cache ();
20710 set_buffer_temp (buf
);
20711 /* bidi_paragraph_init finds the base direction of the paragraph
20712 by searching forward from paragraph start. We need the base
20713 direction of the current or _previous_ paragraph, so we need
20714 to make sure we are within that paragraph. To that end, find
20715 the previous non-empty line. */
20716 if (pos
>= ZV
&& pos
> BEGV
)
20717 DEC_BOTH (pos
, bytepos
);
20718 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20719 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20721 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20722 || c
== ' ' || c
== '\t' || c
== '\f')
20724 if (bytepos
<= BEGV_BYTE
)
20729 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20732 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20733 itb
.paragraph_dir
= NEUTRAL_DIR
;
20734 itb
.string
.s
= NULL
;
20735 itb
.string
.lstring
= Qnil
;
20736 itb
.string
.bufpos
= 0;
20737 itb
.string
.from_disp_str
= 0;
20738 itb
.string
.unibyte
= 0;
20739 /* We have no window to use here for ignoring window-specific
20740 overlays. Using NULL for window pointer will cause
20741 compute_display_string_pos to use the current buffer. */
20743 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20744 bidi_unshelve_cache (itb_data
, 0);
20745 set_buffer_temp (old
);
20746 switch (itb
.paragraph_dir
)
20749 return Qleft_to_right
;
20752 return Qright_to_left
;
20760 DEFUN ("move-point-visually", Fmove_point_visually
,
20761 Smove_point_visually
, 1, 1, 0,
20762 doc
: /* Move point in the visual order in the specified DIRECTION.
20763 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
20766 Value is the new character position of point. */)
20767 (Lisp_Object direction
)
20769 struct window
*w
= XWINDOW (selected_window
);
20770 struct buffer
*b
= XBUFFER (w
->contents
);
20771 struct glyph_row
*row
;
20773 Lisp_Object paragraph_dir
;
20775 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
20776 (!(ROW)->continued_p \
20777 && INTEGERP ((GLYPH)->object) \
20778 && (GLYPH)->type == CHAR_GLYPH \
20779 && (GLYPH)->u.ch == ' ' \
20780 && (GLYPH)->charpos >= 0 \
20781 && !(GLYPH)->avoid_cursor_p)
20783 CHECK_NUMBER (direction
);
20784 dir
= XINT (direction
);
20790 /* If current matrix is up-to-date, we can use the information
20791 recorded in the glyphs, at least as long as the goal is on the
20793 if (w
->window_end_valid
20794 && !windows_or_buffers_changed
20796 && !b
->clip_changed
20797 && !b
->prevent_redisplay_optimizations_p
20798 && !window_outdated (w
)
20799 /* We rely below on the cursor coordinates to be up to date, but
20800 we cannot trust them if some command moved point since the
20801 last complete redisplay. */
20802 && w
->last_point
== BUF_PT (b
)
20803 && w
->cursor
.vpos
>= 0
20804 && w
->cursor
.vpos
< w
->current_matrix
->nrows
20805 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
20807 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
20808 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
20809 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
20811 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
20813 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
20815 SET_PT (g
->charpos
);
20816 w
->cursor
.vpos
= -1;
20817 return make_number (PT
);
20819 else if (!INTEGERP (g
->object
) && !EQ (g
->object
, gpt
->object
))
20823 if (BUFFERP (gpt
->object
))
20826 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
20827 new_pos
+= (row
->reversed_p
? -dir
: dir
);
20829 new_pos
-= (row
->reversed_p
? -dir
: dir
);;
20831 else if (BUFFERP (g
->object
))
20832 new_pos
= g
->charpos
;
20836 w
->cursor
.vpos
= -1;
20837 return make_number (PT
);
20839 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
20841 /* Glyphs inserted at the end of a non-empty line for
20842 positioning the cursor have zero charpos, so we must
20843 deduce the value of point by other means. */
20844 if (g
->charpos
> 0)
20845 SET_PT (g
->charpos
);
20846 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
20848 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
20849 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
20852 w
->cursor
.vpos
= -1;
20853 return make_number (PT
);
20856 if (g
== e
|| INTEGERP (g
->object
))
20858 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
20859 goto simulate_display
;
20860 if (!row
->reversed_p
)
20864 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
20865 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
20866 goto simulate_display
;
20870 if (row
->reversed_p
&& !row
->continued_p
)
20872 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
20873 w
->cursor
.vpos
= -1;
20874 return make_number (PT
);
20876 g
= row
->glyphs
[TEXT_AREA
];
20877 e
= g
+ row
->used
[TEXT_AREA
];
20878 for ( ; g
< e
; g
++)
20880 if (BUFFERP (g
->object
)
20881 /* Empty lines have only one glyph, which stands
20882 for the newline, and whose charpos is the
20883 buffer position of the newline. */
20884 || ROW_GLYPH_NEWLINE_P (row
, g
)
20885 /* When the buffer ends in a newline, the line at
20886 EOB also has one glyph, but its charpos is -1. */
20887 || (row
->ends_at_zv_p
20888 && !row
->reversed_p
20889 && INTEGERP (g
->object
)
20890 && g
->type
== CHAR_GLYPH
20891 && g
->u
.ch
== ' '))
20893 if (g
->charpos
> 0)
20894 SET_PT (g
->charpos
);
20895 else if (!row
->reversed_p
20896 && row
->ends_at_zv_p
20901 w
->cursor
.vpos
= -1;
20902 return make_number (PT
);
20908 if (!row
->reversed_p
&& !row
->continued_p
)
20910 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
20911 w
->cursor
.vpos
= -1;
20912 return make_number (PT
);
20914 e
= row
->glyphs
[TEXT_AREA
];
20915 g
= e
+ row
->used
[TEXT_AREA
] - 1;
20916 for ( ; g
>= e
; g
--)
20918 if (BUFFERP (g
->object
)
20919 || (ROW_GLYPH_NEWLINE_P (row
, g
)
20921 /* Empty R2L lines on GUI frames have the buffer
20922 position of the newline stored in the stretch
20924 || g
->type
== STRETCH_GLYPH
20925 || (row
->ends_at_zv_p
20927 && INTEGERP (g
->object
)
20928 && g
->type
== CHAR_GLYPH
20929 && g
->u
.ch
== ' '))
20931 if (g
->charpos
> 0)
20932 SET_PT (g
->charpos
);
20933 else if (row
->reversed_p
20934 && row
->ends_at_zv_p
20939 w
->cursor
.vpos
= -1;
20940 return make_number (PT
);
20949 /* If we wind up here, we failed to move by using the glyphs, so we
20950 need to simulate display instead. */
20953 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
20955 paragraph_dir
= Qleft_to_right
;
20956 if (EQ (paragraph_dir
, Qright_to_left
))
20958 if (PT
<= BEGV
&& dir
< 0)
20959 xsignal0 (Qbeginning_of_buffer
);
20960 else if (PT
>= ZV
&& dir
> 0)
20961 xsignal0 (Qend_of_buffer
);
20964 struct text_pos pt
;
20966 int pt_x
, target_x
, pixel_width
, pt_vpos
;
20968 bool overshoot_expected
= false;
20969 bool target_is_eol_p
= false;
20971 /* Setup the arena. */
20972 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
20973 start_display (&it
, w
, pt
);
20975 if (it
.cmp_it
.id
< 0
20976 && it
.method
== GET_FROM_STRING
20977 && it
.area
== TEXT_AREA
20978 && it
.string_from_display_prop_p
20979 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
20980 overshoot_expected
= true;
20982 /* Find the X coordinate of point. We start from the beginning
20983 of this or previous line to make sure we are before point in
20984 the logical order (since the move_it_* functions can only
20987 reseat_at_previous_visible_line_start (&it
);
20988 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
20989 if (IT_CHARPOS (it
) != PT
)
20991 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
20992 -1, -1, -1, MOVE_TO_POS
);
20993 /* If we missed point because the character there is
20994 displayed out of a display vector that has more than one
20995 glyph, retry expecting overshoot. */
20996 if (it
.method
== GET_FROM_DISPLAY_VECTOR
20997 && it
.current
.dpvec_index
> 0
20998 && !overshoot_expected
)
21000 overshoot_expected
= true;
21003 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21004 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21006 pt_x
= it
.current_x
;
21008 if (dir
> 0 || overshoot_expected
)
21010 struct glyph_row
*row
= it
.glyph_row
;
21012 /* When point is at beginning of line, we don't have
21013 information about the glyph there loaded into struct
21014 it. Calling get_next_display_element fixes that. */
21016 get_next_display_element (&it
);
21017 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21018 it
.glyph_row
= NULL
;
21019 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21020 it
.glyph_row
= row
;
21021 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21022 it, lest it will become out of sync with it's buffer
21024 it
.current_x
= pt_x
;
21027 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21028 pixel_width
= it
.pixel_width
;
21029 if (overshoot_expected
&& at_eol_p
)
21031 else if (pixel_width
<= 0)
21034 /* If there's a display string (or something similar) at point,
21035 we are actually at the glyph to the left of point, so we need
21036 to correct the X coordinate. */
21037 if (overshoot_expected
)
21040 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21042 pt_x
+= pixel_width
;
21045 /* Compute target X coordinate, either to the left or to the
21046 right of point. On TTY frames, all characters have the same
21047 pixel width of 1, so we can use that. On GUI frames we don't
21048 have an easy way of getting at the pixel width of the
21049 character to the left of point, so we use a different method
21050 of getting to that place. */
21052 target_x
= pt_x
+ pixel_width
;
21054 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21056 /* Target X coordinate could be one line above or below the line
21057 of point, in which case we need to adjust the target X
21058 coordinate. Also, if moving to the left, we need to begin at
21059 the left edge of the point's screen line. */
21064 start_display (&it
, w
, pt
);
21065 reseat_at_previous_visible_line_start (&it
);
21066 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21068 move_it_by_lines (&it
, pt_vpos
);
21072 move_it_by_lines (&it
, -1);
21073 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21074 target_is_eol_p
= true;
21075 /* Under word-wrap, we don't know the x coordinate of
21076 the last character displayed on the previous line,
21077 which immediately precedes the wrap point. To find
21078 out its x coordinate, we try moving to the right
21079 margin of the window, which will stop at the wrap
21080 point, and then reset target_x to point at the
21081 character that precedes the wrap point. This is not
21082 needed on GUI frames, because (see below) there we
21083 move from the left margin one grapheme cluster at a
21084 time, and stop when we hit the wrap point. */
21085 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21087 void *it_data
= NULL
;
21090 SAVE_IT (it2
, it
, it_data
);
21091 move_it_in_display_line_to (&it
, ZV
, target_x
,
21092 MOVE_TO_POS
| MOVE_TO_X
);
21093 /* If we arrived at target_x, that _is_ the last
21094 character on the previous line. */
21095 if (it
.current_x
!= target_x
)
21096 target_x
= it
.current_x
- 1;
21097 RESTORE_IT (&it
, &it2
, it_data
);
21104 || (target_x
>= it
.last_visible_x
21105 && it
.line_wrap
!= TRUNCATE
))
21108 move_it_by_lines (&it
, 0);
21109 move_it_by_lines (&it
, 1);
21114 /* Move to the target X coordinate. */
21115 #ifdef HAVE_WINDOW_SYSTEM
21116 /* On GUI frames, as we don't know the X coordinate of the
21117 character to the left of point, moving point to the left
21118 requires walking, one grapheme cluster at a time, until we
21119 find ourself at a place immediately to the left of the
21120 character at point. */
21121 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21123 struct text_pos new_pos
;
21124 enum move_it_result rc
= MOVE_X_REACHED
;
21126 if (it
.current_x
== 0)
21127 get_next_display_element (&it
);
21128 if (it
.what
== IT_COMPOSITION
)
21130 new_pos
.charpos
= it
.cmp_it
.charpos
;
21131 new_pos
.bytepos
= -1;
21134 new_pos
= it
.current
.pos
;
21136 while (it
.current_x
+ it
.pixel_width
<= target_x
21137 && (rc
== MOVE_X_REACHED
21138 /* Under word-wrap, move_it_in_display_line_to
21139 stops at correct coordinates, but sometimes
21140 returns MOVE_POS_MATCH_OR_ZV. */
21141 || (it
.line_wrap
== WORD_WRAP
21142 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21144 int new_x
= it
.current_x
+ it
.pixel_width
;
21146 /* For composed characters, we want the position of the
21147 first character in the grapheme cluster (usually, the
21148 composition's base character), whereas it.current
21149 might give us the position of the _last_ one, e.g. if
21150 the composition is rendered in reverse due to bidi
21152 if (it
.what
== IT_COMPOSITION
)
21154 new_pos
.charpos
= it
.cmp_it
.charpos
;
21155 new_pos
.bytepos
= -1;
21158 new_pos
= it
.current
.pos
;
21159 if (new_x
== it
.current_x
)
21161 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21162 MOVE_TO_POS
| MOVE_TO_X
);
21163 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21166 /* The previous position we saw in the loop is the one we
21168 if (new_pos
.bytepos
== -1)
21169 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21170 it
.current
.pos
= new_pos
;
21174 if (it
.current_x
!= target_x
)
21175 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21177 /* When lines are truncated, the above loop will stop at the
21178 window edge. But we want to get to the end of line, even if
21179 it is beyond the window edge; automatic hscroll will then
21180 scroll the window to show point as appropriate. */
21181 if (target_is_eol_p
&& it
.line_wrap
== TRUNCATE
21182 && get_next_display_element (&it
))
21184 struct text_pos new_pos
= it
.current
.pos
;
21186 while (!ITERATOR_AT_END_OF_LINE_P (&it
))
21188 set_iterator_to_next (&it
, 0);
21189 if (it
.method
== GET_FROM_BUFFER
)
21190 new_pos
= it
.current
.pos
;
21191 if (!get_next_display_element (&it
))
21195 it
.current
.pos
= new_pos
;
21198 /* If we ended up in a display string that covers point, move to
21199 buffer position to the right in the visual order. */
21202 while (IT_CHARPOS (it
) == PT
)
21204 set_iterator_to_next (&it
, 0);
21205 if (!get_next_display_element (&it
))
21210 /* Move point to that position. */
21211 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21214 return make_number (PT
);
21216 #undef ROW_GLYPH_NEWLINE_P
21220 /***********************************************************************
21222 ***********************************************************************/
21224 /* Redisplay the menu bar in the frame for window W.
21226 The menu bar of X frames that don't have X toolkit support is
21227 displayed in a special window W->frame->menu_bar_window.
21229 The menu bar of terminal frames is treated specially as far as
21230 glyph matrices are concerned. Menu bar lines are not part of
21231 windows, so the update is done directly on the frame matrix rows
21232 for the menu bar. */
21235 display_menu_bar (struct window
*w
)
21237 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21242 /* Don't do all this for graphical frames. */
21244 if (FRAME_W32_P (f
))
21247 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21253 if (FRAME_NS_P (f
))
21255 #endif /* HAVE_NS */
21257 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21258 eassert (!FRAME_WINDOW_P (f
));
21259 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21260 it
.first_visible_x
= 0;
21261 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21262 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21263 if (FRAME_WINDOW_P (f
))
21265 /* Menu bar lines are displayed in the desired matrix of the
21266 dummy window menu_bar_window. */
21267 struct window
*menu_w
;
21268 menu_w
= XWINDOW (f
->menu_bar_window
);
21269 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21271 it
.first_visible_x
= 0;
21272 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21275 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21277 /* This is a TTY frame, i.e. character hpos/vpos are used as
21279 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21281 it
.first_visible_x
= 0;
21282 it
.last_visible_x
= FRAME_COLS (f
);
21285 /* FIXME: This should be controlled by a user option. See the
21286 comments in redisplay_tool_bar and display_mode_line about
21288 it
.paragraph_embedding
= L2R
;
21290 /* Clear all rows of the menu bar. */
21291 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21293 struct glyph_row
*row
= it
.glyph_row
+ i
;
21294 clear_glyph_row (row
);
21295 row
->enabled_p
= true;
21296 row
->full_width_p
= 1;
21299 /* Display all items of the menu bar. */
21300 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21301 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21303 Lisp_Object string
;
21305 /* Stop at nil string. */
21306 string
= AREF (items
, i
+ 1);
21310 /* Remember where item was displayed. */
21311 ASET (items
, i
+ 3, make_number (it
.hpos
));
21313 /* Display the item, pad with one space. */
21314 if (it
.current_x
< it
.last_visible_x
)
21315 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21316 SCHARS (string
) + 1, 0, 0, -1);
21319 /* Fill out the line with spaces. */
21320 if (it
.current_x
< it
.last_visible_x
)
21321 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21323 /* Compute the total height of the lines. */
21324 compute_line_metrics (&it
);
21327 /* Deep copy of a glyph row, including the glyphs. */
21329 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21331 struct glyph
*pointers
[1 + LAST_AREA
];
21332 int to_used
= to
->used
[TEXT_AREA
];
21334 /* Save glyph pointers of TO. */
21335 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21337 /* Do a structure assignment. */
21340 /* Restore original glyph pointers of TO. */
21341 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21343 /* Copy the glyphs. */
21344 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21345 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21347 /* If we filled only part of the TO row, fill the rest with
21348 space_glyph (which will display as empty space). */
21349 if (to_used
> from
->used
[TEXT_AREA
])
21350 fill_up_frame_row_with_spaces (to
, to_used
);
21353 /* Display one menu item on a TTY, by overwriting the glyphs in the
21354 frame F's desired glyph matrix with glyphs produced from the menu
21355 item text. Called from term.c to display TTY drop-down menus one
21358 ITEM_TEXT is the menu item text as a C string.
21360 FACE_ID is the face ID to be used for this menu item. FACE_ID
21361 could specify one of 3 faces: a face for an enabled item, a face
21362 for a disabled item, or a face for a selected item.
21364 X and Y are coordinates of the first glyph in the frame's desired
21365 matrix to be overwritten by the menu item. Since this is a TTY, Y
21366 is the zero-based number of the glyph row and X is the zero-based
21367 glyph number in the row, starting from left, where to start
21368 displaying the item.
21370 SUBMENU non-zero means this menu item drops down a submenu, which
21371 should be indicated by displaying a proper visual cue after the
21375 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21376 int x
, int y
, int submenu
)
21379 struct frame
*f
= SELECTED_FRAME ();
21380 struct window
*w
= XWINDOW (f
->selected_window
);
21381 int saved_used
, saved_truncated
, saved_width
, saved_reversed
;
21382 struct glyph_row
*row
;
21383 size_t item_len
= strlen (item_text
);
21385 eassert (FRAME_TERMCAP_P (f
));
21387 /* Don't write beyond the matrix's last row. This can happen for
21388 TTY screens that are not high enough to show the entire menu.
21389 (This is actually a bit of defensive programming, as
21390 tty_menu_display already limits the number of menu items to one
21391 less than the number of screen lines.) */
21392 if (y
>= f
->desired_matrix
->nrows
)
21395 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21396 it
.first_visible_x
= 0;
21397 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21398 row
= it
.glyph_row
;
21399 /* Start with the row contents from the current matrix. */
21400 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21401 saved_width
= row
->full_width_p
;
21402 row
->full_width_p
= 1;
21403 saved_reversed
= row
->reversed_p
;
21404 row
->reversed_p
= 0;
21405 row
->enabled_p
= true;
21407 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21409 eassert (x
< f
->desired_matrix
->matrix_w
);
21410 it
.current_x
= it
.hpos
= x
;
21411 it
.current_y
= it
.vpos
= y
;
21412 saved_used
= row
->used
[TEXT_AREA
];
21413 saved_truncated
= row
->truncated_on_right_p
;
21414 row
->used
[TEXT_AREA
] = x
;
21415 it
.face_id
= face_id
;
21416 it
.line_wrap
= TRUNCATE
;
21418 /* FIXME: This should be controlled by a user option. See the
21419 comments in redisplay_tool_bar and display_mode_line about this.
21420 Also, if paragraph_embedding could ever be R2L, changes will be
21421 needed to avoid shifting to the right the row characters in
21422 term.c:append_glyph. */
21423 it
.paragraph_embedding
= L2R
;
21425 /* Pad with a space on the left. */
21426 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21428 /* Display the menu item, pad with spaces to WIDTH. */
21431 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21432 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21434 /* Indicate with " >" that there's a submenu. */
21435 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21436 FRAME_COLS (f
) - 1, -1);
21439 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21440 width
, 0, FRAME_COLS (f
) - 1, -1);
21442 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21443 row
->truncated_on_right_p
= saved_truncated
;
21444 row
->hash
= row_hash (row
);
21445 row
->full_width_p
= saved_width
;
21446 row
->reversed_p
= saved_reversed
;
21449 /***********************************************************************
21451 ***********************************************************************/
21453 /* Redisplay mode lines in the window tree whose root is WINDOW. If
21454 FORCE is non-zero, redisplay mode lines unconditionally.
21455 Otherwise, redisplay only mode lines that are garbaged. Value is
21456 the number of windows whose mode lines were redisplayed. */
21459 redisplay_mode_lines (Lisp_Object window
, bool force
)
21463 while (!NILP (window
))
21465 struct window
*w
= XWINDOW (window
);
21467 if (WINDOWP (w
->contents
))
21468 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
21470 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
21471 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
21473 struct text_pos lpoint
;
21474 struct buffer
*old
= current_buffer
;
21476 /* Set the window's buffer for the mode line display. */
21477 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
21478 set_buffer_internal_1 (XBUFFER (w
->contents
));
21480 /* Point refers normally to the selected window. For any
21481 other window, set up appropriate value. */
21482 if (!EQ (window
, selected_window
))
21484 struct text_pos pt
;
21486 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
21487 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
21490 /* Display mode lines. */
21491 clear_glyph_matrix (w
->desired_matrix
);
21492 if (display_mode_lines (w
))
21495 /* Restore old settings. */
21496 set_buffer_internal_1 (old
);
21497 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
21507 /* Display the mode and/or header line of window W. Value is the
21508 sum number of mode lines and header lines displayed. */
21511 display_mode_lines (struct window
*w
)
21513 Lisp_Object old_selected_window
= selected_window
;
21514 Lisp_Object old_selected_frame
= selected_frame
;
21515 Lisp_Object new_frame
= w
->frame
;
21516 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
21519 selected_frame
= new_frame
;
21520 /* FIXME: If we were to allow the mode-line's computation changing the buffer
21521 or window's point, then we'd need select_window_1 here as well. */
21522 XSETWINDOW (selected_window
, w
);
21523 XFRAME (new_frame
)->selected_window
= selected_window
;
21525 /* These will be set while the mode line specs are processed. */
21526 line_number_displayed
= 0;
21527 w
->column_number_displayed
= -1;
21529 if (WINDOW_WANTS_MODELINE_P (w
))
21531 struct window
*sel_w
= XWINDOW (old_selected_window
);
21533 /* Select mode line face based on the real selected window. */
21534 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
21535 BVAR (current_buffer
, mode_line_format
));
21539 if (WINDOW_WANTS_HEADER_LINE_P (w
))
21541 display_mode_line (w
, HEADER_LINE_FACE_ID
,
21542 BVAR (current_buffer
, header_line_format
));
21546 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
21547 selected_frame
= old_selected_frame
;
21548 selected_window
= old_selected_window
;
21550 w
->must_be_updated_p
= true;
21555 /* Display mode or header line of window W. FACE_ID specifies which
21556 line to display; it is either MODE_LINE_FACE_ID or
21557 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
21558 display. Value is the pixel height of the mode/header line
21562 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
21566 ptrdiff_t count
= SPECPDL_INDEX ();
21568 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21569 /* Don't extend on a previously drawn mode-line.
21570 This may happen if called from pos_visible_p. */
21571 it
.glyph_row
->enabled_p
= false;
21572 prepare_desired_row (w
, it
.glyph_row
, true);
21574 it
.glyph_row
->mode_line_p
= 1;
21576 /* FIXME: This should be controlled by a user option. But
21577 supporting such an option is not trivial, since the mode line is
21578 made up of many separate strings. */
21579 it
.paragraph_embedding
= L2R
;
21581 record_unwind_protect (unwind_format_mode_line
,
21582 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
21584 mode_line_target
= MODE_LINE_DISPLAY
;
21586 /* Temporarily make frame's keyboard the current kboard so that
21587 kboard-local variables in the mode_line_format will get the right
21589 push_kboard (FRAME_KBOARD (it
.f
));
21590 record_unwind_save_match_data ();
21591 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21594 unbind_to (count
, Qnil
);
21596 /* Fill up with spaces. */
21597 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
21599 compute_line_metrics (&it
);
21600 it
.glyph_row
->full_width_p
= 1;
21601 it
.glyph_row
->continued_p
= 0;
21602 it
.glyph_row
->truncated_on_left_p
= 0;
21603 it
.glyph_row
->truncated_on_right_p
= 0;
21605 /* Make a 3D mode-line have a shadow at its right end. */
21606 face
= FACE_FROM_ID (it
.f
, face_id
);
21607 extend_face_to_end_of_line (&it
);
21608 if (face
->box
!= FACE_NO_BOX
)
21610 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
21611 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
21612 last
->right_box_line_p
= 1;
21615 return it
.glyph_row
->height
;
21618 /* Move element ELT in LIST to the front of LIST.
21619 Return the updated list. */
21622 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
21624 register Lisp_Object tail
, prev
;
21625 register Lisp_Object tem
;
21629 while (CONSP (tail
))
21635 /* Splice out the link TAIL. */
21637 list
= XCDR (tail
);
21639 Fsetcdr (prev
, XCDR (tail
));
21641 /* Now make it the first. */
21642 Fsetcdr (tail
, list
);
21647 tail
= XCDR (tail
);
21651 /* Not found--return unchanged LIST. */
21655 /* Contribute ELT to the mode line for window IT->w. How it
21656 translates into text depends on its data type.
21658 IT describes the display environment in which we display, as usual.
21660 DEPTH is the depth in recursion. It is used to prevent
21661 infinite recursion here.
21663 FIELD_WIDTH is the number of characters the display of ELT should
21664 occupy in the mode line, and PRECISION is the maximum number of
21665 characters to display from ELT's representation. See
21666 display_string for details.
21668 Returns the hpos of the end of the text generated by ELT.
21670 PROPS is a property list to add to any string we encounter.
21672 If RISKY is nonzero, remove (disregard) any properties in any string
21673 we encounter, and ignore :eval and :propertize.
21675 The global variable `mode_line_target' determines whether the
21676 output is passed to `store_mode_line_noprop',
21677 `store_mode_line_string', or `display_string'. */
21680 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
21681 Lisp_Object elt
, Lisp_Object props
, int risky
)
21683 int n
= 0, field
, prec
;
21688 elt
= build_string ("*too-deep*");
21692 switch (XTYPE (elt
))
21696 /* A string: output it and check for %-constructs within it. */
21698 ptrdiff_t offset
= 0;
21700 if (SCHARS (elt
) > 0
21701 && (!NILP (props
) || risky
))
21703 Lisp_Object oprops
, aelt
;
21704 oprops
= Ftext_properties_at (make_number (0), elt
);
21706 /* If the starting string's properties are not what
21707 we want, translate the string. Also, if the string
21708 is risky, do that anyway. */
21710 if (NILP (Fequal (props
, oprops
)) || risky
)
21712 /* If the starting string has properties,
21713 merge the specified ones onto the existing ones. */
21714 if (! NILP (oprops
) && !risky
)
21718 oprops
= Fcopy_sequence (oprops
);
21720 while (CONSP (tem
))
21722 oprops
= Fplist_put (oprops
, XCAR (tem
),
21723 XCAR (XCDR (tem
)));
21724 tem
= XCDR (XCDR (tem
));
21729 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
21730 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
21732 /* AELT is what we want. Move it to the front
21733 without consing. */
21735 mode_line_proptrans_alist
21736 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
21742 /* If AELT has the wrong props, it is useless.
21743 so get rid of it. */
21745 mode_line_proptrans_alist
21746 = Fdelq (aelt
, mode_line_proptrans_alist
);
21748 elt
= Fcopy_sequence (elt
);
21749 Fset_text_properties (make_number (0), Flength (elt
),
21751 /* Add this item to mode_line_proptrans_alist. */
21752 mode_line_proptrans_alist
21753 = Fcons (Fcons (elt
, props
),
21754 mode_line_proptrans_alist
);
21755 /* Truncate mode_line_proptrans_alist
21756 to at most 50 elements. */
21757 tem
= Fnthcdr (make_number (50),
21758 mode_line_proptrans_alist
);
21760 XSETCDR (tem
, Qnil
);
21769 prec
= precision
- n
;
21770 switch (mode_line_target
)
21772 case MODE_LINE_NOPROP
:
21773 case MODE_LINE_TITLE
:
21774 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
21776 case MODE_LINE_STRING
:
21777 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
21779 case MODE_LINE_DISPLAY
:
21780 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
21781 0, prec
, 0, STRING_MULTIBYTE (elt
));
21788 /* Handle the non-literal case. */
21790 while ((precision
<= 0 || n
< precision
)
21791 && SREF (elt
, offset
) != 0
21792 && (mode_line_target
!= MODE_LINE_DISPLAY
21793 || it
->current_x
< it
->last_visible_x
))
21795 ptrdiff_t last_offset
= offset
;
21797 /* Advance to end of string or next format specifier. */
21798 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
21801 if (offset
- 1 != last_offset
)
21803 ptrdiff_t nchars
, nbytes
;
21805 /* Output to end of string or up to '%'. Field width
21806 is length of string. Don't output more than
21807 PRECISION allows us. */
21810 prec
= c_string_width (SDATA (elt
) + last_offset
,
21811 offset
- last_offset
, precision
- n
,
21814 switch (mode_line_target
)
21816 case MODE_LINE_NOPROP
:
21817 case MODE_LINE_TITLE
:
21818 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
21820 case MODE_LINE_STRING
:
21822 ptrdiff_t bytepos
= last_offset
;
21823 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
21824 ptrdiff_t endpos
= (precision
<= 0
21825 ? string_byte_to_char (elt
, offset
)
21826 : charpos
+ nchars
);
21828 n
+= store_mode_line_string (NULL
,
21829 Fsubstring (elt
, make_number (charpos
),
21830 make_number (endpos
)),
21834 case MODE_LINE_DISPLAY
:
21836 ptrdiff_t bytepos
= last_offset
;
21837 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
21839 if (precision
<= 0)
21840 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
21841 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
21843 STRING_MULTIBYTE (elt
));
21848 else /* c == '%' */
21850 ptrdiff_t percent_position
= offset
;
21852 /* Get the specified minimum width. Zero means
21855 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
21856 field
= field
* 10 + c
- '0';
21858 /* Don't pad beyond the total padding allowed. */
21859 if (field_width
- n
> 0 && field
> field_width
- n
)
21860 field
= field_width
- n
;
21862 /* Note that either PRECISION <= 0 or N < PRECISION. */
21863 prec
= precision
- n
;
21866 n
+= display_mode_element (it
, depth
, field
, prec
,
21867 Vglobal_mode_string
, props
,
21872 ptrdiff_t bytepos
, charpos
;
21874 Lisp_Object string
;
21876 bytepos
= percent_position
;
21877 charpos
= (STRING_MULTIBYTE (elt
)
21878 ? string_byte_to_char (elt
, bytepos
)
21880 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
21881 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
21883 switch (mode_line_target
)
21885 case MODE_LINE_NOPROP
:
21886 case MODE_LINE_TITLE
:
21887 n
+= store_mode_line_noprop (spec
, field
, prec
);
21889 case MODE_LINE_STRING
:
21891 Lisp_Object tem
= build_string (spec
);
21892 props
= Ftext_properties_at (make_number (charpos
), elt
);
21893 /* Should only keep face property in props */
21894 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
21897 case MODE_LINE_DISPLAY
:
21899 int nglyphs_before
, nwritten
;
21901 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
21902 nwritten
= display_string (spec
, string
, elt
,
21907 /* Assign to the glyphs written above the
21908 string where the `%x' came from, position
21912 struct glyph
*glyph
21913 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
21917 for (i
= 0; i
< nwritten
; ++i
)
21919 glyph
[i
].object
= elt
;
21920 glyph
[i
].charpos
= charpos
;
21937 /* A symbol: process the value of the symbol recursively
21938 as if it appeared here directly. Avoid error if symbol void.
21939 Special case: if value of symbol is a string, output the string
21942 register Lisp_Object tem
;
21944 /* If the variable is not marked as risky to set
21945 then its contents are risky to use. */
21946 if (NILP (Fget (elt
, Qrisky_local_variable
)))
21949 tem
= Fboundp (elt
);
21952 tem
= Fsymbol_value (elt
);
21953 /* If value is a string, output that string literally:
21954 don't check for % within it. */
21958 if (!EQ (tem
, elt
))
21960 /* Give up right away for nil or t. */
21970 register Lisp_Object car
, tem
;
21972 /* A cons cell: five distinct cases.
21973 If first element is :eval or :propertize, do something special.
21974 If first element is a string or a cons, process all the elements
21975 and effectively concatenate them.
21976 If first element is a negative number, truncate displaying cdr to
21977 at most that many characters. If positive, pad (with spaces)
21978 to at least that many characters.
21979 If first element is a symbol, process the cadr or caddr recursively
21980 according to whether the symbol's value is non-nil or nil. */
21982 if (EQ (car
, QCeval
))
21984 /* An element of the form (:eval FORM) means evaluate FORM
21985 and use the result as mode line elements. */
21990 if (CONSP (XCDR (elt
)))
21993 spec
= safe__eval (true, XCAR (XCDR (elt
)));
21994 n
+= display_mode_element (it
, depth
, field_width
- n
,
21995 precision
- n
, spec
, props
,
21999 else if (EQ (car
, QCpropertize
))
22001 /* An element of the form (:propertize ELT PROPS...)
22002 means display ELT but applying properties PROPS. */
22007 if (CONSP (XCDR (elt
)))
22008 n
+= display_mode_element (it
, depth
, field_width
- n
,
22009 precision
- n
, XCAR (XCDR (elt
)),
22010 XCDR (XCDR (elt
)), risky
);
22012 else if (SYMBOLP (car
))
22014 tem
= Fboundp (car
);
22018 /* elt is now the cdr, and we know it is a cons cell.
22019 Use its car if CAR has a non-nil value. */
22022 tem
= Fsymbol_value (car
);
22029 /* Symbol's value is nil (or symbol is unbound)
22030 Get the cddr of the original list
22031 and if possible find the caddr and use that. */
22035 else if (!CONSP (elt
))
22040 else if (INTEGERP (car
))
22042 register int lim
= XINT (car
);
22046 /* Negative int means reduce maximum width. */
22047 if (precision
<= 0)
22050 precision
= min (precision
, -lim
);
22054 /* Padding specified. Don't let it be more than
22055 current maximum. */
22057 lim
= min (precision
, lim
);
22059 /* If that's more padding than already wanted, queue it.
22060 But don't reduce padding already specified even if
22061 that is beyond the current truncation point. */
22062 field_width
= max (lim
, field_width
);
22066 else if (STRINGP (car
) || CONSP (car
))
22068 Lisp_Object halftail
= elt
;
22072 && (precision
<= 0 || n
< precision
))
22074 n
+= display_mode_element (it
, depth
,
22075 /* Do padding only after the last
22076 element in the list. */
22077 (! CONSP (XCDR (elt
))
22080 precision
- n
, XCAR (elt
),
22084 if ((len
& 1) == 0)
22085 halftail
= XCDR (halftail
);
22086 /* Check for cycle. */
22087 if (EQ (halftail
, elt
))
22096 elt
= build_string ("*invalid*");
22100 /* Pad to FIELD_WIDTH. */
22101 if (field_width
> 0 && n
< field_width
)
22103 switch (mode_line_target
)
22105 case MODE_LINE_NOPROP
:
22106 case MODE_LINE_TITLE
:
22107 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22109 case MODE_LINE_STRING
:
22110 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
22112 case MODE_LINE_DISPLAY
:
22113 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22122 /* Store a mode-line string element in mode_line_string_list.
22124 If STRING is non-null, display that C string. Otherwise, the Lisp
22125 string LISP_STRING is displayed.
22127 FIELD_WIDTH is the minimum number of output glyphs to produce.
22128 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22129 with spaces. FIELD_WIDTH <= 0 means don't pad.
22131 PRECISION is the maximum number of characters to output from
22132 STRING. PRECISION <= 0 means don't truncate the string.
22134 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
22135 properties to the string.
22137 PROPS are the properties to add to the string.
22138 The mode_line_string_face face property is always added to the string.
22142 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
22143 int field_width
, int precision
, Lisp_Object props
)
22148 if (string
!= NULL
)
22150 len
= strlen (string
);
22151 if (precision
> 0 && len
> precision
)
22153 lisp_string
= make_string (string
, len
);
22155 props
= mode_line_string_face_prop
;
22156 else if (!NILP (mode_line_string_face
))
22158 Lisp_Object face
= Fplist_get (props
, Qface
);
22159 props
= Fcopy_sequence (props
);
22161 face
= mode_line_string_face
;
22163 face
= list2 (face
, mode_line_string_face
);
22164 props
= Fplist_put (props
, Qface
, face
);
22166 Fadd_text_properties (make_number (0), make_number (len
),
22167 props
, lisp_string
);
22171 len
= XFASTINT (Flength (lisp_string
));
22172 if (precision
> 0 && len
> precision
)
22175 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22178 if (!NILP (mode_line_string_face
))
22182 props
= Ftext_properties_at (make_number (0), lisp_string
);
22183 face
= Fplist_get (props
, Qface
);
22185 face
= mode_line_string_face
;
22187 face
= list2 (face
, mode_line_string_face
);
22188 props
= list2 (Qface
, face
);
22190 lisp_string
= Fcopy_sequence (lisp_string
);
22193 Fadd_text_properties (make_number (0), make_number (len
),
22194 props
, lisp_string
);
22199 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22203 if (field_width
> len
)
22205 field_width
-= len
;
22206 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22208 Fadd_text_properties (make_number (0), make_number (field_width
),
22209 props
, lisp_string
);
22210 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22218 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22220 doc
: /* Format a string out of a mode line format specification.
22221 First arg FORMAT specifies the mode line format (see `mode-line-format'
22222 for details) to use.
22224 By default, the format is evaluated for the currently selected window.
22226 Optional second arg FACE specifies the face property to put on all
22227 characters for which no face is specified. The value nil means the
22228 default face. The value t means whatever face the window's mode line
22229 currently uses (either `mode-line' or `mode-line-inactive',
22230 depending on whether the window is the selected window or not).
22231 An integer value means the value string has no text
22234 Optional third and fourth args WINDOW and BUFFER specify the window
22235 and buffer to use as the context for the formatting (defaults
22236 are the selected window and the WINDOW's buffer). */)
22237 (Lisp_Object format
, Lisp_Object face
,
22238 Lisp_Object window
, Lisp_Object buffer
)
22243 struct buffer
*old_buffer
= NULL
;
22245 int no_props
= INTEGERP (face
);
22246 ptrdiff_t count
= SPECPDL_INDEX ();
22248 int string_start
= 0;
22250 w
= decode_any_window (window
);
22251 XSETWINDOW (window
, w
);
22254 buffer
= w
->contents
;
22255 CHECK_BUFFER (buffer
);
22257 /* Make formatting the modeline a non-op when noninteractive, otherwise
22258 there will be problems later caused by a partially initialized frame. */
22259 if (NILP (format
) || noninteractive
)
22260 return empty_unibyte_string
;
22265 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22266 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22267 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22268 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22269 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22270 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22271 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22274 old_buffer
= current_buffer
;
22276 /* Save things including mode_line_proptrans_alist,
22277 and set that to nil so that we don't alter the outer value. */
22278 record_unwind_protect (unwind_format_mode_line
,
22279 format_mode_line_unwind_data
22280 (XFRAME (WINDOW_FRAME (w
)),
22281 old_buffer
, selected_window
, 1));
22282 mode_line_proptrans_alist
= Qnil
;
22284 Fselect_window (window
, Qt
);
22285 set_buffer_internal_1 (XBUFFER (buffer
));
22287 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22291 mode_line_target
= MODE_LINE_NOPROP
;
22292 mode_line_string_face_prop
= Qnil
;
22293 mode_line_string_list
= Qnil
;
22294 string_start
= MODE_LINE_NOPROP_LEN (0);
22298 mode_line_target
= MODE_LINE_STRING
;
22299 mode_line_string_list
= Qnil
;
22300 mode_line_string_face
= face
;
22301 mode_line_string_face_prop
22302 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22305 push_kboard (FRAME_KBOARD (it
.f
));
22306 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
22311 len
= MODE_LINE_NOPROP_LEN (string_start
);
22312 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22316 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22317 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
22318 empty_unibyte_string
);
22321 unbind_to (count
, Qnil
);
22325 /* Write a null-terminated, right justified decimal representation of
22326 the positive integer D to BUF using a minimal field width WIDTH. */
22329 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22331 register char *p
= buf
;
22339 *p
++ = d
% 10 + '0';
22344 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22355 /* Write a null-terminated, right justified decimal and "human
22356 readable" representation of the nonnegative integer D to BUF using
22357 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22359 static const char power_letter
[] =
22373 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22375 /* We aim to represent the nonnegative integer D as
22376 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22377 ptrdiff_t quotient
= d
;
22379 /* -1 means: do not use TENTHS. */
22383 /* Length of QUOTIENT.TENTHS as a string. */
22389 if (quotient
>= 1000)
22391 /* Scale to the appropriate EXPONENT. */
22394 remainder
= quotient
% 1000;
22398 while (quotient
>= 1000);
22400 /* Round to nearest and decide whether to use TENTHS or not. */
22403 tenths
= remainder
/ 100;
22404 if (remainder
% 100 >= 50)
22411 if (quotient
== 10)
22419 if (remainder
>= 500)
22421 if (quotient
< 999)
22432 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22433 if (tenths
== -1 && quotient
<= 99)
22440 p
= psuffix
= buf
+ max (width
, length
);
22442 /* Print EXPONENT. */
22443 *psuffix
++ = power_letter
[exponent
];
22446 /* Print TENTHS. */
22449 *--p
= '0' + tenths
;
22453 /* Print QUOTIENT. */
22456 int digit
= quotient
% 10;
22457 *--p
= '0' + digit
;
22459 while ((quotient
/= 10) != 0);
22461 /* Print leading spaces. */
22466 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22467 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
22468 type of CODING_SYSTEM. Return updated pointer into BUF. */
22470 static unsigned char invalid_eol_type
[] = "(*invalid*)";
22473 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
22476 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
22477 const unsigned char *eol_str
;
22479 /* The EOL conversion we are using. */
22480 Lisp_Object eoltype
;
22482 val
= CODING_SYSTEM_SPEC (coding_system
);
22485 if (!VECTORP (val
)) /* Not yet decided. */
22487 *buf
++ = multibyte
? '-' : ' ';
22489 eoltype
= eol_mnemonic_undecided
;
22490 /* Don't mention EOL conversion if it isn't decided. */
22495 Lisp_Object eolvalue
;
22497 attrs
= AREF (val
, 0);
22498 eolvalue
= AREF (val
, 2);
22501 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
22506 /* The EOL conversion that is normal on this system. */
22508 if (NILP (eolvalue
)) /* Not yet decided. */
22509 eoltype
= eol_mnemonic_undecided
;
22510 else if (VECTORP (eolvalue
)) /* Not yet decided. */
22511 eoltype
= eol_mnemonic_undecided
;
22512 else /* eolvalue is Qunix, Qdos, or Qmac. */
22513 eoltype
= (EQ (eolvalue
, Qunix
)
22514 ? eol_mnemonic_unix
22515 : (EQ (eolvalue
, Qdos
) == 1
22516 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
22522 /* Mention the EOL conversion if it is not the usual one. */
22523 if (STRINGP (eoltype
))
22525 eol_str
= SDATA (eoltype
);
22526 eol_str_len
= SBYTES (eoltype
);
22528 else if (CHARACTERP (eoltype
))
22530 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
22531 int c
= XFASTINT (eoltype
);
22532 eol_str_len
= CHAR_STRING (c
, tmp
);
22537 eol_str
= invalid_eol_type
;
22538 eol_str_len
= sizeof (invalid_eol_type
) - 1;
22540 memcpy (buf
, eol_str
, eol_str_len
);
22541 buf
+= eol_str_len
;
22547 /* Return a string for the output of a mode line %-spec for window W,
22548 generated by character C. FIELD_WIDTH > 0 means pad the string
22549 returned with spaces to that value. Return a Lisp string in
22550 *STRING if the resulting string is taken from that Lisp string.
22552 Note we operate on the current buffer for most purposes. */
22554 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
22556 static const char *
22557 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
22558 Lisp_Object
*string
)
22561 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22562 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
22563 /* We are going to use f->decode_mode_spec_buffer as the buffer to
22564 produce strings from numerical values, so limit preposterously
22565 large values of FIELD_WIDTH to avoid overrunning the buffer's
22566 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
22567 bytes plus the terminating null. */
22568 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
22569 struct buffer
*b
= current_buffer
;
22577 if (!NILP (BVAR (b
, read_only
)))
22579 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22584 /* This differs from %* only for a modified read-only buffer. */
22585 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22587 if (!NILP (BVAR (b
, read_only
)))
22592 /* This differs from %* in ignoring read-only-ness. */
22593 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22605 if (command_loop_level
> 5)
22607 p
= decode_mode_spec_buf
;
22608 for (i
= 0; i
< command_loop_level
; i
++)
22611 return decode_mode_spec_buf
;
22619 if (command_loop_level
> 5)
22621 p
= decode_mode_spec_buf
;
22622 for (i
= 0; i
< command_loop_level
; i
++)
22625 return decode_mode_spec_buf
;
22632 /* Let lots_of_dashes be a string of infinite length. */
22633 if (mode_line_target
== MODE_LINE_NOPROP
22634 || mode_line_target
== MODE_LINE_STRING
)
22636 if (field_width
<= 0
22637 || field_width
> sizeof (lots_of_dashes
))
22639 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
22640 decode_mode_spec_buf
[i
] = '-';
22641 decode_mode_spec_buf
[i
] = '\0';
22642 return decode_mode_spec_buf
;
22645 return lots_of_dashes
;
22649 obj
= BVAR (b
, name
);
22653 /* %c and %l are ignored in `frame-title-format'.
22654 (In redisplay_internal, the frame title is drawn _before_ the
22655 windows are updated, so the stuff which depends on actual
22656 window contents (such as %l) may fail to render properly, or
22657 even crash emacs.) */
22658 if (mode_line_target
== MODE_LINE_TITLE
)
22662 ptrdiff_t col
= current_column ();
22663 w
->column_number_displayed
= col
;
22664 pint2str (decode_mode_spec_buf
, width
, col
);
22665 return decode_mode_spec_buf
;
22669 #ifndef SYSTEM_MALLOC
22671 if (NILP (Vmemory_full
))
22674 return "!MEM FULL! ";
22681 /* %F displays the frame name. */
22682 if (!NILP (f
->title
))
22683 return SSDATA (f
->title
);
22684 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
22685 return SSDATA (f
->name
);
22689 obj
= BVAR (b
, filename
);
22694 ptrdiff_t size
= ZV
- BEGV
;
22695 pint2str (decode_mode_spec_buf
, width
, size
);
22696 return decode_mode_spec_buf
;
22701 ptrdiff_t size
= ZV
- BEGV
;
22702 pint2hrstr (decode_mode_spec_buf
, width
, size
);
22703 return decode_mode_spec_buf
;
22708 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
22709 ptrdiff_t topline
, nlines
, height
;
22712 /* %c and %l are ignored in `frame-title-format'. */
22713 if (mode_line_target
== MODE_LINE_TITLE
)
22716 startpos
= marker_position (w
->start
);
22717 startpos_byte
= marker_byte_position (w
->start
);
22718 height
= WINDOW_TOTAL_LINES (w
);
22720 /* If we decided that this buffer isn't suitable for line numbers,
22721 don't forget that too fast. */
22722 if (w
->base_line_pos
== -1)
22725 /* If the buffer is very big, don't waste time. */
22726 if (INTEGERP (Vline_number_display_limit
)
22727 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
22729 w
->base_line_pos
= 0;
22730 w
->base_line_number
= 0;
22734 if (w
->base_line_number
> 0
22735 && w
->base_line_pos
> 0
22736 && w
->base_line_pos
<= startpos
)
22738 line
= w
->base_line_number
;
22739 linepos
= w
->base_line_pos
;
22740 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
22745 linepos
= BUF_BEGV (b
);
22746 linepos_byte
= BUF_BEGV_BYTE (b
);
22749 /* Count lines from base line to window start position. */
22750 nlines
= display_count_lines (linepos_byte
,
22754 topline
= nlines
+ line
;
22756 /* Determine a new base line, if the old one is too close
22757 or too far away, or if we did not have one.
22758 "Too close" means it's plausible a scroll-down would
22759 go back past it. */
22760 if (startpos
== BUF_BEGV (b
))
22762 w
->base_line_number
= topline
;
22763 w
->base_line_pos
= BUF_BEGV (b
);
22765 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
22766 || linepos
== BUF_BEGV (b
))
22768 ptrdiff_t limit
= BUF_BEGV (b
);
22769 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
22770 ptrdiff_t position
;
22771 ptrdiff_t distance
=
22772 (height
* 2 + 30) * line_number_display_limit_width
;
22774 if (startpos
- distance
> limit
)
22776 limit
= startpos
- distance
;
22777 limit_byte
= CHAR_TO_BYTE (limit
);
22780 nlines
= display_count_lines (startpos_byte
,
22782 - (height
* 2 + 30),
22784 /* If we couldn't find the lines we wanted within
22785 line_number_display_limit_width chars per line,
22786 give up on line numbers for this window. */
22787 if (position
== limit_byte
&& limit
== startpos
- distance
)
22789 w
->base_line_pos
= -1;
22790 w
->base_line_number
= 0;
22794 w
->base_line_number
= topline
- nlines
;
22795 w
->base_line_pos
= BYTE_TO_CHAR (position
);
22798 /* Now count lines from the start pos to point. */
22799 nlines
= display_count_lines (startpos_byte
,
22800 PT_BYTE
, PT
, &junk
);
22802 /* Record that we did display the line number. */
22803 line_number_displayed
= 1;
22805 /* Make the string to show. */
22806 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
22807 return decode_mode_spec_buf
;
22810 char* p
= decode_mode_spec_buf
;
22811 int pad
= width
- 2;
22817 return decode_mode_spec_buf
;
22823 obj
= BVAR (b
, mode_name
);
22827 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
22833 ptrdiff_t pos
= marker_position (w
->start
);
22834 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
22836 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
22838 if (pos
<= BUF_BEGV (b
))
22843 else if (pos
<= BUF_BEGV (b
))
22847 if (total
> 1000000)
22848 /* Do it differently for a large value, to avoid overflow. */
22849 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
22851 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
22852 /* We can't normally display a 3-digit number,
22853 so get us a 2-digit number that is close. */
22856 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
22857 return decode_mode_spec_buf
;
22861 /* Display percentage of size above the bottom of the screen. */
22864 ptrdiff_t toppos
= marker_position (w
->start
);
22865 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
22866 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
22868 if (botpos
>= BUF_ZV (b
))
22870 if (toppos
<= BUF_BEGV (b
))
22877 if (total
> 1000000)
22878 /* Do it differently for a large value, to avoid overflow. */
22879 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
22881 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
22882 /* We can't normally display a 3-digit number,
22883 so get us a 2-digit number that is close. */
22886 if (toppos
<= BUF_BEGV (b
))
22887 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
22889 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
22890 return decode_mode_spec_buf
;
22895 /* status of process */
22896 obj
= Fget_buffer_process (Fcurrent_buffer ());
22898 return "no process";
22900 obj
= Fsymbol_name (Fprocess_status (obj
));
22906 ptrdiff_t count
= inhibit_garbage_collection ();
22907 Lisp_Object val
= call1 (intern ("file-remote-p"),
22908 BVAR (current_buffer
, directory
));
22909 unbind_to (count
, Qnil
);
22918 /* coding-system (not including end-of-line format) */
22920 /* coding-system (including end-of-line type) */
22922 int eol_flag
= (c
== 'Z');
22923 char *p
= decode_mode_spec_buf
;
22925 if (! FRAME_WINDOW_P (f
))
22927 /* No need to mention EOL here--the terminal never needs
22928 to do EOL conversion. */
22929 p
= decode_mode_spec_coding (CODING_ID_NAME
22930 (FRAME_KEYBOARD_CODING (f
)->id
),
22932 p
= decode_mode_spec_coding (CODING_ID_NAME
22933 (FRAME_TERMINAL_CODING (f
)->id
),
22936 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
22939 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
22940 #ifdef subprocesses
22941 obj
= Fget_buffer_process (Fcurrent_buffer ());
22942 if (PROCESSP (obj
))
22944 p
= decode_mode_spec_coding
22945 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
22946 p
= decode_mode_spec_coding
22947 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
22949 #endif /* subprocesses */
22952 return decode_mode_spec_buf
;
22959 return SSDATA (obj
);
22966 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
22967 means count lines back from START_BYTE. But don't go beyond
22968 LIMIT_BYTE. Return the number of lines thus found (always
22971 Set *BYTE_POS_PTR to the byte position where we stopped. This is
22972 either the position COUNT lines after/before START_BYTE, if we
22973 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
22977 display_count_lines (ptrdiff_t start_byte
,
22978 ptrdiff_t limit_byte
, ptrdiff_t count
,
22979 ptrdiff_t *byte_pos_ptr
)
22981 register unsigned char *cursor
;
22982 unsigned char *base
;
22984 register ptrdiff_t ceiling
;
22985 register unsigned char *ceiling_addr
;
22986 ptrdiff_t orig_count
= count
;
22988 /* If we are not in selective display mode,
22989 check only for newlines. */
22990 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
22991 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
22995 while (start_byte
< limit_byte
)
22997 ceiling
= BUFFER_CEILING_OF (start_byte
);
22998 ceiling
= min (limit_byte
- 1, ceiling
);
22999 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23000 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23004 if (selective_display
)
23006 while (*cursor
!= '\n' && *cursor
!= 015
23007 && ++cursor
!= ceiling_addr
)
23009 if (cursor
== ceiling_addr
)
23014 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23023 start_byte
+= cursor
- base
;
23024 *byte_pos_ptr
= start_byte
;
23028 while (cursor
< ceiling_addr
);
23030 start_byte
+= ceiling_addr
- base
;
23035 while (start_byte
> limit_byte
)
23037 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23038 ceiling
= max (limit_byte
, ceiling
);
23039 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23040 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23043 if (selective_display
)
23045 while (--cursor
>= ceiling_addr
23046 && *cursor
!= '\n' && *cursor
!= 015)
23048 if (cursor
< ceiling_addr
)
23053 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23060 start_byte
+= cursor
- base
+ 1;
23061 *byte_pos_ptr
= start_byte
;
23062 /* When scanning backwards, we should
23063 not count the newline posterior to which we stop. */
23064 return - orig_count
- 1;
23067 start_byte
+= ceiling_addr
- base
;
23071 *byte_pos_ptr
= limit_byte
;
23074 return - orig_count
+ count
;
23075 return orig_count
- count
;
23081 /***********************************************************************
23083 ***********************************************************************/
23085 /* Display a NUL-terminated string, starting with index START.
23087 If STRING is non-null, display that C string. Otherwise, the Lisp
23088 string LISP_STRING is displayed. There's a case that STRING is
23089 non-null and LISP_STRING is not nil. It means STRING is a string
23090 data of LISP_STRING. In that case, we display LISP_STRING while
23091 ignoring its text properties.
23093 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23094 FACE_STRING. Display STRING or LISP_STRING with the face at
23095 FACE_STRING_POS in FACE_STRING:
23097 Display the string in the environment given by IT, but use the
23098 standard display table, temporarily.
23100 FIELD_WIDTH is the minimum number of output glyphs to produce.
23101 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23102 with spaces. If STRING has more characters, more than FIELD_WIDTH
23103 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23105 PRECISION is the maximum number of characters to output from
23106 STRING. PRECISION < 0 means don't truncate the string.
23108 This is roughly equivalent to printf format specifiers:
23110 FIELD_WIDTH PRECISION PRINTF
23111 ----------------------------------------
23117 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23118 display them, and < 0 means obey the current buffer's value of
23119 enable_multibyte_characters.
23121 Value is the number of columns displayed. */
23124 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23125 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23126 int field_width
, int precision
, int max_x
, int multibyte
)
23128 int hpos_at_start
= it
->hpos
;
23129 int saved_face_id
= it
->face_id
;
23130 struct glyph_row
*row
= it
->glyph_row
;
23131 ptrdiff_t it_charpos
;
23133 /* Initialize the iterator IT for iteration over STRING beginning
23134 with index START. */
23135 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23136 precision
, field_width
, multibyte
);
23137 if (string
&& STRINGP (lisp_string
))
23138 /* LISP_STRING is the one returned by decode_mode_spec. We should
23139 ignore its text properties. */
23140 it
->stop_charpos
= it
->end_charpos
;
23142 /* If displaying STRING, set up the face of the iterator from
23143 FACE_STRING, if that's given. */
23144 if (STRINGP (face_string
))
23150 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23151 0, &endptr
, it
->base_face_id
, 0);
23152 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23153 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23156 /* Set max_x to the maximum allowed X position. Don't let it go
23157 beyond the right edge of the window. */
23159 max_x
= it
->last_visible_x
;
23161 max_x
= min (max_x
, it
->last_visible_x
);
23163 /* Skip over display elements that are not visible. because IT->w is
23165 if (it
->current_x
< it
->first_visible_x
)
23166 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23167 MOVE_TO_POS
| MOVE_TO_X
);
23169 row
->ascent
= it
->max_ascent
;
23170 row
->height
= it
->max_ascent
+ it
->max_descent
;
23171 row
->phys_ascent
= it
->max_phys_ascent
;
23172 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23173 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23175 if (STRINGP (it
->string
))
23176 it_charpos
= IT_STRING_CHARPOS (*it
);
23178 it_charpos
= IT_CHARPOS (*it
);
23180 /* This condition is for the case that we are called with current_x
23181 past last_visible_x. */
23182 while (it
->current_x
< max_x
)
23184 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23186 /* Get the next display element. */
23187 if (!get_next_display_element (it
))
23190 /* Produce glyphs. */
23191 x_before
= it
->current_x
;
23192 n_glyphs_before
= row
->used
[TEXT_AREA
];
23193 PRODUCE_GLYPHS (it
);
23195 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23198 while (i
< nglyphs
)
23200 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23202 if (it
->line_wrap
!= TRUNCATE
23203 && x
+ glyph
->pixel_width
> max_x
)
23205 /* End of continued line or max_x reached. */
23206 if (CHAR_GLYPH_PADDING_P (*glyph
))
23208 /* A wide character is unbreakable. */
23209 if (row
->reversed_p
)
23210 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23211 - n_glyphs_before
);
23212 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23213 it
->current_x
= x_before
;
23217 if (row
->reversed_p
)
23218 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23219 - (n_glyphs_before
+ i
));
23220 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23225 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23227 /* Glyph is at least partially visible. */
23229 if (x
< it
->first_visible_x
)
23230 row
->x
= x
- it
->first_visible_x
;
23234 /* Glyph is off the left margin of the display area.
23235 Should not happen. */
23239 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23240 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23241 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23242 row
->phys_height
= max (row
->phys_height
,
23243 it
->max_phys_ascent
+ it
->max_phys_descent
);
23244 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23245 it
->max_extra_line_spacing
);
23246 x
+= glyph
->pixel_width
;
23250 /* Stop if max_x reached. */
23254 /* Stop at line ends. */
23255 if (ITERATOR_AT_END_OF_LINE_P (it
))
23257 it
->continuation_lines_width
= 0;
23261 set_iterator_to_next (it
, 1);
23262 if (STRINGP (it
->string
))
23263 it_charpos
= IT_STRING_CHARPOS (*it
);
23265 it_charpos
= IT_CHARPOS (*it
);
23267 /* Stop if truncating at the right edge. */
23268 if (it
->line_wrap
== TRUNCATE
23269 && it
->current_x
>= it
->last_visible_x
)
23271 /* Add truncation mark, but don't do it if the line is
23272 truncated at a padding space. */
23273 if (it_charpos
< it
->string_nchars
)
23275 if (!FRAME_WINDOW_P (it
->f
))
23279 if (it
->current_x
> it
->last_visible_x
)
23281 if (!row
->reversed_p
)
23283 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23284 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23289 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23290 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23292 unproduce_glyphs (it
, ii
+ 1);
23293 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23295 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23297 row
->used
[TEXT_AREA
] = ii
;
23298 produce_special_glyphs (it
, IT_TRUNCATION
);
23301 produce_special_glyphs (it
, IT_TRUNCATION
);
23303 row
->truncated_on_right_p
= 1;
23309 /* Maybe insert a truncation at the left. */
23310 if (it
->first_visible_x
23313 if (!FRAME_WINDOW_P (it
->f
)
23314 || (row
->reversed_p
23315 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23316 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23317 insert_left_trunc_glyphs (it
);
23318 row
->truncated_on_left_p
= 1;
23321 it
->face_id
= saved_face_id
;
23323 /* Value is number of columns displayed. */
23324 return it
->hpos
- hpos_at_start
;
23329 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23330 appears as an element of LIST or as the car of an element of LIST.
23331 If PROPVAL is a list, compare each element against LIST in that
23332 way, and return 1/2 if any element of PROPVAL is found in LIST.
23333 Otherwise return 0. This function cannot quit.
23334 The return value is 2 if the text is invisible but with an ellipsis
23335 and 1 if it's invisible and without an ellipsis. */
23338 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
23340 register Lisp_Object tail
, proptail
;
23342 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23344 register Lisp_Object tem
;
23346 if (EQ (propval
, tem
))
23348 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23349 return NILP (XCDR (tem
)) ? 1 : 2;
23352 if (CONSP (propval
))
23354 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23356 Lisp_Object propelt
;
23357 propelt
= XCAR (proptail
);
23358 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23360 register Lisp_Object tem
;
23362 if (EQ (propelt
, tem
))
23364 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23365 return NILP (XCDR (tem
)) ? 1 : 2;
23373 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23374 doc
: /* Non-nil if the property makes the text invisible.
23375 POS-OR-PROP can be a marker or number, in which case it is taken to be
23376 a position in the current buffer and the value of the `invisible' property
23377 is checked; or it can be some other value, which is then presumed to be the
23378 value of the `invisible' property of the text of interest.
23379 The non-nil value returned can be t for truly invisible text or something
23380 else if the text is replaced by an ellipsis. */)
23381 (Lisp_Object pos_or_prop
)
23384 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23385 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23387 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23388 return (invis
== 0 ? Qnil
23390 : make_number (invis
));
23393 /* Calculate a width or height in pixels from a specification using
23394 the following elements:
23397 NUM - a (fractional) multiple of the default font width/height
23398 (NUM) - specifies exactly NUM pixels
23399 UNIT - a fixed number of pixels, see below.
23400 ELEMENT - size of a display element in pixels, see below.
23401 (NUM . SPEC) - equals NUM * SPEC
23402 (+ SPEC SPEC ...) - add pixel values
23403 (- SPEC SPEC ...) - subtract pixel values
23404 (- SPEC) - negate pixel value
23407 INT or FLOAT - a number constant
23408 SYMBOL - use symbol's (buffer local) variable binding.
23411 in - pixels per inch *)
23412 mm - pixels per 1/1000 meter *)
23413 cm - pixels per 1/100 meter *)
23414 width - width of current font in pixels.
23415 height - height of current font in pixels.
23417 *) using the ratio(s) defined in display-pixels-per-inch.
23421 left-fringe - left fringe width in pixels
23422 right-fringe - right fringe width in pixels
23424 left-margin - left margin width in pixels
23425 right-margin - right margin width in pixels
23427 scroll-bar - scroll-bar area width in pixels
23431 Pixels corresponding to 5 inches:
23434 Total width of non-text areas on left side of window (if scroll-bar is on left):
23435 '(space :width (+ left-fringe left-margin scroll-bar))
23437 Align to first text column (in header line):
23438 '(space :align-to 0)
23440 Align to middle of text area minus half the width of variable `my-image'
23441 containing a loaded image:
23442 '(space :align-to (0.5 . (- text my-image)))
23444 Width of left margin minus width of 1 character in the default font:
23445 '(space :width (- left-margin 1))
23447 Width of left margin minus width of 2 characters in the current font:
23448 '(space :width (- left-margin (2 . width)))
23450 Center 1 character over left-margin (in header line):
23451 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23453 Different ways to express width of left fringe plus left margin minus one pixel:
23454 '(space :width (- (+ left-fringe left-margin) (1)))
23455 '(space :width (+ left-fringe left-margin (- (1))))
23456 '(space :width (+ left-fringe left-margin (-1)))
23461 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
23462 struct font
*font
, int width_p
, int *align_to
)
23466 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
23467 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
23470 return OK_PIXELS (0);
23472 eassert (FRAME_LIVE_P (it
->f
));
23474 if (SYMBOLP (prop
))
23476 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
23478 char *unit
= SSDATA (SYMBOL_NAME (prop
));
23480 if (unit
[0] == 'i' && unit
[1] == 'n')
23482 else if (unit
[0] == 'm' && unit
[1] == 'm')
23484 else if (unit
[0] == 'c' && unit
[1] == 'm')
23490 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
23491 : FRAME_RES_Y (it
->f
));
23494 return OK_PIXELS (ppi
/ pixels
);
23499 #ifdef HAVE_WINDOW_SYSTEM
23500 if (EQ (prop
, Qheight
))
23501 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
23502 if (EQ (prop
, Qwidth
))
23503 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
23505 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
23506 return OK_PIXELS (1);
23509 if (EQ (prop
, Qtext
))
23510 return OK_PIXELS (width_p
23511 ? window_box_width (it
->w
, TEXT_AREA
)
23512 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
23514 if (align_to
&& *align_to
< 0)
23517 if (EQ (prop
, Qleft
))
23518 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
23519 if (EQ (prop
, Qright
))
23520 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
23521 if (EQ (prop
, Qcenter
))
23522 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
23523 + window_box_width (it
->w
, TEXT_AREA
) / 2);
23524 if (EQ (prop
, Qleft_fringe
))
23525 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23526 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
23527 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
23528 if (EQ (prop
, Qright_fringe
))
23529 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23530 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23531 : window_box_right_offset (it
->w
, TEXT_AREA
));
23532 if (EQ (prop
, Qleft_margin
))
23533 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
23534 if (EQ (prop
, Qright_margin
))
23535 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
23536 if (EQ (prop
, Qscroll_bar
))
23537 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
23539 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23540 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23541 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23546 if (EQ (prop
, Qleft_fringe
))
23547 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
23548 if (EQ (prop
, Qright_fringe
))
23549 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
23550 if (EQ (prop
, Qleft_margin
))
23551 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
23552 if (EQ (prop
, Qright_margin
))
23553 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
23554 if (EQ (prop
, Qscroll_bar
))
23555 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
23558 prop
= buffer_local_value_1 (prop
, it
->w
->contents
);
23559 if (EQ (prop
, Qunbound
))
23563 if (INTEGERP (prop
) || FLOATP (prop
))
23565 int base_unit
= (width_p
23566 ? FRAME_COLUMN_WIDTH (it
->f
)
23567 : FRAME_LINE_HEIGHT (it
->f
));
23568 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
23573 Lisp_Object car
= XCAR (prop
);
23574 Lisp_Object cdr
= XCDR (prop
);
23578 #ifdef HAVE_WINDOW_SYSTEM
23579 if (FRAME_WINDOW_P (it
->f
)
23580 && valid_image_p (prop
))
23582 ptrdiff_t id
= lookup_image (it
->f
, prop
);
23583 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
23585 return OK_PIXELS (width_p
? img
->width
: img
->height
);
23588 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
23594 while (CONSP (cdr
))
23596 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
23597 font
, width_p
, align_to
))
23600 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
23605 if (EQ (car
, Qminus
))
23607 return OK_PIXELS (pixels
);
23610 car
= buffer_local_value_1 (car
, it
->w
->contents
);
23611 if (EQ (car
, Qunbound
))
23615 if (INTEGERP (car
) || FLOATP (car
))
23618 pixels
= XFLOATINT (car
);
23620 return OK_PIXELS (pixels
);
23621 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
23622 font
, width_p
, align_to
))
23623 return OK_PIXELS (pixels
* fact
);
23634 /***********************************************************************
23636 ***********************************************************************/
23638 #ifdef HAVE_WINDOW_SYSTEM
23643 dump_glyph_string (struct glyph_string
*s
)
23645 fprintf (stderr
, "glyph string\n");
23646 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
23647 s
->x
, s
->y
, s
->width
, s
->height
);
23648 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
23649 fprintf (stderr
, " hl = %d\n", s
->hl
);
23650 fprintf (stderr
, " left overhang = %d, right = %d\n",
23651 s
->left_overhang
, s
->right_overhang
);
23652 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
23653 fprintf (stderr
, " extends to end of line = %d\n",
23654 s
->extends_to_end_of_line_p
);
23655 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
23656 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
23659 #endif /* GLYPH_DEBUG */
23661 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
23662 of XChar2b structures for S; it can't be allocated in
23663 init_glyph_string because it must be allocated via `alloca'. W
23664 is the window on which S is drawn. ROW and AREA are the glyph row
23665 and area within the row from which S is constructed. START is the
23666 index of the first glyph structure covered by S. HL is a
23667 face-override for drawing S. */
23670 #define OPTIONAL_HDC(hdc) HDC hdc,
23671 #define DECLARE_HDC(hdc) HDC hdc;
23672 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
23673 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
23676 #ifndef OPTIONAL_HDC
23677 #define OPTIONAL_HDC(hdc)
23678 #define DECLARE_HDC(hdc)
23679 #define ALLOCATE_HDC(hdc, f)
23680 #define RELEASE_HDC(hdc, f)
23684 init_glyph_string (struct glyph_string
*s
,
23686 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
23687 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
23689 memset (s
, 0, sizeof *s
);
23691 s
->f
= XFRAME (w
->frame
);
23695 s
->display
= FRAME_X_DISPLAY (s
->f
);
23696 s
->window
= FRAME_X_WINDOW (s
->f
);
23697 s
->char2b
= char2b
;
23701 s
->first_glyph
= row
->glyphs
[area
] + start
;
23702 s
->height
= row
->height
;
23703 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
23704 s
->ybase
= s
->y
+ row
->ascent
;
23708 /* Append the list of glyph strings with head H and tail T to the list
23709 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
23712 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23713 struct glyph_string
*h
, struct glyph_string
*t
)
23727 /* Prepend the list of glyph strings with head H and tail T to the
23728 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
23732 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23733 struct glyph_string
*h
, struct glyph_string
*t
)
23747 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
23748 Set *HEAD and *TAIL to the resulting list. */
23751 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
23752 struct glyph_string
*s
)
23754 s
->next
= s
->prev
= NULL
;
23755 append_glyph_string_lists (head
, tail
, s
, s
);
23759 /* Get face and two-byte form of character C in face FACE_ID on frame F.
23760 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
23761 make sure that X resources for the face returned are allocated.
23762 Value is a pointer to a realized face that is ready for display if
23763 DISPLAY_P is non-zero. */
23765 static struct face
*
23766 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
23767 XChar2b
*char2b
, int display_p
)
23769 struct face
*face
= FACE_FROM_ID (f
, face_id
);
23774 code
= face
->font
->driver
->encode_char (face
->font
, c
);
23776 if (code
== FONT_INVALID_CODE
)
23779 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23781 /* Make sure X resources of the face are allocated. */
23782 #ifdef HAVE_X_WINDOWS
23786 eassert (face
!= NULL
);
23787 PREPARE_FACE_FOR_DISPLAY (f
, face
);
23794 /* Get face and two-byte form of character glyph GLYPH on frame F.
23795 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
23796 a pointer to a realized face that is ready for display. */
23798 static struct face
*
23799 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
23800 XChar2b
*char2b
, int *two_byte_p
)
23805 eassert (glyph
->type
== CHAR_GLYPH
);
23806 face
= FACE_FROM_ID (f
, glyph
->face_id
);
23808 /* Make sure X resources of the face are allocated. */
23809 eassert (face
!= NULL
);
23810 PREPARE_FACE_FOR_DISPLAY (f
, face
);
23817 if (CHAR_BYTE8_P (glyph
->u
.ch
))
23818 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
23820 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
23822 if (code
== FONT_INVALID_CODE
)
23826 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23831 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
23832 Return 1 if FONT has a glyph for C, otherwise return 0. */
23835 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
23839 if (CHAR_BYTE8_P (c
))
23840 code
= CHAR_TO_BYTE8 (c
);
23842 code
= font
->driver
->encode_char (font
, c
);
23844 if (code
== FONT_INVALID_CODE
)
23846 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23851 /* Fill glyph string S with composition components specified by S->cmp.
23853 BASE_FACE is the base face of the composition.
23854 S->cmp_from is the index of the first component for S.
23856 OVERLAPS non-zero means S should draw the foreground only, and use
23857 its physical height for clipping. See also draw_glyphs.
23859 Value is the index of a component not in S. */
23862 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
23866 /* For all glyphs of this composition, starting at the offset
23867 S->cmp_from, until we reach the end of the definition or encounter a
23868 glyph that requires the different face, add it to S. */
23873 s
->for_overlaps
= overlaps
;
23876 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
23878 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
23880 /* TAB in a composition means display glyphs with padding space
23881 on the left or right. */
23884 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
23887 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
23894 s
->font
= s
->face
->font
;
23896 else if (s
->face
!= face
)
23904 if (s
->face
== NULL
)
23906 s
->face
= base_face
->ascii_face
;
23907 s
->font
= s
->face
->font
;
23910 /* All glyph strings for the same composition has the same width,
23911 i.e. the width set for the first component of the composition. */
23912 s
->width
= s
->first_glyph
->pixel_width
;
23914 /* If the specified font could not be loaded, use the frame's
23915 default font, but record the fact that we couldn't load it in
23916 the glyph string so that we can draw rectangles for the
23917 characters of the glyph string. */
23918 if (s
->font
== NULL
)
23920 s
->font_not_found_p
= 1;
23921 s
->font
= FRAME_FONT (s
->f
);
23924 /* Adjust base line for subscript/superscript text. */
23925 s
->ybase
+= s
->first_glyph
->voffset
;
23927 /* This glyph string must always be drawn with 16-bit functions. */
23934 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
23935 int start
, int end
, int overlaps
)
23937 struct glyph
*glyph
, *last
;
23938 Lisp_Object lgstring
;
23941 s
->for_overlaps
= overlaps
;
23942 glyph
= s
->row
->glyphs
[s
->area
] + start
;
23943 last
= s
->row
->glyphs
[s
->area
] + end
;
23944 s
->cmp_id
= glyph
->u
.cmp
.id
;
23945 s
->cmp_from
= glyph
->slice
.cmp
.from
;
23946 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
23947 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
23948 lgstring
= composition_gstring_from_id (s
->cmp_id
);
23949 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
23951 while (glyph
< last
23952 && glyph
->u
.cmp
.automatic
23953 && glyph
->u
.cmp
.id
== s
->cmp_id
23954 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
23955 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
23957 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
23959 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
23960 unsigned code
= LGLYPH_CODE (lglyph
);
23962 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
23964 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
23965 return glyph
- s
->row
->glyphs
[s
->area
];
23969 /* Fill glyph string S from a sequence glyphs for glyphless characters.
23970 See the comment of fill_glyph_string for arguments.
23971 Value is the index of the first glyph not in S. */
23975 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
23976 int start
, int end
, int overlaps
)
23978 struct glyph
*glyph
, *last
;
23981 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
23982 s
->for_overlaps
= overlaps
;
23983 glyph
= s
->row
->glyphs
[s
->area
] + start
;
23984 last
= s
->row
->glyphs
[s
->area
] + end
;
23985 voffset
= glyph
->voffset
;
23986 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
23987 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
23989 s
->width
= glyph
->pixel_width
;
23991 while (glyph
< last
23992 && glyph
->type
== GLYPHLESS_GLYPH
23993 && glyph
->voffset
== voffset
23994 && glyph
->face_id
== face_id
)
23997 s
->width
+= glyph
->pixel_width
;
24000 s
->ybase
+= voffset
;
24001 return glyph
- s
->row
->glyphs
[s
->area
];
24005 /* Fill glyph string S from a sequence of character glyphs.
24007 FACE_ID is the face id of the string. START is the index of the
24008 first glyph to consider, END is the index of the last + 1.
24009 OVERLAPS non-zero means S should draw the foreground only, and use
24010 its physical height for clipping. See also draw_glyphs.
24012 Value is the index of the first glyph not in S. */
24015 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24016 int start
, int end
, int overlaps
)
24018 struct glyph
*glyph
, *last
;
24020 int glyph_not_available_p
;
24022 eassert (s
->f
== XFRAME (s
->w
->frame
));
24023 eassert (s
->nchars
== 0);
24024 eassert (start
>= 0 && end
> start
);
24026 s
->for_overlaps
= overlaps
;
24027 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24028 last
= s
->row
->glyphs
[s
->area
] + end
;
24029 voffset
= glyph
->voffset
;
24030 s
->padding_p
= glyph
->padding_p
;
24031 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24033 while (glyph
< last
24034 && glyph
->type
== CHAR_GLYPH
24035 && glyph
->voffset
== voffset
24036 /* Same face id implies same font, nowadays. */
24037 && glyph
->face_id
== face_id
24038 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24042 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24043 s
->char2b
+ s
->nchars
,
24045 s
->two_byte_p
= two_byte_p
;
24047 eassert (s
->nchars
<= end
- start
);
24048 s
->width
+= glyph
->pixel_width
;
24049 if (glyph
++->padding_p
!= s
->padding_p
)
24053 s
->font
= s
->face
->font
;
24055 /* If the specified font could not be loaded, use the frame's font,
24056 but record the fact that we couldn't load it in
24057 S->font_not_found_p so that we can draw rectangles for the
24058 characters of the glyph string. */
24059 if (s
->font
== NULL
|| glyph_not_available_p
)
24061 s
->font_not_found_p
= 1;
24062 s
->font
= FRAME_FONT (s
->f
);
24065 /* Adjust base line for subscript/superscript text. */
24066 s
->ybase
+= voffset
;
24068 eassert (s
->face
&& s
->face
->gc
);
24069 return glyph
- s
->row
->glyphs
[s
->area
];
24073 /* Fill glyph string S from image glyph S->first_glyph. */
24076 fill_image_glyph_string (struct glyph_string
*s
)
24078 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24079 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24081 s
->slice
= s
->first_glyph
->slice
.img
;
24082 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24083 s
->font
= s
->face
->font
;
24084 s
->width
= s
->first_glyph
->pixel_width
;
24086 /* Adjust base line for subscript/superscript text. */
24087 s
->ybase
+= s
->first_glyph
->voffset
;
24091 /* Fill glyph string S from a sequence of stretch glyphs.
24093 START is the index of the first glyph to consider,
24094 END is the index of the last + 1.
24096 Value is the index of the first glyph not in S. */
24099 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24101 struct glyph
*glyph
, *last
;
24102 int voffset
, face_id
;
24104 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24106 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24107 last
= s
->row
->glyphs
[s
->area
] + end
;
24108 face_id
= glyph
->face_id
;
24109 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24110 s
->font
= s
->face
->font
;
24111 s
->width
= glyph
->pixel_width
;
24113 voffset
= glyph
->voffset
;
24117 && glyph
->type
== STRETCH_GLYPH
24118 && glyph
->voffset
== voffset
24119 && glyph
->face_id
== face_id
);
24121 s
->width
+= glyph
->pixel_width
;
24123 /* Adjust base line for subscript/superscript text. */
24124 s
->ybase
+= voffset
;
24126 /* The case that face->gc == 0 is handled when drawing the glyph
24127 string by calling PREPARE_FACE_FOR_DISPLAY. */
24129 return glyph
- s
->row
->glyphs
[s
->area
];
24132 static struct font_metrics
*
24133 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24135 static struct font_metrics metrics
;
24140 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24141 if (code
== FONT_INVALID_CODE
)
24143 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24148 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24149 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24150 assumed to be zero. */
24153 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24155 *left
= *right
= 0;
24157 if (glyph
->type
== CHAR_GLYPH
)
24161 struct font_metrics
*pcm
;
24163 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
24164 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
24166 if (pcm
->rbearing
> pcm
->width
)
24167 *right
= pcm
->rbearing
- pcm
->width
;
24168 if (pcm
->lbearing
< 0)
24169 *left
= -pcm
->lbearing
;
24172 else if (glyph
->type
== COMPOSITE_GLYPH
)
24174 if (! glyph
->u
.cmp
.automatic
)
24176 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24178 if (cmp
->rbearing
> cmp
->pixel_width
)
24179 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24180 if (cmp
->lbearing
< 0)
24181 *left
= - cmp
->lbearing
;
24185 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24186 struct font_metrics metrics
;
24188 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24189 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24190 if (metrics
.rbearing
> metrics
.width
)
24191 *right
= metrics
.rbearing
- metrics
.width
;
24192 if (metrics
.lbearing
< 0)
24193 *left
= - metrics
.lbearing
;
24199 /* Return the index of the first glyph preceding glyph string S that
24200 is overwritten by S because of S's left overhang. Value is -1
24201 if no glyphs are overwritten. */
24204 left_overwritten (struct glyph_string
*s
)
24208 if (s
->left_overhang
)
24211 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24212 int first
= s
->first_glyph
- glyphs
;
24214 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24215 x
-= glyphs
[i
].pixel_width
;
24226 /* Return the index of the first glyph preceding glyph string S that
24227 is overwriting S because of its right overhang. Value is -1 if no
24228 glyph in front of S overwrites S. */
24231 left_overwriting (struct glyph_string
*s
)
24234 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24235 int first
= s
->first_glyph
- glyphs
;
24239 for (i
= first
- 1; i
>= 0; --i
)
24242 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24245 x
-= glyphs
[i
].pixel_width
;
24252 /* Return the index of the last glyph following glyph string S that is
24253 overwritten by S because of S's right overhang. Value is -1 if
24254 no such glyph is found. */
24257 right_overwritten (struct glyph_string
*s
)
24261 if (s
->right_overhang
)
24264 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24265 int first
= (s
->first_glyph
- glyphs
24266 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24267 int end
= s
->row
->used
[s
->area
];
24269 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24270 x
+= glyphs
[i
].pixel_width
;
24279 /* Return the index of the last glyph following glyph string S that
24280 overwrites S because of its left overhang. Value is negative
24281 if no such glyph is found. */
24284 right_overwriting (struct glyph_string
*s
)
24287 int end
= s
->row
->used
[s
->area
];
24288 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24289 int first
= (s
->first_glyph
- glyphs
24290 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24294 for (i
= first
; i
< end
; ++i
)
24297 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24300 x
+= glyphs
[i
].pixel_width
;
24307 /* Set background width of glyph string S. START is the index of the
24308 first glyph following S. LAST_X is the right-most x-position + 1
24309 in the drawing area. */
24312 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24314 /* If the face of this glyph string has to be drawn to the end of
24315 the drawing area, set S->extends_to_end_of_line_p. */
24317 if (start
== s
->row
->used
[s
->area
]
24318 && ((s
->row
->fill_line_p
24319 && (s
->hl
== DRAW_NORMAL_TEXT
24320 || s
->hl
== DRAW_IMAGE_RAISED
24321 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24322 || s
->hl
== DRAW_MOUSE_FACE
))
24323 s
->extends_to_end_of_line_p
= 1;
24325 /* If S extends its face to the end of the line, set its
24326 background_width to the distance to the right edge of the drawing
24328 if (s
->extends_to_end_of_line_p
)
24329 s
->background_width
= last_x
- s
->x
+ 1;
24331 s
->background_width
= s
->width
;
24335 /* Compute overhangs and x-positions for glyph string S and its
24336 predecessors, or successors. X is the starting x-position for S.
24337 BACKWARD_P non-zero means process predecessors. */
24340 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
24346 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24347 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24357 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24358 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24368 /* The following macros are only called from draw_glyphs below.
24369 They reference the following parameters of that function directly:
24370 `w', `row', `area', and `overlap_p'
24371 as well as the following local variables:
24372 `s', `f', and `hdc' (in W32) */
24375 /* On W32, silently add local `hdc' variable to argument list of
24376 init_glyph_string. */
24377 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24378 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24380 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24381 init_glyph_string (s, char2b, w, row, area, start, hl)
24384 /* Add a glyph string for a stretch glyph to the list of strings
24385 between HEAD and TAIL. START is the index of the stretch glyph in
24386 row area AREA of glyph row ROW. END is the index of the last glyph
24387 in that glyph row area. X is the current output position assigned
24388 to the new glyph string constructed. HL overrides that face of the
24389 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24390 is the right-most x-position of the drawing area. */
24392 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24393 and below -- keep them on one line. */
24394 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24397 s = alloca (sizeof *s); \
24398 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24399 START = fill_stretch_glyph_string (s, START, END); \
24400 append_glyph_string (&HEAD, &TAIL, s); \
24406 /* Add a glyph string for an image glyph to the list of strings
24407 between HEAD and TAIL. START is the index of the image glyph in
24408 row area AREA of glyph row ROW. END is the index of the last glyph
24409 in that glyph row area. X is the current output position assigned
24410 to the new glyph string constructed. HL overrides that face of the
24411 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24412 is the right-most x-position of the drawing area. */
24414 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24417 s = alloca (sizeof *s); \
24418 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24419 fill_image_glyph_string (s); \
24420 append_glyph_string (&HEAD, &TAIL, s); \
24427 /* Add a glyph string for a sequence of character glyphs to the list
24428 of strings between HEAD and TAIL. START is the index of the first
24429 glyph in row area AREA of glyph row ROW that is part of the new
24430 glyph string. END is the index of the last glyph in that glyph row
24431 area. X is the current output position assigned to the new glyph
24432 string constructed. HL overrides that face of the glyph; e.g. it
24433 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24434 right-most x-position of the drawing area. */
24436 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24442 face_id = (row)->glyphs[area][START].face_id; \
24444 s = alloca (sizeof *s); \
24445 char2b = alloca ((END - START) * sizeof *char2b); \
24446 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24447 append_glyph_string (&HEAD, &TAIL, s); \
24449 START = fill_glyph_string (s, face_id, START, END, overlaps); \
24454 /* Add a glyph string for a composite sequence to the list of strings
24455 between HEAD and TAIL. START is the index of the first glyph in
24456 row area AREA of glyph row ROW that is part of the new glyph
24457 string. END is the index of the last glyph in that glyph row area.
24458 X is the current output position assigned to the new glyph string
24459 constructed. HL overrides that face of the glyph; e.g. it is
24460 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
24461 x-position of the drawing area. */
24463 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24465 int face_id = (row)->glyphs[area][START].face_id; \
24466 struct face *base_face = FACE_FROM_ID (f, face_id); \
24467 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
24468 struct composition *cmp = composition_table[cmp_id]; \
24470 struct glyph_string *first_s = NULL; \
24473 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
24475 /* Make glyph_strings for each glyph sequence that is drawable by \
24476 the same face, and append them to HEAD/TAIL. */ \
24477 for (n = 0; n < cmp->glyph_len;) \
24479 s = alloca (sizeof *s); \
24480 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24481 append_glyph_string (&(HEAD), &(TAIL), s); \
24487 n = fill_composite_glyph_string (s, base_face, overlaps); \
24495 /* Add a glyph string for a glyph-string sequence to the list of strings
24496 between HEAD and TAIL. */
24498 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24502 Lisp_Object gstring; \
24504 face_id = (row)->glyphs[area][START].face_id; \
24505 gstring = (composition_gstring_from_id \
24506 ((row)->glyphs[area][START].u.cmp.id)); \
24507 s = alloca (sizeof *s); \
24508 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
24509 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24510 append_glyph_string (&(HEAD), &(TAIL), s); \
24512 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
24516 /* Add a glyph string for a sequence of glyphless character's glyphs
24517 to the list of strings between HEAD and TAIL. The meanings of
24518 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
24520 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24525 face_id = (row)->glyphs[area][START].face_id; \
24527 s = alloca (sizeof *s); \
24528 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24529 append_glyph_string (&HEAD, &TAIL, s); \
24531 START = fill_glyphless_glyph_string (s, face_id, START, END, \
24537 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
24538 of AREA of glyph row ROW on window W between indices START and END.
24539 HL overrides the face for drawing glyph strings, e.g. it is
24540 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
24541 x-positions of the drawing area.
24543 This is an ugly monster macro construct because we must use alloca
24544 to allocate glyph strings (because draw_glyphs can be called
24545 asynchronously). */
24547 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24550 HEAD = TAIL = NULL; \
24551 while (START < END) \
24553 struct glyph *first_glyph = (row)->glyphs[area] + START; \
24554 switch (first_glyph->type) \
24557 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
24561 case COMPOSITE_GLYPH: \
24562 if (first_glyph->u.cmp.automatic) \
24563 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
24566 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
24570 case STRETCH_GLYPH: \
24571 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
24575 case IMAGE_GLYPH: \
24576 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
24580 case GLYPHLESS_GLYPH: \
24581 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
24591 set_glyph_string_background_width (s, START, LAST_X); \
24598 /* Draw glyphs between START and END in AREA of ROW on window W,
24599 starting at x-position X. X is relative to AREA in W. HL is a
24600 face-override with the following meaning:
24602 DRAW_NORMAL_TEXT draw normally
24603 DRAW_CURSOR draw in cursor face
24604 DRAW_MOUSE_FACE draw in mouse face.
24605 DRAW_INVERSE_VIDEO draw in mode line face
24606 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
24607 DRAW_IMAGE_RAISED draw an image with a raised relief around it
24609 If OVERLAPS is non-zero, draw only the foreground of characters and
24610 clip to the physical height of ROW. Non-zero value also defines
24611 the overlapping part to be drawn:
24613 OVERLAPS_PRED overlap with preceding rows
24614 OVERLAPS_SUCC overlap with succeeding rows
24615 OVERLAPS_BOTH overlap with both preceding/succeeding rows
24616 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
24618 Value is the x-position reached, relative to AREA of W. */
24621 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
24622 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
24623 enum draw_glyphs_face hl
, int overlaps
)
24625 struct glyph_string
*head
, *tail
;
24626 struct glyph_string
*s
;
24627 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
24628 int i
, j
, x_reached
, last_x
, area_left
= 0;
24629 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24632 ALLOCATE_HDC (hdc
, f
);
24634 /* Let's rather be paranoid than getting a SEGV. */
24635 end
= min (end
, row
->used
[area
]);
24636 start
= clip_to_bounds (0, start
, end
);
24638 /* Translate X to frame coordinates. Set last_x to the right
24639 end of the drawing area. */
24640 if (row
->full_width_p
)
24642 /* X is relative to the left edge of W, without scroll bars
24644 area_left
= WINDOW_LEFT_EDGE_X (w
);
24645 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
24646 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
24650 area_left
= window_box_left (w
, area
);
24651 last_x
= area_left
+ window_box_width (w
, area
);
24655 /* Build a doubly-linked list of glyph_string structures between
24656 head and tail from what we have to draw. Note that the macro
24657 BUILD_GLYPH_STRINGS will modify its start parameter. That's
24658 the reason we use a separate variable `i'. */
24660 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
24662 x_reached
= tail
->x
+ tail
->background_width
;
24666 /* If there are any glyphs with lbearing < 0 or rbearing > width in
24667 the row, redraw some glyphs in front or following the glyph
24668 strings built above. */
24669 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
24671 struct glyph_string
*h
, *t
;
24672 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24673 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
24674 int check_mouse_face
= 0;
24677 /* If mouse highlighting is on, we may need to draw adjacent
24678 glyphs using mouse-face highlighting. */
24679 if (area
== TEXT_AREA
&& row
->mouse_face_p
24680 && hlinfo
->mouse_face_beg_row
>= 0
24681 && hlinfo
->mouse_face_end_row
>= 0)
24683 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
24685 if (row_vpos
>= hlinfo
->mouse_face_beg_row
24686 && row_vpos
<= hlinfo
->mouse_face_end_row
)
24688 check_mouse_face
= 1;
24689 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
24690 ? hlinfo
->mouse_face_beg_col
: 0;
24691 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
24692 ? hlinfo
->mouse_face_end_col
24693 : row
->used
[TEXT_AREA
];
24697 /* Compute overhangs for all glyph strings. */
24698 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
24699 for (s
= head
; s
; s
= s
->next
)
24700 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
24702 /* Prepend glyph strings for glyphs in front of the first glyph
24703 string that are overwritten because of the first glyph
24704 string's left overhang. The background of all strings
24705 prepended must be drawn because the first glyph string
24707 i
= left_overwritten (head
);
24710 enum draw_glyphs_face overlap_hl
;
24712 /* If this row contains mouse highlighting, attempt to draw
24713 the overlapped glyphs with the correct highlight. This
24714 code fails if the overlap encompasses more than one glyph
24715 and mouse-highlight spans only some of these glyphs.
24716 However, making it work perfectly involves a lot more
24717 code, and I don't know if the pathological case occurs in
24718 practice, so we'll stick to this for now. --- cyd */
24719 if (check_mouse_face
24720 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24721 overlap_hl
= DRAW_MOUSE_FACE
;
24723 overlap_hl
= DRAW_NORMAL_TEXT
;
24726 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
24727 overlap_hl
, dummy_x
, last_x
);
24729 compute_overhangs_and_x (t
, head
->x
, 1);
24730 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24734 /* Prepend glyph strings for glyphs in front of the first glyph
24735 string that overwrite that glyph string because of their
24736 right overhang. For these strings, only the foreground must
24737 be drawn, because it draws over the glyph string at `head'.
24738 The background must not be drawn because this would overwrite
24739 right overhangs of preceding glyphs for which no glyph
24741 i
= left_overwriting (head
);
24744 enum draw_glyphs_face overlap_hl
;
24746 if (check_mouse_face
24747 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24748 overlap_hl
= DRAW_MOUSE_FACE
;
24750 overlap_hl
= DRAW_NORMAL_TEXT
;
24753 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
24754 overlap_hl
, dummy_x
, last_x
);
24755 for (s
= h
; s
; s
= s
->next
)
24756 s
->background_filled_p
= 1;
24757 compute_overhangs_and_x (t
, head
->x
, 1);
24758 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24761 /* Append glyphs strings for glyphs following the last glyph
24762 string tail that are overwritten by tail. The background of
24763 these strings has to be drawn because tail's foreground draws
24765 i
= right_overwritten (tail
);
24768 enum draw_glyphs_face overlap_hl
;
24770 if (check_mouse_face
24771 && mouse_beg_col
< i
&& mouse_end_col
> end
)
24772 overlap_hl
= DRAW_MOUSE_FACE
;
24774 overlap_hl
= DRAW_NORMAL_TEXT
;
24776 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
24777 overlap_hl
, x
, last_x
);
24778 /* Because BUILD_GLYPH_STRINGS updates the first argument,
24779 we don't have `end = i;' here. */
24780 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
24781 append_glyph_string_lists (&head
, &tail
, h
, t
);
24785 /* Append glyph strings for glyphs following the last glyph
24786 string tail that overwrite tail. The foreground of such
24787 glyphs has to be drawn because it writes into the background
24788 of tail. The background must not be drawn because it could
24789 paint over the foreground of following glyphs. */
24790 i
= right_overwriting (tail
);
24793 enum draw_glyphs_face overlap_hl
;
24794 if (check_mouse_face
24795 && mouse_beg_col
< i
&& mouse_end_col
> end
)
24796 overlap_hl
= DRAW_MOUSE_FACE
;
24798 overlap_hl
= DRAW_NORMAL_TEXT
;
24801 i
++; /* We must include the Ith glyph. */
24802 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
24803 overlap_hl
, x
, last_x
);
24804 for (s
= h
; s
; s
= s
->next
)
24805 s
->background_filled_p
= 1;
24806 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
24807 append_glyph_string_lists (&head
, &tail
, h
, t
);
24809 if (clip_head
|| clip_tail
)
24810 for (s
= head
; s
; s
= s
->next
)
24812 s
->clip_head
= clip_head
;
24813 s
->clip_tail
= clip_tail
;
24817 /* Draw all strings. */
24818 for (s
= head
; s
; s
= s
->next
)
24819 FRAME_RIF (f
)->draw_glyph_string (s
);
24822 /* When focus a sole frame and move horizontally, this sets on_p to 0
24823 causing a failure to erase prev cursor position. */
24824 if (area
== TEXT_AREA
24825 && !row
->full_width_p
24826 /* When drawing overlapping rows, only the glyph strings'
24827 foreground is drawn, which doesn't erase a cursor
24831 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
24832 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
24833 : (tail
? tail
->x
+ tail
->background_width
: x
));
24837 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
24838 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
24842 /* Value is the x-position up to which drawn, relative to AREA of W.
24843 This doesn't include parts drawn because of overhangs. */
24844 if (row
->full_width_p
)
24845 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
24847 x_reached
-= area_left
;
24849 RELEASE_HDC (hdc
, f
);
24854 /* Expand row matrix if too narrow. Don't expand if area
24857 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
24859 if (!it->f->fonts_changed \
24860 && (it->glyph_row->glyphs[area] \
24861 < it->glyph_row->glyphs[area + 1])) \
24863 it->w->ncols_scale_factor++; \
24864 it->f->fonts_changed = 1; \
24868 /* Store one glyph for IT->char_to_display in IT->glyph_row.
24869 Called from x_produce_glyphs when IT->glyph_row is non-null. */
24872 append_glyph (struct it
*it
)
24874 struct glyph
*glyph
;
24875 enum glyph_row_area area
= it
->area
;
24877 eassert (it
->glyph_row
);
24878 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
24880 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24881 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24883 /* If the glyph row is reversed, we need to prepend the glyph
24884 rather than append it. */
24885 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24889 /* Make room for the additional glyph. */
24890 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24892 glyph
= it
->glyph_row
->glyphs
[area
];
24894 glyph
->charpos
= CHARPOS (it
->position
);
24895 glyph
->object
= it
->object
;
24896 if (it
->pixel_width
> 0)
24898 glyph
->pixel_width
= it
->pixel_width
;
24899 glyph
->padding_p
= 0;
24903 /* Assure at least 1-pixel width. Otherwise, cursor can't
24904 be displayed correctly. */
24905 glyph
->pixel_width
= 1;
24906 glyph
->padding_p
= 1;
24908 glyph
->ascent
= it
->ascent
;
24909 glyph
->descent
= it
->descent
;
24910 glyph
->voffset
= it
->voffset
;
24911 glyph
->type
= CHAR_GLYPH
;
24912 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24913 glyph
->multibyte_p
= it
->multibyte_p
;
24914 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24916 /* In R2L rows, the left and the right box edges need to be
24917 drawn in reverse direction. */
24918 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24919 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24923 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24924 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24926 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24927 || it
->phys_descent
> it
->descent
);
24928 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
24929 glyph
->face_id
= it
->face_id
;
24930 glyph
->u
.ch
= it
->char_to_display
;
24931 glyph
->slice
.img
= null_glyph_slice
;
24932 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24935 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24936 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24938 glyph
->bidi_type
= it
->bidi_it
.type
;
24942 glyph
->resolved_level
= 0;
24943 glyph
->bidi_type
= UNKNOWN_BT
;
24945 ++it
->glyph_row
->used
[area
];
24948 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24951 /* Store one glyph for the composition IT->cmp_it.id in
24952 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
24956 append_composite_glyph (struct it
*it
)
24958 struct glyph
*glyph
;
24959 enum glyph_row_area area
= it
->area
;
24961 eassert (it
->glyph_row
);
24963 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24964 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24966 /* If the glyph row is reversed, we need to prepend the glyph
24967 rather than append it. */
24968 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
24972 /* Make room for the new glyph. */
24973 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
24975 glyph
= it
->glyph_row
->glyphs
[it
->area
];
24977 glyph
->charpos
= it
->cmp_it
.charpos
;
24978 glyph
->object
= it
->object
;
24979 glyph
->pixel_width
= it
->pixel_width
;
24980 glyph
->ascent
= it
->ascent
;
24981 glyph
->descent
= it
->descent
;
24982 glyph
->voffset
= it
->voffset
;
24983 glyph
->type
= COMPOSITE_GLYPH
;
24984 if (it
->cmp_it
.ch
< 0)
24986 glyph
->u
.cmp
.automatic
= 0;
24987 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
24988 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
24992 glyph
->u
.cmp
.automatic
= 1;
24993 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
24994 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
24995 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
24997 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24998 glyph
->multibyte_p
= it
->multibyte_p
;
24999 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25001 /* In R2L rows, the left and the right box edges need to be
25002 drawn in reverse direction. */
25003 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25004 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25008 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25009 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25011 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25012 || it
->phys_descent
> it
->descent
);
25013 glyph
->padding_p
= 0;
25014 glyph
->glyph_not_available_p
= 0;
25015 glyph
->face_id
= it
->face_id
;
25016 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25019 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25020 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25022 glyph
->bidi_type
= it
->bidi_it
.type
;
25024 ++it
->glyph_row
->used
[area
];
25027 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25031 /* Change IT->ascent and IT->height according to the setting of
25035 take_vertical_position_into_account (struct it
*it
)
25039 if (it
->voffset
< 0)
25040 /* Increase the ascent so that we can display the text higher
25042 it
->ascent
-= it
->voffset
;
25044 /* Increase the descent so that we can display the text lower
25046 it
->descent
+= it
->voffset
;
25051 /* Produce glyphs/get display metrics for the image IT is loaded with.
25052 See the description of struct display_iterator in dispextern.h for
25053 an overview of struct display_iterator. */
25056 produce_image_glyph (struct it
*it
)
25060 int glyph_ascent
, crop
;
25061 struct glyph_slice slice
;
25063 eassert (it
->what
== IT_IMAGE
);
25065 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25067 /* Make sure X resources of the face is loaded. */
25068 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
25070 if (it
->image_id
< 0)
25072 /* Fringe bitmap. */
25073 it
->ascent
= it
->phys_ascent
= 0;
25074 it
->descent
= it
->phys_descent
= 0;
25075 it
->pixel_width
= 0;
25080 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25082 /* Make sure X resources of the image is loaded. */
25083 prepare_image_for_display (it
->f
, img
);
25085 slice
.x
= slice
.y
= 0;
25086 slice
.width
= img
->width
;
25087 slice
.height
= img
->height
;
25089 if (INTEGERP (it
->slice
.x
))
25090 slice
.x
= XINT (it
->slice
.x
);
25091 else if (FLOATP (it
->slice
.x
))
25092 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25094 if (INTEGERP (it
->slice
.y
))
25095 slice
.y
= XINT (it
->slice
.y
);
25096 else if (FLOATP (it
->slice
.y
))
25097 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25099 if (INTEGERP (it
->slice
.width
))
25100 slice
.width
= XINT (it
->slice
.width
);
25101 else if (FLOATP (it
->slice
.width
))
25102 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25104 if (INTEGERP (it
->slice
.height
))
25105 slice
.height
= XINT (it
->slice
.height
);
25106 else if (FLOATP (it
->slice
.height
))
25107 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25109 if (slice
.x
>= img
->width
)
25110 slice
.x
= img
->width
;
25111 if (slice
.y
>= img
->height
)
25112 slice
.y
= img
->height
;
25113 if (slice
.x
+ slice
.width
>= img
->width
)
25114 slice
.width
= img
->width
- slice
.x
;
25115 if (slice
.y
+ slice
.height
> img
->height
)
25116 slice
.height
= img
->height
- slice
.y
;
25118 if (slice
.width
== 0 || slice
.height
== 0)
25121 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25123 it
->descent
= slice
.height
- glyph_ascent
;
25125 it
->descent
+= img
->vmargin
;
25126 if (slice
.y
+ slice
.height
== img
->height
)
25127 it
->descent
+= img
->vmargin
;
25128 it
->phys_descent
= it
->descent
;
25130 it
->pixel_width
= slice
.width
;
25132 it
->pixel_width
+= img
->hmargin
;
25133 if (slice
.x
+ slice
.width
== img
->width
)
25134 it
->pixel_width
+= img
->hmargin
;
25136 /* It's quite possible for images to have an ascent greater than
25137 their height, so don't get confused in that case. */
25138 if (it
->descent
< 0)
25143 if (face
->box
!= FACE_NO_BOX
)
25145 if (face
->box_line_width
> 0)
25148 it
->ascent
+= face
->box_line_width
;
25149 if (slice
.y
+ slice
.height
== img
->height
)
25150 it
->descent
+= face
->box_line_width
;
25153 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25154 it
->pixel_width
+= eabs (face
->box_line_width
);
25155 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25156 it
->pixel_width
+= eabs (face
->box_line_width
);
25159 take_vertical_position_into_account (it
);
25161 /* Automatically crop wide image glyphs at right edge so we can
25162 draw the cursor on same display row. */
25163 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25164 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25166 it
->pixel_width
-= crop
;
25167 slice
.width
-= crop
;
25172 struct glyph
*glyph
;
25173 enum glyph_row_area area
= it
->area
;
25175 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25176 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25178 glyph
->charpos
= CHARPOS (it
->position
);
25179 glyph
->object
= it
->object
;
25180 glyph
->pixel_width
= it
->pixel_width
;
25181 glyph
->ascent
= glyph_ascent
;
25182 glyph
->descent
= it
->descent
;
25183 glyph
->voffset
= it
->voffset
;
25184 glyph
->type
= IMAGE_GLYPH
;
25185 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25186 glyph
->multibyte_p
= it
->multibyte_p
;
25187 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25189 /* In R2L rows, the left and the right box edges need to be
25190 drawn in reverse direction. */
25191 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25192 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25196 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25197 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25199 glyph
->overlaps_vertically_p
= 0;
25200 glyph
->padding_p
= 0;
25201 glyph
->glyph_not_available_p
= 0;
25202 glyph
->face_id
= it
->face_id
;
25203 glyph
->u
.img_id
= img
->id
;
25204 glyph
->slice
.img
= slice
;
25205 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25208 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25209 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25211 glyph
->bidi_type
= it
->bidi_it
.type
;
25213 ++it
->glyph_row
->used
[area
];
25216 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25221 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25222 of the glyph, WIDTH and HEIGHT are the width and height of the
25223 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25226 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25227 int width
, int height
, int ascent
)
25229 struct glyph
*glyph
;
25230 enum glyph_row_area area
= it
->area
;
25232 eassert (ascent
>= 0 && ascent
<= height
);
25234 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25235 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25237 /* If the glyph row is reversed, we need to prepend the glyph
25238 rather than append it. */
25239 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25243 /* Make room for the additional glyph. */
25244 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25246 glyph
= it
->glyph_row
->glyphs
[area
];
25248 glyph
->charpos
= CHARPOS (it
->position
);
25249 glyph
->object
= object
;
25250 glyph
->pixel_width
= width
;
25251 glyph
->ascent
= ascent
;
25252 glyph
->descent
= height
- ascent
;
25253 glyph
->voffset
= it
->voffset
;
25254 glyph
->type
= STRETCH_GLYPH
;
25255 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25256 glyph
->multibyte_p
= it
->multibyte_p
;
25257 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25259 /* In R2L rows, the left and the right box edges need to be
25260 drawn in reverse direction. */
25261 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25262 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25266 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25267 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25269 glyph
->overlaps_vertically_p
= 0;
25270 glyph
->padding_p
= 0;
25271 glyph
->glyph_not_available_p
= 0;
25272 glyph
->face_id
= it
->face_id
;
25273 glyph
->u
.stretch
.ascent
= ascent
;
25274 glyph
->u
.stretch
.height
= height
;
25275 glyph
->slice
.img
= null_glyph_slice
;
25276 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25279 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25280 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25282 glyph
->bidi_type
= it
->bidi_it
.type
;
25286 glyph
->resolved_level
= 0;
25287 glyph
->bidi_type
= UNKNOWN_BT
;
25289 ++it
->glyph_row
->used
[area
];
25292 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25295 #endif /* HAVE_WINDOW_SYSTEM */
25297 /* Produce a stretch glyph for iterator IT. IT->object is the value
25298 of the glyph property displayed. The value must be a list
25299 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25302 1. `:width WIDTH' specifies that the space should be WIDTH *
25303 canonical char width wide. WIDTH may be an integer or floating
25306 2. `:relative-width FACTOR' specifies that the width of the stretch
25307 should be computed from the width of the first character having the
25308 `glyph' property, and should be FACTOR times that width.
25310 3. `:align-to HPOS' specifies that the space should be wide enough
25311 to reach HPOS, a value in canonical character units.
25313 Exactly one of the above pairs must be present.
25315 4. `:height HEIGHT' specifies that the height of the stretch produced
25316 should be HEIGHT, measured in canonical character units.
25318 5. `:relative-height FACTOR' specifies that the height of the
25319 stretch should be FACTOR times the height of the characters having
25320 the glyph property.
25322 Either none or exactly one of 4 or 5 must be present.
25324 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25325 of the stretch should be used for the ascent of the stretch.
25326 ASCENT must be in the range 0 <= ASCENT <= 100. */
25329 produce_stretch_glyph (struct it
*it
)
25331 /* (space :width WIDTH :height HEIGHT ...) */
25332 Lisp_Object prop
, plist
;
25333 int width
= 0, height
= 0, align_to
= -1;
25334 int zero_width_ok_p
= 0;
25336 struct font
*font
= NULL
;
25338 #ifdef HAVE_WINDOW_SYSTEM
25340 int zero_height_ok_p
= 0;
25342 if (FRAME_WINDOW_P (it
->f
))
25344 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25345 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25346 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
25350 /* List should start with `space'. */
25351 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
25352 plist
= XCDR (it
->object
);
25354 /* Compute the width of the stretch. */
25355 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
25356 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
25358 /* Absolute width `:width WIDTH' specified and valid. */
25359 zero_width_ok_p
= 1;
25362 #ifdef HAVE_WINDOW_SYSTEM
25363 else if (FRAME_WINDOW_P (it
->f
)
25364 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
25366 /* Relative width `:relative-width FACTOR' specified and valid.
25367 Compute the width of the characters having the `glyph'
25370 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
25373 if (it
->multibyte_p
)
25374 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
25377 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
25378 if (! ASCII_CHAR_P (it2
.c
))
25379 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
25382 it2
.glyph_row
= NULL
;
25383 it2
.what
= IT_CHARACTER
;
25384 x_produce_glyphs (&it2
);
25385 width
= NUMVAL (prop
) * it2
.pixel_width
;
25387 #endif /* HAVE_WINDOW_SYSTEM */
25388 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
25389 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
25391 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
25392 align_to
= (align_to
< 0
25394 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
25395 else if (align_to
< 0)
25396 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
25397 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
25398 zero_width_ok_p
= 1;
25401 /* Nothing specified -> width defaults to canonical char width. */
25402 width
= FRAME_COLUMN_WIDTH (it
->f
);
25404 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
25407 #ifdef HAVE_WINDOW_SYSTEM
25408 /* Compute height. */
25409 if (FRAME_WINDOW_P (it
->f
))
25411 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
25412 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25415 zero_height_ok_p
= 1;
25417 else if (prop
= Fplist_get (plist
, QCrelative_height
),
25419 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
25421 height
= FONT_HEIGHT (font
);
25423 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
25426 /* Compute percentage of height used for ascent. If
25427 `:ascent ASCENT' is present and valid, use that. Otherwise,
25428 derive the ascent from the font in use. */
25429 if (prop
= Fplist_get (plist
, QCascent
),
25430 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
25431 ascent
= height
* NUMVAL (prop
) / 100.0;
25432 else if (!NILP (prop
)
25433 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25434 ascent
= min (max (0, (int)tem
), height
);
25436 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
25439 #endif /* HAVE_WINDOW_SYSTEM */
25442 if (width
> 0 && it
->line_wrap
!= TRUNCATE
25443 && it
->current_x
+ width
> it
->last_visible_x
)
25445 width
= it
->last_visible_x
- it
->current_x
;
25446 #ifdef HAVE_WINDOW_SYSTEM
25447 /* Subtract one more pixel from the stretch width, but only on
25448 GUI frames, since on a TTY each glyph is one "pixel" wide. */
25449 width
-= FRAME_WINDOW_P (it
->f
);
25453 if (width
> 0 && height
> 0 && it
->glyph_row
)
25455 Lisp_Object o_object
= it
->object
;
25456 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
25459 if (!STRINGP (object
))
25460 object
= it
->w
->contents
;
25461 #ifdef HAVE_WINDOW_SYSTEM
25462 if (FRAME_WINDOW_P (it
->f
))
25463 append_stretch_glyph (it
, object
, width
, height
, ascent
);
25467 it
->object
= object
;
25468 it
->char_to_display
= ' ';
25469 it
->pixel_width
= it
->len
= 1;
25471 tty_append_glyph (it
);
25472 it
->object
= o_object
;
25476 it
->pixel_width
= width
;
25477 #ifdef HAVE_WINDOW_SYSTEM
25478 if (FRAME_WINDOW_P (it
->f
))
25480 it
->ascent
= it
->phys_ascent
= ascent
;
25481 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
25482 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
25483 take_vertical_position_into_account (it
);
25487 it
->nglyphs
= width
;
25490 /* Get information about special display element WHAT in an
25491 environment described by IT. WHAT is one of IT_TRUNCATION or
25492 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
25493 non-null glyph_row member. This function ensures that fields like
25494 face_id, c, len of IT are left untouched. */
25497 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
25504 temp_it
.object
= make_number (0);
25505 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
25507 if (what
== IT_CONTINUATION
)
25509 /* Continuation glyph. For R2L lines, we mirror it by hand. */
25510 if (it
->bidi_it
.paragraph_dir
== R2L
)
25511 SET_GLYPH_FROM_CHAR (glyph
, '/');
25513 SET_GLYPH_FROM_CHAR (glyph
, '\\');
25515 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25517 /* FIXME: Should we mirror GC for R2L lines? */
25518 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25519 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25522 else if (what
== IT_TRUNCATION
)
25524 /* Truncation glyph. */
25525 SET_GLYPH_FROM_CHAR (glyph
, '$');
25527 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25529 /* FIXME: Should we mirror GC for R2L lines? */
25530 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25531 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25537 #ifdef HAVE_WINDOW_SYSTEM
25538 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
25539 is turned off, we precede the truncation/continuation glyphs by a
25540 stretch glyph whose width is computed such that these special
25541 glyphs are aligned at the window margin, even when very different
25542 fonts are used in different glyph rows. */
25543 if (FRAME_WINDOW_P (temp_it
.f
)
25544 /* init_iterator calls this with it->glyph_row == NULL, and it
25545 wants only the pixel width of the truncation/continuation
25547 && temp_it
.glyph_row
25548 /* insert_left_trunc_glyphs calls us at the beginning of the
25549 row, and it has its own calculation of the stretch glyph
25551 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
25552 && (temp_it
.glyph_row
->reversed_p
25553 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
25554 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
25556 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
25558 if (stretch_width
> 0)
25560 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
25561 struct font
*font
=
25562 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
25563 int stretch_ascent
=
25564 (((temp_it
.ascent
+ temp_it
.descent
)
25565 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
25567 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
25568 temp_it
.ascent
+ temp_it
.descent
,
25575 temp_it
.what
= IT_CHARACTER
;
25577 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
25578 temp_it
.face_id
= GLYPH_FACE (glyph
);
25579 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
25581 PRODUCE_GLYPHS (&temp_it
);
25582 it
->pixel_width
= temp_it
.pixel_width
;
25583 it
->nglyphs
= temp_it
.pixel_width
;
25586 #ifdef HAVE_WINDOW_SYSTEM
25588 /* Calculate line-height and line-spacing properties.
25589 An integer value specifies explicit pixel value.
25590 A float value specifies relative value to current face height.
25591 A cons (float . face-name) specifies relative value to
25592 height of specified face font.
25594 Returns height in pixels, or nil. */
25598 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
25599 int boff
, int override
)
25601 Lisp_Object face_name
= Qnil
;
25602 int ascent
, descent
, height
;
25604 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
25609 face_name
= XCAR (val
);
25611 if (!NUMBERP (val
))
25612 val
= make_number (1);
25613 if (NILP (face_name
))
25615 height
= it
->ascent
+ it
->descent
;
25620 if (NILP (face_name
))
25622 font
= FRAME_FONT (it
->f
);
25623 boff
= FRAME_BASELINE_OFFSET (it
->f
);
25625 else if (EQ (face_name
, Qt
))
25634 face_id
= lookup_named_face (it
->f
, face_name
, 0);
25636 return make_number (-1);
25638 face
= FACE_FROM_ID (it
->f
, face_id
);
25641 return make_number (-1);
25642 boff
= font
->baseline_offset
;
25643 if (font
->vertical_centering
)
25644 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25647 ascent
= FONT_BASE (font
) + boff
;
25648 descent
= FONT_DESCENT (font
) - boff
;
25652 it
->override_ascent
= ascent
;
25653 it
->override_descent
= descent
;
25654 it
->override_boff
= boff
;
25657 height
= ascent
+ descent
;
25661 height
= (int)(XFLOAT_DATA (val
) * height
);
25662 else if (INTEGERP (val
))
25663 height
*= XINT (val
);
25665 return make_number (height
);
25669 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
25670 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
25671 and only if this is for a character for which no font was found.
25673 If the display method (it->glyphless_method) is
25674 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
25675 length of the acronym or the hexadecimal string, UPPER_XOFF and
25676 UPPER_YOFF are pixel offsets for the upper part of the string,
25677 LOWER_XOFF and LOWER_YOFF are for the lower part.
25679 For the other display methods, LEN through LOWER_YOFF are zero. */
25682 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
25683 short upper_xoff
, short upper_yoff
,
25684 short lower_xoff
, short lower_yoff
)
25686 struct glyph
*glyph
;
25687 enum glyph_row_area area
= it
->area
;
25689 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25690 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25692 /* If the glyph row is reversed, we need to prepend the glyph
25693 rather than append it. */
25694 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25698 /* Make room for the additional glyph. */
25699 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25701 glyph
= it
->glyph_row
->glyphs
[area
];
25703 glyph
->charpos
= CHARPOS (it
->position
);
25704 glyph
->object
= it
->object
;
25705 glyph
->pixel_width
= it
->pixel_width
;
25706 glyph
->ascent
= it
->ascent
;
25707 glyph
->descent
= it
->descent
;
25708 glyph
->voffset
= it
->voffset
;
25709 glyph
->type
= GLYPHLESS_GLYPH
;
25710 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
25711 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
25712 glyph
->u
.glyphless
.len
= len
;
25713 glyph
->u
.glyphless
.ch
= it
->c
;
25714 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
25715 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
25716 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
25717 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
25718 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25719 glyph
->multibyte_p
= it
->multibyte_p
;
25720 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25722 /* In R2L rows, the left and the right box edges need to be
25723 drawn in reverse direction. */
25724 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25725 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25729 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25730 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25732 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25733 || it
->phys_descent
> it
->descent
);
25734 glyph
->padding_p
= 0;
25735 glyph
->glyph_not_available_p
= 0;
25736 glyph
->face_id
= face_id
;
25737 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25740 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25741 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25743 glyph
->bidi_type
= it
->bidi_it
.type
;
25745 ++it
->glyph_row
->used
[area
];
25748 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25752 /* Produce a glyph for a glyphless character for iterator IT.
25753 IT->glyphless_method specifies which method to use for displaying
25754 the character. See the description of enum
25755 glyphless_display_method in dispextern.h for the detail.
25757 FOR_NO_FONT is nonzero if and only if this is for a character for
25758 which no font was found. ACRONYM, if non-nil, is an acronym string
25759 for the character. */
25762 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
25767 int base_width
, base_height
, width
, height
;
25768 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
25771 /* Get the metrics of the base font. We always refer to the current
25773 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
25774 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25775 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
25776 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
25777 base_height
= it
->ascent
+ it
->descent
;
25778 base_width
= font
->average_width
;
25780 face_id
= merge_glyphless_glyph_face (it
);
25782 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
25784 it
->pixel_width
= THIN_SPACE_WIDTH
;
25786 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
25788 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
25790 width
= CHAR_WIDTH (it
->c
);
25793 else if (width
> 4)
25795 it
->pixel_width
= base_width
* width
;
25797 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
25803 unsigned int code
[6];
25805 int ascent
, descent
;
25806 struct font_metrics metrics_upper
, metrics_lower
;
25808 face
= FACE_FROM_ID (it
->f
, face_id
);
25809 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25810 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
25812 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
25814 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
25815 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
25816 if (CONSP (acronym
))
25817 acronym
= XCAR (acronym
);
25818 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
25822 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
25823 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
25826 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
25827 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
25828 upper_len
= (len
+ 1) / 2;
25829 font
->driver
->text_extents (font
, code
, upper_len
,
25831 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
25836 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
25837 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
25838 upper_xoff
= upper_yoff
= 2; /* the typical case */
25839 if (base_width
>= width
)
25841 /* Align the upper to the left, the lower to the right. */
25842 it
->pixel_width
= base_width
;
25843 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
25847 /* Center the shorter one. */
25848 it
->pixel_width
= width
;
25849 if (metrics_upper
.width
>= metrics_lower
.width
)
25850 lower_xoff
= (width
- metrics_lower
.width
) / 2;
25853 /* FIXME: This code doesn't look right. It formerly was
25854 missing the "lower_xoff = 0;", which couldn't have
25855 been right since it left lower_xoff uninitialized. */
25857 upper_xoff
= (width
- metrics_upper
.width
) / 2;
25861 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
25862 top, bottom, and between upper and lower strings. */
25863 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
25864 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
25865 /* Center vertically.
25866 H:base_height, D:base_descent
25867 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
25869 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
25870 descent = D - H/2 + h/2;
25871 lower_yoff = descent - 2 - ld;
25872 upper_yoff = lower_yoff - la - 1 - ud; */
25873 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
25874 descent
= it
->descent
- (base_height
- height
) / 2;
25875 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
25876 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
25877 - metrics_upper
.descent
);
25878 /* Don't make the height shorter than the base height. */
25879 if (height
> base_height
)
25881 it
->ascent
= ascent
;
25882 it
->descent
= descent
;
25886 it
->phys_ascent
= it
->ascent
;
25887 it
->phys_descent
= it
->descent
;
25889 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
25890 upper_xoff
, upper_yoff
,
25891 lower_xoff
, lower_yoff
);
25893 take_vertical_position_into_account (it
);
25898 Produce glyphs/get display metrics for the display element IT is
25899 loaded with. See the description of struct it in dispextern.h
25900 for an overview of struct it. */
25903 x_produce_glyphs (struct it
*it
)
25905 int extra_line_spacing
= it
->extra_line_spacing
;
25907 it
->glyph_not_available_p
= 0;
25909 if (it
->what
== IT_CHARACTER
)
25912 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25913 struct font
*font
= face
->font
;
25914 struct font_metrics
*pcm
= NULL
;
25915 int boff
; /* Baseline offset. */
25919 /* When no suitable font is found, display this character by
25920 the method specified in the first extra slot of
25921 Vglyphless_char_display. */
25922 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
25924 eassert (it
->what
== IT_GLYPHLESS
);
25925 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
25929 boff
= font
->baseline_offset
;
25930 if (font
->vertical_centering
)
25931 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25933 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
25939 if (it
->override_ascent
>= 0)
25941 it
->ascent
= it
->override_ascent
;
25942 it
->descent
= it
->override_descent
;
25943 boff
= it
->override_boff
;
25947 it
->ascent
= FONT_BASE (font
) + boff
;
25948 it
->descent
= FONT_DESCENT (font
) - boff
;
25951 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
25953 pcm
= get_per_char_metric (font
, &char2b
);
25954 if (pcm
->width
== 0
25955 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
25961 it
->phys_ascent
= pcm
->ascent
+ boff
;
25962 it
->phys_descent
= pcm
->descent
- boff
;
25963 it
->pixel_width
= pcm
->width
;
25967 it
->glyph_not_available_p
= 1;
25968 it
->phys_ascent
= it
->ascent
;
25969 it
->phys_descent
= it
->descent
;
25970 it
->pixel_width
= font
->space_width
;
25973 if (it
->constrain_row_ascent_descent_p
)
25975 if (it
->descent
> it
->max_descent
)
25977 it
->ascent
+= it
->descent
- it
->max_descent
;
25978 it
->descent
= it
->max_descent
;
25980 if (it
->ascent
> it
->max_ascent
)
25982 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
25983 it
->ascent
= it
->max_ascent
;
25985 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
25986 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
25987 extra_line_spacing
= 0;
25990 /* If this is a space inside a region of text with
25991 `space-width' property, change its width. */
25992 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
25994 it
->pixel_width
*= XFLOATINT (it
->space_width
);
25996 /* If face has a box, add the box thickness to the character
25997 height. If character has a box line to the left and/or
25998 right, add the box line width to the character's width. */
25999 if (face
->box
!= FACE_NO_BOX
)
26001 int thick
= face
->box_line_width
;
26005 it
->ascent
+= thick
;
26006 it
->descent
+= thick
;
26011 if (it
->start_of_box_run_p
)
26012 it
->pixel_width
+= thick
;
26013 if (it
->end_of_box_run_p
)
26014 it
->pixel_width
+= thick
;
26017 /* If face has an overline, add the height of the overline
26018 (1 pixel) and a 1 pixel margin to the character height. */
26019 if (face
->overline_p
)
26020 it
->ascent
+= overline_margin
;
26022 if (it
->constrain_row_ascent_descent_p
)
26024 if (it
->ascent
> it
->max_ascent
)
26025 it
->ascent
= it
->max_ascent
;
26026 if (it
->descent
> it
->max_descent
)
26027 it
->descent
= it
->max_descent
;
26030 take_vertical_position_into_account (it
);
26032 /* If we have to actually produce glyphs, do it. */
26037 /* Translate a space with a `space-width' property
26038 into a stretch glyph. */
26039 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26040 / FONT_HEIGHT (font
));
26041 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26042 it
->ascent
+ it
->descent
, ascent
);
26047 /* If characters with lbearing or rbearing are displayed
26048 in this line, record that fact in a flag of the
26049 glyph row. This is used to optimize X output code. */
26050 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26051 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26053 if (! stretched_p
&& it
->pixel_width
== 0)
26054 /* We assure that all visible glyphs have at least 1-pixel
26056 it
->pixel_width
= 1;
26058 else if (it
->char_to_display
== '\n')
26060 /* A newline has no width, but we need the height of the
26061 line. But if previous part of the line sets a height,
26062 don't increase that height. */
26064 Lisp_Object height
;
26065 Lisp_Object total_height
= Qnil
;
26067 it
->override_ascent
= -1;
26068 it
->pixel_width
= 0;
26071 height
= get_it_property (it
, Qline_height
);
26072 /* Split (line-height total-height) list. */
26074 && CONSP (XCDR (height
))
26075 && NILP (XCDR (XCDR (height
))))
26077 total_height
= XCAR (XCDR (height
));
26078 height
= XCAR (height
);
26080 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
26082 if (it
->override_ascent
>= 0)
26084 it
->ascent
= it
->override_ascent
;
26085 it
->descent
= it
->override_descent
;
26086 boff
= it
->override_boff
;
26090 it
->ascent
= FONT_BASE (font
) + boff
;
26091 it
->descent
= FONT_DESCENT (font
) - boff
;
26094 if (EQ (height
, Qt
))
26096 if (it
->descent
> it
->max_descent
)
26098 it
->ascent
+= it
->descent
- it
->max_descent
;
26099 it
->descent
= it
->max_descent
;
26101 if (it
->ascent
> it
->max_ascent
)
26103 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26104 it
->ascent
= it
->max_ascent
;
26106 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26107 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26108 it
->constrain_row_ascent_descent_p
= 1;
26109 extra_line_spacing
= 0;
26113 Lisp_Object spacing
;
26115 it
->phys_ascent
= it
->ascent
;
26116 it
->phys_descent
= it
->descent
;
26118 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26119 && face
->box
!= FACE_NO_BOX
26120 && face
->box_line_width
> 0)
26122 it
->ascent
+= face
->box_line_width
;
26123 it
->descent
+= face
->box_line_width
;
26126 && XINT (height
) > it
->ascent
+ it
->descent
)
26127 it
->ascent
= XINT (height
) - it
->descent
;
26129 if (!NILP (total_height
))
26130 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
26133 spacing
= get_it_property (it
, Qline_spacing
);
26134 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
26136 if (INTEGERP (spacing
))
26138 extra_line_spacing
= XINT (spacing
);
26139 if (!NILP (total_height
))
26140 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26144 else /* i.e. (it->char_to_display == '\t') */
26146 if (font
->space_width
> 0)
26148 int tab_width
= it
->tab_width
* font
->space_width
;
26149 int x
= it
->current_x
+ it
->continuation_lines_width
;
26150 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26152 /* If the distance from the current position to the next tab
26153 stop is less than a space character width, use the
26154 tab stop after that. */
26155 if (next_tab_x
- x
< font
->space_width
)
26156 next_tab_x
+= tab_width
;
26158 it
->pixel_width
= next_tab_x
- x
;
26160 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
26161 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
26165 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26166 it
->ascent
+ it
->descent
, it
->ascent
);
26171 it
->pixel_width
= 0;
26176 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26178 /* A static composition.
26180 Note: A composition is represented as one glyph in the
26181 glyph matrix. There are no padding glyphs.
26183 Important note: pixel_width, ascent, and descent are the
26184 values of what is drawn by draw_glyphs (i.e. the values of
26185 the overall glyphs composed). */
26186 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26187 int boff
; /* baseline offset */
26188 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26189 int glyph_len
= cmp
->glyph_len
;
26190 struct font
*font
= face
->font
;
26194 /* If we have not yet calculated pixel size data of glyphs of
26195 the composition for the current face font, calculate them
26196 now. Theoretically, we have to check all fonts for the
26197 glyphs, but that requires much time and memory space. So,
26198 here we check only the font of the first glyph. This may
26199 lead to incorrect display, but it's very rare, and C-l
26200 (recenter-top-bottom) can correct the display anyway. */
26201 if (! cmp
->font
|| cmp
->font
!= font
)
26203 /* Ascent and descent of the font of the first character
26204 of this composition (adjusted by baseline offset).
26205 Ascent and descent of overall glyphs should not be less
26206 than these, respectively. */
26207 int font_ascent
, font_descent
, font_height
;
26208 /* Bounding box of the overall glyphs. */
26209 int leftmost
, rightmost
, lowest
, highest
;
26210 int lbearing
, rbearing
;
26211 int i
, width
, ascent
, descent
;
26212 int left_padded
= 0, right_padded
= 0;
26213 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26215 struct font_metrics
*pcm
;
26216 int font_not_found_p
;
26219 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26220 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26222 if (glyph_len
< cmp
->glyph_len
)
26224 for (i
= 0; i
< glyph_len
; i
++)
26226 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26228 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26233 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26234 : IT_CHARPOS (*it
));
26235 /* If no suitable font is found, use the default font. */
26236 font_not_found_p
= font
== NULL
;
26237 if (font_not_found_p
)
26239 face
= face
->ascii_face
;
26242 boff
= font
->baseline_offset
;
26243 if (font
->vertical_centering
)
26244 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26245 font_ascent
= FONT_BASE (font
) + boff
;
26246 font_descent
= FONT_DESCENT (font
) - boff
;
26247 font_height
= FONT_HEIGHT (font
);
26252 if (! font_not_found_p
)
26254 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26256 pcm
= get_per_char_metric (font
, &char2b
);
26259 /* Initialize the bounding box. */
26262 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26263 ascent
= pcm
->ascent
;
26264 descent
= pcm
->descent
;
26265 lbearing
= pcm
->lbearing
;
26266 rbearing
= pcm
->rbearing
;
26270 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26271 ascent
= FONT_BASE (font
);
26272 descent
= FONT_DESCENT (font
);
26279 lowest
= - descent
+ boff
;
26280 highest
= ascent
+ boff
;
26282 if (! font_not_found_p
26283 && font
->default_ascent
26284 && CHAR_TABLE_P (Vuse_default_ascent
)
26285 && !NILP (Faref (Vuse_default_ascent
,
26286 make_number (it
->char_to_display
))))
26287 highest
= font
->default_ascent
+ boff
;
26289 /* Draw the first glyph at the normal position. It may be
26290 shifted to right later if some other glyphs are drawn
26292 cmp
->offsets
[i
* 2] = 0;
26293 cmp
->offsets
[i
* 2 + 1] = boff
;
26294 cmp
->lbearing
= lbearing
;
26295 cmp
->rbearing
= rbearing
;
26297 /* Set cmp->offsets for the remaining glyphs. */
26298 for (i
++; i
< glyph_len
; i
++)
26300 int left
, right
, btm
, top
;
26301 int ch
= COMPOSITION_GLYPH (cmp
, i
);
26303 struct face
*this_face
;
26307 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
26308 this_face
= FACE_FROM_ID (it
->f
, face_id
);
26309 font
= this_face
->font
;
26315 get_char_face_and_encoding (it
->f
, ch
, face_id
,
26317 pcm
= get_per_char_metric (font
, &char2b
);
26320 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26323 width
= pcm
->width
;
26324 ascent
= pcm
->ascent
;
26325 descent
= pcm
->descent
;
26326 lbearing
= pcm
->lbearing
;
26327 rbearing
= pcm
->rbearing
;
26328 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
26330 /* Relative composition with or without
26331 alternate chars. */
26332 left
= (leftmost
+ rightmost
- width
) / 2;
26333 btm
= - descent
+ boff
;
26334 if (font
->relative_compose
26335 && (! CHAR_TABLE_P (Vignore_relative_composition
)
26336 || NILP (Faref (Vignore_relative_composition
,
26337 make_number (ch
)))))
26340 if (- descent
>= font
->relative_compose
)
26341 /* One extra pixel between two glyphs. */
26343 else if (ascent
<= 0)
26344 /* One extra pixel between two glyphs. */
26345 btm
= lowest
- 1 - ascent
- descent
;
26350 /* A composition rule is specified by an integer
26351 value that encodes global and new reference
26352 points (GREF and NREF). GREF and NREF are
26353 specified by numbers as below:
26355 0---1---2 -- ascent
26359 9--10--11 -- center
26361 ---3---4---5--- baseline
26363 6---7---8 -- descent
26365 int rule
= COMPOSITION_RULE (cmp
, i
);
26366 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
26368 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
26369 grefx
= gref
% 3, nrefx
= nref
% 3;
26370 grefy
= gref
/ 3, nrefy
= nref
/ 3;
26372 xoff
= font_height
* (xoff
- 128) / 256;
26374 yoff
= font_height
* (yoff
- 128) / 256;
26377 + grefx
* (rightmost
- leftmost
) / 2
26378 - nrefx
* width
/ 2
26381 btm
= ((grefy
== 0 ? highest
26383 : grefy
== 2 ? lowest
26384 : (highest
+ lowest
) / 2)
26385 - (nrefy
== 0 ? ascent
+ descent
26386 : nrefy
== 1 ? descent
- boff
26388 : (ascent
+ descent
) / 2)
26392 cmp
->offsets
[i
* 2] = left
;
26393 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
26395 /* Update the bounding box of the overall glyphs. */
26398 right
= left
+ width
;
26399 if (left
< leftmost
)
26401 if (right
> rightmost
)
26404 top
= btm
+ descent
+ ascent
;
26410 if (cmp
->lbearing
> left
+ lbearing
)
26411 cmp
->lbearing
= left
+ lbearing
;
26412 if (cmp
->rbearing
< left
+ rbearing
)
26413 cmp
->rbearing
= left
+ rbearing
;
26417 /* If there are glyphs whose x-offsets are negative,
26418 shift all glyphs to the right and make all x-offsets
26422 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26423 cmp
->offsets
[i
* 2] -= leftmost
;
26424 rightmost
-= leftmost
;
26425 cmp
->lbearing
-= leftmost
;
26426 cmp
->rbearing
-= leftmost
;
26429 if (left_padded
&& cmp
->lbearing
< 0)
26431 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26432 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
26433 rightmost
-= cmp
->lbearing
;
26434 cmp
->rbearing
-= cmp
->lbearing
;
26437 if (right_padded
&& rightmost
< cmp
->rbearing
)
26439 rightmost
= cmp
->rbearing
;
26442 cmp
->pixel_width
= rightmost
;
26443 cmp
->ascent
= highest
;
26444 cmp
->descent
= - lowest
;
26445 if (cmp
->ascent
< font_ascent
)
26446 cmp
->ascent
= font_ascent
;
26447 if (cmp
->descent
< font_descent
)
26448 cmp
->descent
= font_descent
;
26452 && (cmp
->lbearing
< 0
26453 || cmp
->rbearing
> cmp
->pixel_width
))
26454 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26456 it
->pixel_width
= cmp
->pixel_width
;
26457 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
26458 it
->descent
= it
->phys_descent
= cmp
->descent
;
26459 if (face
->box
!= FACE_NO_BOX
)
26461 int thick
= face
->box_line_width
;
26465 it
->ascent
+= thick
;
26466 it
->descent
+= thick
;
26471 if (it
->start_of_box_run_p
)
26472 it
->pixel_width
+= thick
;
26473 if (it
->end_of_box_run_p
)
26474 it
->pixel_width
+= thick
;
26477 /* If face has an overline, add the height of the overline
26478 (1 pixel) and a 1 pixel margin to the character height. */
26479 if (face
->overline_p
)
26480 it
->ascent
+= overline_margin
;
26482 take_vertical_position_into_account (it
);
26483 if (it
->ascent
< 0)
26485 if (it
->descent
< 0)
26488 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
26489 append_composite_glyph (it
);
26491 else if (it
->what
== IT_COMPOSITION
)
26493 /* A dynamic (automatic) composition. */
26494 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26495 Lisp_Object gstring
;
26496 struct font_metrics metrics
;
26500 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
26502 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
26505 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
26506 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26507 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
26508 it
->descent
= it
->phys_descent
= metrics
.descent
;
26509 if (face
->box
!= FACE_NO_BOX
)
26511 int thick
= face
->box_line_width
;
26515 it
->ascent
+= thick
;
26516 it
->descent
+= thick
;
26521 if (it
->start_of_box_run_p
)
26522 it
->pixel_width
+= thick
;
26523 if (it
->end_of_box_run_p
)
26524 it
->pixel_width
+= thick
;
26526 /* If face has an overline, add the height of the overline
26527 (1 pixel) and a 1 pixel margin to the character height. */
26528 if (face
->overline_p
)
26529 it
->ascent
+= overline_margin
;
26530 take_vertical_position_into_account (it
);
26531 if (it
->ascent
< 0)
26533 if (it
->descent
< 0)
26537 append_composite_glyph (it
);
26539 else if (it
->what
== IT_GLYPHLESS
)
26540 produce_glyphless_glyph (it
, 0, Qnil
);
26541 else if (it
->what
== IT_IMAGE
)
26542 produce_image_glyph (it
);
26543 else if (it
->what
== IT_STRETCH
)
26544 produce_stretch_glyph (it
);
26547 /* Accumulate dimensions. Note: can't assume that it->descent > 0
26548 because this isn't true for images with `:ascent 100'. */
26549 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
26550 if (it
->area
== TEXT_AREA
)
26551 it
->current_x
+= it
->pixel_width
;
26553 if (extra_line_spacing
> 0)
26555 it
->descent
+= extra_line_spacing
;
26556 if (extra_line_spacing
> it
->max_extra_line_spacing
)
26557 it
->max_extra_line_spacing
= extra_line_spacing
;
26560 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
26561 it
->max_descent
= max (it
->max_descent
, it
->descent
);
26562 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
26563 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
26567 Output LEN glyphs starting at START at the nominal cursor position.
26568 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
26569 being updated, and UPDATED_AREA is the area of that row being updated. */
26572 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26573 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26575 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
26577 eassert (updated_row
);
26578 /* When the window is hscrolled, cursor hpos can legitimately be out
26579 of bounds, but we draw the cursor at the corresponding window
26580 margin in that case. */
26581 if (!updated_row
->reversed_p
&& chpos
< 0)
26583 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
26584 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
26588 /* Write glyphs. */
26590 hpos
= start
- updated_row
->glyphs
[updated_area
];
26591 x
= draw_glyphs (w
, w
->output_cursor
.x
,
26592 updated_row
, updated_area
,
26594 DRAW_NORMAL_TEXT
, 0);
26596 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
26597 if (updated_area
== TEXT_AREA
26598 && w
->phys_cursor_on_p
26599 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
26601 && chpos
< hpos
+ len
)
26602 w
->phys_cursor_on_p
= 0;
26606 /* Advance the output cursor. */
26607 w
->output_cursor
.hpos
+= len
;
26608 w
->output_cursor
.x
= x
;
26613 Insert LEN glyphs from START at the nominal cursor position. */
26616 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26617 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26620 int line_height
, shift_by_width
, shifted_region_width
;
26621 struct glyph_row
*row
;
26622 struct glyph
*glyph
;
26623 int frame_x
, frame_y
;
26626 eassert (updated_row
);
26628 f
= XFRAME (WINDOW_FRAME (w
));
26630 /* Get the height of the line we are in. */
26632 line_height
= row
->height
;
26634 /* Get the width of the glyphs to insert. */
26635 shift_by_width
= 0;
26636 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
26637 shift_by_width
+= glyph
->pixel_width
;
26639 /* Get the width of the region to shift right. */
26640 shifted_region_width
= (window_box_width (w
, updated_area
)
26641 - w
->output_cursor
.x
26645 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
26646 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
26648 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
26649 line_height
, shift_by_width
);
26651 /* Write the glyphs. */
26652 hpos
= start
- row
->glyphs
[updated_area
];
26653 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
26655 DRAW_NORMAL_TEXT
, 0);
26657 /* Advance the output cursor. */
26658 w
->output_cursor
.hpos
+= len
;
26659 w
->output_cursor
.x
+= shift_by_width
;
26665 Erase the current text line from the nominal cursor position
26666 (inclusive) to pixel column TO_X (exclusive). The idea is that
26667 everything from TO_X onward is already erased.
26669 TO_X is a pixel position relative to UPDATED_AREA of currently
26670 updated window W. TO_X == -1 means clear to the end of this area. */
26673 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
26674 enum glyph_row_area updated_area
, int to_x
)
26677 int max_x
, min_y
, max_y
;
26678 int from_x
, from_y
, to_y
;
26680 eassert (updated_row
);
26681 f
= XFRAME (w
->frame
);
26683 if (updated_row
->full_width_p
)
26684 max_x
= (WINDOW_PIXEL_WIDTH (w
)
26685 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
26687 max_x
= window_box_width (w
, updated_area
);
26688 max_y
= window_text_bottom_y (w
);
26690 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
26691 of window. For TO_X > 0, truncate to end of drawing area. */
26697 to_x
= min (to_x
, max_x
);
26699 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
26701 /* Notice if the cursor will be cleared by this operation. */
26702 if (!updated_row
->full_width_p
)
26703 notice_overwritten_cursor (w
, updated_area
,
26704 w
->output_cursor
.x
, -1,
26706 MATRIX_ROW_BOTTOM_Y (updated_row
));
26708 from_x
= w
->output_cursor
.x
;
26710 /* Translate to frame coordinates. */
26711 if (updated_row
->full_width_p
)
26713 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
26714 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
26718 int area_left
= window_box_left (w
, updated_area
);
26719 from_x
+= area_left
;
26723 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
26724 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
26725 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
26727 /* Prevent inadvertently clearing to end of the X window. */
26728 if (to_x
> from_x
&& to_y
> from_y
)
26731 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
26732 to_x
- from_x
, to_y
- from_y
);
26737 #endif /* HAVE_WINDOW_SYSTEM */
26741 /***********************************************************************
26743 ***********************************************************************/
26745 /* Value is the internal representation of the specified cursor type
26746 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
26747 of the bar cursor. */
26749 static enum text_cursor_kinds
26750 get_specified_cursor_type (Lisp_Object arg
, int *width
)
26752 enum text_cursor_kinds type
;
26757 if (EQ (arg
, Qbox
))
26758 return FILLED_BOX_CURSOR
;
26760 if (EQ (arg
, Qhollow
))
26761 return HOLLOW_BOX_CURSOR
;
26763 if (EQ (arg
, Qbar
))
26770 && EQ (XCAR (arg
), Qbar
)
26771 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
26773 *width
= XINT (XCDR (arg
));
26777 if (EQ (arg
, Qhbar
))
26780 return HBAR_CURSOR
;
26784 && EQ (XCAR (arg
), Qhbar
)
26785 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
26787 *width
= XINT (XCDR (arg
));
26788 return HBAR_CURSOR
;
26791 /* Treat anything unknown as "hollow box cursor".
26792 It was bad to signal an error; people have trouble fixing
26793 .Xdefaults with Emacs, when it has something bad in it. */
26794 type
= HOLLOW_BOX_CURSOR
;
26799 /* Set the default cursor types for specified frame. */
26801 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
26806 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
26807 FRAME_CURSOR_WIDTH (f
) = width
;
26809 /* By default, set up the blink-off state depending on the on-state. */
26811 tem
= Fassoc (arg
, Vblink_cursor_alist
);
26814 FRAME_BLINK_OFF_CURSOR (f
)
26815 = get_specified_cursor_type (XCDR (tem
), &width
);
26816 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
26819 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
26821 /* Make sure the cursor gets redrawn. */
26822 f
->cursor_type_changed
= 1;
26826 #ifdef HAVE_WINDOW_SYSTEM
26828 /* Return the cursor we want to be displayed in window W. Return
26829 width of bar/hbar cursor through WIDTH arg. Return with
26830 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
26831 (i.e. if the `system caret' should track this cursor).
26833 In a mini-buffer window, we want the cursor only to appear if we
26834 are reading input from this window. For the selected window, we
26835 want the cursor type given by the frame parameter or buffer local
26836 setting of cursor-type. If explicitly marked off, draw no cursor.
26837 In all other cases, we want a hollow box cursor. */
26839 static enum text_cursor_kinds
26840 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
26841 int *active_cursor
)
26843 struct frame
*f
= XFRAME (w
->frame
);
26844 struct buffer
*b
= XBUFFER (w
->contents
);
26845 int cursor_type
= DEFAULT_CURSOR
;
26846 Lisp_Object alt_cursor
;
26847 int non_selected
= 0;
26849 *active_cursor
= 1;
26852 if (cursor_in_echo_area
26853 && FRAME_HAS_MINIBUF_P (f
)
26854 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
26856 if (w
== XWINDOW (echo_area_window
))
26858 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
26860 *width
= FRAME_CURSOR_WIDTH (f
);
26861 return FRAME_DESIRED_CURSOR (f
);
26864 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
26867 *active_cursor
= 0;
26871 /* Detect a nonselected window or nonselected frame. */
26872 else if (w
!= XWINDOW (f
->selected_window
)
26873 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
26875 *active_cursor
= 0;
26877 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
26883 /* Never display a cursor in a window in which cursor-type is nil. */
26884 if (NILP (BVAR (b
, cursor_type
)))
26887 /* Get the normal cursor type for this window. */
26888 if (EQ (BVAR (b
, cursor_type
), Qt
))
26890 cursor_type
= FRAME_DESIRED_CURSOR (f
);
26891 *width
= FRAME_CURSOR_WIDTH (f
);
26894 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
26896 /* Use cursor-in-non-selected-windows instead
26897 for non-selected window or frame. */
26900 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
26901 if (!EQ (Qt
, alt_cursor
))
26902 return get_specified_cursor_type (alt_cursor
, width
);
26903 /* t means modify the normal cursor type. */
26904 if (cursor_type
== FILLED_BOX_CURSOR
)
26905 cursor_type
= HOLLOW_BOX_CURSOR
;
26906 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
26908 return cursor_type
;
26911 /* Use normal cursor if not blinked off. */
26912 if (!w
->cursor_off_p
)
26914 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26916 if (cursor_type
== FILLED_BOX_CURSOR
)
26918 /* Using a block cursor on large images can be very annoying.
26919 So use a hollow cursor for "large" images.
26920 If image is not transparent (no mask), also use hollow cursor. */
26921 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26922 if (img
!= NULL
&& IMAGEP (img
->spec
))
26924 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
26925 where N = size of default frame font size.
26926 This should cover most of the "tiny" icons people may use. */
26928 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
26929 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
26930 cursor_type
= HOLLOW_BOX_CURSOR
;
26933 else if (cursor_type
!= NO_CURSOR
)
26935 /* Display current only supports BOX and HOLLOW cursors for images.
26936 So for now, unconditionally use a HOLLOW cursor when cursor is
26937 not a solid box cursor. */
26938 cursor_type
= HOLLOW_BOX_CURSOR
;
26941 return cursor_type
;
26944 /* Cursor is blinked off, so determine how to "toggle" it. */
26946 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
26947 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
26948 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
26950 /* Then see if frame has specified a specific blink off cursor type. */
26951 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
26953 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
26954 return FRAME_BLINK_OFF_CURSOR (f
);
26958 /* Some people liked having a permanently visible blinking cursor,
26959 while others had very strong opinions against it. So it was
26960 decided to remove it. KFS 2003-09-03 */
26962 /* Finally perform built-in cursor blinking:
26963 filled box <-> hollow box
26964 wide [h]bar <-> narrow [h]bar
26965 narrow [h]bar <-> no cursor
26966 other type <-> no cursor */
26968 if (cursor_type
== FILLED_BOX_CURSOR
)
26969 return HOLLOW_BOX_CURSOR
;
26971 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
26974 return cursor_type
;
26982 /* Notice when the text cursor of window W has been completely
26983 overwritten by a drawing operation that outputs glyphs in AREA
26984 starting at X0 and ending at X1 in the line starting at Y0 and
26985 ending at Y1. X coordinates are area-relative. X1 < 0 means all
26986 the rest of the line after X0 has been written. Y coordinates
26987 are window-relative. */
26990 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
26991 int x0
, int x1
, int y0
, int y1
)
26993 int cx0
, cx1
, cy0
, cy1
;
26994 struct glyph_row
*row
;
26996 if (!w
->phys_cursor_on_p
)
26998 if (area
!= TEXT_AREA
)
27001 if (w
->phys_cursor
.vpos
< 0
27002 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27003 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27004 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27007 if (row
->cursor_in_fringe_p
)
27009 row
->cursor_in_fringe_p
= 0;
27010 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27011 w
->phys_cursor_on_p
= 0;
27015 cx0
= w
->phys_cursor
.x
;
27016 cx1
= cx0
+ w
->phys_cursor_width
;
27017 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27020 /* The cursor image will be completely removed from the
27021 screen if the output area intersects the cursor area in
27022 y-direction. When we draw in [y0 y1[, and some part of
27023 the cursor is at y < y0, that part must have been drawn
27024 before. When scrolling, the cursor is erased before
27025 actually scrolling, so we don't come here. When not
27026 scrolling, the rows above the old cursor row must have
27027 changed, and in this case these rows must have written
27028 over the cursor image.
27030 Likewise if part of the cursor is below y1, with the
27031 exception of the cursor being in the first blank row at
27032 the buffer and window end because update_text_area
27033 doesn't draw that row. (Except when it does, but
27034 that's handled in update_text_area.) */
27036 cy0
= w
->phys_cursor
.y
;
27037 cy1
= cy0
+ w
->phys_cursor_height
;
27038 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27041 w
->phys_cursor_on_p
= 0;
27044 #endif /* HAVE_WINDOW_SYSTEM */
27047 /************************************************************************
27049 ************************************************************************/
27051 #ifdef HAVE_WINDOW_SYSTEM
27054 Fix the display of area AREA of overlapping row ROW in window W
27055 with respect to the overlapping part OVERLAPS. */
27058 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27059 enum glyph_row_area area
, int overlaps
)
27066 for (i
= 0; i
< row
->used
[area
];)
27068 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27070 int start
= i
, start_x
= x
;
27074 x
+= row
->glyphs
[area
][i
].pixel_width
;
27077 while (i
< row
->used
[area
]
27078 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27080 draw_glyphs (w
, start_x
, row
, area
,
27082 DRAW_NORMAL_TEXT
, overlaps
);
27086 x
+= row
->glyphs
[area
][i
].pixel_width
;
27096 Draw the cursor glyph of window W in glyph row ROW. See the
27097 comment of draw_glyphs for the meaning of HL. */
27100 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27101 enum draw_glyphs_face hl
)
27103 /* If cursor hpos is out of bounds, don't draw garbage. This can
27104 happen in mini-buffer windows when switching between echo area
27105 glyphs and mini-buffer. */
27106 if ((row
->reversed_p
27107 ? (w
->phys_cursor
.hpos
>= 0)
27108 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27110 int on_p
= w
->phys_cursor_on_p
;
27112 int hpos
= w
->phys_cursor
.hpos
;
27114 /* When the window is hscrolled, cursor hpos can legitimately be
27115 out of bounds, but we draw the cursor at the corresponding
27116 window margin in that case. */
27117 if (!row
->reversed_p
&& hpos
< 0)
27119 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27120 hpos
= row
->used
[TEXT_AREA
] - 1;
27122 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27124 w
->phys_cursor_on_p
= on_p
;
27126 if (hl
== DRAW_CURSOR
)
27127 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27128 /* When we erase the cursor, and ROW is overlapped by other
27129 rows, make sure that these overlapping parts of other rows
27131 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27133 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27135 if (row
> w
->current_matrix
->rows
27136 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27137 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27138 OVERLAPS_ERASED_CURSOR
);
27140 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27141 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27142 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27143 OVERLAPS_ERASED_CURSOR
);
27149 /* Erase the image of a cursor of window W from the screen. */
27155 erase_phys_cursor (struct window
*w
)
27157 struct frame
*f
= XFRAME (w
->frame
);
27158 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27159 int hpos
= w
->phys_cursor
.hpos
;
27160 int vpos
= w
->phys_cursor
.vpos
;
27161 int mouse_face_here_p
= 0;
27162 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27163 struct glyph_row
*cursor_row
;
27164 struct glyph
*cursor_glyph
;
27165 enum draw_glyphs_face hl
;
27167 /* No cursor displayed or row invalidated => nothing to do on the
27169 if (w
->phys_cursor_type
== NO_CURSOR
)
27170 goto mark_cursor_off
;
27172 /* VPOS >= active_glyphs->nrows means that window has been resized.
27173 Don't bother to erase the cursor. */
27174 if (vpos
>= active_glyphs
->nrows
)
27175 goto mark_cursor_off
;
27177 /* If row containing cursor is marked invalid, there is nothing we
27179 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27180 if (!cursor_row
->enabled_p
)
27181 goto mark_cursor_off
;
27183 /* If line spacing is > 0, old cursor may only be partially visible in
27184 window after split-window. So adjust visible height. */
27185 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27186 window_text_bottom_y (w
) - cursor_row
->y
);
27188 /* If row is completely invisible, don't attempt to delete a cursor which
27189 isn't there. This can happen if cursor is at top of a window, and
27190 we switch to a buffer with a header line in that window. */
27191 if (cursor_row
->visible_height
<= 0)
27192 goto mark_cursor_off
;
27194 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27195 if (cursor_row
->cursor_in_fringe_p
)
27197 cursor_row
->cursor_in_fringe_p
= 0;
27198 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27199 goto mark_cursor_off
;
27202 /* This can happen when the new row is shorter than the old one.
27203 In this case, either draw_glyphs or clear_end_of_line
27204 should have cleared the cursor. Note that we wouldn't be
27205 able to erase the cursor in this case because we don't have a
27206 cursor glyph at hand. */
27207 if ((cursor_row
->reversed_p
27208 ? (w
->phys_cursor
.hpos
< 0)
27209 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27210 goto mark_cursor_off
;
27212 /* When the window is hscrolled, cursor hpos can legitimately be out
27213 of bounds, but we draw the cursor at the corresponding window
27214 margin in that case. */
27215 if (!cursor_row
->reversed_p
&& hpos
< 0)
27217 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27218 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27220 /* If the cursor is in the mouse face area, redisplay that when
27221 we clear the cursor. */
27222 if (! NILP (hlinfo
->mouse_face_window
)
27223 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27224 /* Don't redraw the cursor's spot in mouse face if it is at the
27225 end of a line (on a newline). The cursor appears there, but
27226 mouse highlighting does not. */
27227 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27228 mouse_face_here_p
= 1;
27230 /* Maybe clear the display under the cursor. */
27231 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27234 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27237 cursor_glyph
= get_phys_cursor_glyph (w
);
27238 if (cursor_glyph
== NULL
)
27239 goto mark_cursor_off
;
27241 width
= cursor_glyph
->pixel_width
;
27242 left_x
= window_box_left_offset (w
, TEXT_AREA
);
27243 x
= w
->phys_cursor
.x
;
27245 width
-= left_x
- x
;
27246 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27247 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27248 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
27251 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27254 /* Erase the cursor by redrawing the character underneath it. */
27255 if (mouse_face_here_p
)
27256 hl
= DRAW_MOUSE_FACE
;
27258 hl
= DRAW_NORMAL_TEXT
;
27259 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27262 w
->phys_cursor_on_p
= 0;
27263 w
->phys_cursor_type
= NO_CURSOR
;
27268 Display or clear cursor of window W. If ON is zero, clear the
27269 cursor. If it is non-zero, display the cursor. If ON is nonzero,
27270 where to put the cursor is specified by HPOS, VPOS, X and Y. */
27273 display_and_set_cursor (struct window
*w
, bool on
,
27274 int hpos
, int vpos
, int x
, int y
)
27276 struct frame
*f
= XFRAME (w
->frame
);
27277 int new_cursor_type
;
27278 int new_cursor_width
;
27280 struct glyph_row
*glyph_row
;
27281 struct glyph
*glyph
;
27283 /* This is pointless on invisible frames, and dangerous on garbaged
27284 windows and frames; in the latter case, the frame or window may
27285 be in the midst of changing its size, and x and y may be off the
27287 if (! FRAME_VISIBLE_P (f
)
27288 || FRAME_GARBAGED_P (f
)
27289 || vpos
>= w
->current_matrix
->nrows
27290 || hpos
>= w
->current_matrix
->matrix_w
)
27293 /* If cursor is off and we want it off, return quickly. */
27294 if (!on
&& !w
->phys_cursor_on_p
)
27297 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27298 /* If cursor row is not enabled, we don't really know where to
27299 display the cursor. */
27300 if (!glyph_row
->enabled_p
)
27302 w
->phys_cursor_on_p
= 0;
27307 if (!glyph_row
->exact_window_width_line_p
27308 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
27309 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
27311 eassert (input_blocked_p ());
27313 /* Set new_cursor_type to the cursor we want to be displayed. */
27314 new_cursor_type
= get_window_cursor_type (w
, glyph
,
27315 &new_cursor_width
, &active_cursor
);
27317 /* If cursor is currently being shown and we don't want it to be or
27318 it is in the wrong place, or the cursor type is not what we want,
27320 if (w
->phys_cursor_on_p
27322 || w
->phys_cursor
.x
!= x
27323 || w
->phys_cursor
.y
!= y
27324 || new_cursor_type
!= w
->phys_cursor_type
27325 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
27326 && new_cursor_width
!= w
->phys_cursor_width
)))
27327 erase_phys_cursor (w
);
27329 /* Don't check phys_cursor_on_p here because that flag is only set
27330 to zero in some cases where we know that the cursor has been
27331 completely erased, to avoid the extra work of erasing the cursor
27332 twice. In other words, phys_cursor_on_p can be 1 and the cursor
27333 still not be visible, or it has only been partly erased. */
27336 w
->phys_cursor_ascent
= glyph_row
->ascent
;
27337 w
->phys_cursor_height
= glyph_row
->height
;
27339 /* Set phys_cursor_.* before x_draw_.* is called because some
27340 of them may need the information. */
27341 w
->phys_cursor
.x
= x
;
27342 w
->phys_cursor
.y
= glyph_row
->y
;
27343 w
->phys_cursor
.hpos
= hpos
;
27344 w
->phys_cursor
.vpos
= vpos
;
27347 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
27348 new_cursor_type
, new_cursor_width
,
27349 on
, active_cursor
);
27353 /* Switch the display of W's cursor on or off, according to the value
27357 update_window_cursor (struct window
*w
, bool on
)
27359 /* Don't update cursor in windows whose frame is in the process
27360 of being deleted. */
27361 if (w
->current_matrix
)
27363 int hpos
= w
->phys_cursor
.hpos
;
27364 int vpos
= w
->phys_cursor
.vpos
;
27365 struct glyph_row
*row
;
27367 if (vpos
>= w
->current_matrix
->nrows
27368 || hpos
>= w
->current_matrix
->matrix_w
)
27371 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27373 /* When the window is hscrolled, cursor hpos can legitimately be
27374 out of bounds, but we draw the cursor at the corresponding
27375 window margin in that case. */
27376 if (!row
->reversed_p
&& hpos
< 0)
27378 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27379 hpos
= row
->used
[TEXT_AREA
] - 1;
27382 display_and_set_cursor (w
, on
, hpos
, vpos
,
27383 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27389 /* Call update_window_cursor with parameter ON_P on all leaf windows
27390 in the window tree rooted at W. */
27393 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
27397 if (WINDOWP (w
->contents
))
27398 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
27400 update_window_cursor (w
, on_p
);
27402 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
27408 Display the cursor on window W, or clear it, according to ON_P.
27409 Don't change the cursor's position. */
27412 x_update_cursor (struct frame
*f
, bool on_p
)
27414 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
27419 Clear the cursor of window W to background color, and mark the
27420 cursor as not shown. This is used when the text where the cursor
27421 is about to be rewritten. */
27424 x_clear_cursor (struct window
*w
)
27426 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
27427 update_window_cursor (w
, 0);
27430 #endif /* HAVE_WINDOW_SYSTEM */
27432 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
27435 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
27436 int start_hpos
, int end_hpos
,
27437 enum draw_glyphs_face draw
)
27439 #ifdef HAVE_WINDOW_SYSTEM
27440 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
27442 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
27446 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
27447 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
27451 /* Display the active region described by mouse_face_* according to DRAW. */
27454 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
27456 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
27457 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27459 if (/* If window is in the process of being destroyed, don't bother
27461 w
->current_matrix
!= NULL
27462 /* Don't update mouse highlight if hidden. */
27463 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
27464 /* Recognize when we are called to operate on rows that don't exist
27465 anymore. This can happen when a window is split. */
27466 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
27468 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
27469 struct glyph_row
*row
, *first
, *last
;
27471 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
27472 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
27474 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
27476 int start_hpos
, end_hpos
, start_x
;
27478 /* For all but the first row, the highlight starts at column 0. */
27481 /* R2L rows have BEG and END in reversed order, but the
27482 screen drawing geometry is always left to right. So
27483 we need to mirror the beginning and end of the
27484 highlighted area in R2L rows. */
27485 if (!row
->reversed_p
)
27487 start_hpos
= hlinfo
->mouse_face_beg_col
;
27488 start_x
= hlinfo
->mouse_face_beg_x
;
27490 else if (row
== last
)
27492 start_hpos
= hlinfo
->mouse_face_end_col
;
27493 start_x
= hlinfo
->mouse_face_end_x
;
27501 else if (row
->reversed_p
&& row
== last
)
27503 start_hpos
= hlinfo
->mouse_face_end_col
;
27504 start_x
= hlinfo
->mouse_face_end_x
;
27514 if (!row
->reversed_p
)
27515 end_hpos
= hlinfo
->mouse_face_end_col
;
27516 else if (row
== first
)
27517 end_hpos
= hlinfo
->mouse_face_beg_col
;
27520 end_hpos
= row
->used
[TEXT_AREA
];
27521 if (draw
== DRAW_NORMAL_TEXT
)
27522 row
->fill_line_p
= 1; /* Clear to end of line */
27525 else if (row
->reversed_p
&& row
== first
)
27526 end_hpos
= hlinfo
->mouse_face_beg_col
;
27529 end_hpos
= row
->used
[TEXT_AREA
];
27530 if (draw
== DRAW_NORMAL_TEXT
)
27531 row
->fill_line_p
= 1; /* Clear to end of line */
27534 if (end_hpos
> start_hpos
)
27536 draw_row_with_mouse_face (w
, start_x
, row
,
27537 start_hpos
, end_hpos
, draw
);
27540 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
27544 #ifdef HAVE_WINDOW_SYSTEM
27545 /* When we've written over the cursor, arrange for it to
27546 be displayed again. */
27547 if (FRAME_WINDOW_P (f
)
27548 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
27550 int hpos
= w
->phys_cursor
.hpos
;
27552 /* When the window is hscrolled, cursor hpos can legitimately be
27553 out of bounds, but we draw the cursor at the corresponding
27554 window margin in that case. */
27555 if (!row
->reversed_p
&& hpos
< 0)
27557 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27558 hpos
= row
->used
[TEXT_AREA
] - 1;
27561 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
27562 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27565 #endif /* HAVE_WINDOW_SYSTEM */
27568 #ifdef HAVE_WINDOW_SYSTEM
27569 /* Change the mouse cursor. */
27570 if (FRAME_WINDOW_P (f
))
27572 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
27573 if (draw
== DRAW_NORMAL_TEXT
27574 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
27575 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
27578 if (draw
== DRAW_MOUSE_FACE
)
27579 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
27581 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
27583 #endif /* HAVE_WINDOW_SYSTEM */
27587 Clear out the mouse-highlighted active region.
27588 Redraw it un-highlighted first. Value is non-zero if mouse
27589 face was actually drawn unhighlighted. */
27592 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
27596 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
27598 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
27602 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27603 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27604 hlinfo
->mouse_face_window
= Qnil
;
27605 hlinfo
->mouse_face_overlay
= Qnil
;
27609 /* Return true if the coordinates HPOS and VPOS on windows W are
27610 within the mouse face on that window. */
27612 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
27614 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27616 /* Quickly resolve the easy cases. */
27617 if (!(WINDOWP (hlinfo
->mouse_face_window
)
27618 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
27620 if (vpos
< hlinfo
->mouse_face_beg_row
27621 || vpos
> hlinfo
->mouse_face_end_row
)
27623 if (vpos
> hlinfo
->mouse_face_beg_row
27624 && vpos
< hlinfo
->mouse_face_end_row
)
27627 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
27629 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27631 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
27634 else if ((vpos
== hlinfo
->mouse_face_beg_row
27635 && hpos
>= hlinfo
->mouse_face_beg_col
)
27636 || (vpos
== hlinfo
->mouse_face_end_row
27637 && hpos
< hlinfo
->mouse_face_end_col
))
27642 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27644 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
27647 else if ((vpos
== hlinfo
->mouse_face_beg_row
27648 && hpos
<= hlinfo
->mouse_face_beg_col
)
27649 || (vpos
== hlinfo
->mouse_face_end_row
27650 && hpos
> hlinfo
->mouse_face_end_col
))
27658 True if physical cursor of window W is within mouse face. */
27661 cursor_in_mouse_face_p (struct window
*w
)
27663 int hpos
= w
->phys_cursor
.hpos
;
27664 int vpos
= w
->phys_cursor
.vpos
;
27665 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27667 /* When the window is hscrolled, cursor hpos can legitimately be out
27668 of bounds, but we draw the cursor at the corresponding window
27669 margin in that case. */
27670 if (!row
->reversed_p
&& hpos
< 0)
27672 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27673 hpos
= row
->used
[TEXT_AREA
] - 1;
27675 return coords_in_mouse_face_p (w
, hpos
, vpos
);
27680 /* Find the glyph rows START_ROW and END_ROW of window W that display
27681 characters between buffer positions START_CHARPOS and END_CHARPOS
27682 (excluding END_CHARPOS). DISP_STRING is a display string that
27683 covers these buffer positions. This is similar to
27684 row_containing_pos, but is more accurate when bidi reordering makes
27685 buffer positions change non-linearly with glyph rows. */
27687 rows_from_pos_range (struct window
*w
,
27688 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
27689 Lisp_Object disp_string
,
27690 struct glyph_row
**start
, struct glyph_row
**end
)
27692 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27693 int last_y
= window_text_bottom_y (w
);
27694 struct glyph_row
*row
;
27699 while (!first
->enabled_p
27700 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
27703 /* Find the START row. */
27705 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
27708 /* A row can potentially be the START row if the range of the
27709 characters it displays intersects the range
27710 [START_CHARPOS..END_CHARPOS). */
27711 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
27712 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
27713 /* See the commentary in row_containing_pos, for the
27714 explanation of the complicated way to check whether
27715 some position is beyond the end of the characters
27716 displayed by a row. */
27717 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27718 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27719 && !row
->ends_at_zv_p
27720 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
27721 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27722 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27723 && !row
->ends_at_zv_p
27724 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
27726 /* Found a candidate row. Now make sure at least one of the
27727 glyphs it displays has a charpos from the range
27728 [START_CHARPOS..END_CHARPOS).
27730 This is not obvious because bidi reordering could make
27731 buffer positions of a row be 1,2,3,102,101,100, and if we
27732 want to highlight characters in [50..60), we don't want
27733 this row, even though [50..60) does intersect [1..103),
27734 the range of character positions given by the row's start
27735 and end positions. */
27736 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
27737 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
27741 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
27742 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
27743 /* A glyph that comes from DISP_STRING is by
27744 definition to be highlighted. */
27745 || EQ (g
->object
, disp_string
))
27754 /* Find the END row. */
27756 /* If the last row is partially visible, start looking for END
27757 from that row, instead of starting from FIRST. */
27758 && !(row
->enabled_p
27759 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
27761 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
27763 struct glyph_row
*next
= row
+ 1;
27764 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
27766 if (!next
->enabled_p
27767 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
27768 /* The first row >= START whose range of displayed characters
27769 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
27770 is the row END + 1. */
27771 || (start_charpos
< next_start
27772 && end_charpos
< next_start
)
27773 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
27774 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
27775 && !next
->ends_at_zv_p
27776 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
27777 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
27778 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
27779 && !next
->ends_at_zv_p
27780 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
27787 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
27788 but none of the characters it displays are in the range, it is
27790 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
27791 struct glyph
*s
= g
;
27792 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
27796 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
27797 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
27798 /* If the buffer position of the first glyph in
27799 the row is equal to END_CHARPOS, it means
27800 the last character to be highlighted is the
27801 newline of ROW, and we must consider NEXT as
27803 || (((!next
->reversed_p
&& g
== s
)
27804 || (next
->reversed_p
&& g
== e
- 1))
27805 && (g
->charpos
== end_charpos
27806 /* Special case for when NEXT is an
27807 empty line at ZV. */
27808 || (g
->charpos
== -1
27809 && !row
->ends_at_zv_p
27810 && next_start
== end_charpos
)))))
27811 /* A glyph that comes from DISP_STRING is by
27812 definition to be highlighted. */
27813 || EQ (g
->object
, disp_string
))
27822 /* The first row that ends at ZV must be the last to be
27824 else if (next
->ends_at_zv_p
)
27833 /* This function sets the mouse_face_* elements of HLINFO, assuming
27834 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
27835 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
27836 for the overlay or run of text properties specifying the mouse
27837 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
27838 before-string and after-string that must also be highlighted.
27839 DISP_STRING, if non-nil, is a display string that may cover some
27840 or all of the highlighted text. */
27843 mouse_face_from_buffer_pos (Lisp_Object window
,
27844 Mouse_HLInfo
*hlinfo
,
27845 ptrdiff_t mouse_charpos
,
27846 ptrdiff_t start_charpos
,
27847 ptrdiff_t end_charpos
,
27848 Lisp_Object before_string
,
27849 Lisp_Object after_string
,
27850 Lisp_Object disp_string
)
27852 struct window
*w
= XWINDOW (window
);
27853 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27854 struct glyph_row
*r1
, *r2
;
27855 struct glyph
*glyph
, *end
;
27856 ptrdiff_t ignore
, pos
;
27859 eassert (NILP (disp_string
) || STRINGP (disp_string
));
27860 eassert (NILP (before_string
) || STRINGP (before_string
));
27861 eassert (NILP (after_string
) || STRINGP (after_string
));
27863 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
27864 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
27866 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
27867 /* If the before-string or display-string contains newlines,
27868 rows_from_pos_range skips to its last row. Move back. */
27869 if (!NILP (before_string
) || !NILP (disp_string
))
27871 struct glyph_row
*prev
;
27872 while ((prev
= r1
- 1, prev
>= first
)
27873 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
27874 && prev
->used
[TEXT_AREA
] > 0)
27876 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
27877 glyph
= beg
+ prev
->used
[TEXT_AREA
];
27878 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
27880 || !(EQ (glyph
->object
, before_string
)
27881 || EQ (glyph
->object
, disp_string
)))
27888 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
27889 hlinfo
->mouse_face_past_end
= 1;
27891 else if (!NILP (after_string
))
27893 /* If the after-string has newlines, advance to its last row. */
27894 struct glyph_row
*next
;
27895 struct glyph_row
*last
27896 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
27898 for (next
= r2
+ 1;
27900 && next
->used
[TEXT_AREA
] > 0
27901 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
27905 /* The rest of the display engine assumes that mouse_face_beg_row is
27906 either above mouse_face_end_row or identical to it. But with
27907 bidi-reordered continued lines, the row for START_CHARPOS could
27908 be below the row for END_CHARPOS. If so, swap the rows and store
27909 them in correct order. */
27912 struct glyph_row
*tem
= r2
;
27918 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
27919 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
27921 /* For a bidi-reordered row, the positions of BEFORE_STRING,
27922 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
27923 could be anywhere in the row and in any order. The strategy
27924 below is to find the leftmost and the rightmost glyph that
27925 belongs to either of these 3 strings, or whose position is
27926 between START_CHARPOS and END_CHARPOS, and highlight all the
27927 glyphs between those two. This may cover more than just the text
27928 between START_CHARPOS and END_CHARPOS if the range of characters
27929 strides the bidi level boundary, e.g. if the beginning is in R2L
27930 text while the end is in L2R text or vice versa. */
27931 if (!r1
->reversed_p
)
27933 /* This row is in a left to right paragraph. Scan it left to
27935 glyph
= r1
->glyphs
[TEXT_AREA
];
27936 end
= glyph
+ r1
->used
[TEXT_AREA
];
27939 /* Skip truncation glyphs at the start of the glyph row. */
27940 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
27942 && INTEGERP (glyph
->object
)
27943 && glyph
->charpos
< 0;
27945 x
+= glyph
->pixel_width
;
27947 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
27948 or DISP_STRING, and the first glyph from buffer whose
27949 position is between START_CHARPOS and END_CHARPOS. */
27951 && !INTEGERP (glyph
->object
)
27952 && !EQ (glyph
->object
, disp_string
)
27953 && !(BUFFERP (glyph
->object
)
27954 && (glyph
->charpos
>= start_charpos
27955 && glyph
->charpos
< end_charpos
));
27958 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27959 are present at buffer positions between START_CHARPOS and
27960 END_CHARPOS, or if they come from an overlay. */
27961 if (EQ (glyph
->object
, before_string
))
27963 pos
= string_buffer_position (before_string
,
27965 /* If pos == 0, it means before_string came from an
27966 overlay, not from a buffer position. */
27967 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27970 else if (EQ (glyph
->object
, after_string
))
27972 pos
= string_buffer_position (after_string
, end_charpos
);
27973 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27976 x
+= glyph
->pixel_width
;
27978 hlinfo
->mouse_face_beg_x
= x
;
27979 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
27983 /* This row is in a right to left paragraph. Scan it right to
27987 end
= r1
->glyphs
[TEXT_AREA
] - 1;
27988 glyph
= end
+ r1
->used
[TEXT_AREA
];
27990 /* Skip truncation glyphs at the start of the glyph row. */
27991 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
27993 && INTEGERP (glyph
->object
)
27994 && glyph
->charpos
< 0;
27998 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
27999 or DISP_STRING, and the first glyph from buffer whose
28000 position is between START_CHARPOS and END_CHARPOS. */
28002 && !INTEGERP (glyph
->object
)
28003 && !EQ (glyph
->object
, disp_string
)
28004 && !(BUFFERP (glyph
->object
)
28005 && (glyph
->charpos
>= start_charpos
28006 && glyph
->charpos
< end_charpos
));
28009 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28010 are present at buffer positions between START_CHARPOS and
28011 END_CHARPOS, or if they come from an overlay. */
28012 if (EQ (glyph
->object
, before_string
))
28014 pos
= string_buffer_position (before_string
, start_charpos
);
28015 /* If pos == 0, it means before_string came from an
28016 overlay, not from a buffer position. */
28017 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28020 else if (EQ (glyph
->object
, after_string
))
28022 pos
= string_buffer_position (after_string
, end_charpos
);
28023 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28028 glyph
++; /* first glyph to the right of the highlighted area */
28029 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28030 x
+= g
->pixel_width
;
28031 hlinfo
->mouse_face_beg_x
= x
;
28032 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28035 /* If the highlight ends in a different row, compute GLYPH and END
28036 for the end row. Otherwise, reuse the values computed above for
28037 the row where the highlight begins. */
28040 if (!r2
->reversed_p
)
28042 glyph
= r2
->glyphs
[TEXT_AREA
];
28043 end
= glyph
+ r2
->used
[TEXT_AREA
];
28048 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28049 glyph
= end
+ r2
->used
[TEXT_AREA
];
28053 if (!r2
->reversed_p
)
28055 /* Skip truncation and continuation glyphs near the end of the
28056 row, and also blanks and stretch glyphs inserted by
28057 extend_face_to_end_of_line. */
28059 && INTEGERP ((end
- 1)->object
))
28061 /* Scan the rest of the glyph row from the end, looking for the
28062 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28063 DISP_STRING, or whose position is between START_CHARPOS
28067 && !INTEGERP (end
->object
)
28068 && !EQ (end
->object
, disp_string
)
28069 && !(BUFFERP (end
->object
)
28070 && (end
->charpos
>= start_charpos
28071 && end
->charpos
< end_charpos
));
28074 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28075 are present at buffer positions between START_CHARPOS and
28076 END_CHARPOS, or if they come from an overlay. */
28077 if (EQ (end
->object
, before_string
))
28079 pos
= string_buffer_position (before_string
, start_charpos
);
28080 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28083 else if (EQ (end
->object
, after_string
))
28085 pos
= string_buffer_position (after_string
, end_charpos
);
28086 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28090 /* Find the X coordinate of the last glyph to be highlighted. */
28091 for (; glyph
<= end
; ++glyph
)
28092 x
+= glyph
->pixel_width
;
28094 hlinfo
->mouse_face_end_x
= x
;
28095 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28099 /* Skip truncation and continuation glyphs near the end of the
28100 row, and also blanks and stretch glyphs inserted by
28101 extend_face_to_end_of_line. */
28105 && INTEGERP (end
->object
))
28107 x
+= end
->pixel_width
;
28110 /* Scan the rest of the glyph row from the end, looking for the
28111 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28112 DISP_STRING, or whose position is between START_CHARPOS
28116 && !INTEGERP (end
->object
)
28117 && !EQ (end
->object
, disp_string
)
28118 && !(BUFFERP (end
->object
)
28119 && (end
->charpos
>= start_charpos
28120 && end
->charpos
< end_charpos
));
28123 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28124 are present at buffer positions between START_CHARPOS and
28125 END_CHARPOS, or if they come from an overlay. */
28126 if (EQ (end
->object
, before_string
))
28128 pos
= string_buffer_position (before_string
, start_charpos
);
28129 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28132 else if (EQ (end
->object
, after_string
))
28134 pos
= string_buffer_position (after_string
, end_charpos
);
28135 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28138 x
+= end
->pixel_width
;
28140 /* If we exited the above loop because we arrived at the last
28141 glyph of the row, and its buffer position is still not in
28142 range, it means the last character in range is the preceding
28143 newline. Bump the end column and x values to get past the
28146 && BUFFERP (end
->object
)
28147 && (end
->charpos
< start_charpos
28148 || end
->charpos
>= end_charpos
))
28150 x
+= end
->pixel_width
;
28153 hlinfo
->mouse_face_end_x
= x
;
28154 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28157 hlinfo
->mouse_face_window
= window
;
28158 hlinfo
->mouse_face_face_id
28159 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28161 !hlinfo
->mouse_face_hidden
, -1);
28162 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28165 /* The following function is not used anymore (replaced with
28166 mouse_face_from_string_pos), but I leave it here for the time
28167 being, in case someone would. */
28169 #if 0 /* not used */
28171 /* Find the position of the glyph for position POS in OBJECT in
28172 window W's current matrix, and return in *X, *Y the pixel
28173 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28175 RIGHT_P non-zero means return the position of the right edge of the
28176 glyph, RIGHT_P zero means return the left edge position.
28178 If no glyph for POS exists in the matrix, return the position of
28179 the glyph with the next smaller position that is in the matrix, if
28180 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
28181 exists in the matrix, return the position of the glyph with the
28182 next larger position in OBJECT.
28184 Value is non-zero if a glyph was found. */
28187 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28188 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
28190 int yb
= window_text_bottom_y (w
);
28191 struct glyph_row
*r
;
28192 struct glyph
*best_glyph
= NULL
;
28193 struct glyph_row
*best_row
= NULL
;
28196 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28197 r
->enabled_p
&& r
->y
< yb
;
28200 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28201 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28204 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28205 if (EQ (g
->object
, object
))
28207 if (g
->charpos
== pos
)
28214 else if (best_glyph
== NULL
28215 || ((eabs (g
->charpos
- pos
)
28216 < eabs (best_glyph
->charpos
- pos
))
28219 : g
->charpos
> pos
)))
28233 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28237 *x
+= best_glyph
->pixel_width
;
28242 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28245 return best_glyph
!= NULL
;
28247 #endif /* not used */
28249 /* Find the positions of the first and the last glyphs in window W's
28250 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28251 (assumed to be a string), and return in HLINFO's mouse_face_*
28252 members the pixel and column/row coordinates of those glyphs. */
28255 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28256 Lisp_Object object
,
28257 ptrdiff_t startpos
, ptrdiff_t endpos
)
28259 int yb
= window_text_bottom_y (w
);
28260 struct glyph_row
*r
;
28261 struct glyph
*g
, *e
;
28265 /* Find the glyph row with at least one position in the range
28266 [STARTPOS..ENDPOS), and the first glyph in that row whose
28267 position belongs to that range. */
28268 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28269 r
->enabled_p
&& r
->y
< yb
;
28272 if (!r
->reversed_p
)
28274 g
= r
->glyphs
[TEXT_AREA
];
28275 e
= g
+ r
->used
[TEXT_AREA
];
28276 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28277 if (EQ (g
->object
, object
)
28278 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28280 hlinfo
->mouse_face_beg_row
28281 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28282 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28283 hlinfo
->mouse_face_beg_x
= gx
;
28292 e
= r
->glyphs
[TEXT_AREA
];
28293 g
= e
+ r
->used
[TEXT_AREA
];
28294 for ( ; g
> e
; --g
)
28295 if (EQ ((g
-1)->object
, object
)
28296 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
28298 hlinfo
->mouse_face_beg_row
28299 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28300 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28301 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
28302 gx
+= g1
->pixel_width
;
28303 hlinfo
->mouse_face_beg_x
= gx
;
28315 /* Starting with the next row, look for the first row which does NOT
28316 include any glyphs whose positions are in the range. */
28317 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
28319 g
= r
->glyphs
[TEXT_AREA
];
28320 e
= g
+ r
->used
[TEXT_AREA
];
28322 for ( ; g
< e
; ++g
)
28323 if (EQ (g
->object
, object
)
28324 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28333 /* The highlighted region ends on the previous row. */
28336 /* Set the end row. */
28337 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28339 /* Compute and set the end column and the end column's horizontal
28340 pixel coordinate. */
28341 if (!r
->reversed_p
)
28343 g
= r
->glyphs
[TEXT_AREA
];
28344 e
= g
+ r
->used
[TEXT_AREA
];
28345 for ( ; e
> g
; --e
)
28346 if (EQ ((e
-1)->object
, object
)
28347 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
28349 hlinfo
->mouse_face_end_col
= e
- g
;
28351 for (gx
= r
->x
; g
< e
; ++g
)
28352 gx
+= g
->pixel_width
;
28353 hlinfo
->mouse_face_end_x
= gx
;
28357 e
= r
->glyphs
[TEXT_AREA
];
28358 g
= e
+ r
->used
[TEXT_AREA
];
28359 for (gx
= r
->x
; e
< g
; ++e
)
28361 if (EQ (e
->object
, object
)
28362 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
28364 gx
+= e
->pixel_width
;
28366 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
28367 hlinfo
->mouse_face_end_x
= gx
;
28371 #ifdef HAVE_WINDOW_SYSTEM
28373 /* See if position X, Y is within a hot-spot of an image. */
28376 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
28378 if (!CONSP (hot_spot
))
28381 if (EQ (XCAR (hot_spot
), Qrect
))
28383 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
28384 Lisp_Object rect
= XCDR (hot_spot
);
28388 if (!CONSP (XCAR (rect
)))
28390 if (!CONSP (XCDR (rect
)))
28392 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
28394 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
28396 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
28398 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
28402 else if (EQ (XCAR (hot_spot
), Qcircle
))
28404 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
28405 Lisp_Object circ
= XCDR (hot_spot
);
28406 Lisp_Object lr
, lx0
, ly0
;
28408 && CONSP (XCAR (circ
))
28409 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
28410 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
28411 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
28413 double r
= XFLOATINT (lr
);
28414 double dx
= XINT (lx0
) - x
;
28415 double dy
= XINT (ly0
) - y
;
28416 return (dx
* dx
+ dy
* dy
<= r
* r
);
28419 else if (EQ (XCAR (hot_spot
), Qpoly
))
28421 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
28422 if (VECTORP (XCDR (hot_spot
)))
28424 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
28425 Lisp_Object
*poly
= v
->contents
;
28426 ptrdiff_t n
= v
->header
.size
;
28429 Lisp_Object lx
, ly
;
28432 /* Need an even number of coordinates, and at least 3 edges. */
28433 if (n
< 6 || n
& 1)
28436 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
28437 If count is odd, we are inside polygon. Pixels on edges
28438 may or may not be included depending on actual geometry of the
28440 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
28441 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
28443 x0
= XINT (lx
), y0
= XINT (ly
);
28444 for (i
= 0; i
< n
; i
+= 2)
28446 int x1
= x0
, y1
= y0
;
28447 if ((lx
= poly
[i
], !INTEGERP (lx
))
28448 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
28450 x0
= XINT (lx
), y0
= XINT (ly
);
28452 /* Does this segment cross the X line? */
28460 if (y
> y0
&& y
> y1
)
28462 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
28472 find_hot_spot (Lisp_Object map
, int x
, int y
)
28474 while (CONSP (map
))
28476 if (CONSP (XCAR (map
))
28477 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
28485 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
28487 doc
: /* Lookup in image map MAP coordinates X and Y.
28488 An image map is an alist where each element has the format (AREA ID PLIST).
28489 An AREA is specified as either a rectangle, a circle, or a polygon:
28490 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
28491 pixel coordinates of the upper left and bottom right corners.
28492 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
28493 and the radius of the circle; r may be a float or integer.
28494 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
28495 vector describes one corner in the polygon.
28496 Returns the alist element for the first matching AREA in MAP. */)
28497 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
28505 return find_hot_spot (map
,
28506 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
28507 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
28511 /* Display frame CURSOR, optionally using shape defined by POINTER. */
28513 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
28515 /* Do not change cursor shape while dragging mouse. */
28516 if (!NILP (do_mouse_tracking
))
28519 if (!NILP (pointer
))
28521 if (EQ (pointer
, Qarrow
))
28522 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28523 else if (EQ (pointer
, Qhand
))
28524 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
28525 else if (EQ (pointer
, Qtext
))
28526 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
28527 else if (EQ (pointer
, intern ("hdrag")))
28528 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28529 else if (EQ (pointer
, intern ("nhdrag")))
28530 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
28531 #ifdef HAVE_X_WINDOWS
28532 else if (EQ (pointer
, intern ("vdrag")))
28533 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28535 else if (EQ (pointer
, intern ("hourglass")))
28536 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
28537 else if (EQ (pointer
, Qmodeline
))
28538 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
28540 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28543 if (cursor
!= No_Cursor
)
28544 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
28547 #endif /* HAVE_WINDOW_SYSTEM */
28549 /* Take proper action when mouse has moved to the mode or header line
28550 or marginal area AREA of window W, x-position X and y-position Y.
28551 X is relative to the start of the text display area of W, so the
28552 width of bitmap areas and scroll bars must be subtracted to get a
28553 position relative to the start of the mode line. */
28556 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
28557 enum window_part area
)
28559 struct window
*w
= XWINDOW (window
);
28560 struct frame
*f
= XFRAME (w
->frame
);
28561 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28562 #ifdef HAVE_WINDOW_SYSTEM
28563 Display_Info
*dpyinfo
;
28565 Cursor cursor
= No_Cursor
;
28566 Lisp_Object pointer
= Qnil
;
28567 int dx
, dy
, width
, height
;
28569 Lisp_Object string
, object
= Qnil
;
28570 Lisp_Object pos
IF_LINT (= Qnil
), help
;
28572 Lisp_Object mouse_face
;
28573 int original_x_pixel
= x
;
28574 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
28575 struct glyph_row
*row
IF_LINT (= 0);
28577 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
28582 /* Kludge alert: mode_line_string takes X/Y in pixels, but
28583 returns them in row/column units! */
28584 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
28585 &object
, &dx
, &dy
, &width
, &height
);
28587 row
= (area
== ON_MODE_LINE
28588 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
28589 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
28591 /* Find the glyph under the mouse pointer. */
28592 if (row
->mode_line_p
&& row
->enabled_p
)
28594 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
28595 end
= glyph
+ row
->used
[TEXT_AREA
];
28597 for (x0
= original_x_pixel
;
28598 glyph
< end
&& x0
>= glyph
->pixel_width
;
28600 x0
-= glyph
->pixel_width
;
28608 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
28609 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
28610 returns them in row/column units! */
28611 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
28612 &object
, &dx
, &dy
, &width
, &height
);
28617 #ifdef HAVE_WINDOW_SYSTEM
28618 if (IMAGEP (object
))
28620 Lisp_Object image_map
, hotspot
;
28621 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
28623 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
28625 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
28629 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
28630 If so, we could look for mouse-enter, mouse-leave
28631 properties in PLIST (and do something...). */
28632 hotspot
= XCDR (hotspot
);
28633 if (CONSP (hotspot
)
28634 && (plist
= XCAR (hotspot
), CONSP (plist
)))
28636 pointer
= Fplist_get (plist
, Qpointer
);
28637 if (NILP (pointer
))
28639 help
= Fplist_get (plist
, Qhelp_echo
);
28642 help_echo_string
= help
;
28643 XSETWINDOW (help_echo_window
, w
);
28644 help_echo_object
= w
->contents
;
28645 help_echo_pos
= charpos
;
28649 if (NILP (pointer
))
28650 pointer
= Fplist_get (XCDR (object
), QCpointer
);
28652 #endif /* HAVE_WINDOW_SYSTEM */
28654 if (STRINGP (string
))
28655 pos
= make_number (charpos
);
28657 /* Set the help text and mouse pointer. If the mouse is on a part
28658 of the mode line without any text (e.g. past the right edge of
28659 the mode line text), use the default help text and pointer. */
28660 if (STRINGP (string
) || area
== ON_MODE_LINE
)
28662 /* Arrange to display the help by setting the global variables
28663 help_echo_string, help_echo_object, and help_echo_pos. */
28666 if (STRINGP (string
))
28667 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
28671 help_echo_string
= help
;
28672 XSETWINDOW (help_echo_window
, w
);
28673 help_echo_object
= string
;
28674 help_echo_pos
= charpos
;
28676 else if (area
== ON_MODE_LINE
)
28678 Lisp_Object default_help
28679 = buffer_local_value_1 (Qmode_line_default_help_echo
,
28682 if (STRINGP (default_help
))
28684 help_echo_string
= default_help
;
28685 XSETWINDOW (help_echo_window
, w
);
28686 help_echo_object
= Qnil
;
28687 help_echo_pos
= -1;
28692 #ifdef HAVE_WINDOW_SYSTEM
28693 /* Change the mouse pointer according to what is under it. */
28694 if (FRAME_WINDOW_P (f
))
28696 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
28698 || NILP (Vresize_mini_windows
));
28700 dpyinfo
= FRAME_DISPLAY_INFO (f
);
28701 if (STRINGP (string
))
28703 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28705 if (NILP (pointer
))
28706 pointer
= Fget_text_property (pos
, Qpointer
, string
);
28708 /* Change the mouse pointer according to what is under X/Y. */
28710 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
28713 map
= Fget_text_property (pos
, Qlocal_map
, string
);
28714 if (!KEYMAPP (map
))
28715 map
= Fget_text_property (pos
, Qkeymap
, string
);
28716 if (!KEYMAPP (map
) && draggable
)
28717 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
28720 else if (draggable
)
28721 /* Default mode-line pointer. */
28722 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28727 /* Change the mouse face according to what is under X/Y. */
28728 if (STRINGP (string
))
28730 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
28731 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
28732 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
28737 struct glyph
* tmp_glyph
;
28741 int total_pixel_width
;
28742 ptrdiff_t begpos
, endpos
, ignore
;
28746 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
28747 Qmouse_face
, string
, Qnil
);
28753 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
28755 endpos
= SCHARS (string
);
28759 /* Calculate the glyph position GPOS of GLYPH in the
28760 displayed string, relative to the beginning of the
28761 highlighted part of the string.
28763 Note: GPOS is different from CHARPOS. CHARPOS is the
28764 position of GLYPH in the internal string object. A mode
28765 line string format has structures which are converted to
28766 a flattened string by the Emacs Lisp interpreter. The
28767 internal string is an element of those structures. The
28768 displayed string is the flattened string. */
28769 tmp_glyph
= row_start_glyph
;
28770 while (tmp_glyph
< glyph
28771 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
28772 && begpos
<= tmp_glyph
->charpos
28773 && tmp_glyph
->charpos
< endpos
)))
28775 gpos
= glyph
- tmp_glyph
;
28777 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
28778 the highlighted part of the displayed string to which
28779 GLYPH belongs. Note: GSEQ_LENGTH is different from
28780 SCHARS (STRING), because the latter returns the length of
28781 the internal string. */
28782 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
28784 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
28785 && begpos
<= tmp_glyph
->charpos
28786 && tmp_glyph
->charpos
< endpos
));
28789 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
28791 /* Calculate the total pixel width of all the glyphs between
28792 the beginning of the highlighted area and GLYPH. */
28793 total_pixel_width
= 0;
28794 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
28795 total_pixel_width
+= tmp_glyph
->pixel_width
;
28797 /* Pre calculation of re-rendering position. Note: X is in
28798 column units here, after the call to mode_line_string or
28799 marginal_area_string. */
28801 vpos
= (area
== ON_MODE_LINE
28802 ? (w
->current_matrix
)->nrows
- 1
28805 /* If GLYPH's position is included in the region that is
28806 already drawn in mouse face, we have nothing to do. */
28807 if ( EQ (window
, hlinfo
->mouse_face_window
)
28808 && (!row
->reversed_p
28809 ? (hlinfo
->mouse_face_beg_col
<= hpos
28810 && hpos
< hlinfo
->mouse_face_end_col
)
28811 /* In R2L rows we swap BEG and END, see below. */
28812 : (hlinfo
->mouse_face_end_col
<= hpos
28813 && hpos
< hlinfo
->mouse_face_beg_col
))
28814 && hlinfo
->mouse_face_beg_row
== vpos
)
28817 if (clear_mouse_face (hlinfo
))
28818 cursor
= No_Cursor
;
28820 if (!row
->reversed_p
)
28822 hlinfo
->mouse_face_beg_col
= hpos
;
28823 hlinfo
->mouse_face_beg_x
= original_x_pixel
28824 - (total_pixel_width
+ dx
);
28825 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
28826 hlinfo
->mouse_face_end_x
= 0;
28830 /* In R2L rows, show_mouse_face expects BEG and END
28831 coordinates to be swapped. */
28832 hlinfo
->mouse_face_end_col
= hpos
;
28833 hlinfo
->mouse_face_end_x
= original_x_pixel
28834 - (total_pixel_width
+ dx
);
28835 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
28836 hlinfo
->mouse_face_beg_x
= 0;
28839 hlinfo
->mouse_face_beg_row
= vpos
;
28840 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
28841 hlinfo
->mouse_face_past_end
= 0;
28842 hlinfo
->mouse_face_window
= window
;
28844 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
28849 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28851 if (NILP (pointer
))
28854 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
28855 clear_mouse_face (hlinfo
);
28857 #ifdef HAVE_WINDOW_SYSTEM
28858 if (FRAME_WINDOW_P (f
))
28859 define_frame_cursor1 (f
, cursor
, pointer
);
28865 Take proper action when the mouse has moved to position X, Y on
28866 frame F with regards to highlighting portions of display that have
28867 mouse-face properties. Also de-highlight portions of display where
28868 the mouse was before, set the mouse pointer shape as appropriate
28869 for the mouse coordinates, and activate help echo (tooltips).
28870 X and Y can be negative or out of range. */
28873 note_mouse_highlight (struct frame
*f
, int x
, int y
)
28875 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28876 enum window_part part
= ON_NOTHING
;
28877 Lisp_Object window
;
28879 Cursor cursor
= No_Cursor
;
28880 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
28883 /* When a menu is active, don't highlight because this looks odd. */
28884 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
28885 if (popup_activated ())
28889 if (!f
->glyphs_initialized_p
28890 || f
->pointer_invisible
)
28893 hlinfo
->mouse_face_mouse_x
= x
;
28894 hlinfo
->mouse_face_mouse_y
= y
;
28895 hlinfo
->mouse_face_mouse_frame
= f
;
28897 if (hlinfo
->mouse_face_defer
)
28900 /* Which window is that in? */
28901 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
28903 /* If displaying active text in another window, clear that. */
28904 if (! EQ (window
, hlinfo
->mouse_face_window
)
28905 /* Also clear if we move out of text area in same window. */
28906 || (!NILP (hlinfo
->mouse_face_window
)
28909 && part
!= ON_MODE_LINE
28910 && part
!= ON_HEADER_LINE
))
28911 clear_mouse_face (hlinfo
);
28913 /* Not on a window -> return. */
28914 if (!WINDOWP (window
))
28917 /* Reset help_echo_string. It will get recomputed below. */
28918 help_echo_string
= Qnil
;
28920 /* Convert to window-relative pixel coordinates. */
28921 w
= XWINDOW (window
);
28922 frame_to_window_pixel_xy (w
, &x
, &y
);
28924 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
28925 /* Handle tool-bar window differently since it doesn't display a
28927 if (EQ (window
, f
->tool_bar_window
))
28929 note_tool_bar_highlight (f
, x
, y
);
28934 /* Mouse is on the mode, header line or margin? */
28935 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
28936 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
28938 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
28940 #ifdef HAVE_WINDOW_SYSTEM
28941 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
28943 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28944 /* Show non-text cursor (Bug#16647). */
28952 #ifdef HAVE_WINDOW_SYSTEM
28953 if (part
== ON_VERTICAL_BORDER
)
28955 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28956 help_echo_string
= build_string ("drag-mouse-1: resize");
28958 else if (part
== ON_RIGHT_DIVIDER
)
28960 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28961 help_echo_string
= build_string ("drag-mouse-1: resize");
28963 else if (part
== ON_BOTTOM_DIVIDER
)
28964 if (! WINDOW_BOTTOMMOST_P (w
)
28966 || NILP (Vresize_mini_windows
))
28968 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
28969 help_echo_string
= build_string ("drag-mouse-1: resize");
28972 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28973 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
28974 || part
== ON_SCROLL_BAR
)
28975 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28977 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
28980 /* Are we in a window whose display is up to date?
28981 And verify the buffer's text has not changed. */
28982 b
= XBUFFER (w
->contents
);
28983 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
28985 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
28987 struct glyph
*glyph
;
28988 Lisp_Object object
;
28989 Lisp_Object mouse_face
= Qnil
, position
;
28990 Lisp_Object
*overlay_vec
= NULL
;
28991 ptrdiff_t i
, noverlays
;
28992 struct buffer
*obuf
;
28993 ptrdiff_t obegv
, ozv
;
28996 /* Find the glyph under X/Y. */
28997 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
28999 #ifdef HAVE_WINDOW_SYSTEM
29000 /* Look for :pointer property on image. */
29001 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29003 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29004 if (img
!= NULL
&& IMAGEP (img
->spec
))
29006 Lisp_Object image_map
, hotspot
;
29007 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29009 && (hotspot
= find_hot_spot (image_map
,
29010 glyph
->slice
.img
.x
+ dx
,
29011 glyph
->slice
.img
.y
+ dy
),
29013 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29017 /* Could check XCAR (hotspot) to see if we enter/leave
29019 If so, we could look for mouse-enter, mouse-leave
29020 properties in PLIST (and do something...). */
29021 hotspot
= XCDR (hotspot
);
29022 if (CONSP (hotspot
)
29023 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29025 pointer
= Fplist_get (plist
, Qpointer
);
29026 if (NILP (pointer
))
29028 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29029 if (!NILP (help_echo_string
))
29031 help_echo_window
= window
;
29032 help_echo_object
= glyph
->object
;
29033 help_echo_pos
= glyph
->charpos
;
29037 if (NILP (pointer
))
29038 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29041 #endif /* HAVE_WINDOW_SYSTEM */
29043 /* Clear mouse face if X/Y not over text. */
29045 || area
!= TEXT_AREA
29046 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29047 /* Glyph's OBJECT is an integer for glyphs inserted by the
29048 display engine for its internal purposes, like truncation
29049 and continuation glyphs and blanks beyond the end of
29050 line's text on text terminals. If we are over such a
29051 glyph, we are not over any text. */
29052 || INTEGERP (glyph
->object
)
29053 /* R2L rows have a stretch glyph at their front, which
29054 stands for no text, whereas L2R rows have no glyphs at
29055 all beyond the end of text. Treat such stretch glyphs
29056 like we do with NULL glyphs in L2R rows. */
29057 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29058 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29059 && glyph
->type
== STRETCH_GLYPH
29060 && glyph
->avoid_cursor_p
))
29062 if (clear_mouse_face (hlinfo
))
29063 cursor
= No_Cursor
;
29064 #ifdef HAVE_WINDOW_SYSTEM
29065 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29067 if (area
!= TEXT_AREA
)
29068 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29070 pointer
= Vvoid_text_area_pointer
;
29076 pos
= glyph
->charpos
;
29077 object
= glyph
->object
;
29078 if (!STRINGP (object
) && !BUFFERP (object
))
29081 /* If we get an out-of-range value, return now; avoid an error. */
29082 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29085 /* Make the window's buffer temporarily current for
29086 overlays_at and compute_char_face. */
29087 obuf
= current_buffer
;
29088 current_buffer
= b
;
29094 /* Is this char mouse-active or does it have help-echo? */
29095 position
= make_number (pos
);
29097 if (BUFFERP (object
))
29099 /* Put all the overlays we want in a vector in overlay_vec. */
29100 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
29101 /* Sort overlays into increasing priority order. */
29102 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29107 if (NILP (Vmouse_highlight
))
29109 clear_mouse_face (hlinfo
);
29110 goto check_help_echo
;
29113 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29116 cursor
= No_Cursor
;
29118 /* Check mouse-face highlighting. */
29120 /* If there exists an overlay with mouse-face overlapping
29121 the one we are currently highlighting, we have to
29122 check if we enter the overlapping overlay, and then
29123 highlight only that. */
29124 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29125 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29127 /* Find the highest priority overlay with a mouse-face. */
29128 Lisp_Object overlay
= Qnil
;
29129 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29131 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29132 if (!NILP (mouse_face
))
29133 overlay
= overlay_vec
[i
];
29136 /* If we're highlighting the same overlay as before, there's
29137 no need to do that again. */
29138 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29139 goto check_help_echo
;
29140 hlinfo
->mouse_face_overlay
= overlay
;
29142 /* Clear the display of the old active region, if any. */
29143 if (clear_mouse_face (hlinfo
))
29144 cursor
= No_Cursor
;
29146 /* If no overlay applies, get a text property. */
29147 if (NILP (overlay
))
29148 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29150 /* Next, compute the bounds of the mouse highlighting and
29152 if (!NILP (mouse_face
) && STRINGP (object
))
29154 /* The mouse-highlighting comes from a display string
29155 with a mouse-face. */
29159 s
= Fprevious_single_property_change
29160 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29161 e
= Fnext_single_property_change
29162 (position
, Qmouse_face
, object
, Qnil
);
29164 s
= make_number (0);
29166 e
= make_number (SCHARS (object
));
29167 mouse_face_from_string_pos (w
, hlinfo
, object
,
29168 XINT (s
), XINT (e
));
29169 hlinfo
->mouse_face_past_end
= 0;
29170 hlinfo
->mouse_face_window
= window
;
29171 hlinfo
->mouse_face_face_id
29172 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29173 glyph
->face_id
, 1);
29174 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29175 cursor
= No_Cursor
;
29179 /* The mouse-highlighting, if any, comes from an overlay
29180 or text property in the buffer. */
29181 Lisp_Object buffer
IF_LINT (= Qnil
);
29182 Lisp_Object disp_string
IF_LINT (= Qnil
);
29184 if (STRINGP (object
))
29186 /* If we are on a display string with no mouse-face,
29187 check if the text under it has one. */
29188 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29189 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29190 pos
= string_buffer_position (object
, start
);
29193 mouse_face
= get_char_property_and_overlay
29194 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29195 buffer
= w
->contents
;
29196 disp_string
= object
;
29202 disp_string
= Qnil
;
29205 if (!NILP (mouse_face
))
29207 Lisp_Object before
, after
;
29208 Lisp_Object before_string
, after_string
;
29209 /* To correctly find the limits of mouse highlight
29210 in a bidi-reordered buffer, we must not use the
29211 optimization of limiting the search in
29212 previous-single-property-change and
29213 next-single-property-change, because
29214 rows_from_pos_range needs the real start and end
29215 positions to DTRT in this case. That's because
29216 the first row visible in a window does not
29217 necessarily display the character whose position
29218 is the smallest. */
29220 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29221 ? Fmarker_position (w
->start
)
29224 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29225 ? make_number (BUF_Z (XBUFFER (buffer
))
29226 - w
->window_end_pos
)
29229 if (NILP (overlay
))
29231 /* Handle the text property case. */
29232 before
= Fprevious_single_property_change
29233 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29234 after
= Fnext_single_property_change
29235 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29236 before_string
= after_string
= Qnil
;
29240 /* Handle the overlay case. */
29241 before
= Foverlay_start (overlay
);
29242 after
= Foverlay_end (overlay
);
29243 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29244 after_string
= Foverlay_get (overlay
, Qafter_string
);
29246 if (!STRINGP (before_string
)) before_string
= Qnil
;
29247 if (!STRINGP (after_string
)) after_string
= Qnil
;
29250 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29253 : XFASTINT (before
),
29255 ? BUF_Z (XBUFFER (buffer
))
29256 : XFASTINT (after
),
29257 before_string
, after_string
,
29259 cursor
= No_Cursor
;
29266 /* Look for a `help-echo' property. */
29267 if (NILP (help_echo_string
)) {
29268 Lisp_Object help
, overlay
;
29270 /* Check overlays first. */
29271 help
= overlay
= Qnil
;
29272 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29274 overlay
= overlay_vec
[i
];
29275 help
= Foverlay_get (overlay
, Qhelp_echo
);
29280 help_echo_string
= help
;
29281 help_echo_window
= window
;
29282 help_echo_object
= overlay
;
29283 help_echo_pos
= pos
;
29287 Lisp_Object obj
= glyph
->object
;
29288 ptrdiff_t charpos
= glyph
->charpos
;
29290 /* Try text properties. */
29293 && charpos
< SCHARS (obj
))
29295 help
= Fget_text_property (make_number (charpos
),
29299 /* If the string itself doesn't specify a help-echo,
29300 see if the buffer text ``under'' it does. */
29301 struct glyph_row
*r
29302 = MATRIX_ROW (w
->current_matrix
, vpos
);
29303 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29304 ptrdiff_t p
= string_buffer_position (obj
, start
);
29307 help
= Fget_char_property (make_number (p
),
29308 Qhelp_echo
, w
->contents
);
29317 else if (BUFFERP (obj
)
29320 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
29325 help_echo_string
= help
;
29326 help_echo_window
= window
;
29327 help_echo_object
= obj
;
29328 help_echo_pos
= charpos
;
29333 #ifdef HAVE_WINDOW_SYSTEM
29334 /* Look for a `pointer' property. */
29335 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29337 /* Check overlays first. */
29338 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
29339 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
29341 if (NILP (pointer
))
29343 Lisp_Object obj
= glyph
->object
;
29344 ptrdiff_t charpos
= glyph
->charpos
;
29346 /* Try text properties. */
29349 && charpos
< SCHARS (obj
))
29351 pointer
= Fget_text_property (make_number (charpos
),
29353 if (NILP (pointer
))
29355 /* If the string itself doesn't specify a pointer,
29356 see if the buffer text ``under'' it does. */
29357 struct glyph_row
*r
29358 = MATRIX_ROW (w
->current_matrix
, vpos
);
29359 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29360 ptrdiff_t p
= string_buffer_position (obj
, start
);
29362 pointer
= Fget_char_property (make_number (p
),
29363 Qpointer
, w
->contents
);
29366 else if (BUFFERP (obj
)
29369 pointer
= Fget_text_property (make_number (charpos
),
29373 #endif /* HAVE_WINDOW_SYSTEM */
29377 current_buffer
= obuf
;
29382 #ifdef HAVE_WINDOW_SYSTEM
29383 if (FRAME_WINDOW_P (f
))
29384 define_frame_cursor1 (f
, cursor
, pointer
);
29386 /* This is here to prevent a compiler error, about "label at end of
29387 compound statement". */
29394 Clear any mouse-face on window W. This function is part of the
29395 redisplay interface, and is called from try_window_id and similar
29396 functions to ensure the mouse-highlight is off. */
29399 x_clear_window_mouse_face (struct window
*w
)
29401 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
29402 Lisp_Object window
;
29405 XSETWINDOW (window
, w
);
29406 if (EQ (window
, hlinfo
->mouse_face_window
))
29407 clear_mouse_face (hlinfo
);
29413 Just discard the mouse face information for frame F, if any.
29414 This is used when the size of F is changed. */
29417 cancel_mouse_face (struct frame
*f
)
29419 Lisp_Object window
;
29420 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29422 window
= hlinfo
->mouse_face_window
;
29423 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
29424 reset_mouse_highlight (hlinfo
);
29429 /***********************************************************************
29431 ***********************************************************************/
29433 #ifdef HAVE_WINDOW_SYSTEM
29435 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
29436 which intersects rectangle R. R is in window-relative coordinates. */
29439 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
29440 enum glyph_row_area area
)
29442 struct glyph
*first
= row
->glyphs
[area
];
29443 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
29444 struct glyph
*last
;
29445 int first_x
, start_x
, x
;
29447 if (area
== TEXT_AREA
&& row
->fill_line_p
)
29448 /* If row extends face to end of line write the whole line. */
29449 draw_glyphs (w
, 0, row
, area
,
29450 0, row
->used
[area
],
29451 DRAW_NORMAL_TEXT
, 0);
29454 /* Set START_X to the window-relative start position for drawing glyphs of
29455 AREA. The first glyph of the text area can be partially visible.
29456 The first glyphs of other areas cannot. */
29457 start_x
= window_box_left_offset (w
, area
);
29459 if (area
== TEXT_AREA
)
29462 /* Find the first glyph that must be redrawn. */
29464 && x
+ first
->pixel_width
< r
->x
)
29466 x
+= first
->pixel_width
;
29470 /* Find the last one. */
29474 && x
< r
->x
+ r
->width
)
29476 x
+= last
->pixel_width
;
29482 draw_glyphs (w
, first_x
- start_x
, row
, area
,
29483 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
29484 DRAW_NORMAL_TEXT
, 0);
29489 /* Redraw the parts of the glyph row ROW on window W intersecting
29490 rectangle R. R is in window-relative coordinates. Value is
29491 non-zero if mouse-face was overwritten. */
29494 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
29496 eassert (row
->enabled_p
);
29498 if (row
->mode_line_p
|| w
->pseudo_window_p
)
29499 draw_glyphs (w
, 0, row
, TEXT_AREA
,
29500 0, row
->used
[TEXT_AREA
],
29501 DRAW_NORMAL_TEXT
, 0);
29504 if (row
->used
[LEFT_MARGIN_AREA
])
29505 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
29506 if (row
->used
[TEXT_AREA
])
29507 expose_area (w
, row
, r
, TEXT_AREA
);
29508 if (row
->used
[RIGHT_MARGIN_AREA
])
29509 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
29510 draw_row_fringe_bitmaps (w
, row
);
29513 return row
->mouse_face_p
;
29517 /* Redraw those parts of glyphs rows during expose event handling that
29518 overlap other rows. Redrawing of an exposed line writes over parts
29519 of lines overlapping that exposed line; this function fixes that.
29521 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
29522 row in W's current matrix that is exposed and overlaps other rows.
29523 LAST_OVERLAPPING_ROW is the last such row. */
29526 expose_overlaps (struct window
*w
,
29527 struct glyph_row
*first_overlapping_row
,
29528 struct glyph_row
*last_overlapping_row
,
29531 struct glyph_row
*row
;
29533 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
29534 if (row
->overlapping_p
)
29536 eassert (row
->enabled_p
&& !row
->mode_line_p
);
29539 if (row
->used
[LEFT_MARGIN_AREA
])
29540 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
29542 if (row
->used
[TEXT_AREA
])
29543 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
29545 if (row
->used
[RIGHT_MARGIN_AREA
])
29546 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
29552 /* Return non-zero if W's cursor intersects rectangle R. */
29555 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
29557 XRectangle cr
, result
;
29558 struct glyph
*cursor_glyph
;
29559 struct glyph_row
*row
;
29561 if (w
->phys_cursor
.vpos
>= 0
29562 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
29563 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
29565 && row
->cursor_in_fringe_p
)
29567 /* Cursor is in the fringe. */
29568 cr
.x
= window_box_right_offset (w
,
29569 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
29570 ? RIGHT_MARGIN_AREA
29573 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
29574 cr
.height
= row
->height
;
29575 return x_intersect_rectangles (&cr
, r
, &result
);
29578 cursor_glyph
= get_phys_cursor_glyph (w
);
29581 /* r is relative to W's box, but w->phys_cursor.x is relative
29582 to left edge of W's TEXT area. Adjust it. */
29583 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
29584 cr
.y
= w
->phys_cursor
.y
;
29585 cr
.width
= cursor_glyph
->pixel_width
;
29586 cr
.height
= w
->phys_cursor_height
;
29587 /* ++KFS: W32 version used W32-specific IntersectRect here, but
29588 I assume the effect is the same -- and this is portable. */
29589 return x_intersect_rectangles (&cr
, r
, &result
);
29591 /* If we don't understand the format, pretend we're not in the hot-spot. */
29597 Draw a vertical window border to the right of window W if W doesn't
29598 have vertical scroll bars. */
29601 x_draw_vertical_border (struct window
*w
)
29603 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29605 /* We could do better, if we knew what type of scroll-bar the adjacent
29606 windows (on either side) have... But we don't :-(
29607 However, I think this works ok. ++KFS 2003-04-25 */
29609 /* Redraw borders between horizontally adjacent windows. Don't
29610 do it for frames with vertical scroll bars because either the
29611 right scroll bar of a window, or the left scroll bar of its
29612 neighbor will suffice as a border. */
29613 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
29616 /* Note: It is necessary to redraw both the left and the right
29617 borders, for when only this single window W is being
29619 if (!WINDOW_RIGHTMOST_P (w
)
29620 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
29622 int x0
, x1
, y0
, y1
;
29624 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29627 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29630 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
29633 if (!WINDOW_LEFTMOST_P (w
)
29634 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
29636 int x0
, x1
, y0
, y1
;
29638 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29641 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29644 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
29649 /* Draw window dividers for window W. */
29652 x_draw_right_divider (struct window
*w
)
29654 struct frame
*f
= WINDOW_XFRAME (w
);
29656 if (w
->mini
|| w
->pseudo_window_p
)
29658 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
29660 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
29661 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29662 int y0
= WINDOW_TOP_EDGE_Y (w
);
29663 /* The bottom divider prevails. */
29664 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29666 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29671 x_draw_bottom_divider (struct window
*w
)
29673 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29675 if (w
->mini
|| w
->pseudo_window_p
)
29677 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
29679 int x0
= WINDOW_LEFT_EDGE_X (w
);
29680 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29681 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29682 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
29684 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29688 /* Redraw the part of window W intersection rectangle FR. Pixel
29689 coordinates in FR are frame-relative. Call this function with
29690 input blocked. Value is non-zero if the exposure overwrites
29694 expose_window (struct window
*w
, XRectangle
*fr
)
29696 struct frame
*f
= XFRAME (w
->frame
);
29698 int mouse_face_overwritten_p
= 0;
29700 /* If window is not yet fully initialized, do nothing. This can
29701 happen when toolkit scroll bars are used and a window is split.
29702 Reconfiguring the scroll bar will generate an expose for a newly
29704 if (w
->current_matrix
== NULL
)
29707 /* When we're currently updating the window, display and current
29708 matrix usually don't agree. Arrange for a thorough display
29710 if (w
->must_be_updated_p
)
29712 SET_FRAME_GARBAGED (f
);
29716 /* Frame-relative pixel rectangle of W. */
29717 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
29718 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
29719 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
29720 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
29722 if (x_intersect_rectangles (fr
, &wr
, &r
))
29724 int yb
= window_text_bottom_y (w
);
29725 struct glyph_row
*row
;
29726 int cursor_cleared_p
, phys_cursor_on_p
;
29727 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
29729 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
29730 r
.x
, r
.y
, r
.width
, r
.height
));
29732 /* Convert to window coordinates. */
29733 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
29734 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
29736 /* Turn off the cursor. */
29737 if (!w
->pseudo_window_p
29738 && phys_cursor_in_rect_p (w
, &r
))
29740 x_clear_cursor (w
);
29741 cursor_cleared_p
= 1;
29744 cursor_cleared_p
= 0;
29746 /* If the row containing the cursor extends face to end of line,
29747 then expose_area might overwrite the cursor outside the
29748 rectangle and thus notice_overwritten_cursor might clear
29749 w->phys_cursor_on_p. We remember the original value and
29750 check later if it is changed. */
29751 phys_cursor_on_p
= w
->phys_cursor_on_p
;
29753 /* Update lines intersecting rectangle R. */
29754 first_overlapping_row
= last_overlapping_row
= NULL
;
29755 for (row
= w
->current_matrix
->rows
;
29760 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
29762 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
29763 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
29764 || (r
.y
>= y0
&& r
.y
< y1
)
29765 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
29767 /* A header line may be overlapping, but there is no need
29768 to fix overlapping areas for them. KFS 2005-02-12 */
29769 if (row
->overlapping_p
&& !row
->mode_line_p
)
29771 if (first_overlapping_row
== NULL
)
29772 first_overlapping_row
= row
;
29773 last_overlapping_row
= row
;
29777 if (expose_line (w
, row
, &r
))
29778 mouse_face_overwritten_p
= 1;
29781 else if (row
->overlapping_p
)
29783 /* We must redraw a row overlapping the exposed area. */
29785 ? y0
+ row
->phys_height
> r
.y
29786 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
29788 if (first_overlapping_row
== NULL
)
29789 first_overlapping_row
= row
;
29790 last_overlapping_row
= row
;
29798 /* Display the mode line if there is one. */
29799 if (WINDOW_WANTS_MODELINE_P (w
)
29800 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
29802 && row
->y
< r
.y
+ r
.height
)
29804 if (expose_line (w
, row
, &r
))
29805 mouse_face_overwritten_p
= 1;
29808 if (!w
->pseudo_window_p
)
29810 /* Fix the display of overlapping rows. */
29811 if (first_overlapping_row
)
29812 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
29815 /* Draw border between windows. */
29816 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
29817 x_draw_right_divider (w
);
29819 x_draw_vertical_border (w
);
29821 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
29822 x_draw_bottom_divider (w
);
29824 /* Turn the cursor on again. */
29825 if (cursor_cleared_p
29826 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
29827 update_window_cursor (w
, 1);
29831 return mouse_face_overwritten_p
;
29836 /* Redraw (parts) of all windows in the window tree rooted at W that
29837 intersect R. R contains frame pixel coordinates. Value is
29838 non-zero if the exposure overwrites mouse-face. */
29841 expose_window_tree (struct window
*w
, XRectangle
*r
)
29843 struct frame
*f
= XFRAME (w
->frame
);
29844 int mouse_face_overwritten_p
= 0;
29846 while (w
&& !FRAME_GARBAGED_P (f
))
29848 if (WINDOWP (w
->contents
))
29849 mouse_face_overwritten_p
29850 |= expose_window_tree (XWINDOW (w
->contents
), r
);
29852 mouse_face_overwritten_p
|= expose_window (w
, r
);
29854 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
29857 return mouse_face_overwritten_p
;
29862 Redisplay an exposed area of frame F. X and Y are the upper-left
29863 corner of the exposed rectangle. W and H are width and height of
29864 the exposed area. All are pixel values. W or H zero means redraw
29865 the entire frame. */
29868 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
29871 int mouse_face_overwritten_p
= 0;
29873 TRACE ((stderr
, "expose_frame "));
29875 /* No need to redraw if frame will be redrawn soon. */
29876 if (FRAME_GARBAGED_P (f
))
29878 TRACE ((stderr
, " garbaged\n"));
29882 /* If basic faces haven't been realized yet, there is no point in
29883 trying to redraw anything. This can happen when we get an expose
29884 event while Emacs is starting, e.g. by moving another window. */
29885 if (FRAME_FACE_CACHE (f
) == NULL
29886 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
29888 TRACE ((stderr
, " no faces\n"));
29892 if (w
== 0 || h
== 0)
29895 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
29896 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
29906 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
29907 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
29909 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
29910 if (WINDOWP (f
->tool_bar_window
))
29911 mouse_face_overwritten_p
29912 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
29915 #ifdef HAVE_X_WINDOWS
29917 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
29918 if (WINDOWP (f
->menu_bar_window
))
29919 mouse_face_overwritten_p
29920 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
29921 #endif /* not USE_X_TOOLKIT and not USE_GTK */
29925 /* Some window managers support a focus-follows-mouse style with
29926 delayed raising of frames. Imagine a partially obscured frame,
29927 and moving the mouse into partially obscured mouse-face on that
29928 frame. The visible part of the mouse-face will be highlighted,
29929 then the WM raises the obscured frame. With at least one WM, KDE
29930 2.1, Emacs is not getting any event for the raising of the frame
29931 (even tried with SubstructureRedirectMask), only Expose events.
29932 These expose events will draw text normally, i.e. not
29933 highlighted. Which means we must redo the highlight here.
29934 Subsume it under ``we love X''. --gerd 2001-08-15 */
29935 /* Included in Windows version because Windows most likely does not
29936 do the right thing if any third party tool offers
29937 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
29938 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
29940 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29941 if (f
== hlinfo
->mouse_face_mouse_frame
)
29943 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
29944 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
29945 clear_mouse_face (hlinfo
);
29946 note_mouse_highlight (f
, mouse_x
, mouse_y
);
29953 Determine the intersection of two rectangles R1 and R2. Return
29954 the intersection in *RESULT. Value is non-zero if RESULT is not
29958 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
29960 XRectangle
*left
, *right
;
29961 XRectangle
*upper
, *lower
;
29962 int intersection_p
= 0;
29964 /* Rearrange so that R1 is the left-most rectangle. */
29966 left
= r1
, right
= r2
;
29968 left
= r2
, right
= r1
;
29970 /* X0 of the intersection is right.x0, if this is inside R1,
29971 otherwise there is no intersection. */
29972 if (right
->x
<= left
->x
+ left
->width
)
29974 result
->x
= right
->x
;
29976 /* The right end of the intersection is the minimum of
29977 the right ends of left and right. */
29978 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
29981 /* Same game for Y. */
29983 upper
= r1
, lower
= r2
;
29985 upper
= r2
, lower
= r1
;
29987 /* The upper end of the intersection is lower.y0, if this is inside
29988 of upper. Otherwise, there is no intersection. */
29989 if (lower
->y
<= upper
->y
+ upper
->height
)
29991 result
->y
= lower
->y
;
29993 /* The lower end of the intersection is the minimum of the lower
29994 ends of upper and lower. */
29995 result
->height
= (min (lower
->y
+ lower
->height
,
29996 upper
->y
+ upper
->height
)
29998 intersection_p
= 1;
30002 return intersection_p
;
30005 #endif /* HAVE_WINDOW_SYSTEM */
30008 /***********************************************************************
30010 ***********************************************************************/
30013 syms_of_xdisp (void)
30015 Vwith_echo_area_save_vector
= Qnil
;
30016 staticpro (&Vwith_echo_area_save_vector
);
30018 Vmessage_stack
= Qnil
;
30019 staticpro (&Vmessage_stack
);
30021 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30022 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30024 message_dolog_marker1
= Fmake_marker ();
30025 staticpro (&message_dolog_marker1
);
30026 message_dolog_marker2
= Fmake_marker ();
30027 staticpro (&message_dolog_marker2
);
30028 message_dolog_marker3
= Fmake_marker ();
30029 staticpro (&message_dolog_marker3
);
30032 defsubr (&Sdump_frame_glyph_matrix
);
30033 defsubr (&Sdump_glyph_matrix
);
30034 defsubr (&Sdump_glyph_row
);
30035 defsubr (&Sdump_tool_bar_row
);
30036 defsubr (&Strace_redisplay
);
30037 defsubr (&Strace_to_stderr
);
30039 #ifdef HAVE_WINDOW_SYSTEM
30040 defsubr (&Stool_bar_height
);
30041 defsubr (&Slookup_image_map
);
30043 defsubr (&Sline_pixel_height
);
30044 defsubr (&Sformat_mode_line
);
30045 defsubr (&Sinvisible_p
);
30046 defsubr (&Scurrent_bidi_paragraph_direction
);
30047 defsubr (&Swindow_text_pixel_size
);
30048 defsubr (&Smove_point_visually
);
30050 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30051 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30052 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30053 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30054 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30055 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30056 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30057 DEFSYM (Qeval
, "eval");
30058 DEFSYM (QCdata
, ":data");
30059 DEFSYM (Qdisplay
, "display");
30060 DEFSYM (Qspace_width
, "space-width");
30061 DEFSYM (Qraise
, "raise");
30062 DEFSYM (Qslice
, "slice");
30063 DEFSYM (Qspace
, "space");
30064 DEFSYM (Qmargin
, "margin");
30065 DEFSYM (Qpointer
, "pointer");
30066 DEFSYM (Qleft_margin
, "left-margin");
30067 DEFSYM (Qright_margin
, "right-margin");
30068 DEFSYM (Qcenter
, "center");
30069 DEFSYM (Qline_height
, "line-height");
30070 DEFSYM (QCalign_to
, ":align-to");
30071 DEFSYM (QCrelative_width
, ":relative-width");
30072 DEFSYM (QCrelative_height
, ":relative-height");
30073 DEFSYM (QCeval
, ":eval");
30074 DEFSYM (QCpropertize
, ":propertize");
30075 DEFSYM (QCfile
, ":file");
30076 DEFSYM (Qfontified
, "fontified");
30077 DEFSYM (Qfontification_functions
, "fontification-functions");
30078 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30079 DEFSYM (Qescape_glyph
, "escape-glyph");
30080 DEFSYM (Qnobreak_space
, "nobreak-space");
30081 DEFSYM (Qimage
, "image");
30082 DEFSYM (Qtext
, "text");
30083 DEFSYM (Qboth
, "both");
30084 DEFSYM (Qboth_horiz
, "both-horiz");
30085 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30086 DEFSYM (QCmap
, ":map");
30087 DEFSYM (QCpointer
, ":pointer");
30088 DEFSYM (Qrect
, "rect");
30089 DEFSYM (Qcircle
, "circle");
30090 DEFSYM (Qpoly
, "poly");
30091 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
30092 DEFSYM (Qgrow_only
, "grow-only");
30093 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30094 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30095 DEFSYM (Qposition
, "position");
30096 DEFSYM (Qbuffer_position
, "buffer-position");
30097 DEFSYM (Qobject
, "object");
30098 DEFSYM (Qbar
, "bar");
30099 DEFSYM (Qhbar
, "hbar");
30100 DEFSYM (Qbox
, "box");
30101 DEFSYM (Qhollow
, "hollow");
30102 DEFSYM (Qhand
, "hand");
30103 DEFSYM (Qarrow
, "arrow");
30104 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30106 list_of_error
= list1 (list2 (intern_c_string ("error"),
30107 intern_c_string ("void-variable")));
30108 staticpro (&list_of_error
);
30110 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30111 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30112 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30113 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30115 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30116 staticpro (&echo_buffer
[0]);
30117 staticpro (&echo_buffer
[1]);
30119 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30120 staticpro (&echo_area_buffer
[0]);
30121 staticpro (&echo_area_buffer
[1]);
30123 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30124 staticpro (&Vmessages_buffer_name
);
30126 mode_line_proptrans_alist
= Qnil
;
30127 staticpro (&mode_line_proptrans_alist
);
30128 mode_line_string_list
= Qnil
;
30129 staticpro (&mode_line_string_list
);
30130 mode_line_string_face
= Qnil
;
30131 staticpro (&mode_line_string_face
);
30132 mode_line_string_face_prop
= Qnil
;
30133 staticpro (&mode_line_string_face_prop
);
30134 Vmode_line_unwind_vector
= Qnil
;
30135 staticpro (&Vmode_line_unwind_vector
);
30137 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30139 help_echo_string
= Qnil
;
30140 staticpro (&help_echo_string
);
30141 help_echo_object
= Qnil
;
30142 staticpro (&help_echo_object
);
30143 help_echo_window
= Qnil
;
30144 staticpro (&help_echo_window
);
30145 previous_help_echo_string
= Qnil
;
30146 staticpro (&previous_help_echo_string
);
30147 help_echo_pos
= -1;
30149 DEFSYM (Qright_to_left
, "right-to-left");
30150 DEFSYM (Qleft_to_right
, "left-to-right");
30152 #ifdef HAVE_WINDOW_SYSTEM
30153 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30154 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30155 For example, if a block cursor is over a tab, it will be drawn as
30156 wide as that tab on the display. */);
30157 x_stretch_cursor_p
= 0;
30160 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30161 doc
: /* Non-nil means highlight trailing whitespace.
30162 The face used for trailing whitespace is `trailing-whitespace'. */);
30163 Vshow_trailing_whitespace
= Qnil
;
30165 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30166 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30167 If the value is t, Emacs highlights non-ASCII chars which have the
30168 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30169 or `escape-glyph' face respectively.
30171 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30172 U+2011 (non-breaking hyphen) are affected.
30174 Any other non-nil value means to display these characters as a escape
30175 glyph followed by an ordinary space or hyphen.
30177 A value of nil means no special handling of these characters. */);
30178 Vnobreak_char_display
= Qt
;
30180 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30181 doc
: /* The pointer shape to show in void text areas.
30182 A value of nil means to show the text pointer. Other options are `arrow',
30183 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
30184 Vvoid_text_area_pointer
= Qarrow
;
30186 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30187 doc
: /* Non-nil means don't actually do any redisplay.
30188 This is used for internal purposes. */);
30189 Vinhibit_redisplay
= Qnil
;
30191 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30192 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30193 Vglobal_mode_string
= Qnil
;
30195 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30196 doc
: /* Marker for where to display an arrow on top of the buffer text.
30197 This must be the beginning of a line in order to work.
30198 See also `overlay-arrow-string'. */);
30199 Voverlay_arrow_position
= Qnil
;
30201 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30202 doc
: /* String to display as an arrow in non-window frames.
30203 See also `overlay-arrow-position'. */);
30204 Voverlay_arrow_string
= build_pure_c_string ("=>");
30206 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30207 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30208 The symbols on this list are examined during redisplay to determine
30209 where to display overlay arrows. */);
30210 Voverlay_arrow_variable_list
30211 = list1 (intern_c_string ("overlay-arrow-position"));
30213 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30214 doc
: /* The number of lines to try scrolling a window by when point moves out.
30215 If that fails to bring point back on frame, point is centered instead.
30216 If this is zero, point is always centered after it moves off frame.
30217 If you want scrolling to always be a line at a time, you should set
30218 `scroll-conservatively' to a large value rather than set this to 1. */);
30220 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30221 doc
: /* Scroll up to this many lines, to bring point back on screen.
30222 If point moves off-screen, redisplay will scroll by up to
30223 `scroll-conservatively' lines in order to bring point just barely
30224 onto the screen again. If that cannot be done, then redisplay
30225 recenters point as usual.
30227 If the value is greater than 100, redisplay will never recenter point,
30228 but will always scroll just enough text to bring point into view, even
30229 if you move far away.
30231 A value of zero means always recenter point if it moves off screen. */);
30232 scroll_conservatively
= 0;
30234 DEFVAR_INT ("scroll-margin", scroll_margin
,
30235 doc
: /* Number of lines of margin at the top and bottom of a window.
30236 Recenter the window whenever point gets within this many lines
30237 of the top or bottom of the window. */);
30240 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
30241 doc
: /* Pixels per inch value for non-window system displays.
30242 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30243 Vdisplay_pixels_per_inch
= make_float (72.0);
30246 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
30249 DEFVAR_LISP ("truncate-partial-width-windows",
30250 Vtruncate_partial_width_windows
,
30251 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
30252 For an integer value, truncate lines in each window narrower than the
30253 full frame width, provided the window width is less than that integer;
30254 otherwise, respect the value of `truncate-lines'.
30256 For any other non-nil value, truncate lines in all windows that do
30257 not span the full frame width.
30259 A value of nil means to respect the value of `truncate-lines'.
30261 If `word-wrap' is enabled, you might want to reduce this. */);
30262 Vtruncate_partial_width_windows
= make_number (50);
30264 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
30265 doc
: /* Maximum buffer size for which line number should be displayed.
30266 If the buffer is bigger than this, the line number does not appear
30267 in the mode line. A value of nil means no limit. */);
30268 Vline_number_display_limit
= Qnil
;
30270 DEFVAR_INT ("line-number-display-limit-width",
30271 line_number_display_limit_width
,
30272 doc
: /* Maximum line width (in characters) for line number display.
30273 If the average length of the lines near point is bigger than this, then the
30274 line number may be omitted from the mode line. */);
30275 line_number_display_limit_width
= 200;
30277 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
30278 doc
: /* Non-nil means highlight region even in nonselected windows. */);
30279 highlight_nonselected_windows
= 0;
30281 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
30282 doc
: /* Non-nil if more than one frame is visible on this display.
30283 Minibuffer-only frames don't count, but iconified frames do.
30284 This variable is not guaranteed to be accurate except while processing
30285 `frame-title-format' and `icon-title-format'. */);
30287 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
30288 doc
: /* Template for displaying the title bar of visible frames.
30289 \(Assuming the window manager supports this feature.)
30291 This variable has the same structure as `mode-line-format', except that
30292 the %c and %l constructs are ignored. It is used only on frames for
30293 which no explicit name has been set \(see `modify-frame-parameters'). */);
30295 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
30296 doc
: /* Template for displaying the title bar of an iconified frame.
30297 \(Assuming the window manager supports this feature.)
30298 This variable has the same structure as `mode-line-format' (which see),
30299 and is used only on frames for which no explicit name has been set
30300 \(see `modify-frame-parameters'). */);
30302 = Vframe_title_format
30303 = listn (CONSTYPE_PURE
, 3,
30304 intern_c_string ("multiple-frames"),
30305 build_pure_c_string ("%b"),
30306 listn (CONSTYPE_PURE
, 4,
30307 empty_unibyte_string
,
30308 intern_c_string ("invocation-name"),
30309 build_pure_c_string ("@"),
30310 intern_c_string ("system-name")));
30312 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
30313 doc
: /* Maximum number of lines to keep in the message log buffer.
30314 If nil, disable message logging. If t, log messages but don't truncate
30315 the buffer when it becomes large. */);
30316 Vmessage_log_max
= make_number (1000);
30318 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
30319 doc
: /* Functions called before redisplay, if window sizes have changed.
30320 The value should be a list of functions that take one argument.
30321 Just before redisplay, for each frame, if any of its windows have changed
30322 size since the last redisplay, or have been split or deleted,
30323 all the functions in the list are called, with the frame as argument. */);
30324 Vwindow_size_change_functions
= Qnil
;
30326 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
30327 doc
: /* List of functions to call before redisplaying a window with scrolling.
30328 Each function is called with two arguments, the window and its new
30329 display-start position. Note that these functions are also called by
30330 `set-window-buffer'. Also note that the value of `window-end' is not
30331 valid when these functions are called.
30333 Warning: Do not use this feature to alter the way the window
30334 is scrolled. It is not designed for that, and such use probably won't
30336 Vwindow_scroll_functions
= Qnil
;
30338 DEFVAR_LISP ("window-text-change-functions",
30339 Vwindow_text_change_functions
,
30340 doc
: /* Functions to call in redisplay when text in the window might change. */);
30341 Vwindow_text_change_functions
= Qnil
;
30343 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
30344 doc
: /* Functions called when redisplay of a window reaches the end trigger.
30345 Each function is called with two arguments, the window and the end trigger value.
30346 See `set-window-redisplay-end-trigger'. */);
30347 Vredisplay_end_trigger_functions
= Qnil
;
30349 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
30350 doc
: /* Non-nil means autoselect window with mouse pointer.
30351 If nil, do not autoselect windows.
30352 A positive number means delay autoselection by that many seconds: a
30353 window is autoselected only after the mouse has remained in that
30354 window for the duration of the delay.
30355 A negative number has a similar effect, but causes windows to be
30356 autoselected only after the mouse has stopped moving. \(Because of
30357 the way Emacs compares mouse events, you will occasionally wait twice
30358 that time before the window gets selected.\)
30359 Any other value means to autoselect window instantaneously when the
30360 mouse pointer enters it.
30362 Autoselection selects the minibuffer only if it is active, and never
30363 unselects the minibuffer if it is active.
30365 When customizing this variable make sure that the actual value of
30366 `focus-follows-mouse' matches the behavior of your window manager. */);
30367 Vmouse_autoselect_window
= Qnil
;
30369 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
30370 doc
: /* Non-nil means automatically resize tool-bars.
30371 This dynamically changes the tool-bar's height to the minimum height
30372 that is needed to make all tool-bar items visible.
30373 If value is `grow-only', the tool-bar's height is only increased
30374 automatically; to decrease the tool-bar height, use \\[recenter]. */);
30375 Vauto_resize_tool_bars
= Qt
;
30377 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
30378 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
30379 auto_raise_tool_bar_buttons_p
= 1;
30381 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
30382 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
30383 make_cursor_line_fully_visible_p
= 1;
30385 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
30386 doc
: /* Border below tool-bar in pixels.
30387 If an integer, use it as the height of the border.
30388 If it is one of `internal-border-width' or `border-width', use the
30389 value of the corresponding frame parameter.
30390 Otherwise, no border is added below the tool-bar. */);
30391 Vtool_bar_border
= Qinternal_border_width
;
30393 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
30394 doc
: /* Margin around tool-bar buttons in pixels.
30395 If an integer, use that for both horizontal and vertical margins.
30396 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
30397 HORZ specifying the horizontal margin, and VERT specifying the
30398 vertical margin. */);
30399 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
30401 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
30402 doc
: /* Relief thickness of tool-bar buttons. */);
30403 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
30405 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
30406 doc
: /* Tool bar style to use.
30408 image - show images only
30409 text - show text only
30410 both - show both, text below image
30411 both-horiz - show text to the right of the image
30412 text-image-horiz - show text to the left of the image
30413 any other - use system default or image if no system default.
30415 This variable only affects the GTK+ toolkit version of Emacs. */);
30416 Vtool_bar_style
= Qnil
;
30418 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
30419 doc
: /* Maximum number of characters a label can have to be shown.
30420 The tool bar style must also show labels for this to have any effect, see
30421 `tool-bar-style'. */);
30422 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
30424 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
30425 doc
: /* List of functions to call to fontify regions of text.
30426 Each function is called with one argument POS. Functions must
30427 fontify a region starting at POS in the current buffer, and give
30428 fontified regions the property `fontified'. */);
30429 Vfontification_functions
= Qnil
;
30430 Fmake_variable_buffer_local (Qfontification_functions
);
30432 DEFVAR_BOOL ("unibyte-display-via-language-environment",
30433 unibyte_display_via_language_environment
,
30434 doc
: /* Non-nil means display unibyte text according to language environment.
30435 Specifically, this means that raw bytes in the range 160-255 decimal
30436 are displayed by converting them to the equivalent multibyte characters
30437 according to the current language environment. As a result, they are
30438 displayed according to the current fontset.
30440 Note that this variable affects only how these bytes are displayed,
30441 but does not change the fact they are interpreted as raw bytes. */);
30442 unibyte_display_via_language_environment
= 0;
30444 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
30445 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
30446 If a float, it specifies a fraction of the mini-window frame's height.
30447 If an integer, it specifies a number of lines. */);
30448 Vmax_mini_window_height
= make_float (0.25);
30450 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
30451 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
30452 A value of nil means don't automatically resize mini-windows.
30453 A value of t means resize them to fit the text displayed in them.
30454 A value of `grow-only', the default, means let mini-windows grow only;
30455 they return to their normal size when the minibuffer is closed, or the
30456 echo area becomes empty. */);
30457 Vresize_mini_windows
= Qgrow_only
;
30459 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
30460 doc
: /* Alist specifying how to blink the cursor off.
30461 Each element has the form (ON-STATE . OFF-STATE). Whenever the
30462 `cursor-type' frame-parameter or variable equals ON-STATE,
30463 comparing using `equal', Emacs uses OFF-STATE to specify
30464 how to blink it off. ON-STATE and OFF-STATE are values for
30465 the `cursor-type' frame parameter.
30467 If a frame's ON-STATE has no entry in this list,
30468 the frame's other specifications determine how to blink the cursor off. */);
30469 Vblink_cursor_alist
= Qnil
;
30471 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
30472 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
30473 If non-nil, windows are automatically scrolled horizontally to make
30474 point visible. */);
30475 automatic_hscrolling_p
= 1;
30476 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
30478 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
30479 doc
: /* How many columns away from the window edge point is allowed to get
30480 before automatic hscrolling will horizontally scroll the window. */);
30481 hscroll_margin
= 5;
30483 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
30484 doc
: /* How many columns to scroll the window when point gets too close to the edge.
30485 When point is less than `hscroll-margin' columns from the window
30486 edge, automatic hscrolling will scroll the window by the amount of columns
30487 determined by this variable. If its value is a positive integer, scroll that
30488 many columns. If it's a positive floating-point number, it specifies the
30489 fraction of the window's width to scroll. If it's nil or zero, point will be
30490 centered horizontally after the scroll. Any other value, including negative
30491 numbers, are treated as if the value were zero.
30493 Automatic hscrolling always moves point outside the scroll margin, so if
30494 point was more than scroll step columns inside the margin, the window will
30495 scroll more than the value given by the scroll step.
30497 Note that the lower bound for automatic hscrolling specified by `scroll-left'
30498 and `scroll-right' overrides this variable's effect. */);
30499 Vhscroll_step
= make_number (0);
30501 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
30502 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
30503 Bind this around calls to `message' to let it take effect. */);
30504 message_truncate_lines
= 0;
30506 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
30507 doc
: /* Normal hook run to update the menu bar definitions.
30508 Redisplay runs this hook before it redisplays the menu bar.
30509 This is used to update menus such as Buffers, whose contents depend on
30511 Vmenu_bar_update_hook
= Qnil
;
30513 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
30514 doc
: /* Frame for which we are updating a menu.
30515 The enable predicate for a menu binding should check this variable. */);
30516 Vmenu_updating_frame
= Qnil
;
30518 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
30519 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
30520 inhibit_menubar_update
= 0;
30522 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
30523 doc
: /* Prefix prepended to all continuation lines at display time.
30524 The value may be a string, an image, or a stretch-glyph; it is
30525 interpreted in the same way as the value of a `display' text property.
30527 This variable is overridden by any `wrap-prefix' text or overlay
30530 To add a prefix to non-continuation lines, use `line-prefix'. */);
30531 Vwrap_prefix
= Qnil
;
30532 DEFSYM (Qwrap_prefix
, "wrap-prefix");
30533 Fmake_variable_buffer_local (Qwrap_prefix
);
30535 DEFVAR_LISP ("line-prefix", Vline_prefix
,
30536 doc
: /* Prefix prepended to all non-continuation lines at display time.
30537 The value may be a string, an image, or a stretch-glyph; it is
30538 interpreted in the same way as the value of a `display' text property.
30540 This variable is overridden by any `line-prefix' text or overlay
30543 To add a prefix to continuation lines, use `wrap-prefix'. */);
30544 Vline_prefix
= Qnil
;
30545 DEFSYM (Qline_prefix
, "line-prefix");
30546 Fmake_variable_buffer_local (Qline_prefix
);
30548 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
30549 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
30550 inhibit_eval_during_redisplay
= 0;
30552 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
30553 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
30554 inhibit_free_realized_faces
= 0;
30557 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
30558 doc
: /* Inhibit try_window_id display optimization. */);
30559 inhibit_try_window_id
= 0;
30561 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
30562 doc
: /* Inhibit try_window_reusing display optimization. */);
30563 inhibit_try_window_reusing
= 0;
30565 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
30566 doc
: /* Inhibit try_cursor_movement display optimization. */);
30567 inhibit_try_cursor_movement
= 0;
30568 #endif /* GLYPH_DEBUG */
30570 DEFVAR_INT ("overline-margin", overline_margin
,
30571 doc
: /* Space between overline and text, in pixels.
30572 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
30573 margin to the character height. */);
30574 overline_margin
= 2;
30576 DEFVAR_INT ("underline-minimum-offset",
30577 underline_minimum_offset
,
30578 doc
: /* Minimum distance between baseline and underline.
30579 This can improve legibility of underlined text at small font sizes,
30580 particularly when using variable `x-use-underline-position-properties'
30581 with fonts that specify an UNDERLINE_POSITION relatively close to the
30582 baseline. The default value is 1. */);
30583 underline_minimum_offset
= 1;
30585 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
30586 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
30587 This feature only works when on a window system that can change
30588 cursor shapes. */);
30589 display_hourglass_p
= 1;
30591 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
30592 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
30593 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
30595 #ifdef HAVE_WINDOW_SYSTEM
30596 hourglass_atimer
= NULL
;
30597 hourglass_shown_p
= 0;
30598 #endif /* HAVE_WINDOW_SYSTEM */
30600 DEFSYM (Qglyphless_char
, "glyphless-char");
30601 DEFSYM (Qhex_code
, "hex-code");
30602 DEFSYM (Qempty_box
, "empty-box");
30603 DEFSYM (Qthin_space
, "thin-space");
30604 DEFSYM (Qzero_width
, "zero-width");
30606 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
30607 doc
: /* Function run just before redisplay.
30608 It is called with one argument, which is the set of windows that are to
30609 be redisplayed. This set can be nil (meaning, only the selected window),
30610 or t (meaning all windows). */);
30611 Vpre_redisplay_function
= intern ("ignore");
30613 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
30614 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
30616 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
30617 doc
: /* Char-table defining glyphless characters.
30618 Each element, if non-nil, should be one of the following:
30619 an ASCII acronym string: display this string in a box
30620 `hex-code': display the hexadecimal code of a character in a box
30621 `empty-box': display as an empty box
30622 `thin-space': display as 1-pixel width space
30623 `zero-width': don't display
30624 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
30625 display method for graphical terminals and text terminals respectively.
30626 GRAPHICAL and TEXT should each have one of the values listed above.
30628 The char-table has one extra slot to control the display of a character for
30629 which no font is found. This slot only takes effect on graphical terminals.
30630 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
30631 `thin-space'. The default is `empty-box'.
30633 If a character has a non-nil entry in an active display table, the
30634 display table takes effect; in this case, Emacs does not consult
30635 `glyphless-char-display' at all. */);
30636 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
30637 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
30640 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
30641 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
30642 Vdebug_on_message
= Qnil
;
30644 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
30646 Vredisplay__all_windows_cause
30647 = Fmake_vector (make_number (100), make_number (0));
30649 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
30651 Vredisplay__mode_lines_cause
30652 = Fmake_vector (make_number (100), make_number (0));
30656 /* Initialize this module when Emacs starts. */
30661 CHARPOS (this_line_start_pos
) = 0;
30663 if (!noninteractive
)
30665 struct window
*m
= XWINDOW (minibuf_window
);
30666 Lisp_Object frame
= m
->frame
;
30667 struct frame
*f
= XFRAME (frame
);
30668 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
30669 struct window
*r
= XWINDOW (root
);
30672 echo_area_window
= minibuf_window
;
30674 r
->top_line
= FRAME_TOP_MARGIN (f
);
30675 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
30676 r
->total_cols
= FRAME_COLS (f
);
30677 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30678 r
->total_lines
= FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
30679 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
30681 m
->top_line
= FRAME_LINES (f
) - 1;
30682 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
30683 m
->total_cols
= FRAME_COLS (f
);
30684 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30685 m
->total_lines
= 1;
30686 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
30688 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
30689 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
30690 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
30692 /* The default ellipsis glyphs `...'. */
30693 for (i
= 0; i
< 3; ++i
)
30694 default_invis_vector
[i
] = make_number ('.');
30698 /* Allocate the buffer for frame titles.
30699 Also used for `format-mode-line'. */
30701 mode_line_noprop_buf
= xmalloc (size
);
30702 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
30703 mode_line_noprop_ptr
= mode_line_noprop_buf
;
30704 mode_line_target
= MODE_LINE_DISPLAY
;
30707 help_echo_showing_p
= 0;
30710 #ifdef HAVE_WINDOW_SYSTEM
30712 /* Platform-independent portion of hourglass implementation. */
30714 /* Cancel a currently active hourglass timer, and start a new one. */
30716 start_hourglass (void)
30718 struct timespec delay
;
30720 cancel_hourglass ();
30722 if (INTEGERP (Vhourglass_delay
)
30723 && XINT (Vhourglass_delay
) > 0)
30724 delay
= make_timespec (min (XINT (Vhourglass_delay
),
30725 TYPE_MAXIMUM (time_t)),
30727 else if (FLOATP (Vhourglass_delay
)
30728 && XFLOAT_DATA (Vhourglass_delay
) > 0)
30729 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
30731 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
30735 extern void w32_note_current_window (void);
30736 w32_note_current_window ();
30738 #endif /* HAVE_NTGUI */
30740 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
30741 show_hourglass
, NULL
);
30745 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
30748 cancel_hourglass (void)
30750 if (hourglass_atimer
)
30752 cancel_atimer (hourglass_atimer
);
30753 hourglass_atimer
= NULL
;
30756 if (hourglass_shown_p
)
30760 #endif /* HAVE_WINDOW_SYSTEM */