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
->stop_charpos
= charpos
;
3038 it
->end_charpos
= ZV
;
3039 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
3040 IT_CHARPOS (*it
) = charpos
;
3041 IT_BYTEPOS (*it
) = bytepos
;
3043 /* We will rely on `reseat' to set this up properly, via
3044 handle_face_prop. */
3045 it
->face_id
= it
->base_face_id
;
3047 it
->start
= it
->current
;
3048 /* Do we need to reorder bidirectional text? Not if this is a
3049 unibyte buffer: by definition, none of the single-byte
3050 characters are strong R2L, so no reordering is needed. And
3051 bidi.c doesn't support unibyte buffers anyway. Also, don't
3052 reorder while we are loading loadup.el, since the tables of
3053 character properties needed for reordering are not yet
3057 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
3060 /* If we are to reorder bidirectional text, init the bidi
3064 /* Note the paragraph direction that this buffer wants to
3066 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
3068 it
->paragraph_embedding
= L2R
;
3069 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
3071 it
->paragraph_embedding
= R2L
;
3073 it
->paragraph_embedding
= NEUTRAL_DIR
;
3074 bidi_unshelve_cache (NULL
, 0);
3075 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
3079 /* Compute faces etc. */
3080 reseat (it
, it
->current
.pos
, 1);
3087 /* Initialize IT for the display of window W with window start POS. */
3090 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
3092 struct glyph_row
*row
;
3093 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
3095 row
= w
->desired_matrix
->rows
+ first_vpos
;
3096 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
3097 it
->first_vpos
= first_vpos
;
3099 /* Don't reseat to previous visible line start if current start
3100 position is in a string or image. */
3101 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
3103 int start_at_line_beg_p
;
3104 int first_y
= it
->current_y
;
3106 /* If window start is not at a line start, skip forward to POS to
3107 get the correct continuation lines width. */
3108 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
3109 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
3110 if (!start_at_line_beg_p
)
3114 reseat_at_previous_visible_line_start (it
);
3115 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
3117 new_x
= it
->current_x
+ it
->pixel_width
;
3119 /* If lines are continued, this line may end in the middle
3120 of a multi-glyph character (e.g. a control character
3121 displayed as \003, or in the middle of an overlay
3122 string). In this case move_it_to above will not have
3123 taken us to the start of the continuation line but to the
3124 end of the continued line. */
3125 if (it
->current_x
> 0
3126 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
3127 && (/* And glyph doesn't fit on the line. */
3128 new_x
> it
->last_visible_x
3129 /* Or it fits exactly and we're on a window
3131 || (new_x
== it
->last_visible_x
3132 && FRAME_WINDOW_P (it
->f
)
3133 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
3134 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
3135 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
3137 if ((it
->current
.dpvec_index
>= 0
3138 || it
->current
.overlay_string_index
>= 0)
3139 /* If we are on a newline from a display vector or
3140 overlay string, then we are already at the end of
3141 a screen line; no need to go to the next line in
3142 that case, as this line is not really continued.
3143 (If we do go to the next line, C-e will not DTRT.) */
3146 set_iterator_to_next (it
, 1);
3147 move_it_in_display_line_to (it
, -1, -1, 0);
3150 it
->continuation_lines_width
+= it
->current_x
;
3152 /* If the character at POS is displayed via a display
3153 vector, move_it_to above stops at the final glyph of
3154 IT->dpvec. To make the caller redisplay that character
3155 again (a.k.a. start at POS), we need to reset the
3156 dpvec_index to the beginning of IT->dpvec. */
3157 else if (it
->current
.dpvec_index
>= 0)
3158 it
->current
.dpvec_index
= 0;
3160 /* We're starting a new display line, not affected by the
3161 height of the continued line, so clear the appropriate
3162 fields in the iterator structure. */
3163 it
->max_ascent
= it
->max_descent
= 0;
3164 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3166 it
->current_y
= first_y
;
3168 it
->current_x
= it
->hpos
= 0;
3174 /* Return 1 if POS is a position in ellipses displayed for invisible
3175 text. W is the window we display, for text property lookup. */
3178 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3180 Lisp_Object prop
, window
;
3182 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3184 /* If POS specifies a position in a display vector, this might
3185 be for an ellipsis displayed for invisible text. We won't
3186 get the iterator set up for delivering that ellipsis unless
3187 we make sure that it gets aware of the invisible text. */
3188 if (pos
->dpvec_index
>= 0
3189 && pos
->overlay_string_index
< 0
3190 && CHARPOS (pos
->string_pos
) < 0
3192 && (XSETWINDOW (window
, w
),
3193 prop
= Fget_char_property (make_number (charpos
),
3194 Qinvisible
, window
),
3195 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
3197 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3199 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3206 /* Initialize IT for stepping through current_buffer in window W,
3207 starting at position POS that includes overlay string and display
3208 vector/ control character translation position information. Value
3209 is zero if there are overlay strings with newlines at POS. */
3212 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3214 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3215 int i
, overlay_strings_with_newlines
= 0;
3217 /* If POS specifies a position in a display vector, this might
3218 be for an ellipsis displayed for invisible text. We won't
3219 get the iterator set up for delivering that ellipsis unless
3220 we make sure that it gets aware of the invisible text. */
3221 if (in_ellipses_for_invisible_text_p (pos
, w
))
3227 /* Keep in mind: the call to reseat in init_iterator skips invisible
3228 text, so we might end up at a position different from POS. This
3229 is only a problem when POS is a row start after a newline and an
3230 overlay starts there with an after-string, and the overlay has an
3231 invisible property. Since we don't skip invisible text in
3232 display_line and elsewhere immediately after consuming the
3233 newline before the row start, such a POS will not be in a string,
3234 but the call to init_iterator below will move us to the
3236 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3238 /* This only scans the current chunk -- it should scan all chunks.
3239 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3240 to 16 in 22.1 to make this a lesser problem. */
3241 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3243 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3244 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3246 while (s
< e
&& *s
!= '\n')
3251 overlay_strings_with_newlines
= 1;
3256 /* If position is within an overlay string, set up IT to the right
3258 if (pos
->overlay_string_index
>= 0)
3262 /* If the first overlay string happens to have a `display'
3263 property for an image, the iterator will be set up for that
3264 image, and we have to undo that setup first before we can
3265 correct the overlay string index. */
3266 if (it
->method
== GET_FROM_IMAGE
)
3269 /* We already have the first chunk of overlay strings in
3270 IT->overlay_strings. Load more until the one for
3271 pos->overlay_string_index is in IT->overlay_strings. */
3272 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3274 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3275 it
->current
.overlay_string_index
= 0;
3278 load_overlay_strings (it
, 0);
3279 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3283 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3284 relative_index
= (it
->current
.overlay_string_index
3285 % OVERLAY_STRING_CHUNK_SIZE
);
3286 it
->string
= it
->overlay_strings
[relative_index
];
3287 eassert (STRINGP (it
->string
));
3288 it
->current
.string_pos
= pos
->string_pos
;
3289 it
->method
= GET_FROM_STRING
;
3290 it
->end_charpos
= SCHARS (it
->string
);
3291 /* Set up the bidi iterator for this overlay string. */
3294 it
->bidi_it
.string
.lstring
= it
->string
;
3295 it
->bidi_it
.string
.s
= NULL
;
3296 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3297 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3298 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3299 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3300 it
->bidi_it
.w
= it
->w
;
3301 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3302 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3304 /* Synchronize the state of the bidi iterator with
3305 pos->string_pos. For any string position other than
3306 zero, this will be done automagically when we resume
3307 iteration over the string and get_visually_first_element
3308 is called. But if string_pos is zero, and the string is
3309 to be reordered for display, we need to resync manually,
3310 since it could be that the iteration state recorded in
3311 pos ended at string_pos of 0 moving backwards in string. */
3312 if (CHARPOS (pos
->string_pos
) == 0)
3314 get_visually_first_element (it
);
3315 if (IT_STRING_CHARPOS (*it
) != 0)
3318 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3319 bidi_move_to_visually_next (&it
->bidi_it
);
3320 } while (it
->bidi_it
.charpos
!= 0);
3322 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3323 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3327 if (CHARPOS (pos
->string_pos
) >= 0)
3329 /* Recorded position is not in an overlay string, but in another
3330 string. This can only be a string from a `display' property.
3331 IT should already be filled with that string. */
3332 it
->current
.string_pos
= pos
->string_pos
;
3333 eassert (STRINGP (it
->string
));
3335 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3336 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3339 /* Restore position in display vector translations, control
3340 character translations or ellipses. */
3341 if (pos
->dpvec_index
>= 0)
3343 if (it
->dpvec
== NULL
)
3344 get_next_display_element (it
);
3345 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3346 it
->current
.dpvec_index
= pos
->dpvec_index
;
3350 return !overlay_strings_with_newlines
;
3354 /* Initialize IT for stepping through current_buffer in window W
3355 starting at ROW->start. */
3358 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3360 init_from_display_pos (it
, w
, &row
->start
);
3361 it
->start
= row
->start
;
3362 it
->continuation_lines_width
= row
->continuation_lines_width
;
3367 /* Initialize IT for stepping through current_buffer in window W
3368 starting in the line following ROW, i.e. starting at ROW->end.
3369 Value is zero if there are overlay strings with newlines at ROW's
3373 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3377 if (init_from_display_pos (it
, w
, &row
->end
))
3379 if (row
->continued_p
)
3380 it
->continuation_lines_width
3381 = row
->continuation_lines_width
+ row
->pixel_width
;
3392 /***********************************************************************
3394 ***********************************************************************/
3396 /* Called when IT reaches IT->stop_charpos. Handle text property and
3397 overlay changes. Set IT->stop_charpos to the next position where
3401 handle_stop (struct it
*it
)
3403 enum prop_handled handled
;
3404 int handle_overlay_change_p
;
3408 it
->current
.dpvec_index
= -1;
3409 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3410 it
->ignore_overlay_strings_at_pos_p
= 0;
3413 /* Use face of preceding text for ellipsis (if invisible) */
3414 if (it
->selective_display_ellipsis_p
)
3415 it
->saved_face_id
= it
->face_id
;
3419 handled
= HANDLED_NORMALLY
;
3421 /* Call text property handlers. */
3422 for (p
= it_props
; p
->handler
; ++p
)
3424 handled
= p
->handler (it
);
3426 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3428 else if (handled
== HANDLED_RETURN
)
3430 /* We still want to show before and after strings from
3431 overlays even if the actual buffer text is replaced. */
3432 if (!handle_overlay_change_p
3434 /* Don't call get_overlay_strings_1 if we already
3435 have overlay strings loaded, because doing so
3436 will load them again and push the iterator state
3437 onto the stack one more time, which is not
3438 expected by the rest of the code that processes
3440 || (it
->current
.overlay_string_index
< 0
3441 ? !get_overlay_strings_1 (it
, 0, 0)
3445 setup_for_ellipsis (it
, 0);
3446 /* When handling a display spec, we might load an
3447 empty string. In that case, discard it here. We
3448 used to discard it in handle_single_display_spec,
3449 but that causes get_overlay_strings_1, above, to
3450 ignore overlay strings that we must check. */
3451 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3455 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3459 it
->ignore_overlay_strings_at_pos_p
= true;
3460 it
->string_from_display_prop_p
= 0;
3461 it
->from_disp_prop_p
= 0;
3462 handle_overlay_change_p
= 0;
3464 handled
= HANDLED_RECOMPUTE_PROPS
;
3467 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3468 handle_overlay_change_p
= 0;
3471 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3473 /* Don't check for overlay strings below when set to deliver
3474 characters from a display vector. */
3475 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3476 handle_overlay_change_p
= 0;
3478 /* Handle overlay changes.
3479 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3480 if it finds overlays. */
3481 if (handle_overlay_change_p
)
3482 handled
= handle_overlay_change (it
);
3487 setup_for_ellipsis (it
, 0);
3491 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3493 /* Determine where to stop next. */
3494 if (handled
== HANDLED_NORMALLY
)
3495 compute_stop_pos (it
);
3499 /* Compute IT->stop_charpos from text property and overlay change
3500 information for IT's current position. */
3503 compute_stop_pos (struct it
*it
)
3505 register INTERVAL iv
, next_iv
;
3506 Lisp_Object object
, limit
, position
;
3507 ptrdiff_t charpos
, bytepos
;
3509 if (STRINGP (it
->string
))
3511 /* Strings are usually short, so don't limit the search for
3513 it
->stop_charpos
= it
->end_charpos
;
3514 object
= it
->string
;
3516 charpos
= IT_STRING_CHARPOS (*it
);
3517 bytepos
= IT_STRING_BYTEPOS (*it
);
3523 /* If end_charpos is out of range for some reason, such as a
3524 misbehaving display function, rationalize it (Bug#5984). */
3525 if (it
->end_charpos
> ZV
)
3526 it
->end_charpos
= ZV
;
3527 it
->stop_charpos
= it
->end_charpos
;
3529 /* If next overlay change is in front of the current stop pos
3530 (which is IT->end_charpos), stop there. Note: value of
3531 next_overlay_change is point-max if no overlay change
3533 charpos
= IT_CHARPOS (*it
);
3534 bytepos
= IT_BYTEPOS (*it
);
3535 pos
= next_overlay_change (charpos
);
3536 if (pos
< it
->stop_charpos
)
3537 it
->stop_charpos
= pos
;
3539 /* Set up variables for computing the stop position from text
3540 property changes. */
3541 XSETBUFFER (object
, current_buffer
);
3542 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3545 /* Get the interval containing IT's position. Value is a null
3546 interval if there isn't such an interval. */
3547 position
= make_number (charpos
);
3548 iv
= validate_interval_range (object
, &position
, &position
, 0);
3551 Lisp_Object values_here
[LAST_PROP_IDX
];
3554 /* Get properties here. */
3555 for (p
= it_props
; p
->handler
; ++p
)
3556 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3558 /* Look for an interval following iv that has different
3560 for (next_iv
= next_interval (iv
);
3563 || XFASTINT (limit
) > next_iv
->position
));
3564 next_iv
= next_interval (next_iv
))
3566 for (p
= it_props
; p
->handler
; ++p
)
3568 Lisp_Object new_value
;
3570 new_value
= textget (next_iv
->plist
, *p
->name
);
3571 if (!EQ (values_here
[p
->idx
], new_value
))
3581 if (INTEGERP (limit
)
3582 && next_iv
->position
>= XFASTINT (limit
))
3583 /* No text property change up to limit. */
3584 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3586 /* Text properties change in next_iv. */
3587 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3591 if (it
->cmp_it
.id
< 0)
3593 ptrdiff_t stoppos
= it
->end_charpos
;
3595 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3597 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3598 stoppos
, it
->string
);
3601 eassert (STRINGP (it
->string
)
3602 || (it
->stop_charpos
>= BEGV
3603 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3607 /* Return the position of the next overlay change after POS in
3608 current_buffer. Value is point-max if no overlay change
3609 follows. This is like `next-overlay-change' but doesn't use
3613 next_overlay_change (ptrdiff_t pos
)
3615 ptrdiff_t i
, noverlays
;
3617 Lisp_Object
*overlays
;
3619 /* Get all overlays at the given position. */
3620 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3622 /* If any of these overlays ends before endpos,
3623 use its ending point instead. */
3624 for (i
= 0; i
< noverlays
; ++i
)
3629 oend
= OVERLAY_END (overlays
[i
]);
3630 oendpos
= OVERLAY_POSITION (oend
);
3631 endpos
= min (endpos
, oendpos
);
3637 /* How many characters forward to search for a display property or
3638 display string. Searching too far forward makes the bidi display
3639 sluggish, especially in small windows. */
3640 #define MAX_DISP_SCAN 250
3642 /* Return the character position of a display string at or after
3643 position specified by POSITION. If no display string exists at or
3644 after POSITION, return ZV. A display string is either an overlay
3645 with `display' property whose value is a string, or a `display'
3646 text property whose value is a string. STRING is data about the
3647 string to iterate; if STRING->lstring is nil, we are iterating a
3648 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3649 on a GUI frame. DISP_PROP is set to zero if we searched
3650 MAX_DISP_SCAN characters forward without finding any display
3651 strings, non-zero otherwise. It is set to 2 if the display string
3652 uses any kind of `(space ...)' spec that will produce a stretch of
3653 white space in the text area. */
3655 compute_display_string_pos (struct text_pos
*position
,
3656 struct bidi_string_data
*string
,
3658 int frame_window_p
, int *disp_prop
)
3660 /* OBJECT = nil means current buffer. */
3661 Lisp_Object object
, object1
;
3662 Lisp_Object pos
, spec
, limpos
;
3663 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3664 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3665 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3666 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3668 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3669 struct text_pos tpos
;
3672 if (string
&& STRINGP (string
->lstring
))
3673 object1
= object
= string
->lstring
;
3674 else if (w
&& !string_p
)
3676 XSETWINDOW (object
, w
);
3680 object1
= object
= Qnil
;
3685 /* We don't support display properties whose values are strings
3686 that have display string properties. */
3687 || string
->from_disp_str
3688 /* C strings cannot have display properties. */
3689 || (string
->s
&& !STRINGP (object
)))
3695 /* If the character at CHARPOS is where the display string begins,
3697 pos
= make_number (charpos
);
3698 if (STRINGP (object
))
3699 bufpos
= string
->bufpos
;
3703 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3705 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3708 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3716 /* Look forward for the first character with a `display' property
3717 that will replace the underlying text when displayed. */
3718 limpos
= make_number (lim
);
3720 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3721 CHARPOS (tpos
) = XFASTINT (pos
);
3722 if (CHARPOS (tpos
) >= lim
)
3727 if (STRINGP (object
))
3728 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3730 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3731 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3732 if (!STRINGP (object
))
3733 bufpos
= CHARPOS (tpos
);
3734 } while (NILP (spec
)
3735 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3736 bufpos
, frame_window_p
)));
3740 return CHARPOS (tpos
);
3743 /* Return the character position of the end of the display string that
3744 started at CHARPOS. If there's no display string at CHARPOS,
3745 return -1. A display string is either an overlay with `display'
3746 property whose value is a string or a `display' text property whose
3747 value is a string. */
3749 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3751 /* OBJECT = nil means current buffer. */
3752 Lisp_Object object
=
3753 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3754 Lisp_Object pos
= make_number (charpos
);
3756 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3758 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3761 /* It could happen that the display property or overlay was removed
3762 since we found it in compute_display_string_pos above. One way
3763 this can happen is if JIT font-lock was called (through
3764 handle_fontified_prop), and jit-lock-functions remove text
3765 properties or overlays from the portion of buffer that includes
3766 CHARPOS. Muse mode is known to do that, for example. In this
3767 case, we return -1 to the caller, to signal that no display
3768 string is actually present at CHARPOS. See bidi_fetch_char for
3769 how this is handled.
3771 An alternative would be to never look for display properties past
3772 it->stop_charpos. But neither compute_display_string_pos nor
3773 bidi_fetch_char that calls it know or care where the next
3775 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3778 /* Look forward for the first character where the `display' property
3780 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3782 return XFASTINT (pos
);
3787 /***********************************************************************
3789 ***********************************************************************/
3791 /* Handle changes in the `fontified' property of the current buffer by
3792 calling hook functions from Qfontification_functions to fontify
3795 static enum prop_handled
3796 handle_fontified_prop (struct it
*it
)
3798 Lisp_Object prop
, pos
;
3799 enum prop_handled handled
= HANDLED_NORMALLY
;
3801 if (!NILP (Vmemory_full
))
3804 /* Get the value of the `fontified' property at IT's current buffer
3805 position. (The `fontified' property doesn't have a special
3806 meaning in strings.) If the value is nil, call functions from
3807 Qfontification_functions. */
3808 if (!STRINGP (it
->string
)
3810 && !NILP (Vfontification_functions
)
3811 && !NILP (Vrun_hooks
)
3812 && (pos
= make_number (IT_CHARPOS (*it
)),
3813 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3814 /* Ignore the special cased nil value always present at EOB since
3815 no amount of fontifying will be able to change it. */
3816 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3818 ptrdiff_t count
= SPECPDL_INDEX ();
3820 struct buffer
*obuf
= current_buffer
;
3821 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3822 bool old_clip_changed
= current_buffer
->clip_changed
;
3824 val
= Vfontification_functions
;
3825 specbind (Qfontification_functions
, Qnil
);
3827 eassert (it
->end_charpos
== ZV
);
3829 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3830 safe_call1 (val
, pos
);
3833 Lisp_Object fns
, fn
;
3834 struct gcpro gcpro1
, gcpro2
;
3839 for (; CONSP (val
); val
= XCDR (val
))
3845 /* A value of t indicates this hook has a local
3846 binding; it means to run the global binding too.
3847 In a global value, t should not occur. If it
3848 does, we must ignore it to avoid an endless
3850 for (fns
= Fdefault_value (Qfontification_functions
);
3856 safe_call1 (fn
, pos
);
3860 safe_call1 (fn
, pos
);
3866 unbind_to (count
, Qnil
);
3868 /* Fontification functions routinely call `save-restriction'.
3869 Normally, this tags clip_changed, which can confuse redisplay
3870 (see discussion in Bug#6671). Since we don't perform any
3871 special handling of fontification changes in the case where
3872 `save-restriction' isn't called, there's no point doing so in
3873 this case either. So, if the buffer's restrictions are
3874 actually left unchanged, reset clip_changed. */
3875 if (obuf
== current_buffer
)
3877 if (begv
== BEGV
&& zv
== ZV
)
3878 current_buffer
->clip_changed
= old_clip_changed
;
3880 /* There isn't much we can reasonably do to protect against
3881 misbehaving fontification, but here's a fig leaf. */
3882 else if (BUFFER_LIVE_P (obuf
))
3883 set_buffer_internal_1 (obuf
);
3885 /* The fontification code may have added/removed text.
3886 It could do even a lot worse, but let's at least protect against
3887 the most obvious case where only the text past `pos' gets changed',
3888 as is/was done in grep.el where some escapes sequences are turned
3889 into face properties (bug#7876). */
3890 it
->end_charpos
= ZV
;
3892 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3893 something. This avoids an endless loop if they failed to
3894 fontify the text for which reason ever. */
3895 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3896 handled
= HANDLED_RECOMPUTE_PROPS
;
3904 /***********************************************************************
3906 ***********************************************************************/
3908 /* Set up iterator IT from face properties at its current position.
3909 Called from handle_stop. */
3911 static enum prop_handled
3912 handle_face_prop (struct it
*it
)
3915 ptrdiff_t next_stop
;
3917 if (!STRINGP (it
->string
))
3920 = face_at_buffer_position (it
->w
,
3924 + TEXT_PROP_DISTANCE_LIMIT
),
3925 0, it
->base_face_id
);
3927 /* Is this a start of a run of characters with box face?
3928 Caveat: this can be called for a freshly initialized
3929 iterator; face_id is -1 in this case. We know that the new
3930 face will not change until limit, i.e. if the new face has a
3931 box, all characters up to limit will have one. But, as
3932 usual, we don't know whether limit is really the end. */
3933 if (new_face_id
!= it
->face_id
)
3935 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3936 /* If it->face_id is -1, old_face below will be NULL, see
3937 the definition of FACE_FROM_ID. This will happen if this
3938 is the initial call that gets the face. */
3939 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3941 /* If the value of face_id of the iterator is -1, we have to
3942 look in front of IT's position and see whether there is a
3943 face there that's different from new_face_id. */
3944 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3946 int prev_face_id
= face_before_it_pos (it
);
3948 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3951 /* If the new face has a box, but the old face does not,
3952 this is the start of a run of characters with box face,
3953 i.e. this character has a shadow on the left side. */
3954 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3955 && (old_face
== NULL
|| !old_face
->box
));
3956 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3964 Lisp_Object from_overlay
3965 = (it
->current
.overlay_string_index
>= 0
3966 ? it
->string_overlays
[it
->current
.overlay_string_index
3967 % OVERLAY_STRING_CHUNK_SIZE
]
3970 /* See if we got to this string directly or indirectly from
3971 an overlay property. That includes the before-string or
3972 after-string of an overlay, strings in display properties
3973 provided by an overlay, their text properties, etc.
3975 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3976 if (! NILP (from_overlay
))
3977 for (i
= it
->sp
- 1; i
>= 0; i
--)
3979 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3981 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3982 % OVERLAY_STRING_CHUNK_SIZE
];
3983 else if (! NILP (it
->stack
[i
].from_overlay
))
3984 from_overlay
= it
->stack
[i
].from_overlay
;
3986 if (!NILP (from_overlay
))
3990 if (! NILP (from_overlay
))
3992 bufpos
= IT_CHARPOS (*it
);
3993 /* For a string from an overlay, the base face depends
3994 only on text properties and ignores overlays. */
3996 = face_for_overlay_string (it
->w
,
4000 + TEXT_PROP_DISTANCE_LIMIT
),
4008 /* For strings from a `display' property, use the face at
4009 IT's current buffer position as the base face to merge
4010 with, so that overlay strings appear in the same face as
4011 surrounding text, unless they specify their own faces.
4012 For strings from wrap-prefix and line-prefix properties,
4013 use the default face, possibly remapped via
4014 Vface_remapping_alist. */
4015 /* Note that the fact that we use the face at _buffer_
4016 position means that a 'display' property on an overlay
4017 string will not inherit the face of that overlay string,
4018 but will instead revert to the face of buffer text
4019 covered by the overlay. This is visible, e.g., when the
4020 overlay specifies a box face, but neither the buffer nor
4021 the display string do. This sounds like a design bug,
4022 but Emacs always did that since v21.1, so changing that
4023 might be a big deal. */
4024 base_face_id
= it
->string_from_prefix_prop_p
4025 ? (!NILP (Vface_remapping_alist
)
4026 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
4028 : underlying_face_id (it
);
4031 new_face_id
= face_at_string_position (it
->w
,
4033 IT_STRING_CHARPOS (*it
),
4038 /* Is this a start of a run of characters with box? Caveat:
4039 this can be called for a freshly allocated iterator; face_id
4040 is -1 is this case. We know that the new face will not
4041 change until the next check pos, i.e. if the new face has a
4042 box, all characters up to that position will have a
4043 box. But, as usual, we don't know whether that position
4044 is really the end. */
4045 if (new_face_id
!= it
->face_id
)
4047 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
4048 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4050 /* If new face has a box but old face hasn't, this is the
4051 start of a run of characters with box, i.e. it has a
4052 shadow on the left side. */
4053 it
->start_of_box_run_p
4054 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
4055 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4059 it
->face_id
= new_face_id
;
4060 return HANDLED_NORMALLY
;
4064 /* Return the ID of the face ``underlying'' IT's current position,
4065 which is in a string. If the iterator is associated with a
4066 buffer, return the face at IT's current buffer position.
4067 Otherwise, use the iterator's base_face_id. */
4070 underlying_face_id (struct it
*it
)
4072 int face_id
= it
->base_face_id
, i
;
4074 eassert (STRINGP (it
->string
));
4076 for (i
= it
->sp
- 1; i
>= 0; --i
)
4077 if (NILP (it
->stack
[i
].string
))
4078 face_id
= it
->stack
[i
].face_id
;
4084 /* Compute the face one character before or after the current position
4085 of IT, in the visual order. BEFORE_P non-zero means get the face
4086 in front (to the left in L2R paragraphs, to the right in R2L
4087 paragraphs) of IT's screen position. Value is the ID of the face. */
4090 face_before_or_after_it_pos (struct it
*it
, int before_p
)
4093 ptrdiff_t next_check_charpos
;
4095 void *it_copy_data
= NULL
;
4097 eassert (it
->s
== NULL
);
4099 if (STRINGP (it
->string
))
4101 ptrdiff_t bufpos
, charpos
;
4104 /* No face change past the end of the string (for the case
4105 we are padding with spaces). No face change before the
4107 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4108 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4113 /* Set charpos to the position before or after IT's current
4114 position, in the logical order, which in the non-bidi
4115 case is the same as the visual order. */
4117 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4118 else if (it
->what
== IT_COMPOSITION
)
4119 /* For composition, we must check the character after the
4121 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4123 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4129 /* With bidi iteration, the character before the current
4130 in the visual order cannot be found by simple
4131 iteration, because "reverse" reordering is not
4132 supported. Instead, we need to use the move_it_*
4133 family of functions. */
4134 /* Ignore face changes before the first visible
4135 character on this display line. */
4136 if (it
->current_x
<= it
->first_visible_x
)
4138 SAVE_IT (it_copy
, *it
, it_copy_data
);
4139 /* Implementation note: Since move_it_in_display_line
4140 works in the iterator geometry, and thinks the first
4141 character is always the leftmost, even in R2L lines,
4142 we don't need to distinguish between the R2L and L2R
4144 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
4145 it_copy
.current_x
- 1, MOVE_TO_X
);
4146 charpos
= IT_STRING_CHARPOS (it_copy
);
4147 RESTORE_IT (it
, it
, it_copy_data
);
4151 /* Set charpos to the string position of the character
4152 that comes after IT's current position in the visual
4154 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4158 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4160 charpos
= it_copy
.bidi_it
.charpos
;
4163 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4165 if (it
->current
.overlay_string_index
>= 0)
4166 bufpos
= IT_CHARPOS (*it
);
4170 base_face_id
= underlying_face_id (it
);
4172 /* Get the face for ASCII, or unibyte. */
4173 face_id
= face_at_string_position (it
->w
,
4177 &next_check_charpos
,
4180 /* Correct the face for charsets different from ASCII. Do it
4181 for the multibyte case only. The face returned above is
4182 suitable for unibyte text if IT->string is unibyte. */
4183 if (STRING_MULTIBYTE (it
->string
))
4185 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4186 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4188 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4190 c
= string_char_and_length (p
, &len
);
4191 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4196 struct text_pos pos
;
4198 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4199 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4202 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4203 pos
= it
->current
.pos
;
4208 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4211 if (it
->what
== IT_COMPOSITION
)
4213 /* For composition, we must check the position after
4215 pos
.charpos
+= it
->cmp_it
.nchars
;
4216 pos
.bytepos
+= it
->len
;
4219 INC_TEXT_POS (pos
, it
->multibyte_p
);
4226 /* With bidi iteration, the character before the current
4227 in the visual order cannot be found by simple
4228 iteration, because "reverse" reordering is not
4229 supported. Instead, we need to use the move_it_*
4230 family of functions. */
4231 /* Ignore face changes before the first visible
4232 character on this display line. */
4233 if (it
->current_x
<= it
->first_visible_x
)
4235 SAVE_IT (it_copy
, *it
, it_copy_data
);
4236 /* Implementation note: Since move_it_in_display_line
4237 works in the iterator geometry, and thinks the first
4238 character is always the leftmost, even in R2L lines,
4239 we don't need to distinguish between the R2L and L2R
4241 move_it_in_display_line (&it_copy
, ZV
,
4242 it_copy
.current_x
- 1, MOVE_TO_X
);
4243 pos
= it_copy
.current
.pos
;
4244 RESTORE_IT (it
, it
, it_copy_data
);
4248 /* Set charpos to the buffer position of the character
4249 that comes after IT's current position in the visual
4251 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4255 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4258 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4261 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4263 /* Determine face for CHARSET_ASCII, or unibyte. */
4264 face_id
= face_at_buffer_position (it
->w
,
4266 &next_check_charpos
,
4269 /* Correct the face for charsets different from ASCII. Do it
4270 for the multibyte case only. The face returned above is
4271 suitable for unibyte text if current_buffer is unibyte. */
4272 if (it
->multibyte_p
)
4274 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4275 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4276 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4285 /***********************************************************************
4287 ***********************************************************************/
4289 /* Set up iterator IT from invisible properties at its current
4290 position. Called from handle_stop. */
4292 static enum prop_handled
4293 handle_invisible_prop (struct it
*it
)
4295 enum prop_handled handled
= HANDLED_NORMALLY
;
4299 if (STRINGP (it
->string
))
4301 Lisp_Object end_charpos
, limit
, charpos
;
4303 /* Get the value of the invisible text property at the
4304 current position. Value will be nil if there is no such
4306 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4307 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4308 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4310 if (invis_p
&& IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4312 /* Record whether we have to display an ellipsis for the
4314 int display_ellipsis_p
= (invis_p
== 2);
4315 ptrdiff_t len
, endpos
;
4317 handled
= HANDLED_RECOMPUTE_PROPS
;
4319 /* Get the position at which the next visible text can be
4320 found in IT->string, if any. */
4321 endpos
= len
= SCHARS (it
->string
);
4322 XSETINT (limit
, len
);
4325 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4327 if (INTEGERP (end_charpos
))
4329 endpos
= XFASTINT (end_charpos
);
4330 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4331 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4333 display_ellipsis_p
= true;
4336 while (invis_p
&& endpos
< len
);
4338 if (display_ellipsis_p
)
4339 it
->ellipsis_p
= true;
4343 /* Text at END_CHARPOS is visible. Move IT there. */
4344 struct text_pos old
;
4347 old
= it
->current
.string_pos
;
4348 oldpos
= CHARPOS (old
);
4351 if (it
->bidi_it
.first_elt
4352 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4353 bidi_paragraph_init (it
->paragraph_embedding
,
4355 /* Bidi-iterate out of the invisible text. */
4358 bidi_move_to_visually_next (&it
->bidi_it
);
4360 while (oldpos
<= it
->bidi_it
.charpos
4361 && it
->bidi_it
.charpos
< endpos
);
4363 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4364 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4365 if (IT_CHARPOS (*it
) >= endpos
)
4366 it
->prev_stop
= endpos
;
4370 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4371 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4376 /* The rest of the string is invisible. If this is an
4377 overlay string, proceed with the next overlay string
4378 or whatever comes and return a character from there. */
4379 if (it
->current
.overlay_string_index
>= 0
4380 && !display_ellipsis_p
)
4382 next_overlay_string (it
);
4383 /* Don't check for overlay strings when we just
4384 finished processing them. */
4385 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4389 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4390 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4397 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4398 Lisp_Object pos
, overlay
;
4400 /* First of all, is there invisible text at this position? */
4401 tem
= start_charpos
= IT_CHARPOS (*it
);
4402 pos
= make_number (tem
);
4403 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4405 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4407 /* If we are on invisible text, skip over it. */
4408 if (invis_p
&& start_charpos
< it
->end_charpos
)
4410 /* Record whether we have to display an ellipsis for the
4412 int display_ellipsis_p
= invis_p
== 2;
4414 handled
= HANDLED_RECOMPUTE_PROPS
;
4416 /* Loop skipping over invisible text. The loop is left at
4417 ZV or with IT on the first char being visible again. */
4420 /* Try to skip some invisible text. Return value is the
4421 position reached which can be equal to where we start
4422 if there is nothing invisible there. This skips both
4423 over invisible text properties and overlays with
4424 invisible property. */
4425 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4427 /* If we skipped nothing at all we weren't at invisible
4428 text in the first place. If everything to the end of
4429 the buffer was skipped, end the loop. */
4430 if (newpos
== tem
|| newpos
>= ZV
)
4434 /* We skipped some characters but not necessarily
4435 all there are. Check if we ended up on visible
4436 text. Fget_char_property returns the property of
4437 the char before the given position, i.e. if we
4438 get invis_p = 0, this means that the char at
4439 newpos is visible. */
4440 pos
= make_number (newpos
);
4441 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4442 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4445 /* If we ended up on invisible text, proceed to
4446 skip starting with next_stop. */
4450 /* If there are adjacent invisible texts, don't lose the
4451 second one's ellipsis. */
4453 display_ellipsis_p
= true;
4457 /* The position newpos is now either ZV or on visible text. */
4460 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4462 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4464 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4466 /* If the invisible text ends on a newline or on a
4467 character after a newline, we can avoid the costly,
4468 character by character, bidi iteration to NEWPOS, and
4469 instead simply reseat the iterator there. That's
4470 because all bidi reordering information is tossed at
4471 the newline. This is a big win for modes that hide
4472 complete lines, like Outline, Org, etc. */
4473 if (on_newline
|| after_newline
)
4475 struct text_pos tpos
;
4476 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4478 SET_TEXT_POS (tpos
, newpos
, bpos
);
4479 reseat_1 (it
, tpos
, 0);
4480 /* If we reseat on a newline/ZV, we need to prep the
4481 bidi iterator for advancing to the next character
4482 after the newline/EOB, keeping the current paragraph
4483 direction (so that PRODUCE_GLYPHS does TRT wrt
4484 prepending/appending glyphs to a glyph row). */
4487 it
->bidi_it
.first_elt
= 0;
4488 it
->bidi_it
.paragraph_dir
= pdir
;
4489 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4490 it
->bidi_it
.nchars
= 1;
4491 it
->bidi_it
.ch_len
= 1;
4494 else /* Must use the slow method. */
4496 /* With bidi iteration, the region of invisible text
4497 could start and/or end in the middle of a
4498 non-base embedding level. Therefore, we need to
4499 skip invisible text using the bidi iterator,
4500 starting at IT's current position, until we find
4501 ourselves outside of the invisible text.
4502 Skipping invisible text _after_ bidi iteration
4503 avoids affecting the visual order of the
4504 displayed text when invisible properties are
4505 added or removed. */
4506 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4508 /* If we were `reseat'ed to a new paragraph,
4509 determine the paragraph base direction. We
4510 need to do it now because
4511 next_element_from_buffer may not have a
4512 chance to do it, if we are going to skip any
4513 text at the beginning, which resets the
4515 bidi_paragraph_init (it
->paragraph_embedding
,
4520 bidi_move_to_visually_next (&it
->bidi_it
);
4522 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4523 && it
->bidi_it
.charpos
< newpos
);
4524 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4525 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4526 /* If we overstepped NEWPOS, record its position in
4527 the iterator, so that we skip invisible text if
4528 later the bidi iteration lands us in the
4529 invisible region again. */
4530 if (IT_CHARPOS (*it
) >= newpos
)
4531 it
->prev_stop
= newpos
;
4536 IT_CHARPOS (*it
) = newpos
;
4537 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4540 /* If there are before-strings at the start of invisible
4541 text, and the text is invisible because of a text
4542 property, arrange to show before-strings because 20.x did
4543 it that way. (If the text is invisible because of an
4544 overlay property instead of a text property, this is
4545 already handled in the overlay code.) */
4547 && get_overlay_strings (it
, it
->stop_charpos
))
4549 handled
= HANDLED_RECOMPUTE_PROPS
;
4552 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4553 /* The call to get_overlay_strings above recomputes
4554 it->stop_charpos, but it only considers changes
4555 in properties and overlays beyond iterator's
4556 current position. This causes us to miss changes
4557 that happen exactly where the invisible property
4558 ended. So we play it safe here and force the
4559 iterator to check for potential stop positions
4560 immediately after the invisible text. Note that
4561 if get_overlay_strings returns non-zero, it
4562 normally also pushed the iterator stack, so we
4563 need to update the stop position in the slot
4564 below the current one. */
4565 it
->stack
[it
->sp
- 1].stop_charpos
4566 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4569 else if (display_ellipsis_p
)
4571 /* Make sure that the glyphs of the ellipsis will get
4572 correct `charpos' values. If we would not update
4573 it->position here, the glyphs would belong to the
4574 last visible character _before_ the invisible
4575 text, which confuses `set_cursor_from_row'.
4577 We use the last invisible position instead of the
4578 first because this way the cursor is always drawn on
4579 the first "." of the ellipsis, whenever PT is inside
4580 the invisible text. Otherwise the cursor would be
4581 placed _after_ the ellipsis when the point is after the
4582 first invisible character. */
4583 if (!STRINGP (it
->object
))
4585 it
->position
.charpos
= newpos
- 1;
4586 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4588 it
->ellipsis_p
= true;
4589 /* Let the ellipsis display before
4590 considering any properties of the following char.
4591 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4592 handled
= HANDLED_RETURN
;
4601 /* Make iterator IT return `...' next.
4602 Replaces LEN characters from buffer. */
4605 setup_for_ellipsis (struct it
*it
, int len
)
4607 /* Use the display table definition for `...'. Invalid glyphs
4608 will be handled by the method returning elements from dpvec. */
4609 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4611 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4612 it
->dpvec
= v
->contents
;
4613 it
->dpend
= v
->contents
+ v
->header
.size
;
4617 /* Default `...'. */
4618 it
->dpvec
= default_invis_vector
;
4619 it
->dpend
= default_invis_vector
+ 3;
4622 it
->dpvec_char_len
= len
;
4623 it
->current
.dpvec_index
= 0;
4624 it
->dpvec_face_id
= -1;
4626 /* Remember the current face id in case glyphs specify faces.
4627 IT's face is restored in set_iterator_to_next.
4628 saved_face_id was set to preceding char's face in handle_stop. */
4629 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4630 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4632 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4633 it
->ellipsis_p
= true;
4638 /***********************************************************************
4640 ***********************************************************************/
4642 /* Set up iterator IT from `display' property at its current position.
4643 Called from handle_stop.
4644 We return HANDLED_RETURN if some part of the display property
4645 overrides the display of the buffer text itself.
4646 Otherwise we return HANDLED_NORMALLY. */
4648 static enum prop_handled
4649 handle_display_prop (struct it
*it
)
4651 Lisp_Object propval
, object
, overlay
;
4652 struct text_pos
*position
;
4654 /* Nonzero if some property replaces the display of the text itself. */
4655 int display_replaced_p
= 0;
4657 if (STRINGP (it
->string
))
4659 object
= it
->string
;
4660 position
= &it
->current
.string_pos
;
4661 bufpos
= CHARPOS (it
->current
.pos
);
4665 XSETWINDOW (object
, it
->w
);
4666 position
= &it
->current
.pos
;
4667 bufpos
= CHARPOS (*position
);
4670 /* Reset those iterator values set from display property values. */
4671 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4672 it
->space_width
= Qnil
;
4673 it
->font_height
= Qnil
;
4676 /* We don't support recursive `display' properties, i.e. string
4677 values that have a string `display' property, that have a string
4678 `display' property etc. */
4679 if (!it
->string_from_display_prop_p
)
4680 it
->area
= TEXT_AREA
;
4682 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4683 Qdisplay
, object
, &overlay
);
4685 return HANDLED_NORMALLY
;
4686 /* Now OVERLAY is the overlay that gave us this property, or nil
4687 if it was a text property. */
4689 if (!STRINGP (it
->string
))
4690 object
= it
->w
->contents
;
4692 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4694 FRAME_WINDOW_P (it
->f
));
4696 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4699 /* Subroutine of handle_display_prop. Returns non-zero if the display
4700 specification in SPEC is a replacing specification, i.e. it would
4701 replace the text covered by `display' property with something else,
4702 such as an image or a display string. If SPEC includes any kind or
4703 `(space ...) specification, the value is 2; this is used by
4704 compute_display_string_pos, which see.
4706 See handle_single_display_spec for documentation of arguments.
4707 frame_window_p is non-zero if the window being redisplayed is on a
4708 GUI frame; this argument is used only if IT is NULL, see below.
4710 IT can be NULL, if this is called by the bidi reordering code
4711 through compute_display_string_pos, which see. In that case, this
4712 function only examines SPEC, but does not otherwise "handle" it, in
4713 the sense that it doesn't set up members of IT from the display
4716 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4717 Lisp_Object overlay
, struct text_pos
*position
,
4718 ptrdiff_t bufpos
, int frame_window_p
)
4720 int replacing_p
= 0;
4724 /* Simple specifications. */
4725 && !EQ (XCAR (spec
), Qimage
)
4726 && !EQ (XCAR (spec
), Qspace
)
4727 && !EQ (XCAR (spec
), Qwhen
)
4728 && !EQ (XCAR (spec
), Qslice
)
4729 && !EQ (XCAR (spec
), Qspace_width
)
4730 && !EQ (XCAR (spec
), Qheight
)
4731 && !EQ (XCAR (spec
), Qraise
)
4732 /* Marginal area specifications. */
4733 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4734 && !EQ (XCAR (spec
), Qleft_fringe
)
4735 && !EQ (XCAR (spec
), Qright_fringe
)
4736 && !NILP (XCAR (spec
)))
4738 for (; CONSP (spec
); spec
= XCDR (spec
))
4740 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4741 overlay
, position
, bufpos
,
4742 replacing_p
, frame_window_p
)))
4745 /* If some text in a string is replaced, `position' no
4746 longer points to the position of `object'. */
4747 if (!it
|| STRINGP (object
))
4752 else if (VECTORP (spec
))
4755 for (i
= 0; i
< ASIZE (spec
); ++i
)
4756 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4757 overlay
, position
, bufpos
,
4758 replacing_p
, frame_window_p
)))
4761 /* If some text in a string is replaced, `position' no
4762 longer points to the position of `object'. */
4763 if (!it
|| STRINGP (object
))
4769 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4770 position
, bufpos
, 0,
4778 /* Value is the position of the end of the `display' property starting
4779 at START_POS in OBJECT. */
4781 static struct text_pos
4782 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4785 struct text_pos end_pos
;
4787 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4788 Qdisplay
, object
, Qnil
);
4789 CHARPOS (end_pos
) = XFASTINT (end
);
4790 if (STRINGP (object
))
4791 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4793 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4799 /* Set up IT from a single `display' property specification SPEC. OBJECT
4800 is the object in which the `display' property was found. *POSITION
4801 is the position in OBJECT at which the `display' property was found.
4802 BUFPOS is the buffer position of OBJECT (different from POSITION if
4803 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4804 previously saw a display specification which already replaced text
4805 display with something else, for example an image; we ignore such
4806 properties after the first one has been processed.
4808 OVERLAY is the overlay this `display' property came from,
4809 or nil if it was a text property.
4811 If SPEC is a `space' or `image' specification, and in some other
4812 cases too, set *POSITION to the position where the `display'
4815 If IT is NULL, only examine the property specification in SPEC, but
4816 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4817 is intended to be displayed in a window on a GUI frame.
4819 Value is non-zero if something was found which replaces the display
4820 of buffer or string text. */
4823 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4824 Lisp_Object overlay
, struct text_pos
*position
,
4825 ptrdiff_t bufpos
, int display_replaced_p
,
4829 Lisp_Object location
, value
;
4830 struct text_pos start_pos
= *position
;
4833 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4834 If the result is non-nil, use VALUE instead of SPEC. */
4836 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4845 if (!NILP (form
) && !EQ (form
, Qt
))
4847 ptrdiff_t count
= SPECPDL_INDEX ();
4848 struct gcpro gcpro1
;
4850 /* Bind `object' to the object having the `display' property, a
4851 buffer or string. Bind `position' to the position in the
4852 object where the property was found, and `buffer-position'
4853 to the current position in the buffer. */
4856 XSETBUFFER (object
, current_buffer
);
4857 specbind (Qobject
, object
);
4858 specbind (Qposition
, make_number (CHARPOS (*position
)));
4859 specbind (Qbuffer_position
, make_number (bufpos
));
4861 form
= safe_eval (form
);
4863 unbind_to (count
, Qnil
);
4869 /* Handle `(height HEIGHT)' specifications. */
4871 && EQ (XCAR (spec
), Qheight
)
4872 && CONSP (XCDR (spec
)))
4876 if (!FRAME_WINDOW_P (it
->f
))
4879 it
->font_height
= XCAR (XCDR (spec
));
4880 if (!NILP (it
->font_height
))
4882 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4883 int new_height
= -1;
4885 if (CONSP (it
->font_height
)
4886 && (EQ (XCAR (it
->font_height
), Qplus
)
4887 || EQ (XCAR (it
->font_height
), Qminus
))
4888 && CONSP (XCDR (it
->font_height
))
4889 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4891 /* `(+ N)' or `(- N)' where N is an integer. */
4892 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4893 if (EQ (XCAR (it
->font_height
), Qplus
))
4895 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4897 else if (FUNCTIONP (it
->font_height
))
4899 /* Call function with current height as argument.
4900 Value is the new height. */
4902 height
= safe_call1 (it
->font_height
,
4903 face
->lface
[LFACE_HEIGHT_INDEX
]);
4904 if (NUMBERP (height
))
4905 new_height
= XFLOATINT (height
);
4907 else if (NUMBERP (it
->font_height
))
4909 /* Value is a multiple of the canonical char height. */
4912 f
= FACE_FROM_ID (it
->f
,
4913 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4914 new_height
= (XFLOATINT (it
->font_height
)
4915 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4919 /* Evaluate IT->font_height with `height' bound to the
4920 current specified height to get the new height. */
4921 ptrdiff_t count
= SPECPDL_INDEX ();
4923 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4924 value
= safe_eval (it
->font_height
);
4925 unbind_to (count
, Qnil
);
4927 if (NUMBERP (value
))
4928 new_height
= XFLOATINT (value
);
4932 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4939 /* Handle `(space-width WIDTH)'. */
4941 && EQ (XCAR (spec
), Qspace_width
)
4942 && CONSP (XCDR (spec
)))
4946 if (!FRAME_WINDOW_P (it
->f
))
4949 value
= XCAR (XCDR (spec
));
4950 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4951 it
->space_width
= value
;
4957 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4959 && EQ (XCAR (spec
), Qslice
))
4965 if (!FRAME_WINDOW_P (it
->f
))
4968 if (tem
= XCDR (spec
), CONSP (tem
))
4970 it
->slice
.x
= XCAR (tem
);
4971 if (tem
= XCDR (tem
), CONSP (tem
))
4973 it
->slice
.y
= XCAR (tem
);
4974 if (tem
= XCDR (tem
), CONSP (tem
))
4976 it
->slice
.width
= XCAR (tem
);
4977 if (tem
= XCDR (tem
), CONSP (tem
))
4978 it
->slice
.height
= XCAR (tem
);
4987 /* Handle `(raise FACTOR)'. */
4989 && EQ (XCAR (spec
), Qraise
)
4990 && CONSP (XCDR (spec
)))
4994 if (!FRAME_WINDOW_P (it
->f
))
4997 #ifdef HAVE_WINDOW_SYSTEM
4998 value
= XCAR (XCDR (spec
));
4999 if (NUMBERP (value
))
5001 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5002 it
->voffset
= - (XFLOATINT (value
)
5003 * (FONT_HEIGHT (face
->font
)));
5005 #endif /* HAVE_WINDOW_SYSTEM */
5011 /* Don't handle the other kinds of display specifications
5012 inside a string that we got from a `display' property. */
5013 if (it
&& it
->string_from_display_prop_p
)
5016 /* Characters having this form of property are not displayed, so
5017 we have to find the end of the property. */
5020 start_pos
= *position
;
5021 *position
= display_prop_end (it
, object
, start_pos
);
5025 /* Stop the scan at that end position--we assume that all
5026 text properties change there. */
5028 it
->stop_charpos
= position
->charpos
;
5030 /* Handle `(left-fringe BITMAP [FACE])'
5031 and `(right-fringe BITMAP [FACE])'. */
5033 && (EQ (XCAR (spec
), Qleft_fringe
)
5034 || EQ (XCAR (spec
), Qright_fringe
))
5035 && CONSP (XCDR (spec
)))
5041 if (!FRAME_WINDOW_P (it
->f
))
5042 /* If we return here, POSITION has been advanced
5043 across the text with this property. */
5045 /* Synchronize the bidi iterator with POSITION. This is
5046 needed because we are not going to push the iterator
5047 on behalf of this display property, so there will be
5048 no pop_it call to do this synchronization for us. */
5051 it
->position
= *position
;
5052 iterate_out_of_display_property (it
);
5053 *position
= it
->position
;
5058 else if (!frame_window_p
)
5061 #ifdef HAVE_WINDOW_SYSTEM
5062 value
= XCAR (XCDR (spec
));
5063 if (!SYMBOLP (value
)
5064 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
5065 /* If we return here, POSITION has been advanced
5066 across the text with this property. */
5068 if (it
&& it
->bidi_p
)
5070 it
->position
= *position
;
5071 iterate_out_of_display_property (it
);
5072 *position
= it
->position
;
5079 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
5081 if (CONSP (XCDR (XCDR (spec
))))
5083 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5084 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5090 /* Save current settings of IT so that we can restore them
5091 when we are finished with the glyph property value. */
5092 push_it (it
, position
);
5094 it
->area
= TEXT_AREA
;
5095 it
->what
= IT_IMAGE
;
5096 it
->image_id
= -1; /* no image */
5097 it
->position
= start_pos
;
5098 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5099 it
->method
= GET_FROM_IMAGE
;
5100 it
->from_overlay
= Qnil
;
5101 it
->face_id
= face_id
;
5102 it
->from_disp_prop_p
= true;
5104 /* Say that we haven't consumed the characters with
5105 `display' property yet. The call to pop_it in
5106 set_iterator_to_next will clean this up. */
5107 *position
= start_pos
;
5109 if (EQ (XCAR (spec
), Qleft_fringe
))
5111 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5112 it
->left_user_fringe_face_id
= face_id
;
5116 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5117 it
->right_user_fringe_face_id
= face_id
;
5120 #endif /* HAVE_WINDOW_SYSTEM */
5124 /* Prepare to handle `((margin left-margin) ...)',
5125 `((margin right-margin) ...)' and `((margin nil) ...)'
5126 prefixes for display specifications. */
5127 location
= Qunbound
;
5128 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5132 value
= XCDR (spec
);
5134 value
= XCAR (value
);
5137 if (EQ (XCAR (tem
), Qmargin
)
5138 && (tem
= XCDR (tem
),
5139 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5141 || EQ (tem
, Qleft_margin
)
5142 || EQ (tem
, Qright_margin
))))
5146 if (EQ (location
, Qunbound
))
5152 /* After this point, VALUE is the property after any
5153 margin prefix has been stripped. It must be a string,
5154 an image specification, or `(space ...)'.
5156 LOCATION specifies where to display: `left-margin',
5157 `right-margin' or nil. */
5159 valid_p
= (STRINGP (value
)
5160 #ifdef HAVE_WINDOW_SYSTEM
5161 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5162 && valid_image_p (value
))
5163 #endif /* not HAVE_WINDOW_SYSTEM */
5164 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
5166 if (valid_p
&& !display_replaced_p
)
5172 /* Callers need to know whether the display spec is any kind
5173 of `(space ...)' spec that is about to affect text-area
5175 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5180 /* Save current settings of IT so that we can restore them
5181 when we are finished with the glyph property value. */
5182 push_it (it
, position
);
5183 it
->from_overlay
= overlay
;
5184 it
->from_disp_prop_p
= true;
5186 if (NILP (location
))
5187 it
->area
= TEXT_AREA
;
5188 else if (EQ (location
, Qleft_margin
))
5189 it
->area
= LEFT_MARGIN_AREA
;
5191 it
->area
= RIGHT_MARGIN_AREA
;
5193 if (STRINGP (value
))
5196 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5197 it
->current
.overlay_string_index
= -1;
5198 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5199 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5200 it
->method
= GET_FROM_STRING
;
5201 it
->stop_charpos
= 0;
5203 it
->base_level_stop
= 0;
5204 it
->string_from_display_prop_p
= true;
5205 /* Say that we haven't consumed the characters with
5206 `display' property yet. The call to pop_it in
5207 set_iterator_to_next will clean this up. */
5208 if (BUFFERP (object
))
5209 *position
= start_pos
;
5211 /* Force paragraph direction to be that of the parent
5212 object. If the parent object's paragraph direction is
5213 not yet determined, default to L2R. */
5214 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5215 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5217 it
->paragraph_embedding
= L2R
;
5219 /* Set up the bidi iterator for this display string. */
5222 it
->bidi_it
.string
.lstring
= it
->string
;
5223 it
->bidi_it
.string
.s
= NULL
;
5224 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5225 it
->bidi_it
.string
.bufpos
= bufpos
;
5226 it
->bidi_it
.string
.from_disp_str
= 1;
5227 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5228 it
->bidi_it
.w
= it
->w
;
5229 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5232 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5234 it
->method
= GET_FROM_STRETCH
;
5236 *position
= it
->position
= start_pos
;
5237 retval
= 1 + (it
->area
== TEXT_AREA
);
5239 #ifdef HAVE_WINDOW_SYSTEM
5242 it
->what
= IT_IMAGE
;
5243 it
->image_id
= lookup_image (it
->f
, value
);
5244 it
->position
= start_pos
;
5245 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5246 it
->method
= GET_FROM_IMAGE
;
5248 /* Say that we haven't consumed the characters with
5249 `display' property yet. The call to pop_it in
5250 set_iterator_to_next will clean this up. */
5251 *position
= start_pos
;
5253 #endif /* HAVE_WINDOW_SYSTEM */
5258 /* Invalid property or property not supported. Restore
5259 POSITION to what it was before. */
5260 *position
= start_pos
;
5264 /* Check if PROP is a display property value whose text should be
5265 treated as intangible. OVERLAY is the overlay from which PROP
5266 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5267 specify the buffer position covered by PROP. */
5270 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5271 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5273 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5274 struct text_pos position
;
5276 SET_TEXT_POS (position
, charpos
, bytepos
);
5277 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5278 &position
, charpos
, frame_window_p
);
5282 /* Return 1 if PROP is a display sub-property value containing STRING.
5284 Implementation note: this and the following function are really
5285 special cases of handle_display_spec and
5286 handle_single_display_spec, and should ideally use the same code.
5287 Until they do, these two pairs must be consistent and must be
5288 modified in sync. */
5291 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5293 if (EQ (string
, prop
))
5296 /* Skip over `when FORM'. */
5297 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5302 /* Actually, the condition following `when' should be eval'ed,
5303 like handle_single_display_spec does, and we should return
5304 zero if it evaluates to nil. However, this function is
5305 called only when the buffer was already displayed and some
5306 glyph in the glyph matrix was found to come from a display
5307 string. Therefore, the condition was already evaluated, and
5308 the result was non-nil, otherwise the display string wouldn't
5309 have been displayed and we would have never been called for
5310 this property. Thus, we can skip the evaluation and assume
5311 its result is non-nil. */
5316 /* Skip over `margin LOCATION'. */
5317 if (EQ (XCAR (prop
), Qmargin
))
5328 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5332 /* Return 1 if STRING appears in the `display' property PROP. */
5335 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5338 && !EQ (XCAR (prop
), Qwhen
)
5339 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5341 /* A list of sub-properties. */
5342 while (CONSP (prop
))
5344 if (single_display_spec_string_p (XCAR (prop
), string
))
5349 else if (VECTORP (prop
))
5351 /* A vector of sub-properties. */
5353 for (i
= 0; i
< ASIZE (prop
); ++i
)
5354 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5358 return single_display_spec_string_p (prop
, string
);
5363 /* Look for STRING in overlays and text properties in the current
5364 buffer, between character positions FROM and TO (excluding TO).
5365 BACK_P non-zero means look back (in this case, TO is supposed to be
5367 Value is the first character position where STRING was found, or
5368 zero if it wasn't found before hitting TO.
5370 This function may only use code that doesn't eval because it is
5371 called asynchronously from note_mouse_highlight. */
5374 string_buffer_position_lim (Lisp_Object string
,
5375 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5377 Lisp_Object limit
, prop
, pos
;
5380 pos
= make_number (max (from
, BEGV
));
5382 if (!back_p
) /* looking forward */
5384 limit
= make_number (min (to
, ZV
));
5385 while (!found
&& !EQ (pos
, limit
))
5387 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5388 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5391 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5395 else /* looking back */
5397 limit
= make_number (max (to
, BEGV
));
5398 while (!found
&& !EQ (pos
, limit
))
5400 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5401 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5404 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5409 return found
? XINT (pos
) : 0;
5412 /* Determine which buffer position in current buffer STRING comes from.
5413 AROUND_CHARPOS is an approximate position where it could come from.
5414 Value is the buffer position or 0 if it couldn't be determined.
5416 This function is necessary because we don't record buffer positions
5417 in glyphs generated from strings (to keep struct glyph small).
5418 This function may only use code that doesn't eval because it is
5419 called asynchronously from note_mouse_highlight. */
5422 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5424 const int MAX_DISTANCE
= 1000;
5425 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5426 around_charpos
+ MAX_DISTANCE
,
5430 found
= string_buffer_position_lim (string
, around_charpos
,
5431 around_charpos
- MAX_DISTANCE
, 1);
5437 /***********************************************************************
5438 `composition' property
5439 ***********************************************************************/
5441 /* Set up iterator IT from `composition' property at its current
5442 position. Called from handle_stop. */
5444 static enum prop_handled
5445 handle_composition_prop (struct it
*it
)
5447 Lisp_Object prop
, string
;
5448 ptrdiff_t pos
, pos_byte
, start
, end
;
5450 if (STRINGP (it
->string
))
5454 pos
= IT_STRING_CHARPOS (*it
);
5455 pos_byte
= IT_STRING_BYTEPOS (*it
);
5456 string
= it
->string
;
5457 s
= SDATA (string
) + pos_byte
;
5458 it
->c
= STRING_CHAR (s
);
5462 pos
= IT_CHARPOS (*it
);
5463 pos_byte
= IT_BYTEPOS (*it
);
5465 it
->c
= FETCH_CHAR (pos_byte
);
5468 /* If there's a valid composition and point is not inside of the
5469 composition (in the case that the composition is from the current
5470 buffer), draw a glyph composed from the composition components. */
5471 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5472 && composition_valid_p (start
, end
, prop
)
5473 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5476 /* As we can't handle this situation (perhaps font-lock added
5477 a new composition), we just return here hoping that next
5478 redisplay will detect this composition much earlier. */
5479 return HANDLED_NORMALLY
;
5482 if (STRINGP (it
->string
))
5483 pos_byte
= string_char_to_byte (it
->string
, start
);
5485 pos_byte
= CHAR_TO_BYTE (start
);
5487 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5490 if (it
->cmp_it
.id
>= 0)
5493 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5494 it
->cmp_it
.nglyphs
= -1;
5498 return HANDLED_NORMALLY
;
5503 /***********************************************************************
5505 ***********************************************************************/
5507 /* The following structure is used to record overlay strings for
5508 later sorting in load_overlay_strings. */
5510 struct overlay_entry
5512 Lisp_Object overlay
;
5519 /* Set up iterator IT from overlay strings at its current position.
5520 Called from handle_stop. */
5522 static enum prop_handled
5523 handle_overlay_change (struct it
*it
)
5525 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5526 return HANDLED_RECOMPUTE_PROPS
;
5528 return HANDLED_NORMALLY
;
5532 /* Set up the next overlay string for delivery by IT, if there is an
5533 overlay string to deliver. Called by set_iterator_to_next when the
5534 end of the current overlay string is reached. If there are more
5535 overlay strings to display, IT->string and
5536 IT->current.overlay_string_index are set appropriately here.
5537 Otherwise IT->string is set to nil. */
5540 next_overlay_string (struct it
*it
)
5542 ++it
->current
.overlay_string_index
;
5543 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5545 /* No more overlay strings. Restore IT's settings to what
5546 they were before overlay strings were processed, and
5547 continue to deliver from current_buffer. */
5549 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5552 || (NILP (it
->string
)
5553 && it
->method
== GET_FROM_BUFFER
5554 && it
->stop_charpos
>= BEGV
5555 && it
->stop_charpos
<= it
->end_charpos
));
5556 it
->current
.overlay_string_index
= -1;
5557 it
->n_overlay_strings
= 0;
5558 it
->overlay_strings_charpos
= -1;
5559 /* If there's an empty display string on the stack, pop the
5560 stack, to resync the bidi iterator with IT's position. Such
5561 empty strings are pushed onto the stack in
5562 get_overlay_strings_1. */
5563 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5566 /* If we're at the end of the buffer, record that we have
5567 processed the overlay strings there already, so that
5568 next_element_from_buffer doesn't try it again. */
5569 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5570 it
->overlay_strings_at_end_processed_p
= true;
5574 /* There are more overlay strings to process. If
5575 IT->current.overlay_string_index has advanced to a position
5576 where we must load IT->overlay_strings with more strings, do
5577 it. We must load at the IT->overlay_strings_charpos where
5578 IT->n_overlay_strings was originally computed; when invisible
5579 text is present, this might not be IT_CHARPOS (Bug#7016). */
5580 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5582 if (it
->current
.overlay_string_index
&& i
== 0)
5583 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5585 /* Initialize IT to deliver display elements from the overlay
5587 it
->string
= it
->overlay_strings
[i
];
5588 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5589 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5590 it
->method
= GET_FROM_STRING
;
5591 it
->stop_charpos
= 0;
5592 it
->end_charpos
= SCHARS (it
->string
);
5593 if (it
->cmp_it
.stop_pos
>= 0)
5594 it
->cmp_it
.stop_pos
= 0;
5596 it
->base_level_stop
= 0;
5598 /* Set up the bidi iterator for this overlay string. */
5601 it
->bidi_it
.string
.lstring
= it
->string
;
5602 it
->bidi_it
.string
.s
= NULL
;
5603 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5604 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5605 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5606 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5607 it
->bidi_it
.w
= it
->w
;
5608 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5616 /* Compare two overlay_entry structures E1 and E2. Used as a
5617 comparison function for qsort in load_overlay_strings. Overlay
5618 strings for the same position are sorted so that
5620 1. All after-strings come in front of before-strings, except
5621 when they come from the same overlay.
5623 2. Within after-strings, strings are sorted so that overlay strings
5624 from overlays with higher priorities come first.
5626 2. Within before-strings, strings are sorted so that overlay
5627 strings from overlays with higher priorities come last.
5629 Value is analogous to strcmp. */
5633 compare_overlay_entries (const void *e1
, const void *e2
)
5635 struct overlay_entry
const *entry1
= e1
;
5636 struct overlay_entry
const *entry2
= e2
;
5639 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5641 /* Let after-strings appear in front of before-strings if
5642 they come from different overlays. */
5643 if (EQ (entry1
->overlay
, entry2
->overlay
))
5644 result
= entry1
->after_string_p
? 1 : -1;
5646 result
= entry1
->after_string_p
? -1 : 1;
5648 else if (entry1
->priority
!= entry2
->priority
)
5650 if (entry1
->after_string_p
)
5651 /* After-strings sorted in order of decreasing priority. */
5652 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5654 /* Before-strings sorted in order of increasing priority. */
5655 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5664 /* Load the vector IT->overlay_strings with overlay strings from IT's
5665 current buffer position, or from CHARPOS if that is > 0. Set
5666 IT->n_overlays to the total number of overlay strings found.
5668 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5669 a time. On entry into load_overlay_strings,
5670 IT->current.overlay_string_index gives the number of overlay
5671 strings that have already been loaded by previous calls to this
5674 IT->add_overlay_start contains an additional overlay start
5675 position to consider for taking overlay strings from, if non-zero.
5676 This position comes into play when the overlay has an `invisible'
5677 property, and both before and after-strings. When we've skipped to
5678 the end of the overlay, because of its `invisible' property, we
5679 nevertheless want its before-string to appear.
5680 IT->add_overlay_start will contain the overlay start position
5683 Overlay strings are sorted so that after-string strings come in
5684 front of before-string strings. Within before and after-strings,
5685 strings are sorted by overlay priority. See also function
5686 compare_overlay_entries. */
5689 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5691 Lisp_Object overlay
, window
, str
, invisible
;
5692 struct Lisp_Overlay
*ov
;
5693 ptrdiff_t start
, end
;
5694 ptrdiff_t size
= 20;
5695 ptrdiff_t n
= 0, i
, j
;
5697 struct overlay_entry
*entries
= alloca (size
* sizeof *entries
);
5701 charpos
= IT_CHARPOS (*it
);
5703 /* Append the overlay string STRING of overlay OVERLAY to vector
5704 `entries' which has size `size' and currently contains `n'
5705 elements. AFTER_P non-zero means STRING is an after-string of
5707 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5710 Lisp_Object priority; \
5714 struct overlay_entry *old = entries; \
5715 SAFE_NALLOCA (entries, 2, size); \
5716 memcpy (entries, old, size * sizeof *entries); \
5720 entries[n].string = (STRING); \
5721 entries[n].overlay = (OVERLAY); \
5722 priority = Foverlay_get ((OVERLAY), Qpriority); \
5723 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5724 entries[n].after_string_p = (AFTER_P); \
5729 /* Process overlay before the overlay center. */
5730 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5732 XSETMISC (overlay
, ov
);
5733 eassert (OVERLAYP (overlay
));
5734 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5735 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5740 /* Skip this overlay if it doesn't start or end at IT's current
5742 if (end
!= charpos
&& start
!= charpos
)
5745 /* Skip this overlay if it doesn't apply to IT->w. */
5746 window
= Foverlay_get (overlay
, Qwindow
);
5747 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5750 /* If the text ``under'' the overlay is invisible, both before-
5751 and after-strings from this overlay are visible; start and
5752 end position are indistinguishable. */
5753 invisible
= Foverlay_get (overlay
, Qinvisible
);
5754 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5756 /* If overlay has a non-empty before-string, record it. */
5757 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5758 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5760 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5762 /* If overlay has a non-empty after-string, record it. */
5763 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5764 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5766 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5769 /* Process overlays after the overlay center. */
5770 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5772 XSETMISC (overlay
, ov
);
5773 eassert (OVERLAYP (overlay
));
5774 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5775 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5777 if (start
> charpos
)
5780 /* Skip this overlay if it doesn't start or end at IT's current
5782 if (end
!= charpos
&& start
!= charpos
)
5785 /* Skip this overlay if it doesn't apply to IT->w. */
5786 window
= Foverlay_get (overlay
, Qwindow
);
5787 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5790 /* If the text ``under'' the overlay is invisible, it has a zero
5791 dimension, and both before- and after-strings apply. */
5792 invisible
= Foverlay_get (overlay
, Qinvisible
);
5793 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5795 /* If overlay has a non-empty before-string, record it. */
5796 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5797 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5799 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5801 /* If overlay has a non-empty after-string, record it. */
5802 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5803 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5805 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5808 #undef RECORD_OVERLAY_STRING
5812 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5814 /* Record number of overlay strings, and where we computed it. */
5815 it
->n_overlay_strings
= n
;
5816 it
->overlay_strings_charpos
= charpos
;
5818 /* IT->current.overlay_string_index is the number of overlay strings
5819 that have already been consumed by IT. Copy some of the
5820 remaining overlay strings to IT->overlay_strings. */
5822 j
= it
->current
.overlay_string_index
;
5823 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5825 it
->overlay_strings
[i
] = entries
[j
].string
;
5826 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5834 /* Get the first chunk of overlay strings at IT's current buffer
5835 position, or at CHARPOS if that is > 0. Value is non-zero if at
5836 least one overlay string was found. */
5839 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5841 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5842 process. This fills IT->overlay_strings with strings, and sets
5843 IT->n_overlay_strings to the total number of strings to process.
5844 IT->pos.overlay_string_index has to be set temporarily to zero
5845 because load_overlay_strings needs this; it must be set to -1
5846 when no overlay strings are found because a zero value would
5847 indicate a position in the first overlay string. */
5848 it
->current
.overlay_string_index
= 0;
5849 load_overlay_strings (it
, charpos
);
5851 /* If we found overlay strings, set up IT to deliver display
5852 elements from the first one. Otherwise set up IT to deliver
5853 from current_buffer. */
5854 if (it
->n_overlay_strings
)
5856 /* Make sure we know settings in current_buffer, so that we can
5857 restore meaningful values when we're done with the overlay
5860 compute_stop_pos (it
);
5861 eassert (it
->face_id
>= 0);
5863 /* Save IT's settings. They are restored after all overlay
5864 strings have been processed. */
5865 eassert (!compute_stop_p
|| it
->sp
== 0);
5867 /* When called from handle_stop, there might be an empty display
5868 string loaded. In that case, don't bother saving it. But
5869 don't use this optimization with the bidi iterator, since we
5870 need the corresponding pop_it call to resync the bidi
5871 iterator's position with IT's position, after we are done
5872 with the overlay strings. (The corresponding call to pop_it
5873 in case of an empty display string is in
5874 next_overlay_string.) */
5876 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5879 /* Set up IT to deliver display elements from the first overlay
5881 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5882 it
->string
= it
->overlay_strings
[0];
5883 it
->from_overlay
= Qnil
;
5884 it
->stop_charpos
= 0;
5885 eassert (STRINGP (it
->string
));
5886 it
->end_charpos
= SCHARS (it
->string
);
5888 it
->base_level_stop
= 0;
5889 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5890 it
->method
= GET_FROM_STRING
;
5891 it
->from_disp_prop_p
= 0;
5893 /* Force paragraph direction to be that of the parent
5895 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5896 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5898 it
->paragraph_embedding
= L2R
;
5900 /* Set up the bidi iterator for this overlay string. */
5903 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5905 it
->bidi_it
.string
.lstring
= it
->string
;
5906 it
->bidi_it
.string
.s
= NULL
;
5907 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5908 it
->bidi_it
.string
.bufpos
= pos
;
5909 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5910 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5911 it
->bidi_it
.w
= it
->w
;
5912 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5917 it
->current
.overlay_string_index
= -1;
5922 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5925 it
->method
= GET_FROM_BUFFER
;
5927 (void) get_overlay_strings_1 (it
, charpos
, 1);
5931 /* Value is non-zero if we found at least one overlay string. */
5932 return STRINGP (it
->string
);
5937 /***********************************************************************
5938 Saving and restoring state
5939 ***********************************************************************/
5941 /* Save current settings of IT on IT->stack. Called, for example,
5942 before setting up IT for an overlay string, to be able to restore
5943 IT's settings to what they were after the overlay string has been
5944 processed. If POSITION is non-NULL, it is the position to save on
5945 the stack instead of IT->position. */
5948 push_it (struct it
*it
, struct text_pos
*position
)
5950 struct iterator_stack_entry
*p
;
5952 eassert (it
->sp
< IT_STACK_SIZE
);
5953 p
= it
->stack
+ it
->sp
;
5955 p
->stop_charpos
= it
->stop_charpos
;
5956 p
->prev_stop
= it
->prev_stop
;
5957 p
->base_level_stop
= it
->base_level_stop
;
5958 p
->cmp_it
= it
->cmp_it
;
5959 eassert (it
->face_id
>= 0);
5960 p
->face_id
= it
->face_id
;
5961 p
->string
= it
->string
;
5962 p
->method
= it
->method
;
5963 p
->from_overlay
= it
->from_overlay
;
5966 case GET_FROM_IMAGE
:
5967 p
->u
.image
.object
= it
->object
;
5968 p
->u
.image
.image_id
= it
->image_id
;
5969 p
->u
.image
.slice
= it
->slice
;
5971 case GET_FROM_STRETCH
:
5972 p
->u
.stretch
.object
= it
->object
;
5975 p
->position
= position
? *position
: it
->position
;
5976 p
->current
= it
->current
;
5977 p
->end_charpos
= it
->end_charpos
;
5978 p
->string_nchars
= it
->string_nchars
;
5980 p
->multibyte_p
= it
->multibyte_p
;
5981 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5982 p
->space_width
= it
->space_width
;
5983 p
->font_height
= it
->font_height
;
5984 p
->voffset
= it
->voffset
;
5985 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5986 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5987 p
->display_ellipsis_p
= 0;
5988 p
->line_wrap
= it
->line_wrap
;
5989 p
->bidi_p
= it
->bidi_p
;
5990 p
->paragraph_embedding
= it
->paragraph_embedding
;
5991 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5994 /* Save the state of the bidi iterator as well. */
5996 bidi_push_it (&it
->bidi_it
);
6000 iterate_out_of_display_property (struct it
*it
)
6002 int buffer_p
= !STRINGP (it
->string
);
6003 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
6004 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
6006 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
6008 /* Maybe initialize paragraph direction. If we are at the beginning
6009 of a new paragraph, next_element_from_buffer may not have a
6010 chance to do that. */
6011 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
6012 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6013 /* prev_stop can be zero, so check against BEGV as well. */
6014 while (it
->bidi_it
.charpos
>= bob
6015 && it
->prev_stop
<= it
->bidi_it
.charpos
6016 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
6017 && it
->bidi_it
.charpos
< eob
)
6018 bidi_move_to_visually_next (&it
->bidi_it
);
6019 /* Record the stop_pos we just crossed, for when we cross it
6021 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
6022 it
->prev_stop
= CHARPOS (it
->position
);
6023 /* If we ended up not where pop_it put us, resync IT's
6024 positional members with the bidi iterator. */
6025 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
6026 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
6028 it
->current
.pos
= it
->position
;
6030 it
->current
.string_pos
= it
->position
;
6033 /* Restore IT's settings from IT->stack. Called, for example, when no
6034 more overlay strings must be processed, and we return to delivering
6035 display elements from a buffer, or when the end of a string from a
6036 `display' property is reached and we return to delivering display
6037 elements from an overlay string, or from a buffer. */
6040 pop_it (struct it
*it
)
6042 struct iterator_stack_entry
*p
;
6043 int from_display_prop
= it
->from_disp_prop_p
;
6045 eassert (it
->sp
> 0);
6047 p
= it
->stack
+ it
->sp
;
6048 it
->stop_charpos
= p
->stop_charpos
;
6049 it
->prev_stop
= p
->prev_stop
;
6050 it
->base_level_stop
= p
->base_level_stop
;
6051 it
->cmp_it
= p
->cmp_it
;
6052 it
->face_id
= p
->face_id
;
6053 it
->current
= p
->current
;
6054 it
->position
= p
->position
;
6055 it
->string
= p
->string
;
6056 it
->from_overlay
= p
->from_overlay
;
6057 if (NILP (it
->string
))
6058 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6059 it
->method
= p
->method
;
6062 case GET_FROM_IMAGE
:
6063 it
->image_id
= p
->u
.image
.image_id
;
6064 it
->object
= p
->u
.image
.object
;
6065 it
->slice
= p
->u
.image
.slice
;
6067 case GET_FROM_STRETCH
:
6068 it
->object
= p
->u
.stretch
.object
;
6070 case GET_FROM_BUFFER
:
6071 it
->object
= it
->w
->contents
;
6073 case GET_FROM_STRING
:
6075 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6077 /* Restore the face_box_p flag, since it could have been
6078 overwritten by the face of the object that we just finished
6081 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6082 it
->object
= it
->string
;
6085 case GET_FROM_DISPLAY_VECTOR
:
6087 it
->method
= GET_FROM_C_STRING
;
6088 else if (STRINGP (it
->string
))
6089 it
->method
= GET_FROM_STRING
;
6092 it
->method
= GET_FROM_BUFFER
;
6093 it
->object
= it
->w
->contents
;
6096 it
->end_charpos
= p
->end_charpos
;
6097 it
->string_nchars
= p
->string_nchars
;
6099 it
->multibyte_p
= p
->multibyte_p
;
6100 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6101 it
->space_width
= p
->space_width
;
6102 it
->font_height
= p
->font_height
;
6103 it
->voffset
= p
->voffset
;
6104 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6105 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6106 it
->line_wrap
= p
->line_wrap
;
6107 it
->bidi_p
= p
->bidi_p
;
6108 it
->paragraph_embedding
= p
->paragraph_embedding
;
6109 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6112 bidi_pop_it (&it
->bidi_it
);
6113 /* Bidi-iterate until we get out of the portion of text, if any,
6114 covered by a `display' text property or by an overlay with
6115 `display' property. (We cannot just jump there, because the
6116 internal coherency of the bidi iterator state can not be
6117 preserved across such jumps.) We also must determine the
6118 paragraph base direction if the overlay we just processed is
6119 at the beginning of a new paragraph. */
6120 if (from_display_prop
6121 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6122 iterate_out_of_display_property (it
);
6124 eassert ((BUFFERP (it
->object
)
6125 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6126 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6127 || (STRINGP (it
->object
)
6128 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6129 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6130 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6136 /***********************************************************************
6138 ***********************************************************************/
6140 /* Set IT's current position to the previous line start. */
6143 back_to_previous_line_start (struct it
*it
)
6145 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6148 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6152 /* Move IT to the next line start.
6154 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
6155 we skipped over part of the text (as opposed to moving the iterator
6156 continuously over the text). Otherwise, don't change the value
6159 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6160 iterator on the newline, if it was found.
6162 Newlines may come from buffer text, overlay strings, or strings
6163 displayed via the `display' property. That's the reason we can't
6164 simply use find_newline_no_quit.
6166 Note that this function may not skip over invisible text that is so
6167 because of text properties and immediately follows a newline. If
6168 it would, function reseat_at_next_visible_line_start, when called
6169 from set_iterator_to_next, would effectively make invisible
6170 characters following a newline part of the wrong glyph row, which
6171 leads to wrong cursor motion. */
6174 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
6175 struct bidi_it
*bidi_it_prev
)
6177 ptrdiff_t old_selective
;
6178 int newline_found_p
, n
;
6179 const int MAX_NEWLINE_DISTANCE
= 500;
6181 /* If already on a newline, just consume it to avoid unintended
6182 skipping over invisible text below. */
6183 if (it
->what
== IT_CHARACTER
6185 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6187 if (it
->bidi_p
&& bidi_it_prev
)
6188 *bidi_it_prev
= it
->bidi_it
;
6189 set_iterator_to_next (it
, 0);
6194 /* Don't handle selective display in the following. It's (a)
6195 unnecessary because it's done by the caller, and (b) leads to an
6196 infinite recursion because next_element_from_ellipsis indirectly
6197 calls this function. */
6198 old_selective
= it
->selective
;
6201 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6202 from buffer text. */
6203 for (n
= newline_found_p
= 0;
6204 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6205 n
+= STRINGP (it
->string
) ? 0 : 1)
6207 if (!get_next_display_element (it
))
6209 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6210 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6211 *bidi_it_prev
= it
->bidi_it
;
6212 set_iterator_to_next (it
, 0);
6215 /* If we didn't find a newline near enough, see if we can use a
6217 if (!newline_found_p
)
6219 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6220 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6224 eassert (!STRINGP (it
->string
));
6226 /* If there isn't any `display' property in sight, and no
6227 overlays, we can just use the position of the newline in
6229 if (it
->stop_charpos
>= limit
6230 || ((pos
= Fnext_single_property_change (make_number (start
),
6232 make_number (limit
)),
6234 && next_overlay_change (start
) == ZV
))
6238 IT_CHARPOS (*it
) = limit
;
6239 IT_BYTEPOS (*it
) = bytepos
;
6243 struct bidi_it bprev
;
6245 /* Help bidi.c avoid expensive searches for display
6246 properties and overlays, by telling it that there are
6247 none up to `limit'. */
6248 if (it
->bidi_it
.disp_pos
< limit
)
6250 it
->bidi_it
.disp_pos
= limit
;
6251 it
->bidi_it
.disp_prop
= 0;
6254 bprev
= it
->bidi_it
;
6255 bidi_move_to_visually_next (&it
->bidi_it
);
6256 } while (it
->bidi_it
.charpos
!= limit
);
6257 IT_CHARPOS (*it
) = limit
;
6258 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6260 *bidi_it_prev
= bprev
;
6262 *skipped_p
= newline_found_p
= true;
6266 while (get_next_display_element (it
)
6267 && !newline_found_p
)
6269 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6270 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6271 *bidi_it_prev
= it
->bidi_it
;
6272 set_iterator_to_next (it
, 0);
6277 it
->selective
= old_selective
;
6278 return newline_found_p
;
6282 /* Set IT's current position to the previous visible line start. Skip
6283 invisible text that is so either due to text properties or due to
6284 selective display. Caution: this does not change IT->current_x and
6288 back_to_previous_visible_line_start (struct it
*it
)
6290 while (IT_CHARPOS (*it
) > BEGV
)
6292 back_to_previous_line_start (it
);
6294 if (IT_CHARPOS (*it
) <= BEGV
)
6297 /* If selective > 0, then lines indented more than its value are
6299 if (it
->selective
> 0
6300 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6304 /* Check the newline before point for invisibility. */
6307 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6308 Qinvisible
, it
->window
);
6309 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6313 if (IT_CHARPOS (*it
) <= BEGV
)
6318 void *it2data
= NULL
;
6321 Lisp_Object val
, overlay
;
6323 SAVE_IT (it2
, *it
, it2data
);
6325 /* If newline is part of a composition, continue from start of composition */
6326 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6327 && beg
< IT_CHARPOS (*it
))
6330 /* If newline is replaced by a display property, find start of overlay
6331 or interval and continue search from that point. */
6332 pos
= --IT_CHARPOS (it2
);
6335 bidi_unshelve_cache (NULL
, 0);
6336 it2
.string_from_display_prop_p
= 0;
6337 it2
.from_disp_prop_p
= 0;
6338 if (handle_display_prop (&it2
) == HANDLED_RETURN
6339 && !NILP (val
= get_char_property_and_overlay
6340 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6341 && (OVERLAYP (overlay
)
6342 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6343 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6345 RESTORE_IT (it
, it
, it2data
);
6349 /* Newline is not replaced by anything -- so we are done. */
6350 RESTORE_IT (it
, it
, it2data
);
6356 IT_CHARPOS (*it
) = beg
;
6357 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6361 it
->continuation_lines_width
= 0;
6363 eassert (IT_CHARPOS (*it
) >= BEGV
);
6364 eassert (IT_CHARPOS (*it
) == BEGV
6365 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6370 /* Reseat iterator IT at the previous visible line start. Skip
6371 invisible text that is so either due to text properties or due to
6372 selective display. At the end, update IT's overlay information,
6373 face information etc. */
6376 reseat_at_previous_visible_line_start (struct it
*it
)
6378 back_to_previous_visible_line_start (it
);
6379 reseat (it
, it
->current
.pos
, 1);
6384 /* Reseat iterator IT on the next visible line start in the current
6385 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6386 preceding the line start. Skip over invisible text that is so
6387 because of selective display. Compute faces, overlays etc at the
6388 new position. Note that this function does not skip over text that
6389 is invisible because of text properties. */
6392 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6394 int newline_found_p
, skipped_p
= 0;
6395 struct bidi_it bidi_it_prev
;
6397 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6399 /* Skip over lines that are invisible because they are indented
6400 more than the value of IT->selective. */
6401 if (it
->selective
> 0)
6402 while (IT_CHARPOS (*it
) < ZV
6403 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6406 eassert (IT_BYTEPOS (*it
) == BEGV
6407 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6409 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6412 /* Position on the newline if that's what's requested. */
6413 if (on_newline_p
&& newline_found_p
)
6415 if (STRINGP (it
->string
))
6417 if (IT_STRING_CHARPOS (*it
) > 0)
6421 --IT_STRING_CHARPOS (*it
);
6422 --IT_STRING_BYTEPOS (*it
);
6426 /* We need to restore the bidi iterator to the state
6427 it had on the newline, and resync the IT's
6428 position with that. */
6429 it
->bidi_it
= bidi_it_prev
;
6430 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6431 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6435 else if (IT_CHARPOS (*it
) > BEGV
)
6444 /* We need to restore the bidi iterator to the state it
6445 had on the newline and resync IT with that. */
6446 it
->bidi_it
= bidi_it_prev
;
6447 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6448 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6450 reseat (it
, it
->current
.pos
, 0);
6454 reseat (it
, it
->current
.pos
, 0);
6461 /***********************************************************************
6462 Changing an iterator's position
6463 ***********************************************************************/
6465 /* Change IT's current position to POS in current_buffer. If FORCE_P
6466 is non-zero, always check for text properties at the new position.
6467 Otherwise, text properties are only looked up if POS >=
6468 IT->check_charpos of a property. */
6471 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6473 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6475 reseat_1 (it
, pos
, 0);
6477 /* Determine where to check text properties. Avoid doing it
6478 where possible because text property lookup is very expensive. */
6480 || CHARPOS (pos
) > it
->stop_charpos
6481 || CHARPOS (pos
) < original_pos
)
6485 /* For bidi iteration, we need to prime prev_stop and
6486 base_level_stop with our best estimations. */
6487 /* Implementation note: Of course, POS is not necessarily a
6488 stop position, so assigning prev_pos to it is a lie; we
6489 should have called compute_stop_backwards. However, if
6490 the current buffer does not include any R2L characters,
6491 that call would be a waste of cycles, because the
6492 iterator will never move back, and thus never cross this
6493 "fake" stop position. So we delay that backward search
6494 until the time we really need it, in next_element_from_buffer. */
6495 if (CHARPOS (pos
) != it
->prev_stop
)
6496 it
->prev_stop
= CHARPOS (pos
);
6497 if (CHARPOS (pos
) < it
->base_level_stop
)
6498 it
->base_level_stop
= 0; /* meaning it's unknown */
6504 it
->prev_stop
= it
->base_level_stop
= 0;
6513 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6514 IT->stop_pos to POS, also. */
6517 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6519 /* Don't call this function when scanning a C string. */
6520 eassert (it
->s
== NULL
);
6522 /* POS must be a reasonable value. */
6523 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6525 it
->current
.pos
= it
->position
= pos
;
6526 it
->end_charpos
= ZV
;
6528 it
->current
.dpvec_index
= -1;
6529 it
->current
.overlay_string_index
= -1;
6530 IT_STRING_CHARPOS (*it
) = -1;
6531 IT_STRING_BYTEPOS (*it
) = -1;
6533 it
->method
= GET_FROM_BUFFER
;
6534 it
->object
= it
->w
->contents
;
6535 it
->area
= TEXT_AREA
;
6536 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6538 it
->string_from_display_prop_p
= 0;
6539 it
->string_from_prefix_prop_p
= 0;
6541 it
->from_disp_prop_p
= 0;
6542 it
->face_before_selective_p
= 0;
6545 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6547 bidi_unshelve_cache (NULL
, 0);
6548 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6549 it
->bidi_it
.string
.s
= NULL
;
6550 it
->bidi_it
.string
.lstring
= Qnil
;
6551 it
->bidi_it
.string
.bufpos
= 0;
6552 it
->bidi_it
.string
.from_disp_str
= 0;
6553 it
->bidi_it
.string
.unibyte
= 0;
6554 it
->bidi_it
.w
= it
->w
;
6559 it
->stop_charpos
= CHARPOS (pos
);
6560 it
->base_level_stop
= CHARPOS (pos
);
6562 /* This make the information stored in it->cmp_it invalidate. */
6567 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6568 If S is non-null, it is a C string to iterate over. Otherwise,
6569 STRING gives a Lisp string to iterate over.
6571 If PRECISION > 0, don't return more then PRECISION number of
6572 characters from the string.
6574 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6575 characters have been returned. FIELD_WIDTH < 0 means an infinite
6578 MULTIBYTE = 0 means disable processing of multibyte characters,
6579 MULTIBYTE > 0 means enable it,
6580 MULTIBYTE < 0 means use IT->multibyte_p.
6582 IT must be initialized via a prior call to init_iterator before
6583 calling this function. */
6586 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6587 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6590 /* No text property checks performed by default, but see below. */
6591 it
->stop_charpos
= -1;
6593 /* Set iterator position and end position. */
6594 memset (&it
->current
, 0, sizeof it
->current
);
6595 it
->current
.overlay_string_index
= -1;
6596 it
->current
.dpvec_index
= -1;
6597 eassert (charpos
>= 0);
6599 /* If STRING is specified, use its multibyteness, otherwise use the
6600 setting of MULTIBYTE, if specified. */
6602 it
->multibyte_p
= multibyte
> 0;
6604 /* Bidirectional reordering of strings is controlled by the default
6605 value of bidi-display-reordering. Don't try to reorder while
6606 loading loadup.el, as the necessary character property tables are
6607 not yet available. */
6610 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6614 eassert (STRINGP (string
));
6615 it
->string
= string
;
6617 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6618 it
->method
= GET_FROM_STRING
;
6619 it
->current
.string_pos
= string_pos (charpos
, string
);
6623 it
->bidi_it
.string
.lstring
= string
;
6624 it
->bidi_it
.string
.s
= NULL
;
6625 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6626 it
->bidi_it
.string
.bufpos
= 0;
6627 it
->bidi_it
.string
.from_disp_str
= 0;
6628 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6629 it
->bidi_it
.w
= it
->w
;
6630 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6631 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6636 it
->s
= (const unsigned char *) s
;
6639 /* Note that we use IT->current.pos, not it->current.string_pos,
6640 for displaying C strings. */
6641 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6642 if (it
->multibyte_p
)
6644 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6645 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6649 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6650 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6655 it
->bidi_it
.string
.lstring
= Qnil
;
6656 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6657 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6658 it
->bidi_it
.string
.bufpos
= 0;
6659 it
->bidi_it
.string
.from_disp_str
= 0;
6660 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6661 it
->bidi_it
.w
= it
->w
;
6662 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6665 it
->method
= GET_FROM_C_STRING
;
6668 /* PRECISION > 0 means don't return more than PRECISION characters
6670 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6672 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6674 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6677 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6678 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6679 FIELD_WIDTH < 0 means infinite field width. This is useful for
6680 padding with `-' at the end of a mode line. */
6681 if (field_width
< 0)
6682 field_width
= INFINITY
;
6683 /* Implementation note: We deliberately don't enlarge
6684 it->bidi_it.string.schars here to fit it->end_charpos, because
6685 the bidi iterator cannot produce characters out of thin air. */
6686 if (field_width
> it
->end_charpos
- charpos
)
6687 it
->end_charpos
= charpos
+ field_width
;
6689 /* Use the standard display table for displaying strings. */
6690 if (DISP_TABLE_P (Vstandard_display_table
))
6691 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6693 it
->stop_charpos
= charpos
;
6694 it
->prev_stop
= charpos
;
6695 it
->base_level_stop
= 0;
6698 it
->bidi_it
.first_elt
= 1;
6699 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6700 it
->bidi_it
.disp_pos
= -1;
6702 if (s
== NULL
&& it
->multibyte_p
)
6704 ptrdiff_t endpos
= SCHARS (it
->string
);
6705 if (endpos
> it
->end_charpos
)
6706 endpos
= it
->end_charpos
;
6707 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6715 /***********************************************************************
6717 ***********************************************************************/
6719 /* Map enum it_method value to corresponding next_element_from_* function. */
6721 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6723 next_element_from_buffer
,
6724 next_element_from_display_vector
,
6725 next_element_from_string
,
6726 next_element_from_c_string
,
6727 next_element_from_image
,
6728 next_element_from_stretch
6731 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6734 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6735 (possibly with the following characters). */
6737 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6738 ((IT)->cmp_it.id >= 0 \
6739 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6740 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6741 END_CHARPOS, (IT)->w, \
6742 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6746 /* Lookup the char-table Vglyphless_char_display for character C (-1
6747 if we want information for no-font case), and return the display
6748 method symbol. By side-effect, update it->what and
6749 it->glyphless_method. This function is called from
6750 get_next_display_element for each character element, and from
6751 x_produce_glyphs when no suitable font was found. */
6754 lookup_glyphless_char_display (int c
, struct it
*it
)
6756 Lisp_Object glyphless_method
= Qnil
;
6758 if (CHAR_TABLE_P (Vglyphless_char_display
)
6759 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6763 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6764 if (CONSP (glyphless_method
))
6765 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6766 ? XCAR (glyphless_method
)
6767 : XCDR (glyphless_method
);
6770 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6774 if (NILP (glyphless_method
))
6777 /* The default is to display the character by a proper font. */
6779 /* The default for the no-font case is to display an empty box. */
6780 glyphless_method
= Qempty_box
;
6782 if (EQ (glyphless_method
, Qzero_width
))
6785 return glyphless_method
;
6786 /* This method can't be used for the no-font case. */
6787 glyphless_method
= Qempty_box
;
6789 if (EQ (glyphless_method
, Qthin_space
))
6790 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6791 else if (EQ (glyphless_method
, Qempty_box
))
6792 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6793 else if (EQ (glyphless_method
, Qhex_code
))
6794 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6795 else if (STRINGP (glyphless_method
))
6796 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6799 /* Invalid value. We use the default method. */
6800 glyphless_method
= Qnil
;
6803 it
->what
= IT_GLYPHLESS
;
6804 return glyphless_method
;
6807 /* Merge escape glyph face and cache the result. */
6809 static struct frame
*last_escape_glyph_frame
= NULL
;
6810 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6811 static int last_escape_glyph_merged_face_id
= 0;
6814 merge_escape_glyph_face (struct it
*it
)
6818 if (it
->f
== last_escape_glyph_frame
6819 && it
->face_id
== last_escape_glyph_face_id
)
6820 face_id
= last_escape_glyph_merged_face_id
;
6823 /* Merge the `escape-glyph' face into the current face. */
6824 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6825 last_escape_glyph_frame
= it
->f
;
6826 last_escape_glyph_face_id
= it
->face_id
;
6827 last_escape_glyph_merged_face_id
= face_id
;
6832 /* Likewise for glyphless glyph face. */
6834 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6835 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6836 static int last_glyphless_glyph_merged_face_id
= 0;
6839 merge_glyphless_glyph_face (struct it
*it
)
6843 if (it
->f
== last_glyphless_glyph_frame
6844 && it
->face_id
== last_glyphless_glyph_face_id
)
6845 face_id
= last_glyphless_glyph_merged_face_id
;
6848 /* Merge the `glyphless-char' face into the current face. */
6849 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6850 last_glyphless_glyph_frame
= it
->f
;
6851 last_glyphless_glyph_face_id
= it
->face_id
;
6852 last_glyphless_glyph_merged_face_id
= face_id
;
6857 /* Load IT's display element fields with information about the next
6858 display element from the current position of IT. Value is zero if
6859 end of buffer (or C string) is reached. */
6862 get_next_display_element (struct it
*it
)
6864 /* Non-zero means that we found a display element. Zero means that
6865 we hit the end of what we iterate over. Performance note: the
6866 function pointer `method' used here turns out to be faster than
6867 using a sequence of if-statements. */
6871 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6873 if (it
->what
== IT_CHARACTER
)
6875 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6876 and only if (a) the resolved directionality of that character
6878 /* FIXME: Do we need an exception for characters from display
6880 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6881 it
->c
= bidi_mirror_char (it
->c
);
6882 /* Map via display table or translate control characters.
6883 IT->c, IT->len etc. have been set to the next character by
6884 the function call above. If we have a display table, and it
6885 contains an entry for IT->c, translate it. Don't do this if
6886 IT->c itself comes from a display table, otherwise we could
6887 end up in an infinite recursion. (An alternative could be to
6888 count the recursion depth of this function and signal an
6889 error when a certain maximum depth is reached.) Is it worth
6891 if (success_p
&& it
->dpvec
== NULL
)
6894 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6895 int nonascii_space_p
= 0;
6896 int nonascii_hyphen_p
= 0;
6897 int c
= it
->c
; /* This is the character to display. */
6899 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6901 eassert (SINGLE_BYTE_CHAR_P (c
));
6902 if (unibyte_display_via_language_environment
)
6904 c
= DECODE_CHAR (unibyte
, c
);
6906 c
= BYTE8_TO_CHAR (it
->c
);
6909 c
= BYTE8_TO_CHAR (it
->c
);
6913 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6916 struct Lisp_Vector
*v
= XVECTOR (dv
);
6918 /* Return the first character from the display table
6919 entry, if not empty. If empty, don't display the
6920 current character. */
6923 it
->dpvec_char_len
= it
->len
;
6924 it
->dpvec
= v
->contents
;
6925 it
->dpend
= v
->contents
+ v
->header
.size
;
6926 it
->current
.dpvec_index
= 0;
6927 it
->dpvec_face_id
= -1;
6928 it
->saved_face_id
= it
->face_id
;
6929 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6934 set_iterator_to_next (it
, 0);
6939 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6941 if (it
->what
== IT_GLYPHLESS
)
6943 /* Don't display this character. */
6944 set_iterator_to_next (it
, 0);
6948 /* If `nobreak-char-display' is non-nil, we display
6949 non-ASCII spaces and hyphens specially. */
6950 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6953 nonascii_space_p
= true;
6954 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6955 nonascii_hyphen_p
= true;
6958 /* Translate control characters into `\003' or `^C' form.
6959 Control characters coming from a display table entry are
6960 currently not translated because we use IT->dpvec to hold
6961 the translation. This could easily be changed but I
6962 don't believe that it is worth doing.
6964 The characters handled by `nobreak-char-display' must be
6967 Non-printable characters and raw-byte characters are also
6968 translated to octal form. */
6969 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
6970 ? (it
->area
!= TEXT_AREA
6971 /* In mode line, treat \n, \t like other crl chars. */
6974 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6975 || (c
!= '\n' && c
!= '\t'))
6977 || nonascii_hyphen_p
6979 || ! CHAR_PRINTABLE_P (c
))))
6981 /* C is a control character, non-ASCII space/hyphen,
6982 raw-byte, or a non-printable character which must be
6983 displayed either as '\003' or as `^C' where the '\\'
6984 and '^' can be defined in the display table. Fill
6985 IT->ctl_chars with glyphs for what we have to
6986 display. Then, set IT->dpvec to these glyphs. */
6993 /* Handle control characters with ^. */
6995 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6999 g
= '^'; /* default glyph for Control */
7000 /* Set IT->ctl_chars[0] to the glyph for `^'. */
7002 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7004 g
= GLYPH_CODE_CHAR (gc
);
7005 lface_id
= GLYPH_CODE_FACE (gc
);
7009 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7010 : merge_escape_glyph_face (it
));
7012 XSETINT (it
->ctl_chars
[0], g
);
7013 XSETINT (it
->ctl_chars
[1], c
^ 0100);
7015 goto display_control
;
7018 /* Handle non-ascii space in the mode where it only gets
7021 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7023 /* Merge `nobreak-space' into the current face. */
7024 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7026 XSETINT (it
->ctl_chars
[0], ' ');
7028 goto display_control
;
7031 /* Handle sequences that start with the "escape glyph". */
7033 /* the default escape glyph is \. */
7034 escape_glyph
= '\\';
7037 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7039 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7040 lface_id
= GLYPH_CODE_FACE (gc
);
7044 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7045 : merge_escape_glyph_face (it
));
7047 /* Draw non-ASCII hyphen with just highlighting: */
7049 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7051 XSETINT (it
->ctl_chars
[0], '-');
7053 goto display_control
;
7056 /* Draw non-ASCII space/hyphen with escape glyph: */
7058 if (nonascii_space_p
|| nonascii_hyphen_p
)
7060 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7061 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7063 goto display_control
;
7070 if (CHAR_BYTE8_P (c
))
7071 /* Display \200 instead of \17777600. */
7072 c
= CHAR_TO_BYTE8 (c
);
7073 len
= sprintf (str
, "%03o", c
);
7075 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7076 for (i
= 0; i
< len
; i
++)
7077 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7082 /* Set up IT->dpvec and return first character from it. */
7083 it
->dpvec_char_len
= it
->len
;
7084 it
->dpvec
= it
->ctl_chars
;
7085 it
->dpend
= it
->dpvec
+ ctl_len
;
7086 it
->current
.dpvec_index
= 0;
7087 it
->dpvec_face_id
= face_id
;
7088 it
->saved_face_id
= it
->face_id
;
7089 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7093 it
->char_to_display
= c
;
7097 it
->char_to_display
= it
->c
;
7101 #ifdef HAVE_WINDOW_SYSTEM
7102 /* Adjust face id for a multibyte character. There are no multibyte
7103 character in unibyte text. */
7104 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7107 && FRAME_WINDOW_P (it
->f
))
7109 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7111 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7113 /* Automatic composition with glyph-string. */
7114 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7116 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7120 ptrdiff_t pos
= (it
->s
? -1
7121 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7122 : IT_CHARPOS (*it
));
7125 if (it
->what
== IT_CHARACTER
)
7126 c
= it
->char_to_display
;
7129 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7133 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7134 /* TAB in a composition means display glyphs with
7135 padding space on the left or right. */
7136 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7139 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7142 #endif /* HAVE_WINDOW_SYSTEM */
7145 /* Is this character the last one of a run of characters with
7146 box? If yes, set IT->end_of_box_run_p to 1. */
7150 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7152 int face_id
= underlying_face_id (it
);
7153 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7157 if (face
->box
== FACE_NO_BOX
)
7159 /* If the box comes from face properties in a
7160 display string, check faces in that string. */
7161 int string_face_id
= face_after_it_pos (it
);
7162 it
->end_of_box_run_p
7163 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7166 /* Otherwise, the box comes from the underlying face.
7167 If this is the last string character displayed, check
7168 the next buffer location. */
7169 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7170 /* n_overlay_strings is unreliable unless
7171 overlay_string_index is non-negative. */
7172 && ((it
->current
.overlay_string_index
>= 0
7173 && (it
->current
.overlay_string_index
7174 == it
->n_overlay_strings
- 1))
7175 /* A string from display property. */
7176 || it
->from_disp_prop_p
))
7180 struct text_pos pos
= it
->current
.pos
;
7182 /* For a string from a display property, the next
7183 buffer position is stored in the 'position'
7184 member of the iteration stack slot below the
7185 current one, see handle_single_display_spec. By
7186 contrast, it->current.pos was is not yet updated
7187 to point to that buffer position; that will
7188 happen in pop_it, after we finish displaying the
7189 current string. Note that we already checked
7190 above that it->sp is positive, so subtracting one
7192 if (it
->from_disp_prop_p
)
7193 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7195 INC_TEXT_POS (pos
, it
->multibyte_p
);
7197 if (CHARPOS (pos
) >= ZV
)
7198 it
->end_of_box_run_p
= true;
7201 next_face_id
= face_at_buffer_position
7202 (it
->w
, CHARPOS (pos
), &ignore
,
7203 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, 0, -1);
7204 it
->end_of_box_run_p
7205 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7211 /* next_element_from_display_vector sets this flag according to
7212 faces of the display vector glyphs, see there. */
7213 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7215 int face_id
= face_after_it_pos (it
);
7216 it
->end_of_box_run_p
7217 = (face_id
!= it
->face_id
7218 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7221 /* If we reached the end of the object we've been iterating (e.g., a
7222 display string or an overlay string), and there's something on
7223 IT->stack, proceed with what's on the stack. It doesn't make
7224 sense to return zero if there's unprocessed stuff on the stack,
7225 because otherwise that stuff will never be displayed. */
7226 if (!success_p
&& it
->sp
> 0)
7228 set_iterator_to_next (it
, 0);
7229 success_p
= get_next_display_element (it
);
7232 /* Value is 0 if end of buffer or string reached. */
7237 /* Move IT to the next display element.
7239 RESEAT_P non-zero means if called on a newline in buffer text,
7240 skip to the next visible line start.
7242 Functions get_next_display_element and set_iterator_to_next are
7243 separate because I find this arrangement easier to handle than a
7244 get_next_display_element function that also increments IT's
7245 position. The way it is we can first look at an iterator's current
7246 display element, decide whether it fits on a line, and if it does,
7247 increment the iterator position. The other way around we probably
7248 would either need a flag indicating whether the iterator has to be
7249 incremented the next time, or we would have to implement a
7250 decrement position function which would not be easy to write. */
7253 set_iterator_to_next (struct it
*it
, int reseat_p
)
7255 /* Reset flags indicating start and end of a sequence of characters
7256 with box. Reset them at the start of this function because
7257 moving the iterator to a new position might set them. */
7258 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
7262 case GET_FROM_BUFFER
:
7263 /* The current display element of IT is a character from
7264 current_buffer. Advance in the buffer, and maybe skip over
7265 invisible lines that are so because of selective display. */
7266 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7267 reseat_at_next_visible_line_start (it
, 0);
7268 else if (it
->cmp_it
.id
>= 0)
7270 /* We are currently getting glyphs from a composition. */
7275 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7276 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7277 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7279 it
->cmp_it
.from
= it
->cmp_it
.to
;
7284 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7286 it
->end_charpos
, Qnil
);
7289 else if (! it
->cmp_it
.reversed_p
)
7291 /* Composition created while scanning forward. */
7292 /* Update IT's char/byte positions to point to the first
7293 character of the next grapheme cluster, or to the
7294 character visually after the current composition. */
7295 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7296 bidi_move_to_visually_next (&it
->bidi_it
);
7297 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7298 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7300 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7302 /* Proceed to the next grapheme cluster. */
7303 it
->cmp_it
.from
= it
->cmp_it
.to
;
7307 /* No more grapheme clusters in this composition.
7308 Find the next stop position. */
7309 ptrdiff_t stop
= it
->end_charpos
;
7310 if (it
->bidi_it
.scan_dir
< 0)
7311 /* Now we are scanning backward and don't know
7314 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7315 IT_BYTEPOS (*it
), stop
, Qnil
);
7320 /* Composition created while scanning backward. */
7321 /* Update IT's char/byte positions to point to the last
7322 character of the previous grapheme cluster, or the
7323 character visually after the current composition. */
7324 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7325 bidi_move_to_visually_next (&it
->bidi_it
);
7326 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7327 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7328 if (it
->cmp_it
.from
> 0)
7330 /* Proceed to the previous grapheme cluster. */
7331 it
->cmp_it
.to
= it
->cmp_it
.from
;
7335 /* No more grapheme clusters in this composition.
7336 Find the next stop position. */
7337 ptrdiff_t stop
= it
->end_charpos
;
7338 if (it
->bidi_it
.scan_dir
< 0)
7339 /* Now we are scanning backward and don't know
7342 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7343 IT_BYTEPOS (*it
), stop
, Qnil
);
7349 eassert (it
->len
!= 0);
7353 IT_BYTEPOS (*it
) += it
->len
;
7354 IT_CHARPOS (*it
) += 1;
7358 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7359 /* If this is a new paragraph, determine its base
7360 direction (a.k.a. its base embedding level). */
7361 if (it
->bidi_it
.new_paragraph
)
7362 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7363 bidi_move_to_visually_next (&it
->bidi_it
);
7364 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7365 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7366 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7368 /* As the scan direction was changed, we must
7369 re-compute the stop position for composition. */
7370 ptrdiff_t stop
= it
->end_charpos
;
7371 if (it
->bidi_it
.scan_dir
< 0)
7373 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7374 IT_BYTEPOS (*it
), stop
, Qnil
);
7377 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7381 case GET_FROM_C_STRING
:
7382 /* Current display element of IT is from a C string. */
7384 /* If the string position is beyond string's end, it means
7385 next_element_from_c_string is padding the string with
7386 blanks, in which case we bypass the bidi iterator,
7387 because it cannot deal with such virtual characters. */
7388 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7390 IT_BYTEPOS (*it
) += it
->len
;
7391 IT_CHARPOS (*it
) += 1;
7395 bidi_move_to_visually_next (&it
->bidi_it
);
7396 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7397 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7401 case GET_FROM_DISPLAY_VECTOR
:
7402 /* Current display element of IT is from a display table entry.
7403 Advance in the display table definition. Reset it to null if
7404 end reached, and continue with characters from buffers/
7406 ++it
->current
.dpvec_index
;
7408 /* Restore face of the iterator to what they were before the
7409 display vector entry (these entries may contain faces). */
7410 it
->face_id
= it
->saved_face_id
;
7412 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7414 int recheck_faces
= it
->ellipsis_p
;
7417 it
->method
= GET_FROM_C_STRING
;
7418 else if (STRINGP (it
->string
))
7419 it
->method
= GET_FROM_STRING
;
7422 it
->method
= GET_FROM_BUFFER
;
7423 it
->object
= it
->w
->contents
;
7427 it
->current
.dpvec_index
= -1;
7429 /* Skip over characters which were displayed via IT->dpvec. */
7430 if (it
->dpvec_char_len
< 0)
7431 reseat_at_next_visible_line_start (it
, 1);
7432 else if (it
->dpvec_char_len
> 0)
7434 if (it
->method
== GET_FROM_STRING
7435 && it
->current
.overlay_string_index
>= 0
7436 && it
->n_overlay_strings
> 0)
7437 it
->ignore_overlay_strings_at_pos_p
= true;
7438 it
->len
= it
->dpvec_char_len
;
7439 set_iterator_to_next (it
, reseat_p
);
7442 /* Maybe recheck faces after display vector. */
7444 it
->stop_charpos
= IT_CHARPOS (*it
);
7448 case GET_FROM_STRING
:
7449 /* Current display element is a character from a Lisp string. */
7450 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7451 /* Don't advance past string end. These conditions are true
7452 when set_iterator_to_next is called at the end of
7453 get_next_display_element, in which case the Lisp string is
7454 already exhausted, and all we want is pop the iterator
7456 if (it
->current
.overlay_string_index
>= 0)
7458 /* This is an overlay string, so there's no padding with
7459 spaces, and the number of characters in the string is
7460 where the string ends. */
7461 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7462 goto consider_string_end
;
7466 /* Not an overlay string. There could be padding, so test
7467 against it->end_charpos. */
7468 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7469 goto consider_string_end
;
7471 if (it
->cmp_it
.id
>= 0)
7477 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7478 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7479 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7480 it
->cmp_it
.from
= it
->cmp_it
.to
;
7484 composition_compute_stop_pos (&it
->cmp_it
,
7485 IT_STRING_CHARPOS (*it
),
7486 IT_STRING_BYTEPOS (*it
),
7487 it
->end_charpos
, it
->string
);
7490 else if (! it
->cmp_it
.reversed_p
)
7492 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7493 bidi_move_to_visually_next (&it
->bidi_it
);
7494 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7495 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7497 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7498 it
->cmp_it
.from
= it
->cmp_it
.to
;
7501 ptrdiff_t stop
= it
->end_charpos
;
7502 if (it
->bidi_it
.scan_dir
< 0)
7504 composition_compute_stop_pos (&it
->cmp_it
,
7505 IT_STRING_CHARPOS (*it
),
7506 IT_STRING_BYTEPOS (*it
), stop
,
7512 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7513 bidi_move_to_visually_next (&it
->bidi_it
);
7514 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7515 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7516 if (it
->cmp_it
.from
> 0)
7517 it
->cmp_it
.to
= it
->cmp_it
.from
;
7520 ptrdiff_t stop
= it
->end_charpos
;
7521 if (it
->bidi_it
.scan_dir
< 0)
7523 composition_compute_stop_pos (&it
->cmp_it
,
7524 IT_STRING_CHARPOS (*it
),
7525 IT_STRING_BYTEPOS (*it
), stop
,
7533 /* If the string position is beyond string's end, it
7534 means next_element_from_string is padding the string
7535 with blanks, in which case we bypass the bidi
7536 iterator, because it cannot deal with such virtual
7538 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7540 IT_STRING_BYTEPOS (*it
) += it
->len
;
7541 IT_STRING_CHARPOS (*it
) += 1;
7545 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7547 bidi_move_to_visually_next (&it
->bidi_it
);
7548 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7549 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7550 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7552 ptrdiff_t stop
= it
->end_charpos
;
7554 if (it
->bidi_it
.scan_dir
< 0)
7556 composition_compute_stop_pos (&it
->cmp_it
,
7557 IT_STRING_CHARPOS (*it
),
7558 IT_STRING_BYTEPOS (*it
), stop
,
7564 consider_string_end
:
7566 if (it
->current
.overlay_string_index
>= 0)
7568 /* IT->string is an overlay string. Advance to the
7569 next, if there is one. */
7570 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7573 next_overlay_string (it
);
7575 setup_for_ellipsis (it
, 0);
7580 /* IT->string is not an overlay string. If we reached
7581 its end, and there is something on IT->stack, proceed
7582 with what is on the stack. This can be either another
7583 string, this time an overlay string, or a buffer. */
7584 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7588 if (it
->method
== GET_FROM_STRING
)
7589 goto consider_string_end
;
7594 case GET_FROM_IMAGE
:
7595 case GET_FROM_STRETCH
:
7596 /* The position etc with which we have to proceed are on
7597 the stack. The position may be at the end of a string,
7598 if the `display' property takes up the whole string. */
7599 eassert (it
->sp
> 0);
7601 if (it
->method
== GET_FROM_STRING
)
7602 goto consider_string_end
;
7606 /* There are no other methods defined, so this should be a bug. */
7610 eassert (it
->method
!= GET_FROM_STRING
7611 || (STRINGP (it
->string
)
7612 && IT_STRING_CHARPOS (*it
) >= 0));
7615 /* Load IT's display element fields with information about the next
7616 display element which comes from a display table entry or from the
7617 result of translating a control character to one of the forms `^C'
7620 IT->dpvec holds the glyphs to return as characters.
7621 IT->saved_face_id holds the face id before the display vector--it
7622 is restored into IT->face_id in set_iterator_to_next. */
7625 next_element_from_display_vector (struct it
*it
)
7628 int prev_face_id
= it
->face_id
;
7632 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7634 it
->face_id
= it
->saved_face_id
;
7636 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7637 That seemed totally bogus - so I changed it... */
7638 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7640 if (GLYPH_CODE_P (gc
))
7642 struct face
*this_face
, *prev_face
, *next_face
;
7644 it
->c
= GLYPH_CODE_CHAR (gc
);
7645 it
->len
= CHAR_BYTES (it
->c
);
7647 /* The entry may contain a face id to use. Such a face id is
7648 the id of a Lisp face, not a realized face. A face id of
7649 zero means no face is specified. */
7650 if (it
->dpvec_face_id
>= 0)
7651 it
->face_id
= it
->dpvec_face_id
;
7654 int lface_id
= GLYPH_CODE_FACE (gc
);
7656 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7660 /* Glyphs in the display vector could have the box face, so we
7661 need to set the related flags in the iterator, as
7663 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7664 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7666 /* Is this character the first character of a box-face run? */
7667 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7669 || prev_face
->box
== FACE_NO_BOX
));
7671 /* For the last character of the box-face run, we need to look
7672 either at the next glyph from the display vector, or at the
7673 face we saw before the display vector. */
7674 next_face_id
= it
->saved_face_id
;
7675 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7677 if (it
->dpvec_face_id
>= 0)
7678 next_face_id
= it
->dpvec_face_id
;
7682 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7685 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7689 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7690 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7692 || next_face
->box
== FACE_NO_BOX
));
7693 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7696 /* Display table entry is invalid. Return a space. */
7697 it
->c
= ' ', it
->len
= 1;
7699 /* Don't change position and object of the iterator here. They are
7700 still the values of the character that had this display table
7701 entry or was translated, and that's what we want. */
7702 it
->what
= IT_CHARACTER
;
7706 /* Get the first element of string/buffer in the visual order, after
7707 being reseated to a new position in a string or a buffer. */
7709 get_visually_first_element (struct it
*it
)
7711 int string_p
= STRINGP (it
->string
) || it
->s
;
7712 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7713 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7715 if (STRINGP (it
->string
))
7717 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7718 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7722 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7723 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7726 if (it
->bidi_it
.charpos
== eob
)
7728 /* Nothing to do, but reset the FIRST_ELT flag, like
7729 bidi_paragraph_init does, because we are not going to
7731 it
->bidi_it
.first_elt
= 0;
7733 else if (it
->bidi_it
.charpos
== bob
7735 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7736 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7738 /* If we are at the beginning of a line/string, we can produce
7739 the next element right away. */
7740 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7741 bidi_move_to_visually_next (&it
->bidi_it
);
7745 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7747 /* We need to prime the bidi iterator starting at the line's or
7748 string's beginning, before we will be able to produce the
7751 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7753 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7754 IT_BYTEPOS (*it
), -1,
7755 &it
->bidi_it
.bytepos
);
7756 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7759 /* Now return to buffer/string position where we were asked
7760 to get the next display element, and produce that. */
7761 bidi_move_to_visually_next (&it
->bidi_it
);
7763 while (it
->bidi_it
.bytepos
!= orig_bytepos
7764 && it
->bidi_it
.charpos
< eob
);
7767 /* Adjust IT's position information to where we ended up. */
7768 if (STRINGP (it
->string
))
7770 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7771 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7775 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7776 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7779 if (STRINGP (it
->string
) || !it
->s
)
7781 ptrdiff_t stop
, charpos
, bytepos
;
7783 if (STRINGP (it
->string
))
7786 stop
= SCHARS (it
->string
);
7787 if (stop
> it
->end_charpos
)
7788 stop
= it
->end_charpos
;
7789 charpos
= IT_STRING_CHARPOS (*it
);
7790 bytepos
= IT_STRING_BYTEPOS (*it
);
7794 stop
= it
->end_charpos
;
7795 charpos
= IT_CHARPOS (*it
);
7796 bytepos
= IT_BYTEPOS (*it
);
7798 if (it
->bidi_it
.scan_dir
< 0)
7800 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7805 /* Load IT with the next display element from Lisp string IT->string.
7806 IT->current.string_pos is the current position within the string.
7807 If IT->current.overlay_string_index >= 0, the Lisp string is an
7811 next_element_from_string (struct it
*it
)
7813 struct text_pos position
;
7815 eassert (STRINGP (it
->string
));
7816 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7817 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7818 position
= it
->current
.string_pos
;
7820 /* With bidi reordering, the character to display might not be the
7821 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7822 that we were reseat()ed to a new string, whose paragraph
7823 direction is not known. */
7824 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7826 get_visually_first_element (it
);
7827 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7830 /* Time to check for invisible text? */
7831 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7833 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7836 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7837 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7839 /* With bidi non-linear iteration, we could find
7840 ourselves far beyond the last computed stop_charpos,
7841 with several other stop positions in between that we
7842 missed. Scan them all now, in buffer's logical
7843 order, until we find and handle the last stop_charpos
7844 that precedes our current position. */
7845 handle_stop_backwards (it
, it
->stop_charpos
);
7846 return GET_NEXT_DISPLAY_ELEMENT (it
);
7852 /* Take note of the stop position we just moved
7853 across, for when we will move back across it. */
7854 it
->prev_stop
= it
->stop_charpos
;
7855 /* If we are at base paragraph embedding level, take
7856 note of the last stop position seen at this
7858 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7859 it
->base_level_stop
= it
->stop_charpos
;
7863 /* Since a handler may have changed IT->method, we must
7865 return GET_NEXT_DISPLAY_ELEMENT (it
);
7869 /* If we are before prev_stop, we may have overstepped
7870 on our way backwards a stop_pos, and if so, we need
7871 to handle that stop_pos. */
7872 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7873 /* We can sometimes back up for reasons that have nothing
7874 to do with bidi reordering. E.g., compositions. The
7875 code below is only needed when we are above the base
7876 embedding level, so test for that explicitly. */
7877 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7879 /* If we lost track of base_level_stop, we have no better
7880 place for handle_stop_backwards to start from than string
7881 beginning. This happens, e.g., when we were reseated to
7882 the previous screenful of text by vertical-motion. */
7883 if (it
->base_level_stop
<= 0
7884 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7885 it
->base_level_stop
= 0;
7886 handle_stop_backwards (it
, it
->base_level_stop
);
7887 return GET_NEXT_DISPLAY_ELEMENT (it
);
7891 if (it
->current
.overlay_string_index
>= 0)
7893 /* Get the next character from an overlay string. In overlay
7894 strings, there is no field width or padding with spaces to
7896 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7901 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7902 IT_STRING_BYTEPOS (*it
),
7903 it
->bidi_it
.scan_dir
< 0
7905 : SCHARS (it
->string
))
7906 && next_element_from_composition (it
))
7910 else if (STRING_MULTIBYTE (it
->string
))
7912 const unsigned char *s
= (SDATA (it
->string
)
7913 + IT_STRING_BYTEPOS (*it
));
7914 it
->c
= string_char_and_length (s
, &it
->len
);
7918 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7924 /* Get the next character from a Lisp string that is not an
7925 overlay string. Such strings come from the mode line, for
7926 example. We may have to pad with spaces, or truncate the
7927 string. See also next_element_from_c_string. */
7928 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7933 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7935 /* Pad with spaces. */
7936 it
->c
= ' ', it
->len
= 1;
7937 CHARPOS (position
) = BYTEPOS (position
) = -1;
7939 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7940 IT_STRING_BYTEPOS (*it
),
7941 it
->bidi_it
.scan_dir
< 0
7943 : it
->string_nchars
)
7944 && next_element_from_composition (it
))
7948 else if (STRING_MULTIBYTE (it
->string
))
7950 const unsigned char *s
= (SDATA (it
->string
)
7951 + IT_STRING_BYTEPOS (*it
));
7952 it
->c
= string_char_and_length (s
, &it
->len
);
7956 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7961 /* Record what we have and where it came from. */
7962 it
->what
= IT_CHARACTER
;
7963 it
->object
= it
->string
;
7964 it
->position
= position
;
7969 /* Load IT with next display element from C string IT->s.
7970 IT->string_nchars is the maximum number of characters to return
7971 from the string. IT->end_charpos may be greater than
7972 IT->string_nchars when this function is called, in which case we
7973 may have to return padding spaces. Value is zero if end of string
7974 reached, including padding spaces. */
7977 next_element_from_c_string (struct it
*it
)
7979 bool success_p
= true;
7982 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7983 it
->what
= IT_CHARACTER
;
7984 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7987 /* With bidi reordering, the character to display might not be the
7988 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7989 we were reseated to a new string, whose paragraph direction is
7991 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7992 get_visually_first_element (it
);
7994 /* IT's position can be greater than IT->string_nchars in case a
7995 field width or precision has been specified when the iterator was
7997 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7999 /* End of the game. */
8003 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
8005 /* Pad with spaces. */
8006 it
->c
= ' ', it
->len
= 1;
8007 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
8009 else if (it
->multibyte_p
)
8010 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
8012 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
8018 /* Set up IT to return characters from an ellipsis, if appropriate.
8019 The definition of the ellipsis glyphs may come from a display table
8020 entry. This function fills IT with the first glyph from the
8021 ellipsis if an ellipsis is to be displayed. */
8024 next_element_from_ellipsis (struct it
*it
)
8026 if (it
->selective_display_ellipsis_p
)
8027 setup_for_ellipsis (it
, it
->len
);
8030 /* The face at the current position may be different from the
8031 face we find after the invisible text. Remember what it
8032 was in IT->saved_face_id, and signal that it's there by
8033 setting face_before_selective_p. */
8034 it
->saved_face_id
= it
->face_id
;
8035 it
->method
= GET_FROM_BUFFER
;
8036 it
->object
= it
->w
->contents
;
8037 reseat_at_next_visible_line_start (it
, 1);
8038 it
->face_before_selective_p
= true;
8041 return GET_NEXT_DISPLAY_ELEMENT (it
);
8045 /* Deliver an image display element. The iterator IT is already
8046 filled with image information (done in handle_display_prop). Value
8051 next_element_from_image (struct it
*it
)
8053 it
->what
= IT_IMAGE
;
8054 it
->ignore_overlay_strings_at_pos_p
= 0;
8059 /* Fill iterator IT with next display element from a stretch glyph
8060 property. IT->object is the value of the text property. Value is
8064 next_element_from_stretch (struct it
*it
)
8066 it
->what
= IT_STRETCH
;
8070 /* Scan backwards from IT's current position until we find a stop
8071 position, or until BEGV. This is called when we find ourself
8072 before both the last known prev_stop and base_level_stop while
8073 reordering bidirectional text. */
8076 compute_stop_pos_backwards (struct it
*it
)
8078 const int SCAN_BACK_LIMIT
= 1000;
8079 struct text_pos pos
;
8080 struct display_pos save_current
= it
->current
;
8081 struct text_pos save_position
= it
->position
;
8082 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8083 ptrdiff_t where_we_are
= charpos
;
8084 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8085 ptrdiff_t save_end_pos
= it
->end_charpos
;
8087 eassert (NILP (it
->string
) && !it
->s
);
8088 eassert (it
->bidi_p
);
8092 it
->end_charpos
= min (charpos
+ 1, ZV
);
8093 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8094 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8095 reseat_1 (it
, pos
, 0);
8096 compute_stop_pos (it
);
8097 /* We must advance forward, right? */
8098 if (it
->stop_charpos
<= charpos
)
8101 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8103 if (it
->stop_charpos
<= where_we_are
)
8104 it
->prev_stop
= it
->stop_charpos
;
8106 it
->prev_stop
= BEGV
;
8108 it
->current
= save_current
;
8109 it
->position
= save_position
;
8110 it
->stop_charpos
= save_stop_pos
;
8111 it
->end_charpos
= save_end_pos
;
8114 /* Scan forward from CHARPOS in the current buffer/string, until we
8115 find a stop position > current IT's position. Then handle the stop
8116 position before that. This is called when we bump into a stop
8117 position while reordering bidirectional text. CHARPOS should be
8118 the last previously processed stop_pos (or BEGV/0, if none were
8119 processed yet) whose position is less that IT's current
8123 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8125 int bufp
= !STRINGP (it
->string
);
8126 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8127 struct display_pos save_current
= it
->current
;
8128 struct text_pos save_position
= it
->position
;
8129 struct text_pos pos1
;
8130 ptrdiff_t next_stop
;
8132 /* Scan in strict logical order. */
8133 eassert (it
->bidi_p
);
8137 it
->prev_stop
= charpos
;
8140 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8141 reseat_1 (it
, pos1
, 0);
8144 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8145 compute_stop_pos (it
);
8146 /* We must advance forward, right? */
8147 if (it
->stop_charpos
<= it
->prev_stop
)
8149 charpos
= it
->stop_charpos
;
8151 while (charpos
<= where_we_are
);
8154 it
->current
= save_current
;
8155 it
->position
= save_position
;
8156 next_stop
= it
->stop_charpos
;
8157 it
->stop_charpos
= it
->prev_stop
;
8159 it
->stop_charpos
= next_stop
;
8162 /* Load IT with the next display element from current_buffer. Value
8163 is zero if end of buffer reached. IT->stop_charpos is the next
8164 position at which to stop and check for text properties or buffer
8168 next_element_from_buffer (struct it
*it
)
8170 bool success_p
= true;
8172 eassert (IT_CHARPOS (*it
) >= BEGV
);
8173 eassert (NILP (it
->string
) && !it
->s
);
8174 eassert (!it
->bidi_p
8175 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8176 && it
->bidi_it
.string
.s
== NULL
));
8178 /* With bidi reordering, the character to display might not be the
8179 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8180 we were reseat()ed to a new buffer position, which is potentially
8181 a different paragraph. */
8182 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8184 get_visually_first_element (it
);
8185 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8188 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8190 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8192 int overlay_strings_follow_p
;
8194 /* End of the game, except when overlay strings follow that
8195 haven't been returned yet. */
8196 if (it
->overlay_strings_at_end_processed_p
)
8197 overlay_strings_follow_p
= 0;
8200 it
->overlay_strings_at_end_processed_p
= true;
8201 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8204 if (overlay_strings_follow_p
)
8205 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8209 it
->position
= it
->current
.pos
;
8213 else if (!(!it
->bidi_p
8214 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8215 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8217 /* With bidi non-linear iteration, we could find ourselves
8218 far beyond the last computed stop_charpos, with several
8219 other stop positions in between that we missed. Scan
8220 them all now, in buffer's logical order, until we find
8221 and handle the last stop_charpos that precedes our
8222 current position. */
8223 handle_stop_backwards (it
, it
->stop_charpos
);
8224 return GET_NEXT_DISPLAY_ELEMENT (it
);
8230 /* Take note of the stop position we just moved across,
8231 for when we will move back across it. */
8232 it
->prev_stop
= it
->stop_charpos
;
8233 /* If we are at base paragraph embedding level, take
8234 note of the last stop position seen at this
8236 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8237 it
->base_level_stop
= it
->stop_charpos
;
8240 return GET_NEXT_DISPLAY_ELEMENT (it
);
8244 /* If we are before prev_stop, we may have overstepped on
8245 our way backwards a stop_pos, and if so, we need to
8246 handle that stop_pos. */
8247 && IT_CHARPOS (*it
) < it
->prev_stop
8248 /* We can sometimes back up for reasons that have nothing
8249 to do with bidi reordering. E.g., compositions. The
8250 code below is only needed when we are above the base
8251 embedding level, so test for that explicitly. */
8252 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8254 if (it
->base_level_stop
<= 0
8255 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8257 /* If we lost track of base_level_stop, we need to find
8258 prev_stop by looking backwards. This happens, e.g., when
8259 we were reseated to the previous screenful of text by
8261 it
->base_level_stop
= BEGV
;
8262 compute_stop_pos_backwards (it
);
8263 handle_stop_backwards (it
, it
->prev_stop
);
8266 handle_stop_backwards (it
, it
->base_level_stop
);
8267 return GET_NEXT_DISPLAY_ELEMENT (it
);
8271 /* No face changes, overlays etc. in sight, so just return a
8272 character from current_buffer. */
8276 /* Maybe run the redisplay end trigger hook. Performance note:
8277 This doesn't seem to cost measurable time. */
8278 if (it
->redisplay_end_trigger_charpos
8280 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8281 run_redisplay_end_trigger_hook (it
);
8283 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8284 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8286 && next_element_from_composition (it
))
8291 /* Get the next character, maybe multibyte. */
8292 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8293 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
8294 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8296 it
->c
= *p
, it
->len
= 1;
8298 /* Record what we have and where it came from. */
8299 it
->what
= IT_CHARACTER
;
8300 it
->object
= it
->w
->contents
;
8301 it
->position
= it
->current
.pos
;
8303 /* Normally we return the character found above, except when we
8304 really want to return an ellipsis for selective display. */
8309 /* A value of selective > 0 means hide lines indented more
8310 than that number of columns. */
8311 if (it
->selective
> 0
8312 && IT_CHARPOS (*it
) + 1 < ZV
8313 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8314 IT_BYTEPOS (*it
) + 1,
8317 success_p
= next_element_from_ellipsis (it
);
8318 it
->dpvec_char_len
= -1;
8321 else if (it
->c
== '\r' && it
->selective
== -1)
8323 /* A value of selective == -1 means that everything from the
8324 CR to the end of the line is invisible, with maybe an
8325 ellipsis displayed for it. */
8326 success_p
= next_element_from_ellipsis (it
);
8327 it
->dpvec_char_len
= -1;
8332 /* Value is zero if end of buffer reached. */
8333 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8338 /* Run the redisplay end trigger hook for IT. */
8341 run_redisplay_end_trigger_hook (struct it
*it
)
8343 Lisp_Object args
[3];
8345 /* IT->glyph_row should be non-null, i.e. we should be actually
8346 displaying something, or otherwise we should not run the hook. */
8347 eassert (it
->glyph_row
);
8349 /* Set up hook arguments. */
8350 args
[0] = Qredisplay_end_trigger_functions
;
8351 args
[1] = it
->window
;
8352 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8353 it
->redisplay_end_trigger_charpos
= 0;
8355 /* Since we are *trying* to run these functions, don't try to run
8356 them again, even if they get an error. */
8357 wset_redisplay_end_trigger (it
->w
, Qnil
);
8358 Frun_hook_with_args (3, args
);
8360 /* Notice if it changed the face of the character we are on. */
8361 handle_face_prop (it
);
8365 /* Deliver a composition display element. Unlike the other
8366 next_element_from_XXX, this function is not registered in the array
8367 get_next_element[]. It is called from next_element_from_buffer and
8368 next_element_from_string when necessary. */
8371 next_element_from_composition (struct it
*it
)
8373 it
->what
= IT_COMPOSITION
;
8374 it
->len
= it
->cmp_it
.nbytes
;
8375 if (STRINGP (it
->string
))
8379 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8380 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8383 it
->position
= it
->current
.string_pos
;
8384 it
->object
= it
->string
;
8385 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8386 IT_STRING_BYTEPOS (*it
), it
->string
);
8392 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8393 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8396 if (it
->bidi_it
.new_paragraph
)
8397 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8398 /* Resync the bidi iterator with IT's new position.
8399 FIXME: this doesn't support bidirectional text. */
8400 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8401 bidi_move_to_visually_next (&it
->bidi_it
);
8405 it
->position
= it
->current
.pos
;
8406 it
->object
= it
->w
->contents
;
8407 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8408 IT_BYTEPOS (*it
), Qnil
);
8415 /***********************************************************************
8416 Moving an iterator without producing glyphs
8417 ***********************************************************************/
8419 /* Check if iterator is at a position corresponding to a valid buffer
8420 position after some move_it_ call. */
8422 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8423 ((it)->method == GET_FROM_STRING \
8424 ? IT_STRING_CHARPOS (*it) == 0 \
8428 /* Move iterator IT to a specified buffer or X position within one
8429 line on the display without producing glyphs.
8431 OP should be a bit mask including some or all of these bits:
8432 MOVE_TO_X: Stop upon reaching x-position TO_X.
8433 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8434 Regardless of OP's value, stop upon reaching the end of the display line.
8436 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8437 This means, in particular, that TO_X includes window's horizontal
8440 The return value has several possible values that
8441 say what condition caused the scan to stop:
8443 MOVE_POS_MATCH_OR_ZV
8444 - when TO_POS or ZV was reached.
8447 -when TO_X was reached before TO_POS or ZV were reached.
8450 - when we reached the end of the display area and the line must
8454 - when we reached the end of the display area and the line is
8458 - when we stopped at a line end, i.e. a newline or a CR and selective
8461 static enum move_it_result
8462 move_it_in_display_line_to (struct it
*it
,
8463 ptrdiff_t to_charpos
, int to_x
,
8464 enum move_operation_enum op
)
8466 enum move_it_result result
= MOVE_UNDEFINED
;
8467 struct glyph_row
*saved_glyph_row
;
8468 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8469 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8470 void *ppos_data
= NULL
;
8472 enum it_method prev_method
= it
->method
;
8473 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8474 int saw_smaller_pos
= prev_pos
< to_charpos
;
8476 /* Don't produce glyphs in produce_glyphs. */
8477 saved_glyph_row
= it
->glyph_row
;
8478 it
->glyph_row
= NULL
;
8480 /* Use wrap_it to save a copy of IT wherever a word wrap could
8481 occur. Use atpos_it to save a copy of IT at the desired buffer
8482 position, if found, so that we can scan ahead and check if the
8483 word later overshoots the window edge. Use atx_it similarly, for
8489 /* Use ppos_it under bidi reordering to save a copy of IT for the
8490 initial position. We restore that position in IT when we have
8491 scanned the entire display line without finding a match for
8492 TO_CHARPOS and all the character positions are greater than
8493 TO_CHARPOS. We then restart the scan from the initial position,
8494 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8495 the closest to TO_CHARPOS. */
8498 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8500 SAVE_IT (ppos_it
, *it
, ppos_data
);
8501 closest_pos
= IT_CHARPOS (*it
);
8507 #define BUFFER_POS_REACHED_P() \
8508 ((op & MOVE_TO_POS) != 0 \
8509 && BUFFERP (it->object) \
8510 && (IT_CHARPOS (*it) == to_charpos \
8512 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8513 && IT_CHARPOS (*it) > to_charpos) \
8514 || (it->what == IT_COMPOSITION \
8515 && ((IT_CHARPOS (*it) > to_charpos \
8516 && to_charpos >= it->cmp_it.charpos) \
8517 || (IT_CHARPOS (*it) < to_charpos \
8518 && to_charpos <= it->cmp_it.charpos)))) \
8519 && (it->method == GET_FROM_BUFFER \
8520 || (it->method == GET_FROM_DISPLAY_VECTOR \
8521 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8523 /* If there's a line-/wrap-prefix, handle it. */
8524 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8525 && it
->current_y
< it
->last_visible_y
)
8526 handle_line_prefix (it
);
8528 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8529 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8533 int x
, i
, ascent
= 0, descent
= 0;
8535 /* Utility macro to reset an iterator with x, ascent, and descent. */
8536 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8537 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8538 (IT)->max_descent = descent)
8540 /* Stop if we move beyond TO_CHARPOS (after an image or a
8541 display string or stretch glyph). */
8542 if ((op
& MOVE_TO_POS
) != 0
8543 && BUFFERP (it
->object
)
8544 && it
->method
== GET_FROM_BUFFER
8546 /* When the iterator is at base embedding level, we
8547 are guaranteed that characters are delivered for
8548 display in strictly increasing order of their
8549 buffer positions. */
8550 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8551 && IT_CHARPOS (*it
) > to_charpos
)
8553 && (prev_method
== GET_FROM_IMAGE
8554 || prev_method
== GET_FROM_STRETCH
8555 || prev_method
== GET_FROM_STRING
)
8556 /* Passed TO_CHARPOS from left to right. */
8557 && ((prev_pos
< to_charpos
8558 && IT_CHARPOS (*it
) > to_charpos
)
8559 /* Passed TO_CHARPOS from right to left. */
8560 || (prev_pos
> to_charpos
8561 && IT_CHARPOS (*it
) < to_charpos
)))))
8563 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8565 result
= MOVE_POS_MATCH_OR_ZV
;
8568 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8569 /* If wrap_it is valid, the current position might be in a
8570 word that is wrapped. So, save the iterator in
8571 atpos_it and continue to see if wrapping happens. */
8572 SAVE_IT (atpos_it
, *it
, atpos_data
);
8575 /* Stop when ZV reached.
8576 We used to stop here when TO_CHARPOS reached as well, but that is
8577 too soon if this glyph does not fit on this line. So we handle it
8578 explicitly below. */
8579 if (!get_next_display_element (it
))
8581 result
= MOVE_POS_MATCH_OR_ZV
;
8585 if (it
->line_wrap
== TRUNCATE
)
8587 if (BUFFER_POS_REACHED_P ())
8589 result
= MOVE_POS_MATCH_OR_ZV
;
8595 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8597 if (IT_DISPLAYING_WHITESPACE (it
))
8601 /* We have reached a glyph that follows one or more
8602 whitespace characters. If the position is
8603 already found, we are done. */
8604 if (atpos_it
.sp
>= 0)
8606 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8607 result
= MOVE_POS_MATCH_OR_ZV
;
8612 RESTORE_IT (it
, &atx_it
, atx_data
);
8613 result
= MOVE_X_REACHED
;
8616 /* Otherwise, we can wrap here. */
8617 SAVE_IT (wrap_it
, *it
, wrap_data
);
8623 /* Remember the line height for the current line, in case
8624 the next element doesn't fit on the line. */
8625 ascent
= it
->max_ascent
;
8626 descent
= it
->max_descent
;
8628 /* The call to produce_glyphs will get the metrics of the
8629 display element IT is loaded with. Record the x-position
8630 before this display element, in case it doesn't fit on the
8634 PRODUCE_GLYPHS (it
);
8636 if (it
->area
!= TEXT_AREA
)
8638 prev_method
= it
->method
;
8639 if (it
->method
== GET_FROM_BUFFER
)
8640 prev_pos
= IT_CHARPOS (*it
);
8641 set_iterator_to_next (it
, 1);
8642 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8643 SET_TEXT_POS (this_line_min_pos
,
8644 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8646 && (op
& MOVE_TO_POS
)
8647 && IT_CHARPOS (*it
) > to_charpos
8648 && IT_CHARPOS (*it
) < closest_pos
)
8649 closest_pos
= IT_CHARPOS (*it
);
8653 /* The number of glyphs we get back in IT->nglyphs will normally
8654 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8655 character on a terminal frame, or (iii) a line end. For the
8656 second case, IT->nglyphs - 1 padding glyphs will be present.
8657 (On X frames, there is only one glyph produced for a
8658 composite character.)
8660 The behavior implemented below means, for continuation lines,
8661 that as many spaces of a TAB as fit on the current line are
8662 displayed there. For terminal frames, as many glyphs of a
8663 multi-glyph character are displayed in the current line, too.
8664 This is what the old redisplay code did, and we keep it that
8665 way. Under X, the whole shape of a complex character must
8666 fit on the line or it will be completely displayed in the
8669 Note that both for tabs and padding glyphs, all glyphs have
8673 /* More than one glyph or glyph doesn't fit on line. All
8674 glyphs have the same width. */
8675 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8677 int x_before_this_char
= x
;
8678 int hpos_before_this_char
= it
->hpos
;
8680 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8682 new_x
= x
+ single_glyph_width
;
8684 /* We want to leave anything reaching TO_X to the caller. */
8685 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8687 if (BUFFER_POS_REACHED_P ())
8689 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8690 goto buffer_pos_reached
;
8691 if (atpos_it
.sp
< 0)
8693 SAVE_IT (atpos_it
, *it
, atpos_data
);
8694 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8699 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8702 result
= MOVE_X_REACHED
;
8707 SAVE_IT (atx_it
, *it
, atx_data
);
8708 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8713 if (/* Lines are continued. */
8714 it
->line_wrap
!= TRUNCATE
8715 && (/* And glyph doesn't fit on the line. */
8716 new_x
> it
->last_visible_x
8717 /* Or it fits exactly and we're on a window
8719 || (new_x
== it
->last_visible_x
8720 && FRAME_WINDOW_P (it
->f
)
8721 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8722 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8723 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8725 if (/* IT->hpos == 0 means the very first glyph
8726 doesn't fit on the line, e.g. a wide image. */
8728 || (new_x
== it
->last_visible_x
8729 && FRAME_WINDOW_P (it
->f
)
8730 /* When word-wrap is ON and we have a valid
8731 wrap point, we don't allow the last glyph
8732 to "just barely fit" on the line. */
8733 && (it
->line_wrap
!= WORD_WRAP
8734 || wrap_it
.sp
< 0)))
8737 it
->current_x
= new_x
;
8739 /* The character's last glyph just barely fits
8741 if (i
== it
->nglyphs
- 1)
8743 /* If this is the destination position,
8744 return a position *before* it in this row,
8745 now that we know it fits in this row. */
8746 if (BUFFER_POS_REACHED_P ())
8748 if (it
->line_wrap
!= WORD_WRAP
8751 it
->hpos
= hpos_before_this_char
;
8752 it
->current_x
= x_before_this_char
;
8753 result
= MOVE_POS_MATCH_OR_ZV
;
8756 if (it
->line_wrap
== WORD_WRAP
8759 SAVE_IT (atpos_it
, *it
, atpos_data
);
8760 atpos_it
.current_x
= x_before_this_char
;
8761 atpos_it
.hpos
= hpos_before_this_char
;
8765 prev_method
= it
->method
;
8766 if (it
->method
== GET_FROM_BUFFER
)
8767 prev_pos
= IT_CHARPOS (*it
);
8768 set_iterator_to_next (it
, 1);
8769 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8770 SET_TEXT_POS (this_line_min_pos
,
8771 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8772 /* On graphical terminals, newlines may
8773 "overflow" into the fringe if
8774 overflow-newline-into-fringe is non-nil.
8775 On text terminals, and on graphical
8776 terminals with no right margin, newlines
8777 may overflow into the last glyph on the
8779 if (!FRAME_WINDOW_P (it
->f
)
8781 && it
->bidi_it
.paragraph_dir
== R2L
)
8782 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8783 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8784 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8786 if (!get_next_display_element (it
))
8788 result
= MOVE_POS_MATCH_OR_ZV
;
8791 if (BUFFER_POS_REACHED_P ())
8793 if (ITERATOR_AT_END_OF_LINE_P (it
))
8794 result
= MOVE_POS_MATCH_OR_ZV
;
8796 result
= MOVE_LINE_CONTINUED
;
8799 if (ITERATOR_AT_END_OF_LINE_P (it
)
8800 && (it
->line_wrap
!= WORD_WRAP
8803 result
= MOVE_NEWLINE_OR_CR
;
8810 IT_RESET_X_ASCENT_DESCENT (it
);
8812 if (wrap_it
.sp
>= 0)
8814 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8819 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8821 result
= MOVE_LINE_CONTINUED
;
8825 if (BUFFER_POS_REACHED_P ())
8827 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8828 goto buffer_pos_reached
;
8829 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8831 SAVE_IT (atpos_it
, *it
, atpos_data
);
8832 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8836 if (new_x
> it
->first_visible_x
)
8838 /* Glyph is visible. Increment number of glyphs that
8839 would be displayed. */
8844 if (result
!= MOVE_UNDEFINED
)
8847 else if (BUFFER_POS_REACHED_P ())
8850 IT_RESET_X_ASCENT_DESCENT (it
);
8851 result
= MOVE_POS_MATCH_OR_ZV
;
8854 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8856 /* Stop when TO_X specified and reached. This check is
8857 necessary here because of lines consisting of a line end,
8858 only. The line end will not produce any glyphs and we
8859 would never get MOVE_X_REACHED. */
8860 eassert (it
->nglyphs
== 0);
8861 result
= MOVE_X_REACHED
;
8865 /* Is this a line end? If yes, we're done. */
8866 if (ITERATOR_AT_END_OF_LINE_P (it
))
8868 /* If we are past TO_CHARPOS, but never saw any character
8869 positions smaller than TO_CHARPOS, return
8870 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8872 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8874 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8876 if (closest_pos
< ZV
)
8878 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8879 /* Don't recurse if closest_pos is equal to
8880 to_charpos, since we have just tried that. */
8881 if (closest_pos
!= to_charpos
)
8882 move_it_in_display_line_to (it
, closest_pos
, -1,
8884 result
= MOVE_POS_MATCH_OR_ZV
;
8887 goto buffer_pos_reached
;
8889 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8890 && IT_CHARPOS (*it
) > to_charpos
)
8891 goto buffer_pos_reached
;
8893 result
= MOVE_NEWLINE_OR_CR
;
8896 result
= MOVE_NEWLINE_OR_CR
;
8900 prev_method
= it
->method
;
8901 if (it
->method
== GET_FROM_BUFFER
)
8902 prev_pos
= IT_CHARPOS (*it
);
8903 /* The current display element has been consumed. Advance
8905 set_iterator_to_next (it
, 1);
8906 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8907 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8908 if (IT_CHARPOS (*it
) < to_charpos
)
8909 saw_smaller_pos
= 1;
8911 && (op
& MOVE_TO_POS
)
8912 && IT_CHARPOS (*it
) >= to_charpos
8913 && IT_CHARPOS (*it
) < closest_pos
)
8914 closest_pos
= IT_CHARPOS (*it
);
8916 /* Stop if lines are truncated and IT's current x-position is
8917 past the right edge of the window now. */
8918 if (it
->line_wrap
== TRUNCATE
8919 && it
->current_x
>= it
->last_visible_x
)
8921 if (!FRAME_WINDOW_P (it
->f
)
8922 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8923 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8924 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8925 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8929 if ((at_eob_p
= !get_next_display_element (it
))
8930 || BUFFER_POS_REACHED_P ()
8931 /* If we are past TO_CHARPOS, but never saw any
8932 character positions smaller than TO_CHARPOS,
8933 return MOVE_POS_MATCH_OR_ZV, like the
8934 unidirectional display did. */
8935 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8937 && IT_CHARPOS (*it
) > to_charpos
))
8940 && !BUFFER_POS_REACHED_P ()
8941 && !at_eob_p
&& closest_pos
< ZV
)
8943 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8944 if (closest_pos
!= to_charpos
)
8945 move_it_in_display_line_to (it
, closest_pos
, -1,
8948 result
= MOVE_POS_MATCH_OR_ZV
;
8951 if (ITERATOR_AT_END_OF_LINE_P (it
))
8953 result
= MOVE_NEWLINE_OR_CR
;
8957 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8959 && IT_CHARPOS (*it
) > to_charpos
)
8961 if (closest_pos
< ZV
)
8963 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8964 if (closest_pos
!= to_charpos
)
8965 move_it_in_display_line_to (it
, closest_pos
, -1,
8968 result
= MOVE_POS_MATCH_OR_ZV
;
8971 result
= MOVE_LINE_TRUNCATED
;
8974 #undef IT_RESET_X_ASCENT_DESCENT
8977 #undef BUFFER_POS_REACHED_P
8979 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8980 restore the saved iterator. */
8981 if (atpos_it
.sp
>= 0)
8982 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8983 else if (atx_it
.sp
>= 0)
8984 RESTORE_IT (it
, &atx_it
, atx_data
);
8989 bidi_unshelve_cache (atpos_data
, 1);
8991 bidi_unshelve_cache (atx_data
, 1);
8993 bidi_unshelve_cache (wrap_data
, 1);
8995 bidi_unshelve_cache (ppos_data
, 1);
8997 /* Restore the iterator settings altered at the beginning of this
8999 it
->glyph_row
= saved_glyph_row
;
9003 /* For external use. */
9005 move_it_in_display_line (struct it
*it
,
9006 ptrdiff_t to_charpos
, int to_x
,
9007 enum move_operation_enum op
)
9009 if (it
->line_wrap
== WORD_WRAP
9010 && (op
& MOVE_TO_X
))
9013 void *save_data
= NULL
;
9016 SAVE_IT (save_it
, *it
, save_data
);
9017 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9018 /* When word-wrap is on, TO_X may lie past the end
9019 of a wrapped line. Then it->current is the
9020 character on the next line, so backtrack to the
9021 space before the wrap point. */
9022 if (skip
== MOVE_LINE_CONTINUED
)
9024 int prev_x
= max (it
->current_x
- 1, 0);
9025 RESTORE_IT (it
, &save_it
, save_data
);
9026 move_it_in_display_line_to
9027 (it
, -1, prev_x
, MOVE_TO_X
);
9030 bidi_unshelve_cache (save_data
, 1);
9033 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9037 /* Move IT forward until it satisfies one or more of the criteria in
9038 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9040 OP is a bit-mask that specifies where to stop, and in particular,
9041 which of those four position arguments makes a difference. See the
9042 description of enum move_operation_enum.
9044 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9045 screen line, this function will set IT to the next position that is
9046 displayed to the right of TO_CHARPOS on the screen.
9048 Return the maximum pixel length of any line scanned but never more
9049 than it.last_visible_x. */
9052 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9054 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9055 int line_height
, line_start_x
= 0, reached
= 0;
9056 int max_current_x
= 0;
9057 void *backup_data
= NULL
;
9061 if (op
& MOVE_TO_VPOS
)
9063 /* If no TO_CHARPOS and no TO_X specified, stop at the
9064 start of the line TO_VPOS. */
9065 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9067 if (it
->vpos
== to_vpos
)
9073 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9077 /* TO_VPOS >= 0 means stop at TO_X in the line at
9078 TO_VPOS, or at TO_POS, whichever comes first. */
9079 if (it
->vpos
== to_vpos
)
9085 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9087 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9092 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9094 /* We have reached TO_X but not in the line we want. */
9095 skip
= move_it_in_display_line_to (it
, to_charpos
,
9097 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9105 else if (op
& MOVE_TO_Y
)
9107 struct it it_backup
;
9109 if (it
->line_wrap
== WORD_WRAP
)
9110 SAVE_IT (it_backup
, *it
, backup_data
);
9112 /* TO_Y specified means stop at TO_X in the line containing
9113 TO_Y---or at TO_CHARPOS if this is reached first. The
9114 problem is that we can't really tell whether the line
9115 contains TO_Y before we have completely scanned it, and
9116 this may skip past TO_X. What we do is to first scan to
9119 If TO_X is not specified, use a TO_X of zero. The reason
9120 is to make the outcome of this function more predictable.
9121 If we didn't use TO_X == 0, we would stop at the end of
9122 the line which is probably not what a caller would expect
9124 skip
= move_it_in_display_line_to
9125 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9126 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9128 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9129 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9131 else if (skip
== MOVE_X_REACHED
)
9133 /* If TO_X was reached, we want to know whether TO_Y is
9134 in the line. We know this is the case if the already
9135 scanned glyphs make the line tall enough. Otherwise,
9136 we must check by scanning the rest of the line. */
9137 line_height
= it
->max_ascent
+ it
->max_descent
;
9138 if (to_y
>= it
->current_y
9139 && to_y
< it
->current_y
+ line_height
)
9144 SAVE_IT (it_backup
, *it
, backup_data
);
9145 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9146 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9148 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9149 line_height
= it
->max_ascent
+ it
->max_descent
;
9150 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9152 if (to_y
>= it
->current_y
9153 && to_y
< it
->current_y
+ line_height
)
9155 /* If TO_Y is in this line and TO_X was reached
9156 above, we scanned too far. We have to restore
9157 IT's settings to the ones before skipping. But
9158 keep the more accurate values of max_ascent and
9159 max_descent we've found while skipping the rest
9160 of the line, for the sake of callers, such as
9161 pos_visible_p, that need to know the line
9163 int max_ascent
= it
->max_ascent
;
9164 int max_descent
= it
->max_descent
;
9166 RESTORE_IT (it
, &it_backup
, backup_data
);
9167 it
->max_ascent
= max_ascent
;
9168 it
->max_descent
= max_descent
;
9174 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9180 /* Check whether TO_Y is in this line. */
9181 line_height
= it
->max_ascent
+ it
->max_descent
;
9182 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9184 if (to_y
>= it
->current_y
9185 && to_y
< it
->current_y
+ line_height
)
9187 if (to_y
> it
->current_y
)
9188 max_current_x
= max (it
->current_x
, max_current_x
);
9190 /* When word-wrap is on, TO_X may lie past the end
9191 of a wrapped line. Then it->current is the
9192 character on the next line, so backtrack to the
9193 space before the wrap point. */
9194 if (skip
== MOVE_LINE_CONTINUED
9195 && it
->line_wrap
== WORD_WRAP
)
9197 int prev_x
= max (it
->current_x
- 1, 0);
9198 RESTORE_IT (it
, &it_backup
, backup_data
);
9199 skip
= move_it_in_display_line_to
9200 (it
, -1, prev_x
, MOVE_TO_X
);
9209 max_current_x
= max (it
->current_x
, max_current_x
);
9213 else if (BUFFERP (it
->object
)
9214 && (it
->method
== GET_FROM_BUFFER
9215 || it
->method
== GET_FROM_STRETCH
)
9216 && IT_CHARPOS (*it
) >= to_charpos
9217 /* Under bidi iteration, a call to set_iterator_to_next
9218 can scan far beyond to_charpos if the initial
9219 portion of the next line needs to be reordered. In
9220 that case, give move_it_in_display_line_to another
9223 && it
->bidi_it
.scan_dir
== -1))
9224 skip
= MOVE_POS_MATCH_OR_ZV
;
9226 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9230 case MOVE_POS_MATCH_OR_ZV
:
9231 max_current_x
= max (it
->current_x
, max_current_x
);
9235 case MOVE_NEWLINE_OR_CR
:
9236 max_current_x
= max (it
->current_x
, max_current_x
);
9237 set_iterator_to_next (it
, 1);
9238 it
->continuation_lines_width
= 0;
9241 case MOVE_LINE_TRUNCATED
:
9242 max_current_x
= it
->last_visible_x
;
9243 it
->continuation_lines_width
= 0;
9244 reseat_at_next_visible_line_start (it
, 0);
9245 if ((op
& MOVE_TO_POS
) != 0
9246 && IT_CHARPOS (*it
) > to_charpos
)
9253 case MOVE_LINE_CONTINUED
:
9254 max_current_x
= it
->last_visible_x
;
9255 /* For continued lines ending in a tab, some of the glyphs
9256 associated with the tab are displayed on the current
9257 line. Since it->current_x does not include these glyphs,
9258 we use it->last_visible_x instead. */
9261 it
->continuation_lines_width
+= it
->last_visible_x
;
9262 /* When moving by vpos, ensure that the iterator really
9263 advances to the next line (bug#847, bug#969). Fixme:
9264 do we need to do this in other circumstances? */
9265 if (it
->current_x
!= it
->last_visible_x
9266 && (op
& MOVE_TO_VPOS
)
9267 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9269 line_start_x
= it
->current_x
+ it
->pixel_width
9270 - it
->last_visible_x
;
9271 if (FRAME_WINDOW_P (it
->f
))
9273 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9274 struct font
*face_font
= face
->font
;
9276 /* When display_line produces a continued line
9277 that ends in a TAB, it skips a tab stop that
9278 is closer than the font's space character
9279 width (see x_produce_glyphs where it produces
9280 the stretch glyph which represents a TAB).
9281 We need to reproduce the same logic here. */
9282 eassert (face_font
);
9285 if (line_start_x
< face_font
->space_width
)
9287 += it
->tab_width
* face_font
->space_width
;
9290 set_iterator_to_next (it
, 0);
9294 it
->continuation_lines_width
+= it
->current_x
;
9301 /* Reset/increment for the next run. */
9302 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9303 it
->current_x
= line_start_x
;
9306 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9308 last_height
= it
->max_ascent
+ it
->max_descent
;
9309 it
->max_ascent
= it
->max_descent
= 0;
9314 /* On text terminals, we may stop at the end of a line in the middle
9315 of a multi-character glyph. If the glyph itself is continued,
9316 i.e. it is actually displayed on the next line, don't treat this
9317 stopping point as valid; move to the next line instead (unless
9318 that brings us offscreen). */
9319 if (!FRAME_WINDOW_P (it
->f
)
9321 && IT_CHARPOS (*it
) == to_charpos
9322 && it
->what
== IT_CHARACTER
9324 && it
->line_wrap
== WINDOW_WRAP
9325 && it
->current_x
== it
->last_visible_x
- 1
9328 && it
->vpos
< it
->w
->window_end_vpos
)
9330 it
->continuation_lines_width
+= it
->current_x
;
9331 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9332 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9334 last_height
= it
->max_ascent
+ it
->max_descent
;
9338 bidi_unshelve_cache (backup_data
, 1);
9340 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9342 return max_current_x
;
9346 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9348 If DY > 0, move IT backward at least that many pixels. DY = 0
9349 means move IT backward to the preceding line start or BEGV. This
9350 function may move over more than DY pixels if IT->current_y - DY
9351 ends up in the middle of a line; in this case IT->current_y will be
9352 set to the top of the line moved to. */
9355 move_it_vertically_backward (struct it
*it
, int dy
)
9359 void *it2data
= NULL
, *it3data
= NULL
;
9360 ptrdiff_t start_pos
;
9362 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9363 ptrdiff_t pos_limit
;
9368 start_pos
= IT_CHARPOS (*it
);
9370 /* Estimate how many newlines we must move back. */
9371 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9372 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9375 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9377 /* Set the iterator's position that many lines back. But don't go
9378 back more than NLINES full screen lines -- this wins a day with
9379 buffers which have very long lines. */
9380 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9381 back_to_previous_visible_line_start (it
);
9383 /* Reseat the iterator here. When moving backward, we don't want
9384 reseat to skip forward over invisible text, set up the iterator
9385 to deliver from overlay strings at the new position etc. So,
9386 use reseat_1 here. */
9387 reseat_1 (it
, it
->current
.pos
, 1);
9389 /* We are now surely at a line start. */
9390 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9391 reordering is in effect. */
9392 it
->continuation_lines_width
= 0;
9394 /* Move forward and see what y-distance we moved. First move to the
9395 start of the next line so that we get its height. We need this
9396 height to be able to tell whether we reached the specified
9398 SAVE_IT (it2
, *it
, it2data
);
9399 it2
.max_ascent
= it2
.max_descent
= 0;
9402 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9403 MOVE_TO_POS
| MOVE_TO_VPOS
);
9405 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9406 /* If we are in a display string which starts at START_POS,
9407 and that display string includes a newline, and we are
9408 right after that newline (i.e. at the beginning of a
9409 display line), exit the loop, because otherwise we will
9410 infloop, since move_it_to will see that it is already at
9411 START_POS and will not move. */
9412 || (it2
.method
== GET_FROM_STRING
9413 && IT_CHARPOS (it2
) == start_pos
9414 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9415 eassert (IT_CHARPOS (*it
) >= BEGV
);
9416 SAVE_IT (it3
, it2
, it3data
);
9418 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9419 eassert (IT_CHARPOS (*it
) >= BEGV
);
9420 /* H is the actual vertical distance from the position in *IT
9421 and the starting position. */
9422 h
= it2
.current_y
- it
->current_y
;
9423 /* NLINES is the distance in number of lines. */
9424 nlines
= it2
.vpos
- it
->vpos
;
9426 /* Correct IT's y and vpos position
9427 so that they are relative to the starting point. */
9433 /* DY == 0 means move to the start of the screen line. The
9434 value of nlines is > 0 if continuation lines were involved,
9435 or if the original IT position was at start of a line. */
9436 RESTORE_IT (it
, it
, it2data
);
9438 move_it_by_lines (it
, nlines
);
9439 /* The above code moves us to some position NLINES down,
9440 usually to its first glyph (leftmost in an L2R line), but
9441 that's not necessarily the start of the line, under bidi
9442 reordering. We want to get to the character position
9443 that is immediately after the newline of the previous
9446 && !it
->continuation_lines_width
9447 && !STRINGP (it
->string
)
9448 && IT_CHARPOS (*it
) > BEGV
9449 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9451 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9454 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9455 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9457 bidi_unshelve_cache (it3data
, 1);
9461 /* The y-position we try to reach, relative to *IT.
9462 Note that H has been subtracted in front of the if-statement. */
9463 int target_y
= it
->current_y
+ h
- dy
;
9464 int y0
= it3
.current_y
;
9468 RESTORE_IT (&it3
, &it3
, it3data
);
9469 y1
= line_bottom_y (&it3
);
9470 line_height
= y1
- y0
;
9471 RESTORE_IT (it
, it
, it2data
);
9472 /* If we did not reach target_y, try to move further backward if
9473 we can. If we moved too far backward, try to move forward. */
9474 if (target_y
< it
->current_y
9475 /* This is heuristic. In a window that's 3 lines high, with
9476 a line height of 13 pixels each, recentering with point
9477 on the bottom line will try to move -39/2 = 19 pixels
9478 backward. Try to avoid moving into the first line. */
9479 && (it
->current_y
- target_y
9480 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9481 && IT_CHARPOS (*it
) > BEGV
)
9483 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9484 target_y
- it
->current_y
));
9485 dy
= it
->current_y
- target_y
;
9486 goto move_further_back
;
9488 else if (target_y
>= it
->current_y
+ line_height
9489 && IT_CHARPOS (*it
) < ZV
)
9491 /* Should move forward by at least one line, maybe more.
9493 Note: Calling move_it_by_lines can be expensive on
9494 terminal frames, where compute_motion is used (via
9495 vmotion) to do the job, when there are very long lines
9496 and truncate-lines is nil. That's the reason for
9497 treating terminal frames specially here. */
9499 if (!FRAME_WINDOW_P (it
->f
))
9500 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9505 move_it_by_lines (it
, 1);
9507 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9514 /* Move IT by a specified amount of pixel lines DY. DY negative means
9515 move backwards. DY = 0 means move to start of screen line. At the
9516 end, IT will be on the start of a screen line. */
9519 move_it_vertically (struct it
*it
, int dy
)
9522 move_it_vertically_backward (it
, -dy
);
9525 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9526 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9527 MOVE_TO_POS
| MOVE_TO_Y
);
9528 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9530 /* If buffer ends in ZV without a newline, move to the start of
9531 the line to satisfy the post-condition. */
9532 if (IT_CHARPOS (*it
) == ZV
9534 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9535 move_it_by_lines (it
, 0);
9540 /* Move iterator IT past the end of the text line it is in. */
9543 move_it_past_eol (struct it
*it
)
9545 enum move_it_result rc
;
9547 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9548 if (rc
== MOVE_NEWLINE_OR_CR
)
9549 set_iterator_to_next (it
, 0);
9553 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9554 negative means move up. DVPOS == 0 means move to the start of the
9557 Optimization idea: If we would know that IT->f doesn't use
9558 a face with proportional font, we could be faster for
9559 truncate-lines nil. */
9562 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9565 /* The commented-out optimization uses vmotion on terminals. This
9566 gives bad results, because elements like it->what, on which
9567 callers such as pos_visible_p rely, aren't updated. */
9568 /* struct position pos;
9569 if (!FRAME_WINDOW_P (it->f))
9571 struct text_pos textpos;
9573 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9574 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9575 reseat (it, textpos, 1);
9576 it->vpos += pos.vpos;
9577 it->current_y += pos.vpos;
9583 /* DVPOS == 0 means move to the start of the screen line. */
9584 move_it_vertically_backward (it
, 0);
9585 /* Let next call to line_bottom_y calculate real line height. */
9590 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9591 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9593 /* Only move to the next buffer position if we ended up in a
9594 string from display property, not in an overlay string
9595 (before-string or after-string). That is because the
9596 latter don't conceal the underlying buffer position, so
9597 we can ask to move the iterator to the exact position we
9598 are interested in. Note that, even if we are already at
9599 IT_CHARPOS (*it), the call below is not a no-op, as it
9600 will detect that we are at the end of the string, pop the
9601 iterator, and compute it->current_x and it->hpos
9603 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9604 -1, -1, -1, MOVE_TO_POS
);
9610 void *it2data
= NULL
;
9611 ptrdiff_t start_charpos
, i
;
9613 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9614 bool hit_pos_limit
= false;
9615 ptrdiff_t pos_limit
;
9617 /* Start at the beginning of the screen line containing IT's
9618 position. This may actually move vertically backwards,
9619 in case of overlays, so adjust dvpos accordingly. */
9621 move_it_vertically_backward (it
, 0);
9624 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9625 screen lines, and reseat the iterator there. */
9626 start_charpos
= IT_CHARPOS (*it
);
9627 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9630 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9632 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9633 back_to_previous_visible_line_start (it
);
9634 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9635 hit_pos_limit
= true;
9636 reseat (it
, it
->current
.pos
, 1);
9638 /* Move further back if we end up in a string or an image. */
9639 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9641 /* First try to move to start of display line. */
9643 move_it_vertically_backward (it
, 0);
9645 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9647 /* If start of line is still in string or image,
9648 move further back. */
9649 back_to_previous_visible_line_start (it
);
9650 reseat (it
, it
->current
.pos
, 1);
9654 it
->current_x
= it
->hpos
= 0;
9656 /* Above call may have moved too far if continuation lines
9657 are involved. Scan forward and see if it did. */
9658 SAVE_IT (it2
, *it
, it2data
);
9659 it2
.vpos
= it2
.current_y
= 0;
9660 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9661 it
->vpos
-= it2
.vpos
;
9662 it
->current_y
-= it2
.current_y
;
9663 it
->current_x
= it
->hpos
= 0;
9665 /* If we moved too far back, move IT some lines forward. */
9666 if (it2
.vpos
> -dvpos
)
9668 int delta
= it2
.vpos
+ dvpos
;
9670 RESTORE_IT (&it2
, &it2
, it2data
);
9671 SAVE_IT (it2
, *it
, it2data
);
9672 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9673 /* Move back again if we got too far ahead. */
9674 if (IT_CHARPOS (*it
) >= start_charpos
)
9675 RESTORE_IT (it
, &it2
, it2data
);
9677 bidi_unshelve_cache (it2data
, 1);
9679 else if (hit_pos_limit
&& pos_limit
> BEGV
9680 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9682 /* If we hit the limit, but still didn't make it far enough
9683 back, that means there's a display string with a newline
9684 covering a large chunk of text, and that caused
9685 back_to_previous_visible_line_start try to go too far.
9686 Punish those who commit such atrocities by going back
9687 until we've reached DVPOS, after lifting the limit, which
9688 could make it slow for very long lines. "If it hurts,
9691 RESTORE_IT (it
, it
, it2data
);
9692 for (i
= -dvpos
; i
> 0; --i
)
9694 back_to_previous_visible_line_start (it
);
9699 RESTORE_IT (it
, it
, it2data
);
9703 /* Return true if IT points into the middle of a display vector. */
9706 in_display_vector_p (struct it
*it
)
9708 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9709 && it
->current
.dpvec_index
> 0
9710 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9713 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9714 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9715 WINDOW must be a live window and defaults to the selected one. The
9716 return value is a cons of the maximum pixel-width of any text line and
9717 the maximum pixel-height of all text lines.
9719 The optional argument FROM, if non-nil, specifies the first text
9720 position and defaults to the minimum accessible position of the buffer.
9721 If FROM is t, use the minimum accessible position that is not a newline
9722 character. TO, if non-nil, specifies the last text position and
9723 defaults to the maximum accessible position of the buffer. If TO is t,
9724 use the maximum accessible position that is not a newline character.
9726 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9727 width that can be returned. X-LIMIT nil or omitted, means to use the
9728 pixel-width of WINDOW's body; use this if you do not intend to change
9729 the width of WINDOW. Use the maximum width WINDOW may assume if you
9730 intend to change WINDOW's width. In any case, text whose x-coordinate
9731 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9732 can take some time, it's always a good idea to make this argument as
9733 small as possible; in particular, if the buffer contains long lines that
9734 shall be truncated anyway.
9736 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9737 height that can be returned. Text lines whose y-coordinate is beyond
9738 Y-LIMIT are ignored. Since calculating the text height of a large
9739 buffer can take some time, it makes sense to specify this argument if
9740 the size of the buffer is unknown.
9742 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9743 include the height of the mode- or header-line of WINDOW in the return
9744 value. If it is either the symbol `mode-line' or `header-line', include
9745 only the height of that line, if present, in the return value. If t,
9746 include the height of both, if present, in the return value. */)
9747 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
, Lisp_Object y_limit
,
9748 Lisp_Object mode_and_header_line
)
9750 struct window
*w
= decode_live_window (window
);
9754 struct buffer
*old_buffer
= NULL
;
9755 ptrdiff_t start
, end
, pos
;
9756 struct text_pos startp
;
9757 void *itdata
= NULL
;
9758 int c
, max_y
= -1, x
= 0, y
= 0;
9764 if (b
!= current_buffer
)
9766 old_buffer
= current_buffer
;
9767 set_buffer_internal (b
);
9772 else if (EQ (from
, Qt
))
9775 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9776 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9778 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9783 CHECK_NUMBER_COERCE_MARKER (from
);
9784 start
= min (max (XINT (from
), BEGV
), ZV
);
9789 else if (EQ (to
, Qt
))
9792 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9793 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9795 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9800 CHECK_NUMBER_COERCE_MARKER (to
);
9801 end
= max (start
, min (XINT (to
), ZV
));
9804 if (!NILP (y_limit
))
9806 CHECK_NUMBER (y_limit
);
9807 max_y
= min (XINT (y_limit
), INT_MAX
);
9810 itdata
= bidi_shelve_cache ();
9811 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9812 start_display (&it
, w
, startp
);
9815 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9818 CHECK_NUMBER (x_limit
);
9819 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9820 /* Actually, we never want move_it_to stop at to_x. But to make
9821 sure that move_it_in_display_line_to always moves far enough,
9822 we set it to INT_MAX and specify MOVE_TO_X. */
9823 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9824 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9827 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9829 if (!EQ (mode_and_header_line
, Qheader_line
)
9830 && !EQ (mode_and_header_line
, Qt
))
9831 /* Do not count the header-line which was counted automatically by
9833 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9835 if (EQ (mode_and_header_line
, Qmode_line
)
9836 || EQ (mode_and_header_line
, Qt
))
9837 /* Do count the mode-line which is not included automatically by
9839 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9841 bidi_unshelve_cache (itdata
, 0);
9844 set_buffer_internal (old_buffer
);
9846 return Fcons (make_number (x
), make_number (y
));
9849 /***********************************************************************
9851 ***********************************************************************/
9854 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9858 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9860 Lisp_Object args
[3];
9861 Lisp_Object msg
, fmt
;
9864 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9868 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9870 args
[0] = fmt
= build_string (format
);
9873 msg
= Fformat (3, args
);
9875 len
= SBYTES (msg
) + 1;
9876 buffer
= SAFE_ALLOCA (len
);
9877 memcpy (buffer
, SDATA (msg
), len
);
9879 message_dolog (buffer
, len
- 1, 1, 0);
9886 /* Output a newline in the *Messages* buffer if "needs" one. */
9889 message_log_maybe_newline (void)
9891 if (message_log_need_newline
)
9892 message_dolog ("", 0, 1, 0);
9896 /* Add a string M of length NBYTES to the message log, optionally
9897 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9898 true, means interpret the contents of M as multibyte. This
9899 function calls low-level routines in order to bypass text property
9900 hooks, etc. which might not be safe to run.
9902 This may GC (insert may run before/after change hooks),
9903 so the buffer M must NOT point to a Lisp string. */
9906 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9908 const unsigned char *msg
= (const unsigned char *) m
;
9910 if (!NILP (Vmemory_full
))
9913 if (!NILP (Vmessage_log_max
))
9915 struct buffer
*oldbuf
;
9916 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9917 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9918 ptrdiff_t point_at_end
= 0;
9919 ptrdiff_t zv_at_end
= 0;
9920 Lisp_Object old_deactivate_mark
;
9921 struct gcpro gcpro1
;
9923 old_deactivate_mark
= Vdeactivate_mark
;
9924 oldbuf
= current_buffer
;
9926 /* Ensure the Messages buffer exists, and switch to it.
9927 If we created it, set the major-mode. */
9930 if (NILP (Fget_buffer (Vmessages_buffer_name
))) newbuffer
= 1;
9932 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9935 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9936 call0 (intern ("messages-buffer-mode"));
9939 bset_undo_list (current_buffer
, Qt
);
9940 bset_cache_long_scans (current_buffer
, Qnil
);
9942 oldpoint
= message_dolog_marker1
;
9943 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9944 oldbegv
= message_dolog_marker2
;
9945 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
9946 oldzv
= message_dolog_marker3
;
9947 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
9948 GCPRO1 (old_deactivate_mark
);
9956 BEGV_BYTE
= BEG_BYTE
;
9959 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9961 /* Insert the string--maybe converting multibyte to single byte
9962 or vice versa, so that all the text fits the buffer. */
9964 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9970 /* Convert a multibyte string to single-byte
9971 for the *Message* buffer. */
9972 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9974 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9975 work
[0] = (ASCII_CHAR_P (c
)
9977 : multibyte_char_to_unibyte (c
));
9978 insert_1_both (work
, 1, 1, 1, 0, 0);
9981 else if (! multibyte
9982 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9986 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9987 /* Convert a single-byte string to multibyte
9988 for the *Message* buffer. */
9989 for (i
= 0; i
< nbytes
; i
++)
9992 MAKE_CHAR_MULTIBYTE (c
);
9993 char_bytes
= CHAR_STRING (c
, str
);
9994 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9998 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
, 1, 0, 0);
10002 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
10005 insert_1_both ("\n", 1, 1, 1, 0, 0);
10007 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
10009 this_bol_byte
= PT_BYTE
;
10011 /* See if this line duplicates the previous one.
10012 If so, combine duplicates. */
10013 if (this_bol
> BEG
)
10015 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
10017 prev_bol_byte
= PT_BYTE
;
10019 dups
= message_log_check_duplicate (prev_bol_byte
,
10023 del_range_both (prev_bol
, prev_bol_byte
,
10024 this_bol
, this_bol_byte
, 0);
10027 char dupstr
[sizeof " [ times]"
10028 + INT_STRLEN_BOUND (printmax_t
)];
10030 /* If you change this format, don't forget to also
10031 change message_log_check_duplicate. */
10032 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10033 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10034 insert_1_both (dupstr
, duplen
, duplen
, 1, 0, 1);
10039 /* If we have more than the desired maximum number of lines
10040 in the *Messages* buffer now, delete the oldest ones.
10041 This is safe because we don't have undo in this buffer. */
10043 if (NATNUMP (Vmessage_log_max
))
10045 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10046 -XFASTINT (Vmessage_log_max
) - 1, 0);
10047 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
10050 BEGV
= marker_position (oldbegv
);
10051 BEGV_BYTE
= marker_byte_position (oldbegv
);
10060 ZV
= marker_position (oldzv
);
10061 ZV_BYTE
= marker_byte_position (oldzv
);
10065 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10067 /* We can't do Fgoto_char (oldpoint) because it will run some
10069 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10070 marker_byte_position (oldpoint
));
10073 unchain_marker (XMARKER (oldpoint
));
10074 unchain_marker (XMARKER (oldbegv
));
10075 unchain_marker (XMARKER (oldzv
));
10077 /* We called insert_1_both above with its 5th argument (PREPARE)
10078 zero, which prevents insert_1_both from calling
10079 prepare_to_modify_buffer, which in turns prevents us from
10080 incrementing windows_or_buffers_changed even if *Messages* is
10081 shown in some window. So we must manually set
10082 windows_or_buffers_changed here to make up for that. */
10083 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10084 bset_redisplay (current_buffer
);
10086 set_buffer_internal (oldbuf
);
10088 message_log_need_newline
= !nlflag
;
10089 Vdeactivate_mark
= old_deactivate_mark
;
10094 /* We are at the end of the buffer after just having inserted a newline.
10095 (Note: We depend on the fact we won't be crossing the gap.)
10096 Check to see if the most recent message looks a lot like the previous one.
10097 Return 0 if different, 1 if the new one should just replace it, or a
10098 value N > 1 if we should also append " [N times]". */
10101 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10104 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10106 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10107 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10109 for (i
= 0; i
< len
; i
++)
10111 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10113 if (p1
[i
] != p2
[i
])
10119 if (*p1
++ == ' ' && *p1
++ == '[')
10122 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10123 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10130 /* Display an echo area message M with a specified length of NBYTES
10131 bytes. The string may include null characters. If M is not a
10132 string, clear out any existing message, and let the mini-buffer
10135 This function cancels echoing. */
10138 message3 (Lisp_Object m
)
10140 struct gcpro gcpro1
;
10143 clear_message (true, true);
10146 /* First flush out any partial line written with print. */
10147 message_log_maybe_newline ();
10150 ptrdiff_t nbytes
= SBYTES (m
);
10151 bool multibyte
= STRING_MULTIBYTE (m
);
10153 char *buffer
= SAFE_ALLOCA (nbytes
);
10154 memcpy (buffer
, SDATA (m
), nbytes
);
10155 message_dolog (buffer
, nbytes
, 1, multibyte
);
10158 message3_nolog (m
);
10164 /* The non-logging version of message3.
10165 This does not cancel echoing, because it is used for echoing.
10166 Perhaps we need to make a separate function for echoing
10167 and make this cancel echoing. */
10170 message3_nolog (Lisp_Object m
)
10172 struct frame
*sf
= SELECTED_FRAME ();
10174 if (FRAME_INITIAL_P (sf
))
10176 if (noninteractive_need_newline
)
10177 putc ('\n', stderr
);
10178 noninteractive_need_newline
= 0;
10181 Lisp_Object s
= ENCODE_SYSTEM (m
);
10183 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10185 if (cursor_in_echo_area
== 0)
10186 fprintf (stderr
, "\n");
10189 /* Error messages get reported properly by cmd_error, so this must be just an
10190 informative message; if the frame hasn't really been initialized yet, just
10192 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10194 /* Get the frame containing the mini-buffer
10195 that the selected frame is using. */
10196 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10197 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10198 struct frame
*f
= XFRAME (frame
);
10200 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10201 Fmake_frame_visible (frame
);
10203 if (STRINGP (m
) && SCHARS (m
) > 0)
10206 if (minibuffer_auto_raise
)
10207 Fraise_frame (frame
);
10208 /* Assume we are not echoing.
10209 (If we are, echo_now will override this.) */
10210 echo_message_buffer
= Qnil
;
10213 clear_message (true, true);
10215 do_pending_window_change (0);
10216 echo_area_display (1);
10217 do_pending_window_change (0);
10218 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10219 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10224 /* Display a null-terminated echo area message M. If M is 0, clear
10225 out any existing message, and let the mini-buffer text show through.
10227 The buffer M must continue to exist until after the echo area gets
10228 cleared or some other message gets displayed there. Do not pass
10229 text that is stored in a Lisp string. Do not pass text in a buffer
10230 that was alloca'd. */
10233 message1 (const char *m
)
10235 message3 (m
? build_unibyte_string (m
) : Qnil
);
10239 /* The non-logging counterpart of message1. */
10242 message1_nolog (const char *m
)
10244 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10247 /* Display a message M which contains a single %s
10248 which gets replaced with STRING. */
10251 message_with_string (const char *m
, Lisp_Object string
, int log
)
10253 CHECK_STRING (string
);
10255 if (noninteractive
)
10259 /* ENCODE_SYSTEM below can GC and/or relocate the Lisp
10260 String whose data pointer might be passed to us in M. So
10261 we use a local copy. */
10262 char *fmt
= xstrdup (m
);
10264 if (noninteractive_need_newline
)
10265 putc ('\n', stderr
);
10266 noninteractive_need_newline
= 0;
10267 fprintf (stderr
, fmt
, SDATA (ENCODE_SYSTEM (string
)));
10268 if (!cursor_in_echo_area
)
10269 fprintf (stderr
, "\n");
10274 else if (INTERACTIVE
)
10276 /* The frame whose minibuffer we're going to display the message on.
10277 It may be larger than the selected frame, so we need
10278 to use its buffer, not the selected frame's buffer. */
10279 Lisp_Object mini_window
;
10280 struct frame
*f
, *sf
= SELECTED_FRAME ();
10282 /* Get the frame containing the minibuffer
10283 that the selected frame is using. */
10284 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10285 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10287 /* Error messages get reported properly by cmd_error, so this must be
10288 just an informative message; if the frame hasn't really been
10289 initialized yet, just toss it. */
10290 if (f
->glyphs_initialized_p
)
10292 Lisp_Object args
[2], msg
;
10293 struct gcpro gcpro1
, gcpro2
;
10295 args
[0] = build_string (m
);
10296 args
[1] = msg
= string
;
10297 GCPRO2 (args
[0], msg
);
10300 msg
= Fformat (2, args
);
10305 message3_nolog (msg
);
10309 /* Print should start at the beginning of the message
10310 buffer next time. */
10311 message_buf_print
= 0;
10317 /* Dump an informative message to the minibuf. If M is 0, clear out
10318 any existing message, and let the mini-buffer text show through. */
10321 vmessage (const char *m
, va_list ap
)
10323 if (noninteractive
)
10327 if (noninteractive_need_newline
)
10328 putc ('\n', stderr
);
10329 noninteractive_need_newline
= 0;
10330 vfprintf (stderr
, m
, ap
);
10331 if (cursor_in_echo_area
== 0)
10332 fprintf (stderr
, "\n");
10336 else if (INTERACTIVE
)
10338 /* The frame whose mini-buffer we're going to display the message
10339 on. It may be larger than the selected frame, so we need to
10340 use its buffer, not the selected frame's buffer. */
10341 Lisp_Object mini_window
;
10342 struct frame
*f
, *sf
= SELECTED_FRAME ();
10344 /* Get the frame containing the mini-buffer
10345 that the selected frame is using. */
10346 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10347 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10349 /* Error messages get reported properly by cmd_error, so this must be
10350 just an informative message; if the frame hasn't really been
10351 initialized yet, just toss it. */
10352 if (f
->glyphs_initialized_p
)
10357 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10358 char *message_buf
= alloca (maxsize
+ 1);
10360 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10362 message3 (make_string (message_buf
, len
));
10367 /* Print should start at the beginning of the message
10368 buffer next time. */
10369 message_buf_print
= 0;
10375 message (const char *m
, ...)
10385 /* The non-logging version of message. */
10388 message_nolog (const char *m
, ...)
10390 Lisp_Object old_log_max
;
10393 old_log_max
= Vmessage_log_max
;
10394 Vmessage_log_max
= Qnil
;
10396 Vmessage_log_max
= old_log_max
;
10402 /* Display the current message in the current mini-buffer. This is
10403 only called from error handlers in process.c, and is not time
10407 update_echo_area (void)
10409 if (!NILP (echo_area_buffer
[0]))
10411 Lisp_Object string
;
10412 string
= Fcurrent_message ();
10418 /* Make sure echo area buffers in `echo_buffers' are live.
10419 If they aren't, make new ones. */
10422 ensure_echo_area_buffers (void)
10426 for (i
= 0; i
< 2; ++i
)
10427 if (!BUFFERP (echo_buffer
[i
])
10428 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10431 Lisp_Object old_buffer
;
10434 old_buffer
= echo_buffer
[i
];
10435 echo_buffer
[i
] = Fget_buffer_create
10436 (make_formatted_string (name
, " *Echo Area %d*", i
));
10437 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10438 /* to force word wrap in echo area -
10439 it was decided to postpone this*/
10440 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10442 for (j
= 0; j
< 2; ++j
)
10443 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10444 echo_area_buffer
[j
] = echo_buffer
[i
];
10449 /* Call FN with args A1..A2 with either the current or last displayed
10450 echo_area_buffer as current buffer.
10452 WHICH zero means use the current message buffer
10453 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10454 from echo_buffer[] and clear it.
10456 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10457 suitable buffer from echo_buffer[] and clear it.
10459 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10460 that the current message becomes the last displayed one, make
10461 choose a suitable buffer for echo_area_buffer[0], and clear it.
10463 Value is what FN returns. */
10466 with_echo_area_buffer (struct window
*w
, int which
,
10467 int (*fn
) (ptrdiff_t, Lisp_Object
),
10468 ptrdiff_t a1
, Lisp_Object a2
)
10470 Lisp_Object buffer
;
10471 int this_one
, the_other
, clear_buffer_p
, rc
;
10472 ptrdiff_t count
= SPECPDL_INDEX ();
10474 /* If buffers aren't live, make new ones. */
10475 ensure_echo_area_buffers ();
10477 clear_buffer_p
= 0;
10480 this_one
= 0, the_other
= 1;
10481 else if (which
> 0)
10482 this_one
= 1, the_other
= 0;
10485 this_one
= 0, the_other
= 1;
10486 clear_buffer_p
= true;
10488 /* We need a fresh one in case the current echo buffer equals
10489 the one containing the last displayed echo area message. */
10490 if (!NILP (echo_area_buffer
[this_one
])
10491 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10492 echo_area_buffer
[this_one
] = Qnil
;
10495 /* Choose a suitable buffer from echo_buffer[] is we don't
10497 if (NILP (echo_area_buffer
[this_one
]))
10499 echo_area_buffer
[this_one
]
10500 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10501 ? echo_buffer
[the_other
]
10502 : echo_buffer
[this_one
]);
10503 clear_buffer_p
= true;
10506 buffer
= echo_area_buffer
[this_one
];
10508 /* Don't get confused by reusing the buffer used for echoing
10509 for a different purpose. */
10510 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10513 record_unwind_protect (unwind_with_echo_area_buffer
,
10514 with_echo_area_buffer_unwind_data (w
));
10516 /* Make the echo area buffer current. Note that for display
10517 purposes, it is not necessary that the displayed window's buffer
10518 == current_buffer, except for text property lookup. So, let's
10519 only set that buffer temporarily here without doing a full
10520 Fset_window_buffer. We must also change w->pointm, though,
10521 because otherwise an assertions in unshow_buffer fails, and Emacs
10523 set_buffer_internal_1 (XBUFFER (buffer
));
10526 wset_buffer (w
, buffer
);
10527 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10530 bset_undo_list (current_buffer
, Qt
);
10531 bset_read_only (current_buffer
, Qnil
);
10532 specbind (Qinhibit_read_only
, Qt
);
10533 specbind (Qinhibit_modification_hooks
, Qt
);
10535 if (clear_buffer_p
&& Z
> BEG
)
10536 del_range (BEG
, Z
);
10538 eassert (BEGV
>= BEG
);
10539 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10543 eassert (BEGV
>= BEG
);
10544 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10546 unbind_to (count
, Qnil
);
10551 /* Save state that should be preserved around the call to the function
10552 FN called in with_echo_area_buffer. */
10555 with_echo_area_buffer_unwind_data (struct window
*w
)
10558 Lisp_Object vector
, tmp
;
10560 /* Reduce consing by keeping one vector in
10561 Vwith_echo_area_save_vector. */
10562 vector
= Vwith_echo_area_save_vector
;
10563 Vwith_echo_area_save_vector
= Qnil
;
10566 vector
= Fmake_vector (make_number (9), Qnil
);
10568 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10569 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10570 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10574 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10575 ASET (vector
, i
, w
->contents
); ++i
;
10576 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10577 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10578 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10579 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10584 for (; i
< end
; ++i
)
10585 ASET (vector
, i
, Qnil
);
10588 eassert (i
== ASIZE (vector
));
10593 /* Restore global state from VECTOR which was created by
10594 with_echo_area_buffer_unwind_data. */
10597 unwind_with_echo_area_buffer (Lisp_Object vector
)
10599 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10600 Vdeactivate_mark
= AREF (vector
, 1);
10601 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10603 if (WINDOWP (AREF (vector
, 3)))
10606 Lisp_Object buffer
;
10608 w
= XWINDOW (AREF (vector
, 3));
10609 buffer
= AREF (vector
, 4);
10611 wset_buffer (w
, buffer
);
10612 set_marker_both (w
->pointm
, buffer
,
10613 XFASTINT (AREF (vector
, 5)),
10614 XFASTINT (AREF (vector
, 6)));
10615 set_marker_both (w
->start
, buffer
,
10616 XFASTINT (AREF (vector
, 7)),
10617 XFASTINT (AREF (vector
, 8)));
10620 Vwith_echo_area_save_vector
= vector
;
10624 /* Set up the echo area for use by print functions. MULTIBYTE_P
10625 non-zero means we will print multibyte. */
10628 setup_echo_area_for_printing (int multibyte_p
)
10630 /* If we can't find an echo area any more, exit. */
10631 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10632 Fkill_emacs (Qnil
);
10634 ensure_echo_area_buffers ();
10636 if (!message_buf_print
)
10638 /* A message has been output since the last time we printed.
10639 Choose a fresh echo area buffer. */
10640 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10641 echo_area_buffer
[0] = echo_buffer
[1];
10643 echo_area_buffer
[0] = echo_buffer
[0];
10645 /* Switch to that buffer and clear it. */
10646 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10647 bset_truncate_lines (current_buffer
, Qnil
);
10651 ptrdiff_t count
= SPECPDL_INDEX ();
10652 specbind (Qinhibit_read_only
, Qt
);
10653 /* Note that undo recording is always disabled. */
10654 del_range (BEG
, Z
);
10655 unbind_to (count
, Qnil
);
10657 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10659 /* Set up the buffer for the multibyteness we need. */
10661 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10662 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10664 /* Raise the frame containing the echo area. */
10665 if (minibuffer_auto_raise
)
10667 struct frame
*sf
= SELECTED_FRAME ();
10668 Lisp_Object mini_window
;
10669 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10670 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10673 message_log_maybe_newline ();
10674 message_buf_print
= 1;
10678 if (NILP (echo_area_buffer
[0]))
10680 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10681 echo_area_buffer
[0] = echo_buffer
[1];
10683 echo_area_buffer
[0] = echo_buffer
[0];
10686 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10688 /* Someone switched buffers between print requests. */
10689 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10690 bset_truncate_lines (current_buffer
, Qnil
);
10696 /* Display an echo area message in window W. Value is non-zero if W's
10697 height is changed. If display_last_displayed_message_p is
10698 non-zero, display the message that was last displayed, otherwise
10699 display the current message. */
10702 display_echo_area (struct window
*w
)
10704 int i
, no_message_p
, window_height_changed_p
;
10706 /* Temporarily disable garbage collections while displaying the echo
10707 area. This is done because a GC can print a message itself.
10708 That message would modify the echo area buffer's contents while a
10709 redisplay of the buffer is going on, and seriously confuse
10711 ptrdiff_t count
= inhibit_garbage_collection ();
10713 /* If there is no message, we must call display_echo_area_1
10714 nevertheless because it resizes the window. But we will have to
10715 reset the echo_area_buffer in question to nil at the end because
10716 with_echo_area_buffer will sets it to an empty buffer. */
10717 i
= display_last_displayed_message_p
? 1 : 0;
10718 no_message_p
= NILP (echo_area_buffer
[i
]);
10720 window_height_changed_p
10721 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10722 display_echo_area_1
,
10723 (intptr_t) w
, Qnil
);
10726 echo_area_buffer
[i
] = Qnil
;
10728 unbind_to (count
, Qnil
);
10729 return window_height_changed_p
;
10733 /* Helper for display_echo_area. Display the current buffer which
10734 contains the current echo area message in window W, a mini-window,
10735 a pointer to which is passed in A1. A2..A4 are currently not used.
10736 Change the height of W so that all of the message is displayed.
10737 Value is non-zero if height of W was changed. */
10740 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10743 struct window
*w
= (struct window
*) i1
;
10744 Lisp_Object window
;
10745 struct text_pos start
;
10746 int window_height_changed_p
= 0;
10748 /* Do this before displaying, so that we have a large enough glyph
10749 matrix for the display. If we can't get enough space for the
10750 whole text, display the last N lines. That works by setting w->start. */
10751 window_height_changed_p
= resize_mini_window (w
, 0);
10753 /* Use the starting position chosen by resize_mini_window. */
10754 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10757 clear_glyph_matrix (w
->desired_matrix
);
10758 XSETWINDOW (window
, w
);
10759 try_window (window
, start
, 0);
10761 return window_height_changed_p
;
10765 /* Resize the echo area window to exactly the size needed for the
10766 currently displayed message, if there is one. If a mini-buffer
10767 is active, don't shrink it. */
10770 resize_echo_area_exactly (void)
10772 if (BUFFERP (echo_area_buffer
[0])
10773 && WINDOWP (echo_area_window
))
10775 struct window
*w
= XWINDOW (echo_area_window
);
10776 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10777 int resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10778 (intptr_t) w
, resize_exactly
);
10781 windows_or_buffers_changed
= 42;
10782 update_mode_lines
= 30;
10783 redisplay_internal ();
10789 /* Callback function for with_echo_area_buffer, when used from
10790 resize_echo_area_exactly. A1 contains a pointer to the window to
10791 resize, EXACTLY non-nil means resize the mini-window exactly to the
10792 size of the text displayed. A3 and A4 are not used. Value is what
10793 resize_mini_window returns. */
10796 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10799 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10803 /* Resize mini-window W to fit the size of its contents. EXACT_P
10804 means size the window exactly to the size needed. Otherwise, it's
10805 only enlarged until W's buffer is empty.
10807 Set W->start to the right place to begin display. If the whole
10808 contents fit, start at the beginning. Otherwise, start so as
10809 to make the end of the contents appear. This is particularly
10810 important for y-or-n-p, but seems desirable generally.
10812 Value is non-zero if the window height has been changed. */
10815 resize_mini_window (struct window
*w
, int exact_p
)
10817 struct frame
*f
= XFRAME (w
->frame
);
10818 int window_height_changed_p
= 0;
10820 eassert (MINI_WINDOW_P (w
));
10822 /* By default, start display at the beginning. */
10823 set_marker_both (w
->start
, w
->contents
,
10824 BUF_BEGV (XBUFFER (w
->contents
)),
10825 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10827 /* Don't resize windows while redisplaying a window; it would
10828 confuse redisplay functions when the size of the window they are
10829 displaying changes from under them. Such a resizing can happen,
10830 for instance, when which-func prints a long message while
10831 we are running fontification-functions. We're running these
10832 functions with safe_call which binds inhibit-redisplay to t. */
10833 if (!NILP (Vinhibit_redisplay
))
10836 /* Nil means don't try to resize. */
10837 if (NILP (Vresize_mini_windows
)
10838 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10841 if (!FRAME_MINIBUF_ONLY_P (f
))
10844 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10845 + WINDOW_PIXEL_HEIGHT (w
));
10846 int unit
= FRAME_LINE_HEIGHT (f
);
10847 int height
, max_height
;
10848 struct text_pos start
;
10849 struct buffer
*old_current_buffer
= NULL
;
10851 if (current_buffer
!= XBUFFER (w
->contents
))
10853 old_current_buffer
= current_buffer
;
10854 set_buffer_internal (XBUFFER (w
->contents
));
10857 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10859 /* Compute the max. number of lines specified by the user. */
10860 if (FLOATP (Vmax_mini_window_height
))
10861 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10862 else if (INTEGERP (Vmax_mini_window_height
))
10863 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10865 max_height
= total_height
/ 4;
10867 /* Correct that max. height if it's bogus. */
10868 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10870 /* Find out the height of the text in the window. */
10871 if (it
.line_wrap
== TRUNCATE
)
10876 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10877 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10878 height
= it
.current_y
+ last_height
;
10880 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10881 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10884 /* Compute a suitable window start. */
10885 if (height
> max_height
)
10887 height
= (max_height
/ unit
) * unit
;
10888 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10889 move_it_vertically_backward (&it
, height
- unit
);
10890 start
= it
.current
.pos
;
10893 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10894 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10896 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10898 /* Let it grow only, until we display an empty message, in which
10899 case the window shrinks again. */
10900 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10902 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10904 FRAME_WINDOWS_FROZEN (f
) = 1;
10905 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10906 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10908 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10909 && (exact_p
|| BEGV
== ZV
))
10911 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10913 FRAME_WINDOWS_FROZEN (f
) = 0;
10914 shrink_mini_window (w
, 1);
10915 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10920 /* Always resize to exact size needed. */
10921 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10923 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10925 FRAME_WINDOWS_FROZEN (f
) = 1;
10926 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10927 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10929 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10931 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10933 FRAME_WINDOWS_FROZEN (f
) = 0;
10934 shrink_mini_window (w
, 1);
10938 FRAME_WINDOWS_FROZEN (f
) = 1;
10939 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10942 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10946 if (old_current_buffer
)
10947 set_buffer_internal (old_current_buffer
);
10950 return window_height_changed_p
;
10954 /* Value is the current message, a string, or nil if there is no
10955 current message. */
10958 current_message (void)
10962 if (!BUFFERP (echo_area_buffer
[0]))
10966 with_echo_area_buffer (0, 0, current_message_1
,
10967 (intptr_t) &msg
, Qnil
);
10969 echo_area_buffer
[0] = Qnil
;
10977 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
10980 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10983 *msg
= make_buffer_string (BEG
, Z
, 1);
10990 /* Push the current message on Vmessage_stack for later restoration
10991 by restore_message. Value is non-zero if the current message isn't
10992 empty. This is a relatively infrequent operation, so it's not
10993 worth optimizing. */
10996 push_message (void)
10998 Lisp_Object msg
= current_message ();
10999 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
11000 return STRINGP (msg
);
11004 /* Restore message display from the top of Vmessage_stack. */
11007 restore_message (void)
11009 eassert (CONSP (Vmessage_stack
));
11010 message3_nolog (XCAR (Vmessage_stack
));
11014 /* Handler for unwind-protect calling pop_message. */
11017 pop_message_unwind (void)
11019 /* Pop the top-most entry off Vmessage_stack. */
11020 eassert (CONSP (Vmessage_stack
));
11021 Vmessage_stack
= XCDR (Vmessage_stack
);
11025 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11026 exits. If the stack is not empty, we have a missing pop_message
11030 check_message_stack (void)
11032 if (!NILP (Vmessage_stack
))
11037 /* Truncate to NCHARS what will be displayed in the echo area the next
11038 time we display it---but don't redisplay it now. */
11041 truncate_echo_area (ptrdiff_t nchars
)
11044 echo_area_buffer
[0] = Qnil
;
11045 else if (!noninteractive
11047 && !NILP (echo_area_buffer
[0]))
11049 struct frame
*sf
= SELECTED_FRAME ();
11050 /* Error messages get reported properly by cmd_error, so this must be
11051 just an informative message; if the frame hasn't really been
11052 initialized yet, just toss it. */
11053 if (sf
->glyphs_initialized_p
)
11054 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11059 /* Helper function for truncate_echo_area. Truncate the current
11060 message to at most NCHARS characters. */
11063 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11065 if (BEG
+ nchars
< Z
)
11066 del_range (BEG
+ nchars
, Z
);
11068 echo_area_buffer
[0] = Qnil
;
11072 /* Set the current message to STRING. */
11075 set_message (Lisp_Object string
)
11077 eassert (STRINGP (string
));
11079 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11081 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11082 message_buf_print
= 0;
11083 help_echo_showing_p
= 0;
11085 if (STRINGP (Vdebug_on_message
)
11086 && STRINGP (string
)
11087 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11088 call_debugger (list2 (Qerror
, string
));
11092 /* Helper function for set_message. First argument is ignored and second
11093 argument has the same meaning as for set_message.
11094 This function is called with the echo area buffer being current. */
11097 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11099 eassert (STRINGP (string
));
11101 /* Change multibyteness of the echo buffer appropriately. */
11102 if (message_enable_multibyte
11103 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11104 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11106 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11107 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11108 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11110 /* Insert new message at BEG. */
11111 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11113 /* This function takes care of single/multibyte conversion.
11114 We just have to ensure that the echo area buffer has the right
11115 setting of enable_multibyte_characters. */
11116 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), 1);
11122 /* Clear messages. CURRENT_P non-zero means clear the current
11123 message. LAST_DISPLAYED_P non-zero means clear the message
11127 clear_message (bool current_p
, bool last_displayed_p
)
11131 echo_area_buffer
[0] = Qnil
;
11132 message_cleared_p
= true;
11135 if (last_displayed_p
)
11136 echo_area_buffer
[1] = Qnil
;
11138 message_buf_print
= 0;
11141 /* Clear garbaged frames.
11143 This function is used where the old redisplay called
11144 redraw_garbaged_frames which in turn called redraw_frame which in
11145 turn called clear_frame. The call to clear_frame was a source of
11146 flickering. I believe a clear_frame is not necessary. It should
11147 suffice in the new redisplay to invalidate all current matrices,
11148 and ensure a complete redisplay of all windows. */
11151 clear_garbaged_frames (void)
11153 if (frame_garbaged
)
11155 Lisp_Object tail
, frame
;
11157 FOR_EACH_FRAME (tail
, frame
)
11159 struct frame
*f
= XFRAME (frame
);
11161 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11166 clear_current_matrices (f
);
11167 fset_redisplay (f
);
11168 f
->garbaged
= false;
11169 f
->resized_p
= false;
11173 frame_garbaged
= false;
11178 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
11179 is non-zero update selected_frame. Value is non-zero if the
11180 mini-windows height has been changed. */
11183 echo_area_display (int update_frame_p
)
11185 Lisp_Object mini_window
;
11188 int window_height_changed_p
= 0;
11189 struct frame
*sf
= SELECTED_FRAME ();
11191 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11192 w
= XWINDOW (mini_window
);
11193 f
= XFRAME (WINDOW_FRAME (w
));
11195 /* Don't display if frame is invisible or not yet initialized. */
11196 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11199 #ifdef HAVE_WINDOW_SYSTEM
11200 /* When Emacs starts, selected_frame may be the initial terminal
11201 frame. If we let this through, a message would be displayed on
11203 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11205 #endif /* HAVE_WINDOW_SYSTEM */
11207 /* Redraw garbaged frames. */
11208 clear_garbaged_frames ();
11210 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11212 echo_area_window
= mini_window
;
11213 window_height_changed_p
= display_echo_area (w
);
11214 w
->must_be_updated_p
= true;
11216 /* Update the display, unless called from redisplay_internal.
11217 Also don't update the screen during redisplay itself. The
11218 update will happen at the end of redisplay, and an update
11219 here could cause confusion. */
11220 if (update_frame_p
&& !redisplaying_p
)
11224 /* If the display update has been interrupted by pending
11225 input, update mode lines in the frame. Due to the
11226 pending input, it might have been that redisplay hasn't
11227 been called, so that mode lines above the echo area are
11228 garbaged. This looks odd, so we prevent it here. */
11229 if (!display_completed
)
11230 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11232 if (window_height_changed_p
11233 /* Don't do this if Emacs is shutting down. Redisplay
11234 needs to run hooks. */
11235 && !NILP (Vrun_hooks
))
11237 /* Must update other windows. Likewise as in other
11238 cases, don't let this update be interrupted by
11240 ptrdiff_t count
= SPECPDL_INDEX ();
11241 specbind (Qredisplay_dont_pause
, Qt
);
11242 windows_or_buffers_changed
= 44;
11243 redisplay_internal ();
11244 unbind_to (count
, Qnil
);
11246 else if (FRAME_WINDOW_P (f
) && n
== 0)
11248 /* Window configuration is the same as before.
11249 Can do with a display update of the echo area,
11250 unless we displayed some mode lines. */
11251 update_single_window (w
, 1);
11255 update_frame (f
, 1, 1);
11257 /* If cursor is in the echo area, make sure that the next
11258 redisplay displays the minibuffer, so that the cursor will
11259 be replaced with what the minibuffer wants. */
11260 if (cursor_in_echo_area
)
11261 wset_redisplay (XWINDOW (mini_window
));
11264 else if (!EQ (mini_window
, selected_window
))
11265 wset_redisplay (XWINDOW (mini_window
));
11267 /* Last displayed message is now the current message. */
11268 echo_area_buffer
[1] = echo_area_buffer
[0];
11269 /* Inform read_char that we're not echoing. */
11270 echo_message_buffer
= Qnil
;
11272 /* Prevent redisplay optimization in redisplay_internal by resetting
11273 this_line_start_pos. This is done because the mini-buffer now
11274 displays the message instead of its buffer text. */
11275 if (EQ (mini_window
, selected_window
))
11276 CHARPOS (this_line_start_pos
) = 0;
11278 return window_height_changed_p
;
11281 /* Nonzero if W's buffer was changed but not saved. */
11284 window_buffer_changed (struct window
*w
)
11286 struct buffer
*b
= XBUFFER (w
->contents
);
11288 eassert (BUFFER_LIVE_P (b
));
11290 return (((BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
));
11293 /* Nonzero if W has %c in its mode line and mode line should be updated. */
11296 mode_line_update_needed (struct window
*w
)
11298 return (w
->column_number_displayed
!= -1
11299 && !(PT
== w
->last_point
&& !window_outdated (w
))
11300 && (w
->column_number_displayed
!= current_column ()));
11303 /* Nonzero if window start of W is frozen and may not be changed during
11307 window_frozen_p (struct window
*w
)
11309 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11311 Lisp_Object window
;
11313 XSETWINDOW (window
, w
);
11314 if (MINI_WINDOW_P (w
))
11316 else if (EQ (window
, selected_window
))
11318 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11319 && EQ (window
, Vminibuf_scroll_window
))
11320 /* This special window can't be frozen too. */
11328 /***********************************************************************
11329 Mode Lines and Frame Titles
11330 ***********************************************************************/
11332 /* A buffer for constructing non-propertized mode-line strings and
11333 frame titles in it; allocated from the heap in init_xdisp and
11334 resized as needed in store_mode_line_noprop_char. */
11336 static char *mode_line_noprop_buf
;
11338 /* The buffer's end, and a current output position in it. */
11340 static char *mode_line_noprop_buf_end
;
11341 static char *mode_line_noprop_ptr
;
11343 #define MODE_LINE_NOPROP_LEN(start) \
11344 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11347 MODE_LINE_DISPLAY
= 0,
11351 } mode_line_target
;
11353 /* Alist that caches the results of :propertize.
11354 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11355 static Lisp_Object mode_line_proptrans_alist
;
11357 /* List of strings making up the mode-line. */
11358 static Lisp_Object mode_line_string_list
;
11360 /* Base face property when building propertized mode line string. */
11361 static Lisp_Object mode_line_string_face
;
11362 static Lisp_Object mode_line_string_face_prop
;
11365 /* Unwind data for mode line strings */
11367 static Lisp_Object Vmode_line_unwind_vector
;
11370 format_mode_line_unwind_data (struct frame
*target_frame
,
11371 struct buffer
*obuf
,
11373 int save_proptrans
)
11375 Lisp_Object vector
, tmp
;
11377 /* Reduce consing by keeping one vector in
11378 Vwith_echo_area_save_vector. */
11379 vector
= Vmode_line_unwind_vector
;
11380 Vmode_line_unwind_vector
= Qnil
;
11383 vector
= Fmake_vector (make_number (10), Qnil
);
11385 ASET (vector
, 0, make_number (mode_line_target
));
11386 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11387 ASET (vector
, 2, mode_line_string_list
);
11388 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11389 ASET (vector
, 4, mode_line_string_face
);
11390 ASET (vector
, 5, mode_line_string_face_prop
);
11393 XSETBUFFER (tmp
, obuf
);
11396 ASET (vector
, 6, tmp
);
11397 ASET (vector
, 7, owin
);
11400 /* Similarly to `with-selected-window', if the operation selects
11401 a window on another frame, we must restore that frame's
11402 selected window, and (for a tty) the top-frame. */
11403 ASET (vector
, 8, target_frame
->selected_window
);
11404 if (FRAME_TERMCAP_P (target_frame
))
11405 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11412 unwind_format_mode_line (Lisp_Object vector
)
11414 Lisp_Object old_window
= AREF (vector
, 7);
11415 Lisp_Object target_frame_window
= AREF (vector
, 8);
11416 Lisp_Object old_top_frame
= AREF (vector
, 9);
11418 mode_line_target
= XINT (AREF (vector
, 0));
11419 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11420 mode_line_string_list
= AREF (vector
, 2);
11421 if (! EQ (AREF (vector
, 3), Qt
))
11422 mode_line_proptrans_alist
= AREF (vector
, 3);
11423 mode_line_string_face
= AREF (vector
, 4);
11424 mode_line_string_face_prop
= AREF (vector
, 5);
11426 /* Select window before buffer, since it may change the buffer. */
11427 if (!NILP (old_window
))
11429 /* If the operation that we are unwinding had selected a window
11430 on a different frame, reset its frame-selected-window. For a
11431 text terminal, reset its top-frame if necessary. */
11432 if (!NILP (target_frame_window
))
11435 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11437 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11438 Fselect_window (target_frame_window
, Qt
);
11440 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11441 Fselect_frame (old_top_frame
, Qt
);
11444 Fselect_window (old_window
, Qt
);
11447 if (!NILP (AREF (vector
, 6)))
11449 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11450 ASET (vector
, 6, Qnil
);
11453 Vmode_line_unwind_vector
= vector
;
11457 /* Store a single character C for the frame title in mode_line_noprop_buf.
11458 Re-allocate mode_line_noprop_buf if necessary. */
11461 store_mode_line_noprop_char (char c
)
11463 /* If output position has reached the end of the allocated buffer,
11464 increase the buffer's size. */
11465 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11467 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11468 ptrdiff_t size
= len
;
11469 mode_line_noprop_buf
=
11470 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11471 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11472 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11475 *mode_line_noprop_ptr
++ = c
;
11479 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11480 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11481 characters that yield more columns than PRECISION; PRECISION <= 0
11482 means copy the whole string. Pad with spaces until FIELD_WIDTH
11483 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11484 pad. Called from display_mode_element when it is used to build a
11488 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11490 const unsigned char *str
= (const unsigned char *) string
;
11492 ptrdiff_t dummy
, nbytes
;
11494 /* Copy at most PRECISION chars from STR. */
11495 nbytes
= strlen (string
);
11496 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11498 store_mode_line_noprop_char (*str
++);
11500 /* Fill up with spaces until FIELD_WIDTH reached. */
11501 while (field_width
> 0
11502 && n
< field_width
)
11504 store_mode_line_noprop_char (' ');
11511 /***********************************************************************
11513 ***********************************************************************/
11515 #ifdef HAVE_WINDOW_SYSTEM
11517 /* Set the title of FRAME, if it has changed. The title format is
11518 Vicon_title_format if FRAME is iconified, otherwise it is
11519 frame_title_format. */
11522 x_consider_frame_title (Lisp_Object frame
)
11524 struct frame
*f
= XFRAME (frame
);
11526 if (FRAME_WINDOW_P (f
)
11527 || FRAME_MINIBUF_ONLY_P (f
)
11528 || f
->explicit_name
)
11530 /* Do we have more than one visible frame on this X display? */
11531 Lisp_Object tail
, other_frame
, fmt
;
11532 ptrdiff_t title_start
;
11536 ptrdiff_t count
= SPECPDL_INDEX ();
11538 FOR_EACH_FRAME (tail
, other_frame
)
11540 struct frame
*tf
= XFRAME (other_frame
);
11543 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11544 && !FRAME_MINIBUF_ONLY_P (tf
)
11545 && !EQ (other_frame
, tip_frame
)
11546 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11550 /* Set global variable indicating that multiple frames exist. */
11551 multiple_frames
= CONSP (tail
);
11553 /* Switch to the buffer of selected window of the frame. Set up
11554 mode_line_target so that display_mode_element will output into
11555 mode_line_noprop_buf; then display the title. */
11556 record_unwind_protect (unwind_format_mode_line
,
11557 format_mode_line_unwind_data
11558 (f
, current_buffer
, selected_window
, 0));
11560 Fselect_window (f
->selected_window
, Qt
);
11561 set_buffer_internal_1
11562 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11563 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11565 mode_line_target
= MODE_LINE_TITLE
;
11566 title_start
= MODE_LINE_NOPROP_LEN (0);
11567 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11568 NULL
, DEFAULT_FACE_ID
);
11569 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11570 len
= MODE_LINE_NOPROP_LEN (title_start
);
11571 title
= mode_line_noprop_buf
+ title_start
;
11572 unbind_to (count
, Qnil
);
11574 /* Set the title only if it's changed. This avoids consing in
11575 the common case where it hasn't. (If it turns out that we've
11576 already wasted too much time by walking through the list with
11577 display_mode_element, then we might need to optimize at a
11578 higher level than this.) */
11579 if (! STRINGP (f
->name
)
11580 || SBYTES (f
->name
) != len
11581 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11582 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11586 #endif /* not HAVE_WINDOW_SYSTEM */
11589 /***********************************************************************
11591 ***********************************************************************/
11593 /* Non-zero if we will not redisplay all visible windows. */
11594 #define REDISPLAY_SOME_P() \
11595 ((windows_or_buffers_changed == 0 \
11596 || windows_or_buffers_changed == REDISPLAY_SOME) \
11597 && (update_mode_lines == 0 \
11598 || update_mode_lines == REDISPLAY_SOME))
11600 /* Prepare for redisplay by updating menu-bar item lists when
11601 appropriate. This can call eval. */
11604 prepare_menu_bars (void)
11606 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11607 bool some_windows
= REDISPLAY_SOME_P ();
11608 struct gcpro gcpro1
, gcpro2
;
11609 Lisp_Object tooltip_frame
;
11611 #ifdef HAVE_WINDOW_SYSTEM
11612 tooltip_frame
= tip_frame
;
11614 tooltip_frame
= Qnil
;
11617 if (FUNCTIONP (Vpre_redisplay_function
))
11619 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11620 if (all_windows
&& some_windows
)
11622 Lisp_Object ws
= window_list ();
11623 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11625 Lisp_Object
this = XCAR (ws
);
11626 struct window
*w
= XWINDOW (this);
11628 || XFRAME (w
->frame
)->redisplay
11629 || XBUFFER (w
->contents
)->text
->redisplay
)
11631 windows
= Fcons (this, windows
);
11635 safe__call1 (true, Vpre_redisplay_function
, windows
);
11638 /* Update all frame titles based on their buffer names, etc. We do
11639 this before the menu bars so that the buffer-menu will show the
11640 up-to-date frame titles. */
11641 #ifdef HAVE_WINDOW_SYSTEM
11644 Lisp_Object tail
, frame
;
11646 FOR_EACH_FRAME (tail
, frame
)
11648 struct frame
*f
= XFRAME (frame
);
11649 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11653 && !XBUFFER (w
->contents
)->text
->redisplay
)
11656 if (!EQ (frame
, tooltip_frame
)
11657 && (FRAME_ICONIFIED_P (f
)
11658 || FRAME_VISIBLE_P (f
) == 1
11659 /* Exclude TTY frames that are obscured because they
11660 are not the top frame on their console. This is
11661 because x_consider_frame_title actually switches
11662 to the frame, which for TTY frames means it is
11663 marked as garbaged, and will be completely
11664 redrawn on the next redisplay cycle. This causes
11665 TTY frames to be completely redrawn, when there
11666 are more than one of them, even though nothing
11667 should be changed on display. */
11668 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11669 x_consider_frame_title (frame
);
11672 #endif /* HAVE_WINDOW_SYSTEM */
11674 /* Update the menu bar item lists, if appropriate. This has to be
11675 done before any actual redisplay or generation of display lines. */
11679 Lisp_Object tail
, frame
;
11680 ptrdiff_t count
= SPECPDL_INDEX ();
11681 /* 1 means that update_menu_bar has run its hooks
11682 so any further calls to update_menu_bar shouldn't do so again. */
11683 int menu_bar_hooks_run
= 0;
11685 record_unwind_save_match_data ();
11687 FOR_EACH_FRAME (tail
, frame
)
11689 struct frame
*f
= XFRAME (frame
);
11690 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11692 /* Ignore tooltip frame. */
11693 if (EQ (frame
, tooltip_frame
))
11699 && !XBUFFER (w
->contents
)->text
->redisplay
)
11702 /* If a window on this frame changed size, report that to
11703 the user and clear the size-change flag. */
11704 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11706 Lisp_Object functions
;
11708 /* Clear flag first in case we get an error below. */
11709 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11710 functions
= Vwindow_size_change_functions
;
11711 GCPRO2 (tail
, functions
);
11713 while (CONSP (functions
))
11715 if (!EQ (XCAR (functions
), Qt
))
11716 call1 (XCAR (functions
), frame
);
11717 functions
= XCDR (functions
);
11723 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11724 #ifdef HAVE_WINDOW_SYSTEM
11725 update_tool_bar (f
, 0);
11728 if (windows_or_buffers_changed
11731 (f
, Fbuffer_modified_p (XWINDOW (f
->selected_window
)->contents
));
11736 unbind_to (count
, Qnil
);
11740 struct frame
*sf
= SELECTED_FRAME ();
11741 update_menu_bar (sf
, 1, 0);
11742 #ifdef HAVE_WINDOW_SYSTEM
11743 update_tool_bar (sf
, 1);
11749 /* Update the menu bar item list for frame F. This has to be done
11750 before we start to fill in any display lines, because it can call
11753 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11755 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11756 already ran the menu bar hooks for this redisplay, so there
11757 is no need to run them again. The return value is the
11758 updated value of this flag, to pass to the next call. */
11761 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11763 Lisp_Object window
;
11764 register struct window
*w
;
11766 /* If called recursively during a menu update, do nothing. This can
11767 happen when, for instance, an activate-menubar-hook causes a
11769 if (inhibit_menubar_update
)
11772 window
= FRAME_SELECTED_WINDOW (f
);
11773 w
= XWINDOW (window
);
11775 if (FRAME_WINDOW_P (f
)
11777 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11778 || defined (HAVE_NS) || defined (USE_GTK)
11779 FRAME_EXTERNAL_MENU_BAR (f
)
11781 FRAME_MENU_BAR_LINES (f
) > 0
11783 : FRAME_MENU_BAR_LINES (f
) > 0)
11785 /* If the user has switched buffers or windows, we need to
11786 recompute to reflect the new bindings. But we'll
11787 recompute when update_mode_lines is set too; that means
11788 that people can use force-mode-line-update to request
11789 that the menu bar be recomputed. The adverse effect on
11790 the rest of the redisplay algorithm is about the same as
11791 windows_or_buffers_changed anyway. */
11792 if (windows_or_buffers_changed
11793 /* This used to test w->update_mode_line, but we believe
11794 there is no need to recompute the menu in that case. */
11795 || update_mode_lines
11796 || window_buffer_changed (w
))
11798 struct buffer
*prev
= current_buffer
;
11799 ptrdiff_t count
= SPECPDL_INDEX ();
11801 specbind (Qinhibit_menubar_update
, Qt
);
11803 set_buffer_internal_1 (XBUFFER (w
->contents
));
11804 if (save_match_data
)
11805 record_unwind_save_match_data ();
11806 if (NILP (Voverriding_local_map_menu_flag
))
11808 specbind (Qoverriding_terminal_local_map
, Qnil
);
11809 specbind (Qoverriding_local_map
, Qnil
);
11814 /* Run the Lucid hook. */
11815 safe_run_hooks (Qactivate_menubar_hook
);
11817 /* If it has changed current-menubar from previous value,
11818 really recompute the menu-bar from the value. */
11819 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11820 call0 (Qrecompute_lucid_menubar
);
11822 safe_run_hooks (Qmenu_bar_update_hook
);
11827 XSETFRAME (Vmenu_updating_frame
, f
);
11828 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11830 /* Redisplay the menu bar in case we changed it. */
11831 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11832 || defined (HAVE_NS) || defined (USE_GTK)
11833 if (FRAME_WINDOW_P (f
))
11835 #if defined (HAVE_NS)
11836 /* All frames on Mac OS share the same menubar. So only
11837 the selected frame should be allowed to set it. */
11838 if (f
== SELECTED_FRAME ())
11840 set_frame_menubar (f
, 0, 0);
11843 /* On a terminal screen, the menu bar is an ordinary screen
11844 line, and this makes it get updated. */
11845 w
->update_mode_line
= 1;
11846 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11847 /* In the non-toolkit version, the menu bar is an ordinary screen
11848 line, and this makes it get updated. */
11849 w
->update_mode_line
= 1;
11850 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11852 unbind_to (count
, Qnil
);
11853 set_buffer_internal_1 (prev
);
11860 /***********************************************************************
11862 ***********************************************************************/
11864 #ifdef HAVE_WINDOW_SYSTEM
11866 /* Tool-bar item index of the item on which a mouse button was pressed
11869 int last_tool_bar_item
;
11871 /* Select `frame' temporarily without running all the code in
11873 FIXME: Maybe do_switch_frame should be trimmed down similarly
11874 when `norecord' is set. */
11876 fast_set_selected_frame (Lisp_Object frame
)
11878 if (!EQ (selected_frame
, frame
))
11880 selected_frame
= frame
;
11881 selected_window
= XFRAME (frame
)->selected_window
;
11885 /* Update the tool-bar item list for frame F. This has to be done
11886 before we start to fill in any display lines. Called from
11887 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11888 and restore it here. */
11891 update_tool_bar (struct frame
*f
, int save_match_data
)
11893 #if defined (USE_GTK) || defined (HAVE_NS)
11894 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11896 int do_update
= (WINDOWP (f
->tool_bar_window
)
11897 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0);
11902 Lisp_Object window
;
11905 window
= FRAME_SELECTED_WINDOW (f
);
11906 w
= XWINDOW (window
);
11908 /* If the user has switched buffers or windows, we need to
11909 recompute to reflect the new bindings. But we'll
11910 recompute when update_mode_lines is set too; that means
11911 that people can use force-mode-line-update to request
11912 that the menu bar be recomputed. The adverse effect on
11913 the rest of the redisplay algorithm is about the same as
11914 windows_or_buffers_changed anyway. */
11915 if (windows_or_buffers_changed
11916 || w
->update_mode_line
11917 || update_mode_lines
11918 || window_buffer_changed (w
))
11920 struct buffer
*prev
= current_buffer
;
11921 ptrdiff_t count
= SPECPDL_INDEX ();
11922 Lisp_Object frame
, new_tool_bar
;
11923 int new_n_tool_bar
;
11924 struct gcpro gcpro1
;
11926 /* Set current_buffer to the buffer of the selected
11927 window of the frame, so that we get the right local
11929 set_buffer_internal_1 (XBUFFER (w
->contents
));
11931 /* Save match data, if we must. */
11932 if (save_match_data
)
11933 record_unwind_save_match_data ();
11935 /* Make sure that we don't accidentally use bogus keymaps. */
11936 if (NILP (Voverriding_local_map_menu_flag
))
11938 specbind (Qoverriding_terminal_local_map
, Qnil
);
11939 specbind (Qoverriding_local_map
, Qnil
);
11942 GCPRO1 (new_tool_bar
);
11944 /* We must temporarily set the selected frame to this frame
11945 before calling tool_bar_items, because the calculation of
11946 the tool-bar keymap uses the selected frame (see
11947 `tool-bar-make-keymap' in tool-bar.el). */
11948 eassert (EQ (selected_window
,
11949 /* Since we only explicitly preserve selected_frame,
11950 check that selected_window would be redundant. */
11951 XFRAME (selected_frame
)->selected_window
));
11952 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11953 XSETFRAME (frame
, f
);
11954 fast_set_selected_frame (frame
);
11956 /* Build desired tool-bar items from keymaps. */
11958 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11961 /* Redisplay the tool-bar if we changed it. */
11962 if (new_n_tool_bar
!= f
->n_tool_bar_items
11963 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11965 /* Redisplay that happens asynchronously due to an expose event
11966 may access f->tool_bar_items. Make sure we update both
11967 variables within BLOCK_INPUT so no such event interrupts. */
11969 fset_tool_bar_items (f
, new_tool_bar
);
11970 f
->n_tool_bar_items
= new_n_tool_bar
;
11971 w
->update_mode_line
= 1;
11977 unbind_to (count
, Qnil
);
11978 set_buffer_internal_1 (prev
);
11983 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
11985 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11986 F's desired tool-bar contents. F->tool_bar_items must have
11987 been set up previously by calling prepare_menu_bars. */
11990 build_desired_tool_bar_string (struct frame
*f
)
11992 int i
, size
, size_needed
;
11993 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11994 Lisp_Object image
, plist
, props
;
11996 image
= plist
= props
= Qnil
;
11997 GCPRO3 (image
, plist
, props
);
11999 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
12000 Otherwise, make a new string. */
12002 /* The size of the string we might be able to reuse. */
12003 size
= (STRINGP (f
->desired_tool_bar_string
)
12004 ? SCHARS (f
->desired_tool_bar_string
)
12007 /* We need one space in the string for each image. */
12008 size_needed
= f
->n_tool_bar_items
;
12010 /* Reuse f->desired_tool_bar_string, if possible. */
12011 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
12012 fset_desired_tool_bar_string
12013 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
12016 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
12017 Fremove_text_properties (make_number (0), make_number (size
),
12018 props
, f
->desired_tool_bar_string
);
12021 /* Put a `display' property on the string for the images to display,
12022 put a `menu_item' property on tool-bar items with a value that
12023 is the index of the item in F's tool-bar item vector. */
12024 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
12026 #define PROP(IDX) \
12027 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12029 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
12030 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
12031 int hmargin
, vmargin
, relief
, idx
, end
;
12033 /* If image is a vector, choose the image according to the
12035 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
12036 if (VECTORP (image
))
12040 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12041 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12044 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12045 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12047 eassert (ASIZE (image
) >= idx
);
12048 image
= AREF (image
, idx
);
12053 /* Ignore invalid image specifications. */
12054 if (!valid_image_p (image
))
12057 /* Display the tool-bar button pressed, or depressed. */
12058 plist
= Fcopy_sequence (XCDR (image
));
12060 /* Compute margin and relief to draw. */
12061 relief
= (tool_bar_button_relief
>= 0
12062 ? tool_bar_button_relief
12063 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12064 hmargin
= vmargin
= relief
;
12066 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12067 INT_MAX
- max (hmargin
, vmargin
)))
12069 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12070 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12072 else if (CONSP (Vtool_bar_button_margin
))
12074 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12075 INT_MAX
- hmargin
))
12076 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12078 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12079 INT_MAX
- vmargin
))
12080 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12083 if (auto_raise_tool_bar_buttons_p
)
12085 /* Add a `:relief' property to the image spec if the item is
12089 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12096 /* If image is selected, display it pressed, i.e. with a
12097 negative relief. If it's not selected, display it with a
12099 plist
= Fplist_put (plist
, QCrelief
,
12101 ? make_number (-relief
)
12102 : make_number (relief
)));
12107 /* Put a margin around the image. */
12108 if (hmargin
|| vmargin
)
12110 if (hmargin
== vmargin
)
12111 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12113 plist
= Fplist_put (plist
, QCmargin
,
12114 Fcons (make_number (hmargin
),
12115 make_number (vmargin
)));
12118 /* If button is not enabled, and we don't have special images
12119 for the disabled state, make the image appear disabled by
12120 applying an appropriate algorithm to it. */
12121 if (!enabled_p
&& idx
< 0)
12122 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12124 /* Put a `display' text property on the string for the image to
12125 display. Put a `menu-item' property on the string that gives
12126 the start of this item's properties in the tool-bar items
12128 image
= Fcons (Qimage
, plist
);
12129 props
= list4 (Qdisplay
, image
,
12130 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12132 /* Let the last image hide all remaining spaces in the tool bar
12133 string. The string can be longer than needed when we reuse a
12134 previous string. */
12135 if (i
+ 1 == f
->n_tool_bar_items
)
12136 end
= SCHARS (f
->desired_tool_bar_string
);
12139 Fadd_text_properties (make_number (i
), make_number (end
),
12140 props
, f
->desired_tool_bar_string
);
12148 /* Display one line of the tool-bar of frame IT->f.
12150 HEIGHT specifies the desired height of the tool-bar line.
12151 If the actual height of the glyph row is less than HEIGHT, the
12152 row's height is increased to HEIGHT, and the icons are centered
12153 vertically in the new height.
12155 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12156 count a final empty row in case the tool-bar width exactly matches
12161 display_tool_bar_line (struct it
*it
, int height
)
12163 struct glyph_row
*row
= it
->glyph_row
;
12164 int max_x
= it
->last_visible_x
;
12165 struct glyph
*last
;
12167 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12168 clear_glyph_row (row
);
12169 row
->enabled_p
= true;
12170 row
->y
= it
->current_y
;
12172 /* Note that this isn't made use of if the face hasn't a box,
12173 so there's no need to check the face here. */
12174 it
->start_of_box_run_p
= 1;
12176 while (it
->current_x
< max_x
)
12178 int x
, n_glyphs_before
, i
, nglyphs
;
12179 struct it it_before
;
12181 /* Get the next display element. */
12182 if (!get_next_display_element (it
))
12184 /* Don't count empty row if we are counting needed tool-bar lines. */
12185 if (height
< 0 && !it
->hpos
)
12190 /* Produce glyphs. */
12191 n_glyphs_before
= row
->used
[TEXT_AREA
];
12194 PRODUCE_GLYPHS (it
);
12196 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12198 x
= it_before
.current_x
;
12199 while (i
< nglyphs
)
12201 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12203 if (x
+ glyph
->pixel_width
> max_x
)
12205 /* Glyph doesn't fit on line. Backtrack. */
12206 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12208 /* If this is the only glyph on this line, it will never fit on the
12209 tool-bar, so skip it. But ensure there is at least one glyph,
12210 so we don't accidentally disable the tool-bar. */
12211 if (n_glyphs_before
== 0
12212 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12218 x
+= glyph
->pixel_width
;
12222 /* Stop at line end. */
12223 if (ITERATOR_AT_END_OF_LINE_P (it
))
12226 set_iterator_to_next (it
, 1);
12231 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12233 /* Use default face for the border below the tool bar.
12235 FIXME: When auto-resize-tool-bars is grow-only, there is
12236 no additional border below the possibly empty tool-bar lines.
12237 So to make the extra empty lines look "normal", we have to
12238 use the tool-bar face for the border too. */
12239 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12240 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12241 it
->face_id
= DEFAULT_FACE_ID
;
12243 extend_face_to_end_of_line (it
);
12244 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12245 last
->right_box_line_p
= 1;
12246 if (last
== row
->glyphs
[TEXT_AREA
])
12247 last
->left_box_line_p
= 1;
12249 /* Make line the desired height and center it vertically. */
12250 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12252 /* Don't add more than one line height. */
12253 height
%= FRAME_LINE_HEIGHT (it
->f
);
12254 it
->max_ascent
+= height
/ 2;
12255 it
->max_descent
+= (height
+ 1) / 2;
12258 compute_line_metrics (it
);
12260 /* If line is empty, make it occupy the rest of the tool-bar. */
12261 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12263 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12264 row
->visible_height
= row
->height
;
12265 row
->ascent
= row
->phys_ascent
= 0;
12266 row
->extra_line_spacing
= 0;
12269 row
->full_width_p
= 1;
12270 row
->continued_p
= 0;
12271 row
->truncated_on_left_p
= 0;
12272 row
->truncated_on_right_p
= 0;
12274 it
->current_x
= it
->hpos
= 0;
12275 it
->current_y
+= row
->height
;
12281 /* Max tool-bar height. Basically, this is what makes all other windows
12282 disappear when the frame gets too small. Rethink this! */
12284 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
12285 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
12287 /* Value is the number of pixels needed to make all tool-bar items of
12288 frame F visible. The actual number of glyph rows needed is
12289 returned in *N_ROWS if non-NULL. */
12292 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12294 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12296 /* tool_bar_height is called from redisplay_tool_bar after building
12297 the desired matrix, so use (unused) mode-line row as temporary row to
12298 avoid destroying the first tool-bar row. */
12299 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12301 /* Initialize an iterator for iteration over
12302 F->desired_tool_bar_string in the tool-bar window of frame F. */
12303 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12304 it
.first_visible_x
= 0;
12305 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12306 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12307 it
.paragraph_embedding
= L2R
;
12309 while (!ITERATOR_AT_END_P (&it
))
12311 clear_glyph_row (temp_row
);
12312 it
.glyph_row
= temp_row
;
12313 display_tool_bar_line (&it
, -1);
12315 clear_glyph_row (temp_row
);
12317 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12319 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12322 return it
.current_y
;
12324 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12327 #endif /* !USE_GTK && !HAVE_NS */
12329 #if defined USE_GTK || defined HAVE_NS
12330 EXFUN (Ftool_bar_height
, 2) ATTRIBUTE_CONST
;
12331 EXFUN (Ftool_bar_lines_needed
, 1) ATTRIBUTE_CONST
;
12334 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12336 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12337 If FRAME is nil or omitted, use the selected frame. Optional argument
12338 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12339 (Lisp_Object frame
, Lisp_Object pixelwise
)
12343 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12344 struct frame
*f
= decode_any_frame (frame
);
12346 if (WINDOWP (f
->tool_bar_window
)
12347 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12349 update_tool_bar (f
, 1);
12350 if (f
->n_tool_bar_items
)
12352 build_desired_tool_bar_string (f
);
12353 height
= tool_bar_height (f
, NULL
, NILP (pixelwise
) ? 0 : 1);
12358 return make_number (height
);
12362 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
12363 height should be changed. */
12366 redisplay_tool_bar (struct frame
*f
)
12368 #if defined (USE_GTK) || defined (HAVE_NS)
12370 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12371 update_frame_tool_bar (f
);
12374 #else /* !USE_GTK && !HAVE_NS */
12378 struct glyph_row
*row
;
12380 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12381 do anything. This means you must start with tool-bar-lines
12382 non-zero to get the auto-sizing effect. Or in other words, you
12383 can turn off tool-bars by specifying tool-bar-lines zero. */
12384 if (!WINDOWP (f
->tool_bar_window
)
12385 || (w
= XWINDOW (f
->tool_bar_window
),
12386 WINDOW_PIXEL_HEIGHT (w
) == 0))
12389 /* Set up an iterator for the tool-bar window. */
12390 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12391 it
.first_visible_x
= 0;
12392 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12393 row
= it
.glyph_row
;
12395 /* Build a string that represents the contents of the tool-bar. */
12396 build_desired_tool_bar_string (f
);
12397 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12398 /* FIXME: This should be controlled by a user option. But it
12399 doesn't make sense to have an R2L tool bar if the menu bar cannot
12400 be drawn also R2L, and making the menu bar R2L is tricky due
12401 toolkit-specific code that implements it. If an R2L tool bar is
12402 ever supported, display_tool_bar_line should also be augmented to
12403 call unproduce_glyphs like display_line and display_string
12405 it
.paragraph_embedding
= L2R
;
12407 if (f
->n_tool_bar_rows
== 0)
12409 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, 1);
12411 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12414 int new_lines
= ((new_height
+ FRAME_LINE_HEIGHT (f
) - 1)
12415 / FRAME_LINE_HEIGHT (f
));
12417 XSETFRAME (frame
, f
);
12418 Fmodify_frame_parameters (frame
,
12419 list1 (Fcons (Qtool_bar_lines
,
12420 make_number (new_lines
))));
12421 /* Always do that now. */
12422 clear_glyph_matrix (w
->desired_matrix
);
12423 f
->fonts_changed
= 1;
12428 /* Display as many lines as needed to display all tool-bar items. */
12430 if (f
->n_tool_bar_rows
> 0)
12432 int border
, rows
, height
, extra
;
12434 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12435 border
= XINT (Vtool_bar_border
);
12436 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12437 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12438 else if (EQ (Vtool_bar_border
, Qborder_width
))
12439 border
= f
->border_width
;
12445 rows
= f
->n_tool_bar_rows
;
12446 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12447 extra
= it
.last_visible_y
- border
- height
* rows
;
12449 while (it
.current_y
< it
.last_visible_y
)
12452 if (extra
> 0 && rows
-- > 0)
12454 h
= (extra
+ rows
- 1) / rows
;
12457 display_tool_bar_line (&it
, height
+ h
);
12462 while (it
.current_y
< it
.last_visible_y
)
12463 display_tool_bar_line (&it
, 0);
12466 /* It doesn't make much sense to try scrolling in the tool-bar
12467 window, so don't do it. */
12468 w
->desired_matrix
->no_scrolling_p
= 1;
12469 w
->must_be_updated_p
= 1;
12471 if (!NILP (Vauto_resize_tool_bars
))
12473 /* Do we really allow the toolbar to occupy the whole frame? */
12474 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
12475 int change_height_p
= 0;
12477 /* If we couldn't display everything, change the tool-bar's
12478 height if there is room for more. */
12479 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
12480 && it
.current_y
< max_tool_bar_height
)
12481 change_height_p
= 1;
12483 /* We subtract 1 because display_tool_bar_line advances the
12484 glyph_row pointer before returning to its caller. We want to
12485 examine the last glyph row produced by
12486 display_tool_bar_line. */
12487 row
= it
.glyph_row
- 1;
12489 /* If there are blank lines at the end, except for a partially
12490 visible blank line at the end that is smaller than
12491 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12492 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12493 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12494 change_height_p
= 1;
12496 /* If row displays tool-bar items, but is partially visible,
12497 change the tool-bar's height. */
12498 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12499 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
12500 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
12501 change_height_p
= 1;
12503 /* Resize windows as needed by changing the `tool-bar-lines'
12504 frame parameter. */
12505 if (change_height_p
)
12509 int new_height
= tool_bar_height (f
, &nrows
, 1);
12511 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12512 && !f
->minimize_tool_bar_window_p
)
12513 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12514 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12515 f
->minimize_tool_bar_window_p
= 0;
12517 if (change_height_p
)
12519 /* Current size of the tool-bar window in canonical line
12521 int old_lines
= WINDOW_TOTAL_LINES (w
);
12522 /* Required size of the tool-bar window in canonical
12524 int new_lines
= ((new_height
+ FRAME_LINE_HEIGHT (f
) - 1)
12525 / FRAME_LINE_HEIGHT (f
));
12526 /* Maximum size of the tool-bar window in canonical line
12527 units that this frame can allow. */
12529 WINDOW_TOTAL_LINES (XWINDOW (FRAME_ROOT_WINDOW (f
))) - 1;
12531 /* Don't try to change the tool-bar window size and set
12532 the fonts_changed flag unless really necessary. That
12533 flag causes redisplay to give up and retry
12534 redisplaying the frame from scratch, so setting it
12535 unnecessarily can lead to nasty redisplay loops. */
12536 if (new_lines
<= max_lines
12537 && eabs (new_lines
- old_lines
) >= 1)
12539 XSETFRAME (frame
, f
);
12540 Fmodify_frame_parameters (frame
,
12541 list1 (Fcons (Qtool_bar_lines
,
12542 make_number (new_lines
))));
12543 clear_glyph_matrix (w
->desired_matrix
);
12544 f
->n_tool_bar_rows
= nrows
;
12545 f
->fonts_changed
= 1;
12552 f
->minimize_tool_bar_window_p
= 0;
12555 #endif /* USE_GTK || HAVE_NS */
12558 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12560 /* Get information about the tool-bar item which is displayed in GLYPH
12561 on frame F. Return in *PROP_IDX the index where tool-bar item
12562 properties start in F->tool_bar_items. Value is zero if
12563 GLYPH doesn't display a tool-bar item. */
12566 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12572 /* This function can be called asynchronously, which means we must
12573 exclude any possibility that Fget_text_property signals an
12575 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12576 charpos
= max (0, charpos
);
12578 /* Get the text property `menu-item' at pos. The value of that
12579 property is the start index of this item's properties in
12580 F->tool_bar_items. */
12581 prop
= Fget_text_property (make_number (charpos
),
12582 Qmenu_item
, f
->current_tool_bar_string
);
12583 if (INTEGERP (prop
))
12585 *prop_idx
= XINT (prop
);
12595 /* Get information about the tool-bar item at position X/Y on frame F.
12596 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12597 the current matrix of the tool-bar window of F, or NULL if not
12598 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12599 item in F->tool_bar_items. Value is
12601 -1 if X/Y is not on a tool-bar item
12602 0 if X/Y is on the same item that was highlighted before.
12606 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12607 int *hpos
, int *vpos
, int *prop_idx
)
12609 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12610 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12613 /* Find the glyph under X/Y. */
12614 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12615 if (*glyph
== NULL
)
12618 /* Get the start of this tool-bar item's properties in
12619 f->tool_bar_items. */
12620 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12623 /* Is mouse on the highlighted item? */
12624 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12625 && *vpos
>= hlinfo
->mouse_face_beg_row
12626 && *vpos
<= hlinfo
->mouse_face_end_row
12627 && (*vpos
> hlinfo
->mouse_face_beg_row
12628 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12629 && (*vpos
< hlinfo
->mouse_face_end_row
12630 || *hpos
< hlinfo
->mouse_face_end_col
12631 || hlinfo
->mouse_face_past_end
))
12639 Handle mouse button event on the tool-bar of frame F, at
12640 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12641 0 for button release. MODIFIERS is event modifiers for button
12645 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12648 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12649 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12650 int hpos
, vpos
, prop_idx
;
12651 struct glyph
*glyph
;
12652 Lisp_Object enabled_p
;
12655 /* If not on the highlighted tool-bar item, and mouse-highlight is
12656 non-nil, return. This is so we generate the tool-bar button
12657 click only when the mouse button is released on the same item as
12658 where it was pressed. However, when mouse-highlight is disabled,
12659 generate the click when the button is released regardless of the
12660 highlight, since tool-bar items are not highlighted in that
12662 frame_to_window_pixel_xy (w
, &x
, &y
);
12663 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12665 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12668 /* When mouse-highlight is off, generate the click for the item
12669 where the button was pressed, disregarding where it was
12671 if (NILP (Vmouse_highlight
) && !down_p
)
12672 prop_idx
= last_tool_bar_item
;
12674 /* If item is disabled, do nothing. */
12675 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12676 if (NILP (enabled_p
))
12681 /* Show item in pressed state. */
12682 if (!NILP (Vmouse_highlight
))
12683 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12684 last_tool_bar_item
= prop_idx
;
12688 Lisp_Object key
, frame
;
12689 struct input_event event
;
12690 EVENT_INIT (event
);
12692 /* Show item in released state. */
12693 if (!NILP (Vmouse_highlight
))
12694 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12696 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12698 XSETFRAME (frame
, f
);
12699 event
.kind
= TOOL_BAR_EVENT
;
12700 event
.frame_or_window
= frame
;
12702 kbd_buffer_store_event (&event
);
12704 event
.kind
= TOOL_BAR_EVENT
;
12705 event
.frame_or_window
= frame
;
12707 event
.modifiers
= modifiers
;
12708 kbd_buffer_store_event (&event
);
12709 last_tool_bar_item
= -1;
12714 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12715 tool-bar window-relative coordinates X/Y. Called from
12716 note_mouse_highlight. */
12719 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12721 Lisp_Object window
= f
->tool_bar_window
;
12722 struct window
*w
= XWINDOW (window
);
12723 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12724 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12726 struct glyph
*glyph
;
12727 struct glyph_row
*row
;
12729 Lisp_Object enabled_p
;
12731 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12732 int mouse_down_p
, rc
;
12734 /* Function note_mouse_highlight is called with negative X/Y
12735 values when mouse moves outside of the frame. */
12736 if (x
<= 0 || y
<= 0)
12738 clear_mouse_face (hlinfo
);
12742 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12745 /* Not on tool-bar item. */
12746 clear_mouse_face (hlinfo
);
12750 /* On same tool-bar item as before. */
12751 goto set_help_echo
;
12753 clear_mouse_face (hlinfo
);
12755 /* Mouse is down, but on different tool-bar item? */
12756 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12757 && f
== dpyinfo
->last_mouse_frame
);
12760 && last_tool_bar_item
!= prop_idx
)
12763 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12765 /* If tool-bar item is not enabled, don't highlight it. */
12766 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12767 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12769 /* Compute the x-position of the glyph. In front and past the
12770 image is a space. We include this in the highlighted area. */
12771 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12772 for (i
= x
= 0; i
< hpos
; ++i
)
12773 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12775 /* Record this as the current active region. */
12776 hlinfo
->mouse_face_beg_col
= hpos
;
12777 hlinfo
->mouse_face_beg_row
= vpos
;
12778 hlinfo
->mouse_face_beg_x
= x
;
12779 hlinfo
->mouse_face_past_end
= 0;
12781 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12782 hlinfo
->mouse_face_end_row
= vpos
;
12783 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12784 hlinfo
->mouse_face_window
= window
;
12785 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12787 /* Display it as active. */
12788 show_mouse_face (hlinfo
, draw
);
12793 /* Set help_echo_string to a help string to display for this tool-bar item.
12794 XTread_socket does the rest. */
12795 help_echo_object
= help_echo_window
= Qnil
;
12796 help_echo_pos
= -1;
12797 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12798 if (NILP (help_echo_string
))
12799 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12802 #endif /* !USE_GTK && !HAVE_NS */
12804 #endif /* HAVE_WINDOW_SYSTEM */
12808 /************************************************************************
12809 Horizontal scrolling
12810 ************************************************************************/
12812 static int hscroll_window_tree (Lisp_Object
);
12813 static int hscroll_windows (Lisp_Object
);
12815 /* For all leaf windows in the window tree rooted at WINDOW, set their
12816 hscroll value so that PT is (i) visible in the window, and (ii) so
12817 that it is not within a certain margin at the window's left and
12818 right border. Value is non-zero if any window's hscroll has been
12822 hscroll_window_tree (Lisp_Object window
)
12824 int hscrolled_p
= 0;
12825 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12826 int hscroll_step_abs
= 0;
12827 double hscroll_step_rel
= 0;
12829 if (hscroll_relative_p
)
12831 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12832 if (hscroll_step_rel
< 0)
12834 hscroll_relative_p
= 0;
12835 hscroll_step_abs
= 0;
12838 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12840 hscroll_step_abs
= XINT (Vhscroll_step
);
12841 if (hscroll_step_abs
< 0)
12842 hscroll_step_abs
= 0;
12845 hscroll_step_abs
= 0;
12847 while (WINDOWP (window
))
12849 struct window
*w
= XWINDOW (window
);
12851 if (WINDOWP (w
->contents
))
12852 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12853 else if (w
->cursor
.vpos
>= 0)
12856 int text_area_width
;
12857 struct glyph_row
*cursor_row
;
12858 struct glyph_row
*bottom_row
;
12861 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12862 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12863 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12865 cursor_row
= bottom_row
- 1;
12867 if (!cursor_row
->enabled_p
)
12869 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12870 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12871 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12873 cursor_row
= bottom_row
- 1;
12875 row_r2l_p
= cursor_row
->reversed_p
;
12877 text_area_width
= window_box_width (w
, TEXT_AREA
);
12879 /* Scroll when cursor is inside this scroll margin. */
12880 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12882 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12883 /* In some pathological cases, like restoring a window
12884 configuration into a frame that is much smaller than
12885 the one from which the configuration was saved, we
12886 get glyph rows whose start and end have zero buffer
12887 positions, which we cannot handle below. Just skip
12889 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12890 /* For left-to-right rows, hscroll when cursor is either
12891 (i) inside the right hscroll margin, or (ii) if it is
12892 inside the left margin and the window is already
12896 && w
->cursor
.x
<= h_margin
)
12897 || (cursor_row
->enabled_p
12898 && cursor_row
->truncated_on_right_p
12899 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12900 /* For right-to-left rows, the logic is similar,
12901 except that rules for scrolling to left and right
12902 are reversed. E.g., if cursor.x <= h_margin, we
12903 need to hscroll "to the right" unconditionally,
12904 and that will scroll the screen to the left so as
12905 to reveal the next portion of the row. */
12907 && ((cursor_row
->enabled_p
12908 /* FIXME: It is confusing to set the
12909 truncated_on_right_p flag when R2L rows
12910 are actually truncated on the left. */
12911 && cursor_row
->truncated_on_right_p
12912 && w
->cursor
.x
<= h_margin
)
12914 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12918 struct buffer
*saved_current_buffer
;
12922 /* Find point in a display of infinite width. */
12923 saved_current_buffer
= current_buffer
;
12924 current_buffer
= XBUFFER (w
->contents
);
12926 if (w
== XWINDOW (selected_window
))
12929 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12931 /* Move iterator to pt starting at cursor_row->start in
12932 a line with infinite width. */
12933 init_to_row_start (&it
, w
, cursor_row
);
12934 it
.last_visible_x
= INFINITY
;
12935 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12936 current_buffer
= saved_current_buffer
;
12938 /* Position cursor in window. */
12939 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12940 hscroll
= max (0, (it
.current_x
12941 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12942 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12943 : (text_area_width
/ 2))))
12944 / FRAME_COLUMN_WIDTH (it
.f
);
12945 else if ((!row_r2l_p
12946 && w
->cursor
.x
>= text_area_width
- h_margin
)
12947 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12949 if (hscroll_relative_p
)
12950 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12953 wanted_x
= text_area_width
12954 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12957 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12961 if (hscroll_relative_p
)
12962 wanted_x
= text_area_width
* hscroll_step_rel
12965 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12968 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12970 hscroll
= max (hscroll
, w
->min_hscroll
);
12972 /* Don't prevent redisplay optimizations if hscroll
12973 hasn't changed, as it will unnecessarily slow down
12975 if (w
->hscroll
!= hscroll
)
12977 XBUFFER (w
->contents
)->prevent_redisplay_optimizations_p
= 1;
12978 w
->hscroll
= hscroll
;
12987 /* Value is non-zero if hscroll of any leaf window has been changed. */
12988 return hscrolled_p
;
12992 /* Set hscroll so that cursor is visible and not inside horizontal
12993 scroll margins for all windows in the tree rooted at WINDOW. See
12994 also hscroll_window_tree above. Value is non-zero if any window's
12995 hscroll has been changed. If it has, desired matrices on the frame
12996 of WINDOW are cleared. */
12999 hscroll_windows (Lisp_Object window
)
13001 int hscrolled_p
= hscroll_window_tree (window
);
13003 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
13004 return hscrolled_p
;
13009 /************************************************************************
13011 ************************************************************************/
13013 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
13014 to a non-zero value. This is sometimes handy to have in a debugger
13019 /* First and last unchanged row for try_window_id. */
13021 static int debug_first_unchanged_at_end_vpos
;
13022 static int debug_last_unchanged_at_beg_vpos
;
13024 /* Delta vpos and y. */
13026 static int debug_dvpos
, debug_dy
;
13028 /* Delta in characters and bytes for try_window_id. */
13030 static ptrdiff_t debug_delta
, debug_delta_bytes
;
13032 /* Values of window_end_pos and window_end_vpos at the end of
13035 static ptrdiff_t debug_end_vpos
;
13037 /* Append a string to W->desired_matrix->method. FMT is a printf
13038 format string. If trace_redisplay_p is true also printf the
13039 resulting string to stderr. */
13041 static void debug_method_add (struct window
*, char const *, ...)
13042 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13045 debug_method_add (struct window
*w
, char const *fmt
, ...)
13048 char *method
= w
->desired_matrix
->method
;
13049 int len
= strlen (method
);
13050 int size
= sizeof w
->desired_matrix
->method
;
13051 int remaining
= size
- len
- 1;
13054 if (len
&& remaining
)
13057 --remaining
, ++len
;
13060 va_start (ap
, fmt
);
13061 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13064 if (trace_redisplay_p
)
13065 fprintf (stderr
, "%p (%s): %s\n",
13067 ((BUFFERP (w
->contents
)
13068 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13069 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13074 #endif /* GLYPH_DEBUG */
13077 /* Value is non-zero if all changes in window W, which displays
13078 current_buffer, are in the text between START and END. START is a
13079 buffer position, END is given as a distance from Z. Used in
13080 redisplay_internal for display optimization. */
13083 text_outside_line_unchanged_p (struct window
*w
,
13084 ptrdiff_t start
, ptrdiff_t end
)
13086 int unchanged_p
= 1;
13088 /* If text or overlays have changed, see where. */
13089 if (window_outdated (w
))
13091 /* Gap in the line? */
13092 if (GPT
< start
|| Z
- GPT
< end
)
13095 /* Changes start in front of the line, or end after it? */
13097 && (BEG_UNCHANGED
< start
- 1
13098 || END_UNCHANGED
< end
))
13101 /* If selective display, can't optimize if changes start at the
13102 beginning of the line. */
13104 && INTEGERP (BVAR (current_buffer
, selective_display
))
13105 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13106 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13109 /* If there are overlays at the start or end of the line, these
13110 may have overlay strings with newlines in them. A change at
13111 START, for instance, may actually concern the display of such
13112 overlay strings as well, and they are displayed on different
13113 lines. So, quickly rule out this case. (For the future, it
13114 might be desirable to implement something more telling than
13115 just BEG/END_UNCHANGED.) */
13118 if (BEG
+ BEG_UNCHANGED
== start
13119 && overlay_touches_p (start
))
13121 if (END_UNCHANGED
== end
13122 && overlay_touches_p (Z
- end
))
13126 /* Under bidi reordering, adding or deleting a character in the
13127 beginning of a paragraph, before the first strong directional
13128 character, can change the base direction of the paragraph (unless
13129 the buffer specifies a fixed paragraph direction), which will
13130 require to redisplay the whole paragraph. It might be worthwhile
13131 to find the paragraph limits and widen the range of redisplayed
13132 lines to that, but for now just give up this optimization. */
13133 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13134 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13138 return unchanged_p
;
13142 /* Do a frame update, taking possible shortcuts into account. This is
13143 the main external entry point for redisplay.
13145 If the last redisplay displayed an echo area message and that message
13146 is no longer requested, we clear the echo area or bring back the
13147 mini-buffer if that is in use. */
13152 redisplay_internal ();
13157 overlay_arrow_string_or_property (Lisp_Object var
)
13161 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13164 return Voverlay_arrow_string
;
13167 /* Return 1 if there are any overlay-arrows in current_buffer. */
13169 overlay_arrow_in_current_buffer_p (void)
13173 for (vlist
= Voverlay_arrow_variable_list
;
13175 vlist
= XCDR (vlist
))
13177 Lisp_Object var
= XCAR (vlist
);
13180 if (!SYMBOLP (var
))
13182 val
= find_symbol_value (var
);
13184 && current_buffer
== XMARKER (val
)->buffer
)
13191 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
13195 overlay_arrows_changed_p (void)
13199 for (vlist
= Voverlay_arrow_variable_list
;
13201 vlist
= XCDR (vlist
))
13203 Lisp_Object var
= XCAR (vlist
);
13204 Lisp_Object val
, pstr
;
13206 if (!SYMBOLP (var
))
13208 val
= find_symbol_value (var
);
13209 if (!MARKERP (val
))
13211 if (! EQ (COERCE_MARKER (val
),
13212 Fget (var
, Qlast_arrow_position
))
13213 || ! (pstr
= overlay_arrow_string_or_property (var
),
13214 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13220 /* Mark overlay arrows to be updated on next redisplay. */
13223 update_overlay_arrows (int up_to_date
)
13227 for (vlist
= Voverlay_arrow_variable_list
;
13229 vlist
= XCDR (vlist
))
13231 Lisp_Object var
= XCAR (vlist
);
13233 if (!SYMBOLP (var
))
13236 if (up_to_date
> 0)
13238 Lisp_Object val
= find_symbol_value (var
);
13239 Fput (var
, Qlast_arrow_position
,
13240 COERCE_MARKER (val
));
13241 Fput (var
, Qlast_arrow_string
,
13242 overlay_arrow_string_or_property (var
));
13244 else if (up_to_date
< 0
13245 || !NILP (Fget (var
, Qlast_arrow_position
)))
13247 Fput (var
, Qlast_arrow_position
, Qt
);
13248 Fput (var
, Qlast_arrow_string
, Qt
);
13254 /* Return overlay arrow string to display at row.
13255 Return integer (bitmap number) for arrow bitmap in left fringe.
13256 Return nil if no overlay arrow. */
13259 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13263 for (vlist
= Voverlay_arrow_variable_list
;
13265 vlist
= XCDR (vlist
))
13267 Lisp_Object var
= XCAR (vlist
);
13270 if (!SYMBOLP (var
))
13273 val
= find_symbol_value (var
);
13276 && current_buffer
== XMARKER (val
)->buffer
13277 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13279 if (FRAME_WINDOW_P (it
->f
)
13280 /* FIXME: if ROW->reversed_p is set, this should test
13281 the right fringe, not the left one. */
13282 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13284 #ifdef HAVE_WINDOW_SYSTEM
13285 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13288 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
13289 return make_number (fringe_bitmap
);
13292 return make_number (-1); /* Use default arrow bitmap. */
13294 return overlay_arrow_string_or_property (var
);
13301 /* Return 1 if point moved out of or into a composition. Otherwise
13302 return 0. PREV_BUF and PREV_PT are the last point buffer and
13303 position. BUF and PT are the current point buffer and position. */
13306 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13307 struct buffer
*buf
, ptrdiff_t pt
)
13309 ptrdiff_t start
, end
;
13311 Lisp_Object buffer
;
13313 XSETBUFFER (buffer
, buf
);
13314 /* Check a composition at the last point if point moved within the
13316 if (prev_buf
== buf
)
13319 /* Point didn't move. */
13322 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13323 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13324 && composition_valid_p (start
, end
, prop
)
13325 && start
< prev_pt
&& end
> prev_pt
)
13326 /* The last point was within the composition. Return 1 iff
13327 point moved out of the composition. */
13328 return (pt
<= start
|| pt
>= end
);
13331 /* Check a composition at the current point. */
13332 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13333 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13334 && composition_valid_p (start
, end
, prop
)
13335 && start
< pt
&& end
> pt
);
13338 /* Reconsider the clip changes of buffer which is displayed in W. */
13341 reconsider_clip_changes (struct window
*w
)
13343 struct buffer
*b
= XBUFFER (w
->contents
);
13345 if (b
->clip_changed
13346 && w
->window_end_valid
13347 && w
->current_matrix
->buffer
== b
13348 && w
->current_matrix
->zv
== BUF_ZV (b
)
13349 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13350 b
->clip_changed
= 0;
13352 /* If display wasn't paused, and W is not a tool bar window, see if
13353 point has been moved into or out of a composition. In that case,
13354 we set b->clip_changed to 1 to force updating the screen. If
13355 b->clip_changed has already been set to 1, we can skip this
13357 if (!b
->clip_changed
&& w
->window_end_valid
)
13359 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13360 ? PT
: marker_position (w
->pointm
));
13362 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13363 && check_point_in_composition (w
->current_matrix
->buffer
,
13364 w
->last_point
, b
, pt
))
13365 b
->clip_changed
= 1;
13370 propagate_buffer_redisplay (void)
13371 { /* Resetting b->text->redisplay is problematic!
13372 We can't just reset it in the case that some window that displays
13373 it has not been redisplayed; and such a window can stay
13374 unredisplayed for a long time if it's currently invisible.
13375 But we do want to reset it at the end of redisplay otherwise
13376 its displayed windows will keep being redisplayed over and over
13378 So we copy all b->text->redisplay flags up to their windows here,
13379 such that mark_window_display_accurate can safely reset
13380 b->text->redisplay. */
13381 Lisp_Object ws
= window_list ();
13382 for (; CONSP (ws
); ws
= XCDR (ws
))
13384 struct window
*thisw
= XWINDOW (XCAR (ws
));
13385 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13386 if (thisb
->text
->redisplay
)
13387 thisw
->redisplay
= true;
13391 #define STOP_POLLING \
13392 do { if (! polling_stopped_here) stop_polling (); \
13393 polling_stopped_here = 1; } while (0)
13395 #define RESUME_POLLING \
13396 do { if (polling_stopped_here) start_polling (); \
13397 polling_stopped_here = 0; } while (0)
13400 /* Perhaps in the future avoid recentering windows if it
13401 is not necessary; currently that causes some problems. */
13404 redisplay_internal (void)
13406 struct window
*w
= XWINDOW (selected_window
);
13410 bool must_finish
= 0, match_p
;
13411 struct text_pos tlbufpos
, tlendpos
;
13412 int number_of_visible_frames
;
13415 int polling_stopped_here
= 0;
13416 Lisp_Object tail
, frame
;
13418 /* True means redisplay has to consider all windows on all
13419 frames. False, only selected_window is considered. */
13420 bool consider_all_windows_p
;
13422 /* True means redisplay has to redisplay the miniwindow. */
13423 bool update_miniwindow_p
= false;
13425 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13427 /* No redisplay if running in batch mode or frame is not yet fully
13428 initialized, or redisplay is explicitly turned off by setting
13429 Vinhibit_redisplay. */
13430 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13431 || !NILP (Vinhibit_redisplay
))
13434 /* Don't examine these until after testing Vinhibit_redisplay.
13435 When Emacs is shutting down, perhaps because its connection to
13436 X has dropped, we should not look at them at all. */
13437 fr
= XFRAME (w
->frame
);
13438 sf
= SELECTED_FRAME ();
13440 if (!fr
->glyphs_initialized_p
)
13443 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13444 if (popup_activated ())
13448 /* I don't think this happens but let's be paranoid. */
13449 if (redisplaying_p
)
13452 /* Record a function that clears redisplaying_p
13453 when we leave this function. */
13454 count
= SPECPDL_INDEX ();
13455 record_unwind_protect_void (unwind_redisplay
);
13456 redisplaying_p
= 1;
13457 specbind (Qinhibit_free_realized_faces
, Qnil
);
13459 /* Record this function, so it appears on the profiler's backtraces. */
13460 record_in_backtrace (Qredisplay_internal
, &Qnil
, 0);
13462 FOR_EACH_FRAME (tail
, frame
)
13463 XFRAME (frame
)->already_hscrolled_p
= 0;
13466 /* Remember the currently selected window. */
13470 last_escape_glyph_frame
= NULL
;
13471 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13472 last_glyphless_glyph_frame
= NULL
;
13473 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13475 /* If face_change_count is non-zero, init_iterator will free all
13476 realized faces, which includes the faces referenced from current
13477 matrices. So, we can't reuse current matrices in this case. */
13478 if (face_change_count
)
13479 windows_or_buffers_changed
= 47;
13481 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13482 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13484 /* Since frames on a single ASCII terminal share the same
13485 display area, displaying a different frame means redisplay
13486 the whole thing. */
13487 SET_FRAME_GARBAGED (sf
);
13489 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13491 FRAME_TTY (sf
)->previous_frame
= sf
;
13494 /* Set the visible flags for all frames. Do this before checking for
13495 resized or garbaged frames; they want to know if their frames are
13496 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13497 number_of_visible_frames
= 0;
13499 FOR_EACH_FRAME (tail
, frame
)
13501 struct frame
*f
= XFRAME (frame
);
13503 if (FRAME_VISIBLE_P (f
))
13505 ++number_of_visible_frames
;
13506 /* Adjust matrices for visible frames only. */
13507 if (f
->fonts_changed
)
13509 adjust_frame_glyphs (f
);
13510 f
->fonts_changed
= 0;
13512 /* If cursor type has been changed on the frame
13513 other than selected, consider all frames. */
13514 if (f
!= sf
&& f
->cursor_type_changed
)
13515 update_mode_lines
= 31;
13517 clear_desired_matrices (f
);
13520 /* Notice any pending interrupt request to change frame size. */
13521 do_pending_window_change (1);
13523 /* do_pending_window_change could change the selected_window due to
13524 frame resizing which makes the selected window too small. */
13525 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13528 /* Clear frames marked as garbaged. */
13529 clear_garbaged_frames ();
13531 /* Build menubar and tool-bar items. */
13532 if (NILP (Vmemory_full
))
13533 prepare_menu_bars ();
13535 reconsider_clip_changes (w
);
13537 /* In most cases selected window displays current buffer. */
13538 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13541 /* Detect case that we need to write or remove a star in the mode line. */
13542 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13543 w
->update_mode_line
= 1;
13545 if (mode_line_update_needed (w
))
13546 w
->update_mode_line
= 1;
13549 /* Normally the message* functions will have already displayed and
13550 updated the echo area, but the frame may have been trashed, or
13551 the update may have been preempted, so display the echo area
13552 again here. Checking message_cleared_p captures the case that
13553 the echo area should be cleared. */
13554 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13555 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13556 || (message_cleared_p
13557 && minibuf_level
== 0
13558 /* If the mini-window is currently selected, this means the
13559 echo-area doesn't show through. */
13560 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13562 int window_height_changed_p
= echo_area_display (0);
13564 if (message_cleared_p
)
13565 update_miniwindow_p
= true;
13569 /* If we don't display the current message, don't clear the
13570 message_cleared_p flag, because, if we did, we wouldn't clear
13571 the echo area in the next redisplay which doesn't preserve
13573 if (!display_last_displayed_message_p
)
13574 message_cleared_p
= 0;
13576 if (window_height_changed_p
)
13578 windows_or_buffers_changed
= 50;
13580 /* If window configuration was changed, frames may have been
13581 marked garbaged. Clear them or we will experience
13582 surprises wrt scrolling. */
13583 clear_garbaged_frames ();
13586 else if (EQ (selected_window
, minibuf_window
)
13587 && (current_buffer
->clip_changed
|| window_outdated (w
))
13588 && resize_mini_window (w
, 0))
13590 /* Resized active mini-window to fit the size of what it is
13591 showing if its contents might have changed. */
13594 /* If window configuration was changed, frames may have been
13595 marked garbaged. Clear them or we will experience
13596 surprises wrt scrolling. */
13597 clear_garbaged_frames ();
13600 if (windows_or_buffers_changed
&& !update_mode_lines
)
13601 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13602 only the windows's contents needs to be refreshed, or whether the
13603 mode-lines also need a refresh. */
13604 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13605 ? REDISPLAY_SOME
: 32);
13607 /* If specs for an arrow have changed, do thorough redisplay
13608 to ensure we remove any arrow that should no longer exist. */
13609 if (overlay_arrows_changed_p ())
13610 /* Apparently, this is the only case where we update other windows,
13611 without updating other mode-lines. */
13612 windows_or_buffers_changed
= 49;
13614 consider_all_windows_p
= (update_mode_lines
13615 || windows_or_buffers_changed
);
13617 #define AINC(a,i) \
13618 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13619 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13621 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13622 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13624 /* Optimize the case that only the line containing the cursor in the
13625 selected window has changed. Variables starting with this_ are
13626 set in display_line and record information about the line
13627 containing the cursor. */
13628 tlbufpos
= this_line_start_pos
;
13629 tlendpos
= this_line_end_pos
;
13630 if (!consider_all_windows_p
13631 && CHARPOS (tlbufpos
) > 0
13632 && !w
->update_mode_line
13633 && !current_buffer
->clip_changed
13634 && !current_buffer
->prevent_redisplay_optimizations_p
13635 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13636 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13637 && !XFRAME (w
->frame
)->cursor_type_changed
13638 /* Make sure recorded data applies to current buffer, etc. */
13639 && this_line_buffer
== current_buffer
13642 && !w
->optional_new_start
13643 /* Point must be on the line that we have info recorded about. */
13644 && PT
>= CHARPOS (tlbufpos
)
13645 && PT
<= Z
- CHARPOS (tlendpos
)
13646 /* All text outside that line, including its final newline,
13647 must be unchanged. */
13648 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13649 CHARPOS (tlendpos
)))
13651 if (CHARPOS (tlbufpos
) > BEGV
13652 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13653 && (CHARPOS (tlbufpos
) == ZV
13654 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13655 /* Former continuation line has disappeared by becoming empty. */
13657 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13659 /* We have to handle the case of continuation around a
13660 wide-column character (see the comment in indent.c around
13663 For instance, in the following case:
13665 -------- Insert --------
13666 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13667 J_I_ ==> J_I_ `^^' are cursors.
13671 As we have to redraw the line above, we cannot use this
13675 int line_height_before
= this_line_pixel_height
;
13677 /* Note that start_display will handle the case that the
13678 line starting at tlbufpos is a continuation line. */
13679 start_display (&it
, w
, tlbufpos
);
13681 /* Implementation note: It this still necessary? */
13682 if (it
.current_x
!= this_line_start_x
)
13685 TRACE ((stderr
, "trying display optimization 1\n"));
13686 w
->cursor
.vpos
= -1;
13687 overlay_arrow_seen
= 0;
13688 it
.vpos
= this_line_vpos
;
13689 it
.current_y
= this_line_y
;
13690 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13691 display_line (&it
);
13693 /* If line contains point, is not continued,
13694 and ends at same distance from eob as before, we win. */
13695 if (w
->cursor
.vpos
>= 0
13696 /* Line is not continued, otherwise this_line_start_pos
13697 would have been set to 0 in display_line. */
13698 && CHARPOS (this_line_start_pos
)
13699 /* Line ends as before. */
13700 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13701 /* Line has same height as before. Otherwise other lines
13702 would have to be shifted up or down. */
13703 && this_line_pixel_height
== line_height_before
)
13705 /* If this is not the window's last line, we must adjust
13706 the charstarts of the lines below. */
13707 if (it
.current_y
< it
.last_visible_y
)
13709 struct glyph_row
*row
13710 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13711 ptrdiff_t delta
, delta_bytes
;
13713 /* We used to distinguish between two cases here,
13714 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13715 when the line ends in a newline or the end of the
13716 buffer's accessible portion. But both cases did
13717 the same, so they were collapsed. */
13719 - CHARPOS (tlendpos
)
13720 - MATRIX_ROW_START_CHARPOS (row
));
13721 delta_bytes
= (Z_BYTE
13722 - BYTEPOS (tlendpos
)
13723 - MATRIX_ROW_START_BYTEPOS (row
));
13725 increment_matrix_positions (w
->current_matrix
,
13726 this_line_vpos
+ 1,
13727 w
->current_matrix
->nrows
,
13728 delta
, delta_bytes
);
13731 /* If this row displays text now but previously didn't,
13732 or vice versa, w->window_end_vpos may have to be
13734 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13736 if (w
->window_end_vpos
< this_line_vpos
)
13737 w
->window_end_vpos
= this_line_vpos
;
13739 else if (w
->window_end_vpos
== this_line_vpos
13740 && this_line_vpos
> 0)
13741 w
->window_end_vpos
= this_line_vpos
- 1;
13742 w
->window_end_valid
= 0;
13744 /* Update hint: No need to try to scroll in update_window. */
13745 w
->desired_matrix
->no_scrolling_p
= 1;
13748 *w
->desired_matrix
->method
= 0;
13749 debug_method_add (w
, "optimization 1");
13751 #ifdef HAVE_WINDOW_SYSTEM
13752 update_window_fringes (w
, 0);
13759 else if (/* Cursor position hasn't changed. */
13760 PT
== w
->last_point
13761 /* Make sure the cursor was last displayed
13762 in this window. Otherwise we have to reposition it. */
13764 /* PXW: Must be converted to pixels, probably. */
13765 && 0 <= w
->cursor
.vpos
13766 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13770 do_pending_window_change (1);
13771 /* If selected_window changed, redisplay again. */
13772 if (WINDOWP (selected_window
)
13773 && (w
= XWINDOW (selected_window
)) != sw
)
13776 /* We used to always goto end_of_redisplay here, but this
13777 isn't enough if we have a blinking cursor. */
13778 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13779 goto end_of_redisplay
;
13783 /* If highlighting the region, or if the cursor is in the echo area,
13784 then we can't just move the cursor. */
13785 else if (NILP (Vshow_trailing_whitespace
)
13786 && !cursor_in_echo_area
)
13789 struct glyph_row
*row
;
13791 /* Skip from tlbufpos to PT and see where it is. Note that
13792 PT may be in invisible text. If so, we will end at the
13793 next visible position. */
13794 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13795 NULL
, DEFAULT_FACE_ID
);
13796 it
.current_x
= this_line_start_x
;
13797 it
.current_y
= this_line_y
;
13798 it
.vpos
= this_line_vpos
;
13800 /* The call to move_it_to stops in front of PT, but
13801 moves over before-strings. */
13802 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13804 if (it
.vpos
== this_line_vpos
13805 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13808 eassert (this_line_vpos
== it
.vpos
);
13809 eassert (this_line_y
== it
.current_y
);
13810 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13812 *w
->desired_matrix
->method
= 0;
13813 debug_method_add (w
, "optimization 3");
13822 /* Text changed drastically or point moved off of line. */
13823 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13826 CHARPOS (this_line_start_pos
) = 0;
13827 ++clear_face_cache_count
;
13828 #ifdef HAVE_WINDOW_SYSTEM
13829 ++clear_image_cache_count
;
13832 /* Build desired matrices, and update the display. If
13833 consider_all_windows_p is non-zero, do it for all windows on all
13834 frames. Otherwise do it for selected_window, only. */
13836 if (consider_all_windows_p
)
13838 FOR_EACH_FRAME (tail
, frame
)
13839 XFRAME (frame
)->updated_p
= 0;
13841 propagate_buffer_redisplay ();
13843 FOR_EACH_FRAME (tail
, frame
)
13845 struct frame
*f
= XFRAME (frame
);
13847 /* We don't have to do anything for unselected terminal
13849 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13850 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13855 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13858 /* Only GC scrollbars when we redisplay the whole frame. */
13859 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13860 /* Mark all the scroll bars to be removed; we'll redeem
13861 the ones we want when we redisplay their windows. */
13862 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13863 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13865 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13866 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13867 /* Remember that the invisible frames need to be redisplayed next
13868 time they're visible. */
13869 else if (!REDISPLAY_SOME_P ())
13870 f
->redisplay
= true;
13872 /* The X error handler may have deleted that frame. */
13873 if (!FRAME_LIVE_P (f
))
13876 /* Any scroll bars which redisplay_windows should have
13877 nuked should now go away. */
13878 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13879 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13881 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13883 /* If fonts changed on visible frame, display again. */
13884 if (f
->fonts_changed
)
13886 adjust_frame_glyphs (f
);
13887 f
->fonts_changed
= 0;
13891 /* See if we have to hscroll. */
13892 if (!f
->already_hscrolled_p
)
13894 f
->already_hscrolled_p
= 1;
13895 if (hscroll_windows (f
->root_window
))
13899 /* Prevent various kinds of signals during display
13900 update. stdio is not robust about handling
13901 signals, which can cause an apparent I/O error. */
13902 if (interrupt_input
)
13903 unrequest_sigio ();
13906 pending
|= update_frame (f
, 0, 0);
13907 f
->cursor_type_changed
= 0;
13913 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13917 /* Do the mark_window_display_accurate after all windows have
13918 been redisplayed because this call resets flags in buffers
13919 which are needed for proper redisplay. */
13920 FOR_EACH_FRAME (tail
, frame
)
13922 struct frame
*f
= XFRAME (frame
);
13925 f
->redisplay
= false;
13926 mark_window_display_accurate (f
->root_window
, 1);
13927 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13928 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13933 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13935 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13936 struct frame
*mini_frame
;
13938 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13939 /* Use list_of_error, not Qerror, so that
13940 we catch only errors and don't run the debugger. */
13941 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13943 redisplay_window_error
);
13944 if (update_miniwindow_p
)
13945 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13947 redisplay_window_error
);
13949 /* Compare desired and current matrices, perform output. */
13952 /* If fonts changed, display again. */
13953 if (sf
->fonts_changed
)
13956 /* Prevent various kinds of signals during display update.
13957 stdio is not robust about handling signals,
13958 which can cause an apparent I/O error. */
13959 if (interrupt_input
)
13960 unrequest_sigio ();
13963 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13965 if (hscroll_windows (selected_window
))
13968 XWINDOW (selected_window
)->must_be_updated_p
= true;
13969 pending
= update_frame (sf
, 0, 0);
13970 sf
->cursor_type_changed
= 0;
13973 /* We may have called echo_area_display at the top of this
13974 function. If the echo area is on another frame, that may
13975 have put text on a frame other than the selected one, so the
13976 above call to update_frame would not have caught it. Catch
13978 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13979 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13981 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13983 XWINDOW (mini_window
)->must_be_updated_p
= true;
13984 pending
|= update_frame (mini_frame
, 0, 0);
13985 mini_frame
->cursor_type_changed
= 0;
13986 if (!pending
&& hscroll_windows (mini_window
))
13991 /* If display was paused because of pending input, make sure we do a
13992 thorough update the next time. */
13995 /* Prevent the optimization at the beginning of
13996 redisplay_internal that tries a single-line update of the
13997 line containing the cursor in the selected window. */
13998 CHARPOS (this_line_start_pos
) = 0;
14000 /* Let the overlay arrow be updated the next time. */
14001 update_overlay_arrows (0);
14003 /* If we pause after scrolling, some rows in the current
14004 matrices of some windows are not valid. */
14005 if (!WINDOW_FULL_WIDTH_P (w
)
14006 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
14007 update_mode_lines
= 36;
14011 if (!consider_all_windows_p
)
14013 /* This has already been done above if
14014 consider_all_windows_p is set. */
14015 if (XBUFFER (w
->contents
)->text
->redisplay
14016 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
14017 /* This can happen if b->text->redisplay was set during
14019 propagate_buffer_redisplay ();
14020 mark_window_display_accurate_1 (w
, 1);
14022 /* Say overlay arrows are up to date. */
14023 update_overlay_arrows (1);
14025 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
14026 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
14029 update_mode_lines
= 0;
14030 windows_or_buffers_changed
= 0;
14033 /* Start SIGIO interrupts coming again. Having them off during the
14034 code above makes it less likely one will discard output, but not
14035 impossible, since there might be stuff in the system buffer here.
14036 But it is much hairier to try to do anything about that. */
14037 if (interrupt_input
)
14041 /* If a frame has become visible which was not before, redisplay
14042 again, so that we display it. Expose events for such a frame
14043 (which it gets when becoming visible) don't call the parts of
14044 redisplay constructing glyphs, so simply exposing a frame won't
14045 display anything in this case. So, we have to display these
14046 frames here explicitly. */
14051 FOR_EACH_FRAME (tail
, frame
)
14053 if (XFRAME (frame
)->visible
)
14057 if (new_count
!= number_of_visible_frames
)
14058 windows_or_buffers_changed
= 52;
14061 /* Change frame size now if a change is pending. */
14062 do_pending_window_change (1);
14064 /* If we just did a pending size change, or have additional
14065 visible frames, or selected_window changed, redisplay again. */
14066 if ((windows_or_buffers_changed
&& !pending
)
14067 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14070 /* Clear the face and image caches.
14072 We used to do this only if consider_all_windows_p. But the cache
14073 needs to be cleared if a timer creates images in the current
14074 buffer (e.g. the test case in Bug#6230). */
14076 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14078 clear_face_cache (0);
14079 clear_face_cache_count
= 0;
14082 #ifdef HAVE_WINDOW_SYSTEM
14083 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14085 clear_image_caches (Qnil
);
14086 clear_image_cache_count
= 0;
14088 #endif /* HAVE_WINDOW_SYSTEM */
14091 if (interrupt_input
&& interrupts_deferred
)
14094 unbind_to (count
, Qnil
);
14099 /* Redisplay, but leave alone any recent echo area message unless
14100 another message has been requested in its place.
14102 This is useful in situations where you need to redisplay but no
14103 user action has occurred, making it inappropriate for the message
14104 area to be cleared. See tracking_off and
14105 wait_reading_process_output for examples of these situations.
14107 FROM_WHERE is an integer saying from where this function was
14108 called. This is useful for debugging. */
14111 redisplay_preserve_echo_area (int from_where
)
14113 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14115 if (!NILP (echo_area_buffer
[1]))
14117 /* We have a previously displayed message, but no current
14118 message. Redisplay the previous message. */
14119 display_last_displayed_message_p
= 1;
14120 redisplay_internal ();
14121 display_last_displayed_message_p
= 0;
14124 redisplay_internal ();
14126 flush_frame (SELECTED_FRAME ());
14130 /* Function registered with record_unwind_protect in redisplay_internal. */
14133 unwind_redisplay (void)
14135 redisplaying_p
= 0;
14139 /* Mark the display of leaf window W as accurate or inaccurate.
14140 If ACCURATE_P is non-zero mark display of W as accurate. If
14141 ACCURATE_P is zero, arrange for W to be redisplayed the next
14142 time redisplay_internal is called. */
14145 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
14147 struct buffer
*b
= XBUFFER (w
->contents
);
14149 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14150 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14151 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14155 b
->clip_changed
= false;
14156 b
->prevent_redisplay_optimizations_p
= false;
14157 eassert (buffer_window_count (b
) > 0);
14158 /* Resetting b->text->redisplay is problematic!
14159 In order to make it safer to do it here, redisplay_internal must
14160 have copied all b->text->redisplay to their respective windows. */
14161 b
->text
->redisplay
= false;
14163 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14164 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14165 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14166 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14168 w
->current_matrix
->buffer
= b
;
14169 w
->current_matrix
->begv
= BUF_BEGV (b
);
14170 w
->current_matrix
->zv
= BUF_ZV (b
);
14172 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14173 w
->last_cursor_off_p
= w
->cursor_off_p
;
14175 if (w
== XWINDOW (selected_window
))
14176 w
->last_point
= BUF_PT (b
);
14178 w
->last_point
= marker_position (w
->pointm
);
14180 w
->window_end_valid
= true;
14181 w
->update_mode_line
= false;
14184 w
->redisplay
= !accurate_p
;
14188 /* Mark the display of windows in the window tree rooted at WINDOW as
14189 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
14190 windows as accurate. If ACCURATE_P is zero, arrange for windows to
14191 be redisplayed the next time redisplay_internal is called. */
14194 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
14198 for (; !NILP (window
); window
= w
->next
)
14200 w
= XWINDOW (window
);
14201 if (WINDOWP (w
->contents
))
14202 mark_window_display_accurate (w
->contents
, accurate_p
);
14204 mark_window_display_accurate_1 (w
, accurate_p
);
14208 update_overlay_arrows (1);
14210 /* Force a thorough redisplay the next time by setting
14211 last_arrow_position and last_arrow_string to t, which is
14212 unequal to any useful value of Voverlay_arrow_... */
14213 update_overlay_arrows (-1);
14217 /* Return value in display table DP (Lisp_Char_Table *) for character
14218 C. Since a display table doesn't have any parent, we don't have to
14219 follow parent. Do not call this function directly but use the
14220 macro DISP_CHAR_VECTOR. */
14223 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14227 if (ASCII_CHAR_P (c
))
14230 if (SUB_CHAR_TABLE_P (val
))
14231 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14237 XSETCHAR_TABLE (table
, dp
);
14238 val
= char_table_ref (table
, c
);
14247 /***********************************************************************
14249 ***********************************************************************/
14251 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14254 redisplay_windows (Lisp_Object window
)
14256 while (!NILP (window
))
14258 struct window
*w
= XWINDOW (window
);
14260 if (WINDOWP (w
->contents
))
14261 redisplay_windows (w
->contents
);
14262 else if (BUFFERP (w
->contents
))
14264 displayed_buffer
= XBUFFER (w
->contents
);
14265 /* Use list_of_error, not Qerror, so that
14266 we catch only errors and don't run the debugger. */
14267 internal_condition_case_1 (redisplay_window_0
, window
,
14269 redisplay_window_error
);
14277 redisplay_window_error (Lisp_Object ignore
)
14279 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14284 redisplay_window_0 (Lisp_Object window
)
14286 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14287 redisplay_window (window
, false);
14292 redisplay_window_1 (Lisp_Object window
)
14294 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14295 redisplay_window (window
, true);
14300 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14301 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14302 which positions recorded in ROW differ from current buffer
14305 Return 0 if cursor is not on this row, 1 otherwise. */
14308 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14309 struct glyph_matrix
*matrix
,
14310 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14313 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14314 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14315 struct glyph
*cursor
= NULL
;
14316 /* The last known character position in row. */
14317 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14319 ptrdiff_t pt_old
= PT
- delta
;
14320 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14321 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14322 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14323 /* A glyph beyond the edge of TEXT_AREA which we should never
14325 struct glyph
*glyphs_end
= end
;
14326 /* Non-zero means we've found a match for cursor position, but that
14327 glyph has the avoid_cursor_p flag set. */
14328 int match_with_avoid_cursor
= 0;
14329 /* Non-zero means we've seen at least one glyph that came from a
14331 int string_seen
= 0;
14332 /* Largest and smallest buffer positions seen so far during scan of
14334 ptrdiff_t bpos_max
= pos_before
;
14335 ptrdiff_t bpos_min
= pos_after
;
14336 /* Last buffer position covered by an overlay string with an integer
14337 `cursor' property. */
14338 ptrdiff_t bpos_covered
= 0;
14339 /* Non-zero means the display string on which to display the cursor
14340 comes from a text property, not from an overlay. */
14341 int string_from_text_prop
= 0;
14343 /* Don't even try doing anything if called for a mode-line or
14344 header-line row, since the rest of the code isn't prepared to
14345 deal with such calamities. */
14346 eassert (!row
->mode_line_p
);
14347 if (row
->mode_line_p
)
14350 /* Skip over glyphs not having an object at the start and the end of
14351 the row. These are special glyphs like truncation marks on
14352 terminal frames. */
14353 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14355 if (!row
->reversed_p
)
14358 && INTEGERP (glyph
->object
)
14359 && glyph
->charpos
< 0)
14361 x
+= glyph
->pixel_width
;
14365 && INTEGERP ((end
- 1)->object
)
14366 /* CHARPOS is zero for blanks and stretch glyphs
14367 inserted by extend_face_to_end_of_line. */
14368 && (end
- 1)->charpos
<= 0)
14370 glyph_before
= glyph
- 1;
14377 /* If the glyph row is reversed, we need to process it from back
14378 to front, so swap the edge pointers. */
14379 glyphs_end
= end
= glyph
- 1;
14380 glyph
+= row
->used
[TEXT_AREA
] - 1;
14382 while (glyph
> end
+ 1
14383 && INTEGERP (glyph
->object
)
14384 && glyph
->charpos
< 0)
14387 x
-= glyph
->pixel_width
;
14389 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
14391 /* By default, in reversed rows we put the cursor on the
14392 rightmost (first in the reading order) glyph. */
14393 for (g
= end
+ 1; g
< glyph
; g
++)
14394 x
+= g
->pixel_width
;
14396 && INTEGERP ((end
+ 1)->object
)
14397 && (end
+ 1)->charpos
<= 0)
14399 glyph_before
= glyph
+ 1;
14403 else if (row
->reversed_p
)
14405 /* In R2L rows that don't display text, put the cursor on the
14406 rightmost glyph. Case in point: an empty last line that is
14407 part of an R2L paragraph. */
14409 /* Avoid placing the cursor on the last glyph of the row, where
14410 on terminal frames we hold the vertical border between
14411 adjacent windows. */
14412 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14413 && !WINDOW_RIGHTMOST_P (w
)
14414 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14416 x
= -1; /* will be computed below, at label compute_x */
14419 /* Step 1: Try to find the glyph whose character position
14420 corresponds to point. If that's not possible, find 2 glyphs
14421 whose character positions are the closest to point, one before
14422 point, the other after it. */
14423 if (!row
->reversed_p
)
14424 while (/* not marched to end of glyph row */
14426 /* glyph was not inserted by redisplay for internal purposes */
14427 && !INTEGERP (glyph
->object
))
14429 if (BUFFERP (glyph
->object
))
14431 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14433 if (glyph
->charpos
> bpos_max
)
14434 bpos_max
= glyph
->charpos
;
14435 if (glyph
->charpos
< bpos_min
)
14436 bpos_min
= glyph
->charpos
;
14437 if (!glyph
->avoid_cursor_p
)
14439 /* If we hit point, we've found the glyph on which to
14440 display the cursor. */
14443 match_with_avoid_cursor
= 0;
14446 /* See if we've found a better approximation to
14447 POS_BEFORE or to POS_AFTER. */
14448 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14450 pos_before
= glyph
->charpos
;
14451 glyph_before
= glyph
;
14453 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14455 pos_after
= glyph
->charpos
;
14456 glyph_after
= glyph
;
14459 else if (dpos
== 0)
14460 match_with_avoid_cursor
= 1;
14462 else if (STRINGP (glyph
->object
))
14464 Lisp_Object chprop
;
14465 ptrdiff_t glyph_pos
= glyph
->charpos
;
14467 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14469 if (!NILP (chprop
))
14471 /* If the string came from a `display' text property,
14472 look up the buffer position of that property and
14473 use that position to update bpos_max, as if we
14474 actually saw such a position in one of the row's
14475 glyphs. This helps with supporting integer values
14476 of `cursor' property on the display string in
14477 situations where most or all of the row's buffer
14478 text is completely covered by display properties,
14479 so that no glyph with valid buffer positions is
14480 ever seen in the row. */
14481 ptrdiff_t prop_pos
=
14482 string_buffer_position_lim (glyph
->object
, pos_before
,
14485 if (prop_pos
>= pos_before
)
14486 bpos_max
= prop_pos
;
14488 if (INTEGERP (chprop
))
14490 bpos_covered
= bpos_max
+ XINT (chprop
);
14491 /* If the `cursor' property covers buffer positions up
14492 to and including point, we should display cursor on
14493 this glyph. Note that, if a `cursor' property on one
14494 of the string's characters has an integer value, we
14495 will break out of the loop below _before_ we get to
14496 the position match above. IOW, integer values of
14497 the `cursor' property override the "exact match for
14498 point" strategy of positioning the cursor. */
14499 /* Implementation note: bpos_max == pt_old when, e.g.,
14500 we are in an empty line, where bpos_max is set to
14501 MATRIX_ROW_START_CHARPOS, see above. */
14502 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14511 x
+= glyph
->pixel_width
;
14514 else if (glyph
> end
) /* row is reversed */
14515 while (!INTEGERP (glyph
->object
))
14517 if (BUFFERP (glyph
->object
))
14519 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14521 if (glyph
->charpos
> bpos_max
)
14522 bpos_max
= glyph
->charpos
;
14523 if (glyph
->charpos
< bpos_min
)
14524 bpos_min
= glyph
->charpos
;
14525 if (!glyph
->avoid_cursor_p
)
14529 match_with_avoid_cursor
= 0;
14532 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14534 pos_before
= glyph
->charpos
;
14535 glyph_before
= glyph
;
14537 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14539 pos_after
= glyph
->charpos
;
14540 glyph_after
= glyph
;
14543 else if (dpos
== 0)
14544 match_with_avoid_cursor
= 1;
14546 else if (STRINGP (glyph
->object
))
14548 Lisp_Object chprop
;
14549 ptrdiff_t glyph_pos
= glyph
->charpos
;
14551 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14553 if (!NILP (chprop
))
14555 ptrdiff_t prop_pos
=
14556 string_buffer_position_lim (glyph
->object
, pos_before
,
14559 if (prop_pos
>= pos_before
)
14560 bpos_max
= prop_pos
;
14562 if (INTEGERP (chprop
))
14564 bpos_covered
= bpos_max
+ XINT (chprop
);
14565 /* If the `cursor' property covers buffer positions up
14566 to and including point, we should display cursor on
14568 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14577 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14579 x
--; /* can't use any pixel_width */
14582 x
-= glyph
->pixel_width
;
14585 /* Step 2: If we didn't find an exact match for point, we need to
14586 look for a proper place to put the cursor among glyphs between
14587 GLYPH_BEFORE and GLYPH_AFTER. */
14588 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14589 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14590 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14592 /* An empty line has a single glyph whose OBJECT is zero and
14593 whose CHARPOS is the position of a newline on that line.
14594 Note that on a TTY, there are more glyphs after that, which
14595 were produced by extend_face_to_end_of_line, but their
14596 CHARPOS is zero or negative. */
14598 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14599 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0
14600 /* On a TTY, continued and truncated rows also have a glyph at
14601 their end whose OBJECT is zero and whose CHARPOS is
14602 positive (the continuation and truncation glyphs), but such
14603 rows are obviously not "empty". */
14604 && !(row
->continued_p
|| row
->truncated_on_right_p
);
14606 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14608 ptrdiff_t ellipsis_pos
;
14610 /* Scan back over the ellipsis glyphs. */
14611 if (!row
->reversed_p
)
14613 ellipsis_pos
= (glyph
- 1)->charpos
;
14614 while (glyph
> row
->glyphs
[TEXT_AREA
]
14615 && (glyph
- 1)->charpos
== ellipsis_pos
)
14616 glyph
--, x
-= glyph
->pixel_width
;
14617 /* That loop always goes one position too far, including
14618 the glyph before the ellipsis. So scan forward over
14620 x
+= glyph
->pixel_width
;
14623 else /* row is reversed */
14625 ellipsis_pos
= (glyph
+ 1)->charpos
;
14626 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14627 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14628 glyph
++, x
+= glyph
->pixel_width
;
14629 x
-= glyph
->pixel_width
;
14633 else if (match_with_avoid_cursor
)
14635 cursor
= glyph_after
;
14638 else if (string_seen
)
14640 int incr
= row
->reversed_p
? -1 : +1;
14642 /* Need to find the glyph that came out of a string which is
14643 present at point. That glyph is somewhere between
14644 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14645 positioned between POS_BEFORE and POS_AFTER in the
14647 struct glyph
*start
, *stop
;
14648 ptrdiff_t pos
= pos_before
;
14652 /* If the row ends in a newline from a display string,
14653 reordering could have moved the glyphs belonging to the
14654 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14655 in this case we extend the search to the last glyph in
14656 the row that was not inserted by redisplay. */
14657 if (row
->ends_in_newline_from_string_p
)
14660 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14663 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14664 correspond to POS_BEFORE and POS_AFTER, respectively. We
14665 need START and STOP in the order that corresponds to the
14666 row's direction as given by its reversed_p flag. If the
14667 directionality of characters between POS_BEFORE and
14668 POS_AFTER is the opposite of the row's base direction,
14669 these characters will have been reordered for display,
14670 and we need to reverse START and STOP. */
14671 if (!row
->reversed_p
)
14673 start
= min (glyph_before
, glyph_after
);
14674 stop
= max (glyph_before
, glyph_after
);
14678 start
= max (glyph_before
, glyph_after
);
14679 stop
= min (glyph_before
, glyph_after
);
14681 for (glyph
= start
+ incr
;
14682 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14685 /* Any glyphs that come from the buffer are here because
14686 of bidi reordering. Skip them, and only pay
14687 attention to glyphs that came from some string. */
14688 if (STRINGP (glyph
->object
))
14692 /* If the display property covers the newline, we
14693 need to search for it one position farther. */
14694 ptrdiff_t lim
= pos_after
14695 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14697 string_from_text_prop
= 0;
14698 str
= glyph
->object
;
14699 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14700 if (tem
== 0 /* from overlay */
14703 /* If the string from which this glyph came is
14704 found in the buffer at point, or at position
14705 that is closer to point than pos_after, then
14706 we've found the glyph we've been looking for.
14707 If it comes from an overlay (tem == 0), and
14708 it has the `cursor' property on one of its
14709 glyphs, record that glyph as a candidate for
14710 displaying the cursor. (As in the
14711 unidirectional version, we will display the
14712 cursor on the last candidate we find.) */
14715 || (tem
- pt_old
> 0 && tem
< pos_after
))
14717 /* The glyphs from this string could have
14718 been reordered. Find the one with the
14719 smallest string position. Or there could
14720 be a character in the string with the
14721 `cursor' property, which means display
14722 cursor on that character's glyph. */
14723 ptrdiff_t strpos
= glyph
->charpos
;
14728 string_from_text_prop
= 1;
14731 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14732 && EQ (glyph
->object
, str
);
14736 ptrdiff_t gpos
= glyph
->charpos
;
14738 cprop
= Fget_char_property (make_number (gpos
),
14746 if (tem
&& glyph
->charpos
< strpos
)
14748 strpos
= glyph
->charpos
;
14754 || (tem
- pt_old
> 0 && tem
< pos_after
))
14758 pos
= tem
+ 1; /* don't find previous instances */
14760 /* This string is not what we want; skip all of the
14761 glyphs that came from it. */
14762 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14763 && EQ (glyph
->object
, str
))
14770 /* If we reached the end of the line, and END was from a string,
14771 the cursor is not on this line. */
14773 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14774 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14775 && STRINGP (end
->object
)
14776 && row
->continued_p
)
14779 /* A truncated row may not include PT among its character positions.
14780 Setting the cursor inside the scroll margin will trigger
14781 recalculation of hscroll in hscroll_window_tree. But if a
14782 display string covers point, defer to the string-handling
14783 code below to figure this out. */
14784 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14786 cursor
= glyph_before
;
14789 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14790 /* Zero-width characters produce no glyphs. */
14792 && (row
->reversed_p
14793 ? glyph_after
> glyphs_end
14794 : glyph_after
< glyphs_end
)))
14796 cursor
= glyph_after
;
14802 if (cursor
!= NULL
)
14804 else if (glyph
== glyphs_end
14805 && pos_before
== pos_after
14806 && STRINGP ((row
->reversed_p
14807 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14808 : row
->glyphs
[TEXT_AREA
])->object
))
14810 /* If all the glyphs of this row came from strings, put the
14811 cursor on the first glyph of the row. This avoids having the
14812 cursor outside of the text area in this very rare and hard
14816 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14817 : row
->glyphs
[TEXT_AREA
];
14823 /* Need to compute x that corresponds to GLYPH. */
14824 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14826 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14828 x
+= g
->pixel_width
;
14832 /* ROW could be part of a continued line, which, under bidi
14833 reordering, might have other rows whose start and end charpos
14834 occlude point. Only set w->cursor if we found a better
14835 approximation to the cursor position than we have from previously
14836 examined candidate rows belonging to the same continued line. */
14837 if (/* We already have a candidate row. */
14838 w
->cursor
.vpos
>= 0
14839 /* That candidate is not the row we are processing. */
14840 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14841 /* Make sure cursor.vpos specifies a row whose start and end
14842 charpos occlude point, and it is valid candidate for being a
14843 cursor-row. This is because some callers of this function
14844 leave cursor.vpos at the row where the cursor was displayed
14845 during the last redisplay cycle. */
14846 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14847 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14848 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14851 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14853 /* Don't consider glyphs that are outside TEXT_AREA. */
14854 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14856 /* Keep the candidate whose buffer position is the closest to
14857 point or has the `cursor' property. */
14858 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14859 w
->cursor
.hpos
>= 0
14860 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14861 && ((BUFFERP (g1
->object
)
14862 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14863 || (BUFFERP (glyph
->object
)
14864 && eabs (g1
->charpos
- pt_old
)
14865 < eabs (glyph
->charpos
- pt_old
))))
14866 /* Previous candidate is a glyph from a string that has
14867 a non-nil `cursor' property. */
14868 || (STRINGP (g1
->object
)
14869 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14870 Qcursor
, g1
->object
))
14871 /* Previous candidate is from the same display
14872 string as this one, and the display string
14873 came from a text property. */
14874 || (EQ (g1
->object
, glyph
->object
)
14875 && string_from_text_prop
)
14876 /* this candidate is from newline and its
14877 position is not an exact match */
14878 || (INTEGERP (glyph
->object
)
14879 && glyph
->charpos
!= pt_old
)))))
14881 /* If this candidate gives an exact match, use that. */
14882 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14883 /* If this candidate is a glyph created for the
14884 terminating newline of a line, and point is on that
14885 newline, it wins because it's an exact match. */
14886 || (!row
->continued_p
14887 && INTEGERP (glyph
->object
)
14888 && glyph
->charpos
== 0
14889 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14890 /* Otherwise, keep the candidate that comes from a row
14891 spanning less buffer positions. This may win when one or
14892 both candidate positions are on glyphs that came from
14893 display strings, for which we cannot compare buffer
14895 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14896 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14897 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14900 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14902 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14903 w
->cursor
.y
= row
->y
+ dy
;
14905 if (w
== XWINDOW (selected_window
))
14907 if (!row
->continued_p
14908 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14911 this_line_buffer
= XBUFFER (w
->contents
);
14913 CHARPOS (this_line_start_pos
)
14914 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14915 BYTEPOS (this_line_start_pos
)
14916 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14918 CHARPOS (this_line_end_pos
)
14919 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14920 BYTEPOS (this_line_end_pos
)
14921 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14923 this_line_y
= w
->cursor
.y
;
14924 this_line_pixel_height
= row
->height
;
14925 this_line_vpos
= w
->cursor
.vpos
;
14926 this_line_start_x
= row
->x
;
14929 CHARPOS (this_line_start_pos
) = 0;
14936 /* Run window scroll functions, if any, for WINDOW with new window
14937 start STARTP. Sets the window start of WINDOW to that position.
14939 We assume that the window's buffer is really current. */
14941 static struct text_pos
14942 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14944 struct window
*w
= XWINDOW (window
);
14945 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14947 eassert (current_buffer
== XBUFFER (w
->contents
));
14949 if (!NILP (Vwindow_scroll_functions
))
14951 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14952 make_number (CHARPOS (startp
)));
14953 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14954 /* In case the hook functions switch buffers. */
14955 set_buffer_internal (XBUFFER (w
->contents
));
14962 /* Make sure the line containing the cursor is fully visible.
14963 A value of 1 means there is nothing to be done.
14964 (Either the line is fully visible, or it cannot be made so,
14965 or we cannot tell.)
14967 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14968 is higher than window.
14970 A value of 0 means the caller should do scrolling
14971 as if point had gone off the screen. */
14974 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14976 struct glyph_matrix
*matrix
;
14977 struct glyph_row
*row
;
14980 if (!make_cursor_line_fully_visible_p
)
14983 /* It's not always possible to find the cursor, e.g, when a window
14984 is full of overlay strings. Don't do anything in that case. */
14985 if (w
->cursor
.vpos
< 0)
14988 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14989 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14991 /* If the cursor row is not partially visible, there's nothing to do. */
14992 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14995 /* If the row the cursor is in is taller than the window's height,
14996 it's not clear what to do, so do nothing. */
14997 window_height
= window_box_height (w
);
14998 if (row
->height
>= window_height
)
15000 if (!force_p
|| MINI_WINDOW_P (w
)
15001 || w
->vscroll
|| w
->cursor
.vpos
== 0)
15008 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
15009 non-zero means only WINDOW is redisplayed in redisplay_internal.
15010 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
15011 in redisplay_window to bring a partially visible line into view in
15012 the case that only the cursor has moved.
15014 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
15015 last screen line's vertical height extends past the end of the screen.
15019 1 if scrolling succeeded
15021 0 if scrolling didn't find point.
15023 -1 if new fonts have been loaded so that we must interrupt
15024 redisplay, adjust glyph matrices, and try again. */
15030 SCROLLING_NEED_LARGER_MATRICES
15033 /* If scroll-conservatively is more than this, never recenter.
15035 If you change this, don't forget to update the doc string of
15036 `scroll-conservatively' and the Emacs manual. */
15037 #define SCROLL_LIMIT 100
15040 try_scrolling (Lisp_Object window
, int just_this_one_p
,
15041 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15042 int temp_scroll_step
, int last_line_misfit
)
15044 struct window
*w
= XWINDOW (window
);
15045 struct frame
*f
= XFRAME (w
->frame
);
15046 struct text_pos pos
, startp
;
15048 int this_scroll_margin
, scroll_max
, rc
, height
;
15049 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
15050 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
15051 Lisp_Object aggressive
;
15052 /* We will never try scrolling more than this number of lines. */
15053 int scroll_limit
= SCROLL_LIMIT
;
15054 int frame_line_height
= default_line_pixel_height (w
);
15055 int window_total_lines
15056 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15059 debug_method_add (w
, "try_scrolling");
15062 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15064 /* Compute scroll margin height in pixels. We scroll when point is
15065 within this distance from the top or bottom of the window. */
15066 if (scroll_margin
> 0)
15067 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15068 * frame_line_height
;
15070 this_scroll_margin
= 0;
15072 /* Force arg_scroll_conservatively to have a reasonable value, to
15073 avoid scrolling too far away with slow move_it_* functions. Note
15074 that the user can supply scroll-conservatively equal to
15075 `most-positive-fixnum', which can be larger than INT_MAX. */
15076 if (arg_scroll_conservatively
> scroll_limit
)
15078 arg_scroll_conservatively
= scroll_limit
+ 1;
15079 scroll_max
= scroll_limit
* frame_line_height
;
15081 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15082 /* Compute how much we should try to scroll maximally to bring
15083 point into view. */
15084 scroll_max
= (max (scroll_step
,
15085 max (arg_scroll_conservatively
, temp_scroll_step
))
15086 * frame_line_height
);
15087 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15088 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15089 /* We're trying to scroll because of aggressive scrolling but no
15090 scroll_step is set. Choose an arbitrary one. */
15091 scroll_max
= 10 * frame_line_height
;
15097 /* Decide whether to scroll down. */
15098 if (PT
> CHARPOS (startp
))
15100 int scroll_margin_y
;
15102 /* Compute the pixel ypos of the scroll margin, then move IT to
15103 either that ypos or PT, whichever comes first. */
15104 start_display (&it
, w
, startp
);
15105 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15106 - frame_line_height
* extra_scroll_margin_lines
;
15107 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15108 (MOVE_TO_POS
| MOVE_TO_Y
));
15110 if (PT
> CHARPOS (it
.current
.pos
))
15112 int y0
= line_bottom_y (&it
);
15113 /* Compute how many pixels below window bottom to stop searching
15114 for PT. This avoids costly search for PT that is far away if
15115 the user limited scrolling by a small number of lines, but
15116 always finds PT if scroll_conservatively is set to a large
15117 number, such as most-positive-fixnum. */
15118 int slack
= max (scroll_max
, 10 * frame_line_height
);
15119 int y_to_move
= it
.last_visible_y
+ slack
;
15121 /* Compute the distance from the scroll margin to PT or to
15122 the scroll limit, whichever comes first. This should
15123 include the height of the cursor line, to make that line
15125 move_it_to (&it
, PT
, -1, y_to_move
,
15126 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15127 dy
= line_bottom_y (&it
) - y0
;
15129 if (dy
> scroll_max
)
15130 return SCROLLING_FAILED
;
15139 /* Point is in or below the bottom scroll margin, so move the
15140 window start down. If scrolling conservatively, move it just
15141 enough down to make point visible. If scroll_step is set,
15142 move it down by scroll_step. */
15143 if (arg_scroll_conservatively
)
15145 = min (max (dy
, frame_line_height
),
15146 frame_line_height
* arg_scroll_conservatively
);
15147 else if (scroll_step
|| temp_scroll_step
)
15148 amount_to_scroll
= scroll_max
;
15151 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15152 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15153 if (NUMBERP (aggressive
))
15155 double float_amount
= XFLOATINT (aggressive
) * height
;
15156 int aggressive_scroll
= float_amount
;
15157 if (aggressive_scroll
== 0 && float_amount
> 0)
15158 aggressive_scroll
= 1;
15159 /* Don't let point enter the scroll margin near top of
15160 the window. This could happen if the value of
15161 scroll_up_aggressively is too large and there are
15162 non-zero margins, because scroll_up_aggressively
15163 means put point that fraction of window height
15164 _from_the_bottom_margin_. */
15165 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15166 aggressive_scroll
= height
- 2*this_scroll_margin
;
15167 amount_to_scroll
= dy
+ aggressive_scroll
;
15171 if (amount_to_scroll
<= 0)
15172 return SCROLLING_FAILED
;
15174 start_display (&it
, w
, startp
);
15175 if (arg_scroll_conservatively
<= scroll_limit
)
15176 move_it_vertically (&it
, amount_to_scroll
);
15179 /* Extra precision for users who set scroll-conservatively
15180 to a large number: make sure the amount we scroll
15181 the window start is never less than amount_to_scroll,
15182 which was computed as distance from window bottom to
15183 point. This matters when lines at window top and lines
15184 below window bottom have different height. */
15186 void *it1data
= NULL
;
15187 /* We use a temporary it1 because line_bottom_y can modify
15188 its argument, if it moves one line down; see there. */
15191 SAVE_IT (it1
, it
, it1data
);
15192 start_y
= line_bottom_y (&it1
);
15194 RESTORE_IT (&it
, &it
, it1data
);
15195 move_it_by_lines (&it
, 1);
15196 SAVE_IT (it1
, it
, it1data
);
15197 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15200 /* If STARTP is unchanged, move it down another screen line. */
15201 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
15202 move_it_by_lines (&it
, 1);
15203 startp
= it
.current
.pos
;
15207 struct text_pos scroll_margin_pos
= startp
;
15210 /* See if point is inside the scroll margin at the top of the
15212 if (this_scroll_margin
)
15216 start_display (&it
, w
, startp
);
15217 y_start
= it
.current_y
;
15218 move_it_vertically (&it
, this_scroll_margin
);
15219 scroll_margin_pos
= it
.current
.pos
;
15220 /* If we didn't move enough before hitting ZV, request
15221 additional amount of scroll, to move point out of the
15223 if (IT_CHARPOS (it
) == ZV
15224 && it
.current_y
- y_start
< this_scroll_margin
)
15225 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15228 if (PT
< CHARPOS (scroll_margin_pos
))
15230 /* Point is in the scroll margin at the top of the window or
15231 above what is displayed in the window. */
15234 /* Compute the vertical distance from PT to the scroll
15235 margin position. Move as far as scroll_max allows, or
15236 one screenful, or 10 screen lines, whichever is largest.
15237 Give up if distance is greater than scroll_max or if we
15238 didn't reach the scroll margin position. */
15239 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15240 start_display (&it
, w
, pos
);
15242 y_to_move
= max (it
.last_visible_y
,
15243 max (scroll_max
, 10 * frame_line_height
));
15244 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15246 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15247 dy
= it
.current_y
- y0
;
15248 if (dy
> scroll_max
15249 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15250 return SCROLLING_FAILED
;
15252 /* Additional scroll for when ZV was too close to point. */
15255 /* Compute new window start. */
15256 start_display (&it
, w
, startp
);
15258 if (arg_scroll_conservatively
)
15259 amount_to_scroll
= max (dy
, frame_line_height
*
15260 max (scroll_step
, temp_scroll_step
));
15261 else if (scroll_step
|| temp_scroll_step
)
15262 amount_to_scroll
= scroll_max
;
15265 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15266 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15267 if (NUMBERP (aggressive
))
15269 double float_amount
= XFLOATINT (aggressive
) * height
;
15270 int aggressive_scroll
= float_amount
;
15271 if (aggressive_scroll
== 0 && float_amount
> 0)
15272 aggressive_scroll
= 1;
15273 /* Don't let point enter the scroll margin near
15274 bottom of the window, if the value of
15275 scroll_down_aggressively happens to be too
15277 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15278 aggressive_scroll
= height
- 2*this_scroll_margin
;
15279 amount_to_scroll
= dy
+ aggressive_scroll
;
15283 if (amount_to_scroll
<= 0)
15284 return SCROLLING_FAILED
;
15286 move_it_vertically_backward (&it
, amount_to_scroll
);
15287 startp
= it
.current
.pos
;
15291 /* Run window scroll functions. */
15292 startp
= run_window_scroll_functions (window
, startp
);
15294 /* Display the window. Give up if new fonts are loaded, or if point
15296 if (!try_window (window
, startp
, 0))
15297 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15298 else if (w
->cursor
.vpos
< 0)
15300 clear_glyph_matrix (w
->desired_matrix
);
15301 rc
= SCROLLING_FAILED
;
15305 /* Maybe forget recorded base line for line number display. */
15306 if (!just_this_one_p
15307 || current_buffer
->clip_changed
15308 || BEG_UNCHANGED
< CHARPOS (startp
))
15309 w
->base_line_number
= 0;
15311 /* If cursor ends up on a partially visible line,
15312 treat that as being off the bottom of the screen. */
15313 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
15314 /* It's possible that the cursor is on the first line of the
15315 buffer, which is partially obscured due to a vscroll
15316 (Bug#7537). In that case, avoid looping forever. */
15317 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15319 clear_glyph_matrix (w
->desired_matrix
);
15320 ++extra_scroll_margin_lines
;
15323 rc
= SCROLLING_SUCCESS
;
15330 /* Compute a suitable window start for window W if display of W starts
15331 on a continuation line. Value is non-zero if a new window start
15334 The new window start will be computed, based on W's width, starting
15335 from the start of the continued line. It is the start of the
15336 screen line with the minimum distance from the old start W->start. */
15339 compute_window_start_on_continuation_line (struct window
*w
)
15341 struct text_pos pos
, start_pos
;
15342 int window_start_changed_p
= 0;
15344 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15346 /* If window start is on a continuation line... Window start may be
15347 < BEGV in case there's invisible text at the start of the
15348 buffer (M-x rmail, for example). */
15349 if (CHARPOS (start_pos
) > BEGV
15350 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15353 struct glyph_row
*row
;
15355 /* Handle the case that the window start is out of range. */
15356 if (CHARPOS (start_pos
) < BEGV
)
15357 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15358 else if (CHARPOS (start_pos
) > ZV
)
15359 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15361 /* Find the start of the continued line. This should be fast
15362 because find_newline is fast (newline cache). */
15363 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
15364 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15365 row
, DEFAULT_FACE_ID
);
15366 reseat_at_previous_visible_line_start (&it
);
15368 /* If the line start is "too far" away from the window start,
15369 say it takes too much time to compute a new window start. */
15370 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15371 /* PXW: Do we need upper bounds here? */
15372 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15374 int min_distance
, distance
;
15376 /* Move forward by display lines to find the new window
15377 start. If window width was enlarged, the new start can
15378 be expected to be > the old start. If window width was
15379 decreased, the new window start will be < the old start.
15380 So, we're looking for the display line start with the
15381 minimum distance from the old window start. */
15382 pos
= it
.current
.pos
;
15383 min_distance
= INFINITY
;
15384 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15385 distance
< min_distance
)
15387 min_distance
= distance
;
15388 pos
= it
.current
.pos
;
15389 if (it
.line_wrap
== WORD_WRAP
)
15391 /* Under WORD_WRAP, move_it_by_lines is likely to
15392 overshoot and stop not at the first, but the
15393 second character from the left margin. So in
15394 that case, we need a more tight control on the X
15395 coordinate of the iterator than move_it_by_lines
15396 promises in its contract. The method is to first
15397 go to the last (rightmost) visible character of a
15398 line, then move to the leftmost character on the
15399 next line in a separate call. */
15400 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15401 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15402 move_it_to (&it
, ZV
, 0,
15403 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15404 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15407 move_it_by_lines (&it
, 1);
15410 /* Set the window start there. */
15411 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15412 window_start_changed_p
= 1;
15416 return window_start_changed_p
;
15420 /* Try cursor movement in case text has not changed in window WINDOW,
15421 with window start STARTP. Value is
15423 CURSOR_MOVEMENT_SUCCESS if successful
15425 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15427 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15428 display. *SCROLL_STEP is set to 1, under certain circumstances, if
15429 we want to scroll as if scroll-step were set to 1. See the code.
15431 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15432 which case we have to abort this redisplay, and adjust matrices
15437 CURSOR_MOVEMENT_SUCCESS
,
15438 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15439 CURSOR_MOVEMENT_MUST_SCROLL
,
15440 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15444 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
15446 struct window
*w
= XWINDOW (window
);
15447 struct frame
*f
= XFRAME (w
->frame
);
15448 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15451 if (inhibit_try_cursor_movement
)
15455 /* Previously, there was a check for Lisp integer in the
15456 if-statement below. Now, this field is converted to
15457 ptrdiff_t, thus zero means invalid position in a buffer. */
15458 eassert (w
->last_point
> 0);
15459 /* Likewise there was a check whether window_end_vpos is nil or larger
15460 than the window. Now window_end_vpos is int and so never nil, but
15461 let's leave eassert to check whether it fits in the window. */
15462 eassert (w
->window_end_vpos
< w
->current_matrix
->nrows
);
15464 /* Handle case where text has not changed, only point, and it has
15465 not moved off the frame. */
15466 if (/* Point may be in this window. */
15467 PT
>= CHARPOS (startp
)
15468 /* Selective display hasn't changed. */
15469 && !current_buffer
->clip_changed
15470 /* Function force-mode-line-update is used to force a thorough
15471 redisplay. It sets either windows_or_buffers_changed or
15472 update_mode_lines. So don't take a shortcut here for these
15474 && !update_mode_lines
15475 && !windows_or_buffers_changed
15476 && !f
->cursor_type_changed
15477 && NILP (Vshow_trailing_whitespace
)
15478 /* This code is not used for mini-buffer for the sake of the case
15479 of redisplaying to replace an echo area message; since in
15480 that case the mini-buffer contents per se are usually
15481 unchanged. This code is of no real use in the mini-buffer
15482 since the handling of this_line_start_pos, etc., in redisplay
15483 handles the same cases. */
15484 && !EQ (window
, minibuf_window
)
15485 && (FRAME_WINDOW_P (f
)
15486 || !overlay_arrow_in_current_buffer_p ()))
15488 int this_scroll_margin
, top_scroll_margin
;
15489 struct glyph_row
*row
= NULL
;
15490 int frame_line_height
= default_line_pixel_height (w
);
15491 int window_total_lines
15492 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15495 debug_method_add (w
, "cursor movement");
15498 /* Scroll if point within this distance from the top or bottom
15499 of the window. This is a pixel value. */
15500 if (scroll_margin
> 0)
15502 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15503 this_scroll_margin
*= frame_line_height
;
15506 this_scroll_margin
= 0;
15508 top_scroll_margin
= this_scroll_margin
;
15509 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15510 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15512 /* Start with the row the cursor was displayed during the last
15513 not paused redisplay. Give up if that row is not valid. */
15514 if (w
->last_cursor_vpos
< 0
15515 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15516 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15519 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15520 if (row
->mode_line_p
)
15522 if (!row
->enabled_p
)
15523 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15526 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15528 int scroll_p
= 0, must_scroll
= 0;
15529 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15531 if (PT
> w
->last_point
)
15533 /* Point has moved forward. */
15534 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15535 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15537 eassert (row
->enabled_p
);
15541 /* If the end position of a row equals the start
15542 position of the next row, and PT is at that position,
15543 we would rather display cursor in the next line. */
15544 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15545 && MATRIX_ROW_END_CHARPOS (row
) == PT
15546 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15547 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15548 && !cursor_row_p (row
))
15551 /* If within the scroll margin, scroll. Note that
15552 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15553 the next line would be drawn, and that
15554 this_scroll_margin can be zero. */
15555 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15556 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15557 /* Line is completely visible last line in window
15558 and PT is to be set in the next line. */
15559 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15560 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15561 && !row
->ends_at_zv_p
15562 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15565 else if (PT
< w
->last_point
)
15567 /* Cursor has to be moved backward. Note that PT >=
15568 CHARPOS (startp) because of the outer if-statement. */
15569 while (!row
->mode_line_p
15570 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15571 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15572 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15573 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15574 row
> w
->current_matrix
->rows
15575 && (row
-1)->ends_in_newline_from_string_p
))))
15576 && (row
->y
> top_scroll_margin
15577 || CHARPOS (startp
) == BEGV
))
15579 eassert (row
->enabled_p
);
15583 /* Consider the following case: Window starts at BEGV,
15584 there is invisible, intangible text at BEGV, so that
15585 display starts at some point START > BEGV. It can
15586 happen that we are called with PT somewhere between
15587 BEGV and START. Try to handle that case. */
15588 if (row
< w
->current_matrix
->rows
15589 || row
->mode_line_p
)
15591 row
= w
->current_matrix
->rows
;
15592 if (row
->mode_line_p
)
15596 /* Due to newlines in overlay strings, we may have to
15597 skip forward over overlay strings. */
15598 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15599 && MATRIX_ROW_END_CHARPOS (row
) == PT
15600 && !cursor_row_p (row
))
15603 /* If within the scroll margin, scroll. */
15604 if (row
->y
< top_scroll_margin
15605 && CHARPOS (startp
) != BEGV
)
15610 /* Cursor did not move. So don't scroll even if cursor line
15611 is partially visible, as it was so before. */
15612 rc
= CURSOR_MOVEMENT_SUCCESS
;
15615 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15616 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15618 /* if PT is not in the glyph row, give up. */
15619 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15622 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15623 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15625 struct glyph_row
*row1
;
15627 /* If rows are bidi-reordered and point moved, back up
15628 until we find a row that does not belong to a
15629 continuation line. This is because we must consider
15630 all rows of a continued line as candidates for the
15631 new cursor positioning, since row start and end
15632 positions change non-linearly with vertical position
15634 /* FIXME: Revisit this when glyph ``spilling'' in
15635 continuation lines' rows is implemented for
15636 bidi-reordered rows. */
15637 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15638 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15641 /* If we hit the beginning of the displayed portion
15642 without finding the first row of a continued
15646 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15649 eassert (row
->enabled_p
);
15654 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15655 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15656 /* Make sure this isn't a header line by any chance, since
15657 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15658 && !row
->mode_line_p
15659 && make_cursor_line_fully_visible_p
)
15661 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15662 && !row
->ends_at_zv_p
15663 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15664 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15665 else if (row
->height
> window_box_height (w
))
15667 /* If we end up in a partially visible line, let's
15668 make it fully visible, except when it's taller
15669 than the window, in which case we can't do much
15672 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15676 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15677 if (!cursor_row_fully_visible_p (w
, 0, 1))
15678 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15680 rc
= CURSOR_MOVEMENT_SUCCESS
;
15684 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15685 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15686 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15688 /* With bidi-reordered rows, there could be more than
15689 one candidate row whose start and end positions
15690 occlude point. We need to let set_cursor_from_row
15691 find the best candidate. */
15692 /* FIXME: Revisit this when glyph ``spilling'' in
15693 continuation lines' rows is implemented for
15694 bidi-reordered rows. */
15699 int at_zv_p
= 0, exact_match_p
= 0;
15701 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15702 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15703 && cursor_row_p (row
))
15704 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15706 /* As soon as we've found the exact match for point,
15707 or the first suitable row whose ends_at_zv_p flag
15708 is set, we are done. */
15711 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15712 w
->cursor
.vpos
)->ends_at_zv_p
;
15714 && w
->cursor
.hpos
>= 0
15715 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15718 struct glyph_row
*candidate
=
15719 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15721 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15722 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15725 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15726 || (INTEGERP (g
->object
)
15727 && (g
->charpos
== PT
15728 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15730 if (at_zv_p
|| exact_match_p
)
15732 rc
= CURSOR_MOVEMENT_SUCCESS
;
15736 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15740 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15741 || row
->continued_p
)
15742 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15743 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15744 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15745 /* If we didn't find any candidate rows, or exited the
15746 loop before all the candidates were examined, signal
15747 to the caller that this method failed. */
15748 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15750 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15751 && !row
->continued_p
))
15752 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15754 rc
= CURSOR_MOVEMENT_SUCCESS
;
15760 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15762 rc
= CURSOR_MOVEMENT_SUCCESS
;
15767 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15768 && MATRIX_ROW_START_CHARPOS (row
) == PT
15769 && cursor_row_p (row
));
15777 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15781 set_vertical_scroll_bar (struct window
*w
)
15783 ptrdiff_t start
, end
, whole
;
15785 /* Calculate the start and end positions for the current window.
15786 At some point, it would be nice to choose between scrollbars
15787 which reflect the whole buffer size, with special markers
15788 indicating narrowing, and scrollbars which reflect only the
15791 Note that mini-buffers sometimes aren't displaying any text. */
15792 if (!MINI_WINDOW_P (w
)
15793 || (w
== XWINDOW (minibuf_window
)
15794 && NILP (echo_area_buffer
[0])))
15796 struct buffer
*buf
= XBUFFER (w
->contents
);
15797 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15798 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15799 /* I don't think this is guaranteed to be right. For the
15800 moment, we'll pretend it is. */
15801 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15805 if (whole
< (end
- start
))
15806 whole
= end
- start
;
15809 start
= end
= whole
= 0;
15811 /* Indicate what this scroll bar ought to be displaying now. */
15812 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15813 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15814 (w
, end
- start
, whole
, start
);
15818 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15819 selected_window is redisplayed.
15821 We can return without actually redisplaying the window if fonts has been
15822 changed on window's frame. In that case, redisplay_internal will retry.
15824 As one of the important parts of redisplaying a window, we need to
15825 decide whether the previous window-start position (stored in the
15826 window's w->start marker position) is still valid, and if it isn't,
15827 recompute it. Some details about that:
15829 . The previous window-start could be in a continuation line, in
15830 which case we need to recompute it when the window width
15831 changes. See compute_window_start_on_continuation_line and its
15834 . The text that changed since last redisplay could include the
15835 previous window-start position. In that case, we try to salvage
15836 what we can from the current glyph matrix by calling
15837 try_scrolling, which see.
15839 . Some Emacs command could force us to use a specific window-start
15840 position by setting the window's force_start flag, or gently
15841 propose doing that by setting the window's optional_new_start
15842 flag. In these cases, we try using the specified start point if
15843 that succeeds (i.e. the window desired matrix is successfully
15844 recomputed, and point location is within the window). In case
15845 of optional_new_start, we first check if the specified start
15846 position is feasible, i.e. if it will allow point to be
15847 displayed in the window. If using the specified start point
15848 fails, e.g., if new fonts are needed to be loaded, we abort the
15849 redisplay cycle and leave it up to the next cycle to figure out
15852 . Note that the window's force_start flag is sometimes set by
15853 redisplay itself, when it decides that the previous window start
15854 point is fine and should be kept. Search for "goto force_start"
15855 below to see the details. Like the values of window-start
15856 specified outside of redisplay, these internally-deduced values
15857 are tested for feasibility, and ignored if found to be
15860 . Note that the function try_window, used to completely redisplay
15861 a window, accepts the window's start point as its argument.
15862 This is used several times in the redisplay code to control
15863 where the window start will be, according to user options such
15864 as scroll-conservatively, and also to ensure the screen line
15865 showing point will be fully (as opposed to partially) visible on
15869 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15871 struct window
*w
= XWINDOW (window
);
15872 struct frame
*f
= XFRAME (w
->frame
);
15873 struct buffer
*buffer
= XBUFFER (w
->contents
);
15874 struct buffer
*old
= current_buffer
;
15875 struct text_pos lpoint
, opoint
, startp
;
15876 int update_mode_line
;
15879 /* Record it now because it's overwritten. */
15880 bool current_matrix_up_to_date_p
= false;
15881 bool used_current_matrix_p
= false;
15882 /* This is less strict than current_matrix_up_to_date_p.
15883 It indicates that the buffer contents and narrowing are unchanged. */
15884 bool buffer_unchanged_p
= false;
15885 int temp_scroll_step
= 0;
15886 ptrdiff_t count
= SPECPDL_INDEX ();
15888 int centering_position
= -1;
15889 int last_line_misfit
= 0;
15890 ptrdiff_t beg_unchanged
, end_unchanged
;
15891 int frame_line_height
;
15893 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15897 *w
->desired_matrix
->method
= 0;
15900 if (!just_this_one_p
15901 && REDISPLAY_SOME_P ()
15904 && !buffer
->text
->redisplay
15905 && BUF_PT (buffer
) == w
->last_point
)
15908 /* Make sure that both W's markers are valid. */
15909 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15910 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15912 /* We come here again if we need to run window-text-change-functions
15915 reconsider_clip_changes (w
);
15916 frame_line_height
= default_line_pixel_height (w
);
15918 /* Has the mode line to be updated? */
15919 update_mode_line
= (w
->update_mode_line
15920 || update_mode_lines
15921 || buffer
->clip_changed
15922 || buffer
->prevent_redisplay_optimizations_p
);
15924 if (!just_this_one_p
)
15925 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15926 cleverly elsewhere. */
15927 w
->must_be_updated_p
= true;
15929 if (MINI_WINDOW_P (w
))
15931 if (w
== XWINDOW (echo_area_window
)
15932 && !NILP (echo_area_buffer
[0]))
15934 if (update_mode_line
)
15935 /* We may have to update a tty frame's menu bar or a
15936 tool-bar. Example `M-x C-h C-h C-g'. */
15937 goto finish_menu_bars
;
15939 /* We've already displayed the echo area glyphs in this window. */
15940 goto finish_scroll_bars
;
15942 else if ((w
!= XWINDOW (minibuf_window
)
15943 || minibuf_level
== 0)
15944 /* When buffer is nonempty, redisplay window normally. */
15945 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
15946 /* Quail displays non-mini buffers in minibuffer window.
15947 In that case, redisplay the window normally. */
15948 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
15950 /* W is a mini-buffer window, but it's not active, so clear
15952 int yb
= window_text_bottom_y (w
);
15953 struct glyph_row
*row
;
15956 for (y
= 0, row
= w
->desired_matrix
->rows
;
15958 y
+= row
->height
, ++row
)
15959 blank_row (w
, row
, y
);
15960 goto finish_scroll_bars
;
15963 clear_glyph_matrix (w
->desired_matrix
);
15966 /* Otherwise set up data on this window; select its buffer and point
15968 /* Really select the buffer, for the sake of buffer-local
15970 set_buffer_internal_1 (XBUFFER (w
->contents
));
15972 current_matrix_up_to_date_p
15973 = (w
->window_end_valid
15974 && !current_buffer
->clip_changed
15975 && !current_buffer
->prevent_redisplay_optimizations_p
15976 && !window_outdated (w
));
15978 /* Run the window-text-change-functions
15979 if it is possible that the text on the screen has changed
15980 (either due to modification of the text, or any other reason). */
15981 if (!current_matrix_up_to_date_p
15982 && !NILP (Vwindow_text_change_functions
))
15984 safe_run_hooks (Qwindow_text_change_functions
);
15988 beg_unchanged
= BEG_UNCHANGED
;
15989 end_unchanged
= END_UNCHANGED
;
15991 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15993 specbind (Qinhibit_point_motion_hooks
, Qt
);
15996 = (w
->window_end_valid
15997 && !current_buffer
->clip_changed
15998 && !window_outdated (w
));
16000 /* When windows_or_buffers_changed is non-zero, we can't rely
16001 on the window end being valid, so set it to zero there. */
16002 if (windows_or_buffers_changed
)
16004 /* If window starts on a continuation line, maybe adjust the
16005 window start in case the window's width changed. */
16006 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16007 compute_window_start_on_continuation_line (w
);
16009 w
->window_end_valid
= false;
16010 /* If so, we also can't rely on current matrix
16011 and should not fool try_cursor_movement below. */
16012 current_matrix_up_to_date_p
= false;
16015 /* Some sanity checks. */
16016 CHECK_WINDOW_END (w
);
16017 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16019 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16022 if (mode_line_update_needed (w
))
16023 update_mode_line
= 1;
16025 /* Point refers normally to the selected window. For any other
16026 window, set up appropriate value. */
16027 if (!EQ (window
, selected_window
))
16029 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16030 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16034 new_pt_byte
= BEGV_BYTE
;
16035 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16037 else if (new_pt
> (ZV
- 1))
16040 new_pt_byte
= ZV_BYTE
;
16041 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16044 /* We don't use SET_PT so that the point-motion hooks don't run. */
16045 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16048 /* If any of the character widths specified in the display table
16049 have changed, invalidate the width run cache. It's true that
16050 this may be a bit late to catch such changes, but the rest of
16051 redisplay goes (non-fatally) haywire when the display table is
16052 changed, so why should we worry about doing any better? */
16053 if (current_buffer
->width_run_cache
16054 || (current_buffer
->base_buffer
16055 && current_buffer
->base_buffer
->width_run_cache
))
16057 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16059 if (! disptab_matches_widthtab
16060 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16062 struct buffer
*buf
= current_buffer
;
16064 if (buf
->base_buffer
)
16065 buf
= buf
->base_buffer
;
16066 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16067 recompute_width_table (current_buffer
, disptab
);
16071 /* If window-start is screwed up, choose a new one. */
16072 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16075 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16077 /* If someone specified a new starting point but did not insist,
16078 check whether it can be used. */
16079 if (w
->optional_new_start
16080 && CHARPOS (startp
) >= BEGV
16081 && CHARPOS (startp
) <= ZV
)
16083 w
->optional_new_start
= 0;
16084 start_display (&it
, w
, startp
);
16085 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16086 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16087 if (IT_CHARPOS (it
) == PT
)
16088 w
->force_start
= 1;
16089 /* IT may overshoot PT if text at PT is invisible. */
16090 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
16091 w
->force_start
= 1;
16096 /* Handle case where place to start displaying has been specified,
16097 unless the specified location is outside the accessible range. */
16098 if (w
->force_start
|| window_frozen_p (w
))
16100 /* We set this later on if we have to adjust point. */
16103 w
->force_start
= 0;
16105 w
->window_end_valid
= 0;
16107 /* Forget any recorded base line for line number display. */
16108 if (!buffer_unchanged_p
)
16109 w
->base_line_number
= 0;
16111 /* Redisplay the mode line. Select the buffer properly for that.
16112 Also, run the hook window-scroll-functions
16113 because we have scrolled. */
16114 /* Note, we do this after clearing force_start because
16115 if there's an error, it is better to forget about force_start
16116 than to get into an infinite loop calling the hook functions
16117 and having them get more errors. */
16118 if (!update_mode_line
16119 || ! NILP (Vwindow_scroll_functions
))
16121 update_mode_line
= 1;
16122 w
->update_mode_line
= 1;
16123 startp
= run_window_scroll_functions (window
, startp
);
16126 if (CHARPOS (startp
) < BEGV
)
16127 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16128 else if (CHARPOS (startp
) > ZV
)
16129 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16131 /* Redisplay, then check if cursor has been set during the
16132 redisplay. Give up if new fonts were loaded. */
16133 /* We used to issue a CHECK_MARGINS argument to try_window here,
16134 but this causes scrolling to fail when point begins inside
16135 the scroll margin (bug#148) -- cyd */
16136 if (!try_window (window
, startp
, 0))
16138 w
->force_start
= 1;
16139 clear_glyph_matrix (w
->desired_matrix
);
16140 goto need_larger_matrices
;
16143 if (w
->cursor
.vpos
< 0 && !window_frozen_p (w
))
16145 /* If point does not appear, try to move point so it does
16146 appear. The desired matrix has been built above, so we
16147 can use it here. */
16148 new_vpos
= window_box_height (w
) / 2;
16151 if (!cursor_row_fully_visible_p (w
, 0, 0))
16153 /* Point does appear, but on a line partly visible at end of window.
16154 Move it back to a fully-visible line. */
16155 new_vpos
= window_box_height (w
);
16156 /* But if window_box_height suggests a Y coordinate that is
16157 not less than we already have, that line will clearly not
16158 be fully visible, so give up and scroll the display.
16159 This can happen when the default face uses a font whose
16160 dimensions are different from the frame's default
16162 if (new_vpos
>= w
->cursor
.y
)
16164 w
->cursor
.vpos
= -1;
16165 clear_glyph_matrix (w
->desired_matrix
);
16166 goto try_to_scroll
;
16169 else if (w
->cursor
.vpos
>= 0)
16171 /* Some people insist on not letting point enter the scroll
16172 margin, even though this part handles windows that didn't
16174 int window_total_lines
16175 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16176 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16177 int pixel_margin
= margin
* frame_line_height
;
16178 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16180 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16181 below, which finds the row to move point to, advances by
16182 the Y coordinate of the _next_ row, see the definition of
16183 MATRIX_ROW_BOTTOM_Y. */
16184 if (w
->cursor
.vpos
< margin
+ header_line
)
16186 w
->cursor
.vpos
= -1;
16187 clear_glyph_matrix (w
->desired_matrix
);
16188 goto try_to_scroll
;
16192 int window_height
= window_box_height (w
);
16195 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16196 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16198 w
->cursor
.vpos
= -1;
16199 clear_glyph_matrix (w
->desired_matrix
);
16200 goto try_to_scroll
;
16205 /* If we need to move point for either of the above reasons,
16206 now actually do it. */
16209 struct glyph_row
*row
;
16211 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16212 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16215 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16216 MATRIX_ROW_START_BYTEPOS (row
));
16218 if (w
!= XWINDOW (selected_window
))
16219 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16220 else if (current_buffer
== old
)
16221 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16223 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16225 /* If we are highlighting the region, then we just changed
16226 the region, so redisplay to show it. */
16227 /* FIXME: We need to (re)run pre-redisplay-function! */
16228 /* if (markpos_of_region () >= 0)
16230 clear_glyph_matrix (w->desired_matrix);
16231 if (!try_window (window, startp, 0))
16232 goto need_larger_matrices;
16238 debug_method_add (w
, "forced window start");
16243 /* Handle case where text has not changed, only point, and it has
16244 not moved off the frame, and we are not retrying after hscroll.
16245 (current_matrix_up_to_date_p is nonzero when retrying.) */
16246 if (current_matrix_up_to_date_p
16247 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16248 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16252 case CURSOR_MOVEMENT_SUCCESS
:
16253 used_current_matrix_p
= 1;
16256 case CURSOR_MOVEMENT_MUST_SCROLL
:
16257 goto try_to_scroll
;
16263 /* If current starting point was originally the beginning of a line
16264 but no longer is, find a new starting point. */
16265 else if (w
->start_at_line_beg
16266 && !(CHARPOS (startp
) <= BEGV
16267 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16270 debug_method_add (w
, "recenter 1");
16275 /* Try scrolling with try_window_id. Value is > 0 if update has
16276 been done, it is -1 if we know that the same window start will
16277 not work. It is 0 if unsuccessful for some other reason. */
16278 else if ((tem
= try_window_id (w
)) != 0)
16281 debug_method_add (w
, "try_window_id %d", tem
);
16284 if (f
->fonts_changed
)
16285 goto need_larger_matrices
;
16289 /* Otherwise try_window_id has returned -1 which means that we
16290 don't want the alternative below this comment to execute. */
16292 else if (CHARPOS (startp
) >= BEGV
16293 && CHARPOS (startp
) <= ZV
16294 && PT
>= CHARPOS (startp
)
16295 && (CHARPOS (startp
) < ZV
16296 /* Avoid starting at end of buffer. */
16297 || CHARPOS (startp
) == BEGV
16298 || !window_outdated (w
)))
16300 int d1
, d2
, d3
, d4
, d5
, d6
;
16302 /* If first window line is a continuation line, and window start
16303 is inside the modified region, but the first change is before
16304 current window start, we must select a new window start.
16306 However, if this is the result of a down-mouse event (e.g. by
16307 extending the mouse-drag-overlay), we don't want to select a
16308 new window start, since that would change the position under
16309 the mouse, resulting in an unwanted mouse-movement rather
16310 than a simple mouse-click. */
16311 if (!w
->start_at_line_beg
16312 && NILP (do_mouse_tracking
)
16313 && CHARPOS (startp
) > BEGV
16314 && CHARPOS (startp
) > BEG
+ beg_unchanged
16315 && CHARPOS (startp
) <= Z
- end_unchanged
16316 /* Even if w->start_at_line_beg is nil, a new window may
16317 start at a line_beg, since that's how set_buffer_window
16318 sets it. So, we need to check the return value of
16319 compute_window_start_on_continuation_line. (See also
16321 && XMARKER (w
->start
)->buffer
== current_buffer
16322 && compute_window_start_on_continuation_line (w
)
16323 /* It doesn't make sense to force the window start like we
16324 do at label force_start if it is already known that point
16325 will not be visible in the resulting window, because
16326 doing so will move point from its correct position
16327 instead of scrolling the window to bring point into view.
16329 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
16331 w
->force_start
= 1;
16332 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16337 debug_method_add (w
, "same window start");
16340 /* Try to redisplay starting at same place as before.
16341 If point has not moved off frame, accept the results. */
16342 if (!current_matrix_up_to_date_p
16343 /* Don't use try_window_reusing_current_matrix in this case
16344 because a window scroll function can have changed the
16346 || !NILP (Vwindow_scroll_functions
)
16347 || MINI_WINDOW_P (w
)
16348 || !(used_current_matrix_p
16349 = try_window_reusing_current_matrix (w
)))
16351 IF_DEBUG (debug_method_add (w
, "1"));
16352 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16353 /* -1 means we need to scroll.
16354 0 means we need new matrices, but fonts_changed
16355 is set in that case, so we will detect it below. */
16356 goto try_to_scroll
;
16359 if (f
->fonts_changed
)
16360 goto need_larger_matrices
;
16362 if (w
->cursor
.vpos
>= 0)
16364 if (!just_this_one_p
16365 || current_buffer
->clip_changed
16366 || BEG_UNCHANGED
< CHARPOS (startp
))
16367 /* Forget any recorded base line for line number display. */
16368 w
->base_line_number
= 0;
16370 if (!cursor_row_fully_visible_p (w
, 1, 0))
16372 clear_glyph_matrix (w
->desired_matrix
);
16373 last_line_misfit
= 1;
16375 /* Drop through and scroll. */
16380 clear_glyph_matrix (w
->desired_matrix
);
16385 /* Redisplay the mode line. Select the buffer properly for that. */
16386 if (!update_mode_line
)
16388 update_mode_line
= 1;
16389 w
->update_mode_line
= 1;
16392 /* Try to scroll by specified few lines. */
16393 if ((scroll_conservatively
16394 || emacs_scroll_step
16395 || temp_scroll_step
16396 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16397 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16398 && CHARPOS (startp
) >= BEGV
16399 && CHARPOS (startp
) <= ZV
)
16401 /* The function returns -1 if new fonts were loaded, 1 if
16402 successful, 0 if not successful. */
16403 int ss
= try_scrolling (window
, just_this_one_p
,
16404 scroll_conservatively
,
16406 temp_scroll_step
, last_line_misfit
);
16409 case SCROLLING_SUCCESS
:
16412 case SCROLLING_NEED_LARGER_MATRICES
:
16413 goto need_larger_matrices
;
16415 case SCROLLING_FAILED
:
16423 /* Finally, just choose a place to start which positions point
16424 according to user preferences. */
16429 debug_method_add (w
, "recenter");
16432 /* Forget any previously recorded base line for line number display. */
16433 if (!buffer_unchanged_p
)
16434 w
->base_line_number
= 0;
16436 /* Determine the window start relative to point. */
16437 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16438 it
.current_y
= it
.last_visible_y
;
16439 if (centering_position
< 0)
16441 int window_total_lines
16442 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16445 ? min (scroll_margin
, window_total_lines
/ 4)
16447 ptrdiff_t margin_pos
= CHARPOS (startp
);
16448 Lisp_Object aggressive
;
16451 /* If there is a scroll margin at the top of the window, find
16452 its character position. */
16454 /* Cannot call start_display if startp is not in the
16455 accessible region of the buffer. This can happen when we
16456 have just switched to a different buffer and/or changed
16457 its restriction. In that case, startp is initialized to
16458 the character position 1 (BEGV) because we did not yet
16459 have chance to display the buffer even once. */
16460 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16463 void *it1data
= NULL
;
16465 SAVE_IT (it1
, it
, it1data
);
16466 start_display (&it1
, w
, startp
);
16467 move_it_vertically (&it1
, margin
* frame_line_height
);
16468 margin_pos
= IT_CHARPOS (it1
);
16469 RESTORE_IT (&it
, &it
, it1data
);
16471 scrolling_up
= PT
> margin_pos
;
16474 ? BVAR (current_buffer
, scroll_up_aggressively
)
16475 : BVAR (current_buffer
, scroll_down_aggressively
);
16477 if (!MINI_WINDOW_P (w
)
16478 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16482 /* Setting scroll-conservatively overrides
16483 scroll-*-aggressively. */
16484 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16486 double float_amount
= XFLOATINT (aggressive
);
16488 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16489 if (pt_offset
== 0 && float_amount
> 0)
16491 if (pt_offset
&& margin
> 0)
16494 /* Compute how much to move the window start backward from
16495 point so that point will be displayed where the user
16499 centering_position
= it
.last_visible_y
;
16501 centering_position
-= pt_offset
;
16502 centering_position
-=
16503 frame_line_height
* (1 + margin
+ (last_line_misfit
!= 0))
16504 + WINDOW_HEADER_LINE_HEIGHT (w
);
16505 /* Don't let point enter the scroll margin near top of
16507 if (centering_position
< margin
* frame_line_height
)
16508 centering_position
= margin
* frame_line_height
;
16511 centering_position
= margin
* frame_line_height
+ pt_offset
;
16514 /* Set the window start half the height of the window backward
16516 centering_position
= window_box_height (w
) / 2;
16518 move_it_vertically_backward (&it
, centering_position
);
16520 eassert (IT_CHARPOS (it
) >= BEGV
);
16522 /* The function move_it_vertically_backward may move over more
16523 than the specified y-distance. If it->w is small, e.g. a
16524 mini-buffer window, we may end up in front of the window's
16525 display area. Start displaying at the start of the line
16526 containing PT in this case. */
16527 if (it
.current_y
<= 0)
16529 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16530 move_it_vertically_backward (&it
, 0);
16534 it
.current_x
= it
.hpos
= 0;
16536 /* Set the window start position here explicitly, to avoid an
16537 infinite loop in case the functions in window-scroll-functions
16539 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16541 /* Run scroll hooks. */
16542 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16544 /* Redisplay the window. */
16545 if (!current_matrix_up_to_date_p
16546 || windows_or_buffers_changed
16547 || f
->cursor_type_changed
16548 /* Don't use try_window_reusing_current_matrix in this case
16549 because it can have changed the buffer. */
16550 || !NILP (Vwindow_scroll_functions
)
16551 || !just_this_one_p
16552 || MINI_WINDOW_P (w
)
16553 || !(used_current_matrix_p
16554 = try_window_reusing_current_matrix (w
)))
16555 try_window (window
, startp
, 0);
16557 /* If new fonts have been loaded (due to fontsets), give up. We
16558 have to start a new redisplay since we need to re-adjust glyph
16560 if (f
->fonts_changed
)
16561 goto need_larger_matrices
;
16563 /* If cursor did not appear assume that the middle of the window is
16564 in the first line of the window. Do it again with the next line.
16565 (Imagine a window of height 100, displaying two lines of height
16566 60. Moving back 50 from it->last_visible_y will end in the first
16568 if (w
->cursor
.vpos
< 0)
16570 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16572 clear_glyph_matrix (w
->desired_matrix
);
16573 move_it_by_lines (&it
, 1);
16574 try_window (window
, it
.current
.pos
, 0);
16576 else if (PT
< IT_CHARPOS (it
))
16578 clear_glyph_matrix (w
->desired_matrix
);
16579 move_it_by_lines (&it
, -1);
16580 try_window (window
, it
.current
.pos
, 0);
16584 /* Not much we can do about it. */
16588 /* Consider the following case: Window starts at BEGV, there is
16589 invisible, intangible text at BEGV, so that display starts at
16590 some point START > BEGV. It can happen that we are called with
16591 PT somewhere between BEGV and START. Try to handle that case,
16592 and similar ones. */
16593 if (w
->cursor
.vpos
< 0)
16595 /* First, try locating the proper glyph row for PT. */
16596 struct glyph_row
*row
=
16597 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16599 /* Sometimes point is at the beginning of invisible text that is
16600 before the 1st character displayed in the row. In that case,
16601 row_containing_pos fails to find the row, because no glyphs
16602 with appropriate buffer positions are present in the row.
16603 Therefore, we next try to find the row which shows the 1st
16604 position after the invisible text. */
16608 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16611 if (TEXT_PROP_MEANS_INVISIBLE (val
))
16614 Lisp_Object invis_end
=
16615 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16618 if (NATNUMP (invis_end
))
16619 alt_pos
= XFASTINT (invis_end
);
16622 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16626 /* Finally, fall back on the first row of the window after the
16627 header line (if any). This is slightly better than not
16628 displaying the cursor at all. */
16631 row
= w
->current_matrix
->rows
;
16632 if (row
->mode_line_p
)
16635 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16638 if (!cursor_row_fully_visible_p (w
, 0, 0))
16640 /* If vscroll is enabled, disable it and try again. */
16644 clear_glyph_matrix (w
->desired_matrix
);
16648 /* Users who set scroll-conservatively to a large number want
16649 point just above/below the scroll margin. If we ended up
16650 with point's row partially visible, move the window start to
16651 make that row fully visible and out of the margin. */
16652 if (scroll_conservatively
> SCROLL_LIMIT
)
16654 int window_total_lines
16655 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16658 ? min (scroll_margin
, window_total_lines
/ 4)
16660 int move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16662 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16663 clear_glyph_matrix (w
->desired_matrix
);
16664 if (1 == try_window (window
, it
.current
.pos
,
16665 TRY_WINDOW_CHECK_MARGINS
))
16669 /* If centering point failed to make the whole line visible,
16670 put point at the top instead. That has to make the whole line
16671 visible, if it can be done. */
16672 if (centering_position
== 0)
16675 clear_glyph_matrix (w
->desired_matrix
);
16676 centering_position
= 0;
16682 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16683 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16684 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16686 /* Display the mode line, if we must. */
16687 if ((update_mode_line
16688 /* If window not full width, must redo its mode line
16689 if (a) the window to its side is being redone and
16690 (b) we do a frame-based redisplay. This is a consequence
16691 of how inverted lines are drawn in frame-based redisplay. */
16692 || (!just_this_one_p
16693 && !FRAME_WINDOW_P (f
)
16694 && !WINDOW_FULL_WIDTH_P (w
))
16695 /* Line number to display. */
16696 || w
->base_line_pos
> 0
16697 /* Column number is displayed and different from the one displayed. */
16698 || (w
->column_number_displayed
!= -1
16699 && (w
->column_number_displayed
!= current_column ())))
16700 /* This means that the window has a mode line. */
16701 && (WINDOW_WANTS_MODELINE_P (w
)
16702 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16705 display_mode_lines (w
);
16707 /* If mode line height has changed, arrange for a thorough
16708 immediate redisplay using the correct mode line height. */
16709 if (WINDOW_WANTS_MODELINE_P (w
)
16710 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16712 f
->fonts_changed
= 1;
16713 w
->mode_line_height
= -1;
16714 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16715 = DESIRED_MODE_LINE_HEIGHT (w
);
16718 /* If header line height has changed, arrange for a thorough
16719 immediate redisplay using the correct header line height. */
16720 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16721 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16723 f
->fonts_changed
= 1;
16724 w
->header_line_height
= -1;
16725 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16726 = DESIRED_HEADER_LINE_HEIGHT (w
);
16729 if (f
->fonts_changed
)
16730 goto need_larger_matrices
;
16733 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16735 w
->base_line_pos
= 0;
16736 w
->base_line_number
= 0;
16741 /* When we reach a frame's selected window, redo the frame's menu bar. */
16742 if (update_mode_line
16743 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16745 int redisplay_menu_p
= 0;
16747 if (FRAME_WINDOW_P (f
))
16749 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16750 || defined (HAVE_NS) || defined (USE_GTK)
16751 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16753 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16757 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16759 if (redisplay_menu_p
)
16760 display_menu_bar (w
);
16762 #ifdef HAVE_WINDOW_SYSTEM
16763 if (FRAME_WINDOW_P (f
))
16765 #if defined (USE_GTK) || defined (HAVE_NS)
16766 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16767 redisplay_tool_bar (f
);
16769 if (WINDOWP (f
->tool_bar_window
)
16770 && (FRAME_TOOL_BAR_HEIGHT (f
) > 0
16771 || !NILP (Vauto_resize_tool_bars
))
16772 && redisplay_tool_bar (f
))
16773 ignore_mouse_drag_p
= 1;
16779 #ifdef HAVE_WINDOW_SYSTEM
16780 if (FRAME_WINDOW_P (f
)
16781 && update_window_fringes (w
, (just_this_one_p
16782 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16783 || w
->pseudo_window_p
)))
16787 if (draw_window_fringes (w
, 1))
16789 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16790 x_draw_right_divider (w
);
16792 x_draw_vertical_border (w
);
16798 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16799 x_draw_bottom_divider (w
);
16800 #endif /* HAVE_WINDOW_SYSTEM */
16802 /* We go to this label, with fonts_changed set, if it is
16803 necessary to try again using larger glyph matrices.
16804 We have to redeem the scroll bar even in this case,
16805 because the loop in redisplay_internal expects that. */
16806 need_larger_matrices
:
16808 finish_scroll_bars
:
16810 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16812 /* Set the thumb's position and size. */
16813 set_vertical_scroll_bar (w
);
16815 /* Note that we actually used the scroll bar attached to this
16816 window, so it shouldn't be deleted at the end of redisplay. */
16817 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16818 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16821 /* Restore current_buffer and value of point in it. The window
16822 update may have changed the buffer, so first make sure `opoint'
16823 is still valid (Bug#6177). */
16824 if (CHARPOS (opoint
) < BEGV
)
16825 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16826 else if (CHARPOS (opoint
) > ZV
)
16827 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16829 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16831 set_buffer_internal_1 (old
);
16832 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16833 shorter. This can be caused by log truncation in *Messages*. */
16834 if (CHARPOS (lpoint
) <= ZV
)
16835 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16837 unbind_to (count
, Qnil
);
16841 /* Build the complete desired matrix of WINDOW with a window start
16842 buffer position POS.
16844 Value is 1 if successful. It is zero if fonts were loaded during
16845 redisplay which makes re-adjusting glyph matrices necessary, and -1
16846 if point would appear in the scroll margins.
16847 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16848 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16852 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16854 struct window
*w
= XWINDOW (window
);
16856 struct glyph_row
*last_text_row
= NULL
;
16857 struct frame
*f
= XFRAME (w
->frame
);
16858 int frame_line_height
= default_line_pixel_height (w
);
16860 /* Make POS the new window start. */
16861 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16863 /* Mark cursor position as unknown. No overlay arrow seen. */
16864 w
->cursor
.vpos
= -1;
16865 overlay_arrow_seen
= 0;
16867 /* Initialize iterator and info to start at POS. */
16868 start_display (&it
, w
, pos
);
16870 /* Display all lines of W. */
16871 while (it
.current_y
< it
.last_visible_y
)
16873 if (display_line (&it
))
16874 last_text_row
= it
.glyph_row
- 1;
16875 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16879 /* Don't let the cursor end in the scroll margins. */
16880 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16881 && !MINI_WINDOW_P (w
))
16883 int this_scroll_margin
;
16884 int window_total_lines
16885 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16887 if (scroll_margin
> 0)
16889 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16890 this_scroll_margin
*= frame_line_height
;
16893 this_scroll_margin
= 0;
16895 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16896 && w
->cursor
.y
< this_scroll_margin
16897 && CHARPOS (pos
) > BEGV
16898 && IT_CHARPOS (it
) < ZV
)
16899 /* rms: considering make_cursor_line_fully_visible_p here
16900 seems to give wrong results. We don't want to recenter
16901 when the last line is partly visible, we want to allow
16902 that case to be handled in the usual way. */
16903 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16905 w
->cursor
.vpos
= -1;
16906 clear_glyph_matrix (w
->desired_matrix
);
16911 /* If bottom moved off end of frame, change mode line percentage. */
16912 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
16913 w
->update_mode_line
= 1;
16915 /* Set window_end_pos to the offset of the last character displayed
16916 on the window from the end of current_buffer. Set
16917 window_end_vpos to its row number. */
16920 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16921 adjust_window_ends (w
, last_text_row
, 0);
16923 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
16924 w
->window_end_vpos
)));
16928 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16929 w
->window_end_pos
= Z
- ZV
;
16930 w
->window_end_vpos
= 0;
16933 /* But that is not valid info until redisplay finishes. */
16934 w
->window_end_valid
= 0;
16940 /************************************************************************
16941 Window redisplay reusing current matrix when buffer has not changed
16942 ************************************************************************/
16944 /* Try redisplay of window W showing an unchanged buffer with a
16945 different window start than the last time it was displayed by
16946 reusing its current matrix. Value is non-zero if successful.
16947 W->start is the new window start. */
16950 try_window_reusing_current_matrix (struct window
*w
)
16952 struct frame
*f
= XFRAME (w
->frame
);
16953 struct glyph_row
*bottom_row
;
16956 struct text_pos start
, new_start
;
16957 int nrows_scrolled
, i
;
16958 struct glyph_row
*last_text_row
;
16959 struct glyph_row
*last_reused_text_row
;
16960 struct glyph_row
*start_row
;
16961 int start_vpos
, min_y
, max_y
;
16964 if (inhibit_try_window_reusing
)
16968 if (/* This function doesn't handle terminal frames. */
16969 !FRAME_WINDOW_P (f
)
16970 /* Don't try to reuse the display if windows have been split
16972 || windows_or_buffers_changed
16973 || f
->cursor_type_changed
)
16976 /* Can't do this if showing trailing whitespace. */
16977 if (!NILP (Vshow_trailing_whitespace
))
16980 /* If top-line visibility has changed, give up. */
16981 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16982 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16985 /* Give up if old or new display is scrolled vertically. We could
16986 make this function handle this, but right now it doesn't. */
16987 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16988 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16991 /* The variable new_start now holds the new window start. The old
16992 start `start' can be determined from the current matrix. */
16993 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16994 start
= start_row
->minpos
;
16995 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16997 /* Clear the desired matrix for the display below. */
16998 clear_glyph_matrix (w
->desired_matrix
);
17000 if (CHARPOS (new_start
) <= CHARPOS (start
))
17002 /* Don't use this method if the display starts with an ellipsis
17003 displayed for invisible text. It's not easy to handle that case
17004 below, and it's certainly not worth the effort since this is
17005 not a frequent case. */
17006 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17009 IF_DEBUG (debug_method_add (w
, "twu1"));
17011 /* Display up to a row that can be reused. The variable
17012 last_text_row is set to the last row displayed that displays
17013 text. Note that it.vpos == 0 if or if not there is a
17014 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17015 start_display (&it
, w
, new_start
);
17016 w
->cursor
.vpos
= -1;
17017 last_text_row
= last_reused_text_row
= NULL
;
17019 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17021 /* If we have reached into the characters in the START row,
17022 that means the line boundaries have changed. So we
17023 can't start copying with the row START. Maybe it will
17024 work to start copying with the following row. */
17025 while (IT_CHARPOS (it
) > CHARPOS (start
))
17027 /* Advance to the next row as the "start". */
17029 start
= start_row
->minpos
;
17030 /* If there are no more rows to try, or just one, give up. */
17031 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17032 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17033 || CHARPOS (start
) == ZV
)
17035 clear_glyph_matrix (w
->desired_matrix
);
17039 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17041 /* If we have reached alignment, we can copy the rest of the
17043 if (IT_CHARPOS (it
) == CHARPOS (start
)
17044 /* Don't accept "alignment" inside a display vector,
17045 since start_row could have started in the middle of
17046 that same display vector (thus their character
17047 positions match), and we have no way of telling if
17048 that is the case. */
17049 && it
.current
.dpvec_index
< 0)
17052 if (display_line (&it
))
17053 last_text_row
= it
.glyph_row
- 1;
17057 /* A value of current_y < last_visible_y means that we stopped
17058 at the previous window start, which in turn means that we
17059 have at least one reusable row. */
17060 if (it
.current_y
< it
.last_visible_y
)
17062 struct glyph_row
*row
;
17064 /* IT.vpos always starts from 0; it counts text lines. */
17065 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17067 /* Find PT if not already found in the lines displayed. */
17068 if (w
->cursor
.vpos
< 0)
17070 int dy
= it
.current_y
- start_row
->y
;
17072 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17073 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17075 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17076 dy
, nrows_scrolled
);
17079 clear_glyph_matrix (w
->desired_matrix
);
17084 /* Scroll the display. Do it before the current matrix is
17085 changed. The problem here is that update has not yet
17086 run, i.e. part of the current matrix is not up to date.
17087 scroll_run_hook will clear the cursor, and use the
17088 current matrix to get the height of the row the cursor is
17090 run
.current_y
= start_row
->y
;
17091 run
.desired_y
= it
.current_y
;
17092 run
.height
= it
.last_visible_y
- it
.current_y
;
17094 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17097 FRAME_RIF (f
)->update_window_begin_hook (w
);
17098 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17099 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17100 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17104 /* Shift current matrix down by nrows_scrolled lines. */
17105 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17106 rotate_matrix (w
->current_matrix
,
17108 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17111 /* Disable lines that must be updated. */
17112 for (i
= 0; i
< nrows_scrolled
; ++i
)
17113 (start_row
+ i
)->enabled_p
= false;
17115 /* Re-compute Y positions. */
17116 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17117 max_y
= it
.last_visible_y
;
17118 for (row
= start_row
+ nrows_scrolled
;
17122 row
->y
= it
.current_y
;
17123 row
->visible_height
= row
->height
;
17125 if (row
->y
< min_y
)
17126 row
->visible_height
-= min_y
- row
->y
;
17127 if (row
->y
+ row
->height
> max_y
)
17128 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17129 if (row
->fringe_bitmap_periodic_p
)
17130 row
->redraw_fringe_bitmaps_p
= 1;
17132 it
.current_y
+= row
->height
;
17134 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17135 last_reused_text_row
= row
;
17136 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17140 /* Disable lines in the current matrix which are now
17141 below the window. */
17142 for (++row
; row
< bottom_row
; ++row
)
17143 row
->enabled_p
= row
->mode_line_p
= 0;
17146 /* Update window_end_pos etc.; last_reused_text_row is the last
17147 reused row from the current matrix containing text, if any.
17148 The value of last_text_row is the last displayed line
17149 containing text. */
17150 if (last_reused_text_row
)
17151 adjust_window_ends (w
, last_reused_text_row
, 1);
17152 else if (last_text_row
)
17153 adjust_window_ends (w
, last_text_row
, 0);
17156 /* This window must be completely empty. */
17157 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17158 w
->window_end_pos
= Z
- ZV
;
17159 w
->window_end_vpos
= 0;
17161 w
->window_end_valid
= 0;
17163 /* Update hint: don't try scrolling again in update_window. */
17164 w
->desired_matrix
->no_scrolling_p
= 1;
17167 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17171 else if (CHARPOS (new_start
) > CHARPOS (start
))
17173 struct glyph_row
*pt_row
, *row
;
17174 struct glyph_row
*first_reusable_row
;
17175 struct glyph_row
*first_row_to_display
;
17177 int yb
= window_text_bottom_y (w
);
17179 /* Find the row starting at new_start, if there is one. Don't
17180 reuse a partially visible line at the end. */
17181 first_reusable_row
= start_row
;
17182 while (first_reusable_row
->enabled_p
17183 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17184 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17185 < CHARPOS (new_start
)))
17186 ++first_reusable_row
;
17188 /* Give up if there is no row to reuse. */
17189 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17190 || !first_reusable_row
->enabled_p
17191 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17192 != CHARPOS (new_start
)))
17195 /* We can reuse fully visible rows beginning with
17196 first_reusable_row to the end of the window. Set
17197 first_row_to_display to the first row that cannot be reused.
17198 Set pt_row to the row containing point, if there is any. */
17200 for (first_row_to_display
= first_reusable_row
;
17201 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17202 ++first_row_to_display
)
17204 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17205 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17206 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17207 && first_row_to_display
->ends_at_zv_p
17208 && pt_row
== NULL
)))
17209 pt_row
= first_row_to_display
;
17212 /* Start displaying at the start of first_row_to_display. */
17213 eassert (first_row_to_display
->y
< yb
);
17214 init_to_row_start (&it
, w
, first_row_to_display
);
17216 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17218 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17220 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17221 + WINDOW_HEADER_LINE_HEIGHT (w
));
17223 /* Display lines beginning with first_row_to_display in the
17224 desired matrix. Set last_text_row to the last row displayed
17225 that displays text. */
17226 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17227 if (pt_row
== NULL
)
17228 w
->cursor
.vpos
= -1;
17229 last_text_row
= NULL
;
17230 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17231 if (display_line (&it
))
17232 last_text_row
= it
.glyph_row
- 1;
17234 /* If point is in a reused row, adjust y and vpos of the cursor
17238 w
->cursor
.vpos
-= nrows_scrolled
;
17239 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17242 /* Give up if point isn't in a row displayed or reused. (This
17243 also handles the case where w->cursor.vpos < nrows_scrolled
17244 after the calls to display_line, which can happen with scroll
17245 margins. See bug#1295.) */
17246 if (w
->cursor
.vpos
< 0)
17248 clear_glyph_matrix (w
->desired_matrix
);
17252 /* Scroll the display. */
17253 run
.current_y
= first_reusable_row
->y
;
17254 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17255 run
.height
= it
.last_visible_y
- run
.current_y
;
17256 dy
= run
.current_y
- run
.desired_y
;
17261 FRAME_RIF (f
)->update_window_begin_hook (w
);
17262 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17263 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17264 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17268 /* Adjust Y positions of reused rows. */
17269 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17270 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17271 max_y
= it
.last_visible_y
;
17272 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17275 row
->visible_height
= row
->height
;
17276 if (row
->y
< min_y
)
17277 row
->visible_height
-= min_y
- row
->y
;
17278 if (row
->y
+ row
->height
> max_y
)
17279 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17280 if (row
->fringe_bitmap_periodic_p
)
17281 row
->redraw_fringe_bitmaps_p
= 1;
17284 /* Scroll the current matrix. */
17285 eassert (nrows_scrolled
> 0);
17286 rotate_matrix (w
->current_matrix
,
17288 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17291 /* Disable rows not reused. */
17292 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17293 row
->enabled_p
= false;
17295 /* Point may have moved to a different line, so we cannot assume that
17296 the previous cursor position is valid; locate the correct row. */
17299 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17301 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17302 && !row
->ends_at_zv_p
;
17306 w
->cursor
.y
= row
->y
;
17308 if (row
< bottom_row
)
17310 /* Can't simply scan the row for point with
17311 bidi-reordered glyph rows. Let set_cursor_from_row
17312 figure out where to put the cursor, and if it fails,
17314 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17316 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17319 clear_glyph_matrix (w
->desired_matrix
);
17325 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17326 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17329 && (!BUFFERP (glyph
->object
)
17330 || glyph
->charpos
< PT
);
17334 w
->cursor
.x
+= glyph
->pixel_width
;
17340 /* Adjust window end. A null value of last_text_row means that
17341 the window end is in reused rows which in turn means that
17342 only its vpos can have changed. */
17344 adjust_window_ends (w
, last_text_row
, 0);
17346 w
->window_end_vpos
-= nrows_scrolled
;
17348 w
->window_end_valid
= 0;
17349 w
->desired_matrix
->no_scrolling_p
= 1;
17352 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17362 /************************************************************************
17363 Window redisplay reusing current matrix when buffer has changed
17364 ************************************************************************/
17366 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17367 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17368 ptrdiff_t *, ptrdiff_t *);
17369 static struct glyph_row
*
17370 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17371 struct glyph_row
*);
17374 /* Return the last row in MATRIX displaying text. If row START is
17375 non-null, start searching with that row. IT gives the dimensions
17376 of the display. Value is null if matrix is empty; otherwise it is
17377 a pointer to the row found. */
17379 static struct glyph_row
*
17380 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17381 struct glyph_row
*start
)
17383 struct glyph_row
*row
, *row_found
;
17385 /* Set row_found to the last row in IT->w's current matrix
17386 displaying text. The loop looks funny but think of partially
17389 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17390 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17392 eassert (row
->enabled_p
);
17394 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17403 /* Return the last row in the current matrix of W that is not affected
17404 by changes at the start of current_buffer that occurred since W's
17405 current matrix was built. Value is null if no such row exists.
17407 BEG_UNCHANGED us the number of characters unchanged at the start of
17408 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17409 first changed character in current_buffer. Characters at positions <
17410 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17411 when the current matrix was built. */
17413 static struct glyph_row
*
17414 find_last_unchanged_at_beg_row (struct window
*w
)
17416 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17417 struct glyph_row
*row
;
17418 struct glyph_row
*row_found
= NULL
;
17419 int yb
= window_text_bottom_y (w
);
17421 /* Find the last row displaying unchanged text. */
17422 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17423 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17424 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17427 if (/* If row ends before first_changed_pos, it is unchanged,
17428 except in some case. */
17429 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17430 /* When row ends in ZV and we write at ZV it is not
17432 && !row
->ends_at_zv_p
17433 /* When first_changed_pos is the end of a continued line,
17434 row is not unchanged because it may be no longer
17436 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17437 && (row
->continued_p
17438 || row
->exact_window_width_line_p
))
17439 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17440 needs to be recomputed, so don't consider this row as
17441 unchanged. This happens when the last line was
17442 bidi-reordered and was killed immediately before this
17443 redisplay cycle. In that case, ROW->end stores the
17444 buffer position of the first visual-order character of
17445 the killed text, which is now beyond ZV. */
17446 && CHARPOS (row
->end
.pos
) <= ZV
)
17449 /* Stop if last visible row. */
17450 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17458 /* Find the first glyph row in the current matrix of W that is not
17459 affected by changes at the end of current_buffer since the
17460 time W's current matrix was built.
17462 Return in *DELTA the number of chars by which buffer positions in
17463 unchanged text at the end of current_buffer must be adjusted.
17465 Return in *DELTA_BYTES the corresponding number of bytes.
17467 Value is null if no such row exists, i.e. all rows are affected by
17470 static struct glyph_row
*
17471 find_first_unchanged_at_end_row (struct window
*w
,
17472 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17474 struct glyph_row
*row
;
17475 struct glyph_row
*row_found
= NULL
;
17477 *delta
= *delta_bytes
= 0;
17479 /* Display must not have been paused, otherwise the current matrix
17480 is not up to date. */
17481 eassert (w
->window_end_valid
);
17483 /* A value of window_end_pos >= END_UNCHANGED means that the window
17484 end is in the range of changed text. If so, there is no
17485 unchanged row at the end of W's current matrix. */
17486 if (w
->window_end_pos
>= END_UNCHANGED
)
17489 /* Set row to the last row in W's current matrix displaying text. */
17490 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17492 /* If matrix is entirely empty, no unchanged row exists. */
17493 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17495 /* The value of row is the last glyph row in the matrix having a
17496 meaningful buffer position in it. The end position of row
17497 corresponds to window_end_pos. This allows us to translate
17498 buffer positions in the current matrix to current buffer
17499 positions for characters not in changed text. */
17501 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17502 ptrdiff_t Z_BYTE_old
=
17503 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17504 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17505 struct glyph_row
*first_text_row
17506 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17508 *delta
= Z
- Z_old
;
17509 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17511 /* Set last_unchanged_pos to the buffer position of the last
17512 character in the buffer that has not been changed. Z is the
17513 index + 1 of the last character in current_buffer, i.e. by
17514 subtracting END_UNCHANGED we get the index of the last
17515 unchanged character, and we have to add BEG to get its buffer
17517 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17518 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17520 /* Search backward from ROW for a row displaying a line that
17521 starts at a minimum position >= last_unchanged_pos_old. */
17522 for (; row
> first_text_row
; --row
)
17524 /* This used to abort, but it can happen.
17525 It is ok to just stop the search instead here. KFS. */
17526 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17529 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17534 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17540 /* Make sure that glyph rows in the current matrix of window W
17541 reference the same glyph memory as corresponding rows in the
17542 frame's frame matrix. This function is called after scrolling W's
17543 current matrix on a terminal frame in try_window_id and
17544 try_window_reusing_current_matrix. */
17547 sync_frame_with_window_matrix_rows (struct window
*w
)
17549 struct frame
*f
= XFRAME (w
->frame
);
17550 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17552 /* Preconditions: W must be a leaf window and full-width. Its frame
17553 must have a frame matrix. */
17554 eassert (BUFFERP (w
->contents
));
17555 eassert (WINDOW_FULL_WIDTH_P (w
));
17556 eassert (!FRAME_WINDOW_P (f
));
17558 /* If W is a full-width window, glyph pointers in W's current matrix
17559 have, by definition, to be the same as glyph pointers in the
17560 corresponding frame matrix. Note that frame matrices have no
17561 marginal areas (see build_frame_matrix). */
17562 window_row
= w
->current_matrix
->rows
;
17563 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17564 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17565 while (window_row
< window_row_end
)
17567 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17568 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17570 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17571 frame_row
->glyphs
[TEXT_AREA
] = start
;
17572 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17573 frame_row
->glyphs
[LAST_AREA
] = end
;
17575 /* Disable frame rows whose corresponding window rows have
17576 been disabled in try_window_id. */
17577 if (!window_row
->enabled_p
)
17578 frame_row
->enabled_p
= false;
17580 ++window_row
, ++frame_row
;
17585 /* Find the glyph row in window W containing CHARPOS. Consider all
17586 rows between START and END (not inclusive). END null means search
17587 all rows to the end of the display area of W. Value is the row
17588 containing CHARPOS or null. */
17591 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17592 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17594 struct glyph_row
*row
= start
;
17595 struct glyph_row
*best_row
= NULL
;
17596 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17599 /* If we happen to start on a header-line, skip that. */
17600 if (row
->mode_line_p
)
17603 if ((end
&& row
>= end
) || !row
->enabled_p
)
17606 last_y
= window_text_bottom_y (w
) - dy
;
17610 /* Give up if we have gone too far. */
17611 if (end
&& row
>= end
)
17613 /* This formerly returned if they were equal.
17614 I think that both quantities are of a "last plus one" type;
17615 if so, when they are equal, the row is within the screen. -- rms. */
17616 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17619 /* If it is in this row, return this row. */
17620 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17621 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17622 /* The end position of a row equals the start
17623 position of the next row. If CHARPOS is there, we
17624 would rather consider it displayed in the next
17625 line, except when this line ends in ZV. */
17626 && !row_for_charpos_p (row
, charpos
)))
17627 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17631 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17632 || (!best_row
&& !row
->continued_p
))
17634 /* In bidi-reordered rows, there could be several rows whose
17635 edges surround CHARPOS, all of these rows belonging to
17636 the same continued line. We need to find the row which
17637 fits CHARPOS the best. */
17638 for (g
= row
->glyphs
[TEXT_AREA
];
17639 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17642 if (!STRINGP (g
->object
))
17644 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17646 mindif
= eabs (g
->charpos
- charpos
);
17648 /* Exact match always wins. */
17655 else if (best_row
&& !row
->continued_p
)
17662 /* Try to redisplay window W by reusing its existing display. W's
17663 current matrix must be up to date when this function is called,
17664 i.e. window_end_valid must be nonzero.
17668 >= 1 if successful, i.e. display has been updated
17670 1 means the changes were in front of a newline that precedes
17671 the window start, and the whole current matrix was reused
17672 2 means the changes were after the last position displayed
17673 in the window, and the whole current matrix was reused
17674 3 means portions of the current matrix were reused, while
17675 some of the screen lines were redrawn
17676 -1 if redisplay with same window start is known not to succeed
17677 0 if otherwise unsuccessful
17679 The following steps are performed:
17681 1. Find the last row in the current matrix of W that is not
17682 affected by changes at the start of current_buffer. If no such row
17685 2. Find the first row in W's current matrix that is not affected by
17686 changes at the end of current_buffer. Maybe there is no such row.
17688 3. Display lines beginning with the row + 1 found in step 1 to the
17689 row found in step 2 or, if step 2 didn't find a row, to the end of
17692 4. If cursor is not known to appear on the window, give up.
17694 5. If display stopped at the row found in step 2, scroll the
17695 display and current matrix as needed.
17697 6. Maybe display some lines at the end of W, if we must. This can
17698 happen under various circumstances, like a partially visible line
17699 becoming fully visible, or because newly displayed lines are displayed
17700 in smaller font sizes.
17702 7. Update W's window end information. */
17705 try_window_id (struct window
*w
)
17707 struct frame
*f
= XFRAME (w
->frame
);
17708 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17709 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17710 struct glyph_row
*last_unchanged_at_beg_row
;
17711 struct glyph_row
*first_unchanged_at_end_row
;
17712 struct glyph_row
*row
;
17713 struct glyph_row
*bottom_row
;
17716 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17718 struct text_pos start_pos
;
17720 int first_unchanged_at_end_vpos
= 0;
17721 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17722 struct text_pos start
;
17723 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17726 if (inhibit_try_window_id
)
17730 /* This is handy for debugging. */
17732 #define GIVE_UP(X) \
17734 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17738 #define GIVE_UP(X) return 0
17741 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17743 /* Don't use this for mini-windows because these can show
17744 messages and mini-buffers, and we don't handle that here. */
17745 if (MINI_WINDOW_P (w
))
17748 /* This flag is used to prevent redisplay optimizations. */
17749 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17752 /* This function's optimizations cannot be used if overlays have
17753 changed in the buffer displayed by the window, so give up if they
17755 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17758 /* Verify that narrowing has not changed.
17759 Also verify that we were not told to prevent redisplay optimizations.
17760 It would be nice to further
17761 reduce the number of cases where this prevents try_window_id. */
17762 if (current_buffer
->clip_changed
17763 || current_buffer
->prevent_redisplay_optimizations_p
)
17766 /* Window must either use window-based redisplay or be full width. */
17767 if (!FRAME_WINDOW_P (f
)
17768 && (!FRAME_LINE_INS_DEL_OK (f
)
17769 || !WINDOW_FULL_WIDTH_P (w
)))
17772 /* Give up if point is known NOT to appear in W. */
17773 if (PT
< CHARPOS (start
))
17776 /* Another way to prevent redisplay optimizations. */
17777 if (w
->last_modified
== 0)
17780 /* Verify that window is not hscrolled. */
17781 if (w
->hscroll
!= 0)
17784 /* Verify that display wasn't paused. */
17785 if (!w
->window_end_valid
)
17788 /* Likewise if highlighting trailing whitespace. */
17789 if (!NILP (Vshow_trailing_whitespace
))
17792 /* Can't use this if overlay arrow position and/or string have
17794 if (overlay_arrows_changed_p ())
17797 /* When word-wrap is on, adding a space to the first word of a
17798 wrapped line can change the wrap position, altering the line
17799 above it. It might be worthwhile to handle this more
17800 intelligently, but for now just redisplay from scratch. */
17801 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17804 /* Under bidi reordering, adding or deleting a character in the
17805 beginning of a paragraph, before the first strong directional
17806 character, can change the base direction of the paragraph (unless
17807 the buffer specifies a fixed paragraph direction), which will
17808 require to redisplay the whole paragraph. It might be worthwhile
17809 to find the paragraph limits and widen the range of redisplayed
17810 lines to that, but for now just give up this optimization and
17811 redisplay from scratch. */
17812 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17813 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17816 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17817 only if buffer has really changed. The reason is that the gap is
17818 initially at Z for freshly visited files. The code below would
17819 set end_unchanged to 0 in that case. */
17820 if (MODIFF
> SAVE_MODIFF
17821 /* This seems to happen sometimes after saving a buffer. */
17822 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17824 if (GPT
- BEG
< BEG_UNCHANGED
)
17825 BEG_UNCHANGED
= GPT
- BEG
;
17826 if (Z
- GPT
< END_UNCHANGED
)
17827 END_UNCHANGED
= Z
- GPT
;
17830 /* The position of the first and last character that has been changed. */
17831 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17832 last_changed_charpos
= Z
- END_UNCHANGED
;
17834 /* If window starts after a line end, and the last change is in
17835 front of that newline, then changes don't affect the display.
17836 This case happens with stealth-fontification. Note that although
17837 the display is unchanged, glyph positions in the matrix have to
17838 be adjusted, of course. */
17839 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17840 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17841 && ((last_changed_charpos
< CHARPOS (start
)
17842 && CHARPOS (start
) == BEGV
)
17843 || (last_changed_charpos
< CHARPOS (start
) - 1
17844 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17846 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17847 struct glyph_row
*r0
;
17849 /* Compute how many chars/bytes have been added to or removed
17850 from the buffer. */
17851 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17852 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17853 Z_delta
= Z
- Z_old
;
17854 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17856 /* Give up if PT is not in the window. Note that it already has
17857 been checked at the start of try_window_id that PT is not in
17858 front of the window start. */
17859 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17862 /* If window start is unchanged, we can reuse the whole matrix
17863 as is, after adjusting glyph positions. No need to compute
17864 the window end again, since its offset from Z hasn't changed. */
17865 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17866 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17867 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17868 /* PT must not be in a partially visible line. */
17869 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17870 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17872 /* Adjust positions in the glyph matrix. */
17873 if (Z_delta
|| Z_delta_bytes
)
17875 struct glyph_row
*r1
17876 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17877 increment_matrix_positions (w
->current_matrix
,
17878 MATRIX_ROW_VPOS (r0
, current_matrix
),
17879 MATRIX_ROW_VPOS (r1
, current_matrix
),
17880 Z_delta
, Z_delta_bytes
);
17883 /* Set the cursor. */
17884 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17886 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17891 /* Handle the case that changes are all below what is displayed in
17892 the window, and that PT is in the window. This shortcut cannot
17893 be taken if ZV is visible in the window, and text has been added
17894 there that is visible in the window. */
17895 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17896 /* ZV is not visible in the window, or there are no
17897 changes at ZV, actually. */
17898 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17899 || first_changed_charpos
== last_changed_charpos
))
17901 struct glyph_row
*r0
;
17903 /* Give up if PT is not in the window. Note that it already has
17904 been checked at the start of try_window_id that PT is not in
17905 front of the window start. */
17906 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17909 /* If window start is unchanged, we can reuse the whole matrix
17910 as is, without changing glyph positions since no text has
17911 been added/removed in front of the window end. */
17912 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17913 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17914 /* PT must not be in a partially visible line. */
17915 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17916 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17918 /* We have to compute the window end anew since text
17919 could have been added/removed after it. */
17920 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
17921 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17923 /* Set the cursor. */
17924 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17926 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17931 /* Give up if window start is in the changed area.
17933 The condition used to read
17935 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17937 but why that was tested escapes me at the moment. */
17938 if (CHARPOS (start
) >= first_changed_charpos
17939 && CHARPOS (start
) <= last_changed_charpos
)
17942 /* Check that window start agrees with the start of the first glyph
17943 row in its current matrix. Check this after we know the window
17944 start is not in changed text, otherwise positions would not be
17946 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17947 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17950 /* Give up if the window ends in strings. Overlay strings
17951 at the end are difficult to handle, so don't try. */
17952 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
17953 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17956 /* Compute the position at which we have to start displaying new
17957 lines. Some of the lines at the top of the window might be
17958 reusable because they are not displaying changed text. Find the
17959 last row in W's current matrix not affected by changes at the
17960 start of current_buffer. Value is null if changes start in the
17961 first line of window. */
17962 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17963 if (last_unchanged_at_beg_row
)
17965 /* Avoid starting to display in the middle of a character, a TAB
17966 for instance. This is easier than to set up the iterator
17967 exactly, and it's not a frequent case, so the additional
17968 effort wouldn't really pay off. */
17969 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17970 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17971 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17972 --last_unchanged_at_beg_row
;
17974 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17977 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17979 start_pos
= it
.current
.pos
;
17981 /* Start displaying new lines in the desired matrix at the same
17982 vpos we would use in the current matrix, i.e. below
17983 last_unchanged_at_beg_row. */
17984 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17986 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17987 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17989 eassert (it
.hpos
== 0 && it
.current_x
== 0);
17993 /* There are no reusable lines at the start of the window.
17994 Start displaying in the first text line. */
17995 start_display (&it
, w
, start
);
17996 it
.vpos
= it
.first_vpos
;
17997 start_pos
= it
.current
.pos
;
18000 /* Find the first row that is not affected by changes at the end of
18001 the buffer. Value will be null if there is no unchanged row, in
18002 which case we must redisplay to the end of the window. delta
18003 will be set to the value by which buffer positions beginning with
18004 first_unchanged_at_end_row have to be adjusted due to text
18006 first_unchanged_at_end_row
18007 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18008 IF_DEBUG (debug_delta
= delta
);
18009 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18011 /* Set stop_pos to the buffer position up to which we will have to
18012 display new lines. If first_unchanged_at_end_row != NULL, this
18013 is the buffer position of the start of the line displayed in that
18014 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18015 that we don't stop at a buffer position. */
18017 if (first_unchanged_at_end_row
)
18019 eassert (last_unchanged_at_beg_row
== NULL
18020 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18022 /* If this is a continuation line, move forward to the next one
18023 that isn't. Changes in lines above affect this line.
18024 Caution: this may move first_unchanged_at_end_row to a row
18025 not displaying text. */
18026 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18027 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18028 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18029 < it
.last_visible_y
))
18030 ++first_unchanged_at_end_row
;
18032 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18033 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18034 >= it
.last_visible_y
))
18035 first_unchanged_at_end_row
= NULL
;
18038 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18040 first_unchanged_at_end_vpos
18041 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18042 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18045 else if (last_unchanged_at_beg_row
== NULL
)
18051 /* Either there is no unchanged row at the end, or the one we have
18052 now displays text. This is a necessary condition for the window
18053 end pos calculation at the end of this function. */
18054 eassert (first_unchanged_at_end_row
== NULL
18055 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18057 debug_last_unchanged_at_beg_vpos
18058 = (last_unchanged_at_beg_row
18059 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18061 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18063 #endif /* GLYPH_DEBUG */
18066 /* Display new lines. Set last_text_row to the last new line
18067 displayed which has text on it, i.e. might end up as being the
18068 line where the window_end_vpos is. */
18069 w
->cursor
.vpos
= -1;
18070 last_text_row
= NULL
;
18071 overlay_arrow_seen
= 0;
18072 while (it
.current_y
< it
.last_visible_y
18073 && !f
->fonts_changed
18074 && (first_unchanged_at_end_row
== NULL
18075 || IT_CHARPOS (it
) < stop_pos
))
18077 if (display_line (&it
))
18078 last_text_row
= it
.glyph_row
- 1;
18081 if (f
->fonts_changed
)
18085 /* Compute differences in buffer positions, y-positions etc. for
18086 lines reused at the bottom of the window. Compute what we can
18088 if (first_unchanged_at_end_row
18089 /* No lines reused because we displayed everything up to the
18090 bottom of the window. */
18091 && it
.current_y
< it
.last_visible_y
)
18094 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18096 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18097 run
.current_y
= first_unchanged_at_end_row
->y
;
18098 run
.desired_y
= run
.current_y
+ dy
;
18099 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18103 delta
= delta_bytes
= dvpos
= dy
18104 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18105 first_unchanged_at_end_row
= NULL
;
18107 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18110 /* Find the cursor if not already found. We have to decide whether
18111 PT will appear on this window (it sometimes doesn't, but this is
18112 not a very frequent case.) This decision has to be made before
18113 the current matrix is altered. A value of cursor.vpos < 0 means
18114 that PT is either in one of the lines beginning at
18115 first_unchanged_at_end_row or below the window. Don't care for
18116 lines that might be displayed later at the window end; as
18117 mentioned, this is not a frequent case. */
18118 if (w
->cursor
.vpos
< 0)
18120 /* Cursor in unchanged rows at the top? */
18121 if (PT
< CHARPOS (start_pos
)
18122 && last_unchanged_at_beg_row
)
18124 row
= row_containing_pos (w
, PT
,
18125 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18126 last_unchanged_at_beg_row
+ 1, 0);
18128 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18131 /* Start from first_unchanged_at_end_row looking for PT. */
18132 else if (first_unchanged_at_end_row
)
18134 row
= row_containing_pos (w
, PT
- delta
,
18135 first_unchanged_at_end_row
, NULL
, 0);
18137 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18138 delta_bytes
, dy
, dvpos
);
18141 /* Give up if cursor was not found. */
18142 if (w
->cursor
.vpos
< 0)
18144 clear_glyph_matrix (w
->desired_matrix
);
18149 /* Don't let the cursor end in the scroll margins. */
18151 int this_scroll_margin
, cursor_height
;
18152 int frame_line_height
= default_line_pixel_height (w
);
18153 int window_total_lines
18154 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18156 this_scroll_margin
=
18157 max (0, min (scroll_margin
, window_total_lines
/ 4));
18158 this_scroll_margin
*= frame_line_height
;
18159 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18161 if ((w
->cursor
.y
< this_scroll_margin
18162 && CHARPOS (start
) > BEGV
)
18163 /* Old redisplay didn't take scroll margin into account at the bottom,
18164 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18165 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18166 ? cursor_height
+ this_scroll_margin
18167 : 1)) > it
.last_visible_y
)
18169 w
->cursor
.vpos
= -1;
18170 clear_glyph_matrix (w
->desired_matrix
);
18175 /* Scroll the display. Do it before changing the current matrix so
18176 that xterm.c doesn't get confused about where the cursor glyph is
18178 if (dy
&& run
.height
)
18182 if (FRAME_WINDOW_P (f
))
18184 FRAME_RIF (f
)->update_window_begin_hook (w
);
18185 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18186 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18187 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
18191 /* Terminal frame. In this case, dvpos gives the number of
18192 lines to scroll by; dvpos < 0 means scroll up. */
18194 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18195 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18196 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18197 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
18198 + window_internal_height (w
));
18200 #if defined (HAVE_GPM) || defined (MSDOS)
18201 x_clear_window_mouse_face (w
);
18203 /* Perform the operation on the screen. */
18206 /* Scroll last_unchanged_at_beg_row to the end of the
18207 window down dvpos lines. */
18208 set_terminal_window (f
, end
);
18210 /* On dumb terminals delete dvpos lines at the end
18211 before inserting dvpos empty lines. */
18212 if (!FRAME_SCROLL_REGION_OK (f
))
18213 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18215 /* Insert dvpos empty lines in front of
18216 last_unchanged_at_beg_row. */
18217 ins_del_lines (f
, from
, dvpos
);
18219 else if (dvpos
< 0)
18221 /* Scroll up last_unchanged_at_beg_vpos to the end of
18222 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18223 set_terminal_window (f
, end
);
18225 /* Delete dvpos lines in front of
18226 last_unchanged_at_beg_vpos. ins_del_lines will set
18227 the cursor to the given vpos and emit |dvpos| delete
18229 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18231 /* On a dumb terminal insert dvpos empty lines at the
18233 if (!FRAME_SCROLL_REGION_OK (f
))
18234 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18237 set_terminal_window (f
, 0);
18243 /* Shift reused rows of the current matrix to the right position.
18244 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18246 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18247 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18250 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18251 bottom_vpos
, dvpos
);
18252 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18255 else if (dvpos
> 0)
18257 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18258 bottom_vpos
, dvpos
);
18259 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18260 first_unchanged_at_end_vpos
+ dvpos
);
18263 /* For frame-based redisplay, make sure that current frame and window
18264 matrix are in sync with respect to glyph memory. */
18265 if (!FRAME_WINDOW_P (f
))
18266 sync_frame_with_window_matrix_rows (w
);
18268 /* Adjust buffer positions in reused rows. */
18269 if (delta
|| delta_bytes
)
18270 increment_matrix_positions (current_matrix
,
18271 first_unchanged_at_end_vpos
+ dvpos
,
18272 bottom_vpos
, delta
, delta_bytes
);
18274 /* Adjust Y positions. */
18276 shift_glyph_matrix (w
, current_matrix
,
18277 first_unchanged_at_end_vpos
+ dvpos
,
18280 if (first_unchanged_at_end_row
)
18282 first_unchanged_at_end_row
+= dvpos
;
18283 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18284 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18285 first_unchanged_at_end_row
= NULL
;
18288 /* If scrolling up, there may be some lines to display at the end of
18290 last_text_row_at_end
= NULL
;
18293 /* Scrolling up can leave for example a partially visible line
18294 at the end of the window to be redisplayed. */
18295 /* Set last_row to the glyph row in the current matrix where the
18296 window end line is found. It has been moved up or down in
18297 the matrix by dvpos. */
18298 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18299 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18301 /* If last_row is the window end line, it should display text. */
18302 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18304 /* If window end line was partially visible before, begin
18305 displaying at that line. Otherwise begin displaying with the
18306 line following it. */
18307 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18309 init_to_row_start (&it
, w
, last_row
);
18310 it
.vpos
= last_vpos
;
18311 it
.current_y
= last_row
->y
;
18315 init_to_row_end (&it
, w
, last_row
);
18316 it
.vpos
= 1 + last_vpos
;
18317 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18321 /* We may start in a continuation line. If so, we have to
18322 get the right continuation_lines_width and current_x. */
18323 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18324 it
.hpos
= it
.current_x
= 0;
18326 /* Display the rest of the lines at the window end. */
18327 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18328 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18330 /* Is it always sure that the display agrees with lines in
18331 the current matrix? I don't think so, so we mark rows
18332 displayed invalid in the current matrix by setting their
18333 enabled_p flag to zero. */
18334 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18335 if (display_line (&it
))
18336 last_text_row_at_end
= it
.glyph_row
- 1;
18340 /* Update window_end_pos and window_end_vpos. */
18341 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18343 /* Window end line if one of the preserved rows from the current
18344 matrix. Set row to the last row displaying text in current
18345 matrix starting at first_unchanged_at_end_row, after
18347 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18348 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18349 first_unchanged_at_end_row
);
18350 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18351 adjust_window_ends (w
, row
, 1);
18352 eassert (w
->window_end_bytepos
>= 0);
18353 IF_DEBUG (debug_method_add (w
, "A"));
18355 else if (last_text_row_at_end
)
18357 adjust_window_ends (w
, last_text_row_at_end
, 0);
18358 eassert (w
->window_end_bytepos
>= 0);
18359 IF_DEBUG (debug_method_add (w
, "B"));
18361 else if (last_text_row
)
18363 /* We have displayed either to the end of the window or at the
18364 end of the window, i.e. the last row with text is to be found
18365 in the desired matrix. */
18366 adjust_window_ends (w
, last_text_row
, 0);
18367 eassert (w
->window_end_bytepos
>= 0);
18369 else if (first_unchanged_at_end_row
== NULL
18370 && last_text_row
== NULL
18371 && last_text_row_at_end
== NULL
)
18373 /* Displayed to end of window, but no line containing text was
18374 displayed. Lines were deleted at the end of the window. */
18375 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
18376 int vpos
= w
->window_end_vpos
;
18377 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18378 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18381 row
== NULL
&& vpos
>= first_vpos
;
18382 --vpos
, --current_row
, --desired_row
)
18384 if (desired_row
->enabled_p
)
18386 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18389 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18393 eassert (row
!= NULL
);
18394 w
->window_end_vpos
= vpos
+ 1;
18395 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18396 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18397 eassert (w
->window_end_bytepos
>= 0);
18398 IF_DEBUG (debug_method_add (w
, "C"));
18403 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18404 debug_end_vpos
= w
->window_end_vpos
));
18406 /* Record that display has not been completed. */
18407 w
->window_end_valid
= 0;
18408 w
->desired_matrix
->no_scrolling_p
= 1;
18416 /***********************************************************************
18417 More debugging support
18418 ***********************************************************************/
18422 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18423 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18424 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18427 /* Dump the contents of glyph matrix MATRIX on stderr.
18429 GLYPHS 0 means don't show glyph contents.
18430 GLYPHS 1 means show glyphs in short form
18431 GLYPHS > 1 means show glyphs in long form. */
18434 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18437 for (i
= 0; i
< matrix
->nrows
; ++i
)
18438 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18442 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18443 the glyph row and area where the glyph comes from. */
18446 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18448 if (glyph
->type
== CHAR_GLYPH
18449 || glyph
->type
== GLYPHLESS_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
],
18454 (glyph
->type
== CHAR_GLYPH
18458 (BUFFERP (glyph
->object
)
18460 : (STRINGP (glyph
->object
)
18462 : (INTEGERP (glyph
->object
)
18465 glyph
->pixel_width
,
18467 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18471 glyph
->left_box_line_p
,
18472 glyph
->right_box_line_p
);
18474 else if (glyph
->type
== STRETCH_GLYPH
)
18477 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18478 glyph
- row
->glyphs
[TEXT_AREA
],
18481 (BUFFERP (glyph
->object
)
18483 : (STRINGP (glyph
->object
)
18485 : (INTEGERP (glyph
->object
)
18488 glyph
->pixel_width
,
18492 glyph
->left_box_line_p
,
18493 glyph
->right_box_line_p
);
18495 else if (glyph
->type
== IMAGE_GLYPH
)
18498 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18499 glyph
- row
->glyphs
[TEXT_AREA
],
18502 (BUFFERP (glyph
->object
)
18504 : (STRINGP (glyph
->object
)
18506 : (INTEGERP (glyph
->object
)
18509 glyph
->pixel_width
,
18513 glyph
->left_box_line_p
,
18514 glyph
->right_box_line_p
);
18516 else if (glyph
->type
== COMPOSITE_GLYPH
)
18519 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18520 glyph
- row
->glyphs
[TEXT_AREA
],
18523 (BUFFERP (glyph
->object
)
18525 : (STRINGP (glyph
->object
)
18527 : (INTEGERP (glyph
->object
)
18530 glyph
->pixel_width
,
18532 if (glyph
->u
.cmp
.automatic
)
18535 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18536 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18538 glyph
->left_box_line_p
,
18539 glyph
->right_box_line_p
);
18544 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18545 GLYPHS 0 means don't show glyph contents.
18546 GLYPHS 1 means show glyphs in short form
18547 GLYPHS > 1 means show glyphs in long form. */
18550 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18554 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18555 fprintf (stderr
, "==============================================================================\n");
18557 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18558 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18560 MATRIX_ROW_START_CHARPOS (row
),
18561 MATRIX_ROW_END_CHARPOS (row
),
18562 row
->used
[TEXT_AREA
],
18563 row
->contains_overlapping_glyphs_p
,
18565 row
->truncated_on_left_p
,
18566 row
->truncated_on_right_p
,
18568 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18569 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18572 row
->ends_in_middle_of_char_p
,
18573 row
->starts_in_middle_of_char_p
,
18579 row
->visible_height
,
18582 /* The next 3 lines should align to "Start" in the header. */
18583 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18584 row
->end
.overlay_string_index
,
18585 row
->continuation_lines_width
);
18586 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18587 CHARPOS (row
->start
.string_pos
),
18588 CHARPOS (row
->end
.string_pos
));
18589 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18590 row
->end
.dpvec_index
);
18597 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18599 struct glyph
*glyph
= row
->glyphs
[area
];
18600 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18602 /* Glyph for a line end in text. */
18603 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18606 if (glyph
< glyph_end
)
18607 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18609 for (; glyph
< glyph_end
; ++glyph
)
18610 dump_glyph (row
, glyph
, area
);
18613 else if (glyphs
== 1)
18617 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18619 char *s
= alloca (row
->used
[area
] + 4);
18622 for (i
= 0; i
< row
->used
[area
]; ++i
)
18624 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18625 if (i
== row
->used
[area
] - 1
18626 && area
== TEXT_AREA
18627 && INTEGERP (glyph
->object
)
18628 && glyph
->type
== CHAR_GLYPH
18629 && glyph
->u
.ch
== ' ')
18631 strcpy (&s
[i
], "[\\n]");
18634 else if (glyph
->type
== CHAR_GLYPH
18635 && glyph
->u
.ch
< 0x80
18636 && glyph
->u
.ch
>= ' ')
18637 s
[i
] = glyph
->u
.ch
;
18643 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18649 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18650 Sdump_glyph_matrix
, 0, 1, "p",
18651 doc
: /* Dump the current matrix of the selected window to stderr.
18652 Shows contents of glyph row structures. With non-nil
18653 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18654 glyphs in short form, otherwise show glyphs in long form. */)
18655 (Lisp_Object glyphs
)
18657 struct window
*w
= XWINDOW (selected_window
);
18658 struct buffer
*buffer
= XBUFFER (w
->contents
);
18660 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18661 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18662 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18663 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18664 fprintf (stderr
, "=============================================\n");
18665 dump_glyph_matrix (w
->current_matrix
,
18666 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18671 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18672 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
18675 struct frame
*f
= XFRAME (selected_frame
);
18676 dump_glyph_matrix (f
->current_matrix
, 1);
18681 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18682 doc
: /* Dump glyph row ROW to stderr.
18683 GLYPH 0 means don't dump glyphs.
18684 GLYPH 1 means dump glyphs in short form.
18685 GLYPH > 1 or omitted means dump glyphs in long form. */)
18686 (Lisp_Object row
, Lisp_Object glyphs
)
18688 struct glyph_matrix
*matrix
;
18691 CHECK_NUMBER (row
);
18692 matrix
= XWINDOW (selected_window
)->current_matrix
;
18694 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18695 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18697 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18702 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18703 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18704 GLYPH 0 means don't dump glyphs.
18705 GLYPH 1 means dump glyphs in short form.
18706 GLYPH > 1 or omitted means dump glyphs in long form.
18708 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18710 (Lisp_Object row
, Lisp_Object glyphs
)
18712 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18713 struct frame
*sf
= SELECTED_FRAME ();
18714 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18717 CHECK_NUMBER (row
);
18719 if (vpos
>= 0 && vpos
< m
->nrows
)
18720 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18721 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18727 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18728 doc
: /* Toggle tracing of redisplay.
18729 With ARG, turn tracing on if and only if ARG is positive. */)
18733 trace_redisplay_p
= !trace_redisplay_p
;
18736 arg
= Fprefix_numeric_value (arg
);
18737 trace_redisplay_p
= XINT (arg
) > 0;
18744 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18745 doc
: /* Like `format', but print result to stderr.
18746 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18747 (ptrdiff_t nargs
, Lisp_Object
*args
)
18749 Lisp_Object s
= Fformat (nargs
, args
);
18750 fprintf (stderr
, "%s", SDATA (s
));
18754 #endif /* GLYPH_DEBUG */
18758 /***********************************************************************
18759 Building Desired Matrix Rows
18760 ***********************************************************************/
18762 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18763 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18765 static struct glyph_row
*
18766 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18768 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18769 struct buffer
*buffer
= XBUFFER (w
->contents
);
18770 struct buffer
*old
= current_buffer
;
18771 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18772 int arrow_len
= SCHARS (overlay_arrow_string
);
18773 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18774 const unsigned char *p
;
18777 int n_glyphs_before
;
18779 set_buffer_temp (buffer
);
18780 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18781 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18782 SET_TEXT_POS (it
.position
, 0, 0);
18784 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18786 while (p
< arrow_end
)
18788 Lisp_Object face
, ilisp
;
18790 /* Get the next character. */
18792 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18795 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18796 if (! ASCII_CHAR_P (it
.c
))
18797 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18801 /* Get its face. */
18802 ilisp
= make_number (p
- arrow_string
);
18803 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18804 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18806 /* Compute its width, get its glyphs. */
18807 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18808 SET_TEXT_POS (it
.position
, -1, -1);
18809 PRODUCE_GLYPHS (&it
);
18811 /* If this character doesn't fit any more in the line, we have
18812 to remove some glyphs. */
18813 if (it
.current_x
> it
.last_visible_x
)
18815 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18820 set_buffer_temp (old
);
18821 return it
.glyph_row
;
18825 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18826 glyphs to insert is determined by produce_special_glyphs. */
18829 insert_left_trunc_glyphs (struct it
*it
)
18831 struct it truncate_it
;
18832 struct glyph
*from
, *end
, *to
, *toend
;
18834 eassert (!FRAME_WINDOW_P (it
->f
)
18835 || (!it
->glyph_row
->reversed_p
18836 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18837 || (it
->glyph_row
->reversed_p
18838 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18840 /* Get the truncation glyphs. */
18842 truncate_it
.current_x
= 0;
18843 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18844 truncate_it
.glyph_row
= &scratch_glyph_row
;
18845 truncate_it
.area
= TEXT_AREA
;
18846 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18847 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18848 truncate_it
.object
= make_number (0);
18849 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18851 /* Overwrite glyphs from IT with truncation glyphs. */
18852 if (!it
->glyph_row
->reversed_p
)
18854 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18856 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18857 end
= from
+ tused
;
18858 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18859 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18860 if (FRAME_WINDOW_P (it
->f
))
18862 /* On GUI frames, when variable-size fonts are displayed,
18863 the truncation glyphs may need more pixels than the row's
18864 glyphs they overwrite. We overwrite more glyphs to free
18865 enough screen real estate, and enlarge the stretch glyph
18866 on the right (see display_line), if there is one, to
18867 preserve the screen position of the truncation glyphs on
18870 struct glyph
*g
= to
;
18873 /* The first glyph could be partially visible, in which case
18874 it->glyph_row->x will be negative. But we want the left
18875 truncation glyphs to be aligned at the left margin of the
18876 window, so we override the x coordinate at which the row
18878 it
->glyph_row
->x
= 0;
18879 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18881 w
+= g
->pixel_width
;
18884 if (g
- to
- tused
> 0)
18886 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18887 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18889 used
= it
->glyph_row
->used
[TEXT_AREA
];
18890 if (it
->glyph_row
->truncated_on_right_p
18891 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18892 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18895 int extra
= w
- it
->truncation_pixel_width
;
18897 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18904 /* There may be padding glyphs left over. Overwrite them too. */
18905 if (!FRAME_WINDOW_P (it
->f
))
18907 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18909 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18916 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18920 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18922 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18923 that back to front. */
18924 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18925 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18926 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18927 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18928 if (FRAME_WINDOW_P (it
->f
))
18931 struct glyph
*g
= to
;
18933 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
18935 w
+= g
->pixel_width
;
18938 if (to
- g
- tused
> 0)
18940 if (it
->glyph_row
->truncated_on_right_p
18941 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
18942 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
18944 int extra
= w
- it
->truncation_pixel_width
;
18946 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
18950 while (from
>= end
&& to
>= toend
)
18952 if (!FRAME_WINDOW_P (it
->f
))
18954 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18957 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18958 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18959 while (from
>= end
&& to
>= toend
)
18965 /* Need to free some room before prepending additional
18967 int move_by
= from
- end
+ 1;
18968 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18969 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18971 for ( ; g
>= g0
; g
--)
18973 while (from
>= end
)
18975 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18980 /* Compute the hash code for ROW. */
18982 row_hash (struct glyph_row
*row
)
18985 unsigned hashval
= 0;
18987 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18988 for (k
= 0; k
< row
->used
[area
]; ++k
)
18989 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18990 + row
->glyphs
[area
][k
].u
.val
18991 + row
->glyphs
[area
][k
].face_id
18992 + row
->glyphs
[area
][k
].padding_p
18993 + (row
->glyphs
[area
][k
].type
<< 2));
18998 /* Compute the pixel height and width of IT->glyph_row.
19000 Most of the time, ascent and height of a display line will be equal
19001 to the max_ascent and max_height values of the display iterator
19002 structure. This is not the case if
19004 1. We hit ZV without displaying anything. In this case, max_ascent
19005 and max_height will be zero.
19007 2. We have some glyphs that don't contribute to the line height.
19008 (The glyph row flag contributes_to_line_height_p is for future
19009 pixmap extensions).
19011 The first case is easily covered by using default values because in
19012 these cases, the line height does not really matter, except that it
19013 must not be zero. */
19016 compute_line_metrics (struct it
*it
)
19018 struct glyph_row
*row
= it
->glyph_row
;
19020 if (FRAME_WINDOW_P (it
->f
))
19022 int i
, min_y
, max_y
;
19024 /* The line may consist of one space only, that was added to
19025 place the cursor on it. If so, the row's height hasn't been
19027 if (row
->height
== 0)
19029 if (it
->max_ascent
+ it
->max_descent
== 0)
19030 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19031 row
->ascent
= it
->max_ascent
;
19032 row
->height
= it
->max_ascent
+ it
->max_descent
;
19033 row
->phys_ascent
= it
->max_phys_ascent
;
19034 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19035 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19038 /* Compute the width of this line. */
19039 row
->pixel_width
= row
->x
;
19040 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19041 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19043 eassert (row
->pixel_width
>= 0);
19044 eassert (row
->ascent
>= 0 && row
->height
> 0);
19046 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19047 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19049 /* If first line's physical ascent is larger than its logical
19050 ascent, use the physical ascent, and make the row taller.
19051 This makes accented characters fully visible. */
19052 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19053 && row
->phys_ascent
> row
->ascent
)
19055 row
->height
+= row
->phys_ascent
- row
->ascent
;
19056 row
->ascent
= row
->phys_ascent
;
19059 /* Compute how much of the line is visible. */
19060 row
->visible_height
= row
->height
;
19062 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19063 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19065 if (row
->y
< min_y
)
19066 row
->visible_height
-= min_y
- row
->y
;
19067 if (row
->y
+ row
->height
> max_y
)
19068 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19072 row
->pixel_width
= row
->used
[TEXT_AREA
];
19073 if (row
->continued_p
)
19074 row
->pixel_width
-= it
->continuation_pixel_width
;
19075 else if (row
->truncated_on_right_p
)
19076 row
->pixel_width
-= it
->truncation_pixel_width
;
19077 row
->ascent
= row
->phys_ascent
= 0;
19078 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19079 row
->extra_line_spacing
= 0;
19082 /* Compute a hash code for this row. */
19083 row
->hash
= row_hash (row
);
19085 it
->max_ascent
= it
->max_descent
= 0;
19086 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19090 /* Append one space to the glyph row of iterator IT if doing a
19091 window-based redisplay. The space has the same face as
19092 IT->face_id. Value is non-zero if a space was added.
19094 This function is called to make sure that there is always one glyph
19095 at the end of a glyph row that the cursor can be set on under
19096 window-systems. (If there weren't such a glyph we would not know
19097 how wide and tall a box cursor should be displayed).
19099 At the same time this space let's a nicely handle clearing to the
19100 end of the line if the row ends in italic text. */
19103 append_space_for_newline (struct it
*it
, int default_face_p
)
19105 if (FRAME_WINDOW_P (it
->f
))
19107 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19109 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19110 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19112 /* Save some values that must not be changed.
19113 Must save IT->c and IT->len because otherwise
19114 ITERATOR_AT_END_P wouldn't work anymore after
19115 append_space_for_newline has been called. */
19116 enum display_element_type saved_what
= it
->what
;
19117 int saved_c
= it
->c
, saved_len
= it
->len
;
19118 int saved_char_to_display
= it
->char_to_display
;
19119 int saved_x
= it
->current_x
;
19120 int saved_face_id
= it
->face_id
;
19121 int saved_box_end
= it
->end_of_box_run_p
;
19122 struct text_pos saved_pos
;
19123 Lisp_Object saved_object
;
19126 saved_object
= it
->object
;
19127 saved_pos
= it
->position
;
19129 it
->what
= IT_CHARACTER
;
19130 memset (&it
->position
, 0, sizeof it
->position
);
19131 it
->object
= make_number (0);
19132 it
->c
= it
->char_to_display
= ' ';
19135 /* If the default face was remapped, be sure to use the
19136 remapped face for the appended newline. */
19137 if (default_face_p
)
19138 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19139 else if (it
->face_before_selective_p
)
19140 it
->face_id
= it
->saved_face_id
;
19141 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19142 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19143 /* In R2L rows, we will prepend a stretch glyph that will
19144 have the end_of_box_run_p flag set for it, so there's no
19145 need for the appended newline glyph to have that flag
19147 if (it
->glyph_row
->reversed_p
19148 /* But if the appended newline glyph goes all the way to
19149 the end of the row, there will be no stretch glyph,
19150 so leave the box flag set. */
19151 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19152 it
->end_of_box_run_p
= 0;
19154 PRODUCE_GLYPHS (it
);
19156 it
->override_ascent
= -1;
19157 it
->constrain_row_ascent_descent_p
= 0;
19158 it
->current_x
= saved_x
;
19159 it
->object
= saved_object
;
19160 it
->position
= saved_pos
;
19161 it
->what
= saved_what
;
19162 it
->face_id
= saved_face_id
;
19163 it
->len
= saved_len
;
19165 it
->char_to_display
= saved_char_to_display
;
19166 it
->end_of_box_run_p
= saved_box_end
;
19175 /* Extend the face of the last glyph in the text area of IT->glyph_row
19176 to the end of the display line. Called from display_line. If the
19177 glyph row is empty, add a space glyph to it so that we know the
19178 face to draw. Set the glyph row flag fill_line_p. If the glyph
19179 row is R2L, prepend a stretch glyph to cover the empty space to the
19180 left of the leftmost glyph. */
19183 extend_face_to_end_of_line (struct it
*it
)
19185 struct face
*face
, *default_face
;
19186 struct frame
*f
= it
->f
;
19188 /* If line is already filled, do nothing. Non window-system frames
19189 get a grace of one more ``pixel'' because their characters are
19190 1-``pixel'' wide, so they hit the equality too early. This grace
19191 is needed only for R2L rows that are not continued, to produce
19192 one extra blank where we could display the cursor. */
19193 if ((it
->current_x
>= it
->last_visible_x
19194 + (!FRAME_WINDOW_P (f
)
19195 && it
->glyph_row
->reversed_p
19196 && !it
->glyph_row
->continued_p
))
19197 /* If the window has display margins, we will need to extend
19198 their face even if the text area is filled. */
19199 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19200 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19203 /* The default face, possibly remapped. */
19204 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19206 /* Face extension extends the background and box of IT->face_id
19207 to the end of the line. If the background equals the background
19208 of the frame, we don't have to do anything. */
19209 if (it
->face_before_selective_p
)
19210 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19212 face
= FACE_FROM_ID (f
, it
->face_id
);
19214 if (FRAME_WINDOW_P (f
)
19215 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19216 && face
->box
== FACE_NO_BOX
19217 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19218 #ifdef HAVE_WINDOW_SYSTEM
19221 && !it
->glyph_row
->reversed_p
)
19224 /* Set the glyph row flag indicating that the face of the last glyph
19225 in the text area has to be drawn to the end of the text area. */
19226 it
->glyph_row
->fill_line_p
= 1;
19228 /* If current character of IT is not ASCII, make sure we have the
19229 ASCII face. This will be automatically undone the next time
19230 get_next_display_element returns a multibyte character. Note
19231 that the character will always be single byte in unibyte
19233 if (!ASCII_CHAR_P (it
->c
))
19235 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19238 if (FRAME_WINDOW_P (f
))
19240 /* If the row is empty, add a space with the current face of IT,
19241 so that we know which face to draw. */
19242 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19244 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19245 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19246 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19248 /* Mode line and the header line don't have margins, and
19249 likewise the frame's tool-bar window, if there is any. */
19250 if (!(it
->glyph_row
->mode_line_p
19251 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19252 || (WINDOWP (f
->tool_bar_window
)
19253 && it
->w
== XWINDOW (f
->tool_bar_window
))
19257 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19258 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19260 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19261 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19263 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19265 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19266 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19268 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19269 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19271 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19274 #ifdef HAVE_WINDOW_SYSTEM
19275 if (it
->glyph_row
->reversed_p
)
19277 /* Prepend a stretch glyph to the row, such that the
19278 rightmost glyph will be drawn flushed all the way to the
19279 right margin of the window. The stretch glyph that will
19280 occupy the empty space, if any, to the left of the
19282 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19283 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19284 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19286 int row_width
, stretch_ascent
, stretch_width
;
19287 struct text_pos saved_pos
;
19288 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
19290 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19291 row_width
+= g
->pixel_width
;
19292 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
19293 if (stretch_width
> 0)
19296 (((it
->ascent
+ it
->descent
)
19297 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19298 saved_pos
= it
->position
;
19299 memset (&it
->position
, 0, sizeof it
->position
);
19300 saved_avoid_cursor
= it
->avoid_cursor_p
;
19301 it
->avoid_cursor_p
= 1;
19302 saved_face_id
= it
->face_id
;
19303 saved_box_start
= it
->start_of_box_run_p
;
19304 /* The last row's stretch glyph should get the default
19305 face, to avoid painting the rest of the window with
19306 the region face, if the region ends at ZV. */
19307 if (it
->glyph_row
->ends_at_zv_p
)
19308 it
->face_id
= default_face
->id
;
19310 it
->face_id
= face
->id
;
19311 it
->start_of_box_run_p
= 0;
19312 append_stretch_glyph (it
, make_number (0), stretch_width
,
19313 it
->ascent
+ it
->descent
, stretch_ascent
);
19314 it
->position
= saved_pos
;
19315 it
->avoid_cursor_p
= saved_avoid_cursor
;
19316 it
->face_id
= saved_face_id
;
19317 it
->start_of_box_run_p
= saved_box_start
;
19320 #endif /* HAVE_WINDOW_SYSTEM */
19324 /* Save some values that must not be changed. */
19325 int saved_x
= it
->current_x
;
19326 struct text_pos saved_pos
;
19327 Lisp_Object saved_object
;
19328 enum display_element_type saved_what
= it
->what
;
19329 int saved_face_id
= it
->face_id
;
19331 saved_object
= it
->object
;
19332 saved_pos
= it
->position
;
19334 it
->what
= IT_CHARACTER
;
19335 memset (&it
->position
, 0, sizeof it
->position
);
19336 it
->object
= make_number (0);
19337 it
->c
= it
->char_to_display
= ' ';
19340 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19341 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19342 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19343 && !it
->glyph_row
->mode_line_p
19344 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19346 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19347 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19349 for (it
->current_x
= 0; g
< e
; g
++)
19350 it
->current_x
+= g
->pixel_width
;
19352 it
->area
= LEFT_MARGIN_AREA
;
19353 it
->face_id
= default_face
->id
;
19354 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19355 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19357 PRODUCE_GLYPHS (it
);
19358 /* term.c:produce_glyphs advances it->current_x only for
19360 it
->current_x
+= it
->pixel_width
;
19363 it
->current_x
= saved_x
;
19364 it
->area
= TEXT_AREA
;
19367 /* The last row's blank glyphs should get the default face, to
19368 avoid painting the rest of the window with the region face,
19369 if the region ends at ZV. */
19370 if (it
->glyph_row
->ends_at_zv_p
)
19371 it
->face_id
= default_face
->id
;
19373 it
->face_id
= face
->id
;
19374 PRODUCE_GLYPHS (it
);
19376 while (it
->current_x
<= it
->last_visible_x
)
19377 PRODUCE_GLYPHS (it
);
19379 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19380 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19381 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19382 && !it
->glyph_row
->mode_line_p
19383 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19385 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19386 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19388 for ( ; g
< e
; g
++)
19389 it
->current_x
+= g
->pixel_width
;
19391 it
->area
= RIGHT_MARGIN_AREA
;
19392 it
->face_id
= default_face
->id
;
19393 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19394 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19396 PRODUCE_GLYPHS (it
);
19397 it
->current_x
+= it
->pixel_width
;
19400 it
->area
= TEXT_AREA
;
19403 /* Don't count these blanks really. It would let us insert a left
19404 truncation glyph below and make us set the cursor on them, maybe. */
19405 it
->current_x
= saved_x
;
19406 it
->object
= saved_object
;
19407 it
->position
= saved_pos
;
19408 it
->what
= saved_what
;
19409 it
->face_id
= saved_face_id
;
19414 /* Value is non-zero if text starting at CHARPOS in current_buffer is
19415 trailing whitespace. */
19418 trailing_whitespace_p (ptrdiff_t charpos
)
19420 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19423 while (bytepos
< ZV_BYTE
19424 && (c
= FETCH_CHAR (bytepos
),
19425 c
== ' ' || c
== '\t'))
19428 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19430 if (bytepos
!= PT_BYTE
)
19437 /* Highlight trailing whitespace, if any, in ROW. */
19440 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19442 int used
= row
->used
[TEXT_AREA
];
19446 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19447 struct glyph
*glyph
= start
+ used
- 1;
19449 if (row
->reversed_p
)
19451 /* Right-to-left rows need to be processed in the opposite
19452 direction, so swap the edge pointers. */
19454 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19457 /* Skip over glyphs inserted to display the cursor at the
19458 end of a line, for extending the face of the last glyph
19459 to the end of the line on terminals, and for truncation
19460 and continuation glyphs. */
19461 if (!row
->reversed_p
)
19463 while (glyph
>= start
19464 && glyph
->type
== CHAR_GLYPH
19465 && INTEGERP (glyph
->object
))
19470 while (glyph
<= start
19471 && glyph
->type
== CHAR_GLYPH
19472 && INTEGERP (glyph
->object
))
19476 /* If last glyph is a space or stretch, and it's trailing
19477 whitespace, set the face of all trailing whitespace glyphs in
19478 IT->glyph_row to `trailing-whitespace'. */
19479 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19480 && BUFFERP (glyph
->object
)
19481 && (glyph
->type
== STRETCH_GLYPH
19482 || (glyph
->type
== CHAR_GLYPH
19483 && glyph
->u
.ch
== ' '))
19484 && trailing_whitespace_p (glyph
->charpos
))
19486 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
19490 if (!row
->reversed_p
)
19492 while (glyph
>= start
19493 && BUFFERP (glyph
->object
)
19494 && (glyph
->type
== STRETCH_GLYPH
19495 || (glyph
->type
== CHAR_GLYPH
19496 && glyph
->u
.ch
== ' ')))
19497 (glyph
--)->face_id
= face_id
;
19501 while (glyph
<= start
19502 && BUFFERP (glyph
->object
)
19503 && (glyph
->type
== STRETCH_GLYPH
19504 || (glyph
->type
== CHAR_GLYPH
19505 && glyph
->u
.ch
== ' ')))
19506 (glyph
++)->face_id
= face_id
;
19513 /* Value is non-zero if glyph row ROW should be
19514 considered to hold the buffer position CHARPOS. */
19517 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19521 if (charpos
== CHARPOS (row
->end
.pos
)
19522 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19524 /* Suppose the row ends on a string.
19525 Unless the row is continued, that means it ends on a newline
19526 in the string. If it's anything other than a display string
19527 (e.g., a before-string from an overlay), we don't want the
19528 cursor there. (This heuristic seems to give the optimal
19529 behavior for the various types of multi-line strings.)
19530 One exception: if the string has `cursor' property on one of
19531 its characters, we _do_ want the cursor there. */
19532 if (CHARPOS (row
->end
.string_pos
) >= 0)
19534 if (row
->continued_p
)
19538 /* Check for `display' property. */
19539 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19540 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19541 struct glyph
*glyph
;
19544 for (glyph
= end
; glyph
>= beg
; --glyph
)
19545 if (STRINGP (glyph
->object
))
19548 = Fget_char_property (make_number (charpos
),
19552 && display_prop_string_p (prop
, glyph
->object
));
19553 /* If there's a `cursor' property on one of the
19554 string's characters, this row is a cursor row,
19555 even though this is not a display string. */
19558 Lisp_Object s
= glyph
->object
;
19560 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19562 ptrdiff_t gpos
= glyph
->charpos
;
19564 if (!NILP (Fget_char_property (make_number (gpos
),
19576 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19578 /* If the row ends in middle of a real character,
19579 and the line is continued, we want the cursor here.
19580 That's because CHARPOS (ROW->end.pos) would equal
19581 PT if PT is before the character. */
19582 if (!row
->ends_in_ellipsis_p
)
19583 result
= row
->continued_p
;
19585 /* If the row ends in an ellipsis, then
19586 CHARPOS (ROW->end.pos) will equal point after the
19587 invisible text. We want that position to be displayed
19588 after the ellipsis. */
19591 /* If the row ends at ZV, display the cursor at the end of that
19592 row instead of at the start of the row below. */
19593 else if (row
->ends_at_zv_p
)
19602 /* Value is non-zero if glyph row ROW should be
19603 used to hold the cursor. */
19606 cursor_row_p (struct glyph_row
*row
)
19608 return row_for_charpos_p (row
, PT
);
19613 /* Push the property PROP so that it will be rendered at the current
19614 position in IT. Return 1 if PROP was successfully pushed, 0
19615 otherwise. Called from handle_line_prefix to handle the
19616 `line-prefix' and `wrap-prefix' properties. */
19619 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19621 struct text_pos pos
=
19622 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19624 eassert (it
->method
== GET_FROM_BUFFER
19625 || it
->method
== GET_FROM_DISPLAY_VECTOR
19626 || it
->method
== GET_FROM_STRING
);
19628 /* We need to save the current buffer/string position, so it will be
19629 restored by pop_it, because iterate_out_of_display_property
19630 depends on that being set correctly, but some situations leave
19631 it->position not yet set when this function is called. */
19632 push_it (it
, &pos
);
19634 if (STRINGP (prop
))
19636 if (SCHARS (prop
) == 0)
19643 it
->string_from_prefix_prop_p
= 1;
19644 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19645 it
->current
.overlay_string_index
= -1;
19646 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19647 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19648 it
->method
= GET_FROM_STRING
;
19649 it
->stop_charpos
= 0;
19651 it
->base_level_stop
= 0;
19653 /* Force paragraph direction to be that of the parent
19655 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19656 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19658 it
->paragraph_embedding
= L2R
;
19660 /* Set up the bidi iterator for this display string. */
19663 it
->bidi_it
.string
.lstring
= it
->string
;
19664 it
->bidi_it
.string
.s
= NULL
;
19665 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19666 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19667 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19668 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19669 it
->bidi_it
.w
= it
->w
;
19670 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19673 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19675 it
->method
= GET_FROM_STRETCH
;
19678 #ifdef HAVE_WINDOW_SYSTEM
19679 else if (IMAGEP (prop
))
19681 it
->what
= IT_IMAGE
;
19682 it
->image_id
= lookup_image (it
->f
, prop
);
19683 it
->method
= GET_FROM_IMAGE
;
19685 #endif /* HAVE_WINDOW_SYSTEM */
19688 pop_it (it
); /* bogus display property, give up */
19695 /* Return the character-property PROP at the current position in IT. */
19698 get_it_property (struct it
*it
, Lisp_Object prop
)
19700 Lisp_Object position
, object
= it
->object
;
19702 if (STRINGP (object
))
19703 position
= make_number (IT_STRING_CHARPOS (*it
));
19704 else if (BUFFERP (object
))
19706 position
= make_number (IT_CHARPOS (*it
));
19707 object
= it
->window
;
19712 return Fget_char_property (position
, prop
, object
);
19715 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19718 handle_line_prefix (struct it
*it
)
19720 Lisp_Object prefix
;
19722 if (it
->continuation_lines_width
> 0)
19724 prefix
= get_it_property (it
, Qwrap_prefix
);
19726 prefix
= Vwrap_prefix
;
19730 prefix
= get_it_property (it
, Qline_prefix
);
19732 prefix
= Vline_prefix
;
19734 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19736 /* If the prefix is wider than the window, and we try to wrap
19737 it, it would acquire its own wrap prefix, and so on till the
19738 iterator stack overflows. So, don't wrap the prefix. */
19739 it
->line_wrap
= TRUNCATE
;
19740 it
->avoid_cursor_p
= 1;
19746 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19747 only for R2L lines from display_line and display_string, when they
19748 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19749 the line/string needs to be continued on the next glyph row. */
19751 unproduce_glyphs (struct it
*it
, int n
)
19753 struct glyph
*glyph
, *end
;
19755 eassert (it
->glyph_row
);
19756 eassert (it
->glyph_row
->reversed_p
);
19757 eassert (it
->area
== TEXT_AREA
);
19758 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19760 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19761 n
= it
->glyph_row
->used
[TEXT_AREA
];
19762 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19763 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19764 for ( ; glyph
< end
; glyph
++)
19765 glyph
[-n
] = *glyph
;
19768 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19769 and ROW->maxpos. */
19771 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19772 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19773 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19775 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19776 lines' rows is implemented for bidi-reordered rows. */
19778 /* ROW->minpos is the value of min_pos, the minimal buffer position
19779 we have in ROW, or ROW->start.pos if that is smaller. */
19780 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19781 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19783 /* We didn't find buffer positions smaller than ROW->start, or
19784 didn't find _any_ valid buffer positions in any of the glyphs,
19785 so we must trust the iterator's computed positions. */
19786 row
->minpos
= row
->start
.pos
;
19789 max_pos
= CHARPOS (it
->current
.pos
);
19790 max_bpos
= BYTEPOS (it
->current
.pos
);
19793 /* Here are the various use-cases for ending the row, and the
19794 corresponding values for ROW->maxpos:
19796 Line ends in a newline from buffer eol_pos + 1
19797 Line is continued from buffer max_pos + 1
19798 Line is truncated on right it->current.pos
19799 Line ends in a newline from string max_pos + 1(*)
19800 (*) + 1 only when line ends in a forward scan
19801 Line is continued from string max_pos
19802 Line is continued from display vector max_pos
19803 Line is entirely from a string min_pos == max_pos
19804 Line is entirely from a display vector min_pos == max_pos
19805 Line that ends at ZV ZV
19807 If you discover other use-cases, please add them here as
19809 if (row
->ends_at_zv_p
)
19810 row
->maxpos
= it
->current
.pos
;
19811 else if (row
->used
[TEXT_AREA
])
19813 int seen_this_string
= 0;
19814 struct glyph_row
*r1
= row
- 1;
19816 /* Did we see the same display string on the previous row? */
19817 if (STRINGP (it
->object
)
19818 /* this is not the first row */
19819 && row
> it
->w
->desired_matrix
->rows
19820 /* previous row is not the header line */
19821 && !r1
->mode_line_p
19822 /* previous row also ends in a newline from a string */
19823 && r1
->ends_in_newline_from_string_p
)
19825 struct glyph
*start
, *end
;
19827 /* Search for the last glyph of the previous row that came
19828 from buffer or string. Depending on whether the row is
19829 L2R or R2L, we need to process it front to back or the
19830 other way round. */
19831 if (!r1
->reversed_p
)
19833 start
= r1
->glyphs
[TEXT_AREA
];
19834 end
= start
+ r1
->used
[TEXT_AREA
];
19835 /* Glyphs inserted by redisplay have an integer (zero)
19836 as their object. */
19838 && INTEGERP ((end
- 1)->object
)
19839 && (end
- 1)->charpos
<= 0)
19843 if (EQ ((end
- 1)->object
, it
->object
))
19844 seen_this_string
= 1;
19847 /* If all the glyphs of the previous row were inserted
19848 by redisplay, it means the previous row was
19849 produced from a single newline, which is only
19850 possible if that newline came from the same string
19851 as the one which produced this ROW. */
19852 seen_this_string
= 1;
19856 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19857 start
= end
+ r1
->used
[TEXT_AREA
];
19859 && INTEGERP ((end
+ 1)->object
)
19860 && (end
+ 1)->charpos
<= 0)
19864 if (EQ ((end
+ 1)->object
, it
->object
))
19865 seen_this_string
= 1;
19868 seen_this_string
= 1;
19871 /* Take note of each display string that covers a newline only
19872 once, the first time we see it. This is for when a display
19873 string includes more than one newline in it. */
19874 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
19876 /* If we were scanning the buffer forward when we displayed
19877 the string, we want to account for at least one buffer
19878 position that belongs to this row (position covered by
19879 the display string), so that cursor positioning will
19880 consider this row as a candidate when point is at the end
19881 of the visual line represented by this row. This is not
19882 required when scanning back, because max_pos will already
19883 have a much larger value. */
19884 if (CHARPOS (row
->end
.pos
) > max_pos
)
19885 INC_BOTH (max_pos
, max_bpos
);
19886 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19888 else if (CHARPOS (it
->eol_pos
) > 0)
19889 SET_TEXT_POS (row
->maxpos
,
19890 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
19891 else if (row
->continued_p
)
19893 /* If max_pos is different from IT's current position, it
19894 means IT->method does not belong to the display element
19895 at max_pos. However, it also means that the display
19896 element at max_pos was displayed in its entirety on this
19897 line, which is equivalent to saying that the next line
19898 starts at the next buffer position. */
19899 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
19900 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19903 INC_BOTH (max_pos
, max_bpos
);
19904 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19907 else if (row
->truncated_on_right_p
)
19908 /* display_line already called reseat_at_next_visible_line_start,
19909 which puts the iterator at the beginning of the next line, in
19910 the logical order. */
19911 row
->maxpos
= it
->current
.pos
;
19912 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
19913 /* A line that is entirely from a string/image/stretch... */
19914 row
->maxpos
= row
->minpos
;
19919 row
->maxpos
= it
->current
.pos
;
19922 /* Construct the glyph row IT->glyph_row in the desired matrix of
19923 IT->w from text at the current position of IT. See dispextern.h
19924 for an overview of struct it. Value is non-zero if
19925 IT->glyph_row displays text, as opposed to a line displaying ZV
19929 display_line (struct it
*it
)
19931 struct glyph_row
*row
= it
->glyph_row
;
19932 Lisp_Object overlay_arrow_string
;
19934 void *wrap_data
= NULL
;
19935 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
19936 int wrap_row_used
= -1;
19937 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
19938 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
19939 int wrap_row_extra_line_spacing
IF_LINT (= 0);
19940 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
19941 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
19943 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
19944 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
19946 /* We always start displaying at hpos zero even if hscrolled. */
19947 eassert (it
->hpos
== 0 && it
->current_x
== 0);
19949 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
19950 >= it
->w
->desired_matrix
->nrows
)
19952 it
->w
->nrows_scale_factor
++;
19953 it
->f
->fonts_changed
= 1;
19957 /* Clear the result glyph row and enable it. */
19958 prepare_desired_row (it
->w
, row
, false);
19960 row
->y
= it
->current_y
;
19961 row
->start
= it
->start
;
19962 row
->continuation_lines_width
= it
->continuation_lines_width
;
19963 row
->displays_text_p
= 1;
19964 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
19965 it
->starts_in_middle_of_char_p
= 0;
19967 /* Arrange the overlays nicely for our purposes. Usually, we call
19968 display_line on only one line at a time, in which case this
19969 can't really hurt too much, or we call it on lines which appear
19970 one after another in the buffer, in which case all calls to
19971 recenter_overlay_lists but the first will be pretty cheap. */
19972 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
19974 /* Move over display elements that are not visible because we are
19975 hscrolled. This may stop at an x-position < IT->first_visible_x
19976 if the first glyph is partially visible or if we hit a line end. */
19977 if (it
->current_x
< it
->first_visible_x
)
19979 enum move_it_result move_result
;
19981 this_line_min_pos
= row
->start
.pos
;
19982 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
19983 MOVE_TO_POS
| MOVE_TO_X
);
19984 /* If we are under a large hscroll, move_it_in_display_line_to
19985 could hit the end of the line without reaching
19986 it->first_visible_x. Pretend that we did reach it. This is
19987 especially important on a TTY, where we will call
19988 extend_face_to_end_of_line, which needs to know how many
19989 blank glyphs to produce. */
19990 if (it
->current_x
< it
->first_visible_x
19991 && (move_result
== MOVE_NEWLINE_OR_CR
19992 || move_result
== MOVE_POS_MATCH_OR_ZV
))
19993 it
->current_x
= it
->first_visible_x
;
19995 /* Record the smallest positions seen while we moved over
19996 display elements that are not visible. This is needed by
19997 redisplay_internal for optimizing the case where the cursor
19998 stays inside the same line. The rest of this function only
19999 considers positions that are actually displayed, so
20000 RECORD_MAX_MIN_POS will not otherwise record positions that
20001 are hscrolled to the left of the left edge of the window. */
20002 min_pos
= CHARPOS (this_line_min_pos
);
20003 min_bpos
= BYTEPOS (this_line_min_pos
);
20007 /* We only do this when not calling `move_it_in_display_line_to'
20008 above, because move_it_in_display_line_to calls
20009 handle_line_prefix itself. */
20010 handle_line_prefix (it
);
20013 /* Get the initial row height. This is either the height of the
20014 text hscrolled, if there is any, or zero. */
20015 row
->ascent
= it
->max_ascent
;
20016 row
->height
= it
->max_ascent
+ it
->max_descent
;
20017 row
->phys_ascent
= it
->max_phys_ascent
;
20018 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20019 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20021 /* Utility macro to record max and min buffer positions seen until now. */
20022 #define RECORD_MAX_MIN_POS(IT) \
20025 int composition_p = !STRINGP ((IT)->string) \
20026 && ((IT)->what == IT_COMPOSITION); \
20027 ptrdiff_t current_pos = \
20028 composition_p ? (IT)->cmp_it.charpos \
20029 : IT_CHARPOS (*(IT)); \
20030 ptrdiff_t current_bpos = \
20031 composition_p ? CHAR_TO_BYTE (current_pos) \
20032 : IT_BYTEPOS (*(IT)); \
20033 if (current_pos < min_pos) \
20035 min_pos = current_pos; \
20036 min_bpos = current_bpos; \
20038 if (IT_CHARPOS (*it) > max_pos) \
20040 max_pos = IT_CHARPOS (*it); \
20041 max_bpos = IT_BYTEPOS (*it); \
20046 /* Loop generating characters. The loop is left with IT on the next
20047 character to display. */
20050 int n_glyphs_before
, hpos_before
, x_before
;
20052 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20054 /* Retrieve the next thing to display. Value is zero if end of
20056 if (!get_next_display_element (it
))
20058 /* Maybe add a space at the end of this line that is used to
20059 display the cursor there under X. Set the charpos of the
20060 first glyph of blank lines not corresponding to any text
20062 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20063 row
->exact_window_width_line_p
= 1;
20064 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
20065 || row
->used
[TEXT_AREA
] == 0)
20067 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20068 row
->displays_text_p
= 0;
20070 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20071 && (!MINI_WINDOW_P (it
->w
)
20072 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20073 row
->indicate_empty_line_p
= 1;
20076 it
->continuation_lines_width
= 0;
20077 row
->ends_at_zv_p
= 1;
20078 /* A row that displays right-to-left text must always have
20079 its last face extended all the way to the end of line,
20080 even if this row ends in ZV, because we still write to
20081 the screen left to right. We also need to extend the
20082 last face if the default face is remapped to some
20083 different face, otherwise the functions that clear
20084 portions of the screen will clear with the default face's
20085 background color. */
20086 if (row
->reversed_p
20087 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20088 extend_face_to_end_of_line (it
);
20092 /* Now, get the metrics of what we want to display. This also
20093 generates glyphs in `row' (which is IT->glyph_row). */
20094 n_glyphs_before
= row
->used
[TEXT_AREA
];
20097 /* Remember the line height so far in case the next element doesn't
20098 fit on the line. */
20099 if (it
->line_wrap
!= TRUNCATE
)
20101 ascent
= it
->max_ascent
;
20102 descent
= it
->max_descent
;
20103 phys_ascent
= it
->max_phys_ascent
;
20104 phys_descent
= it
->max_phys_descent
;
20106 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20108 if (IT_DISPLAYING_WHITESPACE (it
))
20112 SAVE_IT (wrap_it
, *it
, wrap_data
);
20114 wrap_row_used
= row
->used
[TEXT_AREA
];
20115 wrap_row_ascent
= row
->ascent
;
20116 wrap_row_height
= row
->height
;
20117 wrap_row_phys_ascent
= row
->phys_ascent
;
20118 wrap_row_phys_height
= row
->phys_height
;
20119 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20120 wrap_row_min_pos
= min_pos
;
20121 wrap_row_min_bpos
= min_bpos
;
20122 wrap_row_max_pos
= max_pos
;
20123 wrap_row_max_bpos
= max_bpos
;
20129 PRODUCE_GLYPHS (it
);
20131 /* If this display element was in marginal areas, continue with
20133 if (it
->area
!= TEXT_AREA
)
20135 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20136 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20137 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20138 row
->phys_height
= max (row
->phys_height
,
20139 it
->max_phys_ascent
+ it
->max_phys_descent
);
20140 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20141 it
->max_extra_line_spacing
);
20142 set_iterator_to_next (it
, 1);
20146 /* Does the display element fit on the line? If we truncate
20147 lines, we should draw past the right edge of the window. If
20148 we don't truncate, we want to stop so that we can display the
20149 continuation glyph before the right margin. If lines are
20150 continued, there are two possible strategies for characters
20151 resulting in more than 1 glyph (e.g. tabs): Display as many
20152 glyphs as possible in this line and leave the rest for the
20153 continuation line, or display the whole element in the next
20154 line. Original redisplay did the former, so we do it also. */
20155 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20156 hpos_before
= it
->hpos
;
20159 if (/* Not a newline. */
20161 /* Glyphs produced fit entirely in the line. */
20162 && it
->current_x
< it
->last_visible_x
)
20164 it
->hpos
+= nglyphs
;
20165 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20166 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20167 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20168 row
->phys_height
= max (row
->phys_height
,
20169 it
->max_phys_ascent
+ it
->max_phys_descent
);
20170 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20171 it
->max_extra_line_spacing
);
20172 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
20173 row
->x
= x
- it
->first_visible_x
;
20174 /* Record the maximum and minimum buffer positions seen so
20175 far in glyphs that will be displayed by this row. */
20177 RECORD_MAX_MIN_POS (it
);
20182 struct glyph
*glyph
;
20184 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20186 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20187 new_x
= x
+ glyph
->pixel_width
;
20189 if (/* Lines are continued. */
20190 it
->line_wrap
!= TRUNCATE
20191 && (/* Glyph doesn't fit on the line. */
20192 new_x
> it
->last_visible_x
20193 /* Or it fits exactly on a window system frame. */
20194 || (new_x
== it
->last_visible_x
20195 && FRAME_WINDOW_P (it
->f
)
20196 && (row
->reversed_p
20197 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20198 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20200 /* End of a continued line. */
20203 || (new_x
== it
->last_visible_x
20204 && FRAME_WINDOW_P (it
->f
)
20205 && (row
->reversed_p
20206 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20207 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20209 /* Current glyph is the only one on the line or
20210 fits exactly on the line. We must continue
20211 the line because we can't draw the cursor
20212 after the glyph. */
20213 row
->continued_p
= 1;
20214 it
->current_x
= new_x
;
20215 it
->continuation_lines_width
+= new_x
;
20217 if (i
== nglyphs
- 1)
20219 /* If line-wrap is on, check if a previous
20220 wrap point was found. */
20221 if (wrap_row_used
> 0
20222 /* Even if there is a previous wrap
20223 point, continue the line here as
20224 usual, if (i) the previous character
20225 was a space or tab AND (ii) the
20226 current character is not. */
20228 || IT_DISPLAYING_WHITESPACE (it
)))
20231 /* Record the maximum and minimum buffer
20232 positions seen so far in glyphs that will be
20233 displayed by this row. */
20235 RECORD_MAX_MIN_POS (it
);
20236 set_iterator_to_next (it
, 1);
20237 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20239 if (!get_next_display_element (it
))
20241 row
->exact_window_width_line_p
= 1;
20242 it
->continuation_lines_width
= 0;
20243 row
->continued_p
= 0;
20244 row
->ends_at_zv_p
= 1;
20246 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20248 row
->continued_p
= 0;
20249 row
->exact_window_width_line_p
= 1;
20253 else if (it
->bidi_p
)
20254 RECORD_MAX_MIN_POS (it
);
20255 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20256 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20257 extend_face_to_end_of_line (it
);
20259 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20260 && !FRAME_WINDOW_P (it
->f
))
20262 /* A padding glyph that doesn't fit on this line.
20263 This means the whole character doesn't fit
20265 if (row
->reversed_p
)
20266 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20267 - n_glyphs_before
);
20268 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20270 /* Fill the rest of the row with continuation
20271 glyphs like in 20.x. */
20272 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20273 < row
->glyphs
[1 + TEXT_AREA
])
20274 produce_special_glyphs (it
, IT_CONTINUATION
);
20276 row
->continued_p
= 1;
20277 it
->current_x
= x_before
;
20278 it
->continuation_lines_width
+= x_before
;
20280 /* Restore the height to what it was before the
20281 element not fitting on the line. */
20282 it
->max_ascent
= ascent
;
20283 it
->max_descent
= descent
;
20284 it
->max_phys_ascent
= phys_ascent
;
20285 it
->max_phys_descent
= phys_descent
;
20286 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20287 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20288 extend_face_to_end_of_line (it
);
20290 else if (wrap_row_used
> 0)
20293 if (row
->reversed_p
)
20294 unproduce_glyphs (it
,
20295 row
->used
[TEXT_AREA
] - wrap_row_used
);
20296 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20297 it
->continuation_lines_width
+= wrap_x
;
20298 row
->used
[TEXT_AREA
] = wrap_row_used
;
20299 row
->ascent
= wrap_row_ascent
;
20300 row
->height
= wrap_row_height
;
20301 row
->phys_ascent
= wrap_row_phys_ascent
;
20302 row
->phys_height
= wrap_row_phys_height
;
20303 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20304 min_pos
= wrap_row_min_pos
;
20305 min_bpos
= wrap_row_min_bpos
;
20306 max_pos
= wrap_row_max_pos
;
20307 max_bpos
= wrap_row_max_bpos
;
20308 row
->continued_p
= 1;
20309 row
->ends_at_zv_p
= 0;
20310 row
->exact_window_width_line_p
= 0;
20311 it
->continuation_lines_width
+= x
;
20313 /* Make sure that a non-default face is extended
20314 up to the right margin of the window. */
20315 extend_face_to_end_of_line (it
);
20317 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20319 /* A TAB that extends past the right edge of the
20320 window. This produces a single glyph on
20321 window system frames. We leave the glyph in
20322 this row and let it fill the row, but don't
20323 consume the TAB. */
20324 if ((row
->reversed_p
20325 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20326 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20327 produce_special_glyphs (it
, IT_CONTINUATION
);
20328 it
->continuation_lines_width
+= it
->last_visible_x
;
20329 row
->ends_in_middle_of_char_p
= 1;
20330 row
->continued_p
= 1;
20331 glyph
->pixel_width
= it
->last_visible_x
- x
;
20332 it
->starts_in_middle_of_char_p
= 1;
20333 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20334 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20335 extend_face_to_end_of_line (it
);
20339 /* Something other than a TAB that draws past
20340 the right edge of the window. Restore
20341 positions to values before the element. */
20342 if (row
->reversed_p
)
20343 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20344 - (n_glyphs_before
+ i
));
20345 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20347 /* Display continuation glyphs. */
20348 it
->current_x
= x_before
;
20349 it
->continuation_lines_width
+= x
;
20350 if (!FRAME_WINDOW_P (it
->f
)
20351 || (row
->reversed_p
20352 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20353 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20354 produce_special_glyphs (it
, IT_CONTINUATION
);
20355 row
->continued_p
= 1;
20357 extend_face_to_end_of_line (it
);
20359 if (nglyphs
> 1 && i
> 0)
20361 row
->ends_in_middle_of_char_p
= 1;
20362 it
->starts_in_middle_of_char_p
= 1;
20365 /* Restore the height to what it was before the
20366 element not fitting on the line. */
20367 it
->max_ascent
= ascent
;
20368 it
->max_descent
= descent
;
20369 it
->max_phys_ascent
= phys_ascent
;
20370 it
->max_phys_descent
= phys_descent
;
20375 else if (new_x
> it
->first_visible_x
)
20377 /* Increment number of glyphs actually displayed. */
20380 /* Record the maximum and minimum buffer positions
20381 seen so far in glyphs that will be displayed by
20384 RECORD_MAX_MIN_POS (it
);
20386 if (x
< it
->first_visible_x
)
20387 /* Glyph is partially visible, i.e. row starts at
20388 negative X position. */
20389 row
->x
= x
- it
->first_visible_x
;
20393 /* Glyph is completely off the left margin of the
20394 window. This should not happen because of the
20395 move_it_in_display_line at the start of this
20396 function, unless the text display area of the
20397 window is empty. */
20398 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20401 /* Even if this display element produced no glyphs at all,
20402 we want to record its position. */
20403 if (it
->bidi_p
&& nglyphs
== 0)
20404 RECORD_MAX_MIN_POS (it
);
20406 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20407 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20408 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20409 row
->phys_height
= max (row
->phys_height
,
20410 it
->max_phys_ascent
+ it
->max_phys_descent
);
20411 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20412 it
->max_extra_line_spacing
);
20414 /* End of this display line if row is continued. */
20415 if (row
->continued_p
|| row
->ends_at_zv_p
)
20420 /* Is this a line end? If yes, we're also done, after making
20421 sure that a non-default face is extended up to the right
20422 margin of the window. */
20423 if (ITERATOR_AT_END_OF_LINE_P (it
))
20425 int used_before
= row
->used
[TEXT_AREA
];
20427 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20429 /* Add a space at the end of the line that is used to
20430 display the cursor there. */
20431 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20432 append_space_for_newline (it
, 0);
20434 /* Extend the face to the end of the line. */
20435 extend_face_to_end_of_line (it
);
20437 /* Make sure we have the position. */
20438 if (used_before
== 0)
20439 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20441 /* Record the position of the newline, for use in
20443 it
->eol_pos
= it
->current
.pos
;
20445 /* Consume the line end. This skips over invisible lines. */
20446 set_iterator_to_next (it
, 1);
20447 it
->continuation_lines_width
= 0;
20451 /* Proceed with next display element. Note that this skips
20452 over lines invisible because of selective display. */
20453 set_iterator_to_next (it
, 1);
20455 /* If we truncate lines, we are done when the last displayed
20456 glyphs reach past the right margin of the window. */
20457 if (it
->line_wrap
== TRUNCATE
20458 && ((FRAME_WINDOW_P (it
->f
)
20459 /* Images are preprocessed in produce_image_glyph such
20460 that they are cropped at the right edge of the
20461 window, so an image glyph will always end exactly at
20462 last_visible_x, even if there's no right fringe. */
20463 && (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) || it
->what
== IT_IMAGE
))
20464 ? (it
->current_x
>= it
->last_visible_x
)
20465 : (it
->current_x
> it
->last_visible_x
)))
20467 /* Maybe add truncation glyphs. */
20468 if (!FRAME_WINDOW_P (it
->f
)
20469 || (row
->reversed_p
20470 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20471 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20475 if (!row
->reversed_p
)
20477 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20478 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20483 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20484 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20486 /* Remove any padding glyphs at the front of ROW, to
20487 make room for the truncation glyphs we will be
20488 adding below. The loop below always inserts at
20489 least one truncation glyph, so also remove the
20490 last glyph added to ROW. */
20491 unproduce_glyphs (it
, i
+ 1);
20492 /* Adjust i for the loop below. */
20493 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20496 /* produce_special_glyphs overwrites the last glyph, so
20497 we don't want that if we want to keep that last
20498 glyph, which means it's an image. */
20499 if (it
->current_x
> it
->last_visible_x
)
20501 it
->current_x
= x_before
;
20502 if (!FRAME_WINDOW_P (it
->f
))
20504 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20506 row
->used
[TEXT_AREA
] = i
;
20507 produce_special_glyphs (it
, IT_TRUNCATION
);
20512 row
->used
[TEXT_AREA
] = i
;
20513 produce_special_glyphs (it
, IT_TRUNCATION
);
20515 it
->hpos
= hpos_before
;
20518 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20520 /* Don't truncate if we can overflow newline into fringe. */
20521 if (!get_next_display_element (it
))
20523 it
->continuation_lines_width
= 0;
20524 row
->ends_at_zv_p
= 1;
20525 row
->exact_window_width_line_p
= 1;
20528 if (ITERATOR_AT_END_OF_LINE_P (it
))
20530 row
->exact_window_width_line_p
= 1;
20531 goto at_end_of_line
;
20533 it
->current_x
= x_before
;
20534 it
->hpos
= hpos_before
;
20537 row
->truncated_on_right_p
= 1;
20538 it
->continuation_lines_width
= 0;
20539 reseat_at_next_visible_line_start (it
, 0);
20540 if (IT_BYTEPOS (*it
) <= BEG_BYTE
)
20541 row
->ends_at_zv_p
= true;
20543 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
20549 bidi_unshelve_cache (wrap_data
, 1);
20551 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20552 at the left window margin. */
20553 if (it
->first_visible_x
20554 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20556 if (!FRAME_WINDOW_P (it
->f
)
20557 || (((row
->reversed_p
20558 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20559 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20560 /* Don't let insert_left_trunc_glyphs overwrite the
20561 first glyph of the row if it is an image. */
20562 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20563 insert_left_trunc_glyphs (it
);
20564 row
->truncated_on_left_p
= 1;
20567 /* Remember the position at which this line ends.
20569 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20570 cannot be before the call to find_row_edges below, since that is
20571 where these positions are determined. */
20572 row
->end
= it
->current
;
20575 row
->minpos
= row
->start
.pos
;
20576 row
->maxpos
= row
->end
.pos
;
20580 /* ROW->minpos and ROW->maxpos must be the smallest and
20581 `1 + the largest' buffer positions in ROW. But if ROW was
20582 bidi-reordered, these two positions can be anywhere in the
20583 row, so we must determine them now. */
20584 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20587 /* If the start of this line is the overlay arrow-position, then
20588 mark this glyph row as the one containing the overlay arrow.
20589 This is clearly a mess with variable size fonts. It would be
20590 better to let it be displayed like cursors under X. */
20591 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20592 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20593 !NILP (overlay_arrow_string
)))
20595 /* Overlay arrow in window redisplay is a fringe bitmap. */
20596 if (STRINGP (overlay_arrow_string
))
20598 struct glyph_row
*arrow_row
20599 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20600 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20601 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20602 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20603 struct glyph
*p2
, *end
;
20605 /* Copy the arrow glyphs. */
20606 while (glyph
< arrow_end
)
20609 /* Throw away padding glyphs. */
20611 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20612 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20618 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20623 eassert (INTEGERP (overlay_arrow_string
));
20624 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20626 overlay_arrow_seen
= 1;
20629 /* Highlight trailing whitespace. */
20630 if (!NILP (Vshow_trailing_whitespace
))
20631 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20633 /* Compute pixel dimensions of this line. */
20634 compute_line_metrics (it
);
20636 /* Implementation note: No changes in the glyphs of ROW or in their
20637 faces can be done past this point, because compute_line_metrics
20638 computes ROW's hash value and stores it within the glyph_row
20641 /* Record whether this row ends inside an ellipsis. */
20642 row
->ends_in_ellipsis_p
20643 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20644 && it
->ellipsis_p
);
20646 /* Save fringe bitmaps in this row. */
20647 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20648 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20649 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20650 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20652 it
->left_user_fringe_bitmap
= 0;
20653 it
->left_user_fringe_face_id
= 0;
20654 it
->right_user_fringe_bitmap
= 0;
20655 it
->right_user_fringe_face_id
= 0;
20657 /* Maybe set the cursor. */
20658 cvpos
= it
->w
->cursor
.vpos
;
20660 /* In bidi-reordered rows, keep checking for proper cursor
20661 position even if one has been found already, because buffer
20662 positions in such rows change non-linearly with ROW->VPOS,
20663 when a line is continued. One exception: when we are at ZV,
20664 display cursor on the first suitable glyph row, since all
20665 the empty rows after that also have their position set to ZV. */
20666 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20667 lines' rows is implemented for bidi-reordered rows. */
20669 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20670 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20671 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20672 && cursor_row_p (row
))
20673 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20675 /* Prepare for the next line. This line starts horizontally at (X
20676 HPOS) = (0 0). Vertical positions are incremented. As a
20677 convenience for the caller, IT->glyph_row is set to the next
20679 it
->current_x
= it
->hpos
= 0;
20680 it
->current_y
+= row
->height
;
20681 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20684 /* The next row should by default use the same value of the
20685 reversed_p flag as this one. set_iterator_to_next decides when
20686 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20687 the flag accordingly. */
20688 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20689 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20690 it
->start
= row
->end
;
20691 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20693 #undef RECORD_MAX_MIN_POS
20696 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20697 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20698 doc
: /* Return paragraph direction at point in BUFFER.
20699 Value is either `left-to-right' or `right-to-left'.
20700 If BUFFER is omitted or nil, it defaults to the current buffer.
20702 Paragraph direction determines how the text in the paragraph is displayed.
20703 In left-to-right paragraphs, text begins at the left margin of the window
20704 and the reading direction is generally left to right. In right-to-left
20705 paragraphs, text begins at the right margin and is read from right to left.
20707 See also `bidi-paragraph-direction'. */)
20708 (Lisp_Object buffer
)
20710 struct buffer
*buf
= current_buffer
;
20711 struct buffer
*old
= buf
;
20713 if (! NILP (buffer
))
20715 CHECK_BUFFER (buffer
);
20716 buf
= XBUFFER (buffer
);
20719 if (NILP (BVAR (buf
, bidi_display_reordering
))
20720 || NILP (BVAR (buf
, enable_multibyte_characters
))
20721 /* When we are loading loadup.el, the character property tables
20722 needed for bidi iteration are not yet available. */
20723 || !NILP (Vpurify_flag
))
20724 return Qleft_to_right
;
20725 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20726 return BVAR (buf
, bidi_paragraph_direction
);
20729 /* Determine the direction from buffer text. We could try to
20730 use current_matrix if it is up to date, but this seems fast
20731 enough as it is. */
20732 struct bidi_it itb
;
20733 ptrdiff_t pos
= BUF_PT (buf
);
20734 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20736 void *itb_data
= bidi_shelve_cache ();
20738 set_buffer_temp (buf
);
20739 /* bidi_paragraph_init finds the base direction of the paragraph
20740 by searching forward from paragraph start. We need the base
20741 direction of the current or _previous_ paragraph, so we need
20742 to make sure we are within that paragraph. To that end, find
20743 the previous non-empty line. */
20744 if (pos
>= ZV
&& pos
> BEGV
)
20745 DEC_BOTH (pos
, bytepos
);
20746 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20747 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20749 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20750 || c
== ' ' || c
== '\t' || c
== '\f')
20752 if (bytepos
<= BEGV_BYTE
)
20757 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20760 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20761 itb
.paragraph_dir
= NEUTRAL_DIR
;
20762 itb
.string
.s
= NULL
;
20763 itb
.string
.lstring
= Qnil
;
20764 itb
.string
.bufpos
= 0;
20765 itb
.string
.from_disp_str
= 0;
20766 itb
.string
.unibyte
= 0;
20767 /* We have no window to use here for ignoring window-specific
20768 overlays. Using NULL for window pointer will cause
20769 compute_display_string_pos to use the current buffer. */
20771 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20772 bidi_unshelve_cache (itb_data
, 0);
20773 set_buffer_temp (old
);
20774 switch (itb
.paragraph_dir
)
20777 return Qleft_to_right
;
20780 return Qright_to_left
;
20788 DEFUN ("move-point-visually", Fmove_point_visually
,
20789 Smove_point_visually
, 1, 1, 0,
20790 doc
: /* Move point in the visual order in the specified DIRECTION.
20791 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
20794 Value is the new character position of point. */)
20795 (Lisp_Object direction
)
20797 struct window
*w
= XWINDOW (selected_window
);
20798 struct buffer
*b
= XBUFFER (w
->contents
);
20799 struct glyph_row
*row
;
20801 Lisp_Object paragraph_dir
;
20803 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
20804 (!(ROW)->continued_p \
20805 && INTEGERP ((GLYPH)->object) \
20806 && (GLYPH)->type == CHAR_GLYPH \
20807 && (GLYPH)->u.ch == ' ' \
20808 && (GLYPH)->charpos >= 0 \
20809 && !(GLYPH)->avoid_cursor_p)
20811 CHECK_NUMBER (direction
);
20812 dir
= XINT (direction
);
20818 /* If current matrix is up-to-date, we can use the information
20819 recorded in the glyphs, at least as long as the goal is on the
20821 if (w
->window_end_valid
20822 && !windows_or_buffers_changed
20824 && !b
->clip_changed
20825 && !b
->prevent_redisplay_optimizations_p
20826 && !window_outdated (w
)
20827 /* We rely below on the cursor coordinates to be up to date, but
20828 we cannot trust them if some command moved point since the
20829 last complete redisplay. */
20830 && w
->last_point
== BUF_PT (b
)
20831 && w
->cursor
.vpos
>= 0
20832 && w
->cursor
.vpos
< w
->current_matrix
->nrows
20833 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
20835 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
20836 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
20837 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
20839 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
20841 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
20843 SET_PT (g
->charpos
);
20844 w
->cursor
.vpos
= -1;
20845 return make_number (PT
);
20847 else if (!INTEGERP (g
->object
) && !EQ (g
->object
, gpt
->object
))
20851 if (BUFFERP (gpt
->object
))
20854 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
20855 new_pos
+= (row
->reversed_p
? -dir
: dir
);
20857 new_pos
-= (row
->reversed_p
? -dir
: dir
);;
20859 else if (BUFFERP (g
->object
))
20860 new_pos
= g
->charpos
;
20864 w
->cursor
.vpos
= -1;
20865 return make_number (PT
);
20867 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
20869 /* Glyphs inserted at the end of a non-empty line for
20870 positioning the cursor have zero charpos, so we must
20871 deduce the value of point by other means. */
20872 if (g
->charpos
> 0)
20873 SET_PT (g
->charpos
);
20874 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
20876 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
20877 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
20880 w
->cursor
.vpos
= -1;
20881 return make_number (PT
);
20884 if (g
== e
|| INTEGERP (g
->object
))
20886 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
20887 goto simulate_display
;
20888 if (!row
->reversed_p
)
20892 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
20893 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
20894 goto simulate_display
;
20898 if (row
->reversed_p
&& !row
->continued_p
)
20900 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
20901 w
->cursor
.vpos
= -1;
20902 return make_number (PT
);
20904 g
= row
->glyphs
[TEXT_AREA
];
20905 e
= g
+ row
->used
[TEXT_AREA
];
20906 for ( ; g
< e
; g
++)
20908 if (BUFFERP (g
->object
)
20909 /* Empty lines have only one glyph, which stands
20910 for the newline, and whose charpos is the
20911 buffer position of the newline. */
20912 || ROW_GLYPH_NEWLINE_P (row
, g
)
20913 /* When the buffer ends in a newline, the line at
20914 EOB also has one glyph, but its charpos is -1. */
20915 || (row
->ends_at_zv_p
20916 && !row
->reversed_p
20917 && INTEGERP (g
->object
)
20918 && g
->type
== CHAR_GLYPH
20919 && g
->u
.ch
== ' '))
20921 if (g
->charpos
> 0)
20922 SET_PT (g
->charpos
);
20923 else if (!row
->reversed_p
20924 && row
->ends_at_zv_p
20929 w
->cursor
.vpos
= -1;
20930 return make_number (PT
);
20936 if (!row
->reversed_p
&& !row
->continued_p
)
20938 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
20939 w
->cursor
.vpos
= -1;
20940 return make_number (PT
);
20942 e
= row
->glyphs
[TEXT_AREA
];
20943 g
= e
+ row
->used
[TEXT_AREA
] - 1;
20944 for ( ; g
>= e
; g
--)
20946 if (BUFFERP (g
->object
)
20947 || (ROW_GLYPH_NEWLINE_P (row
, g
)
20949 /* Empty R2L lines on GUI frames have the buffer
20950 position of the newline stored in the stretch
20952 || g
->type
== STRETCH_GLYPH
20953 || (row
->ends_at_zv_p
20955 && INTEGERP (g
->object
)
20956 && g
->type
== CHAR_GLYPH
20957 && g
->u
.ch
== ' '))
20959 if (g
->charpos
> 0)
20960 SET_PT (g
->charpos
);
20961 else if (row
->reversed_p
20962 && row
->ends_at_zv_p
20967 w
->cursor
.vpos
= -1;
20968 return make_number (PT
);
20977 /* If we wind up here, we failed to move by using the glyphs, so we
20978 need to simulate display instead. */
20981 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
20983 paragraph_dir
= Qleft_to_right
;
20984 if (EQ (paragraph_dir
, Qright_to_left
))
20986 if (PT
<= BEGV
&& dir
< 0)
20987 xsignal0 (Qbeginning_of_buffer
);
20988 else if (PT
>= ZV
&& dir
> 0)
20989 xsignal0 (Qend_of_buffer
);
20992 struct text_pos pt
;
20994 int pt_x
, target_x
, pixel_width
, pt_vpos
;
20996 bool overshoot_expected
= false;
20997 bool target_is_eol_p
= false;
20999 /* Setup the arena. */
21000 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21001 start_display (&it
, w
, pt
);
21003 if (it
.cmp_it
.id
< 0
21004 && it
.method
== GET_FROM_STRING
21005 && it
.area
== TEXT_AREA
21006 && it
.string_from_display_prop_p
21007 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21008 overshoot_expected
= true;
21010 /* Find the X coordinate of point. We start from the beginning
21011 of this or previous line to make sure we are before point in
21012 the logical order (since the move_it_* functions can only
21015 reseat_at_previous_visible_line_start (&it
);
21016 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21017 if (IT_CHARPOS (it
) != PT
)
21019 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21020 -1, -1, -1, MOVE_TO_POS
);
21021 /* If we missed point because the character there is
21022 displayed out of a display vector that has more than one
21023 glyph, retry expecting overshoot. */
21024 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21025 && it
.current
.dpvec_index
> 0
21026 && !overshoot_expected
)
21028 overshoot_expected
= true;
21031 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21032 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21034 pt_x
= it
.current_x
;
21036 if (dir
> 0 || overshoot_expected
)
21038 struct glyph_row
*row
= it
.glyph_row
;
21040 /* When point is at beginning of line, we don't have
21041 information about the glyph there loaded into struct
21042 it. Calling get_next_display_element fixes that. */
21044 get_next_display_element (&it
);
21045 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21046 it
.glyph_row
= NULL
;
21047 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21048 it
.glyph_row
= row
;
21049 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21050 it, lest it will become out of sync with it's buffer
21052 it
.current_x
= pt_x
;
21055 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21056 pixel_width
= it
.pixel_width
;
21057 if (overshoot_expected
&& at_eol_p
)
21059 else if (pixel_width
<= 0)
21062 /* If there's a display string (or something similar) at point,
21063 we are actually at the glyph to the left of point, so we need
21064 to correct the X coordinate. */
21065 if (overshoot_expected
)
21068 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21070 pt_x
+= pixel_width
;
21073 /* Compute target X coordinate, either to the left or to the
21074 right of point. On TTY frames, all characters have the same
21075 pixel width of 1, so we can use that. On GUI frames we don't
21076 have an easy way of getting at the pixel width of the
21077 character to the left of point, so we use a different method
21078 of getting to that place. */
21080 target_x
= pt_x
+ pixel_width
;
21082 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21084 /* Target X coordinate could be one line above or below the line
21085 of point, in which case we need to adjust the target X
21086 coordinate. Also, if moving to the left, we need to begin at
21087 the left edge of the point's screen line. */
21092 start_display (&it
, w
, pt
);
21093 reseat_at_previous_visible_line_start (&it
);
21094 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21096 move_it_by_lines (&it
, pt_vpos
);
21100 move_it_by_lines (&it
, -1);
21101 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21102 target_is_eol_p
= true;
21103 /* Under word-wrap, we don't know the x coordinate of
21104 the last character displayed on the previous line,
21105 which immediately precedes the wrap point. To find
21106 out its x coordinate, we try moving to the right
21107 margin of the window, which will stop at the wrap
21108 point, and then reset target_x to point at the
21109 character that precedes the wrap point. This is not
21110 needed on GUI frames, because (see below) there we
21111 move from the left margin one grapheme cluster at a
21112 time, and stop when we hit the wrap point. */
21113 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21115 void *it_data
= NULL
;
21118 SAVE_IT (it2
, it
, it_data
);
21119 move_it_in_display_line_to (&it
, ZV
, target_x
,
21120 MOVE_TO_POS
| MOVE_TO_X
);
21121 /* If we arrived at target_x, that _is_ the last
21122 character on the previous line. */
21123 if (it
.current_x
!= target_x
)
21124 target_x
= it
.current_x
- 1;
21125 RESTORE_IT (&it
, &it2
, it_data
);
21132 || (target_x
>= it
.last_visible_x
21133 && it
.line_wrap
!= TRUNCATE
))
21136 move_it_by_lines (&it
, 0);
21137 move_it_by_lines (&it
, 1);
21142 /* Move to the target X coordinate. */
21143 #ifdef HAVE_WINDOW_SYSTEM
21144 /* On GUI frames, as we don't know the X coordinate of the
21145 character to the left of point, moving point to the left
21146 requires walking, one grapheme cluster at a time, until we
21147 find ourself at a place immediately to the left of the
21148 character at point. */
21149 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21151 struct text_pos new_pos
;
21152 enum move_it_result rc
= MOVE_X_REACHED
;
21154 if (it
.current_x
== 0)
21155 get_next_display_element (&it
);
21156 if (it
.what
== IT_COMPOSITION
)
21158 new_pos
.charpos
= it
.cmp_it
.charpos
;
21159 new_pos
.bytepos
= -1;
21162 new_pos
= it
.current
.pos
;
21164 while (it
.current_x
+ it
.pixel_width
<= target_x
21165 && (rc
== MOVE_X_REACHED
21166 /* Under word-wrap, move_it_in_display_line_to
21167 stops at correct coordinates, but sometimes
21168 returns MOVE_POS_MATCH_OR_ZV. */
21169 || (it
.line_wrap
== WORD_WRAP
21170 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21172 int new_x
= it
.current_x
+ it
.pixel_width
;
21174 /* For composed characters, we want the position of the
21175 first character in the grapheme cluster (usually, the
21176 composition's base character), whereas it.current
21177 might give us the position of the _last_ one, e.g. if
21178 the composition is rendered in reverse due to bidi
21180 if (it
.what
== IT_COMPOSITION
)
21182 new_pos
.charpos
= it
.cmp_it
.charpos
;
21183 new_pos
.bytepos
= -1;
21186 new_pos
= it
.current
.pos
;
21187 if (new_x
== it
.current_x
)
21189 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21190 MOVE_TO_POS
| MOVE_TO_X
);
21191 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21194 /* The previous position we saw in the loop is the one we
21196 if (new_pos
.bytepos
== -1)
21197 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21198 it
.current
.pos
= new_pos
;
21202 if (it
.current_x
!= target_x
)
21203 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21205 /* When lines are truncated, the above loop will stop at the
21206 window edge. But we want to get to the end of line, even if
21207 it is beyond the window edge; automatic hscroll will then
21208 scroll the window to show point as appropriate. */
21209 if (target_is_eol_p
&& it
.line_wrap
== TRUNCATE
21210 && get_next_display_element (&it
))
21212 struct text_pos new_pos
= it
.current
.pos
;
21214 while (!ITERATOR_AT_END_OF_LINE_P (&it
))
21216 set_iterator_to_next (&it
, 0);
21217 if (it
.method
== GET_FROM_BUFFER
)
21218 new_pos
= it
.current
.pos
;
21219 if (!get_next_display_element (&it
))
21223 it
.current
.pos
= new_pos
;
21226 /* If we ended up in a display string that covers point, move to
21227 buffer position to the right in the visual order. */
21230 while (IT_CHARPOS (it
) == PT
)
21232 set_iterator_to_next (&it
, 0);
21233 if (!get_next_display_element (&it
))
21238 /* Move point to that position. */
21239 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21242 return make_number (PT
);
21244 #undef ROW_GLYPH_NEWLINE_P
21248 /***********************************************************************
21250 ***********************************************************************/
21252 /* Redisplay the menu bar in the frame for window W.
21254 The menu bar of X frames that don't have X toolkit support is
21255 displayed in a special window W->frame->menu_bar_window.
21257 The menu bar of terminal frames is treated specially as far as
21258 glyph matrices are concerned. Menu bar lines are not part of
21259 windows, so the update is done directly on the frame matrix rows
21260 for the menu bar. */
21263 display_menu_bar (struct window
*w
)
21265 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21270 /* Don't do all this for graphical frames. */
21272 if (FRAME_W32_P (f
))
21275 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21281 if (FRAME_NS_P (f
))
21283 #endif /* HAVE_NS */
21285 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21286 eassert (!FRAME_WINDOW_P (f
));
21287 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21288 it
.first_visible_x
= 0;
21289 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21290 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21291 if (FRAME_WINDOW_P (f
))
21293 /* Menu bar lines are displayed in the desired matrix of the
21294 dummy window menu_bar_window. */
21295 struct window
*menu_w
;
21296 menu_w
= XWINDOW (f
->menu_bar_window
);
21297 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21299 it
.first_visible_x
= 0;
21300 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21303 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21305 /* This is a TTY frame, i.e. character hpos/vpos are used as
21307 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21309 it
.first_visible_x
= 0;
21310 it
.last_visible_x
= FRAME_COLS (f
);
21313 /* FIXME: This should be controlled by a user option. See the
21314 comments in redisplay_tool_bar and display_mode_line about
21316 it
.paragraph_embedding
= L2R
;
21318 /* Clear all rows of the menu bar. */
21319 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21321 struct glyph_row
*row
= it
.glyph_row
+ i
;
21322 clear_glyph_row (row
);
21323 row
->enabled_p
= true;
21324 row
->full_width_p
= 1;
21327 /* Display all items of the menu bar. */
21328 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21329 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21331 Lisp_Object string
;
21333 /* Stop at nil string. */
21334 string
= AREF (items
, i
+ 1);
21338 /* Remember where item was displayed. */
21339 ASET (items
, i
+ 3, make_number (it
.hpos
));
21341 /* Display the item, pad with one space. */
21342 if (it
.current_x
< it
.last_visible_x
)
21343 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21344 SCHARS (string
) + 1, 0, 0, -1);
21347 /* Fill out the line with spaces. */
21348 if (it
.current_x
< it
.last_visible_x
)
21349 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21351 /* Compute the total height of the lines. */
21352 compute_line_metrics (&it
);
21355 /* Deep copy of a glyph row, including the glyphs. */
21357 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21359 struct glyph
*pointers
[1 + LAST_AREA
];
21360 int to_used
= to
->used
[TEXT_AREA
];
21362 /* Save glyph pointers of TO. */
21363 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21365 /* Do a structure assignment. */
21368 /* Restore original glyph pointers of TO. */
21369 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21371 /* Copy the glyphs. */
21372 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21373 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21375 /* If we filled only part of the TO row, fill the rest with
21376 space_glyph (which will display as empty space). */
21377 if (to_used
> from
->used
[TEXT_AREA
])
21378 fill_up_frame_row_with_spaces (to
, to_used
);
21381 /* Display one menu item on a TTY, by overwriting the glyphs in the
21382 frame F's desired glyph matrix with glyphs produced from the menu
21383 item text. Called from term.c to display TTY drop-down menus one
21386 ITEM_TEXT is the menu item text as a C string.
21388 FACE_ID is the face ID to be used for this menu item. FACE_ID
21389 could specify one of 3 faces: a face for an enabled item, a face
21390 for a disabled item, or a face for a selected item.
21392 X and Y are coordinates of the first glyph in the frame's desired
21393 matrix to be overwritten by the menu item. Since this is a TTY, Y
21394 is the zero-based number of the glyph row and X is the zero-based
21395 glyph number in the row, starting from left, where to start
21396 displaying the item.
21398 SUBMENU non-zero means this menu item drops down a submenu, which
21399 should be indicated by displaying a proper visual cue after the
21403 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21404 int x
, int y
, int submenu
)
21407 struct frame
*f
= SELECTED_FRAME ();
21408 struct window
*w
= XWINDOW (f
->selected_window
);
21409 int saved_used
, saved_truncated
, saved_width
, saved_reversed
;
21410 struct glyph_row
*row
;
21411 size_t item_len
= strlen (item_text
);
21413 eassert (FRAME_TERMCAP_P (f
));
21415 /* Don't write beyond the matrix's last row. This can happen for
21416 TTY screens that are not high enough to show the entire menu.
21417 (This is actually a bit of defensive programming, as
21418 tty_menu_display already limits the number of menu items to one
21419 less than the number of screen lines.) */
21420 if (y
>= f
->desired_matrix
->nrows
)
21423 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21424 it
.first_visible_x
= 0;
21425 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21426 row
= it
.glyph_row
;
21427 /* Start with the row contents from the current matrix. */
21428 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21429 saved_width
= row
->full_width_p
;
21430 row
->full_width_p
= 1;
21431 saved_reversed
= row
->reversed_p
;
21432 row
->reversed_p
= 0;
21433 row
->enabled_p
= true;
21435 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21437 eassert (x
< f
->desired_matrix
->matrix_w
);
21438 it
.current_x
= it
.hpos
= x
;
21439 it
.current_y
= it
.vpos
= y
;
21440 saved_used
= row
->used
[TEXT_AREA
];
21441 saved_truncated
= row
->truncated_on_right_p
;
21442 row
->used
[TEXT_AREA
] = x
;
21443 it
.face_id
= face_id
;
21444 it
.line_wrap
= TRUNCATE
;
21446 /* FIXME: This should be controlled by a user option. See the
21447 comments in redisplay_tool_bar and display_mode_line about this.
21448 Also, if paragraph_embedding could ever be R2L, changes will be
21449 needed to avoid shifting to the right the row characters in
21450 term.c:append_glyph. */
21451 it
.paragraph_embedding
= L2R
;
21453 /* Pad with a space on the left. */
21454 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21456 /* Display the menu item, pad with spaces to WIDTH. */
21459 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21460 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21462 /* Indicate with " >" that there's a submenu. */
21463 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21464 FRAME_COLS (f
) - 1, -1);
21467 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21468 width
, 0, FRAME_COLS (f
) - 1, -1);
21470 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21471 row
->truncated_on_right_p
= saved_truncated
;
21472 row
->hash
= row_hash (row
);
21473 row
->full_width_p
= saved_width
;
21474 row
->reversed_p
= saved_reversed
;
21477 /***********************************************************************
21479 ***********************************************************************/
21481 /* Redisplay mode lines in the window tree whose root is WINDOW. If
21482 FORCE is non-zero, redisplay mode lines unconditionally.
21483 Otherwise, redisplay only mode lines that are garbaged. Value is
21484 the number of windows whose mode lines were redisplayed. */
21487 redisplay_mode_lines (Lisp_Object window
, bool force
)
21491 while (!NILP (window
))
21493 struct window
*w
= XWINDOW (window
);
21495 if (WINDOWP (w
->contents
))
21496 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
21498 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
21499 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
21501 struct text_pos lpoint
;
21502 struct buffer
*old
= current_buffer
;
21504 /* Set the window's buffer for the mode line display. */
21505 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
21506 set_buffer_internal_1 (XBUFFER (w
->contents
));
21508 /* Point refers normally to the selected window. For any
21509 other window, set up appropriate value. */
21510 if (!EQ (window
, selected_window
))
21512 struct text_pos pt
;
21514 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
21515 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
21518 /* Display mode lines. */
21519 clear_glyph_matrix (w
->desired_matrix
);
21520 if (display_mode_lines (w
))
21523 /* Restore old settings. */
21524 set_buffer_internal_1 (old
);
21525 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
21535 /* Display the mode and/or header line of window W. Value is the
21536 sum number of mode lines and header lines displayed. */
21539 display_mode_lines (struct window
*w
)
21541 Lisp_Object old_selected_window
= selected_window
;
21542 Lisp_Object old_selected_frame
= selected_frame
;
21543 Lisp_Object new_frame
= w
->frame
;
21544 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
21547 selected_frame
= new_frame
;
21548 /* FIXME: If we were to allow the mode-line's computation changing the buffer
21549 or window's point, then we'd need select_window_1 here as well. */
21550 XSETWINDOW (selected_window
, w
);
21551 XFRAME (new_frame
)->selected_window
= selected_window
;
21553 /* These will be set while the mode line specs are processed. */
21554 line_number_displayed
= 0;
21555 w
->column_number_displayed
= -1;
21557 if (WINDOW_WANTS_MODELINE_P (w
))
21559 struct window
*sel_w
= XWINDOW (old_selected_window
);
21561 /* Select mode line face based on the real selected window. */
21562 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
21563 BVAR (current_buffer
, mode_line_format
));
21567 if (WINDOW_WANTS_HEADER_LINE_P (w
))
21569 display_mode_line (w
, HEADER_LINE_FACE_ID
,
21570 BVAR (current_buffer
, header_line_format
));
21574 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
21575 selected_frame
= old_selected_frame
;
21576 selected_window
= old_selected_window
;
21578 w
->must_be_updated_p
= true;
21583 /* Display mode or header line of window W. FACE_ID specifies which
21584 line to display; it is either MODE_LINE_FACE_ID or
21585 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
21586 display. Value is the pixel height of the mode/header line
21590 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
21594 ptrdiff_t count
= SPECPDL_INDEX ();
21596 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21597 /* Don't extend on a previously drawn mode-line.
21598 This may happen if called from pos_visible_p. */
21599 it
.glyph_row
->enabled_p
= false;
21600 prepare_desired_row (w
, it
.glyph_row
, true);
21602 it
.glyph_row
->mode_line_p
= 1;
21604 /* FIXME: This should be controlled by a user option. But
21605 supporting such an option is not trivial, since the mode line is
21606 made up of many separate strings. */
21607 it
.paragraph_embedding
= L2R
;
21609 record_unwind_protect (unwind_format_mode_line
,
21610 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
21612 mode_line_target
= MODE_LINE_DISPLAY
;
21614 /* Temporarily make frame's keyboard the current kboard so that
21615 kboard-local variables in the mode_line_format will get the right
21617 push_kboard (FRAME_KBOARD (it
.f
));
21618 record_unwind_save_match_data ();
21619 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21622 unbind_to (count
, Qnil
);
21624 /* Fill up with spaces. */
21625 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
21627 compute_line_metrics (&it
);
21628 it
.glyph_row
->full_width_p
= 1;
21629 it
.glyph_row
->continued_p
= 0;
21630 it
.glyph_row
->truncated_on_left_p
= 0;
21631 it
.glyph_row
->truncated_on_right_p
= 0;
21633 /* Make a 3D mode-line have a shadow at its right end. */
21634 face
= FACE_FROM_ID (it
.f
, face_id
);
21635 extend_face_to_end_of_line (&it
);
21636 if (face
->box
!= FACE_NO_BOX
)
21638 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
21639 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
21640 last
->right_box_line_p
= 1;
21643 return it
.glyph_row
->height
;
21646 /* Move element ELT in LIST to the front of LIST.
21647 Return the updated list. */
21650 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
21652 register Lisp_Object tail
, prev
;
21653 register Lisp_Object tem
;
21657 while (CONSP (tail
))
21663 /* Splice out the link TAIL. */
21665 list
= XCDR (tail
);
21667 Fsetcdr (prev
, XCDR (tail
));
21669 /* Now make it the first. */
21670 Fsetcdr (tail
, list
);
21675 tail
= XCDR (tail
);
21679 /* Not found--return unchanged LIST. */
21683 /* Contribute ELT to the mode line for window IT->w. How it
21684 translates into text depends on its data type.
21686 IT describes the display environment in which we display, as usual.
21688 DEPTH is the depth in recursion. It is used to prevent
21689 infinite recursion here.
21691 FIELD_WIDTH is the number of characters the display of ELT should
21692 occupy in the mode line, and PRECISION is the maximum number of
21693 characters to display from ELT's representation. See
21694 display_string for details.
21696 Returns the hpos of the end of the text generated by ELT.
21698 PROPS is a property list to add to any string we encounter.
21700 If RISKY is nonzero, remove (disregard) any properties in any string
21701 we encounter, and ignore :eval and :propertize.
21703 The global variable `mode_line_target' determines whether the
21704 output is passed to `store_mode_line_noprop',
21705 `store_mode_line_string', or `display_string'. */
21708 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
21709 Lisp_Object elt
, Lisp_Object props
, int risky
)
21711 int n
= 0, field
, prec
;
21716 elt
= build_string ("*too-deep*");
21720 switch (XTYPE (elt
))
21724 /* A string: output it and check for %-constructs within it. */
21726 ptrdiff_t offset
= 0;
21728 if (SCHARS (elt
) > 0
21729 && (!NILP (props
) || risky
))
21731 Lisp_Object oprops
, aelt
;
21732 oprops
= Ftext_properties_at (make_number (0), elt
);
21734 /* If the starting string's properties are not what
21735 we want, translate the string. Also, if the string
21736 is risky, do that anyway. */
21738 if (NILP (Fequal (props
, oprops
)) || risky
)
21740 /* If the starting string has properties,
21741 merge the specified ones onto the existing ones. */
21742 if (! NILP (oprops
) && !risky
)
21746 oprops
= Fcopy_sequence (oprops
);
21748 while (CONSP (tem
))
21750 oprops
= Fplist_put (oprops
, XCAR (tem
),
21751 XCAR (XCDR (tem
)));
21752 tem
= XCDR (XCDR (tem
));
21757 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
21758 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
21760 /* AELT is what we want. Move it to the front
21761 without consing. */
21763 mode_line_proptrans_alist
21764 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
21770 /* If AELT has the wrong props, it is useless.
21771 so get rid of it. */
21773 mode_line_proptrans_alist
21774 = Fdelq (aelt
, mode_line_proptrans_alist
);
21776 elt
= Fcopy_sequence (elt
);
21777 Fset_text_properties (make_number (0), Flength (elt
),
21779 /* Add this item to mode_line_proptrans_alist. */
21780 mode_line_proptrans_alist
21781 = Fcons (Fcons (elt
, props
),
21782 mode_line_proptrans_alist
);
21783 /* Truncate mode_line_proptrans_alist
21784 to at most 50 elements. */
21785 tem
= Fnthcdr (make_number (50),
21786 mode_line_proptrans_alist
);
21788 XSETCDR (tem
, Qnil
);
21797 prec
= precision
- n
;
21798 switch (mode_line_target
)
21800 case MODE_LINE_NOPROP
:
21801 case MODE_LINE_TITLE
:
21802 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
21804 case MODE_LINE_STRING
:
21805 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
21807 case MODE_LINE_DISPLAY
:
21808 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
21809 0, prec
, 0, STRING_MULTIBYTE (elt
));
21816 /* Handle the non-literal case. */
21818 while ((precision
<= 0 || n
< precision
)
21819 && SREF (elt
, offset
) != 0
21820 && (mode_line_target
!= MODE_LINE_DISPLAY
21821 || it
->current_x
< it
->last_visible_x
))
21823 ptrdiff_t last_offset
= offset
;
21825 /* Advance to end of string or next format specifier. */
21826 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
21829 if (offset
- 1 != last_offset
)
21831 ptrdiff_t nchars
, nbytes
;
21833 /* Output to end of string or up to '%'. Field width
21834 is length of string. Don't output more than
21835 PRECISION allows us. */
21838 prec
= c_string_width (SDATA (elt
) + last_offset
,
21839 offset
- last_offset
, precision
- n
,
21842 switch (mode_line_target
)
21844 case MODE_LINE_NOPROP
:
21845 case MODE_LINE_TITLE
:
21846 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
21848 case MODE_LINE_STRING
:
21850 ptrdiff_t bytepos
= last_offset
;
21851 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
21852 ptrdiff_t endpos
= (precision
<= 0
21853 ? string_byte_to_char (elt
, offset
)
21854 : charpos
+ nchars
);
21856 n
+= store_mode_line_string (NULL
,
21857 Fsubstring (elt
, make_number (charpos
),
21858 make_number (endpos
)),
21862 case MODE_LINE_DISPLAY
:
21864 ptrdiff_t bytepos
= last_offset
;
21865 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
21867 if (precision
<= 0)
21868 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
21869 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
21871 STRING_MULTIBYTE (elt
));
21876 else /* c == '%' */
21878 ptrdiff_t percent_position
= offset
;
21880 /* Get the specified minimum width. Zero means
21883 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
21884 field
= field
* 10 + c
- '0';
21886 /* Don't pad beyond the total padding allowed. */
21887 if (field_width
- n
> 0 && field
> field_width
- n
)
21888 field
= field_width
- n
;
21890 /* Note that either PRECISION <= 0 or N < PRECISION. */
21891 prec
= precision
- n
;
21894 n
+= display_mode_element (it
, depth
, field
, prec
,
21895 Vglobal_mode_string
, props
,
21900 ptrdiff_t bytepos
, charpos
;
21902 Lisp_Object string
;
21904 bytepos
= percent_position
;
21905 charpos
= (STRING_MULTIBYTE (elt
)
21906 ? string_byte_to_char (elt
, bytepos
)
21908 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
21909 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
21911 switch (mode_line_target
)
21913 case MODE_LINE_NOPROP
:
21914 case MODE_LINE_TITLE
:
21915 n
+= store_mode_line_noprop (spec
, field
, prec
);
21917 case MODE_LINE_STRING
:
21919 Lisp_Object tem
= build_string (spec
);
21920 props
= Ftext_properties_at (make_number (charpos
), elt
);
21921 /* Should only keep face property in props */
21922 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
21925 case MODE_LINE_DISPLAY
:
21927 int nglyphs_before
, nwritten
;
21929 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
21930 nwritten
= display_string (spec
, string
, elt
,
21935 /* Assign to the glyphs written above the
21936 string where the `%x' came from, position
21940 struct glyph
*glyph
21941 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
21945 for (i
= 0; i
< nwritten
; ++i
)
21947 glyph
[i
].object
= elt
;
21948 glyph
[i
].charpos
= charpos
;
21965 /* A symbol: process the value of the symbol recursively
21966 as if it appeared here directly. Avoid error if symbol void.
21967 Special case: if value of symbol is a string, output the string
21970 register Lisp_Object tem
;
21972 /* If the variable is not marked as risky to set
21973 then its contents are risky to use. */
21974 if (NILP (Fget (elt
, Qrisky_local_variable
)))
21977 tem
= Fboundp (elt
);
21980 tem
= Fsymbol_value (elt
);
21981 /* If value is a string, output that string literally:
21982 don't check for % within it. */
21986 if (!EQ (tem
, elt
))
21988 /* Give up right away for nil or t. */
21998 register Lisp_Object car
, tem
;
22000 /* A cons cell: five distinct cases.
22001 If first element is :eval or :propertize, do something special.
22002 If first element is a string or a cons, process all the elements
22003 and effectively concatenate them.
22004 If first element is a negative number, truncate displaying cdr to
22005 at most that many characters. If positive, pad (with spaces)
22006 to at least that many characters.
22007 If first element is a symbol, process the cadr or caddr recursively
22008 according to whether the symbol's value is non-nil or nil. */
22010 if (EQ (car
, QCeval
))
22012 /* An element of the form (:eval FORM) means evaluate FORM
22013 and use the result as mode line elements. */
22018 if (CONSP (XCDR (elt
)))
22021 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22022 n
+= display_mode_element (it
, depth
, field_width
- n
,
22023 precision
- n
, spec
, props
,
22027 else if (EQ (car
, QCpropertize
))
22029 /* An element of the form (:propertize ELT PROPS...)
22030 means display ELT but applying properties PROPS. */
22035 if (CONSP (XCDR (elt
)))
22036 n
+= display_mode_element (it
, depth
, field_width
- n
,
22037 precision
- n
, XCAR (XCDR (elt
)),
22038 XCDR (XCDR (elt
)), risky
);
22040 else if (SYMBOLP (car
))
22042 tem
= Fboundp (car
);
22046 /* elt is now the cdr, and we know it is a cons cell.
22047 Use its car if CAR has a non-nil value. */
22050 tem
= Fsymbol_value (car
);
22057 /* Symbol's value is nil (or symbol is unbound)
22058 Get the cddr of the original list
22059 and if possible find the caddr and use that. */
22063 else if (!CONSP (elt
))
22068 else if (INTEGERP (car
))
22070 register int lim
= XINT (car
);
22074 /* Negative int means reduce maximum width. */
22075 if (precision
<= 0)
22078 precision
= min (precision
, -lim
);
22082 /* Padding specified. Don't let it be more than
22083 current maximum. */
22085 lim
= min (precision
, lim
);
22087 /* If that's more padding than already wanted, queue it.
22088 But don't reduce padding already specified even if
22089 that is beyond the current truncation point. */
22090 field_width
= max (lim
, field_width
);
22094 else if (STRINGP (car
) || CONSP (car
))
22096 Lisp_Object halftail
= elt
;
22100 && (precision
<= 0 || n
< precision
))
22102 n
+= display_mode_element (it
, depth
,
22103 /* Do padding only after the last
22104 element in the list. */
22105 (! CONSP (XCDR (elt
))
22108 precision
- n
, XCAR (elt
),
22112 if ((len
& 1) == 0)
22113 halftail
= XCDR (halftail
);
22114 /* Check for cycle. */
22115 if (EQ (halftail
, elt
))
22124 elt
= build_string ("*invalid*");
22128 /* Pad to FIELD_WIDTH. */
22129 if (field_width
> 0 && n
< field_width
)
22131 switch (mode_line_target
)
22133 case MODE_LINE_NOPROP
:
22134 case MODE_LINE_TITLE
:
22135 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22137 case MODE_LINE_STRING
:
22138 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
22140 case MODE_LINE_DISPLAY
:
22141 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22150 /* Store a mode-line string element in mode_line_string_list.
22152 If STRING is non-null, display that C string. Otherwise, the Lisp
22153 string LISP_STRING is displayed.
22155 FIELD_WIDTH is the minimum number of output glyphs to produce.
22156 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22157 with spaces. FIELD_WIDTH <= 0 means don't pad.
22159 PRECISION is the maximum number of characters to output from
22160 STRING. PRECISION <= 0 means don't truncate the string.
22162 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
22163 properties to the string.
22165 PROPS are the properties to add to the string.
22166 The mode_line_string_face face property is always added to the string.
22170 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
22171 int field_width
, int precision
, Lisp_Object props
)
22176 if (string
!= NULL
)
22178 len
= strlen (string
);
22179 if (precision
> 0 && len
> precision
)
22181 lisp_string
= make_string (string
, len
);
22183 props
= mode_line_string_face_prop
;
22184 else if (!NILP (mode_line_string_face
))
22186 Lisp_Object face
= Fplist_get (props
, Qface
);
22187 props
= Fcopy_sequence (props
);
22189 face
= mode_line_string_face
;
22191 face
= list2 (face
, mode_line_string_face
);
22192 props
= Fplist_put (props
, Qface
, face
);
22194 Fadd_text_properties (make_number (0), make_number (len
),
22195 props
, lisp_string
);
22199 len
= XFASTINT (Flength (lisp_string
));
22200 if (precision
> 0 && len
> precision
)
22203 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22206 if (!NILP (mode_line_string_face
))
22210 props
= Ftext_properties_at (make_number (0), lisp_string
);
22211 face
= Fplist_get (props
, Qface
);
22213 face
= mode_line_string_face
;
22215 face
= list2 (face
, mode_line_string_face
);
22216 props
= list2 (Qface
, face
);
22218 lisp_string
= Fcopy_sequence (lisp_string
);
22221 Fadd_text_properties (make_number (0), make_number (len
),
22222 props
, lisp_string
);
22227 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22231 if (field_width
> len
)
22233 field_width
-= len
;
22234 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22236 Fadd_text_properties (make_number (0), make_number (field_width
),
22237 props
, lisp_string
);
22238 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22246 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22248 doc
: /* Format a string out of a mode line format specification.
22249 First arg FORMAT specifies the mode line format (see `mode-line-format'
22250 for details) to use.
22252 By default, the format is evaluated for the currently selected window.
22254 Optional second arg FACE specifies the face property to put on all
22255 characters for which no face is specified. The value nil means the
22256 default face. The value t means whatever face the window's mode line
22257 currently uses (either `mode-line' or `mode-line-inactive',
22258 depending on whether the window is the selected window or not).
22259 An integer value means the value string has no text
22262 Optional third and fourth args WINDOW and BUFFER specify the window
22263 and buffer to use as the context for the formatting (defaults
22264 are the selected window and the WINDOW's buffer). */)
22265 (Lisp_Object format
, Lisp_Object face
,
22266 Lisp_Object window
, Lisp_Object buffer
)
22271 struct buffer
*old_buffer
= NULL
;
22273 int no_props
= INTEGERP (face
);
22274 ptrdiff_t count
= SPECPDL_INDEX ();
22276 int string_start
= 0;
22278 w
= decode_any_window (window
);
22279 XSETWINDOW (window
, w
);
22282 buffer
= w
->contents
;
22283 CHECK_BUFFER (buffer
);
22285 /* Make formatting the modeline a non-op when noninteractive, otherwise
22286 there will be problems later caused by a partially initialized frame. */
22287 if (NILP (format
) || noninteractive
)
22288 return empty_unibyte_string
;
22293 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22294 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22295 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22296 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22297 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22298 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22299 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22302 old_buffer
= current_buffer
;
22304 /* Save things including mode_line_proptrans_alist,
22305 and set that to nil so that we don't alter the outer value. */
22306 record_unwind_protect (unwind_format_mode_line
,
22307 format_mode_line_unwind_data
22308 (XFRAME (WINDOW_FRAME (w
)),
22309 old_buffer
, selected_window
, 1));
22310 mode_line_proptrans_alist
= Qnil
;
22312 Fselect_window (window
, Qt
);
22313 set_buffer_internal_1 (XBUFFER (buffer
));
22315 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22319 mode_line_target
= MODE_LINE_NOPROP
;
22320 mode_line_string_face_prop
= Qnil
;
22321 mode_line_string_list
= Qnil
;
22322 string_start
= MODE_LINE_NOPROP_LEN (0);
22326 mode_line_target
= MODE_LINE_STRING
;
22327 mode_line_string_list
= Qnil
;
22328 mode_line_string_face
= face
;
22329 mode_line_string_face_prop
22330 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22333 push_kboard (FRAME_KBOARD (it
.f
));
22334 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
22339 len
= MODE_LINE_NOPROP_LEN (string_start
);
22340 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22344 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22345 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
22346 empty_unibyte_string
);
22349 unbind_to (count
, Qnil
);
22353 /* Write a null-terminated, right justified decimal representation of
22354 the positive integer D to BUF using a minimal field width WIDTH. */
22357 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22359 register char *p
= buf
;
22367 *p
++ = d
% 10 + '0';
22372 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22383 /* Write a null-terminated, right justified decimal and "human
22384 readable" representation of the nonnegative integer D to BUF using
22385 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22387 static const char power_letter
[] =
22401 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22403 /* We aim to represent the nonnegative integer D as
22404 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22405 ptrdiff_t quotient
= d
;
22407 /* -1 means: do not use TENTHS. */
22411 /* Length of QUOTIENT.TENTHS as a string. */
22417 if (quotient
>= 1000)
22419 /* Scale to the appropriate EXPONENT. */
22422 remainder
= quotient
% 1000;
22426 while (quotient
>= 1000);
22428 /* Round to nearest and decide whether to use TENTHS or not. */
22431 tenths
= remainder
/ 100;
22432 if (remainder
% 100 >= 50)
22439 if (quotient
== 10)
22447 if (remainder
>= 500)
22449 if (quotient
< 999)
22460 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22461 if (tenths
== -1 && quotient
<= 99)
22468 p
= psuffix
= buf
+ max (width
, length
);
22470 /* Print EXPONENT. */
22471 *psuffix
++ = power_letter
[exponent
];
22474 /* Print TENTHS. */
22477 *--p
= '0' + tenths
;
22481 /* Print QUOTIENT. */
22484 int digit
= quotient
% 10;
22485 *--p
= '0' + digit
;
22487 while ((quotient
/= 10) != 0);
22489 /* Print leading spaces. */
22494 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22495 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
22496 type of CODING_SYSTEM. Return updated pointer into BUF. */
22498 static unsigned char invalid_eol_type
[] = "(*invalid*)";
22501 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
22504 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
22505 const unsigned char *eol_str
;
22507 /* The EOL conversion we are using. */
22508 Lisp_Object eoltype
;
22510 val
= CODING_SYSTEM_SPEC (coding_system
);
22513 if (!VECTORP (val
)) /* Not yet decided. */
22515 *buf
++ = multibyte
? '-' : ' ';
22517 eoltype
= eol_mnemonic_undecided
;
22518 /* Don't mention EOL conversion if it isn't decided. */
22523 Lisp_Object eolvalue
;
22525 attrs
= AREF (val
, 0);
22526 eolvalue
= AREF (val
, 2);
22529 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
22534 /* The EOL conversion that is normal on this system. */
22536 if (NILP (eolvalue
)) /* Not yet decided. */
22537 eoltype
= eol_mnemonic_undecided
;
22538 else if (VECTORP (eolvalue
)) /* Not yet decided. */
22539 eoltype
= eol_mnemonic_undecided
;
22540 else /* eolvalue is Qunix, Qdos, or Qmac. */
22541 eoltype
= (EQ (eolvalue
, Qunix
)
22542 ? eol_mnemonic_unix
22543 : (EQ (eolvalue
, Qdos
) == 1
22544 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
22550 /* Mention the EOL conversion if it is not the usual one. */
22551 if (STRINGP (eoltype
))
22553 eol_str
= SDATA (eoltype
);
22554 eol_str_len
= SBYTES (eoltype
);
22556 else if (CHARACTERP (eoltype
))
22558 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
22559 int c
= XFASTINT (eoltype
);
22560 eol_str_len
= CHAR_STRING (c
, tmp
);
22565 eol_str
= invalid_eol_type
;
22566 eol_str_len
= sizeof (invalid_eol_type
) - 1;
22568 memcpy (buf
, eol_str
, eol_str_len
);
22569 buf
+= eol_str_len
;
22575 /* Return a string for the output of a mode line %-spec for window W,
22576 generated by character C. FIELD_WIDTH > 0 means pad the string
22577 returned with spaces to that value. Return a Lisp string in
22578 *STRING if the resulting string is taken from that Lisp string.
22580 Note we operate on the current buffer for most purposes. */
22582 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
22584 static const char *
22585 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
22586 Lisp_Object
*string
)
22589 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22590 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
22591 /* We are going to use f->decode_mode_spec_buffer as the buffer to
22592 produce strings from numerical values, so limit preposterously
22593 large values of FIELD_WIDTH to avoid overrunning the buffer's
22594 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
22595 bytes plus the terminating null. */
22596 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
22597 struct buffer
*b
= current_buffer
;
22605 if (!NILP (BVAR (b
, read_only
)))
22607 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22612 /* This differs from %* only for a modified read-only buffer. */
22613 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22615 if (!NILP (BVAR (b
, read_only
)))
22620 /* This differs from %* in ignoring read-only-ness. */
22621 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22633 if (command_loop_level
> 5)
22635 p
= decode_mode_spec_buf
;
22636 for (i
= 0; i
< command_loop_level
; i
++)
22639 return decode_mode_spec_buf
;
22647 if (command_loop_level
> 5)
22649 p
= decode_mode_spec_buf
;
22650 for (i
= 0; i
< command_loop_level
; i
++)
22653 return decode_mode_spec_buf
;
22660 /* Let lots_of_dashes be a string of infinite length. */
22661 if (mode_line_target
== MODE_LINE_NOPROP
22662 || mode_line_target
== MODE_LINE_STRING
)
22664 if (field_width
<= 0
22665 || field_width
> sizeof (lots_of_dashes
))
22667 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
22668 decode_mode_spec_buf
[i
] = '-';
22669 decode_mode_spec_buf
[i
] = '\0';
22670 return decode_mode_spec_buf
;
22673 return lots_of_dashes
;
22677 obj
= BVAR (b
, name
);
22681 /* %c and %l are ignored in `frame-title-format'.
22682 (In redisplay_internal, the frame title is drawn _before_ the
22683 windows are updated, so the stuff which depends on actual
22684 window contents (such as %l) may fail to render properly, or
22685 even crash emacs.) */
22686 if (mode_line_target
== MODE_LINE_TITLE
)
22690 ptrdiff_t col
= current_column ();
22691 w
->column_number_displayed
= col
;
22692 pint2str (decode_mode_spec_buf
, width
, col
);
22693 return decode_mode_spec_buf
;
22697 #ifndef SYSTEM_MALLOC
22699 if (NILP (Vmemory_full
))
22702 return "!MEM FULL! ";
22709 /* %F displays the frame name. */
22710 if (!NILP (f
->title
))
22711 return SSDATA (f
->title
);
22712 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
22713 return SSDATA (f
->name
);
22717 obj
= BVAR (b
, filename
);
22722 ptrdiff_t size
= ZV
- BEGV
;
22723 pint2str (decode_mode_spec_buf
, width
, size
);
22724 return decode_mode_spec_buf
;
22729 ptrdiff_t size
= ZV
- BEGV
;
22730 pint2hrstr (decode_mode_spec_buf
, width
, size
);
22731 return decode_mode_spec_buf
;
22736 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
22737 ptrdiff_t topline
, nlines
, height
;
22740 /* %c and %l are ignored in `frame-title-format'. */
22741 if (mode_line_target
== MODE_LINE_TITLE
)
22744 startpos
= marker_position (w
->start
);
22745 startpos_byte
= marker_byte_position (w
->start
);
22746 height
= WINDOW_TOTAL_LINES (w
);
22748 /* If we decided that this buffer isn't suitable for line numbers,
22749 don't forget that too fast. */
22750 if (w
->base_line_pos
== -1)
22753 /* If the buffer is very big, don't waste time. */
22754 if (INTEGERP (Vline_number_display_limit
)
22755 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
22757 w
->base_line_pos
= 0;
22758 w
->base_line_number
= 0;
22762 if (w
->base_line_number
> 0
22763 && w
->base_line_pos
> 0
22764 && w
->base_line_pos
<= startpos
)
22766 line
= w
->base_line_number
;
22767 linepos
= w
->base_line_pos
;
22768 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
22773 linepos
= BUF_BEGV (b
);
22774 linepos_byte
= BUF_BEGV_BYTE (b
);
22777 /* Count lines from base line to window start position. */
22778 nlines
= display_count_lines (linepos_byte
,
22782 topline
= nlines
+ line
;
22784 /* Determine a new base line, if the old one is too close
22785 or too far away, or if we did not have one.
22786 "Too close" means it's plausible a scroll-down would
22787 go back past it. */
22788 if (startpos
== BUF_BEGV (b
))
22790 w
->base_line_number
= topline
;
22791 w
->base_line_pos
= BUF_BEGV (b
);
22793 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
22794 || linepos
== BUF_BEGV (b
))
22796 ptrdiff_t limit
= BUF_BEGV (b
);
22797 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
22798 ptrdiff_t position
;
22799 ptrdiff_t distance
=
22800 (height
* 2 + 30) * line_number_display_limit_width
;
22802 if (startpos
- distance
> limit
)
22804 limit
= startpos
- distance
;
22805 limit_byte
= CHAR_TO_BYTE (limit
);
22808 nlines
= display_count_lines (startpos_byte
,
22810 - (height
* 2 + 30),
22812 /* If we couldn't find the lines we wanted within
22813 line_number_display_limit_width chars per line,
22814 give up on line numbers for this window. */
22815 if (position
== limit_byte
&& limit
== startpos
- distance
)
22817 w
->base_line_pos
= -1;
22818 w
->base_line_number
= 0;
22822 w
->base_line_number
= topline
- nlines
;
22823 w
->base_line_pos
= BYTE_TO_CHAR (position
);
22826 /* Now count lines from the start pos to point. */
22827 nlines
= display_count_lines (startpos_byte
,
22828 PT_BYTE
, PT
, &junk
);
22830 /* Record that we did display the line number. */
22831 line_number_displayed
= 1;
22833 /* Make the string to show. */
22834 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
22835 return decode_mode_spec_buf
;
22838 char* p
= decode_mode_spec_buf
;
22839 int pad
= width
- 2;
22845 return decode_mode_spec_buf
;
22851 obj
= BVAR (b
, mode_name
);
22855 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
22861 ptrdiff_t pos
= marker_position (w
->start
);
22862 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
22864 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
22866 if (pos
<= BUF_BEGV (b
))
22871 else if (pos
<= BUF_BEGV (b
))
22875 if (total
> 1000000)
22876 /* Do it differently for a large value, to avoid overflow. */
22877 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
22879 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
22880 /* We can't normally display a 3-digit number,
22881 so get us a 2-digit number that is close. */
22884 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
22885 return decode_mode_spec_buf
;
22889 /* Display percentage of size above the bottom of the screen. */
22892 ptrdiff_t toppos
= marker_position (w
->start
);
22893 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
22894 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
22896 if (botpos
>= BUF_ZV (b
))
22898 if (toppos
<= BUF_BEGV (b
))
22905 if (total
> 1000000)
22906 /* Do it differently for a large value, to avoid overflow. */
22907 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
22909 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
22910 /* We can't normally display a 3-digit number,
22911 so get us a 2-digit number that is close. */
22914 if (toppos
<= BUF_BEGV (b
))
22915 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
22917 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
22918 return decode_mode_spec_buf
;
22923 /* status of process */
22924 obj
= Fget_buffer_process (Fcurrent_buffer ());
22926 return "no process";
22928 obj
= Fsymbol_name (Fprocess_status (obj
));
22934 ptrdiff_t count
= inhibit_garbage_collection ();
22935 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
22936 Lisp_Object val
= Qnil
;
22938 if (STRINGP (curdir
))
22939 val
= call1 (intern ("file-remote-p"), curdir
);
22941 unbind_to (count
, Qnil
);
22950 /* coding-system (not including end-of-line format) */
22952 /* coding-system (including end-of-line type) */
22954 int eol_flag
= (c
== 'Z');
22955 char *p
= decode_mode_spec_buf
;
22957 if (! FRAME_WINDOW_P (f
))
22959 /* No need to mention EOL here--the terminal never needs
22960 to do EOL conversion. */
22961 p
= decode_mode_spec_coding (CODING_ID_NAME
22962 (FRAME_KEYBOARD_CODING (f
)->id
),
22964 p
= decode_mode_spec_coding (CODING_ID_NAME
22965 (FRAME_TERMINAL_CODING (f
)->id
),
22968 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
22971 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
22972 #ifdef subprocesses
22973 obj
= Fget_buffer_process (Fcurrent_buffer ());
22974 if (PROCESSP (obj
))
22976 p
= decode_mode_spec_coding
22977 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
22978 p
= decode_mode_spec_coding
22979 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
22981 #endif /* subprocesses */
22984 return decode_mode_spec_buf
;
22991 return SSDATA (obj
);
22998 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
22999 means count lines back from START_BYTE. But don't go beyond
23000 LIMIT_BYTE. Return the number of lines thus found (always
23003 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23004 either the position COUNT lines after/before START_BYTE, if we
23005 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23009 display_count_lines (ptrdiff_t start_byte
,
23010 ptrdiff_t limit_byte
, ptrdiff_t count
,
23011 ptrdiff_t *byte_pos_ptr
)
23013 register unsigned char *cursor
;
23014 unsigned char *base
;
23016 register ptrdiff_t ceiling
;
23017 register unsigned char *ceiling_addr
;
23018 ptrdiff_t orig_count
= count
;
23020 /* If we are not in selective display mode,
23021 check only for newlines. */
23022 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
23023 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23027 while (start_byte
< limit_byte
)
23029 ceiling
= BUFFER_CEILING_OF (start_byte
);
23030 ceiling
= min (limit_byte
- 1, ceiling
);
23031 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23032 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23036 if (selective_display
)
23038 while (*cursor
!= '\n' && *cursor
!= 015
23039 && ++cursor
!= ceiling_addr
)
23041 if (cursor
== ceiling_addr
)
23046 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23055 start_byte
+= cursor
- base
;
23056 *byte_pos_ptr
= start_byte
;
23060 while (cursor
< ceiling_addr
);
23062 start_byte
+= ceiling_addr
- base
;
23067 while (start_byte
> limit_byte
)
23069 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23070 ceiling
= max (limit_byte
, ceiling
);
23071 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23072 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23075 if (selective_display
)
23077 while (--cursor
>= ceiling_addr
23078 && *cursor
!= '\n' && *cursor
!= 015)
23080 if (cursor
< ceiling_addr
)
23085 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23092 start_byte
+= cursor
- base
+ 1;
23093 *byte_pos_ptr
= start_byte
;
23094 /* When scanning backwards, we should
23095 not count the newline posterior to which we stop. */
23096 return - orig_count
- 1;
23099 start_byte
+= ceiling_addr
- base
;
23103 *byte_pos_ptr
= limit_byte
;
23106 return - orig_count
+ count
;
23107 return orig_count
- count
;
23113 /***********************************************************************
23115 ***********************************************************************/
23117 /* Display a NUL-terminated string, starting with index START.
23119 If STRING is non-null, display that C string. Otherwise, the Lisp
23120 string LISP_STRING is displayed. There's a case that STRING is
23121 non-null and LISP_STRING is not nil. It means STRING is a string
23122 data of LISP_STRING. In that case, we display LISP_STRING while
23123 ignoring its text properties.
23125 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23126 FACE_STRING. Display STRING or LISP_STRING with the face at
23127 FACE_STRING_POS in FACE_STRING:
23129 Display the string in the environment given by IT, but use the
23130 standard display table, temporarily.
23132 FIELD_WIDTH is the minimum number of output glyphs to produce.
23133 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23134 with spaces. If STRING has more characters, more than FIELD_WIDTH
23135 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23137 PRECISION is the maximum number of characters to output from
23138 STRING. PRECISION < 0 means don't truncate the string.
23140 This is roughly equivalent to printf format specifiers:
23142 FIELD_WIDTH PRECISION PRINTF
23143 ----------------------------------------
23149 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23150 display them, and < 0 means obey the current buffer's value of
23151 enable_multibyte_characters.
23153 Value is the number of columns displayed. */
23156 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23157 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23158 int field_width
, int precision
, int max_x
, int multibyte
)
23160 int hpos_at_start
= it
->hpos
;
23161 int saved_face_id
= it
->face_id
;
23162 struct glyph_row
*row
= it
->glyph_row
;
23163 ptrdiff_t it_charpos
;
23165 /* Initialize the iterator IT for iteration over STRING beginning
23166 with index START. */
23167 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23168 precision
, field_width
, multibyte
);
23169 if (string
&& STRINGP (lisp_string
))
23170 /* LISP_STRING is the one returned by decode_mode_spec. We should
23171 ignore its text properties. */
23172 it
->stop_charpos
= it
->end_charpos
;
23174 /* If displaying STRING, set up the face of the iterator from
23175 FACE_STRING, if that's given. */
23176 if (STRINGP (face_string
))
23182 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23183 0, &endptr
, it
->base_face_id
, 0);
23184 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23185 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23188 /* Set max_x to the maximum allowed X position. Don't let it go
23189 beyond the right edge of the window. */
23191 max_x
= it
->last_visible_x
;
23193 max_x
= min (max_x
, it
->last_visible_x
);
23195 /* Skip over display elements that are not visible. because IT->w is
23197 if (it
->current_x
< it
->first_visible_x
)
23198 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23199 MOVE_TO_POS
| MOVE_TO_X
);
23201 row
->ascent
= it
->max_ascent
;
23202 row
->height
= it
->max_ascent
+ it
->max_descent
;
23203 row
->phys_ascent
= it
->max_phys_ascent
;
23204 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23205 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23207 if (STRINGP (it
->string
))
23208 it_charpos
= IT_STRING_CHARPOS (*it
);
23210 it_charpos
= IT_CHARPOS (*it
);
23212 /* This condition is for the case that we are called with current_x
23213 past last_visible_x. */
23214 while (it
->current_x
< max_x
)
23216 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23218 /* Get the next display element. */
23219 if (!get_next_display_element (it
))
23222 /* Produce glyphs. */
23223 x_before
= it
->current_x
;
23224 n_glyphs_before
= row
->used
[TEXT_AREA
];
23225 PRODUCE_GLYPHS (it
);
23227 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23230 while (i
< nglyphs
)
23232 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23234 if (it
->line_wrap
!= TRUNCATE
23235 && x
+ glyph
->pixel_width
> max_x
)
23237 /* End of continued line or max_x reached. */
23238 if (CHAR_GLYPH_PADDING_P (*glyph
))
23240 /* A wide character is unbreakable. */
23241 if (row
->reversed_p
)
23242 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23243 - n_glyphs_before
);
23244 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23245 it
->current_x
= x_before
;
23249 if (row
->reversed_p
)
23250 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23251 - (n_glyphs_before
+ i
));
23252 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23257 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23259 /* Glyph is at least partially visible. */
23261 if (x
< it
->first_visible_x
)
23262 row
->x
= x
- it
->first_visible_x
;
23266 /* Glyph is off the left margin of the display area.
23267 Should not happen. */
23271 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23272 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23273 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23274 row
->phys_height
= max (row
->phys_height
,
23275 it
->max_phys_ascent
+ it
->max_phys_descent
);
23276 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23277 it
->max_extra_line_spacing
);
23278 x
+= glyph
->pixel_width
;
23282 /* Stop if max_x reached. */
23286 /* Stop at line ends. */
23287 if (ITERATOR_AT_END_OF_LINE_P (it
))
23289 it
->continuation_lines_width
= 0;
23293 set_iterator_to_next (it
, 1);
23294 if (STRINGP (it
->string
))
23295 it_charpos
= IT_STRING_CHARPOS (*it
);
23297 it_charpos
= IT_CHARPOS (*it
);
23299 /* Stop if truncating at the right edge. */
23300 if (it
->line_wrap
== TRUNCATE
23301 && it
->current_x
>= it
->last_visible_x
)
23303 /* Add truncation mark, but don't do it if the line is
23304 truncated at a padding space. */
23305 if (it_charpos
< it
->string_nchars
)
23307 if (!FRAME_WINDOW_P (it
->f
))
23311 if (it
->current_x
> it
->last_visible_x
)
23313 if (!row
->reversed_p
)
23315 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23316 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23321 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23322 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23324 unproduce_glyphs (it
, ii
+ 1);
23325 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23327 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23329 row
->used
[TEXT_AREA
] = ii
;
23330 produce_special_glyphs (it
, IT_TRUNCATION
);
23333 produce_special_glyphs (it
, IT_TRUNCATION
);
23335 row
->truncated_on_right_p
= 1;
23341 /* Maybe insert a truncation at the left. */
23342 if (it
->first_visible_x
23345 if (!FRAME_WINDOW_P (it
->f
)
23346 || (row
->reversed_p
23347 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23348 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23349 insert_left_trunc_glyphs (it
);
23350 row
->truncated_on_left_p
= 1;
23353 it
->face_id
= saved_face_id
;
23355 /* Value is number of columns displayed. */
23356 return it
->hpos
- hpos_at_start
;
23361 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23362 appears as an element of LIST or as the car of an element of LIST.
23363 If PROPVAL is a list, compare each element against LIST in that
23364 way, and return 1/2 if any element of PROPVAL is found in LIST.
23365 Otherwise return 0. This function cannot quit.
23366 The return value is 2 if the text is invisible but with an ellipsis
23367 and 1 if it's invisible and without an ellipsis. */
23370 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
23372 register Lisp_Object tail
, proptail
;
23374 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23376 register Lisp_Object tem
;
23378 if (EQ (propval
, tem
))
23380 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23381 return NILP (XCDR (tem
)) ? 1 : 2;
23384 if (CONSP (propval
))
23386 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23388 Lisp_Object propelt
;
23389 propelt
= XCAR (proptail
);
23390 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23392 register Lisp_Object tem
;
23394 if (EQ (propelt
, tem
))
23396 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23397 return NILP (XCDR (tem
)) ? 1 : 2;
23405 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23406 doc
: /* Non-nil if the property makes the text invisible.
23407 POS-OR-PROP can be a marker or number, in which case it is taken to be
23408 a position in the current buffer and the value of the `invisible' property
23409 is checked; or it can be some other value, which is then presumed to be the
23410 value of the `invisible' property of the text of interest.
23411 The non-nil value returned can be t for truly invisible text or something
23412 else if the text is replaced by an ellipsis. */)
23413 (Lisp_Object pos_or_prop
)
23416 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23417 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23419 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23420 return (invis
== 0 ? Qnil
23422 : make_number (invis
));
23425 /* Calculate a width or height in pixels from a specification using
23426 the following elements:
23429 NUM - a (fractional) multiple of the default font width/height
23430 (NUM) - specifies exactly NUM pixels
23431 UNIT - a fixed number of pixels, see below.
23432 ELEMENT - size of a display element in pixels, see below.
23433 (NUM . SPEC) - equals NUM * SPEC
23434 (+ SPEC SPEC ...) - add pixel values
23435 (- SPEC SPEC ...) - subtract pixel values
23436 (- SPEC) - negate pixel value
23439 INT or FLOAT - a number constant
23440 SYMBOL - use symbol's (buffer local) variable binding.
23443 in - pixels per inch *)
23444 mm - pixels per 1/1000 meter *)
23445 cm - pixels per 1/100 meter *)
23446 width - width of current font in pixels.
23447 height - height of current font in pixels.
23449 *) using the ratio(s) defined in display-pixels-per-inch.
23453 left-fringe - left fringe width in pixels
23454 right-fringe - right fringe width in pixels
23456 left-margin - left margin width in pixels
23457 right-margin - right margin width in pixels
23459 scroll-bar - scroll-bar area width in pixels
23463 Pixels corresponding to 5 inches:
23466 Total width of non-text areas on left side of window (if scroll-bar is on left):
23467 '(space :width (+ left-fringe left-margin scroll-bar))
23469 Align to first text column (in header line):
23470 '(space :align-to 0)
23472 Align to middle of text area minus half the width of variable `my-image'
23473 containing a loaded image:
23474 '(space :align-to (0.5 . (- text my-image)))
23476 Width of left margin minus width of 1 character in the default font:
23477 '(space :width (- left-margin 1))
23479 Width of left margin minus width of 2 characters in the current font:
23480 '(space :width (- left-margin (2 . width)))
23482 Center 1 character over left-margin (in header line):
23483 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23485 Different ways to express width of left fringe plus left margin minus one pixel:
23486 '(space :width (- (+ left-fringe left-margin) (1)))
23487 '(space :width (+ left-fringe left-margin (- (1))))
23488 '(space :width (+ left-fringe left-margin (-1)))
23493 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
23494 struct font
*font
, int width_p
, int *align_to
)
23498 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
23499 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
23502 return OK_PIXELS (0);
23504 eassert (FRAME_LIVE_P (it
->f
));
23506 if (SYMBOLP (prop
))
23508 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
23510 char *unit
= SSDATA (SYMBOL_NAME (prop
));
23512 if (unit
[0] == 'i' && unit
[1] == 'n')
23514 else if (unit
[0] == 'm' && unit
[1] == 'm')
23516 else if (unit
[0] == 'c' && unit
[1] == 'm')
23522 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
23523 : FRAME_RES_Y (it
->f
));
23526 return OK_PIXELS (ppi
/ pixels
);
23531 #ifdef HAVE_WINDOW_SYSTEM
23532 if (EQ (prop
, Qheight
))
23533 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
23534 if (EQ (prop
, Qwidth
))
23535 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
23537 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
23538 return OK_PIXELS (1);
23541 if (EQ (prop
, Qtext
))
23542 return OK_PIXELS (width_p
23543 ? window_box_width (it
->w
, TEXT_AREA
)
23544 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
23546 if (align_to
&& *align_to
< 0)
23549 if (EQ (prop
, Qleft
))
23550 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
23551 if (EQ (prop
, Qright
))
23552 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
23553 if (EQ (prop
, Qcenter
))
23554 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
23555 + window_box_width (it
->w
, TEXT_AREA
) / 2);
23556 if (EQ (prop
, Qleft_fringe
))
23557 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23558 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
23559 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
23560 if (EQ (prop
, Qright_fringe
))
23561 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23562 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23563 : window_box_right_offset (it
->w
, TEXT_AREA
));
23564 if (EQ (prop
, Qleft_margin
))
23565 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
23566 if (EQ (prop
, Qright_margin
))
23567 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
23568 if (EQ (prop
, Qscroll_bar
))
23569 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
23571 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23572 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23573 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23578 if (EQ (prop
, Qleft_fringe
))
23579 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
23580 if (EQ (prop
, Qright_fringe
))
23581 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
23582 if (EQ (prop
, Qleft_margin
))
23583 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
23584 if (EQ (prop
, Qright_margin
))
23585 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
23586 if (EQ (prop
, Qscroll_bar
))
23587 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
23590 prop
= buffer_local_value_1 (prop
, it
->w
->contents
);
23591 if (EQ (prop
, Qunbound
))
23595 if (INTEGERP (prop
) || FLOATP (prop
))
23597 int base_unit
= (width_p
23598 ? FRAME_COLUMN_WIDTH (it
->f
)
23599 : FRAME_LINE_HEIGHT (it
->f
));
23600 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
23605 Lisp_Object car
= XCAR (prop
);
23606 Lisp_Object cdr
= XCDR (prop
);
23610 #ifdef HAVE_WINDOW_SYSTEM
23611 if (FRAME_WINDOW_P (it
->f
)
23612 && valid_image_p (prop
))
23614 ptrdiff_t id
= lookup_image (it
->f
, prop
);
23615 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
23617 return OK_PIXELS (width_p
? img
->width
: img
->height
);
23620 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
23626 while (CONSP (cdr
))
23628 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
23629 font
, width_p
, align_to
))
23632 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
23637 if (EQ (car
, Qminus
))
23639 return OK_PIXELS (pixels
);
23642 car
= buffer_local_value_1 (car
, it
->w
->contents
);
23643 if (EQ (car
, Qunbound
))
23647 if (INTEGERP (car
) || FLOATP (car
))
23650 pixels
= XFLOATINT (car
);
23652 return OK_PIXELS (pixels
);
23653 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
23654 font
, width_p
, align_to
))
23655 return OK_PIXELS (pixels
* fact
);
23666 /***********************************************************************
23668 ***********************************************************************/
23670 #ifdef HAVE_WINDOW_SYSTEM
23675 dump_glyph_string (struct glyph_string
*s
)
23677 fprintf (stderr
, "glyph string\n");
23678 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
23679 s
->x
, s
->y
, s
->width
, s
->height
);
23680 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
23681 fprintf (stderr
, " hl = %d\n", s
->hl
);
23682 fprintf (stderr
, " left overhang = %d, right = %d\n",
23683 s
->left_overhang
, s
->right_overhang
);
23684 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
23685 fprintf (stderr
, " extends to end of line = %d\n",
23686 s
->extends_to_end_of_line_p
);
23687 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
23688 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
23691 #endif /* GLYPH_DEBUG */
23693 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
23694 of XChar2b structures for S; it can't be allocated in
23695 init_glyph_string because it must be allocated via `alloca'. W
23696 is the window on which S is drawn. ROW and AREA are the glyph row
23697 and area within the row from which S is constructed. START is the
23698 index of the first glyph structure covered by S. HL is a
23699 face-override for drawing S. */
23702 #define OPTIONAL_HDC(hdc) HDC hdc,
23703 #define DECLARE_HDC(hdc) HDC hdc;
23704 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
23705 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
23708 #ifndef OPTIONAL_HDC
23709 #define OPTIONAL_HDC(hdc)
23710 #define DECLARE_HDC(hdc)
23711 #define ALLOCATE_HDC(hdc, f)
23712 #define RELEASE_HDC(hdc, f)
23716 init_glyph_string (struct glyph_string
*s
,
23718 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
23719 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
23721 memset (s
, 0, sizeof *s
);
23723 s
->f
= XFRAME (w
->frame
);
23727 s
->display
= FRAME_X_DISPLAY (s
->f
);
23728 s
->window
= FRAME_X_WINDOW (s
->f
);
23729 s
->char2b
= char2b
;
23733 s
->first_glyph
= row
->glyphs
[area
] + start
;
23734 s
->height
= row
->height
;
23735 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
23736 s
->ybase
= s
->y
+ row
->ascent
;
23740 /* Append the list of glyph strings with head H and tail T to the list
23741 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
23744 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23745 struct glyph_string
*h
, struct glyph_string
*t
)
23759 /* Prepend the list of glyph strings with head H and tail T to the
23760 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
23764 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23765 struct glyph_string
*h
, struct glyph_string
*t
)
23779 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
23780 Set *HEAD and *TAIL to the resulting list. */
23783 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
23784 struct glyph_string
*s
)
23786 s
->next
= s
->prev
= NULL
;
23787 append_glyph_string_lists (head
, tail
, s
, s
);
23791 /* Get face and two-byte form of character C in face FACE_ID on frame F.
23792 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
23793 make sure that X resources for the face returned are allocated.
23794 Value is a pointer to a realized face that is ready for display if
23795 DISPLAY_P is non-zero. */
23797 static struct face
*
23798 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
23799 XChar2b
*char2b
, int display_p
)
23801 struct face
*face
= FACE_FROM_ID (f
, face_id
);
23806 code
= face
->font
->driver
->encode_char (face
->font
, c
);
23808 if (code
== FONT_INVALID_CODE
)
23811 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23813 /* Make sure X resources of the face are allocated. */
23814 #ifdef HAVE_X_WINDOWS
23818 eassert (face
!= NULL
);
23819 PREPARE_FACE_FOR_DISPLAY (f
, face
);
23826 /* Get face and two-byte form of character glyph GLYPH on frame F.
23827 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
23828 a pointer to a realized face that is ready for display. */
23830 static struct face
*
23831 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
23832 XChar2b
*char2b
, int *two_byte_p
)
23837 eassert (glyph
->type
== CHAR_GLYPH
);
23838 face
= FACE_FROM_ID (f
, glyph
->face_id
);
23840 /* Make sure X resources of the face are allocated. */
23841 eassert (face
!= NULL
);
23842 PREPARE_FACE_FOR_DISPLAY (f
, face
);
23849 if (CHAR_BYTE8_P (glyph
->u
.ch
))
23850 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
23852 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
23854 if (code
== FONT_INVALID_CODE
)
23858 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23863 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
23864 Return 1 if FONT has a glyph for C, otherwise return 0. */
23867 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
23871 if (CHAR_BYTE8_P (c
))
23872 code
= CHAR_TO_BYTE8 (c
);
23874 code
= font
->driver
->encode_char (font
, c
);
23876 if (code
== FONT_INVALID_CODE
)
23878 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23883 /* Fill glyph string S with composition components specified by S->cmp.
23885 BASE_FACE is the base face of the composition.
23886 S->cmp_from is the index of the first component for S.
23888 OVERLAPS non-zero means S should draw the foreground only, and use
23889 its physical height for clipping. See also draw_glyphs.
23891 Value is the index of a component not in S. */
23894 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
23898 /* For all glyphs of this composition, starting at the offset
23899 S->cmp_from, until we reach the end of the definition or encounter a
23900 glyph that requires the different face, add it to S. */
23905 s
->for_overlaps
= overlaps
;
23908 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
23910 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
23912 /* TAB in a composition means display glyphs with padding space
23913 on the left or right. */
23916 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
23919 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
23926 s
->font
= s
->face
->font
;
23928 else if (s
->face
!= face
)
23936 if (s
->face
== NULL
)
23938 s
->face
= base_face
->ascii_face
;
23939 s
->font
= s
->face
->font
;
23942 /* All glyph strings for the same composition has the same width,
23943 i.e. the width set for the first component of the composition. */
23944 s
->width
= s
->first_glyph
->pixel_width
;
23946 /* If the specified font could not be loaded, use the frame's
23947 default font, but record the fact that we couldn't load it in
23948 the glyph string so that we can draw rectangles for the
23949 characters of the glyph string. */
23950 if (s
->font
== NULL
)
23952 s
->font_not_found_p
= 1;
23953 s
->font
= FRAME_FONT (s
->f
);
23956 /* Adjust base line for subscript/superscript text. */
23957 s
->ybase
+= s
->first_glyph
->voffset
;
23959 /* This glyph string must always be drawn with 16-bit functions. */
23966 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
23967 int start
, int end
, int overlaps
)
23969 struct glyph
*glyph
, *last
;
23970 Lisp_Object lgstring
;
23973 s
->for_overlaps
= overlaps
;
23974 glyph
= s
->row
->glyphs
[s
->area
] + start
;
23975 last
= s
->row
->glyphs
[s
->area
] + end
;
23976 s
->cmp_id
= glyph
->u
.cmp
.id
;
23977 s
->cmp_from
= glyph
->slice
.cmp
.from
;
23978 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
23979 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
23980 lgstring
= composition_gstring_from_id (s
->cmp_id
);
23981 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
23983 while (glyph
< last
23984 && glyph
->u
.cmp
.automatic
23985 && glyph
->u
.cmp
.id
== s
->cmp_id
23986 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
23987 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
23989 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
23991 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
23992 unsigned code
= LGLYPH_CODE (lglyph
);
23994 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
23996 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
23997 return glyph
- s
->row
->glyphs
[s
->area
];
24001 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24002 See the comment of fill_glyph_string for arguments.
24003 Value is the index of the first glyph not in S. */
24007 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24008 int start
, int end
, int overlaps
)
24010 struct glyph
*glyph
, *last
;
24013 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24014 s
->for_overlaps
= overlaps
;
24015 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24016 last
= s
->row
->glyphs
[s
->area
] + end
;
24017 voffset
= glyph
->voffset
;
24018 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24019 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24021 s
->width
= glyph
->pixel_width
;
24023 while (glyph
< last
24024 && glyph
->type
== GLYPHLESS_GLYPH
24025 && glyph
->voffset
== voffset
24026 && glyph
->face_id
== face_id
)
24029 s
->width
+= glyph
->pixel_width
;
24032 s
->ybase
+= voffset
;
24033 return glyph
- s
->row
->glyphs
[s
->area
];
24037 /* Fill glyph string S from a sequence of character glyphs.
24039 FACE_ID is the face id of the string. START is the index of the
24040 first glyph to consider, END is the index of the last + 1.
24041 OVERLAPS non-zero means S should draw the foreground only, and use
24042 its physical height for clipping. See also draw_glyphs.
24044 Value is the index of the first glyph not in S. */
24047 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24048 int start
, int end
, int overlaps
)
24050 struct glyph
*glyph
, *last
;
24052 int glyph_not_available_p
;
24054 eassert (s
->f
== XFRAME (s
->w
->frame
));
24055 eassert (s
->nchars
== 0);
24056 eassert (start
>= 0 && end
> start
);
24058 s
->for_overlaps
= overlaps
;
24059 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24060 last
= s
->row
->glyphs
[s
->area
] + end
;
24061 voffset
= glyph
->voffset
;
24062 s
->padding_p
= glyph
->padding_p
;
24063 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24065 while (glyph
< last
24066 && glyph
->type
== CHAR_GLYPH
24067 && glyph
->voffset
== voffset
24068 /* Same face id implies same font, nowadays. */
24069 && glyph
->face_id
== face_id
24070 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24074 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24075 s
->char2b
+ s
->nchars
,
24077 s
->two_byte_p
= two_byte_p
;
24079 eassert (s
->nchars
<= end
- start
);
24080 s
->width
+= glyph
->pixel_width
;
24081 if (glyph
++->padding_p
!= s
->padding_p
)
24085 s
->font
= s
->face
->font
;
24087 /* If the specified font could not be loaded, use the frame's font,
24088 but record the fact that we couldn't load it in
24089 S->font_not_found_p so that we can draw rectangles for the
24090 characters of the glyph string. */
24091 if (s
->font
== NULL
|| glyph_not_available_p
)
24093 s
->font_not_found_p
= 1;
24094 s
->font
= FRAME_FONT (s
->f
);
24097 /* Adjust base line for subscript/superscript text. */
24098 s
->ybase
+= voffset
;
24100 eassert (s
->face
&& s
->face
->gc
);
24101 return glyph
- s
->row
->glyphs
[s
->area
];
24105 /* Fill glyph string S from image glyph S->first_glyph. */
24108 fill_image_glyph_string (struct glyph_string
*s
)
24110 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24111 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24113 s
->slice
= s
->first_glyph
->slice
.img
;
24114 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24115 s
->font
= s
->face
->font
;
24116 s
->width
= s
->first_glyph
->pixel_width
;
24118 /* Adjust base line for subscript/superscript text. */
24119 s
->ybase
+= s
->first_glyph
->voffset
;
24123 /* Fill glyph string S from a sequence of stretch glyphs.
24125 START is the index of the first glyph to consider,
24126 END is the index of the last + 1.
24128 Value is the index of the first glyph not in S. */
24131 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24133 struct glyph
*glyph
, *last
;
24134 int voffset
, face_id
;
24136 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24138 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24139 last
= s
->row
->glyphs
[s
->area
] + end
;
24140 face_id
= glyph
->face_id
;
24141 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24142 s
->font
= s
->face
->font
;
24143 s
->width
= glyph
->pixel_width
;
24145 voffset
= glyph
->voffset
;
24149 && glyph
->type
== STRETCH_GLYPH
24150 && glyph
->voffset
== voffset
24151 && glyph
->face_id
== face_id
);
24153 s
->width
+= glyph
->pixel_width
;
24155 /* Adjust base line for subscript/superscript text. */
24156 s
->ybase
+= voffset
;
24158 /* The case that face->gc == 0 is handled when drawing the glyph
24159 string by calling PREPARE_FACE_FOR_DISPLAY. */
24161 return glyph
- s
->row
->glyphs
[s
->area
];
24164 static struct font_metrics
*
24165 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24167 static struct font_metrics metrics
;
24172 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24173 if (code
== FONT_INVALID_CODE
)
24175 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24180 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24181 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24182 assumed to be zero. */
24185 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24187 *left
= *right
= 0;
24189 if (glyph
->type
== CHAR_GLYPH
)
24193 struct font_metrics
*pcm
;
24195 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
24196 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
24198 if (pcm
->rbearing
> pcm
->width
)
24199 *right
= pcm
->rbearing
- pcm
->width
;
24200 if (pcm
->lbearing
< 0)
24201 *left
= -pcm
->lbearing
;
24204 else if (glyph
->type
== COMPOSITE_GLYPH
)
24206 if (! glyph
->u
.cmp
.automatic
)
24208 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24210 if (cmp
->rbearing
> cmp
->pixel_width
)
24211 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24212 if (cmp
->lbearing
< 0)
24213 *left
= - cmp
->lbearing
;
24217 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24218 struct font_metrics metrics
;
24220 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24221 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24222 if (metrics
.rbearing
> metrics
.width
)
24223 *right
= metrics
.rbearing
- metrics
.width
;
24224 if (metrics
.lbearing
< 0)
24225 *left
= - metrics
.lbearing
;
24231 /* Return the index of the first glyph preceding glyph string S that
24232 is overwritten by S because of S's left overhang. Value is -1
24233 if no glyphs are overwritten. */
24236 left_overwritten (struct glyph_string
*s
)
24240 if (s
->left_overhang
)
24243 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24244 int first
= s
->first_glyph
- glyphs
;
24246 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24247 x
-= glyphs
[i
].pixel_width
;
24258 /* Return the index of the first glyph preceding glyph string S that
24259 is overwriting S because of its right overhang. Value is -1 if no
24260 glyph in front of S overwrites S. */
24263 left_overwriting (struct glyph_string
*s
)
24266 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24267 int first
= s
->first_glyph
- glyphs
;
24271 for (i
= first
- 1; i
>= 0; --i
)
24274 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24277 x
-= glyphs
[i
].pixel_width
;
24284 /* Return the index of the last glyph following glyph string S that is
24285 overwritten by S because of S's right overhang. Value is -1 if
24286 no such glyph is found. */
24289 right_overwritten (struct glyph_string
*s
)
24293 if (s
->right_overhang
)
24296 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24297 int first
= (s
->first_glyph
- glyphs
24298 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24299 int end
= s
->row
->used
[s
->area
];
24301 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24302 x
+= glyphs
[i
].pixel_width
;
24311 /* Return the index of the last glyph following glyph string S that
24312 overwrites S because of its left overhang. Value is negative
24313 if no such glyph is found. */
24316 right_overwriting (struct glyph_string
*s
)
24319 int end
= s
->row
->used
[s
->area
];
24320 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24321 int first
= (s
->first_glyph
- glyphs
24322 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24326 for (i
= first
; i
< end
; ++i
)
24329 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24332 x
+= glyphs
[i
].pixel_width
;
24339 /* Set background width of glyph string S. START is the index of the
24340 first glyph following S. LAST_X is the right-most x-position + 1
24341 in the drawing area. */
24344 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24346 /* If the face of this glyph string has to be drawn to the end of
24347 the drawing area, set S->extends_to_end_of_line_p. */
24349 if (start
== s
->row
->used
[s
->area
]
24350 && ((s
->row
->fill_line_p
24351 && (s
->hl
== DRAW_NORMAL_TEXT
24352 || s
->hl
== DRAW_IMAGE_RAISED
24353 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24354 || s
->hl
== DRAW_MOUSE_FACE
))
24355 s
->extends_to_end_of_line_p
= 1;
24357 /* If S extends its face to the end of the line, set its
24358 background_width to the distance to the right edge of the drawing
24360 if (s
->extends_to_end_of_line_p
)
24361 s
->background_width
= last_x
- s
->x
+ 1;
24363 s
->background_width
= s
->width
;
24367 /* Compute overhangs and x-positions for glyph string S and its
24368 predecessors, or successors. X is the starting x-position for S.
24369 BACKWARD_P non-zero means process predecessors. */
24372 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
24378 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24379 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24389 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24390 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24400 /* The following macros are only called from draw_glyphs below.
24401 They reference the following parameters of that function directly:
24402 `w', `row', `area', and `overlap_p'
24403 as well as the following local variables:
24404 `s', `f', and `hdc' (in W32) */
24407 /* On W32, silently add local `hdc' variable to argument list of
24408 init_glyph_string. */
24409 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24410 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24412 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24413 init_glyph_string (s, char2b, w, row, area, start, hl)
24416 /* Add a glyph string for a stretch glyph to the list of strings
24417 between HEAD and TAIL. START is the index of the stretch glyph in
24418 row area AREA of glyph row ROW. END is the index of the last glyph
24419 in that glyph row area. X is the current output position assigned
24420 to the new glyph string constructed. HL overrides that face of the
24421 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24422 is the right-most x-position of the drawing area. */
24424 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24425 and below -- keep them on one line. */
24426 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24429 s = alloca (sizeof *s); \
24430 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24431 START = fill_stretch_glyph_string (s, START, END); \
24432 append_glyph_string (&HEAD, &TAIL, s); \
24438 /* Add a glyph string for an image glyph to the list of strings
24439 between HEAD and TAIL. START is the index of the image glyph in
24440 row area AREA of glyph row ROW. END is the index of the last glyph
24441 in that glyph row area. X is the current output position assigned
24442 to the new glyph string constructed. HL overrides that face of the
24443 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24444 is the right-most x-position of the drawing area. */
24446 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24449 s = alloca (sizeof *s); \
24450 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24451 fill_image_glyph_string (s); \
24452 append_glyph_string (&HEAD, &TAIL, s); \
24459 /* Add a glyph string for a sequence of character glyphs to the list
24460 of strings between HEAD and TAIL. START is the index of the first
24461 glyph in row area AREA of glyph row ROW that is part of the new
24462 glyph string. END is the index of the last glyph in that glyph row
24463 area. X is the current output position assigned to the new glyph
24464 string constructed. HL overrides that face of the glyph; e.g. it
24465 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24466 right-most x-position of the drawing area. */
24468 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24474 face_id = (row)->glyphs[area][START].face_id; \
24476 s = alloca (sizeof *s); \
24477 char2b = alloca ((END - START) * sizeof *char2b); \
24478 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24479 append_glyph_string (&HEAD, &TAIL, s); \
24481 START = fill_glyph_string (s, face_id, START, END, overlaps); \
24486 /* Add a glyph string for a composite sequence to the list of strings
24487 between HEAD and TAIL. START is the index of the first glyph in
24488 row area AREA of glyph row ROW that is part of the new glyph
24489 string. END is the index of the last glyph in that glyph row area.
24490 X is the current output position assigned to the new glyph string
24491 constructed. HL overrides that face of the glyph; e.g. it is
24492 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
24493 x-position of the drawing area. */
24495 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24497 int face_id = (row)->glyphs[area][START].face_id; \
24498 struct face *base_face = FACE_FROM_ID (f, face_id); \
24499 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
24500 struct composition *cmp = composition_table[cmp_id]; \
24502 struct glyph_string *first_s = NULL; \
24505 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
24507 /* Make glyph_strings for each glyph sequence that is drawable by \
24508 the same face, and append them to HEAD/TAIL. */ \
24509 for (n = 0; n < cmp->glyph_len;) \
24511 s = alloca (sizeof *s); \
24512 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24513 append_glyph_string (&(HEAD), &(TAIL), s); \
24519 n = fill_composite_glyph_string (s, base_face, overlaps); \
24527 /* Add a glyph string for a glyph-string sequence to the list of strings
24528 between HEAD and TAIL. */
24530 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24534 Lisp_Object gstring; \
24536 face_id = (row)->glyphs[area][START].face_id; \
24537 gstring = (composition_gstring_from_id \
24538 ((row)->glyphs[area][START].u.cmp.id)); \
24539 s = alloca (sizeof *s); \
24540 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
24541 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24542 append_glyph_string (&(HEAD), &(TAIL), s); \
24544 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
24548 /* Add a glyph string for a sequence of glyphless character's glyphs
24549 to the list of strings between HEAD and TAIL. The meanings of
24550 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
24552 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24557 face_id = (row)->glyphs[area][START].face_id; \
24559 s = alloca (sizeof *s); \
24560 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24561 append_glyph_string (&HEAD, &TAIL, s); \
24563 START = fill_glyphless_glyph_string (s, face_id, START, END, \
24569 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
24570 of AREA of glyph row ROW on window W between indices START and END.
24571 HL overrides the face for drawing glyph strings, e.g. it is
24572 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
24573 x-positions of the drawing area.
24575 This is an ugly monster macro construct because we must use alloca
24576 to allocate glyph strings (because draw_glyphs can be called
24577 asynchronously). */
24579 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24582 HEAD = TAIL = NULL; \
24583 while (START < END) \
24585 struct glyph *first_glyph = (row)->glyphs[area] + START; \
24586 switch (first_glyph->type) \
24589 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
24593 case COMPOSITE_GLYPH: \
24594 if (first_glyph->u.cmp.automatic) \
24595 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
24598 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
24602 case STRETCH_GLYPH: \
24603 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
24607 case IMAGE_GLYPH: \
24608 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
24612 case GLYPHLESS_GLYPH: \
24613 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
24623 set_glyph_string_background_width (s, START, LAST_X); \
24630 /* Draw glyphs between START and END in AREA of ROW on window W,
24631 starting at x-position X. X is relative to AREA in W. HL is a
24632 face-override with the following meaning:
24634 DRAW_NORMAL_TEXT draw normally
24635 DRAW_CURSOR draw in cursor face
24636 DRAW_MOUSE_FACE draw in mouse face.
24637 DRAW_INVERSE_VIDEO draw in mode line face
24638 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
24639 DRAW_IMAGE_RAISED draw an image with a raised relief around it
24641 If OVERLAPS is non-zero, draw only the foreground of characters and
24642 clip to the physical height of ROW. Non-zero value also defines
24643 the overlapping part to be drawn:
24645 OVERLAPS_PRED overlap with preceding rows
24646 OVERLAPS_SUCC overlap with succeeding rows
24647 OVERLAPS_BOTH overlap with both preceding/succeeding rows
24648 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
24650 Value is the x-position reached, relative to AREA of W. */
24653 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
24654 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
24655 enum draw_glyphs_face hl
, int overlaps
)
24657 struct glyph_string
*head
, *tail
;
24658 struct glyph_string
*s
;
24659 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
24660 int i
, j
, x_reached
, last_x
, area_left
= 0;
24661 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24664 ALLOCATE_HDC (hdc
, f
);
24666 /* Let's rather be paranoid than getting a SEGV. */
24667 end
= min (end
, row
->used
[area
]);
24668 start
= clip_to_bounds (0, start
, end
);
24670 /* Translate X to frame coordinates. Set last_x to the right
24671 end of the drawing area. */
24672 if (row
->full_width_p
)
24674 /* X is relative to the left edge of W, without scroll bars
24676 area_left
= WINDOW_LEFT_EDGE_X (w
);
24677 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
24678 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
24682 area_left
= window_box_left (w
, area
);
24683 last_x
= area_left
+ window_box_width (w
, area
);
24687 /* Build a doubly-linked list of glyph_string structures between
24688 head and tail from what we have to draw. Note that the macro
24689 BUILD_GLYPH_STRINGS will modify its start parameter. That's
24690 the reason we use a separate variable `i'. */
24692 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
24694 x_reached
= tail
->x
+ tail
->background_width
;
24698 /* If there are any glyphs with lbearing < 0 or rbearing > width in
24699 the row, redraw some glyphs in front or following the glyph
24700 strings built above. */
24701 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
24703 struct glyph_string
*h
, *t
;
24704 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24705 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
24706 int check_mouse_face
= 0;
24709 /* If mouse highlighting is on, we may need to draw adjacent
24710 glyphs using mouse-face highlighting. */
24711 if (area
== TEXT_AREA
&& row
->mouse_face_p
24712 && hlinfo
->mouse_face_beg_row
>= 0
24713 && hlinfo
->mouse_face_end_row
>= 0)
24715 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
24717 if (row_vpos
>= hlinfo
->mouse_face_beg_row
24718 && row_vpos
<= hlinfo
->mouse_face_end_row
)
24720 check_mouse_face
= 1;
24721 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
24722 ? hlinfo
->mouse_face_beg_col
: 0;
24723 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
24724 ? hlinfo
->mouse_face_end_col
24725 : row
->used
[TEXT_AREA
];
24729 /* Compute overhangs for all glyph strings. */
24730 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
24731 for (s
= head
; s
; s
= s
->next
)
24732 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
24734 /* Prepend glyph strings for glyphs in front of the first glyph
24735 string that are overwritten because of the first glyph
24736 string's left overhang. The background of all strings
24737 prepended must be drawn because the first glyph string
24739 i
= left_overwritten (head
);
24742 enum draw_glyphs_face overlap_hl
;
24744 /* If this row contains mouse highlighting, attempt to draw
24745 the overlapped glyphs with the correct highlight. This
24746 code fails if the overlap encompasses more than one glyph
24747 and mouse-highlight spans only some of these glyphs.
24748 However, making it work perfectly involves a lot more
24749 code, and I don't know if the pathological case occurs in
24750 practice, so we'll stick to this for now. --- cyd */
24751 if (check_mouse_face
24752 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24753 overlap_hl
= DRAW_MOUSE_FACE
;
24755 overlap_hl
= DRAW_NORMAL_TEXT
;
24758 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
24759 overlap_hl
, dummy_x
, last_x
);
24761 compute_overhangs_and_x (t
, head
->x
, 1);
24762 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24766 /* Prepend glyph strings for glyphs in front of the first glyph
24767 string that overwrite that glyph string because of their
24768 right overhang. For these strings, only the foreground must
24769 be drawn, because it draws over the glyph string at `head'.
24770 The background must not be drawn because this would overwrite
24771 right overhangs of preceding glyphs for which no glyph
24773 i
= left_overwriting (head
);
24776 enum draw_glyphs_face overlap_hl
;
24778 if (check_mouse_face
24779 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24780 overlap_hl
= DRAW_MOUSE_FACE
;
24782 overlap_hl
= DRAW_NORMAL_TEXT
;
24785 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
24786 overlap_hl
, dummy_x
, last_x
);
24787 for (s
= h
; s
; s
= s
->next
)
24788 s
->background_filled_p
= 1;
24789 compute_overhangs_and_x (t
, head
->x
, 1);
24790 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24793 /* Append glyphs strings for glyphs following the last glyph
24794 string tail that are overwritten by tail. The background of
24795 these strings has to be drawn because tail's foreground draws
24797 i
= right_overwritten (tail
);
24800 enum draw_glyphs_face overlap_hl
;
24802 if (check_mouse_face
24803 && mouse_beg_col
< i
&& mouse_end_col
> end
)
24804 overlap_hl
= DRAW_MOUSE_FACE
;
24806 overlap_hl
= DRAW_NORMAL_TEXT
;
24808 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
24809 overlap_hl
, x
, last_x
);
24810 /* Because BUILD_GLYPH_STRINGS updates the first argument,
24811 we don't have `end = i;' here. */
24812 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
24813 append_glyph_string_lists (&head
, &tail
, h
, t
);
24817 /* Append glyph strings for glyphs following the last glyph
24818 string tail that overwrite tail. The foreground of such
24819 glyphs has to be drawn because it writes into the background
24820 of tail. The background must not be drawn because it could
24821 paint over the foreground of following glyphs. */
24822 i
= right_overwriting (tail
);
24825 enum draw_glyphs_face overlap_hl
;
24826 if (check_mouse_face
24827 && mouse_beg_col
< i
&& mouse_end_col
> end
)
24828 overlap_hl
= DRAW_MOUSE_FACE
;
24830 overlap_hl
= DRAW_NORMAL_TEXT
;
24833 i
++; /* We must include the Ith glyph. */
24834 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
24835 overlap_hl
, x
, last_x
);
24836 for (s
= h
; s
; s
= s
->next
)
24837 s
->background_filled_p
= 1;
24838 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
24839 append_glyph_string_lists (&head
, &tail
, h
, t
);
24841 if (clip_head
|| clip_tail
)
24842 for (s
= head
; s
; s
= s
->next
)
24844 s
->clip_head
= clip_head
;
24845 s
->clip_tail
= clip_tail
;
24849 /* Draw all strings. */
24850 for (s
= head
; s
; s
= s
->next
)
24851 FRAME_RIF (f
)->draw_glyph_string (s
);
24854 /* When focus a sole frame and move horizontally, this sets on_p to 0
24855 causing a failure to erase prev cursor position. */
24856 if (area
== TEXT_AREA
24857 && !row
->full_width_p
24858 /* When drawing overlapping rows, only the glyph strings'
24859 foreground is drawn, which doesn't erase a cursor
24863 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
24864 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
24865 : (tail
? tail
->x
+ tail
->background_width
: x
));
24869 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
24870 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
24874 /* Value is the x-position up to which drawn, relative to AREA of W.
24875 This doesn't include parts drawn because of overhangs. */
24876 if (row
->full_width_p
)
24877 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
24879 x_reached
-= area_left
;
24881 RELEASE_HDC (hdc
, f
);
24886 /* Expand row matrix if too narrow. Don't expand if area
24889 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
24891 if (!it->f->fonts_changed \
24892 && (it->glyph_row->glyphs[area] \
24893 < it->glyph_row->glyphs[area + 1])) \
24895 it->w->ncols_scale_factor++; \
24896 it->f->fonts_changed = 1; \
24900 /* Store one glyph for IT->char_to_display in IT->glyph_row.
24901 Called from x_produce_glyphs when IT->glyph_row is non-null. */
24904 append_glyph (struct it
*it
)
24906 struct glyph
*glyph
;
24907 enum glyph_row_area area
= it
->area
;
24909 eassert (it
->glyph_row
);
24910 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
24912 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24913 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24915 /* If the glyph row is reversed, we need to prepend the glyph
24916 rather than append it. */
24917 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24921 /* Make room for the additional glyph. */
24922 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24924 glyph
= it
->glyph_row
->glyphs
[area
];
24926 glyph
->charpos
= CHARPOS (it
->position
);
24927 glyph
->object
= it
->object
;
24928 if (it
->pixel_width
> 0)
24930 glyph
->pixel_width
= it
->pixel_width
;
24931 glyph
->padding_p
= 0;
24935 /* Assure at least 1-pixel width. Otherwise, cursor can't
24936 be displayed correctly. */
24937 glyph
->pixel_width
= 1;
24938 glyph
->padding_p
= 1;
24940 glyph
->ascent
= it
->ascent
;
24941 glyph
->descent
= it
->descent
;
24942 glyph
->voffset
= it
->voffset
;
24943 glyph
->type
= CHAR_GLYPH
;
24944 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24945 glyph
->multibyte_p
= it
->multibyte_p
;
24946 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24948 /* In R2L rows, the left and the right box edges need to be
24949 drawn in reverse direction. */
24950 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24951 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24955 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24956 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24958 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24959 || it
->phys_descent
> it
->descent
);
24960 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
24961 glyph
->face_id
= it
->face_id
;
24962 glyph
->u
.ch
= it
->char_to_display
;
24963 glyph
->slice
.img
= null_glyph_slice
;
24964 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24967 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24968 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24970 glyph
->bidi_type
= it
->bidi_it
.type
;
24974 glyph
->resolved_level
= 0;
24975 glyph
->bidi_type
= UNKNOWN_BT
;
24977 ++it
->glyph_row
->used
[area
];
24980 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24983 /* Store one glyph for the composition IT->cmp_it.id in
24984 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
24988 append_composite_glyph (struct it
*it
)
24990 struct glyph
*glyph
;
24991 enum glyph_row_area area
= it
->area
;
24993 eassert (it
->glyph_row
);
24995 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24996 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24998 /* If the glyph row is reversed, we need to prepend the glyph
24999 rather than append it. */
25000 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25004 /* Make room for the new glyph. */
25005 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25007 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25009 glyph
->charpos
= it
->cmp_it
.charpos
;
25010 glyph
->object
= it
->object
;
25011 glyph
->pixel_width
= it
->pixel_width
;
25012 glyph
->ascent
= it
->ascent
;
25013 glyph
->descent
= it
->descent
;
25014 glyph
->voffset
= it
->voffset
;
25015 glyph
->type
= COMPOSITE_GLYPH
;
25016 if (it
->cmp_it
.ch
< 0)
25018 glyph
->u
.cmp
.automatic
= 0;
25019 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25020 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25024 glyph
->u
.cmp
.automatic
= 1;
25025 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25026 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25027 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25029 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25030 glyph
->multibyte_p
= it
->multibyte_p
;
25031 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25033 /* In R2L rows, the left and the right box edges need to be
25034 drawn in reverse direction. */
25035 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25036 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25040 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25041 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25043 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25044 || it
->phys_descent
> it
->descent
);
25045 glyph
->padding_p
= 0;
25046 glyph
->glyph_not_available_p
= 0;
25047 glyph
->face_id
= it
->face_id
;
25048 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25051 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25052 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25054 glyph
->bidi_type
= it
->bidi_it
.type
;
25056 ++it
->glyph_row
->used
[area
];
25059 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25063 /* Change IT->ascent and IT->height according to the setting of
25067 take_vertical_position_into_account (struct it
*it
)
25071 if (it
->voffset
< 0)
25072 /* Increase the ascent so that we can display the text higher
25074 it
->ascent
-= it
->voffset
;
25076 /* Increase the descent so that we can display the text lower
25078 it
->descent
+= it
->voffset
;
25083 /* Produce glyphs/get display metrics for the image IT is loaded with.
25084 See the description of struct display_iterator in dispextern.h for
25085 an overview of struct display_iterator. */
25088 produce_image_glyph (struct it
*it
)
25092 int glyph_ascent
, crop
;
25093 struct glyph_slice slice
;
25095 eassert (it
->what
== IT_IMAGE
);
25097 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25099 /* Make sure X resources of the face is loaded. */
25100 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
25102 if (it
->image_id
< 0)
25104 /* Fringe bitmap. */
25105 it
->ascent
= it
->phys_ascent
= 0;
25106 it
->descent
= it
->phys_descent
= 0;
25107 it
->pixel_width
= 0;
25112 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25114 /* Make sure X resources of the image is loaded. */
25115 prepare_image_for_display (it
->f
, img
);
25117 slice
.x
= slice
.y
= 0;
25118 slice
.width
= img
->width
;
25119 slice
.height
= img
->height
;
25121 if (INTEGERP (it
->slice
.x
))
25122 slice
.x
= XINT (it
->slice
.x
);
25123 else if (FLOATP (it
->slice
.x
))
25124 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25126 if (INTEGERP (it
->slice
.y
))
25127 slice
.y
= XINT (it
->slice
.y
);
25128 else if (FLOATP (it
->slice
.y
))
25129 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25131 if (INTEGERP (it
->slice
.width
))
25132 slice
.width
= XINT (it
->slice
.width
);
25133 else if (FLOATP (it
->slice
.width
))
25134 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25136 if (INTEGERP (it
->slice
.height
))
25137 slice
.height
= XINT (it
->slice
.height
);
25138 else if (FLOATP (it
->slice
.height
))
25139 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25141 if (slice
.x
>= img
->width
)
25142 slice
.x
= img
->width
;
25143 if (slice
.y
>= img
->height
)
25144 slice
.y
= img
->height
;
25145 if (slice
.x
+ slice
.width
>= img
->width
)
25146 slice
.width
= img
->width
- slice
.x
;
25147 if (slice
.y
+ slice
.height
> img
->height
)
25148 slice
.height
= img
->height
- slice
.y
;
25150 if (slice
.width
== 0 || slice
.height
== 0)
25153 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25155 it
->descent
= slice
.height
- glyph_ascent
;
25157 it
->descent
+= img
->vmargin
;
25158 if (slice
.y
+ slice
.height
== img
->height
)
25159 it
->descent
+= img
->vmargin
;
25160 it
->phys_descent
= it
->descent
;
25162 it
->pixel_width
= slice
.width
;
25164 it
->pixel_width
+= img
->hmargin
;
25165 if (slice
.x
+ slice
.width
== img
->width
)
25166 it
->pixel_width
+= img
->hmargin
;
25168 /* It's quite possible for images to have an ascent greater than
25169 their height, so don't get confused in that case. */
25170 if (it
->descent
< 0)
25175 if (face
->box
!= FACE_NO_BOX
)
25177 if (face
->box_line_width
> 0)
25180 it
->ascent
+= face
->box_line_width
;
25181 if (slice
.y
+ slice
.height
== img
->height
)
25182 it
->descent
+= face
->box_line_width
;
25185 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25186 it
->pixel_width
+= eabs (face
->box_line_width
);
25187 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25188 it
->pixel_width
+= eabs (face
->box_line_width
);
25191 take_vertical_position_into_account (it
);
25193 /* Automatically crop wide image glyphs at right edge so we can
25194 draw the cursor on same display row. */
25195 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25196 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25198 it
->pixel_width
-= crop
;
25199 slice
.width
-= crop
;
25204 struct glyph
*glyph
;
25205 enum glyph_row_area area
= it
->area
;
25207 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25208 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25210 glyph
->charpos
= CHARPOS (it
->position
);
25211 glyph
->object
= it
->object
;
25212 glyph
->pixel_width
= it
->pixel_width
;
25213 glyph
->ascent
= glyph_ascent
;
25214 glyph
->descent
= it
->descent
;
25215 glyph
->voffset
= it
->voffset
;
25216 glyph
->type
= IMAGE_GLYPH
;
25217 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25218 glyph
->multibyte_p
= it
->multibyte_p
;
25219 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25221 /* In R2L rows, the left and the right box edges need to be
25222 drawn in reverse direction. */
25223 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25224 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25228 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25229 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25231 glyph
->overlaps_vertically_p
= 0;
25232 glyph
->padding_p
= 0;
25233 glyph
->glyph_not_available_p
= 0;
25234 glyph
->face_id
= it
->face_id
;
25235 glyph
->u
.img_id
= img
->id
;
25236 glyph
->slice
.img
= slice
;
25237 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25240 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25241 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25243 glyph
->bidi_type
= it
->bidi_it
.type
;
25245 ++it
->glyph_row
->used
[area
];
25248 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25253 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25254 of the glyph, WIDTH and HEIGHT are the width and height of the
25255 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25258 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25259 int width
, int height
, int ascent
)
25261 struct glyph
*glyph
;
25262 enum glyph_row_area area
= it
->area
;
25264 eassert (ascent
>= 0 && ascent
<= height
);
25266 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25267 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25269 /* If the glyph row is reversed, we need to prepend the glyph
25270 rather than append it. */
25271 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25275 /* Make room for the additional glyph. */
25276 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25278 glyph
= it
->glyph_row
->glyphs
[area
];
25280 glyph
->charpos
= CHARPOS (it
->position
);
25281 glyph
->object
= object
;
25282 glyph
->pixel_width
= width
;
25283 glyph
->ascent
= ascent
;
25284 glyph
->descent
= height
- ascent
;
25285 glyph
->voffset
= it
->voffset
;
25286 glyph
->type
= STRETCH_GLYPH
;
25287 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25288 glyph
->multibyte_p
= it
->multibyte_p
;
25289 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25291 /* In R2L rows, the left and the right box edges need to be
25292 drawn in reverse direction. */
25293 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25294 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25298 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25299 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25301 glyph
->overlaps_vertically_p
= 0;
25302 glyph
->padding_p
= 0;
25303 glyph
->glyph_not_available_p
= 0;
25304 glyph
->face_id
= it
->face_id
;
25305 glyph
->u
.stretch
.ascent
= ascent
;
25306 glyph
->u
.stretch
.height
= height
;
25307 glyph
->slice
.img
= null_glyph_slice
;
25308 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25311 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25312 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25314 glyph
->bidi_type
= it
->bidi_it
.type
;
25318 glyph
->resolved_level
= 0;
25319 glyph
->bidi_type
= UNKNOWN_BT
;
25321 ++it
->glyph_row
->used
[area
];
25324 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25327 #endif /* HAVE_WINDOW_SYSTEM */
25329 /* Produce a stretch glyph for iterator IT. IT->object is the value
25330 of the glyph property displayed. The value must be a list
25331 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25334 1. `:width WIDTH' specifies that the space should be WIDTH *
25335 canonical char width wide. WIDTH may be an integer or floating
25338 2. `:relative-width FACTOR' specifies that the width of the stretch
25339 should be computed from the width of the first character having the
25340 `glyph' property, and should be FACTOR times that width.
25342 3. `:align-to HPOS' specifies that the space should be wide enough
25343 to reach HPOS, a value in canonical character units.
25345 Exactly one of the above pairs must be present.
25347 4. `:height HEIGHT' specifies that the height of the stretch produced
25348 should be HEIGHT, measured in canonical character units.
25350 5. `:relative-height FACTOR' specifies that the height of the
25351 stretch should be FACTOR times the height of the characters having
25352 the glyph property.
25354 Either none or exactly one of 4 or 5 must be present.
25356 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25357 of the stretch should be used for the ascent of the stretch.
25358 ASCENT must be in the range 0 <= ASCENT <= 100. */
25361 produce_stretch_glyph (struct it
*it
)
25363 /* (space :width WIDTH :height HEIGHT ...) */
25364 Lisp_Object prop
, plist
;
25365 int width
= 0, height
= 0, align_to
= -1;
25366 int zero_width_ok_p
= 0;
25368 struct font
*font
= NULL
;
25370 #ifdef HAVE_WINDOW_SYSTEM
25372 int zero_height_ok_p
= 0;
25374 if (FRAME_WINDOW_P (it
->f
))
25376 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25377 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25378 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
25382 /* List should start with `space'. */
25383 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
25384 plist
= XCDR (it
->object
);
25386 /* Compute the width of the stretch. */
25387 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
25388 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
25390 /* Absolute width `:width WIDTH' specified and valid. */
25391 zero_width_ok_p
= 1;
25394 #ifdef HAVE_WINDOW_SYSTEM
25395 else if (FRAME_WINDOW_P (it
->f
)
25396 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
25398 /* Relative width `:relative-width FACTOR' specified and valid.
25399 Compute the width of the characters having the `glyph'
25402 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
25405 if (it
->multibyte_p
)
25406 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
25409 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
25410 if (! ASCII_CHAR_P (it2
.c
))
25411 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
25414 it2
.glyph_row
= NULL
;
25415 it2
.what
= IT_CHARACTER
;
25416 x_produce_glyphs (&it2
);
25417 width
= NUMVAL (prop
) * it2
.pixel_width
;
25419 #endif /* HAVE_WINDOW_SYSTEM */
25420 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
25421 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
25423 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
25424 align_to
= (align_to
< 0
25426 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
25427 else if (align_to
< 0)
25428 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
25429 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
25430 zero_width_ok_p
= 1;
25433 /* Nothing specified -> width defaults to canonical char width. */
25434 width
= FRAME_COLUMN_WIDTH (it
->f
);
25436 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
25439 #ifdef HAVE_WINDOW_SYSTEM
25440 /* Compute height. */
25441 if (FRAME_WINDOW_P (it
->f
))
25443 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
25444 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25447 zero_height_ok_p
= 1;
25449 else if (prop
= Fplist_get (plist
, QCrelative_height
),
25451 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
25453 height
= FONT_HEIGHT (font
);
25455 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
25458 /* Compute percentage of height used for ascent. If
25459 `:ascent ASCENT' is present and valid, use that. Otherwise,
25460 derive the ascent from the font in use. */
25461 if (prop
= Fplist_get (plist
, QCascent
),
25462 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
25463 ascent
= height
* NUMVAL (prop
) / 100.0;
25464 else if (!NILP (prop
)
25465 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25466 ascent
= min (max (0, (int)tem
), height
);
25468 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
25471 #endif /* HAVE_WINDOW_SYSTEM */
25474 if (width
> 0 && it
->line_wrap
!= TRUNCATE
25475 && it
->current_x
+ width
> it
->last_visible_x
)
25477 width
= it
->last_visible_x
- it
->current_x
;
25478 #ifdef HAVE_WINDOW_SYSTEM
25479 /* Subtract one more pixel from the stretch width, but only on
25480 GUI frames, since on a TTY each glyph is one "pixel" wide. */
25481 width
-= FRAME_WINDOW_P (it
->f
);
25485 if (width
> 0 && height
> 0 && it
->glyph_row
)
25487 Lisp_Object o_object
= it
->object
;
25488 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
25491 if (!STRINGP (object
))
25492 object
= it
->w
->contents
;
25493 #ifdef HAVE_WINDOW_SYSTEM
25494 if (FRAME_WINDOW_P (it
->f
))
25495 append_stretch_glyph (it
, object
, width
, height
, ascent
);
25499 it
->object
= object
;
25500 it
->char_to_display
= ' ';
25501 it
->pixel_width
= it
->len
= 1;
25503 tty_append_glyph (it
);
25504 it
->object
= o_object
;
25508 it
->pixel_width
= width
;
25509 #ifdef HAVE_WINDOW_SYSTEM
25510 if (FRAME_WINDOW_P (it
->f
))
25512 it
->ascent
= it
->phys_ascent
= ascent
;
25513 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
25514 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
25515 take_vertical_position_into_account (it
);
25519 it
->nglyphs
= width
;
25522 /* Get information about special display element WHAT in an
25523 environment described by IT. WHAT is one of IT_TRUNCATION or
25524 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
25525 non-null glyph_row member. This function ensures that fields like
25526 face_id, c, len of IT are left untouched. */
25529 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
25536 temp_it
.object
= make_number (0);
25537 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
25539 if (what
== IT_CONTINUATION
)
25541 /* Continuation glyph. For R2L lines, we mirror it by hand. */
25542 if (it
->bidi_it
.paragraph_dir
== R2L
)
25543 SET_GLYPH_FROM_CHAR (glyph
, '/');
25545 SET_GLYPH_FROM_CHAR (glyph
, '\\');
25547 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25549 /* FIXME: Should we mirror GC for R2L lines? */
25550 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25551 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25554 else if (what
== IT_TRUNCATION
)
25556 /* Truncation glyph. */
25557 SET_GLYPH_FROM_CHAR (glyph
, '$');
25559 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25561 /* FIXME: Should we mirror GC for R2L lines? */
25562 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25563 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25569 #ifdef HAVE_WINDOW_SYSTEM
25570 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
25571 is turned off, we precede the truncation/continuation glyphs by a
25572 stretch glyph whose width is computed such that these special
25573 glyphs are aligned at the window margin, even when very different
25574 fonts are used in different glyph rows. */
25575 if (FRAME_WINDOW_P (temp_it
.f
)
25576 /* init_iterator calls this with it->glyph_row == NULL, and it
25577 wants only the pixel width of the truncation/continuation
25579 && temp_it
.glyph_row
25580 /* insert_left_trunc_glyphs calls us at the beginning of the
25581 row, and it has its own calculation of the stretch glyph
25583 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
25584 && (temp_it
.glyph_row
->reversed_p
25585 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
25586 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
25588 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
25590 if (stretch_width
> 0)
25592 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
25593 struct font
*font
=
25594 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
25595 int stretch_ascent
=
25596 (((temp_it
.ascent
+ temp_it
.descent
)
25597 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
25599 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
25600 temp_it
.ascent
+ temp_it
.descent
,
25607 temp_it
.what
= IT_CHARACTER
;
25609 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
25610 temp_it
.face_id
= GLYPH_FACE (glyph
);
25611 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
25613 PRODUCE_GLYPHS (&temp_it
);
25614 it
->pixel_width
= temp_it
.pixel_width
;
25615 it
->nglyphs
= temp_it
.pixel_width
;
25618 #ifdef HAVE_WINDOW_SYSTEM
25620 /* Calculate line-height and line-spacing properties.
25621 An integer value specifies explicit pixel value.
25622 A float value specifies relative value to current face height.
25623 A cons (float . face-name) specifies relative value to
25624 height of specified face font.
25626 Returns height in pixels, or nil. */
25630 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
25631 int boff
, int override
)
25633 Lisp_Object face_name
= Qnil
;
25634 int ascent
, descent
, height
;
25636 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
25641 face_name
= XCAR (val
);
25643 if (!NUMBERP (val
))
25644 val
= make_number (1);
25645 if (NILP (face_name
))
25647 height
= it
->ascent
+ it
->descent
;
25652 if (NILP (face_name
))
25654 font
= FRAME_FONT (it
->f
);
25655 boff
= FRAME_BASELINE_OFFSET (it
->f
);
25657 else if (EQ (face_name
, Qt
))
25666 face_id
= lookup_named_face (it
->f
, face_name
, 0);
25668 return make_number (-1);
25670 face
= FACE_FROM_ID (it
->f
, face_id
);
25673 return make_number (-1);
25674 boff
= font
->baseline_offset
;
25675 if (font
->vertical_centering
)
25676 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25679 ascent
= FONT_BASE (font
) + boff
;
25680 descent
= FONT_DESCENT (font
) - boff
;
25684 it
->override_ascent
= ascent
;
25685 it
->override_descent
= descent
;
25686 it
->override_boff
= boff
;
25689 height
= ascent
+ descent
;
25693 height
= (int)(XFLOAT_DATA (val
) * height
);
25694 else if (INTEGERP (val
))
25695 height
*= XINT (val
);
25697 return make_number (height
);
25701 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
25702 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
25703 and only if this is for a character for which no font was found.
25705 If the display method (it->glyphless_method) is
25706 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
25707 length of the acronym or the hexadecimal string, UPPER_XOFF and
25708 UPPER_YOFF are pixel offsets for the upper part of the string,
25709 LOWER_XOFF and LOWER_YOFF are for the lower part.
25711 For the other display methods, LEN through LOWER_YOFF are zero. */
25714 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
25715 short upper_xoff
, short upper_yoff
,
25716 short lower_xoff
, short lower_yoff
)
25718 struct glyph
*glyph
;
25719 enum glyph_row_area area
= it
->area
;
25721 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25722 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25724 /* If the glyph row is reversed, we need to prepend the glyph
25725 rather than append it. */
25726 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25730 /* Make room for the additional glyph. */
25731 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25733 glyph
= it
->glyph_row
->glyphs
[area
];
25735 glyph
->charpos
= CHARPOS (it
->position
);
25736 glyph
->object
= it
->object
;
25737 glyph
->pixel_width
= it
->pixel_width
;
25738 glyph
->ascent
= it
->ascent
;
25739 glyph
->descent
= it
->descent
;
25740 glyph
->voffset
= it
->voffset
;
25741 glyph
->type
= GLYPHLESS_GLYPH
;
25742 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
25743 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
25744 glyph
->u
.glyphless
.len
= len
;
25745 glyph
->u
.glyphless
.ch
= it
->c
;
25746 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
25747 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
25748 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
25749 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
25750 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25751 glyph
->multibyte_p
= it
->multibyte_p
;
25752 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25754 /* In R2L rows, the left and the right box edges need to be
25755 drawn in reverse direction. */
25756 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25757 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25761 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25762 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25764 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25765 || it
->phys_descent
> it
->descent
);
25766 glyph
->padding_p
= 0;
25767 glyph
->glyph_not_available_p
= 0;
25768 glyph
->face_id
= face_id
;
25769 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25772 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25773 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25775 glyph
->bidi_type
= it
->bidi_it
.type
;
25777 ++it
->glyph_row
->used
[area
];
25780 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25784 /* Produce a glyph for a glyphless character for iterator IT.
25785 IT->glyphless_method specifies which method to use for displaying
25786 the character. See the description of enum
25787 glyphless_display_method in dispextern.h for the detail.
25789 FOR_NO_FONT is nonzero if and only if this is for a character for
25790 which no font was found. ACRONYM, if non-nil, is an acronym string
25791 for the character. */
25794 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
25799 int base_width
, base_height
, width
, height
;
25800 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
25803 /* Get the metrics of the base font. We always refer to the current
25805 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
25806 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25807 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
25808 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
25809 base_height
= it
->ascent
+ it
->descent
;
25810 base_width
= font
->average_width
;
25812 face_id
= merge_glyphless_glyph_face (it
);
25814 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
25816 it
->pixel_width
= THIN_SPACE_WIDTH
;
25818 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
25820 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
25822 width
= CHAR_WIDTH (it
->c
);
25825 else if (width
> 4)
25827 it
->pixel_width
= base_width
* width
;
25829 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
25835 unsigned int code
[6];
25837 int ascent
, descent
;
25838 struct font_metrics metrics_upper
, metrics_lower
;
25840 face
= FACE_FROM_ID (it
->f
, face_id
);
25841 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25842 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
25844 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
25846 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
25847 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
25848 if (CONSP (acronym
))
25849 acronym
= XCAR (acronym
);
25850 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
25854 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
25855 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
25858 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
25859 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
25860 upper_len
= (len
+ 1) / 2;
25861 font
->driver
->text_extents (font
, code
, upper_len
,
25863 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
25868 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
25869 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
25870 upper_xoff
= upper_yoff
= 2; /* the typical case */
25871 if (base_width
>= width
)
25873 /* Align the upper to the left, the lower to the right. */
25874 it
->pixel_width
= base_width
;
25875 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
25879 /* Center the shorter one. */
25880 it
->pixel_width
= width
;
25881 if (metrics_upper
.width
>= metrics_lower
.width
)
25882 lower_xoff
= (width
- metrics_lower
.width
) / 2;
25885 /* FIXME: This code doesn't look right. It formerly was
25886 missing the "lower_xoff = 0;", which couldn't have
25887 been right since it left lower_xoff uninitialized. */
25889 upper_xoff
= (width
- metrics_upper
.width
) / 2;
25893 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
25894 top, bottom, and between upper and lower strings. */
25895 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
25896 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
25897 /* Center vertically.
25898 H:base_height, D:base_descent
25899 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
25901 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
25902 descent = D - H/2 + h/2;
25903 lower_yoff = descent - 2 - ld;
25904 upper_yoff = lower_yoff - la - 1 - ud; */
25905 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
25906 descent
= it
->descent
- (base_height
- height
) / 2;
25907 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
25908 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
25909 - metrics_upper
.descent
);
25910 /* Don't make the height shorter than the base height. */
25911 if (height
> base_height
)
25913 it
->ascent
= ascent
;
25914 it
->descent
= descent
;
25918 it
->phys_ascent
= it
->ascent
;
25919 it
->phys_descent
= it
->descent
;
25921 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
25922 upper_xoff
, upper_yoff
,
25923 lower_xoff
, lower_yoff
);
25925 take_vertical_position_into_account (it
);
25930 Produce glyphs/get display metrics for the display element IT is
25931 loaded with. See the description of struct it in dispextern.h
25932 for an overview of struct it. */
25935 x_produce_glyphs (struct it
*it
)
25937 int extra_line_spacing
= it
->extra_line_spacing
;
25939 it
->glyph_not_available_p
= 0;
25941 if (it
->what
== IT_CHARACTER
)
25944 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25945 struct font
*font
= face
->font
;
25946 struct font_metrics
*pcm
= NULL
;
25947 int boff
; /* Baseline offset. */
25951 /* When no suitable font is found, display this character by
25952 the method specified in the first extra slot of
25953 Vglyphless_char_display. */
25954 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
25956 eassert (it
->what
== IT_GLYPHLESS
);
25957 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
25961 boff
= font
->baseline_offset
;
25962 if (font
->vertical_centering
)
25963 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25965 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
25971 if (it
->override_ascent
>= 0)
25973 it
->ascent
= it
->override_ascent
;
25974 it
->descent
= it
->override_descent
;
25975 boff
= it
->override_boff
;
25979 it
->ascent
= FONT_BASE (font
) + boff
;
25980 it
->descent
= FONT_DESCENT (font
) - boff
;
25983 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
25985 pcm
= get_per_char_metric (font
, &char2b
);
25986 if (pcm
->width
== 0
25987 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
25993 it
->phys_ascent
= pcm
->ascent
+ boff
;
25994 it
->phys_descent
= pcm
->descent
- boff
;
25995 it
->pixel_width
= pcm
->width
;
25999 it
->glyph_not_available_p
= 1;
26000 it
->phys_ascent
= it
->ascent
;
26001 it
->phys_descent
= it
->descent
;
26002 it
->pixel_width
= font
->space_width
;
26005 if (it
->constrain_row_ascent_descent_p
)
26007 if (it
->descent
> it
->max_descent
)
26009 it
->ascent
+= it
->descent
- it
->max_descent
;
26010 it
->descent
= it
->max_descent
;
26012 if (it
->ascent
> it
->max_ascent
)
26014 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26015 it
->ascent
= it
->max_ascent
;
26017 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26018 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26019 extra_line_spacing
= 0;
26022 /* If this is a space inside a region of text with
26023 `space-width' property, change its width. */
26024 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26026 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26028 /* If face has a box, add the box thickness to the character
26029 height. If character has a box line to the left and/or
26030 right, add the box line width to the character's width. */
26031 if (face
->box
!= FACE_NO_BOX
)
26033 int thick
= face
->box_line_width
;
26037 it
->ascent
+= thick
;
26038 it
->descent
+= thick
;
26043 if (it
->start_of_box_run_p
)
26044 it
->pixel_width
+= thick
;
26045 if (it
->end_of_box_run_p
)
26046 it
->pixel_width
+= thick
;
26049 /* If face has an overline, add the height of the overline
26050 (1 pixel) and a 1 pixel margin to the character height. */
26051 if (face
->overline_p
)
26052 it
->ascent
+= overline_margin
;
26054 if (it
->constrain_row_ascent_descent_p
)
26056 if (it
->ascent
> it
->max_ascent
)
26057 it
->ascent
= it
->max_ascent
;
26058 if (it
->descent
> it
->max_descent
)
26059 it
->descent
= it
->max_descent
;
26062 take_vertical_position_into_account (it
);
26064 /* If we have to actually produce glyphs, do it. */
26069 /* Translate a space with a `space-width' property
26070 into a stretch glyph. */
26071 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26072 / FONT_HEIGHT (font
));
26073 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26074 it
->ascent
+ it
->descent
, ascent
);
26079 /* If characters with lbearing or rbearing are displayed
26080 in this line, record that fact in a flag of the
26081 glyph row. This is used to optimize X output code. */
26082 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26083 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26085 if (! stretched_p
&& it
->pixel_width
== 0)
26086 /* We assure that all visible glyphs have at least 1-pixel
26088 it
->pixel_width
= 1;
26090 else if (it
->char_to_display
== '\n')
26092 /* A newline has no width, but we need the height of the
26093 line. But if previous part of the line sets a height,
26094 don't increase that height. */
26096 Lisp_Object height
;
26097 Lisp_Object total_height
= Qnil
;
26099 it
->override_ascent
= -1;
26100 it
->pixel_width
= 0;
26103 height
= get_it_property (it
, Qline_height
);
26104 /* Split (line-height total-height) list. */
26106 && CONSP (XCDR (height
))
26107 && NILP (XCDR (XCDR (height
))))
26109 total_height
= XCAR (XCDR (height
));
26110 height
= XCAR (height
);
26112 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
26114 if (it
->override_ascent
>= 0)
26116 it
->ascent
= it
->override_ascent
;
26117 it
->descent
= it
->override_descent
;
26118 boff
= it
->override_boff
;
26122 it
->ascent
= FONT_BASE (font
) + boff
;
26123 it
->descent
= FONT_DESCENT (font
) - boff
;
26126 if (EQ (height
, Qt
))
26128 if (it
->descent
> it
->max_descent
)
26130 it
->ascent
+= it
->descent
- it
->max_descent
;
26131 it
->descent
= it
->max_descent
;
26133 if (it
->ascent
> it
->max_ascent
)
26135 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26136 it
->ascent
= it
->max_ascent
;
26138 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26139 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26140 it
->constrain_row_ascent_descent_p
= 1;
26141 extra_line_spacing
= 0;
26145 Lisp_Object spacing
;
26147 it
->phys_ascent
= it
->ascent
;
26148 it
->phys_descent
= it
->descent
;
26150 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26151 && face
->box
!= FACE_NO_BOX
26152 && face
->box_line_width
> 0)
26154 it
->ascent
+= face
->box_line_width
;
26155 it
->descent
+= face
->box_line_width
;
26158 && XINT (height
) > it
->ascent
+ it
->descent
)
26159 it
->ascent
= XINT (height
) - it
->descent
;
26161 if (!NILP (total_height
))
26162 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
26165 spacing
= get_it_property (it
, Qline_spacing
);
26166 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
26168 if (INTEGERP (spacing
))
26170 extra_line_spacing
= XINT (spacing
);
26171 if (!NILP (total_height
))
26172 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26176 else /* i.e. (it->char_to_display == '\t') */
26178 if (font
->space_width
> 0)
26180 int tab_width
= it
->tab_width
* font
->space_width
;
26181 int x
= it
->current_x
+ it
->continuation_lines_width
;
26182 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26184 /* If the distance from the current position to the next tab
26185 stop is less than a space character width, use the
26186 tab stop after that. */
26187 if (next_tab_x
- x
< font
->space_width
)
26188 next_tab_x
+= tab_width
;
26190 it
->pixel_width
= next_tab_x
- x
;
26192 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
26193 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
26197 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26198 it
->ascent
+ it
->descent
, it
->ascent
);
26203 it
->pixel_width
= 0;
26208 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26210 /* A static composition.
26212 Note: A composition is represented as one glyph in the
26213 glyph matrix. There are no padding glyphs.
26215 Important note: pixel_width, ascent, and descent are the
26216 values of what is drawn by draw_glyphs (i.e. the values of
26217 the overall glyphs composed). */
26218 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26219 int boff
; /* baseline offset */
26220 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26221 int glyph_len
= cmp
->glyph_len
;
26222 struct font
*font
= face
->font
;
26226 /* If we have not yet calculated pixel size data of glyphs of
26227 the composition for the current face font, calculate them
26228 now. Theoretically, we have to check all fonts for the
26229 glyphs, but that requires much time and memory space. So,
26230 here we check only the font of the first glyph. This may
26231 lead to incorrect display, but it's very rare, and C-l
26232 (recenter-top-bottom) can correct the display anyway. */
26233 if (! cmp
->font
|| cmp
->font
!= font
)
26235 /* Ascent and descent of the font of the first character
26236 of this composition (adjusted by baseline offset).
26237 Ascent and descent of overall glyphs should not be less
26238 than these, respectively. */
26239 int font_ascent
, font_descent
, font_height
;
26240 /* Bounding box of the overall glyphs. */
26241 int leftmost
, rightmost
, lowest
, highest
;
26242 int lbearing
, rbearing
;
26243 int i
, width
, ascent
, descent
;
26244 int left_padded
= 0, right_padded
= 0;
26245 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26247 struct font_metrics
*pcm
;
26248 int font_not_found_p
;
26251 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26252 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26254 if (glyph_len
< cmp
->glyph_len
)
26256 for (i
= 0; i
< glyph_len
; i
++)
26258 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26260 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26265 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26266 : IT_CHARPOS (*it
));
26267 /* If no suitable font is found, use the default font. */
26268 font_not_found_p
= font
== NULL
;
26269 if (font_not_found_p
)
26271 face
= face
->ascii_face
;
26274 boff
= font
->baseline_offset
;
26275 if (font
->vertical_centering
)
26276 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26277 font_ascent
= FONT_BASE (font
) + boff
;
26278 font_descent
= FONT_DESCENT (font
) - boff
;
26279 font_height
= FONT_HEIGHT (font
);
26284 if (! font_not_found_p
)
26286 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26288 pcm
= get_per_char_metric (font
, &char2b
);
26291 /* Initialize the bounding box. */
26294 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26295 ascent
= pcm
->ascent
;
26296 descent
= pcm
->descent
;
26297 lbearing
= pcm
->lbearing
;
26298 rbearing
= pcm
->rbearing
;
26302 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26303 ascent
= FONT_BASE (font
);
26304 descent
= FONT_DESCENT (font
);
26311 lowest
= - descent
+ boff
;
26312 highest
= ascent
+ boff
;
26314 if (! font_not_found_p
26315 && font
->default_ascent
26316 && CHAR_TABLE_P (Vuse_default_ascent
)
26317 && !NILP (Faref (Vuse_default_ascent
,
26318 make_number (it
->char_to_display
))))
26319 highest
= font
->default_ascent
+ boff
;
26321 /* Draw the first glyph at the normal position. It may be
26322 shifted to right later if some other glyphs are drawn
26324 cmp
->offsets
[i
* 2] = 0;
26325 cmp
->offsets
[i
* 2 + 1] = boff
;
26326 cmp
->lbearing
= lbearing
;
26327 cmp
->rbearing
= rbearing
;
26329 /* Set cmp->offsets for the remaining glyphs. */
26330 for (i
++; i
< glyph_len
; i
++)
26332 int left
, right
, btm
, top
;
26333 int ch
= COMPOSITION_GLYPH (cmp
, i
);
26335 struct face
*this_face
;
26339 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
26340 this_face
= FACE_FROM_ID (it
->f
, face_id
);
26341 font
= this_face
->font
;
26347 get_char_face_and_encoding (it
->f
, ch
, face_id
,
26349 pcm
= get_per_char_metric (font
, &char2b
);
26352 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26355 width
= pcm
->width
;
26356 ascent
= pcm
->ascent
;
26357 descent
= pcm
->descent
;
26358 lbearing
= pcm
->lbearing
;
26359 rbearing
= pcm
->rbearing
;
26360 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
26362 /* Relative composition with or without
26363 alternate chars. */
26364 left
= (leftmost
+ rightmost
- width
) / 2;
26365 btm
= - descent
+ boff
;
26366 if (font
->relative_compose
26367 && (! CHAR_TABLE_P (Vignore_relative_composition
)
26368 || NILP (Faref (Vignore_relative_composition
,
26369 make_number (ch
)))))
26372 if (- descent
>= font
->relative_compose
)
26373 /* One extra pixel between two glyphs. */
26375 else if (ascent
<= 0)
26376 /* One extra pixel between two glyphs. */
26377 btm
= lowest
- 1 - ascent
- descent
;
26382 /* A composition rule is specified by an integer
26383 value that encodes global and new reference
26384 points (GREF and NREF). GREF and NREF are
26385 specified by numbers as below:
26387 0---1---2 -- ascent
26391 9--10--11 -- center
26393 ---3---4---5--- baseline
26395 6---7---8 -- descent
26397 int rule
= COMPOSITION_RULE (cmp
, i
);
26398 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
26400 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
26401 grefx
= gref
% 3, nrefx
= nref
% 3;
26402 grefy
= gref
/ 3, nrefy
= nref
/ 3;
26404 xoff
= font_height
* (xoff
- 128) / 256;
26406 yoff
= font_height
* (yoff
- 128) / 256;
26409 + grefx
* (rightmost
- leftmost
) / 2
26410 - nrefx
* width
/ 2
26413 btm
= ((grefy
== 0 ? highest
26415 : grefy
== 2 ? lowest
26416 : (highest
+ lowest
) / 2)
26417 - (nrefy
== 0 ? ascent
+ descent
26418 : nrefy
== 1 ? descent
- boff
26420 : (ascent
+ descent
) / 2)
26424 cmp
->offsets
[i
* 2] = left
;
26425 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
26427 /* Update the bounding box of the overall glyphs. */
26430 right
= left
+ width
;
26431 if (left
< leftmost
)
26433 if (right
> rightmost
)
26436 top
= btm
+ descent
+ ascent
;
26442 if (cmp
->lbearing
> left
+ lbearing
)
26443 cmp
->lbearing
= left
+ lbearing
;
26444 if (cmp
->rbearing
< left
+ rbearing
)
26445 cmp
->rbearing
= left
+ rbearing
;
26449 /* If there are glyphs whose x-offsets are negative,
26450 shift all glyphs to the right and make all x-offsets
26454 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26455 cmp
->offsets
[i
* 2] -= leftmost
;
26456 rightmost
-= leftmost
;
26457 cmp
->lbearing
-= leftmost
;
26458 cmp
->rbearing
-= leftmost
;
26461 if (left_padded
&& cmp
->lbearing
< 0)
26463 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26464 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
26465 rightmost
-= cmp
->lbearing
;
26466 cmp
->rbearing
-= cmp
->lbearing
;
26469 if (right_padded
&& rightmost
< cmp
->rbearing
)
26471 rightmost
= cmp
->rbearing
;
26474 cmp
->pixel_width
= rightmost
;
26475 cmp
->ascent
= highest
;
26476 cmp
->descent
= - lowest
;
26477 if (cmp
->ascent
< font_ascent
)
26478 cmp
->ascent
= font_ascent
;
26479 if (cmp
->descent
< font_descent
)
26480 cmp
->descent
= font_descent
;
26484 && (cmp
->lbearing
< 0
26485 || cmp
->rbearing
> cmp
->pixel_width
))
26486 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26488 it
->pixel_width
= cmp
->pixel_width
;
26489 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
26490 it
->descent
= it
->phys_descent
= cmp
->descent
;
26491 if (face
->box
!= FACE_NO_BOX
)
26493 int thick
= face
->box_line_width
;
26497 it
->ascent
+= thick
;
26498 it
->descent
+= thick
;
26503 if (it
->start_of_box_run_p
)
26504 it
->pixel_width
+= thick
;
26505 if (it
->end_of_box_run_p
)
26506 it
->pixel_width
+= thick
;
26509 /* If face has an overline, add the height of the overline
26510 (1 pixel) and a 1 pixel margin to the character height. */
26511 if (face
->overline_p
)
26512 it
->ascent
+= overline_margin
;
26514 take_vertical_position_into_account (it
);
26515 if (it
->ascent
< 0)
26517 if (it
->descent
< 0)
26520 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
26521 append_composite_glyph (it
);
26523 else if (it
->what
== IT_COMPOSITION
)
26525 /* A dynamic (automatic) composition. */
26526 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26527 Lisp_Object gstring
;
26528 struct font_metrics metrics
;
26532 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
26534 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
26537 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
26538 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26539 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
26540 it
->descent
= it
->phys_descent
= metrics
.descent
;
26541 if (face
->box
!= FACE_NO_BOX
)
26543 int thick
= face
->box_line_width
;
26547 it
->ascent
+= thick
;
26548 it
->descent
+= thick
;
26553 if (it
->start_of_box_run_p
)
26554 it
->pixel_width
+= thick
;
26555 if (it
->end_of_box_run_p
)
26556 it
->pixel_width
+= thick
;
26558 /* If face has an overline, add the height of the overline
26559 (1 pixel) and a 1 pixel margin to the character height. */
26560 if (face
->overline_p
)
26561 it
->ascent
+= overline_margin
;
26562 take_vertical_position_into_account (it
);
26563 if (it
->ascent
< 0)
26565 if (it
->descent
< 0)
26569 append_composite_glyph (it
);
26571 else if (it
->what
== IT_GLYPHLESS
)
26572 produce_glyphless_glyph (it
, 0, Qnil
);
26573 else if (it
->what
== IT_IMAGE
)
26574 produce_image_glyph (it
);
26575 else if (it
->what
== IT_STRETCH
)
26576 produce_stretch_glyph (it
);
26579 /* Accumulate dimensions. Note: can't assume that it->descent > 0
26580 because this isn't true for images with `:ascent 100'. */
26581 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
26582 if (it
->area
== TEXT_AREA
)
26583 it
->current_x
+= it
->pixel_width
;
26585 if (extra_line_spacing
> 0)
26587 it
->descent
+= extra_line_spacing
;
26588 if (extra_line_spacing
> it
->max_extra_line_spacing
)
26589 it
->max_extra_line_spacing
= extra_line_spacing
;
26592 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
26593 it
->max_descent
= max (it
->max_descent
, it
->descent
);
26594 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
26595 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
26599 Output LEN glyphs starting at START at the nominal cursor position.
26600 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
26601 being updated, and UPDATED_AREA is the area of that row being updated. */
26604 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26605 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26607 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
26609 eassert (updated_row
);
26610 /* When the window is hscrolled, cursor hpos can legitimately be out
26611 of bounds, but we draw the cursor at the corresponding window
26612 margin in that case. */
26613 if (!updated_row
->reversed_p
&& chpos
< 0)
26615 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
26616 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
26620 /* Write glyphs. */
26622 hpos
= start
- updated_row
->glyphs
[updated_area
];
26623 x
= draw_glyphs (w
, w
->output_cursor
.x
,
26624 updated_row
, updated_area
,
26626 DRAW_NORMAL_TEXT
, 0);
26628 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
26629 if (updated_area
== TEXT_AREA
26630 && w
->phys_cursor_on_p
26631 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
26633 && chpos
< hpos
+ len
)
26634 w
->phys_cursor_on_p
= 0;
26638 /* Advance the output cursor. */
26639 w
->output_cursor
.hpos
+= len
;
26640 w
->output_cursor
.x
= x
;
26645 Insert LEN glyphs from START at the nominal cursor position. */
26648 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26649 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26652 int line_height
, shift_by_width
, shifted_region_width
;
26653 struct glyph_row
*row
;
26654 struct glyph
*glyph
;
26655 int frame_x
, frame_y
;
26658 eassert (updated_row
);
26660 f
= XFRAME (WINDOW_FRAME (w
));
26662 /* Get the height of the line we are in. */
26664 line_height
= row
->height
;
26666 /* Get the width of the glyphs to insert. */
26667 shift_by_width
= 0;
26668 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
26669 shift_by_width
+= glyph
->pixel_width
;
26671 /* Get the width of the region to shift right. */
26672 shifted_region_width
= (window_box_width (w
, updated_area
)
26673 - w
->output_cursor
.x
26677 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
26678 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
26680 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
26681 line_height
, shift_by_width
);
26683 /* Write the glyphs. */
26684 hpos
= start
- row
->glyphs
[updated_area
];
26685 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
26687 DRAW_NORMAL_TEXT
, 0);
26689 /* Advance the output cursor. */
26690 w
->output_cursor
.hpos
+= len
;
26691 w
->output_cursor
.x
+= shift_by_width
;
26697 Erase the current text line from the nominal cursor position
26698 (inclusive) to pixel column TO_X (exclusive). The idea is that
26699 everything from TO_X onward is already erased.
26701 TO_X is a pixel position relative to UPDATED_AREA of currently
26702 updated window W. TO_X == -1 means clear to the end of this area. */
26705 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
26706 enum glyph_row_area updated_area
, int to_x
)
26709 int max_x
, min_y
, max_y
;
26710 int from_x
, from_y
, to_y
;
26712 eassert (updated_row
);
26713 f
= XFRAME (w
->frame
);
26715 if (updated_row
->full_width_p
)
26716 max_x
= (WINDOW_PIXEL_WIDTH (w
)
26717 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
26719 max_x
= window_box_width (w
, updated_area
);
26720 max_y
= window_text_bottom_y (w
);
26722 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
26723 of window. For TO_X > 0, truncate to end of drawing area. */
26729 to_x
= min (to_x
, max_x
);
26731 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
26733 /* Notice if the cursor will be cleared by this operation. */
26734 if (!updated_row
->full_width_p
)
26735 notice_overwritten_cursor (w
, updated_area
,
26736 w
->output_cursor
.x
, -1,
26738 MATRIX_ROW_BOTTOM_Y (updated_row
));
26740 from_x
= w
->output_cursor
.x
;
26742 /* Translate to frame coordinates. */
26743 if (updated_row
->full_width_p
)
26745 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
26746 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
26750 int area_left
= window_box_left (w
, updated_area
);
26751 from_x
+= area_left
;
26755 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
26756 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
26757 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
26759 /* Prevent inadvertently clearing to end of the X window. */
26760 if (to_x
> from_x
&& to_y
> from_y
)
26763 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
26764 to_x
- from_x
, to_y
- from_y
);
26769 #endif /* HAVE_WINDOW_SYSTEM */
26773 /***********************************************************************
26775 ***********************************************************************/
26777 /* Value is the internal representation of the specified cursor type
26778 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
26779 of the bar cursor. */
26781 static enum text_cursor_kinds
26782 get_specified_cursor_type (Lisp_Object arg
, int *width
)
26784 enum text_cursor_kinds type
;
26789 if (EQ (arg
, Qbox
))
26790 return FILLED_BOX_CURSOR
;
26792 if (EQ (arg
, Qhollow
))
26793 return HOLLOW_BOX_CURSOR
;
26795 if (EQ (arg
, Qbar
))
26802 && EQ (XCAR (arg
), Qbar
)
26803 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
26805 *width
= XINT (XCDR (arg
));
26809 if (EQ (arg
, Qhbar
))
26812 return HBAR_CURSOR
;
26816 && EQ (XCAR (arg
), Qhbar
)
26817 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
26819 *width
= XINT (XCDR (arg
));
26820 return HBAR_CURSOR
;
26823 /* Treat anything unknown as "hollow box cursor".
26824 It was bad to signal an error; people have trouble fixing
26825 .Xdefaults with Emacs, when it has something bad in it. */
26826 type
= HOLLOW_BOX_CURSOR
;
26831 /* Set the default cursor types for specified frame. */
26833 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
26838 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
26839 FRAME_CURSOR_WIDTH (f
) = width
;
26841 /* By default, set up the blink-off state depending on the on-state. */
26843 tem
= Fassoc (arg
, Vblink_cursor_alist
);
26846 FRAME_BLINK_OFF_CURSOR (f
)
26847 = get_specified_cursor_type (XCDR (tem
), &width
);
26848 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
26851 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
26853 /* Make sure the cursor gets redrawn. */
26854 f
->cursor_type_changed
= 1;
26858 #ifdef HAVE_WINDOW_SYSTEM
26860 /* Return the cursor we want to be displayed in window W. Return
26861 width of bar/hbar cursor through WIDTH arg. Return with
26862 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
26863 (i.e. if the `system caret' should track this cursor).
26865 In a mini-buffer window, we want the cursor only to appear if we
26866 are reading input from this window. For the selected window, we
26867 want the cursor type given by the frame parameter or buffer local
26868 setting of cursor-type. If explicitly marked off, draw no cursor.
26869 In all other cases, we want a hollow box cursor. */
26871 static enum text_cursor_kinds
26872 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
26873 int *active_cursor
)
26875 struct frame
*f
= XFRAME (w
->frame
);
26876 struct buffer
*b
= XBUFFER (w
->contents
);
26877 int cursor_type
= DEFAULT_CURSOR
;
26878 Lisp_Object alt_cursor
;
26879 int non_selected
= 0;
26881 *active_cursor
= 1;
26884 if (cursor_in_echo_area
26885 && FRAME_HAS_MINIBUF_P (f
)
26886 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
26888 if (w
== XWINDOW (echo_area_window
))
26890 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
26892 *width
= FRAME_CURSOR_WIDTH (f
);
26893 return FRAME_DESIRED_CURSOR (f
);
26896 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
26899 *active_cursor
= 0;
26903 /* Detect a nonselected window or nonselected frame. */
26904 else if (w
!= XWINDOW (f
->selected_window
)
26905 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
26907 *active_cursor
= 0;
26909 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
26915 /* Never display a cursor in a window in which cursor-type is nil. */
26916 if (NILP (BVAR (b
, cursor_type
)))
26919 /* Get the normal cursor type for this window. */
26920 if (EQ (BVAR (b
, cursor_type
), Qt
))
26922 cursor_type
= FRAME_DESIRED_CURSOR (f
);
26923 *width
= FRAME_CURSOR_WIDTH (f
);
26926 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
26928 /* Use cursor-in-non-selected-windows instead
26929 for non-selected window or frame. */
26932 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
26933 if (!EQ (Qt
, alt_cursor
))
26934 return get_specified_cursor_type (alt_cursor
, width
);
26935 /* t means modify the normal cursor type. */
26936 if (cursor_type
== FILLED_BOX_CURSOR
)
26937 cursor_type
= HOLLOW_BOX_CURSOR
;
26938 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
26940 return cursor_type
;
26943 /* Use normal cursor if not blinked off. */
26944 if (!w
->cursor_off_p
)
26946 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26948 if (cursor_type
== FILLED_BOX_CURSOR
)
26950 /* Using a block cursor on large images can be very annoying.
26951 So use a hollow cursor for "large" images.
26952 If image is not transparent (no mask), also use hollow cursor. */
26953 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26954 if (img
!= NULL
&& IMAGEP (img
->spec
))
26956 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
26957 where N = size of default frame font size.
26958 This should cover most of the "tiny" icons people may use. */
26960 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
26961 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
26962 cursor_type
= HOLLOW_BOX_CURSOR
;
26965 else if (cursor_type
!= NO_CURSOR
)
26967 /* Display current only supports BOX and HOLLOW cursors for images.
26968 So for now, unconditionally use a HOLLOW cursor when cursor is
26969 not a solid box cursor. */
26970 cursor_type
= HOLLOW_BOX_CURSOR
;
26973 return cursor_type
;
26976 /* Cursor is blinked off, so determine how to "toggle" it. */
26978 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
26979 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
26980 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
26982 /* Then see if frame has specified a specific blink off cursor type. */
26983 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
26985 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
26986 return FRAME_BLINK_OFF_CURSOR (f
);
26990 /* Some people liked having a permanently visible blinking cursor,
26991 while others had very strong opinions against it. So it was
26992 decided to remove it. KFS 2003-09-03 */
26994 /* Finally perform built-in cursor blinking:
26995 filled box <-> hollow box
26996 wide [h]bar <-> narrow [h]bar
26997 narrow [h]bar <-> no cursor
26998 other type <-> no cursor */
27000 if (cursor_type
== FILLED_BOX_CURSOR
)
27001 return HOLLOW_BOX_CURSOR
;
27003 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
27006 return cursor_type
;
27014 /* Notice when the text cursor of window W has been completely
27015 overwritten by a drawing operation that outputs glyphs in AREA
27016 starting at X0 and ending at X1 in the line starting at Y0 and
27017 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27018 the rest of the line after X0 has been written. Y coordinates
27019 are window-relative. */
27022 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
27023 int x0
, int x1
, int y0
, int y1
)
27025 int cx0
, cx1
, cy0
, cy1
;
27026 struct glyph_row
*row
;
27028 if (!w
->phys_cursor_on_p
)
27030 if (area
!= TEXT_AREA
)
27033 if (w
->phys_cursor
.vpos
< 0
27034 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27035 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27036 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27039 if (row
->cursor_in_fringe_p
)
27041 row
->cursor_in_fringe_p
= 0;
27042 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27043 w
->phys_cursor_on_p
= 0;
27047 cx0
= w
->phys_cursor
.x
;
27048 cx1
= cx0
+ w
->phys_cursor_width
;
27049 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27052 /* The cursor image will be completely removed from the
27053 screen if the output area intersects the cursor area in
27054 y-direction. When we draw in [y0 y1[, and some part of
27055 the cursor is at y < y0, that part must have been drawn
27056 before. When scrolling, the cursor is erased before
27057 actually scrolling, so we don't come here. When not
27058 scrolling, the rows above the old cursor row must have
27059 changed, and in this case these rows must have written
27060 over the cursor image.
27062 Likewise if part of the cursor is below y1, with the
27063 exception of the cursor being in the first blank row at
27064 the buffer and window end because update_text_area
27065 doesn't draw that row. (Except when it does, but
27066 that's handled in update_text_area.) */
27068 cy0
= w
->phys_cursor
.y
;
27069 cy1
= cy0
+ w
->phys_cursor_height
;
27070 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27073 w
->phys_cursor_on_p
= 0;
27076 #endif /* HAVE_WINDOW_SYSTEM */
27079 /************************************************************************
27081 ************************************************************************/
27083 #ifdef HAVE_WINDOW_SYSTEM
27086 Fix the display of area AREA of overlapping row ROW in window W
27087 with respect to the overlapping part OVERLAPS. */
27090 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27091 enum glyph_row_area area
, int overlaps
)
27098 for (i
= 0; i
< row
->used
[area
];)
27100 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27102 int start
= i
, start_x
= x
;
27106 x
+= row
->glyphs
[area
][i
].pixel_width
;
27109 while (i
< row
->used
[area
]
27110 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27112 draw_glyphs (w
, start_x
, row
, area
,
27114 DRAW_NORMAL_TEXT
, overlaps
);
27118 x
+= row
->glyphs
[area
][i
].pixel_width
;
27128 Draw the cursor glyph of window W in glyph row ROW. See the
27129 comment of draw_glyphs for the meaning of HL. */
27132 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27133 enum draw_glyphs_face hl
)
27135 /* If cursor hpos is out of bounds, don't draw garbage. This can
27136 happen in mini-buffer windows when switching between echo area
27137 glyphs and mini-buffer. */
27138 if ((row
->reversed_p
27139 ? (w
->phys_cursor
.hpos
>= 0)
27140 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27142 int on_p
= w
->phys_cursor_on_p
;
27144 int hpos
= w
->phys_cursor
.hpos
;
27146 /* When the window is hscrolled, cursor hpos can legitimately be
27147 out of bounds, but we draw the cursor at the corresponding
27148 window margin in that case. */
27149 if (!row
->reversed_p
&& hpos
< 0)
27151 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27152 hpos
= row
->used
[TEXT_AREA
] - 1;
27154 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27156 w
->phys_cursor_on_p
= on_p
;
27158 if (hl
== DRAW_CURSOR
)
27159 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27160 /* When we erase the cursor, and ROW is overlapped by other
27161 rows, make sure that these overlapping parts of other rows
27163 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27165 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27167 if (row
> w
->current_matrix
->rows
27168 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27169 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27170 OVERLAPS_ERASED_CURSOR
);
27172 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27173 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27174 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27175 OVERLAPS_ERASED_CURSOR
);
27181 /* Erase the image of a cursor of window W from the screen. */
27187 erase_phys_cursor (struct window
*w
)
27189 struct frame
*f
= XFRAME (w
->frame
);
27190 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27191 int hpos
= w
->phys_cursor
.hpos
;
27192 int vpos
= w
->phys_cursor
.vpos
;
27193 int mouse_face_here_p
= 0;
27194 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27195 struct glyph_row
*cursor_row
;
27196 struct glyph
*cursor_glyph
;
27197 enum draw_glyphs_face hl
;
27199 /* No cursor displayed or row invalidated => nothing to do on the
27201 if (w
->phys_cursor_type
== NO_CURSOR
)
27202 goto mark_cursor_off
;
27204 /* VPOS >= active_glyphs->nrows means that window has been resized.
27205 Don't bother to erase the cursor. */
27206 if (vpos
>= active_glyphs
->nrows
)
27207 goto mark_cursor_off
;
27209 /* If row containing cursor is marked invalid, there is nothing we
27211 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27212 if (!cursor_row
->enabled_p
)
27213 goto mark_cursor_off
;
27215 /* If line spacing is > 0, old cursor may only be partially visible in
27216 window after split-window. So adjust visible height. */
27217 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27218 window_text_bottom_y (w
) - cursor_row
->y
);
27220 /* If row is completely invisible, don't attempt to delete a cursor which
27221 isn't there. This can happen if cursor is at top of a window, and
27222 we switch to a buffer with a header line in that window. */
27223 if (cursor_row
->visible_height
<= 0)
27224 goto mark_cursor_off
;
27226 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27227 if (cursor_row
->cursor_in_fringe_p
)
27229 cursor_row
->cursor_in_fringe_p
= 0;
27230 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27231 goto mark_cursor_off
;
27234 /* This can happen when the new row is shorter than the old one.
27235 In this case, either draw_glyphs or clear_end_of_line
27236 should have cleared the cursor. Note that we wouldn't be
27237 able to erase the cursor in this case because we don't have a
27238 cursor glyph at hand. */
27239 if ((cursor_row
->reversed_p
27240 ? (w
->phys_cursor
.hpos
< 0)
27241 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27242 goto mark_cursor_off
;
27244 /* When the window is hscrolled, cursor hpos can legitimately be out
27245 of bounds, but we draw the cursor at the corresponding window
27246 margin in that case. */
27247 if (!cursor_row
->reversed_p
&& hpos
< 0)
27249 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27250 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27252 /* If the cursor is in the mouse face area, redisplay that when
27253 we clear the cursor. */
27254 if (! NILP (hlinfo
->mouse_face_window
)
27255 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27256 /* Don't redraw the cursor's spot in mouse face if it is at the
27257 end of a line (on a newline). The cursor appears there, but
27258 mouse highlighting does not. */
27259 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27260 mouse_face_here_p
= 1;
27262 /* Maybe clear the display under the cursor. */
27263 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27266 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27269 cursor_glyph
= get_phys_cursor_glyph (w
);
27270 if (cursor_glyph
== NULL
)
27271 goto mark_cursor_off
;
27273 width
= cursor_glyph
->pixel_width
;
27274 left_x
= window_box_left_offset (w
, TEXT_AREA
);
27275 x
= w
->phys_cursor
.x
;
27277 width
-= left_x
- x
;
27278 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27279 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27280 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
27283 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27286 /* Erase the cursor by redrawing the character underneath it. */
27287 if (mouse_face_here_p
)
27288 hl
= DRAW_MOUSE_FACE
;
27290 hl
= DRAW_NORMAL_TEXT
;
27291 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27294 w
->phys_cursor_on_p
= 0;
27295 w
->phys_cursor_type
= NO_CURSOR
;
27300 Display or clear cursor of window W. If ON is zero, clear the
27301 cursor. If it is non-zero, display the cursor. If ON is nonzero,
27302 where to put the cursor is specified by HPOS, VPOS, X and Y. */
27305 display_and_set_cursor (struct window
*w
, bool on
,
27306 int hpos
, int vpos
, int x
, int y
)
27308 struct frame
*f
= XFRAME (w
->frame
);
27309 int new_cursor_type
;
27310 int new_cursor_width
;
27312 struct glyph_row
*glyph_row
;
27313 struct glyph
*glyph
;
27315 /* This is pointless on invisible frames, and dangerous on garbaged
27316 windows and frames; in the latter case, the frame or window may
27317 be in the midst of changing its size, and x and y may be off the
27319 if (! FRAME_VISIBLE_P (f
)
27320 || FRAME_GARBAGED_P (f
)
27321 || vpos
>= w
->current_matrix
->nrows
27322 || hpos
>= w
->current_matrix
->matrix_w
)
27325 /* If cursor is off and we want it off, return quickly. */
27326 if (!on
&& !w
->phys_cursor_on_p
)
27329 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27330 /* If cursor row is not enabled, we don't really know where to
27331 display the cursor. */
27332 if (!glyph_row
->enabled_p
)
27334 w
->phys_cursor_on_p
= 0;
27339 if (!glyph_row
->exact_window_width_line_p
27340 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
27341 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
27343 eassert (input_blocked_p ());
27345 /* Set new_cursor_type to the cursor we want to be displayed. */
27346 new_cursor_type
= get_window_cursor_type (w
, glyph
,
27347 &new_cursor_width
, &active_cursor
);
27349 /* If cursor is currently being shown and we don't want it to be or
27350 it is in the wrong place, or the cursor type is not what we want,
27352 if (w
->phys_cursor_on_p
27354 || w
->phys_cursor
.x
!= x
27355 || w
->phys_cursor
.y
!= y
27356 || new_cursor_type
!= w
->phys_cursor_type
27357 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
27358 && new_cursor_width
!= w
->phys_cursor_width
)))
27359 erase_phys_cursor (w
);
27361 /* Don't check phys_cursor_on_p here because that flag is only set
27362 to zero in some cases where we know that the cursor has been
27363 completely erased, to avoid the extra work of erasing the cursor
27364 twice. In other words, phys_cursor_on_p can be 1 and the cursor
27365 still not be visible, or it has only been partly erased. */
27368 w
->phys_cursor_ascent
= glyph_row
->ascent
;
27369 w
->phys_cursor_height
= glyph_row
->height
;
27371 /* Set phys_cursor_.* before x_draw_.* is called because some
27372 of them may need the information. */
27373 w
->phys_cursor
.x
= x
;
27374 w
->phys_cursor
.y
= glyph_row
->y
;
27375 w
->phys_cursor
.hpos
= hpos
;
27376 w
->phys_cursor
.vpos
= vpos
;
27379 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
27380 new_cursor_type
, new_cursor_width
,
27381 on
, active_cursor
);
27385 /* Switch the display of W's cursor on or off, according to the value
27389 update_window_cursor (struct window
*w
, bool on
)
27391 /* Don't update cursor in windows whose frame is in the process
27392 of being deleted. */
27393 if (w
->current_matrix
)
27395 int hpos
= w
->phys_cursor
.hpos
;
27396 int vpos
= w
->phys_cursor
.vpos
;
27397 struct glyph_row
*row
;
27399 if (vpos
>= w
->current_matrix
->nrows
27400 || hpos
>= w
->current_matrix
->matrix_w
)
27403 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27405 /* When the window is hscrolled, cursor hpos can legitimately be
27406 out of bounds, but we draw the cursor at the corresponding
27407 window margin in that case. */
27408 if (!row
->reversed_p
&& hpos
< 0)
27410 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27411 hpos
= row
->used
[TEXT_AREA
] - 1;
27414 display_and_set_cursor (w
, on
, hpos
, vpos
,
27415 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27421 /* Call update_window_cursor with parameter ON_P on all leaf windows
27422 in the window tree rooted at W. */
27425 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
27429 if (WINDOWP (w
->contents
))
27430 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
27432 update_window_cursor (w
, on_p
);
27434 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
27440 Display the cursor on window W, or clear it, according to ON_P.
27441 Don't change the cursor's position. */
27444 x_update_cursor (struct frame
*f
, bool on_p
)
27446 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
27451 Clear the cursor of window W to background color, and mark the
27452 cursor as not shown. This is used when the text where the cursor
27453 is about to be rewritten. */
27456 x_clear_cursor (struct window
*w
)
27458 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
27459 update_window_cursor (w
, 0);
27462 #endif /* HAVE_WINDOW_SYSTEM */
27464 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
27467 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
27468 int start_hpos
, int end_hpos
,
27469 enum draw_glyphs_face draw
)
27471 #ifdef HAVE_WINDOW_SYSTEM
27472 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
27474 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
27478 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
27479 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
27483 /* Display the active region described by mouse_face_* according to DRAW. */
27486 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
27488 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
27489 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27491 if (/* If window is in the process of being destroyed, don't bother
27493 w
->current_matrix
!= NULL
27494 /* Don't update mouse highlight if hidden. */
27495 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
27496 /* Recognize when we are called to operate on rows that don't exist
27497 anymore. This can happen when a window is split. */
27498 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
27500 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
27501 struct glyph_row
*row
, *first
, *last
;
27503 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
27504 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
27506 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
27508 int start_hpos
, end_hpos
, start_x
;
27510 /* For all but the first row, the highlight starts at column 0. */
27513 /* R2L rows have BEG and END in reversed order, but the
27514 screen drawing geometry is always left to right. So
27515 we need to mirror the beginning and end of the
27516 highlighted area in R2L rows. */
27517 if (!row
->reversed_p
)
27519 start_hpos
= hlinfo
->mouse_face_beg_col
;
27520 start_x
= hlinfo
->mouse_face_beg_x
;
27522 else if (row
== last
)
27524 start_hpos
= hlinfo
->mouse_face_end_col
;
27525 start_x
= hlinfo
->mouse_face_end_x
;
27533 else if (row
->reversed_p
&& row
== last
)
27535 start_hpos
= hlinfo
->mouse_face_end_col
;
27536 start_x
= hlinfo
->mouse_face_end_x
;
27546 if (!row
->reversed_p
)
27547 end_hpos
= hlinfo
->mouse_face_end_col
;
27548 else if (row
== first
)
27549 end_hpos
= hlinfo
->mouse_face_beg_col
;
27552 end_hpos
= row
->used
[TEXT_AREA
];
27553 if (draw
== DRAW_NORMAL_TEXT
)
27554 row
->fill_line_p
= 1; /* Clear to end of line */
27557 else if (row
->reversed_p
&& row
== first
)
27558 end_hpos
= hlinfo
->mouse_face_beg_col
;
27561 end_hpos
= row
->used
[TEXT_AREA
];
27562 if (draw
== DRAW_NORMAL_TEXT
)
27563 row
->fill_line_p
= 1; /* Clear to end of line */
27566 if (end_hpos
> start_hpos
)
27568 draw_row_with_mouse_face (w
, start_x
, row
,
27569 start_hpos
, end_hpos
, draw
);
27572 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
27576 #ifdef HAVE_WINDOW_SYSTEM
27577 /* When we've written over the cursor, arrange for it to
27578 be displayed again. */
27579 if (FRAME_WINDOW_P (f
)
27580 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
27582 int hpos
= w
->phys_cursor
.hpos
;
27584 /* When the window is hscrolled, cursor hpos can legitimately be
27585 out of bounds, but we draw the cursor at the corresponding
27586 window margin in that case. */
27587 if (!row
->reversed_p
&& hpos
< 0)
27589 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27590 hpos
= row
->used
[TEXT_AREA
] - 1;
27593 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
27594 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27597 #endif /* HAVE_WINDOW_SYSTEM */
27600 #ifdef HAVE_WINDOW_SYSTEM
27601 /* Change the mouse cursor. */
27602 if (FRAME_WINDOW_P (f
))
27604 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
27605 if (draw
== DRAW_NORMAL_TEXT
27606 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
27607 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
27610 if (draw
== DRAW_MOUSE_FACE
)
27611 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
27613 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
27615 #endif /* HAVE_WINDOW_SYSTEM */
27619 Clear out the mouse-highlighted active region.
27620 Redraw it un-highlighted first. Value is non-zero if mouse
27621 face was actually drawn unhighlighted. */
27624 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
27628 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
27630 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
27634 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27635 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27636 hlinfo
->mouse_face_window
= Qnil
;
27637 hlinfo
->mouse_face_overlay
= Qnil
;
27641 /* Return true if the coordinates HPOS and VPOS on windows W are
27642 within the mouse face on that window. */
27644 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
27646 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27648 /* Quickly resolve the easy cases. */
27649 if (!(WINDOWP (hlinfo
->mouse_face_window
)
27650 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
27652 if (vpos
< hlinfo
->mouse_face_beg_row
27653 || vpos
> hlinfo
->mouse_face_end_row
)
27655 if (vpos
> hlinfo
->mouse_face_beg_row
27656 && vpos
< hlinfo
->mouse_face_end_row
)
27659 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
27661 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27663 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
27666 else if ((vpos
== hlinfo
->mouse_face_beg_row
27667 && hpos
>= hlinfo
->mouse_face_beg_col
)
27668 || (vpos
== hlinfo
->mouse_face_end_row
27669 && hpos
< hlinfo
->mouse_face_end_col
))
27674 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27676 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
27679 else if ((vpos
== hlinfo
->mouse_face_beg_row
27680 && hpos
<= hlinfo
->mouse_face_beg_col
)
27681 || (vpos
== hlinfo
->mouse_face_end_row
27682 && hpos
> hlinfo
->mouse_face_end_col
))
27690 True if physical cursor of window W is within mouse face. */
27693 cursor_in_mouse_face_p (struct window
*w
)
27695 int hpos
= w
->phys_cursor
.hpos
;
27696 int vpos
= w
->phys_cursor
.vpos
;
27697 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27699 /* When the window is hscrolled, cursor hpos can legitimately be out
27700 of bounds, but we draw the cursor at the corresponding window
27701 margin in that case. */
27702 if (!row
->reversed_p
&& hpos
< 0)
27704 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27705 hpos
= row
->used
[TEXT_AREA
] - 1;
27707 return coords_in_mouse_face_p (w
, hpos
, vpos
);
27712 /* Find the glyph rows START_ROW and END_ROW of window W that display
27713 characters between buffer positions START_CHARPOS and END_CHARPOS
27714 (excluding END_CHARPOS). DISP_STRING is a display string that
27715 covers these buffer positions. This is similar to
27716 row_containing_pos, but is more accurate when bidi reordering makes
27717 buffer positions change non-linearly with glyph rows. */
27719 rows_from_pos_range (struct window
*w
,
27720 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
27721 Lisp_Object disp_string
,
27722 struct glyph_row
**start
, struct glyph_row
**end
)
27724 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27725 int last_y
= window_text_bottom_y (w
);
27726 struct glyph_row
*row
;
27731 while (!first
->enabled_p
27732 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
27735 /* Find the START row. */
27737 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
27740 /* A row can potentially be the START row if the range of the
27741 characters it displays intersects the range
27742 [START_CHARPOS..END_CHARPOS). */
27743 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
27744 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
27745 /* See the commentary in row_containing_pos, for the
27746 explanation of the complicated way to check whether
27747 some position is beyond the end of the characters
27748 displayed by a row. */
27749 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27750 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27751 && !row
->ends_at_zv_p
27752 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
27753 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27754 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27755 && !row
->ends_at_zv_p
27756 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
27758 /* Found a candidate row. Now make sure at least one of the
27759 glyphs it displays has a charpos from the range
27760 [START_CHARPOS..END_CHARPOS).
27762 This is not obvious because bidi reordering could make
27763 buffer positions of a row be 1,2,3,102,101,100, and if we
27764 want to highlight characters in [50..60), we don't want
27765 this row, even though [50..60) does intersect [1..103),
27766 the range of character positions given by the row's start
27767 and end positions. */
27768 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
27769 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
27773 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
27774 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
27775 /* A glyph that comes from DISP_STRING is by
27776 definition to be highlighted. */
27777 || EQ (g
->object
, disp_string
))
27786 /* Find the END row. */
27788 /* If the last row is partially visible, start looking for END
27789 from that row, instead of starting from FIRST. */
27790 && !(row
->enabled_p
27791 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
27793 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
27795 struct glyph_row
*next
= row
+ 1;
27796 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
27798 if (!next
->enabled_p
27799 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
27800 /* The first row >= START whose range of displayed characters
27801 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
27802 is the row END + 1. */
27803 || (start_charpos
< next_start
27804 && end_charpos
< next_start
)
27805 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
27806 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
27807 && !next
->ends_at_zv_p
27808 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
27809 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
27810 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
27811 && !next
->ends_at_zv_p
27812 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
27819 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
27820 but none of the characters it displays are in the range, it is
27822 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
27823 struct glyph
*s
= g
;
27824 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
27828 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
27829 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
27830 /* If the buffer position of the first glyph in
27831 the row is equal to END_CHARPOS, it means
27832 the last character to be highlighted is the
27833 newline of ROW, and we must consider NEXT as
27835 || (((!next
->reversed_p
&& g
== s
)
27836 || (next
->reversed_p
&& g
== e
- 1))
27837 && (g
->charpos
== end_charpos
27838 /* Special case for when NEXT is an
27839 empty line at ZV. */
27840 || (g
->charpos
== -1
27841 && !row
->ends_at_zv_p
27842 && next_start
== end_charpos
)))))
27843 /* A glyph that comes from DISP_STRING is by
27844 definition to be highlighted. */
27845 || EQ (g
->object
, disp_string
))
27854 /* The first row that ends at ZV must be the last to be
27856 else if (next
->ends_at_zv_p
)
27865 /* This function sets the mouse_face_* elements of HLINFO, assuming
27866 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
27867 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
27868 for the overlay or run of text properties specifying the mouse
27869 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
27870 before-string and after-string that must also be highlighted.
27871 DISP_STRING, if non-nil, is a display string that may cover some
27872 or all of the highlighted text. */
27875 mouse_face_from_buffer_pos (Lisp_Object window
,
27876 Mouse_HLInfo
*hlinfo
,
27877 ptrdiff_t mouse_charpos
,
27878 ptrdiff_t start_charpos
,
27879 ptrdiff_t end_charpos
,
27880 Lisp_Object before_string
,
27881 Lisp_Object after_string
,
27882 Lisp_Object disp_string
)
27884 struct window
*w
= XWINDOW (window
);
27885 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27886 struct glyph_row
*r1
, *r2
;
27887 struct glyph
*glyph
, *end
;
27888 ptrdiff_t ignore
, pos
;
27891 eassert (NILP (disp_string
) || STRINGP (disp_string
));
27892 eassert (NILP (before_string
) || STRINGP (before_string
));
27893 eassert (NILP (after_string
) || STRINGP (after_string
));
27895 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
27896 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
27898 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
27899 /* If the before-string or display-string contains newlines,
27900 rows_from_pos_range skips to its last row. Move back. */
27901 if (!NILP (before_string
) || !NILP (disp_string
))
27903 struct glyph_row
*prev
;
27904 while ((prev
= r1
- 1, prev
>= first
)
27905 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
27906 && prev
->used
[TEXT_AREA
] > 0)
27908 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
27909 glyph
= beg
+ prev
->used
[TEXT_AREA
];
27910 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
27912 || !(EQ (glyph
->object
, before_string
)
27913 || EQ (glyph
->object
, disp_string
)))
27920 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
27921 hlinfo
->mouse_face_past_end
= 1;
27923 else if (!NILP (after_string
))
27925 /* If the after-string has newlines, advance to its last row. */
27926 struct glyph_row
*next
;
27927 struct glyph_row
*last
27928 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
27930 for (next
= r2
+ 1;
27932 && next
->used
[TEXT_AREA
] > 0
27933 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
27937 /* The rest of the display engine assumes that mouse_face_beg_row is
27938 either above mouse_face_end_row or identical to it. But with
27939 bidi-reordered continued lines, the row for START_CHARPOS could
27940 be below the row for END_CHARPOS. If so, swap the rows and store
27941 them in correct order. */
27944 struct glyph_row
*tem
= r2
;
27950 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
27951 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
27953 /* For a bidi-reordered row, the positions of BEFORE_STRING,
27954 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
27955 could be anywhere in the row and in any order. The strategy
27956 below is to find the leftmost and the rightmost glyph that
27957 belongs to either of these 3 strings, or whose position is
27958 between START_CHARPOS and END_CHARPOS, and highlight all the
27959 glyphs between those two. This may cover more than just the text
27960 between START_CHARPOS and END_CHARPOS if the range of characters
27961 strides the bidi level boundary, e.g. if the beginning is in R2L
27962 text while the end is in L2R text or vice versa. */
27963 if (!r1
->reversed_p
)
27965 /* This row is in a left to right paragraph. Scan it left to
27967 glyph
= r1
->glyphs
[TEXT_AREA
];
27968 end
= glyph
+ r1
->used
[TEXT_AREA
];
27971 /* Skip truncation glyphs at the start of the glyph row. */
27972 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
27974 && INTEGERP (glyph
->object
)
27975 && glyph
->charpos
< 0;
27977 x
+= glyph
->pixel_width
;
27979 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
27980 or DISP_STRING, and the first glyph from buffer whose
27981 position is between START_CHARPOS and END_CHARPOS. */
27983 && !INTEGERP (glyph
->object
)
27984 && !EQ (glyph
->object
, disp_string
)
27985 && !(BUFFERP (glyph
->object
)
27986 && (glyph
->charpos
>= start_charpos
27987 && glyph
->charpos
< end_charpos
));
27990 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27991 are present at buffer positions between START_CHARPOS and
27992 END_CHARPOS, or if they come from an overlay. */
27993 if (EQ (glyph
->object
, before_string
))
27995 pos
= string_buffer_position (before_string
,
27997 /* If pos == 0, it means before_string came from an
27998 overlay, not from a buffer position. */
27999 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28002 else if (EQ (glyph
->object
, after_string
))
28004 pos
= string_buffer_position (after_string
, end_charpos
);
28005 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28008 x
+= glyph
->pixel_width
;
28010 hlinfo
->mouse_face_beg_x
= x
;
28011 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28015 /* This row is in a right to left paragraph. Scan it right to
28019 end
= r1
->glyphs
[TEXT_AREA
] - 1;
28020 glyph
= end
+ r1
->used
[TEXT_AREA
];
28022 /* Skip truncation glyphs at the start of the glyph row. */
28023 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28025 && INTEGERP (glyph
->object
)
28026 && glyph
->charpos
< 0;
28030 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28031 or DISP_STRING, and the first glyph from buffer whose
28032 position is between START_CHARPOS and END_CHARPOS. */
28034 && !INTEGERP (glyph
->object
)
28035 && !EQ (glyph
->object
, disp_string
)
28036 && !(BUFFERP (glyph
->object
)
28037 && (glyph
->charpos
>= start_charpos
28038 && glyph
->charpos
< end_charpos
));
28041 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28042 are present at buffer positions between START_CHARPOS and
28043 END_CHARPOS, or if they come from an overlay. */
28044 if (EQ (glyph
->object
, before_string
))
28046 pos
= string_buffer_position (before_string
, start_charpos
);
28047 /* If pos == 0, it means before_string came from an
28048 overlay, not from a buffer position. */
28049 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28052 else if (EQ (glyph
->object
, after_string
))
28054 pos
= string_buffer_position (after_string
, end_charpos
);
28055 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28060 glyph
++; /* first glyph to the right of the highlighted area */
28061 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28062 x
+= g
->pixel_width
;
28063 hlinfo
->mouse_face_beg_x
= x
;
28064 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28067 /* If the highlight ends in a different row, compute GLYPH and END
28068 for the end row. Otherwise, reuse the values computed above for
28069 the row where the highlight begins. */
28072 if (!r2
->reversed_p
)
28074 glyph
= r2
->glyphs
[TEXT_AREA
];
28075 end
= glyph
+ r2
->used
[TEXT_AREA
];
28080 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28081 glyph
= end
+ r2
->used
[TEXT_AREA
];
28085 if (!r2
->reversed_p
)
28087 /* Skip truncation and continuation glyphs near the end of the
28088 row, and also blanks and stretch glyphs inserted by
28089 extend_face_to_end_of_line. */
28091 && INTEGERP ((end
- 1)->object
))
28093 /* Scan the rest of the glyph row from the end, looking for the
28094 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28095 DISP_STRING, or whose position is between START_CHARPOS
28099 && !INTEGERP (end
->object
)
28100 && !EQ (end
->object
, disp_string
)
28101 && !(BUFFERP (end
->object
)
28102 && (end
->charpos
>= start_charpos
28103 && end
->charpos
< end_charpos
));
28106 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28107 are present at buffer positions between START_CHARPOS and
28108 END_CHARPOS, or if they come from an overlay. */
28109 if (EQ (end
->object
, before_string
))
28111 pos
= string_buffer_position (before_string
, start_charpos
);
28112 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28115 else if (EQ (end
->object
, after_string
))
28117 pos
= string_buffer_position (after_string
, end_charpos
);
28118 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28122 /* Find the X coordinate of the last glyph to be highlighted. */
28123 for (; glyph
<= end
; ++glyph
)
28124 x
+= glyph
->pixel_width
;
28126 hlinfo
->mouse_face_end_x
= x
;
28127 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28131 /* Skip truncation and continuation glyphs near the end of the
28132 row, and also blanks and stretch glyphs inserted by
28133 extend_face_to_end_of_line. */
28137 && INTEGERP (end
->object
))
28139 x
+= end
->pixel_width
;
28142 /* Scan the rest of the glyph row from the end, looking for the
28143 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28144 DISP_STRING, or whose position is between START_CHARPOS
28148 && !INTEGERP (end
->object
)
28149 && !EQ (end
->object
, disp_string
)
28150 && !(BUFFERP (end
->object
)
28151 && (end
->charpos
>= start_charpos
28152 && end
->charpos
< end_charpos
));
28155 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28156 are present at buffer positions between START_CHARPOS and
28157 END_CHARPOS, or if they come from an overlay. */
28158 if (EQ (end
->object
, before_string
))
28160 pos
= string_buffer_position (before_string
, start_charpos
);
28161 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28164 else if (EQ (end
->object
, after_string
))
28166 pos
= string_buffer_position (after_string
, end_charpos
);
28167 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28170 x
+= end
->pixel_width
;
28172 /* If we exited the above loop because we arrived at the last
28173 glyph of the row, and its buffer position is still not in
28174 range, it means the last character in range is the preceding
28175 newline. Bump the end column and x values to get past the
28178 && BUFFERP (end
->object
)
28179 && (end
->charpos
< start_charpos
28180 || end
->charpos
>= end_charpos
))
28182 x
+= end
->pixel_width
;
28185 hlinfo
->mouse_face_end_x
= x
;
28186 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28189 hlinfo
->mouse_face_window
= window
;
28190 hlinfo
->mouse_face_face_id
28191 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28193 !hlinfo
->mouse_face_hidden
, -1);
28194 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28197 /* The following function is not used anymore (replaced with
28198 mouse_face_from_string_pos), but I leave it here for the time
28199 being, in case someone would. */
28201 #if 0 /* not used */
28203 /* Find the position of the glyph for position POS in OBJECT in
28204 window W's current matrix, and return in *X, *Y the pixel
28205 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28207 RIGHT_P non-zero means return the position of the right edge of the
28208 glyph, RIGHT_P zero means return the left edge position.
28210 If no glyph for POS exists in the matrix, return the position of
28211 the glyph with the next smaller position that is in the matrix, if
28212 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
28213 exists in the matrix, return the position of the glyph with the
28214 next larger position in OBJECT.
28216 Value is non-zero if a glyph was found. */
28219 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28220 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
28222 int yb
= window_text_bottom_y (w
);
28223 struct glyph_row
*r
;
28224 struct glyph
*best_glyph
= NULL
;
28225 struct glyph_row
*best_row
= NULL
;
28228 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28229 r
->enabled_p
&& r
->y
< yb
;
28232 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28233 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28236 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28237 if (EQ (g
->object
, object
))
28239 if (g
->charpos
== pos
)
28246 else if (best_glyph
== NULL
28247 || ((eabs (g
->charpos
- pos
)
28248 < eabs (best_glyph
->charpos
- pos
))
28251 : g
->charpos
> pos
)))
28265 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28269 *x
+= best_glyph
->pixel_width
;
28274 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28277 return best_glyph
!= NULL
;
28279 #endif /* not used */
28281 /* Find the positions of the first and the last glyphs in window W's
28282 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28283 (assumed to be a string), and return in HLINFO's mouse_face_*
28284 members the pixel and column/row coordinates of those glyphs. */
28287 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28288 Lisp_Object object
,
28289 ptrdiff_t startpos
, ptrdiff_t endpos
)
28291 int yb
= window_text_bottom_y (w
);
28292 struct glyph_row
*r
;
28293 struct glyph
*g
, *e
;
28297 /* Find the glyph row with at least one position in the range
28298 [STARTPOS..ENDPOS), and the first glyph in that row whose
28299 position belongs to that range. */
28300 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28301 r
->enabled_p
&& r
->y
< yb
;
28304 if (!r
->reversed_p
)
28306 g
= r
->glyphs
[TEXT_AREA
];
28307 e
= g
+ r
->used
[TEXT_AREA
];
28308 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28309 if (EQ (g
->object
, object
)
28310 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28312 hlinfo
->mouse_face_beg_row
28313 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28314 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28315 hlinfo
->mouse_face_beg_x
= gx
;
28324 e
= r
->glyphs
[TEXT_AREA
];
28325 g
= e
+ r
->used
[TEXT_AREA
];
28326 for ( ; g
> e
; --g
)
28327 if (EQ ((g
-1)->object
, object
)
28328 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
28330 hlinfo
->mouse_face_beg_row
28331 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28332 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28333 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
28334 gx
+= g1
->pixel_width
;
28335 hlinfo
->mouse_face_beg_x
= gx
;
28347 /* Starting with the next row, look for the first row which does NOT
28348 include any glyphs whose positions are in the range. */
28349 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
28351 g
= r
->glyphs
[TEXT_AREA
];
28352 e
= g
+ r
->used
[TEXT_AREA
];
28354 for ( ; g
< e
; ++g
)
28355 if (EQ (g
->object
, object
)
28356 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28365 /* The highlighted region ends on the previous row. */
28368 /* Set the end row. */
28369 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28371 /* Compute and set the end column and the end column's horizontal
28372 pixel coordinate. */
28373 if (!r
->reversed_p
)
28375 g
= r
->glyphs
[TEXT_AREA
];
28376 e
= g
+ r
->used
[TEXT_AREA
];
28377 for ( ; e
> g
; --e
)
28378 if (EQ ((e
-1)->object
, object
)
28379 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
28381 hlinfo
->mouse_face_end_col
= e
- g
;
28383 for (gx
= r
->x
; g
< e
; ++g
)
28384 gx
+= g
->pixel_width
;
28385 hlinfo
->mouse_face_end_x
= gx
;
28389 e
= r
->glyphs
[TEXT_AREA
];
28390 g
= e
+ r
->used
[TEXT_AREA
];
28391 for (gx
= r
->x
; e
< g
; ++e
)
28393 if (EQ (e
->object
, object
)
28394 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
28396 gx
+= e
->pixel_width
;
28398 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
28399 hlinfo
->mouse_face_end_x
= gx
;
28403 #ifdef HAVE_WINDOW_SYSTEM
28405 /* See if position X, Y is within a hot-spot of an image. */
28408 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
28410 if (!CONSP (hot_spot
))
28413 if (EQ (XCAR (hot_spot
), Qrect
))
28415 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
28416 Lisp_Object rect
= XCDR (hot_spot
);
28420 if (!CONSP (XCAR (rect
)))
28422 if (!CONSP (XCDR (rect
)))
28424 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
28426 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
28428 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
28430 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
28434 else if (EQ (XCAR (hot_spot
), Qcircle
))
28436 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
28437 Lisp_Object circ
= XCDR (hot_spot
);
28438 Lisp_Object lr
, lx0
, ly0
;
28440 && CONSP (XCAR (circ
))
28441 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
28442 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
28443 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
28445 double r
= XFLOATINT (lr
);
28446 double dx
= XINT (lx0
) - x
;
28447 double dy
= XINT (ly0
) - y
;
28448 return (dx
* dx
+ dy
* dy
<= r
* r
);
28451 else if (EQ (XCAR (hot_spot
), Qpoly
))
28453 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
28454 if (VECTORP (XCDR (hot_spot
)))
28456 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
28457 Lisp_Object
*poly
= v
->contents
;
28458 ptrdiff_t n
= v
->header
.size
;
28461 Lisp_Object lx
, ly
;
28464 /* Need an even number of coordinates, and at least 3 edges. */
28465 if (n
< 6 || n
& 1)
28468 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
28469 If count is odd, we are inside polygon. Pixels on edges
28470 may or may not be included depending on actual geometry of the
28472 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
28473 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
28475 x0
= XINT (lx
), y0
= XINT (ly
);
28476 for (i
= 0; i
< n
; i
+= 2)
28478 int x1
= x0
, y1
= y0
;
28479 if ((lx
= poly
[i
], !INTEGERP (lx
))
28480 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
28482 x0
= XINT (lx
), y0
= XINT (ly
);
28484 /* Does this segment cross the X line? */
28492 if (y
> y0
&& y
> y1
)
28494 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
28504 find_hot_spot (Lisp_Object map
, int x
, int y
)
28506 while (CONSP (map
))
28508 if (CONSP (XCAR (map
))
28509 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
28517 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
28519 doc
: /* Lookup in image map MAP coordinates X and Y.
28520 An image map is an alist where each element has the format (AREA ID PLIST).
28521 An AREA is specified as either a rectangle, a circle, or a polygon:
28522 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
28523 pixel coordinates of the upper left and bottom right corners.
28524 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
28525 and the radius of the circle; r may be a float or integer.
28526 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
28527 vector describes one corner in the polygon.
28528 Returns the alist element for the first matching AREA in MAP. */)
28529 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
28537 return find_hot_spot (map
,
28538 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
28539 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
28543 /* Display frame CURSOR, optionally using shape defined by POINTER. */
28545 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
28547 /* Do not change cursor shape while dragging mouse. */
28548 if (!NILP (do_mouse_tracking
))
28551 if (!NILP (pointer
))
28553 if (EQ (pointer
, Qarrow
))
28554 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28555 else if (EQ (pointer
, Qhand
))
28556 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
28557 else if (EQ (pointer
, Qtext
))
28558 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
28559 else if (EQ (pointer
, intern ("hdrag")))
28560 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28561 else if (EQ (pointer
, intern ("nhdrag")))
28562 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
28563 #ifdef HAVE_X_WINDOWS
28564 else if (EQ (pointer
, intern ("vdrag")))
28565 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28567 else if (EQ (pointer
, intern ("hourglass")))
28568 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
28569 else if (EQ (pointer
, Qmodeline
))
28570 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
28572 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28575 if (cursor
!= No_Cursor
)
28576 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
28579 #endif /* HAVE_WINDOW_SYSTEM */
28581 /* Take proper action when mouse has moved to the mode or header line
28582 or marginal area AREA of window W, x-position X and y-position Y.
28583 X is relative to the start of the text display area of W, so the
28584 width of bitmap areas and scroll bars must be subtracted to get a
28585 position relative to the start of the mode line. */
28588 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
28589 enum window_part area
)
28591 struct window
*w
= XWINDOW (window
);
28592 struct frame
*f
= XFRAME (w
->frame
);
28593 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28594 #ifdef HAVE_WINDOW_SYSTEM
28595 Display_Info
*dpyinfo
;
28597 Cursor cursor
= No_Cursor
;
28598 Lisp_Object pointer
= Qnil
;
28599 int dx
, dy
, width
, height
;
28601 Lisp_Object string
, object
= Qnil
;
28602 Lisp_Object pos
IF_LINT (= Qnil
), help
;
28604 Lisp_Object mouse_face
;
28605 int original_x_pixel
= x
;
28606 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
28607 struct glyph_row
*row
IF_LINT (= 0);
28609 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
28614 /* Kludge alert: mode_line_string takes X/Y in pixels, but
28615 returns them in row/column units! */
28616 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
28617 &object
, &dx
, &dy
, &width
, &height
);
28619 row
= (area
== ON_MODE_LINE
28620 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
28621 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
28623 /* Find the glyph under the mouse pointer. */
28624 if (row
->mode_line_p
&& row
->enabled_p
)
28626 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
28627 end
= glyph
+ row
->used
[TEXT_AREA
];
28629 for (x0
= original_x_pixel
;
28630 glyph
< end
&& x0
>= glyph
->pixel_width
;
28632 x0
-= glyph
->pixel_width
;
28640 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
28641 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
28642 returns them in row/column units! */
28643 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
28644 &object
, &dx
, &dy
, &width
, &height
);
28649 #ifdef HAVE_WINDOW_SYSTEM
28650 if (IMAGEP (object
))
28652 Lisp_Object image_map
, hotspot
;
28653 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
28655 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
28657 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
28661 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
28662 If so, we could look for mouse-enter, mouse-leave
28663 properties in PLIST (and do something...). */
28664 hotspot
= XCDR (hotspot
);
28665 if (CONSP (hotspot
)
28666 && (plist
= XCAR (hotspot
), CONSP (plist
)))
28668 pointer
= Fplist_get (plist
, Qpointer
);
28669 if (NILP (pointer
))
28671 help
= Fplist_get (plist
, Qhelp_echo
);
28674 help_echo_string
= help
;
28675 XSETWINDOW (help_echo_window
, w
);
28676 help_echo_object
= w
->contents
;
28677 help_echo_pos
= charpos
;
28681 if (NILP (pointer
))
28682 pointer
= Fplist_get (XCDR (object
), QCpointer
);
28684 #endif /* HAVE_WINDOW_SYSTEM */
28686 if (STRINGP (string
))
28687 pos
= make_number (charpos
);
28689 /* Set the help text and mouse pointer. If the mouse is on a part
28690 of the mode line without any text (e.g. past the right edge of
28691 the mode line text), use the default help text and pointer. */
28692 if (STRINGP (string
) || area
== ON_MODE_LINE
)
28694 /* Arrange to display the help by setting the global variables
28695 help_echo_string, help_echo_object, and help_echo_pos. */
28698 if (STRINGP (string
))
28699 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
28703 help_echo_string
= help
;
28704 XSETWINDOW (help_echo_window
, w
);
28705 help_echo_object
= string
;
28706 help_echo_pos
= charpos
;
28708 else if (area
== ON_MODE_LINE
)
28710 Lisp_Object default_help
28711 = buffer_local_value_1 (Qmode_line_default_help_echo
,
28714 if (STRINGP (default_help
))
28716 help_echo_string
= default_help
;
28717 XSETWINDOW (help_echo_window
, w
);
28718 help_echo_object
= Qnil
;
28719 help_echo_pos
= -1;
28724 #ifdef HAVE_WINDOW_SYSTEM
28725 /* Change the mouse pointer according to what is under it. */
28726 if (FRAME_WINDOW_P (f
))
28728 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
28730 || NILP (Vresize_mini_windows
));
28732 dpyinfo
= FRAME_DISPLAY_INFO (f
);
28733 if (STRINGP (string
))
28735 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28737 if (NILP (pointer
))
28738 pointer
= Fget_text_property (pos
, Qpointer
, string
);
28740 /* Change the mouse pointer according to what is under X/Y. */
28742 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
28745 map
= Fget_text_property (pos
, Qlocal_map
, string
);
28746 if (!KEYMAPP (map
))
28747 map
= Fget_text_property (pos
, Qkeymap
, string
);
28748 if (!KEYMAPP (map
) && draggable
)
28749 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
28752 else if (draggable
)
28753 /* Default mode-line pointer. */
28754 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28759 /* Change the mouse face according to what is under X/Y. */
28760 if (STRINGP (string
))
28762 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
28763 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
28764 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
28769 struct glyph
* tmp_glyph
;
28773 int total_pixel_width
;
28774 ptrdiff_t begpos
, endpos
, ignore
;
28778 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
28779 Qmouse_face
, string
, Qnil
);
28785 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
28787 endpos
= SCHARS (string
);
28791 /* Calculate the glyph position GPOS of GLYPH in the
28792 displayed string, relative to the beginning of the
28793 highlighted part of the string.
28795 Note: GPOS is different from CHARPOS. CHARPOS is the
28796 position of GLYPH in the internal string object. A mode
28797 line string format has structures which are converted to
28798 a flattened string by the Emacs Lisp interpreter. The
28799 internal string is an element of those structures. The
28800 displayed string is the flattened string. */
28801 tmp_glyph
= row_start_glyph
;
28802 while (tmp_glyph
< glyph
28803 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
28804 && begpos
<= tmp_glyph
->charpos
28805 && tmp_glyph
->charpos
< endpos
)))
28807 gpos
= glyph
- tmp_glyph
;
28809 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
28810 the highlighted part of the displayed string to which
28811 GLYPH belongs. Note: GSEQ_LENGTH is different from
28812 SCHARS (STRING), because the latter returns the length of
28813 the internal string. */
28814 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
28816 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
28817 && begpos
<= tmp_glyph
->charpos
28818 && tmp_glyph
->charpos
< endpos
));
28821 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
28823 /* Calculate the total pixel width of all the glyphs between
28824 the beginning of the highlighted area and GLYPH. */
28825 total_pixel_width
= 0;
28826 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
28827 total_pixel_width
+= tmp_glyph
->pixel_width
;
28829 /* Pre calculation of re-rendering position. Note: X is in
28830 column units here, after the call to mode_line_string or
28831 marginal_area_string. */
28833 vpos
= (area
== ON_MODE_LINE
28834 ? (w
->current_matrix
)->nrows
- 1
28837 /* If GLYPH's position is included in the region that is
28838 already drawn in mouse face, we have nothing to do. */
28839 if ( EQ (window
, hlinfo
->mouse_face_window
)
28840 && (!row
->reversed_p
28841 ? (hlinfo
->mouse_face_beg_col
<= hpos
28842 && hpos
< hlinfo
->mouse_face_end_col
)
28843 /* In R2L rows we swap BEG and END, see below. */
28844 : (hlinfo
->mouse_face_end_col
<= hpos
28845 && hpos
< hlinfo
->mouse_face_beg_col
))
28846 && hlinfo
->mouse_face_beg_row
== vpos
)
28849 if (clear_mouse_face (hlinfo
))
28850 cursor
= No_Cursor
;
28852 if (!row
->reversed_p
)
28854 hlinfo
->mouse_face_beg_col
= hpos
;
28855 hlinfo
->mouse_face_beg_x
= original_x_pixel
28856 - (total_pixel_width
+ dx
);
28857 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
28858 hlinfo
->mouse_face_end_x
= 0;
28862 /* In R2L rows, show_mouse_face expects BEG and END
28863 coordinates to be swapped. */
28864 hlinfo
->mouse_face_end_col
= hpos
;
28865 hlinfo
->mouse_face_end_x
= original_x_pixel
28866 - (total_pixel_width
+ dx
);
28867 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
28868 hlinfo
->mouse_face_beg_x
= 0;
28871 hlinfo
->mouse_face_beg_row
= vpos
;
28872 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
28873 hlinfo
->mouse_face_past_end
= 0;
28874 hlinfo
->mouse_face_window
= window
;
28876 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
28881 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28883 if (NILP (pointer
))
28886 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
28887 clear_mouse_face (hlinfo
);
28889 #ifdef HAVE_WINDOW_SYSTEM
28890 if (FRAME_WINDOW_P (f
))
28891 define_frame_cursor1 (f
, cursor
, pointer
);
28897 Take proper action when the mouse has moved to position X, Y on
28898 frame F with regards to highlighting portions of display that have
28899 mouse-face properties. Also de-highlight portions of display where
28900 the mouse was before, set the mouse pointer shape as appropriate
28901 for the mouse coordinates, and activate help echo (tooltips).
28902 X and Y can be negative or out of range. */
28905 note_mouse_highlight (struct frame
*f
, int x
, int y
)
28907 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28908 enum window_part part
= ON_NOTHING
;
28909 Lisp_Object window
;
28911 Cursor cursor
= No_Cursor
;
28912 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
28915 /* When a menu is active, don't highlight because this looks odd. */
28916 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
28917 if (popup_activated ())
28921 if (!f
->glyphs_initialized_p
28922 || f
->pointer_invisible
)
28925 hlinfo
->mouse_face_mouse_x
= x
;
28926 hlinfo
->mouse_face_mouse_y
= y
;
28927 hlinfo
->mouse_face_mouse_frame
= f
;
28929 if (hlinfo
->mouse_face_defer
)
28932 /* Which window is that in? */
28933 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
28935 /* If displaying active text in another window, clear that. */
28936 if (! EQ (window
, hlinfo
->mouse_face_window
)
28937 /* Also clear if we move out of text area in same window. */
28938 || (!NILP (hlinfo
->mouse_face_window
)
28941 && part
!= ON_MODE_LINE
28942 && part
!= ON_HEADER_LINE
))
28943 clear_mouse_face (hlinfo
);
28945 /* Not on a window -> return. */
28946 if (!WINDOWP (window
))
28949 /* Reset help_echo_string. It will get recomputed below. */
28950 help_echo_string
= Qnil
;
28952 /* Convert to window-relative pixel coordinates. */
28953 w
= XWINDOW (window
);
28954 frame_to_window_pixel_xy (w
, &x
, &y
);
28956 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
28957 /* Handle tool-bar window differently since it doesn't display a
28959 if (EQ (window
, f
->tool_bar_window
))
28961 note_tool_bar_highlight (f
, x
, y
);
28966 /* Mouse is on the mode, header line or margin? */
28967 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
28968 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
28970 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
28972 #ifdef HAVE_WINDOW_SYSTEM
28973 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
28975 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28976 /* Show non-text cursor (Bug#16647). */
28984 #ifdef HAVE_WINDOW_SYSTEM
28985 if (part
== ON_VERTICAL_BORDER
)
28987 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28988 help_echo_string
= build_string ("drag-mouse-1: resize");
28990 else if (part
== ON_RIGHT_DIVIDER
)
28992 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28993 help_echo_string
= build_string ("drag-mouse-1: resize");
28995 else if (part
== ON_BOTTOM_DIVIDER
)
28996 if (! WINDOW_BOTTOMMOST_P (w
)
28998 || NILP (Vresize_mini_windows
))
29000 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29001 help_echo_string
= build_string ("drag-mouse-1: resize");
29004 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29005 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
29006 || part
== ON_SCROLL_BAR
)
29007 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29009 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29012 /* Are we in a window whose display is up to date?
29013 And verify the buffer's text has not changed. */
29014 b
= XBUFFER (w
->contents
);
29015 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
29017 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
29019 struct glyph
*glyph
;
29020 Lisp_Object object
;
29021 Lisp_Object mouse_face
= Qnil
, position
;
29022 Lisp_Object
*overlay_vec
= NULL
;
29023 ptrdiff_t i
, noverlays
;
29024 struct buffer
*obuf
;
29025 ptrdiff_t obegv
, ozv
;
29028 /* Find the glyph under X/Y. */
29029 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
29031 #ifdef HAVE_WINDOW_SYSTEM
29032 /* Look for :pointer property on image. */
29033 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29035 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29036 if (img
!= NULL
&& IMAGEP (img
->spec
))
29038 Lisp_Object image_map
, hotspot
;
29039 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29041 && (hotspot
= find_hot_spot (image_map
,
29042 glyph
->slice
.img
.x
+ dx
,
29043 glyph
->slice
.img
.y
+ dy
),
29045 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29049 /* Could check XCAR (hotspot) to see if we enter/leave
29051 If so, we could look for mouse-enter, mouse-leave
29052 properties in PLIST (and do something...). */
29053 hotspot
= XCDR (hotspot
);
29054 if (CONSP (hotspot
)
29055 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29057 pointer
= Fplist_get (plist
, Qpointer
);
29058 if (NILP (pointer
))
29060 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29061 if (!NILP (help_echo_string
))
29063 help_echo_window
= window
;
29064 help_echo_object
= glyph
->object
;
29065 help_echo_pos
= glyph
->charpos
;
29069 if (NILP (pointer
))
29070 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29073 #endif /* HAVE_WINDOW_SYSTEM */
29075 /* Clear mouse face if X/Y not over text. */
29077 || area
!= TEXT_AREA
29078 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29079 /* Glyph's OBJECT is an integer for glyphs inserted by the
29080 display engine for its internal purposes, like truncation
29081 and continuation glyphs and blanks beyond the end of
29082 line's text on text terminals. If we are over such a
29083 glyph, we are not over any text. */
29084 || INTEGERP (glyph
->object
)
29085 /* R2L rows have a stretch glyph at their front, which
29086 stands for no text, whereas L2R rows have no glyphs at
29087 all beyond the end of text. Treat such stretch glyphs
29088 like we do with NULL glyphs in L2R rows. */
29089 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29090 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29091 && glyph
->type
== STRETCH_GLYPH
29092 && glyph
->avoid_cursor_p
))
29094 if (clear_mouse_face (hlinfo
))
29095 cursor
= No_Cursor
;
29096 #ifdef HAVE_WINDOW_SYSTEM
29097 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29099 if (area
!= TEXT_AREA
)
29100 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29102 pointer
= Vvoid_text_area_pointer
;
29108 pos
= glyph
->charpos
;
29109 object
= glyph
->object
;
29110 if (!STRINGP (object
) && !BUFFERP (object
))
29113 /* If we get an out-of-range value, return now; avoid an error. */
29114 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29117 /* Make the window's buffer temporarily current for
29118 overlays_at and compute_char_face. */
29119 obuf
= current_buffer
;
29120 current_buffer
= b
;
29126 /* Is this char mouse-active or does it have help-echo? */
29127 position
= make_number (pos
);
29129 if (BUFFERP (object
))
29131 /* Put all the overlays we want in a vector in overlay_vec. */
29132 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
29133 /* Sort overlays into increasing priority order. */
29134 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29139 if (NILP (Vmouse_highlight
))
29141 clear_mouse_face (hlinfo
);
29142 goto check_help_echo
;
29145 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29148 cursor
= No_Cursor
;
29150 /* Check mouse-face highlighting. */
29152 /* If there exists an overlay with mouse-face overlapping
29153 the one we are currently highlighting, we have to
29154 check if we enter the overlapping overlay, and then
29155 highlight only that. */
29156 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29157 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29159 /* Find the highest priority overlay with a mouse-face. */
29160 Lisp_Object overlay
= Qnil
;
29161 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29163 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29164 if (!NILP (mouse_face
))
29165 overlay
= overlay_vec
[i
];
29168 /* If we're highlighting the same overlay as before, there's
29169 no need to do that again. */
29170 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29171 goto check_help_echo
;
29172 hlinfo
->mouse_face_overlay
= overlay
;
29174 /* Clear the display of the old active region, if any. */
29175 if (clear_mouse_face (hlinfo
))
29176 cursor
= No_Cursor
;
29178 /* If no overlay applies, get a text property. */
29179 if (NILP (overlay
))
29180 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29182 /* Next, compute the bounds of the mouse highlighting and
29184 if (!NILP (mouse_face
) && STRINGP (object
))
29186 /* The mouse-highlighting comes from a display string
29187 with a mouse-face. */
29191 s
= Fprevious_single_property_change
29192 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29193 e
= Fnext_single_property_change
29194 (position
, Qmouse_face
, object
, Qnil
);
29196 s
= make_number (0);
29198 e
= make_number (SCHARS (object
));
29199 mouse_face_from_string_pos (w
, hlinfo
, object
,
29200 XINT (s
), XINT (e
));
29201 hlinfo
->mouse_face_past_end
= 0;
29202 hlinfo
->mouse_face_window
= window
;
29203 hlinfo
->mouse_face_face_id
29204 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29205 glyph
->face_id
, 1);
29206 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29207 cursor
= No_Cursor
;
29211 /* The mouse-highlighting, if any, comes from an overlay
29212 or text property in the buffer. */
29213 Lisp_Object buffer
IF_LINT (= Qnil
);
29214 Lisp_Object disp_string
IF_LINT (= Qnil
);
29216 if (STRINGP (object
))
29218 /* If we are on a display string with no mouse-face,
29219 check if the text under it has one. */
29220 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29221 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29222 pos
= string_buffer_position (object
, start
);
29225 mouse_face
= get_char_property_and_overlay
29226 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29227 buffer
= w
->contents
;
29228 disp_string
= object
;
29234 disp_string
= Qnil
;
29237 if (!NILP (mouse_face
))
29239 Lisp_Object before
, after
;
29240 Lisp_Object before_string
, after_string
;
29241 /* To correctly find the limits of mouse highlight
29242 in a bidi-reordered buffer, we must not use the
29243 optimization of limiting the search in
29244 previous-single-property-change and
29245 next-single-property-change, because
29246 rows_from_pos_range needs the real start and end
29247 positions to DTRT in this case. That's because
29248 the first row visible in a window does not
29249 necessarily display the character whose position
29250 is the smallest. */
29252 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29253 ? Fmarker_position (w
->start
)
29256 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29257 ? make_number (BUF_Z (XBUFFER (buffer
))
29258 - w
->window_end_pos
)
29261 if (NILP (overlay
))
29263 /* Handle the text property case. */
29264 before
= Fprevious_single_property_change
29265 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29266 after
= Fnext_single_property_change
29267 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29268 before_string
= after_string
= Qnil
;
29272 /* Handle the overlay case. */
29273 before
= Foverlay_start (overlay
);
29274 after
= Foverlay_end (overlay
);
29275 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29276 after_string
= Foverlay_get (overlay
, Qafter_string
);
29278 if (!STRINGP (before_string
)) before_string
= Qnil
;
29279 if (!STRINGP (after_string
)) after_string
= Qnil
;
29282 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29285 : XFASTINT (before
),
29287 ? BUF_Z (XBUFFER (buffer
))
29288 : XFASTINT (after
),
29289 before_string
, after_string
,
29291 cursor
= No_Cursor
;
29298 /* Look for a `help-echo' property. */
29299 if (NILP (help_echo_string
)) {
29300 Lisp_Object help
, overlay
;
29302 /* Check overlays first. */
29303 help
= overlay
= Qnil
;
29304 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29306 overlay
= overlay_vec
[i
];
29307 help
= Foverlay_get (overlay
, Qhelp_echo
);
29312 help_echo_string
= help
;
29313 help_echo_window
= window
;
29314 help_echo_object
= overlay
;
29315 help_echo_pos
= pos
;
29319 Lisp_Object obj
= glyph
->object
;
29320 ptrdiff_t charpos
= glyph
->charpos
;
29322 /* Try text properties. */
29325 && charpos
< SCHARS (obj
))
29327 help
= Fget_text_property (make_number (charpos
),
29331 /* If the string itself doesn't specify a help-echo,
29332 see if the buffer text ``under'' it does. */
29333 struct glyph_row
*r
29334 = MATRIX_ROW (w
->current_matrix
, vpos
);
29335 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29336 ptrdiff_t p
= string_buffer_position (obj
, start
);
29339 help
= Fget_char_property (make_number (p
),
29340 Qhelp_echo
, w
->contents
);
29349 else if (BUFFERP (obj
)
29352 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
29357 help_echo_string
= help
;
29358 help_echo_window
= window
;
29359 help_echo_object
= obj
;
29360 help_echo_pos
= charpos
;
29365 #ifdef HAVE_WINDOW_SYSTEM
29366 /* Look for a `pointer' property. */
29367 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29369 /* Check overlays first. */
29370 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
29371 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
29373 if (NILP (pointer
))
29375 Lisp_Object obj
= glyph
->object
;
29376 ptrdiff_t charpos
= glyph
->charpos
;
29378 /* Try text properties. */
29381 && charpos
< SCHARS (obj
))
29383 pointer
= Fget_text_property (make_number (charpos
),
29385 if (NILP (pointer
))
29387 /* If the string itself doesn't specify a pointer,
29388 see if the buffer text ``under'' it does. */
29389 struct glyph_row
*r
29390 = MATRIX_ROW (w
->current_matrix
, vpos
);
29391 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29392 ptrdiff_t p
= string_buffer_position (obj
, start
);
29394 pointer
= Fget_char_property (make_number (p
),
29395 Qpointer
, w
->contents
);
29398 else if (BUFFERP (obj
)
29401 pointer
= Fget_text_property (make_number (charpos
),
29405 #endif /* HAVE_WINDOW_SYSTEM */
29409 current_buffer
= obuf
;
29414 #ifdef HAVE_WINDOW_SYSTEM
29415 if (FRAME_WINDOW_P (f
))
29416 define_frame_cursor1 (f
, cursor
, pointer
);
29418 /* This is here to prevent a compiler error, about "label at end of
29419 compound statement". */
29426 Clear any mouse-face on window W. This function is part of the
29427 redisplay interface, and is called from try_window_id and similar
29428 functions to ensure the mouse-highlight is off. */
29431 x_clear_window_mouse_face (struct window
*w
)
29433 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
29434 Lisp_Object window
;
29437 XSETWINDOW (window
, w
);
29438 if (EQ (window
, hlinfo
->mouse_face_window
))
29439 clear_mouse_face (hlinfo
);
29445 Just discard the mouse face information for frame F, if any.
29446 This is used when the size of F is changed. */
29449 cancel_mouse_face (struct frame
*f
)
29451 Lisp_Object window
;
29452 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29454 window
= hlinfo
->mouse_face_window
;
29455 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
29456 reset_mouse_highlight (hlinfo
);
29461 /***********************************************************************
29463 ***********************************************************************/
29465 #ifdef HAVE_WINDOW_SYSTEM
29467 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
29468 which intersects rectangle R. R is in window-relative coordinates. */
29471 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
29472 enum glyph_row_area area
)
29474 struct glyph
*first
= row
->glyphs
[area
];
29475 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
29476 struct glyph
*last
;
29477 int first_x
, start_x
, x
;
29479 if (area
== TEXT_AREA
&& row
->fill_line_p
)
29480 /* If row extends face to end of line write the whole line. */
29481 draw_glyphs (w
, 0, row
, area
,
29482 0, row
->used
[area
],
29483 DRAW_NORMAL_TEXT
, 0);
29486 /* Set START_X to the window-relative start position for drawing glyphs of
29487 AREA. The first glyph of the text area can be partially visible.
29488 The first glyphs of other areas cannot. */
29489 start_x
= window_box_left_offset (w
, area
);
29491 if (area
== TEXT_AREA
)
29494 /* Find the first glyph that must be redrawn. */
29496 && x
+ first
->pixel_width
< r
->x
)
29498 x
+= first
->pixel_width
;
29502 /* Find the last one. */
29506 && x
< r
->x
+ r
->width
)
29508 x
+= last
->pixel_width
;
29514 draw_glyphs (w
, first_x
- start_x
, row
, area
,
29515 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
29516 DRAW_NORMAL_TEXT
, 0);
29521 /* Redraw the parts of the glyph row ROW on window W intersecting
29522 rectangle R. R is in window-relative coordinates. Value is
29523 non-zero if mouse-face was overwritten. */
29526 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
29528 eassert (row
->enabled_p
);
29530 if (row
->mode_line_p
|| w
->pseudo_window_p
)
29531 draw_glyphs (w
, 0, row
, TEXT_AREA
,
29532 0, row
->used
[TEXT_AREA
],
29533 DRAW_NORMAL_TEXT
, 0);
29536 if (row
->used
[LEFT_MARGIN_AREA
])
29537 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
29538 if (row
->used
[TEXT_AREA
])
29539 expose_area (w
, row
, r
, TEXT_AREA
);
29540 if (row
->used
[RIGHT_MARGIN_AREA
])
29541 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
29542 draw_row_fringe_bitmaps (w
, row
);
29545 return row
->mouse_face_p
;
29549 /* Redraw those parts of glyphs rows during expose event handling that
29550 overlap other rows. Redrawing of an exposed line writes over parts
29551 of lines overlapping that exposed line; this function fixes that.
29553 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
29554 row in W's current matrix that is exposed and overlaps other rows.
29555 LAST_OVERLAPPING_ROW is the last such row. */
29558 expose_overlaps (struct window
*w
,
29559 struct glyph_row
*first_overlapping_row
,
29560 struct glyph_row
*last_overlapping_row
,
29563 struct glyph_row
*row
;
29565 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
29566 if (row
->overlapping_p
)
29568 eassert (row
->enabled_p
&& !row
->mode_line_p
);
29571 if (row
->used
[LEFT_MARGIN_AREA
])
29572 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
29574 if (row
->used
[TEXT_AREA
])
29575 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
29577 if (row
->used
[RIGHT_MARGIN_AREA
])
29578 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
29584 /* Return non-zero if W's cursor intersects rectangle R. */
29587 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
29589 XRectangle cr
, result
;
29590 struct glyph
*cursor_glyph
;
29591 struct glyph_row
*row
;
29593 if (w
->phys_cursor
.vpos
>= 0
29594 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
29595 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
29597 && row
->cursor_in_fringe_p
)
29599 /* Cursor is in the fringe. */
29600 cr
.x
= window_box_right_offset (w
,
29601 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
29602 ? RIGHT_MARGIN_AREA
29605 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
29606 cr
.height
= row
->height
;
29607 return x_intersect_rectangles (&cr
, r
, &result
);
29610 cursor_glyph
= get_phys_cursor_glyph (w
);
29613 /* r is relative to W's box, but w->phys_cursor.x is relative
29614 to left edge of W's TEXT area. Adjust it. */
29615 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
29616 cr
.y
= w
->phys_cursor
.y
;
29617 cr
.width
= cursor_glyph
->pixel_width
;
29618 cr
.height
= w
->phys_cursor_height
;
29619 /* ++KFS: W32 version used W32-specific IntersectRect here, but
29620 I assume the effect is the same -- and this is portable. */
29621 return x_intersect_rectangles (&cr
, r
, &result
);
29623 /* If we don't understand the format, pretend we're not in the hot-spot. */
29629 Draw a vertical window border to the right of window W if W doesn't
29630 have vertical scroll bars. */
29633 x_draw_vertical_border (struct window
*w
)
29635 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29637 /* We could do better, if we knew what type of scroll-bar the adjacent
29638 windows (on either side) have... But we don't :-(
29639 However, I think this works ok. ++KFS 2003-04-25 */
29641 /* Redraw borders between horizontally adjacent windows. Don't
29642 do it for frames with vertical scroll bars because either the
29643 right scroll bar of a window, or the left scroll bar of its
29644 neighbor will suffice as a border. */
29645 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
29648 /* Note: It is necessary to redraw both the left and the right
29649 borders, for when only this single window W is being
29651 if (!WINDOW_RIGHTMOST_P (w
)
29652 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
29654 int x0
, x1
, y0
, y1
;
29656 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29659 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29662 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
29665 if (!WINDOW_LEFTMOST_P (w
)
29666 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
29668 int x0
, x1
, y0
, y1
;
29670 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29673 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29676 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
29681 /* Draw window dividers for window W. */
29684 x_draw_right_divider (struct window
*w
)
29686 struct frame
*f
= WINDOW_XFRAME (w
);
29688 if (w
->mini
|| w
->pseudo_window_p
)
29690 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
29692 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
29693 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29694 int y0
= WINDOW_TOP_EDGE_Y (w
);
29695 /* The bottom divider prevails. */
29696 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29698 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29703 x_draw_bottom_divider (struct window
*w
)
29705 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29707 if (w
->mini
|| w
->pseudo_window_p
)
29709 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
29711 int x0
= WINDOW_LEFT_EDGE_X (w
);
29712 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29713 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29714 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
29716 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29720 /* Redraw the part of window W intersection rectangle FR. Pixel
29721 coordinates in FR are frame-relative. Call this function with
29722 input blocked. Value is non-zero if the exposure overwrites
29726 expose_window (struct window
*w
, XRectangle
*fr
)
29728 struct frame
*f
= XFRAME (w
->frame
);
29730 int mouse_face_overwritten_p
= 0;
29732 /* If window is not yet fully initialized, do nothing. This can
29733 happen when toolkit scroll bars are used and a window is split.
29734 Reconfiguring the scroll bar will generate an expose for a newly
29736 if (w
->current_matrix
== NULL
)
29739 /* When we're currently updating the window, display and current
29740 matrix usually don't agree. Arrange for a thorough display
29742 if (w
->must_be_updated_p
)
29744 SET_FRAME_GARBAGED (f
);
29748 /* Frame-relative pixel rectangle of W. */
29749 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
29750 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
29751 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
29752 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
29754 if (x_intersect_rectangles (fr
, &wr
, &r
))
29756 int yb
= window_text_bottom_y (w
);
29757 struct glyph_row
*row
;
29758 int cursor_cleared_p
, phys_cursor_on_p
;
29759 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
29761 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
29762 r
.x
, r
.y
, r
.width
, r
.height
));
29764 /* Convert to window coordinates. */
29765 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
29766 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
29768 /* Turn off the cursor. */
29769 if (!w
->pseudo_window_p
29770 && phys_cursor_in_rect_p (w
, &r
))
29772 x_clear_cursor (w
);
29773 cursor_cleared_p
= 1;
29776 cursor_cleared_p
= 0;
29778 /* If the row containing the cursor extends face to end of line,
29779 then expose_area might overwrite the cursor outside the
29780 rectangle and thus notice_overwritten_cursor might clear
29781 w->phys_cursor_on_p. We remember the original value and
29782 check later if it is changed. */
29783 phys_cursor_on_p
= w
->phys_cursor_on_p
;
29785 /* Update lines intersecting rectangle R. */
29786 first_overlapping_row
= last_overlapping_row
= NULL
;
29787 for (row
= w
->current_matrix
->rows
;
29792 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
29794 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
29795 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
29796 || (r
.y
>= y0
&& r
.y
< y1
)
29797 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
29799 /* A header line may be overlapping, but there is no need
29800 to fix overlapping areas for them. KFS 2005-02-12 */
29801 if (row
->overlapping_p
&& !row
->mode_line_p
)
29803 if (first_overlapping_row
== NULL
)
29804 first_overlapping_row
= row
;
29805 last_overlapping_row
= row
;
29809 if (expose_line (w
, row
, &r
))
29810 mouse_face_overwritten_p
= 1;
29813 else if (row
->overlapping_p
)
29815 /* We must redraw a row overlapping the exposed area. */
29817 ? y0
+ row
->phys_height
> r
.y
29818 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
29820 if (first_overlapping_row
== NULL
)
29821 first_overlapping_row
= row
;
29822 last_overlapping_row
= row
;
29830 /* Display the mode line if there is one. */
29831 if (WINDOW_WANTS_MODELINE_P (w
)
29832 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
29834 && row
->y
< r
.y
+ r
.height
)
29836 if (expose_line (w
, row
, &r
))
29837 mouse_face_overwritten_p
= 1;
29840 if (!w
->pseudo_window_p
)
29842 /* Fix the display of overlapping rows. */
29843 if (first_overlapping_row
)
29844 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
29847 /* Draw border between windows. */
29848 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
29849 x_draw_right_divider (w
);
29851 x_draw_vertical_border (w
);
29853 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
29854 x_draw_bottom_divider (w
);
29856 /* Turn the cursor on again. */
29857 if (cursor_cleared_p
29858 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
29859 update_window_cursor (w
, 1);
29863 return mouse_face_overwritten_p
;
29868 /* Redraw (parts) of all windows in the window tree rooted at W that
29869 intersect R. R contains frame pixel coordinates. Value is
29870 non-zero if the exposure overwrites mouse-face. */
29873 expose_window_tree (struct window
*w
, XRectangle
*r
)
29875 struct frame
*f
= XFRAME (w
->frame
);
29876 int mouse_face_overwritten_p
= 0;
29878 while (w
&& !FRAME_GARBAGED_P (f
))
29880 if (WINDOWP (w
->contents
))
29881 mouse_face_overwritten_p
29882 |= expose_window_tree (XWINDOW (w
->contents
), r
);
29884 mouse_face_overwritten_p
|= expose_window (w
, r
);
29886 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
29889 return mouse_face_overwritten_p
;
29894 Redisplay an exposed area of frame F. X and Y are the upper-left
29895 corner of the exposed rectangle. W and H are width and height of
29896 the exposed area. All are pixel values. W or H zero means redraw
29897 the entire frame. */
29900 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
29903 int mouse_face_overwritten_p
= 0;
29905 TRACE ((stderr
, "expose_frame "));
29907 /* No need to redraw if frame will be redrawn soon. */
29908 if (FRAME_GARBAGED_P (f
))
29910 TRACE ((stderr
, " garbaged\n"));
29914 /* If basic faces haven't been realized yet, there is no point in
29915 trying to redraw anything. This can happen when we get an expose
29916 event while Emacs is starting, e.g. by moving another window. */
29917 if (FRAME_FACE_CACHE (f
) == NULL
29918 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
29920 TRACE ((stderr
, " no faces\n"));
29924 if (w
== 0 || h
== 0)
29927 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
29928 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
29938 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
29939 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
29941 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
29942 if (WINDOWP (f
->tool_bar_window
))
29943 mouse_face_overwritten_p
29944 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
29947 #ifdef HAVE_X_WINDOWS
29949 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
29950 if (WINDOWP (f
->menu_bar_window
))
29951 mouse_face_overwritten_p
29952 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
29953 #endif /* not USE_X_TOOLKIT and not USE_GTK */
29957 /* Some window managers support a focus-follows-mouse style with
29958 delayed raising of frames. Imagine a partially obscured frame,
29959 and moving the mouse into partially obscured mouse-face on that
29960 frame. The visible part of the mouse-face will be highlighted,
29961 then the WM raises the obscured frame. With at least one WM, KDE
29962 2.1, Emacs is not getting any event for the raising of the frame
29963 (even tried with SubstructureRedirectMask), only Expose events.
29964 These expose events will draw text normally, i.e. not
29965 highlighted. Which means we must redo the highlight here.
29966 Subsume it under ``we love X''. --gerd 2001-08-15 */
29967 /* Included in Windows version because Windows most likely does not
29968 do the right thing if any third party tool offers
29969 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
29970 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
29972 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29973 if (f
== hlinfo
->mouse_face_mouse_frame
)
29975 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
29976 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
29977 clear_mouse_face (hlinfo
);
29978 note_mouse_highlight (f
, mouse_x
, mouse_y
);
29985 Determine the intersection of two rectangles R1 and R2. Return
29986 the intersection in *RESULT. Value is non-zero if RESULT is not
29990 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
29992 XRectangle
*left
, *right
;
29993 XRectangle
*upper
, *lower
;
29994 int intersection_p
= 0;
29996 /* Rearrange so that R1 is the left-most rectangle. */
29998 left
= r1
, right
= r2
;
30000 left
= r2
, right
= r1
;
30002 /* X0 of the intersection is right.x0, if this is inside R1,
30003 otherwise there is no intersection. */
30004 if (right
->x
<= left
->x
+ left
->width
)
30006 result
->x
= right
->x
;
30008 /* The right end of the intersection is the minimum of
30009 the right ends of left and right. */
30010 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
30013 /* Same game for Y. */
30015 upper
= r1
, lower
= r2
;
30017 upper
= r2
, lower
= r1
;
30019 /* The upper end of the intersection is lower.y0, if this is inside
30020 of upper. Otherwise, there is no intersection. */
30021 if (lower
->y
<= upper
->y
+ upper
->height
)
30023 result
->y
= lower
->y
;
30025 /* The lower end of the intersection is the minimum of the lower
30026 ends of upper and lower. */
30027 result
->height
= (min (lower
->y
+ lower
->height
,
30028 upper
->y
+ upper
->height
)
30030 intersection_p
= 1;
30034 return intersection_p
;
30037 #endif /* HAVE_WINDOW_SYSTEM */
30040 /***********************************************************************
30042 ***********************************************************************/
30045 syms_of_xdisp (void)
30047 Vwith_echo_area_save_vector
= Qnil
;
30048 staticpro (&Vwith_echo_area_save_vector
);
30050 Vmessage_stack
= Qnil
;
30051 staticpro (&Vmessage_stack
);
30053 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30054 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30056 message_dolog_marker1
= Fmake_marker ();
30057 staticpro (&message_dolog_marker1
);
30058 message_dolog_marker2
= Fmake_marker ();
30059 staticpro (&message_dolog_marker2
);
30060 message_dolog_marker3
= Fmake_marker ();
30061 staticpro (&message_dolog_marker3
);
30064 defsubr (&Sdump_frame_glyph_matrix
);
30065 defsubr (&Sdump_glyph_matrix
);
30066 defsubr (&Sdump_glyph_row
);
30067 defsubr (&Sdump_tool_bar_row
);
30068 defsubr (&Strace_redisplay
);
30069 defsubr (&Strace_to_stderr
);
30071 #ifdef HAVE_WINDOW_SYSTEM
30072 defsubr (&Stool_bar_height
);
30073 defsubr (&Slookup_image_map
);
30075 defsubr (&Sline_pixel_height
);
30076 defsubr (&Sformat_mode_line
);
30077 defsubr (&Sinvisible_p
);
30078 defsubr (&Scurrent_bidi_paragraph_direction
);
30079 defsubr (&Swindow_text_pixel_size
);
30080 defsubr (&Smove_point_visually
);
30082 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30083 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30084 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30085 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30086 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30087 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30088 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30089 DEFSYM (Qeval
, "eval");
30090 DEFSYM (QCdata
, ":data");
30091 DEFSYM (Qdisplay
, "display");
30092 DEFSYM (Qspace_width
, "space-width");
30093 DEFSYM (Qraise
, "raise");
30094 DEFSYM (Qslice
, "slice");
30095 DEFSYM (Qspace
, "space");
30096 DEFSYM (Qmargin
, "margin");
30097 DEFSYM (Qpointer
, "pointer");
30098 DEFSYM (Qleft_margin
, "left-margin");
30099 DEFSYM (Qright_margin
, "right-margin");
30100 DEFSYM (Qcenter
, "center");
30101 DEFSYM (Qline_height
, "line-height");
30102 DEFSYM (QCalign_to
, ":align-to");
30103 DEFSYM (QCrelative_width
, ":relative-width");
30104 DEFSYM (QCrelative_height
, ":relative-height");
30105 DEFSYM (QCeval
, ":eval");
30106 DEFSYM (QCpropertize
, ":propertize");
30107 DEFSYM (QCfile
, ":file");
30108 DEFSYM (Qfontified
, "fontified");
30109 DEFSYM (Qfontification_functions
, "fontification-functions");
30110 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30111 DEFSYM (Qescape_glyph
, "escape-glyph");
30112 DEFSYM (Qnobreak_space
, "nobreak-space");
30113 DEFSYM (Qimage
, "image");
30114 DEFSYM (Qtext
, "text");
30115 DEFSYM (Qboth
, "both");
30116 DEFSYM (Qboth_horiz
, "both-horiz");
30117 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30118 DEFSYM (QCmap
, ":map");
30119 DEFSYM (QCpointer
, ":pointer");
30120 DEFSYM (Qrect
, "rect");
30121 DEFSYM (Qcircle
, "circle");
30122 DEFSYM (Qpoly
, "poly");
30123 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
30124 DEFSYM (Qgrow_only
, "grow-only");
30125 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30126 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30127 DEFSYM (Qposition
, "position");
30128 DEFSYM (Qbuffer_position
, "buffer-position");
30129 DEFSYM (Qobject
, "object");
30130 DEFSYM (Qbar
, "bar");
30131 DEFSYM (Qhbar
, "hbar");
30132 DEFSYM (Qbox
, "box");
30133 DEFSYM (Qhollow
, "hollow");
30134 DEFSYM (Qhand
, "hand");
30135 DEFSYM (Qarrow
, "arrow");
30136 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30138 list_of_error
= list1 (list2 (intern_c_string ("error"),
30139 intern_c_string ("void-variable")));
30140 staticpro (&list_of_error
);
30142 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30143 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30144 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30145 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30147 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30148 staticpro (&echo_buffer
[0]);
30149 staticpro (&echo_buffer
[1]);
30151 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30152 staticpro (&echo_area_buffer
[0]);
30153 staticpro (&echo_area_buffer
[1]);
30155 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30156 staticpro (&Vmessages_buffer_name
);
30158 mode_line_proptrans_alist
= Qnil
;
30159 staticpro (&mode_line_proptrans_alist
);
30160 mode_line_string_list
= Qnil
;
30161 staticpro (&mode_line_string_list
);
30162 mode_line_string_face
= Qnil
;
30163 staticpro (&mode_line_string_face
);
30164 mode_line_string_face_prop
= Qnil
;
30165 staticpro (&mode_line_string_face_prop
);
30166 Vmode_line_unwind_vector
= Qnil
;
30167 staticpro (&Vmode_line_unwind_vector
);
30169 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30171 help_echo_string
= Qnil
;
30172 staticpro (&help_echo_string
);
30173 help_echo_object
= Qnil
;
30174 staticpro (&help_echo_object
);
30175 help_echo_window
= Qnil
;
30176 staticpro (&help_echo_window
);
30177 previous_help_echo_string
= Qnil
;
30178 staticpro (&previous_help_echo_string
);
30179 help_echo_pos
= -1;
30181 DEFSYM (Qright_to_left
, "right-to-left");
30182 DEFSYM (Qleft_to_right
, "left-to-right");
30184 #ifdef HAVE_WINDOW_SYSTEM
30185 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30186 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30187 For example, if a block cursor is over a tab, it will be drawn as
30188 wide as that tab on the display. */);
30189 x_stretch_cursor_p
= 0;
30192 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30193 doc
: /* Non-nil means highlight trailing whitespace.
30194 The face used for trailing whitespace is `trailing-whitespace'. */);
30195 Vshow_trailing_whitespace
= Qnil
;
30197 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30198 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30199 If the value is t, Emacs highlights non-ASCII chars which have the
30200 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30201 or `escape-glyph' face respectively.
30203 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30204 U+2011 (non-breaking hyphen) are affected.
30206 Any other non-nil value means to display these characters as a escape
30207 glyph followed by an ordinary space or hyphen.
30209 A value of nil means no special handling of these characters. */);
30210 Vnobreak_char_display
= Qt
;
30212 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30213 doc
: /* The pointer shape to show in void text areas.
30214 A value of nil means to show the text pointer. Other options are `arrow',
30215 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
30216 Vvoid_text_area_pointer
= Qarrow
;
30218 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30219 doc
: /* Non-nil means don't actually do any redisplay.
30220 This is used for internal purposes. */);
30221 Vinhibit_redisplay
= Qnil
;
30223 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30224 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30225 Vglobal_mode_string
= Qnil
;
30227 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30228 doc
: /* Marker for where to display an arrow on top of the buffer text.
30229 This must be the beginning of a line in order to work.
30230 See also `overlay-arrow-string'. */);
30231 Voverlay_arrow_position
= Qnil
;
30233 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30234 doc
: /* String to display as an arrow in non-window frames.
30235 See also `overlay-arrow-position'. */);
30236 Voverlay_arrow_string
= build_pure_c_string ("=>");
30238 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30239 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30240 The symbols on this list are examined during redisplay to determine
30241 where to display overlay arrows. */);
30242 Voverlay_arrow_variable_list
30243 = list1 (intern_c_string ("overlay-arrow-position"));
30245 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30246 doc
: /* The number of lines to try scrolling a window by when point moves out.
30247 If that fails to bring point back on frame, point is centered instead.
30248 If this is zero, point is always centered after it moves off frame.
30249 If you want scrolling to always be a line at a time, you should set
30250 `scroll-conservatively' to a large value rather than set this to 1. */);
30252 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30253 doc
: /* Scroll up to this many lines, to bring point back on screen.
30254 If point moves off-screen, redisplay will scroll by up to
30255 `scroll-conservatively' lines in order to bring point just barely
30256 onto the screen again. If that cannot be done, then redisplay
30257 recenters point as usual.
30259 If the value is greater than 100, redisplay will never recenter point,
30260 but will always scroll just enough text to bring point into view, even
30261 if you move far away.
30263 A value of zero means always recenter point if it moves off screen. */);
30264 scroll_conservatively
= 0;
30266 DEFVAR_INT ("scroll-margin", scroll_margin
,
30267 doc
: /* Number of lines of margin at the top and bottom of a window.
30268 Recenter the window whenever point gets within this many lines
30269 of the top or bottom of the window. */);
30272 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
30273 doc
: /* Pixels per inch value for non-window system displays.
30274 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30275 Vdisplay_pixels_per_inch
= make_float (72.0);
30278 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
30281 DEFVAR_LISP ("truncate-partial-width-windows",
30282 Vtruncate_partial_width_windows
,
30283 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
30284 For an integer value, truncate lines in each window narrower than the
30285 full frame width, provided the window width is less than that integer;
30286 otherwise, respect the value of `truncate-lines'.
30288 For any other non-nil value, truncate lines in all windows that do
30289 not span the full frame width.
30291 A value of nil means to respect the value of `truncate-lines'.
30293 If `word-wrap' is enabled, you might want to reduce this. */);
30294 Vtruncate_partial_width_windows
= make_number (50);
30296 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
30297 doc
: /* Maximum buffer size for which line number should be displayed.
30298 If the buffer is bigger than this, the line number does not appear
30299 in the mode line. A value of nil means no limit. */);
30300 Vline_number_display_limit
= Qnil
;
30302 DEFVAR_INT ("line-number-display-limit-width",
30303 line_number_display_limit_width
,
30304 doc
: /* Maximum line width (in characters) for line number display.
30305 If the average length of the lines near point is bigger than this, then the
30306 line number may be omitted from the mode line. */);
30307 line_number_display_limit_width
= 200;
30309 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
30310 doc
: /* Non-nil means highlight region even in nonselected windows. */);
30311 highlight_nonselected_windows
= 0;
30313 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
30314 doc
: /* Non-nil if more than one frame is visible on this display.
30315 Minibuffer-only frames don't count, but iconified frames do.
30316 This variable is not guaranteed to be accurate except while processing
30317 `frame-title-format' and `icon-title-format'. */);
30319 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
30320 doc
: /* Template for displaying the title bar of visible frames.
30321 \(Assuming the window manager supports this feature.)
30323 This variable has the same structure as `mode-line-format', except that
30324 the %c and %l constructs are ignored. It is used only on frames for
30325 which no explicit name has been set \(see `modify-frame-parameters'). */);
30327 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
30328 doc
: /* Template for displaying the title bar of an iconified frame.
30329 \(Assuming the window manager supports this feature.)
30330 This variable has the same structure as `mode-line-format' (which see),
30331 and is used only on frames for which no explicit name has been set
30332 \(see `modify-frame-parameters'). */);
30334 = Vframe_title_format
30335 = listn (CONSTYPE_PURE
, 3,
30336 intern_c_string ("multiple-frames"),
30337 build_pure_c_string ("%b"),
30338 listn (CONSTYPE_PURE
, 4,
30339 empty_unibyte_string
,
30340 intern_c_string ("invocation-name"),
30341 build_pure_c_string ("@"),
30342 intern_c_string ("system-name")));
30344 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
30345 doc
: /* Maximum number of lines to keep in the message log buffer.
30346 If nil, disable message logging. If t, log messages but don't truncate
30347 the buffer when it becomes large. */);
30348 Vmessage_log_max
= make_number (1000);
30350 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
30351 doc
: /* Functions called before redisplay, if window sizes have changed.
30352 The value should be a list of functions that take one argument.
30353 Just before redisplay, for each frame, if any of its windows have changed
30354 size since the last redisplay, or have been split or deleted,
30355 all the functions in the list are called, with the frame as argument. */);
30356 Vwindow_size_change_functions
= Qnil
;
30358 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
30359 doc
: /* List of functions to call before redisplaying a window with scrolling.
30360 Each function is called with two arguments, the window and its new
30361 display-start position. Note that these functions are also called by
30362 `set-window-buffer'. Also note that the value of `window-end' is not
30363 valid when these functions are called.
30365 Warning: Do not use this feature to alter the way the window
30366 is scrolled. It is not designed for that, and such use probably won't
30368 Vwindow_scroll_functions
= Qnil
;
30370 DEFVAR_LISP ("window-text-change-functions",
30371 Vwindow_text_change_functions
,
30372 doc
: /* Functions to call in redisplay when text in the window might change. */);
30373 Vwindow_text_change_functions
= Qnil
;
30375 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
30376 doc
: /* Functions called when redisplay of a window reaches the end trigger.
30377 Each function is called with two arguments, the window and the end trigger value.
30378 See `set-window-redisplay-end-trigger'. */);
30379 Vredisplay_end_trigger_functions
= Qnil
;
30381 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
30382 doc
: /* Non-nil means autoselect window with mouse pointer.
30383 If nil, do not autoselect windows.
30384 A positive number means delay autoselection by that many seconds: a
30385 window is autoselected only after the mouse has remained in that
30386 window for the duration of the delay.
30387 A negative number has a similar effect, but causes windows to be
30388 autoselected only after the mouse has stopped moving. \(Because of
30389 the way Emacs compares mouse events, you will occasionally wait twice
30390 that time before the window gets selected.\)
30391 Any other value means to autoselect window instantaneously when the
30392 mouse pointer enters it.
30394 Autoselection selects the minibuffer only if it is active, and never
30395 unselects the minibuffer if it is active.
30397 When customizing this variable make sure that the actual value of
30398 `focus-follows-mouse' matches the behavior of your window manager. */);
30399 Vmouse_autoselect_window
= Qnil
;
30401 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
30402 doc
: /* Non-nil means automatically resize tool-bars.
30403 This dynamically changes the tool-bar's height to the minimum height
30404 that is needed to make all tool-bar items visible.
30405 If value is `grow-only', the tool-bar's height is only increased
30406 automatically; to decrease the tool-bar height, use \\[recenter]. */);
30407 Vauto_resize_tool_bars
= Qt
;
30409 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
30410 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
30411 auto_raise_tool_bar_buttons_p
= 1;
30413 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
30414 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
30415 make_cursor_line_fully_visible_p
= 1;
30417 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
30418 doc
: /* Border below tool-bar in pixels.
30419 If an integer, use it as the height of the border.
30420 If it is one of `internal-border-width' or `border-width', use the
30421 value of the corresponding frame parameter.
30422 Otherwise, no border is added below the tool-bar. */);
30423 Vtool_bar_border
= Qinternal_border_width
;
30425 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
30426 doc
: /* Margin around tool-bar buttons in pixels.
30427 If an integer, use that for both horizontal and vertical margins.
30428 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
30429 HORZ specifying the horizontal margin, and VERT specifying the
30430 vertical margin. */);
30431 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
30433 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
30434 doc
: /* Relief thickness of tool-bar buttons. */);
30435 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
30437 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
30438 doc
: /* Tool bar style to use.
30440 image - show images only
30441 text - show text only
30442 both - show both, text below image
30443 both-horiz - show text to the right of the image
30444 text-image-horiz - show text to the left of the image
30445 any other - use system default or image if no system default.
30447 This variable only affects the GTK+ toolkit version of Emacs. */);
30448 Vtool_bar_style
= Qnil
;
30450 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
30451 doc
: /* Maximum number of characters a label can have to be shown.
30452 The tool bar style must also show labels for this to have any effect, see
30453 `tool-bar-style'. */);
30454 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
30456 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
30457 doc
: /* List of functions to call to fontify regions of text.
30458 Each function is called with one argument POS. Functions must
30459 fontify a region starting at POS in the current buffer, and give
30460 fontified regions the property `fontified'. */);
30461 Vfontification_functions
= Qnil
;
30462 Fmake_variable_buffer_local (Qfontification_functions
);
30464 DEFVAR_BOOL ("unibyte-display-via-language-environment",
30465 unibyte_display_via_language_environment
,
30466 doc
: /* Non-nil means display unibyte text according to language environment.
30467 Specifically, this means that raw bytes in the range 160-255 decimal
30468 are displayed by converting them to the equivalent multibyte characters
30469 according to the current language environment. As a result, they are
30470 displayed according to the current fontset.
30472 Note that this variable affects only how these bytes are displayed,
30473 but does not change the fact they are interpreted as raw bytes. */);
30474 unibyte_display_via_language_environment
= 0;
30476 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
30477 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
30478 If a float, it specifies a fraction of the mini-window frame's height.
30479 If an integer, it specifies a number of lines. */);
30480 Vmax_mini_window_height
= make_float (0.25);
30482 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
30483 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
30484 A value of nil means don't automatically resize mini-windows.
30485 A value of t means resize them to fit the text displayed in them.
30486 A value of `grow-only', the default, means let mini-windows grow only;
30487 they return to their normal size when the minibuffer is closed, or the
30488 echo area becomes empty. */);
30489 Vresize_mini_windows
= Qgrow_only
;
30491 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
30492 doc
: /* Alist specifying how to blink the cursor off.
30493 Each element has the form (ON-STATE . OFF-STATE). Whenever the
30494 `cursor-type' frame-parameter or variable equals ON-STATE,
30495 comparing using `equal', Emacs uses OFF-STATE to specify
30496 how to blink it off. ON-STATE and OFF-STATE are values for
30497 the `cursor-type' frame parameter.
30499 If a frame's ON-STATE has no entry in this list,
30500 the frame's other specifications determine how to blink the cursor off. */);
30501 Vblink_cursor_alist
= Qnil
;
30503 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
30504 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
30505 If non-nil, windows are automatically scrolled horizontally to make
30506 point visible. */);
30507 automatic_hscrolling_p
= 1;
30508 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
30510 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
30511 doc
: /* How many columns away from the window edge point is allowed to get
30512 before automatic hscrolling will horizontally scroll the window. */);
30513 hscroll_margin
= 5;
30515 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
30516 doc
: /* How many columns to scroll the window when point gets too close to the edge.
30517 When point is less than `hscroll-margin' columns from the window
30518 edge, automatic hscrolling will scroll the window by the amount of columns
30519 determined by this variable. If its value is a positive integer, scroll that
30520 many columns. If it's a positive floating-point number, it specifies the
30521 fraction of the window's width to scroll. If it's nil or zero, point will be
30522 centered horizontally after the scroll. Any other value, including negative
30523 numbers, are treated as if the value were zero.
30525 Automatic hscrolling always moves point outside the scroll margin, so if
30526 point was more than scroll step columns inside the margin, the window will
30527 scroll more than the value given by the scroll step.
30529 Note that the lower bound for automatic hscrolling specified by `scroll-left'
30530 and `scroll-right' overrides this variable's effect. */);
30531 Vhscroll_step
= make_number (0);
30533 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
30534 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
30535 Bind this around calls to `message' to let it take effect. */);
30536 message_truncate_lines
= 0;
30538 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
30539 doc
: /* Normal hook run to update the menu bar definitions.
30540 Redisplay runs this hook before it redisplays the menu bar.
30541 This is used to update menus such as Buffers, whose contents depend on
30543 Vmenu_bar_update_hook
= Qnil
;
30545 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
30546 doc
: /* Frame for which we are updating a menu.
30547 The enable predicate for a menu binding should check this variable. */);
30548 Vmenu_updating_frame
= Qnil
;
30550 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
30551 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
30552 inhibit_menubar_update
= 0;
30554 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
30555 doc
: /* Prefix prepended to all continuation lines at display time.
30556 The value may be a string, an image, or a stretch-glyph; it is
30557 interpreted in the same way as the value of a `display' text property.
30559 This variable is overridden by any `wrap-prefix' text or overlay
30562 To add a prefix to non-continuation lines, use `line-prefix'. */);
30563 Vwrap_prefix
= Qnil
;
30564 DEFSYM (Qwrap_prefix
, "wrap-prefix");
30565 Fmake_variable_buffer_local (Qwrap_prefix
);
30567 DEFVAR_LISP ("line-prefix", Vline_prefix
,
30568 doc
: /* Prefix prepended to all non-continuation lines at display time.
30569 The value may be a string, an image, or a stretch-glyph; it is
30570 interpreted in the same way as the value of a `display' text property.
30572 This variable is overridden by any `line-prefix' text or overlay
30575 To add a prefix to continuation lines, use `wrap-prefix'. */);
30576 Vline_prefix
= Qnil
;
30577 DEFSYM (Qline_prefix
, "line-prefix");
30578 Fmake_variable_buffer_local (Qline_prefix
);
30580 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
30581 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
30582 inhibit_eval_during_redisplay
= 0;
30584 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
30585 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
30586 inhibit_free_realized_faces
= 0;
30589 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
30590 doc
: /* Inhibit try_window_id display optimization. */);
30591 inhibit_try_window_id
= 0;
30593 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
30594 doc
: /* Inhibit try_window_reusing display optimization. */);
30595 inhibit_try_window_reusing
= 0;
30597 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
30598 doc
: /* Inhibit try_cursor_movement display optimization. */);
30599 inhibit_try_cursor_movement
= 0;
30600 #endif /* GLYPH_DEBUG */
30602 DEFVAR_INT ("overline-margin", overline_margin
,
30603 doc
: /* Space between overline and text, in pixels.
30604 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
30605 margin to the character height. */);
30606 overline_margin
= 2;
30608 DEFVAR_INT ("underline-minimum-offset",
30609 underline_minimum_offset
,
30610 doc
: /* Minimum distance between baseline and underline.
30611 This can improve legibility of underlined text at small font sizes,
30612 particularly when using variable `x-use-underline-position-properties'
30613 with fonts that specify an UNDERLINE_POSITION relatively close to the
30614 baseline. The default value is 1. */);
30615 underline_minimum_offset
= 1;
30617 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
30618 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
30619 This feature only works when on a window system that can change
30620 cursor shapes. */);
30621 display_hourglass_p
= 1;
30623 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
30624 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
30625 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
30627 #ifdef HAVE_WINDOW_SYSTEM
30628 hourglass_atimer
= NULL
;
30629 hourglass_shown_p
= 0;
30630 #endif /* HAVE_WINDOW_SYSTEM */
30632 DEFSYM (Qglyphless_char
, "glyphless-char");
30633 DEFSYM (Qhex_code
, "hex-code");
30634 DEFSYM (Qempty_box
, "empty-box");
30635 DEFSYM (Qthin_space
, "thin-space");
30636 DEFSYM (Qzero_width
, "zero-width");
30638 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
30639 doc
: /* Function run just before redisplay.
30640 It is called with one argument, which is the set of windows that are to
30641 be redisplayed. This set can be nil (meaning, only the selected window),
30642 or t (meaning all windows). */);
30643 Vpre_redisplay_function
= intern ("ignore");
30645 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
30646 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
30648 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
30649 doc
: /* Char-table defining glyphless characters.
30650 Each element, if non-nil, should be one of the following:
30651 an ASCII acronym string: display this string in a box
30652 `hex-code': display the hexadecimal code of a character in a box
30653 `empty-box': display as an empty box
30654 `thin-space': display as 1-pixel width space
30655 `zero-width': don't display
30656 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
30657 display method for graphical terminals and text terminals respectively.
30658 GRAPHICAL and TEXT should each have one of the values listed above.
30660 The char-table has one extra slot to control the display of a character for
30661 which no font is found. This slot only takes effect on graphical terminals.
30662 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
30663 `thin-space'. The default is `empty-box'.
30665 If a character has a non-nil entry in an active display table, the
30666 display table takes effect; in this case, Emacs does not consult
30667 `glyphless-char-display' at all. */);
30668 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
30669 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
30672 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
30673 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
30674 Vdebug_on_message
= Qnil
;
30676 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
30678 Vredisplay__all_windows_cause
30679 = Fmake_vector (make_number (100), make_number (0));
30681 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
30683 Vredisplay__mode_lines_cause
30684 = Fmake_vector (make_number (100), make_number (0));
30688 /* Initialize this module when Emacs starts. */
30693 CHARPOS (this_line_start_pos
) = 0;
30695 if (!noninteractive
)
30697 struct window
*m
= XWINDOW (minibuf_window
);
30698 Lisp_Object frame
= m
->frame
;
30699 struct frame
*f
= XFRAME (frame
);
30700 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
30701 struct window
*r
= XWINDOW (root
);
30704 echo_area_window
= minibuf_window
;
30706 r
->top_line
= FRAME_TOP_MARGIN (f
);
30707 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
30708 r
->total_cols
= FRAME_COLS (f
);
30709 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30710 r
->total_lines
= FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
30711 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
30713 m
->top_line
= FRAME_LINES (f
) - 1;
30714 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
30715 m
->total_cols
= FRAME_COLS (f
);
30716 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30717 m
->total_lines
= 1;
30718 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
30720 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
30721 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
30722 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
30724 /* The default ellipsis glyphs `...'. */
30725 for (i
= 0; i
< 3; ++i
)
30726 default_invis_vector
[i
] = make_number ('.');
30730 /* Allocate the buffer for frame titles.
30731 Also used for `format-mode-line'. */
30733 mode_line_noprop_buf
= xmalloc (size
);
30734 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
30735 mode_line_noprop_ptr
= mode_line_noprop_buf
;
30736 mode_line_target
= MODE_LINE_DISPLAY
;
30739 help_echo_showing_p
= 0;
30742 #ifdef HAVE_WINDOW_SYSTEM
30744 /* Platform-independent portion of hourglass implementation. */
30746 /* Cancel a currently active hourglass timer, and start a new one. */
30748 start_hourglass (void)
30750 struct timespec delay
;
30752 cancel_hourglass ();
30754 if (INTEGERP (Vhourglass_delay
)
30755 && XINT (Vhourglass_delay
) > 0)
30756 delay
= make_timespec (min (XINT (Vhourglass_delay
),
30757 TYPE_MAXIMUM (time_t)),
30759 else if (FLOATP (Vhourglass_delay
)
30760 && XFLOAT_DATA (Vhourglass_delay
) > 0)
30761 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
30763 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
30767 extern void w32_note_current_window (void);
30768 w32_note_current_window ();
30770 #endif /* HAVE_NTGUI */
30772 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
30773 show_hourglass
, NULL
);
30777 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
30780 cancel_hourglass (void)
30782 if (hourglass_atimer
)
30784 cancel_atimer (hourglass_atimer
);
30785 hourglass_atimer
= NULL
;
30788 if (hourglass_shown_p
)
30792 #endif /* HAVE_WINDOW_SYSTEM */