1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
24 Emacs separates the task of updating the display from code
25 modifying global state, e.g. buffer text. This way functions
26 operating on buffers don't also have to be concerned with updating
29 Updating the display is triggered by the Lisp interpreter when it
30 decides it's time to do it. This is done either automatically for
31 you as part of the interpreter's command loop or as the result of
32 calling Lisp functions like `sit-for'. The C function `redisplay'
33 in xdisp.c is the only entry into the inner redisplay code.
35 The following diagram shows how redisplay code is invoked. As you
36 can see, Lisp calls redisplay and vice versa. Under window systems
37 like X, some portions of the redisplay code are also called
38 asynchronously during mouse movement or expose events. It is very
39 important that these code parts do NOT use the C library (malloc,
40 free) because many C libraries under Unix are not reentrant. They
41 may also NOT call functions of the Lisp interpreter which could
42 change the interpreter's state. If you don't follow these rules,
43 you will encounter bugs which are very hard to explain.
45 +--------------+ redisplay +----------------+
46 | Lisp machine |---------------->| Redisplay code |<--+
47 +--------------+ (xdisp.c) +----------------+ |
49 +----------------------------------+ |
50 Don't use this path when called |
53 expose_window (asynchronous) |
55 X expose events -----+
57 What does redisplay do? Obviously, it has to figure out somehow what
58 has been changed since the last time the display has been updated,
59 and to make these changes visible. Preferably it would do that in
60 a moderately intelligent way, i.e. fast.
62 Changes in buffer text can be deduced from window and buffer
63 structures, and from some global variables like `beg_unchanged' and
64 `end_unchanged'. The contents of the display are additionally
65 recorded in a `glyph matrix', a two-dimensional matrix of glyph
66 structures. Each row in such a matrix corresponds to a line on the
67 display, and each glyph in a row corresponds to a column displaying
68 a character, an image, or what else. This matrix is called the
69 `current glyph matrix' or `current matrix' in redisplay
72 For buffer parts that have been changed since the last update, a
73 second glyph matrix is constructed, the so called `desired glyph
74 matrix' or short `desired matrix'. Current and desired matrix are
75 then compared to find a cheap way to update the display, e.g. by
76 reusing part of the display by scrolling lines.
78 You will find a lot of redisplay optimizations when you start
79 looking at the innards of redisplay. The overall goal of all these
80 optimizations is to make redisplay fast because it is done
81 frequently. Some of these optimizations are implemented by the
86 This function tries to update the display if the text in the
87 window did not change and did not scroll, only point moved, and
88 it did not move off the displayed portion of the text.
90 . try_window_reusing_current_matrix
92 This function reuses the current matrix of a window when text
93 has not changed, but the window start changed (e.g., due to
98 This function attempts to redisplay a window by reusing parts of
99 its existing display. It finds and reuses the part that was not
100 changed, and redraws the rest.
104 This function performs the full redisplay of a single window
105 assuming that its fonts were not changed and that the cursor
106 will not end up in the scroll margins. (Loading fonts requires
107 re-adjustment of dimensions of glyph matrices, which makes this
108 method impossible to use.)
110 These optimizations are tried in sequence (some can be skipped if
111 it is known that they are not applicable). If none of the
112 optimizations were successful, redisplay calls redisplay_windows,
113 which performs a full redisplay of all windows.
117 Desired matrices are always built per Emacs window. The function
118 `display_line' is the central function to look at if you are
119 interested. It constructs one row in a desired matrix given an
120 iterator structure containing both a buffer position and a
121 description of the environment in which the text is to be
122 displayed. But this is too early, read on.
124 Characters and pixmaps displayed for a range of buffer text depend
125 on various settings of buffers and windows, on overlays and text
126 properties, on display tables, on selective display. The good news
127 is that all this hairy stuff is hidden behind a small set of
128 interface functions taking an iterator structure (struct it)
131 Iteration over things to be displayed is then simple. It is
132 started by initializing an iterator with a call to init_iterator,
133 passing it the buffer position where to start iteration. For
134 iteration over strings, pass -1 as the position to init_iterator,
135 and call reseat_to_string when the string is ready, to initialize
136 the iterator for that string. Thereafter, calls to
137 get_next_display_element fill the iterator structure with relevant
138 information about the next thing to display. Calls to
139 set_iterator_to_next move the iterator to the next thing.
141 Besides this, an iterator also contains information about the
142 display environment in which glyphs for display elements are to be
143 produced. It has fields for the width and height of the display,
144 the information whether long lines are truncated or continued, a
145 current X and Y position, and lots of other stuff you can better
148 Glyphs in a desired matrix are normally constructed in a loop
149 calling get_next_display_element and then PRODUCE_GLYPHS. The call
150 to PRODUCE_GLYPHS will fill the iterator structure with pixel
151 information about the element being displayed and at the same time
152 produce glyphs for it. If the display element fits on the line
153 being displayed, set_iterator_to_next is called next, otherwise the
154 glyphs produced are discarded. The function display_line is the
155 workhorse of filling glyph rows in the desired matrix with glyphs.
156 In addition to producing glyphs, it also handles line truncation
157 and continuation, word wrap, and cursor positioning (for the
158 latter, see also set_cursor_from_row).
162 That just couldn't be all, could it? What about terminal types not
163 supporting operations on sub-windows of the screen? To update the
164 display on such a terminal, window-based glyph matrices are not
165 well suited. To be able to reuse part of the display (scrolling
166 lines up and down), we must instead have a view of the whole
167 screen. This is what `frame matrices' are for. They are a trick.
169 Frames on terminals like above have a glyph pool. Windows on such
170 a frame sub-allocate their glyph memory from their frame's glyph
171 pool. The frame itself is given its own glyph matrices. By
172 coincidence---or maybe something else---rows in window glyph
173 matrices are slices of corresponding rows in frame matrices. Thus
174 writing to window matrices implicitly updates a frame matrix which
175 provides us with the view of the whole screen that we originally
176 wanted to have without having to move many bytes around. To be
177 honest, there is a little bit more done, but not much more. If you
178 plan to extend that code, take a look at dispnew.c. The function
179 build_frame_matrix is a good starting point.
181 Bidirectional display.
183 Bidirectional display adds quite some hair to this already complex
184 design. The good news are that a large portion of that hairy stuff
185 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
186 reordering engine which is called by set_iterator_to_next and
187 returns the next character to display in the visual order. See
188 commentary on bidi.c for more details. As far as redisplay is
189 concerned, the effect of calling bidi_move_to_visually_next, the
190 main interface of the reordering engine, is that the iterator gets
191 magically placed on the buffer or string position that is to be
192 displayed next. In other words, a linear iteration through the
193 buffer/string is replaced with a non-linear one. All the rest of
194 the redisplay is oblivious to the bidi reordering.
196 Well, almost oblivious---there are still complications, most of
197 them due to the fact that buffer and string positions no longer
198 change monotonously with glyph indices in a glyph row. Moreover,
199 for continued lines, the buffer positions may not even be
200 monotonously changing with vertical positions. Also, accounting
201 for face changes, overlays, etc. becomes more complex because
202 non-linear iteration could potentially skip many positions with
203 changes, and then cross them again on the way back...
205 One other prominent effect of bidirectional display is that some
206 paragraphs of text need to be displayed starting at the right
207 margin of the window---the so-called right-to-left, or R2L
208 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
209 which have their reversed_p flag set. The bidi reordering engine
210 produces characters in such rows starting from the character which
211 should be the rightmost on display. PRODUCE_GLYPHS then reverses
212 the order, when it fills up the glyph row whose reversed_p flag is
213 set, by prepending each new glyph to what is already there, instead
214 of appending it. When the glyph row is complete, the function
215 extend_face_to_end_of_line fills the empty space to the left of the
216 leftmost character with special glyphs, which will display as,
217 well, empty. On text terminals, these special glyphs are simply
218 blank characters. On graphics terminals, there's a single stretch
219 glyph of a suitably computed width. Both the blanks and the
220 stretch glyph are given the face of the background of the line.
221 This way, the terminal-specific back-end can still draw the glyphs
222 left to right, even for R2L lines.
224 Bidirectional display and character compositions
226 Some scripts cannot be displayed by drawing each character
227 individually, because adjacent characters change each other's shape
228 on display. For example, Arabic and Indic scripts belong to this
231 Emacs display supports this by providing "character compositions",
232 most of which is implemented in composite.c. During the buffer
233 scan that delivers characters to PRODUCE_GLYPHS, if the next
234 character to be delivered is a composed character, the iteration
235 calls composition_reseat_it and next_element_from_composition. If
236 they succeed to compose the character with one or more of the
237 following characters, the whole sequence of characters that where
238 composed is recorded in the `struct composition_it' object that is
239 part of the buffer iterator. The composed sequence could produce
240 one or more font glyphs (called "grapheme clusters") on the screen.
241 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
242 in the direction corresponding to the current bidi scan direction
243 (recorded in the scan_dir member of the `struct bidi_it' object
244 that is part of the buffer iterator). In particular, if the bidi
245 iterator currently scans the buffer backwards, the grapheme
246 clusters are delivered back to front. This reorders the grapheme
247 clusters as appropriate for the current bidi context. Note that
248 this means that the grapheme clusters are always stored in the
249 LGSTRING object (see composite.c) in the logical order.
251 Moving an iterator in bidirectional text
252 without producing glyphs
254 Note one important detail mentioned above: that the bidi reordering
255 engine, driven by the iterator, produces characters in R2L rows
256 starting at the character that will be the rightmost on display.
257 As far as the iterator is concerned, the geometry of such rows is
258 still left to right, i.e. the iterator "thinks" the first character
259 is at the leftmost pixel position. The iterator does not know that
260 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
261 delivers. This is important when functions from the move_it_*
262 family are used to get to certain screen position or to match
263 screen coordinates with buffer coordinates: these functions use the
264 iterator geometry, which is left to right even in R2L paragraphs.
265 This works well with most callers of move_it_*, because they need
266 to get to a specific column, and columns are still numbered in the
267 reading order, i.e. the rightmost character in a R2L paragraph is
268 still column zero. But some callers do not get well with this; a
269 notable example is mouse clicks that need to find the character
270 that corresponds to certain pixel coordinates. See
271 buffer_posn_from_coords in dispnew.c for how this is handled. */
279 #include "keyboard.h"
282 #include "termchar.h"
283 #include "dispextern.h"
284 #include "character.h"
288 #include "commands.h"
292 #include "termhooks.h"
293 #include "termopts.h"
294 #include "intervals.h"
297 #include "region-cache.h"
300 #include "blockinput.h"
302 #ifdef HAVE_X_WINDOWS
317 #ifndef FRAME_X_OUTPUT
318 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
321 #define INFINITY 10000000
323 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
324 Lisp_Object Qwindow_scroll_functions
;
325 static Lisp_Object Qwindow_text_change_functions
;
326 static Lisp_Object Qredisplay_end_trigger_functions
;
327 Lisp_Object Qinhibit_point_motion_hooks
;
328 static Lisp_Object QCeval
, QCpropertize
;
329 Lisp_Object QCfile
, QCdata
;
330 static Lisp_Object Qfontified
;
331 static Lisp_Object Qgrow_only
;
332 static Lisp_Object Qinhibit_eval_during_redisplay
;
333 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
334 static Lisp_Object Qright_to_left
, Qleft_to_right
;
337 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
339 /* Pointer shapes. */
340 static Lisp_Object Qarrow
, Qhand
;
343 /* Holds the list (error). */
344 static Lisp_Object list_of_error
;
346 static Lisp_Object Qfontification_functions
;
348 static Lisp_Object Qwrap_prefix
;
349 static Lisp_Object Qline_prefix
;
350 static Lisp_Object Qredisplay_internal
;
352 /* Non-nil means don't actually do any redisplay. */
354 Lisp_Object Qinhibit_redisplay
;
356 /* Names of text properties relevant for redisplay. */
358 Lisp_Object Qdisplay
;
360 Lisp_Object Qspace
, QCalign_to
;
361 static Lisp_Object QCrelative_width
, QCrelative_height
;
362 Lisp_Object Qleft_margin
, Qright_margin
;
363 static Lisp_Object Qspace_width
, Qraise
;
364 static Lisp_Object Qslice
;
366 static Lisp_Object Qmargin
, Qpointer
;
367 static Lisp_Object Qline_height
;
369 /* These setters are used only in this file, so they can be private. */
371 wset_base_line_number (struct window
*w
, Lisp_Object val
)
373 w
->base_line_number
= val
;
376 wset_base_line_pos (struct window
*w
, Lisp_Object val
)
378 w
->base_line_pos
= val
;
381 wset_column_number_displayed (struct window
*w
, Lisp_Object val
)
383 w
->column_number_displayed
= val
;
386 wset_region_showing (struct window
*w
, Lisp_Object val
)
388 w
->region_showing
= val
;
391 #ifdef HAVE_WINDOW_SYSTEM
393 /* Test if overflow newline into fringe. Called with iterator IT
394 at or past right window margin, and with IT->current_x set. */
396 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
397 (!NILP (Voverflow_newline_into_fringe) \
398 && FRAME_WINDOW_P ((IT)->f) \
399 && ((IT)->bidi_it.paragraph_dir == R2L \
400 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
401 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
402 && (IT)->current_x == (IT)->last_visible_x \
403 && (IT)->line_wrap != WORD_WRAP)
405 #else /* !HAVE_WINDOW_SYSTEM */
406 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
407 #endif /* HAVE_WINDOW_SYSTEM */
409 /* Test if the display element loaded in IT, or the underlying buffer
410 or string character, is a space or a TAB character. This is used
411 to determine where word wrapping can occur. */
413 #define IT_DISPLAYING_WHITESPACE(it) \
414 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
415 || ((STRINGP (it->string) \
416 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
417 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
419 && (it->s[IT_BYTEPOS (*it)] == ' ' \
420 || it->s[IT_BYTEPOS (*it)] == '\t')) \
421 || (IT_BYTEPOS (*it) < ZV_BYTE \
422 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
423 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
425 /* Name of the face used to highlight trailing whitespace. */
427 static Lisp_Object Qtrailing_whitespace
;
429 /* Name and number of the face used to highlight escape glyphs. */
431 static Lisp_Object Qescape_glyph
;
433 /* Name and number of the face used to highlight non-breaking spaces. */
435 static Lisp_Object Qnobreak_space
;
437 /* The symbol `image' which is the car of the lists used to represent
438 images in Lisp. Also a tool bar style. */
442 /* The image map types. */
444 static Lisp_Object QCpointer
;
445 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
447 /* Tool bar styles */
448 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
450 /* Non-zero means print newline to stdout before next mini-buffer
453 int noninteractive_need_newline
;
455 /* Non-zero means print newline to message log before next message. */
457 static int message_log_need_newline
;
459 /* Three markers that message_dolog uses.
460 It could allocate them itself, but that causes trouble
461 in handling memory-full errors. */
462 static Lisp_Object message_dolog_marker1
;
463 static Lisp_Object message_dolog_marker2
;
464 static Lisp_Object message_dolog_marker3
;
466 /* The buffer position of the first character appearing entirely or
467 partially on the line of the selected window which contains the
468 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
469 redisplay optimization in redisplay_internal. */
471 static struct text_pos this_line_start_pos
;
473 /* Number of characters past the end of the line above, including the
474 terminating newline. */
476 static struct text_pos this_line_end_pos
;
478 /* The vertical positions and the height of this line. */
480 static int this_line_vpos
;
481 static int this_line_y
;
482 static int this_line_pixel_height
;
484 /* X position at which this display line starts. Usually zero;
485 negative if first character is partially visible. */
487 static int this_line_start_x
;
489 /* The smallest character position seen by move_it_* functions as they
490 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
491 hscrolled lines, see display_line. */
493 static struct text_pos this_line_min_pos
;
495 /* Buffer that this_line_.* variables are referring to. */
497 static struct buffer
*this_line_buffer
;
500 /* Values of those variables at last redisplay are stored as
501 properties on `overlay-arrow-position' symbol. However, if
502 Voverlay_arrow_position is a marker, last-arrow-position is its
503 numerical position. */
505 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
507 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
508 properties on a symbol in overlay-arrow-variable-list. */
510 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
512 Lisp_Object Qmenu_bar_update_hook
;
514 /* Nonzero if an overlay arrow has been displayed in this window. */
516 static int overlay_arrow_seen
;
518 /* Number of windows showing the buffer of the selected window (or
519 another buffer with the same base buffer). keyboard.c refers to
524 /* Vector containing glyphs for an ellipsis `...'. */
526 static Lisp_Object default_invis_vector
[3];
528 /* This is the window where the echo area message was displayed. It
529 is always a mini-buffer window, but it may not be the same window
530 currently active as a mini-buffer. */
532 Lisp_Object echo_area_window
;
534 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
535 pushes the current message and the value of
536 message_enable_multibyte on the stack, the function restore_message
537 pops the stack and displays MESSAGE again. */
539 static Lisp_Object Vmessage_stack
;
541 /* Nonzero means multibyte characters were enabled when the echo area
542 message was specified. */
544 static int message_enable_multibyte
;
546 /* Nonzero if we should redraw the mode lines on the next redisplay. */
548 int update_mode_lines
;
550 /* Nonzero if window sizes or contents have changed since last
551 redisplay that finished. */
553 int windows_or_buffers_changed
;
555 /* Nonzero means a frame's cursor type has been changed. */
557 int cursor_type_changed
;
559 /* Nonzero after display_mode_line if %l was used and it displayed a
562 static int line_number_displayed
;
564 /* The name of the *Messages* buffer, a string. */
566 static Lisp_Object Vmessages_buffer_name
;
568 /* Current, index 0, and last displayed echo area message. Either
569 buffers from echo_buffers, or nil to indicate no message. */
571 Lisp_Object echo_area_buffer
[2];
573 /* The buffers referenced from echo_area_buffer. */
575 static Lisp_Object echo_buffer
[2];
577 /* A vector saved used in with_area_buffer to reduce consing. */
579 static Lisp_Object Vwith_echo_area_save_vector
;
581 /* Non-zero means display_echo_area should display the last echo area
582 message again. Set by redisplay_preserve_echo_area. */
584 static int display_last_displayed_message_p
;
586 /* Nonzero if echo area is being used by print; zero if being used by
589 static int message_buf_print
;
591 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
593 static Lisp_Object Qinhibit_menubar_update
;
594 static Lisp_Object Qmessage_truncate_lines
;
596 /* Set to 1 in clear_message to make redisplay_internal aware
597 of an emptied echo area. */
599 static int message_cleared_p
;
601 /* A scratch glyph row with contents used for generating truncation
602 glyphs. Also used in direct_output_for_insert. */
604 #define MAX_SCRATCH_GLYPHS 100
605 static struct glyph_row scratch_glyph_row
;
606 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
608 /* Ascent and height of the last line processed by move_it_to. */
610 static int last_max_ascent
, last_height
;
612 /* Non-zero if there's a help-echo in the echo area. */
614 int help_echo_showing_p
;
616 /* If >= 0, computed, exact values of mode-line and header-line height
617 to use in the macros CURRENT_MODE_LINE_HEIGHT and
618 CURRENT_HEADER_LINE_HEIGHT. */
620 int current_mode_line_height
, current_header_line_height
;
622 /* The maximum distance to look ahead for text properties. Values
623 that are too small let us call compute_char_face and similar
624 functions too often which is expensive. Values that are too large
625 let us call compute_char_face and alike too often because we
626 might not be interested in text properties that far away. */
628 #define TEXT_PROP_DISTANCE_LIMIT 100
630 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
631 iterator state and later restore it. This is needed because the
632 bidi iterator on bidi.c keeps a stacked cache of its states, which
633 is really a singleton. When we use scratch iterator objects to
634 move around the buffer, we can cause the bidi cache to be pushed or
635 popped, and therefore we need to restore the cache state when we
636 return to the original iterator. */
637 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
640 bidi_unshelve_cache (CACHE, 1); \
642 CACHE = bidi_shelve_cache (); \
645 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
647 if (pITORIG != pITCOPY) \
648 *(pITORIG) = *(pITCOPY); \
649 bidi_unshelve_cache (CACHE, 0); \
655 /* Non-zero means print traces of redisplay if compiled with
656 GLYPH_DEBUG defined. */
658 int trace_redisplay_p
;
660 #endif /* GLYPH_DEBUG */
662 #ifdef DEBUG_TRACE_MOVE
663 /* Non-zero means trace with TRACE_MOVE to stderr. */
666 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
668 #define TRACE_MOVE(x) (void) 0
671 static Lisp_Object Qauto_hscroll_mode
;
673 /* Buffer being redisplayed -- for redisplay_window_error. */
675 static struct buffer
*displayed_buffer
;
677 /* Value returned from text property handlers (see below). */
682 HANDLED_RECOMPUTE_PROPS
,
683 HANDLED_OVERLAY_STRING_CONSUMED
,
687 /* A description of text properties that redisplay is interested
692 /* The name of the property. */
695 /* A unique index for the property. */
698 /* A handler function called to set up iterator IT from the property
699 at IT's current position. Value is used to steer handle_stop. */
700 enum prop_handled (*handler
) (struct it
*it
);
703 static enum prop_handled
handle_face_prop (struct it
*);
704 static enum prop_handled
handle_invisible_prop (struct it
*);
705 static enum prop_handled
handle_display_prop (struct it
*);
706 static enum prop_handled
handle_composition_prop (struct it
*);
707 static enum prop_handled
handle_overlay_change (struct it
*);
708 static enum prop_handled
handle_fontified_prop (struct it
*);
710 /* Properties handled by iterators. */
712 static struct props it_props
[] =
714 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
715 /* Handle `face' before `display' because some sub-properties of
716 `display' need to know the face. */
717 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
718 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
719 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
720 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
724 /* Value is the position described by X. If X is a marker, value is
725 the marker_position of X. Otherwise, value is X. */
727 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
729 /* Enumeration returned by some move_it_.* functions internally. */
733 /* Not used. Undefined value. */
736 /* Move ended at the requested buffer position or ZV. */
737 MOVE_POS_MATCH_OR_ZV
,
739 /* Move ended at the requested X pixel position. */
742 /* Move within a line ended at the end of a line that must be
746 /* Move within a line ended at the end of a line that would
747 be displayed truncated. */
750 /* Move within a line ended at a line end. */
754 /* This counter is used to clear the face cache every once in a while
755 in redisplay_internal. It is incremented for each redisplay.
756 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
759 #define CLEAR_FACE_CACHE_COUNT 500
760 static int clear_face_cache_count
;
762 /* Similarly for the image cache. */
764 #ifdef HAVE_WINDOW_SYSTEM
765 #define CLEAR_IMAGE_CACHE_COUNT 101
766 static int clear_image_cache_count
;
768 /* Null glyph slice */
769 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
772 /* True while redisplay_internal is in progress. */
776 static Lisp_Object Qinhibit_free_realized_faces
;
777 static Lisp_Object Qmode_line_default_help_echo
;
779 /* If a string, XTread_socket generates an event to display that string.
780 (The display is done in read_char.) */
782 Lisp_Object help_echo_string
;
783 Lisp_Object help_echo_window
;
784 Lisp_Object help_echo_object
;
785 ptrdiff_t help_echo_pos
;
787 /* Temporary variable for XTread_socket. */
789 Lisp_Object previous_help_echo_string
;
791 /* Platform-independent portion of hourglass implementation. */
793 /* Non-zero means an hourglass cursor is currently shown. */
794 int hourglass_shown_p
;
796 /* If non-null, an asynchronous timer that, when it expires, displays
797 an hourglass cursor on all frames. */
798 struct atimer
*hourglass_atimer
;
800 /* Name of the face used to display glyphless characters. */
801 Lisp_Object Qglyphless_char
;
803 /* Symbol for the purpose of Vglyphless_char_display. */
804 static Lisp_Object Qglyphless_char_display
;
806 /* Method symbols for Vglyphless_char_display. */
807 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
809 /* Default pixel width of `thin-space' display method. */
810 #define THIN_SPACE_WIDTH 1
812 /* Default number of seconds to wait before displaying an hourglass
814 #define DEFAULT_HOURGLASS_DELAY 1
817 /* Function prototypes. */
819 static void setup_for_ellipsis (struct it
*, int);
820 static void set_iterator_to_next (struct it
*, int);
821 static void mark_window_display_accurate_1 (struct window
*, int);
822 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
823 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
824 static int cursor_row_p (struct glyph_row
*);
825 static int redisplay_mode_lines (Lisp_Object
, int);
826 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
828 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
830 static void handle_line_prefix (struct it
*);
832 static void pint2str (char *, int, ptrdiff_t);
833 static void pint2hrstr (char *, int, ptrdiff_t);
834 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
836 static void reconsider_clip_changes (struct window
*, struct buffer
*);
837 static int text_outside_line_unchanged_p (struct window
*,
838 ptrdiff_t, ptrdiff_t);
839 static void store_mode_line_noprop_char (char);
840 static int store_mode_line_noprop (const char *, int, int);
841 static void handle_stop (struct it
*);
842 static void handle_stop_backwards (struct it
*, ptrdiff_t);
843 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
844 static void ensure_echo_area_buffers (void);
845 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
846 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
847 static int with_echo_area_buffer (struct window
*, int,
848 int (*) (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t),
849 ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
850 static void clear_garbaged_frames (void);
851 static int current_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
852 static void pop_message (void);
853 static int truncate_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
854 static void set_message (const char *, Lisp_Object
, ptrdiff_t, int);
855 static int set_message_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
856 static int display_echo_area (struct window
*);
857 static int display_echo_area_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
858 static int resize_mini_window_1 (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t);
859 static Lisp_Object
unwind_redisplay (Lisp_Object
);
860 static int string_char_and_length (const unsigned char *, int *);
861 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
863 static int compute_window_start_on_continuation_line (struct window
*);
864 static void insert_left_trunc_glyphs (struct it
*);
865 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
867 static void extend_face_to_end_of_line (struct it
*);
868 static int append_space_for_newline (struct it
*, int);
869 static int cursor_row_fully_visible_p (struct window
*, int, int);
870 static int try_scrolling (Lisp_Object
, int, ptrdiff_t, ptrdiff_t, int, int);
871 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
872 static int trailing_whitespace_p (ptrdiff_t);
873 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
874 static void push_it (struct it
*, struct text_pos
*);
875 static void iterate_out_of_display_property (struct it
*);
876 static void pop_it (struct it
*);
877 static void sync_frame_with_window_matrix_rows (struct window
*);
878 static void select_frame_for_redisplay (Lisp_Object
);
879 static void redisplay_internal (void);
880 static int echo_area_display (int);
881 static void redisplay_windows (Lisp_Object
);
882 static void redisplay_window (Lisp_Object
, int);
883 static Lisp_Object
redisplay_window_error (Lisp_Object
);
884 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
885 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
886 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
887 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
889 static int update_menu_bar (struct frame
*, int, int);
890 static int try_window_reusing_current_matrix (struct window
*);
891 static int try_window_id (struct window
*);
892 static int display_line (struct it
*);
893 static int display_mode_lines (struct window
*);
894 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
895 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
896 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
897 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
898 static void display_menu_bar (struct window
*);
899 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
901 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
902 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
903 static void compute_line_metrics (struct it
*);
904 static void run_redisplay_end_trigger_hook (struct it
*);
905 static int get_overlay_strings (struct it
*, ptrdiff_t);
906 static int get_overlay_strings_1 (struct it
*, ptrdiff_t, int);
907 static void next_overlay_string (struct it
*);
908 static void reseat (struct it
*, struct text_pos
, int);
909 static void reseat_1 (struct it
*, struct text_pos
, int);
910 static void back_to_previous_visible_line_start (struct it
*);
911 void reseat_at_previous_visible_line_start (struct it
*);
912 static void reseat_at_next_visible_line_start (struct it
*, int);
913 static int next_element_from_ellipsis (struct it
*);
914 static int next_element_from_display_vector (struct it
*);
915 static int next_element_from_string (struct it
*);
916 static int next_element_from_c_string (struct it
*);
917 static int next_element_from_buffer (struct it
*);
918 static int next_element_from_composition (struct it
*);
919 static int next_element_from_image (struct it
*);
920 static int next_element_from_stretch (struct it
*);
921 static void load_overlay_strings (struct it
*, ptrdiff_t);
922 static int init_from_display_pos (struct it
*, struct window
*,
923 struct display_pos
*);
924 static void reseat_to_string (struct it
*, const char *,
925 Lisp_Object
, ptrdiff_t, ptrdiff_t, int, int);
926 static int get_next_display_element (struct it
*);
927 static enum move_it_result
928 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
929 enum move_operation_enum
);
930 void move_it_vertically_backward (struct it
*, int);
931 static void init_to_row_start (struct it
*, struct window
*,
933 static int init_to_row_end (struct it
*, struct window
*,
935 static void back_to_previous_line_start (struct it
*);
936 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
937 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
938 Lisp_Object
, ptrdiff_t);
939 static struct text_pos
string_pos (ptrdiff_t, Lisp_Object
);
940 static struct text_pos
c_string_pos (ptrdiff_t, const char *, int);
941 static ptrdiff_t number_of_chars (const char *, int);
942 static void compute_stop_pos (struct it
*);
943 static void compute_string_pos (struct text_pos
*, struct text_pos
,
945 static int face_before_or_after_it_pos (struct it
*, int);
946 static ptrdiff_t next_overlay_change (ptrdiff_t);
947 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
948 Lisp_Object
, struct text_pos
*, ptrdiff_t, int);
949 static int handle_single_display_spec (struct it
*, Lisp_Object
,
950 Lisp_Object
, Lisp_Object
,
951 struct text_pos
*, ptrdiff_t, int, int);
952 static int underlying_face_id (struct it
*);
953 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
956 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
957 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
959 #ifdef HAVE_WINDOW_SYSTEM
961 static void x_consider_frame_title (Lisp_Object
);
962 static int tool_bar_lines_needed (struct frame
*, int *);
963 static void update_tool_bar (struct frame
*, int);
964 static void build_desired_tool_bar_string (struct frame
*f
);
965 static int redisplay_tool_bar (struct frame
*);
966 static void display_tool_bar_line (struct it
*, int);
967 static void notice_overwritten_cursor (struct window
*,
970 static void append_stretch_glyph (struct it
*, Lisp_Object
,
974 #endif /* HAVE_WINDOW_SYSTEM */
976 static void produce_special_glyphs (struct it
*, enum display_element_type
);
977 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
978 static int coords_in_mouse_face_p (struct window
*, int, int);
982 /***********************************************************************
983 Window display dimensions
984 ***********************************************************************/
986 /* Return the bottom boundary y-position for text lines in window W.
987 This is the first y position at which a line cannot start.
988 It is relative to the top of the window.
990 This is the height of W minus the height of a mode line, if any. */
993 window_text_bottom_y (struct window
*w
)
995 int height
= WINDOW_TOTAL_HEIGHT (w
);
997 if (WINDOW_WANTS_MODELINE_P (w
))
998 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1002 /* Return the pixel width of display area AREA of window W. AREA < 0
1003 means return the total width of W, not including fringes to
1004 the left and right of the window. */
1007 window_box_width (struct window
*w
, int area
)
1009 int cols
= XFASTINT (w
->total_cols
);
1012 if (!w
->pseudo_window_p
)
1014 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
1016 if (area
== TEXT_AREA
)
1018 if (INTEGERP (w
->left_margin_cols
))
1019 cols
-= XFASTINT (w
->left_margin_cols
);
1020 if (INTEGERP (w
->right_margin_cols
))
1021 cols
-= XFASTINT (w
->right_margin_cols
);
1022 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1024 else if (area
== LEFT_MARGIN_AREA
)
1026 cols
= (INTEGERP (w
->left_margin_cols
)
1027 ? XFASTINT (w
->left_margin_cols
) : 0);
1030 else if (area
== RIGHT_MARGIN_AREA
)
1032 cols
= (INTEGERP (w
->right_margin_cols
)
1033 ? XFASTINT (w
->right_margin_cols
) : 0);
1038 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1042 /* Return the pixel height of the display area of window W, not
1043 including mode lines of W, if any. */
1046 window_box_height (struct window
*w
)
1048 struct frame
*f
= XFRAME (w
->frame
);
1049 int height
= WINDOW_TOTAL_HEIGHT (w
);
1051 eassert (height
>= 0);
1053 /* Note: the code below that determines the mode-line/header-line
1054 height is essentially the same as that contained in the macro
1055 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1056 the appropriate glyph row has its `mode_line_p' flag set,
1057 and if it doesn't, uses estimate_mode_line_height instead. */
1059 if (WINDOW_WANTS_MODELINE_P (w
))
1061 struct glyph_row
*ml_row
1062 = (w
->current_matrix
&& w
->current_matrix
->rows
1063 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1065 if (ml_row
&& ml_row
->mode_line_p
)
1066 height
-= ml_row
->height
;
1068 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1071 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1073 struct glyph_row
*hl_row
1074 = (w
->current_matrix
&& w
->current_matrix
->rows
1075 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1077 if (hl_row
&& hl_row
->mode_line_p
)
1078 height
-= hl_row
->height
;
1080 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1083 /* With a very small font and a mode-line that's taller than
1084 default, we might end up with a negative height. */
1085 return max (0, height
);
1088 /* Return the window-relative coordinate of the left edge of display
1089 area AREA of window W. AREA < 0 means return the left edge of the
1090 whole window, to the right of the left fringe of W. */
1093 window_box_left_offset (struct window
*w
, int area
)
1097 if (w
->pseudo_window_p
)
1100 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1102 if (area
== TEXT_AREA
)
1103 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1104 + window_box_width (w
, LEFT_MARGIN_AREA
));
1105 else if (area
== RIGHT_MARGIN_AREA
)
1106 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1107 + window_box_width (w
, LEFT_MARGIN_AREA
)
1108 + window_box_width (w
, TEXT_AREA
)
1109 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1111 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1112 else if (area
== LEFT_MARGIN_AREA
1113 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1114 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1120 /* Return the window-relative coordinate of the right edge of display
1121 area AREA of window W. AREA < 0 means return the right edge of the
1122 whole window, to the left of the right fringe of W. */
1125 window_box_right_offset (struct window
*w
, int area
)
1127 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1130 /* Return the frame-relative coordinate of the left edge of display
1131 area AREA of window W. AREA < 0 means return the left edge of the
1132 whole window, to the right of the left fringe of W. */
1135 window_box_left (struct window
*w
, int area
)
1137 struct frame
*f
= XFRAME (w
->frame
);
1140 if (w
->pseudo_window_p
)
1141 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1143 x
= (WINDOW_LEFT_EDGE_X (w
)
1144 + window_box_left_offset (w
, area
));
1150 /* Return the frame-relative coordinate of the right edge of display
1151 area AREA of window W. AREA < 0 means return the right edge of the
1152 whole window, to the left of the right fringe of W. */
1155 window_box_right (struct window
*w
, int area
)
1157 return window_box_left (w
, area
) + window_box_width (w
, area
);
1160 /* Get the bounding box of the display area AREA of window W, without
1161 mode lines, in frame-relative coordinates. AREA < 0 means the
1162 whole window, not including the left and right fringes of
1163 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1164 coordinates of the upper-left corner of the box. Return in
1165 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1168 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1169 int *box_width
, int *box_height
)
1172 *box_width
= window_box_width (w
, area
);
1174 *box_height
= window_box_height (w
);
1176 *box_x
= window_box_left (w
, area
);
1179 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1180 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1181 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1186 /* Get the bounding box of the display area AREA of window W, without
1187 mode lines. AREA < 0 means the whole window, not including the
1188 left and right fringe of the window. Return in *TOP_LEFT_X
1189 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1190 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1191 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1195 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1196 int *bottom_right_x
, int *bottom_right_y
)
1198 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1200 *bottom_right_x
+= *top_left_x
;
1201 *bottom_right_y
+= *top_left_y
;
1206 /***********************************************************************
1208 ***********************************************************************/
1210 /* Return the bottom y-position of the line the iterator IT is in.
1211 This can modify IT's settings. */
1214 line_bottom_y (struct it
*it
)
1216 int line_height
= it
->max_ascent
+ it
->max_descent
;
1217 int line_top_y
= it
->current_y
;
1219 if (line_height
== 0)
1222 line_height
= last_height
;
1223 else if (IT_CHARPOS (*it
) < ZV
)
1225 move_it_by_lines (it
, 1);
1226 line_height
= (it
->max_ascent
|| it
->max_descent
1227 ? it
->max_ascent
+ it
->max_descent
1232 struct glyph_row
*row
= it
->glyph_row
;
1234 /* Use the default character height. */
1235 it
->glyph_row
= NULL
;
1236 it
->what
= IT_CHARACTER
;
1239 PRODUCE_GLYPHS (it
);
1240 line_height
= it
->ascent
+ it
->descent
;
1241 it
->glyph_row
= row
;
1245 return line_top_y
+ line_height
;
1248 /* Subroutine of pos_visible_p below. Extracts a display string, if
1249 any, from the display spec given as its argument. */
1251 string_from_display_spec (Lisp_Object spec
)
1255 while (CONSP (spec
))
1257 if (STRINGP (XCAR (spec
)))
1262 else if (VECTORP (spec
))
1266 for (i
= 0; i
< ASIZE (spec
); i
++)
1268 if (STRINGP (AREF (spec
, i
)))
1269 return AREF (spec
, i
);
1278 /* Limit insanely large values of W->hscroll on frame F to the largest
1279 value that will still prevent first_visible_x and last_visible_x of
1280 'struct it' from overflowing an int. */
1282 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1284 ptrdiff_t window_hscroll
= w
->hscroll
;
1285 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1286 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1288 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1289 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1291 return window_hscroll
;
1294 /* Return 1 if position CHARPOS is visible in window W.
1295 CHARPOS < 0 means return info about WINDOW_END position.
1296 If visible, set *X and *Y to pixel coordinates of top left corner.
1297 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1298 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1301 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1302 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1305 void *itdata
= bidi_shelve_cache ();
1306 struct text_pos top
;
1308 struct buffer
*old_buffer
= NULL
;
1310 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1313 if (XBUFFER (w
->buffer
) != current_buffer
)
1315 old_buffer
= current_buffer
;
1316 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1319 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1320 /* Scrolling a minibuffer window via scroll bar when the echo area
1321 shows long text sometimes resets the minibuffer contents behind
1323 if (CHARPOS (top
) > ZV
)
1324 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1326 /* Compute exact mode line heights. */
1327 if (WINDOW_WANTS_MODELINE_P (w
))
1328 current_mode_line_height
1329 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1330 BVAR (current_buffer
, mode_line_format
));
1332 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1333 current_header_line_height
1334 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1335 BVAR (current_buffer
, header_line_format
));
1337 start_display (&it
, w
, top
);
1338 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1339 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1342 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1343 && IT_CHARPOS (it
) >= charpos
)
1344 /* When scanning backwards under bidi iteration, move_it_to
1345 stops at or _before_ CHARPOS, because it stops at or to
1346 the _right_ of the character at CHARPOS. */
1347 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1348 && IT_CHARPOS (it
) <= charpos
)))
1350 /* We have reached CHARPOS, or passed it. How the call to
1351 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1352 or covered by a display property, move_it_to stops at the end
1353 of the invisible text, to the right of CHARPOS. (ii) If
1354 CHARPOS is in a display vector, move_it_to stops on its last
1356 int top_x
= it
.current_x
;
1357 int top_y
= it
.current_y
;
1358 /* Calling line_bottom_y may change it.method, it.position, etc. */
1359 enum it_method it_method
= it
.method
;
1360 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1361 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1363 if (top_y
< window_top_y
)
1364 visible_p
= bottom_y
> window_top_y
;
1365 else if (top_y
< it
.last_visible_y
)
1367 if (bottom_y
>= it
.last_visible_y
1368 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1369 && IT_CHARPOS (it
) < charpos
)
1371 /* When the last line of the window is scanned backwards
1372 under bidi iteration, we could be duped into thinking
1373 that we have passed CHARPOS, when in fact move_it_to
1374 simply stopped short of CHARPOS because it reached
1375 last_visible_y. To see if that's what happened, we call
1376 move_it_to again with a slightly larger vertical limit,
1377 and see if it actually moved vertically; if it did, we
1378 didn't really reach CHARPOS, which is beyond window end. */
1379 struct it save_it
= it
;
1380 /* Why 10? because we don't know how many canonical lines
1381 will the height of the next line(s) be. So we guess. */
1382 int ten_more_lines
=
1383 10 * FRAME_LINE_HEIGHT (XFRAME (WINDOW_FRAME (w
)));
1385 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1386 MOVE_TO_POS
| MOVE_TO_Y
);
1387 if (it
.current_y
> top_y
)
1394 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1396 /* We stopped on the last glyph of a display vector.
1397 Try and recompute. Hack alert! */
1398 if (charpos
< 2 || top
.charpos
>= charpos
)
1399 top_x
= it
.glyph_row
->x
;
1403 start_display (&it2
, w
, top
);
1404 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1405 get_next_display_element (&it2
);
1406 PRODUCE_GLYPHS (&it2
);
1407 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1408 || it2
.current_x
> it2
.last_visible_x
)
1409 top_x
= it
.glyph_row
->x
;
1412 top_x
= it2
.current_x
;
1413 top_y
= it2
.current_y
;
1417 else if (IT_CHARPOS (it
) != charpos
)
1419 Lisp_Object cpos
= make_number (charpos
);
1420 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1421 Lisp_Object string
= string_from_display_spec (spec
);
1422 int newline_in_string
= 0;
1424 if (STRINGP (string
))
1426 const char *s
= SSDATA (string
);
1427 const char *e
= s
+ SBYTES (string
);
1432 newline_in_string
= 1;
1437 /* The tricky code below is needed because there's a
1438 discrepancy between move_it_to and how we set cursor
1439 when the display line ends in a newline from a
1440 display string. move_it_to will stop _after_ such
1441 display strings, whereas set_cursor_from_row
1442 conspires with cursor_row_p to place the cursor on
1443 the first glyph produced from the display string. */
1445 /* We have overshoot PT because it is covered by a
1446 display property whose value is a string. If the
1447 string includes embedded newlines, we are also in the
1448 wrong display line. Backtrack to the correct line,
1449 where the display string begins. */
1450 if (newline_in_string
)
1452 Lisp_Object startpos
, endpos
;
1453 EMACS_INT start
, end
;
1457 /* Find the first and the last buffer positions
1458 covered by the display string. */
1460 Fnext_single_char_property_change (cpos
, Qdisplay
,
1463 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1465 start
= XFASTINT (startpos
);
1466 end
= XFASTINT (endpos
);
1467 /* Move to the last buffer position before the
1468 display property. */
1469 start_display (&it3
, w
, top
);
1470 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1471 /* Move forward one more line if the position before
1472 the display string is a newline or if it is the
1473 rightmost character on a line that is
1474 continued or word-wrapped. */
1475 if (it3
.method
== GET_FROM_BUFFER
1477 move_it_by_lines (&it3
, 1);
1478 else if (move_it_in_display_line_to (&it3
, -1,
1482 == MOVE_LINE_CONTINUED
)
1484 move_it_by_lines (&it3
, 1);
1485 /* When we are under word-wrap, the #$@%!
1486 move_it_by_lines moves 2 lines, so we need to
1488 if (it3
.line_wrap
== WORD_WRAP
)
1489 move_it_by_lines (&it3
, -1);
1492 /* Record the vertical coordinate of the display
1493 line where we wound up. */
1494 top_y
= it3
.current_y
;
1497 /* When characters are reordered for display,
1498 the character displayed to the left of the
1499 display string could be _after_ the display
1500 property in the logical order. Use the
1501 smallest vertical position of these two. */
1502 start_display (&it3
, w
, top
);
1503 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1504 if (it3
.current_y
< top_y
)
1505 top_y
= it3
.current_y
;
1507 /* Move from the top of the window to the beginning
1508 of the display line where the display string
1510 start_display (&it3
, w
, top
);
1511 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1512 /* If it3_moved stays zero after the 'while' loop
1513 below, that means we already were at a newline
1514 before the loop (e.g., the display string begins
1515 with a newline), so we don't need to (and cannot)
1516 inspect the glyphs of it3.glyph_row, because
1517 PRODUCE_GLYPHS will not produce anything for a
1518 newline, and thus it3.glyph_row stays at its
1519 stale content it got at top of the window. */
1521 /* Finally, advance the iterator until we hit the
1522 first display element whose character position is
1523 CHARPOS, or until the first newline from the
1524 display string, which signals the end of the
1526 while (get_next_display_element (&it3
))
1528 PRODUCE_GLYPHS (&it3
);
1529 if (IT_CHARPOS (it3
) == charpos
1530 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1533 set_iterator_to_next (&it3
, 0);
1535 top_x
= it3
.current_x
- it3
.pixel_width
;
1536 /* Normally, we would exit the above loop because we
1537 found the display element whose character
1538 position is CHARPOS. For the contingency that we
1539 didn't, and stopped at the first newline from the
1540 display string, move back over the glyphs
1541 produced from the string, until we find the
1542 rightmost glyph not from the string. */
1544 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1546 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1547 + it3
.glyph_row
->used
[TEXT_AREA
];
1549 while (EQ ((g
- 1)->object
, string
))
1552 top_x
-= g
->pixel_width
;
1554 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1555 + it3
.glyph_row
->used
[TEXT_AREA
]);
1561 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1562 *rtop
= max (0, window_top_y
- top_y
);
1563 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1564 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1565 - max (top_y
, window_top_y
)));
1571 /* We were asked to provide info about WINDOW_END. */
1573 void *it2data
= NULL
;
1575 SAVE_IT (it2
, it
, it2data
);
1576 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1577 move_it_by_lines (&it
, 1);
1578 if (charpos
< IT_CHARPOS (it
)
1579 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1582 RESTORE_IT (&it2
, &it2
, it2data
);
1583 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1585 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1586 *rtop
= max (0, -it2
.current_y
);
1587 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1588 - it
.last_visible_y
));
1589 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1591 - max (it2
.current_y
,
1592 WINDOW_HEADER_LINE_HEIGHT (w
))));
1596 bidi_unshelve_cache (it2data
, 1);
1598 bidi_unshelve_cache (itdata
, 0);
1601 set_buffer_internal_1 (old_buffer
);
1603 current_header_line_height
= current_mode_line_height
= -1;
1605 if (visible_p
&& w
->hscroll
> 0)
1607 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1608 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1611 /* Debugging code. */
1613 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1614 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1616 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1623 /* Return the next character from STR. Return in *LEN the length of
1624 the character. This is like STRING_CHAR_AND_LENGTH but never
1625 returns an invalid character. If we find one, we return a `?', but
1626 with the length of the invalid character. */
1629 string_char_and_length (const unsigned char *str
, int *len
)
1633 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1634 if (!CHAR_VALID_P (c
))
1635 /* We may not change the length here because other places in Emacs
1636 don't use this function, i.e. they silently accept invalid
1645 /* Given a position POS containing a valid character and byte position
1646 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1648 static struct text_pos
1649 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1651 eassert (STRINGP (string
) && nchars
>= 0);
1653 if (STRING_MULTIBYTE (string
))
1655 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1660 string_char_and_length (p
, &len
);
1663 BYTEPOS (pos
) += len
;
1667 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1673 /* Value is the text position, i.e. character and byte position,
1674 for character position CHARPOS in STRING. */
1676 static struct text_pos
1677 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1679 struct text_pos pos
;
1680 eassert (STRINGP (string
));
1681 eassert (charpos
>= 0);
1682 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1687 /* Value is a text position, i.e. character and byte position, for
1688 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1689 means recognize multibyte characters. */
1691 static struct text_pos
1692 c_string_pos (ptrdiff_t charpos
, const char *s
, int multibyte_p
)
1694 struct text_pos pos
;
1696 eassert (s
!= NULL
);
1697 eassert (charpos
>= 0);
1703 SET_TEXT_POS (pos
, 0, 0);
1706 string_char_and_length ((const unsigned char *) s
, &len
);
1709 BYTEPOS (pos
) += len
;
1713 SET_TEXT_POS (pos
, charpos
, charpos
);
1719 /* Value is the number of characters in C string S. MULTIBYTE_P
1720 non-zero means recognize multibyte characters. */
1723 number_of_chars (const char *s
, int multibyte_p
)
1729 ptrdiff_t rest
= strlen (s
);
1731 const unsigned char *p
= (const unsigned char *) s
;
1733 for (nchars
= 0; rest
> 0; ++nchars
)
1735 string_char_and_length (p
, &len
);
1736 rest
-= len
, p
+= len
;
1740 nchars
= strlen (s
);
1746 /* Compute byte position NEWPOS->bytepos corresponding to
1747 NEWPOS->charpos. POS is a known position in string STRING.
1748 NEWPOS->charpos must be >= POS.charpos. */
1751 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1753 eassert (STRINGP (string
));
1754 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1756 if (STRING_MULTIBYTE (string
))
1757 *newpos
= string_pos_nchars_ahead (pos
, string
,
1758 CHARPOS (*newpos
) - CHARPOS (pos
));
1760 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1764 Return an estimation of the pixel height of mode or header lines on
1765 frame F. FACE_ID specifies what line's height to estimate. */
1768 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1770 #ifdef HAVE_WINDOW_SYSTEM
1771 if (FRAME_WINDOW_P (f
))
1773 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1775 /* This function is called so early when Emacs starts that the face
1776 cache and mode line face are not yet initialized. */
1777 if (FRAME_FACE_CACHE (f
))
1779 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1783 height
= FONT_HEIGHT (face
->font
);
1784 if (face
->box_line_width
> 0)
1785 height
+= 2 * face
->box_line_width
;
1796 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1797 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1798 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1799 not force the value into range. */
1802 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1803 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1806 #ifdef HAVE_WINDOW_SYSTEM
1807 if (FRAME_WINDOW_P (f
))
1809 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1810 even for negative values. */
1812 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1814 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1816 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1817 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1820 STORE_NATIVE_RECT (*bounds
,
1821 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1822 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1823 FRAME_COLUMN_WIDTH (f
) - 1,
1824 FRAME_LINE_HEIGHT (f
) - 1);
1830 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1831 pix_x
= FRAME_TOTAL_COLS (f
);
1835 else if (pix_y
> FRAME_LINES (f
))
1836 pix_y
= FRAME_LINES (f
);
1846 /* Find the glyph under window-relative coordinates X/Y in window W.
1847 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1848 strings. Return in *HPOS and *VPOS the row and column number of
1849 the glyph found. Return in *AREA the glyph area containing X.
1850 Value is a pointer to the glyph found or null if X/Y is not on
1851 text, or we can't tell because W's current matrix is not up to
1856 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1857 int *dx
, int *dy
, int *area
)
1859 struct glyph
*glyph
, *end
;
1860 struct glyph_row
*row
= NULL
;
1863 /* Find row containing Y. Give up if some row is not enabled. */
1864 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1866 row
= MATRIX_ROW (w
->current_matrix
, i
);
1867 if (!row
->enabled_p
)
1869 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1876 /* Give up if Y is not in the window. */
1877 if (i
== w
->current_matrix
->nrows
)
1880 /* Get the glyph area containing X. */
1881 if (w
->pseudo_window_p
)
1888 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1890 *area
= LEFT_MARGIN_AREA
;
1891 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1893 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1896 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1900 *area
= RIGHT_MARGIN_AREA
;
1901 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1905 /* Find glyph containing X. */
1906 glyph
= row
->glyphs
[*area
];
1907 end
= glyph
+ row
->used
[*area
];
1909 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1911 x
-= glyph
->pixel_width
;
1921 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1924 *hpos
= glyph
- row
->glyphs
[*area
];
1928 /* Convert frame-relative x/y to coordinates relative to window W.
1929 Takes pseudo-windows into account. */
1932 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1934 if (w
->pseudo_window_p
)
1936 /* A pseudo-window is always full-width, and starts at the
1937 left edge of the frame, plus a frame border. */
1938 struct frame
*f
= XFRAME (w
->frame
);
1939 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1940 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1944 *x
-= WINDOW_LEFT_EDGE_X (w
);
1945 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1949 #ifdef HAVE_WINDOW_SYSTEM
1952 Return in RECTS[] at most N clipping rectangles for glyph string S.
1953 Return the number of stored rectangles. */
1956 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1963 if (s
->row
->full_width_p
)
1965 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1966 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1967 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1969 /* Unless displaying a mode or menu bar line, which are always
1970 fully visible, clip to the visible part of the row. */
1971 if (s
->w
->pseudo_window_p
)
1972 r
.height
= s
->row
->visible_height
;
1974 r
.height
= s
->height
;
1978 /* This is a text line that may be partially visible. */
1979 r
.x
= window_box_left (s
->w
, s
->area
);
1980 r
.width
= window_box_width (s
->w
, s
->area
);
1981 r
.height
= s
->row
->visible_height
;
1985 if (r
.x
< s
->clip_head
->x
)
1987 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1988 r
.width
-= s
->clip_head
->x
- r
.x
;
1991 r
.x
= s
->clip_head
->x
;
1994 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1996 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1997 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
2002 /* If S draws overlapping rows, it's sufficient to use the top and
2003 bottom of the window for clipping because this glyph string
2004 intentionally draws over other lines. */
2005 if (s
->for_overlaps
)
2007 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2008 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2010 /* Alas, the above simple strategy does not work for the
2011 environments with anti-aliased text: if the same text is
2012 drawn onto the same place multiple times, it gets thicker.
2013 If the overlap we are processing is for the erased cursor, we
2014 take the intersection with the rectangle of the cursor. */
2015 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2017 XRectangle rc
, r_save
= r
;
2019 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2020 rc
.y
= s
->w
->phys_cursor
.y
;
2021 rc
.width
= s
->w
->phys_cursor_width
;
2022 rc
.height
= s
->w
->phys_cursor_height
;
2024 x_intersect_rectangles (&r_save
, &rc
, &r
);
2029 /* Don't use S->y for clipping because it doesn't take partially
2030 visible lines into account. For example, it can be negative for
2031 partially visible lines at the top of a window. */
2032 if (!s
->row
->full_width_p
2033 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2034 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2036 r
.y
= max (0, s
->row
->y
);
2039 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2041 /* If drawing the cursor, don't let glyph draw outside its
2042 advertised boundaries. Cleartype does this under some circumstances. */
2043 if (s
->hl
== DRAW_CURSOR
)
2045 struct glyph
*glyph
= s
->first_glyph
;
2050 r
.width
-= s
->x
- r
.x
;
2053 r
.width
= min (r
.width
, glyph
->pixel_width
);
2055 /* If r.y is below window bottom, ensure that we still see a cursor. */
2056 height
= min (glyph
->ascent
+ glyph
->descent
,
2057 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2058 max_y
= window_text_bottom_y (s
->w
) - height
;
2059 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2060 if (s
->ybase
- glyph
->ascent
> max_y
)
2067 /* Don't draw cursor glyph taller than our actual glyph. */
2068 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2069 if (height
< r
.height
)
2071 max_y
= r
.y
+ r
.height
;
2072 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2073 r
.height
= min (max_y
- r
.y
, height
);
2080 XRectangle r_save
= r
;
2082 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2086 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2087 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2089 #ifdef CONVERT_FROM_XRECT
2090 CONVERT_FROM_XRECT (r
, *rects
);
2098 /* If we are processing overlapping and allowed to return
2099 multiple clipping rectangles, we exclude the row of the glyph
2100 string from the clipping rectangle. This is to avoid drawing
2101 the same text on the environment with anti-aliasing. */
2102 #ifdef CONVERT_FROM_XRECT
2105 XRectangle
*rs
= rects
;
2107 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2109 if (s
->for_overlaps
& OVERLAPS_PRED
)
2112 if (r
.y
+ r
.height
> row_y
)
2115 rs
[i
].height
= row_y
- r
.y
;
2121 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2124 if (r
.y
< row_y
+ s
->row
->visible_height
)
2126 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2128 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2129 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2138 #ifdef CONVERT_FROM_XRECT
2139 for (i
= 0; i
< n
; i
++)
2140 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2147 Return in *NR the clipping rectangle for glyph string S. */
2150 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2152 get_glyph_string_clip_rects (s
, nr
, 1);
2157 Return the position and height of the phys cursor in window W.
2158 Set w->phys_cursor_width to width of phys cursor.
2162 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2163 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2165 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2166 int x
, y
, wd
, h
, h0
, y0
;
2168 /* Compute the width of the rectangle to draw. If on a stretch
2169 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2170 rectangle as wide as the glyph, but use a canonical character
2172 wd
= glyph
->pixel_width
- 1;
2173 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2177 x
= w
->phys_cursor
.x
;
2184 if (glyph
->type
== STRETCH_GLYPH
2185 && !x_stretch_cursor_p
)
2186 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2187 w
->phys_cursor_width
= wd
;
2189 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2191 /* If y is below window bottom, ensure that we still see a cursor. */
2192 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2194 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2195 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2197 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2200 h
= max (h
- (y0
- y
) + 1, h0
);
2205 y0
= window_text_bottom_y (w
) - h0
;
2213 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2214 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2219 * Remember which glyph the mouse is over.
2223 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2227 struct glyph_row
*r
, *gr
, *end_row
;
2228 enum window_part part
;
2229 enum glyph_row_area area
;
2230 int x
, y
, width
, height
;
2232 /* Try to determine frame pixel position and size of the glyph under
2233 frame pixel coordinates X/Y on frame F. */
2235 if (!f
->glyphs_initialized_p
2236 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2239 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2240 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2244 w
= XWINDOW (window
);
2245 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2246 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2248 x
= window_relative_x_coord (w
, part
, gx
);
2249 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2251 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2252 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2254 if (w
->pseudo_window_p
)
2257 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2263 case ON_LEFT_MARGIN
:
2264 area
= LEFT_MARGIN_AREA
;
2267 case ON_RIGHT_MARGIN
:
2268 area
= RIGHT_MARGIN_AREA
;
2271 case ON_HEADER_LINE
:
2273 gr
= (part
== ON_HEADER_LINE
2274 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2275 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2278 goto text_glyph_row_found
;
2285 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2286 if (r
->y
+ r
->height
> y
)
2292 text_glyph_row_found
:
2295 struct glyph
*g
= gr
->glyphs
[area
];
2296 struct glyph
*end
= g
+ gr
->used
[area
];
2298 height
= gr
->height
;
2299 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2300 if (gx
+ g
->pixel_width
> x
)
2305 if (g
->type
== IMAGE_GLYPH
)
2307 /* Don't remember when mouse is over image, as
2308 image may have hot-spots. */
2309 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2312 width
= g
->pixel_width
;
2316 /* Use nominal char spacing at end of line. */
2318 gx
+= (x
/ width
) * width
;
2321 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2322 gx
+= window_box_left_offset (w
, area
);
2326 /* Use nominal line height at end of window. */
2327 gx
= (x
/ width
) * width
;
2329 gy
+= (y
/ height
) * height
;
2333 case ON_LEFT_FRINGE
:
2334 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2335 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2336 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2337 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2340 case ON_RIGHT_FRINGE
:
2341 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2342 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2343 : window_box_right_offset (w
, TEXT_AREA
));
2344 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2348 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2350 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2351 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2352 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2354 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2358 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2359 if (r
->y
+ r
->height
> y
)
2366 height
= gr
->height
;
2369 /* Use nominal line height at end of window. */
2371 gy
+= (y
/ height
) * height
;
2378 /* If there is no glyph under the mouse, then we divide the screen
2379 into a grid of the smallest glyph in the frame, and use that
2382 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2383 round down even for negative values. */
2389 gx
= (gx
/ width
) * width
;
2390 gy
= (gy
/ height
) * height
;
2395 gx
+= WINDOW_LEFT_EDGE_X (w
);
2396 gy
+= WINDOW_TOP_EDGE_Y (w
);
2399 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2401 /* Visible feedback for debugging. */
2404 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2405 f
->output_data
.x
->normal_gc
,
2406 gx
, gy
, width
, height
);
2412 #endif /* HAVE_WINDOW_SYSTEM */
2415 /***********************************************************************
2416 Lisp form evaluation
2417 ***********************************************************************/
2419 /* Error handler for safe_eval and safe_call. */
2422 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2424 add_to_log ("Error during redisplay: %S signaled %S",
2425 Flist (nargs
, args
), arg
);
2429 /* Call function FUNC with the rest of NARGS - 1 arguments
2430 following. Return the result, or nil if something went
2431 wrong. Prevent redisplay during the evaluation. */
2434 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2438 if (inhibit_eval_during_redisplay
)
2444 ptrdiff_t count
= SPECPDL_INDEX ();
2445 struct gcpro gcpro1
;
2446 Lisp_Object
*args
= alloca (nargs
* word_size
);
2449 va_start (ap
, func
);
2450 for (i
= 1; i
< nargs
; i
++)
2451 args
[i
] = va_arg (ap
, Lisp_Object
);
2455 gcpro1
.nvars
= nargs
;
2456 specbind (Qinhibit_redisplay
, Qt
);
2457 /* Use Qt to ensure debugger does not run,
2458 so there is no possibility of wanting to redisplay. */
2459 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2462 val
= unbind_to (count
, val
);
2469 /* Call function FN with one argument ARG.
2470 Return the result, or nil if something went wrong. */
2473 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2475 return safe_call (2, fn
, arg
);
2478 static Lisp_Object Qeval
;
2481 safe_eval (Lisp_Object sexpr
)
2483 return safe_call1 (Qeval
, sexpr
);
2486 /* Call function FN with two arguments ARG1 and ARG2.
2487 Return the result, or nil if something went wrong. */
2490 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2492 return safe_call (3, fn
, arg1
, arg2
);
2497 /***********************************************************************
2499 ***********************************************************************/
2503 /* Define CHECK_IT to perform sanity checks on iterators.
2504 This is for debugging. It is too slow to do unconditionally. */
2507 check_it (struct it
*it
)
2509 if (it
->method
== GET_FROM_STRING
)
2511 eassert (STRINGP (it
->string
));
2512 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2516 eassert (IT_STRING_CHARPOS (*it
) < 0);
2517 if (it
->method
== GET_FROM_BUFFER
)
2519 /* Check that character and byte positions agree. */
2520 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2525 eassert (it
->current
.dpvec_index
>= 0);
2527 eassert (it
->current
.dpvec_index
< 0);
2530 #define CHECK_IT(IT) check_it ((IT))
2534 #define CHECK_IT(IT) (void) 0
2539 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2541 /* Check that the window end of window W is what we expect it
2542 to be---the last row in the current matrix displaying text. */
2545 check_window_end (struct window
*w
)
2547 if (!MINI_WINDOW_P (w
)
2548 && !NILP (w
->window_end_valid
))
2550 struct glyph_row
*row
;
2551 eassert ((row
= MATRIX_ROW (w
->current_matrix
,
2552 XFASTINT (w
->window_end_vpos
)),
2554 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2555 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2559 #define CHECK_WINDOW_END(W) check_window_end ((W))
2563 #define CHECK_WINDOW_END(W) (void) 0
2565 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
2569 /***********************************************************************
2570 Iterator initialization
2571 ***********************************************************************/
2573 /* Initialize IT for displaying current_buffer in window W, starting
2574 at character position CHARPOS. CHARPOS < 0 means that no buffer
2575 position is specified which is useful when the iterator is assigned
2576 a position later. BYTEPOS is the byte position corresponding to
2577 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2579 If ROW is not null, calls to produce_glyphs with IT as parameter
2580 will produce glyphs in that row.
2582 BASE_FACE_ID is the id of a base face to use. It must be one of
2583 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2584 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2585 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2587 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2588 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2589 will be initialized to use the corresponding mode line glyph row of
2590 the desired matrix of W. */
2593 init_iterator (struct it
*it
, struct window
*w
,
2594 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2595 struct glyph_row
*row
, enum face_id base_face_id
)
2597 int highlight_region_p
;
2598 enum face_id remapped_base_face_id
= base_face_id
;
2600 /* Some precondition checks. */
2601 eassert (w
!= NULL
&& it
!= NULL
);
2602 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2605 /* If face attributes have been changed since the last redisplay,
2606 free realized faces now because they depend on face definitions
2607 that might have changed. Don't free faces while there might be
2608 desired matrices pending which reference these faces. */
2609 if (face_change_count
&& !inhibit_free_realized_faces
)
2611 face_change_count
= 0;
2612 free_all_realized_faces (Qnil
);
2615 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2616 if (! NILP (Vface_remapping_alist
))
2617 remapped_base_face_id
2618 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2620 /* Use one of the mode line rows of W's desired matrix if
2624 if (base_face_id
== MODE_LINE_FACE_ID
2625 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2626 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2627 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2628 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2632 memset (it
, 0, sizeof *it
);
2633 it
->current
.overlay_string_index
= -1;
2634 it
->current
.dpvec_index
= -1;
2635 it
->base_face_id
= remapped_base_face_id
;
2637 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2638 it
->paragraph_embedding
= L2R
;
2639 it
->bidi_it
.string
.lstring
= Qnil
;
2640 it
->bidi_it
.string
.s
= NULL
;
2641 it
->bidi_it
.string
.bufpos
= 0;
2643 /* The window in which we iterate over current_buffer: */
2644 XSETWINDOW (it
->window
, w
);
2646 it
->f
= XFRAME (w
->frame
);
2650 /* Extra space between lines (on window systems only). */
2651 if (base_face_id
== DEFAULT_FACE_ID
2652 && FRAME_WINDOW_P (it
->f
))
2654 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2655 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2656 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2657 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2658 * FRAME_LINE_HEIGHT (it
->f
));
2659 else if (it
->f
->extra_line_spacing
> 0)
2660 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2661 it
->max_extra_line_spacing
= 0;
2664 /* If realized faces have been removed, e.g. because of face
2665 attribute changes of named faces, recompute them. When running
2666 in batch mode, the face cache of the initial frame is null. If
2667 we happen to get called, make a dummy face cache. */
2668 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2669 init_frame_faces (it
->f
);
2670 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2671 recompute_basic_faces (it
->f
);
2673 /* Current value of the `slice', `space-width', and 'height' properties. */
2674 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2675 it
->space_width
= Qnil
;
2676 it
->font_height
= Qnil
;
2677 it
->override_ascent
= -1;
2679 /* Are control characters displayed as `^C'? */
2680 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2682 /* -1 means everything between a CR and the following line end
2683 is invisible. >0 means lines indented more than this value are
2685 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2687 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2689 : (!NILP (BVAR (current_buffer
, selective_display
))
2691 it
->selective_display_ellipsis_p
2692 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2694 /* Display table to use. */
2695 it
->dp
= window_display_table (w
);
2697 /* Are multibyte characters enabled in current_buffer? */
2698 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2700 /* Non-zero if we should highlight the region. */
2702 = (!NILP (Vtransient_mark_mode
)
2703 && !NILP (BVAR (current_buffer
, mark_active
))
2704 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2706 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2707 start and end of a visible region in window IT->w. Set both to
2708 -1 to indicate no region. */
2709 if (highlight_region_p
2710 /* Maybe highlight only in selected window. */
2711 && (/* Either show region everywhere. */
2712 highlight_nonselected_windows
2713 /* Or show region in the selected window. */
2714 || w
== XWINDOW (selected_window
)
2715 /* Or show the region if we are in the mini-buffer and W is
2716 the window the mini-buffer refers to. */
2717 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2718 && WINDOWP (minibuf_selected_window
)
2719 && w
== XWINDOW (minibuf_selected_window
))))
2721 ptrdiff_t markpos
= marker_position (BVAR (current_buffer
, mark
));
2722 it
->region_beg_charpos
= min (PT
, markpos
);
2723 it
->region_end_charpos
= max (PT
, markpos
);
2726 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2728 /* Get the position at which the redisplay_end_trigger hook should
2729 be run, if it is to be run at all. */
2730 if (MARKERP (w
->redisplay_end_trigger
)
2731 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2732 it
->redisplay_end_trigger_charpos
2733 = marker_position (w
->redisplay_end_trigger
);
2734 else if (INTEGERP (w
->redisplay_end_trigger
))
2735 it
->redisplay_end_trigger_charpos
=
2736 clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
), PTRDIFF_MAX
);
2738 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2740 /* Are lines in the display truncated? */
2741 if (base_face_id
!= DEFAULT_FACE_ID
2743 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2744 && ((!NILP (Vtruncate_partial_width_windows
)
2745 && !INTEGERP (Vtruncate_partial_width_windows
))
2746 || (INTEGERP (Vtruncate_partial_width_windows
)
2747 && (WINDOW_TOTAL_COLS (it
->w
)
2748 < XINT (Vtruncate_partial_width_windows
))))))
2749 it
->line_wrap
= TRUNCATE
;
2750 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2751 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2752 ? WINDOW_WRAP
: WORD_WRAP
;
2754 it
->line_wrap
= TRUNCATE
;
2756 /* Get dimensions of truncation and continuation glyphs. These are
2757 displayed as fringe bitmaps under X, but we need them for such
2758 frames when the fringes are turned off. But leave the dimensions
2759 zero for tooltip frames, as these glyphs look ugly there and also
2760 sabotage calculations of tooltip dimensions in x-show-tip. */
2761 #ifdef HAVE_WINDOW_SYSTEM
2762 if (!(FRAME_WINDOW_P (it
->f
)
2763 && FRAMEP (tip_frame
)
2764 && it
->f
== XFRAME (tip_frame
)))
2767 if (it
->line_wrap
== TRUNCATE
)
2769 /* We will need the truncation glyph. */
2770 eassert (it
->glyph_row
== NULL
);
2771 produce_special_glyphs (it
, IT_TRUNCATION
);
2772 it
->truncation_pixel_width
= it
->pixel_width
;
2776 /* We will need the continuation glyph. */
2777 eassert (it
->glyph_row
== NULL
);
2778 produce_special_glyphs (it
, IT_CONTINUATION
);
2779 it
->continuation_pixel_width
= it
->pixel_width
;
2783 /* Reset these values to zero because the produce_special_glyphs
2784 above has changed them. */
2785 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2786 it
->phys_ascent
= it
->phys_descent
= 0;
2788 /* Set this after getting the dimensions of truncation and
2789 continuation glyphs, so that we don't produce glyphs when calling
2790 produce_special_glyphs, above. */
2791 it
->glyph_row
= row
;
2792 it
->area
= TEXT_AREA
;
2794 /* Forget any previous info about this row being reversed. */
2796 it
->glyph_row
->reversed_p
= 0;
2798 /* Get the dimensions of the display area. The display area
2799 consists of the visible window area plus a horizontally scrolled
2800 part to the left of the window. All x-values are relative to the
2801 start of this total display area. */
2802 if (base_face_id
!= DEFAULT_FACE_ID
)
2804 /* Mode lines, menu bar in terminal frames. */
2805 it
->first_visible_x
= 0;
2806 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2810 it
->first_visible_x
=
2811 window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2812 it
->last_visible_x
= (it
->first_visible_x
2813 + window_box_width (w
, TEXT_AREA
));
2815 /* If we truncate lines, leave room for the truncation glyph(s) at
2816 the right margin. Otherwise, leave room for the continuation
2817 glyph(s). Done only if the window has no fringes. Since we
2818 don't know at this point whether there will be any R2L lines in
2819 the window, we reserve space for truncation/continuation glyphs
2820 even if only one of the fringes is absent. */
2821 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
2822 || (it
->bidi_p
&& WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
2824 if (it
->line_wrap
== TRUNCATE
)
2825 it
->last_visible_x
-= it
->truncation_pixel_width
;
2827 it
->last_visible_x
-= it
->continuation_pixel_width
;
2830 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2831 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2834 /* Leave room for a border glyph. */
2835 if (!FRAME_WINDOW_P (it
->f
)
2836 && !WINDOW_RIGHTMOST_P (it
->w
))
2837 it
->last_visible_x
-= 1;
2839 it
->last_visible_y
= window_text_bottom_y (w
);
2841 /* For mode lines and alike, arrange for the first glyph having a
2842 left box line if the face specifies a box. */
2843 if (base_face_id
!= DEFAULT_FACE_ID
)
2847 it
->face_id
= remapped_base_face_id
;
2849 /* If we have a boxed mode line, make the first character appear
2850 with a left box line. */
2851 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2852 if (face
->box
!= FACE_NO_BOX
)
2853 it
->start_of_box_run_p
= 1;
2856 /* If a buffer position was specified, set the iterator there,
2857 getting overlays and face properties from that position. */
2858 if (charpos
>= BUF_BEG (current_buffer
))
2860 it
->end_charpos
= ZV
;
2861 IT_CHARPOS (*it
) = charpos
;
2863 /* We will rely on `reseat' to set this up properly, via
2864 handle_face_prop. */
2865 it
->face_id
= it
->base_face_id
;
2867 /* Compute byte position if not specified. */
2868 if (bytepos
< charpos
)
2869 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2871 IT_BYTEPOS (*it
) = bytepos
;
2873 it
->start
= it
->current
;
2874 /* Do we need to reorder bidirectional text? Not if this is a
2875 unibyte buffer: by definition, none of the single-byte
2876 characters are strong R2L, so no reordering is needed. And
2877 bidi.c doesn't support unibyte buffers anyway. Also, don't
2878 reorder while we are loading loadup.el, since the tables of
2879 character properties needed for reordering are not yet
2883 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2886 /* If we are to reorder bidirectional text, init the bidi
2890 /* Note the paragraph direction that this buffer wants to
2892 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2894 it
->paragraph_embedding
= L2R
;
2895 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2897 it
->paragraph_embedding
= R2L
;
2899 it
->paragraph_embedding
= NEUTRAL_DIR
;
2900 bidi_unshelve_cache (NULL
, 0);
2901 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2905 /* Compute faces etc. */
2906 reseat (it
, it
->current
.pos
, 1);
2913 /* Initialize IT for the display of window W with window start POS. */
2916 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2918 struct glyph_row
*row
;
2919 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2921 row
= w
->desired_matrix
->rows
+ first_vpos
;
2922 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2923 it
->first_vpos
= first_vpos
;
2925 /* Don't reseat to previous visible line start if current start
2926 position is in a string or image. */
2927 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2929 int start_at_line_beg_p
;
2930 int first_y
= it
->current_y
;
2932 /* If window start is not at a line start, skip forward to POS to
2933 get the correct continuation lines width. */
2934 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2935 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2936 if (!start_at_line_beg_p
)
2940 reseat_at_previous_visible_line_start (it
);
2941 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2943 new_x
= it
->current_x
+ it
->pixel_width
;
2945 /* If lines are continued, this line may end in the middle
2946 of a multi-glyph character (e.g. a control character
2947 displayed as \003, or in the middle of an overlay
2948 string). In this case move_it_to above will not have
2949 taken us to the start of the continuation line but to the
2950 end of the continued line. */
2951 if (it
->current_x
> 0
2952 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2953 && (/* And glyph doesn't fit on the line. */
2954 new_x
> it
->last_visible_x
2955 /* Or it fits exactly and we're on a window
2957 || (new_x
== it
->last_visible_x
2958 && FRAME_WINDOW_P (it
->f
)
2959 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
2960 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
2961 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
2963 if ((it
->current
.dpvec_index
>= 0
2964 || it
->current
.overlay_string_index
>= 0)
2965 /* If we are on a newline from a display vector or
2966 overlay string, then we are already at the end of
2967 a screen line; no need to go to the next line in
2968 that case, as this line is not really continued.
2969 (If we do go to the next line, C-e will not DTRT.) */
2972 set_iterator_to_next (it
, 1);
2973 move_it_in_display_line_to (it
, -1, -1, 0);
2976 it
->continuation_lines_width
+= it
->current_x
;
2978 /* If the character at POS is displayed via a display
2979 vector, move_it_to above stops at the final glyph of
2980 IT->dpvec. To make the caller redisplay that character
2981 again (a.k.a. start at POS), we need to reset the
2982 dpvec_index to the beginning of IT->dpvec. */
2983 else if (it
->current
.dpvec_index
>= 0)
2984 it
->current
.dpvec_index
= 0;
2986 /* We're starting a new display line, not affected by the
2987 height of the continued line, so clear the appropriate
2988 fields in the iterator structure. */
2989 it
->max_ascent
= it
->max_descent
= 0;
2990 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2992 it
->current_y
= first_y
;
2994 it
->current_x
= it
->hpos
= 0;
3000 /* Return 1 if POS is a position in ellipses displayed for invisible
3001 text. W is the window we display, for text property lookup. */
3004 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3006 Lisp_Object prop
, window
;
3008 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3010 /* If POS specifies a position in a display vector, this might
3011 be for an ellipsis displayed for invisible text. We won't
3012 get the iterator set up for delivering that ellipsis unless
3013 we make sure that it gets aware of the invisible text. */
3014 if (pos
->dpvec_index
>= 0
3015 && pos
->overlay_string_index
< 0
3016 && CHARPOS (pos
->string_pos
) < 0
3018 && (XSETWINDOW (window
, w
),
3019 prop
= Fget_char_property (make_number (charpos
),
3020 Qinvisible
, window
),
3021 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
3023 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3025 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3032 /* Initialize IT for stepping through current_buffer in window W,
3033 starting at position POS that includes overlay string and display
3034 vector/ control character translation position information. Value
3035 is zero if there are overlay strings with newlines at POS. */
3038 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3040 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3041 int i
, overlay_strings_with_newlines
= 0;
3043 /* If POS specifies a position in a display vector, this might
3044 be for an ellipsis displayed for invisible text. We won't
3045 get the iterator set up for delivering that ellipsis unless
3046 we make sure that it gets aware of the invisible text. */
3047 if (in_ellipses_for_invisible_text_p (pos
, w
))
3053 /* Keep in mind: the call to reseat in init_iterator skips invisible
3054 text, so we might end up at a position different from POS. This
3055 is only a problem when POS is a row start after a newline and an
3056 overlay starts there with an after-string, and the overlay has an
3057 invisible property. Since we don't skip invisible text in
3058 display_line and elsewhere immediately after consuming the
3059 newline before the row start, such a POS will not be in a string,
3060 but the call to init_iterator below will move us to the
3062 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3064 /* This only scans the current chunk -- it should scan all chunks.
3065 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3066 to 16 in 22.1 to make this a lesser problem. */
3067 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3069 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3070 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3072 while (s
< e
&& *s
!= '\n')
3077 overlay_strings_with_newlines
= 1;
3082 /* If position is within an overlay string, set up IT to the right
3084 if (pos
->overlay_string_index
>= 0)
3088 /* If the first overlay string happens to have a `display'
3089 property for an image, the iterator will be set up for that
3090 image, and we have to undo that setup first before we can
3091 correct the overlay string index. */
3092 if (it
->method
== GET_FROM_IMAGE
)
3095 /* We already have the first chunk of overlay strings in
3096 IT->overlay_strings. Load more until the one for
3097 pos->overlay_string_index is in IT->overlay_strings. */
3098 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3100 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3101 it
->current
.overlay_string_index
= 0;
3104 load_overlay_strings (it
, 0);
3105 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3109 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3110 relative_index
= (it
->current
.overlay_string_index
3111 % OVERLAY_STRING_CHUNK_SIZE
);
3112 it
->string
= it
->overlay_strings
[relative_index
];
3113 eassert (STRINGP (it
->string
));
3114 it
->current
.string_pos
= pos
->string_pos
;
3115 it
->method
= GET_FROM_STRING
;
3118 if (CHARPOS (pos
->string_pos
) >= 0)
3120 /* Recorded position is not in an overlay string, but in another
3121 string. This can only be a string from a `display' property.
3122 IT should already be filled with that string. */
3123 it
->current
.string_pos
= pos
->string_pos
;
3124 eassert (STRINGP (it
->string
));
3127 /* Restore position in display vector translations, control
3128 character translations or ellipses. */
3129 if (pos
->dpvec_index
>= 0)
3131 if (it
->dpvec
== NULL
)
3132 get_next_display_element (it
);
3133 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3134 it
->current
.dpvec_index
= pos
->dpvec_index
;
3138 return !overlay_strings_with_newlines
;
3142 /* Initialize IT for stepping through current_buffer in window W
3143 starting at ROW->start. */
3146 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3148 init_from_display_pos (it
, w
, &row
->start
);
3149 it
->start
= row
->start
;
3150 it
->continuation_lines_width
= row
->continuation_lines_width
;
3155 /* Initialize IT for stepping through current_buffer in window W
3156 starting in the line following ROW, i.e. starting at ROW->end.
3157 Value is zero if there are overlay strings with newlines at ROW's
3161 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3165 if (init_from_display_pos (it
, w
, &row
->end
))
3167 if (row
->continued_p
)
3168 it
->continuation_lines_width
3169 = row
->continuation_lines_width
+ row
->pixel_width
;
3180 /***********************************************************************
3182 ***********************************************************************/
3184 /* Called when IT reaches IT->stop_charpos. Handle text property and
3185 overlay changes. Set IT->stop_charpos to the next position where
3189 handle_stop (struct it
*it
)
3191 enum prop_handled handled
;
3192 int handle_overlay_change_p
;
3196 it
->current
.dpvec_index
= -1;
3197 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3198 it
->ignore_overlay_strings_at_pos_p
= 0;
3201 /* Use face of preceding text for ellipsis (if invisible) */
3202 if (it
->selective_display_ellipsis_p
)
3203 it
->saved_face_id
= it
->face_id
;
3207 handled
= HANDLED_NORMALLY
;
3209 /* Call text property handlers. */
3210 for (p
= it_props
; p
->handler
; ++p
)
3212 handled
= p
->handler (it
);
3214 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3216 else if (handled
== HANDLED_RETURN
)
3218 /* We still want to show before and after strings from
3219 overlays even if the actual buffer text is replaced. */
3220 if (!handle_overlay_change_p
3222 /* Don't call get_overlay_strings_1 if we already
3223 have overlay strings loaded, because doing so
3224 will load them again and push the iterator state
3225 onto the stack one more time, which is not
3226 expected by the rest of the code that processes
3228 || (it
->current
.overlay_string_index
< 0
3229 ? !get_overlay_strings_1 (it
, 0, 0)
3233 setup_for_ellipsis (it
, 0);
3234 /* When handling a display spec, we might load an
3235 empty string. In that case, discard it here. We
3236 used to discard it in handle_single_display_spec,
3237 but that causes get_overlay_strings_1, above, to
3238 ignore overlay strings that we must check. */
3239 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3243 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3247 it
->ignore_overlay_strings_at_pos_p
= 1;
3248 it
->string_from_display_prop_p
= 0;
3249 it
->from_disp_prop_p
= 0;
3250 handle_overlay_change_p
= 0;
3252 handled
= HANDLED_RECOMPUTE_PROPS
;
3255 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3256 handle_overlay_change_p
= 0;
3259 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3261 /* Don't check for overlay strings below when set to deliver
3262 characters from a display vector. */
3263 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3264 handle_overlay_change_p
= 0;
3266 /* Handle overlay changes.
3267 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3268 if it finds overlays. */
3269 if (handle_overlay_change_p
)
3270 handled
= handle_overlay_change (it
);
3275 setup_for_ellipsis (it
, 0);
3279 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3281 /* Determine where to stop next. */
3282 if (handled
== HANDLED_NORMALLY
)
3283 compute_stop_pos (it
);
3287 /* Compute IT->stop_charpos from text property and overlay change
3288 information for IT's current position. */
3291 compute_stop_pos (struct it
*it
)
3293 register INTERVAL iv
, next_iv
;
3294 Lisp_Object object
, limit
, position
;
3295 ptrdiff_t charpos
, bytepos
;
3297 if (STRINGP (it
->string
))
3299 /* Strings are usually short, so don't limit the search for
3301 it
->stop_charpos
= it
->end_charpos
;
3302 object
= it
->string
;
3304 charpos
= IT_STRING_CHARPOS (*it
);
3305 bytepos
= IT_STRING_BYTEPOS (*it
);
3311 /* If end_charpos is out of range for some reason, such as a
3312 misbehaving display function, rationalize it (Bug#5984). */
3313 if (it
->end_charpos
> ZV
)
3314 it
->end_charpos
= ZV
;
3315 it
->stop_charpos
= it
->end_charpos
;
3317 /* If next overlay change is in front of the current stop pos
3318 (which is IT->end_charpos), stop there. Note: value of
3319 next_overlay_change is point-max if no overlay change
3321 charpos
= IT_CHARPOS (*it
);
3322 bytepos
= IT_BYTEPOS (*it
);
3323 pos
= next_overlay_change (charpos
);
3324 if (pos
< it
->stop_charpos
)
3325 it
->stop_charpos
= pos
;
3327 /* If showing the region, we have to stop at the region
3328 start or end because the face might change there. */
3329 if (it
->region_beg_charpos
> 0)
3331 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3332 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3333 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3334 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3337 /* Set up variables for computing the stop position from text
3338 property changes. */
3339 XSETBUFFER (object
, current_buffer
);
3340 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3343 /* Get the interval containing IT's position. Value is a null
3344 interval if there isn't such an interval. */
3345 position
= make_number (charpos
);
3346 iv
= validate_interval_range (object
, &position
, &position
, 0);
3349 Lisp_Object values_here
[LAST_PROP_IDX
];
3352 /* Get properties here. */
3353 for (p
= it_props
; p
->handler
; ++p
)
3354 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3356 /* Look for an interval following iv that has different
3358 for (next_iv
= next_interval (iv
);
3361 || XFASTINT (limit
) > next_iv
->position
));
3362 next_iv
= next_interval (next_iv
))
3364 for (p
= it_props
; p
->handler
; ++p
)
3366 Lisp_Object new_value
;
3368 new_value
= textget (next_iv
->plist
, *p
->name
);
3369 if (!EQ (values_here
[p
->idx
], new_value
))
3379 if (INTEGERP (limit
)
3380 && next_iv
->position
>= XFASTINT (limit
))
3381 /* No text property change up to limit. */
3382 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3384 /* Text properties change in next_iv. */
3385 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3389 if (it
->cmp_it
.id
< 0)
3391 ptrdiff_t stoppos
= it
->end_charpos
;
3393 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3395 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3396 stoppos
, it
->string
);
3399 eassert (STRINGP (it
->string
)
3400 || (it
->stop_charpos
>= BEGV
3401 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3405 /* Return the position of the next overlay change after POS in
3406 current_buffer. Value is point-max if no overlay change
3407 follows. This is like `next-overlay-change' but doesn't use
3411 next_overlay_change (ptrdiff_t pos
)
3413 ptrdiff_t i
, noverlays
;
3415 Lisp_Object
*overlays
;
3417 /* Get all overlays at the given position. */
3418 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3420 /* If any of these overlays ends before endpos,
3421 use its ending point instead. */
3422 for (i
= 0; i
< noverlays
; ++i
)
3427 oend
= OVERLAY_END (overlays
[i
]);
3428 oendpos
= OVERLAY_POSITION (oend
);
3429 endpos
= min (endpos
, oendpos
);
3435 /* How many characters forward to search for a display property or
3436 display string. Searching too far forward makes the bidi display
3437 sluggish, especially in small windows. */
3438 #define MAX_DISP_SCAN 250
3440 /* Return the character position of a display string at or after
3441 position specified by POSITION. If no display string exists at or
3442 after POSITION, return ZV. A display string is either an overlay
3443 with `display' property whose value is a string, or a `display'
3444 text property whose value is a string. STRING is data about the
3445 string to iterate; if STRING->lstring is nil, we are iterating a
3446 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3447 on a GUI frame. DISP_PROP is set to zero if we searched
3448 MAX_DISP_SCAN characters forward without finding any display
3449 strings, non-zero otherwise. It is set to 2 if the display string
3450 uses any kind of `(space ...)' spec that will produce a stretch of
3451 white space in the text area. */
3453 compute_display_string_pos (struct text_pos
*position
,
3454 struct bidi_string_data
*string
,
3455 int frame_window_p
, int *disp_prop
)
3457 /* OBJECT = nil means current buffer. */
3458 Lisp_Object object
=
3459 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3460 Lisp_Object pos
, spec
, limpos
;
3461 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3462 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3463 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3464 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3466 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3467 struct text_pos tpos
;
3473 /* We don't support display properties whose values are strings
3474 that have display string properties. */
3475 || string
->from_disp_str
3476 /* C strings cannot have display properties. */
3477 || (string
->s
&& !STRINGP (object
)))
3483 /* If the character at CHARPOS is where the display string begins,
3485 pos
= make_number (charpos
);
3486 if (STRINGP (object
))
3487 bufpos
= string
->bufpos
;
3491 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3493 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3496 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3504 /* Look forward for the first character with a `display' property
3505 that will replace the underlying text when displayed. */
3506 limpos
= make_number (lim
);
3508 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3509 CHARPOS (tpos
) = XFASTINT (pos
);
3510 if (CHARPOS (tpos
) >= lim
)
3515 if (STRINGP (object
))
3516 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3518 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3519 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3520 if (!STRINGP (object
))
3521 bufpos
= CHARPOS (tpos
);
3522 } while (NILP (spec
)
3523 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3524 bufpos
, frame_window_p
)));
3528 return CHARPOS (tpos
);
3531 /* Return the character position of the end of the display string that
3532 started at CHARPOS. If there's no display string at CHARPOS,
3533 return -1. A display string is either an overlay with `display'
3534 property whose value is a string or a `display' text property whose
3535 value is a string. */
3537 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3539 /* OBJECT = nil means current buffer. */
3540 Lisp_Object object
=
3541 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3542 Lisp_Object pos
= make_number (charpos
);
3544 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3546 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3549 /* It could happen that the display property or overlay was removed
3550 since we found it in compute_display_string_pos above. One way
3551 this can happen is if JIT font-lock was called (through
3552 handle_fontified_prop), and jit-lock-functions remove text
3553 properties or overlays from the portion of buffer that includes
3554 CHARPOS. Muse mode is known to do that, for example. In this
3555 case, we return -1 to the caller, to signal that no display
3556 string is actually present at CHARPOS. See bidi_fetch_char for
3557 how this is handled.
3559 An alternative would be to never look for display properties past
3560 it->stop_charpos. But neither compute_display_string_pos nor
3561 bidi_fetch_char that calls it know or care where the next
3563 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3566 /* Look forward for the first character where the `display' property
3568 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3570 return XFASTINT (pos
);
3575 /***********************************************************************
3577 ***********************************************************************/
3579 /* Handle changes in the `fontified' property of the current buffer by
3580 calling hook functions from Qfontification_functions to fontify
3583 static enum prop_handled
3584 handle_fontified_prop (struct it
*it
)
3586 Lisp_Object prop
, pos
;
3587 enum prop_handled handled
= HANDLED_NORMALLY
;
3589 if (!NILP (Vmemory_full
))
3592 /* Get the value of the `fontified' property at IT's current buffer
3593 position. (The `fontified' property doesn't have a special
3594 meaning in strings.) If the value is nil, call functions from
3595 Qfontification_functions. */
3596 if (!STRINGP (it
->string
)
3598 && !NILP (Vfontification_functions
)
3599 && !NILP (Vrun_hooks
)
3600 && (pos
= make_number (IT_CHARPOS (*it
)),
3601 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3602 /* Ignore the special cased nil value always present at EOB since
3603 no amount of fontifying will be able to change it. */
3604 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3606 ptrdiff_t count
= SPECPDL_INDEX ();
3608 struct buffer
*obuf
= current_buffer
;
3609 int begv
= BEGV
, zv
= ZV
;
3610 int old_clip_changed
= current_buffer
->clip_changed
;
3612 val
= Vfontification_functions
;
3613 specbind (Qfontification_functions
, Qnil
);
3615 eassert (it
->end_charpos
== ZV
);
3617 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3618 safe_call1 (val
, pos
);
3621 Lisp_Object fns
, fn
;
3622 struct gcpro gcpro1
, gcpro2
;
3627 for (; CONSP (val
); val
= XCDR (val
))
3633 /* A value of t indicates this hook has a local
3634 binding; it means to run the global binding too.
3635 In a global value, t should not occur. If it
3636 does, we must ignore it to avoid an endless
3638 for (fns
= Fdefault_value (Qfontification_functions
);
3644 safe_call1 (fn
, pos
);
3648 safe_call1 (fn
, pos
);
3654 unbind_to (count
, Qnil
);
3656 /* Fontification functions routinely call `save-restriction'.
3657 Normally, this tags clip_changed, which can confuse redisplay
3658 (see discussion in Bug#6671). Since we don't perform any
3659 special handling of fontification changes in the case where
3660 `save-restriction' isn't called, there's no point doing so in
3661 this case either. So, if the buffer's restrictions are
3662 actually left unchanged, reset clip_changed. */
3663 if (obuf
== current_buffer
)
3665 if (begv
== BEGV
&& zv
== ZV
)
3666 current_buffer
->clip_changed
= old_clip_changed
;
3668 /* There isn't much we can reasonably do to protect against
3669 misbehaving fontification, but here's a fig leaf. */
3670 else if (BUFFER_LIVE_P (obuf
))
3671 set_buffer_internal_1 (obuf
);
3673 /* The fontification code may have added/removed text.
3674 It could do even a lot worse, but let's at least protect against
3675 the most obvious case where only the text past `pos' gets changed',
3676 as is/was done in grep.el where some escapes sequences are turned
3677 into face properties (bug#7876). */
3678 it
->end_charpos
= ZV
;
3680 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3681 something. This avoids an endless loop if they failed to
3682 fontify the text for which reason ever. */
3683 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3684 handled
= HANDLED_RECOMPUTE_PROPS
;
3692 /***********************************************************************
3694 ***********************************************************************/
3696 /* Set up iterator IT from face properties at its current position.
3697 Called from handle_stop. */
3699 static enum prop_handled
3700 handle_face_prop (struct it
*it
)
3703 ptrdiff_t next_stop
;
3705 if (!STRINGP (it
->string
))
3708 = face_at_buffer_position (it
->w
,
3710 it
->region_beg_charpos
,
3711 it
->region_end_charpos
,
3714 + TEXT_PROP_DISTANCE_LIMIT
),
3715 0, it
->base_face_id
);
3717 /* Is this a start of a run of characters with box face?
3718 Caveat: this can be called for a freshly initialized
3719 iterator; face_id is -1 in this case. We know that the new
3720 face will not change until limit, i.e. if the new face has a
3721 box, all characters up to limit will have one. But, as
3722 usual, we don't know whether limit is really the end. */
3723 if (new_face_id
!= it
->face_id
)
3725 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3727 /* If new face has a box but old face has not, this is
3728 the start of a run of characters with box, i.e. it has
3729 a shadow on the left side. The value of face_id of the
3730 iterator will be -1 if this is the initial call that gets
3731 the face. In this case, we have to look in front of IT's
3732 position and see whether there is a face != new_face_id. */
3733 it
->start_of_box_run_p
3734 = (new_face
->box
!= FACE_NO_BOX
3735 && (it
->face_id
>= 0
3736 || IT_CHARPOS (*it
) == BEG
3737 || new_face_id
!= face_before_it_pos (it
)));
3738 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3746 Lisp_Object from_overlay
3747 = (it
->current
.overlay_string_index
>= 0
3748 ? it
->string_overlays
[it
->current
.overlay_string_index
3749 % OVERLAY_STRING_CHUNK_SIZE
]
3752 /* See if we got to this string directly or indirectly from
3753 an overlay property. That includes the before-string or
3754 after-string of an overlay, strings in display properties
3755 provided by an overlay, their text properties, etc.
3757 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3758 if (! NILP (from_overlay
))
3759 for (i
= it
->sp
- 1; i
>= 0; i
--)
3761 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3763 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3764 % OVERLAY_STRING_CHUNK_SIZE
];
3765 else if (! NILP (it
->stack
[i
].from_overlay
))
3766 from_overlay
= it
->stack
[i
].from_overlay
;
3768 if (!NILP (from_overlay
))
3772 if (! NILP (from_overlay
))
3774 bufpos
= IT_CHARPOS (*it
);
3775 /* For a string from an overlay, the base face depends
3776 only on text properties and ignores overlays. */
3778 = face_for_overlay_string (it
->w
,
3780 it
->region_beg_charpos
,
3781 it
->region_end_charpos
,
3784 + TEXT_PROP_DISTANCE_LIMIT
),
3792 /* For strings from a `display' property, use the face at
3793 IT's current buffer position as the base face to merge
3794 with, so that overlay strings appear in the same face as
3795 surrounding text, unless they specify their own
3797 base_face_id
= it
->string_from_prefix_prop_p
3799 : underlying_face_id (it
);
3802 new_face_id
= face_at_string_position (it
->w
,
3804 IT_STRING_CHARPOS (*it
),
3806 it
->region_beg_charpos
,
3807 it
->region_end_charpos
,
3811 /* Is this a start of a run of characters with box? Caveat:
3812 this can be called for a freshly allocated iterator; face_id
3813 is -1 is this case. We know that the new face will not
3814 change until the next check pos, i.e. if the new face has a
3815 box, all characters up to that position will have a
3816 box. But, as usual, we don't know whether that position
3817 is really the end. */
3818 if (new_face_id
!= it
->face_id
)
3820 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3821 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3823 /* If new face has a box but old face hasn't, this is the
3824 start of a run of characters with box, i.e. it has a
3825 shadow on the left side. */
3826 it
->start_of_box_run_p
3827 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3828 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3832 it
->face_id
= new_face_id
;
3833 return HANDLED_NORMALLY
;
3837 /* Return the ID of the face ``underlying'' IT's current position,
3838 which is in a string. If the iterator is associated with a
3839 buffer, return the face at IT's current buffer position.
3840 Otherwise, use the iterator's base_face_id. */
3843 underlying_face_id (struct it
*it
)
3845 int face_id
= it
->base_face_id
, i
;
3847 eassert (STRINGP (it
->string
));
3849 for (i
= it
->sp
- 1; i
>= 0; --i
)
3850 if (NILP (it
->stack
[i
].string
))
3851 face_id
= it
->stack
[i
].face_id
;
3857 /* Compute the face one character before or after the current position
3858 of IT, in the visual order. BEFORE_P non-zero means get the face
3859 in front (to the left in L2R paragraphs, to the right in R2L
3860 paragraphs) of IT's screen position. Value is the ID of the face. */
3863 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3866 ptrdiff_t next_check_charpos
;
3868 void *it_copy_data
= NULL
;
3870 eassert (it
->s
== NULL
);
3872 if (STRINGP (it
->string
))
3874 ptrdiff_t bufpos
, charpos
;
3877 /* No face change past the end of the string (for the case
3878 we are padding with spaces). No face change before the
3880 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3881 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3886 /* Set charpos to the position before or after IT's current
3887 position, in the logical order, which in the non-bidi
3888 case is the same as the visual order. */
3890 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3891 else if (it
->what
== IT_COMPOSITION
)
3892 /* For composition, we must check the character after the
3894 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3896 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3902 /* With bidi iteration, the character before the current
3903 in the visual order cannot be found by simple
3904 iteration, because "reverse" reordering is not
3905 supported. Instead, we need to use the move_it_*
3906 family of functions. */
3907 /* Ignore face changes before the first visible
3908 character on this display line. */
3909 if (it
->current_x
<= it
->first_visible_x
)
3911 SAVE_IT (it_copy
, *it
, it_copy_data
);
3912 /* Implementation note: Since move_it_in_display_line
3913 works in the iterator geometry, and thinks the first
3914 character is always the leftmost, even in R2L lines,
3915 we don't need to distinguish between the R2L and L2R
3917 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3918 it_copy
.current_x
- 1, MOVE_TO_X
);
3919 charpos
= IT_STRING_CHARPOS (it_copy
);
3920 RESTORE_IT (it
, it
, it_copy_data
);
3924 /* Set charpos to the string position of the character
3925 that comes after IT's current position in the visual
3927 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3931 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3933 charpos
= it_copy
.bidi_it
.charpos
;
3936 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3938 if (it
->current
.overlay_string_index
>= 0)
3939 bufpos
= IT_CHARPOS (*it
);
3943 base_face_id
= underlying_face_id (it
);
3945 /* Get the face for ASCII, or unibyte. */
3946 face_id
= face_at_string_position (it
->w
,
3950 it
->region_beg_charpos
,
3951 it
->region_end_charpos
,
3952 &next_check_charpos
,
3955 /* Correct the face for charsets different from ASCII. Do it
3956 for the multibyte case only. The face returned above is
3957 suitable for unibyte text if IT->string is unibyte. */
3958 if (STRING_MULTIBYTE (it
->string
))
3960 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3961 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3963 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3965 c
= string_char_and_length (p
, &len
);
3966 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3971 struct text_pos pos
;
3973 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3974 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3977 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3978 pos
= it
->current
.pos
;
3983 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3986 if (it
->what
== IT_COMPOSITION
)
3988 /* For composition, we must check the position after
3990 pos
.charpos
+= it
->cmp_it
.nchars
;
3991 pos
.bytepos
+= it
->len
;
3994 INC_TEXT_POS (pos
, it
->multibyte_p
);
4001 /* With bidi iteration, the character before the current
4002 in the visual order cannot be found by simple
4003 iteration, because "reverse" reordering is not
4004 supported. Instead, we need to use the move_it_*
4005 family of functions. */
4006 /* Ignore face changes before the first visible
4007 character on this display line. */
4008 if (it
->current_x
<= it
->first_visible_x
)
4010 SAVE_IT (it_copy
, *it
, it_copy_data
);
4011 /* Implementation note: Since move_it_in_display_line
4012 works in the iterator geometry, and thinks the first
4013 character is always the leftmost, even in R2L lines,
4014 we don't need to distinguish between the R2L and L2R
4016 move_it_in_display_line (&it_copy
, ZV
,
4017 it_copy
.current_x
- 1, MOVE_TO_X
);
4018 pos
= it_copy
.current
.pos
;
4019 RESTORE_IT (it
, it
, it_copy_data
);
4023 /* Set charpos to the buffer position of the character
4024 that comes after IT's current position in the visual
4026 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4030 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4033 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4036 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4038 /* Determine face for CHARSET_ASCII, or unibyte. */
4039 face_id
= face_at_buffer_position (it
->w
,
4041 it
->region_beg_charpos
,
4042 it
->region_end_charpos
,
4043 &next_check_charpos
,
4046 /* Correct the face for charsets different from ASCII. Do it
4047 for the multibyte case only. The face returned above is
4048 suitable for unibyte text if current_buffer is unibyte. */
4049 if (it
->multibyte_p
)
4051 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4052 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4053 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4062 /***********************************************************************
4064 ***********************************************************************/
4066 /* Set up iterator IT from invisible properties at its current
4067 position. Called from handle_stop. */
4069 static enum prop_handled
4070 handle_invisible_prop (struct it
*it
)
4072 enum prop_handled handled
= HANDLED_NORMALLY
;
4076 if (STRINGP (it
->string
))
4078 Lisp_Object end_charpos
, limit
, charpos
;
4080 /* Get the value of the invisible text property at the
4081 current position. Value will be nil if there is no such
4083 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4084 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4085 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4087 if (invis_p
&& IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4089 /* Record whether we have to display an ellipsis for the
4091 int display_ellipsis_p
= (invis_p
== 2);
4092 ptrdiff_t len
, endpos
;
4094 handled
= HANDLED_RECOMPUTE_PROPS
;
4096 /* Get the position at which the next visible text can be
4097 found in IT->string, if any. */
4098 endpos
= len
= SCHARS (it
->string
);
4099 XSETINT (limit
, len
);
4102 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4104 if (INTEGERP (end_charpos
))
4106 endpos
= XFASTINT (end_charpos
);
4107 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4108 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4110 display_ellipsis_p
= 1;
4113 while (invis_p
&& endpos
< len
);
4115 if (display_ellipsis_p
)
4120 /* Text at END_CHARPOS is visible. Move IT there. */
4121 struct text_pos old
;
4124 old
= it
->current
.string_pos
;
4125 oldpos
= CHARPOS (old
);
4128 if (it
->bidi_it
.first_elt
4129 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4130 bidi_paragraph_init (it
->paragraph_embedding
,
4132 /* Bidi-iterate out of the invisible text. */
4135 bidi_move_to_visually_next (&it
->bidi_it
);
4137 while (oldpos
<= it
->bidi_it
.charpos
4138 && it
->bidi_it
.charpos
< endpos
);
4140 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4141 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4142 if (IT_CHARPOS (*it
) >= endpos
)
4143 it
->prev_stop
= endpos
;
4147 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4148 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4153 /* The rest of the string is invisible. If this is an
4154 overlay string, proceed with the next overlay string
4155 or whatever comes and return a character from there. */
4156 if (it
->current
.overlay_string_index
>= 0
4157 && !display_ellipsis_p
)
4159 next_overlay_string (it
);
4160 /* Don't check for overlay strings when we just
4161 finished processing them. */
4162 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4166 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4167 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4174 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4175 Lisp_Object pos
, overlay
;
4177 /* First of all, is there invisible text at this position? */
4178 tem
= start_charpos
= IT_CHARPOS (*it
);
4179 pos
= make_number (tem
);
4180 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4182 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4184 /* If we are on invisible text, skip over it. */
4185 if (invis_p
&& start_charpos
< it
->end_charpos
)
4187 /* Record whether we have to display an ellipsis for the
4189 int display_ellipsis_p
= invis_p
== 2;
4191 handled
= HANDLED_RECOMPUTE_PROPS
;
4193 /* Loop skipping over invisible text. The loop is left at
4194 ZV or with IT on the first char being visible again. */
4197 /* Try to skip some invisible text. Return value is the
4198 position reached which can be equal to where we start
4199 if there is nothing invisible there. This skips both
4200 over invisible text properties and overlays with
4201 invisible property. */
4202 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4204 /* If we skipped nothing at all we weren't at invisible
4205 text in the first place. If everything to the end of
4206 the buffer was skipped, end the loop. */
4207 if (newpos
== tem
|| newpos
>= ZV
)
4211 /* We skipped some characters but not necessarily
4212 all there are. Check if we ended up on visible
4213 text. Fget_char_property returns the property of
4214 the char before the given position, i.e. if we
4215 get invis_p = 0, this means that the char at
4216 newpos is visible. */
4217 pos
= make_number (newpos
);
4218 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4219 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4222 /* If we ended up on invisible text, proceed to
4223 skip starting with next_stop. */
4227 /* If there are adjacent invisible texts, don't lose the
4228 second one's ellipsis. */
4230 display_ellipsis_p
= 1;
4234 /* The position newpos is now either ZV or on visible text. */
4237 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4239 bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4241 newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4243 /* If the invisible text ends on a newline or on a
4244 character after a newline, we can avoid the costly,
4245 character by character, bidi iteration to NEWPOS, and
4246 instead simply reseat the iterator there. That's
4247 because all bidi reordering information is tossed at
4248 the newline. This is a big win for modes that hide
4249 complete lines, like Outline, Org, etc. */
4250 if (on_newline
|| after_newline
)
4252 struct text_pos tpos
;
4253 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4255 SET_TEXT_POS (tpos
, newpos
, bpos
);
4256 reseat_1 (it
, tpos
, 0);
4257 /* If we reseat on a newline/ZV, we need to prep the
4258 bidi iterator for advancing to the next character
4259 after the newline/EOB, keeping the current paragraph
4260 direction (so that PRODUCE_GLYPHS does TRT wrt
4261 prepending/appending glyphs to a glyph row). */
4264 it
->bidi_it
.first_elt
= 0;
4265 it
->bidi_it
.paragraph_dir
= pdir
;
4266 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4267 it
->bidi_it
.nchars
= 1;
4268 it
->bidi_it
.ch_len
= 1;
4271 else /* Must use the slow method. */
4273 /* With bidi iteration, the region of invisible text
4274 could start and/or end in the middle of a
4275 non-base embedding level. Therefore, we need to
4276 skip invisible text using the bidi iterator,
4277 starting at IT's current position, until we find
4278 ourselves outside of the invisible text.
4279 Skipping invisible text _after_ bidi iteration
4280 avoids affecting the visual order of the
4281 displayed text when invisible properties are
4282 added or removed. */
4283 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4285 /* If we were `reseat'ed to a new paragraph,
4286 determine the paragraph base direction. We
4287 need to do it now because
4288 next_element_from_buffer may not have a
4289 chance to do it, if we are going to skip any
4290 text at the beginning, which resets the
4292 bidi_paragraph_init (it
->paragraph_embedding
,
4297 bidi_move_to_visually_next (&it
->bidi_it
);
4299 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4300 && it
->bidi_it
.charpos
< newpos
);
4301 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4302 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4303 /* If we overstepped NEWPOS, record its position in
4304 the iterator, so that we skip invisible text if
4305 later the bidi iteration lands us in the
4306 invisible region again. */
4307 if (IT_CHARPOS (*it
) >= newpos
)
4308 it
->prev_stop
= newpos
;
4313 IT_CHARPOS (*it
) = newpos
;
4314 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4317 /* If there are before-strings at the start of invisible
4318 text, and the text is invisible because of a text
4319 property, arrange to show before-strings because 20.x did
4320 it that way. (If the text is invisible because of an
4321 overlay property instead of a text property, this is
4322 already handled in the overlay code.) */
4324 && get_overlay_strings (it
, it
->stop_charpos
))
4326 handled
= HANDLED_RECOMPUTE_PROPS
;
4327 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4329 else if (display_ellipsis_p
)
4331 /* Make sure that the glyphs of the ellipsis will get
4332 correct `charpos' values. If we would not update
4333 it->position here, the glyphs would belong to the
4334 last visible character _before_ the invisible
4335 text, which confuses `set_cursor_from_row'.
4337 We use the last invisible position instead of the
4338 first because this way the cursor is always drawn on
4339 the first "." of the ellipsis, whenever PT is inside
4340 the invisible text. Otherwise the cursor would be
4341 placed _after_ the ellipsis when the point is after the
4342 first invisible character. */
4343 if (!STRINGP (it
->object
))
4345 it
->position
.charpos
= newpos
- 1;
4346 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4349 /* Let the ellipsis display before
4350 considering any properties of the following char.
4351 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4352 handled
= HANDLED_RETURN
;
4361 /* Make iterator IT return `...' next.
4362 Replaces LEN characters from buffer. */
4365 setup_for_ellipsis (struct it
*it
, int len
)
4367 /* Use the display table definition for `...'. Invalid glyphs
4368 will be handled by the method returning elements from dpvec. */
4369 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4371 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4372 it
->dpvec
= v
->contents
;
4373 it
->dpend
= v
->contents
+ v
->header
.size
;
4377 /* Default `...'. */
4378 it
->dpvec
= default_invis_vector
;
4379 it
->dpend
= default_invis_vector
+ 3;
4382 it
->dpvec_char_len
= len
;
4383 it
->current
.dpvec_index
= 0;
4384 it
->dpvec_face_id
= -1;
4386 /* Remember the current face id in case glyphs specify faces.
4387 IT's face is restored in set_iterator_to_next.
4388 saved_face_id was set to preceding char's face in handle_stop. */
4389 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4390 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4392 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4398 /***********************************************************************
4400 ***********************************************************************/
4402 /* Set up iterator IT from `display' property at its current position.
4403 Called from handle_stop.
4404 We return HANDLED_RETURN if some part of the display property
4405 overrides the display of the buffer text itself.
4406 Otherwise we return HANDLED_NORMALLY. */
4408 static enum prop_handled
4409 handle_display_prop (struct it
*it
)
4411 Lisp_Object propval
, object
, overlay
;
4412 struct text_pos
*position
;
4414 /* Nonzero if some property replaces the display of the text itself. */
4415 int display_replaced_p
= 0;
4417 if (STRINGP (it
->string
))
4419 object
= it
->string
;
4420 position
= &it
->current
.string_pos
;
4421 bufpos
= CHARPOS (it
->current
.pos
);
4425 XSETWINDOW (object
, it
->w
);
4426 position
= &it
->current
.pos
;
4427 bufpos
= CHARPOS (*position
);
4430 /* Reset those iterator values set from display property values. */
4431 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4432 it
->space_width
= Qnil
;
4433 it
->font_height
= Qnil
;
4436 /* We don't support recursive `display' properties, i.e. string
4437 values that have a string `display' property, that have a string
4438 `display' property etc. */
4439 if (!it
->string_from_display_prop_p
)
4440 it
->area
= TEXT_AREA
;
4442 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4443 Qdisplay
, object
, &overlay
);
4445 return HANDLED_NORMALLY
;
4446 /* Now OVERLAY is the overlay that gave us this property, or nil
4447 if it was a text property. */
4449 if (!STRINGP (it
->string
))
4450 object
= it
->w
->buffer
;
4452 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4454 FRAME_WINDOW_P (it
->f
));
4456 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4459 /* Subroutine of handle_display_prop. Returns non-zero if the display
4460 specification in SPEC is a replacing specification, i.e. it would
4461 replace the text covered by `display' property with something else,
4462 such as an image or a display string. If SPEC includes any kind or
4463 `(space ...) specification, the value is 2; this is used by
4464 compute_display_string_pos, which see.
4466 See handle_single_display_spec for documentation of arguments.
4467 frame_window_p is non-zero if the window being redisplayed is on a
4468 GUI frame; this argument is used only if IT is NULL, see below.
4470 IT can be NULL, if this is called by the bidi reordering code
4471 through compute_display_string_pos, which see. In that case, this
4472 function only examines SPEC, but does not otherwise "handle" it, in
4473 the sense that it doesn't set up members of IT from the display
4476 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4477 Lisp_Object overlay
, struct text_pos
*position
,
4478 ptrdiff_t bufpos
, int frame_window_p
)
4480 int replacing_p
= 0;
4484 /* Simple specifications. */
4485 && !EQ (XCAR (spec
), Qimage
)
4486 && !EQ (XCAR (spec
), Qspace
)
4487 && !EQ (XCAR (spec
), Qwhen
)
4488 && !EQ (XCAR (spec
), Qslice
)
4489 && !EQ (XCAR (spec
), Qspace_width
)
4490 && !EQ (XCAR (spec
), Qheight
)
4491 && !EQ (XCAR (spec
), Qraise
)
4492 /* Marginal area specifications. */
4493 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4494 && !EQ (XCAR (spec
), Qleft_fringe
)
4495 && !EQ (XCAR (spec
), Qright_fringe
)
4496 && !NILP (XCAR (spec
)))
4498 for (; CONSP (spec
); spec
= XCDR (spec
))
4500 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4501 overlay
, position
, bufpos
,
4502 replacing_p
, frame_window_p
)))
4505 /* If some text in a string is replaced, `position' no
4506 longer points to the position of `object'. */
4507 if (!it
|| STRINGP (object
))
4512 else if (VECTORP (spec
))
4515 for (i
= 0; i
< ASIZE (spec
); ++i
)
4516 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4517 overlay
, position
, bufpos
,
4518 replacing_p
, frame_window_p
)))
4521 /* If some text in a string is replaced, `position' no
4522 longer points to the position of `object'. */
4523 if (!it
|| STRINGP (object
))
4529 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4530 position
, bufpos
, 0,
4538 /* Value is the position of the end of the `display' property starting
4539 at START_POS in OBJECT. */
4541 static struct text_pos
4542 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4545 struct text_pos end_pos
;
4547 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4548 Qdisplay
, object
, Qnil
);
4549 CHARPOS (end_pos
) = XFASTINT (end
);
4550 if (STRINGP (object
))
4551 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4553 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4559 /* Set up IT from a single `display' property specification SPEC. OBJECT
4560 is the object in which the `display' property was found. *POSITION
4561 is the position in OBJECT at which the `display' property was found.
4562 BUFPOS is the buffer position of OBJECT (different from POSITION if
4563 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4564 previously saw a display specification which already replaced text
4565 display with something else, for example an image; we ignore such
4566 properties after the first one has been processed.
4568 OVERLAY is the overlay this `display' property came from,
4569 or nil if it was a text property.
4571 If SPEC is a `space' or `image' specification, and in some other
4572 cases too, set *POSITION to the position where the `display'
4575 If IT is NULL, only examine the property specification in SPEC, but
4576 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4577 is intended to be displayed in a window on a GUI frame.
4579 Value is non-zero if something was found which replaces the display
4580 of buffer or string text. */
4583 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4584 Lisp_Object overlay
, struct text_pos
*position
,
4585 ptrdiff_t bufpos
, int display_replaced_p
,
4589 Lisp_Object location
, value
;
4590 struct text_pos start_pos
= *position
;
4593 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4594 If the result is non-nil, use VALUE instead of SPEC. */
4596 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4605 if (!NILP (form
) && !EQ (form
, Qt
))
4607 ptrdiff_t count
= SPECPDL_INDEX ();
4608 struct gcpro gcpro1
;
4610 /* Bind `object' to the object having the `display' property, a
4611 buffer or string. Bind `position' to the position in the
4612 object where the property was found, and `buffer-position'
4613 to the current position in the buffer. */
4616 XSETBUFFER (object
, current_buffer
);
4617 specbind (Qobject
, object
);
4618 specbind (Qposition
, make_number (CHARPOS (*position
)));
4619 specbind (Qbuffer_position
, make_number (bufpos
));
4621 form
= safe_eval (form
);
4623 unbind_to (count
, Qnil
);
4629 /* Handle `(height HEIGHT)' specifications. */
4631 && EQ (XCAR (spec
), Qheight
)
4632 && CONSP (XCDR (spec
)))
4636 if (!FRAME_WINDOW_P (it
->f
))
4639 it
->font_height
= XCAR (XCDR (spec
));
4640 if (!NILP (it
->font_height
))
4642 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4643 int new_height
= -1;
4645 if (CONSP (it
->font_height
)
4646 && (EQ (XCAR (it
->font_height
), Qplus
)
4647 || EQ (XCAR (it
->font_height
), Qminus
))
4648 && CONSP (XCDR (it
->font_height
))
4649 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4651 /* `(+ N)' or `(- N)' where N is an integer. */
4652 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4653 if (EQ (XCAR (it
->font_height
), Qplus
))
4655 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4657 else if (FUNCTIONP (it
->font_height
))
4659 /* Call function with current height as argument.
4660 Value is the new height. */
4662 height
= safe_call1 (it
->font_height
,
4663 face
->lface
[LFACE_HEIGHT_INDEX
]);
4664 if (NUMBERP (height
))
4665 new_height
= XFLOATINT (height
);
4667 else if (NUMBERP (it
->font_height
))
4669 /* Value is a multiple of the canonical char height. */
4672 f
= FACE_FROM_ID (it
->f
,
4673 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4674 new_height
= (XFLOATINT (it
->font_height
)
4675 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4679 /* Evaluate IT->font_height with `height' bound to the
4680 current specified height to get the new height. */
4681 ptrdiff_t count
= SPECPDL_INDEX ();
4683 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4684 value
= safe_eval (it
->font_height
);
4685 unbind_to (count
, Qnil
);
4687 if (NUMBERP (value
))
4688 new_height
= XFLOATINT (value
);
4692 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4699 /* Handle `(space-width WIDTH)'. */
4701 && EQ (XCAR (spec
), Qspace_width
)
4702 && CONSP (XCDR (spec
)))
4706 if (!FRAME_WINDOW_P (it
->f
))
4709 value
= XCAR (XCDR (spec
));
4710 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4711 it
->space_width
= value
;
4717 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4719 && EQ (XCAR (spec
), Qslice
))
4725 if (!FRAME_WINDOW_P (it
->f
))
4728 if (tem
= XCDR (spec
), CONSP (tem
))
4730 it
->slice
.x
= XCAR (tem
);
4731 if (tem
= XCDR (tem
), CONSP (tem
))
4733 it
->slice
.y
= XCAR (tem
);
4734 if (tem
= XCDR (tem
), CONSP (tem
))
4736 it
->slice
.width
= XCAR (tem
);
4737 if (tem
= XCDR (tem
), CONSP (tem
))
4738 it
->slice
.height
= XCAR (tem
);
4747 /* Handle `(raise FACTOR)'. */
4749 && EQ (XCAR (spec
), Qraise
)
4750 && CONSP (XCDR (spec
)))
4754 if (!FRAME_WINDOW_P (it
->f
))
4757 #ifdef HAVE_WINDOW_SYSTEM
4758 value
= XCAR (XCDR (spec
));
4759 if (NUMBERP (value
))
4761 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4762 it
->voffset
= - (XFLOATINT (value
)
4763 * (FONT_HEIGHT (face
->font
)));
4765 #endif /* HAVE_WINDOW_SYSTEM */
4771 /* Don't handle the other kinds of display specifications
4772 inside a string that we got from a `display' property. */
4773 if (it
&& it
->string_from_display_prop_p
)
4776 /* Characters having this form of property are not displayed, so
4777 we have to find the end of the property. */
4780 start_pos
= *position
;
4781 *position
= display_prop_end (it
, object
, start_pos
);
4785 /* Stop the scan at that end position--we assume that all
4786 text properties change there. */
4788 it
->stop_charpos
= position
->charpos
;
4790 /* Handle `(left-fringe BITMAP [FACE])'
4791 and `(right-fringe BITMAP [FACE])'. */
4793 && (EQ (XCAR (spec
), Qleft_fringe
)
4794 || EQ (XCAR (spec
), Qright_fringe
))
4795 && CONSP (XCDR (spec
)))
4801 if (!FRAME_WINDOW_P (it
->f
))
4802 /* If we return here, POSITION has been advanced
4803 across the text with this property. */
4805 /* Synchronize the bidi iterator with POSITION. This is
4806 needed because we are not going to push the iterator
4807 on behalf of this display property, so there will be
4808 no pop_it call to do this synchronization for us. */
4811 it
->position
= *position
;
4812 iterate_out_of_display_property (it
);
4813 *position
= it
->position
;
4818 else if (!frame_window_p
)
4821 #ifdef HAVE_WINDOW_SYSTEM
4822 value
= XCAR (XCDR (spec
));
4823 if (!SYMBOLP (value
)
4824 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4825 /* If we return here, POSITION has been advanced
4826 across the text with this property. */
4828 if (it
&& it
->bidi_p
)
4830 it
->position
= *position
;
4831 iterate_out_of_display_property (it
);
4832 *position
= it
->position
;
4839 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4841 if (CONSP (XCDR (XCDR (spec
))))
4843 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4844 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4850 /* Save current settings of IT so that we can restore them
4851 when we are finished with the glyph property value. */
4852 push_it (it
, position
);
4854 it
->area
= TEXT_AREA
;
4855 it
->what
= IT_IMAGE
;
4856 it
->image_id
= -1; /* no image */
4857 it
->position
= start_pos
;
4858 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4859 it
->method
= GET_FROM_IMAGE
;
4860 it
->from_overlay
= Qnil
;
4861 it
->face_id
= face_id
;
4862 it
->from_disp_prop_p
= 1;
4864 /* Say that we haven't consumed the characters with
4865 `display' property yet. The call to pop_it in
4866 set_iterator_to_next will clean this up. */
4867 *position
= start_pos
;
4869 if (EQ (XCAR (spec
), Qleft_fringe
))
4871 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4872 it
->left_user_fringe_face_id
= face_id
;
4876 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4877 it
->right_user_fringe_face_id
= face_id
;
4880 #endif /* HAVE_WINDOW_SYSTEM */
4884 /* Prepare to handle `((margin left-margin) ...)',
4885 `((margin right-margin) ...)' and `((margin nil) ...)'
4886 prefixes for display specifications. */
4887 location
= Qunbound
;
4888 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4892 value
= XCDR (spec
);
4894 value
= XCAR (value
);
4897 if (EQ (XCAR (tem
), Qmargin
)
4898 && (tem
= XCDR (tem
),
4899 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4901 || EQ (tem
, Qleft_margin
)
4902 || EQ (tem
, Qright_margin
))))
4906 if (EQ (location
, Qunbound
))
4912 /* After this point, VALUE is the property after any
4913 margin prefix has been stripped. It must be a string,
4914 an image specification, or `(space ...)'.
4916 LOCATION specifies where to display: `left-margin',
4917 `right-margin' or nil. */
4919 valid_p
= (STRINGP (value
)
4920 #ifdef HAVE_WINDOW_SYSTEM
4921 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4922 && valid_image_p (value
))
4923 #endif /* not HAVE_WINDOW_SYSTEM */
4924 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4926 if (valid_p
&& !display_replaced_p
)
4932 /* Callers need to know whether the display spec is any kind
4933 of `(space ...)' spec that is about to affect text-area
4935 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
4940 /* Save current settings of IT so that we can restore them
4941 when we are finished with the glyph property value. */
4942 push_it (it
, position
);
4943 it
->from_overlay
= overlay
;
4944 it
->from_disp_prop_p
= 1;
4946 if (NILP (location
))
4947 it
->area
= TEXT_AREA
;
4948 else if (EQ (location
, Qleft_margin
))
4949 it
->area
= LEFT_MARGIN_AREA
;
4951 it
->area
= RIGHT_MARGIN_AREA
;
4953 if (STRINGP (value
))
4956 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4957 it
->current
.overlay_string_index
= -1;
4958 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4959 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4960 it
->method
= GET_FROM_STRING
;
4961 it
->stop_charpos
= 0;
4963 it
->base_level_stop
= 0;
4964 it
->string_from_display_prop_p
= 1;
4965 /* Say that we haven't consumed the characters with
4966 `display' property yet. The call to pop_it in
4967 set_iterator_to_next will clean this up. */
4968 if (BUFFERP (object
))
4969 *position
= start_pos
;
4971 /* Force paragraph direction to be that of the parent
4972 object. If the parent object's paragraph direction is
4973 not yet determined, default to L2R. */
4974 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4975 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4977 it
->paragraph_embedding
= L2R
;
4979 /* Set up the bidi iterator for this display string. */
4982 it
->bidi_it
.string
.lstring
= it
->string
;
4983 it
->bidi_it
.string
.s
= NULL
;
4984 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4985 it
->bidi_it
.string
.bufpos
= bufpos
;
4986 it
->bidi_it
.string
.from_disp_str
= 1;
4987 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4988 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4991 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4993 it
->method
= GET_FROM_STRETCH
;
4995 *position
= it
->position
= start_pos
;
4996 retval
= 1 + (it
->area
== TEXT_AREA
);
4998 #ifdef HAVE_WINDOW_SYSTEM
5001 it
->what
= IT_IMAGE
;
5002 it
->image_id
= lookup_image (it
->f
, value
);
5003 it
->position
= start_pos
;
5004 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
5005 it
->method
= GET_FROM_IMAGE
;
5007 /* Say that we haven't consumed the characters with
5008 `display' property yet. The call to pop_it in
5009 set_iterator_to_next will clean this up. */
5010 *position
= start_pos
;
5012 #endif /* HAVE_WINDOW_SYSTEM */
5017 /* Invalid property or property not supported. Restore
5018 POSITION to what it was before. */
5019 *position
= start_pos
;
5023 /* Check if PROP is a display property value whose text should be
5024 treated as intangible. OVERLAY is the overlay from which PROP
5025 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5026 specify the buffer position covered by PROP. */
5029 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5030 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5032 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5033 struct text_pos position
;
5035 SET_TEXT_POS (position
, charpos
, bytepos
);
5036 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5037 &position
, charpos
, frame_window_p
);
5041 /* Return 1 if PROP is a display sub-property value containing STRING.
5043 Implementation note: this and the following function are really
5044 special cases of handle_display_spec and
5045 handle_single_display_spec, and should ideally use the same code.
5046 Until they do, these two pairs must be consistent and must be
5047 modified in sync. */
5050 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5052 if (EQ (string
, prop
))
5055 /* Skip over `when FORM'. */
5056 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5061 /* Actually, the condition following `when' should be eval'ed,
5062 like handle_single_display_spec does, and we should return
5063 zero if it evaluates to nil. However, this function is
5064 called only when the buffer was already displayed and some
5065 glyph in the glyph matrix was found to come from a display
5066 string. Therefore, the condition was already evaluated, and
5067 the result was non-nil, otherwise the display string wouldn't
5068 have been displayed and we would have never been called for
5069 this property. Thus, we can skip the evaluation and assume
5070 its result is non-nil. */
5075 /* Skip over `margin LOCATION'. */
5076 if (EQ (XCAR (prop
), Qmargin
))
5087 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5091 /* Return 1 if STRING appears in the `display' property PROP. */
5094 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5097 && !EQ (XCAR (prop
), Qwhen
)
5098 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5100 /* A list of sub-properties. */
5101 while (CONSP (prop
))
5103 if (single_display_spec_string_p (XCAR (prop
), string
))
5108 else if (VECTORP (prop
))
5110 /* A vector of sub-properties. */
5112 for (i
= 0; i
< ASIZE (prop
); ++i
)
5113 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5117 return single_display_spec_string_p (prop
, string
);
5122 /* Look for STRING in overlays and text properties in the current
5123 buffer, between character positions FROM and TO (excluding TO).
5124 BACK_P non-zero means look back (in this case, TO is supposed to be
5126 Value is the first character position where STRING was found, or
5127 zero if it wasn't found before hitting TO.
5129 This function may only use code that doesn't eval because it is
5130 called asynchronously from note_mouse_highlight. */
5133 string_buffer_position_lim (Lisp_Object string
,
5134 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5136 Lisp_Object limit
, prop
, pos
;
5139 pos
= make_number (max (from
, BEGV
));
5141 if (!back_p
) /* looking forward */
5143 limit
= make_number (min (to
, ZV
));
5144 while (!found
&& !EQ (pos
, limit
))
5146 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5147 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5150 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5154 else /* looking back */
5156 limit
= make_number (max (to
, BEGV
));
5157 while (!found
&& !EQ (pos
, limit
))
5159 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5160 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5163 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5168 return found
? XINT (pos
) : 0;
5171 /* Determine which buffer position in current buffer STRING comes from.
5172 AROUND_CHARPOS is an approximate position where it could come from.
5173 Value is the buffer position or 0 if it couldn't be determined.
5175 This function is necessary because we don't record buffer positions
5176 in glyphs generated from strings (to keep struct glyph small).
5177 This function may only use code that doesn't eval because it is
5178 called asynchronously from note_mouse_highlight. */
5181 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5183 const int MAX_DISTANCE
= 1000;
5184 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5185 around_charpos
+ MAX_DISTANCE
,
5189 found
= string_buffer_position_lim (string
, around_charpos
,
5190 around_charpos
- MAX_DISTANCE
, 1);
5196 /***********************************************************************
5197 `composition' property
5198 ***********************************************************************/
5200 /* Set up iterator IT from `composition' property at its current
5201 position. Called from handle_stop. */
5203 static enum prop_handled
5204 handle_composition_prop (struct it
*it
)
5206 Lisp_Object prop
, string
;
5207 ptrdiff_t pos
, pos_byte
, start
, end
;
5209 if (STRINGP (it
->string
))
5213 pos
= IT_STRING_CHARPOS (*it
);
5214 pos_byte
= IT_STRING_BYTEPOS (*it
);
5215 string
= it
->string
;
5216 s
= SDATA (string
) + pos_byte
;
5217 it
->c
= STRING_CHAR (s
);
5221 pos
= IT_CHARPOS (*it
);
5222 pos_byte
= IT_BYTEPOS (*it
);
5224 it
->c
= FETCH_CHAR (pos_byte
);
5227 /* If there's a valid composition and point is not inside of the
5228 composition (in the case that the composition is from the current
5229 buffer), draw a glyph composed from the composition components. */
5230 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5231 && COMPOSITION_VALID_P (start
, end
, prop
)
5232 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5235 /* As we can't handle this situation (perhaps font-lock added
5236 a new composition), we just return here hoping that next
5237 redisplay will detect this composition much earlier. */
5238 return HANDLED_NORMALLY
;
5241 if (STRINGP (it
->string
))
5242 pos_byte
= string_char_to_byte (it
->string
, start
);
5244 pos_byte
= CHAR_TO_BYTE (start
);
5246 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5249 if (it
->cmp_it
.id
>= 0)
5252 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5253 it
->cmp_it
.nglyphs
= -1;
5257 return HANDLED_NORMALLY
;
5262 /***********************************************************************
5264 ***********************************************************************/
5266 /* The following structure is used to record overlay strings for
5267 later sorting in load_overlay_strings. */
5269 struct overlay_entry
5271 Lisp_Object overlay
;
5278 /* Set up iterator IT from overlay strings at its current position.
5279 Called from handle_stop. */
5281 static enum prop_handled
5282 handle_overlay_change (struct it
*it
)
5284 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5285 return HANDLED_RECOMPUTE_PROPS
;
5287 return HANDLED_NORMALLY
;
5291 /* Set up the next overlay string for delivery by IT, if there is an
5292 overlay string to deliver. Called by set_iterator_to_next when the
5293 end of the current overlay string is reached. If there are more
5294 overlay strings to display, IT->string and
5295 IT->current.overlay_string_index are set appropriately here.
5296 Otherwise IT->string is set to nil. */
5299 next_overlay_string (struct it
*it
)
5301 ++it
->current
.overlay_string_index
;
5302 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5304 /* No more overlay strings. Restore IT's settings to what
5305 they were before overlay strings were processed, and
5306 continue to deliver from current_buffer. */
5308 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5311 || (NILP (it
->string
)
5312 && it
->method
== GET_FROM_BUFFER
5313 && it
->stop_charpos
>= BEGV
5314 && it
->stop_charpos
<= it
->end_charpos
));
5315 it
->current
.overlay_string_index
= -1;
5316 it
->n_overlay_strings
= 0;
5317 it
->overlay_strings_charpos
= -1;
5318 /* If there's an empty display string on the stack, pop the
5319 stack, to resync the bidi iterator with IT's position. Such
5320 empty strings are pushed onto the stack in
5321 get_overlay_strings_1. */
5322 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5325 /* If we're at the end of the buffer, record that we have
5326 processed the overlay strings there already, so that
5327 next_element_from_buffer doesn't try it again. */
5328 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5329 it
->overlay_strings_at_end_processed_p
= 1;
5333 /* There are more overlay strings to process. If
5334 IT->current.overlay_string_index has advanced to a position
5335 where we must load IT->overlay_strings with more strings, do
5336 it. We must load at the IT->overlay_strings_charpos where
5337 IT->n_overlay_strings was originally computed; when invisible
5338 text is present, this might not be IT_CHARPOS (Bug#7016). */
5339 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5341 if (it
->current
.overlay_string_index
&& i
== 0)
5342 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5344 /* Initialize IT to deliver display elements from the overlay
5346 it
->string
= it
->overlay_strings
[i
];
5347 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5348 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5349 it
->method
= GET_FROM_STRING
;
5350 it
->stop_charpos
= 0;
5351 it
->end_charpos
= SCHARS (it
->string
);
5352 if (it
->cmp_it
.stop_pos
>= 0)
5353 it
->cmp_it
.stop_pos
= 0;
5355 it
->base_level_stop
= 0;
5357 /* Set up the bidi iterator for this overlay string. */
5360 it
->bidi_it
.string
.lstring
= it
->string
;
5361 it
->bidi_it
.string
.s
= NULL
;
5362 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5363 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5364 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5365 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5366 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5374 /* Compare two overlay_entry structures E1 and E2. Used as a
5375 comparison function for qsort in load_overlay_strings. Overlay
5376 strings for the same position are sorted so that
5378 1. All after-strings come in front of before-strings, except
5379 when they come from the same overlay.
5381 2. Within after-strings, strings are sorted so that overlay strings
5382 from overlays with higher priorities come first.
5384 2. Within before-strings, strings are sorted so that overlay
5385 strings from overlays with higher priorities come last.
5387 Value is analogous to strcmp. */
5391 compare_overlay_entries (const void *e1
, const void *e2
)
5393 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
5394 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
5397 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5399 /* Let after-strings appear in front of before-strings if
5400 they come from different overlays. */
5401 if (EQ (entry1
->overlay
, entry2
->overlay
))
5402 result
= entry1
->after_string_p
? 1 : -1;
5404 result
= entry1
->after_string_p
? -1 : 1;
5406 else if (entry1
->priority
!= entry2
->priority
)
5408 if (entry1
->after_string_p
)
5409 /* After-strings sorted in order of decreasing priority. */
5410 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5412 /* Before-strings sorted in order of increasing priority. */
5413 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5422 /* Load the vector IT->overlay_strings with overlay strings from IT's
5423 current buffer position, or from CHARPOS if that is > 0. Set
5424 IT->n_overlays to the total number of overlay strings found.
5426 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5427 a time. On entry into load_overlay_strings,
5428 IT->current.overlay_string_index gives the number of overlay
5429 strings that have already been loaded by previous calls to this
5432 IT->add_overlay_start contains an additional overlay start
5433 position to consider for taking overlay strings from, if non-zero.
5434 This position comes into play when the overlay has an `invisible'
5435 property, and both before and after-strings. When we've skipped to
5436 the end of the overlay, because of its `invisible' property, we
5437 nevertheless want its before-string to appear.
5438 IT->add_overlay_start will contain the overlay start position
5441 Overlay strings are sorted so that after-string strings come in
5442 front of before-string strings. Within before and after-strings,
5443 strings are sorted by overlay priority. See also function
5444 compare_overlay_entries. */
5447 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5449 Lisp_Object overlay
, window
, str
, invisible
;
5450 struct Lisp_Overlay
*ov
;
5451 ptrdiff_t start
, end
;
5452 ptrdiff_t size
= 20;
5453 ptrdiff_t n
= 0, i
, j
;
5455 struct overlay_entry
*entries
= alloca (size
* sizeof *entries
);
5459 charpos
= IT_CHARPOS (*it
);
5461 /* Append the overlay string STRING of overlay OVERLAY to vector
5462 `entries' which has size `size' and currently contains `n'
5463 elements. AFTER_P non-zero means STRING is an after-string of
5465 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5468 Lisp_Object priority; \
5472 struct overlay_entry *old = entries; \
5473 SAFE_NALLOCA (entries, 2, size); \
5474 memcpy (entries, old, size * sizeof *entries); \
5478 entries[n].string = (STRING); \
5479 entries[n].overlay = (OVERLAY); \
5480 priority = Foverlay_get ((OVERLAY), Qpriority); \
5481 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5482 entries[n].after_string_p = (AFTER_P); \
5487 /* Process overlay before the overlay center. */
5488 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5490 XSETMISC (overlay
, ov
);
5491 eassert (OVERLAYP (overlay
));
5492 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5493 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5498 /* Skip this overlay if it doesn't start or end at IT's current
5500 if (end
!= charpos
&& start
!= charpos
)
5503 /* Skip this overlay if it doesn't apply to IT->w. */
5504 window
= Foverlay_get (overlay
, Qwindow
);
5505 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5508 /* If the text ``under'' the overlay is invisible, both before-
5509 and after-strings from this overlay are visible; start and
5510 end position are indistinguishable. */
5511 invisible
= Foverlay_get (overlay
, Qinvisible
);
5512 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5514 /* If overlay has a non-empty before-string, record it. */
5515 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5516 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5518 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5520 /* If overlay has a non-empty after-string, record it. */
5521 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5522 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5524 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5527 /* Process overlays after the overlay center. */
5528 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5530 XSETMISC (overlay
, ov
);
5531 eassert (OVERLAYP (overlay
));
5532 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5533 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5535 if (start
> charpos
)
5538 /* Skip this overlay if it doesn't start or end at IT's current
5540 if (end
!= charpos
&& start
!= charpos
)
5543 /* Skip this overlay if it doesn't apply to IT->w. */
5544 window
= Foverlay_get (overlay
, Qwindow
);
5545 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5548 /* If the text ``under'' the overlay is invisible, it has a zero
5549 dimension, and both before- and after-strings apply. */
5550 invisible
= Foverlay_get (overlay
, Qinvisible
);
5551 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5553 /* If overlay has a non-empty before-string, record it. */
5554 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5555 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5557 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5559 /* If overlay has a non-empty after-string, record it. */
5560 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5561 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5563 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5566 #undef RECORD_OVERLAY_STRING
5570 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5572 /* Record number of overlay strings, and where we computed it. */
5573 it
->n_overlay_strings
= n
;
5574 it
->overlay_strings_charpos
= charpos
;
5576 /* IT->current.overlay_string_index is the number of overlay strings
5577 that have already been consumed by IT. Copy some of the
5578 remaining overlay strings to IT->overlay_strings. */
5580 j
= it
->current
.overlay_string_index
;
5581 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5583 it
->overlay_strings
[i
] = entries
[j
].string
;
5584 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5592 /* Get the first chunk of overlay strings at IT's current buffer
5593 position, or at CHARPOS if that is > 0. Value is non-zero if at
5594 least one overlay string was found. */
5597 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5599 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5600 process. This fills IT->overlay_strings with strings, and sets
5601 IT->n_overlay_strings to the total number of strings to process.
5602 IT->pos.overlay_string_index has to be set temporarily to zero
5603 because load_overlay_strings needs this; it must be set to -1
5604 when no overlay strings are found because a zero value would
5605 indicate a position in the first overlay string. */
5606 it
->current
.overlay_string_index
= 0;
5607 load_overlay_strings (it
, charpos
);
5609 /* If we found overlay strings, set up IT to deliver display
5610 elements from the first one. Otherwise set up IT to deliver
5611 from current_buffer. */
5612 if (it
->n_overlay_strings
)
5614 /* Make sure we know settings in current_buffer, so that we can
5615 restore meaningful values when we're done with the overlay
5618 compute_stop_pos (it
);
5619 eassert (it
->face_id
>= 0);
5621 /* Save IT's settings. They are restored after all overlay
5622 strings have been processed. */
5623 eassert (!compute_stop_p
|| it
->sp
== 0);
5625 /* When called from handle_stop, there might be an empty display
5626 string loaded. In that case, don't bother saving it. But
5627 don't use this optimization with the bidi iterator, since we
5628 need the corresponding pop_it call to resync the bidi
5629 iterator's position with IT's position, after we are done
5630 with the overlay strings. (The corresponding call to pop_it
5631 in case of an empty display string is in
5632 next_overlay_string.) */
5634 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5637 /* Set up IT to deliver display elements from the first overlay
5639 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5640 it
->string
= it
->overlay_strings
[0];
5641 it
->from_overlay
= Qnil
;
5642 it
->stop_charpos
= 0;
5643 eassert (STRINGP (it
->string
));
5644 it
->end_charpos
= SCHARS (it
->string
);
5646 it
->base_level_stop
= 0;
5647 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5648 it
->method
= GET_FROM_STRING
;
5649 it
->from_disp_prop_p
= 0;
5651 /* Force paragraph direction to be that of the parent
5653 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5654 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5656 it
->paragraph_embedding
= L2R
;
5658 /* Set up the bidi iterator for this overlay string. */
5661 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5663 it
->bidi_it
.string
.lstring
= it
->string
;
5664 it
->bidi_it
.string
.s
= NULL
;
5665 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5666 it
->bidi_it
.string
.bufpos
= pos
;
5667 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5668 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5669 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5674 it
->current
.overlay_string_index
= -1;
5679 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5682 it
->method
= GET_FROM_BUFFER
;
5684 (void) get_overlay_strings_1 (it
, charpos
, 1);
5688 /* Value is non-zero if we found at least one overlay string. */
5689 return STRINGP (it
->string
);
5694 /***********************************************************************
5695 Saving and restoring state
5696 ***********************************************************************/
5698 /* Save current settings of IT on IT->stack. Called, for example,
5699 before setting up IT for an overlay string, to be able to restore
5700 IT's settings to what they were after the overlay string has been
5701 processed. If POSITION is non-NULL, it is the position to save on
5702 the stack instead of IT->position. */
5705 push_it (struct it
*it
, struct text_pos
*position
)
5707 struct iterator_stack_entry
*p
;
5709 eassert (it
->sp
< IT_STACK_SIZE
);
5710 p
= it
->stack
+ it
->sp
;
5712 p
->stop_charpos
= it
->stop_charpos
;
5713 p
->prev_stop
= it
->prev_stop
;
5714 p
->base_level_stop
= it
->base_level_stop
;
5715 p
->cmp_it
= it
->cmp_it
;
5716 eassert (it
->face_id
>= 0);
5717 p
->face_id
= it
->face_id
;
5718 p
->string
= it
->string
;
5719 p
->method
= it
->method
;
5720 p
->from_overlay
= it
->from_overlay
;
5723 case GET_FROM_IMAGE
:
5724 p
->u
.image
.object
= it
->object
;
5725 p
->u
.image
.image_id
= it
->image_id
;
5726 p
->u
.image
.slice
= it
->slice
;
5728 case GET_FROM_STRETCH
:
5729 p
->u
.stretch
.object
= it
->object
;
5732 p
->position
= position
? *position
: it
->position
;
5733 p
->current
= it
->current
;
5734 p
->end_charpos
= it
->end_charpos
;
5735 p
->string_nchars
= it
->string_nchars
;
5737 p
->multibyte_p
= it
->multibyte_p
;
5738 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5739 p
->space_width
= it
->space_width
;
5740 p
->font_height
= it
->font_height
;
5741 p
->voffset
= it
->voffset
;
5742 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5743 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5744 p
->display_ellipsis_p
= 0;
5745 p
->line_wrap
= it
->line_wrap
;
5746 p
->bidi_p
= it
->bidi_p
;
5747 p
->paragraph_embedding
= it
->paragraph_embedding
;
5748 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5751 /* Save the state of the bidi iterator as well. */
5753 bidi_push_it (&it
->bidi_it
);
5757 iterate_out_of_display_property (struct it
*it
)
5759 int buffer_p
= !STRINGP (it
->string
);
5760 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5761 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
5763 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5765 /* Maybe initialize paragraph direction. If we are at the beginning
5766 of a new paragraph, next_element_from_buffer may not have a
5767 chance to do that. */
5768 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5769 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5770 /* prev_stop can be zero, so check against BEGV as well. */
5771 while (it
->bidi_it
.charpos
>= bob
5772 && it
->prev_stop
<= it
->bidi_it
.charpos
5773 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5774 && it
->bidi_it
.charpos
< eob
)
5775 bidi_move_to_visually_next (&it
->bidi_it
);
5776 /* Record the stop_pos we just crossed, for when we cross it
5778 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5779 it
->prev_stop
= CHARPOS (it
->position
);
5780 /* If we ended up not where pop_it put us, resync IT's
5781 positional members with the bidi iterator. */
5782 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5783 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5785 it
->current
.pos
= it
->position
;
5787 it
->current
.string_pos
= it
->position
;
5790 /* Restore IT's settings from IT->stack. Called, for example, when no
5791 more overlay strings must be processed, and we return to delivering
5792 display elements from a buffer, or when the end of a string from a
5793 `display' property is reached and we return to delivering display
5794 elements from an overlay string, or from a buffer. */
5797 pop_it (struct it
*it
)
5799 struct iterator_stack_entry
*p
;
5800 int from_display_prop
= it
->from_disp_prop_p
;
5802 eassert (it
->sp
> 0);
5804 p
= it
->stack
+ it
->sp
;
5805 it
->stop_charpos
= p
->stop_charpos
;
5806 it
->prev_stop
= p
->prev_stop
;
5807 it
->base_level_stop
= p
->base_level_stop
;
5808 it
->cmp_it
= p
->cmp_it
;
5809 it
->face_id
= p
->face_id
;
5810 it
->current
= p
->current
;
5811 it
->position
= p
->position
;
5812 it
->string
= p
->string
;
5813 it
->from_overlay
= p
->from_overlay
;
5814 if (NILP (it
->string
))
5815 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5816 it
->method
= p
->method
;
5819 case GET_FROM_IMAGE
:
5820 it
->image_id
= p
->u
.image
.image_id
;
5821 it
->object
= p
->u
.image
.object
;
5822 it
->slice
= p
->u
.image
.slice
;
5824 case GET_FROM_STRETCH
:
5825 it
->object
= p
->u
.stretch
.object
;
5827 case GET_FROM_BUFFER
:
5828 it
->object
= it
->w
->buffer
;
5830 case GET_FROM_STRING
:
5831 it
->object
= it
->string
;
5833 case GET_FROM_DISPLAY_VECTOR
:
5835 it
->method
= GET_FROM_C_STRING
;
5836 else if (STRINGP (it
->string
))
5837 it
->method
= GET_FROM_STRING
;
5840 it
->method
= GET_FROM_BUFFER
;
5841 it
->object
= it
->w
->buffer
;
5844 it
->end_charpos
= p
->end_charpos
;
5845 it
->string_nchars
= p
->string_nchars
;
5847 it
->multibyte_p
= p
->multibyte_p
;
5848 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5849 it
->space_width
= p
->space_width
;
5850 it
->font_height
= p
->font_height
;
5851 it
->voffset
= p
->voffset
;
5852 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5853 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
5854 it
->line_wrap
= p
->line_wrap
;
5855 it
->bidi_p
= p
->bidi_p
;
5856 it
->paragraph_embedding
= p
->paragraph_embedding
;
5857 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5860 bidi_pop_it (&it
->bidi_it
);
5861 /* Bidi-iterate until we get out of the portion of text, if any,
5862 covered by a `display' text property or by an overlay with
5863 `display' property. (We cannot just jump there, because the
5864 internal coherency of the bidi iterator state can not be
5865 preserved across such jumps.) We also must determine the
5866 paragraph base direction if the overlay we just processed is
5867 at the beginning of a new paragraph. */
5868 if (from_display_prop
5869 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5870 iterate_out_of_display_property (it
);
5872 eassert ((BUFFERP (it
->object
)
5873 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5874 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5875 || (STRINGP (it
->object
)
5876 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5877 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5878 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
5884 /***********************************************************************
5886 ***********************************************************************/
5888 /* Set IT's current position to the previous line start. */
5891 back_to_previous_line_start (struct it
*it
)
5893 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5894 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5898 /* Move IT to the next line start.
5900 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5901 we skipped over part of the text (as opposed to moving the iterator
5902 continuously over the text). Otherwise, don't change the value
5905 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5906 iterator on the newline, if it was found.
5908 Newlines may come from buffer text, overlay strings, or strings
5909 displayed via the `display' property. That's the reason we can't
5910 simply use find_next_newline_no_quit.
5912 Note that this function may not skip over invisible text that is so
5913 because of text properties and immediately follows a newline. If
5914 it would, function reseat_at_next_visible_line_start, when called
5915 from set_iterator_to_next, would effectively make invisible
5916 characters following a newline part of the wrong glyph row, which
5917 leads to wrong cursor motion. */
5920 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5921 struct bidi_it
*bidi_it_prev
)
5923 ptrdiff_t old_selective
;
5924 int newline_found_p
, n
;
5925 const int MAX_NEWLINE_DISTANCE
= 500;
5927 /* If already on a newline, just consume it to avoid unintended
5928 skipping over invisible text below. */
5929 if (it
->what
== IT_CHARACTER
5931 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5933 if (it
->bidi_p
&& bidi_it_prev
)
5934 *bidi_it_prev
= it
->bidi_it
;
5935 set_iterator_to_next (it
, 0);
5940 /* Don't handle selective display in the following. It's (a)
5941 unnecessary because it's done by the caller, and (b) leads to an
5942 infinite recursion because next_element_from_ellipsis indirectly
5943 calls this function. */
5944 old_selective
= it
->selective
;
5947 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5948 from buffer text. */
5949 for (n
= newline_found_p
= 0;
5950 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5951 n
+= STRINGP (it
->string
) ? 0 : 1)
5953 if (!get_next_display_element (it
))
5955 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5956 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5957 *bidi_it_prev
= it
->bidi_it
;
5958 set_iterator_to_next (it
, 0);
5961 /* If we didn't find a newline near enough, see if we can use a
5963 if (!newline_found_p
)
5965 ptrdiff_t start
= IT_CHARPOS (*it
);
5966 ptrdiff_t limit
= find_next_newline_no_quit (start
, 1);
5969 eassert (!STRINGP (it
->string
));
5971 /* If there isn't any `display' property in sight, and no
5972 overlays, we can just use the position of the newline in
5974 if (it
->stop_charpos
>= limit
5975 || ((pos
= Fnext_single_property_change (make_number (start
),
5977 make_number (limit
)),
5979 && next_overlay_change (start
) == ZV
))
5983 IT_CHARPOS (*it
) = limit
;
5984 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5988 struct bidi_it bprev
;
5990 /* Help bidi.c avoid expensive searches for display
5991 properties and overlays, by telling it that there are
5992 none up to `limit'. */
5993 if (it
->bidi_it
.disp_pos
< limit
)
5995 it
->bidi_it
.disp_pos
= limit
;
5996 it
->bidi_it
.disp_prop
= 0;
5999 bprev
= it
->bidi_it
;
6000 bidi_move_to_visually_next (&it
->bidi_it
);
6001 } while (it
->bidi_it
.charpos
!= limit
);
6002 IT_CHARPOS (*it
) = limit
;
6003 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6005 *bidi_it_prev
= bprev
;
6007 *skipped_p
= newline_found_p
= 1;
6011 while (get_next_display_element (it
)
6012 && !newline_found_p
)
6014 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6015 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6016 *bidi_it_prev
= it
->bidi_it
;
6017 set_iterator_to_next (it
, 0);
6022 it
->selective
= old_selective
;
6023 return newline_found_p
;
6027 /* Set IT's current position to the previous visible line start. Skip
6028 invisible text that is so either due to text properties or due to
6029 selective display. Caution: this does not change IT->current_x and
6033 back_to_previous_visible_line_start (struct it
*it
)
6035 while (IT_CHARPOS (*it
) > BEGV
)
6037 back_to_previous_line_start (it
);
6039 if (IT_CHARPOS (*it
) <= BEGV
)
6042 /* If selective > 0, then lines indented more than its value are
6044 if (it
->selective
> 0
6045 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6049 /* Check the newline before point for invisibility. */
6052 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6053 Qinvisible
, it
->window
);
6054 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6058 if (IT_CHARPOS (*it
) <= BEGV
)
6063 void *it2data
= NULL
;
6066 Lisp_Object val
, overlay
;
6068 SAVE_IT (it2
, *it
, it2data
);
6070 /* If newline is part of a composition, continue from start of composition */
6071 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6072 && beg
< IT_CHARPOS (*it
))
6075 /* If newline is replaced by a display property, find start of overlay
6076 or interval and continue search from that point. */
6077 pos
= --IT_CHARPOS (it2
);
6080 bidi_unshelve_cache (NULL
, 0);
6081 it2
.string_from_display_prop_p
= 0;
6082 it2
.from_disp_prop_p
= 0;
6083 if (handle_display_prop (&it2
) == HANDLED_RETURN
6084 && !NILP (val
= get_char_property_and_overlay
6085 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6086 && (OVERLAYP (overlay
)
6087 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6088 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6090 RESTORE_IT (it
, it
, it2data
);
6094 /* Newline is not replaced by anything -- so we are done. */
6095 RESTORE_IT (it
, it
, it2data
);
6101 IT_CHARPOS (*it
) = beg
;
6102 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6106 it
->continuation_lines_width
= 0;
6108 eassert (IT_CHARPOS (*it
) >= BEGV
);
6109 eassert (IT_CHARPOS (*it
) == BEGV
6110 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6115 /* Reseat iterator IT at the previous visible line start. Skip
6116 invisible text that is so either due to text properties or due to
6117 selective display. At the end, update IT's overlay information,
6118 face information etc. */
6121 reseat_at_previous_visible_line_start (struct it
*it
)
6123 back_to_previous_visible_line_start (it
);
6124 reseat (it
, it
->current
.pos
, 1);
6129 /* Reseat iterator IT on the next visible line start in the current
6130 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6131 preceding the line start. Skip over invisible text that is so
6132 because of selective display. Compute faces, overlays etc at the
6133 new position. Note that this function does not skip over text that
6134 is invisible because of text properties. */
6137 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6139 int newline_found_p
, skipped_p
= 0;
6140 struct bidi_it bidi_it_prev
;
6142 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6144 /* Skip over lines that are invisible because they are indented
6145 more than the value of IT->selective. */
6146 if (it
->selective
> 0)
6147 while (IT_CHARPOS (*it
) < ZV
6148 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6151 eassert (IT_BYTEPOS (*it
) == BEGV
6152 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6154 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6157 /* Position on the newline if that's what's requested. */
6158 if (on_newline_p
&& newline_found_p
)
6160 if (STRINGP (it
->string
))
6162 if (IT_STRING_CHARPOS (*it
) > 0)
6166 --IT_STRING_CHARPOS (*it
);
6167 --IT_STRING_BYTEPOS (*it
);
6171 /* We need to restore the bidi iterator to the state
6172 it had on the newline, and resync the IT's
6173 position with that. */
6174 it
->bidi_it
= bidi_it_prev
;
6175 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6176 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6180 else if (IT_CHARPOS (*it
) > BEGV
)
6189 /* We need to restore the bidi iterator to the state it
6190 had on the newline and resync IT with that. */
6191 it
->bidi_it
= bidi_it_prev
;
6192 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6193 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6195 reseat (it
, it
->current
.pos
, 0);
6199 reseat (it
, it
->current
.pos
, 0);
6206 /***********************************************************************
6207 Changing an iterator's position
6208 ***********************************************************************/
6210 /* Change IT's current position to POS in current_buffer. If FORCE_P
6211 is non-zero, always check for text properties at the new position.
6212 Otherwise, text properties are only looked up if POS >=
6213 IT->check_charpos of a property. */
6216 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6218 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6220 reseat_1 (it
, pos
, 0);
6222 /* Determine where to check text properties. Avoid doing it
6223 where possible because text property lookup is very expensive. */
6225 || CHARPOS (pos
) > it
->stop_charpos
6226 || CHARPOS (pos
) < original_pos
)
6230 /* For bidi iteration, we need to prime prev_stop and
6231 base_level_stop with our best estimations. */
6232 /* Implementation note: Of course, POS is not necessarily a
6233 stop position, so assigning prev_pos to it is a lie; we
6234 should have called compute_stop_backwards. However, if
6235 the current buffer does not include any R2L characters,
6236 that call would be a waste of cycles, because the
6237 iterator will never move back, and thus never cross this
6238 "fake" stop position. So we delay that backward search
6239 until the time we really need it, in next_element_from_buffer. */
6240 if (CHARPOS (pos
) != it
->prev_stop
)
6241 it
->prev_stop
= CHARPOS (pos
);
6242 if (CHARPOS (pos
) < it
->base_level_stop
)
6243 it
->base_level_stop
= 0; /* meaning it's unknown */
6249 it
->prev_stop
= it
->base_level_stop
= 0;
6258 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6259 IT->stop_pos to POS, also. */
6262 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6264 /* Don't call this function when scanning a C string. */
6265 eassert (it
->s
== NULL
);
6267 /* POS must be a reasonable value. */
6268 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6270 it
->current
.pos
= it
->position
= pos
;
6271 it
->end_charpos
= ZV
;
6273 it
->current
.dpvec_index
= -1;
6274 it
->current
.overlay_string_index
= -1;
6275 IT_STRING_CHARPOS (*it
) = -1;
6276 IT_STRING_BYTEPOS (*it
) = -1;
6278 it
->method
= GET_FROM_BUFFER
;
6279 it
->object
= it
->w
->buffer
;
6280 it
->area
= TEXT_AREA
;
6281 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6283 it
->string_from_display_prop_p
= 0;
6284 it
->string_from_prefix_prop_p
= 0;
6286 it
->from_disp_prop_p
= 0;
6287 it
->face_before_selective_p
= 0;
6290 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6292 bidi_unshelve_cache (NULL
, 0);
6293 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6294 it
->bidi_it
.string
.s
= NULL
;
6295 it
->bidi_it
.string
.lstring
= Qnil
;
6296 it
->bidi_it
.string
.bufpos
= 0;
6297 it
->bidi_it
.string
.unibyte
= 0;
6302 it
->stop_charpos
= CHARPOS (pos
);
6303 it
->base_level_stop
= CHARPOS (pos
);
6308 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6309 If S is non-null, it is a C string to iterate over. Otherwise,
6310 STRING gives a Lisp string to iterate over.
6312 If PRECISION > 0, don't return more then PRECISION number of
6313 characters from the string.
6315 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6316 characters have been returned. FIELD_WIDTH < 0 means an infinite
6319 MULTIBYTE = 0 means disable processing of multibyte characters,
6320 MULTIBYTE > 0 means enable it,
6321 MULTIBYTE < 0 means use IT->multibyte_p.
6323 IT must be initialized via a prior call to init_iterator before
6324 calling this function. */
6327 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6328 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6331 /* No region in strings. */
6332 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
6334 /* No text property checks performed by default, but see below. */
6335 it
->stop_charpos
= -1;
6337 /* Set iterator position and end position. */
6338 memset (&it
->current
, 0, sizeof it
->current
);
6339 it
->current
.overlay_string_index
= -1;
6340 it
->current
.dpvec_index
= -1;
6341 eassert (charpos
>= 0);
6343 /* If STRING is specified, use its multibyteness, otherwise use the
6344 setting of MULTIBYTE, if specified. */
6346 it
->multibyte_p
= multibyte
> 0;
6348 /* Bidirectional reordering of strings is controlled by the default
6349 value of bidi-display-reordering. Don't try to reorder while
6350 loading loadup.el, as the necessary character property tables are
6351 not yet available. */
6354 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6358 eassert (STRINGP (string
));
6359 it
->string
= string
;
6361 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6362 it
->method
= GET_FROM_STRING
;
6363 it
->current
.string_pos
= string_pos (charpos
, string
);
6367 it
->bidi_it
.string
.lstring
= string
;
6368 it
->bidi_it
.string
.s
= NULL
;
6369 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6370 it
->bidi_it
.string
.bufpos
= 0;
6371 it
->bidi_it
.string
.from_disp_str
= 0;
6372 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6373 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6374 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6379 it
->s
= (const unsigned char *) s
;
6382 /* Note that we use IT->current.pos, not it->current.string_pos,
6383 for displaying C strings. */
6384 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6385 if (it
->multibyte_p
)
6387 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6388 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6392 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6393 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6398 it
->bidi_it
.string
.lstring
= Qnil
;
6399 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6400 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6401 it
->bidi_it
.string
.bufpos
= 0;
6402 it
->bidi_it
.string
.from_disp_str
= 0;
6403 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6404 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6407 it
->method
= GET_FROM_C_STRING
;
6410 /* PRECISION > 0 means don't return more than PRECISION characters
6412 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6414 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6416 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6419 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6420 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6421 FIELD_WIDTH < 0 means infinite field width. This is useful for
6422 padding with `-' at the end of a mode line. */
6423 if (field_width
< 0)
6424 field_width
= INFINITY
;
6425 /* Implementation note: We deliberately don't enlarge
6426 it->bidi_it.string.schars here to fit it->end_charpos, because
6427 the bidi iterator cannot produce characters out of thin air. */
6428 if (field_width
> it
->end_charpos
- charpos
)
6429 it
->end_charpos
= charpos
+ field_width
;
6431 /* Use the standard display table for displaying strings. */
6432 if (DISP_TABLE_P (Vstandard_display_table
))
6433 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6435 it
->stop_charpos
= charpos
;
6436 it
->prev_stop
= charpos
;
6437 it
->base_level_stop
= 0;
6440 it
->bidi_it
.first_elt
= 1;
6441 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6442 it
->bidi_it
.disp_pos
= -1;
6444 if (s
== NULL
&& it
->multibyte_p
)
6446 ptrdiff_t endpos
= SCHARS (it
->string
);
6447 if (endpos
> it
->end_charpos
)
6448 endpos
= it
->end_charpos
;
6449 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6457 /***********************************************************************
6459 ***********************************************************************/
6461 /* Map enum it_method value to corresponding next_element_from_* function. */
6463 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6465 next_element_from_buffer
,
6466 next_element_from_display_vector
,
6467 next_element_from_string
,
6468 next_element_from_c_string
,
6469 next_element_from_image
,
6470 next_element_from_stretch
6473 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6476 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6477 (possibly with the following characters). */
6479 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6480 ((IT)->cmp_it.id >= 0 \
6481 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6482 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6483 END_CHARPOS, (IT)->w, \
6484 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6488 /* Lookup the char-table Vglyphless_char_display for character C (-1
6489 if we want information for no-font case), and return the display
6490 method symbol. By side-effect, update it->what and
6491 it->glyphless_method. This function is called from
6492 get_next_display_element for each character element, and from
6493 x_produce_glyphs when no suitable font was found. */
6496 lookup_glyphless_char_display (int c
, struct it
*it
)
6498 Lisp_Object glyphless_method
= Qnil
;
6500 if (CHAR_TABLE_P (Vglyphless_char_display
)
6501 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6505 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6506 if (CONSP (glyphless_method
))
6507 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6508 ? XCAR (glyphless_method
)
6509 : XCDR (glyphless_method
);
6512 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6516 if (NILP (glyphless_method
))
6519 /* The default is to display the character by a proper font. */
6521 /* The default for the no-font case is to display an empty box. */
6522 glyphless_method
= Qempty_box
;
6524 if (EQ (glyphless_method
, Qzero_width
))
6527 return glyphless_method
;
6528 /* This method can't be used for the no-font case. */
6529 glyphless_method
= Qempty_box
;
6531 if (EQ (glyphless_method
, Qthin_space
))
6532 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6533 else if (EQ (glyphless_method
, Qempty_box
))
6534 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6535 else if (EQ (glyphless_method
, Qhex_code
))
6536 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6537 else if (STRINGP (glyphless_method
))
6538 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6541 /* Invalid value. We use the default method. */
6542 glyphless_method
= Qnil
;
6545 it
->what
= IT_GLYPHLESS
;
6546 return glyphless_method
;
6549 /* Load IT's display element fields with information about the next
6550 display element from the current position of IT. Value is zero if
6551 end of buffer (or C string) is reached. */
6553 static struct frame
*last_escape_glyph_frame
= NULL
;
6554 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6555 static int last_escape_glyph_merged_face_id
= 0;
6557 struct frame
*last_glyphless_glyph_frame
= NULL
;
6558 int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6559 int last_glyphless_glyph_merged_face_id
= 0;
6562 get_next_display_element (struct it
*it
)
6564 /* Non-zero means that we found a display element. Zero means that
6565 we hit the end of what we iterate over. Performance note: the
6566 function pointer `method' used here turns out to be faster than
6567 using a sequence of if-statements. */
6571 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6573 if (it
->what
== IT_CHARACTER
)
6575 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6576 and only if (a) the resolved directionality of that character
6578 /* FIXME: Do we need an exception for characters from display
6580 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6581 it
->c
= bidi_mirror_char (it
->c
);
6582 /* Map via display table or translate control characters.
6583 IT->c, IT->len etc. have been set to the next character by
6584 the function call above. If we have a display table, and it
6585 contains an entry for IT->c, translate it. Don't do this if
6586 IT->c itself comes from a display table, otherwise we could
6587 end up in an infinite recursion. (An alternative could be to
6588 count the recursion depth of this function and signal an
6589 error when a certain maximum depth is reached.) Is it worth
6591 if (success_p
&& it
->dpvec
== NULL
)
6594 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6595 int nonascii_space_p
= 0;
6596 int nonascii_hyphen_p
= 0;
6597 int c
= it
->c
; /* This is the character to display. */
6599 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6601 eassert (SINGLE_BYTE_CHAR_P (c
));
6602 if (unibyte_display_via_language_environment
)
6604 c
= DECODE_CHAR (unibyte
, c
);
6606 c
= BYTE8_TO_CHAR (it
->c
);
6609 c
= BYTE8_TO_CHAR (it
->c
);
6613 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6616 struct Lisp_Vector
*v
= XVECTOR (dv
);
6618 /* Return the first character from the display table
6619 entry, if not empty. If empty, don't display the
6620 current character. */
6623 it
->dpvec_char_len
= it
->len
;
6624 it
->dpvec
= v
->contents
;
6625 it
->dpend
= v
->contents
+ v
->header
.size
;
6626 it
->current
.dpvec_index
= 0;
6627 it
->dpvec_face_id
= -1;
6628 it
->saved_face_id
= it
->face_id
;
6629 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6634 set_iterator_to_next (it
, 0);
6639 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6641 if (it
->what
== IT_GLYPHLESS
)
6643 /* Don't display this character. */
6644 set_iterator_to_next (it
, 0);
6648 /* If `nobreak-char-display' is non-nil, we display
6649 non-ASCII spaces and hyphens specially. */
6650 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6653 nonascii_space_p
= 1;
6654 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6655 nonascii_hyphen_p
= 1;
6658 /* Translate control characters into `\003' or `^C' form.
6659 Control characters coming from a display table entry are
6660 currently not translated because we use IT->dpvec to hold
6661 the translation. This could easily be changed but I
6662 don't believe that it is worth doing.
6664 The characters handled by `nobreak-char-display' must be
6667 Non-printable characters and raw-byte characters are also
6668 translated to octal form. */
6669 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6670 ? (it
->area
!= TEXT_AREA
6671 /* In mode line, treat \n, \t like other crl chars. */
6674 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6675 || (c
!= '\n' && c
!= '\t'))
6677 || nonascii_hyphen_p
6679 || ! CHAR_PRINTABLE_P (c
))))
6681 /* C is a control character, non-ASCII space/hyphen,
6682 raw-byte, or a non-printable character which must be
6683 displayed either as '\003' or as `^C' where the '\\'
6684 and '^' can be defined in the display table. Fill
6685 IT->ctl_chars with glyphs for what we have to
6686 display. Then, set IT->dpvec to these glyphs. */
6693 /* Handle control characters with ^. */
6695 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6699 g
= '^'; /* default glyph for Control */
6700 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6702 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6704 g
= GLYPH_CODE_CHAR (gc
);
6705 lface_id
= GLYPH_CODE_FACE (gc
);
6709 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6711 else if (it
->f
== last_escape_glyph_frame
6712 && it
->face_id
== last_escape_glyph_face_id
)
6714 face_id
= last_escape_glyph_merged_face_id
;
6718 /* Merge the escape-glyph face into the current face. */
6719 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6721 last_escape_glyph_frame
= it
->f
;
6722 last_escape_glyph_face_id
= it
->face_id
;
6723 last_escape_glyph_merged_face_id
= face_id
;
6726 XSETINT (it
->ctl_chars
[0], g
);
6727 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6729 goto display_control
;
6732 /* Handle non-ascii space in the mode where it only gets
6735 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6737 /* Merge `nobreak-space' into the current face. */
6738 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6740 XSETINT (it
->ctl_chars
[0], ' ');
6742 goto display_control
;
6745 /* Handle sequences that start with the "escape glyph". */
6747 /* the default escape glyph is \. */
6748 escape_glyph
= '\\';
6751 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6753 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6754 lface_id
= GLYPH_CODE_FACE (gc
);
6758 /* The display table specified a face.
6759 Merge it into face_id and also into escape_glyph. */
6760 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6763 else if (it
->f
== last_escape_glyph_frame
6764 && it
->face_id
== last_escape_glyph_face_id
)
6766 face_id
= last_escape_glyph_merged_face_id
;
6770 /* Merge the escape-glyph face into the current face. */
6771 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6773 last_escape_glyph_frame
= it
->f
;
6774 last_escape_glyph_face_id
= it
->face_id
;
6775 last_escape_glyph_merged_face_id
= face_id
;
6778 /* Draw non-ASCII hyphen with just highlighting: */
6780 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6782 XSETINT (it
->ctl_chars
[0], '-');
6784 goto display_control
;
6787 /* Draw non-ASCII space/hyphen with escape glyph: */
6789 if (nonascii_space_p
|| nonascii_hyphen_p
)
6791 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6792 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
6794 goto display_control
;
6801 if (CHAR_BYTE8_P (c
))
6802 /* Display \200 instead of \17777600. */
6803 c
= CHAR_TO_BYTE8 (c
);
6804 len
= sprintf (str
, "%03o", c
);
6806 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6807 for (i
= 0; i
< len
; i
++)
6808 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6813 /* Set up IT->dpvec and return first character from it. */
6814 it
->dpvec_char_len
= it
->len
;
6815 it
->dpvec
= it
->ctl_chars
;
6816 it
->dpend
= it
->dpvec
+ ctl_len
;
6817 it
->current
.dpvec_index
= 0;
6818 it
->dpvec_face_id
= face_id
;
6819 it
->saved_face_id
= it
->face_id
;
6820 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6824 it
->char_to_display
= c
;
6828 it
->char_to_display
= it
->c
;
6832 /* Adjust face id for a multibyte character. There are no multibyte
6833 character in unibyte text. */
6834 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6837 && FRAME_WINDOW_P (it
->f
))
6839 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6841 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6843 /* Automatic composition with glyph-string. */
6844 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6846 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6850 ptrdiff_t pos
= (it
->s
? -1
6851 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6852 : IT_CHARPOS (*it
));
6855 if (it
->what
== IT_CHARACTER
)
6856 c
= it
->char_to_display
;
6859 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6863 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6864 /* TAB in a composition means display glyphs with
6865 padding space on the left or right. */
6866 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6869 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6874 /* Is this character the last one of a run of characters with
6875 box? If yes, set IT->end_of_box_run_p to 1. */
6879 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6881 int face_id
= underlying_face_id (it
);
6882 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6886 if (face
->box
== FACE_NO_BOX
)
6888 /* If the box comes from face properties in a
6889 display string, check faces in that string. */
6890 int string_face_id
= face_after_it_pos (it
);
6891 it
->end_of_box_run_p
6892 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6895 /* Otherwise, the box comes from the underlying face.
6896 If this is the last string character displayed, check
6897 the next buffer location. */
6898 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6899 && (it
->current
.overlay_string_index
6900 == it
->n_overlay_strings
- 1))
6904 struct text_pos pos
= it
->current
.pos
;
6905 INC_TEXT_POS (pos
, it
->multibyte_p
);
6907 next_face_id
= face_at_buffer_position
6908 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6909 it
->region_end_charpos
, &ignore
,
6910 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6912 it
->end_of_box_run_p
6913 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6920 int face_id
= face_after_it_pos (it
);
6921 it
->end_of_box_run_p
6922 = (face_id
!= it
->face_id
6923 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6926 /* If we reached the end of the object we've been iterating (e.g., a
6927 display string or an overlay string), and there's something on
6928 IT->stack, proceed with what's on the stack. It doesn't make
6929 sense to return zero if there's unprocessed stuff on the stack,
6930 because otherwise that stuff will never be displayed. */
6931 if (!success_p
&& it
->sp
> 0)
6933 set_iterator_to_next (it
, 0);
6934 success_p
= get_next_display_element (it
);
6937 /* Value is 0 if end of buffer or string reached. */
6942 /* Move IT to the next display element.
6944 RESEAT_P non-zero means if called on a newline in buffer text,
6945 skip to the next visible line start.
6947 Functions get_next_display_element and set_iterator_to_next are
6948 separate because I find this arrangement easier to handle than a
6949 get_next_display_element function that also increments IT's
6950 position. The way it is we can first look at an iterator's current
6951 display element, decide whether it fits on a line, and if it does,
6952 increment the iterator position. The other way around we probably
6953 would either need a flag indicating whether the iterator has to be
6954 incremented the next time, or we would have to implement a
6955 decrement position function which would not be easy to write. */
6958 set_iterator_to_next (struct it
*it
, int reseat_p
)
6960 /* Reset flags indicating start and end of a sequence of characters
6961 with box. Reset them at the start of this function because
6962 moving the iterator to a new position might set them. */
6963 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6967 case GET_FROM_BUFFER
:
6968 /* The current display element of IT is a character from
6969 current_buffer. Advance in the buffer, and maybe skip over
6970 invisible lines that are so because of selective display. */
6971 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6972 reseat_at_next_visible_line_start (it
, 0);
6973 else if (it
->cmp_it
.id
>= 0)
6975 /* We are currently getting glyphs from a composition. */
6980 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6981 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6982 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6984 it
->cmp_it
.from
= it
->cmp_it
.to
;
6989 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6991 it
->end_charpos
, Qnil
);
6994 else if (! it
->cmp_it
.reversed_p
)
6996 /* Composition created while scanning forward. */
6997 /* Update IT's char/byte positions to point to the first
6998 character of the next grapheme cluster, or to the
6999 character visually after the current composition. */
7000 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7001 bidi_move_to_visually_next (&it
->bidi_it
);
7002 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7003 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7005 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7007 /* Proceed to the next grapheme cluster. */
7008 it
->cmp_it
.from
= it
->cmp_it
.to
;
7012 /* No more grapheme clusters in this composition.
7013 Find the next stop position. */
7014 ptrdiff_t stop
= it
->end_charpos
;
7015 if (it
->bidi_it
.scan_dir
< 0)
7016 /* Now we are scanning backward and don't know
7019 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7020 IT_BYTEPOS (*it
), stop
, Qnil
);
7025 /* Composition created while scanning backward. */
7026 /* Update IT's char/byte positions to point to the last
7027 character of the previous grapheme cluster, or the
7028 character visually after the current composition. */
7029 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7030 bidi_move_to_visually_next (&it
->bidi_it
);
7031 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7032 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7033 if (it
->cmp_it
.from
> 0)
7035 /* Proceed to the previous grapheme cluster. */
7036 it
->cmp_it
.to
= it
->cmp_it
.from
;
7040 /* No more grapheme clusters in this composition.
7041 Find the next stop position. */
7042 ptrdiff_t stop
= it
->end_charpos
;
7043 if (it
->bidi_it
.scan_dir
< 0)
7044 /* Now we are scanning backward and don't know
7047 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7048 IT_BYTEPOS (*it
), stop
, Qnil
);
7054 eassert (it
->len
!= 0);
7058 IT_BYTEPOS (*it
) += it
->len
;
7059 IT_CHARPOS (*it
) += 1;
7063 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7064 /* If this is a new paragraph, determine its base
7065 direction (a.k.a. its base embedding level). */
7066 if (it
->bidi_it
.new_paragraph
)
7067 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7068 bidi_move_to_visually_next (&it
->bidi_it
);
7069 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7070 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7071 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7073 /* As the scan direction was changed, we must
7074 re-compute the stop position for composition. */
7075 ptrdiff_t stop
= it
->end_charpos
;
7076 if (it
->bidi_it
.scan_dir
< 0)
7078 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7079 IT_BYTEPOS (*it
), stop
, Qnil
);
7082 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7086 case GET_FROM_C_STRING
:
7087 /* Current display element of IT is from a C string. */
7089 /* If the string position is beyond string's end, it means
7090 next_element_from_c_string is padding the string with
7091 blanks, in which case we bypass the bidi iterator,
7092 because it cannot deal with such virtual characters. */
7093 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7095 IT_BYTEPOS (*it
) += it
->len
;
7096 IT_CHARPOS (*it
) += 1;
7100 bidi_move_to_visually_next (&it
->bidi_it
);
7101 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7102 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7106 case GET_FROM_DISPLAY_VECTOR
:
7107 /* Current display element of IT is from a display table entry.
7108 Advance in the display table definition. Reset it to null if
7109 end reached, and continue with characters from buffers/
7111 ++it
->current
.dpvec_index
;
7113 /* Restore face of the iterator to what they were before the
7114 display vector entry (these entries may contain faces). */
7115 it
->face_id
= it
->saved_face_id
;
7117 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7119 int recheck_faces
= it
->ellipsis_p
;
7122 it
->method
= GET_FROM_C_STRING
;
7123 else if (STRINGP (it
->string
))
7124 it
->method
= GET_FROM_STRING
;
7127 it
->method
= GET_FROM_BUFFER
;
7128 it
->object
= it
->w
->buffer
;
7132 it
->current
.dpvec_index
= -1;
7134 /* Skip over characters which were displayed via IT->dpvec. */
7135 if (it
->dpvec_char_len
< 0)
7136 reseat_at_next_visible_line_start (it
, 1);
7137 else if (it
->dpvec_char_len
> 0)
7139 if (it
->method
== GET_FROM_STRING
7140 && it
->n_overlay_strings
> 0)
7141 it
->ignore_overlay_strings_at_pos_p
= 1;
7142 it
->len
= it
->dpvec_char_len
;
7143 set_iterator_to_next (it
, reseat_p
);
7146 /* Maybe recheck faces after display vector */
7148 it
->stop_charpos
= IT_CHARPOS (*it
);
7152 case GET_FROM_STRING
:
7153 /* Current display element is a character from a Lisp string. */
7154 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7155 /* Don't advance past string end. These conditions are true
7156 when set_iterator_to_next is called at the end of
7157 get_next_display_element, in which case the Lisp string is
7158 already exhausted, and all we want is pop the iterator
7160 if (it
->current
.overlay_string_index
>= 0)
7162 /* This is an overlay string, so there's no padding with
7163 spaces, and the number of characters in the string is
7164 where the string ends. */
7165 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7166 goto consider_string_end
;
7170 /* Not an overlay string. There could be padding, so test
7171 against it->end_charpos . */
7172 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7173 goto consider_string_end
;
7175 if (it
->cmp_it
.id
>= 0)
7181 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7182 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7183 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7184 it
->cmp_it
.from
= it
->cmp_it
.to
;
7188 composition_compute_stop_pos (&it
->cmp_it
,
7189 IT_STRING_CHARPOS (*it
),
7190 IT_STRING_BYTEPOS (*it
),
7191 it
->end_charpos
, it
->string
);
7194 else if (! it
->cmp_it
.reversed_p
)
7196 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7197 bidi_move_to_visually_next (&it
->bidi_it
);
7198 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7199 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7201 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7202 it
->cmp_it
.from
= it
->cmp_it
.to
;
7205 ptrdiff_t stop
= it
->end_charpos
;
7206 if (it
->bidi_it
.scan_dir
< 0)
7208 composition_compute_stop_pos (&it
->cmp_it
,
7209 IT_STRING_CHARPOS (*it
),
7210 IT_STRING_BYTEPOS (*it
), stop
,
7216 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7217 bidi_move_to_visually_next (&it
->bidi_it
);
7218 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7219 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7220 if (it
->cmp_it
.from
> 0)
7221 it
->cmp_it
.to
= it
->cmp_it
.from
;
7224 ptrdiff_t stop
= it
->end_charpos
;
7225 if (it
->bidi_it
.scan_dir
< 0)
7227 composition_compute_stop_pos (&it
->cmp_it
,
7228 IT_STRING_CHARPOS (*it
),
7229 IT_STRING_BYTEPOS (*it
), stop
,
7237 /* If the string position is beyond string's end, it
7238 means next_element_from_string is padding the string
7239 with blanks, in which case we bypass the bidi
7240 iterator, because it cannot deal with such virtual
7242 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7244 IT_STRING_BYTEPOS (*it
) += it
->len
;
7245 IT_STRING_CHARPOS (*it
) += 1;
7249 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7251 bidi_move_to_visually_next (&it
->bidi_it
);
7252 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7253 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7254 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7256 ptrdiff_t stop
= it
->end_charpos
;
7258 if (it
->bidi_it
.scan_dir
< 0)
7260 composition_compute_stop_pos (&it
->cmp_it
,
7261 IT_STRING_CHARPOS (*it
),
7262 IT_STRING_BYTEPOS (*it
), stop
,
7268 consider_string_end
:
7270 if (it
->current
.overlay_string_index
>= 0)
7272 /* IT->string is an overlay string. Advance to the
7273 next, if there is one. */
7274 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7277 next_overlay_string (it
);
7279 setup_for_ellipsis (it
, 0);
7284 /* IT->string is not an overlay string. If we reached
7285 its end, and there is something on IT->stack, proceed
7286 with what is on the stack. This can be either another
7287 string, this time an overlay string, or a buffer. */
7288 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7292 if (it
->method
== GET_FROM_STRING
)
7293 goto consider_string_end
;
7298 case GET_FROM_IMAGE
:
7299 case GET_FROM_STRETCH
:
7300 /* The position etc with which we have to proceed are on
7301 the stack. The position may be at the end of a string,
7302 if the `display' property takes up the whole string. */
7303 eassert (it
->sp
> 0);
7305 if (it
->method
== GET_FROM_STRING
)
7306 goto consider_string_end
;
7310 /* There are no other methods defined, so this should be a bug. */
7314 eassert (it
->method
!= GET_FROM_STRING
7315 || (STRINGP (it
->string
)
7316 && IT_STRING_CHARPOS (*it
) >= 0));
7319 /* Load IT's display element fields with information about the next
7320 display element which comes from a display table entry or from the
7321 result of translating a control character to one of the forms `^C'
7324 IT->dpvec holds the glyphs to return as characters.
7325 IT->saved_face_id holds the face id before the display vector--it
7326 is restored into IT->face_id in set_iterator_to_next. */
7329 next_element_from_display_vector (struct it
*it
)
7334 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7336 it
->face_id
= it
->saved_face_id
;
7338 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7339 That seemed totally bogus - so I changed it... */
7340 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7342 if (GLYPH_CODE_P (gc
))
7344 it
->c
= GLYPH_CODE_CHAR (gc
);
7345 it
->len
= CHAR_BYTES (it
->c
);
7347 /* The entry may contain a face id to use. Such a face id is
7348 the id of a Lisp face, not a realized face. A face id of
7349 zero means no face is specified. */
7350 if (it
->dpvec_face_id
>= 0)
7351 it
->face_id
= it
->dpvec_face_id
;
7354 int lface_id
= GLYPH_CODE_FACE (gc
);
7356 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7361 /* Display table entry is invalid. Return a space. */
7362 it
->c
= ' ', it
->len
= 1;
7364 /* Don't change position and object of the iterator here. They are
7365 still the values of the character that had this display table
7366 entry or was translated, and that's what we want. */
7367 it
->what
= IT_CHARACTER
;
7371 /* Get the first element of string/buffer in the visual order, after
7372 being reseated to a new position in a string or a buffer. */
7374 get_visually_first_element (struct it
*it
)
7376 int string_p
= STRINGP (it
->string
) || it
->s
;
7377 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7378 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7380 if (STRINGP (it
->string
))
7382 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7383 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7387 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7388 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7391 if (it
->bidi_it
.charpos
== eob
)
7393 /* Nothing to do, but reset the FIRST_ELT flag, like
7394 bidi_paragraph_init does, because we are not going to
7396 it
->bidi_it
.first_elt
= 0;
7398 else if (it
->bidi_it
.charpos
== bob
7400 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7401 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7403 /* If we are at the beginning of a line/string, we can produce
7404 the next element right away. */
7405 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7406 bidi_move_to_visually_next (&it
->bidi_it
);
7410 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7412 /* We need to prime the bidi iterator starting at the line's or
7413 string's beginning, before we will be able to produce the
7416 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7419 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
7421 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
7423 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7426 /* Now return to buffer/string position where we were asked
7427 to get the next display element, and produce that. */
7428 bidi_move_to_visually_next (&it
->bidi_it
);
7430 while (it
->bidi_it
.bytepos
!= orig_bytepos
7431 && it
->bidi_it
.charpos
< eob
);
7434 /* Adjust IT's position information to where we ended up. */
7435 if (STRINGP (it
->string
))
7437 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7438 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7442 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7443 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7446 if (STRINGP (it
->string
) || !it
->s
)
7448 ptrdiff_t stop
, charpos
, bytepos
;
7450 if (STRINGP (it
->string
))
7453 stop
= SCHARS (it
->string
);
7454 if (stop
> it
->end_charpos
)
7455 stop
= it
->end_charpos
;
7456 charpos
= IT_STRING_CHARPOS (*it
);
7457 bytepos
= IT_STRING_BYTEPOS (*it
);
7461 stop
= it
->end_charpos
;
7462 charpos
= IT_CHARPOS (*it
);
7463 bytepos
= IT_BYTEPOS (*it
);
7465 if (it
->bidi_it
.scan_dir
< 0)
7467 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7472 /* Load IT with the next display element from Lisp string IT->string.
7473 IT->current.string_pos is the current position within the string.
7474 If IT->current.overlay_string_index >= 0, the Lisp string is an
7478 next_element_from_string (struct it
*it
)
7480 struct text_pos position
;
7482 eassert (STRINGP (it
->string
));
7483 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7484 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7485 position
= it
->current
.string_pos
;
7487 /* With bidi reordering, the character to display might not be the
7488 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7489 that we were reseat()ed to a new string, whose paragraph
7490 direction is not known. */
7491 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7493 get_visually_first_element (it
);
7494 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7497 /* Time to check for invisible text? */
7498 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7500 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7503 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7504 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7506 /* With bidi non-linear iteration, we could find
7507 ourselves far beyond the last computed stop_charpos,
7508 with several other stop positions in between that we
7509 missed. Scan them all now, in buffer's logical
7510 order, until we find and handle the last stop_charpos
7511 that precedes our current position. */
7512 handle_stop_backwards (it
, it
->stop_charpos
);
7513 return GET_NEXT_DISPLAY_ELEMENT (it
);
7519 /* Take note of the stop position we just moved
7520 across, for when we will move back across it. */
7521 it
->prev_stop
= it
->stop_charpos
;
7522 /* If we are at base paragraph embedding level, take
7523 note of the last stop position seen at this
7525 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7526 it
->base_level_stop
= it
->stop_charpos
;
7530 /* Since a handler may have changed IT->method, we must
7532 return GET_NEXT_DISPLAY_ELEMENT (it
);
7536 /* If we are before prev_stop, we may have overstepped
7537 on our way backwards a stop_pos, and if so, we need
7538 to handle that stop_pos. */
7539 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7540 /* We can sometimes back up for reasons that have nothing
7541 to do with bidi reordering. E.g., compositions. The
7542 code below is only needed when we are above the base
7543 embedding level, so test for that explicitly. */
7544 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7546 /* If we lost track of base_level_stop, we have no better
7547 place for handle_stop_backwards to start from than string
7548 beginning. This happens, e.g., when we were reseated to
7549 the previous screenful of text by vertical-motion. */
7550 if (it
->base_level_stop
<= 0
7551 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7552 it
->base_level_stop
= 0;
7553 handle_stop_backwards (it
, it
->base_level_stop
);
7554 return GET_NEXT_DISPLAY_ELEMENT (it
);
7558 if (it
->current
.overlay_string_index
>= 0)
7560 /* Get the next character from an overlay string. In overlay
7561 strings, there is no field width or padding with spaces to
7563 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7568 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7569 IT_STRING_BYTEPOS (*it
),
7570 it
->bidi_it
.scan_dir
< 0
7572 : SCHARS (it
->string
))
7573 && next_element_from_composition (it
))
7577 else if (STRING_MULTIBYTE (it
->string
))
7579 const unsigned char *s
= (SDATA (it
->string
)
7580 + IT_STRING_BYTEPOS (*it
));
7581 it
->c
= string_char_and_length (s
, &it
->len
);
7585 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7591 /* Get the next character from a Lisp string that is not an
7592 overlay string. Such strings come from the mode line, for
7593 example. We may have to pad with spaces, or truncate the
7594 string. See also next_element_from_c_string. */
7595 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7600 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7602 /* Pad with spaces. */
7603 it
->c
= ' ', it
->len
= 1;
7604 CHARPOS (position
) = BYTEPOS (position
) = -1;
7606 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7607 IT_STRING_BYTEPOS (*it
),
7608 it
->bidi_it
.scan_dir
< 0
7610 : it
->string_nchars
)
7611 && next_element_from_composition (it
))
7615 else if (STRING_MULTIBYTE (it
->string
))
7617 const unsigned char *s
= (SDATA (it
->string
)
7618 + IT_STRING_BYTEPOS (*it
));
7619 it
->c
= string_char_and_length (s
, &it
->len
);
7623 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7628 /* Record what we have and where it came from. */
7629 it
->what
= IT_CHARACTER
;
7630 it
->object
= it
->string
;
7631 it
->position
= position
;
7636 /* Load IT with next display element from C string IT->s.
7637 IT->string_nchars is the maximum number of characters to return
7638 from the string. IT->end_charpos may be greater than
7639 IT->string_nchars when this function is called, in which case we
7640 may have to return padding spaces. Value is zero if end of string
7641 reached, including padding spaces. */
7644 next_element_from_c_string (struct it
*it
)
7649 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7650 it
->what
= IT_CHARACTER
;
7651 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7654 /* With bidi reordering, the character to display might not be the
7655 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7656 we were reseated to a new string, whose paragraph direction is
7658 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7659 get_visually_first_element (it
);
7661 /* IT's position can be greater than IT->string_nchars in case a
7662 field width or precision has been specified when the iterator was
7664 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7666 /* End of the game. */
7670 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7672 /* Pad with spaces. */
7673 it
->c
= ' ', it
->len
= 1;
7674 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7676 else if (it
->multibyte_p
)
7677 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7679 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7685 /* Set up IT to return characters from an ellipsis, if appropriate.
7686 The definition of the ellipsis glyphs may come from a display table
7687 entry. This function fills IT with the first glyph from the
7688 ellipsis if an ellipsis is to be displayed. */
7691 next_element_from_ellipsis (struct it
*it
)
7693 if (it
->selective_display_ellipsis_p
)
7694 setup_for_ellipsis (it
, it
->len
);
7697 /* The face at the current position may be different from the
7698 face we find after the invisible text. Remember what it
7699 was in IT->saved_face_id, and signal that it's there by
7700 setting face_before_selective_p. */
7701 it
->saved_face_id
= it
->face_id
;
7702 it
->method
= GET_FROM_BUFFER
;
7703 it
->object
= it
->w
->buffer
;
7704 reseat_at_next_visible_line_start (it
, 1);
7705 it
->face_before_selective_p
= 1;
7708 return GET_NEXT_DISPLAY_ELEMENT (it
);
7712 /* Deliver an image display element. The iterator IT is already
7713 filled with image information (done in handle_display_prop). Value
7718 next_element_from_image (struct it
*it
)
7720 it
->what
= IT_IMAGE
;
7721 it
->ignore_overlay_strings_at_pos_p
= 0;
7726 /* Fill iterator IT with next display element from a stretch glyph
7727 property. IT->object is the value of the text property. Value is
7731 next_element_from_stretch (struct it
*it
)
7733 it
->what
= IT_STRETCH
;
7737 /* Scan backwards from IT's current position until we find a stop
7738 position, or until BEGV. This is called when we find ourself
7739 before both the last known prev_stop and base_level_stop while
7740 reordering bidirectional text. */
7743 compute_stop_pos_backwards (struct it
*it
)
7745 const int SCAN_BACK_LIMIT
= 1000;
7746 struct text_pos pos
;
7747 struct display_pos save_current
= it
->current
;
7748 struct text_pos save_position
= it
->position
;
7749 ptrdiff_t charpos
= IT_CHARPOS (*it
);
7750 ptrdiff_t where_we_are
= charpos
;
7751 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
7752 ptrdiff_t save_end_pos
= it
->end_charpos
;
7754 eassert (NILP (it
->string
) && !it
->s
);
7755 eassert (it
->bidi_p
);
7759 it
->end_charpos
= min (charpos
+ 1, ZV
);
7760 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7761 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
7762 reseat_1 (it
, pos
, 0);
7763 compute_stop_pos (it
);
7764 /* We must advance forward, right? */
7765 if (it
->stop_charpos
<= charpos
)
7768 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7770 if (it
->stop_charpos
<= where_we_are
)
7771 it
->prev_stop
= it
->stop_charpos
;
7773 it
->prev_stop
= BEGV
;
7775 it
->current
= save_current
;
7776 it
->position
= save_position
;
7777 it
->stop_charpos
= save_stop_pos
;
7778 it
->end_charpos
= save_end_pos
;
7781 /* Scan forward from CHARPOS in the current buffer/string, until we
7782 find a stop position > current IT's position. Then handle the stop
7783 position before that. This is called when we bump into a stop
7784 position while reordering bidirectional text. CHARPOS should be
7785 the last previously processed stop_pos (or BEGV/0, if none were
7786 processed yet) whose position is less that IT's current
7790 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
7792 int bufp
= !STRINGP (it
->string
);
7793 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7794 struct display_pos save_current
= it
->current
;
7795 struct text_pos save_position
= it
->position
;
7796 struct text_pos pos1
;
7797 ptrdiff_t next_stop
;
7799 /* Scan in strict logical order. */
7800 eassert (it
->bidi_p
);
7804 it
->prev_stop
= charpos
;
7807 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7808 reseat_1 (it
, pos1
, 0);
7811 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7812 compute_stop_pos (it
);
7813 /* We must advance forward, right? */
7814 if (it
->stop_charpos
<= it
->prev_stop
)
7816 charpos
= it
->stop_charpos
;
7818 while (charpos
<= where_we_are
);
7821 it
->current
= save_current
;
7822 it
->position
= save_position
;
7823 next_stop
= it
->stop_charpos
;
7824 it
->stop_charpos
= it
->prev_stop
;
7826 it
->stop_charpos
= next_stop
;
7829 /* Load IT with the next display element from current_buffer. Value
7830 is zero if end of buffer reached. IT->stop_charpos is the next
7831 position at which to stop and check for text properties or buffer
7835 next_element_from_buffer (struct it
*it
)
7839 eassert (IT_CHARPOS (*it
) >= BEGV
);
7840 eassert (NILP (it
->string
) && !it
->s
);
7841 eassert (!it
->bidi_p
7842 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7843 && it
->bidi_it
.string
.s
== NULL
));
7845 /* With bidi reordering, the character to display might not be the
7846 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7847 we were reseat()ed to a new buffer position, which is potentially
7848 a different paragraph. */
7849 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7851 get_visually_first_element (it
);
7852 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7855 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7857 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7859 int overlay_strings_follow_p
;
7861 /* End of the game, except when overlay strings follow that
7862 haven't been returned yet. */
7863 if (it
->overlay_strings_at_end_processed_p
)
7864 overlay_strings_follow_p
= 0;
7867 it
->overlay_strings_at_end_processed_p
= 1;
7868 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7871 if (overlay_strings_follow_p
)
7872 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7876 it
->position
= it
->current
.pos
;
7880 else if (!(!it
->bidi_p
7881 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7882 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7884 /* With bidi non-linear iteration, we could find ourselves
7885 far beyond the last computed stop_charpos, with several
7886 other stop positions in between that we missed. Scan
7887 them all now, in buffer's logical order, until we find
7888 and handle the last stop_charpos that precedes our
7889 current position. */
7890 handle_stop_backwards (it
, it
->stop_charpos
);
7891 return GET_NEXT_DISPLAY_ELEMENT (it
);
7897 /* Take note of the stop position we just moved across,
7898 for when we will move back across it. */
7899 it
->prev_stop
= it
->stop_charpos
;
7900 /* If we are at base paragraph embedding level, take
7901 note of the last stop position seen at this
7903 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7904 it
->base_level_stop
= it
->stop_charpos
;
7907 return GET_NEXT_DISPLAY_ELEMENT (it
);
7911 /* If we are before prev_stop, we may have overstepped on
7912 our way backwards a stop_pos, and if so, we need to
7913 handle that stop_pos. */
7914 && IT_CHARPOS (*it
) < it
->prev_stop
7915 /* We can sometimes back up for reasons that have nothing
7916 to do with bidi reordering. E.g., compositions. The
7917 code below is only needed when we are above the base
7918 embedding level, so test for that explicitly. */
7919 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7921 if (it
->base_level_stop
<= 0
7922 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7924 /* If we lost track of base_level_stop, we need to find
7925 prev_stop by looking backwards. This happens, e.g., when
7926 we were reseated to the previous screenful of text by
7928 it
->base_level_stop
= BEGV
;
7929 compute_stop_pos_backwards (it
);
7930 handle_stop_backwards (it
, it
->prev_stop
);
7933 handle_stop_backwards (it
, it
->base_level_stop
);
7934 return GET_NEXT_DISPLAY_ELEMENT (it
);
7938 /* No face changes, overlays etc. in sight, so just return a
7939 character from current_buffer. */
7943 /* Maybe run the redisplay end trigger hook. Performance note:
7944 This doesn't seem to cost measurable time. */
7945 if (it
->redisplay_end_trigger_charpos
7947 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7948 run_redisplay_end_trigger_hook (it
);
7950 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7951 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7953 && next_element_from_composition (it
))
7958 /* Get the next character, maybe multibyte. */
7959 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7960 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7961 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7963 it
->c
= *p
, it
->len
= 1;
7965 /* Record what we have and where it came from. */
7966 it
->what
= IT_CHARACTER
;
7967 it
->object
= it
->w
->buffer
;
7968 it
->position
= it
->current
.pos
;
7970 /* Normally we return the character found above, except when we
7971 really want to return an ellipsis for selective display. */
7976 /* A value of selective > 0 means hide lines indented more
7977 than that number of columns. */
7978 if (it
->selective
> 0
7979 && IT_CHARPOS (*it
) + 1 < ZV
7980 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7981 IT_BYTEPOS (*it
) + 1,
7984 success_p
= next_element_from_ellipsis (it
);
7985 it
->dpvec_char_len
= -1;
7988 else if (it
->c
== '\r' && it
->selective
== -1)
7990 /* A value of selective == -1 means that everything from the
7991 CR to the end of the line is invisible, with maybe an
7992 ellipsis displayed for it. */
7993 success_p
= next_element_from_ellipsis (it
);
7994 it
->dpvec_char_len
= -1;
7999 /* Value is zero if end of buffer reached. */
8000 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8005 /* Run the redisplay end trigger hook for IT. */
8008 run_redisplay_end_trigger_hook (struct it
*it
)
8010 Lisp_Object args
[3];
8012 /* IT->glyph_row should be non-null, i.e. we should be actually
8013 displaying something, or otherwise we should not run the hook. */
8014 eassert (it
->glyph_row
);
8016 /* Set up hook arguments. */
8017 args
[0] = Qredisplay_end_trigger_functions
;
8018 args
[1] = it
->window
;
8019 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8020 it
->redisplay_end_trigger_charpos
= 0;
8022 /* Since we are *trying* to run these functions, don't try to run
8023 them again, even if they get an error. */
8024 wset_redisplay_end_trigger (it
->w
, Qnil
);
8025 Frun_hook_with_args (3, args
);
8027 /* Notice if it changed the face of the character we are on. */
8028 handle_face_prop (it
);
8032 /* Deliver a composition display element. Unlike the other
8033 next_element_from_XXX, this function is not registered in the array
8034 get_next_element[]. It is called from next_element_from_buffer and
8035 next_element_from_string when necessary. */
8038 next_element_from_composition (struct it
*it
)
8040 it
->what
= IT_COMPOSITION
;
8041 it
->len
= it
->cmp_it
.nbytes
;
8042 if (STRINGP (it
->string
))
8046 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8047 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8050 it
->position
= it
->current
.string_pos
;
8051 it
->object
= it
->string
;
8052 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8053 IT_STRING_BYTEPOS (*it
), it
->string
);
8059 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8060 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8063 if (it
->bidi_it
.new_paragraph
)
8064 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8065 /* Resync the bidi iterator with IT's new position.
8066 FIXME: this doesn't support bidirectional text. */
8067 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8068 bidi_move_to_visually_next (&it
->bidi_it
);
8072 it
->position
= it
->current
.pos
;
8073 it
->object
= it
->w
->buffer
;
8074 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8075 IT_BYTEPOS (*it
), Qnil
);
8082 /***********************************************************************
8083 Moving an iterator without producing glyphs
8084 ***********************************************************************/
8086 /* Check if iterator is at a position corresponding to a valid buffer
8087 position after some move_it_ call. */
8089 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8090 ((it)->method == GET_FROM_STRING \
8091 ? IT_STRING_CHARPOS (*it) == 0 \
8095 /* Move iterator IT to a specified buffer or X position within one
8096 line on the display without producing glyphs.
8098 OP should be a bit mask including some or all of these bits:
8099 MOVE_TO_X: Stop upon reaching x-position TO_X.
8100 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8101 Regardless of OP's value, stop upon reaching the end of the display line.
8103 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8104 This means, in particular, that TO_X includes window's horizontal
8107 The return value has several possible values that
8108 say what condition caused the scan to stop:
8110 MOVE_POS_MATCH_OR_ZV
8111 - when TO_POS or ZV was reached.
8114 -when TO_X was reached before TO_POS or ZV were reached.
8117 - when we reached the end of the display area and the line must
8121 - when we reached the end of the display area and the line is
8125 - when we stopped at a line end, i.e. a newline or a CR and selective
8128 static enum move_it_result
8129 move_it_in_display_line_to (struct it
*it
,
8130 ptrdiff_t to_charpos
, int to_x
,
8131 enum move_operation_enum op
)
8133 enum move_it_result result
= MOVE_UNDEFINED
;
8134 struct glyph_row
*saved_glyph_row
;
8135 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8136 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8137 void *ppos_data
= NULL
;
8139 enum it_method prev_method
= it
->method
;
8140 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
8141 int saw_smaller_pos
= prev_pos
< to_charpos
;
8143 /* Don't produce glyphs in produce_glyphs. */
8144 saved_glyph_row
= it
->glyph_row
;
8145 it
->glyph_row
= NULL
;
8147 /* Use wrap_it to save a copy of IT wherever a word wrap could
8148 occur. Use atpos_it to save a copy of IT at the desired buffer
8149 position, if found, so that we can scan ahead and check if the
8150 word later overshoots the window edge. Use atx_it similarly, for
8156 /* Use ppos_it under bidi reordering to save a copy of IT for the
8157 position > CHARPOS that is the closest to CHARPOS. We restore
8158 that position in IT when we have scanned the entire display line
8159 without finding a match for CHARPOS and all the character
8160 positions are greater than CHARPOS. */
8163 SAVE_IT (ppos_it
, *it
, ppos_data
);
8164 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
8165 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8166 SAVE_IT (ppos_it
, *it
, ppos_data
);
8169 #define BUFFER_POS_REACHED_P() \
8170 ((op & MOVE_TO_POS) != 0 \
8171 && BUFFERP (it->object) \
8172 && (IT_CHARPOS (*it) == to_charpos \
8174 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8175 && IT_CHARPOS (*it) > to_charpos) \
8176 || (it->what == IT_COMPOSITION \
8177 && ((IT_CHARPOS (*it) > to_charpos \
8178 && to_charpos >= it->cmp_it.charpos) \
8179 || (IT_CHARPOS (*it) < to_charpos \
8180 && to_charpos <= it->cmp_it.charpos)))) \
8181 && (it->method == GET_FROM_BUFFER \
8182 || (it->method == GET_FROM_DISPLAY_VECTOR \
8183 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8185 /* If there's a line-/wrap-prefix, handle it. */
8186 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8187 && it
->current_y
< it
->last_visible_y
)
8188 handle_line_prefix (it
);
8190 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8191 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8195 int x
, i
, ascent
= 0, descent
= 0;
8197 /* Utility macro to reset an iterator with x, ascent, and descent. */
8198 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8199 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8200 (IT)->max_descent = descent)
8202 /* Stop if we move beyond TO_CHARPOS (after an image or a
8203 display string or stretch glyph). */
8204 if ((op
& MOVE_TO_POS
) != 0
8205 && BUFFERP (it
->object
)
8206 && it
->method
== GET_FROM_BUFFER
8208 /* When the iterator is at base embedding level, we
8209 are guaranteed that characters are delivered for
8210 display in strictly increasing order of their
8211 buffer positions. */
8212 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8213 && IT_CHARPOS (*it
) > to_charpos
)
8215 && (prev_method
== GET_FROM_IMAGE
8216 || prev_method
== GET_FROM_STRETCH
8217 || prev_method
== GET_FROM_STRING
)
8218 /* Passed TO_CHARPOS from left to right. */
8219 && ((prev_pos
< to_charpos
8220 && IT_CHARPOS (*it
) > to_charpos
)
8221 /* Passed TO_CHARPOS from right to left. */
8222 || (prev_pos
> to_charpos
8223 && IT_CHARPOS (*it
) < to_charpos
)))))
8225 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8227 result
= MOVE_POS_MATCH_OR_ZV
;
8230 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8231 /* If wrap_it is valid, the current position might be in a
8232 word that is wrapped. So, save the iterator in
8233 atpos_it and continue to see if wrapping happens. */
8234 SAVE_IT (atpos_it
, *it
, atpos_data
);
8237 /* Stop when ZV reached.
8238 We used to stop here when TO_CHARPOS reached as well, but that is
8239 too soon if this glyph does not fit on this line. So we handle it
8240 explicitly below. */
8241 if (!get_next_display_element (it
))
8243 result
= MOVE_POS_MATCH_OR_ZV
;
8247 if (it
->line_wrap
== TRUNCATE
)
8249 if (BUFFER_POS_REACHED_P ())
8251 result
= MOVE_POS_MATCH_OR_ZV
;
8257 if (it
->line_wrap
== WORD_WRAP
)
8259 if (IT_DISPLAYING_WHITESPACE (it
))
8263 /* We have reached a glyph that follows one or more
8264 whitespace characters. If the position is
8265 already found, we are done. */
8266 if (atpos_it
.sp
>= 0)
8268 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8269 result
= MOVE_POS_MATCH_OR_ZV
;
8274 RESTORE_IT (it
, &atx_it
, atx_data
);
8275 result
= MOVE_X_REACHED
;
8278 /* Otherwise, we can wrap here. */
8279 SAVE_IT (wrap_it
, *it
, wrap_data
);
8285 /* Remember the line height for the current line, in case
8286 the next element doesn't fit on the line. */
8287 ascent
= it
->max_ascent
;
8288 descent
= it
->max_descent
;
8290 /* The call to produce_glyphs will get the metrics of the
8291 display element IT is loaded with. Record the x-position
8292 before this display element, in case it doesn't fit on the
8296 PRODUCE_GLYPHS (it
);
8298 if (it
->area
!= TEXT_AREA
)
8300 prev_method
= it
->method
;
8301 if (it
->method
== GET_FROM_BUFFER
)
8302 prev_pos
= IT_CHARPOS (*it
);
8303 set_iterator_to_next (it
, 1);
8304 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8305 SET_TEXT_POS (this_line_min_pos
,
8306 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8308 && (op
& MOVE_TO_POS
)
8309 && IT_CHARPOS (*it
) > to_charpos
8310 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8311 SAVE_IT (ppos_it
, *it
, ppos_data
);
8315 /* The number of glyphs we get back in IT->nglyphs will normally
8316 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8317 character on a terminal frame, or (iii) a line end. For the
8318 second case, IT->nglyphs - 1 padding glyphs will be present.
8319 (On X frames, there is only one glyph produced for a
8320 composite character.)
8322 The behavior implemented below means, for continuation lines,
8323 that as many spaces of a TAB as fit on the current line are
8324 displayed there. For terminal frames, as many glyphs of a
8325 multi-glyph character are displayed in the current line, too.
8326 This is what the old redisplay code did, and we keep it that
8327 way. Under X, the whole shape of a complex character must
8328 fit on the line or it will be completely displayed in the
8331 Note that both for tabs and padding glyphs, all glyphs have
8335 /* More than one glyph or glyph doesn't fit on line. All
8336 glyphs have the same width. */
8337 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8339 int x_before_this_char
= x
;
8340 int hpos_before_this_char
= it
->hpos
;
8342 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8344 new_x
= x
+ single_glyph_width
;
8346 /* We want to leave anything reaching TO_X to the caller. */
8347 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8349 if (BUFFER_POS_REACHED_P ())
8351 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8352 goto buffer_pos_reached
;
8353 if (atpos_it
.sp
< 0)
8355 SAVE_IT (atpos_it
, *it
, atpos_data
);
8356 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8361 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8364 result
= MOVE_X_REACHED
;
8369 SAVE_IT (atx_it
, *it
, atx_data
);
8370 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8375 if (/* Lines are continued. */
8376 it
->line_wrap
!= TRUNCATE
8377 && (/* And glyph doesn't fit on the line. */
8378 new_x
> it
->last_visible_x
8379 /* Or it fits exactly and we're on a window
8381 || (new_x
== it
->last_visible_x
8382 && FRAME_WINDOW_P (it
->f
)
8383 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8384 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8385 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8387 if (/* IT->hpos == 0 means the very first glyph
8388 doesn't fit on the line, e.g. a wide image. */
8390 || (new_x
== it
->last_visible_x
8391 && FRAME_WINDOW_P (it
->f
)))
8394 it
->current_x
= new_x
;
8396 /* The character's last glyph just barely fits
8398 if (i
== it
->nglyphs
- 1)
8400 /* If this is the destination position,
8401 return a position *before* it in this row,
8402 now that we know it fits in this row. */
8403 if (BUFFER_POS_REACHED_P ())
8405 if (it
->line_wrap
!= WORD_WRAP
8408 it
->hpos
= hpos_before_this_char
;
8409 it
->current_x
= x_before_this_char
;
8410 result
= MOVE_POS_MATCH_OR_ZV
;
8413 if (it
->line_wrap
== WORD_WRAP
8416 SAVE_IT (atpos_it
, *it
, atpos_data
);
8417 atpos_it
.current_x
= x_before_this_char
;
8418 atpos_it
.hpos
= hpos_before_this_char
;
8422 prev_method
= it
->method
;
8423 if (it
->method
== GET_FROM_BUFFER
)
8424 prev_pos
= IT_CHARPOS (*it
);
8425 set_iterator_to_next (it
, 1);
8426 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8427 SET_TEXT_POS (this_line_min_pos
,
8428 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8429 /* On graphical terminals, newlines may
8430 "overflow" into the fringe if
8431 overflow-newline-into-fringe is non-nil.
8432 On text terminals, and on graphical
8433 terminals with no right margin, newlines
8434 may overflow into the last glyph on the
8436 if (!FRAME_WINDOW_P (it
->f
)
8438 && it
->bidi_it
.paragraph_dir
== R2L
)
8439 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8440 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8441 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8443 if (!get_next_display_element (it
))
8445 result
= MOVE_POS_MATCH_OR_ZV
;
8448 if (BUFFER_POS_REACHED_P ())
8450 if (ITERATOR_AT_END_OF_LINE_P (it
))
8451 result
= MOVE_POS_MATCH_OR_ZV
;
8453 result
= MOVE_LINE_CONTINUED
;
8456 if (ITERATOR_AT_END_OF_LINE_P (it
))
8458 result
= MOVE_NEWLINE_OR_CR
;
8465 IT_RESET_X_ASCENT_DESCENT (it
);
8467 if (wrap_it
.sp
>= 0)
8469 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8474 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8476 result
= MOVE_LINE_CONTINUED
;
8480 if (BUFFER_POS_REACHED_P ())
8482 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8483 goto buffer_pos_reached
;
8484 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8486 SAVE_IT (atpos_it
, *it
, atpos_data
);
8487 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8491 if (new_x
> it
->first_visible_x
)
8493 /* Glyph is visible. Increment number of glyphs that
8494 would be displayed. */
8499 if (result
!= MOVE_UNDEFINED
)
8502 else if (BUFFER_POS_REACHED_P ())
8505 IT_RESET_X_ASCENT_DESCENT (it
);
8506 result
= MOVE_POS_MATCH_OR_ZV
;
8509 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8511 /* Stop when TO_X specified and reached. This check is
8512 necessary here because of lines consisting of a line end,
8513 only. The line end will not produce any glyphs and we
8514 would never get MOVE_X_REACHED. */
8515 eassert (it
->nglyphs
== 0);
8516 result
= MOVE_X_REACHED
;
8520 /* Is this a line end? If yes, we're done. */
8521 if (ITERATOR_AT_END_OF_LINE_P (it
))
8523 /* If we are past TO_CHARPOS, but never saw any character
8524 positions smaller than TO_CHARPOS, return
8525 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8527 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8529 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8531 if (IT_CHARPOS (ppos_it
) < ZV
)
8533 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8534 result
= MOVE_POS_MATCH_OR_ZV
;
8537 goto buffer_pos_reached
;
8539 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8540 && IT_CHARPOS (*it
) > to_charpos
)
8541 goto buffer_pos_reached
;
8543 result
= MOVE_NEWLINE_OR_CR
;
8546 result
= MOVE_NEWLINE_OR_CR
;
8550 prev_method
= it
->method
;
8551 if (it
->method
== GET_FROM_BUFFER
)
8552 prev_pos
= IT_CHARPOS (*it
);
8553 /* The current display element has been consumed. Advance
8555 set_iterator_to_next (it
, 1);
8556 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8557 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8558 if (IT_CHARPOS (*it
) < to_charpos
)
8559 saw_smaller_pos
= 1;
8561 && (op
& MOVE_TO_POS
)
8562 && IT_CHARPOS (*it
) >= to_charpos
8563 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8564 SAVE_IT (ppos_it
, *it
, ppos_data
);
8566 /* Stop if lines are truncated and IT's current x-position is
8567 past the right edge of the window now. */
8568 if (it
->line_wrap
== TRUNCATE
8569 && it
->current_x
>= it
->last_visible_x
)
8571 if (!FRAME_WINDOW_P (it
->f
)
8572 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8573 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8574 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8575 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8579 if ((at_eob_p
= !get_next_display_element (it
))
8580 || BUFFER_POS_REACHED_P ()
8581 /* If we are past TO_CHARPOS, but never saw any
8582 character positions smaller than TO_CHARPOS,
8583 return MOVE_POS_MATCH_OR_ZV, like the
8584 unidirectional display did. */
8585 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8587 && IT_CHARPOS (*it
) > to_charpos
))
8590 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8591 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8592 result
= MOVE_POS_MATCH_OR_ZV
;
8595 if (ITERATOR_AT_END_OF_LINE_P (it
))
8597 result
= MOVE_NEWLINE_OR_CR
;
8601 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8603 && IT_CHARPOS (*it
) > to_charpos
)
8605 if (IT_CHARPOS (ppos_it
) < ZV
)
8606 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8607 result
= MOVE_POS_MATCH_OR_ZV
;
8610 result
= MOVE_LINE_TRUNCATED
;
8613 #undef IT_RESET_X_ASCENT_DESCENT
8616 #undef BUFFER_POS_REACHED_P
8618 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8619 restore the saved iterator. */
8620 if (atpos_it
.sp
>= 0)
8621 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8622 else if (atx_it
.sp
>= 0)
8623 RESTORE_IT (it
, &atx_it
, atx_data
);
8628 bidi_unshelve_cache (atpos_data
, 1);
8630 bidi_unshelve_cache (atx_data
, 1);
8632 bidi_unshelve_cache (wrap_data
, 1);
8634 bidi_unshelve_cache (ppos_data
, 1);
8636 /* Restore the iterator settings altered at the beginning of this
8638 it
->glyph_row
= saved_glyph_row
;
8642 /* For external use. */
8644 move_it_in_display_line (struct it
*it
,
8645 ptrdiff_t to_charpos
, int to_x
,
8646 enum move_operation_enum op
)
8648 if (it
->line_wrap
== WORD_WRAP
8649 && (op
& MOVE_TO_X
))
8652 void *save_data
= NULL
;
8655 SAVE_IT (save_it
, *it
, save_data
);
8656 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8657 /* When word-wrap is on, TO_X may lie past the end
8658 of a wrapped line. Then it->current is the
8659 character on the next line, so backtrack to the
8660 space before the wrap point. */
8661 if (skip
== MOVE_LINE_CONTINUED
)
8663 int prev_x
= max (it
->current_x
- 1, 0);
8664 RESTORE_IT (it
, &save_it
, save_data
);
8665 move_it_in_display_line_to
8666 (it
, -1, prev_x
, MOVE_TO_X
);
8669 bidi_unshelve_cache (save_data
, 1);
8672 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8676 /* Move IT forward until it satisfies one or more of the criteria in
8677 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8679 OP is a bit-mask that specifies where to stop, and in particular,
8680 which of those four position arguments makes a difference. See the
8681 description of enum move_operation_enum.
8683 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8684 screen line, this function will set IT to the next position that is
8685 displayed to the right of TO_CHARPOS on the screen. */
8688 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8690 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8691 int line_height
, line_start_x
= 0, reached
= 0;
8692 void *backup_data
= NULL
;
8696 if (op
& MOVE_TO_VPOS
)
8698 /* If no TO_CHARPOS and no TO_X specified, stop at the
8699 start of the line TO_VPOS. */
8700 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8702 if (it
->vpos
== to_vpos
)
8708 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8712 /* TO_VPOS >= 0 means stop at TO_X in the line at
8713 TO_VPOS, or at TO_POS, whichever comes first. */
8714 if (it
->vpos
== to_vpos
)
8720 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8722 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8727 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8729 /* We have reached TO_X but not in the line we want. */
8730 skip
= move_it_in_display_line_to (it
, to_charpos
,
8732 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8740 else if (op
& MOVE_TO_Y
)
8742 struct it it_backup
;
8744 if (it
->line_wrap
== WORD_WRAP
)
8745 SAVE_IT (it_backup
, *it
, backup_data
);
8747 /* TO_Y specified means stop at TO_X in the line containing
8748 TO_Y---or at TO_CHARPOS if this is reached first. The
8749 problem is that we can't really tell whether the line
8750 contains TO_Y before we have completely scanned it, and
8751 this may skip past TO_X. What we do is to first scan to
8754 If TO_X is not specified, use a TO_X of zero. The reason
8755 is to make the outcome of this function more predictable.
8756 If we didn't use TO_X == 0, we would stop at the end of
8757 the line which is probably not what a caller would expect
8759 skip
= move_it_in_display_line_to
8760 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8761 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8763 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8764 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8766 else if (skip
== MOVE_X_REACHED
)
8768 /* If TO_X was reached, we want to know whether TO_Y is
8769 in the line. We know this is the case if the already
8770 scanned glyphs make the line tall enough. Otherwise,
8771 we must check by scanning the rest of the line. */
8772 line_height
= it
->max_ascent
+ it
->max_descent
;
8773 if (to_y
>= it
->current_y
8774 && to_y
< it
->current_y
+ line_height
)
8779 SAVE_IT (it_backup
, *it
, backup_data
);
8780 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8781 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8783 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8784 line_height
= it
->max_ascent
+ it
->max_descent
;
8785 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8787 if (to_y
>= it
->current_y
8788 && to_y
< it
->current_y
+ line_height
)
8790 /* If TO_Y is in this line and TO_X was reached
8791 above, we scanned too far. We have to restore
8792 IT's settings to the ones before skipping. But
8793 keep the more accurate values of max_ascent and
8794 max_descent we've found while skipping the rest
8795 of the line, for the sake of callers, such as
8796 pos_visible_p, that need to know the line
8798 int max_ascent
= it
->max_ascent
;
8799 int max_descent
= it
->max_descent
;
8801 RESTORE_IT (it
, &it_backup
, backup_data
);
8802 it
->max_ascent
= max_ascent
;
8803 it
->max_descent
= max_descent
;
8809 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8815 /* Check whether TO_Y is in this line. */
8816 line_height
= it
->max_ascent
+ it
->max_descent
;
8817 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8819 if (to_y
>= it
->current_y
8820 && to_y
< it
->current_y
+ line_height
)
8822 /* When word-wrap is on, TO_X may lie past the end
8823 of a wrapped line. Then it->current is the
8824 character on the next line, so backtrack to the
8825 space before the wrap point. */
8826 if (skip
== MOVE_LINE_CONTINUED
8827 && it
->line_wrap
== WORD_WRAP
)
8829 int prev_x
= max (it
->current_x
- 1, 0);
8830 RESTORE_IT (it
, &it_backup
, backup_data
);
8831 skip
= move_it_in_display_line_to
8832 (it
, -1, prev_x
, MOVE_TO_X
);
8841 else if (BUFFERP (it
->object
)
8842 && (it
->method
== GET_FROM_BUFFER
8843 || it
->method
== GET_FROM_STRETCH
)
8844 && IT_CHARPOS (*it
) >= to_charpos
8845 /* Under bidi iteration, a call to set_iterator_to_next
8846 can scan far beyond to_charpos if the initial
8847 portion of the next line needs to be reordered. In
8848 that case, give move_it_in_display_line_to another
8851 && it
->bidi_it
.scan_dir
== -1))
8852 skip
= MOVE_POS_MATCH_OR_ZV
;
8854 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8858 case MOVE_POS_MATCH_OR_ZV
:
8862 case MOVE_NEWLINE_OR_CR
:
8863 set_iterator_to_next (it
, 1);
8864 it
->continuation_lines_width
= 0;
8867 case MOVE_LINE_TRUNCATED
:
8868 it
->continuation_lines_width
= 0;
8869 reseat_at_next_visible_line_start (it
, 0);
8870 if ((op
& MOVE_TO_POS
) != 0
8871 && IT_CHARPOS (*it
) > to_charpos
)
8878 case MOVE_LINE_CONTINUED
:
8879 /* For continued lines ending in a tab, some of the glyphs
8880 associated with the tab are displayed on the current
8881 line. Since it->current_x does not include these glyphs,
8882 we use it->last_visible_x instead. */
8885 it
->continuation_lines_width
+= it
->last_visible_x
;
8886 /* When moving by vpos, ensure that the iterator really
8887 advances to the next line (bug#847, bug#969). Fixme:
8888 do we need to do this in other circumstances? */
8889 if (it
->current_x
!= it
->last_visible_x
8890 && (op
& MOVE_TO_VPOS
)
8891 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8893 line_start_x
= it
->current_x
+ it
->pixel_width
8894 - it
->last_visible_x
;
8895 set_iterator_to_next (it
, 0);
8899 it
->continuation_lines_width
+= it
->current_x
;
8906 /* Reset/increment for the next run. */
8907 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8908 it
->current_x
= line_start_x
;
8911 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8913 last_height
= it
->max_ascent
+ it
->max_descent
;
8914 last_max_ascent
= it
->max_ascent
;
8915 it
->max_ascent
= it
->max_descent
= 0;
8920 /* On text terminals, we may stop at the end of a line in the middle
8921 of a multi-character glyph. If the glyph itself is continued,
8922 i.e. it is actually displayed on the next line, don't treat this
8923 stopping point as valid; move to the next line instead (unless
8924 that brings us offscreen). */
8925 if (!FRAME_WINDOW_P (it
->f
)
8927 && IT_CHARPOS (*it
) == to_charpos
8928 && it
->what
== IT_CHARACTER
8930 && it
->line_wrap
== WINDOW_WRAP
8931 && it
->current_x
== it
->last_visible_x
- 1
8934 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8936 it
->continuation_lines_width
+= it
->current_x
;
8937 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8938 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8940 last_height
= it
->max_ascent
+ it
->max_descent
;
8941 last_max_ascent
= it
->max_ascent
;
8945 bidi_unshelve_cache (backup_data
, 1);
8947 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8951 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8953 If DY > 0, move IT backward at least that many pixels. DY = 0
8954 means move IT backward to the preceding line start or BEGV. This
8955 function may move over more than DY pixels if IT->current_y - DY
8956 ends up in the middle of a line; in this case IT->current_y will be
8957 set to the top of the line moved to. */
8960 move_it_vertically_backward (struct it
*it
, int dy
)
8964 void *it2data
= NULL
, *it3data
= NULL
;
8965 ptrdiff_t start_pos
;
8970 start_pos
= IT_CHARPOS (*it
);
8972 /* Estimate how many newlines we must move back. */
8973 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8975 /* Set the iterator's position that many lines back. */
8976 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8977 back_to_previous_visible_line_start (it
);
8979 /* Reseat the iterator here. When moving backward, we don't want
8980 reseat to skip forward over invisible text, set up the iterator
8981 to deliver from overlay strings at the new position etc. So,
8982 use reseat_1 here. */
8983 reseat_1 (it
, it
->current
.pos
, 1);
8985 /* We are now surely at a line start. */
8986 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
8987 reordering is in effect. */
8988 it
->continuation_lines_width
= 0;
8990 /* Move forward and see what y-distance we moved. First move to the
8991 start of the next line so that we get its height. We need this
8992 height to be able to tell whether we reached the specified
8994 SAVE_IT (it2
, *it
, it2data
);
8995 it2
.max_ascent
= it2
.max_descent
= 0;
8998 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8999 MOVE_TO_POS
| MOVE_TO_VPOS
);
9001 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9002 /* If we are in a display string which starts at START_POS,
9003 and that display string includes a newline, and we are
9004 right after that newline (i.e. at the beginning of a
9005 display line), exit the loop, because otherwise we will
9006 infloop, since move_it_to will see that it is already at
9007 START_POS and will not move. */
9008 || (it2
.method
== GET_FROM_STRING
9009 && IT_CHARPOS (it2
) == start_pos
9010 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9011 eassert (IT_CHARPOS (*it
) >= BEGV
);
9012 SAVE_IT (it3
, it2
, it3data
);
9014 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9015 eassert (IT_CHARPOS (*it
) >= BEGV
);
9016 /* H is the actual vertical distance from the position in *IT
9017 and the starting position. */
9018 h
= it2
.current_y
- it
->current_y
;
9019 /* NLINES is the distance in number of lines. */
9020 nlines
= it2
.vpos
- it
->vpos
;
9022 /* Correct IT's y and vpos position
9023 so that they are relative to the starting point. */
9029 /* DY == 0 means move to the start of the screen line. The
9030 value of nlines is > 0 if continuation lines were involved,
9031 or if the original IT position was at start of a line. */
9032 RESTORE_IT (it
, it
, it2data
);
9034 move_it_by_lines (it
, nlines
);
9035 /* The above code moves us to some position NLINES down,
9036 usually to its first glyph (leftmost in an L2R line), but
9037 that's not necessarily the start of the line, under bidi
9038 reordering. We want to get to the character position
9039 that is immediately after the newline of the previous
9042 && !it
->continuation_lines_width
9043 && !STRINGP (it
->string
)
9044 && IT_CHARPOS (*it
) > BEGV
9045 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9048 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
9050 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
9052 bidi_unshelve_cache (it3data
, 1);
9056 /* The y-position we try to reach, relative to *IT.
9057 Note that H has been subtracted in front of the if-statement. */
9058 int target_y
= it
->current_y
+ h
- dy
;
9059 int y0
= it3
.current_y
;
9063 RESTORE_IT (&it3
, &it3
, it3data
);
9064 y1
= line_bottom_y (&it3
);
9065 line_height
= y1
- y0
;
9066 RESTORE_IT (it
, it
, it2data
);
9067 /* If we did not reach target_y, try to move further backward if
9068 we can. If we moved too far backward, try to move forward. */
9069 if (target_y
< it
->current_y
9070 /* This is heuristic. In a window that's 3 lines high, with
9071 a line height of 13 pixels each, recentering with point
9072 on the bottom line will try to move -39/2 = 19 pixels
9073 backward. Try to avoid moving into the first line. */
9074 && (it
->current_y
- target_y
9075 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9076 && IT_CHARPOS (*it
) > BEGV
)
9078 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9079 target_y
- it
->current_y
));
9080 dy
= it
->current_y
- target_y
;
9081 goto move_further_back
;
9083 else if (target_y
>= it
->current_y
+ line_height
9084 && IT_CHARPOS (*it
) < ZV
)
9086 /* Should move forward by at least one line, maybe more.
9088 Note: Calling move_it_by_lines can be expensive on
9089 terminal frames, where compute_motion is used (via
9090 vmotion) to do the job, when there are very long lines
9091 and truncate-lines is nil. That's the reason for
9092 treating terminal frames specially here. */
9094 if (!FRAME_WINDOW_P (it
->f
))
9095 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9100 move_it_by_lines (it
, 1);
9102 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9109 /* Move IT by a specified amount of pixel lines DY. DY negative means
9110 move backwards. DY = 0 means move to start of screen line. At the
9111 end, IT will be on the start of a screen line. */
9114 move_it_vertically (struct it
*it
, int dy
)
9117 move_it_vertically_backward (it
, -dy
);
9120 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9121 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9122 MOVE_TO_POS
| MOVE_TO_Y
);
9123 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9125 /* If buffer ends in ZV without a newline, move to the start of
9126 the line to satisfy the post-condition. */
9127 if (IT_CHARPOS (*it
) == ZV
9129 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9130 move_it_by_lines (it
, 0);
9135 /* Move iterator IT past the end of the text line it is in. */
9138 move_it_past_eol (struct it
*it
)
9140 enum move_it_result rc
;
9142 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9143 if (rc
== MOVE_NEWLINE_OR_CR
)
9144 set_iterator_to_next (it
, 0);
9148 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9149 negative means move up. DVPOS == 0 means move to the start of the
9152 Optimization idea: If we would know that IT->f doesn't use
9153 a face with proportional font, we could be faster for
9154 truncate-lines nil. */
9157 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9160 /* The commented-out optimization uses vmotion on terminals. This
9161 gives bad results, because elements like it->what, on which
9162 callers such as pos_visible_p rely, aren't updated. */
9163 /* struct position pos;
9164 if (!FRAME_WINDOW_P (it->f))
9166 struct text_pos textpos;
9168 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9169 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9170 reseat (it, textpos, 1);
9171 it->vpos += pos.vpos;
9172 it->current_y += pos.vpos;
9178 /* DVPOS == 0 means move to the start of the screen line. */
9179 move_it_vertically_backward (it
, 0);
9180 /* Let next call to line_bottom_y calculate real line height */
9185 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9186 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9188 /* Only move to the next buffer position if we ended up in a
9189 string from display property, not in an overlay string
9190 (before-string or after-string). That is because the
9191 latter don't conceal the underlying buffer position, so
9192 we can ask to move the iterator to the exact position we
9193 are interested in. Note that, even if we are already at
9194 IT_CHARPOS (*it), the call below is not a no-op, as it
9195 will detect that we are at the end of the string, pop the
9196 iterator, and compute it->current_x and it->hpos
9198 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9199 -1, -1, -1, MOVE_TO_POS
);
9205 void *it2data
= NULL
;
9206 ptrdiff_t start_charpos
, i
;
9208 /* Start at the beginning of the screen line containing IT's
9209 position. This may actually move vertically backwards,
9210 in case of overlays, so adjust dvpos accordingly. */
9212 move_it_vertically_backward (it
, 0);
9215 /* Go back -DVPOS visible lines and reseat the iterator there. */
9216 start_charpos
= IT_CHARPOS (*it
);
9217 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
9218 back_to_previous_visible_line_start (it
);
9219 reseat (it
, it
->current
.pos
, 1);
9221 /* Move further back if we end up in a string or an image. */
9222 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9224 /* First try to move to start of display line. */
9226 move_it_vertically_backward (it
, 0);
9228 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9230 /* If start of line is still in string or image,
9231 move further back. */
9232 back_to_previous_visible_line_start (it
);
9233 reseat (it
, it
->current
.pos
, 1);
9237 it
->current_x
= it
->hpos
= 0;
9239 /* Above call may have moved too far if continuation lines
9240 are involved. Scan forward and see if it did. */
9241 SAVE_IT (it2
, *it
, it2data
);
9242 it2
.vpos
= it2
.current_y
= 0;
9243 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9244 it
->vpos
-= it2
.vpos
;
9245 it
->current_y
-= it2
.current_y
;
9246 it
->current_x
= it
->hpos
= 0;
9248 /* If we moved too far back, move IT some lines forward. */
9249 if (it2
.vpos
> -dvpos
)
9251 int delta
= it2
.vpos
+ dvpos
;
9253 RESTORE_IT (&it2
, &it2
, it2data
);
9254 SAVE_IT (it2
, *it
, it2data
);
9255 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9256 /* Move back again if we got too far ahead. */
9257 if (IT_CHARPOS (*it
) >= start_charpos
)
9258 RESTORE_IT (it
, &it2
, it2data
);
9260 bidi_unshelve_cache (it2data
, 1);
9263 RESTORE_IT (it
, it
, it2data
);
9267 /* Return 1 if IT points into the middle of a display vector. */
9270 in_display_vector_p (struct it
*it
)
9272 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9273 && it
->current
.dpvec_index
> 0
9274 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9278 /***********************************************************************
9280 ***********************************************************************/
9283 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9287 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9289 Lisp_Object args
[3];
9290 Lisp_Object msg
, fmt
;
9293 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9297 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9299 args
[0] = fmt
= build_string (format
);
9302 msg
= Fformat (3, args
);
9304 len
= SBYTES (msg
) + 1;
9305 buffer
= SAFE_ALLOCA (len
);
9306 memcpy (buffer
, SDATA (msg
), len
);
9308 message_dolog (buffer
, len
- 1, 1, 0);
9315 /* Output a newline in the *Messages* buffer if "needs" one. */
9318 message_log_maybe_newline (void)
9320 if (message_log_need_newline
)
9321 message_dolog ("", 0, 1, 0);
9325 /* Add a string M of length NBYTES to the message log, optionally
9326 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
9327 nonzero, means interpret the contents of M as multibyte. This
9328 function calls low-level routines in order to bypass text property
9329 hooks, etc. which might not be safe to run.
9331 This may GC (insert may run before/after change hooks),
9332 so the buffer M must NOT point to a Lisp string. */
9335 message_dolog (const char *m
, ptrdiff_t nbytes
, int nlflag
, int multibyte
)
9337 const unsigned char *msg
= (const unsigned char *) m
;
9339 if (!NILP (Vmemory_full
))
9342 if (!NILP (Vmessage_log_max
))
9344 struct buffer
*oldbuf
;
9345 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9346 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9347 ptrdiff_t point_at_end
= 0;
9348 ptrdiff_t zv_at_end
= 0;
9349 Lisp_Object old_deactivate_mark
, tem
;
9350 struct gcpro gcpro1
;
9352 old_deactivate_mark
= Vdeactivate_mark
;
9353 oldbuf
= current_buffer
;
9354 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9355 bset_undo_list (current_buffer
, Qt
);
9357 oldpoint
= message_dolog_marker1
;
9358 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
9359 oldbegv
= message_dolog_marker2
;
9360 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
9361 oldzv
= message_dolog_marker3
;
9362 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
9363 GCPRO1 (old_deactivate_mark
);
9371 BEGV_BYTE
= BEG_BYTE
;
9374 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9376 /* Insert the string--maybe converting multibyte to single byte
9377 or vice versa, so that all the text fits the buffer. */
9379 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9385 /* Convert a multibyte string to single-byte
9386 for the *Message* buffer. */
9387 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9389 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9390 work
[0] = (ASCII_CHAR_P (c
)
9392 : multibyte_char_to_unibyte (c
));
9393 insert_1_both (work
, 1, 1, 1, 0, 0);
9396 else if (! multibyte
9397 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9401 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9402 /* Convert a single-byte string to multibyte
9403 for the *Message* buffer. */
9404 for (i
= 0; i
< nbytes
; i
++)
9407 MAKE_CHAR_MULTIBYTE (c
);
9408 char_bytes
= CHAR_STRING (c
, str
);
9409 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9413 insert_1 (m
, nbytes
, 1, 0, 0);
9417 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9419 insert_1 ("\n", 1, 1, 0, 0);
9421 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9423 this_bol_byte
= PT_BYTE
;
9425 /* See if this line duplicates the previous one.
9426 If so, combine duplicates. */
9429 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9431 prev_bol_byte
= PT_BYTE
;
9433 dups
= message_log_check_duplicate (prev_bol_byte
,
9437 del_range_both (prev_bol
, prev_bol_byte
,
9438 this_bol
, this_bol_byte
, 0);
9441 char dupstr
[sizeof " [ times]"
9442 + INT_STRLEN_BOUND (printmax_t
)];
9444 /* If you change this format, don't forget to also
9445 change message_log_check_duplicate. */
9446 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
9447 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9448 insert_1 (dupstr
, duplen
, 1, 0, 1);
9453 /* If we have more than the desired maximum number of lines
9454 in the *Messages* buffer now, delete the oldest ones.
9455 This is safe because we don't have undo in this buffer. */
9457 if (NATNUMP (Vmessage_log_max
))
9459 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9460 -XFASTINT (Vmessage_log_max
) - 1, 0);
9461 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9464 BEGV
= XMARKER (oldbegv
)->charpos
;
9465 BEGV_BYTE
= marker_byte_position (oldbegv
);
9474 ZV
= XMARKER (oldzv
)->charpos
;
9475 ZV_BYTE
= marker_byte_position (oldzv
);
9479 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9481 /* We can't do Fgoto_char (oldpoint) because it will run some
9483 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
9484 XMARKER (oldpoint
)->bytepos
);
9487 unchain_marker (XMARKER (oldpoint
));
9488 unchain_marker (XMARKER (oldbegv
));
9489 unchain_marker (XMARKER (oldzv
));
9491 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
9492 set_buffer_internal (oldbuf
);
9494 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9495 message_log_need_newline
= !nlflag
;
9496 Vdeactivate_mark
= old_deactivate_mark
;
9501 /* We are at the end of the buffer after just having inserted a newline.
9502 (Note: We depend on the fact we won't be crossing the gap.)
9503 Check to see if the most recent message looks a lot like the previous one.
9504 Return 0 if different, 1 if the new one should just replace it, or a
9505 value N > 1 if we should also append " [N times]". */
9508 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
9511 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
9513 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9514 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9516 for (i
= 0; i
< len
; i
++)
9518 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9526 if (*p1
++ == ' ' && *p1
++ == '[')
9529 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9530 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9537 /* Display an echo area message M with a specified length of NBYTES
9538 bytes. The string may include null characters. If M is 0, clear
9539 out any existing message, and let the mini-buffer text show
9542 This may GC, so the buffer M must NOT point to a Lisp string. */
9545 message2 (const char *m
, ptrdiff_t nbytes
, int multibyte
)
9547 /* First flush out any partial line written with print. */
9548 message_log_maybe_newline ();
9550 message_dolog (m
, nbytes
, 1, multibyte
);
9551 message2_nolog (m
, nbytes
, multibyte
);
9555 /* The non-logging counterpart of message2. */
9558 message2_nolog (const char *m
, ptrdiff_t nbytes
, int multibyte
)
9560 struct frame
*sf
= SELECTED_FRAME ();
9561 message_enable_multibyte
= multibyte
;
9563 if (FRAME_INITIAL_P (sf
))
9565 if (noninteractive_need_newline
)
9566 putc ('\n', stderr
);
9567 noninteractive_need_newline
= 0;
9569 fwrite (m
, nbytes
, 1, stderr
);
9570 if (cursor_in_echo_area
== 0)
9571 fprintf (stderr
, "\n");
9574 /* A null message buffer means that the frame hasn't really been
9575 initialized yet. Error messages get reported properly by
9576 cmd_error, so this must be just an informative message; toss it. */
9577 else if (INTERACTIVE
9578 && sf
->glyphs_initialized_p
9579 && FRAME_MESSAGE_BUF (sf
))
9581 Lisp_Object mini_window
;
9584 /* Get the frame containing the mini-buffer
9585 that the selected frame is using. */
9586 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9587 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9589 FRAME_SAMPLE_VISIBILITY (f
);
9590 if (FRAME_VISIBLE_P (sf
)
9591 && ! FRAME_VISIBLE_P (f
))
9592 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9596 set_message (m
, Qnil
, nbytes
, multibyte
);
9597 if (minibuffer_auto_raise
)
9598 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9601 clear_message (1, 1);
9603 do_pending_window_change (0);
9604 echo_area_display (1);
9605 do_pending_window_change (0);
9606 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9607 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9612 /* Display an echo area message M with a specified length of NBYTES
9613 bytes. The string may include null characters. If M is not a
9614 string, clear out any existing message, and let the mini-buffer
9617 This function cancels echoing. */
9620 message3 (Lisp_Object m
, ptrdiff_t nbytes
, int multibyte
)
9622 struct gcpro gcpro1
;
9625 clear_message (1,1);
9628 /* First flush out any partial line written with print. */
9629 message_log_maybe_newline ();
9633 char *buffer
= SAFE_ALLOCA (nbytes
);
9634 memcpy (buffer
, SDATA (m
), nbytes
);
9635 message_dolog (buffer
, nbytes
, 1, multibyte
);
9638 message3_nolog (m
, nbytes
, multibyte
);
9644 /* The non-logging version of message3.
9645 This does not cancel echoing, because it is used for echoing.
9646 Perhaps we need to make a separate function for echoing
9647 and make this cancel echoing. */
9650 message3_nolog (Lisp_Object m
, ptrdiff_t nbytes
, int multibyte
)
9652 struct frame
*sf
= SELECTED_FRAME ();
9653 message_enable_multibyte
= multibyte
;
9655 if (FRAME_INITIAL_P (sf
))
9657 if (noninteractive_need_newline
)
9658 putc ('\n', stderr
);
9659 noninteractive_need_newline
= 0;
9661 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9662 if (cursor_in_echo_area
== 0)
9663 fprintf (stderr
, "\n");
9666 /* A null message buffer means that the frame hasn't really been
9667 initialized yet. Error messages get reported properly by
9668 cmd_error, so this must be just an informative message; toss it. */
9669 else if (INTERACTIVE
9670 && sf
->glyphs_initialized_p
9671 && FRAME_MESSAGE_BUF (sf
))
9673 Lisp_Object mini_window
;
9677 /* Get the frame containing the mini-buffer
9678 that the selected frame is using. */
9679 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9680 frame
= XWINDOW (mini_window
)->frame
;
9683 FRAME_SAMPLE_VISIBILITY (f
);
9684 if (FRAME_VISIBLE_P (sf
)
9685 && !FRAME_VISIBLE_P (f
))
9686 Fmake_frame_visible (frame
);
9688 if (STRINGP (m
) && SCHARS (m
) > 0)
9690 set_message (NULL
, m
, nbytes
, multibyte
);
9691 if (minibuffer_auto_raise
)
9692 Fraise_frame (frame
);
9693 /* Assume we are not echoing.
9694 (If we are, echo_now will override this.) */
9695 echo_message_buffer
= Qnil
;
9698 clear_message (1, 1);
9700 do_pending_window_change (0);
9701 echo_area_display (1);
9702 do_pending_window_change (0);
9703 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9704 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9709 /* Display a null-terminated echo area message M. If M is 0, clear
9710 out any existing message, and let the mini-buffer text show through.
9712 The buffer M must continue to exist until after the echo area gets
9713 cleared or some other message gets displayed there. Do not pass
9714 text that is stored in a Lisp string. Do not pass text in a buffer
9715 that was alloca'd. */
9718 message1 (const char *m
)
9720 message2 (m
, (m
? strlen (m
) : 0), 0);
9724 /* The non-logging counterpart of message1. */
9727 message1_nolog (const char *m
)
9729 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9732 /* Display a message M which contains a single %s
9733 which gets replaced with STRING. */
9736 message_with_string (const char *m
, Lisp_Object string
, int log
)
9738 CHECK_STRING (string
);
9744 if (noninteractive_need_newline
)
9745 putc ('\n', stderr
);
9746 noninteractive_need_newline
= 0;
9747 fprintf (stderr
, m
, SDATA (string
));
9748 if (!cursor_in_echo_area
)
9749 fprintf (stderr
, "\n");
9753 else if (INTERACTIVE
)
9755 /* The frame whose minibuffer we're going to display the message on.
9756 It may be larger than the selected frame, so we need
9757 to use its buffer, not the selected frame's buffer. */
9758 Lisp_Object mini_window
;
9759 struct frame
*f
, *sf
= SELECTED_FRAME ();
9761 /* Get the frame containing the minibuffer
9762 that the selected frame is using. */
9763 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9764 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9766 /* A null message buffer means that the frame hasn't really been
9767 initialized yet. Error messages get reported properly by
9768 cmd_error, so this must be just an informative message; toss it. */
9769 if (FRAME_MESSAGE_BUF (f
))
9771 Lisp_Object args
[2], msg
;
9772 struct gcpro gcpro1
, gcpro2
;
9774 args
[0] = build_string (m
);
9775 args
[1] = msg
= string
;
9776 GCPRO2 (args
[0], msg
);
9779 msg
= Fformat (2, args
);
9782 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9784 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9788 /* Print should start at the beginning of the message
9789 buffer next time. */
9790 message_buf_print
= 0;
9796 /* Dump an informative message to the minibuf. If M is 0, clear out
9797 any existing message, and let the mini-buffer text show through. */
9800 vmessage (const char *m
, va_list ap
)
9806 if (noninteractive_need_newline
)
9807 putc ('\n', stderr
);
9808 noninteractive_need_newline
= 0;
9809 vfprintf (stderr
, m
, ap
);
9810 if (cursor_in_echo_area
== 0)
9811 fprintf (stderr
, "\n");
9815 else if (INTERACTIVE
)
9817 /* The frame whose mini-buffer we're going to display the message
9818 on. It may be larger than the selected frame, so we need to
9819 use its buffer, not the selected frame's buffer. */
9820 Lisp_Object mini_window
;
9821 struct frame
*f
, *sf
= SELECTED_FRAME ();
9823 /* Get the frame containing the mini-buffer
9824 that the selected frame is using. */
9825 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9826 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9828 /* A null message buffer means that the frame hasn't really been
9829 initialized yet. Error messages get reported properly by
9830 cmd_error, so this must be just an informative message; toss
9832 if (FRAME_MESSAGE_BUF (f
))
9838 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9839 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9841 message2 (FRAME_MESSAGE_BUF (f
), len
, 1);
9846 /* Print should start at the beginning of the message
9847 buffer next time. */
9848 message_buf_print
= 0;
9854 message (const char *m
, ...)
9864 /* The non-logging version of message. */
9867 message_nolog (const char *m
, ...)
9869 Lisp_Object old_log_max
;
9872 old_log_max
= Vmessage_log_max
;
9873 Vmessage_log_max
= Qnil
;
9875 Vmessage_log_max
= old_log_max
;
9881 /* Display the current message in the current mini-buffer. This is
9882 only called from error handlers in process.c, and is not time
9886 update_echo_area (void)
9888 if (!NILP (echo_area_buffer
[0]))
9891 string
= Fcurrent_message ();
9892 message3 (string
, SBYTES (string
),
9893 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9898 /* Make sure echo area buffers in `echo_buffers' are live.
9899 If they aren't, make new ones. */
9902 ensure_echo_area_buffers (void)
9906 for (i
= 0; i
< 2; ++i
)
9907 if (!BUFFERP (echo_buffer
[i
])
9908 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
9911 Lisp_Object old_buffer
;
9914 old_buffer
= echo_buffer
[i
];
9915 echo_buffer
[i
] = Fget_buffer_create
9916 (make_formatted_string (name
, " *Echo Area %d*", i
));
9917 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
9918 /* to force word wrap in echo area -
9919 it was decided to postpone this*/
9920 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9922 for (j
= 0; j
< 2; ++j
)
9923 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9924 echo_area_buffer
[j
] = echo_buffer
[i
];
9929 /* Call FN with args A1..A4 with either the current or last displayed
9930 echo_area_buffer as current buffer.
9932 WHICH zero means use the current message buffer
9933 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9934 from echo_buffer[] and clear it.
9936 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9937 suitable buffer from echo_buffer[] and clear it.
9939 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9940 that the current message becomes the last displayed one, make
9941 choose a suitable buffer for echo_area_buffer[0], and clear it.
9943 Value is what FN returns. */
9946 with_echo_area_buffer (struct window
*w
, int which
,
9947 int (*fn
) (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t),
9948 ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
9951 int this_one
, the_other
, clear_buffer_p
, rc
;
9952 ptrdiff_t count
= SPECPDL_INDEX ();
9954 /* If buffers aren't live, make new ones. */
9955 ensure_echo_area_buffers ();
9960 this_one
= 0, the_other
= 1;
9962 this_one
= 1, the_other
= 0;
9965 this_one
= 0, the_other
= 1;
9968 /* We need a fresh one in case the current echo buffer equals
9969 the one containing the last displayed echo area message. */
9970 if (!NILP (echo_area_buffer
[this_one
])
9971 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9972 echo_area_buffer
[this_one
] = Qnil
;
9975 /* Choose a suitable buffer from echo_buffer[] is we don't
9977 if (NILP (echo_area_buffer
[this_one
]))
9979 echo_area_buffer
[this_one
]
9980 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9981 ? echo_buffer
[the_other
]
9982 : echo_buffer
[this_one
]);
9986 buffer
= echo_area_buffer
[this_one
];
9988 /* Don't get confused by reusing the buffer used for echoing
9989 for a different purpose. */
9990 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9993 record_unwind_protect (unwind_with_echo_area_buffer
,
9994 with_echo_area_buffer_unwind_data (w
));
9996 /* Make the echo area buffer current. Note that for display
9997 purposes, it is not necessary that the displayed window's buffer
9998 == current_buffer, except for text property lookup. So, let's
9999 only set that buffer temporarily here without doing a full
10000 Fset_window_buffer. We must also change w->pointm, though,
10001 because otherwise an assertions in unshow_buffer fails, and Emacs
10003 set_buffer_internal_1 (XBUFFER (buffer
));
10006 wset_buffer (w
, buffer
);
10007 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10010 bset_undo_list (current_buffer
, Qt
);
10011 bset_read_only (current_buffer
, Qnil
);
10012 specbind (Qinhibit_read_only
, Qt
);
10013 specbind (Qinhibit_modification_hooks
, Qt
);
10015 if (clear_buffer_p
&& Z
> BEG
)
10016 del_range (BEG
, Z
);
10018 eassert (BEGV
>= BEG
);
10019 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10021 rc
= fn (a1
, a2
, a3
, a4
);
10023 eassert (BEGV
>= BEG
);
10024 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10026 unbind_to (count
, Qnil
);
10031 /* Save state that should be preserved around the call to the function
10032 FN called in with_echo_area_buffer. */
10035 with_echo_area_buffer_unwind_data (struct window
*w
)
10038 Lisp_Object vector
, tmp
;
10040 /* Reduce consing by keeping one vector in
10041 Vwith_echo_area_save_vector. */
10042 vector
= Vwith_echo_area_save_vector
;
10043 Vwith_echo_area_save_vector
= Qnil
;
10046 vector
= Fmake_vector (make_number (7), Qnil
);
10048 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10049 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10050 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10054 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10055 ASET (vector
, i
, w
->buffer
); ++i
;
10056 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
10057 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
10062 for (; i
< end
; ++i
)
10063 ASET (vector
, i
, Qnil
);
10066 eassert (i
== ASIZE (vector
));
10071 /* Restore global state from VECTOR which was created by
10072 with_echo_area_buffer_unwind_data. */
10075 unwind_with_echo_area_buffer (Lisp_Object vector
)
10077 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10078 Vdeactivate_mark
= AREF (vector
, 1);
10079 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10081 if (WINDOWP (AREF (vector
, 3)))
10084 Lisp_Object buffer
, charpos
, bytepos
;
10086 w
= XWINDOW (AREF (vector
, 3));
10087 buffer
= AREF (vector
, 4);
10088 charpos
= AREF (vector
, 5);
10089 bytepos
= AREF (vector
, 6);
10091 wset_buffer (w
, buffer
);
10092 set_marker_both (w
->pointm
, buffer
,
10093 XFASTINT (charpos
), XFASTINT (bytepos
));
10096 Vwith_echo_area_save_vector
= vector
;
10101 /* Set up the echo area for use by print functions. MULTIBYTE_P
10102 non-zero means we will print multibyte. */
10105 setup_echo_area_for_printing (int multibyte_p
)
10107 /* If we can't find an echo area any more, exit. */
10108 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10109 Fkill_emacs (Qnil
);
10111 ensure_echo_area_buffers ();
10113 if (!message_buf_print
)
10115 /* A message has been output since the last time we printed.
10116 Choose a fresh echo area buffer. */
10117 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10118 echo_area_buffer
[0] = echo_buffer
[1];
10120 echo_area_buffer
[0] = echo_buffer
[0];
10122 /* Switch to that buffer and clear it. */
10123 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10124 bset_truncate_lines (current_buffer
, Qnil
);
10128 ptrdiff_t count
= SPECPDL_INDEX ();
10129 specbind (Qinhibit_read_only
, Qt
);
10130 /* Note that undo recording is always disabled. */
10131 del_range (BEG
, Z
);
10132 unbind_to (count
, Qnil
);
10134 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10136 /* Set up the buffer for the multibyteness we need. */
10138 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10139 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10141 /* Raise the frame containing the echo area. */
10142 if (minibuffer_auto_raise
)
10144 struct frame
*sf
= SELECTED_FRAME ();
10145 Lisp_Object mini_window
;
10146 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10147 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10150 message_log_maybe_newline ();
10151 message_buf_print
= 1;
10155 if (NILP (echo_area_buffer
[0]))
10157 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10158 echo_area_buffer
[0] = echo_buffer
[1];
10160 echo_area_buffer
[0] = echo_buffer
[0];
10163 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10165 /* Someone switched buffers between print requests. */
10166 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10167 bset_truncate_lines (current_buffer
, Qnil
);
10173 /* Display an echo area message in window W. Value is non-zero if W's
10174 height is changed. If display_last_displayed_message_p is
10175 non-zero, display the message that was last displayed, otherwise
10176 display the current message. */
10179 display_echo_area (struct window
*w
)
10181 int i
, no_message_p
, window_height_changed_p
;
10183 /* Temporarily disable garbage collections while displaying the echo
10184 area. This is done because a GC can print a message itself.
10185 That message would modify the echo area buffer's contents while a
10186 redisplay of the buffer is going on, and seriously confuse
10188 ptrdiff_t count
= inhibit_garbage_collection ();
10190 /* If there is no message, we must call display_echo_area_1
10191 nevertheless because it resizes the window. But we will have to
10192 reset the echo_area_buffer in question to nil at the end because
10193 with_echo_area_buffer will sets it to an empty buffer. */
10194 i
= display_last_displayed_message_p
? 1 : 0;
10195 no_message_p
= NILP (echo_area_buffer
[i
]);
10197 window_height_changed_p
10198 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10199 display_echo_area_1
,
10200 (intptr_t) w
, Qnil
, 0, 0);
10203 echo_area_buffer
[i
] = Qnil
;
10205 unbind_to (count
, Qnil
);
10206 return window_height_changed_p
;
10210 /* Helper for display_echo_area. Display the current buffer which
10211 contains the current echo area message in window W, a mini-window,
10212 a pointer to which is passed in A1. A2..A4 are currently not used.
10213 Change the height of W so that all of the message is displayed.
10214 Value is non-zero if height of W was changed. */
10217 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10220 struct window
*w
= (struct window
*) i1
;
10221 Lisp_Object window
;
10222 struct text_pos start
;
10223 int window_height_changed_p
= 0;
10225 /* Do this before displaying, so that we have a large enough glyph
10226 matrix for the display. If we can't get enough space for the
10227 whole text, display the last N lines. That works by setting w->start. */
10228 window_height_changed_p
= resize_mini_window (w
, 0);
10230 /* Use the starting position chosen by resize_mini_window. */
10231 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10234 clear_glyph_matrix (w
->desired_matrix
);
10235 XSETWINDOW (window
, w
);
10236 try_window (window
, start
, 0);
10238 return window_height_changed_p
;
10242 /* Resize the echo area window to exactly the size needed for the
10243 currently displayed message, if there is one. If a mini-buffer
10244 is active, don't shrink it. */
10247 resize_echo_area_exactly (void)
10249 if (BUFFERP (echo_area_buffer
[0])
10250 && WINDOWP (echo_area_window
))
10252 struct window
*w
= XWINDOW (echo_area_window
);
10254 Lisp_Object resize_exactly
;
10256 if (minibuf_level
== 0)
10257 resize_exactly
= Qt
;
10259 resize_exactly
= Qnil
;
10261 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10262 (intptr_t) w
, resize_exactly
,
10266 ++windows_or_buffers_changed
;
10267 ++update_mode_lines
;
10268 redisplay_internal ();
10274 /* Callback function for with_echo_area_buffer, when used from
10275 resize_echo_area_exactly. A1 contains a pointer to the window to
10276 resize, EXACTLY non-nil means resize the mini-window exactly to the
10277 size of the text displayed. A3 and A4 are not used. Value is what
10278 resize_mini_window returns. */
10281 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
, ptrdiff_t a3
, ptrdiff_t a4
)
10284 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10288 /* Resize mini-window W to fit the size of its contents. EXACT_P
10289 means size the window exactly to the size needed. Otherwise, it's
10290 only enlarged until W's buffer is empty.
10292 Set W->start to the right place to begin display. If the whole
10293 contents fit, start at the beginning. Otherwise, start so as
10294 to make the end of the contents appear. This is particularly
10295 important for y-or-n-p, but seems desirable generally.
10297 Value is non-zero if the window height has been changed. */
10300 resize_mini_window (struct window
*w
, int exact_p
)
10302 struct frame
*f
= XFRAME (w
->frame
);
10303 int window_height_changed_p
= 0;
10305 eassert (MINI_WINDOW_P (w
));
10307 /* By default, start display at the beginning. */
10308 set_marker_both (w
->start
, w
->buffer
,
10309 BUF_BEGV (XBUFFER (w
->buffer
)),
10310 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
10312 /* Don't resize windows while redisplaying a window; it would
10313 confuse redisplay functions when the size of the window they are
10314 displaying changes from under them. Such a resizing can happen,
10315 for instance, when which-func prints a long message while
10316 we are running fontification-functions. We're running these
10317 functions with safe_call which binds inhibit-redisplay to t. */
10318 if (!NILP (Vinhibit_redisplay
))
10321 /* Nil means don't try to resize. */
10322 if (NILP (Vresize_mini_windows
)
10323 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10326 if (!FRAME_MINIBUF_ONLY_P (f
))
10329 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10330 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10332 EMACS_INT max_height
;
10333 int unit
= FRAME_LINE_HEIGHT (f
);
10334 struct text_pos start
;
10335 struct buffer
*old_current_buffer
= NULL
;
10337 if (current_buffer
!= XBUFFER (w
->buffer
))
10339 old_current_buffer
= current_buffer
;
10340 set_buffer_internal (XBUFFER (w
->buffer
));
10343 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10345 /* Compute the max. number of lines specified by the user. */
10346 if (FLOATP (Vmax_mini_window_height
))
10347 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10348 else if (INTEGERP (Vmax_mini_window_height
))
10349 max_height
= XINT (Vmax_mini_window_height
);
10351 max_height
= total_height
/ 4;
10353 /* Correct that max. height if it's bogus. */
10354 max_height
= max (1, max_height
);
10355 max_height
= min (total_height
, max_height
);
10357 /* Find out the height of the text in the window. */
10358 if (it
.line_wrap
== TRUNCATE
)
10363 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10364 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10365 height
= it
.current_y
+ last_height
;
10367 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10368 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10369 height
= (height
+ unit
- 1) / unit
;
10372 /* Compute a suitable window start. */
10373 if (height
> max_height
)
10375 height
= max_height
;
10376 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10377 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10378 start
= it
.current
.pos
;
10381 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10382 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10384 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10386 /* Let it grow only, until we display an empty message, in which
10387 case the window shrinks again. */
10388 if (height
> WINDOW_TOTAL_LINES (w
))
10390 int old_height
= WINDOW_TOTAL_LINES (w
);
10391 freeze_window_starts (f
, 1);
10392 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10393 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10395 else if (height
< WINDOW_TOTAL_LINES (w
)
10396 && (exact_p
|| BEGV
== ZV
))
10398 int old_height
= WINDOW_TOTAL_LINES (w
);
10399 freeze_window_starts (f
, 0);
10400 shrink_mini_window (w
);
10401 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10406 /* Always resize to exact size needed. */
10407 if (height
> WINDOW_TOTAL_LINES (w
))
10409 int old_height
= WINDOW_TOTAL_LINES (w
);
10410 freeze_window_starts (f
, 1);
10411 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10412 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10414 else if (height
< WINDOW_TOTAL_LINES (w
))
10416 int old_height
= WINDOW_TOTAL_LINES (w
);
10417 freeze_window_starts (f
, 0);
10418 shrink_mini_window (w
);
10422 freeze_window_starts (f
, 1);
10423 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10426 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10430 if (old_current_buffer
)
10431 set_buffer_internal (old_current_buffer
);
10434 return window_height_changed_p
;
10438 /* Value is the current message, a string, or nil if there is no
10439 current message. */
10442 current_message (void)
10446 if (!BUFFERP (echo_area_buffer
[0]))
10450 with_echo_area_buffer (0, 0, current_message_1
,
10451 (intptr_t) &msg
, Qnil
, 0, 0);
10453 echo_area_buffer
[0] = Qnil
;
10461 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10464 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10467 *msg
= make_buffer_string (BEG
, Z
, 1);
10474 /* Push the current message on Vmessage_stack for later restoration
10475 by restore_message. Value is non-zero if the current message isn't
10476 empty. This is a relatively infrequent operation, so it's not
10477 worth optimizing. */
10480 push_message (void)
10482 Lisp_Object msg
= current_message ();
10483 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10484 return STRINGP (msg
);
10488 /* Restore message display from the top of Vmessage_stack. */
10491 restore_message (void)
10495 eassert (CONSP (Vmessage_stack
));
10496 msg
= XCAR (Vmessage_stack
);
10498 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10500 message3_nolog (msg
, 0, 0);
10504 /* Handler for record_unwind_protect calling pop_message. */
10507 pop_message_unwind (Lisp_Object dummy
)
10513 /* Pop the top-most entry off Vmessage_stack. */
10518 eassert (CONSP (Vmessage_stack
));
10519 Vmessage_stack
= XCDR (Vmessage_stack
);
10523 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10524 exits. If the stack is not empty, we have a missing pop_message
10528 check_message_stack (void)
10530 if (!NILP (Vmessage_stack
))
10535 /* Truncate to NCHARS what will be displayed in the echo area the next
10536 time we display it---but don't redisplay it now. */
10539 truncate_echo_area (ptrdiff_t nchars
)
10542 echo_area_buffer
[0] = Qnil
;
10543 /* A null message buffer means that the frame hasn't really been
10544 initialized yet. Error messages get reported properly by
10545 cmd_error, so this must be just an informative message; toss it. */
10546 else if (!noninteractive
10548 && !NILP (echo_area_buffer
[0]))
10550 struct frame
*sf
= SELECTED_FRAME ();
10551 if (FRAME_MESSAGE_BUF (sf
))
10552 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10557 /* Helper function for truncate_echo_area. Truncate the current
10558 message to at most NCHARS characters. */
10561 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10563 if (BEG
+ nchars
< Z
)
10564 del_range (BEG
+ nchars
, Z
);
10566 echo_area_buffer
[0] = Qnil
;
10570 /* Set the current message to a substring of S or STRING.
10572 If STRING is a Lisp string, set the message to the first NBYTES
10573 bytes from STRING. NBYTES zero means use the whole string. If
10574 STRING is multibyte, the message will be displayed multibyte.
10576 If S is not null, set the message to the first LEN bytes of S. LEN
10577 zero means use the whole string. MULTIBYTE_P non-zero means S is
10578 multibyte. Display the message multibyte in that case.
10580 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10581 to t before calling set_message_1 (which calls insert).
10585 set_message (const char *s
, Lisp_Object string
,
10586 ptrdiff_t nbytes
, int multibyte_p
)
10588 message_enable_multibyte
10589 = ((s
&& multibyte_p
)
10590 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10592 with_echo_area_buffer (0, -1, set_message_1
,
10593 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10594 message_buf_print
= 0;
10595 help_echo_showing_p
= 0;
10597 if (STRINGP (Vdebug_on_message
)
10598 && fast_string_match (Vdebug_on_message
, string
) >= 0)
10599 call_debugger (list2 (Qerror
, string
));
10603 /* Helper function for set_message. Arguments have the same meaning
10604 as there, with A1 corresponding to S and A2 corresponding to STRING
10605 This function is called with the echo area buffer being
10609 set_message_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t nbytes
, ptrdiff_t multibyte_p
)
10612 const char *s
= (const char *) i1
;
10613 const unsigned char *msg
= (const unsigned char *) s
;
10614 Lisp_Object string
= a2
;
10616 /* Change multibyteness of the echo buffer appropriately. */
10617 if (message_enable_multibyte
10618 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10619 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10621 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
10622 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10623 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
10625 /* Insert new message at BEG. */
10626 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10628 if (STRINGP (string
))
10633 nbytes
= SBYTES (string
);
10634 nchars
= string_byte_to_char (string
, nbytes
);
10636 /* This function takes care of single/multibyte conversion. We
10637 just have to ensure that the echo area buffer has the right
10638 setting of enable_multibyte_characters. */
10639 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10644 nbytes
= strlen (s
);
10646 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10648 /* Convert from multi-byte to single-byte. */
10653 /* Convert a multibyte string to single-byte. */
10654 for (i
= 0; i
< nbytes
; i
+= n
)
10656 c
= string_char_and_length (msg
+ i
, &n
);
10657 work
[0] = (ASCII_CHAR_P (c
)
10659 : multibyte_char_to_unibyte (c
));
10660 insert_1_both (work
, 1, 1, 1, 0, 0);
10663 else if (!multibyte_p
10664 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10666 /* Convert from single-byte to multi-byte. */
10669 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10671 /* Convert a single-byte string to multibyte. */
10672 for (i
= 0; i
< nbytes
; i
++)
10675 MAKE_CHAR_MULTIBYTE (c
);
10676 n
= CHAR_STRING (c
, str
);
10677 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10681 insert_1 (s
, nbytes
, 1, 0, 0);
10688 /* Clear messages. CURRENT_P non-zero means clear the current
10689 message. LAST_DISPLAYED_P non-zero means clear the message
10693 clear_message (int current_p
, int last_displayed_p
)
10697 echo_area_buffer
[0] = Qnil
;
10698 message_cleared_p
= 1;
10701 if (last_displayed_p
)
10702 echo_area_buffer
[1] = Qnil
;
10704 message_buf_print
= 0;
10707 /* Clear garbaged frames.
10709 This function is used where the old redisplay called
10710 redraw_garbaged_frames which in turn called redraw_frame which in
10711 turn called clear_frame. The call to clear_frame was a source of
10712 flickering. I believe a clear_frame is not necessary. It should
10713 suffice in the new redisplay to invalidate all current matrices,
10714 and ensure a complete redisplay of all windows. */
10717 clear_garbaged_frames (void)
10719 if (frame_garbaged
)
10721 Lisp_Object tail
, frame
;
10722 int changed_count
= 0;
10724 FOR_EACH_FRAME (tail
, frame
)
10726 struct frame
*f
= XFRAME (frame
);
10728 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10732 Fredraw_frame (frame
);
10733 f
->force_flush_display_p
= 1;
10735 clear_current_matrices (f
);
10742 frame_garbaged
= 0;
10744 ++windows_or_buffers_changed
;
10749 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10750 is non-zero update selected_frame. Value is non-zero if the
10751 mini-windows height has been changed. */
10754 echo_area_display (int update_frame_p
)
10756 Lisp_Object mini_window
;
10759 int window_height_changed_p
= 0;
10760 struct frame
*sf
= SELECTED_FRAME ();
10762 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10763 w
= XWINDOW (mini_window
);
10764 f
= XFRAME (WINDOW_FRAME (w
));
10766 /* Don't display if frame is invisible or not yet initialized. */
10767 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10770 #ifdef HAVE_WINDOW_SYSTEM
10771 /* When Emacs starts, selected_frame may be the initial terminal
10772 frame. If we let this through, a message would be displayed on
10774 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10776 #endif /* HAVE_WINDOW_SYSTEM */
10778 /* Redraw garbaged frames. */
10779 if (frame_garbaged
)
10780 clear_garbaged_frames ();
10782 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10784 echo_area_window
= mini_window
;
10785 window_height_changed_p
= display_echo_area (w
);
10786 w
->must_be_updated_p
= 1;
10788 /* Update the display, unless called from redisplay_internal.
10789 Also don't update the screen during redisplay itself. The
10790 update will happen at the end of redisplay, and an update
10791 here could cause confusion. */
10792 if (update_frame_p
&& !redisplaying_p
)
10796 /* If the display update has been interrupted by pending
10797 input, update mode lines in the frame. Due to the
10798 pending input, it might have been that redisplay hasn't
10799 been called, so that mode lines above the echo area are
10800 garbaged. This looks odd, so we prevent it here. */
10801 if (!display_completed
)
10802 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10804 if (window_height_changed_p
10805 /* Don't do this if Emacs is shutting down. Redisplay
10806 needs to run hooks. */
10807 && !NILP (Vrun_hooks
))
10809 /* Must update other windows. Likewise as in other
10810 cases, don't let this update be interrupted by
10812 ptrdiff_t count
= SPECPDL_INDEX ();
10813 specbind (Qredisplay_dont_pause
, Qt
);
10814 windows_or_buffers_changed
= 1;
10815 redisplay_internal ();
10816 unbind_to (count
, Qnil
);
10818 else if (FRAME_WINDOW_P (f
) && n
== 0)
10820 /* Window configuration is the same as before.
10821 Can do with a display update of the echo area,
10822 unless we displayed some mode lines. */
10823 update_single_window (w
, 1);
10824 FRAME_RIF (f
)->flush_display (f
);
10827 update_frame (f
, 1, 1);
10829 /* If cursor is in the echo area, make sure that the next
10830 redisplay displays the minibuffer, so that the cursor will
10831 be replaced with what the minibuffer wants. */
10832 if (cursor_in_echo_area
)
10833 ++windows_or_buffers_changed
;
10836 else if (!EQ (mini_window
, selected_window
))
10837 windows_or_buffers_changed
++;
10839 /* Last displayed message is now the current message. */
10840 echo_area_buffer
[1] = echo_area_buffer
[0];
10841 /* Inform read_char that we're not echoing. */
10842 echo_message_buffer
= Qnil
;
10844 /* Prevent redisplay optimization in redisplay_internal by resetting
10845 this_line_start_pos. This is done because the mini-buffer now
10846 displays the message instead of its buffer text. */
10847 if (EQ (mini_window
, selected_window
))
10848 CHARPOS (this_line_start_pos
) = 0;
10850 return window_height_changed_p
;
10855 /***********************************************************************
10856 Mode Lines and Frame Titles
10857 ***********************************************************************/
10859 /* A buffer for constructing non-propertized mode-line strings and
10860 frame titles in it; allocated from the heap in init_xdisp and
10861 resized as needed in store_mode_line_noprop_char. */
10863 static char *mode_line_noprop_buf
;
10865 /* The buffer's end, and a current output position in it. */
10867 static char *mode_line_noprop_buf_end
;
10868 static char *mode_line_noprop_ptr
;
10870 #define MODE_LINE_NOPROP_LEN(start) \
10871 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10874 MODE_LINE_DISPLAY
= 0,
10878 } mode_line_target
;
10880 /* Alist that caches the results of :propertize.
10881 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10882 static Lisp_Object mode_line_proptrans_alist
;
10884 /* List of strings making up the mode-line. */
10885 static Lisp_Object mode_line_string_list
;
10887 /* Base face property when building propertized mode line string. */
10888 static Lisp_Object mode_line_string_face
;
10889 static Lisp_Object mode_line_string_face_prop
;
10892 /* Unwind data for mode line strings */
10894 static Lisp_Object Vmode_line_unwind_vector
;
10897 format_mode_line_unwind_data (struct frame
*target_frame
,
10898 struct buffer
*obuf
,
10900 int save_proptrans
)
10902 Lisp_Object vector
, tmp
;
10904 /* Reduce consing by keeping one vector in
10905 Vwith_echo_area_save_vector. */
10906 vector
= Vmode_line_unwind_vector
;
10907 Vmode_line_unwind_vector
= Qnil
;
10910 vector
= Fmake_vector (make_number (10), Qnil
);
10912 ASET (vector
, 0, make_number (mode_line_target
));
10913 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10914 ASET (vector
, 2, mode_line_string_list
);
10915 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10916 ASET (vector
, 4, mode_line_string_face
);
10917 ASET (vector
, 5, mode_line_string_face_prop
);
10920 XSETBUFFER (tmp
, obuf
);
10923 ASET (vector
, 6, tmp
);
10924 ASET (vector
, 7, owin
);
10927 /* Similarly to `with-selected-window', if the operation selects
10928 a window on another frame, we must restore that frame's
10929 selected window, and (for a tty) the top-frame. */
10930 ASET (vector
, 8, target_frame
->selected_window
);
10931 if (FRAME_TERMCAP_P (target_frame
))
10932 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
10939 unwind_format_mode_line (Lisp_Object vector
)
10941 Lisp_Object old_window
= AREF (vector
, 7);
10942 Lisp_Object target_frame_window
= AREF (vector
, 8);
10943 Lisp_Object old_top_frame
= AREF (vector
, 9);
10945 mode_line_target
= XINT (AREF (vector
, 0));
10946 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10947 mode_line_string_list
= AREF (vector
, 2);
10948 if (! EQ (AREF (vector
, 3), Qt
))
10949 mode_line_proptrans_alist
= AREF (vector
, 3);
10950 mode_line_string_face
= AREF (vector
, 4);
10951 mode_line_string_face_prop
= AREF (vector
, 5);
10953 /* Select window before buffer, since it may change the buffer. */
10954 if (!NILP (old_window
))
10956 /* If the operation that we are unwinding had selected a window
10957 on a different frame, reset its frame-selected-window. For a
10958 text terminal, reset its top-frame if necessary. */
10959 if (!NILP (target_frame_window
))
10962 = WINDOW_FRAME (XWINDOW (target_frame_window
));
10964 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
10965 Fselect_window (target_frame_window
, Qt
);
10967 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
10968 Fselect_frame (old_top_frame
, Qt
);
10971 Fselect_window (old_window
, Qt
);
10974 if (!NILP (AREF (vector
, 6)))
10976 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10977 ASET (vector
, 6, Qnil
);
10980 Vmode_line_unwind_vector
= vector
;
10985 /* Store a single character C for the frame title in mode_line_noprop_buf.
10986 Re-allocate mode_line_noprop_buf if necessary. */
10989 store_mode_line_noprop_char (char c
)
10991 /* If output position has reached the end of the allocated buffer,
10992 increase the buffer's size. */
10993 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10995 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10996 ptrdiff_t size
= len
;
10997 mode_line_noprop_buf
=
10998 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
10999 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11000 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11003 *mode_line_noprop_ptr
++ = c
;
11007 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11008 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11009 characters that yield more columns than PRECISION; PRECISION <= 0
11010 means copy the whole string. Pad with spaces until FIELD_WIDTH
11011 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11012 pad. Called from display_mode_element when it is used to build a
11016 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11018 const unsigned char *str
= (const unsigned char *) string
;
11020 ptrdiff_t dummy
, nbytes
;
11022 /* Copy at most PRECISION chars from STR. */
11023 nbytes
= strlen (string
);
11024 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11026 store_mode_line_noprop_char (*str
++);
11028 /* Fill up with spaces until FIELD_WIDTH reached. */
11029 while (field_width
> 0
11030 && n
< field_width
)
11032 store_mode_line_noprop_char (' ');
11039 /***********************************************************************
11041 ***********************************************************************/
11043 #ifdef HAVE_WINDOW_SYSTEM
11045 /* Set the title of FRAME, if it has changed. The title format is
11046 Vicon_title_format if FRAME is iconified, otherwise it is
11047 frame_title_format. */
11050 x_consider_frame_title (Lisp_Object frame
)
11052 struct frame
*f
= XFRAME (frame
);
11054 if (FRAME_WINDOW_P (f
)
11055 || FRAME_MINIBUF_ONLY_P (f
)
11056 || f
->explicit_name
)
11058 /* Do we have more than one visible frame on this X display? */
11061 ptrdiff_t title_start
;
11065 ptrdiff_t count
= SPECPDL_INDEX ();
11067 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
11069 Lisp_Object other_frame
= XCAR (tail
);
11070 struct frame
*tf
= XFRAME (other_frame
);
11073 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11074 && !FRAME_MINIBUF_ONLY_P (tf
)
11075 && !EQ (other_frame
, tip_frame
)
11076 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11080 /* Set global variable indicating that multiple frames exist. */
11081 multiple_frames
= CONSP (tail
);
11083 /* Switch to the buffer of selected window of the frame. Set up
11084 mode_line_target so that display_mode_element will output into
11085 mode_line_noprop_buf; then display the title. */
11086 record_unwind_protect (unwind_format_mode_line
,
11087 format_mode_line_unwind_data
11088 (f
, current_buffer
, selected_window
, 0));
11090 Fselect_window (f
->selected_window
, Qt
);
11091 set_buffer_internal_1
11092 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
11093 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11095 mode_line_target
= MODE_LINE_TITLE
;
11096 title_start
= MODE_LINE_NOPROP_LEN (0);
11097 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11098 NULL
, DEFAULT_FACE_ID
);
11099 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11100 len
= MODE_LINE_NOPROP_LEN (title_start
);
11101 title
= mode_line_noprop_buf
+ title_start
;
11102 unbind_to (count
, Qnil
);
11104 /* Set the title only if it's changed. This avoids consing in
11105 the common case where it hasn't. (If it turns out that we've
11106 already wasted too much time by walking through the list with
11107 display_mode_element, then we might need to optimize at a
11108 higher level than this.) */
11109 if (! STRINGP (f
->name
)
11110 || SBYTES (f
->name
) != len
11111 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11112 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11116 #endif /* not HAVE_WINDOW_SYSTEM */
11119 /***********************************************************************
11121 ***********************************************************************/
11124 /* Prepare for redisplay by updating menu-bar item lists when
11125 appropriate. This can call eval. */
11128 prepare_menu_bars (void)
11131 struct gcpro gcpro1
, gcpro2
;
11133 Lisp_Object tooltip_frame
;
11135 #ifdef HAVE_WINDOW_SYSTEM
11136 tooltip_frame
= tip_frame
;
11138 tooltip_frame
= Qnil
;
11141 /* Update all frame titles based on their buffer names, etc. We do
11142 this before the menu bars so that the buffer-menu will show the
11143 up-to-date frame titles. */
11144 #ifdef HAVE_WINDOW_SYSTEM
11145 if (windows_or_buffers_changed
|| update_mode_lines
)
11147 Lisp_Object tail
, frame
;
11149 FOR_EACH_FRAME (tail
, frame
)
11151 f
= XFRAME (frame
);
11152 if (!EQ (frame
, tooltip_frame
)
11153 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
11154 x_consider_frame_title (frame
);
11157 #endif /* HAVE_WINDOW_SYSTEM */
11159 /* Update the menu bar item lists, if appropriate. This has to be
11160 done before any actual redisplay or generation of display lines. */
11161 all_windows
= (update_mode_lines
11162 || buffer_shared
> 1
11163 || windows_or_buffers_changed
);
11166 Lisp_Object tail
, frame
;
11167 ptrdiff_t count
= SPECPDL_INDEX ();
11168 /* 1 means that update_menu_bar has run its hooks
11169 so any further calls to update_menu_bar shouldn't do so again. */
11170 int menu_bar_hooks_run
= 0;
11172 record_unwind_save_match_data ();
11174 FOR_EACH_FRAME (tail
, frame
)
11176 f
= XFRAME (frame
);
11178 /* Ignore tooltip frame. */
11179 if (EQ (frame
, tooltip_frame
))
11182 /* If a window on this frame changed size, report that to
11183 the user and clear the size-change flag. */
11184 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11186 Lisp_Object functions
;
11188 /* Clear flag first in case we get an error below. */
11189 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11190 functions
= Vwindow_size_change_functions
;
11191 GCPRO2 (tail
, functions
);
11193 while (CONSP (functions
))
11195 if (!EQ (XCAR (functions
), Qt
))
11196 call1 (XCAR (functions
), frame
);
11197 functions
= XCDR (functions
);
11203 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11204 #ifdef HAVE_WINDOW_SYSTEM
11205 update_tool_bar (f
, 0);
11208 if (windows_or_buffers_changed
11211 (f
, Fbuffer_modified_p (XWINDOW (f
->selected_window
)->buffer
));
11216 unbind_to (count
, Qnil
);
11220 struct frame
*sf
= SELECTED_FRAME ();
11221 update_menu_bar (sf
, 1, 0);
11222 #ifdef HAVE_WINDOW_SYSTEM
11223 update_tool_bar (sf
, 1);
11229 /* Update the menu bar item list for frame F. This has to be done
11230 before we start to fill in any display lines, because it can call
11233 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11235 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11236 already ran the menu bar hooks for this redisplay, so there
11237 is no need to run them again. The return value is the
11238 updated value of this flag, to pass to the next call. */
11241 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11243 Lisp_Object window
;
11244 register struct window
*w
;
11246 /* If called recursively during a menu update, do nothing. This can
11247 happen when, for instance, an activate-menubar-hook causes a
11249 if (inhibit_menubar_update
)
11252 window
= FRAME_SELECTED_WINDOW (f
);
11253 w
= XWINDOW (window
);
11255 if (FRAME_WINDOW_P (f
)
11257 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11258 || defined (HAVE_NS) || defined (USE_GTK)
11259 FRAME_EXTERNAL_MENU_BAR (f
)
11261 FRAME_MENU_BAR_LINES (f
) > 0
11263 : FRAME_MENU_BAR_LINES (f
) > 0)
11265 /* If the user has switched buffers or windows, we need to
11266 recompute to reflect the new bindings. But we'll
11267 recompute when update_mode_lines is set too; that means
11268 that people can use force-mode-line-update to request
11269 that the menu bar be recomputed. The adverse effect on
11270 the rest of the redisplay algorithm is about the same as
11271 windows_or_buffers_changed anyway. */
11272 if (windows_or_buffers_changed
11273 /* This used to test w->update_mode_line, but we believe
11274 there is no need to recompute the menu in that case. */
11275 || update_mode_lines
11276 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11277 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11278 != w
->last_had_star
)
11279 || ((!NILP (Vtransient_mark_mode
)
11280 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11281 != !NILP (w
->region_showing
)))
11283 struct buffer
*prev
= current_buffer
;
11284 ptrdiff_t count
= SPECPDL_INDEX ();
11286 specbind (Qinhibit_menubar_update
, Qt
);
11288 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11289 if (save_match_data
)
11290 record_unwind_save_match_data ();
11291 if (NILP (Voverriding_local_map_menu_flag
))
11293 specbind (Qoverriding_terminal_local_map
, Qnil
);
11294 specbind (Qoverriding_local_map
, Qnil
);
11299 /* Run the Lucid hook. */
11300 safe_run_hooks (Qactivate_menubar_hook
);
11302 /* If it has changed current-menubar from previous value,
11303 really recompute the menu-bar from the value. */
11304 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11305 call0 (Qrecompute_lucid_menubar
);
11307 safe_run_hooks (Qmenu_bar_update_hook
);
11312 XSETFRAME (Vmenu_updating_frame
, f
);
11313 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11315 /* Redisplay the menu bar in case we changed it. */
11316 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11317 || defined (HAVE_NS) || defined (USE_GTK)
11318 if (FRAME_WINDOW_P (f
))
11320 #if defined (HAVE_NS)
11321 /* All frames on Mac OS share the same menubar. So only
11322 the selected frame should be allowed to set it. */
11323 if (f
== SELECTED_FRAME ())
11325 set_frame_menubar (f
, 0, 0);
11328 /* On a terminal screen, the menu bar is an ordinary screen
11329 line, and this makes it get updated. */
11330 w
->update_mode_line
= 1;
11331 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11332 /* In the non-toolkit version, the menu bar is an ordinary screen
11333 line, and this makes it get updated. */
11334 w
->update_mode_line
= 1;
11335 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11337 unbind_to (count
, Qnil
);
11338 set_buffer_internal_1 (prev
);
11347 /***********************************************************************
11349 ***********************************************************************/
11351 #ifdef HAVE_WINDOW_SYSTEM
11354 Nominal cursor position -- where to draw output.
11355 HPOS and VPOS are window relative glyph matrix coordinates.
11356 X and Y are window relative pixel coordinates. */
11358 struct cursor_pos output_cursor
;
11362 Set the global variable output_cursor to CURSOR. All cursor
11363 positions are relative to updated_window. */
11366 set_output_cursor (struct cursor_pos
*cursor
)
11368 output_cursor
.hpos
= cursor
->hpos
;
11369 output_cursor
.vpos
= cursor
->vpos
;
11370 output_cursor
.x
= cursor
->x
;
11371 output_cursor
.y
= cursor
->y
;
11376 Set a nominal cursor position.
11378 HPOS and VPOS are column/row positions in a window glyph matrix. X
11379 and Y are window text area relative pixel positions.
11381 If this is done during an update, updated_window will contain the
11382 window that is being updated and the position is the future output
11383 cursor position for that window. If updated_window is null, use
11384 selected_window and display the cursor at the given position. */
11387 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
11391 /* If updated_window is not set, work on selected_window. */
11392 if (updated_window
)
11393 w
= updated_window
;
11395 w
= XWINDOW (selected_window
);
11397 /* Set the output cursor. */
11398 output_cursor
.hpos
= hpos
;
11399 output_cursor
.vpos
= vpos
;
11400 output_cursor
.x
= x
;
11401 output_cursor
.y
= y
;
11403 /* If not called as part of an update, really display the cursor.
11404 This will also set the cursor position of W. */
11405 if (updated_window
== NULL
)
11408 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
11409 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11410 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11415 #endif /* HAVE_WINDOW_SYSTEM */
11418 /***********************************************************************
11420 ***********************************************************************/
11422 #ifdef HAVE_WINDOW_SYSTEM
11424 /* Where the mouse was last time we reported a mouse event. */
11426 FRAME_PTR last_mouse_frame
;
11428 /* Tool-bar item index of the item on which a mouse button was pressed
11431 int last_tool_bar_item
;
11435 update_tool_bar_unwind (Lisp_Object frame
)
11437 selected_frame
= frame
;
11441 /* Update the tool-bar item list for frame F. This has to be done
11442 before we start to fill in any display lines. Called from
11443 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11444 and restore it here. */
11447 update_tool_bar (struct frame
*f
, int save_match_data
)
11449 #if defined (USE_GTK) || defined (HAVE_NS)
11450 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11452 int do_update
= WINDOWP (f
->tool_bar_window
)
11453 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11458 Lisp_Object window
;
11461 window
= FRAME_SELECTED_WINDOW (f
);
11462 w
= XWINDOW (window
);
11464 /* If the user has switched buffers or windows, we need to
11465 recompute to reflect the new bindings. But we'll
11466 recompute when update_mode_lines is set too; that means
11467 that people can use force-mode-line-update to request
11468 that the menu bar be recomputed. The adverse effect on
11469 the rest of the redisplay algorithm is about the same as
11470 windows_or_buffers_changed anyway. */
11471 if (windows_or_buffers_changed
11472 || w
->update_mode_line
11473 || update_mode_lines
11474 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11475 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11476 != w
->last_had_star
)
11477 || ((!NILP (Vtransient_mark_mode
)
11478 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11479 != !NILP (w
->region_showing
)))
11481 struct buffer
*prev
= current_buffer
;
11482 ptrdiff_t count
= SPECPDL_INDEX ();
11483 Lisp_Object frame
, new_tool_bar
;
11484 int new_n_tool_bar
;
11485 struct gcpro gcpro1
;
11487 /* Set current_buffer to the buffer of the selected
11488 window of the frame, so that we get the right local
11490 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11492 /* Save match data, if we must. */
11493 if (save_match_data
)
11494 record_unwind_save_match_data ();
11496 /* Make sure that we don't accidentally use bogus keymaps. */
11497 if (NILP (Voverriding_local_map_menu_flag
))
11499 specbind (Qoverriding_terminal_local_map
, Qnil
);
11500 specbind (Qoverriding_local_map
, Qnil
);
11503 GCPRO1 (new_tool_bar
);
11505 /* We must temporarily set the selected frame to this frame
11506 before calling tool_bar_items, because the calculation of
11507 the tool-bar keymap uses the selected frame (see
11508 `tool-bar-make-keymap' in tool-bar.el). */
11509 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
11510 XSETFRAME (frame
, f
);
11511 selected_frame
= frame
;
11513 /* Build desired tool-bar items from keymaps. */
11515 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11518 /* Redisplay the tool-bar if we changed it. */
11519 if (new_n_tool_bar
!= f
->n_tool_bar_items
11520 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11522 /* Redisplay that happens asynchronously due to an expose event
11523 may access f->tool_bar_items. Make sure we update both
11524 variables within BLOCK_INPUT so no such event interrupts. */
11526 fset_tool_bar_items (f
, new_tool_bar
);
11527 f
->n_tool_bar_items
= new_n_tool_bar
;
11528 w
->update_mode_line
= 1;
11534 unbind_to (count
, Qnil
);
11535 set_buffer_internal_1 (prev
);
11541 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11542 F's desired tool-bar contents. F->tool_bar_items must have
11543 been set up previously by calling prepare_menu_bars. */
11546 build_desired_tool_bar_string (struct frame
*f
)
11548 int i
, size
, size_needed
;
11549 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11550 Lisp_Object image
, plist
, props
;
11552 image
= plist
= props
= Qnil
;
11553 GCPRO3 (image
, plist
, props
);
11555 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11556 Otherwise, make a new string. */
11558 /* The size of the string we might be able to reuse. */
11559 size
= (STRINGP (f
->desired_tool_bar_string
)
11560 ? SCHARS (f
->desired_tool_bar_string
)
11563 /* We need one space in the string for each image. */
11564 size_needed
= f
->n_tool_bar_items
;
11566 /* Reuse f->desired_tool_bar_string, if possible. */
11567 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11568 fset_desired_tool_bar_string
11569 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11572 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11573 Fremove_text_properties (make_number (0), make_number (size
),
11574 props
, f
->desired_tool_bar_string
);
11577 /* Put a `display' property on the string for the images to display,
11578 put a `menu_item' property on tool-bar items with a value that
11579 is the index of the item in F's tool-bar item vector. */
11580 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11582 #define PROP(IDX) \
11583 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11585 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11586 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11587 int hmargin
, vmargin
, relief
, idx
, end
;
11589 /* If image is a vector, choose the image according to the
11591 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11592 if (VECTORP (image
))
11596 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11597 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11600 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11601 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11603 eassert (ASIZE (image
) >= idx
);
11604 image
= AREF (image
, idx
);
11609 /* Ignore invalid image specifications. */
11610 if (!valid_image_p (image
))
11613 /* Display the tool-bar button pressed, or depressed. */
11614 plist
= Fcopy_sequence (XCDR (image
));
11616 /* Compute margin and relief to draw. */
11617 relief
= (tool_bar_button_relief
>= 0
11618 ? tool_bar_button_relief
11619 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11620 hmargin
= vmargin
= relief
;
11622 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
11623 INT_MAX
- max (hmargin
, vmargin
)))
11625 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11626 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11628 else if (CONSP (Vtool_bar_button_margin
))
11630 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
11631 INT_MAX
- hmargin
))
11632 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11634 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
11635 INT_MAX
- vmargin
))
11636 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11639 if (auto_raise_tool_bar_buttons_p
)
11641 /* Add a `:relief' property to the image spec if the item is
11645 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11652 /* If image is selected, display it pressed, i.e. with a
11653 negative relief. If it's not selected, display it with a
11655 plist
= Fplist_put (plist
, QCrelief
,
11657 ? make_number (-relief
)
11658 : make_number (relief
)));
11663 /* Put a margin around the image. */
11664 if (hmargin
|| vmargin
)
11666 if (hmargin
== vmargin
)
11667 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11669 plist
= Fplist_put (plist
, QCmargin
,
11670 Fcons (make_number (hmargin
),
11671 make_number (vmargin
)));
11674 /* If button is not enabled, and we don't have special images
11675 for the disabled state, make the image appear disabled by
11676 applying an appropriate algorithm to it. */
11677 if (!enabled_p
&& idx
< 0)
11678 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11680 /* Put a `display' text property on the string for the image to
11681 display. Put a `menu-item' property on the string that gives
11682 the start of this item's properties in the tool-bar items
11684 image
= Fcons (Qimage
, plist
);
11685 props
= list4 (Qdisplay
, image
,
11686 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11688 /* Let the last image hide all remaining spaces in the tool bar
11689 string. The string can be longer than needed when we reuse a
11690 previous string. */
11691 if (i
+ 1 == f
->n_tool_bar_items
)
11692 end
= SCHARS (f
->desired_tool_bar_string
);
11695 Fadd_text_properties (make_number (i
), make_number (end
),
11696 props
, f
->desired_tool_bar_string
);
11704 /* Display one line of the tool-bar of frame IT->f.
11706 HEIGHT specifies the desired height of the tool-bar line.
11707 If the actual height of the glyph row is less than HEIGHT, the
11708 row's height is increased to HEIGHT, and the icons are centered
11709 vertically in the new height.
11711 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11712 count a final empty row in case the tool-bar width exactly matches
11717 display_tool_bar_line (struct it
*it
, int height
)
11719 struct glyph_row
*row
= it
->glyph_row
;
11720 int max_x
= it
->last_visible_x
;
11721 struct glyph
*last
;
11723 prepare_desired_row (row
);
11724 row
->y
= it
->current_y
;
11726 /* Note that this isn't made use of if the face hasn't a box,
11727 so there's no need to check the face here. */
11728 it
->start_of_box_run_p
= 1;
11730 while (it
->current_x
< max_x
)
11732 int x
, n_glyphs_before
, i
, nglyphs
;
11733 struct it it_before
;
11735 /* Get the next display element. */
11736 if (!get_next_display_element (it
))
11738 /* Don't count empty row if we are counting needed tool-bar lines. */
11739 if (height
< 0 && !it
->hpos
)
11744 /* Produce glyphs. */
11745 n_glyphs_before
= row
->used
[TEXT_AREA
];
11748 PRODUCE_GLYPHS (it
);
11750 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11752 x
= it_before
.current_x
;
11753 while (i
< nglyphs
)
11755 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11757 if (x
+ glyph
->pixel_width
> max_x
)
11759 /* Glyph doesn't fit on line. Backtrack. */
11760 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11762 /* If this is the only glyph on this line, it will never fit on the
11763 tool-bar, so skip it. But ensure there is at least one glyph,
11764 so we don't accidentally disable the tool-bar. */
11765 if (n_glyphs_before
== 0
11766 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11772 x
+= glyph
->pixel_width
;
11776 /* Stop at line end. */
11777 if (ITERATOR_AT_END_OF_LINE_P (it
))
11780 set_iterator_to_next (it
, 1);
11785 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11787 /* Use default face for the border below the tool bar.
11789 FIXME: When auto-resize-tool-bars is grow-only, there is
11790 no additional border below the possibly empty tool-bar lines.
11791 So to make the extra empty lines look "normal", we have to
11792 use the tool-bar face for the border too. */
11793 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11794 it
->face_id
= DEFAULT_FACE_ID
;
11796 extend_face_to_end_of_line (it
);
11797 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11798 last
->right_box_line_p
= 1;
11799 if (last
== row
->glyphs
[TEXT_AREA
])
11800 last
->left_box_line_p
= 1;
11802 /* Make line the desired height and center it vertically. */
11803 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11805 /* Don't add more than one line height. */
11806 height
%= FRAME_LINE_HEIGHT (it
->f
);
11807 it
->max_ascent
+= height
/ 2;
11808 it
->max_descent
+= (height
+ 1) / 2;
11811 compute_line_metrics (it
);
11813 /* If line is empty, make it occupy the rest of the tool-bar. */
11814 if (!row
->displays_text_p
)
11816 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11817 row
->visible_height
= row
->height
;
11818 row
->ascent
= row
->phys_ascent
= 0;
11819 row
->extra_line_spacing
= 0;
11822 row
->full_width_p
= 1;
11823 row
->continued_p
= 0;
11824 row
->truncated_on_left_p
= 0;
11825 row
->truncated_on_right_p
= 0;
11827 it
->current_x
= it
->hpos
= 0;
11828 it
->current_y
+= row
->height
;
11834 /* Max tool-bar height. */
11836 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11837 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11839 /* Value is the number of screen lines needed to make all tool-bar
11840 items of frame F visible. The number of actual rows needed is
11841 returned in *N_ROWS if non-NULL. */
11844 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11846 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11848 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11849 the desired matrix, so use (unused) mode-line row as temporary row to
11850 avoid destroying the first tool-bar row. */
11851 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11853 /* Initialize an iterator for iteration over
11854 F->desired_tool_bar_string in the tool-bar window of frame F. */
11855 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11856 it
.first_visible_x
= 0;
11857 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11858 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11859 it
.paragraph_embedding
= L2R
;
11861 while (!ITERATOR_AT_END_P (&it
))
11863 clear_glyph_row (temp_row
);
11864 it
.glyph_row
= temp_row
;
11865 display_tool_bar_line (&it
, -1);
11867 clear_glyph_row (temp_row
);
11869 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11871 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11873 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11877 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11879 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11880 (Lisp_Object frame
)
11887 frame
= selected_frame
;
11889 CHECK_FRAME (frame
);
11890 f
= XFRAME (frame
);
11892 if (WINDOWP (f
->tool_bar_window
)
11893 && (w
= XWINDOW (f
->tool_bar_window
),
11894 WINDOW_TOTAL_LINES (w
) > 0))
11896 update_tool_bar (f
, 1);
11897 if (f
->n_tool_bar_items
)
11899 build_desired_tool_bar_string (f
);
11900 nlines
= tool_bar_lines_needed (f
, NULL
);
11904 return make_number (nlines
);
11908 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11909 height should be changed. */
11912 redisplay_tool_bar (struct frame
*f
)
11916 struct glyph_row
*row
;
11918 #if defined (USE_GTK) || defined (HAVE_NS)
11919 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11920 update_frame_tool_bar (f
);
11924 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11925 do anything. This means you must start with tool-bar-lines
11926 non-zero to get the auto-sizing effect. Or in other words, you
11927 can turn off tool-bars by specifying tool-bar-lines zero. */
11928 if (!WINDOWP (f
->tool_bar_window
)
11929 || (w
= XWINDOW (f
->tool_bar_window
),
11930 WINDOW_TOTAL_LINES (w
) == 0))
11933 /* Set up an iterator for the tool-bar window. */
11934 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11935 it
.first_visible_x
= 0;
11936 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11937 row
= it
.glyph_row
;
11939 /* Build a string that represents the contents of the tool-bar. */
11940 build_desired_tool_bar_string (f
);
11941 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11942 /* FIXME: This should be controlled by a user option. But it
11943 doesn't make sense to have an R2L tool bar if the menu bar cannot
11944 be drawn also R2L, and making the menu bar R2L is tricky due
11945 toolkit-specific code that implements it. If an R2L tool bar is
11946 ever supported, display_tool_bar_line should also be augmented to
11947 call unproduce_glyphs like display_line and display_string
11949 it
.paragraph_embedding
= L2R
;
11951 if (f
->n_tool_bar_rows
== 0)
11955 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11956 nlines
!= WINDOW_TOTAL_LINES (w
)))
11959 int old_height
= WINDOW_TOTAL_LINES (w
);
11961 XSETFRAME (frame
, f
);
11962 Fmodify_frame_parameters (frame
,
11963 Fcons (Fcons (Qtool_bar_lines
,
11964 make_number (nlines
)),
11966 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11968 clear_glyph_matrix (w
->desired_matrix
);
11969 fonts_changed_p
= 1;
11975 /* Display as many lines as needed to display all tool-bar items. */
11977 if (f
->n_tool_bar_rows
> 0)
11979 int border
, rows
, height
, extra
;
11981 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
11982 border
= XINT (Vtool_bar_border
);
11983 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11984 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11985 else if (EQ (Vtool_bar_border
, Qborder_width
))
11986 border
= f
->border_width
;
11992 rows
= f
->n_tool_bar_rows
;
11993 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11994 extra
= it
.last_visible_y
- border
- height
* rows
;
11996 while (it
.current_y
< it
.last_visible_y
)
11999 if (extra
> 0 && rows
-- > 0)
12001 h
= (extra
+ rows
- 1) / rows
;
12004 display_tool_bar_line (&it
, height
+ h
);
12009 while (it
.current_y
< it
.last_visible_y
)
12010 display_tool_bar_line (&it
, 0);
12013 /* It doesn't make much sense to try scrolling in the tool-bar
12014 window, so don't do it. */
12015 w
->desired_matrix
->no_scrolling_p
= 1;
12016 w
->must_be_updated_p
= 1;
12018 if (!NILP (Vauto_resize_tool_bars
))
12020 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
12021 int change_height_p
= 0;
12023 /* If we couldn't display everything, change the tool-bar's
12024 height if there is room for more. */
12025 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
12026 && it
.current_y
< max_tool_bar_height
)
12027 change_height_p
= 1;
12029 row
= it
.glyph_row
- 1;
12031 /* If there are blank lines at the end, except for a partially
12032 visible blank line at the end that is smaller than
12033 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12034 if (!row
->displays_text_p
12035 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12036 change_height_p
= 1;
12038 /* If row displays tool-bar items, but is partially visible,
12039 change the tool-bar's height. */
12040 if (row
->displays_text_p
12041 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
12042 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
12043 change_height_p
= 1;
12045 /* Resize windows as needed by changing the `tool-bar-lines'
12046 frame parameter. */
12047 if (change_height_p
)
12050 int old_height
= WINDOW_TOTAL_LINES (w
);
12052 int nlines
= tool_bar_lines_needed (f
, &nrows
);
12054 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12055 && !f
->minimize_tool_bar_window_p
)
12056 ? (nlines
> old_height
)
12057 : (nlines
!= old_height
));
12058 f
->minimize_tool_bar_window_p
= 0;
12060 if (change_height_p
)
12062 XSETFRAME (frame
, f
);
12063 Fmodify_frame_parameters (frame
,
12064 Fcons (Fcons (Qtool_bar_lines
,
12065 make_number (nlines
)),
12067 if (WINDOW_TOTAL_LINES (w
) != old_height
)
12069 clear_glyph_matrix (w
->desired_matrix
);
12070 f
->n_tool_bar_rows
= nrows
;
12071 fonts_changed_p
= 1;
12078 f
->minimize_tool_bar_window_p
= 0;
12083 /* Get information about the tool-bar item which is displayed in GLYPH
12084 on frame F. Return in *PROP_IDX the index where tool-bar item
12085 properties start in F->tool_bar_items. Value is zero if
12086 GLYPH doesn't display a tool-bar item. */
12089 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12095 /* This function can be called asynchronously, which means we must
12096 exclude any possibility that Fget_text_property signals an
12098 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12099 charpos
= max (0, charpos
);
12101 /* Get the text property `menu-item' at pos. The value of that
12102 property is the start index of this item's properties in
12103 F->tool_bar_items. */
12104 prop
= Fget_text_property (make_number (charpos
),
12105 Qmenu_item
, f
->current_tool_bar_string
);
12106 if (INTEGERP (prop
))
12108 *prop_idx
= XINT (prop
);
12118 /* Get information about the tool-bar item at position X/Y on frame F.
12119 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12120 the current matrix of the tool-bar window of F, or NULL if not
12121 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12122 item in F->tool_bar_items. Value is
12124 -1 if X/Y is not on a tool-bar item
12125 0 if X/Y is on the same item that was highlighted before.
12129 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12130 int *hpos
, int *vpos
, int *prop_idx
)
12132 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12133 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12136 /* Find the glyph under X/Y. */
12137 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12138 if (*glyph
== NULL
)
12141 /* Get the start of this tool-bar item's properties in
12142 f->tool_bar_items. */
12143 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12146 /* Is mouse on the highlighted item? */
12147 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12148 && *vpos
>= hlinfo
->mouse_face_beg_row
12149 && *vpos
<= hlinfo
->mouse_face_end_row
12150 && (*vpos
> hlinfo
->mouse_face_beg_row
12151 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12152 && (*vpos
< hlinfo
->mouse_face_end_row
12153 || *hpos
< hlinfo
->mouse_face_end_col
12154 || hlinfo
->mouse_face_past_end
))
12162 Handle mouse button event on the tool-bar of frame F, at
12163 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12164 0 for button release. MODIFIERS is event modifiers for button
12168 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12171 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12172 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12173 int hpos
, vpos
, prop_idx
;
12174 struct glyph
*glyph
;
12175 Lisp_Object enabled_p
;
12177 /* If not on the highlighted tool-bar item, return. */
12178 frame_to_window_pixel_xy (w
, &x
, &y
);
12179 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
12182 /* If item is disabled, do nothing. */
12183 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12184 if (NILP (enabled_p
))
12189 /* Show item in pressed state. */
12190 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12191 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
12192 last_tool_bar_item
= prop_idx
;
12196 Lisp_Object key
, frame
;
12197 struct input_event event
;
12198 EVENT_INIT (event
);
12200 /* Show item in released state. */
12201 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12202 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
12204 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12206 XSETFRAME (frame
, f
);
12207 event
.kind
= TOOL_BAR_EVENT
;
12208 event
.frame_or_window
= frame
;
12210 kbd_buffer_store_event (&event
);
12212 event
.kind
= TOOL_BAR_EVENT
;
12213 event
.frame_or_window
= frame
;
12215 event
.modifiers
= modifiers
;
12216 kbd_buffer_store_event (&event
);
12217 last_tool_bar_item
= -1;
12222 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12223 tool-bar window-relative coordinates X/Y. Called from
12224 note_mouse_highlight. */
12227 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12229 Lisp_Object window
= f
->tool_bar_window
;
12230 struct window
*w
= XWINDOW (window
);
12231 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
12232 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12234 struct glyph
*glyph
;
12235 struct glyph_row
*row
;
12237 Lisp_Object enabled_p
;
12239 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12240 int mouse_down_p
, rc
;
12242 /* Function note_mouse_highlight is called with negative X/Y
12243 values when mouse moves outside of the frame. */
12244 if (x
<= 0 || y
<= 0)
12246 clear_mouse_face (hlinfo
);
12250 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12253 /* Not on tool-bar item. */
12254 clear_mouse_face (hlinfo
);
12258 /* On same tool-bar item as before. */
12259 goto set_help_echo
;
12261 clear_mouse_face (hlinfo
);
12263 /* Mouse is down, but on different tool-bar item? */
12264 mouse_down_p
= (dpyinfo
->grabbed
12265 && f
== last_mouse_frame
12266 && FRAME_LIVE_P (f
));
12268 && last_tool_bar_item
!= prop_idx
)
12271 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
12272 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12274 /* If tool-bar item is not enabled, don't highlight it. */
12275 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12276 if (!NILP (enabled_p
))
12278 /* Compute the x-position of the glyph. In front and past the
12279 image is a space. We include this in the highlighted area. */
12280 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12281 for (i
= x
= 0; i
< hpos
; ++i
)
12282 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12284 /* Record this as the current active region. */
12285 hlinfo
->mouse_face_beg_col
= hpos
;
12286 hlinfo
->mouse_face_beg_row
= vpos
;
12287 hlinfo
->mouse_face_beg_x
= x
;
12288 hlinfo
->mouse_face_beg_y
= row
->y
;
12289 hlinfo
->mouse_face_past_end
= 0;
12291 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12292 hlinfo
->mouse_face_end_row
= vpos
;
12293 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12294 hlinfo
->mouse_face_end_y
= row
->y
;
12295 hlinfo
->mouse_face_window
= window
;
12296 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12298 /* Display it as active. */
12299 show_mouse_face (hlinfo
, draw
);
12300 hlinfo
->mouse_face_image_state
= draw
;
12305 /* Set help_echo_string to a help string to display for this tool-bar item.
12306 XTread_socket does the rest. */
12307 help_echo_object
= help_echo_window
= Qnil
;
12308 help_echo_pos
= -1;
12309 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12310 if (NILP (help_echo_string
))
12311 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12314 #endif /* HAVE_WINDOW_SYSTEM */
12318 /************************************************************************
12319 Horizontal scrolling
12320 ************************************************************************/
12322 static int hscroll_window_tree (Lisp_Object
);
12323 static int hscroll_windows (Lisp_Object
);
12325 /* For all leaf windows in the window tree rooted at WINDOW, set their
12326 hscroll value so that PT is (i) visible in the window, and (ii) so
12327 that it is not within a certain margin at the window's left and
12328 right border. Value is non-zero if any window's hscroll has been
12332 hscroll_window_tree (Lisp_Object window
)
12334 int hscrolled_p
= 0;
12335 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12336 int hscroll_step_abs
= 0;
12337 double hscroll_step_rel
= 0;
12339 if (hscroll_relative_p
)
12341 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12342 if (hscroll_step_rel
< 0)
12344 hscroll_relative_p
= 0;
12345 hscroll_step_abs
= 0;
12348 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12350 hscroll_step_abs
= XINT (Vhscroll_step
);
12351 if (hscroll_step_abs
< 0)
12352 hscroll_step_abs
= 0;
12355 hscroll_step_abs
= 0;
12357 while (WINDOWP (window
))
12359 struct window
*w
= XWINDOW (window
);
12361 if (WINDOWP (w
->hchild
))
12362 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
12363 else if (WINDOWP (w
->vchild
))
12364 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
12365 else if (w
->cursor
.vpos
>= 0)
12368 int text_area_width
;
12369 struct glyph_row
*current_cursor_row
12370 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12371 struct glyph_row
*desired_cursor_row
12372 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12373 struct glyph_row
*cursor_row
12374 = (desired_cursor_row
->enabled_p
12375 ? desired_cursor_row
12376 : current_cursor_row
);
12377 int row_r2l_p
= cursor_row
->reversed_p
;
12379 text_area_width
= window_box_width (w
, TEXT_AREA
);
12381 /* Scroll when cursor is inside this scroll margin. */
12382 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12384 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
12385 /* For left-to-right rows, hscroll when cursor is either
12386 (i) inside the right hscroll margin, or (ii) if it is
12387 inside the left margin and the window is already
12391 && w
->cursor
.x
<= h_margin
)
12392 || (cursor_row
->enabled_p
12393 && cursor_row
->truncated_on_right_p
12394 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12395 /* For right-to-left rows, the logic is similar,
12396 except that rules for scrolling to left and right
12397 are reversed. E.g., if cursor.x <= h_margin, we
12398 need to hscroll "to the right" unconditionally,
12399 and that will scroll the screen to the left so as
12400 to reveal the next portion of the row. */
12402 && ((cursor_row
->enabled_p
12403 /* FIXME: It is confusing to set the
12404 truncated_on_right_p flag when R2L rows
12405 are actually truncated on the left. */
12406 && cursor_row
->truncated_on_right_p
12407 && w
->cursor
.x
<= h_margin
)
12409 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12413 struct buffer
*saved_current_buffer
;
12417 /* Find point in a display of infinite width. */
12418 saved_current_buffer
= current_buffer
;
12419 current_buffer
= XBUFFER (w
->buffer
);
12421 if (w
== XWINDOW (selected_window
))
12425 pt
= marker_position (w
->pointm
);
12426 pt
= max (BEGV
, pt
);
12430 /* Move iterator to pt starting at cursor_row->start in
12431 a line with infinite width. */
12432 init_to_row_start (&it
, w
, cursor_row
);
12433 it
.last_visible_x
= INFINITY
;
12434 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12435 current_buffer
= saved_current_buffer
;
12437 /* Position cursor in window. */
12438 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12439 hscroll
= max (0, (it
.current_x
12440 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12441 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12442 : (text_area_width
/ 2))))
12443 / FRAME_COLUMN_WIDTH (it
.f
);
12444 else if ((!row_r2l_p
12445 && w
->cursor
.x
>= text_area_width
- h_margin
)
12446 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12448 if (hscroll_relative_p
)
12449 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12452 wanted_x
= text_area_width
12453 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12456 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12460 if (hscroll_relative_p
)
12461 wanted_x
= text_area_width
* hscroll_step_rel
12464 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12467 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12469 hscroll
= max (hscroll
, w
->min_hscroll
);
12471 /* Don't prevent redisplay optimizations if hscroll
12472 hasn't changed, as it will unnecessarily slow down
12474 if (w
->hscroll
!= hscroll
)
12476 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
12477 w
->hscroll
= hscroll
;
12486 /* Value is non-zero if hscroll of any leaf window has been changed. */
12487 return hscrolled_p
;
12491 /* Set hscroll so that cursor is visible and not inside horizontal
12492 scroll margins for all windows in the tree rooted at WINDOW. See
12493 also hscroll_window_tree above. Value is non-zero if any window's
12494 hscroll has been changed. If it has, desired matrices on the frame
12495 of WINDOW are cleared. */
12498 hscroll_windows (Lisp_Object window
)
12500 int hscrolled_p
= hscroll_window_tree (window
);
12502 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12503 return hscrolled_p
;
12508 /************************************************************************
12510 ************************************************************************/
12512 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12513 to a non-zero value. This is sometimes handy to have in a debugger
12518 /* First and last unchanged row for try_window_id. */
12520 static int debug_first_unchanged_at_end_vpos
;
12521 static int debug_last_unchanged_at_beg_vpos
;
12523 /* Delta vpos and y. */
12525 static int debug_dvpos
, debug_dy
;
12527 /* Delta in characters and bytes for try_window_id. */
12529 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12531 /* Values of window_end_pos and window_end_vpos at the end of
12534 static ptrdiff_t debug_end_vpos
;
12536 /* Append a string to W->desired_matrix->method. FMT is a printf
12537 format string. If trace_redisplay_p is non-zero also printf the
12538 resulting string to stderr. */
12540 static void debug_method_add (struct window
*, char const *, ...)
12541 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12544 debug_method_add (struct window
*w
, char const *fmt
, ...)
12546 char *method
= w
->desired_matrix
->method
;
12547 int len
= strlen (method
);
12548 int size
= sizeof w
->desired_matrix
->method
;
12549 int remaining
= size
- len
- 1;
12552 if (len
&& remaining
)
12555 --remaining
, ++len
;
12558 va_start (ap
, fmt
);
12559 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
12562 if (trace_redisplay_p
)
12563 fprintf (stderr
, "%p (%s): %s\n",
12565 ((BUFFERP (w
->buffer
)
12566 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12567 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12572 #endif /* GLYPH_DEBUG */
12575 /* Value is non-zero if all changes in window W, which displays
12576 current_buffer, are in the text between START and END. START is a
12577 buffer position, END is given as a distance from Z. Used in
12578 redisplay_internal for display optimization. */
12581 text_outside_line_unchanged_p (struct window
*w
,
12582 ptrdiff_t start
, ptrdiff_t end
)
12584 int unchanged_p
= 1;
12586 /* If text or overlays have changed, see where. */
12587 if (w
->last_modified
< MODIFF
12588 || w
->last_overlay_modified
< OVERLAY_MODIFF
)
12590 /* Gap in the line? */
12591 if (GPT
< start
|| Z
- GPT
< end
)
12594 /* Changes start in front of the line, or end after it? */
12596 && (BEG_UNCHANGED
< start
- 1
12597 || END_UNCHANGED
< end
))
12600 /* If selective display, can't optimize if changes start at the
12601 beginning of the line. */
12603 && INTEGERP (BVAR (current_buffer
, selective_display
))
12604 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12605 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12608 /* If there are overlays at the start or end of the line, these
12609 may have overlay strings with newlines in them. A change at
12610 START, for instance, may actually concern the display of such
12611 overlay strings as well, and they are displayed on different
12612 lines. So, quickly rule out this case. (For the future, it
12613 might be desirable to implement something more telling than
12614 just BEG/END_UNCHANGED.) */
12617 if (BEG
+ BEG_UNCHANGED
== start
12618 && overlay_touches_p (start
))
12620 if (END_UNCHANGED
== end
12621 && overlay_touches_p (Z
- end
))
12625 /* Under bidi reordering, adding or deleting a character in the
12626 beginning of a paragraph, before the first strong directional
12627 character, can change the base direction of the paragraph (unless
12628 the buffer specifies a fixed paragraph direction), which will
12629 require to redisplay the whole paragraph. It might be worthwhile
12630 to find the paragraph limits and widen the range of redisplayed
12631 lines to that, but for now just give up this optimization. */
12632 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12633 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12637 return unchanged_p
;
12641 /* Do a frame update, taking possible shortcuts into account. This is
12642 the main external entry point for redisplay.
12644 If the last redisplay displayed an echo area message and that message
12645 is no longer requested, we clear the echo area or bring back the
12646 mini-buffer if that is in use. */
12651 redisplay_internal ();
12656 overlay_arrow_string_or_property (Lisp_Object var
)
12660 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12663 return Voverlay_arrow_string
;
12666 /* Return 1 if there are any overlay-arrows in current_buffer. */
12668 overlay_arrow_in_current_buffer_p (void)
12672 for (vlist
= Voverlay_arrow_variable_list
;
12674 vlist
= XCDR (vlist
))
12676 Lisp_Object var
= XCAR (vlist
);
12679 if (!SYMBOLP (var
))
12681 val
= find_symbol_value (var
);
12683 && current_buffer
== XMARKER (val
)->buffer
)
12690 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12694 overlay_arrows_changed_p (void)
12698 for (vlist
= Voverlay_arrow_variable_list
;
12700 vlist
= XCDR (vlist
))
12702 Lisp_Object var
= XCAR (vlist
);
12703 Lisp_Object val
, pstr
;
12705 if (!SYMBOLP (var
))
12707 val
= find_symbol_value (var
);
12708 if (!MARKERP (val
))
12710 if (! EQ (COERCE_MARKER (val
),
12711 Fget (var
, Qlast_arrow_position
))
12712 || ! (pstr
= overlay_arrow_string_or_property (var
),
12713 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12719 /* Mark overlay arrows to be updated on next redisplay. */
12722 update_overlay_arrows (int up_to_date
)
12726 for (vlist
= Voverlay_arrow_variable_list
;
12728 vlist
= XCDR (vlist
))
12730 Lisp_Object var
= XCAR (vlist
);
12732 if (!SYMBOLP (var
))
12735 if (up_to_date
> 0)
12737 Lisp_Object val
= find_symbol_value (var
);
12738 Fput (var
, Qlast_arrow_position
,
12739 COERCE_MARKER (val
));
12740 Fput (var
, Qlast_arrow_string
,
12741 overlay_arrow_string_or_property (var
));
12743 else if (up_to_date
< 0
12744 || !NILP (Fget (var
, Qlast_arrow_position
)))
12746 Fput (var
, Qlast_arrow_position
, Qt
);
12747 Fput (var
, Qlast_arrow_string
, Qt
);
12753 /* Return overlay arrow string to display at row.
12754 Return integer (bitmap number) for arrow bitmap in left fringe.
12755 Return nil if no overlay arrow. */
12758 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12762 for (vlist
= Voverlay_arrow_variable_list
;
12764 vlist
= XCDR (vlist
))
12766 Lisp_Object var
= XCAR (vlist
);
12769 if (!SYMBOLP (var
))
12772 val
= find_symbol_value (var
);
12775 && current_buffer
== XMARKER (val
)->buffer
12776 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12778 if (FRAME_WINDOW_P (it
->f
)
12779 /* FIXME: if ROW->reversed_p is set, this should test
12780 the right fringe, not the left one. */
12781 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12783 #ifdef HAVE_WINDOW_SYSTEM
12784 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12787 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12788 return make_number (fringe_bitmap
);
12791 return make_number (-1); /* Use default arrow bitmap. */
12793 return overlay_arrow_string_or_property (var
);
12800 /* Return 1 if point moved out of or into a composition. Otherwise
12801 return 0. PREV_BUF and PREV_PT are the last point buffer and
12802 position. BUF and PT are the current point buffer and position. */
12805 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
12806 struct buffer
*buf
, ptrdiff_t pt
)
12808 ptrdiff_t start
, end
;
12810 Lisp_Object buffer
;
12812 XSETBUFFER (buffer
, buf
);
12813 /* Check a composition at the last point if point moved within the
12815 if (prev_buf
== buf
)
12818 /* Point didn't move. */
12821 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12822 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12823 && COMPOSITION_VALID_P (start
, end
, prop
)
12824 && start
< prev_pt
&& end
> prev_pt
)
12825 /* The last point was within the composition. Return 1 iff
12826 point moved out of the composition. */
12827 return (pt
<= start
|| pt
>= end
);
12830 /* Check a composition at the current point. */
12831 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12832 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12833 && COMPOSITION_VALID_P (start
, end
, prop
)
12834 && start
< pt
&& end
> pt
);
12838 /* Reconsider the setting of B->clip_changed which is displayed
12842 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12844 if (b
->clip_changed
12845 && !NILP (w
->window_end_valid
)
12846 && w
->current_matrix
->buffer
== b
12847 && w
->current_matrix
->zv
== BUF_ZV (b
)
12848 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12849 b
->clip_changed
= 0;
12851 /* If display wasn't paused, and W is not a tool bar window, see if
12852 point has been moved into or out of a composition. In that case,
12853 we set b->clip_changed to 1 to force updating the screen. If
12854 b->clip_changed has already been set to 1, we can skip this
12856 if (!b
->clip_changed
12857 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12861 if (w
== XWINDOW (selected_window
))
12864 pt
= marker_position (w
->pointm
);
12866 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12867 || pt
!= w
->last_point
)
12868 && check_point_in_composition (w
->current_matrix
->buffer
,
12870 XBUFFER (w
->buffer
), pt
))
12871 b
->clip_changed
= 1;
12876 /* Select FRAME to forward the values of frame-local variables into C
12877 variables so that the redisplay routines can access those values
12881 select_frame_for_redisplay (Lisp_Object frame
)
12883 Lisp_Object tail
, tem
;
12884 Lisp_Object old
= selected_frame
;
12885 struct Lisp_Symbol
*sym
;
12887 eassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12889 selected_frame
= frame
;
12892 for (tail
= XFRAME (frame
)->param_alist
;
12893 CONSP (tail
); tail
= XCDR (tail
))
12894 if (CONSP (XCAR (tail
))
12895 && (tem
= XCAR (XCAR (tail
)),
12897 && (sym
= indirect_variable (XSYMBOL (tem
)),
12898 sym
->redirect
== SYMBOL_LOCALIZED
)
12899 && sym
->val
.blv
->frame_local
)
12900 /* Use find_symbol_value rather than Fsymbol_value
12901 to avoid an error if it is void. */
12902 find_symbol_value (tem
);
12903 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12907 #define STOP_POLLING \
12908 do { if (! polling_stopped_here) stop_polling (); \
12909 polling_stopped_here = 1; } while (0)
12911 #define RESUME_POLLING \
12912 do { if (polling_stopped_here) start_polling (); \
12913 polling_stopped_here = 0; } while (0)
12916 /* Perhaps in the future avoid recentering windows if it
12917 is not necessary; currently that causes some problems. */
12920 redisplay_internal (void)
12922 struct window
*w
= XWINDOW (selected_window
);
12926 int must_finish
= 0;
12927 struct text_pos tlbufpos
, tlendpos
;
12928 int number_of_visible_frames
;
12929 ptrdiff_t count
, count1
;
12931 int polling_stopped_here
= 0;
12932 Lisp_Object old_frame
= selected_frame
;
12933 struct backtrace backtrace
;
12935 /* Non-zero means redisplay has to consider all windows on all
12936 frames. Zero means, only selected_window is considered. */
12937 int consider_all_windows_p
;
12939 /* Non-zero means redisplay has to redisplay the miniwindow. */
12940 int update_miniwindow_p
= 0;
12942 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12944 /* No redisplay if running in batch mode or frame is not yet fully
12945 initialized, or redisplay is explicitly turned off by setting
12946 Vinhibit_redisplay. */
12947 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12948 || !NILP (Vinhibit_redisplay
))
12951 /* Don't examine these until after testing Vinhibit_redisplay.
12952 When Emacs is shutting down, perhaps because its connection to
12953 X has dropped, we should not look at them at all. */
12954 fr
= XFRAME (w
->frame
);
12955 sf
= SELECTED_FRAME ();
12957 if (!fr
->glyphs_initialized_p
)
12960 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12961 if (popup_activated ())
12965 /* I don't think this happens but let's be paranoid. */
12966 if (redisplaying_p
)
12969 /* Record a function that clears redisplaying_p
12970 when we leave this function. */
12971 count
= SPECPDL_INDEX ();
12972 record_unwind_protect (unwind_redisplay
, selected_frame
);
12973 redisplaying_p
= 1;
12974 specbind (Qinhibit_free_realized_faces
, Qnil
);
12976 /* Record this function, so it appears on the profiler's backtraces. */
12977 backtrace
.next
= backtrace_list
;
12978 backtrace
.function
= Qredisplay_internal
;
12979 backtrace
.args
= &Qnil
;
12980 backtrace
.nargs
= 0;
12981 backtrace
.debug_on_exit
= 0;
12982 backtrace_list
= &backtrace
;
12985 Lisp_Object tail
, frame
;
12987 FOR_EACH_FRAME (tail
, frame
)
12989 struct frame
*f
= XFRAME (frame
);
12990 f
->already_hscrolled_p
= 0;
12995 /* Remember the currently selected window. */
12998 if (!EQ (old_frame
, selected_frame
)
12999 && FRAME_LIVE_P (XFRAME (old_frame
)))
13000 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
13001 selected_frame and selected_window to be temporarily out-of-sync so
13002 when we come back here via `goto retry', we need to resync because we
13003 may need to run Elisp code (via prepare_menu_bars). */
13004 select_frame_for_redisplay (old_frame
);
13007 reconsider_clip_changes (w
, current_buffer
);
13008 last_escape_glyph_frame
= NULL
;
13009 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13010 last_glyphless_glyph_frame
= NULL
;
13011 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13013 /* If new fonts have been loaded that make a glyph matrix adjustment
13014 necessary, do it. */
13015 if (fonts_changed_p
)
13017 adjust_glyphs (NULL
);
13018 ++windows_or_buffers_changed
;
13019 fonts_changed_p
= 0;
13022 /* If face_change_count is non-zero, init_iterator will free all
13023 realized faces, which includes the faces referenced from current
13024 matrices. So, we can't reuse current matrices in this case. */
13025 if (face_change_count
)
13026 ++windows_or_buffers_changed
;
13028 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13029 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13031 /* Since frames on a single ASCII terminal share the same
13032 display area, displaying a different frame means redisplay
13033 the whole thing. */
13034 windows_or_buffers_changed
++;
13035 SET_FRAME_GARBAGED (sf
);
13037 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13039 FRAME_TTY (sf
)->previous_frame
= sf
;
13042 /* Set the visible flags for all frames. Do this before checking
13043 for resized or garbaged frames; they want to know if their frames
13044 are visible. See the comment in frame.h for
13045 FRAME_SAMPLE_VISIBILITY. */
13047 Lisp_Object tail
, frame
;
13049 number_of_visible_frames
= 0;
13051 FOR_EACH_FRAME (tail
, frame
)
13053 struct frame
*f
= XFRAME (frame
);
13055 FRAME_SAMPLE_VISIBILITY (f
);
13056 if (FRAME_VISIBLE_P (f
))
13057 ++number_of_visible_frames
;
13058 clear_desired_matrices (f
);
13062 /* Notice any pending interrupt request to change frame size. */
13063 do_pending_window_change (1);
13065 /* do_pending_window_change could change the selected_window due to
13066 frame resizing which makes the selected window too small. */
13067 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13070 reconsider_clip_changes (w
, current_buffer
);
13073 /* Clear frames marked as garbaged. */
13074 if (frame_garbaged
)
13075 clear_garbaged_frames ();
13077 /* Build menubar and tool-bar items. */
13078 if (NILP (Vmemory_full
))
13079 prepare_menu_bars ();
13081 if (windows_or_buffers_changed
)
13082 update_mode_lines
++;
13084 /* Detect case that we need to write or remove a star in the mode line. */
13085 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13087 w
->update_mode_line
= 1;
13088 if (buffer_shared
> 1)
13089 update_mode_lines
++;
13092 /* Avoid invocation of point motion hooks by `current_column' below. */
13093 count1
= SPECPDL_INDEX ();
13094 specbind (Qinhibit_point_motion_hooks
, Qt
);
13096 /* If %c is in the mode line, update it if needed. */
13097 if (!NILP (w
->column_number_displayed
)
13098 /* This alternative quickly identifies a common case
13099 where no change is needed. */
13100 && !(PT
== w
->last_point
13101 && w
->last_modified
>= MODIFF
13102 && w
->last_overlay_modified
>= OVERLAY_MODIFF
)
13103 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
13104 w
->update_mode_line
= 1;
13106 unbind_to (count1
, Qnil
);
13108 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
13110 /* The variable buffer_shared is set in redisplay_window and
13111 indicates that we redisplay a buffer in different windows. See
13113 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
13114 || cursor_type_changed
);
13116 /* If specs for an arrow have changed, do thorough redisplay
13117 to ensure we remove any arrow that should no longer exist. */
13118 if (overlay_arrows_changed_p ())
13119 consider_all_windows_p
= windows_or_buffers_changed
= 1;
13121 /* Normally the message* functions will have already displayed and
13122 updated the echo area, but the frame may have been trashed, or
13123 the update may have been preempted, so display the echo area
13124 again here. Checking message_cleared_p captures the case that
13125 the echo area should be cleared. */
13126 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13127 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13128 || (message_cleared_p
13129 && minibuf_level
== 0
13130 /* If the mini-window is currently selected, this means the
13131 echo-area doesn't show through. */
13132 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13134 int window_height_changed_p
= echo_area_display (0);
13136 if (message_cleared_p
)
13137 update_miniwindow_p
= 1;
13141 /* If we don't display the current message, don't clear the
13142 message_cleared_p flag, because, if we did, we wouldn't clear
13143 the echo area in the next redisplay which doesn't preserve
13145 if (!display_last_displayed_message_p
)
13146 message_cleared_p
= 0;
13148 if (fonts_changed_p
)
13150 else if (window_height_changed_p
)
13152 consider_all_windows_p
= 1;
13153 ++update_mode_lines
;
13154 ++windows_or_buffers_changed
;
13156 /* If window configuration was changed, frames may have been
13157 marked garbaged. Clear them or we will experience
13158 surprises wrt scrolling. */
13159 if (frame_garbaged
)
13160 clear_garbaged_frames ();
13163 else if (EQ (selected_window
, minibuf_window
)
13164 && (current_buffer
->clip_changed
13165 || w
->last_modified
< MODIFF
13166 || w
->last_overlay_modified
< OVERLAY_MODIFF
)
13167 && resize_mini_window (w
, 0))
13169 /* Resized active mini-window to fit the size of what it is
13170 showing if its contents might have changed. */
13172 /* FIXME: this causes all frames to be updated, which seems unnecessary
13173 since only the current frame needs to be considered. This function needs
13174 to be rewritten with two variables, consider_all_windows and
13175 consider_all_frames. */
13176 consider_all_windows_p
= 1;
13177 ++windows_or_buffers_changed
;
13178 ++update_mode_lines
;
13180 /* If window configuration was changed, frames may have been
13181 marked garbaged. Clear them or we will experience
13182 surprises wrt scrolling. */
13183 if (frame_garbaged
)
13184 clear_garbaged_frames ();
13188 /* If showing the region, and mark has changed, we must redisplay
13189 the whole window. The assignment to this_line_start_pos prevents
13190 the optimization directly below this if-statement. */
13191 if (((!NILP (Vtransient_mark_mode
)
13192 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
13193 != !NILP (w
->region_showing
))
13194 || (!NILP (w
->region_showing
)
13195 && !EQ (w
->region_showing
,
13196 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
13197 CHARPOS (this_line_start_pos
) = 0;
13199 /* Optimize the case that only the line containing the cursor in the
13200 selected window has changed. Variables starting with this_ are
13201 set in display_line and record information about the line
13202 containing the cursor. */
13203 tlbufpos
= this_line_start_pos
;
13204 tlendpos
= this_line_end_pos
;
13205 if (!consider_all_windows_p
13206 && CHARPOS (tlbufpos
) > 0
13207 && !w
->update_mode_line
13208 && !current_buffer
->clip_changed
13209 && !current_buffer
->prevent_redisplay_optimizations_p
13210 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13211 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13212 /* Make sure recorded data applies to current buffer, etc. */
13213 && this_line_buffer
== current_buffer
13214 && current_buffer
== XBUFFER (w
->buffer
)
13216 && !w
->optional_new_start
13217 /* Point must be on the line that we have info recorded about. */
13218 && PT
>= CHARPOS (tlbufpos
)
13219 && PT
<= Z
- CHARPOS (tlendpos
)
13220 /* All text outside that line, including its final newline,
13221 must be unchanged. */
13222 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13223 CHARPOS (tlendpos
)))
13225 if (CHARPOS (tlbufpos
) > BEGV
13226 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13227 && (CHARPOS (tlbufpos
) == ZV
13228 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13229 /* Former continuation line has disappeared by becoming empty. */
13231 else if (w
->last_modified
< MODIFF
13232 || w
->last_overlay_modified
< OVERLAY_MODIFF
13233 || MINI_WINDOW_P (w
))
13235 /* We have to handle the case of continuation around a
13236 wide-column character (see the comment in indent.c around
13239 For instance, in the following case:
13241 -------- Insert --------
13242 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13243 J_I_ ==> J_I_ `^^' are cursors.
13247 As we have to redraw the line above, we cannot use this
13251 int line_height_before
= this_line_pixel_height
;
13253 /* Note that start_display will handle the case that the
13254 line starting at tlbufpos is a continuation line. */
13255 start_display (&it
, w
, tlbufpos
);
13257 /* Implementation note: It this still necessary? */
13258 if (it
.current_x
!= this_line_start_x
)
13261 TRACE ((stderr
, "trying display optimization 1\n"));
13262 w
->cursor
.vpos
= -1;
13263 overlay_arrow_seen
= 0;
13264 it
.vpos
= this_line_vpos
;
13265 it
.current_y
= this_line_y
;
13266 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13267 display_line (&it
);
13269 /* If line contains point, is not continued,
13270 and ends at same distance from eob as before, we win. */
13271 if (w
->cursor
.vpos
>= 0
13272 /* Line is not continued, otherwise this_line_start_pos
13273 would have been set to 0 in display_line. */
13274 && CHARPOS (this_line_start_pos
)
13275 /* Line ends as before. */
13276 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13277 /* Line has same height as before. Otherwise other lines
13278 would have to be shifted up or down. */
13279 && this_line_pixel_height
== line_height_before
)
13281 /* If this is not the window's last line, we must adjust
13282 the charstarts of the lines below. */
13283 if (it
.current_y
< it
.last_visible_y
)
13285 struct glyph_row
*row
13286 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13287 ptrdiff_t delta
, delta_bytes
;
13289 /* We used to distinguish between two cases here,
13290 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13291 when the line ends in a newline or the end of the
13292 buffer's accessible portion. But both cases did
13293 the same, so they were collapsed. */
13295 - CHARPOS (tlendpos
)
13296 - MATRIX_ROW_START_CHARPOS (row
));
13297 delta_bytes
= (Z_BYTE
13298 - BYTEPOS (tlendpos
)
13299 - MATRIX_ROW_START_BYTEPOS (row
));
13301 increment_matrix_positions (w
->current_matrix
,
13302 this_line_vpos
+ 1,
13303 w
->current_matrix
->nrows
,
13304 delta
, delta_bytes
);
13307 /* If this row displays text now but previously didn't,
13308 or vice versa, w->window_end_vpos may have to be
13310 if ((it
.glyph_row
- 1)->displays_text_p
)
13312 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
13313 wset_window_end_vpos (w
, make_number (this_line_vpos
));
13315 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
13316 && this_line_vpos
> 0)
13317 wset_window_end_vpos (w
, make_number (this_line_vpos
- 1));
13318 wset_window_end_valid (w
, Qnil
);
13320 /* Update hint: No need to try to scroll in update_window. */
13321 w
->desired_matrix
->no_scrolling_p
= 1;
13324 *w
->desired_matrix
->method
= 0;
13325 debug_method_add (w
, "optimization 1");
13327 #ifdef HAVE_WINDOW_SYSTEM
13328 update_window_fringes (w
, 0);
13335 else if (/* Cursor position hasn't changed. */
13336 PT
== w
->last_point
13337 /* Make sure the cursor was last displayed
13338 in this window. Otherwise we have to reposition it. */
13339 && 0 <= w
->cursor
.vpos
13340 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
13344 do_pending_window_change (1);
13345 /* If selected_window changed, redisplay again. */
13346 if (WINDOWP (selected_window
)
13347 && (w
= XWINDOW (selected_window
)) != sw
)
13350 /* We used to always goto end_of_redisplay here, but this
13351 isn't enough if we have a blinking cursor. */
13352 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13353 goto end_of_redisplay
;
13357 /* If highlighting the region, or if the cursor is in the echo area,
13358 then we can't just move the cursor. */
13359 else if (! (!NILP (Vtransient_mark_mode
)
13360 && !NILP (BVAR (current_buffer
, mark_active
)))
13361 && (EQ (selected_window
,
13362 BVAR (current_buffer
, last_selected_window
))
13363 || highlight_nonselected_windows
)
13364 && NILP (w
->region_showing
)
13365 && NILP (Vshow_trailing_whitespace
)
13366 && !cursor_in_echo_area
)
13369 struct glyph_row
*row
;
13371 /* Skip from tlbufpos to PT and see where it is. Note that
13372 PT may be in invisible text. If so, we will end at the
13373 next visible position. */
13374 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13375 NULL
, DEFAULT_FACE_ID
);
13376 it
.current_x
= this_line_start_x
;
13377 it
.current_y
= this_line_y
;
13378 it
.vpos
= this_line_vpos
;
13380 /* The call to move_it_to stops in front of PT, but
13381 moves over before-strings. */
13382 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13384 if (it
.vpos
== this_line_vpos
13385 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13388 eassert (this_line_vpos
== it
.vpos
);
13389 eassert (this_line_y
== it
.current_y
);
13390 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13392 *w
->desired_matrix
->method
= 0;
13393 debug_method_add (w
, "optimization 3");
13402 /* Text changed drastically or point moved off of line. */
13403 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13406 CHARPOS (this_line_start_pos
) = 0;
13407 consider_all_windows_p
|= buffer_shared
> 1;
13408 ++clear_face_cache_count
;
13409 #ifdef HAVE_WINDOW_SYSTEM
13410 ++clear_image_cache_count
;
13413 /* Build desired matrices, and update the display. If
13414 consider_all_windows_p is non-zero, do it for all windows on all
13415 frames. Otherwise do it for selected_window, only. */
13417 if (consider_all_windows_p
)
13419 Lisp_Object tail
, frame
;
13421 FOR_EACH_FRAME (tail
, frame
)
13422 XFRAME (frame
)->updated_p
= 0;
13424 /* Recompute # windows showing selected buffer. This will be
13425 incremented each time such a window is displayed. */
13428 FOR_EACH_FRAME (tail
, frame
)
13430 struct frame
*f
= XFRAME (frame
);
13432 /* We don't have to do anything for unselected terminal
13434 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13435 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13438 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13440 if (! EQ (frame
, selected_frame
))
13441 /* Select the frame, for the sake of frame-local
13443 select_frame_for_redisplay (frame
);
13445 /* Mark all the scroll bars to be removed; we'll redeem
13446 the ones we want when we redisplay their windows. */
13447 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13448 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13450 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13451 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13453 /* The X error handler may have deleted that frame. */
13454 if (!FRAME_LIVE_P (f
))
13457 /* Any scroll bars which redisplay_windows should have
13458 nuked should now go away. */
13459 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13460 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13462 /* If fonts changed, display again. */
13463 /* ??? rms: I suspect it is a mistake to jump all the way
13464 back to retry here. It should just retry this frame. */
13465 if (fonts_changed_p
)
13468 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13470 /* See if we have to hscroll. */
13471 if (!f
->already_hscrolled_p
)
13473 f
->already_hscrolled_p
= 1;
13474 if (hscroll_windows (f
->root_window
))
13478 /* Prevent various kinds of signals during display
13479 update. stdio is not robust about handling
13480 signals, which can cause an apparent I/O
13482 if (interrupt_input
)
13483 unrequest_sigio ();
13486 /* Update the display. */
13487 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13488 pending
|= update_frame (f
, 0, 0);
13494 if (!EQ (old_frame
, selected_frame
)
13495 && FRAME_LIVE_P (XFRAME (old_frame
)))
13496 /* We played a bit fast-and-loose above and allowed selected_frame
13497 and selected_window to be temporarily out-of-sync but let's make
13498 sure this stays contained. */
13499 select_frame_for_redisplay (old_frame
);
13500 eassert (EQ (XFRAME (selected_frame
)->selected_window
,
13505 /* Do the mark_window_display_accurate after all windows have
13506 been redisplayed because this call resets flags in buffers
13507 which are needed for proper redisplay. */
13508 FOR_EACH_FRAME (tail
, frame
)
13510 struct frame
*f
= XFRAME (frame
);
13513 mark_window_display_accurate (f
->root_window
, 1);
13514 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13515 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13520 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13522 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13523 struct frame
*mini_frame
;
13525 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13526 /* Use list_of_error, not Qerror, so that
13527 we catch only errors and don't run the debugger. */
13528 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13530 redisplay_window_error
);
13531 if (update_miniwindow_p
)
13532 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13534 redisplay_window_error
);
13536 /* Compare desired and current matrices, perform output. */
13539 /* If fonts changed, display again. */
13540 if (fonts_changed_p
)
13543 /* Prevent various kinds of signals during display update.
13544 stdio is not robust about handling signals,
13545 which can cause an apparent I/O error. */
13546 if (interrupt_input
)
13547 unrequest_sigio ();
13550 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13552 if (hscroll_windows (selected_window
))
13555 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13556 pending
= update_frame (sf
, 0, 0);
13559 /* We may have called echo_area_display at the top of this
13560 function. If the echo area is on another frame, that may
13561 have put text on a frame other than the selected one, so the
13562 above call to update_frame would not have caught it. Catch
13564 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13565 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13567 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13569 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13570 pending
|= update_frame (mini_frame
, 0, 0);
13571 if (!pending
&& hscroll_windows (mini_window
))
13576 /* If display was paused because of pending input, make sure we do a
13577 thorough update the next time. */
13580 /* Prevent the optimization at the beginning of
13581 redisplay_internal that tries a single-line update of the
13582 line containing the cursor in the selected window. */
13583 CHARPOS (this_line_start_pos
) = 0;
13585 /* Let the overlay arrow be updated the next time. */
13586 update_overlay_arrows (0);
13588 /* If we pause after scrolling, some rows in the current
13589 matrices of some windows are not valid. */
13590 if (!WINDOW_FULL_WIDTH_P (w
)
13591 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13592 update_mode_lines
= 1;
13596 if (!consider_all_windows_p
)
13598 /* This has already been done above if
13599 consider_all_windows_p is set. */
13600 mark_window_display_accurate_1 (w
, 1);
13602 /* Say overlay arrows are up to date. */
13603 update_overlay_arrows (1);
13605 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13606 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13609 update_mode_lines
= 0;
13610 windows_or_buffers_changed
= 0;
13611 cursor_type_changed
= 0;
13614 /* Start SIGIO interrupts coming again. Having them off during the
13615 code above makes it less likely one will discard output, but not
13616 impossible, since there might be stuff in the system buffer here.
13617 But it is much hairier to try to do anything about that. */
13618 if (interrupt_input
)
13622 /* If a frame has become visible which was not before, redisplay
13623 again, so that we display it. Expose events for such a frame
13624 (which it gets when becoming visible) don't call the parts of
13625 redisplay constructing glyphs, so simply exposing a frame won't
13626 display anything in this case. So, we have to display these
13627 frames here explicitly. */
13630 Lisp_Object tail
, frame
;
13633 FOR_EACH_FRAME (tail
, frame
)
13635 int this_is_visible
= 0;
13637 if (XFRAME (frame
)->visible
)
13638 this_is_visible
= 1;
13639 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13640 if (XFRAME (frame
)->visible
)
13641 this_is_visible
= 1;
13643 if (this_is_visible
)
13647 if (new_count
!= number_of_visible_frames
)
13648 windows_or_buffers_changed
++;
13651 /* Change frame size now if a change is pending. */
13652 do_pending_window_change (1);
13654 /* If we just did a pending size change, or have additional
13655 visible frames, or selected_window changed, redisplay again. */
13656 if ((windows_or_buffers_changed
&& !pending
)
13657 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13660 /* Clear the face and image caches.
13662 We used to do this only if consider_all_windows_p. But the cache
13663 needs to be cleared if a timer creates images in the current
13664 buffer (e.g. the test case in Bug#6230). */
13666 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13668 clear_face_cache (0);
13669 clear_face_cache_count
= 0;
13672 #ifdef HAVE_WINDOW_SYSTEM
13673 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13675 clear_image_caches (Qnil
);
13676 clear_image_cache_count
= 0;
13678 #endif /* HAVE_WINDOW_SYSTEM */
13681 backtrace_list
= backtrace
.next
;
13682 unbind_to (count
, Qnil
);
13687 /* Redisplay, but leave alone any recent echo area message unless
13688 another message has been requested in its place.
13690 This is useful in situations where you need to redisplay but no
13691 user action has occurred, making it inappropriate for the message
13692 area to be cleared. See tracking_off and
13693 wait_reading_process_output for examples of these situations.
13695 FROM_WHERE is an integer saying from where this function was
13696 called. This is useful for debugging. */
13699 redisplay_preserve_echo_area (int from_where
)
13701 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13703 if (!NILP (echo_area_buffer
[1]))
13705 /* We have a previously displayed message, but no current
13706 message. Redisplay the previous message. */
13707 display_last_displayed_message_p
= 1;
13708 redisplay_internal ();
13709 display_last_displayed_message_p
= 0;
13712 redisplay_internal ();
13714 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13715 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13716 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13720 /* Function registered with record_unwind_protect in redisplay_internal.
13721 Clear redisplaying_p. Also, select the previously
13722 selected frame, unless it has been deleted (by an X connection
13723 failure during redisplay, for example). */
13726 unwind_redisplay (Lisp_Object old_frame
)
13728 redisplaying_p
= 0;
13729 if (! EQ (old_frame
, selected_frame
)
13730 && FRAME_LIVE_P (XFRAME (old_frame
)))
13731 select_frame_for_redisplay (old_frame
);
13736 /* Mark the display of window W as accurate or inaccurate. If
13737 ACCURATE_P is non-zero mark display of W as accurate. If
13738 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13739 redisplay_internal is called. */
13742 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13744 if (BUFFERP (w
->buffer
))
13746 struct buffer
*b
= XBUFFER (w
->buffer
);
13748 w
->last_modified
= accurate_p
? BUF_MODIFF(b
) : 0;
13749 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF(b
) : 0;
13751 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
13755 b
->clip_changed
= 0;
13756 b
->prevent_redisplay_optimizations_p
= 0;
13758 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13759 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13760 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13761 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13763 w
->current_matrix
->buffer
= b
;
13764 w
->current_matrix
->begv
= BUF_BEGV (b
);
13765 w
->current_matrix
->zv
= BUF_ZV (b
);
13767 w
->last_cursor
= w
->cursor
;
13768 w
->last_cursor_off_p
= w
->cursor_off_p
;
13770 if (w
== XWINDOW (selected_window
))
13771 w
->last_point
= BUF_PT (b
);
13773 w
->last_point
= XMARKER (w
->pointm
)->charpos
;
13779 wset_window_end_valid (w
, w
->buffer
);
13780 w
->update_mode_line
= 0;
13785 /* Mark the display of windows in the window tree rooted at WINDOW as
13786 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13787 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13788 be redisplayed the next time redisplay_internal is called. */
13791 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13795 for (; !NILP (window
); window
= w
->next
)
13797 w
= XWINDOW (window
);
13798 mark_window_display_accurate_1 (w
, accurate_p
);
13800 if (!NILP (w
->vchild
))
13801 mark_window_display_accurate (w
->vchild
, accurate_p
);
13802 if (!NILP (w
->hchild
))
13803 mark_window_display_accurate (w
->hchild
, accurate_p
);
13808 update_overlay_arrows (1);
13812 /* Force a thorough redisplay the next time by setting
13813 last_arrow_position and last_arrow_string to t, which is
13814 unequal to any useful value of Voverlay_arrow_... */
13815 update_overlay_arrows (-1);
13820 /* Return value in display table DP (Lisp_Char_Table *) for character
13821 C. Since a display table doesn't have any parent, we don't have to
13822 follow parent. Do not call this function directly but use the
13823 macro DISP_CHAR_VECTOR. */
13826 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13830 if (ASCII_CHAR_P (c
))
13833 if (SUB_CHAR_TABLE_P (val
))
13834 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13840 XSETCHAR_TABLE (table
, dp
);
13841 val
= char_table_ref (table
, c
);
13850 /***********************************************************************
13852 ***********************************************************************/
13854 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13857 redisplay_windows (Lisp_Object window
)
13859 while (!NILP (window
))
13861 struct window
*w
= XWINDOW (window
);
13863 if (!NILP (w
->hchild
))
13864 redisplay_windows (w
->hchild
);
13865 else if (!NILP (w
->vchild
))
13866 redisplay_windows (w
->vchild
);
13867 else if (!NILP (w
->buffer
))
13869 displayed_buffer
= XBUFFER (w
->buffer
);
13870 /* Use list_of_error, not Qerror, so that
13871 we catch only errors and don't run the debugger. */
13872 internal_condition_case_1 (redisplay_window_0
, window
,
13874 redisplay_window_error
);
13882 redisplay_window_error (Lisp_Object ignore
)
13884 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13889 redisplay_window_0 (Lisp_Object window
)
13891 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13892 redisplay_window (window
, 0);
13897 redisplay_window_1 (Lisp_Object window
)
13899 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13900 redisplay_window (window
, 1);
13905 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13906 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13907 which positions recorded in ROW differ from current buffer
13910 Return 0 if cursor is not on this row, 1 otherwise. */
13913 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13914 struct glyph_matrix
*matrix
,
13915 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
13918 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13919 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13920 struct glyph
*cursor
= NULL
;
13921 /* The last known character position in row. */
13922 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13924 ptrdiff_t pt_old
= PT
- delta
;
13925 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13926 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13927 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13928 /* A glyph beyond the edge of TEXT_AREA which we should never
13930 struct glyph
*glyphs_end
= end
;
13931 /* Non-zero means we've found a match for cursor position, but that
13932 glyph has the avoid_cursor_p flag set. */
13933 int match_with_avoid_cursor
= 0;
13934 /* Non-zero means we've seen at least one glyph that came from a
13936 int string_seen
= 0;
13937 /* Largest and smallest buffer positions seen so far during scan of
13939 ptrdiff_t bpos_max
= pos_before
;
13940 ptrdiff_t bpos_min
= pos_after
;
13941 /* Last buffer position covered by an overlay string with an integer
13942 `cursor' property. */
13943 ptrdiff_t bpos_covered
= 0;
13944 /* Non-zero means the display string on which to display the cursor
13945 comes from a text property, not from an overlay. */
13946 int string_from_text_prop
= 0;
13948 /* Don't even try doing anything if called for a mode-line or
13949 header-line row, since the rest of the code isn't prepared to
13950 deal with such calamities. */
13951 eassert (!row
->mode_line_p
);
13952 if (row
->mode_line_p
)
13955 /* Skip over glyphs not having an object at the start and the end of
13956 the row. These are special glyphs like truncation marks on
13957 terminal frames. */
13958 if (row
->displays_text_p
)
13960 if (!row
->reversed_p
)
13963 && INTEGERP (glyph
->object
)
13964 && glyph
->charpos
< 0)
13966 x
+= glyph
->pixel_width
;
13970 && INTEGERP ((end
- 1)->object
)
13971 /* CHARPOS is zero for blanks and stretch glyphs
13972 inserted by extend_face_to_end_of_line. */
13973 && (end
- 1)->charpos
<= 0)
13975 glyph_before
= glyph
- 1;
13982 /* If the glyph row is reversed, we need to process it from back
13983 to front, so swap the edge pointers. */
13984 glyphs_end
= end
= glyph
- 1;
13985 glyph
+= row
->used
[TEXT_AREA
] - 1;
13987 while (glyph
> end
+ 1
13988 && INTEGERP (glyph
->object
)
13989 && glyph
->charpos
< 0)
13992 x
-= glyph
->pixel_width
;
13994 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13996 /* By default, in reversed rows we put the cursor on the
13997 rightmost (first in the reading order) glyph. */
13998 for (g
= end
+ 1; g
< glyph
; g
++)
13999 x
+= g
->pixel_width
;
14001 && INTEGERP ((end
+ 1)->object
)
14002 && (end
+ 1)->charpos
<= 0)
14004 glyph_before
= glyph
+ 1;
14008 else if (row
->reversed_p
)
14010 /* In R2L rows that don't display text, put the cursor on the
14011 rightmost glyph. Case in point: an empty last line that is
14012 part of an R2L paragraph. */
14014 /* Avoid placing the cursor on the last glyph of the row, where
14015 on terminal frames we hold the vertical border between
14016 adjacent windows. */
14017 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14018 && !WINDOW_RIGHTMOST_P (w
)
14019 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14021 x
= -1; /* will be computed below, at label compute_x */
14024 /* Step 1: Try to find the glyph whose character position
14025 corresponds to point. If that's not possible, find 2 glyphs
14026 whose character positions are the closest to point, one before
14027 point, the other after it. */
14028 if (!row
->reversed_p
)
14029 while (/* not marched to end of glyph row */
14031 /* glyph was not inserted by redisplay for internal purposes */
14032 && !INTEGERP (glyph
->object
))
14034 if (BUFFERP (glyph
->object
))
14036 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14038 if (glyph
->charpos
> bpos_max
)
14039 bpos_max
= glyph
->charpos
;
14040 if (glyph
->charpos
< bpos_min
)
14041 bpos_min
= glyph
->charpos
;
14042 if (!glyph
->avoid_cursor_p
)
14044 /* If we hit point, we've found the glyph on which to
14045 display the cursor. */
14048 match_with_avoid_cursor
= 0;
14051 /* See if we've found a better approximation to
14052 POS_BEFORE or to POS_AFTER. */
14053 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14055 pos_before
= glyph
->charpos
;
14056 glyph_before
= glyph
;
14058 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14060 pos_after
= glyph
->charpos
;
14061 glyph_after
= glyph
;
14064 else if (dpos
== 0)
14065 match_with_avoid_cursor
= 1;
14067 else if (STRINGP (glyph
->object
))
14069 Lisp_Object chprop
;
14070 ptrdiff_t glyph_pos
= glyph
->charpos
;
14072 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14074 if (!NILP (chprop
))
14076 /* If the string came from a `display' text property,
14077 look up the buffer position of that property and
14078 use that position to update bpos_max, as if we
14079 actually saw such a position in one of the row's
14080 glyphs. This helps with supporting integer values
14081 of `cursor' property on the display string in
14082 situations where most or all of the row's buffer
14083 text is completely covered by display properties,
14084 so that no glyph with valid buffer positions is
14085 ever seen in the row. */
14086 ptrdiff_t prop_pos
=
14087 string_buffer_position_lim (glyph
->object
, pos_before
,
14090 if (prop_pos
>= pos_before
)
14091 bpos_max
= prop_pos
- 1;
14093 if (INTEGERP (chprop
))
14095 bpos_covered
= bpos_max
+ XINT (chprop
);
14096 /* If the `cursor' property covers buffer positions up
14097 to and including point, we should display cursor on
14098 this glyph. Note that, if a `cursor' property on one
14099 of the string's characters has an integer value, we
14100 will break out of the loop below _before_ we get to
14101 the position match above. IOW, integer values of
14102 the `cursor' property override the "exact match for
14103 point" strategy of positioning the cursor. */
14104 /* Implementation note: bpos_max == pt_old when, e.g.,
14105 we are in an empty line, where bpos_max is set to
14106 MATRIX_ROW_START_CHARPOS, see above. */
14107 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14116 x
+= glyph
->pixel_width
;
14119 else if (glyph
> end
) /* row is reversed */
14120 while (!INTEGERP (glyph
->object
))
14122 if (BUFFERP (glyph
->object
))
14124 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14126 if (glyph
->charpos
> bpos_max
)
14127 bpos_max
= glyph
->charpos
;
14128 if (glyph
->charpos
< bpos_min
)
14129 bpos_min
= glyph
->charpos
;
14130 if (!glyph
->avoid_cursor_p
)
14134 match_with_avoid_cursor
= 0;
14137 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14139 pos_before
= glyph
->charpos
;
14140 glyph_before
= glyph
;
14142 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14144 pos_after
= glyph
->charpos
;
14145 glyph_after
= glyph
;
14148 else if (dpos
== 0)
14149 match_with_avoid_cursor
= 1;
14151 else if (STRINGP (glyph
->object
))
14153 Lisp_Object chprop
;
14154 ptrdiff_t glyph_pos
= glyph
->charpos
;
14156 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14158 if (!NILP (chprop
))
14160 ptrdiff_t prop_pos
=
14161 string_buffer_position_lim (glyph
->object
, pos_before
,
14164 if (prop_pos
>= pos_before
)
14165 bpos_max
= prop_pos
- 1;
14167 if (INTEGERP (chprop
))
14169 bpos_covered
= bpos_max
+ XINT (chprop
);
14170 /* If the `cursor' property covers buffer positions up
14171 to and including point, we should display cursor on
14173 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14182 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14184 x
--; /* can't use any pixel_width */
14187 x
-= glyph
->pixel_width
;
14190 /* Step 2: If we didn't find an exact match for point, we need to
14191 look for a proper place to put the cursor among glyphs between
14192 GLYPH_BEFORE and GLYPH_AFTER. */
14193 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14194 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14195 && bpos_covered
< pt_old
)
14197 /* An empty line has a single glyph whose OBJECT is zero and
14198 whose CHARPOS is the position of a newline on that line.
14199 Note that on a TTY, there are more glyphs after that, which
14200 were produced by extend_face_to_end_of_line, but their
14201 CHARPOS is zero or negative. */
14203 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14204 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
14206 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14208 ptrdiff_t ellipsis_pos
;
14210 /* Scan back over the ellipsis glyphs. */
14211 if (!row
->reversed_p
)
14213 ellipsis_pos
= (glyph
- 1)->charpos
;
14214 while (glyph
> row
->glyphs
[TEXT_AREA
]
14215 && (glyph
- 1)->charpos
== ellipsis_pos
)
14216 glyph
--, x
-= glyph
->pixel_width
;
14217 /* That loop always goes one position too far, including
14218 the glyph before the ellipsis. So scan forward over
14220 x
+= glyph
->pixel_width
;
14223 else /* row is reversed */
14225 ellipsis_pos
= (glyph
+ 1)->charpos
;
14226 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14227 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14228 glyph
++, x
+= glyph
->pixel_width
;
14229 x
-= glyph
->pixel_width
;
14233 else if (match_with_avoid_cursor
)
14235 cursor
= glyph_after
;
14238 else if (string_seen
)
14240 int incr
= row
->reversed_p
? -1 : +1;
14242 /* Need to find the glyph that came out of a string which is
14243 present at point. That glyph is somewhere between
14244 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14245 positioned between POS_BEFORE and POS_AFTER in the
14247 struct glyph
*start
, *stop
;
14248 ptrdiff_t pos
= pos_before
;
14252 /* If the row ends in a newline from a display string,
14253 reordering could have moved the glyphs belonging to the
14254 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14255 in this case we extend the search to the last glyph in
14256 the row that was not inserted by redisplay. */
14257 if (row
->ends_in_newline_from_string_p
)
14260 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14263 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14264 correspond to POS_BEFORE and POS_AFTER, respectively. We
14265 need START and STOP in the order that corresponds to the
14266 row's direction as given by its reversed_p flag. If the
14267 directionality of characters between POS_BEFORE and
14268 POS_AFTER is the opposite of the row's base direction,
14269 these characters will have been reordered for display,
14270 and we need to reverse START and STOP. */
14271 if (!row
->reversed_p
)
14273 start
= min (glyph_before
, glyph_after
);
14274 stop
= max (glyph_before
, glyph_after
);
14278 start
= max (glyph_before
, glyph_after
);
14279 stop
= min (glyph_before
, glyph_after
);
14281 for (glyph
= start
+ incr
;
14282 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14285 /* Any glyphs that come from the buffer are here because
14286 of bidi reordering. Skip them, and only pay
14287 attention to glyphs that came from some string. */
14288 if (STRINGP (glyph
->object
))
14292 /* If the display property covers the newline, we
14293 need to search for it one position farther. */
14294 ptrdiff_t lim
= pos_after
14295 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14297 string_from_text_prop
= 0;
14298 str
= glyph
->object
;
14299 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14300 if (tem
== 0 /* from overlay */
14303 /* If the string from which this glyph came is
14304 found in the buffer at point, or at position
14305 that is closer to point than pos_after, then
14306 we've found the glyph we've been looking for.
14307 If it comes from an overlay (tem == 0), and
14308 it has the `cursor' property on one of its
14309 glyphs, record that glyph as a candidate for
14310 displaying the cursor. (As in the
14311 unidirectional version, we will display the
14312 cursor on the last candidate we find.) */
14315 || (tem
- pt_old
> 0 && tem
< pos_after
))
14317 /* The glyphs from this string could have
14318 been reordered. Find the one with the
14319 smallest string position. Or there could
14320 be a character in the string with the
14321 `cursor' property, which means display
14322 cursor on that character's glyph. */
14323 ptrdiff_t strpos
= glyph
->charpos
;
14328 string_from_text_prop
= 1;
14331 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14332 && EQ (glyph
->object
, str
);
14336 ptrdiff_t gpos
= glyph
->charpos
;
14338 cprop
= Fget_char_property (make_number (gpos
),
14346 if (tem
&& glyph
->charpos
< strpos
)
14348 strpos
= glyph
->charpos
;
14354 || (tem
- pt_old
> 0 && tem
< pos_after
))
14358 pos
= tem
+ 1; /* don't find previous instances */
14360 /* This string is not what we want; skip all of the
14361 glyphs that came from it. */
14362 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14363 && EQ (glyph
->object
, str
))
14370 /* If we reached the end of the line, and END was from a string,
14371 the cursor is not on this line. */
14373 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14374 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14375 && STRINGP (end
->object
)
14376 && row
->continued_p
)
14379 /* A truncated row may not include PT among its character positions.
14380 Setting the cursor inside the scroll margin will trigger
14381 recalculation of hscroll in hscroll_window_tree. But if a
14382 display string covers point, defer to the string-handling
14383 code below to figure this out. */
14384 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14386 cursor
= glyph_before
;
14389 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14390 /* Zero-width characters produce no glyphs. */
14392 && (row
->reversed_p
14393 ? glyph_after
> glyphs_end
14394 : glyph_after
< glyphs_end
)))
14396 cursor
= glyph_after
;
14402 if (cursor
!= NULL
)
14404 else if (glyph
== glyphs_end
14405 && pos_before
== pos_after
14406 && STRINGP ((row
->reversed_p
14407 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14408 : row
->glyphs
[TEXT_AREA
])->object
))
14410 /* If all the glyphs of this row came from strings, put the
14411 cursor on the first glyph of the row. This avoids having the
14412 cursor outside of the text area in this very rare and hard
14416 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14417 : row
->glyphs
[TEXT_AREA
];
14423 /* Need to compute x that corresponds to GLYPH. */
14424 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14426 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14428 x
+= g
->pixel_width
;
14432 /* ROW could be part of a continued line, which, under bidi
14433 reordering, might have other rows whose start and end charpos
14434 occlude point. Only set w->cursor if we found a better
14435 approximation to the cursor position than we have from previously
14436 examined candidate rows belonging to the same continued line. */
14437 if (/* we already have a candidate row */
14438 w
->cursor
.vpos
>= 0
14439 /* that candidate is not the row we are processing */
14440 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14441 /* Make sure cursor.vpos specifies a row whose start and end
14442 charpos occlude point, and it is valid candidate for being a
14443 cursor-row. This is because some callers of this function
14444 leave cursor.vpos at the row where the cursor was displayed
14445 during the last redisplay cycle. */
14446 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14447 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14448 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14451 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14453 /* Don't consider glyphs that are outside TEXT_AREA. */
14454 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14456 /* Keep the candidate whose buffer position is the closest to
14457 point or has the `cursor' property. */
14458 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14459 w
->cursor
.hpos
>= 0
14460 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14461 && ((BUFFERP (g1
->object
)
14462 && (g1
->charpos
== pt_old
/* an exact match always wins */
14463 || (BUFFERP (glyph
->object
)
14464 && eabs (g1
->charpos
- pt_old
)
14465 < eabs (glyph
->charpos
- pt_old
))))
14466 /* previous candidate is a glyph from a string that has
14467 a non-nil `cursor' property */
14468 || (STRINGP (g1
->object
)
14469 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14470 Qcursor
, g1
->object
))
14471 /* previous candidate is from the same display
14472 string as this one, and the display string
14473 came from a text property */
14474 || (EQ (g1
->object
, glyph
->object
)
14475 && string_from_text_prop
)
14476 /* this candidate is from newline and its
14477 position is not an exact match */
14478 || (INTEGERP (glyph
->object
)
14479 && glyph
->charpos
!= pt_old
)))))
14481 /* If this candidate gives an exact match, use that. */
14482 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14483 /* If this candidate is a glyph created for the
14484 terminating newline of a line, and point is on that
14485 newline, it wins because it's an exact match. */
14486 || (!row
->continued_p
14487 && INTEGERP (glyph
->object
)
14488 && glyph
->charpos
== 0
14489 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14490 /* Otherwise, keep the candidate that comes from a row
14491 spanning less buffer positions. This may win when one or
14492 both candidate positions are on glyphs that came from
14493 display strings, for which we cannot compare buffer
14495 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14496 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14497 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14500 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14502 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14503 w
->cursor
.y
= row
->y
+ dy
;
14505 if (w
== XWINDOW (selected_window
))
14507 if (!row
->continued_p
14508 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14511 this_line_buffer
= XBUFFER (w
->buffer
);
14513 CHARPOS (this_line_start_pos
)
14514 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14515 BYTEPOS (this_line_start_pos
)
14516 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14518 CHARPOS (this_line_end_pos
)
14519 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14520 BYTEPOS (this_line_end_pos
)
14521 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14523 this_line_y
= w
->cursor
.y
;
14524 this_line_pixel_height
= row
->height
;
14525 this_line_vpos
= w
->cursor
.vpos
;
14526 this_line_start_x
= row
->x
;
14529 CHARPOS (this_line_start_pos
) = 0;
14536 /* Run window scroll functions, if any, for WINDOW with new window
14537 start STARTP. Sets the window start of WINDOW to that position.
14539 We assume that the window's buffer is really current. */
14541 static struct text_pos
14542 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14544 struct window
*w
= XWINDOW (window
);
14545 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14547 if (current_buffer
!= XBUFFER (w
->buffer
))
14550 if (!NILP (Vwindow_scroll_functions
))
14552 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14553 make_number (CHARPOS (startp
)));
14554 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14555 /* In case the hook functions switch buffers. */
14556 set_buffer_internal (XBUFFER (w
->buffer
));
14563 /* Make sure the line containing the cursor is fully visible.
14564 A value of 1 means there is nothing to be done.
14565 (Either the line is fully visible, or it cannot be made so,
14566 or we cannot tell.)
14568 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14569 is higher than window.
14571 A value of 0 means the caller should do scrolling
14572 as if point had gone off the screen. */
14575 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14577 struct glyph_matrix
*matrix
;
14578 struct glyph_row
*row
;
14581 if (!make_cursor_line_fully_visible_p
)
14584 /* It's not always possible to find the cursor, e.g, when a window
14585 is full of overlay strings. Don't do anything in that case. */
14586 if (w
->cursor
.vpos
< 0)
14589 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14590 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14592 /* If the cursor row is not partially visible, there's nothing to do. */
14593 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14596 /* If the row the cursor is in is taller than the window's height,
14597 it's not clear what to do, so do nothing. */
14598 window_height
= window_box_height (w
);
14599 if (row
->height
>= window_height
)
14601 if (!force_p
|| MINI_WINDOW_P (w
)
14602 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14609 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14610 non-zero means only WINDOW is redisplayed in redisplay_internal.
14611 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14612 in redisplay_window to bring a partially visible line into view in
14613 the case that only the cursor has moved.
14615 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14616 last screen line's vertical height extends past the end of the screen.
14620 1 if scrolling succeeded
14622 0 if scrolling didn't find point.
14624 -1 if new fonts have been loaded so that we must interrupt
14625 redisplay, adjust glyph matrices, and try again. */
14631 SCROLLING_NEED_LARGER_MATRICES
14634 /* If scroll-conservatively is more than this, never recenter.
14636 If you change this, don't forget to update the doc string of
14637 `scroll-conservatively' and the Emacs manual. */
14638 #define SCROLL_LIMIT 100
14641 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14642 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14643 int temp_scroll_step
, int last_line_misfit
)
14645 struct window
*w
= XWINDOW (window
);
14646 struct frame
*f
= XFRAME (w
->frame
);
14647 struct text_pos pos
, startp
;
14649 int this_scroll_margin
, scroll_max
, rc
, height
;
14650 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14651 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14652 Lisp_Object aggressive
;
14653 /* We will never try scrolling more than this number of lines. */
14654 int scroll_limit
= SCROLL_LIMIT
;
14657 debug_method_add (w
, "try_scrolling");
14660 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14662 /* Compute scroll margin height in pixels. We scroll when point is
14663 within this distance from the top or bottom of the window. */
14664 if (scroll_margin
> 0)
14665 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14666 * FRAME_LINE_HEIGHT (f
);
14668 this_scroll_margin
= 0;
14670 /* Force arg_scroll_conservatively to have a reasonable value, to
14671 avoid scrolling too far away with slow move_it_* functions. Note
14672 that the user can supply scroll-conservatively equal to
14673 `most-positive-fixnum', which can be larger than INT_MAX. */
14674 if (arg_scroll_conservatively
> scroll_limit
)
14676 arg_scroll_conservatively
= scroll_limit
+ 1;
14677 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14679 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14680 /* Compute how much we should try to scroll maximally to bring
14681 point into view. */
14682 scroll_max
= (max (scroll_step
,
14683 max (arg_scroll_conservatively
, temp_scroll_step
))
14684 * FRAME_LINE_HEIGHT (f
));
14685 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14686 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14687 /* We're trying to scroll because of aggressive scrolling but no
14688 scroll_step is set. Choose an arbitrary one. */
14689 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14695 /* Decide whether to scroll down. */
14696 if (PT
> CHARPOS (startp
))
14698 int scroll_margin_y
;
14700 /* Compute the pixel ypos of the scroll margin, then move IT to
14701 either that ypos or PT, whichever comes first. */
14702 start_display (&it
, w
, startp
);
14703 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14704 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14705 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14706 (MOVE_TO_POS
| MOVE_TO_Y
));
14708 if (PT
> CHARPOS (it
.current
.pos
))
14710 int y0
= line_bottom_y (&it
);
14711 /* Compute how many pixels below window bottom to stop searching
14712 for PT. This avoids costly search for PT that is far away if
14713 the user limited scrolling by a small number of lines, but
14714 always finds PT if scroll_conservatively is set to a large
14715 number, such as most-positive-fixnum. */
14716 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14717 int y_to_move
= it
.last_visible_y
+ slack
;
14719 /* Compute the distance from the scroll margin to PT or to
14720 the scroll limit, whichever comes first. This should
14721 include the height of the cursor line, to make that line
14723 move_it_to (&it
, PT
, -1, y_to_move
,
14724 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14725 dy
= line_bottom_y (&it
) - y0
;
14727 if (dy
> scroll_max
)
14728 return SCROLLING_FAILED
;
14737 /* Point is in or below the bottom scroll margin, so move the
14738 window start down. If scrolling conservatively, move it just
14739 enough down to make point visible. If scroll_step is set,
14740 move it down by scroll_step. */
14741 if (arg_scroll_conservatively
)
14743 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14744 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14745 else if (scroll_step
|| temp_scroll_step
)
14746 amount_to_scroll
= scroll_max
;
14749 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14750 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14751 if (NUMBERP (aggressive
))
14753 double float_amount
= XFLOATINT (aggressive
) * height
;
14754 amount_to_scroll
= float_amount
;
14755 if (amount_to_scroll
== 0 && float_amount
> 0)
14756 amount_to_scroll
= 1;
14757 /* Don't let point enter the scroll margin near top of
14759 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14760 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14764 if (amount_to_scroll
<= 0)
14765 return SCROLLING_FAILED
;
14767 start_display (&it
, w
, startp
);
14768 if (arg_scroll_conservatively
<= scroll_limit
)
14769 move_it_vertically (&it
, amount_to_scroll
);
14772 /* Extra precision for users who set scroll-conservatively
14773 to a large number: make sure the amount we scroll
14774 the window start is never less than amount_to_scroll,
14775 which was computed as distance from window bottom to
14776 point. This matters when lines at window top and lines
14777 below window bottom have different height. */
14779 void *it1data
= NULL
;
14780 /* We use a temporary it1 because line_bottom_y can modify
14781 its argument, if it moves one line down; see there. */
14784 SAVE_IT (it1
, it
, it1data
);
14785 start_y
= line_bottom_y (&it1
);
14787 RESTORE_IT (&it
, &it
, it1data
);
14788 move_it_by_lines (&it
, 1);
14789 SAVE_IT (it1
, it
, it1data
);
14790 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14793 /* If STARTP is unchanged, move it down another screen line. */
14794 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14795 move_it_by_lines (&it
, 1);
14796 startp
= it
.current
.pos
;
14800 struct text_pos scroll_margin_pos
= startp
;
14802 /* See if point is inside the scroll margin at the top of the
14804 if (this_scroll_margin
)
14806 start_display (&it
, w
, startp
);
14807 move_it_vertically (&it
, this_scroll_margin
);
14808 scroll_margin_pos
= it
.current
.pos
;
14811 if (PT
< CHARPOS (scroll_margin_pos
))
14813 /* Point is in the scroll margin at the top of the window or
14814 above what is displayed in the window. */
14817 /* Compute the vertical distance from PT to the scroll
14818 margin position. Move as far as scroll_max allows, or
14819 one screenful, or 10 screen lines, whichever is largest.
14820 Give up if distance is greater than scroll_max. */
14821 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14822 start_display (&it
, w
, pos
);
14824 y_to_move
= max (it
.last_visible_y
,
14825 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14826 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14828 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14829 dy
= it
.current_y
- y0
;
14830 if (dy
> scroll_max
)
14831 return SCROLLING_FAILED
;
14833 /* Compute new window start. */
14834 start_display (&it
, w
, startp
);
14836 if (arg_scroll_conservatively
)
14837 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14838 max (scroll_step
, temp_scroll_step
));
14839 else if (scroll_step
|| temp_scroll_step
)
14840 amount_to_scroll
= scroll_max
;
14843 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14844 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14845 if (NUMBERP (aggressive
))
14847 double float_amount
= XFLOATINT (aggressive
) * height
;
14848 amount_to_scroll
= float_amount
;
14849 if (amount_to_scroll
== 0 && float_amount
> 0)
14850 amount_to_scroll
= 1;
14851 amount_to_scroll
-=
14852 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14853 /* Don't let point enter the scroll margin near
14854 bottom of the window. */
14855 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14856 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14860 if (amount_to_scroll
<= 0)
14861 return SCROLLING_FAILED
;
14863 move_it_vertically_backward (&it
, amount_to_scroll
);
14864 startp
= it
.current
.pos
;
14868 /* Run window scroll functions. */
14869 startp
= run_window_scroll_functions (window
, startp
);
14871 /* Display the window. Give up if new fonts are loaded, or if point
14873 if (!try_window (window
, startp
, 0))
14874 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14875 else if (w
->cursor
.vpos
< 0)
14877 clear_glyph_matrix (w
->desired_matrix
);
14878 rc
= SCROLLING_FAILED
;
14882 /* Maybe forget recorded base line for line number display. */
14883 if (!just_this_one_p
14884 || current_buffer
->clip_changed
14885 || BEG_UNCHANGED
< CHARPOS (startp
))
14886 wset_base_line_number (w
, Qnil
);
14888 /* If cursor ends up on a partially visible line,
14889 treat that as being off the bottom of the screen. */
14890 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14891 /* It's possible that the cursor is on the first line of the
14892 buffer, which is partially obscured due to a vscroll
14893 (Bug#7537). In that case, avoid looping forever . */
14894 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14896 clear_glyph_matrix (w
->desired_matrix
);
14897 ++extra_scroll_margin_lines
;
14900 rc
= SCROLLING_SUCCESS
;
14907 /* Compute a suitable window start for window W if display of W starts
14908 on a continuation line. Value is non-zero if a new window start
14911 The new window start will be computed, based on W's width, starting
14912 from the start of the continued line. It is the start of the
14913 screen line with the minimum distance from the old start W->start. */
14916 compute_window_start_on_continuation_line (struct window
*w
)
14918 struct text_pos pos
, start_pos
;
14919 int window_start_changed_p
= 0;
14921 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14923 /* If window start is on a continuation line... Window start may be
14924 < BEGV in case there's invisible text at the start of the
14925 buffer (M-x rmail, for example). */
14926 if (CHARPOS (start_pos
) > BEGV
14927 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14930 struct glyph_row
*row
;
14932 /* Handle the case that the window start is out of range. */
14933 if (CHARPOS (start_pos
) < BEGV
)
14934 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14935 else if (CHARPOS (start_pos
) > ZV
)
14936 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14938 /* Find the start of the continued line. This should be fast
14939 because scan_buffer is fast (newline cache). */
14940 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14941 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14942 row
, DEFAULT_FACE_ID
);
14943 reseat_at_previous_visible_line_start (&it
);
14945 /* If the line start is "too far" away from the window start,
14946 say it takes too much time to compute a new window start. */
14947 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14948 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14950 int min_distance
, distance
;
14952 /* Move forward by display lines to find the new window
14953 start. If window width was enlarged, the new start can
14954 be expected to be > the old start. If window width was
14955 decreased, the new window start will be < the old start.
14956 So, we're looking for the display line start with the
14957 minimum distance from the old window start. */
14958 pos
= it
.current
.pos
;
14959 min_distance
= INFINITY
;
14960 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14961 distance
< min_distance
)
14963 min_distance
= distance
;
14964 pos
= it
.current
.pos
;
14965 move_it_by_lines (&it
, 1);
14968 /* Set the window start there. */
14969 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14970 window_start_changed_p
= 1;
14974 return window_start_changed_p
;
14978 /* Try cursor movement in case text has not changed in window WINDOW,
14979 with window start STARTP. Value is
14981 CURSOR_MOVEMENT_SUCCESS if successful
14983 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14985 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14986 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14987 we want to scroll as if scroll-step were set to 1. See the code.
14989 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14990 which case we have to abort this redisplay, and adjust matrices
14995 CURSOR_MOVEMENT_SUCCESS
,
14996 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14997 CURSOR_MOVEMENT_MUST_SCROLL
,
14998 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15002 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
15004 struct window
*w
= XWINDOW (window
);
15005 struct frame
*f
= XFRAME (w
->frame
);
15006 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15009 if (inhibit_try_cursor_movement
)
15013 /* Previously, there was a check for Lisp integer in the
15014 if-statement below. Now, this field is converted to
15015 ptrdiff_t, thus zero means invalid position in a buffer. */
15016 eassert (w
->last_point
> 0);
15018 /* Handle case where text has not changed, only point, and it has
15019 not moved off the frame. */
15020 if (/* Point may be in this window. */
15021 PT
>= CHARPOS (startp
)
15022 /* Selective display hasn't changed. */
15023 && !current_buffer
->clip_changed
15024 /* Function force-mode-line-update is used to force a thorough
15025 redisplay. It sets either windows_or_buffers_changed or
15026 update_mode_lines. So don't take a shortcut here for these
15028 && !update_mode_lines
15029 && !windows_or_buffers_changed
15030 && !cursor_type_changed
15031 /* Can't use this case if highlighting a region. When a
15032 region exists, cursor movement has to do more than just
15034 && !(!NILP (Vtransient_mark_mode
)
15035 && !NILP (BVAR (current_buffer
, mark_active
)))
15036 && NILP (w
->region_showing
)
15037 && NILP (Vshow_trailing_whitespace
)
15038 /* This code is not used for mini-buffer for the sake of the case
15039 of redisplaying to replace an echo area message; since in
15040 that case the mini-buffer contents per se are usually
15041 unchanged. This code is of no real use in the mini-buffer
15042 since the handling of this_line_start_pos, etc., in redisplay
15043 handles the same cases. */
15044 && !EQ (window
, minibuf_window
)
15045 /* When splitting windows or for new windows, it happens that
15046 redisplay is called with a nil window_end_vpos or one being
15047 larger than the window. This should really be fixed in
15048 window.c. I don't have this on my list, now, so we do
15049 approximately the same as the old redisplay code. --gerd. */
15050 && INTEGERP (w
->window_end_vpos
)
15051 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
15052 && (FRAME_WINDOW_P (f
)
15053 || !overlay_arrow_in_current_buffer_p ()))
15055 int this_scroll_margin
, top_scroll_margin
;
15056 struct glyph_row
*row
= NULL
;
15059 debug_method_add (w
, "cursor movement");
15062 /* Scroll if point within this distance from the top or bottom
15063 of the window. This is a pixel value. */
15064 if (scroll_margin
> 0)
15066 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15067 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15070 this_scroll_margin
= 0;
15072 top_scroll_margin
= this_scroll_margin
;
15073 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15074 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15076 /* Start with the row the cursor was displayed during the last
15077 not paused redisplay. Give up if that row is not valid. */
15078 if (w
->last_cursor
.vpos
< 0
15079 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
15080 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15083 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
15084 if (row
->mode_line_p
)
15086 if (!row
->enabled_p
)
15087 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15090 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15092 int scroll_p
= 0, must_scroll
= 0;
15093 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15095 if (PT
> w
->last_point
)
15097 /* Point has moved forward. */
15098 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15099 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15101 eassert (row
->enabled_p
);
15105 /* If the end position of a row equals the start
15106 position of the next row, and PT is at that position,
15107 we would rather display cursor in the next line. */
15108 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15109 && MATRIX_ROW_END_CHARPOS (row
) == PT
15110 && row
< w
->current_matrix
->rows
15111 + w
->current_matrix
->nrows
- 1
15112 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15113 && !cursor_row_p (row
))
15116 /* If within the scroll margin, scroll. Note that
15117 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15118 the next line would be drawn, and that
15119 this_scroll_margin can be zero. */
15120 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15121 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15122 /* Line is completely visible last line in window
15123 and PT is to be set in the next line. */
15124 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15125 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15126 && !row
->ends_at_zv_p
15127 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15130 else if (PT
< w
->last_point
)
15132 /* Cursor has to be moved backward. Note that PT >=
15133 CHARPOS (startp) because of the outer if-statement. */
15134 while (!row
->mode_line_p
15135 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15136 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15137 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15138 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15139 row
> w
->current_matrix
->rows
15140 && (row
-1)->ends_in_newline_from_string_p
))))
15141 && (row
->y
> top_scroll_margin
15142 || CHARPOS (startp
) == BEGV
))
15144 eassert (row
->enabled_p
);
15148 /* Consider the following case: Window starts at BEGV,
15149 there is invisible, intangible text at BEGV, so that
15150 display starts at some point START > BEGV. It can
15151 happen that we are called with PT somewhere between
15152 BEGV and START. Try to handle that case. */
15153 if (row
< w
->current_matrix
->rows
15154 || row
->mode_line_p
)
15156 row
= w
->current_matrix
->rows
;
15157 if (row
->mode_line_p
)
15161 /* Due to newlines in overlay strings, we may have to
15162 skip forward over overlay strings. */
15163 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15164 && MATRIX_ROW_END_CHARPOS (row
) == PT
15165 && !cursor_row_p (row
))
15168 /* If within the scroll margin, scroll. */
15169 if (row
->y
< top_scroll_margin
15170 && CHARPOS (startp
) != BEGV
)
15175 /* Cursor did not move. So don't scroll even if cursor line
15176 is partially visible, as it was so before. */
15177 rc
= CURSOR_MOVEMENT_SUCCESS
;
15180 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15181 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15183 /* if PT is not in the glyph row, give up. */
15184 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15187 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15188 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15190 struct glyph_row
*row1
;
15192 /* If rows are bidi-reordered and point moved, back up
15193 until we find a row that does not belong to a
15194 continuation line. This is because we must consider
15195 all rows of a continued line as candidates for the
15196 new cursor positioning, since row start and end
15197 positions change non-linearly with vertical position
15199 /* FIXME: Revisit this when glyph ``spilling'' in
15200 continuation lines' rows is implemented for
15201 bidi-reordered rows. */
15202 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15203 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15206 /* If we hit the beginning of the displayed portion
15207 without finding the first row of a continued
15211 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15214 eassert (row
->enabled_p
);
15219 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15220 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15221 /* Make sure this isn't a header line by any chance, since
15222 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15223 && !row
->mode_line_p
15224 && make_cursor_line_fully_visible_p
)
15226 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15227 && !row
->ends_at_zv_p
15228 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15229 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15230 else if (row
->height
> window_box_height (w
))
15232 /* If we end up in a partially visible line, let's
15233 make it fully visible, except when it's taller
15234 than the window, in which case we can't do much
15237 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15241 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15242 if (!cursor_row_fully_visible_p (w
, 0, 1))
15243 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15245 rc
= CURSOR_MOVEMENT_SUCCESS
;
15249 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15250 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15251 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15253 /* With bidi-reordered rows, there could be more than
15254 one candidate row whose start and end positions
15255 occlude point. We need to let set_cursor_from_row
15256 find the best candidate. */
15257 /* FIXME: Revisit this when glyph ``spilling'' in
15258 continuation lines' rows is implemented for
15259 bidi-reordered rows. */
15264 int at_zv_p
= 0, exact_match_p
= 0;
15266 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15267 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15268 && cursor_row_p (row
))
15269 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15271 /* As soon as we've found the exact match for point,
15272 or the first suitable row whose ends_at_zv_p flag
15273 is set, we are done. */
15275 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
15277 && w
->cursor
.hpos
>= 0
15278 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15281 struct glyph_row
*candidate
=
15282 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15284 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15285 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15288 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15289 || (INTEGERP (g
->object
)
15290 && (g
->charpos
== PT
15291 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15293 if (rv
&& (at_zv_p
|| exact_match_p
))
15295 rc
= CURSOR_MOVEMENT_SUCCESS
;
15298 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15302 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15303 || row
->continued_p
)
15304 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15305 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15306 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15307 /* If we didn't find any candidate rows, or exited the
15308 loop before all the candidates were examined, signal
15309 to the caller that this method failed. */
15310 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15312 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15313 && !row
->continued_p
))
15314 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15316 rc
= CURSOR_MOVEMENT_SUCCESS
;
15322 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15324 rc
= CURSOR_MOVEMENT_SUCCESS
;
15329 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15330 && MATRIX_ROW_START_CHARPOS (row
) == PT
15331 && cursor_row_p (row
));
15339 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15343 set_vertical_scroll_bar (struct window
*w
)
15345 ptrdiff_t start
, end
, whole
;
15347 /* Calculate the start and end positions for the current window.
15348 At some point, it would be nice to choose between scrollbars
15349 which reflect the whole buffer size, with special markers
15350 indicating narrowing, and scrollbars which reflect only the
15353 Note that mini-buffers sometimes aren't displaying any text. */
15354 if (!MINI_WINDOW_P (w
)
15355 || (w
== XWINDOW (minibuf_window
)
15356 && NILP (echo_area_buffer
[0])))
15358 struct buffer
*buf
= XBUFFER (w
->buffer
);
15359 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15360 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15361 /* I don't think this is guaranteed to be right. For the
15362 moment, we'll pretend it is. */
15363 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
15367 if (whole
< (end
- start
))
15368 whole
= end
- start
;
15371 start
= end
= whole
= 0;
15373 /* Indicate what this scroll bar ought to be displaying now. */
15374 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15375 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15376 (w
, end
- start
, whole
, start
);
15380 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15381 selected_window is redisplayed.
15383 We can return without actually redisplaying the window if
15384 fonts_changed_p. In that case, redisplay_internal will
15388 redisplay_window (Lisp_Object window
, int just_this_one_p
)
15390 struct window
*w
= XWINDOW (window
);
15391 struct frame
*f
= XFRAME (w
->frame
);
15392 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15393 struct buffer
*old
= current_buffer
;
15394 struct text_pos lpoint
, opoint
, startp
;
15395 int update_mode_line
;
15398 /* Record it now because it's overwritten. */
15399 int current_matrix_up_to_date_p
= 0;
15400 int used_current_matrix_p
= 0;
15401 /* This is less strict than current_matrix_up_to_date_p.
15402 It indicates that the buffer contents and narrowing are unchanged. */
15403 int buffer_unchanged_p
= 0;
15404 int temp_scroll_step
= 0;
15405 ptrdiff_t count
= SPECPDL_INDEX ();
15407 int centering_position
= -1;
15408 int last_line_misfit
= 0;
15409 ptrdiff_t beg_unchanged
, end_unchanged
;
15411 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15414 /* W must be a leaf window here. */
15415 eassert (!NILP (w
->buffer
));
15417 *w
->desired_matrix
->method
= 0;
15421 reconsider_clip_changes (w
, buffer
);
15423 /* Has the mode line to be updated? */
15424 update_mode_line
= (w
->update_mode_line
15425 || update_mode_lines
15426 || buffer
->clip_changed
15427 || buffer
->prevent_redisplay_optimizations_p
);
15429 if (MINI_WINDOW_P (w
))
15431 if (w
== XWINDOW (echo_area_window
)
15432 && !NILP (echo_area_buffer
[0]))
15434 if (update_mode_line
)
15435 /* We may have to update a tty frame's menu bar or a
15436 tool-bar. Example `M-x C-h C-h C-g'. */
15437 goto finish_menu_bars
;
15439 /* We've already displayed the echo area glyphs in this window. */
15440 goto finish_scroll_bars
;
15442 else if ((w
!= XWINDOW (minibuf_window
)
15443 || minibuf_level
== 0)
15444 /* When buffer is nonempty, redisplay window normally. */
15445 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
15446 /* Quail displays non-mini buffers in minibuffer window.
15447 In that case, redisplay the window normally. */
15448 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
15450 /* W is a mini-buffer window, but it's not active, so clear
15452 int yb
= window_text_bottom_y (w
);
15453 struct glyph_row
*row
;
15456 for (y
= 0, row
= w
->desired_matrix
->rows
;
15458 y
+= row
->height
, ++row
)
15459 blank_row (w
, row
, y
);
15460 goto finish_scroll_bars
;
15463 clear_glyph_matrix (w
->desired_matrix
);
15466 /* Otherwise set up data on this window; select its buffer and point
15468 /* Really select the buffer, for the sake of buffer-local
15470 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15472 current_matrix_up_to_date_p
15473 = (!NILP (w
->window_end_valid
)
15474 && !current_buffer
->clip_changed
15475 && !current_buffer
->prevent_redisplay_optimizations_p
15476 && w
->last_modified
>= MODIFF
15477 && w
->last_overlay_modified
>= OVERLAY_MODIFF
);
15479 /* Run the window-bottom-change-functions
15480 if it is possible that the text on the screen has changed
15481 (either due to modification of the text, or any other reason). */
15482 if (!current_matrix_up_to_date_p
15483 && !NILP (Vwindow_text_change_functions
))
15485 safe_run_hooks (Qwindow_text_change_functions
);
15489 beg_unchanged
= BEG_UNCHANGED
;
15490 end_unchanged
= END_UNCHANGED
;
15492 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15494 specbind (Qinhibit_point_motion_hooks
, Qt
);
15497 = (!NILP (w
->window_end_valid
)
15498 && !current_buffer
->clip_changed
15499 && w
->last_modified
>= MODIFF
15500 && w
->last_overlay_modified
>= OVERLAY_MODIFF
);
15502 /* When windows_or_buffers_changed is non-zero, we can't rely on
15503 the window end being valid, so set it to nil there. */
15504 if (windows_or_buffers_changed
)
15506 /* If window starts on a continuation line, maybe adjust the
15507 window start in case the window's width changed. */
15508 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15509 compute_window_start_on_continuation_line (w
);
15511 wset_window_end_valid (w
, Qnil
);
15514 /* Some sanity checks. */
15515 CHECK_WINDOW_END (w
);
15516 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15518 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15521 /* If %c is in mode line, update it if needed. */
15522 if (!NILP (w
->column_number_displayed
)
15523 /* This alternative quickly identifies a common case
15524 where no change is needed. */
15525 && !(PT
== w
->last_point
15526 && w
->last_modified
>= MODIFF
15527 && w
->last_overlay_modified
>= OVERLAY_MODIFF
)
15528 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
15529 update_mode_line
= 1;
15531 /* Count number of windows showing the selected buffer. An indirect
15532 buffer counts as its base buffer. */
15533 if (!just_this_one_p
)
15535 struct buffer
*current_base
, *window_base
;
15536 current_base
= current_buffer
;
15537 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
15538 if (current_base
->base_buffer
)
15539 current_base
= current_base
->base_buffer
;
15540 if (window_base
->base_buffer
)
15541 window_base
= window_base
->base_buffer
;
15542 if (current_base
== window_base
)
15546 /* Point refers normally to the selected window. For any other
15547 window, set up appropriate value. */
15548 if (!EQ (window
, selected_window
))
15550 ptrdiff_t new_pt
= XMARKER (w
->pointm
)->charpos
;
15551 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
15555 new_pt_byte
= BEGV_BYTE
;
15556 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15558 else if (new_pt
> (ZV
- 1))
15561 new_pt_byte
= ZV_BYTE
;
15562 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15565 /* We don't use SET_PT so that the point-motion hooks don't run. */
15566 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15569 /* If any of the character widths specified in the display table
15570 have changed, invalidate the width run cache. It's true that
15571 this may be a bit late to catch such changes, but the rest of
15572 redisplay goes (non-fatally) haywire when the display table is
15573 changed, so why should we worry about doing any better? */
15574 if (current_buffer
->width_run_cache
)
15576 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15578 if (! disptab_matches_widthtab
15579 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
15581 invalidate_region_cache (current_buffer
,
15582 current_buffer
->width_run_cache
,
15584 recompute_width_table (current_buffer
, disptab
);
15588 /* If window-start is screwed up, choose a new one. */
15589 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15592 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15594 /* If someone specified a new starting point but did not insist,
15595 check whether it can be used. */
15596 if (w
->optional_new_start
15597 && CHARPOS (startp
) >= BEGV
15598 && CHARPOS (startp
) <= ZV
)
15600 w
->optional_new_start
= 0;
15601 start_display (&it
, w
, startp
);
15602 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15603 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15604 if (IT_CHARPOS (it
) == PT
)
15605 w
->force_start
= 1;
15606 /* IT may overshoot PT if text at PT is invisible. */
15607 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15608 w
->force_start
= 1;
15613 /* Handle case where place to start displaying has been specified,
15614 unless the specified location is outside the accessible range. */
15615 if (w
->force_start
|| w
->frozen_window_start_p
)
15617 /* We set this later on if we have to adjust point. */
15620 w
->force_start
= 0;
15622 wset_window_end_valid (w
, Qnil
);
15624 /* Forget any recorded base line for line number display. */
15625 if (!buffer_unchanged_p
)
15626 wset_base_line_number (w
, Qnil
);
15628 /* Redisplay the mode line. Select the buffer properly for that.
15629 Also, run the hook window-scroll-functions
15630 because we have scrolled. */
15631 /* Note, we do this after clearing force_start because
15632 if there's an error, it is better to forget about force_start
15633 than to get into an infinite loop calling the hook functions
15634 and having them get more errors. */
15635 if (!update_mode_line
15636 || ! NILP (Vwindow_scroll_functions
))
15638 update_mode_line
= 1;
15639 w
->update_mode_line
= 1;
15640 startp
= run_window_scroll_functions (window
, startp
);
15643 w
->last_modified
= 0;
15644 w
->last_overlay_modified
= 0;
15645 if (CHARPOS (startp
) < BEGV
)
15646 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15647 else if (CHARPOS (startp
) > ZV
)
15648 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15650 /* Redisplay, then check if cursor has been set during the
15651 redisplay. Give up if new fonts were loaded. */
15652 /* We used to issue a CHECK_MARGINS argument to try_window here,
15653 but this causes scrolling to fail when point begins inside
15654 the scroll margin (bug#148) -- cyd */
15655 if (!try_window (window
, startp
, 0))
15657 w
->force_start
= 1;
15658 clear_glyph_matrix (w
->desired_matrix
);
15659 goto need_larger_matrices
;
15662 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15664 /* If point does not appear, try to move point so it does
15665 appear. The desired matrix has been built above, so we
15666 can use it here. */
15667 new_vpos
= window_box_height (w
) / 2;
15670 if (!cursor_row_fully_visible_p (w
, 0, 0))
15672 /* Point does appear, but on a line partly visible at end of window.
15673 Move it back to a fully-visible line. */
15674 new_vpos
= window_box_height (w
);
15677 /* If we need to move point for either of the above reasons,
15678 now actually do it. */
15681 struct glyph_row
*row
;
15683 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15684 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15687 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15688 MATRIX_ROW_START_BYTEPOS (row
));
15690 if (w
!= XWINDOW (selected_window
))
15691 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15692 else if (current_buffer
== old
)
15693 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15695 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15697 /* If we are highlighting the region, then we just changed
15698 the region, so redisplay to show it. */
15699 if (!NILP (Vtransient_mark_mode
)
15700 && !NILP (BVAR (current_buffer
, mark_active
)))
15702 clear_glyph_matrix (w
->desired_matrix
);
15703 if (!try_window (window
, startp
, 0))
15704 goto need_larger_matrices
;
15709 debug_method_add (w
, "forced window start");
15714 /* Handle case where text has not changed, only point, and it has
15715 not moved off the frame, and we are not retrying after hscroll.
15716 (current_matrix_up_to_date_p is nonzero when retrying.) */
15717 if (current_matrix_up_to_date_p
15718 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15719 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15723 case CURSOR_MOVEMENT_SUCCESS
:
15724 used_current_matrix_p
= 1;
15727 case CURSOR_MOVEMENT_MUST_SCROLL
:
15728 goto try_to_scroll
;
15734 /* If current starting point was originally the beginning of a line
15735 but no longer is, find a new starting point. */
15736 else if (w
->start_at_line_beg
15737 && !(CHARPOS (startp
) <= BEGV
15738 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15741 debug_method_add (w
, "recenter 1");
15746 /* Try scrolling with try_window_id. Value is > 0 if update has
15747 been done, it is -1 if we know that the same window start will
15748 not work. It is 0 if unsuccessful for some other reason. */
15749 else if ((tem
= try_window_id (w
)) != 0)
15752 debug_method_add (w
, "try_window_id %d", tem
);
15755 if (fonts_changed_p
)
15756 goto need_larger_matrices
;
15760 /* Otherwise try_window_id has returned -1 which means that we
15761 don't want the alternative below this comment to execute. */
15763 else if (CHARPOS (startp
) >= BEGV
15764 && CHARPOS (startp
) <= ZV
15765 && PT
>= CHARPOS (startp
)
15766 && (CHARPOS (startp
) < ZV
15767 /* Avoid starting at end of buffer. */
15768 || CHARPOS (startp
) == BEGV
15769 || (w
->last_modified
>= MODIFF
15770 && w
->last_overlay_modified
>= OVERLAY_MODIFF
)))
15772 int d1
, d2
, d3
, d4
, d5
, d6
;
15774 /* If first window line is a continuation line, and window start
15775 is inside the modified region, but the first change is before
15776 current window start, we must select a new window start.
15778 However, if this is the result of a down-mouse event (e.g. by
15779 extending the mouse-drag-overlay), we don't want to select a
15780 new window start, since that would change the position under
15781 the mouse, resulting in an unwanted mouse-movement rather
15782 than a simple mouse-click. */
15783 if (!w
->start_at_line_beg
15784 && NILP (do_mouse_tracking
)
15785 && CHARPOS (startp
) > BEGV
15786 && CHARPOS (startp
) > BEG
+ beg_unchanged
15787 && CHARPOS (startp
) <= Z
- end_unchanged
15788 /* Even if w->start_at_line_beg is nil, a new window may
15789 start at a line_beg, since that's how set_buffer_window
15790 sets it. So, we need to check the return value of
15791 compute_window_start_on_continuation_line. (See also
15793 && XMARKER (w
->start
)->buffer
== current_buffer
15794 && compute_window_start_on_continuation_line (w
)
15795 /* It doesn't make sense to force the window start like we
15796 do at label force_start if it is already known that point
15797 will not be visible in the resulting window, because
15798 doing so will move point from its correct position
15799 instead of scrolling the window to bring point into view.
15801 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15803 w
->force_start
= 1;
15804 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15809 debug_method_add (w
, "same window start");
15812 /* Try to redisplay starting at same place as before.
15813 If point has not moved off frame, accept the results. */
15814 if (!current_matrix_up_to_date_p
15815 /* Don't use try_window_reusing_current_matrix in this case
15816 because a window scroll function can have changed the
15818 || !NILP (Vwindow_scroll_functions
)
15819 || MINI_WINDOW_P (w
)
15820 || !(used_current_matrix_p
15821 = try_window_reusing_current_matrix (w
)))
15823 IF_DEBUG (debug_method_add (w
, "1"));
15824 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15825 /* -1 means we need to scroll.
15826 0 means we need new matrices, but fonts_changed_p
15827 is set in that case, so we will detect it below. */
15828 goto try_to_scroll
;
15831 if (fonts_changed_p
)
15832 goto need_larger_matrices
;
15834 if (w
->cursor
.vpos
>= 0)
15836 if (!just_this_one_p
15837 || current_buffer
->clip_changed
15838 || BEG_UNCHANGED
< CHARPOS (startp
))
15839 /* Forget any recorded base line for line number display. */
15840 wset_base_line_number (w
, Qnil
);
15842 if (!cursor_row_fully_visible_p (w
, 1, 0))
15844 clear_glyph_matrix (w
->desired_matrix
);
15845 last_line_misfit
= 1;
15847 /* Drop through and scroll. */
15852 clear_glyph_matrix (w
->desired_matrix
);
15857 w
->last_modified
= 0;
15858 w
->last_overlay_modified
= 0;
15860 /* Redisplay the mode line. Select the buffer properly for that. */
15861 if (!update_mode_line
)
15863 update_mode_line
= 1;
15864 w
->update_mode_line
= 1;
15867 /* Try to scroll by specified few lines. */
15868 if ((scroll_conservatively
15869 || emacs_scroll_step
15870 || temp_scroll_step
15871 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15872 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15873 && CHARPOS (startp
) >= BEGV
15874 && CHARPOS (startp
) <= ZV
)
15876 /* The function returns -1 if new fonts were loaded, 1 if
15877 successful, 0 if not successful. */
15878 int ss
= try_scrolling (window
, just_this_one_p
,
15879 scroll_conservatively
,
15881 temp_scroll_step
, last_line_misfit
);
15884 case SCROLLING_SUCCESS
:
15887 case SCROLLING_NEED_LARGER_MATRICES
:
15888 goto need_larger_matrices
;
15890 case SCROLLING_FAILED
:
15898 /* Finally, just choose a place to start which positions point
15899 according to user preferences. */
15904 debug_method_add (w
, "recenter");
15907 /* w->vscroll = 0; */
15909 /* Forget any previously recorded base line for line number display. */
15910 if (!buffer_unchanged_p
)
15911 wset_base_line_number (w
, Qnil
);
15913 /* Determine the window start relative to point. */
15914 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15915 it
.current_y
= it
.last_visible_y
;
15916 if (centering_position
< 0)
15920 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15922 ptrdiff_t margin_pos
= CHARPOS (startp
);
15923 Lisp_Object aggressive
;
15926 /* If there is a scroll margin at the top of the window, find
15927 its character position. */
15929 /* Cannot call start_display if startp is not in the
15930 accessible region of the buffer. This can happen when we
15931 have just switched to a different buffer and/or changed
15932 its restriction. In that case, startp is initialized to
15933 the character position 1 (BEGV) because we did not yet
15934 have chance to display the buffer even once. */
15935 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15938 void *it1data
= NULL
;
15940 SAVE_IT (it1
, it
, it1data
);
15941 start_display (&it1
, w
, startp
);
15942 move_it_vertically (&it1
, margin
* FRAME_LINE_HEIGHT (f
));
15943 margin_pos
= IT_CHARPOS (it1
);
15944 RESTORE_IT (&it
, &it
, it1data
);
15946 scrolling_up
= PT
> margin_pos
;
15949 ? BVAR (current_buffer
, scroll_up_aggressively
)
15950 : BVAR (current_buffer
, scroll_down_aggressively
);
15952 if (!MINI_WINDOW_P (w
)
15953 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15957 /* Setting scroll-conservatively overrides
15958 scroll-*-aggressively. */
15959 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15961 double float_amount
= XFLOATINT (aggressive
);
15963 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15964 if (pt_offset
== 0 && float_amount
> 0)
15966 if (pt_offset
&& margin
> 0)
15969 /* Compute how much to move the window start backward from
15970 point so that point will be displayed where the user
15974 centering_position
= it
.last_visible_y
;
15976 centering_position
-= pt_offset
;
15977 centering_position
-=
15978 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15979 + WINDOW_HEADER_LINE_HEIGHT (w
);
15980 /* Don't let point enter the scroll margin near top of
15982 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15983 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15986 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15989 /* Set the window start half the height of the window backward
15991 centering_position
= window_box_height (w
) / 2;
15993 move_it_vertically_backward (&it
, centering_position
);
15995 eassert (IT_CHARPOS (it
) >= BEGV
);
15997 /* The function move_it_vertically_backward may move over more
15998 than the specified y-distance. If it->w is small, e.g. a
15999 mini-buffer window, we may end up in front of the window's
16000 display area. Start displaying at the start of the line
16001 containing PT in this case. */
16002 if (it
.current_y
<= 0)
16004 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16005 move_it_vertically_backward (&it
, 0);
16009 it
.current_x
= it
.hpos
= 0;
16011 /* Set the window start position here explicitly, to avoid an
16012 infinite loop in case the functions in window-scroll-functions
16014 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16016 /* Run scroll hooks. */
16017 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16019 /* Redisplay the window. */
16020 if (!current_matrix_up_to_date_p
16021 || windows_or_buffers_changed
16022 || cursor_type_changed
16023 /* Don't use try_window_reusing_current_matrix in this case
16024 because it can have changed the buffer. */
16025 || !NILP (Vwindow_scroll_functions
)
16026 || !just_this_one_p
16027 || MINI_WINDOW_P (w
)
16028 || !(used_current_matrix_p
16029 = try_window_reusing_current_matrix (w
)))
16030 try_window (window
, startp
, 0);
16032 /* If new fonts have been loaded (due to fontsets), give up. We
16033 have to start a new redisplay since we need to re-adjust glyph
16035 if (fonts_changed_p
)
16036 goto need_larger_matrices
;
16038 /* If cursor did not appear assume that the middle of the window is
16039 in the first line of the window. Do it again with the next line.
16040 (Imagine a window of height 100, displaying two lines of height
16041 60. Moving back 50 from it->last_visible_y will end in the first
16043 if (w
->cursor
.vpos
< 0)
16045 if (!NILP (w
->window_end_valid
)
16046 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
16048 clear_glyph_matrix (w
->desired_matrix
);
16049 move_it_by_lines (&it
, 1);
16050 try_window (window
, it
.current
.pos
, 0);
16052 else if (PT
< IT_CHARPOS (it
))
16054 clear_glyph_matrix (w
->desired_matrix
);
16055 move_it_by_lines (&it
, -1);
16056 try_window (window
, it
.current
.pos
, 0);
16060 /* Not much we can do about it. */
16064 /* Consider the following case: Window starts at BEGV, there is
16065 invisible, intangible text at BEGV, so that display starts at
16066 some point START > BEGV. It can happen that we are called with
16067 PT somewhere between BEGV and START. Try to handle that case. */
16068 if (w
->cursor
.vpos
< 0)
16070 struct glyph_row
*row
= w
->current_matrix
->rows
;
16071 if (row
->mode_line_p
)
16073 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16076 if (!cursor_row_fully_visible_p (w
, 0, 0))
16078 /* If vscroll is enabled, disable it and try again. */
16082 clear_glyph_matrix (w
->desired_matrix
);
16086 /* Users who set scroll-conservatively to a large number want
16087 point just above/below the scroll margin. If we ended up
16088 with point's row partially visible, move the window start to
16089 make that row fully visible and out of the margin. */
16090 if (scroll_conservatively
> SCROLL_LIMIT
)
16094 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
16096 int move_down
= w
->cursor
.vpos
>= WINDOW_TOTAL_LINES (w
) / 2;
16098 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16099 clear_glyph_matrix (w
->desired_matrix
);
16100 if (1 == try_window (window
, it
.current
.pos
,
16101 TRY_WINDOW_CHECK_MARGINS
))
16105 /* If centering point failed to make the whole line visible,
16106 put point at the top instead. That has to make the whole line
16107 visible, if it can be done. */
16108 if (centering_position
== 0)
16111 clear_glyph_matrix (w
->desired_matrix
);
16112 centering_position
= 0;
16118 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16119 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16120 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16122 /* Display the mode line, if we must. */
16123 if ((update_mode_line
16124 /* If window not full width, must redo its mode line
16125 if (a) the window to its side is being redone and
16126 (b) we do a frame-based redisplay. This is a consequence
16127 of how inverted lines are drawn in frame-based redisplay. */
16128 || (!just_this_one_p
16129 && !FRAME_WINDOW_P (f
)
16130 && !WINDOW_FULL_WIDTH_P (w
))
16131 /* Line number to display. */
16132 || INTEGERP (w
->base_line_pos
)
16133 /* Column number is displayed and different from the one displayed. */
16134 || (!NILP (w
->column_number_displayed
)
16135 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
16136 /* This means that the window has a mode line. */
16137 && (WINDOW_WANTS_MODELINE_P (w
)
16138 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16140 display_mode_lines (w
);
16142 /* If mode line height has changed, arrange for a thorough
16143 immediate redisplay using the correct mode line height. */
16144 if (WINDOW_WANTS_MODELINE_P (w
)
16145 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16147 fonts_changed_p
= 1;
16148 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16149 = DESIRED_MODE_LINE_HEIGHT (w
);
16152 /* If header line height has changed, arrange for a thorough
16153 immediate redisplay using the correct header line height. */
16154 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16155 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16157 fonts_changed_p
= 1;
16158 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16159 = DESIRED_HEADER_LINE_HEIGHT (w
);
16162 if (fonts_changed_p
)
16163 goto need_larger_matrices
;
16166 if (!line_number_displayed
16167 && !BUFFERP (w
->base_line_pos
))
16169 wset_base_line_pos (w
, Qnil
);
16170 wset_base_line_number (w
, Qnil
);
16175 /* When we reach a frame's selected window, redo the frame's menu bar. */
16176 if (update_mode_line
16177 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16179 int redisplay_menu_p
= 0;
16181 if (FRAME_WINDOW_P (f
))
16183 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16184 || defined (HAVE_NS) || defined (USE_GTK)
16185 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16187 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16191 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16193 if (redisplay_menu_p
)
16194 display_menu_bar (w
);
16196 #ifdef HAVE_WINDOW_SYSTEM
16197 if (FRAME_WINDOW_P (f
))
16199 #if defined (USE_GTK) || defined (HAVE_NS)
16200 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16201 redisplay_tool_bar (f
);
16203 if (WINDOWP (f
->tool_bar_window
)
16204 && (FRAME_TOOL_BAR_LINES (f
) > 0
16205 || !NILP (Vauto_resize_tool_bars
))
16206 && redisplay_tool_bar (f
))
16207 ignore_mouse_drag_p
= 1;
16213 #ifdef HAVE_WINDOW_SYSTEM
16214 if (FRAME_WINDOW_P (f
)
16215 && update_window_fringes (w
, (just_this_one_p
16216 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16217 || w
->pseudo_window_p
)))
16221 if (draw_window_fringes (w
, 1))
16222 x_draw_vertical_border (w
);
16226 #endif /* HAVE_WINDOW_SYSTEM */
16228 /* We go to this label, with fonts_changed_p set,
16229 if it is necessary to try again using larger glyph matrices.
16230 We have to redeem the scroll bar even in this case,
16231 because the loop in redisplay_internal expects that. */
16232 need_larger_matrices
:
16234 finish_scroll_bars
:
16236 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16238 /* Set the thumb's position and size. */
16239 set_vertical_scroll_bar (w
);
16241 /* Note that we actually used the scroll bar attached to this
16242 window, so it shouldn't be deleted at the end of redisplay. */
16243 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16244 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16247 /* Restore current_buffer and value of point in it. The window
16248 update may have changed the buffer, so first make sure `opoint'
16249 is still valid (Bug#6177). */
16250 if (CHARPOS (opoint
) < BEGV
)
16251 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16252 else if (CHARPOS (opoint
) > ZV
)
16253 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16255 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16257 set_buffer_internal_1 (old
);
16258 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16259 shorter. This can be caused by log truncation in *Messages*. */
16260 if (CHARPOS (lpoint
) <= ZV
)
16261 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16263 unbind_to (count
, Qnil
);
16267 /* Build the complete desired matrix of WINDOW with a window start
16268 buffer position POS.
16270 Value is 1 if successful. It is zero if fonts were loaded during
16271 redisplay which makes re-adjusting glyph matrices necessary, and -1
16272 if point would appear in the scroll margins.
16273 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16274 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16278 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16280 struct window
*w
= XWINDOW (window
);
16282 struct glyph_row
*last_text_row
= NULL
;
16283 struct frame
*f
= XFRAME (w
->frame
);
16285 /* Make POS the new window start. */
16286 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16288 /* Mark cursor position as unknown. No overlay arrow seen. */
16289 w
->cursor
.vpos
= -1;
16290 overlay_arrow_seen
= 0;
16292 /* Initialize iterator and info to start at POS. */
16293 start_display (&it
, w
, pos
);
16295 /* Display all lines of W. */
16296 while (it
.current_y
< it
.last_visible_y
)
16298 if (display_line (&it
))
16299 last_text_row
= it
.glyph_row
- 1;
16300 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16304 /* Don't let the cursor end in the scroll margins. */
16305 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16306 && !MINI_WINDOW_P (w
))
16308 int this_scroll_margin
;
16310 if (scroll_margin
> 0)
16312 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16313 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
16316 this_scroll_margin
= 0;
16318 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16319 && w
->cursor
.y
< this_scroll_margin
16320 && CHARPOS (pos
) > BEGV
16321 && IT_CHARPOS (it
) < ZV
)
16322 /* rms: considering make_cursor_line_fully_visible_p here
16323 seems to give wrong results. We don't want to recenter
16324 when the last line is partly visible, we want to allow
16325 that case to be handled in the usual way. */
16326 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16328 w
->cursor
.vpos
= -1;
16329 clear_glyph_matrix (w
->desired_matrix
);
16334 /* If bottom moved off end of frame, change mode line percentage. */
16335 if (XFASTINT (w
->window_end_pos
) <= 0
16336 && Z
!= IT_CHARPOS (it
))
16337 w
->update_mode_line
= 1;
16339 /* Set window_end_pos to the offset of the last character displayed
16340 on the window from the end of current_buffer. Set
16341 window_end_vpos to its row number. */
16344 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16345 w
->window_end_bytepos
16346 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16347 wset_window_end_pos
16348 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16349 wset_window_end_vpos
16350 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
)));
16352 (MATRIX_ROW (w
->desired_matrix
,
16353 XFASTINT (w
->window_end_vpos
))->displays_text_p
);
16357 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16358 wset_window_end_pos (w
, make_number (Z
- ZV
));
16359 wset_window_end_vpos (w
, make_number (0));
16362 /* But that is not valid info until redisplay finishes. */
16363 wset_window_end_valid (w
, Qnil
);
16369 /************************************************************************
16370 Window redisplay reusing current matrix when buffer has not changed
16371 ************************************************************************/
16373 /* Try redisplay of window W showing an unchanged buffer with a
16374 different window start than the last time it was displayed by
16375 reusing its current matrix. Value is non-zero if successful.
16376 W->start is the new window start. */
16379 try_window_reusing_current_matrix (struct window
*w
)
16381 struct frame
*f
= XFRAME (w
->frame
);
16382 struct glyph_row
*bottom_row
;
16385 struct text_pos start
, new_start
;
16386 int nrows_scrolled
, i
;
16387 struct glyph_row
*last_text_row
;
16388 struct glyph_row
*last_reused_text_row
;
16389 struct glyph_row
*start_row
;
16390 int start_vpos
, min_y
, max_y
;
16393 if (inhibit_try_window_reusing
)
16397 if (/* This function doesn't handle terminal frames. */
16398 !FRAME_WINDOW_P (f
)
16399 /* Don't try to reuse the display if windows have been split
16401 || windows_or_buffers_changed
16402 || cursor_type_changed
)
16405 /* Can't do this if region may have changed. */
16406 if ((!NILP (Vtransient_mark_mode
)
16407 && !NILP (BVAR (current_buffer
, mark_active
)))
16408 || !NILP (w
->region_showing
)
16409 || !NILP (Vshow_trailing_whitespace
))
16412 /* If top-line visibility has changed, give up. */
16413 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16414 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16417 /* Give up if old or new display is scrolled vertically. We could
16418 make this function handle this, but right now it doesn't. */
16419 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16420 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16423 /* The variable new_start now holds the new window start. The old
16424 start `start' can be determined from the current matrix. */
16425 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16426 start
= start_row
->minpos
;
16427 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16429 /* Clear the desired matrix for the display below. */
16430 clear_glyph_matrix (w
->desired_matrix
);
16432 if (CHARPOS (new_start
) <= CHARPOS (start
))
16434 /* Don't use this method if the display starts with an ellipsis
16435 displayed for invisible text. It's not easy to handle that case
16436 below, and it's certainly not worth the effort since this is
16437 not a frequent case. */
16438 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16441 IF_DEBUG (debug_method_add (w
, "twu1"));
16443 /* Display up to a row that can be reused. The variable
16444 last_text_row is set to the last row displayed that displays
16445 text. Note that it.vpos == 0 if or if not there is a
16446 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16447 start_display (&it
, w
, new_start
);
16448 w
->cursor
.vpos
= -1;
16449 last_text_row
= last_reused_text_row
= NULL
;
16451 while (it
.current_y
< it
.last_visible_y
16452 && !fonts_changed_p
)
16454 /* If we have reached into the characters in the START row,
16455 that means the line boundaries have changed. So we
16456 can't start copying with the row START. Maybe it will
16457 work to start copying with the following row. */
16458 while (IT_CHARPOS (it
) > CHARPOS (start
))
16460 /* Advance to the next row as the "start". */
16462 start
= start_row
->minpos
;
16463 /* If there are no more rows to try, or just one, give up. */
16464 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16465 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16466 || CHARPOS (start
) == ZV
)
16468 clear_glyph_matrix (w
->desired_matrix
);
16472 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16474 /* If we have reached alignment, we can copy the rest of the
16476 if (IT_CHARPOS (it
) == CHARPOS (start
)
16477 /* Don't accept "alignment" inside a display vector,
16478 since start_row could have started in the middle of
16479 that same display vector (thus their character
16480 positions match), and we have no way of telling if
16481 that is the case. */
16482 && it
.current
.dpvec_index
< 0)
16485 if (display_line (&it
))
16486 last_text_row
= it
.glyph_row
- 1;
16490 /* A value of current_y < last_visible_y means that we stopped
16491 at the previous window start, which in turn means that we
16492 have at least one reusable row. */
16493 if (it
.current_y
< it
.last_visible_y
)
16495 struct glyph_row
*row
;
16497 /* IT.vpos always starts from 0; it counts text lines. */
16498 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16500 /* Find PT if not already found in the lines displayed. */
16501 if (w
->cursor
.vpos
< 0)
16503 int dy
= it
.current_y
- start_row
->y
;
16505 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16506 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16508 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16509 dy
, nrows_scrolled
);
16512 clear_glyph_matrix (w
->desired_matrix
);
16517 /* Scroll the display. Do it before the current matrix is
16518 changed. The problem here is that update has not yet
16519 run, i.e. part of the current matrix is not up to date.
16520 scroll_run_hook will clear the cursor, and use the
16521 current matrix to get the height of the row the cursor is
16523 run
.current_y
= start_row
->y
;
16524 run
.desired_y
= it
.current_y
;
16525 run
.height
= it
.last_visible_y
- it
.current_y
;
16527 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16530 FRAME_RIF (f
)->update_window_begin_hook (w
);
16531 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16532 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16533 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16537 /* Shift current matrix down by nrows_scrolled lines. */
16538 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16539 rotate_matrix (w
->current_matrix
,
16541 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16544 /* Disable lines that must be updated. */
16545 for (i
= 0; i
< nrows_scrolled
; ++i
)
16546 (start_row
+ i
)->enabled_p
= 0;
16548 /* Re-compute Y positions. */
16549 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16550 max_y
= it
.last_visible_y
;
16551 for (row
= start_row
+ nrows_scrolled
;
16555 row
->y
= it
.current_y
;
16556 row
->visible_height
= row
->height
;
16558 if (row
->y
< min_y
)
16559 row
->visible_height
-= min_y
- row
->y
;
16560 if (row
->y
+ row
->height
> max_y
)
16561 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16562 if (row
->fringe_bitmap_periodic_p
)
16563 row
->redraw_fringe_bitmaps_p
= 1;
16565 it
.current_y
+= row
->height
;
16567 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16568 last_reused_text_row
= row
;
16569 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16573 /* Disable lines in the current matrix which are now
16574 below the window. */
16575 for (++row
; row
< bottom_row
; ++row
)
16576 row
->enabled_p
= row
->mode_line_p
= 0;
16579 /* Update window_end_pos etc.; last_reused_text_row is the last
16580 reused row from the current matrix containing text, if any.
16581 The value of last_text_row is the last displayed line
16582 containing text. */
16583 if (last_reused_text_row
)
16585 w
->window_end_bytepos
16586 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
16587 wset_window_end_pos
16589 - MATRIX_ROW_END_CHARPOS (last_reused_text_row
)));
16590 wset_window_end_vpos
16591 (w
, make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
16592 w
->current_matrix
)));
16594 else if (last_text_row
)
16596 w
->window_end_bytepos
16597 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16598 wset_window_end_pos
16599 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16600 wset_window_end_vpos
16601 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
,
16602 w
->desired_matrix
)));
16606 /* This window must be completely empty. */
16607 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16608 wset_window_end_pos (w
, make_number (Z
- ZV
));
16609 wset_window_end_vpos (w
, make_number (0));
16611 wset_window_end_valid (w
, Qnil
);
16613 /* Update hint: don't try scrolling again in update_window. */
16614 w
->desired_matrix
->no_scrolling_p
= 1;
16617 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16621 else if (CHARPOS (new_start
) > CHARPOS (start
))
16623 struct glyph_row
*pt_row
, *row
;
16624 struct glyph_row
*first_reusable_row
;
16625 struct glyph_row
*first_row_to_display
;
16627 int yb
= window_text_bottom_y (w
);
16629 /* Find the row starting at new_start, if there is one. Don't
16630 reuse a partially visible line at the end. */
16631 first_reusable_row
= start_row
;
16632 while (first_reusable_row
->enabled_p
16633 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16634 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16635 < CHARPOS (new_start
)))
16636 ++first_reusable_row
;
16638 /* Give up if there is no row to reuse. */
16639 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16640 || !first_reusable_row
->enabled_p
16641 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16642 != CHARPOS (new_start
)))
16645 /* We can reuse fully visible rows beginning with
16646 first_reusable_row to the end of the window. Set
16647 first_row_to_display to the first row that cannot be reused.
16648 Set pt_row to the row containing point, if there is any. */
16650 for (first_row_to_display
= first_reusable_row
;
16651 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16652 ++first_row_to_display
)
16654 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16655 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16656 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16657 && first_row_to_display
->ends_at_zv_p
16658 && pt_row
== NULL
)))
16659 pt_row
= first_row_to_display
;
16662 /* Start displaying at the start of first_row_to_display. */
16663 eassert (first_row_to_display
->y
< yb
);
16664 init_to_row_start (&it
, w
, first_row_to_display
);
16666 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16668 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16670 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16671 + WINDOW_HEADER_LINE_HEIGHT (w
));
16673 /* Display lines beginning with first_row_to_display in the
16674 desired matrix. Set last_text_row to the last row displayed
16675 that displays text. */
16676 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16677 if (pt_row
== NULL
)
16678 w
->cursor
.vpos
= -1;
16679 last_text_row
= NULL
;
16680 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16681 if (display_line (&it
))
16682 last_text_row
= it
.glyph_row
- 1;
16684 /* If point is in a reused row, adjust y and vpos of the cursor
16688 w
->cursor
.vpos
-= nrows_scrolled
;
16689 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16692 /* Give up if point isn't in a row displayed or reused. (This
16693 also handles the case where w->cursor.vpos < nrows_scrolled
16694 after the calls to display_line, which can happen with scroll
16695 margins. See bug#1295.) */
16696 if (w
->cursor
.vpos
< 0)
16698 clear_glyph_matrix (w
->desired_matrix
);
16702 /* Scroll the display. */
16703 run
.current_y
= first_reusable_row
->y
;
16704 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16705 run
.height
= it
.last_visible_y
- run
.current_y
;
16706 dy
= run
.current_y
- run
.desired_y
;
16711 FRAME_RIF (f
)->update_window_begin_hook (w
);
16712 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16713 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16714 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16718 /* Adjust Y positions of reused rows. */
16719 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16720 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16721 max_y
= it
.last_visible_y
;
16722 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16725 row
->visible_height
= row
->height
;
16726 if (row
->y
< min_y
)
16727 row
->visible_height
-= min_y
- row
->y
;
16728 if (row
->y
+ row
->height
> max_y
)
16729 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16730 if (row
->fringe_bitmap_periodic_p
)
16731 row
->redraw_fringe_bitmaps_p
= 1;
16734 /* Scroll the current matrix. */
16735 eassert (nrows_scrolled
> 0);
16736 rotate_matrix (w
->current_matrix
,
16738 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16741 /* Disable rows not reused. */
16742 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16743 row
->enabled_p
= 0;
16745 /* Point may have moved to a different line, so we cannot assume that
16746 the previous cursor position is valid; locate the correct row. */
16749 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16751 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
16752 && !row
->ends_at_zv_p
;
16756 w
->cursor
.y
= row
->y
;
16758 if (row
< bottom_row
)
16760 /* Can't simply scan the row for point with
16761 bidi-reordered glyph rows. Let set_cursor_from_row
16762 figure out where to put the cursor, and if it fails,
16764 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16766 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
16769 clear_glyph_matrix (w
->desired_matrix
);
16775 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16776 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16779 && (!BUFFERP (glyph
->object
)
16780 || glyph
->charpos
< PT
);
16784 w
->cursor
.x
+= glyph
->pixel_width
;
16790 /* Adjust window end. A null value of last_text_row means that
16791 the window end is in reused rows which in turn means that
16792 only its vpos can have changed. */
16795 w
->window_end_bytepos
16796 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16797 wset_window_end_pos
16798 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16799 wset_window_end_vpos
16800 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
,
16801 w
->desired_matrix
)));
16805 wset_window_end_vpos
16806 (w
, make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
));
16809 wset_window_end_valid (w
, Qnil
);
16810 w
->desired_matrix
->no_scrolling_p
= 1;
16813 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16823 /************************************************************************
16824 Window redisplay reusing current matrix when buffer has changed
16825 ************************************************************************/
16827 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16828 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16829 ptrdiff_t *, ptrdiff_t *);
16830 static struct glyph_row
*
16831 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16832 struct glyph_row
*);
16835 /* Return the last row in MATRIX displaying text. If row START is
16836 non-null, start searching with that row. IT gives the dimensions
16837 of the display. Value is null if matrix is empty; otherwise it is
16838 a pointer to the row found. */
16840 static struct glyph_row
*
16841 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16842 struct glyph_row
*start
)
16844 struct glyph_row
*row
, *row_found
;
16846 /* Set row_found to the last row in IT->w's current matrix
16847 displaying text. The loop looks funny but think of partially
16850 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16851 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16853 eassert (row
->enabled_p
);
16855 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16864 /* Return the last row in the current matrix of W that is not affected
16865 by changes at the start of current_buffer that occurred since W's
16866 current matrix was built. Value is null if no such row exists.
16868 BEG_UNCHANGED us the number of characters unchanged at the start of
16869 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16870 first changed character in current_buffer. Characters at positions <
16871 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16872 when the current matrix was built. */
16874 static struct glyph_row
*
16875 find_last_unchanged_at_beg_row (struct window
*w
)
16877 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16878 struct glyph_row
*row
;
16879 struct glyph_row
*row_found
= NULL
;
16880 int yb
= window_text_bottom_y (w
);
16882 /* Find the last row displaying unchanged text. */
16883 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16884 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16885 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16888 if (/* If row ends before first_changed_pos, it is unchanged,
16889 except in some case. */
16890 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16891 /* When row ends in ZV and we write at ZV it is not
16893 && !row
->ends_at_zv_p
16894 /* When first_changed_pos is the end of a continued line,
16895 row is not unchanged because it may be no longer
16897 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16898 && (row
->continued_p
16899 || row
->exact_window_width_line_p
))
16900 /* If ROW->end is beyond ZV, then ROW->end is outdated and
16901 needs to be recomputed, so don't consider this row as
16902 unchanged. This happens when the last line was
16903 bidi-reordered and was killed immediately before this
16904 redisplay cycle. In that case, ROW->end stores the
16905 buffer position of the first visual-order character of
16906 the killed text, which is now beyond ZV. */
16907 && CHARPOS (row
->end
.pos
) <= ZV
)
16910 /* Stop if last visible row. */
16911 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16919 /* Find the first glyph row in the current matrix of W that is not
16920 affected by changes at the end of current_buffer since the
16921 time W's current matrix was built.
16923 Return in *DELTA the number of chars by which buffer positions in
16924 unchanged text at the end of current_buffer must be adjusted.
16926 Return in *DELTA_BYTES the corresponding number of bytes.
16928 Value is null if no such row exists, i.e. all rows are affected by
16931 static struct glyph_row
*
16932 find_first_unchanged_at_end_row (struct window
*w
,
16933 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
16935 struct glyph_row
*row
;
16936 struct glyph_row
*row_found
= NULL
;
16938 *delta
= *delta_bytes
= 0;
16940 /* Display must not have been paused, otherwise the current matrix
16941 is not up to date. */
16942 eassert (!NILP (w
->window_end_valid
));
16944 /* A value of window_end_pos >= END_UNCHANGED means that the window
16945 end is in the range of changed text. If so, there is no
16946 unchanged row at the end of W's current matrix. */
16947 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16950 /* Set row to the last row in W's current matrix displaying text. */
16951 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16953 /* If matrix is entirely empty, no unchanged row exists. */
16954 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16956 /* The value of row is the last glyph row in the matrix having a
16957 meaningful buffer position in it. The end position of row
16958 corresponds to window_end_pos. This allows us to translate
16959 buffer positions in the current matrix to current buffer
16960 positions for characters not in changed text. */
16962 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16963 ptrdiff_t Z_BYTE_old
=
16964 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16965 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
16966 struct glyph_row
*first_text_row
16967 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16969 *delta
= Z
- Z_old
;
16970 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16972 /* Set last_unchanged_pos to the buffer position of the last
16973 character in the buffer that has not been changed. Z is the
16974 index + 1 of the last character in current_buffer, i.e. by
16975 subtracting END_UNCHANGED we get the index of the last
16976 unchanged character, and we have to add BEG to get its buffer
16978 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16979 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16981 /* Search backward from ROW for a row displaying a line that
16982 starts at a minimum position >= last_unchanged_pos_old. */
16983 for (; row
> first_text_row
; --row
)
16985 /* This used to abort, but it can happen.
16986 It is ok to just stop the search instead here. KFS. */
16987 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16990 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16995 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17001 /* Make sure that glyph rows in the current matrix of window W
17002 reference the same glyph memory as corresponding rows in the
17003 frame's frame matrix. This function is called after scrolling W's
17004 current matrix on a terminal frame in try_window_id and
17005 try_window_reusing_current_matrix. */
17008 sync_frame_with_window_matrix_rows (struct window
*w
)
17010 struct frame
*f
= XFRAME (w
->frame
);
17011 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17013 /* Preconditions: W must be a leaf window and full-width. Its frame
17014 must have a frame matrix. */
17015 eassert (NILP (w
->hchild
) && NILP (w
->vchild
));
17016 eassert (WINDOW_FULL_WIDTH_P (w
));
17017 eassert (!FRAME_WINDOW_P (f
));
17019 /* If W is a full-width window, glyph pointers in W's current matrix
17020 have, by definition, to be the same as glyph pointers in the
17021 corresponding frame matrix. Note that frame matrices have no
17022 marginal areas (see build_frame_matrix). */
17023 window_row
= w
->current_matrix
->rows
;
17024 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17025 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17026 while (window_row
< window_row_end
)
17028 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17029 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17031 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17032 frame_row
->glyphs
[TEXT_AREA
] = start
;
17033 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17034 frame_row
->glyphs
[LAST_AREA
] = end
;
17036 /* Disable frame rows whose corresponding window rows have
17037 been disabled in try_window_id. */
17038 if (!window_row
->enabled_p
)
17039 frame_row
->enabled_p
= 0;
17041 ++window_row
, ++frame_row
;
17046 /* Find the glyph row in window W containing CHARPOS. Consider all
17047 rows between START and END (not inclusive). END null means search
17048 all rows to the end of the display area of W. Value is the row
17049 containing CHARPOS or null. */
17052 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17053 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17055 struct glyph_row
*row
= start
;
17056 struct glyph_row
*best_row
= NULL
;
17057 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
17060 /* If we happen to start on a header-line, skip that. */
17061 if (row
->mode_line_p
)
17064 if ((end
&& row
>= end
) || !row
->enabled_p
)
17067 last_y
= window_text_bottom_y (w
) - dy
;
17071 /* Give up if we have gone too far. */
17072 if (end
&& row
>= end
)
17074 /* This formerly returned if they were equal.
17075 I think that both quantities are of a "last plus one" type;
17076 if so, when they are equal, the row is within the screen. -- rms. */
17077 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17080 /* If it is in this row, return this row. */
17081 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17082 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17083 /* The end position of a row equals the start
17084 position of the next row. If CHARPOS is there, we
17085 would rather display it in the next line, except
17086 when this line ends in ZV. */
17087 && !row
->ends_at_zv_p
17088 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
17089 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17093 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
17094 || (!best_row
&& !row
->continued_p
))
17096 /* In bidi-reordered rows, there could be several rows
17097 occluding point, all of them belonging to the same
17098 continued line. We need to find the row which fits
17099 CHARPOS the best. */
17100 for (g
= row
->glyphs
[TEXT_AREA
];
17101 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17104 if (!STRINGP (g
->object
))
17106 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17108 mindif
= eabs (g
->charpos
- charpos
);
17110 /* Exact match always wins. */
17117 else if (best_row
&& !row
->continued_p
)
17124 /* Try to redisplay window W by reusing its existing display. W's
17125 current matrix must be up to date when this function is called,
17126 i.e. window_end_valid must not be nil.
17130 1 if display has been updated
17131 0 if otherwise unsuccessful
17132 -1 if redisplay with same window start is known not to succeed
17134 The following steps are performed:
17136 1. Find the last row in the current matrix of W that is not
17137 affected by changes at the start of current_buffer. If no such row
17140 2. Find the first row in W's current matrix that is not affected by
17141 changes at the end of current_buffer. Maybe there is no such row.
17143 3. Display lines beginning with the row + 1 found in step 1 to the
17144 row found in step 2 or, if step 2 didn't find a row, to the end of
17147 4. If cursor is not known to appear on the window, give up.
17149 5. If display stopped at the row found in step 2, scroll the
17150 display and current matrix as needed.
17152 6. Maybe display some lines at the end of W, if we must. This can
17153 happen under various circumstances, like a partially visible line
17154 becoming fully visible, or because newly displayed lines are displayed
17155 in smaller font sizes.
17157 7. Update W's window end information. */
17160 try_window_id (struct window
*w
)
17162 struct frame
*f
= XFRAME (w
->frame
);
17163 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17164 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17165 struct glyph_row
*last_unchanged_at_beg_row
;
17166 struct glyph_row
*first_unchanged_at_end_row
;
17167 struct glyph_row
*row
;
17168 struct glyph_row
*bottom_row
;
17171 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17173 struct text_pos start_pos
;
17175 int first_unchanged_at_end_vpos
= 0;
17176 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17177 struct text_pos start
;
17178 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17181 if (inhibit_try_window_id
)
17185 /* This is handy for debugging. */
17187 #define GIVE_UP(X) \
17189 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17193 #define GIVE_UP(X) return 0
17196 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17198 /* Don't use this for mini-windows because these can show
17199 messages and mini-buffers, and we don't handle that here. */
17200 if (MINI_WINDOW_P (w
))
17203 /* This flag is used to prevent redisplay optimizations. */
17204 if (windows_or_buffers_changed
|| cursor_type_changed
)
17207 /* Verify that narrowing has not changed.
17208 Also verify that we were not told to prevent redisplay optimizations.
17209 It would be nice to further
17210 reduce the number of cases where this prevents try_window_id. */
17211 if (current_buffer
->clip_changed
17212 || current_buffer
->prevent_redisplay_optimizations_p
)
17215 /* Window must either use window-based redisplay or be full width. */
17216 if (!FRAME_WINDOW_P (f
)
17217 && (!FRAME_LINE_INS_DEL_OK (f
)
17218 || !WINDOW_FULL_WIDTH_P (w
)))
17221 /* Give up if point is known NOT to appear in W. */
17222 if (PT
< CHARPOS (start
))
17225 /* Another way to prevent redisplay optimizations. */
17226 if (w
->last_modified
== 0)
17229 /* Verify that window is not hscrolled. */
17230 if (w
->hscroll
!= 0)
17233 /* Verify that display wasn't paused. */
17234 if (NILP (w
->window_end_valid
))
17237 /* Can't use this if highlighting a region because a cursor movement
17238 will do more than just set the cursor. */
17239 if (!NILP (Vtransient_mark_mode
)
17240 && !NILP (BVAR (current_buffer
, mark_active
)))
17243 /* Likewise if highlighting trailing whitespace. */
17244 if (!NILP (Vshow_trailing_whitespace
))
17247 /* Likewise if showing a region. */
17248 if (!NILP (w
->region_showing
))
17251 /* Can't use this if overlay arrow position and/or string have
17253 if (overlay_arrows_changed_p ())
17256 /* When word-wrap is on, adding a space to the first word of a
17257 wrapped line can change the wrap position, altering the line
17258 above it. It might be worthwhile to handle this more
17259 intelligently, but for now just redisplay from scratch. */
17260 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
17263 /* Under bidi reordering, adding or deleting a character in the
17264 beginning of a paragraph, before the first strong directional
17265 character, can change the base direction of the paragraph (unless
17266 the buffer specifies a fixed paragraph direction), which will
17267 require to redisplay the whole paragraph. It might be worthwhile
17268 to find the paragraph limits and widen the range of redisplayed
17269 lines to that, but for now just give up this optimization and
17270 redisplay from scratch. */
17271 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
17272 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
17275 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17276 only if buffer has really changed. The reason is that the gap is
17277 initially at Z for freshly visited files. The code below would
17278 set end_unchanged to 0 in that case. */
17279 if (MODIFF
> SAVE_MODIFF
17280 /* This seems to happen sometimes after saving a buffer. */
17281 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17283 if (GPT
- BEG
< BEG_UNCHANGED
)
17284 BEG_UNCHANGED
= GPT
- BEG
;
17285 if (Z
- GPT
< END_UNCHANGED
)
17286 END_UNCHANGED
= Z
- GPT
;
17289 /* The position of the first and last character that has been changed. */
17290 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17291 last_changed_charpos
= Z
- END_UNCHANGED
;
17293 /* If window starts after a line end, and the last change is in
17294 front of that newline, then changes don't affect the display.
17295 This case happens with stealth-fontification. Note that although
17296 the display is unchanged, glyph positions in the matrix have to
17297 be adjusted, of course. */
17298 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
17299 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17300 && ((last_changed_charpos
< CHARPOS (start
)
17301 && CHARPOS (start
) == BEGV
)
17302 || (last_changed_charpos
< CHARPOS (start
) - 1
17303 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17305 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17306 struct glyph_row
*r0
;
17308 /* Compute how many chars/bytes have been added to or removed
17309 from the buffer. */
17310 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
17311 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17312 Z_delta
= Z
- Z_old
;
17313 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17315 /* Give up if PT is not in the window. Note that it already has
17316 been checked at the start of try_window_id that PT is not in
17317 front of the window start. */
17318 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17321 /* If window start is unchanged, we can reuse the whole matrix
17322 as is, after adjusting glyph positions. No need to compute
17323 the window end again, since its offset from Z hasn't changed. */
17324 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17325 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17326 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17327 /* PT must not be in a partially visible line. */
17328 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17329 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17331 /* Adjust positions in the glyph matrix. */
17332 if (Z_delta
|| Z_delta_bytes
)
17334 struct glyph_row
*r1
17335 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17336 increment_matrix_positions (w
->current_matrix
,
17337 MATRIX_ROW_VPOS (r0
, current_matrix
),
17338 MATRIX_ROW_VPOS (r1
, current_matrix
),
17339 Z_delta
, Z_delta_bytes
);
17342 /* Set the cursor. */
17343 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17345 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17352 /* Handle the case that changes are all below what is displayed in
17353 the window, and that PT is in the window. This shortcut cannot
17354 be taken if ZV is visible in the window, and text has been added
17355 there that is visible in the window. */
17356 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17357 /* ZV is not visible in the window, or there are no
17358 changes at ZV, actually. */
17359 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17360 || first_changed_charpos
== last_changed_charpos
))
17362 struct glyph_row
*r0
;
17364 /* Give up if PT is not in the window. Note that it already has
17365 been checked at the start of try_window_id that PT is not in
17366 front of the window start. */
17367 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17370 /* If window start is unchanged, we can reuse the whole matrix
17371 as is, without changing glyph positions since no text has
17372 been added/removed in front of the window end. */
17373 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17374 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17375 /* PT must not be in a partially visible line. */
17376 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17377 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17379 /* We have to compute the window end anew since text
17380 could have been added/removed after it. */
17381 wset_window_end_pos
17382 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17383 w
->window_end_bytepos
17384 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17386 /* Set the cursor. */
17387 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17389 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17396 /* Give up if window start is in the changed area.
17398 The condition used to read
17400 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17402 but why that was tested escapes me at the moment. */
17403 if (CHARPOS (start
) >= first_changed_charpos
17404 && CHARPOS (start
) <= last_changed_charpos
)
17407 /* Check that window start agrees with the start of the first glyph
17408 row in its current matrix. Check this after we know the window
17409 start is not in changed text, otherwise positions would not be
17411 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17412 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17415 /* Give up if the window ends in strings. Overlay strings
17416 at the end are difficult to handle, so don't try. */
17417 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
17418 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17421 /* Compute the position at which we have to start displaying new
17422 lines. Some of the lines at the top of the window might be
17423 reusable because they are not displaying changed text. Find the
17424 last row in W's current matrix not affected by changes at the
17425 start of current_buffer. Value is null if changes start in the
17426 first line of window. */
17427 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17428 if (last_unchanged_at_beg_row
)
17430 /* Avoid starting to display in the middle of a character, a TAB
17431 for instance. This is easier than to set up the iterator
17432 exactly, and it's not a frequent case, so the additional
17433 effort wouldn't really pay off. */
17434 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17435 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17436 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17437 --last_unchanged_at_beg_row
;
17439 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17442 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17444 start_pos
= it
.current
.pos
;
17446 /* Start displaying new lines in the desired matrix at the same
17447 vpos we would use in the current matrix, i.e. below
17448 last_unchanged_at_beg_row. */
17449 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17451 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17452 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17454 eassert (it
.hpos
== 0 && it
.current_x
== 0);
17458 /* There are no reusable lines at the start of the window.
17459 Start displaying in the first text line. */
17460 start_display (&it
, w
, start
);
17461 it
.vpos
= it
.first_vpos
;
17462 start_pos
= it
.current
.pos
;
17465 /* Find the first row that is not affected by changes at the end of
17466 the buffer. Value will be null if there is no unchanged row, in
17467 which case we must redisplay to the end of the window. delta
17468 will be set to the value by which buffer positions beginning with
17469 first_unchanged_at_end_row have to be adjusted due to text
17471 first_unchanged_at_end_row
17472 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17473 IF_DEBUG (debug_delta
= delta
);
17474 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17476 /* Set stop_pos to the buffer position up to which we will have to
17477 display new lines. If first_unchanged_at_end_row != NULL, this
17478 is the buffer position of the start of the line displayed in that
17479 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17480 that we don't stop at a buffer position. */
17482 if (first_unchanged_at_end_row
)
17484 eassert (last_unchanged_at_beg_row
== NULL
17485 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17487 /* If this is a continuation line, move forward to the next one
17488 that isn't. Changes in lines above affect this line.
17489 Caution: this may move first_unchanged_at_end_row to a row
17490 not displaying text. */
17491 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17492 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17493 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17494 < it
.last_visible_y
))
17495 ++first_unchanged_at_end_row
;
17497 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17498 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17499 >= it
.last_visible_y
))
17500 first_unchanged_at_end_row
= NULL
;
17503 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17505 first_unchanged_at_end_vpos
17506 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17507 eassert (stop_pos
>= Z
- END_UNCHANGED
);
17510 else if (last_unchanged_at_beg_row
== NULL
)
17516 /* Either there is no unchanged row at the end, or the one we have
17517 now displays text. This is a necessary condition for the window
17518 end pos calculation at the end of this function. */
17519 eassert (first_unchanged_at_end_row
== NULL
17520 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17522 debug_last_unchanged_at_beg_vpos
17523 = (last_unchanged_at_beg_row
17524 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17526 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17528 #endif /* GLYPH_DEBUG */
17531 /* Display new lines. Set last_text_row to the last new line
17532 displayed which has text on it, i.e. might end up as being the
17533 line where the window_end_vpos is. */
17534 w
->cursor
.vpos
= -1;
17535 last_text_row
= NULL
;
17536 overlay_arrow_seen
= 0;
17537 while (it
.current_y
< it
.last_visible_y
17538 && !fonts_changed_p
17539 && (first_unchanged_at_end_row
== NULL
17540 || IT_CHARPOS (it
) < stop_pos
))
17542 if (display_line (&it
))
17543 last_text_row
= it
.glyph_row
- 1;
17546 if (fonts_changed_p
)
17550 /* Compute differences in buffer positions, y-positions etc. for
17551 lines reused at the bottom of the window. Compute what we can
17553 if (first_unchanged_at_end_row
17554 /* No lines reused because we displayed everything up to the
17555 bottom of the window. */
17556 && it
.current_y
< it
.last_visible_y
)
17559 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17561 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17562 run
.current_y
= first_unchanged_at_end_row
->y
;
17563 run
.desired_y
= run
.current_y
+ dy
;
17564 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17568 delta
= delta_bytes
= dvpos
= dy
17569 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17570 first_unchanged_at_end_row
= NULL
;
17572 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17575 /* Find the cursor if not already found. We have to decide whether
17576 PT will appear on this window (it sometimes doesn't, but this is
17577 not a very frequent case.) This decision has to be made before
17578 the current matrix is altered. A value of cursor.vpos < 0 means
17579 that PT is either in one of the lines beginning at
17580 first_unchanged_at_end_row or below the window. Don't care for
17581 lines that might be displayed later at the window end; as
17582 mentioned, this is not a frequent case. */
17583 if (w
->cursor
.vpos
< 0)
17585 /* Cursor in unchanged rows at the top? */
17586 if (PT
< CHARPOS (start_pos
)
17587 && last_unchanged_at_beg_row
)
17589 row
= row_containing_pos (w
, PT
,
17590 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17591 last_unchanged_at_beg_row
+ 1, 0);
17593 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17596 /* Start from first_unchanged_at_end_row looking for PT. */
17597 else if (first_unchanged_at_end_row
)
17599 row
= row_containing_pos (w
, PT
- delta
,
17600 first_unchanged_at_end_row
, NULL
, 0);
17602 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17603 delta_bytes
, dy
, dvpos
);
17606 /* Give up if cursor was not found. */
17607 if (w
->cursor
.vpos
< 0)
17609 clear_glyph_matrix (w
->desired_matrix
);
17614 /* Don't let the cursor end in the scroll margins. */
17616 int this_scroll_margin
, cursor_height
;
17618 this_scroll_margin
=
17619 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
17620 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
17621 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17623 if ((w
->cursor
.y
< this_scroll_margin
17624 && CHARPOS (start
) > BEGV
)
17625 /* Old redisplay didn't take scroll margin into account at the bottom,
17626 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17627 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17628 ? cursor_height
+ this_scroll_margin
17629 : 1)) > it
.last_visible_y
)
17631 w
->cursor
.vpos
= -1;
17632 clear_glyph_matrix (w
->desired_matrix
);
17637 /* Scroll the display. Do it before changing the current matrix so
17638 that xterm.c doesn't get confused about where the cursor glyph is
17640 if (dy
&& run
.height
)
17644 if (FRAME_WINDOW_P (f
))
17646 FRAME_RIF (f
)->update_window_begin_hook (w
);
17647 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17648 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17649 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17653 /* Terminal frame. In this case, dvpos gives the number of
17654 lines to scroll by; dvpos < 0 means scroll up. */
17656 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17657 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17658 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17659 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17660 + window_internal_height (w
));
17662 #if defined (HAVE_GPM) || defined (MSDOS)
17663 x_clear_window_mouse_face (w
);
17665 /* Perform the operation on the screen. */
17668 /* Scroll last_unchanged_at_beg_row to the end of the
17669 window down dvpos lines. */
17670 set_terminal_window (f
, end
);
17672 /* On dumb terminals delete dvpos lines at the end
17673 before inserting dvpos empty lines. */
17674 if (!FRAME_SCROLL_REGION_OK (f
))
17675 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17677 /* Insert dvpos empty lines in front of
17678 last_unchanged_at_beg_row. */
17679 ins_del_lines (f
, from
, dvpos
);
17681 else if (dvpos
< 0)
17683 /* Scroll up last_unchanged_at_beg_vpos to the end of
17684 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17685 set_terminal_window (f
, end
);
17687 /* Delete dvpos lines in front of
17688 last_unchanged_at_beg_vpos. ins_del_lines will set
17689 the cursor to the given vpos and emit |dvpos| delete
17691 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17693 /* On a dumb terminal insert dvpos empty lines at the
17695 if (!FRAME_SCROLL_REGION_OK (f
))
17696 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17699 set_terminal_window (f
, 0);
17705 /* Shift reused rows of the current matrix to the right position.
17706 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17708 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17709 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17712 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17713 bottom_vpos
, dvpos
);
17714 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17717 else if (dvpos
> 0)
17719 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17720 bottom_vpos
, dvpos
);
17721 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17722 first_unchanged_at_end_vpos
+ dvpos
);
17725 /* For frame-based redisplay, make sure that current frame and window
17726 matrix are in sync with respect to glyph memory. */
17727 if (!FRAME_WINDOW_P (f
))
17728 sync_frame_with_window_matrix_rows (w
);
17730 /* Adjust buffer positions in reused rows. */
17731 if (delta
|| delta_bytes
)
17732 increment_matrix_positions (current_matrix
,
17733 first_unchanged_at_end_vpos
+ dvpos
,
17734 bottom_vpos
, delta
, delta_bytes
);
17736 /* Adjust Y positions. */
17738 shift_glyph_matrix (w
, current_matrix
,
17739 first_unchanged_at_end_vpos
+ dvpos
,
17742 if (first_unchanged_at_end_row
)
17744 first_unchanged_at_end_row
+= dvpos
;
17745 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17746 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17747 first_unchanged_at_end_row
= NULL
;
17750 /* If scrolling up, there may be some lines to display at the end of
17752 last_text_row_at_end
= NULL
;
17755 /* Scrolling up can leave for example a partially visible line
17756 at the end of the window to be redisplayed. */
17757 /* Set last_row to the glyph row in the current matrix where the
17758 window end line is found. It has been moved up or down in
17759 the matrix by dvpos. */
17760 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17761 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17763 /* If last_row is the window end line, it should display text. */
17764 eassert (last_row
->displays_text_p
);
17766 /* If window end line was partially visible before, begin
17767 displaying at that line. Otherwise begin displaying with the
17768 line following it. */
17769 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17771 init_to_row_start (&it
, w
, last_row
);
17772 it
.vpos
= last_vpos
;
17773 it
.current_y
= last_row
->y
;
17777 init_to_row_end (&it
, w
, last_row
);
17778 it
.vpos
= 1 + last_vpos
;
17779 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17783 /* We may start in a continuation line. If so, we have to
17784 get the right continuation_lines_width and current_x. */
17785 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17786 it
.hpos
= it
.current_x
= 0;
17788 /* Display the rest of the lines at the window end. */
17789 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17790 while (it
.current_y
< it
.last_visible_y
17791 && !fonts_changed_p
)
17793 /* Is it always sure that the display agrees with lines in
17794 the current matrix? I don't think so, so we mark rows
17795 displayed invalid in the current matrix by setting their
17796 enabled_p flag to zero. */
17797 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17798 if (display_line (&it
))
17799 last_text_row_at_end
= it
.glyph_row
- 1;
17803 /* Update window_end_pos and window_end_vpos. */
17804 if (first_unchanged_at_end_row
17805 && !last_text_row_at_end
)
17807 /* Window end line if one of the preserved rows from the current
17808 matrix. Set row to the last row displaying text in current
17809 matrix starting at first_unchanged_at_end_row, after
17811 eassert (first_unchanged_at_end_row
->displays_text_p
);
17812 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17813 first_unchanged_at_end_row
);
17814 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17816 wset_window_end_pos (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17817 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17818 wset_window_end_vpos
17819 (w
, make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
)));
17820 eassert (w
->window_end_bytepos
>= 0);
17821 IF_DEBUG (debug_method_add (w
, "A"));
17823 else if (last_text_row_at_end
)
17825 wset_window_end_pos
17826 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
)));
17827 w
->window_end_bytepos
17828 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17829 wset_window_end_vpos
17830 (w
, make_number (MATRIX_ROW_VPOS (last_text_row_at_end
,
17832 eassert (w
->window_end_bytepos
>= 0);
17833 IF_DEBUG (debug_method_add (w
, "B"));
17835 else if (last_text_row
)
17837 /* We have displayed either to the end of the window or at the
17838 end of the window, i.e. the last row with text is to be found
17839 in the desired matrix. */
17840 wset_window_end_pos
17841 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
17842 w
->window_end_bytepos
17843 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17844 wset_window_end_vpos
17845 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
)));
17846 eassert (w
->window_end_bytepos
>= 0);
17848 else if (first_unchanged_at_end_row
== NULL
17849 && last_text_row
== NULL
17850 && last_text_row_at_end
== NULL
)
17852 /* Displayed to end of window, but no line containing text was
17853 displayed. Lines were deleted at the end of the window. */
17854 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17855 int vpos
= XFASTINT (w
->window_end_vpos
);
17856 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17857 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17860 row
== NULL
&& vpos
>= first_vpos
;
17861 --vpos
, --current_row
, --desired_row
)
17863 if (desired_row
->enabled_p
)
17865 if (desired_row
->displays_text_p
)
17868 else if (current_row
->displays_text_p
)
17872 eassert (row
!= NULL
);
17873 wset_window_end_vpos (w
, make_number (vpos
+ 1));
17874 wset_window_end_pos (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17875 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17876 eassert (w
->window_end_bytepos
>= 0);
17877 IF_DEBUG (debug_method_add (w
, "C"));
17882 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17883 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17885 /* Record that display has not been completed. */
17886 wset_window_end_valid (w
, Qnil
);
17887 w
->desired_matrix
->no_scrolling_p
= 1;
17895 /***********************************************************************
17896 More debugging support
17897 ***********************************************************************/
17901 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17902 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17903 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17906 /* Dump the contents of glyph matrix MATRIX on stderr.
17908 GLYPHS 0 means don't show glyph contents.
17909 GLYPHS 1 means show glyphs in short form
17910 GLYPHS > 1 means show glyphs in long form. */
17913 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17916 for (i
= 0; i
< matrix
->nrows
; ++i
)
17917 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17921 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17922 the glyph row and area where the glyph comes from. */
17925 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17927 if (glyph
->type
== CHAR_GLYPH
)
17930 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17931 glyph
- row
->glyphs
[TEXT_AREA
],
17934 (BUFFERP (glyph
->object
)
17936 : (STRINGP (glyph
->object
)
17939 glyph
->pixel_width
,
17941 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17945 glyph
->left_box_line_p
,
17946 glyph
->right_box_line_p
);
17948 else if (glyph
->type
== STRETCH_GLYPH
)
17951 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17952 glyph
- row
->glyphs
[TEXT_AREA
],
17955 (BUFFERP (glyph
->object
)
17957 : (STRINGP (glyph
->object
)
17960 glyph
->pixel_width
,
17964 glyph
->left_box_line_p
,
17965 glyph
->right_box_line_p
);
17967 else if (glyph
->type
== IMAGE_GLYPH
)
17970 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17971 glyph
- row
->glyphs
[TEXT_AREA
],
17974 (BUFFERP (glyph
->object
)
17976 : (STRINGP (glyph
->object
)
17979 glyph
->pixel_width
,
17983 glyph
->left_box_line_p
,
17984 glyph
->right_box_line_p
);
17986 else if (glyph
->type
== COMPOSITE_GLYPH
)
17989 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17990 glyph
- row
->glyphs
[TEXT_AREA
],
17993 (BUFFERP (glyph
->object
)
17995 : (STRINGP (glyph
->object
)
17998 glyph
->pixel_width
,
18000 if (glyph
->u
.cmp
.automatic
)
18003 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18004 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18006 glyph
->left_box_line_p
,
18007 glyph
->right_box_line_p
);
18012 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18013 GLYPHS 0 means don't show glyph contents.
18014 GLYPHS 1 means show glyphs in short form
18015 GLYPHS > 1 means show glyphs in long form. */
18018 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18022 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18023 fprintf (stderr
, "======================================================================\n");
18025 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18026 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18028 MATRIX_ROW_START_CHARPOS (row
),
18029 MATRIX_ROW_END_CHARPOS (row
),
18030 row
->used
[TEXT_AREA
],
18031 row
->contains_overlapping_glyphs_p
,
18033 row
->truncated_on_left_p
,
18034 row
->truncated_on_right_p
,
18036 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18037 row
->displays_text_p
,
18040 row
->ends_in_middle_of_char_p
,
18041 row
->starts_in_middle_of_char_p
,
18047 row
->visible_height
,
18050 fprintf (stderr
, "%9"pD
"d %5"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18051 row
->end
.overlay_string_index
,
18052 row
->continuation_lines_width
);
18053 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
18054 CHARPOS (row
->start
.string_pos
),
18055 CHARPOS (row
->end
.string_pos
));
18056 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
18057 row
->end
.dpvec_index
);
18064 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18066 struct glyph
*glyph
= row
->glyphs
[area
];
18067 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18069 /* Glyph for a line end in text. */
18070 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18073 if (glyph
< glyph_end
)
18074 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
18076 for (; glyph
< glyph_end
; ++glyph
)
18077 dump_glyph (row
, glyph
, area
);
18080 else if (glyphs
== 1)
18084 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18086 char *s
= alloca (row
->used
[area
] + 1);
18089 for (i
= 0; i
< row
->used
[area
]; ++i
)
18091 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18092 if (glyph
->type
== CHAR_GLYPH
18093 && glyph
->u
.ch
< 0x80
18094 && glyph
->u
.ch
>= ' ')
18095 s
[i
] = glyph
->u
.ch
;
18101 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18107 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18108 Sdump_glyph_matrix
, 0, 1, "p",
18109 doc
: /* Dump the current matrix of the selected window to stderr.
18110 Shows contents of glyph row structures. With non-nil
18111 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18112 glyphs in short form, otherwise show glyphs in long form. */)
18113 (Lisp_Object glyphs
)
18115 struct window
*w
= XWINDOW (selected_window
);
18116 struct buffer
*buffer
= XBUFFER (w
->buffer
);
18118 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18119 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18120 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18121 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18122 fprintf (stderr
, "=============================================\n");
18123 dump_glyph_matrix (w
->current_matrix
,
18124 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18129 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18130 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
18133 struct frame
*f
= XFRAME (selected_frame
);
18134 dump_glyph_matrix (f
->current_matrix
, 1);
18139 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18140 doc
: /* Dump glyph row ROW to stderr.
18141 GLYPH 0 means don't dump glyphs.
18142 GLYPH 1 means dump glyphs in short form.
18143 GLYPH > 1 or omitted means dump glyphs in long form. */)
18144 (Lisp_Object row
, Lisp_Object glyphs
)
18146 struct glyph_matrix
*matrix
;
18149 CHECK_NUMBER (row
);
18150 matrix
= XWINDOW (selected_window
)->current_matrix
;
18152 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18153 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18155 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18160 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18161 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18162 GLYPH 0 means don't dump glyphs.
18163 GLYPH 1 means dump glyphs in short form.
18164 GLYPH > 1 or omitted means dump glyphs in long form. */)
18165 (Lisp_Object row
, Lisp_Object glyphs
)
18167 struct frame
*sf
= SELECTED_FRAME ();
18168 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18171 CHECK_NUMBER (row
);
18173 if (vpos
>= 0 && vpos
< m
->nrows
)
18174 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18175 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18180 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18181 doc
: /* Toggle tracing of redisplay.
18182 With ARG, turn tracing on if and only if ARG is positive. */)
18186 trace_redisplay_p
= !trace_redisplay_p
;
18189 arg
= Fprefix_numeric_value (arg
);
18190 trace_redisplay_p
= XINT (arg
) > 0;
18197 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18198 doc
: /* Like `format', but print result to stderr.
18199 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18200 (ptrdiff_t nargs
, Lisp_Object
*args
)
18202 Lisp_Object s
= Fformat (nargs
, args
);
18203 fprintf (stderr
, "%s", SDATA (s
));
18207 #endif /* GLYPH_DEBUG */
18211 /***********************************************************************
18212 Building Desired Matrix Rows
18213 ***********************************************************************/
18215 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18216 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18218 static struct glyph_row
*
18219 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18221 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18222 struct buffer
*buffer
= XBUFFER (w
->buffer
);
18223 struct buffer
*old
= current_buffer
;
18224 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18225 int arrow_len
= SCHARS (overlay_arrow_string
);
18226 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18227 const unsigned char *p
;
18230 int n_glyphs_before
;
18232 set_buffer_temp (buffer
);
18233 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18234 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18235 SET_TEXT_POS (it
.position
, 0, 0);
18237 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18239 while (p
< arrow_end
)
18241 Lisp_Object face
, ilisp
;
18243 /* Get the next character. */
18245 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18248 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18249 if (! ASCII_CHAR_P (it
.c
))
18250 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18254 /* Get its face. */
18255 ilisp
= make_number (p
- arrow_string
);
18256 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18257 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18259 /* Compute its width, get its glyphs. */
18260 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18261 SET_TEXT_POS (it
.position
, -1, -1);
18262 PRODUCE_GLYPHS (&it
);
18264 /* If this character doesn't fit any more in the line, we have
18265 to remove some glyphs. */
18266 if (it
.current_x
> it
.last_visible_x
)
18268 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18273 set_buffer_temp (old
);
18274 return it
.glyph_row
;
18278 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18279 glyphs to insert is determined by produce_special_glyphs. */
18282 insert_left_trunc_glyphs (struct it
*it
)
18284 struct it truncate_it
;
18285 struct glyph
*from
, *end
, *to
, *toend
;
18287 eassert (!FRAME_WINDOW_P (it
->f
)
18288 || (!it
->glyph_row
->reversed_p
18289 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18290 || (it
->glyph_row
->reversed_p
18291 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18293 /* Get the truncation glyphs. */
18295 truncate_it
.current_x
= 0;
18296 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18297 truncate_it
.glyph_row
= &scratch_glyph_row
;
18298 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18299 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18300 truncate_it
.object
= make_number (0);
18301 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18303 /* Overwrite glyphs from IT with truncation glyphs. */
18304 if (!it
->glyph_row
->reversed_p
)
18306 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18308 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18309 end
= from
+ tused
;
18310 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18311 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18312 if (FRAME_WINDOW_P (it
->f
))
18314 /* On GUI frames, when variable-size fonts are displayed,
18315 the truncation glyphs may need more pixels than the row's
18316 glyphs they overwrite. We overwrite more glyphs to free
18317 enough screen real estate, and enlarge the stretch glyph
18318 on the right (see display_line), if there is one, to
18319 preserve the screen position of the truncation glyphs on
18322 struct glyph
*g
= to
;
18325 /* The first glyph could be partially visible, in which case
18326 it->glyph_row->x will be negative. But we want the left
18327 truncation glyphs to be aligned at the left margin of the
18328 window, so we override the x coordinate at which the row
18330 it
->glyph_row
->x
= 0;
18331 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18333 w
+= g
->pixel_width
;
18336 if (g
- to
- tused
> 0)
18338 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18339 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18341 used
= it
->glyph_row
->used
[TEXT_AREA
];
18342 if (it
->glyph_row
->truncated_on_right_p
18343 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18344 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18347 int extra
= w
- it
->truncation_pixel_width
;
18349 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18356 /* There may be padding glyphs left over. Overwrite them too. */
18357 if (!FRAME_WINDOW_P (it
->f
))
18359 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18361 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18368 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18372 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18374 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18375 that back to front. */
18376 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18377 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18378 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18379 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18380 if (FRAME_WINDOW_P (it
->f
))
18383 struct glyph
*g
= to
;
18385 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
18387 w
+= g
->pixel_width
;
18390 if (to
- g
- tused
> 0)
18392 if (it
->glyph_row
->truncated_on_right_p
18393 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
18394 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
18396 int extra
= w
- it
->truncation_pixel_width
;
18398 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
18402 while (from
>= end
&& to
>= toend
)
18404 if (!FRAME_WINDOW_P (it
->f
))
18406 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18409 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18410 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18411 while (from
>= end
&& to
>= toend
)
18417 /* Need to free some room before prepending additional
18419 int move_by
= from
- end
+ 1;
18420 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18421 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18423 for ( ; g
>= g0
; g
--)
18425 while (from
>= end
)
18427 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18432 /* Compute the hash code for ROW. */
18434 row_hash (struct glyph_row
*row
)
18437 unsigned hashval
= 0;
18439 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18440 for (k
= 0; k
< row
->used
[area
]; ++k
)
18441 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18442 + row
->glyphs
[area
][k
].u
.val
18443 + row
->glyphs
[area
][k
].face_id
18444 + row
->glyphs
[area
][k
].padding_p
18445 + (row
->glyphs
[area
][k
].type
<< 2));
18450 /* Compute the pixel height and width of IT->glyph_row.
18452 Most of the time, ascent and height of a display line will be equal
18453 to the max_ascent and max_height values of the display iterator
18454 structure. This is not the case if
18456 1. We hit ZV without displaying anything. In this case, max_ascent
18457 and max_height will be zero.
18459 2. We have some glyphs that don't contribute to the line height.
18460 (The glyph row flag contributes_to_line_height_p is for future
18461 pixmap extensions).
18463 The first case is easily covered by using default values because in
18464 these cases, the line height does not really matter, except that it
18465 must not be zero. */
18468 compute_line_metrics (struct it
*it
)
18470 struct glyph_row
*row
= it
->glyph_row
;
18472 if (FRAME_WINDOW_P (it
->f
))
18474 int i
, min_y
, max_y
;
18476 /* The line may consist of one space only, that was added to
18477 place the cursor on it. If so, the row's height hasn't been
18479 if (row
->height
== 0)
18481 if (it
->max_ascent
+ it
->max_descent
== 0)
18482 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18483 row
->ascent
= it
->max_ascent
;
18484 row
->height
= it
->max_ascent
+ it
->max_descent
;
18485 row
->phys_ascent
= it
->max_phys_ascent
;
18486 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18487 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18490 /* Compute the width of this line. */
18491 row
->pixel_width
= row
->x
;
18492 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18493 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18495 eassert (row
->pixel_width
>= 0);
18496 eassert (row
->ascent
>= 0 && row
->height
> 0);
18498 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
18499 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
18501 /* If first line's physical ascent is larger than its logical
18502 ascent, use the physical ascent, and make the row taller.
18503 This makes accented characters fully visible. */
18504 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
18505 && row
->phys_ascent
> row
->ascent
)
18507 row
->height
+= row
->phys_ascent
- row
->ascent
;
18508 row
->ascent
= row
->phys_ascent
;
18511 /* Compute how much of the line is visible. */
18512 row
->visible_height
= row
->height
;
18514 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18515 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18517 if (row
->y
< min_y
)
18518 row
->visible_height
-= min_y
- row
->y
;
18519 if (row
->y
+ row
->height
> max_y
)
18520 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18524 row
->pixel_width
= row
->used
[TEXT_AREA
];
18525 if (row
->continued_p
)
18526 row
->pixel_width
-= it
->continuation_pixel_width
;
18527 else if (row
->truncated_on_right_p
)
18528 row
->pixel_width
-= it
->truncation_pixel_width
;
18529 row
->ascent
= row
->phys_ascent
= 0;
18530 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18531 row
->extra_line_spacing
= 0;
18534 /* Compute a hash code for this row. */
18535 row
->hash
= row_hash (row
);
18537 it
->max_ascent
= it
->max_descent
= 0;
18538 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18542 /* Append one space to the glyph row of iterator IT if doing a
18543 window-based redisplay. The space has the same face as
18544 IT->face_id. Value is non-zero if a space was added.
18546 This function is called to make sure that there is always one glyph
18547 at the end of a glyph row that the cursor can be set on under
18548 window-systems. (If there weren't such a glyph we would not know
18549 how wide and tall a box cursor should be displayed).
18551 At the same time this space let's a nicely handle clearing to the
18552 end of the line if the row ends in italic text. */
18555 append_space_for_newline (struct it
*it
, int default_face_p
)
18557 if (FRAME_WINDOW_P (it
->f
))
18559 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18561 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18562 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18564 /* Save some values that must not be changed.
18565 Must save IT->c and IT->len because otherwise
18566 ITERATOR_AT_END_P wouldn't work anymore after
18567 append_space_for_newline has been called. */
18568 enum display_element_type saved_what
= it
->what
;
18569 int saved_c
= it
->c
, saved_len
= it
->len
;
18570 int saved_char_to_display
= it
->char_to_display
;
18571 int saved_x
= it
->current_x
;
18572 int saved_face_id
= it
->face_id
;
18573 struct text_pos saved_pos
;
18574 Lisp_Object saved_object
;
18577 saved_object
= it
->object
;
18578 saved_pos
= it
->position
;
18580 it
->what
= IT_CHARACTER
;
18581 memset (&it
->position
, 0, sizeof it
->position
);
18582 it
->object
= make_number (0);
18583 it
->c
= it
->char_to_display
= ' ';
18586 /* If the default face was remapped, be sure to use the
18587 remapped face for the appended newline. */
18588 if (default_face_p
)
18589 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
18590 else if (it
->face_before_selective_p
)
18591 it
->face_id
= it
->saved_face_id
;
18592 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18593 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18595 PRODUCE_GLYPHS (it
);
18597 it
->override_ascent
= -1;
18598 it
->constrain_row_ascent_descent_p
= 0;
18599 it
->current_x
= saved_x
;
18600 it
->object
= saved_object
;
18601 it
->position
= saved_pos
;
18602 it
->what
= saved_what
;
18603 it
->face_id
= saved_face_id
;
18604 it
->len
= saved_len
;
18606 it
->char_to_display
= saved_char_to_display
;
18615 /* Extend the face of the last glyph in the text area of IT->glyph_row
18616 to the end of the display line. Called from display_line. If the
18617 glyph row is empty, add a space glyph to it so that we know the
18618 face to draw. Set the glyph row flag fill_line_p. If the glyph
18619 row is R2L, prepend a stretch glyph to cover the empty space to the
18620 left of the leftmost glyph. */
18623 extend_face_to_end_of_line (struct it
*it
)
18625 struct face
*face
, *default_face
;
18626 struct frame
*f
= it
->f
;
18628 /* If line is already filled, do nothing. Non window-system frames
18629 get a grace of one more ``pixel'' because their characters are
18630 1-``pixel'' wide, so they hit the equality too early. This grace
18631 is needed only for R2L rows that are not continued, to produce
18632 one extra blank where we could display the cursor. */
18633 if (it
->current_x
>= it
->last_visible_x
18634 + (!FRAME_WINDOW_P (f
)
18635 && it
->glyph_row
->reversed_p
18636 && !it
->glyph_row
->continued_p
))
18639 /* The default face, possibly remapped. */
18640 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
18642 /* Face extension extends the background and box of IT->face_id
18643 to the end of the line. If the background equals the background
18644 of the frame, we don't have to do anything. */
18645 if (it
->face_before_selective_p
)
18646 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18648 face
= FACE_FROM_ID (f
, it
->face_id
);
18650 if (FRAME_WINDOW_P (f
)
18651 && it
->glyph_row
->displays_text_p
18652 && face
->box
== FACE_NO_BOX
18653 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18655 && !it
->glyph_row
->reversed_p
)
18658 /* Set the glyph row flag indicating that the face of the last glyph
18659 in the text area has to be drawn to the end of the text area. */
18660 it
->glyph_row
->fill_line_p
= 1;
18662 /* If current character of IT is not ASCII, make sure we have the
18663 ASCII face. This will be automatically undone the next time
18664 get_next_display_element returns a multibyte character. Note
18665 that the character will always be single byte in unibyte
18667 if (!ASCII_CHAR_P (it
->c
))
18669 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18672 if (FRAME_WINDOW_P (f
))
18674 /* If the row is empty, add a space with the current face of IT,
18675 so that we know which face to draw. */
18676 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18678 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18679 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
18680 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18682 #ifdef HAVE_WINDOW_SYSTEM
18683 if (it
->glyph_row
->reversed_p
)
18685 /* Prepend a stretch glyph to the row, such that the
18686 rightmost glyph will be drawn flushed all the way to the
18687 right margin of the window. The stretch glyph that will
18688 occupy the empty space, if any, to the left of the
18690 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18691 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18692 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18694 int row_width
, stretch_ascent
, stretch_width
;
18695 struct text_pos saved_pos
;
18696 int saved_face_id
, saved_avoid_cursor
;
18698 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18699 row_width
+= g
->pixel_width
;
18700 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18701 if (stretch_width
> 0)
18704 (((it
->ascent
+ it
->descent
)
18705 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18706 saved_pos
= it
->position
;
18707 memset (&it
->position
, 0, sizeof it
->position
);
18708 saved_avoid_cursor
= it
->avoid_cursor_p
;
18709 it
->avoid_cursor_p
= 1;
18710 saved_face_id
= it
->face_id
;
18711 /* The last row's stretch glyph should get the default
18712 face, to avoid painting the rest of the window with
18713 the region face, if the region ends at ZV. */
18714 if (it
->glyph_row
->ends_at_zv_p
)
18715 it
->face_id
= default_face
->id
;
18717 it
->face_id
= face
->id
;
18718 append_stretch_glyph (it
, make_number (0), stretch_width
,
18719 it
->ascent
+ it
->descent
, stretch_ascent
);
18720 it
->position
= saved_pos
;
18721 it
->avoid_cursor_p
= saved_avoid_cursor
;
18722 it
->face_id
= saved_face_id
;
18725 #endif /* HAVE_WINDOW_SYSTEM */
18729 /* Save some values that must not be changed. */
18730 int saved_x
= it
->current_x
;
18731 struct text_pos saved_pos
;
18732 Lisp_Object saved_object
;
18733 enum display_element_type saved_what
= it
->what
;
18734 int saved_face_id
= it
->face_id
;
18736 saved_object
= it
->object
;
18737 saved_pos
= it
->position
;
18739 it
->what
= IT_CHARACTER
;
18740 memset (&it
->position
, 0, sizeof it
->position
);
18741 it
->object
= make_number (0);
18742 it
->c
= it
->char_to_display
= ' ';
18744 /* The last row's blank glyphs should get the default face, to
18745 avoid painting the rest of the window with the region face,
18746 if the region ends at ZV. */
18747 if (it
->glyph_row
->ends_at_zv_p
)
18748 it
->face_id
= default_face
->id
;
18750 it
->face_id
= face
->id
;
18752 PRODUCE_GLYPHS (it
);
18754 while (it
->current_x
<= it
->last_visible_x
)
18755 PRODUCE_GLYPHS (it
);
18757 /* Don't count these blanks really. It would let us insert a left
18758 truncation glyph below and make us set the cursor on them, maybe. */
18759 it
->current_x
= saved_x
;
18760 it
->object
= saved_object
;
18761 it
->position
= saved_pos
;
18762 it
->what
= saved_what
;
18763 it
->face_id
= saved_face_id
;
18768 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18769 trailing whitespace. */
18772 trailing_whitespace_p (ptrdiff_t charpos
)
18774 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
18777 while (bytepos
< ZV_BYTE
18778 && (c
= FETCH_CHAR (bytepos
),
18779 c
== ' ' || c
== '\t'))
18782 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18784 if (bytepos
!= PT_BYTE
)
18791 /* Highlight trailing whitespace, if any, in ROW. */
18794 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18796 int used
= row
->used
[TEXT_AREA
];
18800 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18801 struct glyph
*glyph
= start
+ used
- 1;
18803 if (row
->reversed_p
)
18805 /* Right-to-left rows need to be processed in the opposite
18806 direction, so swap the edge pointers. */
18808 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18811 /* Skip over glyphs inserted to display the cursor at the
18812 end of a line, for extending the face of the last glyph
18813 to the end of the line on terminals, and for truncation
18814 and continuation glyphs. */
18815 if (!row
->reversed_p
)
18817 while (glyph
>= start
18818 && glyph
->type
== CHAR_GLYPH
18819 && INTEGERP (glyph
->object
))
18824 while (glyph
<= start
18825 && glyph
->type
== CHAR_GLYPH
18826 && INTEGERP (glyph
->object
))
18830 /* If last glyph is a space or stretch, and it's trailing
18831 whitespace, set the face of all trailing whitespace glyphs in
18832 IT->glyph_row to `trailing-whitespace'. */
18833 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18834 && BUFFERP (glyph
->object
)
18835 && (glyph
->type
== STRETCH_GLYPH
18836 || (glyph
->type
== CHAR_GLYPH
18837 && glyph
->u
.ch
== ' '))
18838 && trailing_whitespace_p (glyph
->charpos
))
18840 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18844 if (!row
->reversed_p
)
18846 while (glyph
>= start
18847 && BUFFERP (glyph
->object
)
18848 && (glyph
->type
== STRETCH_GLYPH
18849 || (glyph
->type
== CHAR_GLYPH
18850 && glyph
->u
.ch
== ' ')))
18851 (glyph
--)->face_id
= face_id
;
18855 while (glyph
<= start
18856 && BUFFERP (glyph
->object
)
18857 && (glyph
->type
== STRETCH_GLYPH
18858 || (glyph
->type
== CHAR_GLYPH
18859 && glyph
->u
.ch
== ' ')))
18860 (glyph
++)->face_id
= face_id
;
18867 /* Value is non-zero if glyph row ROW should be
18868 used to hold the cursor. */
18871 cursor_row_p (struct glyph_row
*row
)
18875 if (PT
== CHARPOS (row
->end
.pos
)
18876 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18878 /* Suppose the row ends on a string.
18879 Unless the row is continued, that means it ends on a newline
18880 in the string. If it's anything other than a display string
18881 (e.g., a before-string from an overlay), we don't want the
18882 cursor there. (This heuristic seems to give the optimal
18883 behavior for the various types of multi-line strings.)
18884 One exception: if the string has `cursor' property on one of
18885 its characters, we _do_ want the cursor there. */
18886 if (CHARPOS (row
->end
.string_pos
) >= 0)
18888 if (row
->continued_p
)
18892 /* Check for `display' property. */
18893 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18894 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18895 struct glyph
*glyph
;
18898 for (glyph
= end
; glyph
>= beg
; --glyph
)
18899 if (STRINGP (glyph
->object
))
18902 = Fget_char_property (make_number (PT
),
18906 && display_prop_string_p (prop
, glyph
->object
));
18907 /* If there's a `cursor' property on one of the
18908 string's characters, this row is a cursor row,
18909 even though this is not a display string. */
18912 Lisp_Object s
= glyph
->object
;
18914 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
18916 ptrdiff_t gpos
= glyph
->charpos
;
18918 if (!NILP (Fget_char_property (make_number (gpos
),
18930 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18932 /* If the row ends in middle of a real character,
18933 and the line is continued, we want the cursor here.
18934 That's because CHARPOS (ROW->end.pos) would equal
18935 PT if PT is before the character. */
18936 if (!row
->ends_in_ellipsis_p
)
18937 result
= row
->continued_p
;
18939 /* If the row ends in an ellipsis, then
18940 CHARPOS (ROW->end.pos) will equal point after the
18941 invisible text. We want that position to be displayed
18942 after the ellipsis. */
18945 /* If the row ends at ZV, display the cursor at the end of that
18946 row instead of at the start of the row below. */
18947 else if (row
->ends_at_zv_p
)
18958 /* Push the property PROP so that it will be rendered at the current
18959 position in IT. Return 1 if PROP was successfully pushed, 0
18960 otherwise. Called from handle_line_prefix to handle the
18961 `line-prefix' and `wrap-prefix' properties. */
18964 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
18966 struct text_pos pos
=
18967 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
18969 eassert (it
->method
== GET_FROM_BUFFER
18970 || it
->method
== GET_FROM_DISPLAY_VECTOR
18971 || it
->method
== GET_FROM_STRING
);
18973 /* We need to save the current buffer/string position, so it will be
18974 restored by pop_it, because iterate_out_of_display_property
18975 depends on that being set correctly, but some situations leave
18976 it->position not yet set when this function is called. */
18977 push_it (it
, &pos
);
18979 if (STRINGP (prop
))
18981 if (SCHARS (prop
) == 0)
18988 it
->string_from_prefix_prop_p
= 1;
18989 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18990 it
->current
.overlay_string_index
= -1;
18991 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18992 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18993 it
->method
= GET_FROM_STRING
;
18994 it
->stop_charpos
= 0;
18996 it
->base_level_stop
= 0;
18998 /* Force paragraph direction to be that of the parent
19000 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19001 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19003 it
->paragraph_embedding
= L2R
;
19005 /* Set up the bidi iterator for this display string. */
19008 it
->bidi_it
.string
.lstring
= it
->string
;
19009 it
->bidi_it
.string
.s
= NULL
;
19010 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19011 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19012 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19013 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19014 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19017 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19019 it
->method
= GET_FROM_STRETCH
;
19022 #ifdef HAVE_WINDOW_SYSTEM
19023 else if (IMAGEP (prop
))
19025 it
->what
= IT_IMAGE
;
19026 it
->image_id
= lookup_image (it
->f
, prop
);
19027 it
->method
= GET_FROM_IMAGE
;
19029 #endif /* HAVE_WINDOW_SYSTEM */
19032 pop_it (it
); /* bogus display property, give up */
19039 /* Return the character-property PROP at the current position in IT. */
19042 get_it_property (struct it
*it
, Lisp_Object prop
)
19044 Lisp_Object position
;
19046 if (STRINGP (it
->object
))
19047 position
= make_number (IT_STRING_CHARPOS (*it
));
19048 else if (BUFFERP (it
->object
))
19049 position
= make_number (IT_CHARPOS (*it
));
19053 return Fget_char_property (position
, prop
, it
->object
);
19056 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19059 handle_line_prefix (struct it
*it
)
19061 Lisp_Object prefix
;
19063 if (it
->continuation_lines_width
> 0)
19065 prefix
= get_it_property (it
, Qwrap_prefix
);
19067 prefix
= Vwrap_prefix
;
19071 prefix
= get_it_property (it
, Qline_prefix
);
19073 prefix
= Vline_prefix
;
19075 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19077 /* If the prefix is wider than the window, and we try to wrap
19078 it, it would acquire its own wrap prefix, and so on till the
19079 iterator stack overflows. So, don't wrap the prefix. */
19080 it
->line_wrap
= TRUNCATE
;
19081 it
->avoid_cursor_p
= 1;
19087 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19088 only for R2L lines from display_line and display_string, when they
19089 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19090 the line/string needs to be continued on the next glyph row. */
19092 unproduce_glyphs (struct it
*it
, int n
)
19094 struct glyph
*glyph
, *end
;
19096 eassert (it
->glyph_row
);
19097 eassert (it
->glyph_row
->reversed_p
);
19098 eassert (it
->area
== TEXT_AREA
);
19099 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19101 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19102 n
= it
->glyph_row
->used
[TEXT_AREA
];
19103 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19104 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19105 for ( ; glyph
< end
; glyph
++)
19106 glyph
[-n
] = *glyph
;
19109 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19110 and ROW->maxpos. */
19112 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19113 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19114 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19116 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19117 lines' rows is implemented for bidi-reordered rows. */
19119 /* ROW->minpos is the value of min_pos, the minimal buffer position
19120 we have in ROW, or ROW->start.pos if that is smaller. */
19121 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19122 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19124 /* We didn't find buffer positions smaller than ROW->start, or
19125 didn't find _any_ valid buffer positions in any of the glyphs,
19126 so we must trust the iterator's computed positions. */
19127 row
->minpos
= row
->start
.pos
;
19130 max_pos
= CHARPOS (it
->current
.pos
);
19131 max_bpos
= BYTEPOS (it
->current
.pos
);
19134 /* Here are the various use-cases for ending the row, and the
19135 corresponding values for ROW->maxpos:
19137 Line ends in a newline from buffer eol_pos + 1
19138 Line is continued from buffer max_pos + 1
19139 Line is truncated on right it->current.pos
19140 Line ends in a newline from string max_pos + 1(*)
19141 (*) + 1 only when line ends in a forward scan
19142 Line is continued from string max_pos
19143 Line is continued from display vector max_pos
19144 Line is entirely from a string min_pos == max_pos
19145 Line is entirely from a display vector min_pos == max_pos
19146 Line that ends at ZV ZV
19148 If you discover other use-cases, please add them here as
19150 if (row
->ends_at_zv_p
)
19151 row
->maxpos
= it
->current
.pos
;
19152 else if (row
->used
[TEXT_AREA
])
19154 int seen_this_string
= 0;
19155 struct glyph_row
*r1
= row
- 1;
19157 /* Did we see the same display string on the previous row? */
19158 if (STRINGP (it
->object
)
19159 /* this is not the first row */
19160 && row
> it
->w
->desired_matrix
->rows
19161 /* previous row is not the header line */
19162 && !r1
->mode_line_p
19163 /* previous row also ends in a newline from a string */
19164 && r1
->ends_in_newline_from_string_p
)
19166 struct glyph
*start
, *end
;
19168 /* Search for the last glyph of the previous row that came
19169 from buffer or string. Depending on whether the row is
19170 L2R or R2L, we need to process it front to back or the
19171 other way round. */
19172 if (!r1
->reversed_p
)
19174 start
= r1
->glyphs
[TEXT_AREA
];
19175 end
= start
+ r1
->used
[TEXT_AREA
];
19176 /* Glyphs inserted by redisplay have an integer (zero)
19177 as their object. */
19179 && INTEGERP ((end
- 1)->object
)
19180 && (end
- 1)->charpos
<= 0)
19184 if (EQ ((end
- 1)->object
, it
->object
))
19185 seen_this_string
= 1;
19188 /* If all the glyphs of the previous row were inserted
19189 by redisplay, it means the previous row was
19190 produced from a single newline, which is only
19191 possible if that newline came from the same string
19192 as the one which produced this ROW. */
19193 seen_this_string
= 1;
19197 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19198 start
= end
+ r1
->used
[TEXT_AREA
];
19200 && INTEGERP ((end
+ 1)->object
)
19201 && (end
+ 1)->charpos
<= 0)
19205 if (EQ ((end
+ 1)->object
, it
->object
))
19206 seen_this_string
= 1;
19209 seen_this_string
= 1;
19212 /* Take note of each display string that covers a newline only
19213 once, the first time we see it. This is for when a display
19214 string includes more than one newline in it. */
19215 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
19217 /* If we were scanning the buffer forward when we displayed
19218 the string, we want to account for at least one buffer
19219 position that belongs to this row (position covered by
19220 the display string), so that cursor positioning will
19221 consider this row as a candidate when point is at the end
19222 of the visual line represented by this row. This is not
19223 required when scanning back, because max_pos will already
19224 have a much larger value. */
19225 if (CHARPOS (row
->end
.pos
) > max_pos
)
19226 INC_BOTH (max_pos
, max_bpos
);
19227 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19229 else if (CHARPOS (it
->eol_pos
) > 0)
19230 SET_TEXT_POS (row
->maxpos
,
19231 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
19232 else if (row
->continued_p
)
19234 /* If max_pos is different from IT's current position, it
19235 means IT->method does not belong to the display element
19236 at max_pos. However, it also means that the display
19237 element at max_pos was displayed in its entirety on this
19238 line, which is equivalent to saying that the next line
19239 starts at the next buffer position. */
19240 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
19241 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19244 INC_BOTH (max_pos
, max_bpos
);
19245 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19248 else if (row
->truncated_on_right_p
)
19249 /* display_line already called reseat_at_next_visible_line_start,
19250 which puts the iterator at the beginning of the next line, in
19251 the logical order. */
19252 row
->maxpos
= it
->current
.pos
;
19253 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
19254 /* A line that is entirely from a string/image/stretch... */
19255 row
->maxpos
= row
->minpos
;
19260 row
->maxpos
= it
->current
.pos
;
19263 /* Construct the glyph row IT->glyph_row in the desired matrix of
19264 IT->w from text at the current position of IT. See dispextern.h
19265 for an overview of struct it. Value is non-zero if
19266 IT->glyph_row displays text, as opposed to a line displaying ZV
19270 display_line (struct it
*it
)
19272 struct glyph_row
*row
= it
->glyph_row
;
19273 Lisp_Object overlay_arrow_string
;
19275 void *wrap_data
= NULL
;
19276 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
19277 int wrap_row_used
= -1;
19278 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
19279 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
19280 int wrap_row_extra_line_spacing
IF_LINT (= 0);
19281 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
19282 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
19284 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
19285 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
19287 /* We always start displaying at hpos zero even if hscrolled. */
19288 eassert (it
->hpos
== 0 && it
->current_x
== 0);
19290 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
19291 >= it
->w
->desired_matrix
->nrows
)
19293 it
->w
->nrows_scale_factor
++;
19294 fonts_changed_p
= 1;
19298 /* Is IT->w showing the region? */
19299 wset_region_showing (it
->w
, it
->region_beg_charpos
> 0 ? Qt
: Qnil
);
19301 /* Clear the result glyph row and enable it. */
19302 prepare_desired_row (row
);
19304 row
->y
= it
->current_y
;
19305 row
->start
= it
->start
;
19306 row
->continuation_lines_width
= it
->continuation_lines_width
;
19307 row
->displays_text_p
= 1;
19308 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
19309 it
->starts_in_middle_of_char_p
= 0;
19311 /* Arrange the overlays nicely for our purposes. Usually, we call
19312 display_line on only one line at a time, in which case this
19313 can't really hurt too much, or we call it on lines which appear
19314 one after another in the buffer, in which case all calls to
19315 recenter_overlay_lists but the first will be pretty cheap. */
19316 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
19318 /* Move over display elements that are not visible because we are
19319 hscrolled. This may stop at an x-position < IT->first_visible_x
19320 if the first glyph is partially visible or if we hit a line end. */
19321 if (it
->current_x
< it
->first_visible_x
)
19323 enum move_it_result move_result
;
19325 this_line_min_pos
= row
->start
.pos
;
19326 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
19327 MOVE_TO_POS
| MOVE_TO_X
);
19328 /* If we are under a large hscroll, move_it_in_display_line_to
19329 could hit the end of the line without reaching
19330 it->first_visible_x. Pretend that we did reach it. This is
19331 especially important on a TTY, where we will call
19332 extend_face_to_end_of_line, which needs to know how many
19333 blank glyphs to produce. */
19334 if (it
->current_x
< it
->first_visible_x
19335 && (move_result
== MOVE_NEWLINE_OR_CR
19336 || move_result
== MOVE_POS_MATCH_OR_ZV
))
19337 it
->current_x
= it
->first_visible_x
;
19339 /* Record the smallest positions seen while we moved over
19340 display elements that are not visible. This is needed by
19341 redisplay_internal for optimizing the case where the cursor
19342 stays inside the same line. The rest of this function only
19343 considers positions that are actually displayed, so
19344 RECORD_MAX_MIN_POS will not otherwise record positions that
19345 are hscrolled to the left of the left edge of the window. */
19346 min_pos
= CHARPOS (this_line_min_pos
);
19347 min_bpos
= BYTEPOS (this_line_min_pos
);
19351 /* We only do this when not calling `move_it_in_display_line_to'
19352 above, because move_it_in_display_line_to calls
19353 handle_line_prefix itself. */
19354 handle_line_prefix (it
);
19357 /* Get the initial row height. This is either the height of the
19358 text hscrolled, if there is any, or zero. */
19359 row
->ascent
= it
->max_ascent
;
19360 row
->height
= it
->max_ascent
+ it
->max_descent
;
19361 row
->phys_ascent
= it
->max_phys_ascent
;
19362 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19363 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19365 /* Utility macro to record max and min buffer positions seen until now. */
19366 #define RECORD_MAX_MIN_POS(IT) \
19369 int composition_p = !STRINGP ((IT)->string) \
19370 && ((IT)->what == IT_COMPOSITION); \
19371 ptrdiff_t current_pos = \
19372 composition_p ? (IT)->cmp_it.charpos \
19373 : IT_CHARPOS (*(IT)); \
19374 ptrdiff_t current_bpos = \
19375 composition_p ? CHAR_TO_BYTE (current_pos) \
19376 : IT_BYTEPOS (*(IT)); \
19377 if (current_pos < min_pos) \
19379 min_pos = current_pos; \
19380 min_bpos = current_bpos; \
19382 if (IT_CHARPOS (*it) > max_pos) \
19384 max_pos = IT_CHARPOS (*it); \
19385 max_bpos = IT_BYTEPOS (*it); \
19390 /* Loop generating characters. The loop is left with IT on the next
19391 character to display. */
19394 int n_glyphs_before
, hpos_before
, x_before
;
19396 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
19398 /* Retrieve the next thing to display. Value is zero if end of
19400 if (!get_next_display_element (it
))
19402 /* Maybe add a space at the end of this line that is used to
19403 display the cursor there under X. Set the charpos of the
19404 first glyph of blank lines not corresponding to any text
19406 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19407 row
->exact_window_width_line_p
= 1;
19408 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
19409 || row
->used
[TEXT_AREA
] == 0)
19411 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
19412 row
->displays_text_p
= 0;
19414 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
19415 && (!MINI_WINDOW_P (it
->w
)
19416 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
19417 row
->indicate_empty_line_p
= 1;
19420 it
->continuation_lines_width
= 0;
19421 row
->ends_at_zv_p
= 1;
19422 /* A row that displays right-to-left text must always have
19423 its last face extended all the way to the end of line,
19424 even if this row ends in ZV, because we still write to
19425 the screen left to right. We also need to extend the
19426 last face if the default face is remapped to some
19427 different face, otherwise the functions that clear
19428 portions of the screen will clear with the default face's
19429 background color. */
19430 if (row
->reversed_p
19431 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
19432 extend_face_to_end_of_line (it
);
19436 /* Now, get the metrics of what we want to display. This also
19437 generates glyphs in `row' (which is IT->glyph_row). */
19438 n_glyphs_before
= row
->used
[TEXT_AREA
];
19441 /* Remember the line height so far in case the next element doesn't
19442 fit on the line. */
19443 if (it
->line_wrap
!= TRUNCATE
)
19445 ascent
= it
->max_ascent
;
19446 descent
= it
->max_descent
;
19447 phys_ascent
= it
->max_phys_ascent
;
19448 phys_descent
= it
->max_phys_descent
;
19450 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
19452 if (IT_DISPLAYING_WHITESPACE (it
))
19456 SAVE_IT (wrap_it
, *it
, wrap_data
);
19458 wrap_row_used
= row
->used
[TEXT_AREA
];
19459 wrap_row_ascent
= row
->ascent
;
19460 wrap_row_height
= row
->height
;
19461 wrap_row_phys_ascent
= row
->phys_ascent
;
19462 wrap_row_phys_height
= row
->phys_height
;
19463 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
19464 wrap_row_min_pos
= min_pos
;
19465 wrap_row_min_bpos
= min_bpos
;
19466 wrap_row_max_pos
= max_pos
;
19467 wrap_row_max_bpos
= max_bpos
;
19473 PRODUCE_GLYPHS (it
);
19475 /* If this display element was in marginal areas, continue with
19477 if (it
->area
!= TEXT_AREA
)
19479 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19480 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19481 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19482 row
->phys_height
= max (row
->phys_height
,
19483 it
->max_phys_ascent
+ it
->max_phys_descent
);
19484 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19485 it
->max_extra_line_spacing
);
19486 set_iterator_to_next (it
, 1);
19490 /* Does the display element fit on the line? If we truncate
19491 lines, we should draw past the right edge of the window. If
19492 we don't truncate, we want to stop so that we can display the
19493 continuation glyph before the right margin. If lines are
19494 continued, there are two possible strategies for characters
19495 resulting in more than 1 glyph (e.g. tabs): Display as many
19496 glyphs as possible in this line and leave the rest for the
19497 continuation line, or display the whole element in the next
19498 line. Original redisplay did the former, so we do it also. */
19499 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
19500 hpos_before
= it
->hpos
;
19503 if (/* Not a newline. */
19505 /* Glyphs produced fit entirely in the line. */
19506 && it
->current_x
< it
->last_visible_x
)
19508 it
->hpos
+= nglyphs
;
19509 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19510 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19511 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19512 row
->phys_height
= max (row
->phys_height
,
19513 it
->max_phys_ascent
+ it
->max_phys_descent
);
19514 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19515 it
->max_extra_line_spacing
);
19516 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
19517 row
->x
= x
- it
->first_visible_x
;
19518 /* Record the maximum and minimum buffer positions seen so
19519 far in glyphs that will be displayed by this row. */
19521 RECORD_MAX_MIN_POS (it
);
19526 struct glyph
*glyph
;
19528 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
19530 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19531 new_x
= x
+ glyph
->pixel_width
;
19533 if (/* Lines are continued. */
19534 it
->line_wrap
!= TRUNCATE
19535 && (/* Glyph doesn't fit on the line. */
19536 new_x
> it
->last_visible_x
19537 /* Or it fits exactly on a window system frame. */
19538 || (new_x
== it
->last_visible_x
19539 && FRAME_WINDOW_P (it
->f
)
19540 && (row
->reversed_p
19541 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19542 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
19544 /* End of a continued line. */
19547 || (new_x
== it
->last_visible_x
19548 && FRAME_WINDOW_P (it
->f
)
19549 && (row
->reversed_p
19550 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19551 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
19553 /* Current glyph is the only one on the line or
19554 fits exactly on the line. We must continue
19555 the line because we can't draw the cursor
19556 after the glyph. */
19557 row
->continued_p
= 1;
19558 it
->current_x
= new_x
;
19559 it
->continuation_lines_width
+= new_x
;
19561 if (i
== nglyphs
- 1)
19563 /* If line-wrap is on, check if a previous
19564 wrap point was found. */
19565 if (wrap_row_used
> 0
19566 /* Even if there is a previous wrap
19567 point, continue the line here as
19568 usual, if (i) the previous character
19569 was a space or tab AND (ii) the
19570 current character is not. */
19572 || IT_DISPLAYING_WHITESPACE (it
)))
19575 /* Record the maximum and minimum buffer
19576 positions seen so far in glyphs that will be
19577 displayed by this row. */
19579 RECORD_MAX_MIN_POS (it
);
19580 set_iterator_to_next (it
, 1);
19581 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19583 if (!get_next_display_element (it
))
19585 row
->exact_window_width_line_p
= 1;
19586 it
->continuation_lines_width
= 0;
19587 row
->continued_p
= 0;
19588 row
->ends_at_zv_p
= 1;
19590 else if (ITERATOR_AT_END_OF_LINE_P (it
))
19592 row
->continued_p
= 0;
19593 row
->exact_window_width_line_p
= 1;
19597 else if (it
->bidi_p
)
19598 RECORD_MAX_MIN_POS (it
);
19600 else if (CHAR_GLYPH_PADDING_P (*glyph
)
19601 && !FRAME_WINDOW_P (it
->f
))
19603 /* A padding glyph that doesn't fit on this line.
19604 This means the whole character doesn't fit
19606 if (row
->reversed_p
)
19607 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19608 - n_glyphs_before
);
19609 row
->used
[TEXT_AREA
] = n_glyphs_before
;
19611 /* Fill the rest of the row with continuation
19612 glyphs like in 20.x. */
19613 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19614 < row
->glyphs
[1 + TEXT_AREA
])
19615 produce_special_glyphs (it
, IT_CONTINUATION
);
19617 row
->continued_p
= 1;
19618 it
->current_x
= x_before
;
19619 it
->continuation_lines_width
+= x_before
;
19621 /* Restore the height to what it was before the
19622 element not fitting on the line. */
19623 it
->max_ascent
= ascent
;
19624 it
->max_descent
= descent
;
19625 it
->max_phys_ascent
= phys_ascent
;
19626 it
->max_phys_descent
= phys_descent
;
19628 else if (wrap_row_used
> 0)
19631 if (row
->reversed_p
)
19632 unproduce_glyphs (it
,
19633 row
->used
[TEXT_AREA
] - wrap_row_used
);
19634 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19635 it
->continuation_lines_width
+= wrap_x
;
19636 row
->used
[TEXT_AREA
] = wrap_row_used
;
19637 row
->ascent
= wrap_row_ascent
;
19638 row
->height
= wrap_row_height
;
19639 row
->phys_ascent
= wrap_row_phys_ascent
;
19640 row
->phys_height
= wrap_row_phys_height
;
19641 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19642 min_pos
= wrap_row_min_pos
;
19643 min_bpos
= wrap_row_min_bpos
;
19644 max_pos
= wrap_row_max_pos
;
19645 max_bpos
= wrap_row_max_bpos
;
19646 row
->continued_p
= 1;
19647 row
->ends_at_zv_p
= 0;
19648 row
->exact_window_width_line_p
= 0;
19649 it
->continuation_lines_width
+= x
;
19651 /* Make sure that a non-default face is extended
19652 up to the right margin of the window. */
19653 extend_face_to_end_of_line (it
);
19655 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19657 /* A TAB that extends past the right edge of the
19658 window. This produces a single glyph on
19659 window system frames. We leave the glyph in
19660 this row and let it fill the row, but don't
19661 consume the TAB. */
19662 if ((row
->reversed_p
19663 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19664 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19665 produce_special_glyphs (it
, IT_CONTINUATION
);
19666 it
->continuation_lines_width
+= it
->last_visible_x
;
19667 row
->ends_in_middle_of_char_p
= 1;
19668 row
->continued_p
= 1;
19669 glyph
->pixel_width
= it
->last_visible_x
- x
;
19670 it
->starts_in_middle_of_char_p
= 1;
19674 /* Something other than a TAB that draws past
19675 the right edge of the window. Restore
19676 positions to values before the element. */
19677 if (row
->reversed_p
)
19678 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19679 - (n_glyphs_before
+ i
));
19680 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19682 /* Display continuation glyphs. */
19683 it
->current_x
= x_before
;
19684 it
->continuation_lines_width
+= x
;
19685 if (!FRAME_WINDOW_P (it
->f
)
19686 || (row
->reversed_p
19687 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19688 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19689 produce_special_glyphs (it
, IT_CONTINUATION
);
19690 row
->continued_p
= 1;
19692 extend_face_to_end_of_line (it
);
19694 if (nglyphs
> 1 && i
> 0)
19696 row
->ends_in_middle_of_char_p
= 1;
19697 it
->starts_in_middle_of_char_p
= 1;
19700 /* Restore the height to what it was before the
19701 element not fitting on the line. */
19702 it
->max_ascent
= ascent
;
19703 it
->max_descent
= descent
;
19704 it
->max_phys_ascent
= phys_ascent
;
19705 it
->max_phys_descent
= phys_descent
;
19710 else if (new_x
> it
->first_visible_x
)
19712 /* Increment number of glyphs actually displayed. */
19715 /* Record the maximum and minimum buffer positions
19716 seen so far in glyphs that will be displayed by
19719 RECORD_MAX_MIN_POS (it
);
19721 if (x
< it
->first_visible_x
)
19722 /* Glyph is partially visible, i.e. row starts at
19723 negative X position. */
19724 row
->x
= x
- it
->first_visible_x
;
19728 /* Glyph is completely off the left margin of the
19729 window. This should not happen because of the
19730 move_it_in_display_line at the start of this
19731 function, unless the text display area of the
19732 window is empty. */
19733 eassert (it
->first_visible_x
<= it
->last_visible_x
);
19736 /* Even if this display element produced no glyphs at all,
19737 we want to record its position. */
19738 if (it
->bidi_p
&& nglyphs
== 0)
19739 RECORD_MAX_MIN_POS (it
);
19741 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19742 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19743 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19744 row
->phys_height
= max (row
->phys_height
,
19745 it
->max_phys_ascent
+ it
->max_phys_descent
);
19746 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19747 it
->max_extra_line_spacing
);
19749 /* End of this display line if row is continued. */
19750 if (row
->continued_p
|| row
->ends_at_zv_p
)
19755 /* Is this a line end? If yes, we're also done, after making
19756 sure that a non-default face is extended up to the right
19757 margin of the window. */
19758 if (ITERATOR_AT_END_OF_LINE_P (it
))
19760 int used_before
= row
->used
[TEXT_AREA
];
19762 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19764 /* Add a space at the end of the line that is used to
19765 display the cursor there. */
19766 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19767 append_space_for_newline (it
, 0);
19769 /* Extend the face to the end of the line. */
19770 extend_face_to_end_of_line (it
);
19772 /* Make sure we have the position. */
19773 if (used_before
== 0)
19774 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19776 /* Record the position of the newline, for use in
19778 it
->eol_pos
= it
->current
.pos
;
19780 /* Consume the line end. This skips over invisible lines. */
19781 set_iterator_to_next (it
, 1);
19782 it
->continuation_lines_width
= 0;
19786 /* Proceed with next display element. Note that this skips
19787 over lines invisible because of selective display. */
19788 set_iterator_to_next (it
, 1);
19790 /* If we truncate lines, we are done when the last displayed
19791 glyphs reach past the right margin of the window. */
19792 if (it
->line_wrap
== TRUNCATE
19793 && (FRAME_WINDOW_P (it
->f
) && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19794 ? (it
->current_x
>= it
->last_visible_x
)
19795 : (it
->current_x
> it
->last_visible_x
)))
19797 /* Maybe add truncation glyphs. */
19798 if (!FRAME_WINDOW_P (it
->f
)
19799 || (row
->reversed_p
19800 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19801 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19805 if (!row
->reversed_p
)
19807 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19808 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19813 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19814 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19816 /* Remove any padding glyphs at the front of ROW, to
19817 make room for the truncation glyphs we will be
19818 adding below. The loop below always inserts at
19819 least one truncation glyph, so also remove the
19820 last glyph added to ROW. */
19821 unproduce_glyphs (it
, i
+ 1);
19822 /* Adjust i for the loop below. */
19823 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19826 it
->current_x
= x_before
;
19827 if (!FRAME_WINDOW_P (it
->f
))
19829 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19831 row
->used
[TEXT_AREA
] = i
;
19832 produce_special_glyphs (it
, IT_TRUNCATION
);
19837 row
->used
[TEXT_AREA
] = i
;
19838 produce_special_glyphs (it
, IT_TRUNCATION
);
19841 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19843 /* Don't truncate if we can overflow newline into fringe. */
19844 if (!get_next_display_element (it
))
19846 it
->continuation_lines_width
= 0;
19847 row
->ends_at_zv_p
= 1;
19848 row
->exact_window_width_line_p
= 1;
19851 if (ITERATOR_AT_END_OF_LINE_P (it
))
19853 row
->exact_window_width_line_p
= 1;
19854 goto at_end_of_line
;
19856 it
->current_x
= x_before
;
19859 row
->truncated_on_right_p
= 1;
19860 it
->continuation_lines_width
= 0;
19861 reseat_at_next_visible_line_start (it
, 0);
19862 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19863 it
->hpos
= hpos_before
;
19869 bidi_unshelve_cache (wrap_data
, 1);
19871 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19872 at the left window margin. */
19873 if (it
->first_visible_x
19874 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19876 if (!FRAME_WINDOW_P (it
->f
)
19877 || (row
->reversed_p
19878 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19879 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
19880 insert_left_trunc_glyphs (it
);
19881 row
->truncated_on_left_p
= 1;
19884 /* Remember the position at which this line ends.
19886 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19887 cannot be before the call to find_row_edges below, since that is
19888 where these positions are determined. */
19889 row
->end
= it
->current
;
19892 row
->minpos
= row
->start
.pos
;
19893 row
->maxpos
= row
->end
.pos
;
19897 /* ROW->minpos and ROW->maxpos must be the smallest and
19898 `1 + the largest' buffer positions in ROW. But if ROW was
19899 bidi-reordered, these two positions can be anywhere in the
19900 row, so we must determine them now. */
19901 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19904 /* If the start of this line is the overlay arrow-position, then
19905 mark this glyph row as the one containing the overlay arrow.
19906 This is clearly a mess with variable size fonts. It would be
19907 better to let it be displayed like cursors under X. */
19908 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19909 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19910 !NILP (overlay_arrow_string
)))
19912 /* Overlay arrow in window redisplay is a fringe bitmap. */
19913 if (STRINGP (overlay_arrow_string
))
19915 struct glyph_row
*arrow_row
19916 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19917 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19918 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19919 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19920 struct glyph
*p2
, *end
;
19922 /* Copy the arrow glyphs. */
19923 while (glyph
< arrow_end
)
19926 /* Throw away padding glyphs. */
19928 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19929 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19935 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19940 eassert (INTEGERP (overlay_arrow_string
));
19941 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19943 overlay_arrow_seen
= 1;
19946 /* Highlight trailing whitespace. */
19947 if (!NILP (Vshow_trailing_whitespace
))
19948 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19950 /* Compute pixel dimensions of this line. */
19951 compute_line_metrics (it
);
19953 /* Implementation note: No changes in the glyphs of ROW or in their
19954 faces can be done past this point, because compute_line_metrics
19955 computes ROW's hash value and stores it within the glyph_row
19958 /* Record whether this row ends inside an ellipsis. */
19959 row
->ends_in_ellipsis_p
19960 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19961 && it
->ellipsis_p
);
19963 /* Save fringe bitmaps in this row. */
19964 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19965 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19966 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19967 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19969 it
->left_user_fringe_bitmap
= 0;
19970 it
->left_user_fringe_face_id
= 0;
19971 it
->right_user_fringe_bitmap
= 0;
19972 it
->right_user_fringe_face_id
= 0;
19974 /* Maybe set the cursor. */
19975 cvpos
= it
->w
->cursor
.vpos
;
19977 /* In bidi-reordered rows, keep checking for proper cursor
19978 position even if one has been found already, because buffer
19979 positions in such rows change non-linearly with ROW->VPOS,
19980 when a line is continued. One exception: when we are at ZV,
19981 display cursor on the first suitable glyph row, since all
19982 the empty rows after that also have their position set to ZV. */
19983 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19984 lines' rows is implemented for bidi-reordered rows. */
19986 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19987 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19988 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19989 && cursor_row_p (row
))
19990 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19992 /* Prepare for the next line. This line starts horizontally at (X
19993 HPOS) = (0 0). Vertical positions are incremented. As a
19994 convenience for the caller, IT->glyph_row is set to the next
19996 it
->current_x
= it
->hpos
= 0;
19997 it
->current_y
+= row
->height
;
19998 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20001 /* The next row should by default use the same value of the
20002 reversed_p flag as this one. set_iterator_to_next decides when
20003 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20004 the flag accordingly. */
20005 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20006 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20007 it
->start
= row
->end
;
20008 return row
->displays_text_p
;
20010 #undef RECORD_MAX_MIN_POS
20013 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20014 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20015 doc
: /* Return paragraph direction at point in BUFFER.
20016 Value is either `left-to-right' or `right-to-left'.
20017 If BUFFER is omitted or nil, it defaults to the current buffer.
20019 Paragraph direction determines how the text in the paragraph is displayed.
20020 In left-to-right paragraphs, text begins at the left margin of the window
20021 and the reading direction is generally left to right. In right-to-left
20022 paragraphs, text begins at the right margin and is read from right to left.
20024 See also `bidi-paragraph-direction'. */)
20025 (Lisp_Object buffer
)
20027 struct buffer
*buf
= current_buffer
;
20028 struct buffer
*old
= buf
;
20030 if (! NILP (buffer
))
20032 CHECK_BUFFER (buffer
);
20033 buf
= XBUFFER (buffer
);
20036 if (NILP (BVAR (buf
, bidi_display_reordering
))
20037 || NILP (BVAR (buf
, enable_multibyte_characters
))
20038 /* When we are loading loadup.el, the character property tables
20039 needed for bidi iteration are not yet available. */
20040 || !NILP (Vpurify_flag
))
20041 return Qleft_to_right
;
20042 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20043 return BVAR (buf
, bidi_paragraph_direction
);
20046 /* Determine the direction from buffer text. We could try to
20047 use current_matrix if it is up to date, but this seems fast
20048 enough as it is. */
20049 struct bidi_it itb
;
20050 ptrdiff_t pos
= BUF_PT (buf
);
20051 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20053 void *itb_data
= bidi_shelve_cache ();
20055 set_buffer_temp (buf
);
20056 /* bidi_paragraph_init finds the base direction of the paragraph
20057 by searching forward from paragraph start. We need the base
20058 direction of the current or _previous_ paragraph, so we need
20059 to make sure we are within that paragraph. To that end, find
20060 the previous non-empty line. */
20061 if (pos
>= ZV
&& pos
> BEGV
)
20064 bytepos
= CHAR_TO_BYTE (pos
);
20066 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20067 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20069 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20070 || c
== ' ' || c
== '\t' || c
== '\f')
20072 if (bytepos
<= BEGV_BYTE
)
20077 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20080 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20081 itb
.paragraph_dir
= NEUTRAL_DIR
;
20082 itb
.string
.s
= NULL
;
20083 itb
.string
.lstring
= Qnil
;
20084 itb
.string
.bufpos
= 0;
20085 itb
.string
.unibyte
= 0;
20086 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20087 bidi_unshelve_cache (itb_data
, 0);
20088 set_buffer_temp (old
);
20089 switch (itb
.paragraph_dir
)
20092 return Qleft_to_right
;
20095 return Qright_to_left
;
20105 /***********************************************************************
20107 ***********************************************************************/
20109 /* Redisplay the menu bar in the frame for window W.
20111 The menu bar of X frames that don't have X toolkit support is
20112 displayed in a special window W->frame->menu_bar_window.
20114 The menu bar of terminal frames is treated specially as far as
20115 glyph matrices are concerned. Menu bar lines are not part of
20116 windows, so the update is done directly on the frame matrix rows
20117 for the menu bar. */
20120 display_menu_bar (struct window
*w
)
20122 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20127 /* Don't do all this for graphical frames. */
20129 if (FRAME_W32_P (f
))
20132 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
20138 if (FRAME_NS_P (f
))
20140 #endif /* HAVE_NS */
20142 #ifdef USE_X_TOOLKIT
20143 eassert (!FRAME_WINDOW_P (f
));
20144 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
20145 it
.first_visible_x
= 0;
20146 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
20147 #else /* not USE_X_TOOLKIT */
20148 if (FRAME_WINDOW_P (f
))
20150 /* Menu bar lines are displayed in the desired matrix of the
20151 dummy window menu_bar_window. */
20152 struct window
*menu_w
;
20153 eassert (WINDOWP (f
->menu_bar_window
));
20154 menu_w
= XWINDOW (f
->menu_bar_window
);
20155 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
20157 it
.first_visible_x
= 0;
20158 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
20162 /* This is a TTY frame, i.e. character hpos/vpos are used as
20164 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
20166 it
.first_visible_x
= 0;
20167 it
.last_visible_x
= FRAME_COLS (f
);
20169 #endif /* not USE_X_TOOLKIT */
20171 /* FIXME: This should be controlled by a user option. See the
20172 comments in redisplay_tool_bar and display_mode_line about
20174 it
.paragraph_embedding
= L2R
;
20176 /* Clear all rows of the menu bar. */
20177 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
20179 struct glyph_row
*row
= it
.glyph_row
+ i
;
20180 clear_glyph_row (row
);
20181 row
->enabled_p
= 1;
20182 row
->full_width_p
= 1;
20185 /* Display all items of the menu bar. */
20186 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
20187 for (i
= 0; i
< ASIZE (items
); i
+= 4)
20189 Lisp_Object string
;
20191 /* Stop at nil string. */
20192 string
= AREF (items
, i
+ 1);
20196 /* Remember where item was displayed. */
20197 ASET (items
, i
+ 3, make_number (it
.hpos
));
20199 /* Display the item, pad with one space. */
20200 if (it
.current_x
< it
.last_visible_x
)
20201 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
20202 SCHARS (string
) + 1, 0, 0, -1);
20205 /* Fill out the line with spaces. */
20206 if (it
.current_x
< it
.last_visible_x
)
20207 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
20209 /* Compute the total height of the lines. */
20210 compute_line_metrics (&it
);
20215 /***********************************************************************
20217 ***********************************************************************/
20219 /* Redisplay mode lines in the window tree whose root is WINDOW. If
20220 FORCE is non-zero, redisplay mode lines unconditionally.
20221 Otherwise, redisplay only mode lines that are garbaged. Value is
20222 the number of windows whose mode lines were redisplayed. */
20225 redisplay_mode_lines (Lisp_Object window
, int force
)
20229 while (!NILP (window
))
20231 struct window
*w
= XWINDOW (window
);
20233 if (WINDOWP (w
->hchild
))
20234 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
20235 else if (WINDOWP (w
->vchild
))
20236 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
20238 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
20239 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
20241 struct text_pos lpoint
;
20242 struct buffer
*old
= current_buffer
;
20244 /* Set the window's buffer for the mode line display. */
20245 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
20246 set_buffer_internal_1 (XBUFFER (w
->buffer
));
20248 /* Point refers normally to the selected window. For any
20249 other window, set up appropriate value. */
20250 if (!EQ (window
, selected_window
))
20252 struct text_pos pt
;
20254 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
20255 if (CHARPOS (pt
) < BEGV
)
20256 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
20257 else if (CHARPOS (pt
) > (ZV
- 1))
20258 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
20260 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
20263 /* Display mode lines. */
20264 clear_glyph_matrix (w
->desired_matrix
);
20265 if (display_mode_lines (w
))
20268 w
->must_be_updated_p
= 1;
20271 /* Restore old settings. */
20272 set_buffer_internal_1 (old
);
20273 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
20283 /* Display the mode and/or header line of window W. Value is the
20284 sum number of mode lines and header lines displayed. */
20287 display_mode_lines (struct window
*w
)
20289 Lisp_Object old_selected_window
, old_selected_frame
;
20292 old_selected_frame
= selected_frame
;
20293 selected_frame
= w
->frame
;
20294 old_selected_window
= selected_window
;
20295 XSETWINDOW (selected_window
, w
);
20297 /* These will be set while the mode line specs are processed. */
20298 line_number_displayed
= 0;
20299 wset_column_number_displayed (w
, Qnil
);
20301 if (WINDOW_WANTS_MODELINE_P (w
))
20303 struct window
*sel_w
= XWINDOW (old_selected_window
);
20305 /* Select mode line face based on the real selected window. */
20306 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
20307 BVAR (current_buffer
, mode_line_format
));
20311 if (WINDOW_WANTS_HEADER_LINE_P (w
))
20313 display_mode_line (w
, HEADER_LINE_FACE_ID
,
20314 BVAR (current_buffer
, header_line_format
));
20318 selected_frame
= old_selected_frame
;
20319 selected_window
= old_selected_window
;
20324 /* Display mode or header line of window W. FACE_ID specifies which
20325 line to display; it is either MODE_LINE_FACE_ID or
20326 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
20327 display. Value is the pixel height of the mode/header line
20331 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
20335 ptrdiff_t count
= SPECPDL_INDEX ();
20337 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20338 /* Don't extend on a previously drawn mode-line.
20339 This may happen if called from pos_visible_p. */
20340 it
.glyph_row
->enabled_p
= 0;
20341 prepare_desired_row (it
.glyph_row
);
20343 it
.glyph_row
->mode_line_p
= 1;
20345 /* FIXME: This should be controlled by a user option. But
20346 supporting such an option is not trivial, since the mode line is
20347 made up of many separate strings. */
20348 it
.paragraph_embedding
= L2R
;
20350 record_unwind_protect (unwind_format_mode_line
,
20351 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
20353 mode_line_target
= MODE_LINE_DISPLAY
;
20355 /* Temporarily make frame's keyboard the current kboard so that
20356 kboard-local variables in the mode_line_format will get the right
20358 push_kboard (FRAME_KBOARD (it
.f
));
20359 record_unwind_save_match_data ();
20360 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20363 unbind_to (count
, Qnil
);
20365 /* Fill up with spaces. */
20366 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
20368 compute_line_metrics (&it
);
20369 it
.glyph_row
->full_width_p
= 1;
20370 it
.glyph_row
->continued_p
= 0;
20371 it
.glyph_row
->truncated_on_left_p
= 0;
20372 it
.glyph_row
->truncated_on_right_p
= 0;
20374 /* Make a 3D mode-line have a shadow at its right end. */
20375 face
= FACE_FROM_ID (it
.f
, face_id
);
20376 extend_face_to_end_of_line (&it
);
20377 if (face
->box
!= FACE_NO_BOX
)
20379 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
20380 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
20381 last
->right_box_line_p
= 1;
20384 return it
.glyph_row
->height
;
20387 /* Move element ELT in LIST to the front of LIST.
20388 Return the updated list. */
20391 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
20393 register Lisp_Object tail
, prev
;
20394 register Lisp_Object tem
;
20398 while (CONSP (tail
))
20404 /* Splice out the link TAIL. */
20406 list
= XCDR (tail
);
20408 Fsetcdr (prev
, XCDR (tail
));
20410 /* Now make it the first. */
20411 Fsetcdr (tail
, list
);
20416 tail
= XCDR (tail
);
20420 /* Not found--return unchanged LIST. */
20424 /* Contribute ELT to the mode line for window IT->w. How it
20425 translates into text depends on its data type.
20427 IT describes the display environment in which we display, as usual.
20429 DEPTH is the depth in recursion. It is used to prevent
20430 infinite recursion here.
20432 FIELD_WIDTH is the number of characters the display of ELT should
20433 occupy in the mode line, and PRECISION is the maximum number of
20434 characters to display from ELT's representation. See
20435 display_string for details.
20437 Returns the hpos of the end of the text generated by ELT.
20439 PROPS is a property list to add to any string we encounter.
20441 If RISKY is nonzero, remove (disregard) any properties in any string
20442 we encounter, and ignore :eval and :propertize.
20444 The global variable `mode_line_target' determines whether the
20445 output is passed to `store_mode_line_noprop',
20446 `store_mode_line_string', or `display_string'. */
20449 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
20450 Lisp_Object elt
, Lisp_Object props
, int risky
)
20452 int n
= 0, field
, prec
;
20457 elt
= build_string ("*too-deep*");
20461 switch (XTYPE (elt
))
20465 /* A string: output it and check for %-constructs within it. */
20467 ptrdiff_t offset
= 0;
20469 if (SCHARS (elt
) > 0
20470 && (!NILP (props
) || risky
))
20472 Lisp_Object oprops
, aelt
;
20473 oprops
= Ftext_properties_at (make_number (0), elt
);
20475 /* If the starting string's properties are not what
20476 we want, translate the string. Also, if the string
20477 is risky, do that anyway. */
20479 if (NILP (Fequal (props
, oprops
)) || risky
)
20481 /* If the starting string has properties,
20482 merge the specified ones onto the existing ones. */
20483 if (! NILP (oprops
) && !risky
)
20487 oprops
= Fcopy_sequence (oprops
);
20489 while (CONSP (tem
))
20491 oprops
= Fplist_put (oprops
, XCAR (tem
),
20492 XCAR (XCDR (tem
)));
20493 tem
= XCDR (XCDR (tem
));
20498 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
20499 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
20501 /* AELT is what we want. Move it to the front
20502 without consing. */
20504 mode_line_proptrans_alist
20505 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
20511 /* If AELT has the wrong props, it is useless.
20512 so get rid of it. */
20514 mode_line_proptrans_alist
20515 = Fdelq (aelt
, mode_line_proptrans_alist
);
20517 elt
= Fcopy_sequence (elt
);
20518 Fset_text_properties (make_number (0), Flength (elt
),
20520 /* Add this item to mode_line_proptrans_alist. */
20521 mode_line_proptrans_alist
20522 = Fcons (Fcons (elt
, props
),
20523 mode_line_proptrans_alist
);
20524 /* Truncate mode_line_proptrans_alist
20525 to at most 50 elements. */
20526 tem
= Fnthcdr (make_number (50),
20527 mode_line_proptrans_alist
);
20529 XSETCDR (tem
, Qnil
);
20538 prec
= precision
- n
;
20539 switch (mode_line_target
)
20541 case MODE_LINE_NOPROP
:
20542 case MODE_LINE_TITLE
:
20543 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
20545 case MODE_LINE_STRING
:
20546 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
20548 case MODE_LINE_DISPLAY
:
20549 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
20550 0, prec
, 0, STRING_MULTIBYTE (elt
));
20557 /* Handle the non-literal case. */
20559 while ((precision
<= 0 || n
< precision
)
20560 && SREF (elt
, offset
) != 0
20561 && (mode_line_target
!= MODE_LINE_DISPLAY
20562 || it
->current_x
< it
->last_visible_x
))
20564 ptrdiff_t last_offset
= offset
;
20566 /* Advance to end of string or next format specifier. */
20567 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
20570 if (offset
- 1 != last_offset
)
20572 ptrdiff_t nchars
, nbytes
;
20574 /* Output to end of string or up to '%'. Field width
20575 is length of string. Don't output more than
20576 PRECISION allows us. */
20579 prec
= c_string_width (SDATA (elt
) + last_offset
,
20580 offset
- last_offset
, precision
- n
,
20583 switch (mode_line_target
)
20585 case MODE_LINE_NOPROP
:
20586 case MODE_LINE_TITLE
:
20587 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
20589 case MODE_LINE_STRING
:
20591 ptrdiff_t bytepos
= last_offset
;
20592 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20593 ptrdiff_t endpos
= (precision
<= 0
20594 ? string_byte_to_char (elt
, offset
)
20595 : charpos
+ nchars
);
20597 n
+= store_mode_line_string (NULL
,
20598 Fsubstring (elt
, make_number (charpos
),
20599 make_number (endpos
)),
20603 case MODE_LINE_DISPLAY
:
20605 ptrdiff_t bytepos
= last_offset
;
20606 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20608 if (precision
<= 0)
20609 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
20610 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
20612 STRING_MULTIBYTE (elt
));
20617 else /* c == '%' */
20619 ptrdiff_t percent_position
= offset
;
20621 /* Get the specified minimum width. Zero means
20624 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
20625 field
= field
* 10 + c
- '0';
20627 /* Don't pad beyond the total padding allowed. */
20628 if (field_width
- n
> 0 && field
> field_width
- n
)
20629 field
= field_width
- n
;
20631 /* Note that either PRECISION <= 0 or N < PRECISION. */
20632 prec
= precision
- n
;
20635 n
+= display_mode_element (it
, depth
, field
, prec
,
20636 Vglobal_mode_string
, props
,
20641 ptrdiff_t bytepos
, charpos
;
20643 Lisp_Object string
;
20645 bytepos
= percent_position
;
20646 charpos
= (STRING_MULTIBYTE (elt
)
20647 ? string_byte_to_char (elt
, bytepos
)
20649 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
20650 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
20652 switch (mode_line_target
)
20654 case MODE_LINE_NOPROP
:
20655 case MODE_LINE_TITLE
:
20656 n
+= store_mode_line_noprop (spec
, field
, prec
);
20658 case MODE_LINE_STRING
:
20660 Lisp_Object tem
= build_string (spec
);
20661 props
= Ftext_properties_at (make_number (charpos
), elt
);
20662 /* Should only keep face property in props */
20663 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
20666 case MODE_LINE_DISPLAY
:
20668 int nglyphs_before
, nwritten
;
20670 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20671 nwritten
= display_string (spec
, string
, elt
,
20676 /* Assign to the glyphs written above the
20677 string where the `%x' came from, position
20681 struct glyph
*glyph
20682 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
20686 for (i
= 0; i
< nwritten
; ++i
)
20688 glyph
[i
].object
= elt
;
20689 glyph
[i
].charpos
= charpos
;
20706 /* A symbol: process the value of the symbol recursively
20707 as if it appeared here directly. Avoid error if symbol void.
20708 Special case: if value of symbol is a string, output the string
20711 register Lisp_Object tem
;
20713 /* If the variable is not marked as risky to set
20714 then its contents are risky to use. */
20715 if (NILP (Fget (elt
, Qrisky_local_variable
)))
20718 tem
= Fboundp (elt
);
20721 tem
= Fsymbol_value (elt
);
20722 /* If value is a string, output that string literally:
20723 don't check for % within it. */
20727 if (!EQ (tem
, elt
))
20729 /* Give up right away for nil or t. */
20739 register Lisp_Object car
, tem
;
20741 /* A cons cell: five distinct cases.
20742 If first element is :eval or :propertize, do something special.
20743 If first element is a string or a cons, process all the elements
20744 and effectively concatenate them.
20745 If first element is a negative number, truncate displaying cdr to
20746 at most that many characters. If positive, pad (with spaces)
20747 to at least that many characters.
20748 If first element is a symbol, process the cadr or caddr recursively
20749 according to whether the symbol's value is non-nil or nil. */
20751 if (EQ (car
, QCeval
))
20753 /* An element of the form (:eval FORM) means evaluate FORM
20754 and use the result as mode line elements. */
20759 if (CONSP (XCDR (elt
)))
20762 spec
= safe_eval (XCAR (XCDR (elt
)));
20763 n
+= display_mode_element (it
, depth
, field_width
- n
,
20764 precision
- n
, spec
, props
,
20768 else if (EQ (car
, QCpropertize
))
20770 /* An element of the form (:propertize ELT PROPS...)
20771 means display ELT but applying properties PROPS. */
20776 if (CONSP (XCDR (elt
)))
20777 n
+= display_mode_element (it
, depth
, field_width
- n
,
20778 precision
- n
, XCAR (XCDR (elt
)),
20779 XCDR (XCDR (elt
)), risky
);
20781 else if (SYMBOLP (car
))
20783 tem
= Fboundp (car
);
20787 /* elt is now the cdr, and we know it is a cons cell.
20788 Use its car if CAR has a non-nil value. */
20791 tem
= Fsymbol_value (car
);
20798 /* Symbol's value is nil (or symbol is unbound)
20799 Get the cddr of the original list
20800 and if possible find the caddr and use that. */
20804 else if (!CONSP (elt
))
20809 else if (INTEGERP (car
))
20811 register int lim
= XINT (car
);
20815 /* Negative int means reduce maximum width. */
20816 if (precision
<= 0)
20819 precision
= min (precision
, -lim
);
20823 /* Padding specified. Don't let it be more than
20824 current maximum. */
20826 lim
= min (precision
, lim
);
20828 /* If that's more padding than already wanted, queue it.
20829 But don't reduce padding already specified even if
20830 that is beyond the current truncation point. */
20831 field_width
= max (lim
, field_width
);
20835 else if (STRINGP (car
) || CONSP (car
))
20837 Lisp_Object halftail
= elt
;
20841 && (precision
<= 0 || n
< precision
))
20843 n
+= display_mode_element (it
, depth
,
20844 /* Do padding only after the last
20845 element in the list. */
20846 (! CONSP (XCDR (elt
))
20849 precision
- n
, XCAR (elt
),
20853 if ((len
& 1) == 0)
20854 halftail
= XCDR (halftail
);
20855 /* Check for cycle. */
20856 if (EQ (halftail
, elt
))
20865 elt
= build_string ("*invalid*");
20869 /* Pad to FIELD_WIDTH. */
20870 if (field_width
> 0 && n
< field_width
)
20872 switch (mode_line_target
)
20874 case MODE_LINE_NOPROP
:
20875 case MODE_LINE_TITLE
:
20876 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20878 case MODE_LINE_STRING
:
20879 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20881 case MODE_LINE_DISPLAY
:
20882 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20891 /* Store a mode-line string element in mode_line_string_list.
20893 If STRING is non-null, display that C string. Otherwise, the Lisp
20894 string LISP_STRING is displayed.
20896 FIELD_WIDTH is the minimum number of output glyphs to produce.
20897 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20898 with spaces. FIELD_WIDTH <= 0 means don't pad.
20900 PRECISION is the maximum number of characters to output from
20901 STRING. PRECISION <= 0 means don't truncate the string.
20903 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20904 properties to the string.
20906 PROPS are the properties to add to the string.
20907 The mode_line_string_face face property is always added to the string.
20911 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20912 int field_width
, int precision
, Lisp_Object props
)
20917 if (string
!= NULL
)
20919 len
= strlen (string
);
20920 if (precision
> 0 && len
> precision
)
20922 lisp_string
= make_string (string
, len
);
20924 props
= mode_line_string_face_prop
;
20925 else if (!NILP (mode_line_string_face
))
20927 Lisp_Object face
= Fplist_get (props
, Qface
);
20928 props
= Fcopy_sequence (props
);
20930 face
= mode_line_string_face
;
20932 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20933 props
= Fplist_put (props
, Qface
, face
);
20935 Fadd_text_properties (make_number (0), make_number (len
),
20936 props
, lisp_string
);
20940 len
= XFASTINT (Flength (lisp_string
));
20941 if (precision
> 0 && len
> precision
)
20944 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20947 if (!NILP (mode_line_string_face
))
20951 props
= Ftext_properties_at (make_number (0), lisp_string
);
20952 face
= Fplist_get (props
, Qface
);
20954 face
= mode_line_string_face
;
20956 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20957 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20959 lisp_string
= Fcopy_sequence (lisp_string
);
20962 Fadd_text_properties (make_number (0), make_number (len
),
20963 props
, lisp_string
);
20968 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20972 if (field_width
> len
)
20974 field_width
-= len
;
20975 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20977 Fadd_text_properties (make_number (0), make_number (field_width
),
20978 props
, lisp_string
);
20979 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20987 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20989 doc
: /* Format a string out of a mode line format specification.
20990 First arg FORMAT specifies the mode line format (see `mode-line-format'
20991 for details) to use.
20993 By default, the format is evaluated for the currently selected window.
20995 Optional second arg FACE specifies the face property to put on all
20996 characters for which no face is specified. The value nil means the
20997 default face. The value t means whatever face the window's mode line
20998 currently uses (either `mode-line' or `mode-line-inactive',
20999 depending on whether the window is the selected window or not).
21000 An integer value means the value string has no text
21003 Optional third and fourth args WINDOW and BUFFER specify the window
21004 and buffer to use as the context for the formatting (defaults
21005 are the selected window and the WINDOW's buffer). */)
21006 (Lisp_Object format
, Lisp_Object face
,
21007 Lisp_Object window
, Lisp_Object buffer
)
21012 struct buffer
*old_buffer
= NULL
;
21014 int no_props
= INTEGERP (face
);
21015 ptrdiff_t count
= SPECPDL_INDEX ();
21017 int string_start
= 0;
21020 window
= selected_window
;
21021 CHECK_WINDOW (window
);
21022 w
= XWINDOW (window
);
21025 buffer
= w
->buffer
;
21026 CHECK_BUFFER (buffer
);
21028 /* Make formatting the modeline a non-op when noninteractive, otherwise
21029 there will be problems later caused by a partially initialized frame. */
21030 if (NILP (format
) || noninteractive
)
21031 return empty_unibyte_string
;
21036 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
21037 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
21038 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
21039 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
21040 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
21041 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
21042 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
21045 old_buffer
= current_buffer
;
21047 /* Save things including mode_line_proptrans_alist,
21048 and set that to nil so that we don't alter the outer value. */
21049 record_unwind_protect (unwind_format_mode_line
,
21050 format_mode_line_unwind_data
21051 (XFRAME (WINDOW_FRAME (XWINDOW (window
))),
21052 old_buffer
, selected_window
, 1));
21053 mode_line_proptrans_alist
= Qnil
;
21055 Fselect_window (window
, Qt
);
21056 set_buffer_internal_1 (XBUFFER (buffer
));
21058 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21062 mode_line_target
= MODE_LINE_NOPROP
;
21063 mode_line_string_face_prop
= Qnil
;
21064 mode_line_string_list
= Qnil
;
21065 string_start
= MODE_LINE_NOPROP_LEN (0);
21069 mode_line_target
= MODE_LINE_STRING
;
21070 mode_line_string_list
= Qnil
;
21071 mode_line_string_face
= face
;
21072 mode_line_string_face_prop
21073 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
21076 push_kboard (FRAME_KBOARD (it
.f
));
21077 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21082 len
= MODE_LINE_NOPROP_LEN (string_start
);
21083 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
21087 mode_line_string_list
= Fnreverse (mode_line_string_list
);
21088 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
21089 empty_unibyte_string
);
21092 unbind_to (count
, Qnil
);
21096 /* Write a null-terminated, right justified decimal representation of
21097 the positive integer D to BUF using a minimal field width WIDTH. */
21100 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
21102 register char *p
= buf
;
21110 *p
++ = d
% 10 + '0';
21115 for (width
-= (int) (p
- buf
); width
> 0; --width
)
21126 /* Write a null-terminated, right justified decimal and "human
21127 readable" representation of the nonnegative integer D to BUF using
21128 a minimal field width WIDTH. D should be smaller than 999.5e24. */
21130 static const char power_letter
[] =
21144 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
21146 /* We aim to represent the nonnegative integer D as
21147 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
21148 ptrdiff_t quotient
= d
;
21150 /* -1 means: do not use TENTHS. */
21154 /* Length of QUOTIENT.TENTHS as a string. */
21160 if (1000 <= quotient
)
21162 /* Scale to the appropriate EXPONENT. */
21165 remainder
= quotient
% 1000;
21169 while (1000 <= quotient
);
21171 /* Round to nearest and decide whether to use TENTHS or not. */
21174 tenths
= remainder
/ 100;
21175 if (50 <= remainder
% 100)
21182 if (quotient
== 10)
21190 if (500 <= remainder
)
21192 if (quotient
< 999)
21203 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
21204 if (tenths
== -1 && quotient
<= 99)
21211 p
= psuffix
= buf
+ max (width
, length
);
21213 /* Print EXPONENT. */
21214 *psuffix
++ = power_letter
[exponent
];
21217 /* Print TENTHS. */
21220 *--p
= '0' + tenths
;
21224 /* Print QUOTIENT. */
21227 int digit
= quotient
% 10;
21228 *--p
= '0' + digit
;
21230 while ((quotient
/= 10) != 0);
21232 /* Print leading spaces. */
21237 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
21238 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
21239 type of CODING_SYSTEM. Return updated pointer into BUF. */
21241 static unsigned char invalid_eol_type
[] = "(*invalid*)";
21244 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
21247 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
21248 const unsigned char *eol_str
;
21250 /* The EOL conversion we are using. */
21251 Lisp_Object eoltype
;
21253 val
= CODING_SYSTEM_SPEC (coding_system
);
21256 if (!VECTORP (val
)) /* Not yet decided. */
21258 *buf
++ = multibyte
? '-' : ' ';
21260 eoltype
= eol_mnemonic_undecided
;
21261 /* Don't mention EOL conversion if it isn't decided. */
21266 Lisp_Object eolvalue
;
21268 attrs
= AREF (val
, 0);
21269 eolvalue
= AREF (val
, 2);
21272 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
21277 /* The EOL conversion that is normal on this system. */
21279 if (NILP (eolvalue
)) /* Not yet decided. */
21280 eoltype
= eol_mnemonic_undecided
;
21281 else if (VECTORP (eolvalue
)) /* Not yet decided. */
21282 eoltype
= eol_mnemonic_undecided
;
21283 else /* eolvalue is Qunix, Qdos, or Qmac. */
21284 eoltype
= (EQ (eolvalue
, Qunix
)
21285 ? eol_mnemonic_unix
21286 : (EQ (eolvalue
, Qdos
) == 1
21287 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
21293 /* Mention the EOL conversion if it is not the usual one. */
21294 if (STRINGP (eoltype
))
21296 eol_str
= SDATA (eoltype
);
21297 eol_str_len
= SBYTES (eoltype
);
21299 else if (CHARACTERP (eoltype
))
21301 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
21302 int c
= XFASTINT (eoltype
);
21303 eol_str_len
= CHAR_STRING (c
, tmp
);
21308 eol_str
= invalid_eol_type
;
21309 eol_str_len
= sizeof (invalid_eol_type
) - 1;
21311 memcpy (buf
, eol_str
, eol_str_len
);
21312 buf
+= eol_str_len
;
21318 /* Return a string for the output of a mode line %-spec for window W,
21319 generated by character C. FIELD_WIDTH > 0 means pad the string
21320 returned with spaces to that value. Return a Lisp string in
21321 *STRING if the resulting string is taken from that Lisp string.
21323 Note we operate on the current buffer for most purposes,
21324 the exception being w->base_line_pos. */
21326 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
21328 static const char *
21329 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
21330 Lisp_Object
*string
)
21333 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21334 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
21335 struct buffer
*b
= current_buffer
;
21343 if (!NILP (BVAR (b
, read_only
)))
21345 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21350 /* This differs from %* only for a modified read-only buffer. */
21351 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21353 if (!NILP (BVAR (b
, read_only
)))
21358 /* This differs from %* in ignoring read-only-ness. */
21359 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21371 if (command_loop_level
> 5)
21373 p
= decode_mode_spec_buf
;
21374 for (i
= 0; i
< command_loop_level
; i
++)
21377 return decode_mode_spec_buf
;
21385 if (command_loop_level
> 5)
21387 p
= decode_mode_spec_buf
;
21388 for (i
= 0; i
< command_loop_level
; i
++)
21391 return decode_mode_spec_buf
;
21398 /* Let lots_of_dashes be a string of infinite length. */
21399 if (mode_line_target
== MODE_LINE_NOPROP
||
21400 mode_line_target
== MODE_LINE_STRING
)
21402 if (field_width
<= 0
21403 || field_width
> sizeof (lots_of_dashes
))
21405 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
21406 decode_mode_spec_buf
[i
] = '-';
21407 decode_mode_spec_buf
[i
] = '\0';
21408 return decode_mode_spec_buf
;
21411 return lots_of_dashes
;
21415 obj
= BVAR (b
, name
);
21419 /* %c and %l are ignored in `frame-title-format'.
21420 (In redisplay_internal, the frame title is drawn _before_ the
21421 windows are updated, so the stuff which depends on actual
21422 window contents (such as %l) may fail to render properly, or
21423 even crash emacs.) */
21424 if (mode_line_target
== MODE_LINE_TITLE
)
21428 ptrdiff_t col
= current_column ();
21429 wset_column_number_displayed (w
, make_number (col
));
21430 pint2str (decode_mode_spec_buf
, field_width
, col
);
21431 return decode_mode_spec_buf
;
21435 #ifndef SYSTEM_MALLOC
21437 if (NILP (Vmemory_full
))
21440 return "!MEM FULL! ";
21447 /* %F displays the frame name. */
21448 if (!NILP (f
->title
))
21449 return SSDATA (f
->title
);
21450 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
21451 return SSDATA (f
->name
);
21455 obj
= BVAR (b
, filename
);
21460 ptrdiff_t size
= ZV
- BEGV
;
21461 pint2str (decode_mode_spec_buf
, field_width
, size
);
21462 return decode_mode_spec_buf
;
21467 ptrdiff_t size
= ZV
- BEGV
;
21468 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
21469 return decode_mode_spec_buf
;
21474 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
21475 ptrdiff_t topline
, nlines
, height
;
21478 /* %c and %l are ignored in `frame-title-format'. */
21479 if (mode_line_target
== MODE_LINE_TITLE
)
21482 startpos
= XMARKER (w
->start
)->charpos
;
21483 startpos_byte
= marker_byte_position (w
->start
);
21484 height
= WINDOW_TOTAL_LINES (w
);
21486 /* If we decided that this buffer isn't suitable for line numbers,
21487 don't forget that too fast. */
21488 if (EQ (w
->base_line_pos
, w
->buffer
))
21490 /* But do forget it, if the window shows a different buffer now. */
21491 else if (BUFFERP (w
->base_line_pos
))
21492 wset_base_line_pos (w
, Qnil
);
21494 /* If the buffer is very big, don't waste time. */
21495 if (INTEGERP (Vline_number_display_limit
)
21496 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
21498 wset_base_line_pos (w
, Qnil
);
21499 wset_base_line_number (w
, Qnil
);
21503 if (INTEGERP (w
->base_line_number
)
21504 && INTEGERP (w
->base_line_pos
)
21505 && XFASTINT (w
->base_line_pos
) <= startpos
)
21507 line
= XFASTINT (w
->base_line_number
);
21508 linepos
= XFASTINT (w
->base_line_pos
);
21509 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
21514 linepos
= BUF_BEGV (b
);
21515 linepos_byte
= BUF_BEGV_BYTE (b
);
21518 /* Count lines from base line to window start position. */
21519 nlines
= display_count_lines (linepos_byte
,
21523 topline
= nlines
+ line
;
21525 /* Determine a new base line, if the old one is too close
21526 or too far away, or if we did not have one.
21527 "Too close" means it's plausible a scroll-down would
21528 go back past it. */
21529 if (startpos
== BUF_BEGV (b
))
21531 wset_base_line_number (w
, make_number (topline
));
21532 wset_base_line_pos (w
, make_number (BUF_BEGV (b
)));
21534 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
21535 || linepos
== BUF_BEGV (b
))
21537 ptrdiff_t limit
= BUF_BEGV (b
);
21538 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
21539 ptrdiff_t position
;
21540 ptrdiff_t distance
=
21541 (height
* 2 + 30) * line_number_display_limit_width
;
21543 if (startpos
- distance
> limit
)
21545 limit
= startpos
- distance
;
21546 limit_byte
= CHAR_TO_BYTE (limit
);
21549 nlines
= display_count_lines (startpos_byte
,
21551 - (height
* 2 + 30),
21553 /* If we couldn't find the lines we wanted within
21554 line_number_display_limit_width chars per line,
21555 give up on line numbers for this window. */
21556 if (position
== limit_byte
&& limit
== startpos
- distance
)
21558 wset_base_line_pos (w
, w
->buffer
);
21559 wset_base_line_number (w
, Qnil
);
21563 wset_base_line_number (w
, make_number (topline
- nlines
));
21564 wset_base_line_pos (w
, make_number (BYTE_TO_CHAR (position
)));
21567 /* Now count lines from the start pos to point. */
21568 nlines
= display_count_lines (startpos_byte
,
21569 PT_BYTE
, PT
, &junk
);
21571 /* Record that we did display the line number. */
21572 line_number_displayed
= 1;
21574 /* Make the string to show. */
21575 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
21576 return decode_mode_spec_buf
;
21579 char* p
= decode_mode_spec_buf
;
21580 int pad
= field_width
- 2;
21586 return decode_mode_spec_buf
;
21592 obj
= BVAR (b
, mode_name
);
21596 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
21602 ptrdiff_t pos
= marker_position (w
->start
);
21603 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21605 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
21607 if (pos
<= BUF_BEGV (b
))
21612 else if (pos
<= BUF_BEGV (b
))
21616 if (total
> 1000000)
21617 /* Do it differently for a large value, to avoid overflow. */
21618 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21620 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21621 /* We can't normally display a 3-digit number,
21622 so get us a 2-digit number that is close. */
21625 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21626 return decode_mode_spec_buf
;
21630 /* Display percentage of size above the bottom of the screen. */
21633 ptrdiff_t toppos
= marker_position (w
->start
);
21634 ptrdiff_t botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
21635 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21637 if (botpos
>= BUF_ZV (b
))
21639 if (toppos
<= BUF_BEGV (b
))
21646 if (total
> 1000000)
21647 /* Do it differently for a large value, to avoid overflow. */
21648 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21650 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21651 /* We can't normally display a 3-digit number,
21652 so get us a 2-digit number that is close. */
21655 if (toppos
<= BUF_BEGV (b
))
21656 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
21658 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21659 return decode_mode_spec_buf
;
21664 /* status of process */
21665 obj
= Fget_buffer_process (Fcurrent_buffer ());
21667 return "no process";
21669 obj
= Fsymbol_name (Fprocess_status (obj
));
21675 ptrdiff_t count
= inhibit_garbage_collection ();
21676 Lisp_Object val
= call1 (intern ("file-remote-p"),
21677 BVAR (current_buffer
, directory
));
21678 unbind_to (count
, Qnil
);
21686 case 't': /* indicate TEXT or BINARY */
21690 /* coding-system (not including end-of-line format) */
21692 /* coding-system (including end-of-line type) */
21694 int eol_flag
= (c
== 'Z');
21695 char *p
= decode_mode_spec_buf
;
21697 if (! FRAME_WINDOW_P (f
))
21699 /* No need to mention EOL here--the terminal never needs
21700 to do EOL conversion. */
21701 p
= decode_mode_spec_coding (CODING_ID_NAME
21702 (FRAME_KEYBOARD_CODING (f
)->id
),
21704 p
= decode_mode_spec_coding (CODING_ID_NAME
21705 (FRAME_TERMINAL_CODING (f
)->id
),
21708 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
21711 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21712 #ifdef subprocesses
21713 obj
= Fget_buffer_process (Fcurrent_buffer ());
21714 if (PROCESSP (obj
))
21716 p
= decode_mode_spec_coding
21717 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
21718 p
= decode_mode_spec_coding
21719 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
21721 #endif /* subprocesses */
21724 return decode_mode_spec_buf
;
21731 return SSDATA (obj
);
21738 /* Count up to COUNT lines starting from START_BYTE.
21739 But don't go beyond LIMIT_BYTE.
21740 Return the number of lines thus found (always nonnegative).
21742 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
21745 display_count_lines (ptrdiff_t start_byte
,
21746 ptrdiff_t limit_byte
, ptrdiff_t count
,
21747 ptrdiff_t *byte_pos_ptr
)
21749 register unsigned char *cursor
;
21750 unsigned char *base
;
21752 register ptrdiff_t ceiling
;
21753 register unsigned char *ceiling_addr
;
21754 ptrdiff_t orig_count
= count
;
21756 /* If we are not in selective display mode,
21757 check only for newlines. */
21758 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
21759 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
21763 while (start_byte
< limit_byte
)
21765 ceiling
= BUFFER_CEILING_OF (start_byte
);
21766 ceiling
= min (limit_byte
- 1, ceiling
);
21767 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
21768 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
21771 if (selective_display
)
21772 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
21775 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
21778 if (cursor
!= ceiling_addr
)
21782 start_byte
+= cursor
- base
+ 1;
21783 *byte_pos_ptr
= start_byte
;
21787 if (++cursor
== ceiling_addr
)
21793 start_byte
+= cursor
- base
;
21798 while (start_byte
> limit_byte
)
21800 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
21801 ceiling
= max (limit_byte
, ceiling
);
21802 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
21803 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
21806 if (selective_display
)
21807 while (--cursor
!= ceiling_addr
21808 && *cursor
!= '\n' && *cursor
!= 015)
21811 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
21814 if (cursor
!= ceiling_addr
)
21818 start_byte
+= cursor
- base
+ 1;
21819 *byte_pos_ptr
= start_byte
;
21820 /* When scanning backwards, we should
21821 not count the newline posterior to which we stop. */
21822 return - orig_count
- 1;
21828 /* Here we add 1 to compensate for the last decrement
21829 of CURSOR, which took it past the valid range. */
21830 start_byte
+= cursor
- base
+ 1;
21834 *byte_pos_ptr
= limit_byte
;
21837 return - orig_count
+ count
;
21838 return orig_count
- count
;
21844 /***********************************************************************
21846 ***********************************************************************/
21848 /* Display a NUL-terminated string, starting with index START.
21850 If STRING is non-null, display that C string. Otherwise, the Lisp
21851 string LISP_STRING is displayed. There's a case that STRING is
21852 non-null and LISP_STRING is not nil. It means STRING is a string
21853 data of LISP_STRING. In that case, we display LISP_STRING while
21854 ignoring its text properties.
21856 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21857 FACE_STRING. Display STRING or LISP_STRING with the face at
21858 FACE_STRING_POS in FACE_STRING:
21860 Display the string in the environment given by IT, but use the
21861 standard display table, temporarily.
21863 FIELD_WIDTH is the minimum number of output glyphs to produce.
21864 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21865 with spaces. If STRING has more characters, more than FIELD_WIDTH
21866 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21868 PRECISION is the maximum number of characters to output from
21869 STRING. PRECISION < 0 means don't truncate the string.
21871 This is roughly equivalent to printf format specifiers:
21873 FIELD_WIDTH PRECISION PRINTF
21874 ----------------------------------------
21880 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21881 display them, and < 0 means obey the current buffer's value of
21882 enable_multibyte_characters.
21884 Value is the number of columns displayed. */
21887 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21888 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
21889 int field_width
, int precision
, int max_x
, int multibyte
)
21891 int hpos_at_start
= it
->hpos
;
21892 int saved_face_id
= it
->face_id
;
21893 struct glyph_row
*row
= it
->glyph_row
;
21894 ptrdiff_t it_charpos
;
21896 /* Initialize the iterator IT for iteration over STRING beginning
21897 with index START. */
21898 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21899 precision
, field_width
, multibyte
);
21900 if (string
&& STRINGP (lisp_string
))
21901 /* LISP_STRING is the one returned by decode_mode_spec. We should
21902 ignore its text properties. */
21903 it
->stop_charpos
= it
->end_charpos
;
21905 /* If displaying STRING, set up the face of the iterator from
21906 FACE_STRING, if that's given. */
21907 if (STRINGP (face_string
))
21913 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21914 0, it
->region_beg_charpos
,
21915 it
->region_end_charpos
,
21916 &endptr
, it
->base_face_id
, 0);
21917 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21918 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21921 /* Set max_x to the maximum allowed X position. Don't let it go
21922 beyond the right edge of the window. */
21924 max_x
= it
->last_visible_x
;
21926 max_x
= min (max_x
, it
->last_visible_x
);
21928 /* Skip over display elements that are not visible. because IT->w is
21930 if (it
->current_x
< it
->first_visible_x
)
21931 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21932 MOVE_TO_POS
| MOVE_TO_X
);
21934 row
->ascent
= it
->max_ascent
;
21935 row
->height
= it
->max_ascent
+ it
->max_descent
;
21936 row
->phys_ascent
= it
->max_phys_ascent
;
21937 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21938 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21940 if (STRINGP (it
->string
))
21941 it_charpos
= IT_STRING_CHARPOS (*it
);
21943 it_charpos
= IT_CHARPOS (*it
);
21945 /* This condition is for the case that we are called with current_x
21946 past last_visible_x. */
21947 while (it
->current_x
< max_x
)
21949 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21951 /* Get the next display element. */
21952 if (!get_next_display_element (it
))
21955 /* Produce glyphs. */
21956 x_before
= it
->current_x
;
21957 n_glyphs_before
= row
->used
[TEXT_AREA
];
21958 PRODUCE_GLYPHS (it
);
21960 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21963 while (i
< nglyphs
)
21965 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21967 if (it
->line_wrap
!= TRUNCATE
21968 && x
+ glyph
->pixel_width
> max_x
)
21970 /* End of continued line or max_x reached. */
21971 if (CHAR_GLYPH_PADDING_P (*glyph
))
21973 /* A wide character is unbreakable. */
21974 if (row
->reversed_p
)
21975 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21976 - n_glyphs_before
);
21977 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21978 it
->current_x
= x_before
;
21982 if (row
->reversed_p
)
21983 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21984 - (n_glyphs_before
+ i
));
21985 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21990 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21992 /* Glyph is at least partially visible. */
21994 if (x
< it
->first_visible_x
)
21995 row
->x
= x
- it
->first_visible_x
;
21999 /* Glyph is off the left margin of the display area.
22000 Should not happen. */
22004 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
22005 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
22006 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
22007 row
->phys_height
= max (row
->phys_height
,
22008 it
->max_phys_ascent
+ it
->max_phys_descent
);
22009 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
22010 it
->max_extra_line_spacing
);
22011 x
+= glyph
->pixel_width
;
22015 /* Stop if max_x reached. */
22019 /* Stop at line ends. */
22020 if (ITERATOR_AT_END_OF_LINE_P (it
))
22022 it
->continuation_lines_width
= 0;
22026 set_iterator_to_next (it
, 1);
22027 if (STRINGP (it
->string
))
22028 it_charpos
= IT_STRING_CHARPOS (*it
);
22030 it_charpos
= IT_CHARPOS (*it
);
22032 /* Stop if truncating at the right edge. */
22033 if (it
->line_wrap
== TRUNCATE
22034 && it
->current_x
>= it
->last_visible_x
)
22036 /* Add truncation mark, but don't do it if the line is
22037 truncated at a padding space. */
22038 if (it_charpos
< it
->string_nchars
)
22040 if (!FRAME_WINDOW_P (it
->f
))
22044 if (it
->current_x
> it
->last_visible_x
)
22046 if (!row
->reversed_p
)
22048 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
22049 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
22054 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
22055 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
22057 unproduce_glyphs (it
, ii
+ 1);
22058 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
22060 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
22062 row
->used
[TEXT_AREA
] = ii
;
22063 produce_special_glyphs (it
, IT_TRUNCATION
);
22066 produce_special_glyphs (it
, IT_TRUNCATION
);
22068 row
->truncated_on_right_p
= 1;
22074 /* Maybe insert a truncation at the left. */
22075 if (it
->first_visible_x
22078 if (!FRAME_WINDOW_P (it
->f
)
22079 || (row
->reversed_p
22080 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
22081 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
22082 insert_left_trunc_glyphs (it
);
22083 row
->truncated_on_left_p
= 1;
22086 it
->face_id
= saved_face_id
;
22088 /* Value is number of columns displayed. */
22089 return it
->hpos
- hpos_at_start
;
22094 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
22095 appears as an element of LIST or as the car of an element of LIST.
22096 If PROPVAL is a list, compare each element against LIST in that
22097 way, and return 1/2 if any element of PROPVAL is found in LIST.
22098 Otherwise return 0. This function cannot quit.
22099 The return value is 2 if the text is invisible but with an ellipsis
22100 and 1 if it's invisible and without an ellipsis. */
22103 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
22105 register Lisp_Object tail
, proptail
;
22107 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
22109 register Lisp_Object tem
;
22111 if (EQ (propval
, tem
))
22113 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
22114 return NILP (XCDR (tem
)) ? 1 : 2;
22117 if (CONSP (propval
))
22119 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
22121 Lisp_Object propelt
;
22122 propelt
= XCAR (proptail
);
22123 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
22125 register Lisp_Object tem
;
22127 if (EQ (propelt
, tem
))
22129 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
22130 return NILP (XCDR (tem
)) ? 1 : 2;
22138 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
22139 doc
: /* Non-nil if the property makes the text invisible.
22140 POS-OR-PROP can be a marker or number, in which case it is taken to be
22141 a position in the current buffer and the value of the `invisible' property
22142 is checked; or it can be some other value, which is then presumed to be the
22143 value of the `invisible' property of the text of interest.
22144 The non-nil value returned can be t for truly invisible text or something
22145 else if the text is replaced by an ellipsis. */)
22146 (Lisp_Object pos_or_prop
)
22149 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
22150 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
22152 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
22153 return (invis
== 0 ? Qnil
22155 : make_number (invis
));
22158 /* Calculate a width or height in pixels from a specification using
22159 the following elements:
22162 NUM - a (fractional) multiple of the default font width/height
22163 (NUM) - specifies exactly NUM pixels
22164 UNIT - a fixed number of pixels, see below.
22165 ELEMENT - size of a display element in pixels, see below.
22166 (NUM . SPEC) - equals NUM * SPEC
22167 (+ SPEC SPEC ...) - add pixel values
22168 (- SPEC SPEC ...) - subtract pixel values
22169 (- SPEC) - negate pixel value
22172 INT or FLOAT - a number constant
22173 SYMBOL - use symbol's (buffer local) variable binding.
22176 in - pixels per inch *)
22177 mm - pixels per 1/1000 meter *)
22178 cm - pixels per 1/100 meter *)
22179 width - width of current font in pixels.
22180 height - height of current font in pixels.
22182 *) using the ratio(s) defined in display-pixels-per-inch.
22186 left-fringe - left fringe width in pixels
22187 right-fringe - right fringe width in pixels
22189 left-margin - left margin width in pixels
22190 right-margin - right margin width in pixels
22192 scroll-bar - scroll-bar area width in pixels
22196 Pixels corresponding to 5 inches:
22199 Total width of non-text areas on left side of window (if scroll-bar is on left):
22200 '(space :width (+ left-fringe left-margin scroll-bar))
22202 Align to first text column (in header line):
22203 '(space :align-to 0)
22205 Align to middle of text area minus half the width of variable `my-image'
22206 containing a loaded image:
22207 '(space :align-to (0.5 . (- text my-image)))
22209 Width of left margin minus width of 1 character in the default font:
22210 '(space :width (- left-margin 1))
22212 Width of left margin minus width of 2 characters in the current font:
22213 '(space :width (- left-margin (2 . width)))
22215 Center 1 character over left-margin (in header line):
22216 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
22218 Different ways to express width of left fringe plus left margin minus one pixel:
22219 '(space :width (- (+ left-fringe left-margin) (1)))
22220 '(space :width (+ left-fringe left-margin (- (1))))
22221 '(space :width (+ left-fringe left-margin (-1)))
22225 #define NUMVAL(X) \
22226 ((INTEGERP (X) || FLOATP (X)) \
22231 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
22232 struct font
*font
, int width_p
, int *align_to
)
22236 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
22237 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
22240 return OK_PIXELS (0);
22242 eassert (FRAME_LIVE_P (it
->f
));
22244 if (SYMBOLP (prop
))
22246 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
22248 char *unit
= SSDATA (SYMBOL_NAME (prop
));
22250 if (unit
[0] == 'i' && unit
[1] == 'n')
22252 else if (unit
[0] == 'm' && unit
[1] == 'm')
22254 else if (unit
[0] == 'c' && unit
[1] == 'm')
22261 #ifdef HAVE_WINDOW_SYSTEM
22262 if (FRAME_WINDOW_P (it
->f
)
22264 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
22265 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
22267 return OK_PIXELS (ppi
/ pixels
);
22270 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
22271 || (CONSP (Vdisplay_pixels_per_inch
)
22273 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
22274 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
22276 return OK_PIXELS (ppi
/ pixels
);
22282 #ifdef HAVE_WINDOW_SYSTEM
22283 if (EQ (prop
, Qheight
))
22284 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
22285 if (EQ (prop
, Qwidth
))
22286 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
22288 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
22289 return OK_PIXELS (1);
22292 if (EQ (prop
, Qtext
))
22293 return OK_PIXELS (width_p
22294 ? window_box_width (it
->w
, TEXT_AREA
)
22295 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
22297 if (align_to
&& *align_to
< 0)
22300 if (EQ (prop
, Qleft
))
22301 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
22302 if (EQ (prop
, Qright
))
22303 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
22304 if (EQ (prop
, Qcenter
))
22305 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
22306 + window_box_width (it
->w
, TEXT_AREA
) / 2);
22307 if (EQ (prop
, Qleft_fringe
))
22308 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22309 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
22310 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
22311 if (EQ (prop
, Qright_fringe
))
22312 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22313 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22314 : window_box_right_offset (it
->w
, TEXT_AREA
));
22315 if (EQ (prop
, Qleft_margin
))
22316 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
22317 if (EQ (prop
, Qright_margin
))
22318 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
22319 if (EQ (prop
, Qscroll_bar
))
22320 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
22322 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22323 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22324 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
22329 if (EQ (prop
, Qleft_fringe
))
22330 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
22331 if (EQ (prop
, Qright_fringe
))
22332 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
22333 if (EQ (prop
, Qleft_margin
))
22334 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
22335 if (EQ (prop
, Qright_margin
))
22336 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
22337 if (EQ (prop
, Qscroll_bar
))
22338 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
22341 prop
= buffer_local_value_1 (prop
, it
->w
->buffer
);
22342 if (EQ (prop
, Qunbound
))
22346 if (INTEGERP (prop
) || FLOATP (prop
))
22348 int base_unit
= (width_p
22349 ? FRAME_COLUMN_WIDTH (it
->f
)
22350 : FRAME_LINE_HEIGHT (it
->f
));
22351 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
22356 Lisp_Object car
= XCAR (prop
);
22357 Lisp_Object cdr
= XCDR (prop
);
22361 #ifdef HAVE_WINDOW_SYSTEM
22362 if (FRAME_WINDOW_P (it
->f
)
22363 && valid_image_p (prop
))
22365 ptrdiff_t id
= lookup_image (it
->f
, prop
);
22366 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
22368 return OK_PIXELS (width_p
? img
->width
: img
->height
);
22371 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
22377 while (CONSP (cdr
))
22379 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
22380 font
, width_p
, align_to
))
22383 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
22388 if (EQ (car
, Qminus
))
22390 return OK_PIXELS (pixels
);
22393 car
= buffer_local_value_1 (car
, it
->w
->buffer
);
22394 if (EQ (car
, Qunbound
))
22398 if (INTEGERP (car
) || FLOATP (car
))
22401 pixels
= XFLOATINT (car
);
22403 return OK_PIXELS (pixels
);
22404 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
22405 font
, width_p
, align_to
))
22406 return OK_PIXELS (pixels
* fact
);
22417 /***********************************************************************
22419 ***********************************************************************/
22421 #ifdef HAVE_WINDOW_SYSTEM
22426 dump_glyph_string (struct glyph_string
*s
)
22428 fprintf (stderr
, "glyph string\n");
22429 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
22430 s
->x
, s
->y
, s
->width
, s
->height
);
22431 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
22432 fprintf (stderr
, " hl = %d\n", s
->hl
);
22433 fprintf (stderr
, " left overhang = %d, right = %d\n",
22434 s
->left_overhang
, s
->right_overhang
);
22435 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
22436 fprintf (stderr
, " extends to end of line = %d\n",
22437 s
->extends_to_end_of_line_p
);
22438 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
22439 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
22442 #endif /* GLYPH_DEBUG */
22444 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
22445 of XChar2b structures for S; it can't be allocated in
22446 init_glyph_string because it must be allocated via `alloca'. W
22447 is the window on which S is drawn. ROW and AREA are the glyph row
22448 and area within the row from which S is constructed. START is the
22449 index of the first glyph structure covered by S. HL is a
22450 face-override for drawing S. */
22453 #define OPTIONAL_HDC(hdc) HDC hdc,
22454 #define DECLARE_HDC(hdc) HDC hdc;
22455 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
22456 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
22459 #ifndef OPTIONAL_HDC
22460 #define OPTIONAL_HDC(hdc)
22461 #define DECLARE_HDC(hdc)
22462 #define ALLOCATE_HDC(hdc, f)
22463 #define RELEASE_HDC(hdc, f)
22467 init_glyph_string (struct glyph_string
*s
,
22469 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
22470 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
22472 memset (s
, 0, sizeof *s
);
22474 s
->f
= XFRAME (w
->frame
);
22478 s
->display
= FRAME_X_DISPLAY (s
->f
);
22479 s
->window
= FRAME_X_WINDOW (s
->f
);
22480 s
->char2b
= char2b
;
22484 s
->first_glyph
= row
->glyphs
[area
] + start
;
22485 s
->height
= row
->height
;
22486 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
22487 s
->ybase
= s
->y
+ row
->ascent
;
22491 /* Append the list of glyph strings with head H and tail T to the list
22492 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
22495 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22496 struct glyph_string
*h
, struct glyph_string
*t
)
22510 /* Prepend the list of glyph strings with head H and tail T to the
22511 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
22515 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22516 struct glyph_string
*h
, struct glyph_string
*t
)
22530 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
22531 Set *HEAD and *TAIL to the resulting list. */
22534 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
22535 struct glyph_string
*s
)
22537 s
->next
= s
->prev
= NULL
;
22538 append_glyph_string_lists (head
, tail
, s
, s
);
22542 /* Get face and two-byte form of character C in face FACE_ID on frame F.
22543 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
22544 make sure that X resources for the face returned are allocated.
22545 Value is a pointer to a realized face that is ready for display if
22546 DISPLAY_P is non-zero. */
22548 static struct face
*
22549 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
22550 XChar2b
*char2b
, int display_p
)
22552 struct face
*face
= FACE_FROM_ID (f
, face_id
);
22556 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
22558 if (code
!= FONT_INVALID_CODE
)
22559 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22561 STORE_XCHAR2B (char2b
, 0, 0);
22564 /* Make sure X resources of the face are allocated. */
22565 #ifdef HAVE_X_WINDOWS
22569 eassert (face
!= NULL
);
22570 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22577 /* Get face and two-byte form of character glyph GLYPH on frame F.
22578 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
22579 a pointer to a realized face that is ready for display. */
22581 static struct face
*
22582 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
22583 XChar2b
*char2b
, int *two_byte_p
)
22587 eassert (glyph
->type
== CHAR_GLYPH
);
22588 face
= FACE_FROM_ID (f
, glyph
->face_id
);
22597 if (CHAR_BYTE8_P (glyph
->u
.ch
))
22598 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
22600 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
22602 if (code
!= FONT_INVALID_CODE
)
22603 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22605 STORE_XCHAR2B (char2b
, 0, 0);
22608 /* Make sure X resources of the face are allocated. */
22609 eassert (face
!= NULL
);
22610 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22615 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22616 Return 1 if FONT has a glyph for C, otherwise return 0. */
22619 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
22623 if (CHAR_BYTE8_P (c
))
22624 code
= CHAR_TO_BYTE8 (c
);
22626 code
= font
->driver
->encode_char (font
, c
);
22628 if (code
== FONT_INVALID_CODE
)
22630 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22635 /* Fill glyph string S with composition components specified by S->cmp.
22637 BASE_FACE is the base face of the composition.
22638 S->cmp_from is the index of the first component for S.
22640 OVERLAPS non-zero means S should draw the foreground only, and use
22641 its physical height for clipping. See also draw_glyphs.
22643 Value is the index of a component not in S. */
22646 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22650 /* For all glyphs of this composition, starting at the offset
22651 S->cmp_from, until we reach the end of the definition or encounter a
22652 glyph that requires the different face, add it to S. */
22657 s
->for_overlaps
= overlaps
;
22660 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
22662 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
22664 /* TAB in a composition means display glyphs with padding space
22665 on the left or right. */
22668 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
22671 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
22678 s
->font
= s
->face
->font
;
22680 else if (s
->face
!= face
)
22688 if (s
->face
== NULL
)
22690 s
->face
= base_face
->ascii_face
;
22691 s
->font
= s
->face
->font
;
22694 /* All glyph strings for the same composition has the same width,
22695 i.e. the width set for the first component of the composition. */
22696 s
->width
= s
->first_glyph
->pixel_width
;
22698 /* If the specified font could not be loaded, use the frame's
22699 default font, but record the fact that we couldn't load it in
22700 the glyph string so that we can draw rectangles for the
22701 characters of the glyph string. */
22702 if (s
->font
== NULL
)
22704 s
->font_not_found_p
= 1;
22705 s
->font
= FRAME_FONT (s
->f
);
22708 /* Adjust base line for subscript/superscript text. */
22709 s
->ybase
+= s
->first_glyph
->voffset
;
22711 /* This glyph string must always be drawn with 16-bit functions. */
22718 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
22719 int start
, int end
, int overlaps
)
22721 struct glyph
*glyph
, *last
;
22722 Lisp_Object lgstring
;
22725 s
->for_overlaps
= overlaps
;
22726 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22727 last
= s
->row
->glyphs
[s
->area
] + end
;
22728 s
->cmp_id
= glyph
->u
.cmp
.id
;
22729 s
->cmp_from
= glyph
->slice
.cmp
.from
;
22730 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
22731 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22732 lgstring
= composition_gstring_from_id (s
->cmp_id
);
22733 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
22735 while (glyph
< last
22736 && glyph
->u
.cmp
.automatic
22737 && glyph
->u
.cmp
.id
== s
->cmp_id
22738 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
22739 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
22741 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
22743 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
22744 unsigned code
= LGLYPH_CODE (lglyph
);
22746 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
22748 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
22749 return glyph
- s
->row
->glyphs
[s
->area
];
22753 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22754 See the comment of fill_glyph_string for arguments.
22755 Value is the index of the first glyph not in S. */
22759 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
22760 int start
, int end
, int overlaps
)
22762 struct glyph
*glyph
, *last
;
22765 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
22766 s
->for_overlaps
= overlaps
;
22767 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22768 last
= s
->row
->glyphs
[s
->area
] + end
;
22769 voffset
= glyph
->voffset
;
22770 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22771 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
22773 s
->width
= glyph
->pixel_width
;
22775 while (glyph
< last
22776 && glyph
->type
== GLYPHLESS_GLYPH
22777 && glyph
->voffset
== voffset
22778 && glyph
->face_id
== face_id
)
22781 s
->width
+= glyph
->pixel_width
;
22784 s
->ybase
+= voffset
;
22785 return glyph
- s
->row
->glyphs
[s
->area
];
22789 /* Fill glyph string S from a sequence of character glyphs.
22791 FACE_ID is the face id of the string. START is the index of the
22792 first glyph to consider, END is the index of the last + 1.
22793 OVERLAPS non-zero means S should draw the foreground only, and use
22794 its physical height for clipping. See also draw_glyphs.
22796 Value is the index of the first glyph not in S. */
22799 fill_glyph_string (struct glyph_string
*s
, int face_id
,
22800 int start
, int end
, int overlaps
)
22802 struct glyph
*glyph
, *last
;
22804 int glyph_not_available_p
;
22806 eassert (s
->f
== XFRAME (s
->w
->frame
));
22807 eassert (s
->nchars
== 0);
22808 eassert (start
>= 0 && end
> start
);
22810 s
->for_overlaps
= overlaps
;
22811 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22812 last
= s
->row
->glyphs
[s
->area
] + end
;
22813 voffset
= glyph
->voffset
;
22814 s
->padding_p
= glyph
->padding_p
;
22815 glyph_not_available_p
= glyph
->glyph_not_available_p
;
22817 while (glyph
< last
22818 && glyph
->type
== CHAR_GLYPH
22819 && glyph
->voffset
== voffset
22820 /* Same face id implies same font, nowadays. */
22821 && glyph
->face_id
== face_id
22822 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
22826 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
22827 s
->char2b
+ s
->nchars
,
22829 s
->two_byte_p
= two_byte_p
;
22831 eassert (s
->nchars
<= end
- start
);
22832 s
->width
+= glyph
->pixel_width
;
22833 if (glyph
++->padding_p
!= s
->padding_p
)
22837 s
->font
= s
->face
->font
;
22839 /* If the specified font could not be loaded, use the frame's font,
22840 but record the fact that we couldn't load it in
22841 S->font_not_found_p so that we can draw rectangles for the
22842 characters of the glyph string. */
22843 if (s
->font
== NULL
|| glyph_not_available_p
)
22845 s
->font_not_found_p
= 1;
22846 s
->font
= FRAME_FONT (s
->f
);
22849 /* Adjust base line for subscript/superscript text. */
22850 s
->ybase
+= voffset
;
22852 eassert (s
->face
&& s
->face
->gc
);
22853 return glyph
- s
->row
->glyphs
[s
->area
];
22857 /* Fill glyph string S from image glyph S->first_glyph. */
22860 fill_image_glyph_string (struct glyph_string
*s
)
22862 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22863 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22865 s
->slice
= s
->first_glyph
->slice
.img
;
22866 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22867 s
->font
= s
->face
->font
;
22868 s
->width
= s
->first_glyph
->pixel_width
;
22870 /* Adjust base line for subscript/superscript text. */
22871 s
->ybase
+= s
->first_glyph
->voffset
;
22875 /* Fill glyph string S from a sequence of stretch glyphs.
22877 START is the index of the first glyph to consider,
22878 END is the index of the last + 1.
22880 Value is the index of the first glyph not in S. */
22883 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
22885 struct glyph
*glyph
, *last
;
22886 int voffset
, face_id
;
22888 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22890 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22891 last
= s
->row
->glyphs
[s
->area
] + end
;
22892 face_id
= glyph
->face_id
;
22893 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22894 s
->font
= s
->face
->font
;
22895 s
->width
= glyph
->pixel_width
;
22897 voffset
= glyph
->voffset
;
22901 && glyph
->type
== STRETCH_GLYPH
22902 && glyph
->voffset
== voffset
22903 && glyph
->face_id
== face_id
);
22905 s
->width
+= glyph
->pixel_width
;
22907 /* Adjust base line for subscript/superscript text. */
22908 s
->ybase
+= voffset
;
22910 /* The case that face->gc == 0 is handled when drawing the glyph
22911 string by calling PREPARE_FACE_FOR_DISPLAY. */
22913 return glyph
- s
->row
->glyphs
[s
->area
];
22916 static struct font_metrics
*
22917 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22919 static struct font_metrics metrics
;
22920 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22922 if (! font
|| code
== FONT_INVALID_CODE
)
22924 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
22929 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22930 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22931 assumed to be zero. */
22934 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22936 *left
= *right
= 0;
22938 if (glyph
->type
== CHAR_GLYPH
)
22942 struct font_metrics
*pcm
;
22944 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22945 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22947 if (pcm
->rbearing
> pcm
->width
)
22948 *right
= pcm
->rbearing
- pcm
->width
;
22949 if (pcm
->lbearing
< 0)
22950 *left
= -pcm
->lbearing
;
22953 else if (glyph
->type
== COMPOSITE_GLYPH
)
22955 if (! glyph
->u
.cmp
.automatic
)
22957 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22959 if (cmp
->rbearing
> cmp
->pixel_width
)
22960 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22961 if (cmp
->lbearing
< 0)
22962 *left
= - cmp
->lbearing
;
22966 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22967 struct font_metrics metrics
;
22969 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22970 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22971 if (metrics
.rbearing
> metrics
.width
)
22972 *right
= metrics
.rbearing
- metrics
.width
;
22973 if (metrics
.lbearing
< 0)
22974 *left
= - metrics
.lbearing
;
22980 /* Return the index of the first glyph preceding glyph string S that
22981 is overwritten by S because of S's left overhang. Value is -1
22982 if no glyphs are overwritten. */
22985 left_overwritten (struct glyph_string
*s
)
22989 if (s
->left_overhang
)
22992 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22993 int first
= s
->first_glyph
- glyphs
;
22995 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22996 x
-= glyphs
[i
].pixel_width
;
23007 /* Return the index of the first glyph preceding glyph string S that
23008 is overwriting S because of its right overhang. Value is -1 if no
23009 glyph in front of S overwrites S. */
23012 left_overwriting (struct glyph_string
*s
)
23015 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23016 int first
= s
->first_glyph
- glyphs
;
23020 for (i
= first
- 1; i
>= 0; --i
)
23023 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
23026 x
-= glyphs
[i
].pixel_width
;
23033 /* Return the index of the last glyph following glyph string S that is
23034 overwritten by S because of S's right overhang. Value is -1 if
23035 no such glyph is found. */
23038 right_overwritten (struct glyph_string
*s
)
23042 if (s
->right_overhang
)
23045 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23046 int first
= (s
->first_glyph
- glyphs
23047 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
23048 int end
= s
->row
->used
[s
->area
];
23050 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
23051 x
+= glyphs
[i
].pixel_width
;
23060 /* Return the index of the last glyph following glyph string S that
23061 overwrites S because of its left overhang. Value is negative
23062 if no such glyph is found. */
23065 right_overwriting (struct glyph_string
*s
)
23068 int end
= s
->row
->used
[s
->area
];
23069 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23070 int first
= (s
->first_glyph
- glyphs
23071 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
23075 for (i
= first
; i
< end
; ++i
)
23078 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
23081 x
+= glyphs
[i
].pixel_width
;
23088 /* Set background width of glyph string S. START is the index of the
23089 first glyph following S. LAST_X is the right-most x-position + 1
23090 in the drawing area. */
23093 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
23095 /* If the face of this glyph string has to be drawn to the end of
23096 the drawing area, set S->extends_to_end_of_line_p. */
23098 if (start
== s
->row
->used
[s
->area
]
23099 && s
->area
== TEXT_AREA
23100 && ((s
->row
->fill_line_p
23101 && (s
->hl
== DRAW_NORMAL_TEXT
23102 || s
->hl
== DRAW_IMAGE_RAISED
23103 || s
->hl
== DRAW_IMAGE_SUNKEN
))
23104 || s
->hl
== DRAW_MOUSE_FACE
))
23105 s
->extends_to_end_of_line_p
= 1;
23107 /* If S extends its face to the end of the line, set its
23108 background_width to the distance to the right edge of the drawing
23110 if (s
->extends_to_end_of_line_p
)
23111 s
->background_width
= last_x
- s
->x
+ 1;
23113 s
->background_width
= s
->width
;
23117 /* Compute overhangs and x-positions for glyph string S and its
23118 predecessors, or successors. X is the starting x-position for S.
23119 BACKWARD_P non-zero means process predecessors. */
23122 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
23128 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
23129 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
23139 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
23140 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
23150 /* The following macros are only called from draw_glyphs below.
23151 They reference the following parameters of that function directly:
23152 `w', `row', `area', and `overlap_p'
23153 as well as the following local variables:
23154 `s', `f', and `hdc' (in W32) */
23157 /* On W32, silently add local `hdc' variable to argument list of
23158 init_glyph_string. */
23159 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23160 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
23162 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23163 init_glyph_string (s, char2b, w, row, area, start, hl)
23166 /* Add a glyph string for a stretch glyph to the list of strings
23167 between HEAD and TAIL. START is the index of the stretch glyph in
23168 row area AREA of glyph row ROW. END is the index of the last glyph
23169 in that glyph row area. X is the current output position assigned
23170 to the new glyph string constructed. HL overrides that face of the
23171 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23172 is the right-most x-position of the drawing area. */
23174 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
23175 and below -- keep them on one line. */
23176 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23179 s = alloca (sizeof *s); \
23180 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23181 START = fill_stretch_glyph_string (s, START, END); \
23182 append_glyph_string (&HEAD, &TAIL, s); \
23188 /* Add a glyph string for an image glyph to the list of strings
23189 between HEAD and TAIL. START is the index of the image glyph in
23190 row area AREA of glyph row ROW. END is the index of the last glyph
23191 in that glyph row area. X is the current output position assigned
23192 to the new glyph string constructed. HL overrides that face of the
23193 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23194 is the right-most x-position of the drawing area. */
23196 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23199 s = alloca (sizeof *s); \
23200 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23201 fill_image_glyph_string (s); \
23202 append_glyph_string (&HEAD, &TAIL, s); \
23209 /* Add a glyph string for a sequence of character glyphs to the list
23210 of strings between HEAD and TAIL. START is the index of the first
23211 glyph in row area AREA of glyph row ROW that is part of the new
23212 glyph string. END is the index of the last glyph in that glyph row
23213 area. X is the current output position assigned to the new glyph
23214 string constructed. HL overrides that face of the glyph; e.g. it
23215 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
23216 right-most x-position of the drawing area. */
23218 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23224 face_id = (row)->glyphs[area][START].face_id; \
23226 s = alloca (sizeof *s); \
23227 char2b = alloca ((END - START) * sizeof *char2b); \
23228 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23229 append_glyph_string (&HEAD, &TAIL, s); \
23231 START = fill_glyph_string (s, face_id, START, END, overlaps); \
23236 /* Add a glyph string for a composite sequence to the list of strings
23237 between HEAD and TAIL. START is the index of the first glyph in
23238 row area AREA of glyph row ROW that is part of the new glyph
23239 string. END is the index of the last glyph in that glyph row area.
23240 X is the current output position assigned to the new glyph string
23241 constructed. HL overrides that face of the glyph; e.g. it is
23242 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
23243 x-position of the drawing area. */
23245 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23247 int face_id = (row)->glyphs[area][START].face_id; \
23248 struct face *base_face = FACE_FROM_ID (f, face_id); \
23249 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
23250 struct composition *cmp = composition_table[cmp_id]; \
23252 struct glyph_string *first_s = NULL; \
23255 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
23257 /* Make glyph_strings for each glyph sequence that is drawable by \
23258 the same face, and append them to HEAD/TAIL. */ \
23259 for (n = 0; n < cmp->glyph_len;) \
23261 s = alloca (sizeof *s); \
23262 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23263 append_glyph_string (&(HEAD), &(TAIL), s); \
23269 n = fill_composite_glyph_string (s, base_face, overlaps); \
23277 /* Add a glyph string for a glyph-string sequence to the list of strings
23278 between HEAD and TAIL. */
23280 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23284 Lisp_Object gstring; \
23286 face_id = (row)->glyphs[area][START].face_id; \
23287 gstring = (composition_gstring_from_id \
23288 ((row)->glyphs[area][START].u.cmp.id)); \
23289 s = alloca (sizeof *s); \
23290 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
23291 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23292 append_glyph_string (&(HEAD), &(TAIL), s); \
23294 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
23298 /* Add a glyph string for a sequence of glyphless character's glyphs
23299 to the list of strings between HEAD and TAIL. The meanings of
23300 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
23302 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23307 face_id = (row)->glyphs[area][START].face_id; \
23309 s = alloca (sizeof *s); \
23310 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23311 append_glyph_string (&HEAD, &TAIL, s); \
23313 START = fill_glyphless_glyph_string (s, face_id, START, END, \
23319 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
23320 of AREA of glyph row ROW on window W between indices START and END.
23321 HL overrides the face for drawing glyph strings, e.g. it is
23322 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
23323 x-positions of the drawing area.
23325 This is an ugly monster macro construct because we must use alloca
23326 to allocate glyph strings (because draw_glyphs can be called
23327 asynchronously). */
23329 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23332 HEAD = TAIL = NULL; \
23333 while (START < END) \
23335 struct glyph *first_glyph = (row)->glyphs[area] + START; \
23336 switch (first_glyph->type) \
23339 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
23343 case COMPOSITE_GLYPH: \
23344 if (first_glyph->u.cmp.automatic) \
23345 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
23348 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
23352 case STRETCH_GLYPH: \
23353 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
23357 case IMAGE_GLYPH: \
23358 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
23362 case GLYPHLESS_GLYPH: \
23363 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
23373 set_glyph_string_background_width (s, START, LAST_X); \
23380 /* Draw glyphs between START and END in AREA of ROW on window W,
23381 starting at x-position X. X is relative to AREA in W. HL is a
23382 face-override with the following meaning:
23384 DRAW_NORMAL_TEXT draw normally
23385 DRAW_CURSOR draw in cursor face
23386 DRAW_MOUSE_FACE draw in mouse face.
23387 DRAW_INVERSE_VIDEO draw in mode line face
23388 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
23389 DRAW_IMAGE_RAISED draw an image with a raised relief around it
23391 If OVERLAPS is non-zero, draw only the foreground of characters and
23392 clip to the physical height of ROW. Non-zero value also defines
23393 the overlapping part to be drawn:
23395 OVERLAPS_PRED overlap with preceding rows
23396 OVERLAPS_SUCC overlap with succeeding rows
23397 OVERLAPS_BOTH overlap with both preceding/succeeding rows
23398 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
23400 Value is the x-position reached, relative to AREA of W. */
23403 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
23404 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
23405 enum draw_glyphs_face hl
, int overlaps
)
23407 struct glyph_string
*head
, *tail
;
23408 struct glyph_string
*s
;
23409 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
23410 int i
, j
, x_reached
, last_x
, area_left
= 0;
23411 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23414 ALLOCATE_HDC (hdc
, f
);
23416 /* Let's rather be paranoid than getting a SEGV. */
23417 end
= min (end
, row
->used
[area
]);
23418 start
= max (0, start
);
23419 start
= min (end
, start
);
23421 /* Translate X to frame coordinates. Set last_x to the right
23422 end of the drawing area. */
23423 if (row
->full_width_p
)
23425 /* X is relative to the left edge of W, without scroll bars
23427 area_left
= WINDOW_LEFT_EDGE_X (w
);
23428 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
23432 area_left
= window_box_left (w
, area
);
23433 last_x
= area_left
+ window_box_width (w
, area
);
23437 /* Build a doubly-linked list of glyph_string structures between
23438 head and tail from what we have to draw. Note that the macro
23439 BUILD_GLYPH_STRINGS will modify its start parameter. That's
23440 the reason we use a separate variable `i'. */
23442 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
23444 x_reached
= tail
->x
+ tail
->background_width
;
23448 /* If there are any glyphs with lbearing < 0 or rbearing > width in
23449 the row, redraw some glyphs in front or following the glyph
23450 strings built above. */
23451 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
23453 struct glyph_string
*h
, *t
;
23454 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23455 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
23456 int check_mouse_face
= 0;
23459 /* If mouse highlighting is on, we may need to draw adjacent
23460 glyphs using mouse-face highlighting. */
23461 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
23463 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
23465 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23466 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23468 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
23470 check_mouse_face
= 1;
23471 mouse_beg_col
= (row
== mouse_beg_row
)
23472 ? hlinfo
->mouse_face_beg_col
: 0;
23473 mouse_end_col
= (row
== mouse_end_row
)
23474 ? hlinfo
->mouse_face_end_col
23475 : row
->used
[TEXT_AREA
];
23479 /* Compute overhangs for all glyph strings. */
23480 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
23481 for (s
= head
; s
; s
= s
->next
)
23482 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
23484 /* Prepend glyph strings for glyphs in front of the first glyph
23485 string that are overwritten because of the first glyph
23486 string's left overhang. The background of all strings
23487 prepended must be drawn because the first glyph string
23489 i
= left_overwritten (head
);
23492 enum draw_glyphs_face overlap_hl
;
23494 /* If this row contains mouse highlighting, attempt to draw
23495 the overlapped glyphs with the correct highlight. This
23496 code fails if the overlap encompasses more than one glyph
23497 and mouse-highlight spans only some of these glyphs.
23498 However, making it work perfectly involves a lot more
23499 code, and I don't know if the pathological case occurs in
23500 practice, so we'll stick to this for now. --- cyd */
23501 if (check_mouse_face
23502 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23503 overlap_hl
= DRAW_MOUSE_FACE
;
23505 overlap_hl
= DRAW_NORMAL_TEXT
;
23508 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
23509 overlap_hl
, dummy_x
, last_x
);
23511 compute_overhangs_and_x (t
, head
->x
, 1);
23512 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23516 /* Prepend glyph strings for glyphs in front of the first glyph
23517 string that overwrite that glyph string because of their
23518 right overhang. For these strings, only the foreground must
23519 be drawn, because it draws over the glyph string at `head'.
23520 The background must not be drawn because this would overwrite
23521 right overhangs of preceding glyphs for which no glyph
23523 i
= left_overwriting (head
);
23526 enum draw_glyphs_face overlap_hl
;
23528 if (check_mouse_face
23529 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23530 overlap_hl
= DRAW_MOUSE_FACE
;
23532 overlap_hl
= DRAW_NORMAL_TEXT
;
23535 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
23536 overlap_hl
, dummy_x
, last_x
);
23537 for (s
= h
; s
; s
= s
->next
)
23538 s
->background_filled_p
= 1;
23539 compute_overhangs_and_x (t
, head
->x
, 1);
23540 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23543 /* Append glyphs strings for glyphs following the last glyph
23544 string tail that are overwritten by tail. The background of
23545 these strings has to be drawn because tail's foreground draws
23547 i
= right_overwritten (tail
);
23550 enum draw_glyphs_face overlap_hl
;
23552 if (check_mouse_face
23553 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23554 overlap_hl
= DRAW_MOUSE_FACE
;
23556 overlap_hl
= DRAW_NORMAL_TEXT
;
23558 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23559 overlap_hl
, x
, last_x
);
23560 /* Because BUILD_GLYPH_STRINGS updates the first argument,
23561 we don't have `end = i;' here. */
23562 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23563 append_glyph_string_lists (&head
, &tail
, h
, t
);
23567 /* Append glyph strings for glyphs following the last glyph
23568 string tail that overwrite tail. The foreground of such
23569 glyphs has to be drawn because it writes into the background
23570 of tail. The background must not be drawn because it could
23571 paint over the foreground of following glyphs. */
23572 i
= right_overwriting (tail
);
23575 enum draw_glyphs_face overlap_hl
;
23576 if (check_mouse_face
23577 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23578 overlap_hl
= DRAW_MOUSE_FACE
;
23580 overlap_hl
= DRAW_NORMAL_TEXT
;
23583 i
++; /* We must include the Ith glyph. */
23584 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23585 overlap_hl
, x
, last_x
);
23586 for (s
= h
; s
; s
= s
->next
)
23587 s
->background_filled_p
= 1;
23588 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23589 append_glyph_string_lists (&head
, &tail
, h
, t
);
23591 if (clip_head
|| clip_tail
)
23592 for (s
= head
; s
; s
= s
->next
)
23594 s
->clip_head
= clip_head
;
23595 s
->clip_tail
= clip_tail
;
23599 /* Draw all strings. */
23600 for (s
= head
; s
; s
= s
->next
)
23601 FRAME_RIF (f
)->draw_glyph_string (s
);
23604 /* When focus a sole frame and move horizontally, this sets on_p to 0
23605 causing a failure to erase prev cursor position. */
23606 if (area
== TEXT_AREA
23607 && !row
->full_width_p
23608 /* When drawing overlapping rows, only the glyph strings'
23609 foreground is drawn, which doesn't erase a cursor
23613 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
23614 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
23615 : (tail
? tail
->x
+ tail
->background_width
: x
));
23619 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
23620 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
23624 /* Value is the x-position up to which drawn, relative to AREA of W.
23625 This doesn't include parts drawn because of overhangs. */
23626 if (row
->full_width_p
)
23627 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
23629 x_reached
-= area_left
;
23631 RELEASE_HDC (hdc
, f
);
23636 /* Expand row matrix if too narrow. Don't expand if area
23639 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23641 if (!fonts_changed_p \
23642 && (it->glyph_row->glyphs[area] \
23643 < it->glyph_row->glyphs[area + 1])) \
23645 it->w->ncols_scale_factor++; \
23646 fonts_changed_p = 1; \
23650 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23651 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23654 append_glyph (struct it
*it
)
23656 struct glyph
*glyph
;
23657 enum glyph_row_area area
= it
->area
;
23659 eassert (it
->glyph_row
);
23660 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
23662 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23663 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23665 /* If the glyph row is reversed, we need to prepend the glyph
23666 rather than append it. */
23667 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23671 /* Make room for the additional glyph. */
23672 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23674 glyph
= it
->glyph_row
->glyphs
[area
];
23676 glyph
->charpos
= CHARPOS (it
->position
);
23677 glyph
->object
= it
->object
;
23678 if (it
->pixel_width
> 0)
23680 glyph
->pixel_width
= it
->pixel_width
;
23681 glyph
->padding_p
= 0;
23685 /* Assure at least 1-pixel width. Otherwise, cursor can't
23686 be displayed correctly. */
23687 glyph
->pixel_width
= 1;
23688 glyph
->padding_p
= 1;
23690 glyph
->ascent
= it
->ascent
;
23691 glyph
->descent
= it
->descent
;
23692 glyph
->voffset
= it
->voffset
;
23693 glyph
->type
= CHAR_GLYPH
;
23694 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23695 glyph
->multibyte_p
= it
->multibyte_p
;
23696 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23697 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23698 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23699 || it
->phys_descent
> it
->descent
);
23700 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
23701 glyph
->face_id
= it
->face_id
;
23702 glyph
->u
.ch
= it
->char_to_display
;
23703 glyph
->slice
.img
= null_glyph_slice
;
23704 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23707 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23708 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23710 glyph
->bidi_type
= it
->bidi_it
.type
;
23714 glyph
->resolved_level
= 0;
23715 glyph
->bidi_type
= UNKNOWN_BT
;
23717 ++it
->glyph_row
->used
[area
];
23720 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23723 /* Store one glyph for the composition IT->cmp_it.id in
23724 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23728 append_composite_glyph (struct it
*it
)
23730 struct glyph
*glyph
;
23731 enum glyph_row_area area
= it
->area
;
23733 eassert (it
->glyph_row
);
23735 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23736 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23738 /* If the glyph row is reversed, we need to prepend the glyph
23739 rather than append it. */
23740 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
23744 /* Make room for the new glyph. */
23745 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
23747 glyph
= it
->glyph_row
->glyphs
[it
->area
];
23749 glyph
->charpos
= it
->cmp_it
.charpos
;
23750 glyph
->object
= it
->object
;
23751 glyph
->pixel_width
= it
->pixel_width
;
23752 glyph
->ascent
= it
->ascent
;
23753 glyph
->descent
= it
->descent
;
23754 glyph
->voffset
= it
->voffset
;
23755 glyph
->type
= COMPOSITE_GLYPH
;
23756 if (it
->cmp_it
.ch
< 0)
23758 glyph
->u
.cmp
.automatic
= 0;
23759 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23760 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
23764 glyph
->u
.cmp
.automatic
= 1;
23765 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23766 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
23767 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
23769 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23770 glyph
->multibyte_p
= it
->multibyte_p
;
23771 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23772 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23773 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23774 || it
->phys_descent
> it
->descent
);
23775 glyph
->padding_p
= 0;
23776 glyph
->glyph_not_available_p
= 0;
23777 glyph
->face_id
= it
->face_id
;
23778 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23781 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23782 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23784 glyph
->bidi_type
= it
->bidi_it
.type
;
23786 ++it
->glyph_row
->used
[area
];
23789 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23793 /* Change IT->ascent and IT->height according to the setting of
23797 take_vertical_position_into_account (struct it
*it
)
23801 if (it
->voffset
< 0)
23802 /* Increase the ascent so that we can display the text higher
23804 it
->ascent
-= it
->voffset
;
23806 /* Increase the descent so that we can display the text lower
23808 it
->descent
+= it
->voffset
;
23813 /* Produce glyphs/get display metrics for the image IT is loaded with.
23814 See the description of struct display_iterator in dispextern.h for
23815 an overview of struct display_iterator. */
23818 produce_image_glyph (struct it
*it
)
23822 int glyph_ascent
, crop
;
23823 struct glyph_slice slice
;
23825 eassert (it
->what
== IT_IMAGE
);
23827 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23829 /* Make sure X resources of the face is loaded. */
23830 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23832 if (it
->image_id
< 0)
23834 /* Fringe bitmap. */
23835 it
->ascent
= it
->phys_ascent
= 0;
23836 it
->descent
= it
->phys_descent
= 0;
23837 it
->pixel_width
= 0;
23842 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
23844 /* Make sure X resources of the image is loaded. */
23845 prepare_image_for_display (it
->f
, img
);
23847 slice
.x
= slice
.y
= 0;
23848 slice
.width
= img
->width
;
23849 slice
.height
= img
->height
;
23851 if (INTEGERP (it
->slice
.x
))
23852 slice
.x
= XINT (it
->slice
.x
);
23853 else if (FLOATP (it
->slice
.x
))
23854 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
23856 if (INTEGERP (it
->slice
.y
))
23857 slice
.y
= XINT (it
->slice
.y
);
23858 else if (FLOATP (it
->slice
.y
))
23859 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
23861 if (INTEGERP (it
->slice
.width
))
23862 slice
.width
= XINT (it
->slice
.width
);
23863 else if (FLOATP (it
->slice
.width
))
23864 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
23866 if (INTEGERP (it
->slice
.height
))
23867 slice
.height
= XINT (it
->slice
.height
);
23868 else if (FLOATP (it
->slice
.height
))
23869 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
23871 if (slice
.x
>= img
->width
)
23872 slice
.x
= img
->width
;
23873 if (slice
.y
>= img
->height
)
23874 slice
.y
= img
->height
;
23875 if (slice
.x
+ slice
.width
>= img
->width
)
23876 slice
.width
= img
->width
- slice
.x
;
23877 if (slice
.y
+ slice
.height
> img
->height
)
23878 slice
.height
= img
->height
- slice
.y
;
23880 if (slice
.width
== 0 || slice
.height
== 0)
23883 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
23885 it
->descent
= slice
.height
- glyph_ascent
;
23887 it
->descent
+= img
->vmargin
;
23888 if (slice
.y
+ slice
.height
== img
->height
)
23889 it
->descent
+= img
->vmargin
;
23890 it
->phys_descent
= it
->descent
;
23892 it
->pixel_width
= slice
.width
;
23894 it
->pixel_width
+= img
->hmargin
;
23895 if (slice
.x
+ slice
.width
== img
->width
)
23896 it
->pixel_width
+= img
->hmargin
;
23898 /* It's quite possible for images to have an ascent greater than
23899 their height, so don't get confused in that case. */
23900 if (it
->descent
< 0)
23905 if (face
->box
!= FACE_NO_BOX
)
23907 if (face
->box_line_width
> 0)
23910 it
->ascent
+= face
->box_line_width
;
23911 if (slice
.y
+ slice
.height
== img
->height
)
23912 it
->descent
+= face
->box_line_width
;
23915 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23916 it
->pixel_width
+= eabs (face
->box_line_width
);
23917 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23918 it
->pixel_width
+= eabs (face
->box_line_width
);
23921 take_vertical_position_into_account (it
);
23923 /* Automatically crop wide image glyphs at right edge so we can
23924 draw the cursor on same display row. */
23925 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23926 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23928 it
->pixel_width
-= crop
;
23929 slice
.width
-= crop
;
23934 struct glyph
*glyph
;
23935 enum glyph_row_area area
= it
->area
;
23937 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23938 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23940 glyph
->charpos
= CHARPOS (it
->position
);
23941 glyph
->object
= it
->object
;
23942 glyph
->pixel_width
= it
->pixel_width
;
23943 glyph
->ascent
= glyph_ascent
;
23944 glyph
->descent
= it
->descent
;
23945 glyph
->voffset
= it
->voffset
;
23946 glyph
->type
= IMAGE_GLYPH
;
23947 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23948 glyph
->multibyte_p
= it
->multibyte_p
;
23949 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23950 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23951 glyph
->overlaps_vertically_p
= 0;
23952 glyph
->padding_p
= 0;
23953 glyph
->glyph_not_available_p
= 0;
23954 glyph
->face_id
= it
->face_id
;
23955 glyph
->u
.img_id
= img
->id
;
23956 glyph
->slice
.img
= slice
;
23957 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23960 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23961 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23963 glyph
->bidi_type
= it
->bidi_it
.type
;
23965 ++it
->glyph_row
->used
[area
];
23968 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23973 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23974 of the glyph, WIDTH and HEIGHT are the width and height of the
23975 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23978 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23979 int width
, int height
, int ascent
)
23981 struct glyph
*glyph
;
23982 enum glyph_row_area area
= it
->area
;
23984 eassert (ascent
>= 0 && ascent
<= height
);
23986 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23987 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23989 /* If the glyph row is reversed, we need to prepend the glyph
23990 rather than append it. */
23991 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23995 /* Make room for the additional glyph. */
23996 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23998 glyph
= it
->glyph_row
->glyphs
[area
];
24000 glyph
->charpos
= CHARPOS (it
->position
);
24001 glyph
->object
= object
;
24002 glyph
->pixel_width
= width
;
24003 glyph
->ascent
= ascent
;
24004 glyph
->descent
= height
- ascent
;
24005 glyph
->voffset
= it
->voffset
;
24006 glyph
->type
= STRETCH_GLYPH
;
24007 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24008 glyph
->multibyte_p
= it
->multibyte_p
;
24009 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24010 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24011 glyph
->overlaps_vertically_p
= 0;
24012 glyph
->padding_p
= 0;
24013 glyph
->glyph_not_available_p
= 0;
24014 glyph
->face_id
= it
->face_id
;
24015 glyph
->u
.stretch
.ascent
= ascent
;
24016 glyph
->u
.stretch
.height
= height
;
24017 glyph
->slice
.img
= null_glyph_slice
;
24018 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24021 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24022 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24024 glyph
->bidi_type
= it
->bidi_it
.type
;
24028 glyph
->resolved_level
= 0;
24029 glyph
->bidi_type
= UNKNOWN_BT
;
24031 ++it
->glyph_row
->used
[area
];
24034 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24037 #endif /* HAVE_WINDOW_SYSTEM */
24039 /* Produce a stretch glyph for iterator IT. IT->object is the value
24040 of the glyph property displayed. The value must be a list
24041 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
24044 1. `:width WIDTH' specifies that the space should be WIDTH *
24045 canonical char width wide. WIDTH may be an integer or floating
24048 2. `:relative-width FACTOR' specifies that the width of the stretch
24049 should be computed from the width of the first character having the
24050 `glyph' property, and should be FACTOR times that width.
24052 3. `:align-to HPOS' specifies that the space should be wide enough
24053 to reach HPOS, a value in canonical character units.
24055 Exactly one of the above pairs must be present.
24057 4. `:height HEIGHT' specifies that the height of the stretch produced
24058 should be HEIGHT, measured in canonical character units.
24060 5. `:relative-height FACTOR' specifies that the height of the
24061 stretch should be FACTOR times the height of the characters having
24062 the glyph property.
24064 Either none or exactly one of 4 or 5 must be present.
24066 6. `:ascent ASCENT' specifies that ASCENT percent of the height
24067 of the stretch should be used for the ascent of the stretch.
24068 ASCENT must be in the range 0 <= ASCENT <= 100. */
24071 produce_stretch_glyph (struct it
*it
)
24073 /* (space :width WIDTH :height HEIGHT ...) */
24074 Lisp_Object prop
, plist
;
24075 int width
= 0, height
= 0, align_to
= -1;
24076 int zero_width_ok_p
= 0;
24079 struct face
*face
= NULL
;
24080 struct font
*font
= NULL
;
24082 #ifdef HAVE_WINDOW_SYSTEM
24083 int zero_height_ok_p
= 0;
24085 if (FRAME_WINDOW_P (it
->f
))
24087 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24088 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24089 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24093 /* List should start with `space'. */
24094 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
24095 plist
= XCDR (it
->object
);
24097 /* Compute the width of the stretch. */
24098 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
24099 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
24101 /* Absolute width `:width WIDTH' specified and valid. */
24102 zero_width_ok_p
= 1;
24105 #ifdef HAVE_WINDOW_SYSTEM
24106 else if (FRAME_WINDOW_P (it
->f
)
24107 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
24109 /* Relative width `:relative-width FACTOR' specified and valid.
24110 Compute the width of the characters having the `glyph'
24113 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
24116 if (it
->multibyte_p
)
24117 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
24120 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
24121 if (! ASCII_CHAR_P (it2
.c
))
24122 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
24125 it2
.glyph_row
= NULL
;
24126 it2
.what
= IT_CHARACTER
;
24127 x_produce_glyphs (&it2
);
24128 width
= NUMVAL (prop
) * it2
.pixel_width
;
24130 #endif /* HAVE_WINDOW_SYSTEM */
24131 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
24132 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
24134 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
24135 align_to
= (align_to
< 0
24137 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
24138 else if (align_to
< 0)
24139 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
24140 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
24141 zero_width_ok_p
= 1;
24144 /* Nothing specified -> width defaults to canonical char width. */
24145 width
= FRAME_COLUMN_WIDTH (it
->f
);
24147 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
24150 #ifdef HAVE_WINDOW_SYSTEM
24151 /* Compute height. */
24152 if (FRAME_WINDOW_P (it
->f
))
24154 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
24155 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24158 zero_height_ok_p
= 1;
24160 else if (prop
= Fplist_get (plist
, QCrelative_height
),
24162 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
24164 height
= FONT_HEIGHT (font
);
24166 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
24169 /* Compute percentage of height used for ascent. If
24170 `:ascent ASCENT' is present and valid, use that. Otherwise,
24171 derive the ascent from the font in use. */
24172 if (prop
= Fplist_get (plist
, QCascent
),
24173 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
24174 ascent
= height
* NUMVAL (prop
) / 100.0;
24175 else if (!NILP (prop
)
24176 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24177 ascent
= min (max (0, (int)tem
), height
);
24179 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
24182 #endif /* HAVE_WINDOW_SYSTEM */
24185 if (width
> 0 && it
->line_wrap
!= TRUNCATE
24186 && it
->current_x
+ width
> it
->last_visible_x
)
24188 width
= it
->last_visible_x
- it
->current_x
;
24189 #ifdef HAVE_WINDOW_SYSTEM
24190 /* Subtract one more pixel from the stretch width, but only on
24191 GUI frames, since on a TTY each glyph is one "pixel" wide. */
24192 width
-= FRAME_WINDOW_P (it
->f
);
24196 if (width
> 0 && height
> 0 && it
->glyph_row
)
24198 Lisp_Object o_object
= it
->object
;
24199 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
24202 if (!STRINGP (object
))
24203 object
= it
->w
->buffer
;
24204 #ifdef HAVE_WINDOW_SYSTEM
24205 if (FRAME_WINDOW_P (it
->f
))
24206 append_stretch_glyph (it
, object
, width
, height
, ascent
);
24210 it
->object
= object
;
24211 it
->char_to_display
= ' ';
24212 it
->pixel_width
= it
->len
= 1;
24214 tty_append_glyph (it
);
24215 it
->object
= o_object
;
24219 it
->pixel_width
= width
;
24220 #ifdef HAVE_WINDOW_SYSTEM
24221 if (FRAME_WINDOW_P (it
->f
))
24223 it
->ascent
= it
->phys_ascent
= ascent
;
24224 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
24225 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
24226 take_vertical_position_into_account (it
);
24230 it
->nglyphs
= width
;
24233 /* Get information about special display element WHAT in an
24234 environment described by IT. WHAT is one of IT_TRUNCATION or
24235 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
24236 non-null glyph_row member. This function ensures that fields like
24237 face_id, c, len of IT are left untouched. */
24240 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
24247 temp_it
.object
= make_number (0);
24248 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
24250 if (what
== IT_CONTINUATION
)
24252 /* Continuation glyph. For R2L lines, we mirror it by hand. */
24253 if (it
->bidi_it
.paragraph_dir
== R2L
)
24254 SET_GLYPH_FROM_CHAR (glyph
, '/');
24256 SET_GLYPH_FROM_CHAR (glyph
, '\\');
24258 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24260 /* FIXME: Should we mirror GC for R2L lines? */
24261 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24262 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24265 else if (what
== IT_TRUNCATION
)
24267 /* Truncation glyph. */
24268 SET_GLYPH_FROM_CHAR (glyph
, '$');
24270 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24272 /* FIXME: Should we mirror GC for R2L lines? */
24273 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24274 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24280 #ifdef HAVE_WINDOW_SYSTEM
24281 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
24282 is turned off, we precede the truncation/continuation glyphs by a
24283 stretch glyph whose width is computed such that these special
24284 glyphs are aligned at the window margin, even when very different
24285 fonts are used in different glyph rows. */
24286 if (FRAME_WINDOW_P (temp_it
.f
)
24287 /* init_iterator calls this with it->glyph_row == NULL, and it
24288 wants only the pixel width of the truncation/continuation
24290 && temp_it
.glyph_row
24291 /* insert_left_trunc_glyphs calls us at the beginning of the
24292 row, and it has its own calculation of the stretch glyph
24294 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
24295 && (temp_it
.glyph_row
->reversed_p
24296 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
24297 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
24299 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
24301 if (stretch_width
> 0)
24303 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
24304 struct font
*font
=
24305 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
24306 int stretch_ascent
=
24307 (((temp_it
.ascent
+ temp_it
.descent
)
24308 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
24310 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
24311 temp_it
.ascent
+ temp_it
.descent
,
24318 temp_it
.what
= IT_CHARACTER
;
24320 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
24321 temp_it
.face_id
= GLYPH_FACE (glyph
);
24322 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
24324 PRODUCE_GLYPHS (&temp_it
);
24325 it
->pixel_width
= temp_it
.pixel_width
;
24326 it
->nglyphs
= temp_it
.pixel_width
;
24329 #ifdef HAVE_WINDOW_SYSTEM
24331 /* Calculate line-height and line-spacing properties.
24332 An integer value specifies explicit pixel value.
24333 A float value specifies relative value to current face height.
24334 A cons (float . face-name) specifies relative value to
24335 height of specified face font.
24337 Returns height in pixels, or nil. */
24341 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
24342 int boff
, int override
)
24344 Lisp_Object face_name
= Qnil
;
24345 int ascent
, descent
, height
;
24347 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
24352 face_name
= XCAR (val
);
24354 if (!NUMBERP (val
))
24355 val
= make_number (1);
24356 if (NILP (face_name
))
24358 height
= it
->ascent
+ it
->descent
;
24363 if (NILP (face_name
))
24365 font
= FRAME_FONT (it
->f
);
24366 boff
= FRAME_BASELINE_OFFSET (it
->f
);
24368 else if (EQ (face_name
, Qt
))
24377 face_id
= lookup_named_face (it
->f
, face_name
, 0);
24379 return make_number (-1);
24381 face
= FACE_FROM_ID (it
->f
, face_id
);
24384 return make_number (-1);
24385 boff
= font
->baseline_offset
;
24386 if (font
->vertical_centering
)
24387 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24390 ascent
= FONT_BASE (font
) + boff
;
24391 descent
= FONT_DESCENT (font
) - boff
;
24395 it
->override_ascent
= ascent
;
24396 it
->override_descent
= descent
;
24397 it
->override_boff
= boff
;
24400 height
= ascent
+ descent
;
24404 height
= (int)(XFLOAT_DATA (val
) * height
);
24405 else if (INTEGERP (val
))
24406 height
*= XINT (val
);
24408 return make_number (height
);
24412 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
24413 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
24414 and only if this is for a character for which no font was found.
24416 If the display method (it->glyphless_method) is
24417 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
24418 length of the acronym or the hexadecimal string, UPPER_XOFF and
24419 UPPER_YOFF are pixel offsets for the upper part of the string,
24420 LOWER_XOFF and LOWER_YOFF are for the lower part.
24422 For the other display methods, LEN through LOWER_YOFF are zero. */
24425 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
24426 short upper_xoff
, short upper_yoff
,
24427 short lower_xoff
, short lower_yoff
)
24429 struct glyph
*glyph
;
24430 enum glyph_row_area area
= it
->area
;
24432 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24433 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24435 /* If the glyph row is reversed, we need to prepend the glyph
24436 rather than append it. */
24437 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24441 /* Make room for the additional glyph. */
24442 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24444 glyph
= it
->glyph_row
->glyphs
[area
];
24446 glyph
->charpos
= CHARPOS (it
->position
);
24447 glyph
->object
= it
->object
;
24448 glyph
->pixel_width
= it
->pixel_width
;
24449 glyph
->ascent
= it
->ascent
;
24450 glyph
->descent
= it
->descent
;
24451 glyph
->voffset
= it
->voffset
;
24452 glyph
->type
= GLYPHLESS_GLYPH
;
24453 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
24454 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
24455 glyph
->u
.glyphless
.len
= len
;
24456 glyph
->u
.glyphless
.ch
= it
->c
;
24457 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
24458 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
24459 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
24460 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
24461 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24462 glyph
->multibyte_p
= it
->multibyte_p
;
24463 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24464 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24465 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24466 || it
->phys_descent
> it
->descent
);
24467 glyph
->padding_p
= 0;
24468 glyph
->glyph_not_available_p
= 0;
24469 glyph
->face_id
= face_id
;
24470 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24473 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24474 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24476 glyph
->bidi_type
= it
->bidi_it
.type
;
24478 ++it
->glyph_row
->used
[area
];
24481 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24485 /* Produce a glyph for a glyphless character for iterator IT.
24486 IT->glyphless_method specifies which method to use for displaying
24487 the character. See the description of enum
24488 glyphless_display_method in dispextern.h for the detail.
24490 FOR_NO_FONT is nonzero if and only if this is for a character for
24491 which no font was found. ACRONYM, if non-nil, is an acronym string
24492 for the character. */
24495 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
24500 int base_width
, base_height
, width
, height
;
24501 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
24504 /* Get the metrics of the base font. We always refer to the current
24506 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
24507 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24508 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
24509 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
24510 base_height
= it
->ascent
+ it
->descent
;
24511 base_width
= font
->average_width
;
24513 /* Get a face ID for the glyph by utilizing a cache (the same way as
24514 done for `escape-glyph' in get_next_display_element). */
24515 if (it
->f
== last_glyphless_glyph_frame
24516 && it
->face_id
== last_glyphless_glyph_face_id
)
24518 face_id
= last_glyphless_glyph_merged_face_id
;
24522 /* Merge the `glyphless-char' face into the current face. */
24523 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
24524 last_glyphless_glyph_frame
= it
->f
;
24525 last_glyphless_glyph_face_id
= it
->face_id
;
24526 last_glyphless_glyph_merged_face_id
= face_id
;
24529 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
24531 it
->pixel_width
= THIN_SPACE_WIDTH
;
24533 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24535 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
24537 width
= CHAR_WIDTH (it
->c
);
24540 else if (width
> 4)
24542 it
->pixel_width
= base_width
* width
;
24544 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24550 unsigned int code
[6];
24552 int ascent
, descent
;
24553 struct font_metrics metrics_upper
, metrics_lower
;
24555 face
= FACE_FROM_ID (it
->f
, face_id
);
24556 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24557 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24559 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
24561 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
24562 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
24563 if (CONSP (acronym
))
24564 acronym
= XCAR (acronym
);
24565 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
24569 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
24570 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
24573 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
24574 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
24575 upper_len
= (len
+ 1) / 2;
24576 font
->driver
->text_extents (font
, code
, upper_len
,
24578 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
24583 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
24584 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
24585 upper_xoff
= upper_yoff
= 2; /* the typical case */
24586 if (base_width
>= width
)
24588 /* Align the upper to the left, the lower to the right. */
24589 it
->pixel_width
= base_width
;
24590 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
24594 /* Center the shorter one. */
24595 it
->pixel_width
= width
;
24596 if (metrics_upper
.width
>= metrics_lower
.width
)
24597 lower_xoff
= (width
- metrics_lower
.width
) / 2;
24600 /* FIXME: This code doesn't look right. It formerly was
24601 missing the "lower_xoff = 0;", which couldn't have
24602 been right since it left lower_xoff uninitialized. */
24604 upper_xoff
= (width
- metrics_upper
.width
) / 2;
24608 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
24609 top, bottom, and between upper and lower strings. */
24610 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
24611 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
24612 /* Center vertically.
24613 H:base_height, D:base_descent
24614 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
24616 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
24617 descent = D - H/2 + h/2;
24618 lower_yoff = descent - 2 - ld;
24619 upper_yoff = lower_yoff - la - 1 - ud; */
24620 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
24621 descent
= it
->descent
- (base_height
- height
) / 2;
24622 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
24623 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
24624 - metrics_upper
.descent
);
24625 /* Don't make the height shorter than the base height. */
24626 if (height
> base_height
)
24628 it
->ascent
= ascent
;
24629 it
->descent
= descent
;
24633 it
->phys_ascent
= it
->ascent
;
24634 it
->phys_descent
= it
->descent
;
24636 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
24637 upper_xoff
, upper_yoff
,
24638 lower_xoff
, lower_yoff
);
24640 take_vertical_position_into_account (it
);
24645 Produce glyphs/get display metrics for the display element IT is
24646 loaded with. See the description of struct it in dispextern.h
24647 for an overview of struct it. */
24650 x_produce_glyphs (struct it
*it
)
24652 int extra_line_spacing
= it
->extra_line_spacing
;
24654 it
->glyph_not_available_p
= 0;
24656 if (it
->what
== IT_CHARACTER
)
24659 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24660 struct font
*font
= face
->font
;
24661 struct font_metrics
*pcm
= NULL
;
24662 int boff
; /* baseline offset */
24666 /* When no suitable font is found, display this character by
24667 the method specified in the first extra slot of
24668 Vglyphless_char_display. */
24669 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
24671 eassert (it
->what
== IT_GLYPHLESS
);
24672 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
24676 boff
= font
->baseline_offset
;
24677 if (font
->vertical_centering
)
24678 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24680 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
24686 if (it
->override_ascent
>= 0)
24688 it
->ascent
= it
->override_ascent
;
24689 it
->descent
= it
->override_descent
;
24690 boff
= it
->override_boff
;
24694 it
->ascent
= FONT_BASE (font
) + boff
;
24695 it
->descent
= FONT_DESCENT (font
) - boff
;
24698 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
24700 pcm
= get_per_char_metric (font
, &char2b
);
24701 if (pcm
->width
== 0
24702 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
24708 it
->phys_ascent
= pcm
->ascent
+ boff
;
24709 it
->phys_descent
= pcm
->descent
- boff
;
24710 it
->pixel_width
= pcm
->width
;
24714 it
->glyph_not_available_p
= 1;
24715 it
->phys_ascent
= it
->ascent
;
24716 it
->phys_descent
= it
->descent
;
24717 it
->pixel_width
= font
->space_width
;
24720 if (it
->constrain_row_ascent_descent_p
)
24722 if (it
->descent
> it
->max_descent
)
24724 it
->ascent
+= it
->descent
- it
->max_descent
;
24725 it
->descent
= it
->max_descent
;
24727 if (it
->ascent
> it
->max_ascent
)
24729 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24730 it
->ascent
= it
->max_ascent
;
24732 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24733 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24734 extra_line_spacing
= 0;
24737 /* If this is a space inside a region of text with
24738 `space-width' property, change its width. */
24739 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
24741 it
->pixel_width
*= XFLOATINT (it
->space_width
);
24743 /* If face has a box, add the box thickness to the character
24744 height. If character has a box line to the left and/or
24745 right, add the box line width to the character's width. */
24746 if (face
->box
!= FACE_NO_BOX
)
24748 int thick
= face
->box_line_width
;
24752 it
->ascent
+= thick
;
24753 it
->descent
+= thick
;
24758 if (it
->start_of_box_run_p
)
24759 it
->pixel_width
+= thick
;
24760 if (it
->end_of_box_run_p
)
24761 it
->pixel_width
+= thick
;
24764 /* If face has an overline, add the height of the overline
24765 (1 pixel) and a 1 pixel margin to the character height. */
24766 if (face
->overline_p
)
24767 it
->ascent
+= overline_margin
;
24769 if (it
->constrain_row_ascent_descent_p
)
24771 if (it
->ascent
> it
->max_ascent
)
24772 it
->ascent
= it
->max_ascent
;
24773 if (it
->descent
> it
->max_descent
)
24774 it
->descent
= it
->max_descent
;
24777 take_vertical_position_into_account (it
);
24779 /* If we have to actually produce glyphs, do it. */
24784 /* Translate a space with a `space-width' property
24785 into a stretch glyph. */
24786 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
24787 / FONT_HEIGHT (font
));
24788 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24789 it
->ascent
+ it
->descent
, ascent
);
24794 /* If characters with lbearing or rbearing are displayed
24795 in this line, record that fact in a flag of the
24796 glyph row. This is used to optimize X output code. */
24797 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
24798 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24800 if (! stretched_p
&& it
->pixel_width
== 0)
24801 /* We assure that all visible glyphs have at least 1-pixel
24803 it
->pixel_width
= 1;
24805 else if (it
->char_to_display
== '\n')
24807 /* A newline has no width, but we need the height of the
24808 line. But if previous part of the line sets a height,
24809 don't increase that height */
24811 Lisp_Object height
;
24812 Lisp_Object total_height
= Qnil
;
24814 it
->override_ascent
= -1;
24815 it
->pixel_width
= 0;
24818 height
= get_it_property (it
, Qline_height
);
24819 /* Split (line-height total-height) list */
24821 && CONSP (XCDR (height
))
24822 && NILP (XCDR (XCDR (height
))))
24824 total_height
= XCAR (XCDR (height
));
24825 height
= XCAR (height
);
24827 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
24829 if (it
->override_ascent
>= 0)
24831 it
->ascent
= it
->override_ascent
;
24832 it
->descent
= it
->override_descent
;
24833 boff
= it
->override_boff
;
24837 it
->ascent
= FONT_BASE (font
) + boff
;
24838 it
->descent
= FONT_DESCENT (font
) - boff
;
24841 if (EQ (height
, Qt
))
24843 if (it
->descent
> it
->max_descent
)
24845 it
->ascent
+= it
->descent
- it
->max_descent
;
24846 it
->descent
= it
->max_descent
;
24848 if (it
->ascent
> it
->max_ascent
)
24850 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24851 it
->ascent
= it
->max_ascent
;
24853 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24854 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24855 it
->constrain_row_ascent_descent_p
= 1;
24856 extra_line_spacing
= 0;
24860 Lisp_Object spacing
;
24862 it
->phys_ascent
= it
->ascent
;
24863 it
->phys_descent
= it
->descent
;
24865 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
24866 && face
->box
!= FACE_NO_BOX
24867 && face
->box_line_width
> 0)
24869 it
->ascent
+= face
->box_line_width
;
24870 it
->descent
+= face
->box_line_width
;
24873 && XINT (height
) > it
->ascent
+ it
->descent
)
24874 it
->ascent
= XINT (height
) - it
->descent
;
24876 if (!NILP (total_height
))
24877 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
24880 spacing
= get_it_property (it
, Qline_spacing
);
24881 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
24883 if (INTEGERP (spacing
))
24885 extra_line_spacing
= XINT (spacing
);
24886 if (!NILP (total_height
))
24887 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
24891 else /* i.e. (it->char_to_display == '\t') */
24893 if (font
->space_width
> 0)
24895 int tab_width
= it
->tab_width
* font
->space_width
;
24896 int x
= it
->current_x
+ it
->continuation_lines_width
;
24897 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
24899 /* If the distance from the current position to the next tab
24900 stop is less than a space character width, use the
24901 tab stop after that. */
24902 if (next_tab_x
- x
< font
->space_width
)
24903 next_tab_x
+= tab_width
;
24905 it
->pixel_width
= next_tab_x
- x
;
24907 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
24908 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
24912 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24913 it
->ascent
+ it
->descent
, it
->ascent
);
24918 it
->pixel_width
= 0;
24923 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
24925 /* A static composition.
24927 Note: A composition is represented as one glyph in the
24928 glyph matrix. There are no padding glyphs.
24930 Important note: pixel_width, ascent, and descent are the
24931 values of what is drawn by draw_glyphs (i.e. the values of
24932 the overall glyphs composed). */
24933 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24934 int boff
; /* baseline offset */
24935 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
24936 int glyph_len
= cmp
->glyph_len
;
24937 struct font
*font
= face
->font
;
24941 /* If we have not yet calculated pixel size data of glyphs of
24942 the composition for the current face font, calculate them
24943 now. Theoretically, we have to check all fonts for the
24944 glyphs, but that requires much time and memory space. So,
24945 here we check only the font of the first glyph. This may
24946 lead to incorrect display, but it's very rare, and C-l
24947 (recenter-top-bottom) can correct the display anyway. */
24948 if (! cmp
->font
|| cmp
->font
!= font
)
24950 /* Ascent and descent of the font of the first character
24951 of this composition (adjusted by baseline offset).
24952 Ascent and descent of overall glyphs should not be less
24953 than these, respectively. */
24954 int font_ascent
, font_descent
, font_height
;
24955 /* Bounding box of the overall glyphs. */
24956 int leftmost
, rightmost
, lowest
, highest
;
24957 int lbearing
, rbearing
;
24958 int i
, width
, ascent
, descent
;
24959 int left_padded
= 0, right_padded
= 0;
24960 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
24962 struct font_metrics
*pcm
;
24963 int font_not_found_p
;
24966 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
24967 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
24969 if (glyph_len
< cmp
->glyph_len
)
24971 for (i
= 0; i
< glyph_len
; i
++)
24973 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
24975 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24980 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
24981 : IT_CHARPOS (*it
));
24982 /* If no suitable font is found, use the default font. */
24983 font_not_found_p
= font
== NULL
;
24984 if (font_not_found_p
)
24986 face
= face
->ascii_face
;
24989 boff
= font
->baseline_offset
;
24990 if (font
->vertical_centering
)
24991 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24992 font_ascent
= FONT_BASE (font
) + boff
;
24993 font_descent
= FONT_DESCENT (font
) - boff
;
24994 font_height
= FONT_HEIGHT (font
);
24999 if (! font_not_found_p
)
25001 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
25003 pcm
= get_per_char_metric (font
, &char2b
);
25006 /* Initialize the bounding box. */
25009 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
25010 ascent
= pcm
->ascent
;
25011 descent
= pcm
->descent
;
25012 lbearing
= pcm
->lbearing
;
25013 rbearing
= pcm
->rbearing
;
25017 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
25018 ascent
= FONT_BASE (font
);
25019 descent
= FONT_DESCENT (font
);
25026 lowest
= - descent
+ boff
;
25027 highest
= ascent
+ boff
;
25029 if (! font_not_found_p
25030 && font
->default_ascent
25031 && CHAR_TABLE_P (Vuse_default_ascent
)
25032 && !NILP (Faref (Vuse_default_ascent
,
25033 make_number (it
->char_to_display
))))
25034 highest
= font
->default_ascent
+ boff
;
25036 /* Draw the first glyph at the normal position. It may be
25037 shifted to right later if some other glyphs are drawn
25039 cmp
->offsets
[i
* 2] = 0;
25040 cmp
->offsets
[i
* 2 + 1] = boff
;
25041 cmp
->lbearing
= lbearing
;
25042 cmp
->rbearing
= rbearing
;
25044 /* Set cmp->offsets for the remaining glyphs. */
25045 for (i
++; i
< glyph_len
; i
++)
25047 int left
, right
, btm
, top
;
25048 int ch
= COMPOSITION_GLYPH (cmp
, i
);
25050 struct face
*this_face
;
25054 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
25055 this_face
= FACE_FROM_ID (it
->f
, face_id
);
25056 font
= this_face
->font
;
25062 get_char_face_and_encoding (it
->f
, ch
, face_id
,
25064 pcm
= get_per_char_metric (font
, &char2b
);
25067 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
25070 width
= pcm
->width
;
25071 ascent
= pcm
->ascent
;
25072 descent
= pcm
->descent
;
25073 lbearing
= pcm
->lbearing
;
25074 rbearing
= pcm
->rbearing
;
25075 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
25077 /* Relative composition with or without
25078 alternate chars. */
25079 left
= (leftmost
+ rightmost
- width
) / 2;
25080 btm
= - descent
+ boff
;
25081 if (font
->relative_compose
25082 && (! CHAR_TABLE_P (Vignore_relative_composition
)
25083 || NILP (Faref (Vignore_relative_composition
,
25084 make_number (ch
)))))
25087 if (- descent
>= font
->relative_compose
)
25088 /* One extra pixel between two glyphs. */
25090 else if (ascent
<= 0)
25091 /* One extra pixel between two glyphs. */
25092 btm
= lowest
- 1 - ascent
- descent
;
25097 /* A composition rule is specified by an integer
25098 value that encodes global and new reference
25099 points (GREF and NREF). GREF and NREF are
25100 specified by numbers as below:
25102 0---1---2 -- ascent
25106 9--10--11 -- center
25108 ---3---4---5--- baseline
25110 6---7---8 -- descent
25112 int rule
= COMPOSITION_RULE (cmp
, i
);
25113 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
25115 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
25116 grefx
= gref
% 3, nrefx
= nref
% 3;
25117 grefy
= gref
/ 3, nrefy
= nref
/ 3;
25119 xoff
= font_height
* (xoff
- 128) / 256;
25121 yoff
= font_height
* (yoff
- 128) / 256;
25124 + grefx
* (rightmost
- leftmost
) / 2
25125 - nrefx
* width
/ 2
25128 btm
= ((grefy
== 0 ? highest
25130 : grefy
== 2 ? lowest
25131 : (highest
+ lowest
) / 2)
25132 - (nrefy
== 0 ? ascent
+ descent
25133 : nrefy
== 1 ? descent
- boff
25135 : (ascent
+ descent
) / 2)
25139 cmp
->offsets
[i
* 2] = left
;
25140 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
25142 /* Update the bounding box of the overall glyphs. */
25145 right
= left
+ width
;
25146 if (left
< leftmost
)
25148 if (right
> rightmost
)
25151 top
= btm
+ descent
+ ascent
;
25157 if (cmp
->lbearing
> left
+ lbearing
)
25158 cmp
->lbearing
= left
+ lbearing
;
25159 if (cmp
->rbearing
< left
+ rbearing
)
25160 cmp
->rbearing
= left
+ rbearing
;
25164 /* If there are glyphs whose x-offsets are negative,
25165 shift all glyphs to the right and make all x-offsets
25169 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25170 cmp
->offsets
[i
* 2] -= leftmost
;
25171 rightmost
-= leftmost
;
25172 cmp
->lbearing
-= leftmost
;
25173 cmp
->rbearing
-= leftmost
;
25176 if (left_padded
&& cmp
->lbearing
< 0)
25178 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25179 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
25180 rightmost
-= cmp
->lbearing
;
25181 cmp
->rbearing
-= cmp
->lbearing
;
25184 if (right_padded
&& rightmost
< cmp
->rbearing
)
25186 rightmost
= cmp
->rbearing
;
25189 cmp
->pixel_width
= rightmost
;
25190 cmp
->ascent
= highest
;
25191 cmp
->descent
= - lowest
;
25192 if (cmp
->ascent
< font_ascent
)
25193 cmp
->ascent
= font_ascent
;
25194 if (cmp
->descent
< font_descent
)
25195 cmp
->descent
= font_descent
;
25199 && (cmp
->lbearing
< 0
25200 || cmp
->rbearing
> cmp
->pixel_width
))
25201 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25203 it
->pixel_width
= cmp
->pixel_width
;
25204 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
25205 it
->descent
= it
->phys_descent
= cmp
->descent
;
25206 if (face
->box
!= FACE_NO_BOX
)
25208 int thick
= face
->box_line_width
;
25212 it
->ascent
+= thick
;
25213 it
->descent
+= thick
;
25218 if (it
->start_of_box_run_p
)
25219 it
->pixel_width
+= thick
;
25220 if (it
->end_of_box_run_p
)
25221 it
->pixel_width
+= thick
;
25224 /* If face has an overline, add the height of the overline
25225 (1 pixel) and a 1 pixel margin to the character height. */
25226 if (face
->overline_p
)
25227 it
->ascent
+= overline_margin
;
25229 take_vertical_position_into_account (it
);
25230 if (it
->ascent
< 0)
25232 if (it
->descent
< 0)
25235 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
25236 append_composite_glyph (it
);
25238 else if (it
->what
== IT_COMPOSITION
)
25240 /* A dynamic (automatic) composition. */
25241 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25242 Lisp_Object gstring
;
25243 struct font_metrics metrics
;
25247 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
25249 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
25252 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
25253 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25254 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
25255 it
->descent
= it
->phys_descent
= metrics
.descent
;
25256 if (face
->box
!= FACE_NO_BOX
)
25258 int thick
= face
->box_line_width
;
25262 it
->ascent
+= thick
;
25263 it
->descent
+= thick
;
25268 if (it
->start_of_box_run_p
)
25269 it
->pixel_width
+= thick
;
25270 if (it
->end_of_box_run_p
)
25271 it
->pixel_width
+= thick
;
25273 /* If face has an overline, add the height of the overline
25274 (1 pixel) and a 1 pixel margin to the character height. */
25275 if (face
->overline_p
)
25276 it
->ascent
+= overline_margin
;
25277 take_vertical_position_into_account (it
);
25278 if (it
->ascent
< 0)
25280 if (it
->descent
< 0)
25284 append_composite_glyph (it
);
25286 else if (it
->what
== IT_GLYPHLESS
)
25287 produce_glyphless_glyph (it
, 0, Qnil
);
25288 else if (it
->what
== IT_IMAGE
)
25289 produce_image_glyph (it
);
25290 else if (it
->what
== IT_STRETCH
)
25291 produce_stretch_glyph (it
);
25294 /* Accumulate dimensions. Note: can't assume that it->descent > 0
25295 because this isn't true for images with `:ascent 100'. */
25296 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
25297 if (it
->area
== TEXT_AREA
)
25298 it
->current_x
+= it
->pixel_width
;
25300 if (extra_line_spacing
> 0)
25302 it
->descent
+= extra_line_spacing
;
25303 if (extra_line_spacing
> it
->max_extra_line_spacing
)
25304 it
->max_extra_line_spacing
= extra_line_spacing
;
25307 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
25308 it
->max_descent
= max (it
->max_descent
, it
->descent
);
25309 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
25310 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
25314 Output LEN glyphs starting at START at the nominal cursor position.
25315 Advance the nominal cursor over the text. The global variable
25316 updated_window contains the window being updated, updated_row is
25317 the glyph row being updated, and updated_area is the area of that
25318 row being updated. */
25321 x_write_glyphs (struct glyph
*start
, int len
)
25323 int x
, hpos
, chpos
= updated_window
->phys_cursor
.hpos
;
25325 eassert (updated_window
&& updated_row
);
25326 /* When the window is hscrolled, cursor hpos can legitimately be out
25327 of bounds, but we draw the cursor at the corresponding window
25328 margin in that case. */
25329 if (!updated_row
->reversed_p
&& chpos
< 0)
25331 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
25332 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
25336 /* Write glyphs. */
25338 hpos
= start
- updated_row
->glyphs
[updated_area
];
25339 x
= draw_glyphs (updated_window
, output_cursor
.x
,
25340 updated_row
, updated_area
,
25342 DRAW_NORMAL_TEXT
, 0);
25344 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
25345 if (updated_area
== TEXT_AREA
25346 && updated_window
->phys_cursor_on_p
25347 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
25349 && chpos
< hpos
+ len
)
25350 updated_window
->phys_cursor_on_p
= 0;
25354 /* Advance the output cursor. */
25355 output_cursor
.hpos
+= len
;
25356 output_cursor
.x
= x
;
25361 Insert LEN glyphs from START at the nominal cursor position. */
25364 x_insert_glyphs (struct glyph
*start
, int len
)
25368 int line_height
, shift_by_width
, shifted_region_width
;
25369 struct glyph_row
*row
;
25370 struct glyph
*glyph
;
25371 int frame_x
, frame_y
;
25374 eassert (updated_window
&& updated_row
);
25376 w
= updated_window
;
25377 f
= XFRAME (WINDOW_FRAME (w
));
25379 /* Get the height of the line we are in. */
25381 line_height
= row
->height
;
25383 /* Get the width of the glyphs to insert. */
25384 shift_by_width
= 0;
25385 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
25386 shift_by_width
+= glyph
->pixel_width
;
25388 /* Get the width of the region to shift right. */
25389 shifted_region_width
= (window_box_width (w
, updated_area
)
25394 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
25395 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
25397 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
25398 line_height
, shift_by_width
);
25400 /* Write the glyphs. */
25401 hpos
= start
- row
->glyphs
[updated_area
];
25402 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
25404 DRAW_NORMAL_TEXT
, 0);
25406 /* Advance the output cursor. */
25407 output_cursor
.hpos
+= len
;
25408 output_cursor
.x
+= shift_by_width
;
25414 Erase the current text line from the nominal cursor position
25415 (inclusive) to pixel column TO_X (exclusive). The idea is that
25416 everything from TO_X onward is already erased.
25418 TO_X is a pixel position relative to updated_area of
25419 updated_window. TO_X == -1 means clear to the end of this area. */
25422 x_clear_end_of_line (int to_x
)
25425 struct window
*w
= updated_window
;
25426 int max_x
, min_y
, max_y
;
25427 int from_x
, from_y
, to_y
;
25429 eassert (updated_window
&& updated_row
);
25430 f
= XFRAME (w
->frame
);
25432 if (updated_row
->full_width_p
)
25433 max_x
= WINDOW_TOTAL_WIDTH (w
);
25435 max_x
= window_box_width (w
, updated_area
);
25436 max_y
= window_text_bottom_y (w
);
25438 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
25439 of window. For TO_X > 0, truncate to end of drawing area. */
25445 to_x
= min (to_x
, max_x
);
25447 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
25449 /* Notice if the cursor will be cleared by this operation. */
25450 if (!updated_row
->full_width_p
)
25451 notice_overwritten_cursor (w
, updated_area
,
25452 output_cursor
.x
, -1,
25454 MATRIX_ROW_BOTTOM_Y (updated_row
));
25456 from_x
= output_cursor
.x
;
25458 /* Translate to frame coordinates. */
25459 if (updated_row
->full_width_p
)
25461 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
25462 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
25466 int area_left
= window_box_left (w
, updated_area
);
25467 from_x
+= area_left
;
25471 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
25472 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
25473 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
25475 /* Prevent inadvertently clearing to end of the X window. */
25476 if (to_x
> from_x
&& to_y
> from_y
)
25479 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
25480 to_x
- from_x
, to_y
- from_y
);
25485 #endif /* HAVE_WINDOW_SYSTEM */
25489 /***********************************************************************
25491 ***********************************************************************/
25493 /* Value is the internal representation of the specified cursor type
25494 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
25495 of the bar cursor. */
25497 static enum text_cursor_kinds
25498 get_specified_cursor_type (Lisp_Object arg
, int *width
)
25500 enum text_cursor_kinds type
;
25505 if (EQ (arg
, Qbox
))
25506 return FILLED_BOX_CURSOR
;
25508 if (EQ (arg
, Qhollow
))
25509 return HOLLOW_BOX_CURSOR
;
25511 if (EQ (arg
, Qbar
))
25518 && EQ (XCAR (arg
), Qbar
)
25519 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25521 *width
= XINT (XCDR (arg
));
25525 if (EQ (arg
, Qhbar
))
25528 return HBAR_CURSOR
;
25532 && EQ (XCAR (arg
), Qhbar
)
25533 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25535 *width
= XINT (XCDR (arg
));
25536 return HBAR_CURSOR
;
25539 /* Treat anything unknown as "hollow box cursor".
25540 It was bad to signal an error; people have trouble fixing
25541 .Xdefaults with Emacs, when it has something bad in it. */
25542 type
= HOLLOW_BOX_CURSOR
;
25547 /* Set the default cursor types for specified frame. */
25549 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
25554 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
25555 FRAME_CURSOR_WIDTH (f
) = width
;
25557 /* By default, set up the blink-off state depending on the on-state. */
25559 tem
= Fassoc (arg
, Vblink_cursor_alist
);
25562 FRAME_BLINK_OFF_CURSOR (f
)
25563 = get_specified_cursor_type (XCDR (tem
), &width
);
25564 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
25567 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
25571 #ifdef HAVE_WINDOW_SYSTEM
25573 /* Return the cursor we want to be displayed in window W. Return
25574 width of bar/hbar cursor through WIDTH arg. Return with
25575 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
25576 (i.e. if the `system caret' should track this cursor).
25578 In a mini-buffer window, we want the cursor only to appear if we
25579 are reading input from this window. For the selected window, we
25580 want the cursor type given by the frame parameter or buffer local
25581 setting of cursor-type. If explicitly marked off, draw no cursor.
25582 In all other cases, we want a hollow box cursor. */
25584 static enum text_cursor_kinds
25585 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
25586 int *active_cursor
)
25588 struct frame
*f
= XFRAME (w
->frame
);
25589 struct buffer
*b
= XBUFFER (w
->buffer
);
25590 int cursor_type
= DEFAULT_CURSOR
;
25591 Lisp_Object alt_cursor
;
25592 int non_selected
= 0;
25594 *active_cursor
= 1;
25597 if (cursor_in_echo_area
25598 && FRAME_HAS_MINIBUF_P (f
)
25599 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
25601 if (w
== XWINDOW (echo_area_window
))
25603 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
25605 *width
= FRAME_CURSOR_WIDTH (f
);
25606 return FRAME_DESIRED_CURSOR (f
);
25609 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25612 *active_cursor
= 0;
25616 /* Detect a nonselected window or nonselected frame. */
25617 else if (w
!= XWINDOW (f
->selected_window
)
25618 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
25620 *active_cursor
= 0;
25622 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
25628 /* Never display a cursor in a window in which cursor-type is nil. */
25629 if (NILP (BVAR (b
, cursor_type
)))
25632 /* Get the normal cursor type for this window. */
25633 if (EQ (BVAR (b
, cursor_type
), Qt
))
25635 cursor_type
= FRAME_DESIRED_CURSOR (f
);
25636 *width
= FRAME_CURSOR_WIDTH (f
);
25639 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25641 /* Use cursor-in-non-selected-windows instead
25642 for non-selected window or frame. */
25645 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
25646 if (!EQ (Qt
, alt_cursor
))
25647 return get_specified_cursor_type (alt_cursor
, width
);
25648 /* t means modify the normal cursor type. */
25649 if (cursor_type
== FILLED_BOX_CURSOR
)
25650 cursor_type
= HOLLOW_BOX_CURSOR
;
25651 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
25653 return cursor_type
;
25656 /* Use normal cursor if not blinked off. */
25657 if (!w
->cursor_off_p
)
25659 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25661 if (cursor_type
== FILLED_BOX_CURSOR
)
25663 /* Using a block cursor on large images can be very annoying.
25664 So use a hollow cursor for "large" images.
25665 If image is not transparent (no mask), also use hollow cursor. */
25666 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25667 if (img
!= NULL
&& IMAGEP (img
->spec
))
25669 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
25670 where N = size of default frame font size.
25671 This should cover most of the "tiny" icons people may use. */
25673 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
25674 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
25675 cursor_type
= HOLLOW_BOX_CURSOR
;
25678 else if (cursor_type
!= NO_CURSOR
)
25680 /* Display current only supports BOX and HOLLOW cursors for images.
25681 So for now, unconditionally use a HOLLOW cursor when cursor is
25682 not a solid box cursor. */
25683 cursor_type
= HOLLOW_BOX_CURSOR
;
25686 return cursor_type
;
25689 /* Cursor is blinked off, so determine how to "toggle" it. */
25691 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
25692 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
25693 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
25695 /* Then see if frame has specified a specific blink off cursor type. */
25696 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
25698 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
25699 return FRAME_BLINK_OFF_CURSOR (f
);
25703 /* Some people liked having a permanently visible blinking cursor,
25704 while others had very strong opinions against it. So it was
25705 decided to remove it. KFS 2003-09-03 */
25707 /* Finally perform built-in cursor blinking:
25708 filled box <-> hollow box
25709 wide [h]bar <-> narrow [h]bar
25710 narrow [h]bar <-> no cursor
25711 other type <-> no cursor */
25713 if (cursor_type
== FILLED_BOX_CURSOR
)
25714 return HOLLOW_BOX_CURSOR
;
25716 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
25719 return cursor_type
;
25727 /* Notice when the text cursor of window W has been completely
25728 overwritten by a drawing operation that outputs glyphs in AREA
25729 starting at X0 and ending at X1 in the line starting at Y0 and
25730 ending at Y1. X coordinates are area-relative. X1 < 0 means all
25731 the rest of the line after X0 has been written. Y coordinates
25732 are window-relative. */
25735 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
25736 int x0
, int x1
, int y0
, int y1
)
25738 int cx0
, cx1
, cy0
, cy1
;
25739 struct glyph_row
*row
;
25741 if (!w
->phys_cursor_on_p
)
25743 if (area
!= TEXT_AREA
)
25746 if (w
->phys_cursor
.vpos
< 0
25747 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
25748 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
25749 !(row
->enabled_p
&& row
->displays_text_p
)))
25752 if (row
->cursor_in_fringe_p
)
25754 row
->cursor_in_fringe_p
= 0;
25755 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
25756 w
->phys_cursor_on_p
= 0;
25760 cx0
= w
->phys_cursor
.x
;
25761 cx1
= cx0
+ w
->phys_cursor_width
;
25762 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
25765 /* The cursor image will be completely removed from the
25766 screen if the output area intersects the cursor area in
25767 y-direction. When we draw in [y0 y1[, and some part of
25768 the cursor is at y < y0, that part must have been drawn
25769 before. When scrolling, the cursor is erased before
25770 actually scrolling, so we don't come here. When not
25771 scrolling, the rows above the old cursor row must have
25772 changed, and in this case these rows must have written
25773 over the cursor image.
25775 Likewise if part of the cursor is below y1, with the
25776 exception of the cursor being in the first blank row at
25777 the buffer and window end because update_text_area
25778 doesn't draw that row. (Except when it does, but
25779 that's handled in update_text_area.) */
25781 cy0
= w
->phys_cursor
.y
;
25782 cy1
= cy0
+ w
->phys_cursor_height
;
25783 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
25786 w
->phys_cursor_on_p
= 0;
25789 #endif /* HAVE_WINDOW_SYSTEM */
25792 /************************************************************************
25794 ************************************************************************/
25796 #ifdef HAVE_WINDOW_SYSTEM
25799 Fix the display of area AREA of overlapping row ROW in window W
25800 with respect to the overlapping part OVERLAPS. */
25803 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
25804 enum glyph_row_area area
, int overlaps
)
25811 for (i
= 0; i
< row
->used
[area
];)
25813 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
25815 int start
= i
, start_x
= x
;
25819 x
+= row
->glyphs
[area
][i
].pixel_width
;
25822 while (i
< row
->used
[area
]
25823 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
25825 draw_glyphs (w
, start_x
, row
, area
,
25827 DRAW_NORMAL_TEXT
, overlaps
);
25831 x
+= row
->glyphs
[area
][i
].pixel_width
;
25841 Draw the cursor glyph of window W in glyph row ROW. See the
25842 comment of draw_glyphs for the meaning of HL. */
25845 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
25846 enum draw_glyphs_face hl
)
25848 /* If cursor hpos is out of bounds, don't draw garbage. This can
25849 happen in mini-buffer windows when switching between echo area
25850 glyphs and mini-buffer. */
25851 if ((row
->reversed_p
25852 ? (w
->phys_cursor
.hpos
>= 0)
25853 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
25855 int on_p
= w
->phys_cursor_on_p
;
25857 int hpos
= w
->phys_cursor
.hpos
;
25859 /* When the window is hscrolled, cursor hpos can legitimately be
25860 out of bounds, but we draw the cursor at the corresponding
25861 window margin in that case. */
25862 if (!row
->reversed_p
&& hpos
< 0)
25864 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25865 hpos
= row
->used
[TEXT_AREA
] - 1;
25867 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
25869 w
->phys_cursor_on_p
= on_p
;
25871 if (hl
== DRAW_CURSOR
)
25872 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25873 /* When we erase the cursor, and ROW is overlapped by other
25874 rows, make sure that these overlapping parts of other rows
25876 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
25878 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25880 if (row
> w
->current_matrix
->rows
25881 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
25882 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
25883 OVERLAPS_ERASED_CURSOR
);
25885 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
25886 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
25887 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
25888 OVERLAPS_ERASED_CURSOR
);
25895 Erase the image of a cursor of window W from the screen. */
25898 erase_phys_cursor (struct window
*w
)
25900 struct frame
*f
= XFRAME (w
->frame
);
25901 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25902 int hpos
= w
->phys_cursor
.hpos
;
25903 int vpos
= w
->phys_cursor
.vpos
;
25904 int mouse_face_here_p
= 0;
25905 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
25906 struct glyph_row
*cursor_row
;
25907 struct glyph
*cursor_glyph
;
25908 enum draw_glyphs_face hl
;
25910 /* No cursor displayed or row invalidated => nothing to do on the
25912 if (w
->phys_cursor_type
== NO_CURSOR
)
25913 goto mark_cursor_off
;
25915 /* VPOS >= active_glyphs->nrows means that window has been resized.
25916 Don't bother to erase the cursor. */
25917 if (vpos
>= active_glyphs
->nrows
)
25918 goto mark_cursor_off
;
25920 /* If row containing cursor is marked invalid, there is nothing we
25922 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
25923 if (!cursor_row
->enabled_p
)
25924 goto mark_cursor_off
;
25926 /* If line spacing is > 0, old cursor may only be partially visible in
25927 window after split-window. So adjust visible height. */
25928 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
25929 window_text_bottom_y (w
) - cursor_row
->y
);
25931 /* If row is completely invisible, don't attempt to delete a cursor which
25932 isn't there. This can happen if cursor is at top of a window, and
25933 we switch to a buffer with a header line in that window. */
25934 if (cursor_row
->visible_height
<= 0)
25935 goto mark_cursor_off
;
25937 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
25938 if (cursor_row
->cursor_in_fringe_p
)
25940 cursor_row
->cursor_in_fringe_p
= 0;
25941 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
25942 goto mark_cursor_off
;
25945 /* This can happen when the new row is shorter than the old one.
25946 In this case, either draw_glyphs or clear_end_of_line
25947 should have cleared the cursor. Note that we wouldn't be
25948 able to erase the cursor in this case because we don't have a
25949 cursor glyph at hand. */
25950 if ((cursor_row
->reversed_p
25951 ? (w
->phys_cursor
.hpos
< 0)
25952 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
25953 goto mark_cursor_off
;
25955 /* When the window is hscrolled, cursor hpos can legitimately be out
25956 of bounds, but we draw the cursor at the corresponding window
25957 margin in that case. */
25958 if (!cursor_row
->reversed_p
&& hpos
< 0)
25960 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
25961 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
25963 /* If the cursor is in the mouse face area, redisplay that when
25964 we clear the cursor. */
25965 if (! NILP (hlinfo
->mouse_face_window
)
25966 && coords_in_mouse_face_p (w
, hpos
, vpos
)
25967 /* Don't redraw the cursor's spot in mouse face if it is at the
25968 end of a line (on a newline). The cursor appears there, but
25969 mouse highlighting does not. */
25970 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
25971 mouse_face_here_p
= 1;
25973 /* Maybe clear the display under the cursor. */
25974 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
25977 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
25980 cursor_glyph
= get_phys_cursor_glyph (w
);
25981 if (cursor_glyph
== NULL
)
25982 goto mark_cursor_off
;
25984 width
= cursor_glyph
->pixel_width
;
25985 left_x
= window_box_left_offset (w
, TEXT_AREA
);
25986 x
= w
->phys_cursor
.x
;
25988 width
-= left_x
- x
;
25989 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
25990 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
25991 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
25994 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
25997 /* Erase the cursor by redrawing the character underneath it. */
25998 if (mouse_face_here_p
)
25999 hl
= DRAW_MOUSE_FACE
;
26001 hl
= DRAW_NORMAL_TEXT
;
26002 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
26005 w
->phys_cursor_on_p
= 0;
26006 w
->phys_cursor_type
= NO_CURSOR
;
26011 Display or clear cursor of window W. If ON is zero, clear the
26012 cursor. If it is non-zero, display the cursor. If ON is nonzero,
26013 where to put the cursor is specified by HPOS, VPOS, X and Y. */
26016 display_and_set_cursor (struct window
*w
, int on
,
26017 int hpos
, int vpos
, int x
, int y
)
26019 struct frame
*f
= XFRAME (w
->frame
);
26020 int new_cursor_type
;
26021 int new_cursor_width
;
26023 struct glyph_row
*glyph_row
;
26024 struct glyph
*glyph
;
26026 /* This is pointless on invisible frames, and dangerous on garbaged
26027 windows and frames; in the latter case, the frame or window may
26028 be in the midst of changing its size, and x and y may be off the
26030 if (! FRAME_VISIBLE_P (f
)
26031 || FRAME_GARBAGED_P (f
)
26032 || vpos
>= w
->current_matrix
->nrows
26033 || hpos
>= w
->current_matrix
->matrix_w
)
26036 /* If cursor is off and we want it off, return quickly. */
26037 if (!on
&& !w
->phys_cursor_on_p
)
26040 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26041 /* If cursor row is not enabled, we don't really know where to
26042 display the cursor. */
26043 if (!glyph_row
->enabled_p
)
26045 w
->phys_cursor_on_p
= 0;
26050 if (!glyph_row
->exact_window_width_line_p
26051 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
26052 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
26054 eassert (input_blocked_p ());
26056 /* Set new_cursor_type to the cursor we want to be displayed. */
26057 new_cursor_type
= get_window_cursor_type (w
, glyph
,
26058 &new_cursor_width
, &active_cursor
);
26060 /* If cursor is currently being shown and we don't want it to be or
26061 it is in the wrong place, or the cursor type is not what we want,
26063 if (w
->phys_cursor_on_p
26065 || w
->phys_cursor
.x
!= x
26066 || w
->phys_cursor
.y
!= y
26067 || new_cursor_type
!= w
->phys_cursor_type
26068 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
26069 && new_cursor_width
!= w
->phys_cursor_width
)))
26070 erase_phys_cursor (w
);
26072 /* Don't check phys_cursor_on_p here because that flag is only set
26073 to zero in some cases where we know that the cursor has been
26074 completely erased, to avoid the extra work of erasing the cursor
26075 twice. In other words, phys_cursor_on_p can be 1 and the cursor
26076 still not be visible, or it has only been partly erased. */
26079 w
->phys_cursor_ascent
= glyph_row
->ascent
;
26080 w
->phys_cursor_height
= glyph_row
->height
;
26082 /* Set phys_cursor_.* before x_draw_.* is called because some
26083 of them may need the information. */
26084 w
->phys_cursor
.x
= x
;
26085 w
->phys_cursor
.y
= glyph_row
->y
;
26086 w
->phys_cursor
.hpos
= hpos
;
26087 w
->phys_cursor
.vpos
= vpos
;
26090 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
26091 new_cursor_type
, new_cursor_width
,
26092 on
, active_cursor
);
26096 /* Switch the display of W's cursor on or off, according to the value
26100 update_window_cursor (struct window
*w
, int on
)
26102 /* Don't update cursor in windows whose frame is in the process
26103 of being deleted. */
26104 if (w
->current_matrix
)
26106 int hpos
= w
->phys_cursor
.hpos
;
26107 int vpos
= w
->phys_cursor
.vpos
;
26108 struct glyph_row
*row
;
26110 if (vpos
>= w
->current_matrix
->nrows
26111 || hpos
>= w
->current_matrix
->matrix_w
)
26114 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26116 /* When the window is hscrolled, cursor hpos can legitimately be
26117 out of bounds, but we draw the cursor at the corresponding
26118 window margin in that case. */
26119 if (!row
->reversed_p
&& hpos
< 0)
26121 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26122 hpos
= row
->used
[TEXT_AREA
] - 1;
26125 display_and_set_cursor (w
, on
, hpos
, vpos
,
26126 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26132 /* Call update_window_cursor with parameter ON_P on all leaf windows
26133 in the window tree rooted at W. */
26136 update_cursor_in_window_tree (struct window
*w
, int on_p
)
26140 if (!NILP (w
->hchild
))
26141 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
26142 else if (!NILP (w
->vchild
))
26143 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
26145 update_window_cursor (w
, on_p
);
26147 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
26153 Display the cursor on window W, or clear it, according to ON_P.
26154 Don't change the cursor's position. */
26157 x_update_cursor (struct frame
*f
, int on_p
)
26159 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
26164 Clear the cursor of window W to background color, and mark the
26165 cursor as not shown. This is used when the text where the cursor
26166 is about to be rewritten. */
26169 x_clear_cursor (struct window
*w
)
26171 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
26172 update_window_cursor (w
, 0);
26175 #endif /* HAVE_WINDOW_SYSTEM */
26177 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
26180 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
26181 int start_hpos
, int end_hpos
,
26182 enum draw_glyphs_face draw
)
26184 #ifdef HAVE_WINDOW_SYSTEM
26185 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
26187 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
26191 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
26192 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
26196 /* Display the active region described by mouse_face_* according to DRAW. */
26199 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
26201 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
26202 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26204 if (/* If window is in the process of being destroyed, don't bother
26206 w
->current_matrix
!= NULL
26207 /* Don't update mouse highlight if hidden */
26208 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
26209 /* Recognize when we are called to operate on rows that don't exist
26210 anymore. This can happen when a window is split. */
26211 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
26213 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
26214 struct glyph_row
*row
, *first
, *last
;
26216 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
26217 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
26219 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
26221 int start_hpos
, end_hpos
, start_x
;
26223 /* For all but the first row, the highlight starts at column 0. */
26226 /* R2L rows have BEG and END in reversed order, but the
26227 screen drawing geometry is always left to right. So
26228 we need to mirror the beginning and end of the
26229 highlighted area in R2L rows. */
26230 if (!row
->reversed_p
)
26232 start_hpos
= hlinfo
->mouse_face_beg_col
;
26233 start_x
= hlinfo
->mouse_face_beg_x
;
26235 else if (row
== last
)
26237 start_hpos
= hlinfo
->mouse_face_end_col
;
26238 start_x
= hlinfo
->mouse_face_end_x
;
26246 else if (row
->reversed_p
&& row
== last
)
26248 start_hpos
= hlinfo
->mouse_face_end_col
;
26249 start_x
= hlinfo
->mouse_face_end_x
;
26259 if (!row
->reversed_p
)
26260 end_hpos
= hlinfo
->mouse_face_end_col
;
26261 else if (row
== first
)
26262 end_hpos
= hlinfo
->mouse_face_beg_col
;
26265 end_hpos
= row
->used
[TEXT_AREA
];
26266 if (draw
== DRAW_NORMAL_TEXT
)
26267 row
->fill_line_p
= 1; /* Clear to end of line */
26270 else if (row
->reversed_p
&& row
== first
)
26271 end_hpos
= hlinfo
->mouse_face_beg_col
;
26274 end_hpos
= row
->used
[TEXT_AREA
];
26275 if (draw
== DRAW_NORMAL_TEXT
)
26276 row
->fill_line_p
= 1; /* Clear to end of line */
26279 if (end_hpos
> start_hpos
)
26281 draw_row_with_mouse_face (w
, start_x
, row
,
26282 start_hpos
, end_hpos
, draw
);
26285 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
26289 #ifdef HAVE_WINDOW_SYSTEM
26290 /* When we've written over the cursor, arrange for it to
26291 be displayed again. */
26292 if (FRAME_WINDOW_P (f
)
26293 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
26295 int hpos
= w
->phys_cursor
.hpos
;
26297 /* When the window is hscrolled, cursor hpos can legitimately be
26298 out of bounds, but we draw the cursor at the corresponding
26299 window margin in that case. */
26300 if (!row
->reversed_p
&& hpos
< 0)
26302 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26303 hpos
= row
->used
[TEXT_AREA
] - 1;
26306 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
26307 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26310 #endif /* HAVE_WINDOW_SYSTEM */
26313 #ifdef HAVE_WINDOW_SYSTEM
26314 /* Change the mouse cursor. */
26315 if (FRAME_WINDOW_P (f
))
26317 if (draw
== DRAW_NORMAL_TEXT
26318 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
26319 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
26320 else if (draw
== DRAW_MOUSE_FACE
)
26321 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
26323 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
26325 #endif /* HAVE_WINDOW_SYSTEM */
26329 Clear out the mouse-highlighted active region.
26330 Redraw it un-highlighted first. Value is non-zero if mouse
26331 face was actually drawn unhighlighted. */
26334 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
26338 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
26340 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
26344 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
26345 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
26346 hlinfo
->mouse_face_window
= Qnil
;
26347 hlinfo
->mouse_face_overlay
= Qnil
;
26351 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
26352 within the mouse face on that window. */
26354 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
26356 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26358 /* Quickly resolve the easy cases. */
26359 if (!(WINDOWP (hlinfo
->mouse_face_window
)
26360 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
26362 if (vpos
< hlinfo
->mouse_face_beg_row
26363 || vpos
> hlinfo
->mouse_face_end_row
)
26365 if (vpos
> hlinfo
->mouse_face_beg_row
26366 && vpos
< hlinfo
->mouse_face_end_row
)
26369 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
26371 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26373 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
26376 else if ((vpos
== hlinfo
->mouse_face_beg_row
26377 && hpos
>= hlinfo
->mouse_face_beg_col
)
26378 || (vpos
== hlinfo
->mouse_face_end_row
26379 && hpos
< hlinfo
->mouse_face_end_col
))
26384 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26386 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
26389 else if ((vpos
== hlinfo
->mouse_face_beg_row
26390 && hpos
<= hlinfo
->mouse_face_beg_col
)
26391 || (vpos
== hlinfo
->mouse_face_end_row
26392 && hpos
> hlinfo
->mouse_face_end_col
))
26400 Non-zero if physical cursor of window W is within mouse face. */
26403 cursor_in_mouse_face_p (struct window
*w
)
26405 int hpos
= w
->phys_cursor
.hpos
;
26406 int vpos
= w
->phys_cursor
.vpos
;
26407 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26409 /* When the window is hscrolled, cursor hpos can legitimately be out
26410 of bounds, but we draw the cursor at the corresponding window
26411 margin in that case. */
26412 if (!row
->reversed_p
&& hpos
< 0)
26414 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26415 hpos
= row
->used
[TEXT_AREA
] - 1;
26417 return coords_in_mouse_face_p (w
, hpos
, vpos
);
26422 /* Find the glyph rows START_ROW and END_ROW of window W that display
26423 characters between buffer positions START_CHARPOS and END_CHARPOS
26424 (excluding END_CHARPOS). DISP_STRING is a display string that
26425 covers these buffer positions. This is similar to
26426 row_containing_pos, but is more accurate when bidi reordering makes
26427 buffer positions change non-linearly with glyph rows. */
26429 rows_from_pos_range (struct window
*w
,
26430 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
26431 Lisp_Object disp_string
,
26432 struct glyph_row
**start
, struct glyph_row
**end
)
26434 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26435 int last_y
= window_text_bottom_y (w
);
26436 struct glyph_row
*row
;
26441 while (!first
->enabled_p
26442 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
26445 /* Find the START row. */
26447 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
26450 /* A row can potentially be the START row if the range of the
26451 characters it displays intersects the range
26452 [START_CHARPOS..END_CHARPOS). */
26453 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
26454 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
26455 /* See the commentary in row_containing_pos, for the
26456 explanation of the complicated way to check whether
26457 some position is beyond the end of the characters
26458 displayed by a row. */
26459 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26460 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26461 && !row
->ends_at_zv_p
26462 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
26463 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26464 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26465 && !row
->ends_at_zv_p
26466 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
26468 /* Found a candidate row. Now make sure at least one of the
26469 glyphs it displays has a charpos from the range
26470 [START_CHARPOS..END_CHARPOS).
26472 This is not obvious because bidi reordering could make
26473 buffer positions of a row be 1,2,3,102,101,100, and if we
26474 want to highlight characters in [50..60), we don't want
26475 this row, even though [50..60) does intersect [1..103),
26476 the range of character positions given by the row's start
26477 and end positions. */
26478 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
26479 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
26483 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26484 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26485 /* A glyph that comes from DISP_STRING is by
26486 definition to be highlighted. */
26487 || EQ (g
->object
, disp_string
))
26496 /* Find the END row. */
26498 /* If the last row is partially visible, start looking for END
26499 from that row, instead of starting from FIRST. */
26500 && !(row
->enabled_p
26501 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
26503 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
26505 struct glyph_row
*next
= row
+ 1;
26506 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
26508 if (!next
->enabled_p
26509 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
26510 /* The first row >= START whose range of displayed characters
26511 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
26512 is the row END + 1. */
26513 || (start_charpos
< next_start
26514 && end_charpos
< next_start
)
26515 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26516 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26517 && !next
->ends_at_zv_p
26518 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
26519 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26520 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26521 && !next
->ends_at_zv_p
26522 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
26529 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
26530 but none of the characters it displays are in the range, it is
26532 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
26533 struct glyph
*s
= g
;
26534 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
26538 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26539 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26540 /* If the buffer position of the first glyph in
26541 the row is equal to END_CHARPOS, it means
26542 the last character to be highlighted is the
26543 newline of ROW, and we must consider NEXT as
26545 || (((!next
->reversed_p
&& g
== s
)
26546 || (next
->reversed_p
&& g
== e
- 1))
26547 && (g
->charpos
== end_charpos
26548 /* Special case for when NEXT is an
26549 empty line at ZV. */
26550 || (g
->charpos
== -1
26551 && !row
->ends_at_zv_p
26552 && next_start
== end_charpos
)))))
26553 /* A glyph that comes from DISP_STRING is by
26554 definition to be highlighted. */
26555 || EQ (g
->object
, disp_string
))
26564 /* The first row that ends at ZV must be the last to be
26566 else if (next
->ends_at_zv_p
)
26575 /* This function sets the mouse_face_* elements of HLINFO, assuming
26576 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
26577 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
26578 for the overlay or run of text properties specifying the mouse
26579 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
26580 before-string and after-string that must also be highlighted.
26581 DISP_STRING, if non-nil, is a display string that may cover some
26582 or all of the highlighted text. */
26585 mouse_face_from_buffer_pos (Lisp_Object window
,
26586 Mouse_HLInfo
*hlinfo
,
26587 ptrdiff_t mouse_charpos
,
26588 ptrdiff_t start_charpos
,
26589 ptrdiff_t end_charpos
,
26590 Lisp_Object before_string
,
26591 Lisp_Object after_string
,
26592 Lisp_Object disp_string
)
26594 struct window
*w
= XWINDOW (window
);
26595 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26596 struct glyph_row
*r1
, *r2
;
26597 struct glyph
*glyph
, *end
;
26598 ptrdiff_t ignore
, pos
;
26601 eassert (NILP (disp_string
) || STRINGP (disp_string
));
26602 eassert (NILP (before_string
) || STRINGP (before_string
));
26603 eassert (NILP (after_string
) || STRINGP (after_string
));
26605 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
26606 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
26608 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26609 /* If the before-string or display-string contains newlines,
26610 rows_from_pos_range skips to its last row. Move back. */
26611 if (!NILP (before_string
) || !NILP (disp_string
))
26613 struct glyph_row
*prev
;
26614 while ((prev
= r1
- 1, prev
>= first
)
26615 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
26616 && prev
->used
[TEXT_AREA
] > 0)
26618 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
26619 glyph
= beg
+ prev
->used
[TEXT_AREA
];
26620 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
26622 || !(EQ (glyph
->object
, before_string
)
26623 || EQ (glyph
->object
, disp_string
)))
26630 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26631 hlinfo
->mouse_face_past_end
= 1;
26633 else if (!NILP (after_string
))
26635 /* If the after-string has newlines, advance to its last row. */
26636 struct glyph_row
*next
;
26637 struct glyph_row
*last
26638 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26640 for (next
= r2
+ 1;
26642 && next
->used
[TEXT_AREA
] > 0
26643 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
26647 /* The rest of the display engine assumes that mouse_face_beg_row is
26648 either above mouse_face_end_row or identical to it. But with
26649 bidi-reordered continued lines, the row for START_CHARPOS could
26650 be below the row for END_CHARPOS. If so, swap the rows and store
26651 them in correct order. */
26654 struct glyph_row
*tem
= r2
;
26660 hlinfo
->mouse_face_beg_y
= r1
->y
;
26661 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
26662 hlinfo
->mouse_face_end_y
= r2
->y
;
26663 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
26665 /* For a bidi-reordered row, the positions of BEFORE_STRING,
26666 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
26667 could be anywhere in the row and in any order. The strategy
26668 below is to find the leftmost and the rightmost glyph that
26669 belongs to either of these 3 strings, or whose position is
26670 between START_CHARPOS and END_CHARPOS, and highlight all the
26671 glyphs between those two. This may cover more than just the text
26672 between START_CHARPOS and END_CHARPOS if the range of characters
26673 strides the bidi level boundary, e.g. if the beginning is in R2L
26674 text while the end is in L2R text or vice versa. */
26675 if (!r1
->reversed_p
)
26677 /* This row is in a left to right paragraph. Scan it left to
26679 glyph
= r1
->glyphs
[TEXT_AREA
];
26680 end
= glyph
+ r1
->used
[TEXT_AREA
];
26683 /* Skip truncation glyphs at the start of the glyph row. */
26684 if (r1
->displays_text_p
)
26686 && INTEGERP (glyph
->object
)
26687 && glyph
->charpos
< 0;
26689 x
+= glyph
->pixel_width
;
26691 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26692 or DISP_STRING, and the first glyph from buffer whose
26693 position is between START_CHARPOS and END_CHARPOS. */
26695 && !INTEGERP (glyph
->object
)
26696 && !EQ (glyph
->object
, disp_string
)
26697 && !(BUFFERP (glyph
->object
)
26698 && (glyph
->charpos
>= start_charpos
26699 && glyph
->charpos
< end_charpos
));
26702 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26703 are present at buffer positions between START_CHARPOS and
26704 END_CHARPOS, or if they come from an overlay. */
26705 if (EQ (glyph
->object
, before_string
))
26707 pos
= string_buffer_position (before_string
,
26709 /* If pos == 0, it means before_string came from an
26710 overlay, not from a buffer position. */
26711 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26714 else if (EQ (glyph
->object
, after_string
))
26716 pos
= string_buffer_position (after_string
, end_charpos
);
26717 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26720 x
+= glyph
->pixel_width
;
26722 hlinfo
->mouse_face_beg_x
= x
;
26723 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26727 /* This row is in a right to left paragraph. Scan it right to
26731 end
= r1
->glyphs
[TEXT_AREA
] - 1;
26732 glyph
= end
+ r1
->used
[TEXT_AREA
];
26734 /* Skip truncation glyphs at the start of the glyph row. */
26735 if (r1
->displays_text_p
)
26737 && INTEGERP (glyph
->object
)
26738 && glyph
->charpos
< 0;
26742 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26743 or DISP_STRING, and the first glyph from buffer whose
26744 position is between START_CHARPOS and END_CHARPOS. */
26746 && !INTEGERP (glyph
->object
)
26747 && !EQ (glyph
->object
, disp_string
)
26748 && !(BUFFERP (glyph
->object
)
26749 && (glyph
->charpos
>= start_charpos
26750 && glyph
->charpos
< end_charpos
));
26753 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26754 are present at buffer positions between START_CHARPOS and
26755 END_CHARPOS, or if they come from an overlay. */
26756 if (EQ (glyph
->object
, before_string
))
26758 pos
= string_buffer_position (before_string
, start_charpos
);
26759 /* If pos == 0, it means before_string came from an
26760 overlay, not from a buffer position. */
26761 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26764 else if (EQ (glyph
->object
, after_string
))
26766 pos
= string_buffer_position (after_string
, end_charpos
);
26767 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26772 glyph
++; /* first glyph to the right of the highlighted area */
26773 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
26774 x
+= g
->pixel_width
;
26775 hlinfo
->mouse_face_beg_x
= x
;
26776 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26779 /* If the highlight ends in a different row, compute GLYPH and END
26780 for the end row. Otherwise, reuse the values computed above for
26781 the row where the highlight begins. */
26784 if (!r2
->reversed_p
)
26786 glyph
= r2
->glyphs
[TEXT_AREA
];
26787 end
= glyph
+ r2
->used
[TEXT_AREA
];
26792 end
= r2
->glyphs
[TEXT_AREA
] - 1;
26793 glyph
= end
+ r2
->used
[TEXT_AREA
];
26797 if (!r2
->reversed_p
)
26799 /* Skip truncation and continuation glyphs near the end of the
26800 row, and also blanks and stretch glyphs inserted by
26801 extend_face_to_end_of_line. */
26803 && INTEGERP ((end
- 1)->object
))
26805 /* Scan the rest of the glyph row from the end, looking for the
26806 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26807 DISP_STRING, or whose position is between START_CHARPOS
26811 && !INTEGERP (end
->object
)
26812 && !EQ (end
->object
, disp_string
)
26813 && !(BUFFERP (end
->object
)
26814 && (end
->charpos
>= start_charpos
26815 && end
->charpos
< end_charpos
));
26818 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26819 are present at buffer positions between START_CHARPOS and
26820 END_CHARPOS, or if they come from an overlay. */
26821 if (EQ (end
->object
, before_string
))
26823 pos
= string_buffer_position (before_string
, start_charpos
);
26824 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26827 else if (EQ (end
->object
, after_string
))
26829 pos
= string_buffer_position (after_string
, end_charpos
);
26830 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26834 /* Find the X coordinate of the last glyph to be highlighted. */
26835 for (; glyph
<= end
; ++glyph
)
26836 x
+= glyph
->pixel_width
;
26838 hlinfo
->mouse_face_end_x
= x
;
26839 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
26843 /* Skip truncation and continuation glyphs near the end of the
26844 row, and also blanks and stretch glyphs inserted by
26845 extend_face_to_end_of_line. */
26849 && INTEGERP (end
->object
))
26851 x
+= end
->pixel_width
;
26854 /* Scan the rest of the glyph row from the end, looking for the
26855 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26856 DISP_STRING, or whose position is between START_CHARPOS
26860 && !INTEGERP (end
->object
)
26861 && !EQ (end
->object
, disp_string
)
26862 && !(BUFFERP (end
->object
)
26863 && (end
->charpos
>= start_charpos
26864 && end
->charpos
< end_charpos
));
26867 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26868 are present at buffer positions between START_CHARPOS and
26869 END_CHARPOS, or if they come from an overlay. */
26870 if (EQ (end
->object
, before_string
))
26872 pos
= string_buffer_position (before_string
, start_charpos
);
26873 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26876 else if (EQ (end
->object
, after_string
))
26878 pos
= string_buffer_position (after_string
, end_charpos
);
26879 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26882 x
+= end
->pixel_width
;
26884 /* If we exited the above loop because we arrived at the last
26885 glyph of the row, and its buffer position is still not in
26886 range, it means the last character in range is the preceding
26887 newline. Bump the end column and x values to get past the
26890 && BUFFERP (end
->object
)
26891 && (end
->charpos
< start_charpos
26892 || end
->charpos
>= end_charpos
))
26894 x
+= end
->pixel_width
;
26897 hlinfo
->mouse_face_end_x
= x
;
26898 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
26901 hlinfo
->mouse_face_window
= window
;
26902 hlinfo
->mouse_face_face_id
26903 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
26905 !hlinfo
->mouse_face_hidden
, -1);
26906 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26909 /* The following function is not used anymore (replaced with
26910 mouse_face_from_string_pos), but I leave it here for the time
26911 being, in case someone would. */
26913 #if 0 /* not used */
26915 /* Find the position of the glyph for position POS in OBJECT in
26916 window W's current matrix, and return in *X, *Y the pixel
26917 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
26919 RIGHT_P non-zero means return the position of the right edge of the
26920 glyph, RIGHT_P zero means return the left edge position.
26922 If no glyph for POS exists in the matrix, return the position of
26923 the glyph with the next smaller position that is in the matrix, if
26924 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
26925 exists in the matrix, return the position of the glyph with the
26926 next larger position in OBJECT.
26928 Value is non-zero if a glyph was found. */
26931 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
26932 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
26934 int yb
= window_text_bottom_y (w
);
26935 struct glyph_row
*r
;
26936 struct glyph
*best_glyph
= NULL
;
26937 struct glyph_row
*best_row
= NULL
;
26940 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26941 r
->enabled_p
&& r
->y
< yb
;
26944 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
26945 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
26948 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26949 if (EQ (g
->object
, object
))
26951 if (g
->charpos
== pos
)
26958 else if (best_glyph
== NULL
26959 || ((eabs (g
->charpos
- pos
)
26960 < eabs (best_glyph
->charpos
- pos
))
26963 : g
->charpos
> pos
)))
26977 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
26981 *x
+= best_glyph
->pixel_width
;
26986 *vpos
= best_row
- w
->current_matrix
->rows
;
26989 return best_glyph
!= NULL
;
26991 #endif /* not used */
26993 /* Find the positions of the first and the last glyphs in window W's
26994 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
26995 (assumed to be a string), and return in HLINFO's mouse_face_*
26996 members the pixel and column/row coordinates of those glyphs. */
26999 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
27000 Lisp_Object object
,
27001 ptrdiff_t startpos
, ptrdiff_t endpos
)
27003 int yb
= window_text_bottom_y (w
);
27004 struct glyph_row
*r
;
27005 struct glyph
*g
, *e
;
27009 /* Find the glyph row with at least one position in the range
27010 [STARTPOS..ENDPOS], and the first glyph in that row whose
27011 position belongs to that range. */
27012 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27013 r
->enabled_p
&& r
->y
< yb
;
27016 if (!r
->reversed_p
)
27018 g
= r
->glyphs
[TEXT_AREA
];
27019 e
= g
+ r
->used
[TEXT_AREA
];
27020 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
27021 if (EQ (g
->object
, object
)
27022 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
27024 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
27025 hlinfo
->mouse_face_beg_y
= r
->y
;
27026 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
27027 hlinfo
->mouse_face_beg_x
= gx
;
27036 e
= r
->glyphs
[TEXT_AREA
];
27037 g
= e
+ r
->used
[TEXT_AREA
];
27038 for ( ; g
> e
; --g
)
27039 if (EQ ((g
-1)->object
, object
)
27040 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
27042 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
27043 hlinfo
->mouse_face_beg_y
= r
->y
;
27044 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
27045 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
27046 gx
+= g1
->pixel_width
;
27047 hlinfo
->mouse_face_beg_x
= gx
;
27059 /* Starting with the next row, look for the first row which does NOT
27060 include any glyphs whose positions are in the range. */
27061 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
27063 g
= r
->glyphs
[TEXT_AREA
];
27064 e
= g
+ r
->used
[TEXT_AREA
];
27066 for ( ; g
< e
; ++g
)
27067 if (EQ (g
->object
, object
)
27068 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
27077 /* The highlighted region ends on the previous row. */
27080 /* Set the end row and its vertical pixel coordinate. */
27081 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
27082 hlinfo
->mouse_face_end_y
= r
->y
;
27084 /* Compute and set the end column and the end column's horizontal
27085 pixel coordinate. */
27086 if (!r
->reversed_p
)
27088 g
= r
->glyphs
[TEXT_AREA
];
27089 e
= g
+ r
->used
[TEXT_AREA
];
27090 for ( ; e
> g
; --e
)
27091 if (EQ ((e
-1)->object
, object
)
27092 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
27094 hlinfo
->mouse_face_end_col
= e
- g
;
27096 for (gx
= r
->x
; g
< e
; ++g
)
27097 gx
+= g
->pixel_width
;
27098 hlinfo
->mouse_face_end_x
= gx
;
27102 e
= r
->glyphs
[TEXT_AREA
];
27103 g
= e
+ r
->used
[TEXT_AREA
];
27104 for (gx
= r
->x
; e
< g
; ++e
)
27106 if (EQ (e
->object
, object
)
27107 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
27109 gx
+= e
->pixel_width
;
27111 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
27112 hlinfo
->mouse_face_end_x
= gx
;
27116 #ifdef HAVE_WINDOW_SYSTEM
27118 /* See if position X, Y is within a hot-spot of an image. */
27121 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
27123 if (!CONSP (hot_spot
))
27126 if (EQ (XCAR (hot_spot
), Qrect
))
27128 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
27129 Lisp_Object rect
= XCDR (hot_spot
);
27133 if (!CONSP (XCAR (rect
)))
27135 if (!CONSP (XCDR (rect
)))
27137 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
27139 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
27141 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
27143 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
27147 else if (EQ (XCAR (hot_spot
), Qcircle
))
27149 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
27150 Lisp_Object circ
= XCDR (hot_spot
);
27151 Lisp_Object lr
, lx0
, ly0
;
27153 && CONSP (XCAR (circ
))
27154 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
27155 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
27156 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
27158 double r
= XFLOATINT (lr
);
27159 double dx
= XINT (lx0
) - x
;
27160 double dy
= XINT (ly0
) - y
;
27161 return (dx
* dx
+ dy
* dy
<= r
* r
);
27164 else if (EQ (XCAR (hot_spot
), Qpoly
))
27166 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
27167 if (VECTORP (XCDR (hot_spot
)))
27169 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
27170 Lisp_Object
*poly
= v
->contents
;
27171 ptrdiff_t n
= v
->header
.size
;
27174 Lisp_Object lx
, ly
;
27177 /* Need an even number of coordinates, and at least 3 edges. */
27178 if (n
< 6 || n
& 1)
27181 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
27182 If count is odd, we are inside polygon. Pixels on edges
27183 may or may not be included depending on actual geometry of the
27185 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
27186 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
27188 x0
= XINT (lx
), y0
= XINT (ly
);
27189 for (i
= 0; i
< n
; i
+= 2)
27191 int x1
= x0
, y1
= y0
;
27192 if ((lx
= poly
[i
], !INTEGERP (lx
))
27193 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
27195 x0
= XINT (lx
), y0
= XINT (ly
);
27197 /* Does this segment cross the X line? */
27205 if (y
> y0
&& y
> y1
)
27207 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
27217 find_hot_spot (Lisp_Object map
, int x
, int y
)
27219 while (CONSP (map
))
27221 if (CONSP (XCAR (map
))
27222 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
27230 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
27232 doc
: /* Lookup in image map MAP coordinates X and Y.
27233 An image map is an alist where each element has the format (AREA ID PLIST).
27234 An AREA is specified as either a rectangle, a circle, or a polygon:
27235 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
27236 pixel coordinates of the upper left and bottom right corners.
27237 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
27238 and the radius of the circle; r may be a float or integer.
27239 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
27240 vector describes one corner in the polygon.
27241 Returns the alist element for the first matching AREA in MAP. */)
27242 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
27250 return find_hot_spot (map
,
27251 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
27252 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
27256 /* Display frame CURSOR, optionally using shape defined by POINTER. */
27258 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
27260 /* Do not change cursor shape while dragging mouse. */
27261 if (!NILP (do_mouse_tracking
))
27264 if (!NILP (pointer
))
27266 if (EQ (pointer
, Qarrow
))
27267 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27268 else if (EQ (pointer
, Qhand
))
27269 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
27270 else if (EQ (pointer
, Qtext
))
27271 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27272 else if (EQ (pointer
, intern ("hdrag")))
27273 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27274 #ifdef HAVE_X_WINDOWS
27275 else if (EQ (pointer
, intern ("vdrag")))
27276 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27278 else if (EQ (pointer
, intern ("hourglass")))
27279 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
27280 else if (EQ (pointer
, Qmodeline
))
27281 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
27283 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27286 if (cursor
!= No_Cursor
)
27287 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
27290 #endif /* HAVE_WINDOW_SYSTEM */
27292 /* Take proper action when mouse has moved to the mode or header line
27293 or marginal area AREA of window W, x-position X and y-position Y.
27294 X is relative to the start of the text display area of W, so the
27295 width of bitmap areas and scroll bars must be subtracted to get a
27296 position relative to the start of the mode line. */
27299 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
27300 enum window_part area
)
27302 struct window
*w
= XWINDOW (window
);
27303 struct frame
*f
= XFRAME (w
->frame
);
27304 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27305 #ifdef HAVE_WINDOW_SYSTEM
27306 Display_Info
*dpyinfo
;
27308 Cursor cursor
= No_Cursor
;
27309 Lisp_Object pointer
= Qnil
;
27310 int dx
, dy
, width
, height
;
27312 Lisp_Object string
, object
= Qnil
;
27313 Lisp_Object pos
IF_LINT (= Qnil
), help
;
27315 Lisp_Object mouse_face
;
27316 int original_x_pixel
= x
;
27317 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
27318 struct glyph_row
*row
IF_LINT (= 0);
27320 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
27325 /* Kludge alert: mode_line_string takes X/Y in pixels, but
27326 returns them in row/column units! */
27327 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
27328 &object
, &dx
, &dy
, &width
, &height
);
27330 row
= (area
== ON_MODE_LINE
27331 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
27332 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
27334 /* Find the glyph under the mouse pointer. */
27335 if (row
->mode_line_p
&& row
->enabled_p
)
27337 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
27338 end
= glyph
+ row
->used
[TEXT_AREA
];
27340 for (x0
= original_x_pixel
;
27341 glyph
< end
&& x0
>= glyph
->pixel_width
;
27343 x0
-= glyph
->pixel_width
;
27351 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
27352 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
27353 returns them in row/column units! */
27354 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
27355 &object
, &dx
, &dy
, &width
, &height
);
27360 #ifdef HAVE_WINDOW_SYSTEM
27361 if (IMAGEP (object
))
27363 Lisp_Object image_map
, hotspot
;
27364 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
27366 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
27368 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27372 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
27373 If so, we could look for mouse-enter, mouse-leave
27374 properties in PLIST (and do something...). */
27375 hotspot
= XCDR (hotspot
);
27376 if (CONSP (hotspot
)
27377 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27379 pointer
= Fplist_get (plist
, Qpointer
);
27380 if (NILP (pointer
))
27382 help
= Fplist_get (plist
, Qhelp_echo
);
27385 help_echo_string
= help
;
27386 XSETWINDOW (help_echo_window
, w
);
27387 help_echo_object
= w
->buffer
;
27388 help_echo_pos
= charpos
;
27392 if (NILP (pointer
))
27393 pointer
= Fplist_get (XCDR (object
), QCpointer
);
27395 #endif /* HAVE_WINDOW_SYSTEM */
27397 if (STRINGP (string
))
27398 pos
= make_number (charpos
);
27400 /* Set the help text and mouse pointer. If the mouse is on a part
27401 of the mode line without any text (e.g. past the right edge of
27402 the mode line text), use the default help text and pointer. */
27403 if (STRINGP (string
) || area
== ON_MODE_LINE
)
27405 /* Arrange to display the help by setting the global variables
27406 help_echo_string, help_echo_object, and help_echo_pos. */
27409 if (STRINGP (string
))
27410 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
27414 help_echo_string
= help
;
27415 XSETWINDOW (help_echo_window
, w
);
27416 help_echo_object
= string
;
27417 help_echo_pos
= charpos
;
27419 else if (area
== ON_MODE_LINE
)
27421 Lisp_Object default_help
27422 = buffer_local_value_1 (Qmode_line_default_help_echo
,
27425 if (STRINGP (default_help
))
27427 help_echo_string
= default_help
;
27428 XSETWINDOW (help_echo_window
, w
);
27429 help_echo_object
= Qnil
;
27430 help_echo_pos
= -1;
27435 #ifdef HAVE_WINDOW_SYSTEM
27436 /* Change the mouse pointer according to what is under it. */
27437 if (FRAME_WINDOW_P (f
))
27439 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
27440 if (STRINGP (string
))
27442 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27444 if (NILP (pointer
))
27445 pointer
= Fget_text_property (pos
, Qpointer
, string
);
27447 /* Change the mouse pointer according to what is under X/Y. */
27449 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
27452 map
= Fget_text_property (pos
, Qlocal_map
, string
);
27453 if (!KEYMAPP (map
))
27454 map
= Fget_text_property (pos
, Qkeymap
, string
);
27455 if (!KEYMAPP (map
))
27456 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
27460 /* Default mode-line pointer. */
27461 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27466 /* Change the mouse face according to what is under X/Y. */
27467 if (STRINGP (string
))
27469 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
27470 if (!NILP (mouse_face
)
27471 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27476 struct glyph
* tmp_glyph
;
27480 int total_pixel_width
;
27481 ptrdiff_t begpos
, endpos
, ignore
;
27485 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
27486 Qmouse_face
, string
, Qnil
);
27492 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
27494 endpos
= SCHARS (string
);
27498 /* Calculate the glyph position GPOS of GLYPH in the
27499 displayed string, relative to the beginning of the
27500 highlighted part of the string.
27502 Note: GPOS is different from CHARPOS. CHARPOS is the
27503 position of GLYPH in the internal string object. A mode
27504 line string format has structures which are converted to
27505 a flattened string by the Emacs Lisp interpreter. The
27506 internal string is an element of those structures. The
27507 displayed string is the flattened string. */
27508 tmp_glyph
= row_start_glyph
;
27509 while (tmp_glyph
< glyph
27510 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27511 && begpos
<= tmp_glyph
->charpos
27512 && tmp_glyph
->charpos
< endpos
)))
27514 gpos
= glyph
- tmp_glyph
;
27516 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
27517 the highlighted part of the displayed string to which
27518 GLYPH belongs. Note: GSEQ_LENGTH is different from
27519 SCHARS (STRING), because the latter returns the length of
27520 the internal string. */
27521 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
27523 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27524 && begpos
<= tmp_glyph
->charpos
27525 && tmp_glyph
->charpos
< endpos
));
27528 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
27530 /* Calculate the total pixel width of all the glyphs between
27531 the beginning of the highlighted area and GLYPH. */
27532 total_pixel_width
= 0;
27533 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
27534 total_pixel_width
+= tmp_glyph
->pixel_width
;
27536 /* Pre calculation of re-rendering position. Note: X is in
27537 column units here, after the call to mode_line_string or
27538 marginal_area_string. */
27540 vpos
= (area
== ON_MODE_LINE
27541 ? (w
->current_matrix
)->nrows
- 1
27544 /* If GLYPH's position is included in the region that is
27545 already drawn in mouse face, we have nothing to do. */
27546 if ( EQ (window
, hlinfo
->mouse_face_window
)
27547 && (!row
->reversed_p
27548 ? (hlinfo
->mouse_face_beg_col
<= hpos
27549 && hpos
< hlinfo
->mouse_face_end_col
)
27550 /* In R2L rows we swap BEG and END, see below. */
27551 : (hlinfo
->mouse_face_end_col
<= hpos
27552 && hpos
< hlinfo
->mouse_face_beg_col
))
27553 && hlinfo
->mouse_face_beg_row
== vpos
)
27556 if (clear_mouse_face (hlinfo
))
27557 cursor
= No_Cursor
;
27559 if (!row
->reversed_p
)
27561 hlinfo
->mouse_face_beg_col
= hpos
;
27562 hlinfo
->mouse_face_beg_x
= original_x_pixel
27563 - (total_pixel_width
+ dx
);
27564 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
27565 hlinfo
->mouse_face_end_x
= 0;
27569 /* In R2L rows, show_mouse_face expects BEG and END
27570 coordinates to be swapped. */
27571 hlinfo
->mouse_face_end_col
= hpos
;
27572 hlinfo
->mouse_face_end_x
= original_x_pixel
27573 - (total_pixel_width
+ dx
);
27574 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
27575 hlinfo
->mouse_face_beg_x
= 0;
27578 hlinfo
->mouse_face_beg_row
= vpos
;
27579 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
27580 hlinfo
->mouse_face_beg_y
= 0;
27581 hlinfo
->mouse_face_end_y
= 0;
27582 hlinfo
->mouse_face_past_end
= 0;
27583 hlinfo
->mouse_face_window
= window
;
27585 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
27591 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27593 if (NILP (pointer
))
27596 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27597 clear_mouse_face (hlinfo
);
27599 #ifdef HAVE_WINDOW_SYSTEM
27600 if (FRAME_WINDOW_P (f
))
27601 define_frame_cursor1 (f
, cursor
, pointer
);
27607 Take proper action when the mouse has moved to position X, Y on
27608 frame F as regards highlighting characters that have mouse-face
27609 properties. Also de-highlighting chars where the mouse was before.
27610 X and Y can be negative or out of range. */
27613 note_mouse_highlight (struct frame
*f
, int x
, int y
)
27615 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27616 enum window_part part
= ON_NOTHING
;
27617 Lisp_Object window
;
27619 Cursor cursor
= No_Cursor
;
27620 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
27623 /* When a menu is active, don't highlight because this looks odd. */
27624 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
27625 if (popup_activated ())
27629 if (NILP (Vmouse_highlight
)
27630 || !f
->glyphs_initialized_p
27631 || f
->pointer_invisible
)
27634 hlinfo
->mouse_face_mouse_x
= x
;
27635 hlinfo
->mouse_face_mouse_y
= y
;
27636 hlinfo
->mouse_face_mouse_frame
= f
;
27638 if (hlinfo
->mouse_face_defer
)
27641 if (gc_in_progress
)
27643 hlinfo
->mouse_face_deferred_gc
= 1;
27647 /* Which window is that in? */
27648 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
27650 /* If displaying active text in another window, clear that. */
27651 if (! EQ (window
, hlinfo
->mouse_face_window
)
27652 /* Also clear if we move out of text area in same window. */
27653 || (!NILP (hlinfo
->mouse_face_window
)
27656 && part
!= ON_MODE_LINE
27657 && part
!= ON_HEADER_LINE
))
27658 clear_mouse_face (hlinfo
);
27660 /* Not on a window -> return. */
27661 if (!WINDOWP (window
))
27664 /* Reset help_echo_string. It will get recomputed below. */
27665 help_echo_string
= Qnil
;
27667 /* Convert to window-relative pixel coordinates. */
27668 w
= XWINDOW (window
);
27669 frame_to_window_pixel_xy (w
, &x
, &y
);
27671 #ifdef HAVE_WINDOW_SYSTEM
27672 /* Handle tool-bar window differently since it doesn't display a
27674 if (EQ (window
, f
->tool_bar_window
))
27676 note_tool_bar_highlight (f
, x
, y
);
27681 /* Mouse is on the mode, header line or margin? */
27682 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
27683 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
27685 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
27689 #ifdef HAVE_WINDOW_SYSTEM
27690 if (part
== ON_VERTICAL_BORDER
)
27692 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27693 help_echo_string
= build_string ("drag-mouse-1: resize");
27695 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
27696 || part
== ON_SCROLL_BAR
)
27697 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27699 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27702 /* Are we in a window whose display is up to date?
27703 And verify the buffer's text has not changed. */
27704 b
= XBUFFER (w
->buffer
);
27705 if (part
== ON_TEXT
27706 && EQ (w
->window_end_valid
, w
->buffer
)
27707 && w
->last_modified
== BUF_MODIFF (b
)
27708 && w
->last_overlay_modified
== BUF_OVERLAY_MODIFF (b
))
27710 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
27712 struct glyph
*glyph
;
27713 Lisp_Object object
;
27714 Lisp_Object mouse_face
= Qnil
, position
;
27715 Lisp_Object
*overlay_vec
= NULL
;
27716 ptrdiff_t i
, noverlays
;
27717 struct buffer
*obuf
;
27718 ptrdiff_t obegv
, ozv
;
27721 /* Find the glyph under X/Y. */
27722 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
27724 #ifdef HAVE_WINDOW_SYSTEM
27725 /* Look for :pointer property on image. */
27726 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27728 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27729 if (img
!= NULL
&& IMAGEP (img
->spec
))
27731 Lisp_Object image_map
, hotspot
;
27732 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
27734 && (hotspot
= find_hot_spot (image_map
,
27735 glyph
->slice
.img
.x
+ dx
,
27736 glyph
->slice
.img
.y
+ dy
),
27738 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27742 /* Could check XCAR (hotspot) to see if we enter/leave
27744 If so, we could look for mouse-enter, mouse-leave
27745 properties in PLIST (and do something...). */
27746 hotspot
= XCDR (hotspot
);
27747 if (CONSP (hotspot
)
27748 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27750 pointer
= Fplist_get (plist
, Qpointer
);
27751 if (NILP (pointer
))
27753 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
27754 if (!NILP (help_echo_string
))
27756 help_echo_window
= window
;
27757 help_echo_object
= glyph
->object
;
27758 help_echo_pos
= glyph
->charpos
;
27762 if (NILP (pointer
))
27763 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
27766 #endif /* HAVE_WINDOW_SYSTEM */
27768 /* Clear mouse face if X/Y not over text. */
27770 || area
!= TEXT_AREA
27771 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
27772 /* Glyph's OBJECT is an integer for glyphs inserted by the
27773 display engine for its internal purposes, like truncation
27774 and continuation glyphs and blanks beyond the end of
27775 line's text on text terminals. If we are over such a
27776 glyph, we are not over any text. */
27777 || INTEGERP (glyph
->object
)
27778 /* R2L rows have a stretch glyph at their front, which
27779 stands for no text, whereas L2R rows have no glyphs at
27780 all beyond the end of text. Treat such stretch glyphs
27781 like we do with NULL glyphs in L2R rows. */
27782 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
27783 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
27784 && glyph
->type
== STRETCH_GLYPH
27785 && glyph
->avoid_cursor_p
))
27787 if (clear_mouse_face (hlinfo
))
27788 cursor
= No_Cursor
;
27789 #ifdef HAVE_WINDOW_SYSTEM
27790 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27792 if (area
!= TEXT_AREA
)
27793 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27795 pointer
= Vvoid_text_area_pointer
;
27801 pos
= glyph
->charpos
;
27802 object
= glyph
->object
;
27803 if (!STRINGP (object
) && !BUFFERP (object
))
27806 /* If we get an out-of-range value, return now; avoid an error. */
27807 if (BUFFERP (object
) && pos
> BUF_Z (b
))
27810 /* Make the window's buffer temporarily current for
27811 overlays_at and compute_char_face. */
27812 obuf
= current_buffer
;
27813 current_buffer
= b
;
27819 /* Is this char mouse-active or does it have help-echo? */
27820 position
= make_number (pos
);
27822 if (BUFFERP (object
))
27824 /* Put all the overlays we want in a vector in overlay_vec. */
27825 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
27826 /* Sort overlays into increasing priority order. */
27827 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
27832 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
27835 cursor
= No_Cursor
;
27837 /* Check mouse-face highlighting. */
27839 /* If there exists an overlay with mouse-face overlapping
27840 the one we are currently highlighting, we have to
27841 check if we enter the overlapping overlay, and then
27842 highlight only that. */
27843 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
27844 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
27846 /* Find the highest priority overlay with a mouse-face. */
27847 Lisp_Object overlay
= Qnil
;
27848 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
27850 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
27851 if (!NILP (mouse_face
))
27852 overlay
= overlay_vec
[i
];
27855 /* If we're highlighting the same overlay as before, there's
27856 no need to do that again. */
27857 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
27858 goto check_help_echo
;
27859 hlinfo
->mouse_face_overlay
= overlay
;
27861 /* Clear the display of the old active region, if any. */
27862 if (clear_mouse_face (hlinfo
))
27863 cursor
= No_Cursor
;
27865 /* If no overlay applies, get a text property. */
27866 if (NILP (overlay
))
27867 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
27869 /* Next, compute the bounds of the mouse highlighting and
27871 if (!NILP (mouse_face
) && STRINGP (object
))
27873 /* The mouse-highlighting comes from a display string
27874 with a mouse-face. */
27878 s
= Fprevious_single_property_change
27879 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
27880 e
= Fnext_single_property_change
27881 (position
, Qmouse_face
, object
, Qnil
);
27883 s
= make_number (0);
27885 e
= make_number (SCHARS (object
) - 1);
27886 mouse_face_from_string_pos (w
, hlinfo
, object
,
27887 XINT (s
), XINT (e
));
27888 hlinfo
->mouse_face_past_end
= 0;
27889 hlinfo
->mouse_face_window
= window
;
27890 hlinfo
->mouse_face_face_id
27891 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
27892 glyph
->face_id
, 1);
27893 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27894 cursor
= No_Cursor
;
27898 /* The mouse-highlighting, if any, comes from an overlay
27899 or text property in the buffer. */
27900 Lisp_Object buffer
IF_LINT (= Qnil
);
27901 Lisp_Object disp_string
IF_LINT (= Qnil
);
27903 if (STRINGP (object
))
27905 /* If we are on a display string with no mouse-face,
27906 check if the text under it has one. */
27907 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
27908 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
27909 pos
= string_buffer_position (object
, start
);
27912 mouse_face
= get_char_property_and_overlay
27913 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
27914 buffer
= w
->buffer
;
27915 disp_string
= object
;
27921 disp_string
= Qnil
;
27924 if (!NILP (mouse_face
))
27926 Lisp_Object before
, after
;
27927 Lisp_Object before_string
, after_string
;
27928 /* To correctly find the limits of mouse highlight
27929 in a bidi-reordered buffer, we must not use the
27930 optimization of limiting the search in
27931 previous-single-property-change and
27932 next-single-property-change, because
27933 rows_from_pos_range needs the real start and end
27934 positions to DTRT in this case. That's because
27935 the first row visible in a window does not
27936 necessarily display the character whose position
27937 is the smallest. */
27939 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27940 ? Fmarker_position (w
->start
)
27943 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27944 ? make_number (BUF_Z (XBUFFER (buffer
))
27945 - XFASTINT (w
->window_end_pos
))
27948 if (NILP (overlay
))
27950 /* Handle the text property case. */
27951 before
= Fprevious_single_property_change
27952 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
27953 after
= Fnext_single_property_change
27954 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
27955 before_string
= after_string
= Qnil
;
27959 /* Handle the overlay case. */
27960 before
= Foverlay_start (overlay
);
27961 after
= Foverlay_end (overlay
);
27962 before_string
= Foverlay_get (overlay
, Qbefore_string
);
27963 after_string
= Foverlay_get (overlay
, Qafter_string
);
27965 if (!STRINGP (before_string
)) before_string
= Qnil
;
27966 if (!STRINGP (after_string
)) after_string
= Qnil
;
27969 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
27972 : XFASTINT (before
),
27974 ? BUF_Z (XBUFFER (buffer
))
27975 : XFASTINT (after
),
27976 before_string
, after_string
,
27978 cursor
= No_Cursor
;
27985 /* Look for a `help-echo' property. */
27986 if (NILP (help_echo_string
)) {
27987 Lisp_Object help
, overlay
;
27989 /* Check overlays first. */
27990 help
= overlay
= Qnil
;
27991 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
27993 overlay
= overlay_vec
[i
];
27994 help
= Foverlay_get (overlay
, Qhelp_echo
);
27999 help_echo_string
= help
;
28000 help_echo_window
= window
;
28001 help_echo_object
= overlay
;
28002 help_echo_pos
= pos
;
28006 Lisp_Object obj
= glyph
->object
;
28007 ptrdiff_t charpos
= glyph
->charpos
;
28009 /* Try text properties. */
28012 && charpos
< SCHARS (obj
))
28014 help
= Fget_text_property (make_number (charpos
),
28018 /* If the string itself doesn't specify a help-echo,
28019 see if the buffer text ``under'' it does. */
28020 struct glyph_row
*r
28021 = MATRIX_ROW (w
->current_matrix
, vpos
);
28022 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
28023 ptrdiff_t p
= string_buffer_position (obj
, start
);
28026 help
= Fget_char_property (make_number (p
),
28027 Qhelp_echo
, w
->buffer
);
28036 else if (BUFFERP (obj
)
28039 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
28044 help_echo_string
= help
;
28045 help_echo_window
= window
;
28046 help_echo_object
= obj
;
28047 help_echo_pos
= charpos
;
28052 #ifdef HAVE_WINDOW_SYSTEM
28053 /* Look for a `pointer' property. */
28054 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
28056 /* Check overlays first. */
28057 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
28058 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
28060 if (NILP (pointer
))
28062 Lisp_Object obj
= glyph
->object
;
28063 ptrdiff_t charpos
= glyph
->charpos
;
28065 /* Try text properties. */
28068 && charpos
< SCHARS (obj
))
28070 pointer
= Fget_text_property (make_number (charpos
),
28072 if (NILP (pointer
))
28074 /* If the string itself doesn't specify a pointer,
28075 see if the buffer text ``under'' it does. */
28076 struct glyph_row
*r
28077 = MATRIX_ROW (w
->current_matrix
, vpos
);
28078 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
28079 ptrdiff_t p
= string_buffer_position (obj
, start
);
28081 pointer
= Fget_char_property (make_number (p
),
28082 Qpointer
, w
->buffer
);
28085 else if (BUFFERP (obj
)
28088 pointer
= Fget_text_property (make_number (charpos
),
28092 #endif /* HAVE_WINDOW_SYSTEM */
28096 current_buffer
= obuf
;
28101 #ifdef HAVE_WINDOW_SYSTEM
28102 if (FRAME_WINDOW_P (f
))
28103 define_frame_cursor1 (f
, cursor
, pointer
);
28105 /* This is here to prevent a compiler error, about "label at end of
28106 compound statement". */
28113 Clear any mouse-face on window W. This function is part of the
28114 redisplay interface, and is called from try_window_id and similar
28115 functions to ensure the mouse-highlight is off. */
28118 x_clear_window_mouse_face (struct window
*w
)
28120 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28121 Lisp_Object window
;
28124 XSETWINDOW (window
, w
);
28125 if (EQ (window
, hlinfo
->mouse_face_window
))
28126 clear_mouse_face (hlinfo
);
28132 Just discard the mouse face information for frame F, if any.
28133 This is used when the size of F is changed. */
28136 cancel_mouse_face (struct frame
*f
)
28138 Lisp_Object window
;
28139 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28141 window
= hlinfo
->mouse_face_window
;
28142 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
28144 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28145 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28146 hlinfo
->mouse_face_window
= Qnil
;
28152 /***********************************************************************
28154 ***********************************************************************/
28156 #ifdef HAVE_WINDOW_SYSTEM
28158 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
28159 which intersects rectangle R. R is in window-relative coordinates. */
28162 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
28163 enum glyph_row_area area
)
28165 struct glyph
*first
= row
->glyphs
[area
];
28166 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
28167 struct glyph
*last
;
28168 int first_x
, start_x
, x
;
28170 if (area
== TEXT_AREA
&& row
->fill_line_p
)
28171 /* If row extends face to end of line write the whole line. */
28172 draw_glyphs (w
, 0, row
, area
,
28173 0, row
->used
[area
],
28174 DRAW_NORMAL_TEXT
, 0);
28177 /* Set START_X to the window-relative start position for drawing glyphs of
28178 AREA. The first glyph of the text area can be partially visible.
28179 The first glyphs of other areas cannot. */
28180 start_x
= window_box_left_offset (w
, area
);
28182 if (area
== TEXT_AREA
)
28185 /* Find the first glyph that must be redrawn. */
28187 && x
+ first
->pixel_width
< r
->x
)
28189 x
+= first
->pixel_width
;
28193 /* Find the last one. */
28197 && x
< r
->x
+ r
->width
)
28199 x
+= last
->pixel_width
;
28205 draw_glyphs (w
, first_x
- start_x
, row
, area
,
28206 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
28207 DRAW_NORMAL_TEXT
, 0);
28212 /* Redraw the parts of the glyph row ROW on window W intersecting
28213 rectangle R. R is in window-relative coordinates. Value is
28214 non-zero if mouse-face was overwritten. */
28217 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
28219 eassert (row
->enabled_p
);
28221 if (row
->mode_line_p
|| w
->pseudo_window_p
)
28222 draw_glyphs (w
, 0, row
, TEXT_AREA
,
28223 0, row
->used
[TEXT_AREA
],
28224 DRAW_NORMAL_TEXT
, 0);
28227 if (row
->used
[LEFT_MARGIN_AREA
])
28228 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
28229 if (row
->used
[TEXT_AREA
])
28230 expose_area (w
, row
, r
, TEXT_AREA
);
28231 if (row
->used
[RIGHT_MARGIN_AREA
])
28232 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
28233 draw_row_fringe_bitmaps (w
, row
);
28236 return row
->mouse_face_p
;
28240 /* Redraw those parts of glyphs rows during expose event handling that
28241 overlap other rows. Redrawing of an exposed line writes over parts
28242 of lines overlapping that exposed line; this function fixes that.
28244 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
28245 row in W's current matrix that is exposed and overlaps other rows.
28246 LAST_OVERLAPPING_ROW is the last such row. */
28249 expose_overlaps (struct window
*w
,
28250 struct glyph_row
*first_overlapping_row
,
28251 struct glyph_row
*last_overlapping_row
,
28254 struct glyph_row
*row
;
28256 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
28257 if (row
->overlapping_p
)
28259 eassert (row
->enabled_p
&& !row
->mode_line_p
);
28262 if (row
->used
[LEFT_MARGIN_AREA
])
28263 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
28265 if (row
->used
[TEXT_AREA
])
28266 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
28268 if (row
->used
[RIGHT_MARGIN_AREA
])
28269 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
28275 /* Return non-zero if W's cursor intersects rectangle R. */
28278 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
28280 XRectangle cr
, result
;
28281 struct glyph
*cursor_glyph
;
28282 struct glyph_row
*row
;
28284 if (w
->phys_cursor
.vpos
>= 0
28285 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
28286 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
28288 && row
->cursor_in_fringe_p
)
28290 /* Cursor is in the fringe. */
28291 cr
.x
= window_box_right_offset (w
,
28292 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
28293 ? RIGHT_MARGIN_AREA
28296 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
28297 cr
.height
= row
->height
;
28298 return x_intersect_rectangles (&cr
, r
, &result
);
28301 cursor_glyph
= get_phys_cursor_glyph (w
);
28304 /* r is relative to W's box, but w->phys_cursor.x is relative
28305 to left edge of W's TEXT area. Adjust it. */
28306 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
28307 cr
.y
= w
->phys_cursor
.y
;
28308 cr
.width
= cursor_glyph
->pixel_width
;
28309 cr
.height
= w
->phys_cursor_height
;
28310 /* ++KFS: W32 version used W32-specific IntersectRect here, but
28311 I assume the effect is the same -- and this is portable. */
28312 return x_intersect_rectangles (&cr
, r
, &result
);
28314 /* If we don't understand the format, pretend we're not in the hot-spot. */
28320 Draw a vertical window border to the right of window W if W doesn't
28321 have vertical scroll bars. */
28324 x_draw_vertical_border (struct window
*w
)
28326 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28328 /* We could do better, if we knew what type of scroll-bar the adjacent
28329 windows (on either side) have... But we don't :-(
28330 However, I think this works ok. ++KFS 2003-04-25 */
28332 /* Redraw borders between horizontally adjacent windows. Don't
28333 do it for frames with vertical scroll bars because either the
28334 right scroll bar of a window, or the left scroll bar of its
28335 neighbor will suffice as a border. */
28336 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
28339 if (!WINDOW_RIGHTMOST_P (w
)
28340 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
28342 int x0
, x1
, y0
, y1
;
28344 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28347 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28350 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
28352 else if (!WINDOW_LEFTMOST_P (w
)
28353 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
28355 int x0
, x1
, y0
, y1
;
28357 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28360 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28363 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
28368 /* Redraw the part of window W intersection rectangle FR. Pixel
28369 coordinates in FR are frame-relative. Call this function with
28370 input blocked. Value is non-zero if the exposure overwrites
28374 expose_window (struct window
*w
, XRectangle
*fr
)
28376 struct frame
*f
= XFRAME (w
->frame
);
28378 int mouse_face_overwritten_p
= 0;
28380 /* If window is not yet fully initialized, do nothing. This can
28381 happen when toolkit scroll bars are used and a window is split.
28382 Reconfiguring the scroll bar will generate an expose for a newly
28384 if (w
->current_matrix
== NULL
)
28387 /* When we're currently updating the window, display and current
28388 matrix usually don't agree. Arrange for a thorough display
28390 if (w
== updated_window
)
28392 SET_FRAME_GARBAGED (f
);
28396 /* Frame-relative pixel rectangle of W. */
28397 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
28398 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
28399 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
28400 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
28402 if (x_intersect_rectangles (fr
, &wr
, &r
))
28404 int yb
= window_text_bottom_y (w
);
28405 struct glyph_row
*row
;
28406 int cursor_cleared_p
, phys_cursor_on_p
;
28407 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
28409 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
28410 r
.x
, r
.y
, r
.width
, r
.height
));
28412 /* Convert to window coordinates. */
28413 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
28414 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
28416 /* Turn off the cursor. */
28417 if (!w
->pseudo_window_p
28418 && phys_cursor_in_rect_p (w
, &r
))
28420 x_clear_cursor (w
);
28421 cursor_cleared_p
= 1;
28424 cursor_cleared_p
= 0;
28426 /* If the row containing the cursor extends face to end of line,
28427 then expose_area might overwrite the cursor outside the
28428 rectangle and thus notice_overwritten_cursor might clear
28429 w->phys_cursor_on_p. We remember the original value and
28430 check later if it is changed. */
28431 phys_cursor_on_p
= w
->phys_cursor_on_p
;
28433 /* Update lines intersecting rectangle R. */
28434 first_overlapping_row
= last_overlapping_row
= NULL
;
28435 for (row
= w
->current_matrix
->rows
;
28440 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
28442 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
28443 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
28444 || (r
.y
>= y0
&& r
.y
< y1
)
28445 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
28447 /* A header line may be overlapping, but there is no need
28448 to fix overlapping areas for them. KFS 2005-02-12 */
28449 if (row
->overlapping_p
&& !row
->mode_line_p
)
28451 if (first_overlapping_row
== NULL
)
28452 first_overlapping_row
= row
;
28453 last_overlapping_row
= row
;
28457 if (expose_line (w
, row
, &r
))
28458 mouse_face_overwritten_p
= 1;
28461 else if (row
->overlapping_p
)
28463 /* We must redraw a row overlapping the exposed area. */
28465 ? y0
+ row
->phys_height
> r
.y
28466 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
28468 if (first_overlapping_row
== NULL
)
28469 first_overlapping_row
= row
;
28470 last_overlapping_row
= row
;
28478 /* Display the mode line if there is one. */
28479 if (WINDOW_WANTS_MODELINE_P (w
)
28480 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
28482 && row
->y
< r
.y
+ r
.height
)
28484 if (expose_line (w
, row
, &r
))
28485 mouse_face_overwritten_p
= 1;
28488 if (!w
->pseudo_window_p
)
28490 /* Fix the display of overlapping rows. */
28491 if (first_overlapping_row
)
28492 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
28495 /* Draw border between windows. */
28496 x_draw_vertical_border (w
);
28498 /* Turn the cursor on again. */
28499 if (cursor_cleared_p
28500 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
28501 update_window_cursor (w
, 1);
28505 return mouse_face_overwritten_p
;
28510 /* Redraw (parts) of all windows in the window tree rooted at W that
28511 intersect R. R contains frame pixel coordinates. Value is
28512 non-zero if the exposure overwrites mouse-face. */
28515 expose_window_tree (struct window
*w
, XRectangle
*r
)
28517 struct frame
*f
= XFRAME (w
->frame
);
28518 int mouse_face_overwritten_p
= 0;
28520 while (w
&& !FRAME_GARBAGED_P (f
))
28522 if (!NILP (w
->hchild
))
28523 mouse_face_overwritten_p
28524 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
28525 else if (!NILP (w
->vchild
))
28526 mouse_face_overwritten_p
28527 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
28529 mouse_face_overwritten_p
|= expose_window (w
, r
);
28531 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
28534 return mouse_face_overwritten_p
;
28539 Redisplay an exposed area of frame F. X and Y are the upper-left
28540 corner of the exposed rectangle. W and H are width and height of
28541 the exposed area. All are pixel values. W or H zero means redraw
28542 the entire frame. */
28545 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
28548 int mouse_face_overwritten_p
= 0;
28550 TRACE ((stderr
, "expose_frame "));
28552 /* No need to redraw if frame will be redrawn soon. */
28553 if (FRAME_GARBAGED_P (f
))
28555 TRACE ((stderr
, " garbaged\n"));
28559 /* If basic faces haven't been realized yet, there is no point in
28560 trying to redraw anything. This can happen when we get an expose
28561 event while Emacs is starting, e.g. by moving another window. */
28562 if (FRAME_FACE_CACHE (f
) == NULL
28563 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
28565 TRACE ((stderr
, " no faces\n"));
28569 if (w
== 0 || h
== 0)
28572 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
28573 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
28583 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
28584 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
28586 if (WINDOWP (f
->tool_bar_window
))
28587 mouse_face_overwritten_p
28588 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
28590 #ifdef HAVE_X_WINDOWS
28592 #ifndef USE_X_TOOLKIT
28593 if (WINDOWP (f
->menu_bar_window
))
28594 mouse_face_overwritten_p
28595 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
28596 #endif /* not USE_X_TOOLKIT */
28600 /* Some window managers support a focus-follows-mouse style with
28601 delayed raising of frames. Imagine a partially obscured frame,
28602 and moving the mouse into partially obscured mouse-face on that
28603 frame. The visible part of the mouse-face will be highlighted,
28604 then the WM raises the obscured frame. With at least one WM, KDE
28605 2.1, Emacs is not getting any event for the raising of the frame
28606 (even tried with SubstructureRedirectMask), only Expose events.
28607 These expose events will draw text normally, i.e. not
28608 highlighted. Which means we must redo the highlight here.
28609 Subsume it under ``we love X''. --gerd 2001-08-15 */
28610 /* Included in Windows version because Windows most likely does not
28611 do the right thing if any third party tool offers
28612 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
28613 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
28615 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28616 if (f
== hlinfo
->mouse_face_mouse_frame
)
28618 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
28619 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
28620 clear_mouse_face (hlinfo
);
28621 note_mouse_highlight (f
, mouse_x
, mouse_y
);
28628 Determine the intersection of two rectangles R1 and R2. Return
28629 the intersection in *RESULT. Value is non-zero if RESULT is not
28633 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
28635 XRectangle
*left
, *right
;
28636 XRectangle
*upper
, *lower
;
28637 int intersection_p
= 0;
28639 /* Rearrange so that R1 is the left-most rectangle. */
28641 left
= r1
, right
= r2
;
28643 left
= r2
, right
= r1
;
28645 /* X0 of the intersection is right.x0, if this is inside R1,
28646 otherwise there is no intersection. */
28647 if (right
->x
<= left
->x
+ left
->width
)
28649 result
->x
= right
->x
;
28651 /* The right end of the intersection is the minimum of
28652 the right ends of left and right. */
28653 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
28656 /* Same game for Y. */
28658 upper
= r1
, lower
= r2
;
28660 upper
= r2
, lower
= r1
;
28662 /* The upper end of the intersection is lower.y0, if this is inside
28663 of upper. Otherwise, there is no intersection. */
28664 if (lower
->y
<= upper
->y
+ upper
->height
)
28666 result
->y
= lower
->y
;
28668 /* The lower end of the intersection is the minimum of the lower
28669 ends of upper and lower. */
28670 result
->height
= (min (lower
->y
+ lower
->height
,
28671 upper
->y
+ upper
->height
)
28673 intersection_p
= 1;
28677 return intersection_p
;
28680 #endif /* HAVE_WINDOW_SYSTEM */
28683 /***********************************************************************
28685 ***********************************************************************/
28688 syms_of_xdisp (void)
28690 Vwith_echo_area_save_vector
= Qnil
;
28691 staticpro (&Vwith_echo_area_save_vector
);
28693 Vmessage_stack
= Qnil
;
28694 staticpro (&Vmessage_stack
);
28696 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
28697 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
28699 message_dolog_marker1
= Fmake_marker ();
28700 staticpro (&message_dolog_marker1
);
28701 message_dolog_marker2
= Fmake_marker ();
28702 staticpro (&message_dolog_marker2
);
28703 message_dolog_marker3
= Fmake_marker ();
28704 staticpro (&message_dolog_marker3
);
28707 defsubr (&Sdump_frame_glyph_matrix
);
28708 defsubr (&Sdump_glyph_matrix
);
28709 defsubr (&Sdump_glyph_row
);
28710 defsubr (&Sdump_tool_bar_row
);
28711 defsubr (&Strace_redisplay
);
28712 defsubr (&Strace_to_stderr
);
28714 #ifdef HAVE_WINDOW_SYSTEM
28715 defsubr (&Stool_bar_lines_needed
);
28716 defsubr (&Slookup_image_map
);
28718 defsubr (&Sformat_mode_line
);
28719 defsubr (&Sinvisible_p
);
28720 defsubr (&Scurrent_bidi_paragraph_direction
);
28722 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
28723 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
28724 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
28725 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
28726 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
28727 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
28728 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
28729 DEFSYM (Qeval
, "eval");
28730 DEFSYM (QCdata
, ":data");
28731 DEFSYM (Qdisplay
, "display");
28732 DEFSYM (Qspace_width
, "space-width");
28733 DEFSYM (Qraise
, "raise");
28734 DEFSYM (Qslice
, "slice");
28735 DEFSYM (Qspace
, "space");
28736 DEFSYM (Qmargin
, "margin");
28737 DEFSYM (Qpointer
, "pointer");
28738 DEFSYM (Qleft_margin
, "left-margin");
28739 DEFSYM (Qright_margin
, "right-margin");
28740 DEFSYM (Qcenter
, "center");
28741 DEFSYM (Qline_height
, "line-height");
28742 DEFSYM (QCalign_to
, ":align-to");
28743 DEFSYM (QCrelative_width
, ":relative-width");
28744 DEFSYM (QCrelative_height
, ":relative-height");
28745 DEFSYM (QCeval
, ":eval");
28746 DEFSYM (QCpropertize
, ":propertize");
28747 DEFSYM (QCfile
, ":file");
28748 DEFSYM (Qfontified
, "fontified");
28749 DEFSYM (Qfontification_functions
, "fontification-functions");
28750 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
28751 DEFSYM (Qescape_glyph
, "escape-glyph");
28752 DEFSYM (Qnobreak_space
, "nobreak-space");
28753 DEFSYM (Qimage
, "image");
28754 DEFSYM (Qtext
, "text");
28755 DEFSYM (Qboth
, "both");
28756 DEFSYM (Qboth_horiz
, "both-horiz");
28757 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
28758 DEFSYM (QCmap
, ":map");
28759 DEFSYM (QCpointer
, ":pointer");
28760 DEFSYM (Qrect
, "rect");
28761 DEFSYM (Qcircle
, "circle");
28762 DEFSYM (Qpoly
, "poly");
28763 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
28764 DEFSYM (Qgrow_only
, "grow-only");
28765 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
28766 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
28767 DEFSYM (Qposition
, "position");
28768 DEFSYM (Qbuffer_position
, "buffer-position");
28769 DEFSYM (Qobject
, "object");
28770 DEFSYM (Qbar
, "bar");
28771 DEFSYM (Qhbar
, "hbar");
28772 DEFSYM (Qbox
, "box");
28773 DEFSYM (Qhollow
, "hollow");
28774 DEFSYM (Qhand
, "hand");
28775 DEFSYM (Qarrow
, "arrow");
28776 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
28778 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
28779 Fcons (intern_c_string ("void-variable"), Qnil
)),
28781 staticpro (&list_of_error
);
28783 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
28784 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
28785 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
28786 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
28788 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
28789 staticpro (&echo_buffer
[0]);
28790 staticpro (&echo_buffer
[1]);
28792 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
28793 staticpro (&echo_area_buffer
[0]);
28794 staticpro (&echo_area_buffer
[1]);
28796 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
28797 staticpro (&Vmessages_buffer_name
);
28799 mode_line_proptrans_alist
= Qnil
;
28800 staticpro (&mode_line_proptrans_alist
);
28801 mode_line_string_list
= Qnil
;
28802 staticpro (&mode_line_string_list
);
28803 mode_line_string_face
= Qnil
;
28804 staticpro (&mode_line_string_face
);
28805 mode_line_string_face_prop
= Qnil
;
28806 staticpro (&mode_line_string_face_prop
);
28807 Vmode_line_unwind_vector
= Qnil
;
28808 staticpro (&Vmode_line_unwind_vector
);
28810 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
28812 help_echo_string
= Qnil
;
28813 staticpro (&help_echo_string
);
28814 help_echo_object
= Qnil
;
28815 staticpro (&help_echo_object
);
28816 help_echo_window
= Qnil
;
28817 staticpro (&help_echo_window
);
28818 previous_help_echo_string
= Qnil
;
28819 staticpro (&previous_help_echo_string
);
28820 help_echo_pos
= -1;
28822 DEFSYM (Qright_to_left
, "right-to-left");
28823 DEFSYM (Qleft_to_right
, "left-to-right");
28825 #ifdef HAVE_WINDOW_SYSTEM
28826 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
28827 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
28828 For example, if a block cursor is over a tab, it will be drawn as
28829 wide as that tab on the display. */);
28830 x_stretch_cursor_p
= 0;
28833 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
28834 doc
: /* Non-nil means highlight trailing whitespace.
28835 The face used for trailing whitespace is `trailing-whitespace'. */);
28836 Vshow_trailing_whitespace
= Qnil
;
28838 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
28839 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
28840 If the value is t, Emacs highlights non-ASCII chars which have the
28841 same appearance as an ASCII space or hyphen, using the `nobreak-space'
28842 or `escape-glyph' face respectively.
28844 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
28845 U+2011 (non-breaking hyphen) are affected.
28847 Any other non-nil value means to display these characters as a escape
28848 glyph followed by an ordinary space or hyphen.
28850 A value of nil means no special handling of these characters. */);
28851 Vnobreak_char_display
= Qt
;
28853 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
28854 doc
: /* The pointer shape to show in void text areas.
28855 A value of nil means to show the text pointer. Other options are `arrow',
28856 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
28857 Vvoid_text_area_pointer
= Qarrow
;
28859 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
28860 doc
: /* Non-nil means don't actually do any redisplay.
28861 This is used for internal purposes. */);
28862 Vinhibit_redisplay
= Qnil
;
28864 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
28865 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
28866 Vglobal_mode_string
= Qnil
;
28868 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
28869 doc
: /* Marker for where to display an arrow on top of the buffer text.
28870 This must be the beginning of a line in order to work.
28871 See also `overlay-arrow-string'. */);
28872 Voverlay_arrow_position
= Qnil
;
28874 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
28875 doc
: /* String to display as an arrow in non-window frames.
28876 See also `overlay-arrow-position'. */);
28877 Voverlay_arrow_string
= build_pure_c_string ("=>");
28879 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
28880 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
28881 The symbols on this list are examined during redisplay to determine
28882 where to display overlay arrows. */);
28883 Voverlay_arrow_variable_list
28884 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
28886 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
28887 doc
: /* The number of lines to try scrolling a window by when point moves out.
28888 If that fails to bring point back on frame, point is centered instead.
28889 If this is zero, point is always centered after it moves off frame.
28890 If you want scrolling to always be a line at a time, you should set
28891 `scroll-conservatively' to a large value rather than set this to 1. */);
28893 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
28894 doc
: /* Scroll up to this many lines, to bring point back on screen.
28895 If point moves off-screen, redisplay will scroll by up to
28896 `scroll-conservatively' lines in order to bring point just barely
28897 onto the screen again. If that cannot be done, then redisplay
28898 recenters point as usual.
28900 If the value is greater than 100, redisplay will never recenter point,
28901 but will always scroll just enough text to bring point into view, even
28902 if you move far away.
28904 A value of zero means always recenter point if it moves off screen. */);
28905 scroll_conservatively
= 0;
28907 DEFVAR_INT ("scroll-margin", scroll_margin
,
28908 doc
: /* Number of lines of margin at the top and bottom of a window.
28909 Recenter the window whenever point gets within this many lines
28910 of the top or bottom of the window. */);
28913 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
28914 doc
: /* Pixels per inch value for non-window system displays.
28915 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
28916 Vdisplay_pixels_per_inch
= make_float (72.0);
28919 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
28922 DEFVAR_LISP ("truncate-partial-width-windows",
28923 Vtruncate_partial_width_windows
,
28924 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
28925 For an integer value, truncate lines in each window narrower than the
28926 full frame width, provided the window width is less than that integer;
28927 otherwise, respect the value of `truncate-lines'.
28929 For any other non-nil value, truncate lines in all windows that do
28930 not span the full frame width.
28932 A value of nil means to respect the value of `truncate-lines'.
28934 If `word-wrap' is enabled, you might want to reduce this. */);
28935 Vtruncate_partial_width_windows
= make_number (50);
28937 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
28938 doc
: /* Maximum buffer size for which line number should be displayed.
28939 If the buffer is bigger than this, the line number does not appear
28940 in the mode line. A value of nil means no limit. */);
28941 Vline_number_display_limit
= Qnil
;
28943 DEFVAR_INT ("line-number-display-limit-width",
28944 line_number_display_limit_width
,
28945 doc
: /* Maximum line width (in characters) for line number display.
28946 If the average length of the lines near point is bigger than this, then the
28947 line number may be omitted from the mode line. */);
28948 line_number_display_limit_width
= 200;
28950 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
28951 doc
: /* Non-nil means highlight region even in nonselected windows. */);
28952 highlight_nonselected_windows
= 0;
28954 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
28955 doc
: /* Non-nil if more than one frame is visible on this display.
28956 Minibuffer-only frames don't count, but iconified frames do.
28957 This variable is not guaranteed to be accurate except while processing
28958 `frame-title-format' and `icon-title-format'. */);
28960 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
28961 doc
: /* Template for displaying the title bar of visible frames.
28962 \(Assuming the window manager supports this feature.)
28964 This variable has the same structure as `mode-line-format', except that
28965 the %c and %l constructs are ignored. It is used only on frames for
28966 which no explicit name has been set \(see `modify-frame-parameters'). */);
28968 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
28969 doc
: /* Template for displaying the title bar of an iconified frame.
28970 \(Assuming the window manager supports this feature.)
28971 This variable has the same structure as `mode-line-format' (which see),
28972 and is used only on frames for which no explicit name has been set
28973 \(see `modify-frame-parameters'). */);
28975 = Vframe_title_format
28976 = listn (CONSTYPE_PURE
, 3,
28977 intern_c_string ("multiple-frames"),
28978 build_pure_c_string ("%b"),
28979 listn (CONSTYPE_PURE
, 4,
28980 empty_unibyte_string
,
28981 intern_c_string ("invocation-name"),
28982 build_pure_c_string ("@"),
28983 intern_c_string ("system-name")));
28985 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
28986 doc
: /* Maximum number of lines to keep in the message log buffer.
28987 If nil, disable message logging. If t, log messages but don't truncate
28988 the buffer when it becomes large. */);
28989 Vmessage_log_max
= make_number (1000);
28991 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
28992 doc
: /* Functions called before redisplay, if window sizes have changed.
28993 The value should be a list of functions that take one argument.
28994 Just before redisplay, for each frame, if any of its windows have changed
28995 size since the last redisplay, or have been split or deleted,
28996 all the functions in the list are called, with the frame as argument. */);
28997 Vwindow_size_change_functions
= Qnil
;
28999 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
29000 doc
: /* List of functions to call before redisplaying a window with scrolling.
29001 Each function is called with two arguments, the window and its new
29002 display-start position. Note that these functions are also called by
29003 `set-window-buffer'. Also note that the value of `window-end' is not
29004 valid when these functions are called.
29006 Warning: Do not use this feature to alter the way the window
29007 is scrolled. It is not designed for that, and such use probably won't
29009 Vwindow_scroll_functions
= Qnil
;
29011 DEFVAR_LISP ("window-text-change-functions",
29012 Vwindow_text_change_functions
,
29013 doc
: /* Functions to call in redisplay when text in the window might change. */);
29014 Vwindow_text_change_functions
= Qnil
;
29016 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
29017 doc
: /* Functions called when redisplay of a window reaches the end trigger.
29018 Each function is called with two arguments, the window and the end trigger value.
29019 See `set-window-redisplay-end-trigger'. */);
29020 Vredisplay_end_trigger_functions
= Qnil
;
29022 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
29023 doc
: /* Non-nil means autoselect window with mouse pointer.
29024 If nil, do not autoselect windows.
29025 A positive number means delay autoselection by that many seconds: a
29026 window is autoselected only after the mouse has remained in that
29027 window for the duration of the delay.
29028 A negative number has a similar effect, but causes windows to be
29029 autoselected only after the mouse has stopped moving. \(Because of
29030 the way Emacs compares mouse events, you will occasionally wait twice
29031 that time before the window gets selected.\)
29032 Any other value means to autoselect window instantaneously when the
29033 mouse pointer enters it.
29035 Autoselection selects the minibuffer only if it is active, and never
29036 unselects the minibuffer if it is active.
29038 When customizing this variable make sure that the actual value of
29039 `focus-follows-mouse' matches the behavior of your window manager. */);
29040 Vmouse_autoselect_window
= Qnil
;
29042 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
29043 doc
: /* Non-nil means automatically resize tool-bars.
29044 This dynamically changes the tool-bar's height to the minimum height
29045 that is needed to make all tool-bar items visible.
29046 If value is `grow-only', the tool-bar's height is only increased
29047 automatically; to decrease the tool-bar height, use \\[recenter]. */);
29048 Vauto_resize_tool_bars
= Qt
;
29050 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
29051 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
29052 auto_raise_tool_bar_buttons_p
= 1;
29054 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
29055 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
29056 make_cursor_line_fully_visible_p
= 1;
29058 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
29059 doc
: /* Border below tool-bar in pixels.
29060 If an integer, use it as the height of the border.
29061 If it is one of `internal-border-width' or `border-width', use the
29062 value of the corresponding frame parameter.
29063 Otherwise, no border is added below the tool-bar. */);
29064 Vtool_bar_border
= Qinternal_border_width
;
29066 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
29067 doc
: /* Margin around tool-bar buttons in pixels.
29068 If an integer, use that for both horizontal and vertical margins.
29069 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
29070 HORZ specifying the horizontal margin, and VERT specifying the
29071 vertical margin. */);
29072 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
29074 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
29075 doc
: /* Relief thickness of tool-bar buttons. */);
29076 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
29078 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
29079 doc
: /* Tool bar style to use.
29081 image - show images only
29082 text - show text only
29083 both - show both, text below image
29084 both-horiz - show text to the right of the image
29085 text-image-horiz - show text to the left of the image
29086 any other - use system default or image if no system default.
29088 This variable only affects the GTK+ toolkit version of Emacs. */);
29089 Vtool_bar_style
= Qnil
;
29091 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
29092 doc
: /* Maximum number of characters a label can have to be shown.
29093 The tool bar style must also show labels for this to have any effect, see
29094 `tool-bar-style'. */);
29095 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
29097 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
29098 doc
: /* List of functions to call to fontify regions of text.
29099 Each function is called with one argument POS. Functions must
29100 fontify a region starting at POS in the current buffer, and give
29101 fontified regions the property `fontified'. */);
29102 Vfontification_functions
= Qnil
;
29103 Fmake_variable_buffer_local (Qfontification_functions
);
29105 DEFVAR_BOOL ("unibyte-display-via-language-environment",
29106 unibyte_display_via_language_environment
,
29107 doc
: /* Non-nil means display unibyte text according to language environment.
29108 Specifically, this means that raw bytes in the range 160-255 decimal
29109 are displayed by converting them to the equivalent multibyte characters
29110 according to the current language environment. As a result, they are
29111 displayed according to the current fontset.
29113 Note that this variable affects only how these bytes are displayed,
29114 but does not change the fact they are interpreted as raw bytes. */);
29115 unibyte_display_via_language_environment
= 0;
29117 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
29118 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
29119 If a float, it specifies a fraction of the mini-window frame's height.
29120 If an integer, it specifies a number of lines. */);
29121 Vmax_mini_window_height
= make_float (0.25);
29123 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
29124 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
29125 A value of nil means don't automatically resize mini-windows.
29126 A value of t means resize them to fit the text displayed in them.
29127 A value of `grow-only', the default, means let mini-windows grow only;
29128 they return to their normal size when the minibuffer is closed, or the
29129 echo area becomes empty. */);
29130 Vresize_mini_windows
= Qgrow_only
;
29132 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
29133 doc
: /* Alist specifying how to blink the cursor off.
29134 Each element has the form (ON-STATE . OFF-STATE). Whenever the
29135 `cursor-type' frame-parameter or variable equals ON-STATE,
29136 comparing using `equal', Emacs uses OFF-STATE to specify
29137 how to blink it off. ON-STATE and OFF-STATE are values for
29138 the `cursor-type' frame parameter.
29140 If a frame's ON-STATE has no entry in this list,
29141 the frame's other specifications determine how to blink the cursor off. */);
29142 Vblink_cursor_alist
= Qnil
;
29144 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
29145 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
29146 If non-nil, windows are automatically scrolled horizontally to make
29147 point visible. */);
29148 automatic_hscrolling_p
= 1;
29149 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
29151 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
29152 doc
: /* How many columns away from the window edge point is allowed to get
29153 before automatic hscrolling will horizontally scroll the window. */);
29154 hscroll_margin
= 5;
29156 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
29157 doc
: /* How many columns to scroll the window when point gets too close to the edge.
29158 When point is less than `hscroll-margin' columns from the window
29159 edge, automatic hscrolling will scroll the window by the amount of columns
29160 determined by this variable. If its value is a positive integer, scroll that
29161 many columns. If it's a positive floating-point number, it specifies the
29162 fraction of the window's width to scroll. If it's nil or zero, point will be
29163 centered horizontally after the scroll. Any other value, including negative
29164 numbers, are treated as if the value were zero.
29166 Automatic hscrolling always moves point outside the scroll margin, so if
29167 point was more than scroll step columns inside the margin, the window will
29168 scroll more than the value given by the scroll step.
29170 Note that the lower bound for automatic hscrolling specified by `scroll-left'
29171 and `scroll-right' overrides this variable's effect. */);
29172 Vhscroll_step
= make_number (0);
29174 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
29175 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
29176 Bind this around calls to `message' to let it take effect. */);
29177 message_truncate_lines
= 0;
29179 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
29180 doc
: /* Normal hook run to update the menu bar definitions.
29181 Redisplay runs this hook before it redisplays the menu bar.
29182 This is used to update submenus such as Buffers,
29183 whose contents depend on various data. */);
29184 Vmenu_bar_update_hook
= Qnil
;
29186 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
29187 doc
: /* Frame for which we are updating a menu.
29188 The enable predicate for a menu binding should check this variable. */);
29189 Vmenu_updating_frame
= Qnil
;
29191 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
29192 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
29193 inhibit_menubar_update
= 0;
29195 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
29196 doc
: /* Prefix prepended to all continuation lines at display time.
29197 The value may be a string, an image, or a stretch-glyph; it is
29198 interpreted in the same way as the value of a `display' text property.
29200 This variable is overridden by any `wrap-prefix' text or overlay
29203 To add a prefix to non-continuation lines, use `line-prefix'. */);
29204 Vwrap_prefix
= Qnil
;
29205 DEFSYM (Qwrap_prefix
, "wrap-prefix");
29206 Fmake_variable_buffer_local (Qwrap_prefix
);
29208 DEFVAR_LISP ("line-prefix", Vline_prefix
,
29209 doc
: /* Prefix prepended to all non-continuation lines at display time.
29210 The value may be a string, an image, or a stretch-glyph; it is
29211 interpreted in the same way as the value of a `display' text property.
29213 This variable is overridden by any `line-prefix' text or overlay
29216 To add a prefix to continuation lines, use `wrap-prefix'. */);
29217 Vline_prefix
= Qnil
;
29218 DEFSYM (Qline_prefix
, "line-prefix");
29219 Fmake_variable_buffer_local (Qline_prefix
);
29221 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
29222 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
29223 inhibit_eval_during_redisplay
= 0;
29225 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
29226 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
29227 inhibit_free_realized_faces
= 0;
29230 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
29231 doc
: /* Inhibit try_window_id display optimization. */);
29232 inhibit_try_window_id
= 0;
29234 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
29235 doc
: /* Inhibit try_window_reusing display optimization. */);
29236 inhibit_try_window_reusing
= 0;
29238 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
29239 doc
: /* Inhibit try_cursor_movement display optimization. */);
29240 inhibit_try_cursor_movement
= 0;
29241 #endif /* GLYPH_DEBUG */
29243 DEFVAR_INT ("overline-margin", overline_margin
,
29244 doc
: /* Space between overline and text, in pixels.
29245 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
29246 margin to the character height. */);
29247 overline_margin
= 2;
29249 DEFVAR_INT ("underline-minimum-offset",
29250 underline_minimum_offset
,
29251 doc
: /* Minimum distance between baseline and underline.
29252 This can improve legibility of underlined text at small font sizes,
29253 particularly when using variable `x-use-underline-position-properties'
29254 with fonts that specify an UNDERLINE_POSITION relatively close to the
29255 baseline. The default value is 1. */);
29256 underline_minimum_offset
= 1;
29258 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
29259 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
29260 This feature only works when on a window system that can change
29261 cursor shapes. */);
29262 display_hourglass_p
= 1;
29264 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
29265 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
29266 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
29268 hourglass_atimer
= NULL
;
29269 hourglass_shown_p
= 0;
29271 DEFSYM (Qglyphless_char
, "glyphless-char");
29272 DEFSYM (Qhex_code
, "hex-code");
29273 DEFSYM (Qempty_box
, "empty-box");
29274 DEFSYM (Qthin_space
, "thin-space");
29275 DEFSYM (Qzero_width
, "zero-width");
29277 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
29278 /* Intern this now in case it isn't already done.
29279 Setting this variable twice is harmless.
29280 But don't staticpro it here--that is done in alloc.c. */
29281 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
29282 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
29284 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
29285 doc
: /* Char-table defining glyphless characters.
29286 Each element, if non-nil, should be one of the following:
29287 an ASCII acronym string: display this string in a box
29288 `hex-code': display the hexadecimal code of a character in a box
29289 `empty-box': display as an empty box
29290 `thin-space': display as 1-pixel width space
29291 `zero-width': don't display
29292 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
29293 display method for graphical terminals and text terminals respectively.
29294 GRAPHICAL and TEXT should each have one of the values listed above.
29296 The char-table has one extra slot to control the display of a character for
29297 which no font is found. This slot only takes effect on graphical terminals.
29298 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
29299 `thin-space'. The default is `empty-box'. */);
29300 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
29301 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
29304 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
29305 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
29306 Vdebug_on_message
= Qnil
;
29310 /* Initialize this module when Emacs starts. */
29315 current_header_line_height
= current_mode_line_height
= -1;
29317 CHARPOS (this_line_start_pos
) = 0;
29319 if (!noninteractive
)
29321 struct window
*m
= XWINDOW (minibuf_window
);
29322 Lisp_Object frame
= m
->frame
;
29323 struct frame
*f
= XFRAME (frame
);
29324 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
29325 struct window
*r
= XWINDOW (root
);
29328 echo_area_window
= minibuf_window
;
29330 wset_top_line (r
, make_number (FRAME_TOP_MARGIN (f
)));
29332 (r
, make_number (FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
)));
29333 wset_total_cols (r
, make_number (FRAME_COLS (f
)));
29334 wset_top_line (m
, make_number (FRAME_LINES (f
) - 1));
29335 wset_total_lines (m
, make_number (1));
29336 wset_total_cols (m
, make_number (FRAME_COLS (f
)));
29338 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
29339 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
29340 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
29342 /* The default ellipsis glyphs `...'. */
29343 for (i
= 0; i
< 3; ++i
)
29344 default_invis_vector
[i
] = make_number ('.');
29348 /* Allocate the buffer for frame titles.
29349 Also used for `format-mode-line'. */
29351 mode_line_noprop_buf
= xmalloc (size
);
29352 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
29353 mode_line_noprop_ptr
= mode_line_noprop_buf
;
29354 mode_line_target
= MODE_LINE_DISPLAY
;
29357 help_echo_showing_p
= 0;
29360 /* Platform-independent portion of hourglass implementation. */
29362 /* Cancel a currently active hourglass timer, and start a new one. */
29364 start_hourglass (void)
29366 #if defined (HAVE_WINDOW_SYSTEM)
29369 cancel_hourglass ();
29371 if (INTEGERP (Vhourglass_delay
)
29372 && XINT (Vhourglass_delay
) > 0)
29373 delay
= make_emacs_time (min (XINT (Vhourglass_delay
),
29374 TYPE_MAXIMUM (time_t)),
29376 else if (FLOATP (Vhourglass_delay
)
29377 && XFLOAT_DATA (Vhourglass_delay
) > 0)
29378 delay
= EMACS_TIME_FROM_DOUBLE (XFLOAT_DATA (Vhourglass_delay
));
29380 delay
= make_emacs_time (DEFAULT_HOURGLASS_DELAY
, 0);
29383 w32_note_current_window ();
29386 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
29387 show_hourglass
, NULL
);
29392 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
29395 cancel_hourglass (void)
29397 #if defined (HAVE_WINDOW_SYSTEM)
29398 if (hourglass_atimer
)
29400 cancel_atimer (hourglass_atimer
);
29401 hourglass_atimer
= NULL
;
29404 if (hourglass_shown_p
)