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
);
6305 /* This make the information stored in it->cmp_it invalidate. */
6310 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6311 If S is non-null, it is a C string to iterate over. Otherwise,
6312 STRING gives a Lisp string to iterate over.
6314 If PRECISION > 0, don't return more then PRECISION number of
6315 characters from the string.
6317 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6318 characters have been returned. FIELD_WIDTH < 0 means an infinite
6321 MULTIBYTE = 0 means disable processing of multibyte characters,
6322 MULTIBYTE > 0 means enable it,
6323 MULTIBYTE < 0 means use IT->multibyte_p.
6325 IT must be initialized via a prior call to init_iterator before
6326 calling this function. */
6329 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6330 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6333 /* No region in strings. */
6334 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
6336 /* No text property checks performed by default, but see below. */
6337 it
->stop_charpos
= -1;
6339 /* Set iterator position and end position. */
6340 memset (&it
->current
, 0, sizeof it
->current
);
6341 it
->current
.overlay_string_index
= -1;
6342 it
->current
.dpvec_index
= -1;
6343 eassert (charpos
>= 0);
6345 /* If STRING is specified, use its multibyteness, otherwise use the
6346 setting of MULTIBYTE, if specified. */
6348 it
->multibyte_p
= multibyte
> 0;
6350 /* Bidirectional reordering of strings is controlled by the default
6351 value of bidi-display-reordering. Don't try to reorder while
6352 loading loadup.el, as the necessary character property tables are
6353 not yet available. */
6356 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6360 eassert (STRINGP (string
));
6361 it
->string
= string
;
6363 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6364 it
->method
= GET_FROM_STRING
;
6365 it
->current
.string_pos
= string_pos (charpos
, string
);
6369 it
->bidi_it
.string
.lstring
= string
;
6370 it
->bidi_it
.string
.s
= NULL
;
6371 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6372 it
->bidi_it
.string
.bufpos
= 0;
6373 it
->bidi_it
.string
.from_disp_str
= 0;
6374 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6375 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6376 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6381 it
->s
= (const unsigned char *) s
;
6384 /* Note that we use IT->current.pos, not it->current.string_pos,
6385 for displaying C strings. */
6386 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6387 if (it
->multibyte_p
)
6389 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6390 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6394 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6395 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6400 it
->bidi_it
.string
.lstring
= Qnil
;
6401 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6402 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6403 it
->bidi_it
.string
.bufpos
= 0;
6404 it
->bidi_it
.string
.from_disp_str
= 0;
6405 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6406 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6409 it
->method
= GET_FROM_C_STRING
;
6412 /* PRECISION > 0 means don't return more than PRECISION characters
6414 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6416 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6418 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6421 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6422 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6423 FIELD_WIDTH < 0 means infinite field width. This is useful for
6424 padding with `-' at the end of a mode line. */
6425 if (field_width
< 0)
6426 field_width
= INFINITY
;
6427 /* Implementation note: We deliberately don't enlarge
6428 it->bidi_it.string.schars here to fit it->end_charpos, because
6429 the bidi iterator cannot produce characters out of thin air. */
6430 if (field_width
> it
->end_charpos
- charpos
)
6431 it
->end_charpos
= charpos
+ field_width
;
6433 /* Use the standard display table for displaying strings. */
6434 if (DISP_TABLE_P (Vstandard_display_table
))
6435 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6437 it
->stop_charpos
= charpos
;
6438 it
->prev_stop
= charpos
;
6439 it
->base_level_stop
= 0;
6442 it
->bidi_it
.first_elt
= 1;
6443 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6444 it
->bidi_it
.disp_pos
= -1;
6446 if (s
== NULL
&& it
->multibyte_p
)
6448 ptrdiff_t endpos
= SCHARS (it
->string
);
6449 if (endpos
> it
->end_charpos
)
6450 endpos
= it
->end_charpos
;
6451 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6459 /***********************************************************************
6461 ***********************************************************************/
6463 /* Map enum it_method value to corresponding next_element_from_* function. */
6465 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6467 next_element_from_buffer
,
6468 next_element_from_display_vector
,
6469 next_element_from_string
,
6470 next_element_from_c_string
,
6471 next_element_from_image
,
6472 next_element_from_stretch
6475 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6478 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6479 (possibly with the following characters). */
6481 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6482 ((IT)->cmp_it.id >= 0 \
6483 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6484 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6485 END_CHARPOS, (IT)->w, \
6486 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6490 /* Lookup the char-table Vglyphless_char_display for character C (-1
6491 if we want information for no-font case), and return the display
6492 method symbol. By side-effect, update it->what and
6493 it->glyphless_method. This function is called from
6494 get_next_display_element for each character element, and from
6495 x_produce_glyphs when no suitable font was found. */
6498 lookup_glyphless_char_display (int c
, struct it
*it
)
6500 Lisp_Object glyphless_method
= Qnil
;
6502 if (CHAR_TABLE_P (Vglyphless_char_display
)
6503 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6507 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6508 if (CONSP (glyphless_method
))
6509 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6510 ? XCAR (glyphless_method
)
6511 : XCDR (glyphless_method
);
6514 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6518 if (NILP (glyphless_method
))
6521 /* The default is to display the character by a proper font. */
6523 /* The default for the no-font case is to display an empty box. */
6524 glyphless_method
= Qempty_box
;
6526 if (EQ (glyphless_method
, Qzero_width
))
6529 return glyphless_method
;
6530 /* This method can't be used for the no-font case. */
6531 glyphless_method
= Qempty_box
;
6533 if (EQ (glyphless_method
, Qthin_space
))
6534 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6535 else if (EQ (glyphless_method
, Qempty_box
))
6536 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6537 else if (EQ (glyphless_method
, Qhex_code
))
6538 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6539 else if (STRINGP (glyphless_method
))
6540 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6543 /* Invalid value. We use the default method. */
6544 glyphless_method
= Qnil
;
6547 it
->what
= IT_GLYPHLESS
;
6548 return glyphless_method
;
6551 /* Load IT's display element fields with information about the next
6552 display element from the current position of IT. Value is zero if
6553 end of buffer (or C string) is reached. */
6555 static struct frame
*last_escape_glyph_frame
= NULL
;
6556 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6557 static int last_escape_glyph_merged_face_id
= 0;
6559 struct frame
*last_glyphless_glyph_frame
= NULL
;
6560 int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6561 int last_glyphless_glyph_merged_face_id
= 0;
6564 get_next_display_element (struct it
*it
)
6566 /* Non-zero means that we found a display element. Zero means that
6567 we hit the end of what we iterate over. Performance note: the
6568 function pointer `method' used here turns out to be faster than
6569 using a sequence of if-statements. */
6573 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6575 if (it
->what
== IT_CHARACTER
)
6577 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6578 and only if (a) the resolved directionality of that character
6580 /* FIXME: Do we need an exception for characters from display
6582 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6583 it
->c
= bidi_mirror_char (it
->c
);
6584 /* Map via display table or translate control characters.
6585 IT->c, IT->len etc. have been set to the next character by
6586 the function call above. If we have a display table, and it
6587 contains an entry for IT->c, translate it. Don't do this if
6588 IT->c itself comes from a display table, otherwise we could
6589 end up in an infinite recursion. (An alternative could be to
6590 count the recursion depth of this function and signal an
6591 error when a certain maximum depth is reached.) Is it worth
6593 if (success_p
&& it
->dpvec
== NULL
)
6596 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6597 int nonascii_space_p
= 0;
6598 int nonascii_hyphen_p
= 0;
6599 int c
= it
->c
; /* This is the character to display. */
6601 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6603 eassert (SINGLE_BYTE_CHAR_P (c
));
6604 if (unibyte_display_via_language_environment
)
6606 c
= DECODE_CHAR (unibyte
, c
);
6608 c
= BYTE8_TO_CHAR (it
->c
);
6611 c
= BYTE8_TO_CHAR (it
->c
);
6615 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6618 struct Lisp_Vector
*v
= XVECTOR (dv
);
6620 /* Return the first character from the display table
6621 entry, if not empty. If empty, don't display the
6622 current character. */
6625 it
->dpvec_char_len
= it
->len
;
6626 it
->dpvec
= v
->contents
;
6627 it
->dpend
= v
->contents
+ v
->header
.size
;
6628 it
->current
.dpvec_index
= 0;
6629 it
->dpvec_face_id
= -1;
6630 it
->saved_face_id
= it
->face_id
;
6631 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6636 set_iterator_to_next (it
, 0);
6641 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6643 if (it
->what
== IT_GLYPHLESS
)
6645 /* Don't display this character. */
6646 set_iterator_to_next (it
, 0);
6650 /* If `nobreak-char-display' is non-nil, we display
6651 non-ASCII spaces and hyphens specially. */
6652 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6655 nonascii_space_p
= 1;
6656 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6657 nonascii_hyphen_p
= 1;
6660 /* Translate control characters into `\003' or `^C' form.
6661 Control characters coming from a display table entry are
6662 currently not translated because we use IT->dpvec to hold
6663 the translation. This could easily be changed but I
6664 don't believe that it is worth doing.
6666 The characters handled by `nobreak-char-display' must be
6669 Non-printable characters and raw-byte characters are also
6670 translated to octal form. */
6671 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6672 ? (it
->area
!= TEXT_AREA
6673 /* In mode line, treat \n, \t like other crl chars. */
6676 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6677 || (c
!= '\n' && c
!= '\t'))
6679 || nonascii_hyphen_p
6681 || ! CHAR_PRINTABLE_P (c
))))
6683 /* C is a control character, non-ASCII space/hyphen,
6684 raw-byte, or a non-printable character which must be
6685 displayed either as '\003' or as `^C' where the '\\'
6686 and '^' can be defined in the display table. Fill
6687 IT->ctl_chars with glyphs for what we have to
6688 display. Then, set IT->dpvec to these glyphs. */
6695 /* Handle control characters with ^. */
6697 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6701 g
= '^'; /* default glyph for Control */
6702 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6704 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6706 g
= GLYPH_CODE_CHAR (gc
);
6707 lface_id
= GLYPH_CODE_FACE (gc
);
6711 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6713 else if (it
->f
== last_escape_glyph_frame
6714 && it
->face_id
== last_escape_glyph_face_id
)
6716 face_id
= last_escape_glyph_merged_face_id
;
6720 /* Merge the escape-glyph face into the current face. */
6721 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6723 last_escape_glyph_frame
= it
->f
;
6724 last_escape_glyph_face_id
= it
->face_id
;
6725 last_escape_glyph_merged_face_id
= face_id
;
6728 XSETINT (it
->ctl_chars
[0], g
);
6729 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6731 goto display_control
;
6734 /* Handle non-ascii space in the mode where it only gets
6737 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6739 /* Merge `nobreak-space' into the current face. */
6740 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6742 XSETINT (it
->ctl_chars
[0], ' ');
6744 goto display_control
;
6747 /* Handle sequences that start with the "escape glyph". */
6749 /* the default escape glyph is \. */
6750 escape_glyph
= '\\';
6753 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6755 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6756 lface_id
= GLYPH_CODE_FACE (gc
);
6760 /* The display table specified a face.
6761 Merge it into face_id and also into escape_glyph. */
6762 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6765 else if (it
->f
== last_escape_glyph_frame
6766 && it
->face_id
== last_escape_glyph_face_id
)
6768 face_id
= last_escape_glyph_merged_face_id
;
6772 /* Merge the escape-glyph face into the current face. */
6773 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6775 last_escape_glyph_frame
= it
->f
;
6776 last_escape_glyph_face_id
= it
->face_id
;
6777 last_escape_glyph_merged_face_id
= face_id
;
6780 /* Draw non-ASCII hyphen with just highlighting: */
6782 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6784 XSETINT (it
->ctl_chars
[0], '-');
6786 goto display_control
;
6789 /* Draw non-ASCII space/hyphen with escape glyph: */
6791 if (nonascii_space_p
|| nonascii_hyphen_p
)
6793 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6794 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
6796 goto display_control
;
6803 if (CHAR_BYTE8_P (c
))
6804 /* Display \200 instead of \17777600. */
6805 c
= CHAR_TO_BYTE8 (c
);
6806 len
= sprintf (str
, "%03o", c
);
6808 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6809 for (i
= 0; i
< len
; i
++)
6810 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6815 /* Set up IT->dpvec and return first character from it. */
6816 it
->dpvec_char_len
= it
->len
;
6817 it
->dpvec
= it
->ctl_chars
;
6818 it
->dpend
= it
->dpvec
+ ctl_len
;
6819 it
->current
.dpvec_index
= 0;
6820 it
->dpvec_face_id
= face_id
;
6821 it
->saved_face_id
= it
->face_id
;
6822 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6826 it
->char_to_display
= c
;
6830 it
->char_to_display
= it
->c
;
6834 /* Adjust face id for a multibyte character. There are no multibyte
6835 character in unibyte text. */
6836 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6839 && FRAME_WINDOW_P (it
->f
))
6841 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6843 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6845 /* Automatic composition with glyph-string. */
6846 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6848 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6852 ptrdiff_t pos
= (it
->s
? -1
6853 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6854 : IT_CHARPOS (*it
));
6857 if (it
->what
== IT_CHARACTER
)
6858 c
= it
->char_to_display
;
6861 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6865 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6866 /* TAB in a composition means display glyphs with
6867 padding space on the left or right. */
6868 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6871 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6876 /* Is this character the last one of a run of characters with
6877 box? If yes, set IT->end_of_box_run_p to 1. */
6881 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6883 int face_id
= underlying_face_id (it
);
6884 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6888 if (face
->box
== FACE_NO_BOX
)
6890 /* If the box comes from face properties in a
6891 display string, check faces in that string. */
6892 int string_face_id
= face_after_it_pos (it
);
6893 it
->end_of_box_run_p
6894 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6897 /* Otherwise, the box comes from the underlying face.
6898 If this is the last string character displayed, check
6899 the next buffer location. */
6900 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6901 && (it
->current
.overlay_string_index
6902 == it
->n_overlay_strings
- 1))
6906 struct text_pos pos
= it
->current
.pos
;
6907 INC_TEXT_POS (pos
, it
->multibyte_p
);
6909 next_face_id
= face_at_buffer_position
6910 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6911 it
->region_end_charpos
, &ignore
,
6912 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6914 it
->end_of_box_run_p
6915 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6922 int face_id
= face_after_it_pos (it
);
6923 it
->end_of_box_run_p
6924 = (face_id
!= it
->face_id
6925 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6928 /* If we reached the end of the object we've been iterating (e.g., a
6929 display string or an overlay string), and there's something on
6930 IT->stack, proceed with what's on the stack. It doesn't make
6931 sense to return zero if there's unprocessed stuff on the stack,
6932 because otherwise that stuff will never be displayed. */
6933 if (!success_p
&& it
->sp
> 0)
6935 set_iterator_to_next (it
, 0);
6936 success_p
= get_next_display_element (it
);
6939 /* Value is 0 if end of buffer or string reached. */
6944 /* Move IT to the next display element.
6946 RESEAT_P non-zero means if called on a newline in buffer text,
6947 skip to the next visible line start.
6949 Functions get_next_display_element and set_iterator_to_next are
6950 separate because I find this arrangement easier to handle than a
6951 get_next_display_element function that also increments IT's
6952 position. The way it is we can first look at an iterator's current
6953 display element, decide whether it fits on a line, and if it does,
6954 increment the iterator position. The other way around we probably
6955 would either need a flag indicating whether the iterator has to be
6956 incremented the next time, or we would have to implement a
6957 decrement position function which would not be easy to write. */
6960 set_iterator_to_next (struct it
*it
, int reseat_p
)
6962 /* Reset flags indicating start and end of a sequence of characters
6963 with box. Reset them at the start of this function because
6964 moving the iterator to a new position might set them. */
6965 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6969 case GET_FROM_BUFFER
:
6970 /* The current display element of IT is a character from
6971 current_buffer. Advance in the buffer, and maybe skip over
6972 invisible lines that are so because of selective display. */
6973 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6974 reseat_at_next_visible_line_start (it
, 0);
6975 else if (it
->cmp_it
.id
>= 0)
6977 /* We are currently getting glyphs from a composition. */
6982 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6983 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6984 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6986 it
->cmp_it
.from
= it
->cmp_it
.to
;
6991 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6993 it
->end_charpos
, Qnil
);
6996 else if (! it
->cmp_it
.reversed_p
)
6998 /* Composition created while scanning forward. */
6999 /* Update IT's char/byte positions to point to the first
7000 character of the next grapheme cluster, or to the
7001 character visually after the current composition. */
7002 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7003 bidi_move_to_visually_next (&it
->bidi_it
);
7004 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7005 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7007 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7009 /* Proceed to the next grapheme cluster. */
7010 it
->cmp_it
.from
= it
->cmp_it
.to
;
7014 /* No more grapheme clusters in this composition.
7015 Find the next stop position. */
7016 ptrdiff_t stop
= it
->end_charpos
;
7017 if (it
->bidi_it
.scan_dir
< 0)
7018 /* Now we are scanning backward and don't know
7021 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7022 IT_BYTEPOS (*it
), stop
, Qnil
);
7027 /* Composition created while scanning backward. */
7028 /* Update IT's char/byte positions to point to the last
7029 character of the previous grapheme cluster, or the
7030 character visually after the current composition. */
7031 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7032 bidi_move_to_visually_next (&it
->bidi_it
);
7033 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7034 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7035 if (it
->cmp_it
.from
> 0)
7037 /* Proceed to the previous grapheme cluster. */
7038 it
->cmp_it
.to
= it
->cmp_it
.from
;
7042 /* No more grapheme clusters in this composition.
7043 Find the next stop position. */
7044 ptrdiff_t stop
= it
->end_charpos
;
7045 if (it
->bidi_it
.scan_dir
< 0)
7046 /* Now we are scanning backward and don't know
7049 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7050 IT_BYTEPOS (*it
), stop
, Qnil
);
7056 eassert (it
->len
!= 0);
7060 IT_BYTEPOS (*it
) += it
->len
;
7061 IT_CHARPOS (*it
) += 1;
7065 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7066 /* If this is a new paragraph, determine its base
7067 direction (a.k.a. its base embedding level). */
7068 if (it
->bidi_it
.new_paragraph
)
7069 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7070 bidi_move_to_visually_next (&it
->bidi_it
);
7071 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7072 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7073 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7075 /* As the scan direction was changed, we must
7076 re-compute the stop position for composition. */
7077 ptrdiff_t stop
= it
->end_charpos
;
7078 if (it
->bidi_it
.scan_dir
< 0)
7080 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7081 IT_BYTEPOS (*it
), stop
, Qnil
);
7084 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7088 case GET_FROM_C_STRING
:
7089 /* Current display element of IT is from a C string. */
7091 /* If the string position is beyond string's end, it means
7092 next_element_from_c_string is padding the string with
7093 blanks, in which case we bypass the bidi iterator,
7094 because it cannot deal with such virtual characters. */
7095 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7097 IT_BYTEPOS (*it
) += it
->len
;
7098 IT_CHARPOS (*it
) += 1;
7102 bidi_move_to_visually_next (&it
->bidi_it
);
7103 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7104 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7108 case GET_FROM_DISPLAY_VECTOR
:
7109 /* Current display element of IT is from a display table entry.
7110 Advance in the display table definition. Reset it to null if
7111 end reached, and continue with characters from buffers/
7113 ++it
->current
.dpvec_index
;
7115 /* Restore face of the iterator to what they were before the
7116 display vector entry (these entries may contain faces). */
7117 it
->face_id
= it
->saved_face_id
;
7119 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7121 int recheck_faces
= it
->ellipsis_p
;
7124 it
->method
= GET_FROM_C_STRING
;
7125 else if (STRINGP (it
->string
))
7126 it
->method
= GET_FROM_STRING
;
7129 it
->method
= GET_FROM_BUFFER
;
7130 it
->object
= it
->w
->buffer
;
7134 it
->current
.dpvec_index
= -1;
7136 /* Skip over characters which were displayed via IT->dpvec. */
7137 if (it
->dpvec_char_len
< 0)
7138 reseat_at_next_visible_line_start (it
, 1);
7139 else if (it
->dpvec_char_len
> 0)
7141 if (it
->method
== GET_FROM_STRING
7142 && it
->n_overlay_strings
> 0)
7143 it
->ignore_overlay_strings_at_pos_p
= 1;
7144 it
->len
= it
->dpvec_char_len
;
7145 set_iterator_to_next (it
, reseat_p
);
7148 /* Maybe recheck faces after display vector */
7150 it
->stop_charpos
= IT_CHARPOS (*it
);
7154 case GET_FROM_STRING
:
7155 /* Current display element is a character from a Lisp string. */
7156 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7157 /* Don't advance past string end. These conditions are true
7158 when set_iterator_to_next is called at the end of
7159 get_next_display_element, in which case the Lisp string is
7160 already exhausted, and all we want is pop the iterator
7162 if (it
->current
.overlay_string_index
>= 0)
7164 /* This is an overlay string, so there's no padding with
7165 spaces, and the number of characters in the string is
7166 where the string ends. */
7167 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7168 goto consider_string_end
;
7172 /* Not an overlay string. There could be padding, so test
7173 against it->end_charpos . */
7174 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7175 goto consider_string_end
;
7177 if (it
->cmp_it
.id
>= 0)
7183 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7184 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7185 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7186 it
->cmp_it
.from
= it
->cmp_it
.to
;
7190 composition_compute_stop_pos (&it
->cmp_it
,
7191 IT_STRING_CHARPOS (*it
),
7192 IT_STRING_BYTEPOS (*it
),
7193 it
->end_charpos
, it
->string
);
7196 else if (! it
->cmp_it
.reversed_p
)
7198 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7199 bidi_move_to_visually_next (&it
->bidi_it
);
7200 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7201 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7203 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7204 it
->cmp_it
.from
= it
->cmp_it
.to
;
7207 ptrdiff_t stop
= it
->end_charpos
;
7208 if (it
->bidi_it
.scan_dir
< 0)
7210 composition_compute_stop_pos (&it
->cmp_it
,
7211 IT_STRING_CHARPOS (*it
),
7212 IT_STRING_BYTEPOS (*it
), stop
,
7218 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7219 bidi_move_to_visually_next (&it
->bidi_it
);
7220 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7221 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7222 if (it
->cmp_it
.from
> 0)
7223 it
->cmp_it
.to
= it
->cmp_it
.from
;
7226 ptrdiff_t stop
= it
->end_charpos
;
7227 if (it
->bidi_it
.scan_dir
< 0)
7229 composition_compute_stop_pos (&it
->cmp_it
,
7230 IT_STRING_CHARPOS (*it
),
7231 IT_STRING_BYTEPOS (*it
), stop
,
7239 /* If the string position is beyond string's end, it
7240 means next_element_from_string is padding the string
7241 with blanks, in which case we bypass the bidi
7242 iterator, because it cannot deal with such virtual
7244 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7246 IT_STRING_BYTEPOS (*it
) += it
->len
;
7247 IT_STRING_CHARPOS (*it
) += 1;
7251 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7253 bidi_move_to_visually_next (&it
->bidi_it
);
7254 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7255 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7256 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7258 ptrdiff_t stop
= it
->end_charpos
;
7260 if (it
->bidi_it
.scan_dir
< 0)
7262 composition_compute_stop_pos (&it
->cmp_it
,
7263 IT_STRING_CHARPOS (*it
),
7264 IT_STRING_BYTEPOS (*it
), stop
,
7270 consider_string_end
:
7272 if (it
->current
.overlay_string_index
>= 0)
7274 /* IT->string is an overlay string. Advance to the
7275 next, if there is one. */
7276 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7279 next_overlay_string (it
);
7281 setup_for_ellipsis (it
, 0);
7286 /* IT->string is not an overlay string. If we reached
7287 its end, and there is something on IT->stack, proceed
7288 with what is on the stack. This can be either another
7289 string, this time an overlay string, or a buffer. */
7290 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7294 if (it
->method
== GET_FROM_STRING
)
7295 goto consider_string_end
;
7300 case GET_FROM_IMAGE
:
7301 case GET_FROM_STRETCH
:
7302 /* The position etc with which we have to proceed are on
7303 the stack. The position may be at the end of a string,
7304 if the `display' property takes up the whole string. */
7305 eassert (it
->sp
> 0);
7307 if (it
->method
== GET_FROM_STRING
)
7308 goto consider_string_end
;
7312 /* There are no other methods defined, so this should be a bug. */
7316 eassert (it
->method
!= GET_FROM_STRING
7317 || (STRINGP (it
->string
)
7318 && IT_STRING_CHARPOS (*it
) >= 0));
7321 /* Load IT's display element fields with information about the next
7322 display element which comes from a display table entry or from the
7323 result of translating a control character to one of the forms `^C'
7326 IT->dpvec holds the glyphs to return as characters.
7327 IT->saved_face_id holds the face id before the display vector--it
7328 is restored into IT->face_id in set_iterator_to_next. */
7331 next_element_from_display_vector (struct it
*it
)
7336 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7338 it
->face_id
= it
->saved_face_id
;
7340 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7341 That seemed totally bogus - so I changed it... */
7342 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7344 if (GLYPH_CODE_P (gc
))
7346 it
->c
= GLYPH_CODE_CHAR (gc
);
7347 it
->len
= CHAR_BYTES (it
->c
);
7349 /* The entry may contain a face id to use. Such a face id is
7350 the id of a Lisp face, not a realized face. A face id of
7351 zero means no face is specified. */
7352 if (it
->dpvec_face_id
>= 0)
7353 it
->face_id
= it
->dpvec_face_id
;
7356 int lface_id
= GLYPH_CODE_FACE (gc
);
7358 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7363 /* Display table entry is invalid. Return a space. */
7364 it
->c
= ' ', it
->len
= 1;
7366 /* Don't change position and object of the iterator here. They are
7367 still the values of the character that had this display table
7368 entry or was translated, and that's what we want. */
7369 it
->what
= IT_CHARACTER
;
7373 /* Get the first element of string/buffer in the visual order, after
7374 being reseated to a new position in a string or a buffer. */
7376 get_visually_first_element (struct it
*it
)
7378 int string_p
= STRINGP (it
->string
) || it
->s
;
7379 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7380 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7382 if (STRINGP (it
->string
))
7384 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7385 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7389 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7390 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7393 if (it
->bidi_it
.charpos
== eob
)
7395 /* Nothing to do, but reset the FIRST_ELT flag, like
7396 bidi_paragraph_init does, because we are not going to
7398 it
->bidi_it
.first_elt
= 0;
7400 else if (it
->bidi_it
.charpos
== bob
7402 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7403 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7405 /* If we are at the beginning of a line/string, we can produce
7406 the next element right away. */
7407 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7408 bidi_move_to_visually_next (&it
->bidi_it
);
7412 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7414 /* We need to prime the bidi iterator starting at the line's or
7415 string's beginning, before we will be able to produce the
7418 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7421 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
7423 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
7425 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7428 /* Now return to buffer/string position where we were asked
7429 to get the next display element, and produce that. */
7430 bidi_move_to_visually_next (&it
->bidi_it
);
7432 while (it
->bidi_it
.bytepos
!= orig_bytepos
7433 && it
->bidi_it
.charpos
< eob
);
7436 /* Adjust IT's position information to where we ended up. */
7437 if (STRINGP (it
->string
))
7439 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7440 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7444 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7445 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7448 if (STRINGP (it
->string
) || !it
->s
)
7450 ptrdiff_t stop
, charpos
, bytepos
;
7452 if (STRINGP (it
->string
))
7455 stop
= SCHARS (it
->string
);
7456 if (stop
> it
->end_charpos
)
7457 stop
= it
->end_charpos
;
7458 charpos
= IT_STRING_CHARPOS (*it
);
7459 bytepos
= IT_STRING_BYTEPOS (*it
);
7463 stop
= it
->end_charpos
;
7464 charpos
= IT_CHARPOS (*it
);
7465 bytepos
= IT_BYTEPOS (*it
);
7467 if (it
->bidi_it
.scan_dir
< 0)
7469 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7474 /* Load IT with the next display element from Lisp string IT->string.
7475 IT->current.string_pos is the current position within the string.
7476 If IT->current.overlay_string_index >= 0, the Lisp string is an
7480 next_element_from_string (struct it
*it
)
7482 struct text_pos position
;
7484 eassert (STRINGP (it
->string
));
7485 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7486 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7487 position
= it
->current
.string_pos
;
7489 /* With bidi reordering, the character to display might not be the
7490 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7491 that we were reseat()ed to a new string, whose paragraph
7492 direction is not known. */
7493 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7495 get_visually_first_element (it
);
7496 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7499 /* Time to check for invisible text? */
7500 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7502 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7505 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7506 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7508 /* With bidi non-linear iteration, we could find
7509 ourselves far beyond the last computed stop_charpos,
7510 with several other stop positions in between that we
7511 missed. Scan them all now, in buffer's logical
7512 order, until we find and handle the last stop_charpos
7513 that precedes our current position. */
7514 handle_stop_backwards (it
, it
->stop_charpos
);
7515 return GET_NEXT_DISPLAY_ELEMENT (it
);
7521 /* Take note of the stop position we just moved
7522 across, for when we will move back across it. */
7523 it
->prev_stop
= it
->stop_charpos
;
7524 /* If we are at base paragraph embedding level, take
7525 note of the last stop position seen at this
7527 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7528 it
->base_level_stop
= it
->stop_charpos
;
7532 /* Since a handler may have changed IT->method, we must
7534 return GET_NEXT_DISPLAY_ELEMENT (it
);
7538 /* If we are before prev_stop, we may have overstepped
7539 on our way backwards a stop_pos, and if so, we need
7540 to handle that stop_pos. */
7541 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7542 /* We can sometimes back up for reasons that have nothing
7543 to do with bidi reordering. E.g., compositions. The
7544 code below is only needed when we are above the base
7545 embedding level, so test for that explicitly. */
7546 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7548 /* If we lost track of base_level_stop, we have no better
7549 place for handle_stop_backwards to start from than string
7550 beginning. This happens, e.g., when we were reseated to
7551 the previous screenful of text by vertical-motion. */
7552 if (it
->base_level_stop
<= 0
7553 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7554 it
->base_level_stop
= 0;
7555 handle_stop_backwards (it
, it
->base_level_stop
);
7556 return GET_NEXT_DISPLAY_ELEMENT (it
);
7560 if (it
->current
.overlay_string_index
>= 0)
7562 /* Get the next character from an overlay string. In overlay
7563 strings, there is no field width or padding with spaces to
7565 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7570 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7571 IT_STRING_BYTEPOS (*it
),
7572 it
->bidi_it
.scan_dir
< 0
7574 : SCHARS (it
->string
))
7575 && next_element_from_composition (it
))
7579 else if (STRING_MULTIBYTE (it
->string
))
7581 const unsigned char *s
= (SDATA (it
->string
)
7582 + IT_STRING_BYTEPOS (*it
));
7583 it
->c
= string_char_and_length (s
, &it
->len
);
7587 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7593 /* Get the next character from a Lisp string that is not an
7594 overlay string. Such strings come from the mode line, for
7595 example. We may have to pad with spaces, or truncate the
7596 string. See also next_element_from_c_string. */
7597 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7602 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7604 /* Pad with spaces. */
7605 it
->c
= ' ', it
->len
= 1;
7606 CHARPOS (position
) = BYTEPOS (position
) = -1;
7608 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7609 IT_STRING_BYTEPOS (*it
),
7610 it
->bidi_it
.scan_dir
< 0
7612 : it
->string_nchars
)
7613 && next_element_from_composition (it
))
7617 else if (STRING_MULTIBYTE (it
->string
))
7619 const unsigned char *s
= (SDATA (it
->string
)
7620 + IT_STRING_BYTEPOS (*it
));
7621 it
->c
= string_char_and_length (s
, &it
->len
);
7625 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7630 /* Record what we have and where it came from. */
7631 it
->what
= IT_CHARACTER
;
7632 it
->object
= it
->string
;
7633 it
->position
= position
;
7638 /* Load IT with next display element from C string IT->s.
7639 IT->string_nchars is the maximum number of characters to return
7640 from the string. IT->end_charpos may be greater than
7641 IT->string_nchars when this function is called, in which case we
7642 may have to return padding spaces. Value is zero if end of string
7643 reached, including padding spaces. */
7646 next_element_from_c_string (struct it
*it
)
7651 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7652 it
->what
= IT_CHARACTER
;
7653 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7656 /* With bidi reordering, the character to display might not be the
7657 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7658 we were reseated to a new string, whose paragraph direction is
7660 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7661 get_visually_first_element (it
);
7663 /* IT's position can be greater than IT->string_nchars in case a
7664 field width or precision has been specified when the iterator was
7666 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7668 /* End of the game. */
7672 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7674 /* Pad with spaces. */
7675 it
->c
= ' ', it
->len
= 1;
7676 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7678 else if (it
->multibyte_p
)
7679 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7681 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7687 /* Set up IT to return characters from an ellipsis, if appropriate.
7688 The definition of the ellipsis glyphs may come from a display table
7689 entry. This function fills IT with the first glyph from the
7690 ellipsis if an ellipsis is to be displayed. */
7693 next_element_from_ellipsis (struct it
*it
)
7695 if (it
->selective_display_ellipsis_p
)
7696 setup_for_ellipsis (it
, it
->len
);
7699 /* The face at the current position may be different from the
7700 face we find after the invisible text. Remember what it
7701 was in IT->saved_face_id, and signal that it's there by
7702 setting face_before_selective_p. */
7703 it
->saved_face_id
= it
->face_id
;
7704 it
->method
= GET_FROM_BUFFER
;
7705 it
->object
= it
->w
->buffer
;
7706 reseat_at_next_visible_line_start (it
, 1);
7707 it
->face_before_selective_p
= 1;
7710 return GET_NEXT_DISPLAY_ELEMENT (it
);
7714 /* Deliver an image display element. The iterator IT is already
7715 filled with image information (done in handle_display_prop). Value
7720 next_element_from_image (struct it
*it
)
7722 it
->what
= IT_IMAGE
;
7723 it
->ignore_overlay_strings_at_pos_p
= 0;
7728 /* Fill iterator IT with next display element from a stretch glyph
7729 property. IT->object is the value of the text property. Value is
7733 next_element_from_stretch (struct it
*it
)
7735 it
->what
= IT_STRETCH
;
7739 /* Scan backwards from IT's current position until we find a stop
7740 position, or until BEGV. This is called when we find ourself
7741 before both the last known prev_stop and base_level_stop while
7742 reordering bidirectional text. */
7745 compute_stop_pos_backwards (struct it
*it
)
7747 const int SCAN_BACK_LIMIT
= 1000;
7748 struct text_pos pos
;
7749 struct display_pos save_current
= it
->current
;
7750 struct text_pos save_position
= it
->position
;
7751 ptrdiff_t charpos
= IT_CHARPOS (*it
);
7752 ptrdiff_t where_we_are
= charpos
;
7753 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
7754 ptrdiff_t save_end_pos
= it
->end_charpos
;
7756 eassert (NILP (it
->string
) && !it
->s
);
7757 eassert (it
->bidi_p
);
7761 it
->end_charpos
= min (charpos
+ 1, ZV
);
7762 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7763 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
7764 reseat_1 (it
, pos
, 0);
7765 compute_stop_pos (it
);
7766 /* We must advance forward, right? */
7767 if (it
->stop_charpos
<= charpos
)
7770 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7772 if (it
->stop_charpos
<= where_we_are
)
7773 it
->prev_stop
= it
->stop_charpos
;
7775 it
->prev_stop
= BEGV
;
7777 it
->current
= save_current
;
7778 it
->position
= save_position
;
7779 it
->stop_charpos
= save_stop_pos
;
7780 it
->end_charpos
= save_end_pos
;
7783 /* Scan forward from CHARPOS in the current buffer/string, until we
7784 find a stop position > current IT's position. Then handle the stop
7785 position before that. This is called when we bump into a stop
7786 position while reordering bidirectional text. CHARPOS should be
7787 the last previously processed stop_pos (or BEGV/0, if none were
7788 processed yet) whose position is less that IT's current
7792 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
7794 int bufp
= !STRINGP (it
->string
);
7795 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7796 struct display_pos save_current
= it
->current
;
7797 struct text_pos save_position
= it
->position
;
7798 struct text_pos pos1
;
7799 ptrdiff_t next_stop
;
7801 /* Scan in strict logical order. */
7802 eassert (it
->bidi_p
);
7806 it
->prev_stop
= charpos
;
7809 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7810 reseat_1 (it
, pos1
, 0);
7813 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7814 compute_stop_pos (it
);
7815 /* We must advance forward, right? */
7816 if (it
->stop_charpos
<= it
->prev_stop
)
7818 charpos
= it
->stop_charpos
;
7820 while (charpos
<= where_we_are
);
7823 it
->current
= save_current
;
7824 it
->position
= save_position
;
7825 next_stop
= it
->stop_charpos
;
7826 it
->stop_charpos
= it
->prev_stop
;
7828 it
->stop_charpos
= next_stop
;
7831 /* Load IT with the next display element from current_buffer. Value
7832 is zero if end of buffer reached. IT->stop_charpos is the next
7833 position at which to stop and check for text properties or buffer
7837 next_element_from_buffer (struct it
*it
)
7841 eassert (IT_CHARPOS (*it
) >= BEGV
);
7842 eassert (NILP (it
->string
) && !it
->s
);
7843 eassert (!it
->bidi_p
7844 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7845 && it
->bidi_it
.string
.s
== NULL
));
7847 /* With bidi reordering, the character to display might not be the
7848 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7849 we were reseat()ed to a new buffer position, which is potentially
7850 a different paragraph. */
7851 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7853 get_visually_first_element (it
);
7854 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7857 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7859 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7861 int overlay_strings_follow_p
;
7863 /* End of the game, except when overlay strings follow that
7864 haven't been returned yet. */
7865 if (it
->overlay_strings_at_end_processed_p
)
7866 overlay_strings_follow_p
= 0;
7869 it
->overlay_strings_at_end_processed_p
= 1;
7870 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7873 if (overlay_strings_follow_p
)
7874 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7878 it
->position
= it
->current
.pos
;
7882 else if (!(!it
->bidi_p
7883 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7884 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7886 /* With bidi non-linear iteration, we could find ourselves
7887 far beyond the last computed stop_charpos, with several
7888 other stop positions in between that we missed. Scan
7889 them all now, in buffer's logical order, until we find
7890 and handle the last stop_charpos that precedes our
7891 current position. */
7892 handle_stop_backwards (it
, it
->stop_charpos
);
7893 return GET_NEXT_DISPLAY_ELEMENT (it
);
7899 /* Take note of the stop position we just moved across,
7900 for when we will move back across it. */
7901 it
->prev_stop
= it
->stop_charpos
;
7902 /* If we are at base paragraph embedding level, take
7903 note of the last stop position seen at this
7905 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7906 it
->base_level_stop
= it
->stop_charpos
;
7909 return GET_NEXT_DISPLAY_ELEMENT (it
);
7913 /* If we are before prev_stop, we may have overstepped on
7914 our way backwards a stop_pos, and if so, we need to
7915 handle that stop_pos. */
7916 && IT_CHARPOS (*it
) < it
->prev_stop
7917 /* We can sometimes back up for reasons that have nothing
7918 to do with bidi reordering. E.g., compositions. The
7919 code below is only needed when we are above the base
7920 embedding level, so test for that explicitly. */
7921 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7923 if (it
->base_level_stop
<= 0
7924 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7926 /* If we lost track of base_level_stop, we need to find
7927 prev_stop by looking backwards. This happens, e.g., when
7928 we were reseated to the previous screenful of text by
7930 it
->base_level_stop
= BEGV
;
7931 compute_stop_pos_backwards (it
);
7932 handle_stop_backwards (it
, it
->prev_stop
);
7935 handle_stop_backwards (it
, it
->base_level_stop
);
7936 return GET_NEXT_DISPLAY_ELEMENT (it
);
7940 /* No face changes, overlays etc. in sight, so just return a
7941 character from current_buffer. */
7945 /* Maybe run the redisplay end trigger hook. Performance note:
7946 This doesn't seem to cost measurable time. */
7947 if (it
->redisplay_end_trigger_charpos
7949 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7950 run_redisplay_end_trigger_hook (it
);
7952 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7953 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7955 && next_element_from_composition (it
))
7960 /* Get the next character, maybe multibyte. */
7961 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7962 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7963 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7965 it
->c
= *p
, it
->len
= 1;
7967 /* Record what we have and where it came from. */
7968 it
->what
= IT_CHARACTER
;
7969 it
->object
= it
->w
->buffer
;
7970 it
->position
= it
->current
.pos
;
7972 /* Normally we return the character found above, except when we
7973 really want to return an ellipsis for selective display. */
7978 /* A value of selective > 0 means hide lines indented more
7979 than that number of columns. */
7980 if (it
->selective
> 0
7981 && IT_CHARPOS (*it
) + 1 < ZV
7982 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7983 IT_BYTEPOS (*it
) + 1,
7986 success_p
= next_element_from_ellipsis (it
);
7987 it
->dpvec_char_len
= -1;
7990 else if (it
->c
== '\r' && it
->selective
== -1)
7992 /* A value of selective == -1 means that everything from the
7993 CR to the end of the line is invisible, with maybe an
7994 ellipsis displayed for it. */
7995 success_p
= next_element_from_ellipsis (it
);
7996 it
->dpvec_char_len
= -1;
8001 /* Value is zero if end of buffer reached. */
8002 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8007 /* Run the redisplay end trigger hook for IT. */
8010 run_redisplay_end_trigger_hook (struct it
*it
)
8012 Lisp_Object args
[3];
8014 /* IT->glyph_row should be non-null, i.e. we should be actually
8015 displaying something, or otherwise we should not run the hook. */
8016 eassert (it
->glyph_row
);
8018 /* Set up hook arguments. */
8019 args
[0] = Qredisplay_end_trigger_functions
;
8020 args
[1] = it
->window
;
8021 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8022 it
->redisplay_end_trigger_charpos
= 0;
8024 /* Since we are *trying* to run these functions, don't try to run
8025 them again, even if they get an error. */
8026 wset_redisplay_end_trigger (it
->w
, Qnil
);
8027 Frun_hook_with_args (3, args
);
8029 /* Notice if it changed the face of the character we are on. */
8030 handle_face_prop (it
);
8034 /* Deliver a composition display element. Unlike the other
8035 next_element_from_XXX, this function is not registered in the array
8036 get_next_element[]. It is called from next_element_from_buffer and
8037 next_element_from_string when necessary. */
8040 next_element_from_composition (struct it
*it
)
8042 it
->what
= IT_COMPOSITION
;
8043 it
->len
= it
->cmp_it
.nbytes
;
8044 if (STRINGP (it
->string
))
8048 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8049 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8052 it
->position
= it
->current
.string_pos
;
8053 it
->object
= it
->string
;
8054 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8055 IT_STRING_BYTEPOS (*it
), it
->string
);
8061 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8062 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8065 if (it
->bidi_it
.new_paragraph
)
8066 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8067 /* Resync the bidi iterator with IT's new position.
8068 FIXME: this doesn't support bidirectional text. */
8069 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8070 bidi_move_to_visually_next (&it
->bidi_it
);
8074 it
->position
= it
->current
.pos
;
8075 it
->object
= it
->w
->buffer
;
8076 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8077 IT_BYTEPOS (*it
), Qnil
);
8084 /***********************************************************************
8085 Moving an iterator without producing glyphs
8086 ***********************************************************************/
8088 /* Check if iterator is at a position corresponding to a valid buffer
8089 position after some move_it_ call. */
8091 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8092 ((it)->method == GET_FROM_STRING \
8093 ? IT_STRING_CHARPOS (*it) == 0 \
8097 /* Move iterator IT to a specified buffer or X position within one
8098 line on the display without producing glyphs.
8100 OP should be a bit mask including some or all of these bits:
8101 MOVE_TO_X: Stop upon reaching x-position TO_X.
8102 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8103 Regardless of OP's value, stop upon reaching the end of the display line.
8105 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8106 This means, in particular, that TO_X includes window's horizontal
8109 The return value has several possible values that
8110 say what condition caused the scan to stop:
8112 MOVE_POS_MATCH_OR_ZV
8113 - when TO_POS or ZV was reached.
8116 -when TO_X was reached before TO_POS or ZV were reached.
8119 - when we reached the end of the display area and the line must
8123 - when we reached the end of the display area and the line is
8127 - when we stopped at a line end, i.e. a newline or a CR and selective
8130 static enum move_it_result
8131 move_it_in_display_line_to (struct it
*it
,
8132 ptrdiff_t to_charpos
, int to_x
,
8133 enum move_operation_enum op
)
8135 enum move_it_result result
= MOVE_UNDEFINED
;
8136 struct glyph_row
*saved_glyph_row
;
8137 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8138 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8139 void *ppos_data
= NULL
;
8141 enum it_method prev_method
= it
->method
;
8142 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
8143 int saw_smaller_pos
= prev_pos
< to_charpos
;
8145 /* Don't produce glyphs in produce_glyphs. */
8146 saved_glyph_row
= it
->glyph_row
;
8147 it
->glyph_row
= NULL
;
8149 /* Use wrap_it to save a copy of IT wherever a word wrap could
8150 occur. Use atpos_it to save a copy of IT at the desired buffer
8151 position, if found, so that we can scan ahead and check if the
8152 word later overshoots the window edge. Use atx_it similarly, for
8158 /* Use ppos_it under bidi reordering to save a copy of IT for the
8159 position > CHARPOS that is the closest to CHARPOS. We restore
8160 that position in IT when we have scanned the entire display line
8161 without finding a match for CHARPOS and all the character
8162 positions are greater than CHARPOS. */
8165 SAVE_IT (ppos_it
, *it
, ppos_data
);
8166 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
8167 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8168 SAVE_IT (ppos_it
, *it
, ppos_data
);
8171 #define BUFFER_POS_REACHED_P() \
8172 ((op & MOVE_TO_POS) != 0 \
8173 && BUFFERP (it->object) \
8174 && (IT_CHARPOS (*it) == to_charpos \
8176 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8177 && IT_CHARPOS (*it) > to_charpos) \
8178 || (it->what == IT_COMPOSITION \
8179 && ((IT_CHARPOS (*it) > to_charpos \
8180 && to_charpos >= it->cmp_it.charpos) \
8181 || (IT_CHARPOS (*it) < to_charpos \
8182 && to_charpos <= it->cmp_it.charpos)))) \
8183 && (it->method == GET_FROM_BUFFER \
8184 || (it->method == GET_FROM_DISPLAY_VECTOR \
8185 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8187 /* If there's a line-/wrap-prefix, handle it. */
8188 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8189 && it
->current_y
< it
->last_visible_y
)
8190 handle_line_prefix (it
);
8192 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8193 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8197 int x
, i
, ascent
= 0, descent
= 0;
8199 /* Utility macro to reset an iterator with x, ascent, and descent. */
8200 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8201 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8202 (IT)->max_descent = descent)
8204 /* Stop if we move beyond TO_CHARPOS (after an image or a
8205 display string or stretch glyph). */
8206 if ((op
& MOVE_TO_POS
) != 0
8207 && BUFFERP (it
->object
)
8208 && it
->method
== GET_FROM_BUFFER
8210 /* When the iterator is at base embedding level, we
8211 are guaranteed that characters are delivered for
8212 display in strictly increasing order of their
8213 buffer positions. */
8214 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8215 && IT_CHARPOS (*it
) > to_charpos
)
8217 && (prev_method
== GET_FROM_IMAGE
8218 || prev_method
== GET_FROM_STRETCH
8219 || prev_method
== GET_FROM_STRING
)
8220 /* Passed TO_CHARPOS from left to right. */
8221 && ((prev_pos
< to_charpos
8222 && IT_CHARPOS (*it
) > to_charpos
)
8223 /* Passed TO_CHARPOS from right to left. */
8224 || (prev_pos
> to_charpos
8225 && IT_CHARPOS (*it
) < to_charpos
)))))
8227 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8229 result
= MOVE_POS_MATCH_OR_ZV
;
8232 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8233 /* If wrap_it is valid, the current position might be in a
8234 word that is wrapped. So, save the iterator in
8235 atpos_it and continue to see if wrapping happens. */
8236 SAVE_IT (atpos_it
, *it
, atpos_data
);
8239 /* Stop when ZV reached.
8240 We used to stop here when TO_CHARPOS reached as well, but that is
8241 too soon if this glyph does not fit on this line. So we handle it
8242 explicitly below. */
8243 if (!get_next_display_element (it
))
8245 result
= MOVE_POS_MATCH_OR_ZV
;
8249 if (it
->line_wrap
== TRUNCATE
)
8251 if (BUFFER_POS_REACHED_P ())
8253 result
= MOVE_POS_MATCH_OR_ZV
;
8259 if (it
->line_wrap
== WORD_WRAP
)
8261 if (IT_DISPLAYING_WHITESPACE (it
))
8265 /* We have reached a glyph that follows one or more
8266 whitespace characters. If the position is
8267 already found, we are done. */
8268 if (atpos_it
.sp
>= 0)
8270 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8271 result
= MOVE_POS_MATCH_OR_ZV
;
8276 RESTORE_IT (it
, &atx_it
, atx_data
);
8277 result
= MOVE_X_REACHED
;
8280 /* Otherwise, we can wrap here. */
8281 SAVE_IT (wrap_it
, *it
, wrap_data
);
8287 /* Remember the line height for the current line, in case
8288 the next element doesn't fit on the line. */
8289 ascent
= it
->max_ascent
;
8290 descent
= it
->max_descent
;
8292 /* The call to produce_glyphs will get the metrics of the
8293 display element IT is loaded with. Record the x-position
8294 before this display element, in case it doesn't fit on the
8298 PRODUCE_GLYPHS (it
);
8300 if (it
->area
!= TEXT_AREA
)
8302 prev_method
= it
->method
;
8303 if (it
->method
== GET_FROM_BUFFER
)
8304 prev_pos
= IT_CHARPOS (*it
);
8305 set_iterator_to_next (it
, 1);
8306 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8307 SET_TEXT_POS (this_line_min_pos
,
8308 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8310 && (op
& MOVE_TO_POS
)
8311 && IT_CHARPOS (*it
) > to_charpos
8312 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8313 SAVE_IT (ppos_it
, *it
, ppos_data
);
8317 /* The number of glyphs we get back in IT->nglyphs will normally
8318 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8319 character on a terminal frame, or (iii) a line end. For the
8320 second case, IT->nglyphs - 1 padding glyphs will be present.
8321 (On X frames, there is only one glyph produced for a
8322 composite character.)
8324 The behavior implemented below means, for continuation lines,
8325 that as many spaces of a TAB as fit on the current line are
8326 displayed there. For terminal frames, as many glyphs of a
8327 multi-glyph character are displayed in the current line, too.
8328 This is what the old redisplay code did, and we keep it that
8329 way. Under X, the whole shape of a complex character must
8330 fit on the line or it will be completely displayed in the
8333 Note that both for tabs and padding glyphs, all glyphs have
8337 /* More than one glyph or glyph doesn't fit on line. All
8338 glyphs have the same width. */
8339 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8341 int x_before_this_char
= x
;
8342 int hpos_before_this_char
= it
->hpos
;
8344 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8346 new_x
= x
+ single_glyph_width
;
8348 /* We want to leave anything reaching TO_X to the caller. */
8349 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8351 if (BUFFER_POS_REACHED_P ())
8353 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8354 goto buffer_pos_reached
;
8355 if (atpos_it
.sp
< 0)
8357 SAVE_IT (atpos_it
, *it
, atpos_data
);
8358 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8363 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8366 result
= MOVE_X_REACHED
;
8371 SAVE_IT (atx_it
, *it
, atx_data
);
8372 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8377 if (/* Lines are continued. */
8378 it
->line_wrap
!= TRUNCATE
8379 && (/* And glyph doesn't fit on the line. */
8380 new_x
> it
->last_visible_x
8381 /* Or it fits exactly and we're on a window
8383 || (new_x
== it
->last_visible_x
8384 && FRAME_WINDOW_P (it
->f
)
8385 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8386 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8387 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8389 if (/* IT->hpos == 0 means the very first glyph
8390 doesn't fit on the line, e.g. a wide image. */
8392 || (new_x
== it
->last_visible_x
8393 && FRAME_WINDOW_P (it
->f
)))
8396 it
->current_x
= new_x
;
8398 /* The character's last glyph just barely fits
8400 if (i
== it
->nglyphs
- 1)
8402 /* If this is the destination position,
8403 return a position *before* it in this row,
8404 now that we know it fits in this row. */
8405 if (BUFFER_POS_REACHED_P ())
8407 if (it
->line_wrap
!= WORD_WRAP
8410 it
->hpos
= hpos_before_this_char
;
8411 it
->current_x
= x_before_this_char
;
8412 result
= MOVE_POS_MATCH_OR_ZV
;
8415 if (it
->line_wrap
== WORD_WRAP
8418 SAVE_IT (atpos_it
, *it
, atpos_data
);
8419 atpos_it
.current_x
= x_before_this_char
;
8420 atpos_it
.hpos
= hpos_before_this_char
;
8424 prev_method
= it
->method
;
8425 if (it
->method
== GET_FROM_BUFFER
)
8426 prev_pos
= IT_CHARPOS (*it
);
8427 set_iterator_to_next (it
, 1);
8428 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8429 SET_TEXT_POS (this_line_min_pos
,
8430 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8431 /* On graphical terminals, newlines may
8432 "overflow" into the fringe if
8433 overflow-newline-into-fringe is non-nil.
8434 On text terminals, and on graphical
8435 terminals with no right margin, newlines
8436 may overflow into the last glyph on the
8438 if (!FRAME_WINDOW_P (it
->f
)
8440 && it
->bidi_it
.paragraph_dir
== R2L
)
8441 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8442 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8443 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8445 if (!get_next_display_element (it
))
8447 result
= MOVE_POS_MATCH_OR_ZV
;
8450 if (BUFFER_POS_REACHED_P ())
8452 if (ITERATOR_AT_END_OF_LINE_P (it
))
8453 result
= MOVE_POS_MATCH_OR_ZV
;
8455 result
= MOVE_LINE_CONTINUED
;
8458 if (ITERATOR_AT_END_OF_LINE_P (it
))
8460 result
= MOVE_NEWLINE_OR_CR
;
8467 IT_RESET_X_ASCENT_DESCENT (it
);
8469 if (wrap_it
.sp
>= 0)
8471 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8476 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8478 result
= MOVE_LINE_CONTINUED
;
8482 if (BUFFER_POS_REACHED_P ())
8484 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8485 goto buffer_pos_reached
;
8486 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8488 SAVE_IT (atpos_it
, *it
, atpos_data
);
8489 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8493 if (new_x
> it
->first_visible_x
)
8495 /* Glyph is visible. Increment number of glyphs that
8496 would be displayed. */
8501 if (result
!= MOVE_UNDEFINED
)
8504 else if (BUFFER_POS_REACHED_P ())
8507 IT_RESET_X_ASCENT_DESCENT (it
);
8508 result
= MOVE_POS_MATCH_OR_ZV
;
8511 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8513 /* Stop when TO_X specified and reached. This check is
8514 necessary here because of lines consisting of a line end,
8515 only. The line end will not produce any glyphs and we
8516 would never get MOVE_X_REACHED. */
8517 eassert (it
->nglyphs
== 0);
8518 result
= MOVE_X_REACHED
;
8522 /* Is this a line end? If yes, we're done. */
8523 if (ITERATOR_AT_END_OF_LINE_P (it
))
8525 /* If we are past TO_CHARPOS, but never saw any character
8526 positions smaller than TO_CHARPOS, return
8527 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8529 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8531 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8533 if (IT_CHARPOS (ppos_it
) < ZV
)
8535 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8536 result
= MOVE_POS_MATCH_OR_ZV
;
8539 goto buffer_pos_reached
;
8541 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8542 && IT_CHARPOS (*it
) > to_charpos
)
8543 goto buffer_pos_reached
;
8545 result
= MOVE_NEWLINE_OR_CR
;
8548 result
= MOVE_NEWLINE_OR_CR
;
8552 prev_method
= it
->method
;
8553 if (it
->method
== GET_FROM_BUFFER
)
8554 prev_pos
= IT_CHARPOS (*it
);
8555 /* The current display element has been consumed. Advance
8557 set_iterator_to_next (it
, 1);
8558 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8559 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8560 if (IT_CHARPOS (*it
) < to_charpos
)
8561 saw_smaller_pos
= 1;
8563 && (op
& MOVE_TO_POS
)
8564 && IT_CHARPOS (*it
) >= to_charpos
8565 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8566 SAVE_IT (ppos_it
, *it
, ppos_data
);
8568 /* Stop if lines are truncated and IT's current x-position is
8569 past the right edge of the window now. */
8570 if (it
->line_wrap
== TRUNCATE
8571 && it
->current_x
>= it
->last_visible_x
)
8573 if (!FRAME_WINDOW_P (it
->f
)
8574 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8575 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8576 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8577 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8581 if ((at_eob_p
= !get_next_display_element (it
))
8582 || BUFFER_POS_REACHED_P ()
8583 /* If we are past TO_CHARPOS, but never saw any
8584 character positions smaller than TO_CHARPOS,
8585 return MOVE_POS_MATCH_OR_ZV, like the
8586 unidirectional display did. */
8587 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8589 && IT_CHARPOS (*it
) > to_charpos
))
8592 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8593 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8594 result
= MOVE_POS_MATCH_OR_ZV
;
8597 if (ITERATOR_AT_END_OF_LINE_P (it
))
8599 result
= MOVE_NEWLINE_OR_CR
;
8603 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8605 && IT_CHARPOS (*it
) > to_charpos
)
8607 if (IT_CHARPOS (ppos_it
) < ZV
)
8608 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8609 result
= MOVE_POS_MATCH_OR_ZV
;
8612 result
= MOVE_LINE_TRUNCATED
;
8615 #undef IT_RESET_X_ASCENT_DESCENT
8618 #undef BUFFER_POS_REACHED_P
8620 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8621 restore the saved iterator. */
8622 if (atpos_it
.sp
>= 0)
8623 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8624 else if (atx_it
.sp
>= 0)
8625 RESTORE_IT (it
, &atx_it
, atx_data
);
8630 bidi_unshelve_cache (atpos_data
, 1);
8632 bidi_unshelve_cache (atx_data
, 1);
8634 bidi_unshelve_cache (wrap_data
, 1);
8636 bidi_unshelve_cache (ppos_data
, 1);
8638 /* Restore the iterator settings altered at the beginning of this
8640 it
->glyph_row
= saved_glyph_row
;
8644 /* For external use. */
8646 move_it_in_display_line (struct it
*it
,
8647 ptrdiff_t to_charpos
, int to_x
,
8648 enum move_operation_enum op
)
8650 if (it
->line_wrap
== WORD_WRAP
8651 && (op
& MOVE_TO_X
))
8654 void *save_data
= NULL
;
8657 SAVE_IT (save_it
, *it
, save_data
);
8658 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8659 /* When word-wrap is on, TO_X may lie past the end
8660 of a wrapped line. Then it->current is the
8661 character on the next line, so backtrack to the
8662 space before the wrap point. */
8663 if (skip
== MOVE_LINE_CONTINUED
)
8665 int prev_x
= max (it
->current_x
- 1, 0);
8666 RESTORE_IT (it
, &save_it
, save_data
);
8667 move_it_in_display_line_to
8668 (it
, -1, prev_x
, MOVE_TO_X
);
8671 bidi_unshelve_cache (save_data
, 1);
8674 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8678 /* Move IT forward until it satisfies one or more of the criteria in
8679 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8681 OP is a bit-mask that specifies where to stop, and in particular,
8682 which of those four position arguments makes a difference. See the
8683 description of enum move_operation_enum.
8685 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8686 screen line, this function will set IT to the next position that is
8687 displayed to the right of TO_CHARPOS on the screen. */
8690 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8692 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8693 int line_height
, line_start_x
= 0, reached
= 0;
8694 void *backup_data
= NULL
;
8698 if (op
& MOVE_TO_VPOS
)
8700 /* If no TO_CHARPOS and no TO_X specified, stop at the
8701 start of the line TO_VPOS. */
8702 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8704 if (it
->vpos
== to_vpos
)
8710 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8714 /* TO_VPOS >= 0 means stop at TO_X in the line at
8715 TO_VPOS, or at TO_POS, whichever comes first. */
8716 if (it
->vpos
== to_vpos
)
8722 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8724 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8729 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8731 /* We have reached TO_X but not in the line we want. */
8732 skip
= move_it_in_display_line_to (it
, to_charpos
,
8734 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8742 else if (op
& MOVE_TO_Y
)
8744 struct it it_backup
;
8746 if (it
->line_wrap
== WORD_WRAP
)
8747 SAVE_IT (it_backup
, *it
, backup_data
);
8749 /* TO_Y specified means stop at TO_X in the line containing
8750 TO_Y---or at TO_CHARPOS if this is reached first. The
8751 problem is that we can't really tell whether the line
8752 contains TO_Y before we have completely scanned it, and
8753 this may skip past TO_X. What we do is to first scan to
8756 If TO_X is not specified, use a TO_X of zero. The reason
8757 is to make the outcome of this function more predictable.
8758 If we didn't use TO_X == 0, we would stop at the end of
8759 the line which is probably not what a caller would expect
8761 skip
= move_it_in_display_line_to
8762 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8763 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8765 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8766 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8768 else if (skip
== MOVE_X_REACHED
)
8770 /* If TO_X was reached, we want to know whether TO_Y is
8771 in the line. We know this is the case if the already
8772 scanned glyphs make the line tall enough. Otherwise,
8773 we must check by scanning the rest of the line. */
8774 line_height
= it
->max_ascent
+ it
->max_descent
;
8775 if (to_y
>= it
->current_y
8776 && to_y
< it
->current_y
+ line_height
)
8781 SAVE_IT (it_backup
, *it
, backup_data
);
8782 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8783 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8785 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8786 line_height
= it
->max_ascent
+ it
->max_descent
;
8787 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8789 if (to_y
>= it
->current_y
8790 && to_y
< it
->current_y
+ line_height
)
8792 /* If TO_Y is in this line and TO_X was reached
8793 above, we scanned too far. We have to restore
8794 IT's settings to the ones before skipping. But
8795 keep the more accurate values of max_ascent and
8796 max_descent we've found while skipping the rest
8797 of the line, for the sake of callers, such as
8798 pos_visible_p, that need to know the line
8800 int max_ascent
= it
->max_ascent
;
8801 int max_descent
= it
->max_descent
;
8803 RESTORE_IT (it
, &it_backup
, backup_data
);
8804 it
->max_ascent
= max_ascent
;
8805 it
->max_descent
= max_descent
;
8811 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8817 /* Check whether TO_Y is in this line. */
8818 line_height
= it
->max_ascent
+ it
->max_descent
;
8819 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8821 if (to_y
>= it
->current_y
8822 && to_y
< it
->current_y
+ line_height
)
8824 /* When word-wrap is on, TO_X may lie past the end
8825 of a wrapped line. Then it->current is the
8826 character on the next line, so backtrack to the
8827 space before the wrap point. */
8828 if (skip
== MOVE_LINE_CONTINUED
8829 && it
->line_wrap
== WORD_WRAP
)
8831 int prev_x
= max (it
->current_x
- 1, 0);
8832 RESTORE_IT (it
, &it_backup
, backup_data
);
8833 skip
= move_it_in_display_line_to
8834 (it
, -1, prev_x
, MOVE_TO_X
);
8843 else if (BUFFERP (it
->object
)
8844 && (it
->method
== GET_FROM_BUFFER
8845 || it
->method
== GET_FROM_STRETCH
)
8846 && IT_CHARPOS (*it
) >= to_charpos
8847 /* Under bidi iteration, a call to set_iterator_to_next
8848 can scan far beyond to_charpos if the initial
8849 portion of the next line needs to be reordered. In
8850 that case, give move_it_in_display_line_to another
8853 && it
->bidi_it
.scan_dir
== -1))
8854 skip
= MOVE_POS_MATCH_OR_ZV
;
8856 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8860 case MOVE_POS_MATCH_OR_ZV
:
8864 case MOVE_NEWLINE_OR_CR
:
8865 set_iterator_to_next (it
, 1);
8866 it
->continuation_lines_width
= 0;
8869 case MOVE_LINE_TRUNCATED
:
8870 it
->continuation_lines_width
= 0;
8871 reseat_at_next_visible_line_start (it
, 0);
8872 if ((op
& MOVE_TO_POS
) != 0
8873 && IT_CHARPOS (*it
) > to_charpos
)
8880 case MOVE_LINE_CONTINUED
:
8881 /* For continued lines ending in a tab, some of the glyphs
8882 associated with the tab are displayed on the current
8883 line. Since it->current_x does not include these glyphs,
8884 we use it->last_visible_x instead. */
8887 it
->continuation_lines_width
+= it
->last_visible_x
;
8888 /* When moving by vpos, ensure that the iterator really
8889 advances to the next line (bug#847, bug#969). Fixme:
8890 do we need to do this in other circumstances? */
8891 if (it
->current_x
!= it
->last_visible_x
8892 && (op
& MOVE_TO_VPOS
)
8893 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8895 line_start_x
= it
->current_x
+ it
->pixel_width
8896 - it
->last_visible_x
;
8897 set_iterator_to_next (it
, 0);
8901 it
->continuation_lines_width
+= it
->current_x
;
8908 /* Reset/increment for the next run. */
8909 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8910 it
->current_x
= line_start_x
;
8913 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8915 last_height
= it
->max_ascent
+ it
->max_descent
;
8916 last_max_ascent
= it
->max_ascent
;
8917 it
->max_ascent
= it
->max_descent
= 0;
8922 /* On text terminals, we may stop at the end of a line in the middle
8923 of a multi-character glyph. If the glyph itself is continued,
8924 i.e. it is actually displayed on the next line, don't treat this
8925 stopping point as valid; move to the next line instead (unless
8926 that brings us offscreen). */
8927 if (!FRAME_WINDOW_P (it
->f
)
8929 && IT_CHARPOS (*it
) == to_charpos
8930 && it
->what
== IT_CHARACTER
8932 && it
->line_wrap
== WINDOW_WRAP
8933 && it
->current_x
== it
->last_visible_x
- 1
8936 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8938 it
->continuation_lines_width
+= it
->current_x
;
8939 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8940 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8942 last_height
= it
->max_ascent
+ it
->max_descent
;
8943 last_max_ascent
= it
->max_ascent
;
8947 bidi_unshelve_cache (backup_data
, 1);
8949 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8953 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8955 If DY > 0, move IT backward at least that many pixels. DY = 0
8956 means move IT backward to the preceding line start or BEGV. This
8957 function may move over more than DY pixels if IT->current_y - DY
8958 ends up in the middle of a line; in this case IT->current_y will be
8959 set to the top of the line moved to. */
8962 move_it_vertically_backward (struct it
*it
, int dy
)
8966 void *it2data
= NULL
, *it3data
= NULL
;
8967 ptrdiff_t start_pos
;
8972 start_pos
= IT_CHARPOS (*it
);
8974 /* Estimate how many newlines we must move back. */
8975 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8977 /* Set the iterator's position that many lines back. */
8978 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8979 back_to_previous_visible_line_start (it
);
8981 /* Reseat the iterator here. When moving backward, we don't want
8982 reseat to skip forward over invisible text, set up the iterator
8983 to deliver from overlay strings at the new position etc. So,
8984 use reseat_1 here. */
8985 reseat_1 (it
, it
->current
.pos
, 1);
8987 /* We are now surely at a line start. */
8988 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
8989 reordering is in effect. */
8990 it
->continuation_lines_width
= 0;
8992 /* Move forward and see what y-distance we moved. First move to the
8993 start of the next line so that we get its height. We need this
8994 height to be able to tell whether we reached the specified
8996 SAVE_IT (it2
, *it
, it2data
);
8997 it2
.max_ascent
= it2
.max_descent
= 0;
9000 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9001 MOVE_TO_POS
| MOVE_TO_VPOS
);
9003 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9004 /* If we are in a display string which starts at START_POS,
9005 and that display string includes a newline, and we are
9006 right after that newline (i.e. at the beginning of a
9007 display line), exit the loop, because otherwise we will
9008 infloop, since move_it_to will see that it is already at
9009 START_POS and will not move. */
9010 || (it2
.method
== GET_FROM_STRING
9011 && IT_CHARPOS (it2
) == start_pos
9012 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9013 eassert (IT_CHARPOS (*it
) >= BEGV
);
9014 SAVE_IT (it3
, it2
, it3data
);
9016 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9017 eassert (IT_CHARPOS (*it
) >= BEGV
);
9018 /* H is the actual vertical distance from the position in *IT
9019 and the starting position. */
9020 h
= it2
.current_y
- it
->current_y
;
9021 /* NLINES is the distance in number of lines. */
9022 nlines
= it2
.vpos
- it
->vpos
;
9024 /* Correct IT's y and vpos position
9025 so that they are relative to the starting point. */
9031 /* DY == 0 means move to the start of the screen line. The
9032 value of nlines is > 0 if continuation lines were involved,
9033 or if the original IT position was at start of a line. */
9034 RESTORE_IT (it
, it
, it2data
);
9036 move_it_by_lines (it
, nlines
);
9037 /* The above code moves us to some position NLINES down,
9038 usually to its first glyph (leftmost in an L2R line), but
9039 that's not necessarily the start of the line, under bidi
9040 reordering. We want to get to the character position
9041 that is immediately after the newline of the previous
9044 && !it
->continuation_lines_width
9045 && !STRINGP (it
->string
)
9046 && IT_CHARPOS (*it
) > BEGV
9047 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9050 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
9052 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
9054 bidi_unshelve_cache (it3data
, 1);
9058 /* The y-position we try to reach, relative to *IT.
9059 Note that H has been subtracted in front of the if-statement. */
9060 int target_y
= it
->current_y
+ h
- dy
;
9061 int y0
= it3
.current_y
;
9065 RESTORE_IT (&it3
, &it3
, it3data
);
9066 y1
= line_bottom_y (&it3
);
9067 line_height
= y1
- y0
;
9068 RESTORE_IT (it
, it
, it2data
);
9069 /* If we did not reach target_y, try to move further backward if
9070 we can. If we moved too far backward, try to move forward. */
9071 if (target_y
< it
->current_y
9072 /* This is heuristic. In a window that's 3 lines high, with
9073 a line height of 13 pixels each, recentering with point
9074 on the bottom line will try to move -39/2 = 19 pixels
9075 backward. Try to avoid moving into the first line. */
9076 && (it
->current_y
- target_y
9077 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9078 && IT_CHARPOS (*it
) > BEGV
)
9080 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9081 target_y
- it
->current_y
));
9082 dy
= it
->current_y
- target_y
;
9083 goto move_further_back
;
9085 else if (target_y
>= it
->current_y
+ line_height
9086 && IT_CHARPOS (*it
) < ZV
)
9088 /* Should move forward by at least one line, maybe more.
9090 Note: Calling move_it_by_lines can be expensive on
9091 terminal frames, where compute_motion is used (via
9092 vmotion) to do the job, when there are very long lines
9093 and truncate-lines is nil. That's the reason for
9094 treating terminal frames specially here. */
9096 if (!FRAME_WINDOW_P (it
->f
))
9097 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9102 move_it_by_lines (it
, 1);
9104 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9111 /* Move IT by a specified amount of pixel lines DY. DY negative means
9112 move backwards. DY = 0 means move to start of screen line. At the
9113 end, IT will be on the start of a screen line. */
9116 move_it_vertically (struct it
*it
, int dy
)
9119 move_it_vertically_backward (it
, -dy
);
9122 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9123 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9124 MOVE_TO_POS
| MOVE_TO_Y
);
9125 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9127 /* If buffer ends in ZV without a newline, move to the start of
9128 the line to satisfy the post-condition. */
9129 if (IT_CHARPOS (*it
) == ZV
9131 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9132 move_it_by_lines (it
, 0);
9137 /* Move iterator IT past the end of the text line it is in. */
9140 move_it_past_eol (struct it
*it
)
9142 enum move_it_result rc
;
9144 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9145 if (rc
== MOVE_NEWLINE_OR_CR
)
9146 set_iterator_to_next (it
, 0);
9150 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9151 negative means move up. DVPOS == 0 means move to the start of the
9154 Optimization idea: If we would know that IT->f doesn't use
9155 a face with proportional font, we could be faster for
9156 truncate-lines nil. */
9159 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9162 /* The commented-out optimization uses vmotion on terminals. This
9163 gives bad results, because elements like it->what, on which
9164 callers such as pos_visible_p rely, aren't updated. */
9165 /* struct position pos;
9166 if (!FRAME_WINDOW_P (it->f))
9168 struct text_pos textpos;
9170 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9171 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9172 reseat (it, textpos, 1);
9173 it->vpos += pos.vpos;
9174 it->current_y += pos.vpos;
9180 /* DVPOS == 0 means move to the start of the screen line. */
9181 move_it_vertically_backward (it
, 0);
9182 /* Let next call to line_bottom_y calculate real line height */
9187 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9188 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9190 /* Only move to the next buffer position if we ended up in a
9191 string from display property, not in an overlay string
9192 (before-string or after-string). That is because the
9193 latter don't conceal the underlying buffer position, so
9194 we can ask to move the iterator to the exact position we
9195 are interested in. Note that, even if we are already at
9196 IT_CHARPOS (*it), the call below is not a no-op, as it
9197 will detect that we are at the end of the string, pop the
9198 iterator, and compute it->current_x and it->hpos
9200 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9201 -1, -1, -1, MOVE_TO_POS
);
9207 void *it2data
= NULL
;
9208 ptrdiff_t start_charpos
, i
;
9210 /* Start at the beginning of the screen line containing IT's
9211 position. This may actually move vertically backwards,
9212 in case of overlays, so adjust dvpos accordingly. */
9214 move_it_vertically_backward (it
, 0);
9217 /* Go back -DVPOS visible lines and reseat the iterator there. */
9218 start_charpos
= IT_CHARPOS (*it
);
9219 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
9220 back_to_previous_visible_line_start (it
);
9221 reseat (it
, it
->current
.pos
, 1);
9223 /* Move further back if we end up in a string or an image. */
9224 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9226 /* First try to move to start of display line. */
9228 move_it_vertically_backward (it
, 0);
9230 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9232 /* If start of line is still in string or image,
9233 move further back. */
9234 back_to_previous_visible_line_start (it
);
9235 reseat (it
, it
->current
.pos
, 1);
9239 it
->current_x
= it
->hpos
= 0;
9241 /* Above call may have moved too far if continuation lines
9242 are involved. Scan forward and see if it did. */
9243 SAVE_IT (it2
, *it
, it2data
);
9244 it2
.vpos
= it2
.current_y
= 0;
9245 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9246 it
->vpos
-= it2
.vpos
;
9247 it
->current_y
-= it2
.current_y
;
9248 it
->current_x
= it
->hpos
= 0;
9250 /* If we moved too far back, move IT some lines forward. */
9251 if (it2
.vpos
> -dvpos
)
9253 int delta
= it2
.vpos
+ dvpos
;
9255 RESTORE_IT (&it2
, &it2
, it2data
);
9256 SAVE_IT (it2
, *it
, it2data
);
9257 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9258 /* Move back again if we got too far ahead. */
9259 if (IT_CHARPOS (*it
) >= start_charpos
)
9260 RESTORE_IT (it
, &it2
, it2data
);
9262 bidi_unshelve_cache (it2data
, 1);
9265 RESTORE_IT (it
, it
, it2data
);
9269 /* Return 1 if IT points into the middle of a display vector. */
9272 in_display_vector_p (struct it
*it
)
9274 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9275 && it
->current
.dpvec_index
> 0
9276 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9280 /***********************************************************************
9282 ***********************************************************************/
9285 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9289 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9291 Lisp_Object args
[3];
9292 Lisp_Object msg
, fmt
;
9295 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9299 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9301 args
[0] = fmt
= build_string (format
);
9304 msg
= Fformat (3, args
);
9306 len
= SBYTES (msg
) + 1;
9307 buffer
= SAFE_ALLOCA (len
);
9308 memcpy (buffer
, SDATA (msg
), len
);
9310 message_dolog (buffer
, len
- 1, 1, 0);
9317 /* Output a newline in the *Messages* buffer if "needs" one. */
9320 message_log_maybe_newline (void)
9322 if (message_log_need_newline
)
9323 message_dolog ("", 0, 1, 0);
9327 /* Add a string M of length NBYTES to the message log, optionally
9328 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
9329 nonzero, means interpret the contents of M as multibyte. This
9330 function calls low-level routines in order to bypass text property
9331 hooks, etc. which might not be safe to run.
9333 This may GC (insert may run before/after change hooks),
9334 so the buffer M must NOT point to a Lisp string. */
9337 message_dolog (const char *m
, ptrdiff_t nbytes
, int nlflag
, int multibyte
)
9339 const unsigned char *msg
= (const unsigned char *) m
;
9341 if (!NILP (Vmemory_full
))
9344 if (!NILP (Vmessage_log_max
))
9346 struct buffer
*oldbuf
;
9347 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9348 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9349 ptrdiff_t point_at_end
= 0;
9350 ptrdiff_t zv_at_end
= 0;
9351 Lisp_Object old_deactivate_mark
, tem
;
9352 struct gcpro gcpro1
;
9354 old_deactivate_mark
= Vdeactivate_mark
;
9355 oldbuf
= current_buffer
;
9356 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9357 bset_undo_list (current_buffer
, Qt
);
9359 oldpoint
= message_dolog_marker1
;
9360 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
9361 oldbegv
= message_dolog_marker2
;
9362 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
9363 oldzv
= message_dolog_marker3
;
9364 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
9365 GCPRO1 (old_deactivate_mark
);
9373 BEGV_BYTE
= BEG_BYTE
;
9376 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9378 /* Insert the string--maybe converting multibyte to single byte
9379 or vice versa, so that all the text fits the buffer. */
9381 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9387 /* Convert a multibyte string to single-byte
9388 for the *Message* buffer. */
9389 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9391 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9392 work
[0] = (ASCII_CHAR_P (c
)
9394 : multibyte_char_to_unibyte (c
));
9395 insert_1_both (work
, 1, 1, 1, 0, 0);
9398 else if (! multibyte
9399 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9403 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9404 /* Convert a single-byte string to multibyte
9405 for the *Message* buffer. */
9406 for (i
= 0; i
< nbytes
; i
++)
9409 MAKE_CHAR_MULTIBYTE (c
);
9410 char_bytes
= CHAR_STRING (c
, str
);
9411 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9415 insert_1 (m
, nbytes
, 1, 0, 0);
9419 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9421 insert_1 ("\n", 1, 1, 0, 0);
9423 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9425 this_bol_byte
= PT_BYTE
;
9427 /* See if this line duplicates the previous one.
9428 If so, combine duplicates. */
9431 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9433 prev_bol_byte
= PT_BYTE
;
9435 dups
= message_log_check_duplicate (prev_bol_byte
,
9439 del_range_both (prev_bol
, prev_bol_byte
,
9440 this_bol
, this_bol_byte
, 0);
9443 char dupstr
[sizeof " [ times]"
9444 + INT_STRLEN_BOUND (printmax_t
)];
9446 /* If you change this format, don't forget to also
9447 change message_log_check_duplicate. */
9448 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
9449 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9450 insert_1 (dupstr
, duplen
, 1, 0, 1);
9455 /* If we have more than the desired maximum number of lines
9456 in the *Messages* buffer now, delete the oldest ones.
9457 This is safe because we don't have undo in this buffer. */
9459 if (NATNUMP (Vmessage_log_max
))
9461 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9462 -XFASTINT (Vmessage_log_max
) - 1, 0);
9463 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9466 BEGV
= XMARKER (oldbegv
)->charpos
;
9467 BEGV_BYTE
= marker_byte_position (oldbegv
);
9476 ZV
= XMARKER (oldzv
)->charpos
;
9477 ZV_BYTE
= marker_byte_position (oldzv
);
9481 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9483 /* We can't do Fgoto_char (oldpoint) because it will run some
9485 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
9486 XMARKER (oldpoint
)->bytepos
);
9489 unchain_marker (XMARKER (oldpoint
));
9490 unchain_marker (XMARKER (oldbegv
));
9491 unchain_marker (XMARKER (oldzv
));
9493 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
9494 set_buffer_internal (oldbuf
);
9496 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9497 message_log_need_newline
= !nlflag
;
9498 Vdeactivate_mark
= old_deactivate_mark
;
9503 /* We are at the end of the buffer after just having inserted a newline.
9504 (Note: We depend on the fact we won't be crossing the gap.)
9505 Check to see if the most recent message looks a lot like the previous one.
9506 Return 0 if different, 1 if the new one should just replace it, or a
9507 value N > 1 if we should also append " [N times]". */
9510 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
9513 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
9515 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9516 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9518 for (i
= 0; i
< len
; i
++)
9520 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9528 if (*p1
++ == ' ' && *p1
++ == '[')
9531 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9532 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9539 /* Display an echo area message M with a specified length of NBYTES
9540 bytes. The string may include null characters. If M is 0, clear
9541 out any existing message, and let the mini-buffer text show
9544 This may GC, so the buffer M must NOT point to a Lisp string. */
9547 message2 (const char *m
, ptrdiff_t nbytes
, int multibyte
)
9549 /* First flush out any partial line written with print. */
9550 message_log_maybe_newline ();
9552 message_dolog (m
, nbytes
, 1, multibyte
);
9553 message2_nolog (m
, nbytes
, multibyte
);
9557 /* The non-logging counterpart of message2. */
9560 message2_nolog (const char *m
, ptrdiff_t nbytes
, int multibyte
)
9562 struct frame
*sf
= SELECTED_FRAME ();
9563 message_enable_multibyte
= multibyte
;
9565 if (FRAME_INITIAL_P (sf
))
9567 if (noninteractive_need_newline
)
9568 putc ('\n', stderr
);
9569 noninteractive_need_newline
= 0;
9571 fwrite (m
, nbytes
, 1, stderr
);
9572 if (cursor_in_echo_area
== 0)
9573 fprintf (stderr
, "\n");
9576 /* A null message buffer means that the frame hasn't really been
9577 initialized yet. Error messages get reported properly by
9578 cmd_error, so this must be just an informative message; toss it. */
9579 else if (INTERACTIVE
9580 && sf
->glyphs_initialized_p
9581 && FRAME_MESSAGE_BUF (sf
))
9583 Lisp_Object mini_window
;
9586 /* Get the frame containing the mini-buffer
9587 that the selected frame is using. */
9588 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9589 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9591 FRAME_SAMPLE_VISIBILITY (f
);
9592 if (FRAME_VISIBLE_P (sf
)
9593 && ! FRAME_VISIBLE_P (f
))
9594 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9598 set_message (m
, Qnil
, nbytes
, multibyte
);
9599 if (minibuffer_auto_raise
)
9600 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9603 clear_message (1, 1);
9605 do_pending_window_change (0);
9606 echo_area_display (1);
9607 do_pending_window_change (0);
9608 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9609 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9614 /* Display an echo area message M with a specified length of NBYTES
9615 bytes. The string may include null characters. If M is not a
9616 string, clear out any existing message, and let the mini-buffer
9619 This function cancels echoing. */
9622 message3 (Lisp_Object m
, ptrdiff_t nbytes
, int multibyte
)
9624 struct gcpro gcpro1
;
9627 clear_message (1,1);
9630 /* First flush out any partial line written with print. */
9631 message_log_maybe_newline ();
9635 char *buffer
= SAFE_ALLOCA (nbytes
);
9636 memcpy (buffer
, SDATA (m
), nbytes
);
9637 message_dolog (buffer
, nbytes
, 1, multibyte
);
9640 message3_nolog (m
, nbytes
, multibyte
);
9646 /* The non-logging version of message3.
9647 This does not cancel echoing, because it is used for echoing.
9648 Perhaps we need to make a separate function for echoing
9649 and make this cancel echoing. */
9652 message3_nolog (Lisp_Object m
, ptrdiff_t nbytes
, int multibyte
)
9654 struct frame
*sf
= SELECTED_FRAME ();
9655 message_enable_multibyte
= multibyte
;
9657 if (FRAME_INITIAL_P (sf
))
9659 if (noninteractive_need_newline
)
9660 putc ('\n', stderr
);
9661 noninteractive_need_newline
= 0;
9663 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9664 if (cursor_in_echo_area
== 0)
9665 fprintf (stderr
, "\n");
9668 /* A null message buffer means that the frame hasn't really been
9669 initialized yet. Error messages get reported properly by
9670 cmd_error, so this must be just an informative message; toss it. */
9671 else if (INTERACTIVE
9672 && sf
->glyphs_initialized_p
9673 && FRAME_MESSAGE_BUF (sf
))
9675 Lisp_Object mini_window
;
9679 /* Get the frame containing the mini-buffer
9680 that the selected frame is using. */
9681 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9682 frame
= XWINDOW (mini_window
)->frame
;
9685 FRAME_SAMPLE_VISIBILITY (f
);
9686 if (FRAME_VISIBLE_P (sf
)
9687 && !FRAME_VISIBLE_P (f
))
9688 Fmake_frame_visible (frame
);
9690 if (STRINGP (m
) && SCHARS (m
) > 0)
9692 set_message (NULL
, m
, nbytes
, multibyte
);
9693 if (minibuffer_auto_raise
)
9694 Fraise_frame (frame
);
9695 /* Assume we are not echoing.
9696 (If we are, echo_now will override this.) */
9697 echo_message_buffer
= Qnil
;
9700 clear_message (1, 1);
9702 do_pending_window_change (0);
9703 echo_area_display (1);
9704 do_pending_window_change (0);
9705 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9706 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9711 /* Display a null-terminated echo area message M. If M is 0, clear
9712 out any existing message, and let the mini-buffer text show through.
9714 The buffer M must continue to exist until after the echo area gets
9715 cleared or some other message gets displayed there. Do not pass
9716 text that is stored in a Lisp string. Do not pass text in a buffer
9717 that was alloca'd. */
9720 message1 (const char *m
)
9722 message2 (m
, (m
? strlen (m
) : 0), 0);
9726 /* The non-logging counterpart of message1. */
9729 message1_nolog (const char *m
)
9731 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9734 /* Display a message M which contains a single %s
9735 which gets replaced with STRING. */
9738 message_with_string (const char *m
, Lisp_Object string
, int log
)
9740 CHECK_STRING (string
);
9746 if (noninteractive_need_newline
)
9747 putc ('\n', stderr
);
9748 noninteractive_need_newline
= 0;
9749 fprintf (stderr
, m
, SDATA (string
));
9750 if (!cursor_in_echo_area
)
9751 fprintf (stderr
, "\n");
9755 else if (INTERACTIVE
)
9757 /* The frame whose minibuffer we're going to display the message on.
9758 It may be larger than the selected frame, so we need
9759 to use its buffer, not the selected frame's buffer. */
9760 Lisp_Object mini_window
;
9761 struct frame
*f
, *sf
= SELECTED_FRAME ();
9763 /* Get the frame containing the minibuffer
9764 that the selected frame is using. */
9765 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9766 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9768 /* A null message buffer means that the frame hasn't really been
9769 initialized yet. Error messages get reported properly by
9770 cmd_error, so this must be just an informative message; toss it. */
9771 if (FRAME_MESSAGE_BUF (f
))
9773 Lisp_Object args
[2], msg
;
9774 struct gcpro gcpro1
, gcpro2
;
9776 args
[0] = build_string (m
);
9777 args
[1] = msg
= string
;
9778 GCPRO2 (args
[0], msg
);
9781 msg
= Fformat (2, args
);
9784 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9786 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9790 /* Print should start at the beginning of the message
9791 buffer next time. */
9792 message_buf_print
= 0;
9798 /* Dump an informative message to the minibuf. If M is 0, clear out
9799 any existing message, and let the mini-buffer text show through. */
9802 vmessage (const char *m
, va_list ap
)
9808 if (noninteractive_need_newline
)
9809 putc ('\n', stderr
);
9810 noninteractive_need_newline
= 0;
9811 vfprintf (stderr
, m
, ap
);
9812 if (cursor_in_echo_area
== 0)
9813 fprintf (stderr
, "\n");
9817 else if (INTERACTIVE
)
9819 /* The frame whose mini-buffer we're going to display the message
9820 on. It may be larger than the selected frame, so we need to
9821 use its buffer, not the selected frame's buffer. */
9822 Lisp_Object mini_window
;
9823 struct frame
*f
, *sf
= SELECTED_FRAME ();
9825 /* Get the frame containing the mini-buffer
9826 that the selected frame is using. */
9827 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9828 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9830 /* A null message buffer means that the frame hasn't really been
9831 initialized yet. Error messages get reported properly by
9832 cmd_error, so this must be just an informative message; toss
9834 if (FRAME_MESSAGE_BUF (f
))
9840 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9841 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9843 message2 (FRAME_MESSAGE_BUF (f
), len
, 1);
9848 /* Print should start at the beginning of the message
9849 buffer next time. */
9850 message_buf_print
= 0;
9856 message (const char *m
, ...)
9866 /* The non-logging version of message. */
9869 message_nolog (const char *m
, ...)
9871 Lisp_Object old_log_max
;
9874 old_log_max
= Vmessage_log_max
;
9875 Vmessage_log_max
= Qnil
;
9877 Vmessage_log_max
= old_log_max
;
9883 /* Display the current message in the current mini-buffer. This is
9884 only called from error handlers in process.c, and is not time
9888 update_echo_area (void)
9890 if (!NILP (echo_area_buffer
[0]))
9893 string
= Fcurrent_message ();
9894 message3 (string
, SBYTES (string
),
9895 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9900 /* Make sure echo area buffers in `echo_buffers' are live.
9901 If they aren't, make new ones. */
9904 ensure_echo_area_buffers (void)
9908 for (i
= 0; i
< 2; ++i
)
9909 if (!BUFFERP (echo_buffer
[i
])
9910 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
9913 Lisp_Object old_buffer
;
9916 old_buffer
= echo_buffer
[i
];
9917 echo_buffer
[i
] = Fget_buffer_create
9918 (make_formatted_string (name
, " *Echo Area %d*", i
));
9919 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
9920 /* to force word wrap in echo area -
9921 it was decided to postpone this*/
9922 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9924 for (j
= 0; j
< 2; ++j
)
9925 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9926 echo_area_buffer
[j
] = echo_buffer
[i
];
9931 /* Call FN with args A1..A4 with either the current or last displayed
9932 echo_area_buffer as current buffer.
9934 WHICH zero means use the current message buffer
9935 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9936 from echo_buffer[] and clear it.
9938 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9939 suitable buffer from echo_buffer[] and clear it.
9941 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9942 that the current message becomes the last displayed one, make
9943 choose a suitable buffer for echo_area_buffer[0], and clear it.
9945 Value is what FN returns. */
9948 with_echo_area_buffer (struct window
*w
, int which
,
9949 int (*fn
) (ptrdiff_t, Lisp_Object
, ptrdiff_t, ptrdiff_t),
9950 ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
9953 int this_one
, the_other
, clear_buffer_p
, rc
;
9954 ptrdiff_t count
= SPECPDL_INDEX ();
9956 /* If buffers aren't live, make new ones. */
9957 ensure_echo_area_buffers ();
9962 this_one
= 0, the_other
= 1;
9964 this_one
= 1, the_other
= 0;
9967 this_one
= 0, the_other
= 1;
9970 /* We need a fresh one in case the current echo buffer equals
9971 the one containing the last displayed echo area message. */
9972 if (!NILP (echo_area_buffer
[this_one
])
9973 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9974 echo_area_buffer
[this_one
] = Qnil
;
9977 /* Choose a suitable buffer from echo_buffer[] is we don't
9979 if (NILP (echo_area_buffer
[this_one
]))
9981 echo_area_buffer
[this_one
]
9982 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9983 ? echo_buffer
[the_other
]
9984 : echo_buffer
[this_one
]);
9988 buffer
= echo_area_buffer
[this_one
];
9990 /* Don't get confused by reusing the buffer used for echoing
9991 for a different purpose. */
9992 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9995 record_unwind_protect (unwind_with_echo_area_buffer
,
9996 with_echo_area_buffer_unwind_data (w
));
9998 /* Make the echo area buffer current. Note that for display
9999 purposes, it is not necessary that the displayed window's buffer
10000 == current_buffer, except for text property lookup. So, let's
10001 only set that buffer temporarily here without doing a full
10002 Fset_window_buffer. We must also change w->pointm, though,
10003 because otherwise an assertions in unshow_buffer fails, and Emacs
10005 set_buffer_internal_1 (XBUFFER (buffer
));
10008 wset_buffer (w
, buffer
);
10009 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10012 bset_undo_list (current_buffer
, Qt
);
10013 bset_read_only (current_buffer
, Qnil
);
10014 specbind (Qinhibit_read_only
, Qt
);
10015 specbind (Qinhibit_modification_hooks
, Qt
);
10017 if (clear_buffer_p
&& Z
> BEG
)
10018 del_range (BEG
, Z
);
10020 eassert (BEGV
>= BEG
);
10021 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10023 rc
= fn (a1
, a2
, a3
, a4
);
10025 eassert (BEGV
>= BEG
);
10026 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10028 unbind_to (count
, Qnil
);
10033 /* Save state that should be preserved around the call to the function
10034 FN called in with_echo_area_buffer. */
10037 with_echo_area_buffer_unwind_data (struct window
*w
)
10040 Lisp_Object vector
, tmp
;
10042 /* Reduce consing by keeping one vector in
10043 Vwith_echo_area_save_vector. */
10044 vector
= Vwith_echo_area_save_vector
;
10045 Vwith_echo_area_save_vector
= Qnil
;
10048 vector
= Fmake_vector (make_number (7), Qnil
);
10050 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10051 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10052 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10056 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10057 ASET (vector
, i
, w
->buffer
); ++i
;
10058 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
10059 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
10064 for (; i
< end
; ++i
)
10065 ASET (vector
, i
, Qnil
);
10068 eassert (i
== ASIZE (vector
));
10073 /* Restore global state from VECTOR which was created by
10074 with_echo_area_buffer_unwind_data. */
10077 unwind_with_echo_area_buffer (Lisp_Object vector
)
10079 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10080 Vdeactivate_mark
= AREF (vector
, 1);
10081 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10083 if (WINDOWP (AREF (vector
, 3)))
10086 Lisp_Object buffer
, charpos
, bytepos
;
10088 w
= XWINDOW (AREF (vector
, 3));
10089 buffer
= AREF (vector
, 4);
10090 charpos
= AREF (vector
, 5);
10091 bytepos
= AREF (vector
, 6);
10093 wset_buffer (w
, buffer
);
10094 set_marker_both (w
->pointm
, buffer
,
10095 XFASTINT (charpos
), XFASTINT (bytepos
));
10098 Vwith_echo_area_save_vector
= vector
;
10103 /* Set up the echo area for use by print functions. MULTIBYTE_P
10104 non-zero means we will print multibyte. */
10107 setup_echo_area_for_printing (int multibyte_p
)
10109 /* If we can't find an echo area any more, exit. */
10110 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10111 Fkill_emacs (Qnil
);
10113 ensure_echo_area_buffers ();
10115 if (!message_buf_print
)
10117 /* A message has been output since the last time we printed.
10118 Choose a fresh echo area buffer. */
10119 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10120 echo_area_buffer
[0] = echo_buffer
[1];
10122 echo_area_buffer
[0] = echo_buffer
[0];
10124 /* Switch to that buffer and clear it. */
10125 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10126 bset_truncate_lines (current_buffer
, Qnil
);
10130 ptrdiff_t count
= SPECPDL_INDEX ();
10131 specbind (Qinhibit_read_only
, Qt
);
10132 /* Note that undo recording is always disabled. */
10133 del_range (BEG
, Z
);
10134 unbind_to (count
, Qnil
);
10136 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10138 /* Set up the buffer for the multibyteness we need. */
10140 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10141 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10143 /* Raise the frame containing the echo area. */
10144 if (minibuffer_auto_raise
)
10146 struct frame
*sf
= SELECTED_FRAME ();
10147 Lisp_Object mini_window
;
10148 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10149 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10152 message_log_maybe_newline ();
10153 message_buf_print
= 1;
10157 if (NILP (echo_area_buffer
[0]))
10159 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10160 echo_area_buffer
[0] = echo_buffer
[1];
10162 echo_area_buffer
[0] = echo_buffer
[0];
10165 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10167 /* Someone switched buffers between print requests. */
10168 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10169 bset_truncate_lines (current_buffer
, Qnil
);
10175 /* Display an echo area message in window W. Value is non-zero if W's
10176 height is changed. If display_last_displayed_message_p is
10177 non-zero, display the message that was last displayed, otherwise
10178 display the current message. */
10181 display_echo_area (struct window
*w
)
10183 int i
, no_message_p
, window_height_changed_p
;
10185 /* Temporarily disable garbage collections while displaying the echo
10186 area. This is done because a GC can print a message itself.
10187 That message would modify the echo area buffer's contents while a
10188 redisplay of the buffer is going on, and seriously confuse
10190 ptrdiff_t count
= inhibit_garbage_collection ();
10192 /* If there is no message, we must call display_echo_area_1
10193 nevertheless because it resizes the window. But we will have to
10194 reset the echo_area_buffer in question to nil at the end because
10195 with_echo_area_buffer will sets it to an empty buffer. */
10196 i
= display_last_displayed_message_p
? 1 : 0;
10197 no_message_p
= NILP (echo_area_buffer
[i
]);
10199 window_height_changed_p
10200 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10201 display_echo_area_1
,
10202 (intptr_t) w
, Qnil
, 0, 0);
10205 echo_area_buffer
[i
] = Qnil
;
10207 unbind_to (count
, Qnil
);
10208 return window_height_changed_p
;
10212 /* Helper for display_echo_area. Display the current buffer which
10213 contains the current echo area message in window W, a mini-window,
10214 a pointer to which is passed in A1. A2..A4 are currently not used.
10215 Change the height of W so that all of the message is displayed.
10216 Value is non-zero if height of W was changed. */
10219 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10222 struct window
*w
= (struct window
*) i1
;
10223 Lisp_Object window
;
10224 struct text_pos start
;
10225 int window_height_changed_p
= 0;
10227 /* Do this before displaying, so that we have a large enough glyph
10228 matrix for the display. If we can't get enough space for the
10229 whole text, display the last N lines. That works by setting w->start. */
10230 window_height_changed_p
= resize_mini_window (w
, 0);
10232 /* Use the starting position chosen by resize_mini_window. */
10233 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10236 clear_glyph_matrix (w
->desired_matrix
);
10237 XSETWINDOW (window
, w
);
10238 try_window (window
, start
, 0);
10240 return window_height_changed_p
;
10244 /* Resize the echo area window to exactly the size needed for the
10245 currently displayed message, if there is one. If a mini-buffer
10246 is active, don't shrink it. */
10249 resize_echo_area_exactly (void)
10251 if (BUFFERP (echo_area_buffer
[0])
10252 && WINDOWP (echo_area_window
))
10254 struct window
*w
= XWINDOW (echo_area_window
);
10256 Lisp_Object resize_exactly
;
10258 if (minibuf_level
== 0)
10259 resize_exactly
= Qt
;
10261 resize_exactly
= Qnil
;
10263 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10264 (intptr_t) w
, resize_exactly
,
10268 ++windows_or_buffers_changed
;
10269 ++update_mode_lines
;
10270 redisplay_internal ();
10276 /* Callback function for with_echo_area_buffer, when used from
10277 resize_echo_area_exactly. A1 contains a pointer to the window to
10278 resize, EXACTLY non-nil means resize the mini-window exactly to the
10279 size of the text displayed. A3 and A4 are not used. Value is what
10280 resize_mini_window returns. */
10283 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
, ptrdiff_t a3
, ptrdiff_t a4
)
10286 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10290 /* Resize mini-window W to fit the size of its contents. EXACT_P
10291 means size the window exactly to the size needed. Otherwise, it's
10292 only enlarged until W's buffer is empty.
10294 Set W->start to the right place to begin display. If the whole
10295 contents fit, start at the beginning. Otherwise, start so as
10296 to make the end of the contents appear. This is particularly
10297 important for y-or-n-p, but seems desirable generally.
10299 Value is non-zero if the window height has been changed. */
10302 resize_mini_window (struct window
*w
, int exact_p
)
10304 struct frame
*f
= XFRAME (w
->frame
);
10305 int window_height_changed_p
= 0;
10307 eassert (MINI_WINDOW_P (w
));
10309 /* By default, start display at the beginning. */
10310 set_marker_both (w
->start
, w
->buffer
,
10311 BUF_BEGV (XBUFFER (w
->buffer
)),
10312 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
10314 /* Don't resize windows while redisplaying a window; it would
10315 confuse redisplay functions when the size of the window they are
10316 displaying changes from under them. Such a resizing can happen,
10317 for instance, when which-func prints a long message while
10318 we are running fontification-functions. We're running these
10319 functions with safe_call which binds inhibit-redisplay to t. */
10320 if (!NILP (Vinhibit_redisplay
))
10323 /* Nil means don't try to resize. */
10324 if (NILP (Vresize_mini_windows
)
10325 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10328 if (!FRAME_MINIBUF_ONLY_P (f
))
10331 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10332 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10334 EMACS_INT max_height
;
10335 int unit
= FRAME_LINE_HEIGHT (f
);
10336 struct text_pos start
;
10337 struct buffer
*old_current_buffer
= NULL
;
10339 if (current_buffer
!= XBUFFER (w
->buffer
))
10341 old_current_buffer
= current_buffer
;
10342 set_buffer_internal (XBUFFER (w
->buffer
));
10345 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10347 /* Compute the max. number of lines specified by the user. */
10348 if (FLOATP (Vmax_mini_window_height
))
10349 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10350 else if (INTEGERP (Vmax_mini_window_height
))
10351 max_height
= XINT (Vmax_mini_window_height
);
10353 max_height
= total_height
/ 4;
10355 /* Correct that max. height if it's bogus. */
10356 max_height
= max (1, max_height
);
10357 max_height
= min (total_height
, max_height
);
10359 /* Find out the height of the text in the window. */
10360 if (it
.line_wrap
== TRUNCATE
)
10365 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10366 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10367 height
= it
.current_y
+ last_height
;
10369 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10370 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10371 height
= (height
+ unit
- 1) / unit
;
10374 /* Compute a suitable window start. */
10375 if (height
> max_height
)
10377 height
= max_height
;
10378 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10379 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10380 start
= it
.current
.pos
;
10383 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10384 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10386 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10388 /* Let it grow only, until we display an empty message, in which
10389 case the window shrinks again. */
10390 if (height
> WINDOW_TOTAL_LINES (w
))
10392 int old_height
= WINDOW_TOTAL_LINES (w
);
10393 freeze_window_starts (f
, 1);
10394 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10395 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10397 else if (height
< WINDOW_TOTAL_LINES (w
)
10398 && (exact_p
|| BEGV
== ZV
))
10400 int old_height
= WINDOW_TOTAL_LINES (w
);
10401 freeze_window_starts (f
, 0);
10402 shrink_mini_window (w
);
10403 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10408 /* Always resize to exact size needed. */
10409 if (height
> WINDOW_TOTAL_LINES (w
))
10411 int old_height
= WINDOW_TOTAL_LINES (w
);
10412 freeze_window_starts (f
, 1);
10413 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10414 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10416 else if (height
< WINDOW_TOTAL_LINES (w
))
10418 int old_height
= WINDOW_TOTAL_LINES (w
);
10419 freeze_window_starts (f
, 0);
10420 shrink_mini_window (w
);
10424 freeze_window_starts (f
, 1);
10425 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10428 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10432 if (old_current_buffer
)
10433 set_buffer_internal (old_current_buffer
);
10436 return window_height_changed_p
;
10440 /* Value is the current message, a string, or nil if there is no
10441 current message. */
10444 current_message (void)
10448 if (!BUFFERP (echo_area_buffer
[0]))
10452 with_echo_area_buffer (0, 0, current_message_1
,
10453 (intptr_t) &msg
, Qnil
, 0, 0);
10455 echo_area_buffer
[0] = Qnil
;
10463 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10466 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10469 *msg
= make_buffer_string (BEG
, Z
, 1);
10476 /* Push the current message on Vmessage_stack for later restoration
10477 by restore_message. Value is non-zero if the current message isn't
10478 empty. This is a relatively infrequent operation, so it's not
10479 worth optimizing. */
10482 push_message (void)
10484 Lisp_Object msg
= current_message ();
10485 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10486 return STRINGP (msg
);
10490 /* Restore message display from the top of Vmessage_stack. */
10493 restore_message (void)
10497 eassert (CONSP (Vmessage_stack
));
10498 msg
= XCAR (Vmessage_stack
);
10500 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10502 message3_nolog (msg
, 0, 0);
10506 /* Handler for record_unwind_protect calling pop_message. */
10509 pop_message_unwind (Lisp_Object dummy
)
10515 /* Pop the top-most entry off Vmessage_stack. */
10520 eassert (CONSP (Vmessage_stack
));
10521 Vmessage_stack
= XCDR (Vmessage_stack
);
10525 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10526 exits. If the stack is not empty, we have a missing pop_message
10530 check_message_stack (void)
10532 if (!NILP (Vmessage_stack
))
10537 /* Truncate to NCHARS what will be displayed in the echo area the next
10538 time we display it---but don't redisplay it now. */
10541 truncate_echo_area (ptrdiff_t nchars
)
10544 echo_area_buffer
[0] = Qnil
;
10545 /* A null message buffer means that the frame hasn't really been
10546 initialized yet. Error messages get reported properly by
10547 cmd_error, so this must be just an informative message; toss it. */
10548 else if (!noninteractive
10550 && !NILP (echo_area_buffer
[0]))
10552 struct frame
*sf
= SELECTED_FRAME ();
10553 if (FRAME_MESSAGE_BUF (sf
))
10554 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10559 /* Helper function for truncate_echo_area. Truncate the current
10560 message to at most NCHARS characters. */
10563 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
, ptrdiff_t a3
, ptrdiff_t a4
)
10565 if (BEG
+ nchars
< Z
)
10566 del_range (BEG
+ nchars
, Z
);
10568 echo_area_buffer
[0] = Qnil
;
10572 /* Set the current message to a substring of S or STRING.
10574 If STRING is a Lisp string, set the message to the first NBYTES
10575 bytes from STRING. NBYTES zero means use the whole string. If
10576 STRING is multibyte, the message will be displayed multibyte.
10578 If S is not null, set the message to the first LEN bytes of S. LEN
10579 zero means use the whole string. MULTIBYTE_P non-zero means S is
10580 multibyte. Display the message multibyte in that case.
10582 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10583 to t before calling set_message_1 (which calls insert).
10587 set_message (const char *s
, Lisp_Object string
,
10588 ptrdiff_t nbytes
, int multibyte_p
)
10590 message_enable_multibyte
10591 = ((s
&& multibyte_p
)
10592 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10594 with_echo_area_buffer (0, -1, set_message_1
,
10595 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10596 message_buf_print
= 0;
10597 help_echo_showing_p
= 0;
10599 if (STRINGP (Vdebug_on_message
)
10600 && fast_string_match (Vdebug_on_message
, string
) >= 0)
10601 call_debugger (list2 (Qerror
, string
));
10605 /* Helper function for set_message. Arguments have the same meaning
10606 as there, with A1 corresponding to S and A2 corresponding to STRING
10607 This function is called with the echo area buffer being
10611 set_message_1 (ptrdiff_t a1
, Lisp_Object a2
, ptrdiff_t nbytes
, ptrdiff_t multibyte_p
)
10614 const char *s
= (const char *) i1
;
10615 const unsigned char *msg
= (const unsigned char *) s
;
10616 Lisp_Object string
= a2
;
10618 /* Change multibyteness of the echo buffer appropriately. */
10619 if (message_enable_multibyte
10620 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10621 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10623 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
10624 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10625 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
10627 /* Insert new message at BEG. */
10628 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10630 if (STRINGP (string
))
10635 nbytes
= SBYTES (string
);
10636 nchars
= string_byte_to_char (string
, nbytes
);
10638 /* This function takes care of single/multibyte conversion. We
10639 just have to ensure that the echo area buffer has the right
10640 setting of enable_multibyte_characters. */
10641 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10646 nbytes
= strlen (s
);
10648 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10650 /* Convert from multi-byte to single-byte. */
10655 /* Convert a multibyte string to single-byte. */
10656 for (i
= 0; i
< nbytes
; i
+= n
)
10658 c
= string_char_and_length (msg
+ i
, &n
);
10659 work
[0] = (ASCII_CHAR_P (c
)
10661 : multibyte_char_to_unibyte (c
));
10662 insert_1_both (work
, 1, 1, 1, 0, 0);
10665 else if (!multibyte_p
10666 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10668 /* Convert from single-byte to multi-byte. */
10671 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10673 /* Convert a single-byte string to multibyte. */
10674 for (i
= 0; i
< nbytes
; i
++)
10677 MAKE_CHAR_MULTIBYTE (c
);
10678 n
= CHAR_STRING (c
, str
);
10679 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10683 insert_1 (s
, nbytes
, 1, 0, 0);
10690 /* Clear messages. CURRENT_P non-zero means clear the current
10691 message. LAST_DISPLAYED_P non-zero means clear the message
10695 clear_message (int current_p
, int last_displayed_p
)
10699 echo_area_buffer
[0] = Qnil
;
10700 message_cleared_p
= 1;
10703 if (last_displayed_p
)
10704 echo_area_buffer
[1] = Qnil
;
10706 message_buf_print
= 0;
10709 /* Clear garbaged frames.
10711 This function is used where the old redisplay called
10712 redraw_garbaged_frames which in turn called redraw_frame which in
10713 turn called clear_frame. The call to clear_frame was a source of
10714 flickering. I believe a clear_frame is not necessary. It should
10715 suffice in the new redisplay to invalidate all current matrices,
10716 and ensure a complete redisplay of all windows. */
10719 clear_garbaged_frames (void)
10721 if (frame_garbaged
)
10723 Lisp_Object tail
, frame
;
10724 int changed_count
= 0;
10726 FOR_EACH_FRAME (tail
, frame
)
10728 struct frame
*f
= XFRAME (frame
);
10730 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10734 Fredraw_frame (frame
);
10735 f
->force_flush_display_p
= 1;
10737 clear_current_matrices (f
);
10744 frame_garbaged
= 0;
10746 ++windows_or_buffers_changed
;
10751 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10752 is non-zero update selected_frame. Value is non-zero if the
10753 mini-windows height has been changed. */
10756 echo_area_display (int update_frame_p
)
10758 Lisp_Object mini_window
;
10761 int window_height_changed_p
= 0;
10762 struct frame
*sf
= SELECTED_FRAME ();
10764 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10765 w
= XWINDOW (mini_window
);
10766 f
= XFRAME (WINDOW_FRAME (w
));
10768 /* Don't display if frame is invisible or not yet initialized. */
10769 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10772 #ifdef HAVE_WINDOW_SYSTEM
10773 /* When Emacs starts, selected_frame may be the initial terminal
10774 frame. If we let this through, a message would be displayed on
10776 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10778 #endif /* HAVE_WINDOW_SYSTEM */
10780 /* Redraw garbaged frames. */
10781 if (frame_garbaged
)
10782 clear_garbaged_frames ();
10784 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10786 echo_area_window
= mini_window
;
10787 window_height_changed_p
= display_echo_area (w
);
10788 w
->must_be_updated_p
= 1;
10790 /* Update the display, unless called from redisplay_internal.
10791 Also don't update the screen during redisplay itself. The
10792 update will happen at the end of redisplay, and an update
10793 here could cause confusion. */
10794 if (update_frame_p
&& !redisplaying_p
)
10798 /* If the display update has been interrupted by pending
10799 input, update mode lines in the frame. Due to the
10800 pending input, it might have been that redisplay hasn't
10801 been called, so that mode lines above the echo area are
10802 garbaged. This looks odd, so we prevent it here. */
10803 if (!display_completed
)
10804 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10806 if (window_height_changed_p
10807 /* Don't do this if Emacs is shutting down. Redisplay
10808 needs to run hooks. */
10809 && !NILP (Vrun_hooks
))
10811 /* Must update other windows. Likewise as in other
10812 cases, don't let this update be interrupted by
10814 ptrdiff_t count
= SPECPDL_INDEX ();
10815 specbind (Qredisplay_dont_pause
, Qt
);
10816 windows_or_buffers_changed
= 1;
10817 redisplay_internal ();
10818 unbind_to (count
, Qnil
);
10820 else if (FRAME_WINDOW_P (f
) && n
== 0)
10822 /* Window configuration is the same as before.
10823 Can do with a display update of the echo area,
10824 unless we displayed some mode lines. */
10825 update_single_window (w
, 1);
10826 FRAME_RIF (f
)->flush_display (f
);
10829 update_frame (f
, 1, 1);
10831 /* If cursor is in the echo area, make sure that the next
10832 redisplay displays the minibuffer, so that the cursor will
10833 be replaced with what the minibuffer wants. */
10834 if (cursor_in_echo_area
)
10835 ++windows_or_buffers_changed
;
10838 else if (!EQ (mini_window
, selected_window
))
10839 windows_or_buffers_changed
++;
10841 /* Last displayed message is now the current message. */
10842 echo_area_buffer
[1] = echo_area_buffer
[0];
10843 /* Inform read_char that we're not echoing. */
10844 echo_message_buffer
= Qnil
;
10846 /* Prevent redisplay optimization in redisplay_internal by resetting
10847 this_line_start_pos. This is done because the mini-buffer now
10848 displays the message instead of its buffer text. */
10849 if (EQ (mini_window
, selected_window
))
10850 CHARPOS (this_line_start_pos
) = 0;
10852 return window_height_changed_p
;
10857 /***********************************************************************
10858 Mode Lines and Frame Titles
10859 ***********************************************************************/
10861 /* A buffer for constructing non-propertized mode-line strings and
10862 frame titles in it; allocated from the heap in init_xdisp and
10863 resized as needed in store_mode_line_noprop_char. */
10865 static char *mode_line_noprop_buf
;
10867 /* The buffer's end, and a current output position in it. */
10869 static char *mode_line_noprop_buf_end
;
10870 static char *mode_line_noprop_ptr
;
10872 #define MODE_LINE_NOPROP_LEN(start) \
10873 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10876 MODE_LINE_DISPLAY
= 0,
10880 } mode_line_target
;
10882 /* Alist that caches the results of :propertize.
10883 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10884 static Lisp_Object mode_line_proptrans_alist
;
10886 /* List of strings making up the mode-line. */
10887 static Lisp_Object mode_line_string_list
;
10889 /* Base face property when building propertized mode line string. */
10890 static Lisp_Object mode_line_string_face
;
10891 static Lisp_Object mode_line_string_face_prop
;
10894 /* Unwind data for mode line strings */
10896 static Lisp_Object Vmode_line_unwind_vector
;
10899 format_mode_line_unwind_data (struct frame
*target_frame
,
10900 struct buffer
*obuf
,
10902 int save_proptrans
)
10904 Lisp_Object vector
, tmp
;
10906 /* Reduce consing by keeping one vector in
10907 Vwith_echo_area_save_vector. */
10908 vector
= Vmode_line_unwind_vector
;
10909 Vmode_line_unwind_vector
= Qnil
;
10912 vector
= Fmake_vector (make_number (10), Qnil
);
10914 ASET (vector
, 0, make_number (mode_line_target
));
10915 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10916 ASET (vector
, 2, mode_line_string_list
);
10917 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10918 ASET (vector
, 4, mode_line_string_face
);
10919 ASET (vector
, 5, mode_line_string_face_prop
);
10922 XSETBUFFER (tmp
, obuf
);
10925 ASET (vector
, 6, tmp
);
10926 ASET (vector
, 7, owin
);
10929 /* Similarly to `with-selected-window', if the operation selects
10930 a window on another frame, we must restore that frame's
10931 selected window, and (for a tty) the top-frame. */
10932 ASET (vector
, 8, target_frame
->selected_window
);
10933 if (FRAME_TERMCAP_P (target_frame
))
10934 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
10941 unwind_format_mode_line (Lisp_Object vector
)
10943 Lisp_Object old_window
= AREF (vector
, 7);
10944 Lisp_Object target_frame_window
= AREF (vector
, 8);
10945 Lisp_Object old_top_frame
= AREF (vector
, 9);
10947 mode_line_target
= XINT (AREF (vector
, 0));
10948 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10949 mode_line_string_list
= AREF (vector
, 2);
10950 if (! EQ (AREF (vector
, 3), Qt
))
10951 mode_line_proptrans_alist
= AREF (vector
, 3);
10952 mode_line_string_face
= AREF (vector
, 4);
10953 mode_line_string_face_prop
= AREF (vector
, 5);
10955 /* Select window before buffer, since it may change the buffer. */
10956 if (!NILP (old_window
))
10958 /* If the operation that we are unwinding had selected a window
10959 on a different frame, reset its frame-selected-window. For a
10960 text terminal, reset its top-frame if necessary. */
10961 if (!NILP (target_frame_window
))
10964 = WINDOW_FRAME (XWINDOW (target_frame_window
));
10966 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
10967 Fselect_window (target_frame_window
, Qt
);
10969 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
10970 Fselect_frame (old_top_frame
, Qt
);
10973 Fselect_window (old_window
, Qt
);
10976 if (!NILP (AREF (vector
, 6)))
10978 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10979 ASET (vector
, 6, Qnil
);
10982 Vmode_line_unwind_vector
= vector
;
10987 /* Store a single character C for the frame title in mode_line_noprop_buf.
10988 Re-allocate mode_line_noprop_buf if necessary. */
10991 store_mode_line_noprop_char (char c
)
10993 /* If output position has reached the end of the allocated buffer,
10994 increase the buffer's size. */
10995 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10997 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10998 ptrdiff_t size
= len
;
10999 mode_line_noprop_buf
=
11000 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11001 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11002 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11005 *mode_line_noprop_ptr
++ = c
;
11009 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11010 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11011 characters that yield more columns than PRECISION; PRECISION <= 0
11012 means copy the whole string. Pad with spaces until FIELD_WIDTH
11013 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11014 pad. Called from display_mode_element when it is used to build a
11018 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11020 const unsigned char *str
= (const unsigned char *) string
;
11022 ptrdiff_t dummy
, nbytes
;
11024 /* Copy at most PRECISION chars from STR. */
11025 nbytes
= strlen (string
);
11026 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11028 store_mode_line_noprop_char (*str
++);
11030 /* Fill up with spaces until FIELD_WIDTH reached. */
11031 while (field_width
> 0
11032 && n
< field_width
)
11034 store_mode_line_noprop_char (' ');
11041 /***********************************************************************
11043 ***********************************************************************/
11045 #ifdef HAVE_WINDOW_SYSTEM
11047 /* Set the title of FRAME, if it has changed. The title format is
11048 Vicon_title_format if FRAME is iconified, otherwise it is
11049 frame_title_format. */
11052 x_consider_frame_title (Lisp_Object frame
)
11054 struct frame
*f
= XFRAME (frame
);
11056 if (FRAME_WINDOW_P (f
)
11057 || FRAME_MINIBUF_ONLY_P (f
)
11058 || f
->explicit_name
)
11060 /* Do we have more than one visible frame on this X display? */
11063 ptrdiff_t title_start
;
11067 ptrdiff_t count
= SPECPDL_INDEX ();
11069 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
11071 Lisp_Object other_frame
= XCAR (tail
);
11072 struct frame
*tf
= XFRAME (other_frame
);
11075 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11076 && !FRAME_MINIBUF_ONLY_P (tf
)
11077 && !EQ (other_frame
, tip_frame
)
11078 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11082 /* Set global variable indicating that multiple frames exist. */
11083 multiple_frames
= CONSP (tail
);
11085 /* Switch to the buffer of selected window of the frame. Set up
11086 mode_line_target so that display_mode_element will output into
11087 mode_line_noprop_buf; then display the title. */
11088 record_unwind_protect (unwind_format_mode_line
,
11089 format_mode_line_unwind_data
11090 (f
, current_buffer
, selected_window
, 0));
11092 Fselect_window (f
->selected_window
, Qt
);
11093 set_buffer_internal_1
11094 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
11095 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11097 mode_line_target
= MODE_LINE_TITLE
;
11098 title_start
= MODE_LINE_NOPROP_LEN (0);
11099 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11100 NULL
, DEFAULT_FACE_ID
);
11101 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11102 len
= MODE_LINE_NOPROP_LEN (title_start
);
11103 title
= mode_line_noprop_buf
+ title_start
;
11104 unbind_to (count
, Qnil
);
11106 /* Set the title only if it's changed. This avoids consing in
11107 the common case where it hasn't. (If it turns out that we've
11108 already wasted too much time by walking through the list with
11109 display_mode_element, then we might need to optimize at a
11110 higher level than this.) */
11111 if (! STRINGP (f
->name
)
11112 || SBYTES (f
->name
) != len
11113 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11114 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11118 #endif /* not HAVE_WINDOW_SYSTEM */
11121 /***********************************************************************
11123 ***********************************************************************/
11126 /* Prepare for redisplay by updating menu-bar item lists when
11127 appropriate. This can call eval. */
11130 prepare_menu_bars (void)
11133 struct gcpro gcpro1
, gcpro2
;
11135 Lisp_Object tooltip_frame
;
11137 #ifdef HAVE_WINDOW_SYSTEM
11138 tooltip_frame
= tip_frame
;
11140 tooltip_frame
= Qnil
;
11143 /* Update all frame titles based on their buffer names, etc. We do
11144 this before the menu bars so that the buffer-menu will show the
11145 up-to-date frame titles. */
11146 #ifdef HAVE_WINDOW_SYSTEM
11147 if (windows_or_buffers_changed
|| update_mode_lines
)
11149 Lisp_Object tail
, frame
;
11151 FOR_EACH_FRAME (tail
, frame
)
11153 f
= XFRAME (frame
);
11154 if (!EQ (frame
, tooltip_frame
)
11155 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
11156 x_consider_frame_title (frame
);
11159 #endif /* HAVE_WINDOW_SYSTEM */
11161 /* Update the menu bar item lists, if appropriate. This has to be
11162 done before any actual redisplay or generation of display lines. */
11163 all_windows
= (update_mode_lines
11164 || buffer_shared
> 1
11165 || windows_or_buffers_changed
);
11168 Lisp_Object tail
, frame
;
11169 ptrdiff_t count
= SPECPDL_INDEX ();
11170 /* 1 means that update_menu_bar has run its hooks
11171 so any further calls to update_menu_bar shouldn't do so again. */
11172 int menu_bar_hooks_run
= 0;
11174 record_unwind_save_match_data ();
11176 FOR_EACH_FRAME (tail
, frame
)
11178 f
= XFRAME (frame
);
11180 /* Ignore tooltip frame. */
11181 if (EQ (frame
, tooltip_frame
))
11184 /* If a window on this frame changed size, report that to
11185 the user and clear the size-change flag. */
11186 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11188 Lisp_Object functions
;
11190 /* Clear flag first in case we get an error below. */
11191 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11192 functions
= Vwindow_size_change_functions
;
11193 GCPRO2 (tail
, functions
);
11195 while (CONSP (functions
))
11197 if (!EQ (XCAR (functions
), Qt
))
11198 call1 (XCAR (functions
), frame
);
11199 functions
= XCDR (functions
);
11205 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11206 #ifdef HAVE_WINDOW_SYSTEM
11207 update_tool_bar (f
, 0);
11210 if (windows_or_buffers_changed
11213 (f
, Fbuffer_modified_p (XWINDOW (f
->selected_window
)->buffer
));
11218 unbind_to (count
, Qnil
);
11222 struct frame
*sf
= SELECTED_FRAME ();
11223 update_menu_bar (sf
, 1, 0);
11224 #ifdef HAVE_WINDOW_SYSTEM
11225 update_tool_bar (sf
, 1);
11231 /* Update the menu bar item list for frame F. This has to be done
11232 before we start to fill in any display lines, because it can call
11235 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11237 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11238 already ran the menu bar hooks for this redisplay, so there
11239 is no need to run them again. The return value is the
11240 updated value of this flag, to pass to the next call. */
11243 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11245 Lisp_Object window
;
11246 register struct window
*w
;
11248 /* If called recursively during a menu update, do nothing. This can
11249 happen when, for instance, an activate-menubar-hook causes a
11251 if (inhibit_menubar_update
)
11254 window
= FRAME_SELECTED_WINDOW (f
);
11255 w
= XWINDOW (window
);
11257 if (FRAME_WINDOW_P (f
)
11259 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11260 || defined (HAVE_NS) || defined (USE_GTK)
11261 FRAME_EXTERNAL_MENU_BAR (f
)
11263 FRAME_MENU_BAR_LINES (f
) > 0
11265 : FRAME_MENU_BAR_LINES (f
) > 0)
11267 /* If the user has switched buffers or windows, we need to
11268 recompute to reflect the new bindings. But we'll
11269 recompute when update_mode_lines is set too; that means
11270 that people can use force-mode-line-update to request
11271 that the menu bar be recomputed. The adverse effect on
11272 the rest of the redisplay algorithm is about the same as
11273 windows_or_buffers_changed anyway. */
11274 if (windows_or_buffers_changed
11275 /* This used to test w->update_mode_line, but we believe
11276 there is no need to recompute the menu in that case. */
11277 || update_mode_lines
11278 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11279 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11280 != w
->last_had_star
)
11281 || ((!NILP (Vtransient_mark_mode
)
11282 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11283 != !NILP (w
->region_showing
)))
11285 struct buffer
*prev
= current_buffer
;
11286 ptrdiff_t count
= SPECPDL_INDEX ();
11288 specbind (Qinhibit_menubar_update
, Qt
);
11290 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11291 if (save_match_data
)
11292 record_unwind_save_match_data ();
11293 if (NILP (Voverriding_local_map_menu_flag
))
11295 specbind (Qoverriding_terminal_local_map
, Qnil
);
11296 specbind (Qoverriding_local_map
, Qnil
);
11301 /* Run the Lucid hook. */
11302 safe_run_hooks (Qactivate_menubar_hook
);
11304 /* If it has changed current-menubar from previous value,
11305 really recompute the menu-bar from the value. */
11306 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11307 call0 (Qrecompute_lucid_menubar
);
11309 safe_run_hooks (Qmenu_bar_update_hook
);
11314 XSETFRAME (Vmenu_updating_frame
, f
);
11315 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11317 /* Redisplay the menu bar in case we changed it. */
11318 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11319 || defined (HAVE_NS) || defined (USE_GTK)
11320 if (FRAME_WINDOW_P (f
))
11322 #if defined (HAVE_NS)
11323 /* All frames on Mac OS share the same menubar. So only
11324 the selected frame should be allowed to set it. */
11325 if (f
== SELECTED_FRAME ())
11327 set_frame_menubar (f
, 0, 0);
11330 /* On a terminal screen, the menu bar is an ordinary screen
11331 line, and this makes it get updated. */
11332 w
->update_mode_line
= 1;
11333 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11334 /* In the non-toolkit version, the menu bar is an ordinary screen
11335 line, and this makes it get updated. */
11336 w
->update_mode_line
= 1;
11337 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11339 unbind_to (count
, Qnil
);
11340 set_buffer_internal_1 (prev
);
11349 /***********************************************************************
11351 ***********************************************************************/
11353 #ifdef HAVE_WINDOW_SYSTEM
11356 Nominal cursor position -- where to draw output.
11357 HPOS and VPOS are window relative glyph matrix coordinates.
11358 X and Y are window relative pixel coordinates. */
11360 struct cursor_pos output_cursor
;
11364 Set the global variable output_cursor to CURSOR. All cursor
11365 positions are relative to updated_window. */
11368 set_output_cursor (struct cursor_pos
*cursor
)
11370 output_cursor
.hpos
= cursor
->hpos
;
11371 output_cursor
.vpos
= cursor
->vpos
;
11372 output_cursor
.x
= cursor
->x
;
11373 output_cursor
.y
= cursor
->y
;
11378 Set a nominal cursor position.
11380 HPOS and VPOS are column/row positions in a window glyph matrix. X
11381 and Y are window text area relative pixel positions.
11383 If this is done during an update, updated_window will contain the
11384 window that is being updated and the position is the future output
11385 cursor position for that window. If updated_window is null, use
11386 selected_window and display the cursor at the given position. */
11389 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
11393 /* If updated_window is not set, work on selected_window. */
11394 if (updated_window
)
11395 w
= updated_window
;
11397 w
= XWINDOW (selected_window
);
11399 /* Set the output cursor. */
11400 output_cursor
.hpos
= hpos
;
11401 output_cursor
.vpos
= vpos
;
11402 output_cursor
.x
= x
;
11403 output_cursor
.y
= y
;
11405 /* If not called as part of an update, really display the cursor.
11406 This will also set the cursor position of W. */
11407 if (updated_window
== NULL
)
11410 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
11411 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11412 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11417 #endif /* HAVE_WINDOW_SYSTEM */
11420 /***********************************************************************
11422 ***********************************************************************/
11424 #ifdef HAVE_WINDOW_SYSTEM
11426 /* Where the mouse was last time we reported a mouse event. */
11428 FRAME_PTR last_mouse_frame
;
11430 /* Tool-bar item index of the item on which a mouse button was pressed
11433 int last_tool_bar_item
;
11437 update_tool_bar_unwind (Lisp_Object frame
)
11439 selected_frame
= frame
;
11443 /* Update the tool-bar item list for frame F. This has to be done
11444 before we start to fill in any display lines. Called from
11445 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11446 and restore it here. */
11449 update_tool_bar (struct frame
*f
, int save_match_data
)
11451 #if defined (USE_GTK) || defined (HAVE_NS)
11452 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11454 int do_update
= WINDOWP (f
->tool_bar_window
)
11455 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11460 Lisp_Object window
;
11463 window
= FRAME_SELECTED_WINDOW (f
);
11464 w
= XWINDOW (window
);
11466 /* If the user has switched buffers or windows, we need to
11467 recompute to reflect the new bindings. But we'll
11468 recompute when update_mode_lines is set too; that means
11469 that people can use force-mode-line-update to request
11470 that the menu bar be recomputed. The adverse effect on
11471 the rest of the redisplay algorithm is about the same as
11472 windows_or_buffers_changed anyway. */
11473 if (windows_or_buffers_changed
11474 || w
->update_mode_line
11475 || update_mode_lines
11476 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11477 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11478 != w
->last_had_star
)
11479 || ((!NILP (Vtransient_mark_mode
)
11480 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11481 != !NILP (w
->region_showing
)))
11483 struct buffer
*prev
= current_buffer
;
11484 ptrdiff_t count
= SPECPDL_INDEX ();
11485 Lisp_Object frame
, new_tool_bar
;
11486 int new_n_tool_bar
;
11487 struct gcpro gcpro1
;
11489 /* Set current_buffer to the buffer of the selected
11490 window of the frame, so that we get the right local
11492 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11494 /* Save match data, if we must. */
11495 if (save_match_data
)
11496 record_unwind_save_match_data ();
11498 /* Make sure that we don't accidentally use bogus keymaps. */
11499 if (NILP (Voverriding_local_map_menu_flag
))
11501 specbind (Qoverriding_terminal_local_map
, Qnil
);
11502 specbind (Qoverriding_local_map
, Qnil
);
11505 GCPRO1 (new_tool_bar
);
11507 /* We must temporarily set the selected frame to this frame
11508 before calling tool_bar_items, because the calculation of
11509 the tool-bar keymap uses the selected frame (see
11510 `tool-bar-make-keymap' in tool-bar.el). */
11511 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
11512 XSETFRAME (frame
, f
);
11513 selected_frame
= frame
;
11515 /* Build desired tool-bar items from keymaps. */
11517 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11520 /* Redisplay the tool-bar if we changed it. */
11521 if (new_n_tool_bar
!= f
->n_tool_bar_items
11522 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11524 /* Redisplay that happens asynchronously due to an expose event
11525 may access f->tool_bar_items. Make sure we update both
11526 variables within BLOCK_INPUT so no such event interrupts. */
11528 fset_tool_bar_items (f
, new_tool_bar
);
11529 f
->n_tool_bar_items
= new_n_tool_bar
;
11530 w
->update_mode_line
= 1;
11536 unbind_to (count
, Qnil
);
11537 set_buffer_internal_1 (prev
);
11543 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11544 F's desired tool-bar contents. F->tool_bar_items must have
11545 been set up previously by calling prepare_menu_bars. */
11548 build_desired_tool_bar_string (struct frame
*f
)
11550 int i
, size
, size_needed
;
11551 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11552 Lisp_Object image
, plist
, props
;
11554 image
= plist
= props
= Qnil
;
11555 GCPRO3 (image
, plist
, props
);
11557 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11558 Otherwise, make a new string. */
11560 /* The size of the string we might be able to reuse. */
11561 size
= (STRINGP (f
->desired_tool_bar_string
)
11562 ? SCHARS (f
->desired_tool_bar_string
)
11565 /* We need one space in the string for each image. */
11566 size_needed
= f
->n_tool_bar_items
;
11568 /* Reuse f->desired_tool_bar_string, if possible. */
11569 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11570 fset_desired_tool_bar_string
11571 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11574 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11575 Fremove_text_properties (make_number (0), make_number (size
),
11576 props
, f
->desired_tool_bar_string
);
11579 /* Put a `display' property on the string for the images to display,
11580 put a `menu_item' property on tool-bar items with a value that
11581 is the index of the item in F's tool-bar item vector. */
11582 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11584 #define PROP(IDX) \
11585 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11587 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11588 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11589 int hmargin
, vmargin
, relief
, idx
, end
;
11591 /* If image is a vector, choose the image according to the
11593 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11594 if (VECTORP (image
))
11598 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11599 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11602 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11603 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11605 eassert (ASIZE (image
) >= idx
);
11606 image
= AREF (image
, idx
);
11611 /* Ignore invalid image specifications. */
11612 if (!valid_image_p (image
))
11615 /* Display the tool-bar button pressed, or depressed. */
11616 plist
= Fcopy_sequence (XCDR (image
));
11618 /* Compute margin and relief to draw. */
11619 relief
= (tool_bar_button_relief
>= 0
11620 ? tool_bar_button_relief
11621 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11622 hmargin
= vmargin
= relief
;
11624 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
11625 INT_MAX
- max (hmargin
, vmargin
)))
11627 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11628 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11630 else if (CONSP (Vtool_bar_button_margin
))
11632 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
11633 INT_MAX
- hmargin
))
11634 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11636 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
11637 INT_MAX
- vmargin
))
11638 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11641 if (auto_raise_tool_bar_buttons_p
)
11643 /* Add a `:relief' property to the image spec if the item is
11647 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11654 /* If image is selected, display it pressed, i.e. with a
11655 negative relief. If it's not selected, display it with a
11657 plist
= Fplist_put (plist
, QCrelief
,
11659 ? make_number (-relief
)
11660 : make_number (relief
)));
11665 /* Put a margin around the image. */
11666 if (hmargin
|| vmargin
)
11668 if (hmargin
== vmargin
)
11669 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11671 plist
= Fplist_put (plist
, QCmargin
,
11672 Fcons (make_number (hmargin
),
11673 make_number (vmargin
)));
11676 /* If button is not enabled, and we don't have special images
11677 for the disabled state, make the image appear disabled by
11678 applying an appropriate algorithm to it. */
11679 if (!enabled_p
&& idx
< 0)
11680 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11682 /* Put a `display' text property on the string for the image to
11683 display. Put a `menu-item' property on the string that gives
11684 the start of this item's properties in the tool-bar items
11686 image
= Fcons (Qimage
, plist
);
11687 props
= list4 (Qdisplay
, image
,
11688 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11690 /* Let the last image hide all remaining spaces in the tool bar
11691 string. The string can be longer than needed when we reuse a
11692 previous string. */
11693 if (i
+ 1 == f
->n_tool_bar_items
)
11694 end
= SCHARS (f
->desired_tool_bar_string
);
11697 Fadd_text_properties (make_number (i
), make_number (end
),
11698 props
, f
->desired_tool_bar_string
);
11706 /* Display one line of the tool-bar of frame IT->f.
11708 HEIGHT specifies the desired height of the tool-bar line.
11709 If the actual height of the glyph row is less than HEIGHT, the
11710 row's height is increased to HEIGHT, and the icons are centered
11711 vertically in the new height.
11713 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11714 count a final empty row in case the tool-bar width exactly matches
11719 display_tool_bar_line (struct it
*it
, int height
)
11721 struct glyph_row
*row
= it
->glyph_row
;
11722 int max_x
= it
->last_visible_x
;
11723 struct glyph
*last
;
11725 prepare_desired_row (row
);
11726 row
->y
= it
->current_y
;
11728 /* Note that this isn't made use of if the face hasn't a box,
11729 so there's no need to check the face here. */
11730 it
->start_of_box_run_p
= 1;
11732 while (it
->current_x
< max_x
)
11734 int x
, n_glyphs_before
, i
, nglyphs
;
11735 struct it it_before
;
11737 /* Get the next display element. */
11738 if (!get_next_display_element (it
))
11740 /* Don't count empty row if we are counting needed tool-bar lines. */
11741 if (height
< 0 && !it
->hpos
)
11746 /* Produce glyphs. */
11747 n_glyphs_before
= row
->used
[TEXT_AREA
];
11750 PRODUCE_GLYPHS (it
);
11752 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11754 x
= it_before
.current_x
;
11755 while (i
< nglyphs
)
11757 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11759 if (x
+ glyph
->pixel_width
> max_x
)
11761 /* Glyph doesn't fit on line. Backtrack. */
11762 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11764 /* If this is the only glyph on this line, it will never fit on the
11765 tool-bar, so skip it. But ensure there is at least one glyph,
11766 so we don't accidentally disable the tool-bar. */
11767 if (n_glyphs_before
== 0
11768 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11774 x
+= glyph
->pixel_width
;
11778 /* Stop at line end. */
11779 if (ITERATOR_AT_END_OF_LINE_P (it
))
11782 set_iterator_to_next (it
, 1);
11787 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11789 /* Use default face for the border below the tool bar.
11791 FIXME: When auto-resize-tool-bars is grow-only, there is
11792 no additional border below the possibly empty tool-bar lines.
11793 So to make the extra empty lines look "normal", we have to
11794 use the tool-bar face for the border too. */
11795 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11796 it
->face_id
= DEFAULT_FACE_ID
;
11798 extend_face_to_end_of_line (it
);
11799 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11800 last
->right_box_line_p
= 1;
11801 if (last
== row
->glyphs
[TEXT_AREA
])
11802 last
->left_box_line_p
= 1;
11804 /* Make line the desired height and center it vertically. */
11805 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11807 /* Don't add more than one line height. */
11808 height
%= FRAME_LINE_HEIGHT (it
->f
);
11809 it
->max_ascent
+= height
/ 2;
11810 it
->max_descent
+= (height
+ 1) / 2;
11813 compute_line_metrics (it
);
11815 /* If line is empty, make it occupy the rest of the tool-bar. */
11816 if (!row
->displays_text_p
)
11818 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11819 row
->visible_height
= row
->height
;
11820 row
->ascent
= row
->phys_ascent
= 0;
11821 row
->extra_line_spacing
= 0;
11824 row
->full_width_p
= 1;
11825 row
->continued_p
= 0;
11826 row
->truncated_on_left_p
= 0;
11827 row
->truncated_on_right_p
= 0;
11829 it
->current_x
= it
->hpos
= 0;
11830 it
->current_y
+= row
->height
;
11836 /* Max tool-bar height. */
11838 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11839 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11841 /* Value is the number of screen lines needed to make all tool-bar
11842 items of frame F visible. The number of actual rows needed is
11843 returned in *N_ROWS if non-NULL. */
11846 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11848 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11850 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11851 the desired matrix, so use (unused) mode-line row as temporary row to
11852 avoid destroying the first tool-bar row. */
11853 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11855 /* Initialize an iterator for iteration over
11856 F->desired_tool_bar_string in the tool-bar window of frame F. */
11857 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11858 it
.first_visible_x
= 0;
11859 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11860 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11861 it
.paragraph_embedding
= L2R
;
11863 while (!ITERATOR_AT_END_P (&it
))
11865 clear_glyph_row (temp_row
);
11866 it
.glyph_row
= temp_row
;
11867 display_tool_bar_line (&it
, -1);
11869 clear_glyph_row (temp_row
);
11871 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11873 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11875 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11879 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11881 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11882 (Lisp_Object frame
)
11889 frame
= selected_frame
;
11891 CHECK_FRAME (frame
);
11892 f
= XFRAME (frame
);
11894 if (WINDOWP (f
->tool_bar_window
)
11895 && (w
= XWINDOW (f
->tool_bar_window
),
11896 WINDOW_TOTAL_LINES (w
) > 0))
11898 update_tool_bar (f
, 1);
11899 if (f
->n_tool_bar_items
)
11901 build_desired_tool_bar_string (f
);
11902 nlines
= tool_bar_lines_needed (f
, NULL
);
11906 return make_number (nlines
);
11910 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11911 height should be changed. */
11914 redisplay_tool_bar (struct frame
*f
)
11918 struct glyph_row
*row
;
11920 #if defined (USE_GTK) || defined (HAVE_NS)
11921 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11922 update_frame_tool_bar (f
);
11926 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11927 do anything. This means you must start with tool-bar-lines
11928 non-zero to get the auto-sizing effect. Or in other words, you
11929 can turn off tool-bars by specifying tool-bar-lines zero. */
11930 if (!WINDOWP (f
->tool_bar_window
)
11931 || (w
= XWINDOW (f
->tool_bar_window
),
11932 WINDOW_TOTAL_LINES (w
) == 0))
11935 /* Set up an iterator for the tool-bar window. */
11936 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11937 it
.first_visible_x
= 0;
11938 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11939 row
= it
.glyph_row
;
11941 /* Build a string that represents the contents of the tool-bar. */
11942 build_desired_tool_bar_string (f
);
11943 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11944 /* FIXME: This should be controlled by a user option. But it
11945 doesn't make sense to have an R2L tool bar if the menu bar cannot
11946 be drawn also R2L, and making the menu bar R2L is tricky due
11947 toolkit-specific code that implements it. If an R2L tool bar is
11948 ever supported, display_tool_bar_line should also be augmented to
11949 call unproduce_glyphs like display_line and display_string
11951 it
.paragraph_embedding
= L2R
;
11953 if (f
->n_tool_bar_rows
== 0)
11957 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11958 nlines
!= WINDOW_TOTAL_LINES (w
)))
11961 int old_height
= WINDOW_TOTAL_LINES (w
);
11963 XSETFRAME (frame
, f
);
11964 Fmodify_frame_parameters (frame
,
11965 Fcons (Fcons (Qtool_bar_lines
,
11966 make_number (nlines
)),
11968 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11970 clear_glyph_matrix (w
->desired_matrix
);
11971 fonts_changed_p
= 1;
11977 /* Display as many lines as needed to display all tool-bar items. */
11979 if (f
->n_tool_bar_rows
> 0)
11981 int border
, rows
, height
, extra
;
11983 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
11984 border
= XINT (Vtool_bar_border
);
11985 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11986 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11987 else if (EQ (Vtool_bar_border
, Qborder_width
))
11988 border
= f
->border_width
;
11994 rows
= f
->n_tool_bar_rows
;
11995 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11996 extra
= it
.last_visible_y
- border
- height
* rows
;
11998 while (it
.current_y
< it
.last_visible_y
)
12001 if (extra
> 0 && rows
-- > 0)
12003 h
= (extra
+ rows
- 1) / rows
;
12006 display_tool_bar_line (&it
, height
+ h
);
12011 while (it
.current_y
< it
.last_visible_y
)
12012 display_tool_bar_line (&it
, 0);
12015 /* It doesn't make much sense to try scrolling in the tool-bar
12016 window, so don't do it. */
12017 w
->desired_matrix
->no_scrolling_p
= 1;
12018 w
->must_be_updated_p
= 1;
12020 if (!NILP (Vauto_resize_tool_bars
))
12022 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
12023 int change_height_p
= 0;
12025 /* If we couldn't display everything, change the tool-bar's
12026 height if there is room for more. */
12027 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
12028 && it
.current_y
< max_tool_bar_height
)
12029 change_height_p
= 1;
12031 row
= it
.glyph_row
- 1;
12033 /* If there are blank lines at the end, except for a partially
12034 visible blank line at the end that is smaller than
12035 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12036 if (!row
->displays_text_p
12037 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12038 change_height_p
= 1;
12040 /* If row displays tool-bar items, but is partially visible,
12041 change the tool-bar's height. */
12042 if (row
->displays_text_p
12043 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
12044 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
12045 change_height_p
= 1;
12047 /* Resize windows as needed by changing the `tool-bar-lines'
12048 frame parameter. */
12049 if (change_height_p
)
12052 int old_height
= WINDOW_TOTAL_LINES (w
);
12054 int nlines
= tool_bar_lines_needed (f
, &nrows
);
12056 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12057 && !f
->minimize_tool_bar_window_p
)
12058 ? (nlines
> old_height
)
12059 : (nlines
!= old_height
));
12060 f
->minimize_tool_bar_window_p
= 0;
12062 if (change_height_p
)
12064 XSETFRAME (frame
, f
);
12065 Fmodify_frame_parameters (frame
,
12066 Fcons (Fcons (Qtool_bar_lines
,
12067 make_number (nlines
)),
12069 if (WINDOW_TOTAL_LINES (w
) != old_height
)
12071 clear_glyph_matrix (w
->desired_matrix
);
12072 f
->n_tool_bar_rows
= nrows
;
12073 fonts_changed_p
= 1;
12080 f
->minimize_tool_bar_window_p
= 0;
12085 /* Get information about the tool-bar item which is displayed in GLYPH
12086 on frame F. Return in *PROP_IDX the index where tool-bar item
12087 properties start in F->tool_bar_items. Value is zero if
12088 GLYPH doesn't display a tool-bar item. */
12091 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12097 /* This function can be called asynchronously, which means we must
12098 exclude any possibility that Fget_text_property signals an
12100 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12101 charpos
= max (0, charpos
);
12103 /* Get the text property `menu-item' at pos. The value of that
12104 property is the start index of this item's properties in
12105 F->tool_bar_items. */
12106 prop
= Fget_text_property (make_number (charpos
),
12107 Qmenu_item
, f
->current_tool_bar_string
);
12108 if (INTEGERP (prop
))
12110 *prop_idx
= XINT (prop
);
12120 /* Get information about the tool-bar item at position X/Y on frame F.
12121 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12122 the current matrix of the tool-bar window of F, or NULL if not
12123 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12124 item in F->tool_bar_items. Value is
12126 -1 if X/Y is not on a tool-bar item
12127 0 if X/Y is on the same item that was highlighted before.
12131 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12132 int *hpos
, int *vpos
, int *prop_idx
)
12134 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12135 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12138 /* Find the glyph under X/Y. */
12139 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12140 if (*glyph
== NULL
)
12143 /* Get the start of this tool-bar item's properties in
12144 f->tool_bar_items. */
12145 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12148 /* Is mouse on the highlighted item? */
12149 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12150 && *vpos
>= hlinfo
->mouse_face_beg_row
12151 && *vpos
<= hlinfo
->mouse_face_end_row
12152 && (*vpos
> hlinfo
->mouse_face_beg_row
12153 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12154 && (*vpos
< hlinfo
->mouse_face_end_row
12155 || *hpos
< hlinfo
->mouse_face_end_col
12156 || hlinfo
->mouse_face_past_end
))
12164 Handle mouse button event on the tool-bar of frame F, at
12165 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12166 0 for button release. MODIFIERS is event modifiers for button
12170 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12173 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12174 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12175 int hpos
, vpos
, prop_idx
;
12176 struct glyph
*glyph
;
12177 Lisp_Object enabled_p
;
12179 /* If not on the highlighted tool-bar item, return. */
12180 frame_to_window_pixel_xy (w
, &x
, &y
);
12181 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
12184 /* If item is disabled, do nothing. */
12185 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12186 if (NILP (enabled_p
))
12191 /* Show item in pressed state. */
12192 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12193 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
12194 last_tool_bar_item
= prop_idx
;
12198 Lisp_Object key
, frame
;
12199 struct input_event event
;
12200 EVENT_INIT (event
);
12202 /* Show item in released state. */
12203 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12204 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
12206 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12208 XSETFRAME (frame
, f
);
12209 event
.kind
= TOOL_BAR_EVENT
;
12210 event
.frame_or_window
= frame
;
12212 kbd_buffer_store_event (&event
);
12214 event
.kind
= TOOL_BAR_EVENT
;
12215 event
.frame_or_window
= frame
;
12217 event
.modifiers
= modifiers
;
12218 kbd_buffer_store_event (&event
);
12219 last_tool_bar_item
= -1;
12224 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12225 tool-bar window-relative coordinates X/Y. Called from
12226 note_mouse_highlight. */
12229 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12231 Lisp_Object window
= f
->tool_bar_window
;
12232 struct window
*w
= XWINDOW (window
);
12233 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
12234 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12236 struct glyph
*glyph
;
12237 struct glyph_row
*row
;
12239 Lisp_Object enabled_p
;
12241 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12242 int mouse_down_p
, rc
;
12244 /* Function note_mouse_highlight is called with negative X/Y
12245 values when mouse moves outside of the frame. */
12246 if (x
<= 0 || y
<= 0)
12248 clear_mouse_face (hlinfo
);
12252 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12255 /* Not on tool-bar item. */
12256 clear_mouse_face (hlinfo
);
12260 /* On same tool-bar item as before. */
12261 goto set_help_echo
;
12263 clear_mouse_face (hlinfo
);
12265 /* Mouse is down, but on different tool-bar item? */
12266 mouse_down_p
= (dpyinfo
->grabbed
12267 && f
== last_mouse_frame
12268 && FRAME_LIVE_P (f
));
12270 && last_tool_bar_item
!= prop_idx
)
12273 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
12274 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12276 /* If tool-bar item is not enabled, don't highlight it. */
12277 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12278 if (!NILP (enabled_p
))
12280 /* Compute the x-position of the glyph. In front and past the
12281 image is a space. We include this in the highlighted area. */
12282 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12283 for (i
= x
= 0; i
< hpos
; ++i
)
12284 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12286 /* Record this as the current active region. */
12287 hlinfo
->mouse_face_beg_col
= hpos
;
12288 hlinfo
->mouse_face_beg_row
= vpos
;
12289 hlinfo
->mouse_face_beg_x
= x
;
12290 hlinfo
->mouse_face_beg_y
= row
->y
;
12291 hlinfo
->mouse_face_past_end
= 0;
12293 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12294 hlinfo
->mouse_face_end_row
= vpos
;
12295 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12296 hlinfo
->mouse_face_end_y
= row
->y
;
12297 hlinfo
->mouse_face_window
= window
;
12298 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12300 /* Display it as active. */
12301 show_mouse_face (hlinfo
, draw
);
12302 hlinfo
->mouse_face_image_state
= draw
;
12307 /* Set help_echo_string to a help string to display for this tool-bar item.
12308 XTread_socket does the rest. */
12309 help_echo_object
= help_echo_window
= Qnil
;
12310 help_echo_pos
= -1;
12311 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12312 if (NILP (help_echo_string
))
12313 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12316 #endif /* HAVE_WINDOW_SYSTEM */
12320 /************************************************************************
12321 Horizontal scrolling
12322 ************************************************************************/
12324 static int hscroll_window_tree (Lisp_Object
);
12325 static int hscroll_windows (Lisp_Object
);
12327 /* For all leaf windows in the window tree rooted at WINDOW, set their
12328 hscroll value so that PT is (i) visible in the window, and (ii) so
12329 that it is not within a certain margin at the window's left and
12330 right border. Value is non-zero if any window's hscroll has been
12334 hscroll_window_tree (Lisp_Object window
)
12336 int hscrolled_p
= 0;
12337 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12338 int hscroll_step_abs
= 0;
12339 double hscroll_step_rel
= 0;
12341 if (hscroll_relative_p
)
12343 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12344 if (hscroll_step_rel
< 0)
12346 hscroll_relative_p
= 0;
12347 hscroll_step_abs
= 0;
12350 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12352 hscroll_step_abs
= XINT (Vhscroll_step
);
12353 if (hscroll_step_abs
< 0)
12354 hscroll_step_abs
= 0;
12357 hscroll_step_abs
= 0;
12359 while (WINDOWP (window
))
12361 struct window
*w
= XWINDOW (window
);
12363 if (WINDOWP (w
->hchild
))
12364 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
12365 else if (WINDOWP (w
->vchild
))
12366 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
12367 else if (w
->cursor
.vpos
>= 0)
12370 int text_area_width
;
12371 struct glyph_row
*current_cursor_row
12372 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12373 struct glyph_row
*desired_cursor_row
12374 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12375 struct glyph_row
*cursor_row
12376 = (desired_cursor_row
->enabled_p
12377 ? desired_cursor_row
12378 : current_cursor_row
);
12379 int row_r2l_p
= cursor_row
->reversed_p
;
12381 text_area_width
= window_box_width (w
, TEXT_AREA
);
12383 /* Scroll when cursor is inside this scroll margin. */
12384 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12386 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
12387 /* For left-to-right rows, hscroll when cursor is either
12388 (i) inside the right hscroll margin, or (ii) if it is
12389 inside the left margin and the window is already
12393 && w
->cursor
.x
<= h_margin
)
12394 || (cursor_row
->enabled_p
12395 && cursor_row
->truncated_on_right_p
12396 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12397 /* For right-to-left rows, the logic is similar,
12398 except that rules for scrolling to left and right
12399 are reversed. E.g., if cursor.x <= h_margin, we
12400 need to hscroll "to the right" unconditionally,
12401 and that will scroll the screen to the left so as
12402 to reveal the next portion of the row. */
12404 && ((cursor_row
->enabled_p
12405 /* FIXME: It is confusing to set the
12406 truncated_on_right_p flag when R2L rows
12407 are actually truncated on the left. */
12408 && cursor_row
->truncated_on_right_p
12409 && w
->cursor
.x
<= h_margin
)
12411 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12415 struct buffer
*saved_current_buffer
;
12419 /* Find point in a display of infinite width. */
12420 saved_current_buffer
= current_buffer
;
12421 current_buffer
= XBUFFER (w
->buffer
);
12423 if (w
== XWINDOW (selected_window
))
12427 pt
= marker_position (w
->pointm
);
12428 pt
= max (BEGV
, pt
);
12432 /* Move iterator to pt starting at cursor_row->start in
12433 a line with infinite width. */
12434 init_to_row_start (&it
, w
, cursor_row
);
12435 it
.last_visible_x
= INFINITY
;
12436 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12437 current_buffer
= saved_current_buffer
;
12439 /* Position cursor in window. */
12440 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12441 hscroll
= max (0, (it
.current_x
12442 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12443 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12444 : (text_area_width
/ 2))))
12445 / FRAME_COLUMN_WIDTH (it
.f
);
12446 else if ((!row_r2l_p
12447 && w
->cursor
.x
>= text_area_width
- h_margin
)
12448 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12450 if (hscroll_relative_p
)
12451 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12454 wanted_x
= text_area_width
12455 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12458 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12462 if (hscroll_relative_p
)
12463 wanted_x
= text_area_width
* hscroll_step_rel
12466 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12469 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12471 hscroll
= max (hscroll
, w
->min_hscroll
);
12473 /* Don't prevent redisplay optimizations if hscroll
12474 hasn't changed, as it will unnecessarily slow down
12476 if (w
->hscroll
!= hscroll
)
12478 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
12479 w
->hscroll
= hscroll
;
12488 /* Value is non-zero if hscroll of any leaf window has been changed. */
12489 return hscrolled_p
;
12493 /* Set hscroll so that cursor is visible and not inside horizontal
12494 scroll margins for all windows in the tree rooted at WINDOW. See
12495 also hscroll_window_tree above. Value is non-zero if any window's
12496 hscroll has been changed. If it has, desired matrices on the frame
12497 of WINDOW are cleared. */
12500 hscroll_windows (Lisp_Object window
)
12502 int hscrolled_p
= hscroll_window_tree (window
);
12504 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12505 return hscrolled_p
;
12510 /************************************************************************
12512 ************************************************************************/
12514 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12515 to a non-zero value. This is sometimes handy to have in a debugger
12520 /* First and last unchanged row for try_window_id. */
12522 static int debug_first_unchanged_at_end_vpos
;
12523 static int debug_last_unchanged_at_beg_vpos
;
12525 /* Delta vpos and y. */
12527 static int debug_dvpos
, debug_dy
;
12529 /* Delta in characters and bytes for try_window_id. */
12531 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12533 /* Values of window_end_pos and window_end_vpos at the end of
12536 static ptrdiff_t debug_end_vpos
;
12538 /* Append a string to W->desired_matrix->method. FMT is a printf
12539 format string. If trace_redisplay_p is non-zero also printf the
12540 resulting string to stderr. */
12542 static void debug_method_add (struct window
*, char const *, ...)
12543 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12546 debug_method_add (struct window
*w
, char const *fmt
, ...)
12548 char *method
= w
->desired_matrix
->method
;
12549 int len
= strlen (method
);
12550 int size
= sizeof w
->desired_matrix
->method
;
12551 int remaining
= size
- len
- 1;
12554 if (len
&& remaining
)
12557 --remaining
, ++len
;
12560 va_start (ap
, fmt
);
12561 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
12564 if (trace_redisplay_p
)
12565 fprintf (stderr
, "%p (%s): %s\n",
12567 ((BUFFERP (w
->buffer
)
12568 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12569 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12574 #endif /* GLYPH_DEBUG */
12577 /* Value is non-zero if all changes in window W, which displays
12578 current_buffer, are in the text between START and END. START is a
12579 buffer position, END is given as a distance from Z. Used in
12580 redisplay_internal for display optimization. */
12583 text_outside_line_unchanged_p (struct window
*w
,
12584 ptrdiff_t start
, ptrdiff_t end
)
12586 int unchanged_p
= 1;
12588 /* If text or overlays have changed, see where. */
12589 if (w
->last_modified
< MODIFF
12590 || w
->last_overlay_modified
< OVERLAY_MODIFF
)
12592 /* Gap in the line? */
12593 if (GPT
< start
|| Z
- GPT
< end
)
12596 /* Changes start in front of the line, or end after it? */
12598 && (BEG_UNCHANGED
< start
- 1
12599 || END_UNCHANGED
< end
))
12602 /* If selective display, can't optimize if changes start at the
12603 beginning of the line. */
12605 && INTEGERP (BVAR (current_buffer
, selective_display
))
12606 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12607 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12610 /* If there are overlays at the start or end of the line, these
12611 may have overlay strings with newlines in them. A change at
12612 START, for instance, may actually concern the display of such
12613 overlay strings as well, and they are displayed on different
12614 lines. So, quickly rule out this case. (For the future, it
12615 might be desirable to implement something more telling than
12616 just BEG/END_UNCHANGED.) */
12619 if (BEG
+ BEG_UNCHANGED
== start
12620 && overlay_touches_p (start
))
12622 if (END_UNCHANGED
== end
12623 && overlay_touches_p (Z
- end
))
12627 /* Under bidi reordering, adding or deleting a character in the
12628 beginning of a paragraph, before the first strong directional
12629 character, can change the base direction of the paragraph (unless
12630 the buffer specifies a fixed paragraph direction), which will
12631 require to redisplay the whole paragraph. It might be worthwhile
12632 to find the paragraph limits and widen the range of redisplayed
12633 lines to that, but for now just give up this optimization. */
12634 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12635 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12639 return unchanged_p
;
12643 /* Do a frame update, taking possible shortcuts into account. This is
12644 the main external entry point for redisplay.
12646 If the last redisplay displayed an echo area message and that message
12647 is no longer requested, we clear the echo area or bring back the
12648 mini-buffer if that is in use. */
12653 redisplay_internal ();
12658 overlay_arrow_string_or_property (Lisp_Object var
)
12662 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12665 return Voverlay_arrow_string
;
12668 /* Return 1 if there are any overlay-arrows in current_buffer. */
12670 overlay_arrow_in_current_buffer_p (void)
12674 for (vlist
= Voverlay_arrow_variable_list
;
12676 vlist
= XCDR (vlist
))
12678 Lisp_Object var
= XCAR (vlist
);
12681 if (!SYMBOLP (var
))
12683 val
= find_symbol_value (var
);
12685 && current_buffer
== XMARKER (val
)->buffer
)
12692 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12696 overlay_arrows_changed_p (void)
12700 for (vlist
= Voverlay_arrow_variable_list
;
12702 vlist
= XCDR (vlist
))
12704 Lisp_Object var
= XCAR (vlist
);
12705 Lisp_Object val
, pstr
;
12707 if (!SYMBOLP (var
))
12709 val
= find_symbol_value (var
);
12710 if (!MARKERP (val
))
12712 if (! EQ (COERCE_MARKER (val
),
12713 Fget (var
, Qlast_arrow_position
))
12714 || ! (pstr
= overlay_arrow_string_or_property (var
),
12715 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12721 /* Mark overlay arrows to be updated on next redisplay. */
12724 update_overlay_arrows (int up_to_date
)
12728 for (vlist
= Voverlay_arrow_variable_list
;
12730 vlist
= XCDR (vlist
))
12732 Lisp_Object var
= XCAR (vlist
);
12734 if (!SYMBOLP (var
))
12737 if (up_to_date
> 0)
12739 Lisp_Object val
= find_symbol_value (var
);
12740 Fput (var
, Qlast_arrow_position
,
12741 COERCE_MARKER (val
));
12742 Fput (var
, Qlast_arrow_string
,
12743 overlay_arrow_string_or_property (var
));
12745 else if (up_to_date
< 0
12746 || !NILP (Fget (var
, Qlast_arrow_position
)))
12748 Fput (var
, Qlast_arrow_position
, Qt
);
12749 Fput (var
, Qlast_arrow_string
, Qt
);
12755 /* Return overlay arrow string to display at row.
12756 Return integer (bitmap number) for arrow bitmap in left fringe.
12757 Return nil if no overlay arrow. */
12760 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12764 for (vlist
= Voverlay_arrow_variable_list
;
12766 vlist
= XCDR (vlist
))
12768 Lisp_Object var
= XCAR (vlist
);
12771 if (!SYMBOLP (var
))
12774 val
= find_symbol_value (var
);
12777 && current_buffer
== XMARKER (val
)->buffer
12778 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12780 if (FRAME_WINDOW_P (it
->f
)
12781 /* FIXME: if ROW->reversed_p is set, this should test
12782 the right fringe, not the left one. */
12783 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12785 #ifdef HAVE_WINDOW_SYSTEM
12786 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12789 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12790 return make_number (fringe_bitmap
);
12793 return make_number (-1); /* Use default arrow bitmap. */
12795 return overlay_arrow_string_or_property (var
);
12802 /* Return 1 if point moved out of or into a composition. Otherwise
12803 return 0. PREV_BUF and PREV_PT are the last point buffer and
12804 position. BUF and PT are the current point buffer and position. */
12807 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
12808 struct buffer
*buf
, ptrdiff_t pt
)
12810 ptrdiff_t start
, end
;
12812 Lisp_Object buffer
;
12814 XSETBUFFER (buffer
, buf
);
12815 /* Check a composition at the last point if point moved within the
12817 if (prev_buf
== buf
)
12820 /* Point didn't move. */
12823 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12824 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12825 && COMPOSITION_VALID_P (start
, end
, prop
)
12826 && start
< prev_pt
&& end
> prev_pt
)
12827 /* The last point was within the composition. Return 1 iff
12828 point moved out of the composition. */
12829 return (pt
<= start
|| pt
>= end
);
12832 /* Check a composition at the current point. */
12833 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12834 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12835 && COMPOSITION_VALID_P (start
, end
, prop
)
12836 && start
< pt
&& end
> pt
);
12840 /* Reconsider the setting of B->clip_changed which is displayed
12844 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12846 if (b
->clip_changed
12847 && !NILP (w
->window_end_valid
)
12848 && w
->current_matrix
->buffer
== b
12849 && w
->current_matrix
->zv
== BUF_ZV (b
)
12850 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12851 b
->clip_changed
= 0;
12853 /* If display wasn't paused, and W is not a tool bar window, see if
12854 point has been moved into or out of a composition. In that case,
12855 we set b->clip_changed to 1 to force updating the screen. If
12856 b->clip_changed has already been set to 1, we can skip this
12858 if (!b
->clip_changed
12859 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12863 if (w
== XWINDOW (selected_window
))
12866 pt
= marker_position (w
->pointm
);
12868 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12869 || pt
!= w
->last_point
)
12870 && check_point_in_composition (w
->current_matrix
->buffer
,
12872 XBUFFER (w
->buffer
), pt
))
12873 b
->clip_changed
= 1;
12878 /* Select FRAME to forward the values of frame-local variables into C
12879 variables so that the redisplay routines can access those values
12883 select_frame_for_redisplay (Lisp_Object frame
)
12885 Lisp_Object tail
, tem
;
12886 Lisp_Object old
= selected_frame
;
12887 struct Lisp_Symbol
*sym
;
12889 eassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12891 selected_frame
= frame
;
12894 for (tail
= XFRAME (frame
)->param_alist
;
12895 CONSP (tail
); tail
= XCDR (tail
))
12896 if (CONSP (XCAR (tail
))
12897 && (tem
= XCAR (XCAR (tail
)),
12899 && (sym
= indirect_variable (XSYMBOL (tem
)),
12900 sym
->redirect
== SYMBOL_LOCALIZED
)
12901 && sym
->val
.blv
->frame_local
)
12902 /* Use find_symbol_value rather than Fsymbol_value
12903 to avoid an error if it is void. */
12904 find_symbol_value (tem
);
12905 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12909 #define STOP_POLLING \
12910 do { if (! polling_stopped_here) stop_polling (); \
12911 polling_stopped_here = 1; } while (0)
12913 #define RESUME_POLLING \
12914 do { if (polling_stopped_here) start_polling (); \
12915 polling_stopped_here = 0; } while (0)
12918 /* Perhaps in the future avoid recentering windows if it
12919 is not necessary; currently that causes some problems. */
12922 redisplay_internal (void)
12924 struct window
*w
= XWINDOW (selected_window
);
12928 int must_finish
= 0;
12929 struct text_pos tlbufpos
, tlendpos
;
12930 int number_of_visible_frames
;
12931 ptrdiff_t count
, count1
;
12933 int polling_stopped_here
= 0;
12934 Lisp_Object old_frame
= selected_frame
;
12935 struct backtrace backtrace
;
12937 /* Non-zero means redisplay has to consider all windows on all
12938 frames. Zero means, only selected_window is considered. */
12939 int consider_all_windows_p
;
12941 /* Non-zero means redisplay has to redisplay the miniwindow. */
12942 int update_miniwindow_p
= 0;
12944 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12946 /* No redisplay if running in batch mode or frame is not yet fully
12947 initialized, or redisplay is explicitly turned off by setting
12948 Vinhibit_redisplay. */
12949 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12950 || !NILP (Vinhibit_redisplay
))
12953 /* Don't examine these until after testing Vinhibit_redisplay.
12954 When Emacs is shutting down, perhaps because its connection to
12955 X has dropped, we should not look at them at all. */
12956 fr
= XFRAME (w
->frame
);
12957 sf
= SELECTED_FRAME ();
12959 if (!fr
->glyphs_initialized_p
)
12962 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12963 if (popup_activated ())
12967 /* I don't think this happens but let's be paranoid. */
12968 if (redisplaying_p
)
12971 /* Record a function that clears redisplaying_p
12972 when we leave this function. */
12973 count
= SPECPDL_INDEX ();
12974 record_unwind_protect (unwind_redisplay
, selected_frame
);
12975 redisplaying_p
= 1;
12976 specbind (Qinhibit_free_realized_faces
, Qnil
);
12978 /* Record this function, so it appears on the profiler's backtraces. */
12979 backtrace
.next
= backtrace_list
;
12980 backtrace
.function
= Qredisplay_internal
;
12981 backtrace
.args
= &Qnil
;
12982 backtrace
.nargs
= 0;
12983 backtrace
.debug_on_exit
= 0;
12984 backtrace_list
= &backtrace
;
12987 Lisp_Object tail
, frame
;
12989 FOR_EACH_FRAME (tail
, frame
)
12991 struct frame
*f
= XFRAME (frame
);
12992 f
->already_hscrolled_p
= 0;
12997 /* Remember the currently selected window. */
13000 if (!EQ (old_frame
, selected_frame
)
13001 && FRAME_LIVE_P (XFRAME (old_frame
)))
13002 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
13003 selected_frame and selected_window to be temporarily out-of-sync so
13004 when we come back here via `goto retry', we need to resync because we
13005 may need to run Elisp code (via prepare_menu_bars). */
13006 select_frame_for_redisplay (old_frame
);
13009 reconsider_clip_changes (w
, current_buffer
);
13010 last_escape_glyph_frame
= NULL
;
13011 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13012 last_glyphless_glyph_frame
= NULL
;
13013 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13015 /* If new fonts have been loaded that make a glyph matrix adjustment
13016 necessary, do it. */
13017 if (fonts_changed_p
)
13019 adjust_glyphs (NULL
);
13020 ++windows_or_buffers_changed
;
13021 fonts_changed_p
= 0;
13024 /* If face_change_count is non-zero, init_iterator will free all
13025 realized faces, which includes the faces referenced from current
13026 matrices. So, we can't reuse current matrices in this case. */
13027 if (face_change_count
)
13028 ++windows_or_buffers_changed
;
13030 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13031 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13033 /* Since frames on a single ASCII terminal share the same
13034 display area, displaying a different frame means redisplay
13035 the whole thing. */
13036 windows_or_buffers_changed
++;
13037 SET_FRAME_GARBAGED (sf
);
13039 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13041 FRAME_TTY (sf
)->previous_frame
= sf
;
13044 /* Set the visible flags for all frames. Do this before checking
13045 for resized or garbaged frames; they want to know if their frames
13046 are visible. See the comment in frame.h for
13047 FRAME_SAMPLE_VISIBILITY. */
13049 Lisp_Object tail
, frame
;
13051 number_of_visible_frames
= 0;
13053 FOR_EACH_FRAME (tail
, frame
)
13055 struct frame
*f
= XFRAME (frame
);
13057 FRAME_SAMPLE_VISIBILITY (f
);
13058 if (FRAME_VISIBLE_P (f
))
13059 ++number_of_visible_frames
;
13060 clear_desired_matrices (f
);
13064 /* Notice any pending interrupt request to change frame size. */
13065 do_pending_window_change (1);
13067 /* do_pending_window_change could change the selected_window due to
13068 frame resizing which makes the selected window too small. */
13069 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13072 reconsider_clip_changes (w
, current_buffer
);
13075 /* Clear frames marked as garbaged. */
13076 if (frame_garbaged
)
13077 clear_garbaged_frames ();
13079 /* Build menubar and tool-bar items. */
13080 if (NILP (Vmemory_full
))
13081 prepare_menu_bars ();
13083 if (windows_or_buffers_changed
)
13084 update_mode_lines
++;
13086 /* Detect case that we need to write or remove a star in the mode line. */
13087 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13089 w
->update_mode_line
= 1;
13090 if (buffer_shared
> 1)
13091 update_mode_lines
++;
13094 /* Avoid invocation of point motion hooks by `current_column' below. */
13095 count1
= SPECPDL_INDEX ();
13096 specbind (Qinhibit_point_motion_hooks
, Qt
);
13098 /* If %c is in the mode line, update it if needed. */
13099 if (!NILP (w
->column_number_displayed
)
13100 /* This alternative quickly identifies a common case
13101 where no change is needed. */
13102 && !(PT
== w
->last_point
13103 && w
->last_modified
>= MODIFF
13104 && w
->last_overlay_modified
>= OVERLAY_MODIFF
)
13105 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
13106 w
->update_mode_line
= 1;
13108 unbind_to (count1
, Qnil
);
13110 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
13112 /* The variable buffer_shared is set in redisplay_window and
13113 indicates that we redisplay a buffer in different windows. See
13115 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
13116 || cursor_type_changed
);
13118 /* If specs for an arrow have changed, do thorough redisplay
13119 to ensure we remove any arrow that should no longer exist. */
13120 if (overlay_arrows_changed_p ())
13121 consider_all_windows_p
= windows_or_buffers_changed
= 1;
13123 /* Normally the message* functions will have already displayed and
13124 updated the echo area, but the frame may have been trashed, or
13125 the update may have been preempted, so display the echo area
13126 again here. Checking message_cleared_p captures the case that
13127 the echo area should be cleared. */
13128 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13129 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13130 || (message_cleared_p
13131 && minibuf_level
== 0
13132 /* If the mini-window is currently selected, this means the
13133 echo-area doesn't show through. */
13134 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13136 int window_height_changed_p
= echo_area_display (0);
13138 if (message_cleared_p
)
13139 update_miniwindow_p
= 1;
13143 /* If we don't display the current message, don't clear the
13144 message_cleared_p flag, because, if we did, we wouldn't clear
13145 the echo area in the next redisplay which doesn't preserve
13147 if (!display_last_displayed_message_p
)
13148 message_cleared_p
= 0;
13150 if (fonts_changed_p
)
13152 else if (window_height_changed_p
)
13154 consider_all_windows_p
= 1;
13155 ++update_mode_lines
;
13156 ++windows_or_buffers_changed
;
13158 /* If window configuration was changed, frames may have been
13159 marked garbaged. Clear them or we will experience
13160 surprises wrt scrolling. */
13161 if (frame_garbaged
)
13162 clear_garbaged_frames ();
13165 else if (EQ (selected_window
, minibuf_window
)
13166 && (current_buffer
->clip_changed
13167 || w
->last_modified
< MODIFF
13168 || w
->last_overlay_modified
< OVERLAY_MODIFF
)
13169 && resize_mini_window (w
, 0))
13171 /* Resized active mini-window to fit the size of what it is
13172 showing if its contents might have changed. */
13174 /* FIXME: this causes all frames to be updated, which seems unnecessary
13175 since only the current frame needs to be considered. This function needs
13176 to be rewritten with two variables, consider_all_windows and
13177 consider_all_frames. */
13178 consider_all_windows_p
= 1;
13179 ++windows_or_buffers_changed
;
13180 ++update_mode_lines
;
13182 /* If window configuration was changed, frames may have been
13183 marked garbaged. Clear them or we will experience
13184 surprises wrt scrolling. */
13185 if (frame_garbaged
)
13186 clear_garbaged_frames ();
13190 /* If showing the region, and mark has changed, we must redisplay
13191 the whole window. The assignment to this_line_start_pos prevents
13192 the optimization directly below this if-statement. */
13193 if (((!NILP (Vtransient_mark_mode
)
13194 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
13195 != !NILP (w
->region_showing
))
13196 || (!NILP (w
->region_showing
)
13197 && !EQ (w
->region_showing
,
13198 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
13199 CHARPOS (this_line_start_pos
) = 0;
13201 /* Optimize the case that only the line containing the cursor in the
13202 selected window has changed. Variables starting with this_ are
13203 set in display_line and record information about the line
13204 containing the cursor. */
13205 tlbufpos
= this_line_start_pos
;
13206 tlendpos
= this_line_end_pos
;
13207 if (!consider_all_windows_p
13208 && CHARPOS (tlbufpos
) > 0
13209 && !w
->update_mode_line
13210 && !current_buffer
->clip_changed
13211 && !current_buffer
->prevent_redisplay_optimizations_p
13212 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13213 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13214 /* Make sure recorded data applies to current buffer, etc. */
13215 && this_line_buffer
== current_buffer
13216 && current_buffer
== XBUFFER (w
->buffer
)
13218 && !w
->optional_new_start
13219 /* Point must be on the line that we have info recorded about. */
13220 && PT
>= CHARPOS (tlbufpos
)
13221 && PT
<= Z
- CHARPOS (tlendpos
)
13222 /* All text outside that line, including its final newline,
13223 must be unchanged. */
13224 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13225 CHARPOS (tlendpos
)))
13227 if (CHARPOS (tlbufpos
) > BEGV
13228 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13229 && (CHARPOS (tlbufpos
) == ZV
13230 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13231 /* Former continuation line has disappeared by becoming empty. */
13233 else if (w
->last_modified
< MODIFF
13234 || w
->last_overlay_modified
< OVERLAY_MODIFF
13235 || MINI_WINDOW_P (w
))
13237 /* We have to handle the case of continuation around a
13238 wide-column character (see the comment in indent.c around
13241 For instance, in the following case:
13243 -------- Insert --------
13244 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13245 J_I_ ==> J_I_ `^^' are cursors.
13249 As we have to redraw the line above, we cannot use this
13253 int line_height_before
= this_line_pixel_height
;
13255 /* Note that start_display will handle the case that the
13256 line starting at tlbufpos is a continuation line. */
13257 start_display (&it
, w
, tlbufpos
);
13259 /* Implementation note: It this still necessary? */
13260 if (it
.current_x
!= this_line_start_x
)
13263 TRACE ((stderr
, "trying display optimization 1\n"));
13264 w
->cursor
.vpos
= -1;
13265 overlay_arrow_seen
= 0;
13266 it
.vpos
= this_line_vpos
;
13267 it
.current_y
= this_line_y
;
13268 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13269 display_line (&it
);
13271 /* If line contains point, is not continued,
13272 and ends at same distance from eob as before, we win. */
13273 if (w
->cursor
.vpos
>= 0
13274 /* Line is not continued, otherwise this_line_start_pos
13275 would have been set to 0 in display_line. */
13276 && CHARPOS (this_line_start_pos
)
13277 /* Line ends as before. */
13278 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13279 /* Line has same height as before. Otherwise other lines
13280 would have to be shifted up or down. */
13281 && this_line_pixel_height
== line_height_before
)
13283 /* If this is not the window's last line, we must adjust
13284 the charstarts of the lines below. */
13285 if (it
.current_y
< it
.last_visible_y
)
13287 struct glyph_row
*row
13288 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13289 ptrdiff_t delta
, delta_bytes
;
13291 /* We used to distinguish between two cases here,
13292 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13293 when the line ends in a newline or the end of the
13294 buffer's accessible portion. But both cases did
13295 the same, so they were collapsed. */
13297 - CHARPOS (tlendpos
)
13298 - MATRIX_ROW_START_CHARPOS (row
));
13299 delta_bytes
= (Z_BYTE
13300 - BYTEPOS (tlendpos
)
13301 - MATRIX_ROW_START_BYTEPOS (row
));
13303 increment_matrix_positions (w
->current_matrix
,
13304 this_line_vpos
+ 1,
13305 w
->current_matrix
->nrows
,
13306 delta
, delta_bytes
);
13309 /* If this row displays text now but previously didn't,
13310 or vice versa, w->window_end_vpos may have to be
13312 if ((it
.glyph_row
- 1)->displays_text_p
)
13314 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
13315 wset_window_end_vpos (w
, make_number (this_line_vpos
));
13317 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
13318 && this_line_vpos
> 0)
13319 wset_window_end_vpos (w
, make_number (this_line_vpos
- 1));
13320 wset_window_end_valid (w
, Qnil
);
13322 /* Update hint: No need to try to scroll in update_window. */
13323 w
->desired_matrix
->no_scrolling_p
= 1;
13326 *w
->desired_matrix
->method
= 0;
13327 debug_method_add (w
, "optimization 1");
13329 #ifdef HAVE_WINDOW_SYSTEM
13330 update_window_fringes (w
, 0);
13337 else if (/* Cursor position hasn't changed. */
13338 PT
== w
->last_point
13339 /* Make sure the cursor was last displayed
13340 in this window. Otherwise we have to reposition it. */
13341 && 0 <= w
->cursor
.vpos
13342 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
13346 do_pending_window_change (1);
13347 /* If selected_window changed, redisplay again. */
13348 if (WINDOWP (selected_window
)
13349 && (w
= XWINDOW (selected_window
)) != sw
)
13352 /* We used to always goto end_of_redisplay here, but this
13353 isn't enough if we have a blinking cursor. */
13354 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13355 goto end_of_redisplay
;
13359 /* If highlighting the region, or if the cursor is in the echo area,
13360 then we can't just move the cursor. */
13361 else if (! (!NILP (Vtransient_mark_mode
)
13362 && !NILP (BVAR (current_buffer
, mark_active
)))
13363 && (EQ (selected_window
,
13364 BVAR (current_buffer
, last_selected_window
))
13365 || highlight_nonselected_windows
)
13366 && NILP (w
->region_showing
)
13367 && NILP (Vshow_trailing_whitespace
)
13368 && !cursor_in_echo_area
)
13371 struct glyph_row
*row
;
13373 /* Skip from tlbufpos to PT and see where it is. Note that
13374 PT may be in invisible text. If so, we will end at the
13375 next visible position. */
13376 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13377 NULL
, DEFAULT_FACE_ID
);
13378 it
.current_x
= this_line_start_x
;
13379 it
.current_y
= this_line_y
;
13380 it
.vpos
= this_line_vpos
;
13382 /* The call to move_it_to stops in front of PT, but
13383 moves over before-strings. */
13384 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13386 if (it
.vpos
== this_line_vpos
13387 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13390 eassert (this_line_vpos
== it
.vpos
);
13391 eassert (this_line_y
== it
.current_y
);
13392 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13394 *w
->desired_matrix
->method
= 0;
13395 debug_method_add (w
, "optimization 3");
13404 /* Text changed drastically or point moved off of line. */
13405 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13408 CHARPOS (this_line_start_pos
) = 0;
13409 consider_all_windows_p
|= buffer_shared
> 1;
13410 ++clear_face_cache_count
;
13411 #ifdef HAVE_WINDOW_SYSTEM
13412 ++clear_image_cache_count
;
13415 /* Build desired matrices, and update the display. If
13416 consider_all_windows_p is non-zero, do it for all windows on all
13417 frames. Otherwise do it for selected_window, only. */
13419 if (consider_all_windows_p
)
13421 Lisp_Object tail
, frame
;
13423 FOR_EACH_FRAME (tail
, frame
)
13424 XFRAME (frame
)->updated_p
= 0;
13426 /* Recompute # windows showing selected buffer. This will be
13427 incremented each time such a window is displayed. */
13430 FOR_EACH_FRAME (tail
, frame
)
13432 struct frame
*f
= XFRAME (frame
);
13434 /* We don't have to do anything for unselected terminal
13436 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13437 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13440 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13442 if (! EQ (frame
, selected_frame
))
13443 /* Select the frame, for the sake of frame-local
13445 select_frame_for_redisplay (frame
);
13447 /* Mark all the scroll bars to be removed; we'll redeem
13448 the ones we want when we redisplay their windows. */
13449 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13450 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13452 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13453 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13455 /* The X error handler may have deleted that frame. */
13456 if (!FRAME_LIVE_P (f
))
13459 /* Any scroll bars which redisplay_windows should have
13460 nuked should now go away. */
13461 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13462 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13464 /* If fonts changed, display again. */
13465 /* ??? rms: I suspect it is a mistake to jump all the way
13466 back to retry here. It should just retry this frame. */
13467 if (fonts_changed_p
)
13470 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13472 /* See if we have to hscroll. */
13473 if (!f
->already_hscrolled_p
)
13475 f
->already_hscrolled_p
= 1;
13476 if (hscroll_windows (f
->root_window
))
13480 /* Prevent various kinds of signals during display
13481 update. stdio is not robust about handling
13482 signals, which can cause an apparent I/O
13484 if (interrupt_input
)
13485 unrequest_sigio ();
13488 /* Update the display. */
13489 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13490 pending
|= update_frame (f
, 0, 0);
13496 if (!EQ (old_frame
, selected_frame
)
13497 && FRAME_LIVE_P (XFRAME (old_frame
)))
13498 /* We played a bit fast-and-loose above and allowed selected_frame
13499 and selected_window to be temporarily out-of-sync but let's make
13500 sure this stays contained. */
13501 select_frame_for_redisplay (old_frame
);
13502 eassert (EQ (XFRAME (selected_frame
)->selected_window
,
13507 /* Do the mark_window_display_accurate after all windows have
13508 been redisplayed because this call resets flags in buffers
13509 which are needed for proper redisplay. */
13510 FOR_EACH_FRAME (tail
, frame
)
13512 struct frame
*f
= XFRAME (frame
);
13515 mark_window_display_accurate (f
->root_window
, 1);
13516 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13517 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13522 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13524 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13525 struct frame
*mini_frame
;
13527 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13528 /* Use list_of_error, not Qerror, so that
13529 we catch only errors and don't run the debugger. */
13530 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13532 redisplay_window_error
);
13533 if (update_miniwindow_p
)
13534 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13536 redisplay_window_error
);
13538 /* Compare desired and current matrices, perform output. */
13541 /* If fonts changed, display again. */
13542 if (fonts_changed_p
)
13545 /* Prevent various kinds of signals during display update.
13546 stdio is not robust about handling signals,
13547 which can cause an apparent I/O error. */
13548 if (interrupt_input
)
13549 unrequest_sigio ();
13552 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13554 if (hscroll_windows (selected_window
))
13557 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13558 pending
= update_frame (sf
, 0, 0);
13561 /* We may have called echo_area_display at the top of this
13562 function. If the echo area is on another frame, that may
13563 have put text on a frame other than the selected one, so the
13564 above call to update_frame would not have caught it. Catch
13566 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13567 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13569 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13571 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13572 pending
|= update_frame (mini_frame
, 0, 0);
13573 if (!pending
&& hscroll_windows (mini_window
))
13578 /* If display was paused because of pending input, make sure we do a
13579 thorough update the next time. */
13582 /* Prevent the optimization at the beginning of
13583 redisplay_internal that tries a single-line update of the
13584 line containing the cursor in the selected window. */
13585 CHARPOS (this_line_start_pos
) = 0;
13587 /* Let the overlay arrow be updated the next time. */
13588 update_overlay_arrows (0);
13590 /* If we pause after scrolling, some rows in the current
13591 matrices of some windows are not valid. */
13592 if (!WINDOW_FULL_WIDTH_P (w
)
13593 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13594 update_mode_lines
= 1;
13598 if (!consider_all_windows_p
)
13600 /* This has already been done above if
13601 consider_all_windows_p is set. */
13602 mark_window_display_accurate_1 (w
, 1);
13604 /* Say overlay arrows are up to date. */
13605 update_overlay_arrows (1);
13607 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13608 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13611 update_mode_lines
= 0;
13612 windows_or_buffers_changed
= 0;
13613 cursor_type_changed
= 0;
13616 /* Start SIGIO interrupts coming again. Having them off during the
13617 code above makes it less likely one will discard output, but not
13618 impossible, since there might be stuff in the system buffer here.
13619 But it is much hairier to try to do anything about that. */
13620 if (interrupt_input
)
13624 /* If a frame has become visible which was not before, redisplay
13625 again, so that we display it. Expose events for such a frame
13626 (which it gets when becoming visible) don't call the parts of
13627 redisplay constructing glyphs, so simply exposing a frame won't
13628 display anything in this case. So, we have to display these
13629 frames here explicitly. */
13632 Lisp_Object tail
, frame
;
13635 FOR_EACH_FRAME (tail
, frame
)
13637 int this_is_visible
= 0;
13639 if (XFRAME (frame
)->visible
)
13640 this_is_visible
= 1;
13641 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13642 if (XFRAME (frame
)->visible
)
13643 this_is_visible
= 1;
13645 if (this_is_visible
)
13649 if (new_count
!= number_of_visible_frames
)
13650 windows_or_buffers_changed
++;
13653 /* Change frame size now if a change is pending. */
13654 do_pending_window_change (1);
13656 /* If we just did a pending size change, or have additional
13657 visible frames, or selected_window changed, redisplay again. */
13658 if ((windows_or_buffers_changed
&& !pending
)
13659 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13662 /* Clear the face and image caches.
13664 We used to do this only if consider_all_windows_p. But the cache
13665 needs to be cleared if a timer creates images in the current
13666 buffer (e.g. the test case in Bug#6230). */
13668 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13670 clear_face_cache (0);
13671 clear_face_cache_count
= 0;
13674 #ifdef HAVE_WINDOW_SYSTEM
13675 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13677 clear_image_caches (Qnil
);
13678 clear_image_cache_count
= 0;
13680 #endif /* HAVE_WINDOW_SYSTEM */
13683 backtrace_list
= backtrace
.next
;
13684 unbind_to (count
, Qnil
);
13689 /* Redisplay, but leave alone any recent echo area message unless
13690 another message has been requested in its place.
13692 This is useful in situations where you need to redisplay but no
13693 user action has occurred, making it inappropriate for the message
13694 area to be cleared. See tracking_off and
13695 wait_reading_process_output for examples of these situations.
13697 FROM_WHERE is an integer saying from where this function was
13698 called. This is useful for debugging. */
13701 redisplay_preserve_echo_area (int from_where
)
13703 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13705 if (!NILP (echo_area_buffer
[1]))
13707 /* We have a previously displayed message, but no current
13708 message. Redisplay the previous message. */
13709 display_last_displayed_message_p
= 1;
13710 redisplay_internal ();
13711 display_last_displayed_message_p
= 0;
13714 redisplay_internal ();
13716 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13717 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13718 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13722 /* Function registered with record_unwind_protect in redisplay_internal.
13723 Clear redisplaying_p. Also, select the previously
13724 selected frame, unless it has been deleted (by an X connection
13725 failure during redisplay, for example). */
13728 unwind_redisplay (Lisp_Object old_frame
)
13730 redisplaying_p
= 0;
13731 if (! EQ (old_frame
, selected_frame
)
13732 && FRAME_LIVE_P (XFRAME (old_frame
)))
13733 select_frame_for_redisplay (old_frame
);
13738 /* Mark the display of window W as accurate or inaccurate. If
13739 ACCURATE_P is non-zero mark display of W as accurate. If
13740 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13741 redisplay_internal is called. */
13744 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13746 if (BUFFERP (w
->buffer
))
13748 struct buffer
*b
= XBUFFER (w
->buffer
);
13750 w
->last_modified
= accurate_p
? BUF_MODIFF(b
) : 0;
13751 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF(b
) : 0;
13753 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
13757 b
->clip_changed
= 0;
13758 b
->prevent_redisplay_optimizations_p
= 0;
13760 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13761 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13762 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13763 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13765 w
->current_matrix
->buffer
= b
;
13766 w
->current_matrix
->begv
= BUF_BEGV (b
);
13767 w
->current_matrix
->zv
= BUF_ZV (b
);
13769 w
->last_cursor
= w
->cursor
;
13770 w
->last_cursor_off_p
= w
->cursor_off_p
;
13772 if (w
== XWINDOW (selected_window
))
13773 w
->last_point
= BUF_PT (b
);
13775 w
->last_point
= XMARKER (w
->pointm
)->charpos
;
13781 wset_window_end_valid (w
, w
->buffer
);
13782 w
->update_mode_line
= 0;
13787 /* Mark the display of windows in the window tree rooted at WINDOW as
13788 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13789 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13790 be redisplayed the next time redisplay_internal is called. */
13793 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13797 for (; !NILP (window
); window
= w
->next
)
13799 w
= XWINDOW (window
);
13800 mark_window_display_accurate_1 (w
, accurate_p
);
13802 if (!NILP (w
->vchild
))
13803 mark_window_display_accurate (w
->vchild
, accurate_p
);
13804 if (!NILP (w
->hchild
))
13805 mark_window_display_accurate (w
->hchild
, accurate_p
);
13810 update_overlay_arrows (1);
13814 /* Force a thorough redisplay the next time by setting
13815 last_arrow_position and last_arrow_string to t, which is
13816 unequal to any useful value of Voverlay_arrow_... */
13817 update_overlay_arrows (-1);
13822 /* Return value in display table DP (Lisp_Char_Table *) for character
13823 C. Since a display table doesn't have any parent, we don't have to
13824 follow parent. Do not call this function directly but use the
13825 macro DISP_CHAR_VECTOR. */
13828 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13832 if (ASCII_CHAR_P (c
))
13835 if (SUB_CHAR_TABLE_P (val
))
13836 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13842 XSETCHAR_TABLE (table
, dp
);
13843 val
= char_table_ref (table
, c
);
13852 /***********************************************************************
13854 ***********************************************************************/
13856 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13859 redisplay_windows (Lisp_Object window
)
13861 while (!NILP (window
))
13863 struct window
*w
= XWINDOW (window
);
13865 if (!NILP (w
->hchild
))
13866 redisplay_windows (w
->hchild
);
13867 else if (!NILP (w
->vchild
))
13868 redisplay_windows (w
->vchild
);
13869 else if (!NILP (w
->buffer
))
13871 displayed_buffer
= XBUFFER (w
->buffer
);
13872 /* Use list_of_error, not Qerror, so that
13873 we catch only errors and don't run the debugger. */
13874 internal_condition_case_1 (redisplay_window_0
, window
,
13876 redisplay_window_error
);
13884 redisplay_window_error (Lisp_Object ignore
)
13886 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13891 redisplay_window_0 (Lisp_Object window
)
13893 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13894 redisplay_window (window
, 0);
13899 redisplay_window_1 (Lisp_Object window
)
13901 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13902 redisplay_window (window
, 1);
13907 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13908 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13909 which positions recorded in ROW differ from current buffer
13912 Return 0 if cursor is not on this row, 1 otherwise. */
13915 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13916 struct glyph_matrix
*matrix
,
13917 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
13920 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13921 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13922 struct glyph
*cursor
= NULL
;
13923 /* The last known character position in row. */
13924 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13926 ptrdiff_t pt_old
= PT
- delta
;
13927 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13928 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13929 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13930 /* A glyph beyond the edge of TEXT_AREA which we should never
13932 struct glyph
*glyphs_end
= end
;
13933 /* Non-zero means we've found a match for cursor position, but that
13934 glyph has the avoid_cursor_p flag set. */
13935 int match_with_avoid_cursor
= 0;
13936 /* Non-zero means we've seen at least one glyph that came from a
13938 int string_seen
= 0;
13939 /* Largest and smallest buffer positions seen so far during scan of
13941 ptrdiff_t bpos_max
= pos_before
;
13942 ptrdiff_t bpos_min
= pos_after
;
13943 /* Last buffer position covered by an overlay string with an integer
13944 `cursor' property. */
13945 ptrdiff_t bpos_covered
= 0;
13946 /* Non-zero means the display string on which to display the cursor
13947 comes from a text property, not from an overlay. */
13948 int string_from_text_prop
= 0;
13950 /* Don't even try doing anything if called for a mode-line or
13951 header-line row, since the rest of the code isn't prepared to
13952 deal with such calamities. */
13953 eassert (!row
->mode_line_p
);
13954 if (row
->mode_line_p
)
13957 /* Skip over glyphs not having an object at the start and the end of
13958 the row. These are special glyphs like truncation marks on
13959 terminal frames. */
13960 if (row
->displays_text_p
)
13962 if (!row
->reversed_p
)
13965 && INTEGERP (glyph
->object
)
13966 && glyph
->charpos
< 0)
13968 x
+= glyph
->pixel_width
;
13972 && INTEGERP ((end
- 1)->object
)
13973 /* CHARPOS is zero for blanks and stretch glyphs
13974 inserted by extend_face_to_end_of_line. */
13975 && (end
- 1)->charpos
<= 0)
13977 glyph_before
= glyph
- 1;
13984 /* If the glyph row is reversed, we need to process it from back
13985 to front, so swap the edge pointers. */
13986 glyphs_end
= end
= glyph
- 1;
13987 glyph
+= row
->used
[TEXT_AREA
] - 1;
13989 while (glyph
> end
+ 1
13990 && INTEGERP (glyph
->object
)
13991 && glyph
->charpos
< 0)
13994 x
-= glyph
->pixel_width
;
13996 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13998 /* By default, in reversed rows we put the cursor on the
13999 rightmost (first in the reading order) glyph. */
14000 for (g
= end
+ 1; g
< glyph
; g
++)
14001 x
+= g
->pixel_width
;
14003 && INTEGERP ((end
+ 1)->object
)
14004 && (end
+ 1)->charpos
<= 0)
14006 glyph_before
= glyph
+ 1;
14010 else if (row
->reversed_p
)
14012 /* In R2L rows that don't display text, put the cursor on the
14013 rightmost glyph. Case in point: an empty last line that is
14014 part of an R2L paragraph. */
14016 /* Avoid placing the cursor on the last glyph of the row, where
14017 on terminal frames we hold the vertical border between
14018 adjacent windows. */
14019 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14020 && !WINDOW_RIGHTMOST_P (w
)
14021 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14023 x
= -1; /* will be computed below, at label compute_x */
14026 /* Step 1: Try to find the glyph whose character position
14027 corresponds to point. If that's not possible, find 2 glyphs
14028 whose character positions are the closest to point, one before
14029 point, the other after it. */
14030 if (!row
->reversed_p
)
14031 while (/* not marched to end of glyph row */
14033 /* glyph was not inserted by redisplay for internal purposes */
14034 && !INTEGERP (glyph
->object
))
14036 if (BUFFERP (glyph
->object
))
14038 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14040 if (glyph
->charpos
> bpos_max
)
14041 bpos_max
= glyph
->charpos
;
14042 if (glyph
->charpos
< bpos_min
)
14043 bpos_min
= glyph
->charpos
;
14044 if (!glyph
->avoid_cursor_p
)
14046 /* If we hit point, we've found the glyph on which to
14047 display the cursor. */
14050 match_with_avoid_cursor
= 0;
14053 /* See if we've found a better approximation to
14054 POS_BEFORE or to POS_AFTER. */
14055 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14057 pos_before
= glyph
->charpos
;
14058 glyph_before
= glyph
;
14060 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14062 pos_after
= glyph
->charpos
;
14063 glyph_after
= glyph
;
14066 else if (dpos
== 0)
14067 match_with_avoid_cursor
= 1;
14069 else if (STRINGP (glyph
->object
))
14071 Lisp_Object chprop
;
14072 ptrdiff_t glyph_pos
= glyph
->charpos
;
14074 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14076 if (!NILP (chprop
))
14078 /* If the string came from a `display' text property,
14079 look up the buffer position of that property and
14080 use that position to update bpos_max, as if we
14081 actually saw such a position in one of the row's
14082 glyphs. This helps with supporting integer values
14083 of `cursor' property on the display string in
14084 situations where most or all of the row's buffer
14085 text is completely covered by display properties,
14086 so that no glyph with valid buffer positions is
14087 ever seen in the row. */
14088 ptrdiff_t prop_pos
=
14089 string_buffer_position_lim (glyph
->object
, pos_before
,
14092 if (prop_pos
>= pos_before
)
14093 bpos_max
= prop_pos
- 1;
14095 if (INTEGERP (chprop
))
14097 bpos_covered
= bpos_max
+ XINT (chprop
);
14098 /* If the `cursor' property covers buffer positions up
14099 to and including point, we should display cursor on
14100 this glyph. Note that, if a `cursor' property on one
14101 of the string's characters has an integer value, we
14102 will break out of the loop below _before_ we get to
14103 the position match above. IOW, integer values of
14104 the `cursor' property override the "exact match for
14105 point" strategy of positioning the cursor. */
14106 /* Implementation note: bpos_max == pt_old when, e.g.,
14107 we are in an empty line, where bpos_max is set to
14108 MATRIX_ROW_START_CHARPOS, see above. */
14109 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14118 x
+= glyph
->pixel_width
;
14121 else if (glyph
> end
) /* row is reversed */
14122 while (!INTEGERP (glyph
->object
))
14124 if (BUFFERP (glyph
->object
))
14126 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14128 if (glyph
->charpos
> bpos_max
)
14129 bpos_max
= glyph
->charpos
;
14130 if (glyph
->charpos
< bpos_min
)
14131 bpos_min
= glyph
->charpos
;
14132 if (!glyph
->avoid_cursor_p
)
14136 match_with_avoid_cursor
= 0;
14139 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14141 pos_before
= glyph
->charpos
;
14142 glyph_before
= glyph
;
14144 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14146 pos_after
= glyph
->charpos
;
14147 glyph_after
= glyph
;
14150 else if (dpos
== 0)
14151 match_with_avoid_cursor
= 1;
14153 else if (STRINGP (glyph
->object
))
14155 Lisp_Object chprop
;
14156 ptrdiff_t glyph_pos
= glyph
->charpos
;
14158 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14160 if (!NILP (chprop
))
14162 ptrdiff_t prop_pos
=
14163 string_buffer_position_lim (glyph
->object
, pos_before
,
14166 if (prop_pos
>= pos_before
)
14167 bpos_max
= prop_pos
- 1;
14169 if (INTEGERP (chprop
))
14171 bpos_covered
= bpos_max
+ XINT (chprop
);
14172 /* If the `cursor' property covers buffer positions up
14173 to and including point, we should display cursor on
14175 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14184 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14186 x
--; /* can't use any pixel_width */
14189 x
-= glyph
->pixel_width
;
14192 /* Step 2: If we didn't find an exact match for point, we need to
14193 look for a proper place to put the cursor among glyphs between
14194 GLYPH_BEFORE and GLYPH_AFTER. */
14195 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14196 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14197 && bpos_covered
< pt_old
)
14199 /* An empty line has a single glyph whose OBJECT is zero and
14200 whose CHARPOS is the position of a newline on that line.
14201 Note that on a TTY, there are more glyphs after that, which
14202 were produced by extend_face_to_end_of_line, but their
14203 CHARPOS is zero or negative. */
14205 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14206 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
14208 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14210 ptrdiff_t ellipsis_pos
;
14212 /* Scan back over the ellipsis glyphs. */
14213 if (!row
->reversed_p
)
14215 ellipsis_pos
= (glyph
- 1)->charpos
;
14216 while (glyph
> row
->glyphs
[TEXT_AREA
]
14217 && (glyph
- 1)->charpos
== ellipsis_pos
)
14218 glyph
--, x
-= glyph
->pixel_width
;
14219 /* That loop always goes one position too far, including
14220 the glyph before the ellipsis. So scan forward over
14222 x
+= glyph
->pixel_width
;
14225 else /* row is reversed */
14227 ellipsis_pos
= (glyph
+ 1)->charpos
;
14228 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14229 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14230 glyph
++, x
+= glyph
->pixel_width
;
14231 x
-= glyph
->pixel_width
;
14235 else if (match_with_avoid_cursor
)
14237 cursor
= glyph_after
;
14240 else if (string_seen
)
14242 int incr
= row
->reversed_p
? -1 : +1;
14244 /* Need to find the glyph that came out of a string which is
14245 present at point. That glyph is somewhere between
14246 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14247 positioned between POS_BEFORE and POS_AFTER in the
14249 struct glyph
*start
, *stop
;
14250 ptrdiff_t pos
= pos_before
;
14254 /* If the row ends in a newline from a display string,
14255 reordering could have moved the glyphs belonging to the
14256 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14257 in this case we extend the search to the last glyph in
14258 the row that was not inserted by redisplay. */
14259 if (row
->ends_in_newline_from_string_p
)
14262 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14265 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14266 correspond to POS_BEFORE and POS_AFTER, respectively. We
14267 need START and STOP in the order that corresponds to the
14268 row's direction as given by its reversed_p flag. If the
14269 directionality of characters between POS_BEFORE and
14270 POS_AFTER is the opposite of the row's base direction,
14271 these characters will have been reordered for display,
14272 and we need to reverse START and STOP. */
14273 if (!row
->reversed_p
)
14275 start
= min (glyph_before
, glyph_after
);
14276 stop
= max (glyph_before
, glyph_after
);
14280 start
= max (glyph_before
, glyph_after
);
14281 stop
= min (glyph_before
, glyph_after
);
14283 for (glyph
= start
+ incr
;
14284 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14287 /* Any glyphs that come from the buffer are here because
14288 of bidi reordering. Skip them, and only pay
14289 attention to glyphs that came from some string. */
14290 if (STRINGP (glyph
->object
))
14294 /* If the display property covers the newline, we
14295 need to search for it one position farther. */
14296 ptrdiff_t lim
= pos_after
14297 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14299 string_from_text_prop
= 0;
14300 str
= glyph
->object
;
14301 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14302 if (tem
== 0 /* from overlay */
14305 /* If the string from which this glyph came is
14306 found in the buffer at point, or at position
14307 that is closer to point than pos_after, then
14308 we've found the glyph we've been looking for.
14309 If it comes from an overlay (tem == 0), and
14310 it has the `cursor' property on one of its
14311 glyphs, record that glyph as a candidate for
14312 displaying the cursor. (As in the
14313 unidirectional version, we will display the
14314 cursor on the last candidate we find.) */
14317 || (tem
- pt_old
> 0 && tem
< pos_after
))
14319 /* The glyphs from this string could have
14320 been reordered. Find the one with the
14321 smallest string position. Or there could
14322 be a character in the string with the
14323 `cursor' property, which means display
14324 cursor on that character's glyph. */
14325 ptrdiff_t strpos
= glyph
->charpos
;
14330 string_from_text_prop
= 1;
14333 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14334 && EQ (glyph
->object
, str
);
14338 ptrdiff_t gpos
= glyph
->charpos
;
14340 cprop
= Fget_char_property (make_number (gpos
),
14348 if (tem
&& glyph
->charpos
< strpos
)
14350 strpos
= glyph
->charpos
;
14356 || (tem
- pt_old
> 0 && tem
< pos_after
))
14360 pos
= tem
+ 1; /* don't find previous instances */
14362 /* This string is not what we want; skip all of the
14363 glyphs that came from it. */
14364 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14365 && EQ (glyph
->object
, str
))
14372 /* If we reached the end of the line, and END was from a string,
14373 the cursor is not on this line. */
14375 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14376 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14377 && STRINGP (end
->object
)
14378 && row
->continued_p
)
14381 /* A truncated row may not include PT among its character positions.
14382 Setting the cursor inside the scroll margin will trigger
14383 recalculation of hscroll in hscroll_window_tree. But if a
14384 display string covers point, defer to the string-handling
14385 code below to figure this out. */
14386 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14388 cursor
= glyph_before
;
14391 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14392 /* Zero-width characters produce no glyphs. */
14394 && (row
->reversed_p
14395 ? glyph_after
> glyphs_end
14396 : glyph_after
< glyphs_end
)))
14398 cursor
= glyph_after
;
14404 if (cursor
!= NULL
)
14406 else if (glyph
== glyphs_end
14407 && pos_before
== pos_after
14408 && STRINGP ((row
->reversed_p
14409 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14410 : row
->glyphs
[TEXT_AREA
])->object
))
14412 /* If all the glyphs of this row came from strings, put the
14413 cursor on the first glyph of the row. This avoids having the
14414 cursor outside of the text area in this very rare and hard
14418 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14419 : row
->glyphs
[TEXT_AREA
];
14425 /* Need to compute x that corresponds to GLYPH. */
14426 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14428 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14430 x
+= g
->pixel_width
;
14434 /* ROW could be part of a continued line, which, under bidi
14435 reordering, might have other rows whose start and end charpos
14436 occlude point. Only set w->cursor if we found a better
14437 approximation to the cursor position than we have from previously
14438 examined candidate rows belonging to the same continued line. */
14439 if (/* we already have a candidate row */
14440 w
->cursor
.vpos
>= 0
14441 /* that candidate is not the row we are processing */
14442 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14443 /* Make sure cursor.vpos specifies a row whose start and end
14444 charpos occlude point, and it is valid candidate for being a
14445 cursor-row. This is because some callers of this function
14446 leave cursor.vpos at the row where the cursor was displayed
14447 during the last redisplay cycle. */
14448 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14449 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14450 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14453 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14455 /* Don't consider glyphs that are outside TEXT_AREA. */
14456 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14458 /* Keep the candidate whose buffer position is the closest to
14459 point or has the `cursor' property. */
14460 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14461 w
->cursor
.hpos
>= 0
14462 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14463 && ((BUFFERP (g1
->object
)
14464 && (g1
->charpos
== pt_old
/* an exact match always wins */
14465 || (BUFFERP (glyph
->object
)
14466 && eabs (g1
->charpos
- pt_old
)
14467 < eabs (glyph
->charpos
- pt_old
))))
14468 /* previous candidate is a glyph from a string that has
14469 a non-nil `cursor' property */
14470 || (STRINGP (g1
->object
)
14471 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14472 Qcursor
, g1
->object
))
14473 /* previous candidate is from the same display
14474 string as this one, and the display string
14475 came from a text property */
14476 || (EQ (g1
->object
, glyph
->object
)
14477 && string_from_text_prop
)
14478 /* this candidate is from newline and its
14479 position is not an exact match */
14480 || (INTEGERP (glyph
->object
)
14481 && glyph
->charpos
!= pt_old
)))))
14483 /* If this candidate gives an exact match, use that. */
14484 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14485 /* If this candidate is a glyph created for the
14486 terminating newline of a line, and point is on that
14487 newline, it wins because it's an exact match. */
14488 || (!row
->continued_p
14489 && INTEGERP (glyph
->object
)
14490 && glyph
->charpos
== 0
14491 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14492 /* Otherwise, keep the candidate that comes from a row
14493 spanning less buffer positions. This may win when one or
14494 both candidate positions are on glyphs that came from
14495 display strings, for which we cannot compare buffer
14497 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14498 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14499 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14502 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14504 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14505 w
->cursor
.y
= row
->y
+ dy
;
14507 if (w
== XWINDOW (selected_window
))
14509 if (!row
->continued_p
14510 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14513 this_line_buffer
= XBUFFER (w
->buffer
);
14515 CHARPOS (this_line_start_pos
)
14516 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14517 BYTEPOS (this_line_start_pos
)
14518 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14520 CHARPOS (this_line_end_pos
)
14521 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14522 BYTEPOS (this_line_end_pos
)
14523 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14525 this_line_y
= w
->cursor
.y
;
14526 this_line_pixel_height
= row
->height
;
14527 this_line_vpos
= w
->cursor
.vpos
;
14528 this_line_start_x
= row
->x
;
14531 CHARPOS (this_line_start_pos
) = 0;
14538 /* Run window scroll functions, if any, for WINDOW with new window
14539 start STARTP. Sets the window start of WINDOW to that position.
14541 We assume that the window's buffer is really current. */
14543 static struct text_pos
14544 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14546 struct window
*w
= XWINDOW (window
);
14547 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14549 if (current_buffer
!= XBUFFER (w
->buffer
))
14552 if (!NILP (Vwindow_scroll_functions
))
14554 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14555 make_number (CHARPOS (startp
)));
14556 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14557 /* In case the hook functions switch buffers. */
14558 set_buffer_internal (XBUFFER (w
->buffer
));
14565 /* Make sure the line containing the cursor is fully visible.
14566 A value of 1 means there is nothing to be done.
14567 (Either the line is fully visible, or it cannot be made so,
14568 or we cannot tell.)
14570 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14571 is higher than window.
14573 A value of 0 means the caller should do scrolling
14574 as if point had gone off the screen. */
14577 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14579 struct glyph_matrix
*matrix
;
14580 struct glyph_row
*row
;
14583 if (!make_cursor_line_fully_visible_p
)
14586 /* It's not always possible to find the cursor, e.g, when a window
14587 is full of overlay strings. Don't do anything in that case. */
14588 if (w
->cursor
.vpos
< 0)
14591 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14592 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14594 /* If the cursor row is not partially visible, there's nothing to do. */
14595 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14598 /* If the row the cursor is in is taller than the window's height,
14599 it's not clear what to do, so do nothing. */
14600 window_height
= window_box_height (w
);
14601 if (row
->height
>= window_height
)
14603 if (!force_p
|| MINI_WINDOW_P (w
)
14604 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14611 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14612 non-zero means only WINDOW is redisplayed in redisplay_internal.
14613 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14614 in redisplay_window to bring a partially visible line into view in
14615 the case that only the cursor has moved.
14617 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14618 last screen line's vertical height extends past the end of the screen.
14622 1 if scrolling succeeded
14624 0 if scrolling didn't find point.
14626 -1 if new fonts have been loaded so that we must interrupt
14627 redisplay, adjust glyph matrices, and try again. */
14633 SCROLLING_NEED_LARGER_MATRICES
14636 /* If scroll-conservatively is more than this, never recenter.
14638 If you change this, don't forget to update the doc string of
14639 `scroll-conservatively' and the Emacs manual. */
14640 #define SCROLL_LIMIT 100
14643 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14644 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14645 int temp_scroll_step
, int last_line_misfit
)
14647 struct window
*w
= XWINDOW (window
);
14648 struct frame
*f
= XFRAME (w
->frame
);
14649 struct text_pos pos
, startp
;
14651 int this_scroll_margin
, scroll_max
, rc
, height
;
14652 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14653 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14654 Lisp_Object aggressive
;
14655 /* We will never try scrolling more than this number of lines. */
14656 int scroll_limit
= SCROLL_LIMIT
;
14659 debug_method_add (w
, "try_scrolling");
14662 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14664 /* Compute scroll margin height in pixels. We scroll when point is
14665 within this distance from the top or bottom of the window. */
14666 if (scroll_margin
> 0)
14667 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14668 * FRAME_LINE_HEIGHT (f
);
14670 this_scroll_margin
= 0;
14672 /* Force arg_scroll_conservatively to have a reasonable value, to
14673 avoid scrolling too far away with slow move_it_* functions. Note
14674 that the user can supply scroll-conservatively equal to
14675 `most-positive-fixnum', which can be larger than INT_MAX. */
14676 if (arg_scroll_conservatively
> scroll_limit
)
14678 arg_scroll_conservatively
= scroll_limit
+ 1;
14679 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14681 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14682 /* Compute how much we should try to scroll maximally to bring
14683 point into view. */
14684 scroll_max
= (max (scroll_step
,
14685 max (arg_scroll_conservatively
, temp_scroll_step
))
14686 * FRAME_LINE_HEIGHT (f
));
14687 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14688 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14689 /* We're trying to scroll because of aggressive scrolling but no
14690 scroll_step is set. Choose an arbitrary one. */
14691 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14697 /* Decide whether to scroll down. */
14698 if (PT
> CHARPOS (startp
))
14700 int scroll_margin_y
;
14702 /* Compute the pixel ypos of the scroll margin, then move IT to
14703 either that ypos or PT, whichever comes first. */
14704 start_display (&it
, w
, startp
);
14705 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14706 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14707 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14708 (MOVE_TO_POS
| MOVE_TO_Y
));
14710 if (PT
> CHARPOS (it
.current
.pos
))
14712 int y0
= line_bottom_y (&it
);
14713 /* Compute how many pixels below window bottom to stop searching
14714 for PT. This avoids costly search for PT that is far away if
14715 the user limited scrolling by a small number of lines, but
14716 always finds PT if scroll_conservatively is set to a large
14717 number, such as most-positive-fixnum. */
14718 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14719 int y_to_move
= it
.last_visible_y
+ slack
;
14721 /* Compute the distance from the scroll margin to PT or to
14722 the scroll limit, whichever comes first. This should
14723 include the height of the cursor line, to make that line
14725 move_it_to (&it
, PT
, -1, y_to_move
,
14726 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14727 dy
= line_bottom_y (&it
) - y0
;
14729 if (dy
> scroll_max
)
14730 return SCROLLING_FAILED
;
14739 /* Point is in or below the bottom scroll margin, so move the
14740 window start down. If scrolling conservatively, move it just
14741 enough down to make point visible. If scroll_step is set,
14742 move it down by scroll_step. */
14743 if (arg_scroll_conservatively
)
14745 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14746 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14747 else if (scroll_step
|| temp_scroll_step
)
14748 amount_to_scroll
= scroll_max
;
14751 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14752 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14753 if (NUMBERP (aggressive
))
14755 double float_amount
= XFLOATINT (aggressive
) * height
;
14756 amount_to_scroll
= float_amount
;
14757 if (amount_to_scroll
== 0 && float_amount
> 0)
14758 amount_to_scroll
= 1;
14759 /* Don't let point enter the scroll margin near top of
14761 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14762 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14766 if (amount_to_scroll
<= 0)
14767 return SCROLLING_FAILED
;
14769 start_display (&it
, w
, startp
);
14770 if (arg_scroll_conservatively
<= scroll_limit
)
14771 move_it_vertically (&it
, amount_to_scroll
);
14774 /* Extra precision for users who set scroll-conservatively
14775 to a large number: make sure the amount we scroll
14776 the window start is never less than amount_to_scroll,
14777 which was computed as distance from window bottom to
14778 point. This matters when lines at window top and lines
14779 below window bottom have different height. */
14781 void *it1data
= NULL
;
14782 /* We use a temporary it1 because line_bottom_y can modify
14783 its argument, if it moves one line down; see there. */
14786 SAVE_IT (it1
, it
, it1data
);
14787 start_y
= line_bottom_y (&it1
);
14789 RESTORE_IT (&it
, &it
, it1data
);
14790 move_it_by_lines (&it
, 1);
14791 SAVE_IT (it1
, it
, it1data
);
14792 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14795 /* If STARTP is unchanged, move it down another screen line. */
14796 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14797 move_it_by_lines (&it
, 1);
14798 startp
= it
.current
.pos
;
14802 struct text_pos scroll_margin_pos
= startp
;
14804 /* See if point is inside the scroll margin at the top of the
14806 if (this_scroll_margin
)
14808 start_display (&it
, w
, startp
);
14809 move_it_vertically (&it
, this_scroll_margin
);
14810 scroll_margin_pos
= it
.current
.pos
;
14813 if (PT
< CHARPOS (scroll_margin_pos
))
14815 /* Point is in the scroll margin at the top of the window or
14816 above what is displayed in the window. */
14819 /* Compute the vertical distance from PT to the scroll
14820 margin position. Move as far as scroll_max allows, or
14821 one screenful, or 10 screen lines, whichever is largest.
14822 Give up if distance is greater than scroll_max. */
14823 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14824 start_display (&it
, w
, pos
);
14826 y_to_move
= max (it
.last_visible_y
,
14827 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14828 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14830 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14831 dy
= it
.current_y
- y0
;
14832 if (dy
> scroll_max
)
14833 return SCROLLING_FAILED
;
14835 /* Compute new window start. */
14836 start_display (&it
, w
, startp
);
14838 if (arg_scroll_conservatively
)
14839 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14840 max (scroll_step
, temp_scroll_step
));
14841 else if (scroll_step
|| temp_scroll_step
)
14842 amount_to_scroll
= scroll_max
;
14845 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14846 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14847 if (NUMBERP (aggressive
))
14849 double float_amount
= XFLOATINT (aggressive
) * height
;
14850 amount_to_scroll
= float_amount
;
14851 if (amount_to_scroll
== 0 && float_amount
> 0)
14852 amount_to_scroll
= 1;
14853 amount_to_scroll
-=
14854 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14855 /* Don't let point enter the scroll margin near
14856 bottom of the window. */
14857 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14858 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14862 if (amount_to_scroll
<= 0)
14863 return SCROLLING_FAILED
;
14865 move_it_vertically_backward (&it
, amount_to_scroll
);
14866 startp
= it
.current
.pos
;
14870 /* Run window scroll functions. */
14871 startp
= run_window_scroll_functions (window
, startp
);
14873 /* Display the window. Give up if new fonts are loaded, or if point
14875 if (!try_window (window
, startp
, 0))
14876 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14877 else if (w
->cursor
.vpos
< 0)
14879 clear_glyph_matrix (w
->desired_matrix
);
14880 rc
= SCROLLING_FAILED
;
14884 /* Maybe forget recorded base line for line number display. */
14885 if (!just_this_one_p
14886 || current_buffer
->clip_changed
14887 || BEG_UNCHANGED
< CHARPOS (startp
))
14888 wset_base_line_number (w
, Qnil
);
14890 /* If cursor ends up on a partially visible line,
14891 treat that as being off the bottom of the screen. */
14892 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14893 /* It's possible that the cursor is on the first line of the
14894 buffer, which is partially obscured due to a vscroll
14895 (Bug#7537). In that case, avoid looping forever . */
14896 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14898 clear_glyph_matrix (w
->desired_matrix
);
14899 ++extra_scroll_margin_lines
;
14902 rc
= SCROLLING_SUCCESS
;
14909 /* Compute a suitable window start for window W if display of W starts
14910 on a continuation line. Value is non-zero if a new window start
14913 The new window start will be computed, based on W's width, starting
14914 from the start of the continued line. It is the start of the
14915 screen line with the minimum distance from the old start W->start. */
14918 compute_window_start_on_continuation_line (struct window
*w
)
14920 struct text_pos pos
, start_pos
;
14921 int window_start_changed_p
= 0;
14923 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14925 /* If window start is on a continuation line... Window start may be
14926 < BEGV in case there's invisible text at the start of the
14927 buffer (M-x rmail, for example). */
14928 if (CHARPOS (start_pos
) > BEGV
14929 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14932 struct glyph_row
*row
;
14934 /* Handle the case that the window start is out of range. */
14935 if (CHARPOS (start_pos
) < BEGV
)
14936 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14937 else if (CHARPOS (start_pos
) > ZV
)
14938 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14940 /* Find the start of the continued line. This should be fast
14941 because scan_buffer is fast (newline cache). */
14942 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14943 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14944 row
, DEFAULT_FACE_ID
);
14945 reseat_at_previous_visible_line_start (&it
);
14947 /* If the line start is "too far" away from the window start,
14948 say it takes too much time to compute a new window start. */
14949 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14950 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14952 int min_distance
, distance
;
14954 /* Move forward by display lines to find the new window
14955 start. If window width was enlarged, the new start can
14956 be expected to be > the old start. If window width was
14957 decreased, the new window start will be < the old start.
14958 So, we're looking for the display line start with the
14959 minimum distance from the old window start. */
14960 pos
= it
.current
.pos
;
14961 min_distance
= INFINITY
;
14962 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14963 distance
< min_distance
)
14965 min_distance
= distance
;
14966 pos
= it
.current
.pos
;
14967 move_it_by_lines (&it
, 1);
14970 /* Set the window start there. */
14971 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14972 window_start_changed_p
= 1;
14976 return window_start_changed_p
;
14980 /* Try cursor movement in case text has not changed in window WINDOW,
14981 with window start STARTP. Value is
14983 CURSOR_MOVEMENT_SUCCESS if successful
14985 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14987 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14988 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14989 we want to scroll as if scroll-step were set to 1. See the code.
14991 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14992 which case we have to abort this redisplay, and adjust matrices
14997 CURSOR_MOVEMENT_SUCCESS
,
14998 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14999 CURSOR_MOVEMENT_MUST_SCROLL
,
15000 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15004 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
15006 struct window
*w
= XWINDOW (window
);
15007 struct frame
*f
= XFRAME (w
->frame
);
15008 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15011 if (inhibit_try_cursor_movement
)
15015 /* Previously, there was a check for Lisp integer in the
15016 if-statement below. Now, this field is converted to
15017 ptrdiff_t, thus zero means invalid position in a buffer. */
15018 eassert (w
->last_point
> 0);
15020 /* Handle case where text has not changed, only point, and it has
15021 not moved off the frame. */
15022 if (/* Point may be in this window. */
15023 PT
>= CHARPOS (startp
)
15024 /* Selective display hasn't changed. */
15025 && !current_buffer
->clip_changed
15026 /* Function force-mode-line-update is used to force a thorough
15027 redisplay. It sets either windows_or_buffers_changed or
15028 update_mode_lines. So don't take a shortcut here for these
15030 && !update_mode_lines
15031 && !windows_or_buffers_changed
15032 && !cursor_type_changed
15033 /* Can't use this case if highlighting a region. When a
15034 region exists, cursor movement has to do more than just
15036 && !(!NILP (Vtransient_mark_mode
)
15037 && !NILP (BVAR (current_buffer
, mark_active
)))
15038 && NILP (w
->region_showing
)
15039 && NILP (Vshow_trailing_whitespace
)
15040 /* This code is not used for mini-buffer for the sake of the case
15041 of redisplaying to replace an echo area message; since in
15042 that case the mini-buffer contents per se are usually
15043 unchanged. This code is of no real use in the mini-buffer
15044 since the handling of this_line_start_pos, etc., in redisplay
15045 handles the same cases. */
15046 && !EQ (window
, minibuf_window
)
15047 /* When splitting windows or for new windows, it happens that
15048 redisplay is called with a nil window_end_vpos or one being
15049 larger than the window. This should really be fixed in
15050 window.c. I don't have this on my list, now, so we do
15051 approximately the same as the old redisplay code. --gerd. */
15052 && INTEGERP (w
->window_end_vpos
)
15053 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
15054 && (FRAME_WINDOW_P (f
)
15055 || !overlay_arrow_in_current_buffer_p ()))
15057 int this_scroll_margin
, top_scroll_margin
;
15058 struct glyph_row
*row
= NULL
;
15061 debug_method_add (w
, "cursor movement");
15064 /* Scroll if point within this distance from the top or bottom
15065 of the window. This is a pixel value. */
15066 if (scroll_margin
> 0)
15068 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15069 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15072 this_scroll_margin
= 0;
15074 top_scroll_margin
= this_scroll_margin
;
15075 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15076 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15078 /* Start with the row the cursor was displayed during the last
15079 not paused redisplay. Give up if that row is not valid. */
15080 if (w
->last_cursor
.vpos
< 0
15081 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
15082 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15085 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
15086 if (row
->mode_line_p
)
15088 if (!row
->enabled_p
)
15089 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15092 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15094 int scroll_p
= 0, must_scroll
= 0;
15095 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15097 if (PT
> w
->last_point
)
15099 /* Point has moved forward. */
15100 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15101 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15103 eassert (row
->enabled_p
);
15107 /* If the end position of a row equals the start
15108 position of the next row, and PT is at that position,
15109 we would rather display cursor in the next line. */
15110 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15111 && MATRIX_ROW_END_CHARPOS (row
) == PT
15112 && row
< w
->current_matrix
->rows
15113 + w
->current_matrix
->nrows
- 1
15114 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15115 && !cursor_row_p (row
))
15118 /* If within the scroll margin, scroll. Note that
15119 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15120 the next line would be drawn, and that
15121 this_scroll_margin can be zero. */
15122 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15123 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15124 /* Line is completely visible last line in window
15125 and PT is to be set in the next line. */
15126 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15127 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15128 && !row
->ends_at_zv_p
15129 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15132 else if (PT
< w
->last_point
)
15134 /* Cursor has to be moved backward. Note that PT >=
15135 CHARPOS (startp) because of the outer if-statement. */
15136 while (!row
->mode_line_p
15137 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15138 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15139 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15140 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15141 row
> w
->current_matrix
->rows
15142 && (row
-1)->ends_in_newline_from_string_p
))))
15143 && (row
->y
> top_scroll_margin
15144 || CHARPOS (startp
) == BEGV
))
15146 eassert (row
->enabled_p
);
15150 /* Consider the following case: Window starts at BEGV,
15151 there is invisible, intangible text at BEGV, so that
15152 display starts at some point START > BEGV. It can
15153 happen that we are called with PT somewhere between
15154 BEGV and START. Try to handle that case. */
15155 if (row
< w
->current_matrix
->rows
15156 || row
->mode_line_p
)
15158 row
= w
->current_matrix
->rows
;
15159 if (row
->mode_line_p
)
15163 /* Due to newlines in overlay strings, we may have to
15164 skip forward over overlay strings. */
15165 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15166 && MATRIX_ROW_END_CHARPOS (row
) == PT
15167 && !cursor_row_p (row
))
15170 /* If within the scroll margin, scroll. */
15171 if (row
->y
< top_scroll_margin
15172 && CHARPOS (startp
) != BEGV
)
15177 /* Cursor did not move. So don't scroll even if cursor line
15178 is partially visible, as it was so before. */
15179 rc
= CURSOR_MOVEMENT_SUCCESS
;
15182 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15183 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15185 /* if PT is not in the glyph row, give up. */
15186 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15189 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15190 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15192 struct glyph_row
*row1
;
15194 /* If rows are bidi-reordered and point moved, back up
15195 until we find a row that does not belong to a
15196 continuation line. This is because we must consider
15197 all rows of a continued line as candidates for the
15198 new cursor positioning, since row start and end
15199 positions change non-linearly with vertical position
15201 /* FIXME: Revisit this when glyph ``spilling'' in
15202 continuation lines' rows is implemented for
15203 bidi-reordered rows. */
15204 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15205 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15208 /* If we hit the beginning of the displayed portion
15209 without finding the first row of a continued
15213 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15216 eassert (row
->enabled_p
);
15221 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15222 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15223 /* Make sure this isn't a header line by any chance, since
15224 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15225 && !row
->mode_line_p
15226 && make_cursor_line_fully_visible_p
)
15228 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15229 && !row
->ends_at_zv_p
15230 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15231 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15232 else if (row
->height
> window_box_height (w
))
15234 /* If we end up in a partially visible line, let's
15235 make it fully visible, except when it's taller
15236 than the window, in which case we can't do much
15239 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15243 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15244 if (!cursor_row_fully_visible_p (w
, 0, 1))
15245 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15247 rc
= CURSOR_MOVEMENT_SUCCESS
;
15251 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15252 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15253 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15255 /* With bidi-reordered rows, there could be more than
15256 one candidate row whose start and end positions
15257 occlude point. We need to let set_cursor_from_row
15258 find the best candidate. */
15259 /* FIXME: Revisit this when glyph ``spilling'' in
15260 continuation lines' rows is implemented for
15261 bidi-reordered rows. */
15266 int at_zv_p
= 0, exact_match_p
= 0;
15268 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15269 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15270 && cursor_row_p (row
))
15271 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15273 /* As soon as we've found the exact match for point,
15274 or the first suitable row whose ends_at_zv_p flag
15275 is set, we are done. */
15277 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
15279 && w
->cursor
.hpos
>= 0
15280 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15283 struct glyph_row
*candidate
=
15284 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15286 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15287 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15290 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15291 || (INTEGERP (g
->object
)
15292 && (g
->charpos
== PT
15293 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15295 if (rv
&& (at_zv_p
|| exact_match_p
))
15297 rc
= CURSOR_MOVEMENT_SUCCESS
;
15300 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15304 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15305 || row
->continued_p
)
15306 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15307 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15308 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15309 /* If we didn't find any candidate rows, or exited the
15310 loop before all the candidates were examined, signal
15311 to the caller that this method failed. */
15312 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15314 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15315 && !row
->continued_p
))
15316 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15318 rc
= CURSOR_MOVEMENT_SUCCESS
;
15324 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15326 rc
= CURSOR_MOVEMENT_SUCCESS
;
15331 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15332 && MATRIX_ROW_START_CHARPOS (row
) == PT
15333 && cursor_row_p (row
));
15341 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15345 set_vertical_scroll_bar (struct window
*w
)
15347 ptrdiff_t start
, end
, whole
;
15349 /* Calculate the start and end positions for the current window.
15350 At some point, it would be nice to choose between scrollbars
15351 which reflect the whole buffer size, with special markers
15352 indicating narrowing, and scrollbars which reflect only the
15355 Note that mini-buffers sometimes aren't displaying any text. */
15356 if (!MINI_WINDOW_P (w
)
15357 || (w
== XWINDOW (minibuf_window
)
15358 && NILP (echo_area_buffer
[0])))
15360 struct buffer
*buf
= XBUFFER (w
->buffer
);
15361 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15362 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15363 /* I don't think this is guaranteed to be right. For the
15364 moment, we'll pretend it is. */
15365 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
15369 if (whole
< (end
- start
))
15370 whole
= end
- start
;
15373 start
= end
= whole
= 0;
15375 /* Indicate what this scroll bar ought to be displaying now. */
15376 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15377 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15378 (w
, end
- start
, whole
, start
);
15382 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15383 selected_window is redisplayed.
15385 We can return without actually redisplaying the window if
15386 fonts_changed_p. In that case, redisplay_internal will
15390 redisplay_window (Lisp_Object window
, int just_this_one_p
)
15392 struct window
*w
= XWINDOW (window
);
15393 struct frame
*f
= XFRAME (w
->frame
);
15394 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15395 struct buffer
*old
= current_buffer
;
15396 struct text_pos lpoint
, opoint
, startp
;
15397 int update_mode_line
;
15400 /* Record it now because it's overwritten. */
15401 int current_matrix_up_to_date_p
= 0;
15402 int used_current_matrix_p
= 0;
15403 /* This is less strict than current_matrix_up_to_date_p.
15404 It indicates that the buffer contents and narrowing are unchanged. */
15405 int buffer_unchanged_p
= 0;
15406 int temp_scroll_step
= 0;
15407 ptrdiff_t count
= SPECPDL_INDEX ();
15409 int centering_position
= -1;
15410 int last_line_misfit
= 0;
15411 ptrdiff_t beg_unchanged
, end_unchanged
;
15413 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15416 /* W must be a leaf window here. */
15417 eassert (!NILP (w
->buffer
));
15419 *w
->desired_matrix
->method
= 0;
15423 reconsider_clip_changes (w
, buffer
);
15425 /* Has the mode line to be updated? */
15426 update_mode_line
= (w
->update_mode_line
15427 || update_mode_lines
15428 || buffer
->clip_changed
15429 || buffer
->prevent_redisplay_optimizations_p
);
15431 if (MINI_WINDOW_P (w
))
15433 if (w
== XWINDOW (echo_area_window
)
15434 && !NILP (echo_area_buffer
[0]))
15436 if (update_mode_line
)
15437 /* We may have to update a tty frame's menu bar or a
15438 tool-bar. Example `M-x C-h C-h C-g'. */
15439 goto finish_menu_bars
;
15441 /* We've already displayed the echo area glyphs in this window. */
15442 goto finish_scroll_bars
;
15444 else if ((w
!= XWINDOW (minibuf_window
)
15445 || minibuf_level
== 0)
15446 /* When buffer is nonempty, redisplay window normally. */
15447 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
15448 /* Quail displays non-mini buffers in minibuffer window.
15449 In that case, redisplay the window normally. */
15450 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
15452 /* W is a mini-buffer window, but it's not active, so clear
15454 int yb
= window_text_bottom_y (w
);
15455 struct glyph_row
*row
;
15458 for (y
= 0, row
= w
->desired_matrix
->rows
;
15460 y
+= row
->height
, ++row
)
15461 blank_row (w
, row
, y
);
15462 goto finish_scroll_bars
;
15465 clear_glyph_matrix (w
->desired_matrix
);
15468 /* Otherwise set up data on this window; select its buffer and point
15470 /* Really select the buffer, for the sake of buffer-local
15472 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15474 current_matrix_up_to_date_p
15475 = (!NILP (w
->window_end_valid
)
15476 && !current_buffer
->clip_changed
15477 && !current_buffer
->prevent_redisplay_optimizations_p
15478 && w
->last_modified
>= MODIFF
15479 && w
->last_overlay_modified
>= OVERLAY_MODIFF
);
15481 /* Run the window-bottom-change-functions
15482 if it is possible that the text on the screen has changed
15483 (either due to modification of the text, or any other reason). */
15484 if (!current_matrix_up_to_date_p
15485 && !NILP (Vwindow_text_change_functions
))
15487 safe_run_hooks (Qwindow_text_change_functions
);
15491 beg_unchanged
= BEG_UNCHANGED
;
15492 end_unchanged
= END_UNCHANGED
;
15494 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15496 specbind (Qinhibit_point_motion_hooks
, Qt
);
15499 = (!NILP (w
->window_end_valid
)
15500 && !current_buffer
->clip_changed
15501 && w
->last_modified
>= MODIFF
15502 && w
->last_overlay_modified
>= OVERLAY_MODIFF
);
15504 /* When windows_or_buffers_changed is non-zero, we can't rely on
15505 the window end being valid, so set it to nil there. */
15506 if (windows_or_buffers_changed
)
15508 /* If window starts on a continuation line, maybe adjust the
15509 window start in case the window's width changed. */
15510 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15511 compute_window_start_on_continuation_line (w
);
15513 wset_window_end_valid (w
, Qnil
);
15516 /* Some sanity checks. */
15517 CHECK_WINDOW_END (w
);
15518 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15520 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15523 /* If %c is in mode line, update it if needed. */
15524 if (!NILP (w
->column_number_displayed
)
15525 /* This alternative quickly identifies a common case
15526 where no change is needed. */
15527 && !(PT
== w
->last_point
15528 && w
->last_modified
>= MODIFF
15529 && w
->last_overlay_modified
>= OVERLAY_MODIFF
)
15530 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
15531 update_mode_line
= 1;
15533 /* Count number of windows showing the selected buffer. An indirect
15534 buffer counts as its base buffer. */
15535 if (!just_this_one_p
)
15537 struct buffer
*current_base
, *window_base
;
15538 current_base
= current_buffer
;
15539 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
15540 if (current_base
->base_buffer
)
15541 current_base
= current_base
->base_buffer
;
15542 if (window_base
->base_buffer
)
15543 window_base
= window_base
->base_buffer
;
15544 if (current_base
== window_base
)
15548 /* Point refers normally to the selected window. For any other
15549 window, set up appropriate value. */
15550 if (!EQ (window
, selected_window
))
15552 ptrdiff_t new_pt
= XMARKER (w
->pointm
)->charpos
;
15553 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
15557 new_pt_byte
= BEGV_BYTE
;
15558 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15560 else if (new_pt
> (ZV
- 1))
15563 new_pt_byte
= ZV_BYTE
;
15564 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15567 /* We don't use SET_PT so that the point-motion hooks don't run. */
15568 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15571 /* If any of the character widths specified in the display table
15572 have changed, invalidate the width run cache. It's true that
15573 this may be a bit late to catch such changes, but the rest of
15574 redisplay goes (non-fatally) haywire when the display table is
15575 changed, so why should we worry about doing any better? */
15576 if (current_buffer
->width_run_cache
)
15578 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15580 if (! disptab_matches_widthtab
15581 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
15583 invalidate_region_cache (current_buffer
,
15584 current_buffer
->width_run_cache
,
15586 recompute_width_table (current_buffer
, disptab
);
15590 /* If window-start is screwed up, choose a new one. */
15591 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15594 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15596 /* If someone specified a new starting point but did not insist,
15597 check whether it can be used. */
15598 if (w
->optional_new_start
15599 && CHARPOS (startp
) >= BEGV
15600 && CHARPOS (startp
) <= ZV
)
15602 w
->optional_new_start
= 0;
15603 start_display (&it
, w
, startp
);
15604 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15605 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15606 if (IT_CHARPOS (it
) == PT
)
15607 w
->force_start
= 1;
15608 /* IT may overshoot PT if text at PT is invisible. */
15609 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15610 w
->force_start
= 1;
15615 /* Handle case where place to start displaying has been specified,
15616 unless the specified location is outside the accessible range. */
15617 if (w
->force_start
|| w
->frozen_window_start_p
)
15619 /* We set this later on if we have to adjust point. */
15622 w
->force_start
= 0;
15624 wset_window_end_valid (w
, Qnil
);
15626 /* Forget any recorded base line for line number display. */
15627 if (!buffer_unchanged_p
)
15628 wset_base_line_number (w
, Qnil
);
15630 /* Redisplay the mode line. Select the buffer properly for that.
15631 Also, run the hook window-scroll-functions
15632 because we have scrolled. */
15633 /* Note, we do this after clearing force_start because
15634 if there's an error, it is better to forget about force_start
15635 than to get into an infinite loop calling the hook functions
15636 and having them get more errors. */
15637 if (!update_mode_line
15638 || ! NILP (Vwindow_scroll_functions
))
15640 update_mode_line
= 1;
15641 w
->update_mode_line
= 1;
15642 startp
= run_window_scroll_functions (window
, startp
);
15645 w
->last_modified
= 0;
15646 w
->last_overlay_modified
= 0;
15647 if (CHARPOS (startp
) < BEGV
)
15648 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15649 else if (CHARPOS (startp
) > ZV
)
15650 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15652 /* Redisplay, then check if cursor has been set during the
15653 redisplay. Give up if new fonts were loaded. */
15654 /* We used to issue a CHECK_MARGINS argument to try_window here,
15655 but this causes scrolling to fail when point begins inside
15656 the scroll margin (bug#148) -- cyd */
15657 if (!try_window (window
, startp
, 0))
15659 w
->force_start
= 1;
15660 clear_glyph_matrix (w
->desired_matrix
);
15661 goto need_larger_matrices
;
15664 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15666 /* If point does not appear, try to move point so it does
15667 appear. The desired matrix has been built above, so we
15668 can use it here. */
15669 new_vpos
= window_box_height (w
) / 2;
15672 if (!cursor_row_fully_visible_p (w
, 0, 0))
15674 /* Point does appear, but on a line partly visible at end of window.
15675 Move it back to a fully-visible line. */
15676 new_vpos
= window_box_height (w
);
15679 /* If we need to move point for either of the above reasons,
15680 now actually do it. */
15683 struct glyph_row
*row
;
15685 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15686 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15689 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15690 MATRIX_ROW_START_BYTEPOS (row
));
15692 if (w
!= XWINDOW (selected_window
))
15693 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15694 else if (current_buffer
== old
)
15695 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15697 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15699 /* If we are highlighting the region, then we just changed
15700 the region, so redisplay to show it. */
15701 if (!NILP (Vtransient_mark_mode
)
15702 && !NILP (BVAR (current_buffer
, mark_active
)))
15704 clear_glyph_matrix (w
->desired_matrix
);
15705 if (!try_window (window
, startp
, 0))
15706 goto need_larger_matrices
;
15711 debug_method_add (w
, "forced window start");
15716 /* Handle case where text has not changed, only point, and it has
15717 not moved off the frame, and we are not retrying after hscroll.
15718 (current_matrix_up_to_date_p is nonzero when retrying.) */
15719 if (current_matrix_up_to_date_p
15720 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15721 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15725 case CURSOR_MOVEMENT_SUCCESS
:
15726 used_current_matrix_p
= 1;
15729 case CURSOR_MOVEMENT_MUST_SCROLL
:
15730 goto try_to_scroll
;
15736 /* If current starting point was originally the beginning of a line
15737 but no longer is, find a new starting point. */
15738 else if (w
->start_at_line_beg
15739 && !(CHARPOS (startp
) <= BEGV
15740 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15743 debug_method_add (w
, "recenter 1");
15748 /* Try scrolling with try_window_id. Value is > 0 if update has
15749 been done, it is -1 if we know that the same window start will
15750 not work. It is 0 if unsuccessful for some other reason. */
15751 else if ((tem
= try_window_id (w
)) != 0)
15754 debug_method_add (w
, "try_window_id %d", tem
);
15757 if (fonts_changed_p
)
15758 goto need_larger_matrices
;
15762 /* Otherwise try_window_id has returned -1 which means that we
15763 don't want the alternative below this comment to execute. */
15765 else if (CHARPOS (startp
) >= BEGV
15766 && CHARPOS (startp
) <= ZV
15767 && PT
>= CHARPOS (startp
)
15768 && (CHARPOS (startp
) < ZV
15769 /* Avoid starting at end of buffer. */
15770 || CHARPOS (startp
) == BEGV
15771 || (w
->last_modified
>= MODIFF
15772 && w
->last_overlay_modified
>= OVERLAY_MODIFF
)))
15774 int d1
, d2
, d3
, d4
, d5
, d6
;
15776 /* If first window line is a continuation line, and window start
15777 is inside the modified region, but the first change is before
15778 current window start, we must select a new window start.
15780 However, if this is the result of a down-mouse event (e.g. by
15781 extending the mouse-drag-overlay), we don't want to select a
15782 new window start, since that would change the position under
15783 the mouse, resulting in an unwanted mouse-movement rather
15784 than a simple mouse-click. */
15785 if (!w
->start_at_line_beg
15786 && NILP (do_mouse_tracking
)
15787 && CHARPOS (startp
) > BEGV
15788 && CHARPOS (startp
) > BEG
+ beg_unchanged
15789 && CHARPOS (startp
) <= Z
- end_unchanged
15790 /* Even if w->start_at_line_beg is nil, a new window may
15791 start at a line_beg, since that's how set_buffer_window
15792 sets it. So, we need to check the return value of
15793 compute_window_start_on_continuation_line. (See also
15795 && XMARKER (w
->start
)->buffer
== current_buffer
15796 && compute_window_start_on_continuation_line (w
)
15797 /* It doesn't make sense to force the window start like we
15798 do at label force_start if it is already known that point
15799 will not be visible in the resulting window, because
15800 doing so will move point from its correct position
15801 instead of scrolling the window to bring point into view.
15803 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15805 w
->force_start
= 1;
15806 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15811 debug_method_add (w
, "same window start");
15814 /* Try to redisplay starting at same place as before.
15815 If point has not moved off frame, accept the results. */
15816 if (!current_matrix_up_to_date_p
15817 /* Don't use try_window_reusing_current_matrix in this case
15818 because a window scroll function can have changed the
15820 || !NILP (Vwindow_scroll_functions
)
15821 || MINI_WINDOW_P (w
)
15822 || !(used_current_matrix_p
15823 = try_window_reusing_current_matrix (w
)))
15825 IF_DEBUG (debug_method_add (w
, "1"));
15826 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15827 /* -1 means we need to scroll.
15828 0 means we need new matrices, but fonts_changed_p
15829 is set in that case, so we will detect it below. */
15830 goto try_to_scroll
;
15833 if (fonts_changed_p
)
15834 goto need_larger_matrices
;
15836 if (w
->cursor
.vpos
>= 0)
15838 if (!just_this_one_p
15839 || current_buffer
->clip_changed
15840 || BEG_UNCHANGED
< CHARPOS (startp
))
15841 /* Forget any recorded base line for line number display. */
15842 wset_base_line_number (w
, Qnil
);
15844 if (!cursor_row_fully_visible_p (w
, 1, 0))
15846 clear_glyph_matrix (w
->desired_matrix
);
15847 last_line_misfit
= 1;
15849 /* Drop through and scroll. */
15854 clear_glyph_matrix (w
->desired_matrix
);
15859 w
->last_modified
= 0;
15860 w
->last_overlay_modified
= 0;
15862 /* Redisplay the mode line. Select the buffer properly for that. */
15863 if (!update_mode_line
)
15865 update_mode_line
= 1;
15866 w
->update_mode_line
= 1;
15869 /* Try to scroll by specified few lines. */
15870 if ((scroll_conservatively
15871 || emacs_scroll_step
15872 || temp_scroll_step
15873 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15874 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15875 && CHARPOS (startp
) >= BEGV
15876 && CHARPOS (startp
) <= ZV
)
15878 /* The function returns -1 if new fonts were loaded, 1 if
15879 successful, 0 if not successful. */
15880 int ss
= try_scrolling (window
, just_this_one_p
,
15881 scroll_conservatively
,
15883 temp_scroll_step
, last_line_misfit
);
15886 case SCROLLING_SUCCESS
:
15889 case SCROLLING_NEED_LARGER_MATRICES
:
15890 goto need_larger_matrices
;
15892 case SCROLLING_FAILED
:
15900 /* Finally, just choose a place to start which positions point
15901 according to user preferences. */
15906 debug_method_add (w
, "recenter");
15909 /* w->vscroll = 0; */
15911 /* Forget any previously recorded base line for line number display. */
15912 if (!buffer_unchanged_p
)
15913 wset_base_line_number (w
, Qnil
);
15915 /* Determine the window start relative to point. */
15916 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15917 it
.current_y
= it
.last_visible_y
;
15918 if (centering_position
< 0)
15922 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15924 ptrdiff_t margin_pos
= CHARPOS (startp
);
15925 Lisp_Object aggressive
;
15928 /* If there is a scroll margin at the top of the window, find
15929 its character position. */
15931 /* Cannot call start_display if startp is not in the
15932 accessible region of the buffer. This can happen when we
15933 have just switched to a different buffer and/or changed
15934 its restriction. In that case, startp is initialized to
15935 the character position 1 (BEGV) because we did not yet
15936 have chance to display the buffer even once. */
15937 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15940 void *it1data
= NULL
;
15942 SAVE_IT (it1
, it
, it1data
);
15943 start_display (&it1
, w
, startp
);
15944 move_it_vertically (&it1
, margin
* FRAME_LINE_HEIGHT (f
));
15945 margin_pos
= IT_CHARPOS (it1
);
15946 RESTORE_IT (&it
, &it
, it1data
);
15948 scrolling_up
= PT
> margin_pos
;
15951 ? BVAR (current_buffer
, scroll_up_aggressively
)
15952 : BVAR (current_buffer
, scroll_down_aggressively
);
15954 if (!MINI_WINDOW_P (w
)
15955 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15959 /* Setting scroll-conservatively overrides
15960 scroll-*-aggressively. */
15961 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15963 double float_amount
= XFLOATINT (aggressive
);
15965 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15966 if (pt_offset
== 0 && float_amount
> 0)
15968 if (pt_offset
&& margin
> 0)
15971 /* Compute how much to move the window start backward from
15972 point so that point will be displayed where the user
15976 centering_position
= it
.last_visible_y
;
15978 centering_position
-= pt_offset
;
15979 centering_position
-=
15980 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15981 + WINDOW_HEADER_LINE_HEIGHT (w
);
15982 /* Don't let point enter the scroll margin near top of
15984 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15985 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15988 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15991 /* Set the window start half the height of the window backward
15993 centering_position
= window_box_height (w
) / 2;
15995 move_it_vertically_backward (&it
, centering_position
);
15997 eassert (IT_CHARPOS (it
) >= BEGV
);
15999 /* The function move_it_vertically_backward may move over more
16000 than the specified y-distance. If it->w is small, e.g. a
16001 mini-buffer window, we may end up in front of the window's
16002 display area. Start displaying at the start of the line
16003 containing PT in this case. */
16004 if (it
.current_y
<= 0)
16006 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16007 move_it_vertically_backward (&it
, 0);
16011 it
.current_x
= it
.hpos
= 0;
16013 /* Set the window start position here explicitly, to avoid an
16014 infinite loop in case the functions in window-scroll-functions
16016 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16018 /* Run scroll hooks. */
16019 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16021 /* Redisplay the window. */
16022 if (!current_matrix_up_to_date_p
16023 || windows_or_buffers_changed
16024 || cursor_type_changed
16025 /* Don't use try_window_reusing_current_matrix in this case
16026 because it can have changed the buffer. */
16027 || !NILP (Vwindow_scroll_functions
)
16028 || !just_this_one_p
16029 || MINI_WINDOW_P (w
)
16030 || !(used_current_matrix_p
16031 = try_window_reusing_current_matrix (w
)))
16032 try_window (window
, startp
, 0);
16034 /* If new fonts have been loaded (due to fontsets), give up. We
16035 have to start a new redisplay since we need to re-adjust glyph
16037 if (fonts_changed_p
)
16038 goto need_larger_matrices
;
16040 /* If cursor did not appear assume that the middle of the window is
16041 in the first line of the window. Do it again with the next line.
16042 (Imagine a window of height 100, displaying two lines of height
16043 60. Moving back 50 from it->last_visible_y will end in the first
16045 if (w
->cursor
.vpos
< 0)
16047 if (!NILP (w
->window_end_valid
)
16048 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
16050 clear_glyph_matrix (w
->desired_matrix
);
16051 move_it_by_lines (&it
, 1);
16052 try_window (window
, it
.current
.pos
, 0);
16054 else if (PT
< IT_CHARPOS (it
))
16056 clear_glyph_matrix (w
->desired_matrix
);
16057 move_it_by_lines (&it
, -1);
16058 try_window (window
, it
.current
.pos
, 0);
16062 /* Not much we can do about it. */
16066 /* Consider the following case: Window starts at BEGV, there is
16067 invisible, intangible text at BEGV, so that display starts at
16068 some point START > BEGV. It can happen that we are called with
16069 PT somewhere between BEGV and START. Try to handle that case. */
16070 if (w
->cursor
.vpos
< 0)
16072 struct glyph_row
*row
= w
->current_matrix
->rows
;
16073 if (row
->mode_line_p
)
16075 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16078 if (!cursor_row_fully_visible_p (w
, 0, 0))
16080 /* If vscroll is enabled, disable it and try again. */
16084 clear_glyph_matrix (w
->desired_matrix
);
16088 /* Users who set scroll-conservatively to a large number want
16089 point just above/below the scroll margin. If we ended up
16090 with point's row partially visible, move the window start to
16091 make that row fully visible and out of the margin. */
16092 if (scroll_conservatively
> SCROLL_LIMIT
)
16096 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
16098 int move_down
= w
->cursor
.vpos
>= WINDOW_TOTAL_LINES (w
) / 2;
16100 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16101 clear_glyph_matrix (w
->desired_matrix
);
16102 if (1 == try_window (window
, it
.current
.pos
,
16103 TRY_WINDOW_CHECK_MARGINS
))
16107 /* If centering point failed to make the whole line visible,
16108 put point at the top instead. That has to make the whole line
16109 visible, if it can be done. */
16110 if (centering_position
== 0)
16113 clear_glyph_matrix (w
->desired_matrix
);
16114 centering_position
= 0;
16120 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16121 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16122 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16124 /* Display the mode line, if we must. */
16125 if ((update_mode_line
16126 /* If window not full width, must redo its mode line
16127 if (a) the window to its side is being redone and
16128 (b) we do a frame-based redisplay. This is a consequence
16129 of how inverted lines are drawn in frame-based redisplay. */
16130 || (!just_this_one_p
16131 && !FRAME_WINDOW_P (f
)
16132 && !WINDOW_FULL_WIDTH_P (w
))
16133 /* Line number to display. */
16134 || INTEGERP (w
->base_line_pos
)
16135 /* Column number is displayed and different from the one displayed. */
16136 || (!NILP (w
->column_number_displayed
)
16137 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
16138 /* This means that the window has a mode line. */
16139 && (WINDOW_WANTS_MODELINE_P (w
)
16140 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16142 display_mode_lines (w
);
16144 /* If mode line height has changed, arrange for a thorough
16145 immediate redisplay using the correct mode line height. */
16146 if (WINDOW_WANTS_MODELINE_P (w
)
16147 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16149 fonts_changed_p
= 1;
16150 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16151 = DESIRED_MODE_LINE_HEIGHT (w
);
16154 /* If header line height has changed, arrange for a thorough
16155 immediate redisplay using the correct header line height. */
16156 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16157 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16159 fonts_changed_p
= 1;
16160 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16161 = DESIRED_HEADER_LINE_HEIGHT (w
);
16164 if (fonts_changed_p
)
16165 goto need_larger_matrices
;
16168 if (!line_number_displayed
16169 && !BUFFERP (w
->base_line_pos
))
16171 wset_base_line_pos (w
, Qnil
);
16172 wset_base_line_number (w
, Qnil
);
16177 /* When we reach a frame's selected window, redo the frame's menu bar. */
16178 if (update_mode_line
16179 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16181 int redisplay_menu_p
= 0;
16183 if (FRAME_WINDOW_P (f
))
16185 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16186 || defined (HAVE_NS) || defined (USE_GTK)
16187 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16189 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16193 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16195 if (redisplay_menu_p
)
16196 display_menu_bar (w
);
16198 #ifdef HAVE_WINDOW_SYSTEM
16199 if (FRAME_WINDOW_P (f
))
16201 #if defined (USE_GTK) || defined (HAVE_NS)
16202 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16203 redisplay_tool_bar (f
);
16205 if (WINDOWP (f
->tool_bar_window
)
16206 && (FRAME_TOOL_BAR_LINES (f
) > 0
16207 || !NILP (Vauto_resize_tool_bars
))
16208 && redisplay_tool_bar (f
))
16209 ignore_mouse_drag_p
= 1;
16215 #ifdef HAVE_WINDOW_SYSTEM
16216 if (FRAME_WINDOW_P (f
)
16217 && update_window_fringes (w
, (just_this_one_p
16218 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16219 || w
->pseudo_window_p
)))
16223 if (draw_window_fringes (w
, 1))
16224 x_draw_vertical_border (w
);
16228 #endif /* HAVE_WINDOW_SYSTEM */
16230 /* We go to this label, with fonts_changed_p set,
16231 if it is necessary to try again using larger glyph matrices.
16232 We have to redeem the scroll bar even in this case,
16233 because the loop in redisplay_internal expects that. */
16234 need_larger_matrices
:
16236 finish_scroll_bars
:
16238 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16240 /* Set the thumb's position and size. */
16241 set_vertical_scroll_bar (w
);
16243 /* Note that we actually used the scroll bar attached to this
16244 window, so it shouldn't be deleted at the end of redisplay. */
16245 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16246 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16249 /* Restore current_buffer and value of point in it. The window
16250 update may have changed the buffer, so first make sure `opoint'
16251 is still valid (Bug#6177). */
16252 if (CHARPOS (opoint
) < BEGV
)
16253 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16254 else if (CHARPOS (opoint
) > ZV
)
16255 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16257 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16259 set_buffer_internal_1 (old
);
16260 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16261 shorter. This can be caused by log truncation in *Messages*. */
16262 if (CHARPOS (lpoint
) <= ZV
)
16263 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16265 unbind_to (count
, Qnil
);
16269 /* Build the complete desired matrix of WINDOW with a window start
16270 buffer position POS.
16272 Value is 1 if successful. It is zero if fonts were loaded during
16273 redisplay which makes re-adjusting glyph matrices necessary, and -1
16274 if point would appear in the scroll margins.
16275 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16276 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16280 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16282 struct window
*w
= XWINDOW (window
);
16284 struct glyph_row
*last_text_row
= NULL
;
16285 struct frame
*f
= XFRAME (w
->frame
);
16287 /* Make POS the new window start. */
16288 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16290 /* Mark cursor position as unknown. No overlay arrow seen. */
16291 w
->cursor
.vpos
= -1;
16292 overlay_arrow_seen
= 0;
16294 /* Initialize iterator and info to start at POS. */
16295 start_display (&it
, w
, pos
);
16297 /* Display all lines of W. */
16298 while (it
.current_y
< it
.last_visible_y
)
16300 if (display_line (&it
))
16301 last_text_row
= it
.glyph_row
- 1;
16302 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16306 /* Don't let the cursor end in the scroll margins. */
16307 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16308 && !MINI_WINDOW_P (w
))
16310 int this_scroll_margin
;
16312 if (scroll_margin
> 0)
16314 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16315 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
16318 this_scroll_margin
= 0;
16320 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16321 && w
->cursor
.y
< this_scroll_margin
16322 && CHARPOS (pos
) > BEGV
16323 && IT_CHARPOS (it
) < ZV
)
16324 /* rms: considering make_cursor_line_fully_visible_p here
16325 seems to give wrong results. We don't want to recenter
16326 when the last line is partly visible, we want to allow
16327 that case to be handled in the usual way. */
16328 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16330 w
->cursor
.vpos
= -1;
16331 clear_glyph_matrix (w
->desired_matrix
);
16336 /* If bottom moved off end of frame, change mode line percentage. */
16337 if (XFASTINT (w
->window_end_pos
) <= 0
16338 && Z
!= IT_CHARPOS (it
))
16339 w
->update_mode_line
= 1;
16341 /* Set window_end_pos to the offset of the last character displayed
16342 on the window from the end of current_buffer. Set
16343 window_end_vpos to its row number. */
16346 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16347 w
->window_end_bytepos
16348 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16349 wset_window_end_pos
16350 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16351 wset_window_end_vpos
16352 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
)));
16354 (MATRIX_ROW (w
->desired_matrix
,
16355 XFASTINT (w
->window_end_vpos
))->displays_text_p
);
16359 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16360 wset_window_end_pos (w
, make_number (Z
- ZV
));
16361 wset_window_end_vpos (w
, make_number (0));
16364 /* But that is not valid info until redisplay finishes. */
16365 wset_window_end_valid (w
, Qnil
);
16371 /************************************************************************
16372 Window redisplay reusing current matrix when buffer has not changed
16373 ************************************************************************/
16375 /* Try redisplay of window W showing an unchanged buffer with a
16376 different window start than the last time it was displayed by
16377 reusing its current matrix. Value is non-zero if successful.
16378 W->start is the new window start. */
16381 try_window_reusing_current_matrix (struct window
*w
)
16383 struct frame
*f
= XFRAME (w
->frame
);
16384 struct glyph_row
*bottom_row
;
16387 struct text_pos start
, new_start
;
16388 int nrows_scrolled
, i
;
16389 struct glyph_row
*last_text_row
;
16390 struct glyph_row
*last_reused_text_row
;
16391 struct glyph_row
*start_row
;
16392 int start_vpos
, min_y
, max_y
;
16395 if (inhibit_try_window_reusing
)
16399 if (/* This function doesn't handle terminal frames. */
16400 !FRAME_WINDOW_P (f
)
16401 /* Don't try to reuse the display if windows have been split
16403 || windows_or_buffers_changed
16404 || cursor_type_changed
)
16407 /* Can't do this if region may have changed. */
16408 if ((!NILP (Vtransient_mark_mode
)
16409 && !NILP (BVAR (current_buffer
, mark_active
)))
16410 || !NILP (w
->region_showing
)
16411 || !NILP (Vshow_trailing_whitespace
))
16414 /* If top-line visibility has changed, give up. */
16415 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16416 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16419 /* Give up if old or new display is scrolled vertically. We could
16420 make this function handle this, but right now it doesn't. */
16421 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16422 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16425 /* The variable new_start now holds the new window start. The old
16426 start `start' can be determined from the current matrix. */
16427 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16428 start
= start_row
->minpos
;
16429 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16431 /* Clear the desired matrix for the display below. */
16432 clear_glyph_matrix (w
->desired_matrix
);
16434 if (CHARPOS (new_start
) <= CHARPOS (start
))
16436 /* Don't use this method if the display starts with an ellipsis
16437 displayed for invisible text. It's not easy to handle that case
16438 below, and it's certainly not worth the effort since this is
16439 not a frequent case. */
16440 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16443 IF_DEBUG (debug_method_add (w
, "twu1"));
16445 /* Display up to a row that can be reused. The variable
16446 last_text_row is set to the last row displayed that displays
16447 text. Note that it.vpos == 0 if or if not there is a
16448 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16449 start_display (&it
, w
, new_start
);
16450 w
->cursor
.vpos
= -1;
16451 last_text_row
= last_reused_text_row
= NULL
;
16453 while (it
.current_y
< it
.last_visible_y
16454 && !fonts_changed_p
)
16456 /* If we have reached into the characters in the START row,
16457 that means the line boundaries have changed. So we
16458 can't start copying with the row START. Maybe it will
16459 work to start copying with the following row. */
16460 while (IT_CHARPOS (it
) > CHARPOS (start
))
16462 /* Advance to the next row as the "start". */
16464 start
= start_row
->minpos
;
16465 /* If there are no more rows to try, or just one, give up. */
16466 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16467 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16468 || CHARPOS (start
) == ZV
)
16470 clear_glyph_matrix (w
->desired_matrix
);
16474 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16476 /* If we have reached alignment, we can copy the rest of the
16478 if (IT_CHARPOS (it
) == CHARPOS (start
)
16479 /* Don't accept "alignment" inside a display vector,
16480 since start_row could have started in the middle of
16481 that same display vector (thus their character
16482 positions match), and we have no way of telling if
16483 that is the case. */
16484 && it
.current
.dpvec_index
< 0)
16487 if (display_line (&it
))
16488 last_text_row
= it
.glyph_row
- 1;
16492 /* A value of current_y < last_visible_y means that we stopped
16493 at the previous window start, which in turn means that we
16494 have at least one reusable row. */
16495 if (it
.current_y
< it
.last_visible_y
)
16497 struct glyph_row
*row
;
16499 /* IT.vpos always starts from 0; it counts text lines. */
16500 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16502 /* Find PT if not already found in the lines displayed. */
16503 if (w
->cursor
.vpos
< 0)
16505 int dy
= it
.current_y
- start_row
->y
;
16507 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16508 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16510 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16511 dy
, nrows_scrolled
);
16514 clear_glyph_matrix (w
->desired_matrix
);
16519 /* Scroll the display. Do it before the current matrix is
16520 changed. The problem here is that update has not yet
16521 run, i.e. part of the current matrix is not up to date.
16522 scroll_run_hook will clear the cursor, and use the
16523 current matrix to get the height of the row the cursor is
16525 run
.current_y
= start_row
->y
;
16526 run
.desired_y
= it
.current_y
;
16527 run
.height
= it
.last_visible_y
- it
.current_y
;
16529 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16532 FRAME_RIF (f
)->update_window_begin_hook (w
);
16533 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16534 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16535 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16539 /* Shift current matrix down by nrows_scrolled lines. */
16540 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16541 rotate_matrix (w
->current_matrix
,
16543 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16546 /* Disable lines that must be updated. */
16547 for (i
= 0; i
< nrows_scrolled
; ++i
)
16548 (start_row
+ i
)->enabled_p
= 0;
16550 /* Re-compute Y positions. */
16551 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16552 max_y
= it
.last_visible_y
;
16553 for (row
= start_row
+ nrows_scrolled
;
16557 row
->y
= it
.current_y
;
16558 row
->visible_height
= row
->height
;
16560 if (row
->y
< min_y
)
16561 row
->visible_height
-= min_y
- row
->y
;
16562 if (row
->y
+ row
->height
> max_y
)
16563 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16564 if (row
->fringe_bitmap_periodic_p
)
16565 row
->redraw_fringe_bitmaps_p
= 1;
16567 it
.current_y
+= row
->height
;
16569 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16570 last_reused_text_row
= row
;
16571 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16575 /* Disable lines in the current matrix which are now
16576 below the window. */
16577 for (++row
; row
< bottom_row
; ++row
)
16578 row
->enabled_p
= row
->mode_line_p
= 0;
16581 /* Update window_end_pos etc.; last_reused_text_row is the last
16582 reused row from the current matrix containing text, if any.
16583 The value of last_text_row is the last displayed line
16584 containing text. */
16585 if (last_reused_text_row
)
16587 w
->window_end_bytepos
16588 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
16589 wset_window_end_pos
16591 - MATRIX_ROW_END_CHARPOS (last_reused_text_row
)));
16592 wset_window_end_vpos
16593 (w
, make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
16594 w
->current_matrix
)));
16596 else if (last_text_row
)
16598 w
->window_end_bytepos
16599 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16600 wset_window_end_pos
16601 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16602 wset_window_end_vpos
16603 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
,
16604 w
->desired_matrix
)));
16608 /* This window must be completely empty. */
16609 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16610 wset_window_end_pos (w
, make_number (Z
- ZV
));
16611 wset_window_end_vpos (w
, make_number (0));
16613 wset_window_end_valid (w
, Qnil
);
16615 /* Update hint: don't try scrolling again in update_window. */
16616 w
->desired_matrix
->no_scrolling_p
= 1;
16619 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16623 else if (CHARPOS (new_start
) > CHARPOS (start
))
16625 struct glyph_row
*pt_row
, *row
;
16626 struct glyph_row
*first_reusable_row
;
16627 struct glyph_row
*first_row_to_display
;
16629 int yb
= window_text_bottom_y (w
);
16631 /* Find the row starting at new_start, if there is one. Don't
16632 reuse a partially visible line at the end. */
16633 first_reusable_row
= start_row
;
16634 while (first_reusable_row
->enabled_p
16635 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16636 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16637 < CHARPOS (new_start
)))
16638 ++first_reusable_row
;
16640 /* Give up if there is no row to reuse. */
16641 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16642 || !first_reusable_row
->enabled_p
16643 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16644 != CHARPOS (new_start
)))
16647 /* We can reuse fully visible rows beginning with
16648 first_reusable_row to the end of the window. Set
16649 first_row_to_display to the first row that cannot be reused.
16650 Set pt_row to the row containing point, if there is any. */
16652 for (first_row_to_display
= first_reusable_row
;
16653 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16654 ++first_row_to_display
)
16656 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16657 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16658 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16659 && first_row_to_display
->ends_at_zv_p
16660 && pt_row
== NULL
)))
16661 pt_row
= first_row_to_display
;
16664 /* Start displaying at the start of first_row_to_display. */
16665 eassert (first_row_to_display
->y
< yb
);
16666 init_to_row_start (&it
, w
, first_row_to_display
);
16668 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16670 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16672 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16673 + WINDOW_HEADER_LINE_HEIGHT (w
));
16675 /* Display lines beginning with first_row_to_display in the
16676 desired matrix. Set last_text_row to the last row displayed
16677 that displays text. */
16678 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16679 if (pt_row
== NULL
)
16680 w
->cursor
.vpos
= -1;
16681 last_text_row
= NULL
;
16682 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16683 if (display_line (&it
))
16684 last_text_row
= it
.glyph_row
- 1;
16686 /* If point is in a reused row, adjust y and vpos of the cursor
16690 w
->cursor
.vpos
-= nrows_scrolled
;
16691 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16694 /* Give up if point isn't in a row displayed or reused. (This
16695 also handles the case where w->cursor.vpos < nrows_scrolled
16696 after the calls to display_line, which can happen with scroll
16697 margins. See bug#1295.) */
16698 if (w
->cursor
.vpos
< 0)
16700 clear_glyph_matrix (w
->desired_matrix
);
16704 /* Scroll the display. */
16705 run
.current_y
= first_reusable_row
->y
;
16706 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16707 run
.height
= it
.last_visible_y
- run
.current_y
;
16708 dy
= run
.current_y
- run
.desired_y
;
16713 FRAME_RIF (f
)->update_window_begin_hook (w
);
16714 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16715 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16716 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16720 /* Adjust Y positions of reused rows. */
16721 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16722 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16723 max_y
= it
.last_visible_y
;
16724 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16727 row
->visible_height
= row
->height
;
16728 if (row
->y
< min_y
)
16729 row
->visible_height
-= min_y
- row
->y
;
16730 if (row
->y
+ row
->height
> max_y
)
16731 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16732 if (row
->fringe_bitmap_periodic_p
)
16733 row
->redraw_fringe_bitmaps_p
= 1;
16736 /* Scroll the current matrix. */
16737 eassert (nrows_scrolled
> 0);
16738 rotate_matrix (w
->current_matrix
,
16740 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16743 /* Disable rows not reused. */
16744 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16745 row
->enabled_p
= 0;
16747 /* Point may have moved to a different line, so we cannot assume that
16748 the previous cursor position is valid; locate the correct row. */
16751 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16753 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
16754 && !row
->ends_at_zv_p
;
16758 w
->cursor
.y
= row
->y
;
16760 if (row
< bottom_row
)
16762 /* Can't simply scan the row for point with
16763 bidi-reordered glyph rows. Let set_cursor_from_row
16764 figure out where to put the cursor, and if it fails,
16766 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16768 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
16771 clear_glyph_matrix (w
->desired_matrix
);
16777 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16778 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16781 && (!BUFFERP (glyph
->object
)
16782 || glyph
->charpos
< PT
);
16786 w
->cursor
.x
+= glyph
->pixel_width
;
16792 /* Adjust window end. A null value of last_text_row means that
16793 the window end is in reused rows which in turn means that
16794 only its vpos can have changed. */
16797 w
->window_end_bytepos
16798 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16799 wset_window_end_pos
16800 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
16801 wset_window_end_vpos
16802 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
,
16803 w
->desired_matrix
)));
16807 wset_window_end_vpos
16808 (w
, make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
));
16811 wset_window_end_valid (w
, Qnil
);
16812 w
->desired_matrix
->no_scrolling_p
= 1;
16815 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16825 /************************************************************************
16826 Window redisplay reusing current matrix when buffer has changed
16827 ************************************************************************/
16829 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16830 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16831 ptrdiff_t *, ptrdiff_t *);
16832 static struct glyph_row
*
16833 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16834 struct glyph_row
*);
16837 /* Return the last row in MATRIX displaying text. If row START is
16838 non-null, start searching with that row. IT gives the dimensions
16839 of the display. Value is null if matrix is empty; otherwise it is
16840 a pointer to the row found. */
16842 static struct glyph_row
*
16843 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16844 struct glyph_row
*start
)
16846 struct glyph_row
*row
, *row_found
;
16848 /* Set row_found to the last row in IT->w's current matrix
16849 displaying text. The loop looks funny but think of partially
16852 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16853 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16855 eassert (row
->enabled_p
);
16857 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16866 /* Return the last row in the current matrix of W that is not affected
16867 by changes at the start of current_buffer that occurred since W's
16868 current matrix was built. Value is null if no such row exists.
16870 BEG_UNCHANGED us the number of characters unchanged at the start of
16871 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16872 first changed character in current_buffer. Characters at positions <
16873 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16874 when the current matrix was built. */
16876 static struct glyph_row
*
16877 find_last_unchanged_at_beg_row (struct window
*w
)
16879 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16880 struct glyph_row
*row
;
16881 struct glyph_row
*row_found
= NULL
;
16882 int yb
= window_text_bottom_y (w
);
16884 /* Find the last row displaying unchanged text. */
16885 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16886 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16887 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16890 if (/* If row ends before first_changed_pos, it is unchanged,
16891 except in some case. */
16892 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16893 /* When row ends in ZV and we write at ZV it is not
16895 && !row
->ends_at_zv_p
16896 /* When first_changed_pos is the end of a continued line,
16897 row is not unchanged because it may be no longer
16899 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16900 && (row
->continued_p
16901 || row
->exact_window_width_line_p
))
16902 /* If ROW->end is beyond ZV, then ROW->end is outdated and
16903 needs to be recomputed, so don't consider this row as
16904 unchanged. This happens when the last line was
16905 bidi-reordered and was killed immediately before this
16906 redisplay cycle. In that case, ROW->end stores the
16907 buffer position of the first visual-order character of
16908 the killed text, which is now beyond ZV. */
16909 && CHARPOS (row
->end
.pos
) <= ZV
)
16912 /* Stop if last visible row. */
16913 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16921 /* Find the first glyph row in the current matrix of W that is not
16922 affected by changes at the end of current_buffer since the
16923 time W's current matrix was built.
16925 Return in *DELTA the number of chars by which buffer positions in
16926 unchanged text at the end of current_buffer must be adjusted.
16928 Return in *DELTA_BYTES the corresponding number of bytes.
16930 Value is null if no such row exists, i.e. all rows are affected by
16933 static struct glyph_row
*
16934 find_first_unchanged_at_end_row (struct window
*w
,
16935 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
16937 struct glyph_row
*row
;
16938 struct glyph_row
*row_found
= NULL
;
16940 *delta
= *delta_bytes
= 0;
16942 /* Display must not have been paused, otherwise the current matrix
16943 is not up to date. */
16944 eassert (!NILP (w
->window_end_valid
));
16946 /* A value of window_end_pos >= END_UNCHANGED means that the window
16947 end is in the range of changed text. If so, there is no
16948 unchanged row at the end of W's current matrix. */
16949 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16952 /* Set row to the last row in W's current matrix displaying text. */
16953 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16955 /* If matrix is entirely empty, no unchanged row exists. */
16956 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16958 /* The value of row is the last glyph row in the matrix having a
16959 meaningful buffer position in it. The end position of row
16960 corresponds to window_end_pos. This allows us to translate
16961 buffer positions in the current matrix to current buffer
16962 positions for characters not in changed text. */
16964 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16965 ptrdiff_t Z_BYTE_old
=
16966 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16967 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
16968 struct glyph_row
*first_text_row
16969 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16971 *delta
= Z
- Z_old
;
16972 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16974 /* Set last_unchanged_pos to the buffer position of the last
16975 character in the buffer that has not been changed. Z is the
16976 index + 1 of the last character in current_buffer, i.e. by
16977 subtracting END_UNCHANGED we get the index of the last
16978 unchanged character, and we have to add BEG to get its buffer
16980 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16981 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16983 /* Search backward from ROW for a row displaying a line that
16984 starts at a minimum position >= last_unchanged_pos_old. */
16985 for (; row
> first_text_row
; --row
)
16987 /* This used to abort, but it can happen.
16988 It is ok to just stop the search instead here. KFS. */
16989 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16992 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16997 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17003 /* Make sure that glyph rows in the current matrix of window W
17004 reference the same glyph memory as corresponding rows in the
17005 frame's frame matrix. This function is called after scrolling W's
17006 current matrix on a terminal frame in try_window_id and
17007 try_window_reusing_current_matrix. */
17010 sync_frame_with_window_matrix_rows (struct window
*w
)
17012 struct frame
*f
= XFRAME (w
->frame
);
17013 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17015 /* Preconditions: W must be a leaf window and full-width. Its frame
17016 must have a frame matrix. */
17017 eassert (NILP (w
->hchild
) && NILP (w
->vchild
));
17018 eassert (WINDOW_FULL_WIDTH_P (w
));
17019 eassert (!FRAME_WINDOW_P (f
));
17021 /* If W is a full-width window, glyph pointers in W's current matrix
17022 have, by definition, to be the same as glyph pointers in the
17023 corresponding frame matrix. Note that frame matrices have no
17024 marginal areas (see build_frame_matrix). */
17025 window_row
= w
->current_matrix
->rows
;
17026 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17027 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17028 while (window_row
< window_row_end
)
17030 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17031 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17033 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17034 frame_row
->glyphs
[TEXT_AREA
] = start
;
17035 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17036 frame_row
->glyphs
[LAST_AREA
] = end
;
17038 /* Disable frame rows whose corresponding window rows have
17039 been disabled in try_window_id. */
17040 if (!window_row
->enabled_p
)
17041 frame_row
->enabled_p
= 0;
17043 ++window_row
, ++frame_row
;
17048 /* Find the glyph row in window W containing CHARPOS. Consider all
17049 rows between START and END (not inclusive). END null means search
17050 all rows to the end of the display area of W. Value is the row
17051 containing CHARPOS or null. */
17054 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17055 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17057 struct glyph_row
*row
= start
;
17058 struct glyph_row
*best_row
= NULL
;
17059 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
17062 /* If we happen to start on a header-line, skip that. */
17063 if (row
->mode_line_p
)
17066 if ((end
&& row
>= end
) || !row
->enabled_p
)
17069 last_y
= window_text_bottom_y (w
) - dy
;
17073 /* Give up if we have gone too far. */
17074 if (end
&& row
>= end
)
17076 /* This formerly returned if they were equal.
17077 I think that both quantities are of a "last plus one" type;
17078 if so, when they are equal, the row is within the screen. -- rms. */
17079 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17082 /* If it is in this row, return this row. */
17083 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17084 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17085 /* The end position of a row equals the start
17086 position of the next row. If CHARPOS is there, we
17087 would rather display it in the next line, except
17088 when this line ends in ZV. */
17089 && !row
->ends_at_zv_p
17090 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
17091 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17095 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
17096 || (!best_row
&& !row
->continued_p
))
17098 /* In bidi-reordered rows, there could be several rows
17099 occluding point, all of them belonging to the same
17100 continued line. We need to find the row which fits
17101 CHARPOS the best. */
17102 for (g
= row
->glyphs
[TEXT_AREA
];
17103 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17106 if (!STRINGP (g
->object
))
17108 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17110 mindif
= eabs (g
->charpos
- charpos
);
17112 /* Exact match always wins. */
17119 else if (best_row
&& !row
->continued_p
)
17126 /* Try to redisplay window W by reusing its existing display. W's
17127 current matrix must be up to date when this function is called,
17128 i.e. window_end_valid must not be nil.
17132 1 if display has been updated
17133 0 if otherwise unsuccessful
17134 -1 if redisplay with same window start is known not to succeed
17136 The following steps are performed:
17138 1. Find the last row in the current matrix of W that is not
17139 affected by changes at the start of current_buffer. If no such row
17142 2. Find the first row in W's current matrix that is not affected by
17143 changes at the end of current_buffer. Maybe there is no such row.
17145 3. Display lines beginning with the row + 1 found in step 1 to the
17146 row found in step 2 or, if step 2 didn't find a row, to the end of
17149 4. If cursor is not known to appear on the window, give up.
17151 5. If display stopped at the row found in step 2, scroll the
17152 display and current matrix as needed.
17154 6. Maybe display some lines at the end of W, if we must. This can
17155 happen under various circumstances, like a partially visible line
17156 becoming fully visible, or because newly displayed lines are displayed
17157 in smaller font sizes.
17159 7. Update W's window end information. */
17162 try_window_id (struct window
*w
)
17164 struct frame
*f
= XFRAME (w
->frame
);
17165 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17166 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17167 struct glyph_row
*last_unchanged_at_beg_row
;
17168 struct glyph_row
*first_unchanged_at_end_row
;
17169 struct glyph_row
*row
;
17170 struct glyph_row
*bottom_row
;
17173 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17175 struct text_pos start_pos
;
17177 int first_unchanged_at_end_vpos
= 0;
17178 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17179 struct text_pos start
;
17180 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17183 if (inhibit_try_window_id
)
17187 /* This is handy for debugging. */
17189 #define GIVE_UP(X) \
17191 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17195 #define GIVE_UP(X) return 0
17198 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17200 /* Don't use this for mini-windows because these can show
17201 messages and mini-buffers, and we don't handle that here. */
17202 if (MINI_WINDOW_P (w
))
17205 /* This flag is used to prevent redisplay optimizations. */
17206 if (windows_or_buffers_changed
|| cursor_type_changed
)
17209 /* Verify that narrowing has not changed.
17210 Also verify that we were not told to prevent redisplay optimizations.
17211 It would be nice to further
17212 reduce the number of cases where this prevents try_window_id. */
17213 if (current_buffer
->clip_changed
17214 || current_buffer
->prevent_redisplay_optimizations_p
)
17217 /* Window must either use window-based redisplay or be full width. */
17218 if (!FRAME_WINDOW_P (f
)
17219 && (!FRAME_LINE_INS_DEL_OK (f
)
17220 || !WINDOW_FULL_WIDTH_P (w
)))
17223 /* Give up if point is known NOT to appear in W. */
17224 if (PT
< CHARPOS (start
))
17227 /* Another way to prevent redisplay optimizations. */
17228 if (w
->last_modified
== 0)
17231 /* Verify that window is not hscrolled. */
17232 if (w
->hscroll
!= 0)
17235 /* Verify that display wasn't paused. */
17236 if (NILP (w
->window_end_valid
))
17239 /* Can't use this if highlighting a region because a cursor movement
17240 will do more than just set the cursor. */
17241 if (!NILP (Vtransient_mark_mode
)
17242 && !NILP (BVAR (current_buffer
, mark_active
)))
17245 /* Likewise if highlighting trailing whitespace. */
17246 if (!NILP (Vshow_trailing_whitespace
))
17249 /* Likewise if showing a region. */
17250 if (!NILP (w
->region_showing
))
17253 /* Can't use this if overlay arrow position and/or string have
17255 if (overlay_arrows_changed_p ())
17258 /* When word-wrap is on, adding a space to the first word of a
17259 wrapped line can change the wrap position, altering the line
17260 above it. It might be worthwhile to handle this more
17261 intelligently, but for now just redisplay from scratch. */
17262 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
17265 /* Under bidi reordering, adding or deleting a character in the
17266 beginning of a paragraph, before the first strong directional
17267 character, can change the base direction of the paragraph (unless
17268 the buffer specifies a fixed paragraph direction), which will
17269 require to redisplay the whole paragraph. It might be worthwhile
17270 to find the paragraph limits and widen the range of redisplayed
17271 lines to that, but for now just give up this optimization and
17272 redisplay from scratch. */
17273 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
17274 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
17277 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17278 only if buffer has really changed. The reason is that the gap is
17279 initially at Z for freshly visited files. The code below would
17280 set end_unchanged to 0 in that case. */
17281 if (MODIFF
> SAVE_MODIFF
17282 /* This seems to happen sometimes after saving a buffer. */
17283 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17285 if (GPT
- BEG
< BEG_UNCHANGED
)
17286 BEG_UNCHANGED
= GPT
- BEG
;
17287 if (Z
- GPT
< END_UNCHANGED
)
17288 END_UNCHANGED
= Z
- GPT
;
17291 /* The position of the first and last character that has been changed. */
17292 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17293 last_changed_charpos
= Z
- END_UNCHANGED
;
17295 /* If window starts after a line end, and the last change is in
17296 front of that newline, then changes don't affect the display.
17297 This case happens with stealth-fontification. Note that although
17298 the display is unchanged, glyph positions in the matrix have to
17299 be adjusted, of course. */
17300 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
17301 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17302 && ((last_changed_charpos
< CHARPOS (start
)
17303 && CHARPOS (start
) == BEGV
)
17304 || (last_changed_charpos
< CHARPOS (start
) - 1
17305 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17307 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17308 struct glyph_row
*r0
;
17310 /* Compute how many chars/bytes have been added to or removed
17311 from the buffer. */
17312 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
17313 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17314 Z_delta
= Z
- Z_old
;
17315 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17317 /* Give up if PT is not in the window. Note that it already has
17318 been checked at the start of try_window_id that PT is not in
17319 front of the window start. */
17320 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17323 /* If window start is unchanged, we can reuse the whole matrix
17324 as is, after adjusting glyph positions. No need to compute
17325 the window end again, since its offset from Z hasn't changed. */
17326 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17327 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17328 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17329 /* PT must not be in a partially visible line. */
17330 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17331 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17333 /* Adjust positions in the glyph matrix. */
17334 if (Z_delta
|| Z_delta_bytes
)
17336 struct glyph_row
*r1
17337 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17338 increment_matrix_positions (w
->current_matrix
,
17339 MATRIX_ROW_VPOS (r0
, current_matrix
),
17340 MATRIX_ROW_VPOS (r1
, current_matrix
),
17341 Z_delta
, Z_delta_bytes
);
17344 /* Set the cursor. */
17345 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17347 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17354 /* Handle the case that changes are all below what is displayed in
17355 the window, and that PT is in the window. This shortcut cannot
17356 be taken if ZV is visible in the window, and text has been added
17357 there that is visible in the window. */
17358 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17359 /* ZV is not visible in the window, or there are no
17360 changes at ZV, actually. */
17361 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17362 || first_changed_charpos
== last_changed_charpos
))
17364 struct glyph_row
*r0
;
17366 /* Give up if PT is not in the window. Note that it already has
17367 been checked at the start of try_window_id that PT is not in
17368 front of the window start. */
17369 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17372 /* If window start is unchanged, we can reuse the whole matrix
17373 as is, without changing glyph positions since no text has
17374 been added/removed in front of the window end. */
17375 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17376 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17377 /* PT must not be in a partially visible line. */
17378 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17379 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17381 /* We have to compute the window end anew since text
17382 could have been added/removed after it. */
17383 wset_window_end_pos
17384 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17385 w
->window_end_bytepos
17386 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17388 /* Set the cursor. */
17389 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17391 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17398 /* Give up if window start is in the changed area.
17400 The condition used to read
17402 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17404 but why that was tested escapes me at the moment. */
17405 if (CHARPOS (start
) >= first_changed_charpos
17406 && CHARPOS (start
) <= last_changed_charpos
)
17409 /* Check that window start agrees with the start of the first glyph
17410 row in its current matrix. Check this after we know the window
17411 start is not in changed text, otherwise positions would not be
17413 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17414 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17417 /* Give up if the window ends in strings. Overlay strings
17418 at the end are difficult to handle, so don't try. */
17419 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
17420 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17423 /* Compute the position at which we have to start displaying new
17424 lines. Some of the lines at the top of the window might be
17425 reusable because they are not displaying changed text. Find the
17426 last row in W's current matrix not affected by changes at the
17427 start of current_buffer. Value is null if changes start in the
17428 first line of window. */
17429 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17430 if (last_unchanged_at_beg_row
)
17432 /* Avoid starting to display in the middle of a character, a TAB
17433 for instance. This is easier than to set up the iterator
17434 exactly, and it's not a frequent case, so the additional
17435 effort wouldn't really pay off. */
17436 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17437 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17438 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17439 --last_unchanged_at_beg_row
;
17441 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17444 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17446 start_pos
= it
.current
.pos
;
17448 /* Start displaying new lines in the desired matrix at the same
17449 vpos we would use in the current matrix, i.e. below
17450 last_unchanged_at_beg_row. */
17451 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17453 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17454 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17456 eassert (it
.hpos
== 0 && it
.current_x
== 0);
17460 /* There are no reusable lines at the start of the window.
17461 Start displaying in the first text line. */
17462 start_display (&it
, w
, start
);
17463 it
.vpos
= it
.first_vpos
;
17464 start_pos
= it
.current
.pos
;
17467 /* Find the first row that is not affected by changes at the end of
17468 the buffer. Value will be null if there is no unchanged row, in
17469 which case we must redisplay to the end of the window. delta
17470 will be set to the value by which buffer positions beginning with
17471 first_unchanged_at_end_row have to be adjusted due to text
17473 first_unchanged_at_end_row
17474 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17475 IF_DEBUG (debug_delta
= delta
);
17476 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17478 /* Set stop_pos to the buffer position up to which we will have to
17479 display new lines. If first_unchanged_at_end_row != NULL, this
17480 is the buffer position of the start of the line displayed in that
17481 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17482 that we don't stop at a buffer position. */
17484 if (first_unchanged_at_end_row
)
17486 eassert (last_unchanged_at_beg_row
== NULL
17487 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17489 /* If this is a continuation line, move forward to the next one
17490 that isn't. Changes in lines above affect this line.
17491 Caution: this may move first_unchanged_at_end_row to a row
17492 not displaying text. */
17493 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17494 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17495 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17496 < it
.last_visible_y
))
17497 ++first_unchanged_at_end_row
;
17499 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17500 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17501 >= it
.last_visible_y
))
17502 first_unchanged_at_end_row
= NULL
;
17505 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17507 first_unchanged_at_end_vpos
17508 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17509 eassert (stop_pos
>= Z
- END_UNCHANGED
);
17512 else if (last_unchanged_at_beg_row
== NULL
)
17518 /* Either there is no unchanged row at the end, or the one we have
17519 now displays text. This is a necessary condition for the window
17520 end pos calculation at the end of this function. */
17521 eassert (first_unchanged_at_end_row
== NULL
17522 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17524 debug_last_unchanged_at_beg_vpos
17525 = (last_unchanged_at_beg_row
17526 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17528 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17530 #endif /* GLYPH_DEBUG */
17533 /* Display new lines. Set last_text_row to the last new line
17534 displayed which has text on it, i.e. might end up as being the
17535 line where the window_end_vpos is. */
17536 w
->cursor
.vpos
= -1;
17537 last_text_row
= NULL
;
17538 overlay_arrow_seen
= 0;
17539 while (it
.current_y
< it
.last_visible_y
17540 && !fonts_changed_p
17541 && (first_unchanged_at_end_row
== NULL
17542 || IT_CHARPOS (it
) < stop_pos
))
17544 if (display_line (&it
))
17545 last_text_row
= it
.glyph_row
- 1;
17548 if (fonts_changed_p
)
17552 /* Compute differences in buffer positions, y-positions etc. for
17553 lines reused at the bottom of the window. Compute what we can
17555 if (first_unchanged_at_end_row
17556 /* No lines reused because we displayed everything up to the
17557 bottom of the window. */
17558 && it
.current_y
< it
.last_visible_y
)
17561 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17563 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17564 run
.current_y
= first_unchanged_at_end_row
->y
;
17565 run
.desired_y
= run
.current_y
+ dy
;
17566 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17570 delta
= delta_bytes
= dvpos
= dy
17571 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17572 first_unchanged_at_end_row
= NULL
;
17574 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17577 /* Find the cursor if not already found. We have to decide whether
17578 PT will appear on this window (it sometimes doesn't, but this is
17579 not a very frequent case.) This decision has to be made before
17580 the current matrix is altered. A value of cursor.vpos < 0 means
17581 that PT is either in one of the lines beginning at
17582 first_unchanged_at_end_row or below the window. Don't care for
17583 lines that might be displayed later at the window end; as
17584 mentioned, this is not a frequent case. */
17585 if (w
->cursor
.vpos
< 0)
17587 /* Cursor in unchanged rows at the top? */
17588 if (PT
< CHARPOS (start_pos
)
17589 && last_unchanged_at_beg_row
)
17591 row
= row_containing_pos (w
, PT
,
17592 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17593 last_unchanged_at_beg_row
+ 1, 0);
17595 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17598 /* Start from first_unchanged_at_end_row looking for PT. */
17599 else if (first_unchanged_at_end_row
)
17601 row
= row_containing_pos (w
, PT
- delta
,
17602 first_unchanged_at_end_row
, NULL
, 0);
17604 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17605 delta_bytes
, dy
, dvpos
);
17608 /* Give up if cursor was not found. */
17609 if (w
->cursor
.vpos
< 0)
17611 clear_glyph_matrix (w
->desired_matrix
);
17616 /* Don't let the cursor end in the scroll margins. */
17618 int this_scroll_margin
, cursor_height
;
17620 this_scroll_margin
=
17621 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
17622 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
17623 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17625 if ((w
->cursor
.y
< this_scroll_margin
17626 && CHARPOS (start
) > BEGV
)
17627 /* Old redisplay didn't take scroll margin into account at the bottom,
17628 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17629 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17630 ? cursor_height
+ this_scroll_margin
17631 : 1)) > it
.last_visible_y
)
17633 w
->cursor
.vpos
= -1;
17634 clear_glyph_matrix (w
->desired_matrix
);
17639 /* Scroll the display. Do it before changing the current matrix so
17640 that xterm.c doesn't get confused about where the cursor glyph is
17642 if (dy
&& run
.height
)
17646 if (FRAME_WINDOW_P (f
))
17648 FRAME_RIF (f
)->update_window_begin_hook (w
);
17649 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17650 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17651 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17655 /* Terminal frame. In this case, dvpos gives the number of
17656 lines to scroll by; dvpos < 0 means scroll up. */
17658 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17659 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17660 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17661 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17662 + window_internal_height (w
));
17664 #if defined (HAVE_GPM) || defined (MSDOS)
17665 x_clear_window_mouse_face (w
);
17667 /* Perform the operation on the screen. */
17670 /* Scroll last_unchanged_at_beg_row to the end of the
17671 window down dvpos lines. */
17672 set_terminal_window (f
, end
);
17674 /* On dumb terminals delete dvpos lines at the end
17675 before inserting dvpos empty lines. */
17676 if (!FRAME_SCROLL_REGION_OK (f
))
17677 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17679 /* Insert dvpos empty lines in front of
17680 last_unchanged_at_beg_row. */
17681 ins_del_lines (f
, from
, dvpos
);
17683 else if (dvpos
< 0)
17685 /* Scroll up last_unchanged_at_beg_vpos to the end of
17686 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17687 set_terminal_window (f
, end
);
17689 /* Delete dvpos lines in front of
17690 last_unchanged_at_beg_vpos. ins_del_lines will set
17691 the cursor to the given vpos and emit |dvpos| delete
17693 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17695 /* On a dumb terminal insert dvpos empty lines at the
17697 if (!FRAME_SCROLL_REGION_OK (f
))
17698 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17701 set_terminal_window (f
, 0);
17707 /* Shift reused rows of the current matrix to the right position.
17708 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17710 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17711 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17714 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17715 bottom_vpos
, dvpos
);
17716 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17719 else if (dvpos
> 0)
17721 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17722 bottom_vpos
, dvpos
);
17723 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17724 first_unchanged_at_end_vpos
+ dvpos
);
17727 /* For frame-based redisplay, make sure that current frame and window
17728 matrix are in sync with respect to glyph memory. */
17729 if (!FRAME_WINDOW_P (f
))
17730 sync_frame_with_window_matrix_rows (w
);
17732 /* Adjust buffer positions in reused rows. */
17733 if (delta
|| delta_bytes
)
17734 increment_matrix_positions (current_matrix
,
17735 first_unchanged_at_end_vpos
+ dvpos
,
17736 bottom_vpos
, delta
, delta_bytes
);
17738 /* Adjust Y positions. */
17740 shift_glyph_matrix (w
, current_matrix
,
17741 first_unchanged_at_end_vpos
+ dvpos
,
17744 if (first_unchanged_at_end_row
)
17746 first_unchanged_at_end_row
+= dvpos
;
17747 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17748 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17749 first_unchanged_at_end_row
= NULL
;
17752 /* If scrolling up, there may be some lines to display at the end of
17754 last_text_row_at_end
= NULL
;
17757 /* Scrolling up can leave for example a partially visible line
17758 at the end of the window to be redisplayed. */
17759 /* Set last_row to the glyph row in the current matrix where the
17760 window end line is found. It has been moved up or down in
17761 the matrix by dvpos. */
17762 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17763 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17765 /* If last_row is the window end line, it should display text. */
17766 eassert (last_row
->displays_text_p
);
17768 /* If window end line was partially visible before, begin
17769 displaying at that line. Otherwise begin displaying with the
17770 line following it. */
17771 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17773 init_to_row_start (&it
, w
, last_row
);
17774 it
.vpos
= last_vpos
;
17775 it
.current_y
= last_row
->y
;
17779 init_to_row_end (&it
, w
, last_row
);
17780 it
.vpos
= 1 + last_vpos
;
17781 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17785 /* We may start in a continuation line. If so, we have to
17786 get the right continuation_lines_width and current_x. */
17787 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17788 it
.hpos
= it
.current_x
= 0;
17790 /* Display the rest of the lines at the window end. */
17791 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17792 while (it
.current_y
< it
.last_visible_y
17793 && !fonts_changed_p
)
17795 /* Is it always sure that the display agrees with lines in
17796 the current matrix? I don't think so, so we mark rows
17797 displayed invalid in the current matrix by setting their
17798 enabled_p flag to zero. */
17799 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17800 if (display_line (&it
))
17801 last_text_row_at_end
= it
.glyph_row
- 1;
17805 /* Update window_end_pos and window_end_vpos. */
17806 if (first_unchanged_at_end_row
17807 && !last_text_row_at_end
)
17809 /* Window end line if one of the preserved rows from the current
17810 matrix. Set row to the last row displaying text in current
17811 matrix starting at first_unchanged_at_end_row, after
17813 eassert (first_unchanged_at_end_row
->displays_text_p
);
17814 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17815 first_unchanged_at_end_row
);
17816 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17818 wset_window_end_pos (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17819 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17820 wset_window_end_vpos
17821 (w
, make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
)));
17822 eassert (w
->window_end_bytepos
>= 0);
17823 IF_DEBUG (debug_method_add (w
, "A"));
17825 else if (last_text_row_at_end
)
17827 wset_window_end_pos
17828 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
)));
17829 w
->window_end_bytepos
17830 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17831 wset_window_end_vpos
17832 (w
, make_number (MATRIX_ROW_VPOS (last_text_row_at_end
,
17834 eassert (w
->window_end_bytepos
>= 0);
17835 IF_DEBUG (debug_method_add (w
, "B"));
17837 else if (last_text_row
)
17839 /* We have displayed either to the end of the window or at the
17840 end of the window, i.e. the last row with text is to be found
17841 in the desired matrix. */
17842 wset_window_end_pos
17843 (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
)));
17844 w
->window_end_bytepos
17845 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17846 wset_window_end_vpos
17847 (w
, make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
)));
17848 eassert (w
->window_end_bytepos
>= 0);
17850 else if (first_unchanged_at_end_row
== NULL
17851 && last_text_row
== NULL
17852 && last_text_row_at_end
== NULL
)
17854 /* Displayed to end of window, but no line containing text was
17855 displayed. Lines were deleted at the end of the window. */
17856 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17857 int vpos
= XFASTINT (w
->window_end_vpos
);
17858 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17859 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17862 row
== NULL
&& vpos
>= first_vpos
;
17863 --vpos
, --current_row
, --desired_row
)
17865 if (desired_row
->enabled_p
)
17867 if (desired_row
->displays_text_p
)
17870 else if (current_row
->displays_text_p
)
17874 eassert (row
!= NULL
);
17875 wset_window_end_vpos (w
, make_number (vpos
+ 1));
17876 wset_window_end_pos (w
, make_number (Z
- MATRIX_ROW_END_CHARPOS (row
)));
17877 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17878 eassert (w
->window_end_bytepos
>= 0);
17879 IF_DEBUG (debug_method_add (w
, "C"));
17884 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17885 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17887 /* Record that display has not been completed. */
17888 wset_window_end_valid (w
, Qnil
);
17889 w
->desired_matrix
->no_scrolling_p
= 1;
17897 /***********************************************************************
17898 More debugging support
17899 ***********************************************************************/
17903 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17904 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17905 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17908 /* Dump the contents of glyph matrix MATRIX on stderr.
17910 GLYPHS 0 means don't show glyph contents.
17911 GLYPHS 1 means show glyphs in short form
17912 GLYPHS > 1 means show glyphs in long form. */
17915 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17918 for (i
= 0; i
< matrix
->nrows
; ++i
)
17919 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17923 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17924 the glyph row and area where the glyph comes from. */
17927 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17929 if (glyph
->type
== CHAR_GLYPH
)
17932 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17933 glyph
- row
->glyphs
[TEXT_AREA
],
17936 (BUFFERP (glyph
->object
)
17938 : (STRINGP (glyph
->object
)
17941 glyph
->pixel_width
,
17943 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17947 glyph
->left_box_line_p
,
17948 glyph
->right_box_line_p
);
17950 else if (glyph
->type
== STRETCH_GLYPH
)
17953 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17954 glyph
- row
->glyphs
[TEXT_AREA
],
17957 (BUFFERP (glyph
->object
)
17959 : (STRINGP (glyph
->object
)
17962 glyph
->pixel_width
,
17966 glyph
->left_box_line_p
,
17967 glyph
->right_box_line_p
);
17969 else if (glyph
->type
== IMAGE_GLYPH
)
17972 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17973 glyph
- row
->glyphs
[TEXT_AREA
],
17976 (BUFFERP (glyph
->object
)
17978 : (STRINGP (glyph
->object
)
17981 glyph
->pixel_width
,
17985 glyph
->left_box_line_p
,
17986 glyph
->right_box_line_p
);
17988 else if (glyph
->type
== COMPOSITE_GLYPH
)
17991 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17992 glyph
- row
->glyphs
[TEXT_AREA
],
17995 (BUFFERP (glyph
->object
)
17997 : (STRINGP (glyph
->object
)
18000 glyph
->pixel_width
,
18002 if (glyph
->u
.cmp
.automatic
)
18005 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18006 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18008 glyph
->left_box_line_p
,
18009 glyph
->right_box_line_p
);
18014 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18015 GLYPHS 0 means don't show glyph contents.
18016 GLYPHS 1 means show glyphs in short form
18017 GLYPHS > 1 means show glyphs in long form. */
18020 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18024 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18025 fprintf (stderr
, "======================================================================\n");
18027 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18028 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18030 MATRIX_ROW_START_CHARPOS (row
),
18031 MATRIX_ROW_END_CHARPOS (row
),
18032 row
->used
[TEXT_AREA
],
18033 row
->contains_overlapping_glyphs_p
,
18035 row
->truncated_on_left_p
,
18036 row
->truncated_on_right_p
,
18038 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18039 row
->displays_text_p
,
18042 row
->ends_in_middle_of_char_p
,
18043 row
->starts_in_middle_of_char_p
,
18049 row
->visible_height
,
18052 fprintf (stderr
, "%9"pD
"d %5"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18053 row
->end
.overlay_string_index
,
18054 row
->continuation_lines_width
);
18055 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
18056 CHARPOS (row
->start
.string_pos
),
18057 CHARPOS (row
->end
.string_pos
));
18058 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
18059 row
->end
.dpvec_index
);
18066 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18068 struct glyph
*glyph
= row
->glyphs
[area
];
18069 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18071 /* Glyph for a line end in text. */
18072 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18075 if (glyph
< glyph_end
)
18076 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
18078 for (; glyph
< glyph_end
; ++glyph
)
18079 dump_glyph (row
, glyph
, area
);
18082 else if (glyphs
== 1)
18086 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18088 char *s
= alloca (row
->used
[area
] + 1);
18091 for (i
= 0; i
< row
->used
[area
]; ++i
)
18093 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18094 if (glyph
->type
== CHAR_GLYPH
18095 && glyph
->u
.ch
< 0x80
18096 && glyph
->u
.ch
>= ' ')
18097 s
[i
] = glyph
->u
.ch
;
18103 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18109 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18110 Sdump_glyph_matrix
, 0, 1, "p",
18111 doc
: /* Dump the current matrix of the selected window to stderr.
18112 Shows contents of glyph row structures. With non-nil
18113 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18114 glyphs in short form, otherwise show glyphs in long form. */)
18115 (Lisp_Object glyphs
)
18117 struct window
*w
= XWINDOW (selected_window
);
18118 struct buffer
*buffer
= XBUFFER (w
->buffer
);
18120 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18121 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18122 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18123 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18124 fprintf (stderr
, "=============================================\n");
18125 dump_glyph_matrix (w
->current_matrix
,
18126 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18131 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18132 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
18135 struct frame
*f
= XFRAME (selected_frame
);
18136 dump_glyph_matrix (f
->current_matrix
, 1);
18141 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18142 doc
: /* Dump glyph row ROW to stderr.
18143 GLYPH 0 means don't dump glyphs.
18144 GLYPH 1 means dump glyphs in short form.
18145 GLYPH > 1 or omitted means dump glyphs in long form. */)
18146 (Lisp_Object row
, Lisp_Object glyphs
)
18148 struct glyph_matrix
*matrix
;
18151 CHECK_NUMBER (row
);
18152 matrix
= XWINDOW (selected_window
)->current_matrix
;
18154 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18155 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18157 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18162 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18163 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18164 GLYPH 0 means don't dump glyphs.
18165 GLYPH 1 means dump glyphs in short form.
18166 GLYPH > 1 or omitted means dump glyphs in long form. */)
18167 (Lisp_Object row
, Lisp_Object glyphs
)
18169 struct frame
*sf
= SELECTED_FRAME ();
18170 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18173 CHECK_NUMBER (row
);
18175 if (vpos
>= 0 && vpos
< m
->nrows
)
18176 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18177 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18182 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18183 doc
: /* Toggle tracing of redisplay.
18184 With ARG, turn tracing on if and only if ARG is positive. */)
18188 trace_redisplay_p
= !trace_redisplay_p
;
18191 arg
= Fprefix_numeric_value (arg
);
18192 trace_redisplay_p
= XINT (arg
) > 0;
18199 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18200 doc
: /* Like `format', but print result to stderr.
18201 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18202 (ptrdiff_t nargs
, Lisp_Object
*args
)
18204 Lisp_Object s
= Fformat (nargs
, args
);
18205 fprintf (stderr
, "%s", SDATA (s
));
18209 #endif /* GLYPH_DEBUG */
18213 /***********************************************************************
18214 Building Desired Matrix Rows
18215 ***********************************************************************/
18217 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18218 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18220 static struct glyph_row
*
18221 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18223 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18224 struct buffer
*buffer
= XBUFFER (w
->buffer
);
18225 struct buffer
*old
= current_buffer
;
18226 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18227 int arrow_len
= SCHARS (overlay_arrow_string
);
18228 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18229 const unsigned char *p
;
18232 int n_glyphs_before
;
18234 set_buffer_temp (buffer
);
18235 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18236 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18237 SET_TEXT_POS (it
.position
, 0, 0);
18239 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18241 while (p
< arrow_end
)
18243 Lisp_Object face
, ilisp
;
18245 /* Get the next character. */
18247 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18250 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18251 if (! ASCII_CHAR_P (it
.c
))
18252 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18256 /* Get its face. */
18257 ilisp
= make_number (p
- arrow_string
);
18258 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18259 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18261 /* Compute its width, get its glyphs. */
18262 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18263 SET_TEXT_POS (it
.position
, -1, -1);
18264 PRODUCE_GLYPHS (&it
);
18266 /* If this character doesn't fit any more in the line, we have
18267 to remove some glyphs. */
18268 if (it
.current_x
> it
.last_visible_x
)
18270 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18275 set_buffer_temp (old
);
18276 return it
.glyph_row
;
18280 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18281 glyphs to insert is determined by produce_special_glyphs. */
18284 insert_left_trunc_glyphs (struct it
*it
)
18286 struct it truncate_it
;
18287 struct glyph
*from
, *end
, *to
, *toend
;
18289 eassert (!FRAME_WINDOW_P (it
->f
)
18290 || (!it
->glyph_row
->reversed_p
18291 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18292 || (it
->glyph_row
->reversed_p
18293 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18295 /* Get the truncation glyphs. */
18297 truncate_it
.current_x
= 0;
18298 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18299 truncate_it
.glyph_row
= &scratch_glyph_row
;
18300 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18301 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18302 truncate_it
.object
= make_number (0);
18303 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18305 /* Overwrite glyphs from IT with truncation glyphs. */
18306 if (!it
->glyph_row
->reversed_p
)
18308 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18310 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18311 end
= from
+ tused
;
18312 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18313 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18314 if (FRAME_WINDOW_P (it
->f
))
18316 /* On GUI frames, when variable-size fonts are displayed,
18317 the truncation glyphs may need more pixels than the row's
18318 glyphs they overwrite. We overwrite more glyphs to free
18319 enough screen real estate, and enlarge the stretch glyph
18320 on the right (see display_line), if there is one, to
18321 preserve the screen position of the truncation glyphs on
18324 struct glyph
*g
= to
;
18327 /* The first glyph could be partially visible, in which case
18328 it->glyph_row->x will be negative. But we want the left
18329 truncation glyphs to be aligned at the left margin of the
18330 window, so we override the x coordinate at which the row
18332 it
->glyph_row
->x
= 0;
18333 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18335 w
+= g
->pixel_width
;
18338 if (g
- to
- tused
> 0)
18340 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18341 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18343 used
= it
->glyph_row
->used
[TEXT_AREA
];
18344 if (it
->glyph_row
->truncated_on_right_p
18345 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18346 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18349 int extra
= w
- it
->truncation_pixel_width
;
18351 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18358 /* There may be padding glyphs left over. Overwrite them too. */
18359 if (!FRAME_WINDOW_P (it
->f
))
18361 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18363 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18370 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18374 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18376 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18377 that back to front. */
18378 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18379 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18380 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18381 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18382 if (FRAME_WINDOW_P (it
->f
))
18385 struct glyph
*g
= to
;
18387 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
18389 w
+= g
->pixel_width
;
18392 if (to
- g
- tused
> 0)
18394 if (it
->glyph_row
->truncated_on_right_p
18395 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
18396 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
18398 int extra
= w
- it
->truncation_pixel_width
;
18400 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
18404 while (from
>= end
&& to
>= toend
)
18406 if (!FRAME_WINDOW_P (it
->f
))
18408 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18411 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18412 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18413 while (from
>= end
&& to
>= toend
)
18419 /* Need to free some room before prepending additional
18421 int move_by
= from
- end
+ 1;
18422 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18423 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18425 for ( ; g
>= g0
; g
--)
18427 while (from
>= end
)
18429 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18434 /* Compute the hash code for ROW. */
18436 row_hash (struct glyph_row
*row
)
18439 unsigned hashval
= 0;
18441 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18442 for (k
= 0; k
< row
->used
[area
]; ++k
)
18443 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18444 + row
->glyphs
[area
][k
].u
.val
18445 + row
->glyphs
[area
][k
].face_id
18446 + row
->glyphs
[area
][k
].padding_p
18447 + (row
->glyphs
[area
][k
].type
<< 2));
18452 /* Compute the pixel height and width of IT->glyph_row.
18454 Most of the time, ascent and height of a display line will be equal
18455 to the max_ascent and max_height values of the display iterator
18456 structure. This is not the case if
18458 1. We hit ZV without displaying anything. In this case, max_ascent
18459 and max_height will be zero.
18461 2. We have some glyphs that don't contribute to the line height.
18462 (The glyph row flag contributes_to_line_height_p is for future
18463 pixmap extensions).
18465 The first case is easily covered by using default values because in
18466 these cases, the line height does not really matter, except that it
18467 must not be zero. */
18470 compute_line_metrics (struct it
*it
)
18472 struct glyph_row
*row
= it
->glyph_row
;
18474 if (FRAME_WINDOW_P (it
->f
))
18476 int i
, min_y
, max_y
;
18478 /* The line may consist of one space only, that was added to
18479 place the cursor on it. If so, the row's height hasn't been
18481 if (row
->height
== 0)
18483 if (it
->max_ascent
+ it
->max_descent
== 0)
18484 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18485 row
->ascent
= it
->max_ascent
;
18486 row
->height
= it
->max_ascent
+ it
->max_descent
;
18487 row
->phys_ascent
= it
->max_phys_ascent
;
18488 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18489 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18492 /* Compute the width of this line. */
18493 row
->pixel_width
= row
->x
;
18494 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18495 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18497 eassert (row
->pixel_width
>= 0);
18498 eassert (row
->ascent
>= 0 && row
->height
> 0);
18500 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
18501 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
18503 /* If first line's physical ascent is larger than its logical
18504 ascent, use the physical ascent, and make the row taller.
18505 This makes accented characters fully visible. */
18506 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
18507 && row
->phys_ascent
> row
->ascent
)
18509 row
->height
+= row
->phys_ascent
- row
->ascent
;
18510 row
->ascent
= row
->phys_ascent
;
18513 /* Compute how much of the line is visible. */
18514 row
->visible_height
= row
->height
;
18516 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18517 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18519 if (row
->y
< min_y
)
18520 row
->visible_height
-= min_y
- row
->y
;
18521 if (row
->y
+ row
->height
> max_y
)
18522 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18526 row
->pixel_width
= row
->used
[TEXT_AREA
];
18527 if (row
->continued_p
)
18528 row
->pixel_width
-= it
->continuation_pixel_width
;
18529 else if (row
->truncated_on_right_p
)
18530 row
->pixel_width
-= it
->truncation_pixel_width
;
18531 row
->ascent
= row
->phys_ascent
= 0;
18532 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18533 row
->extra_line_spacing
= 0;
18536 /* Compute a hash code for this row. */
18537 row
->hash
= row_hash (row
);
18539 it
->max_ascent
= it
->max_descent
= 0;
18540 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18544 /* Append one space to the glyph row of iterator IT if doing a
18545 window-based redisplay. The space has the same face as
18546 IT->face_id. Value is non-zero if a space was added.
18548 This function is called to make sure that there is always one glyph
18549 at the end of a glyph row that the cursor can be set on under
18550 window-systems. (If there weren't such a glyph we would not know
18551 how wide and tall a box cursor should be displayed).
18553 At the same time this space let's a nicely handle clearing to the
18554 end of the line if the row ends in italic text. */
18557 append_space_for_newline (struct it
*it
, int default_face_p
)
18559 if (FRAME_WINDOW_P (it
->f
))
18561 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18563 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18564 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18566 /* Save some values that must not be changed.
18567 Must save IT->c and IT->len because otherwise
18568 ITERATOR_AT_END_P wouldn't work anymore after
18569 append_space_for_newline has been called. */
18570 enum display_element_type saved_what
= it
->what
;
18571 int saved_c
= it
->c
, saved_len
= it
->len
;
18572 int saved_char_to_display
= it
->char_to_display
;
18573 int saved_x
= it
->current_x
;
18574 int saved_face_id
= it
->face_id
;
18575 struct text_pos saved_pos
;
18576 Lisp_Object saved_object
;
18579 saved_object
= it
->object
;
18580 saved_pos
= it
->position
;
18582 it
->what
= IT_CHARACTER
;
18583 memset (&it
->position
, 0, sizeof it
->position
);
18584 it
->object
= make_number (0);
18585 it
->c
= it
->char_to_display
= ' ';
18588 /* If the default face was remapped, be sure to use the
18589 remapped face for the appended newline. */
18590 if (default_face_p
)
18591 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
18592 else if (it
->face_before_selective_p
)
18593 it
->face_id
= it
->saved_face_id
;
18594 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18595 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18597 PRODUCE_GLYPHS (it
);
18599 it
->override_ascent
= -1;
18600 it
->constrain_row_ascent_descent_p
= 0;
18601 it
->current_x
= saved_x
;
18602 it
->object
= saved_object
;
18603 it
->position
= saved_pos
;
18604 it
->what
= saved_what
;
18605 it
->face_id
= saved_face_id
;
18606 it
->len
= saved_len
;
18608 it
->char_to_display
= saved_char_to_display
;
18617 /* Extend the face of the last glyph in the text area of IT->glyph_row
18618 to the end of the display line. Called from display_line. If the
18619 glyph row is empty, add a space glyph to it so that we know the
18620 face to draw. Set the glyph row flag fill_line_p. If the glyph
18621 row is R2L, prepend a stretch glyph to cover the empty space to the
18622 left of the leftmost glyph. */
18625 extend_face_to_end_of_line (struct it
*it
)
18627 struct face
*face
, *default_face
;
18628 struct frame
*f
= it
->f
;
18630 /* If line is already filled, do nothing. Non window-system frames
18631 get a grace of one more ``pixel'' because their characters are
18632 1-``pixel'' wide, so they hit the equality too early. This grace
18633 is needed only for R2L rows that are not continued, to produce
18634 one extra blank where we could display the cursor. */
18635 if (it
->current_x
>= it
->last_visible_x
18636 + (!FRAME_WINDOW_P (f
)
18637 && it
->glyph_row
->reversed_p
18638 && !it
->glyph_row
->continued_p
))
18641 /* The default face, possibly remapped. */
18642 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
18644 /* Face extension extends the background and box of IT->face_id
18645 to the end of the line. If the background equals the background
18646 of the frame, we don't have to do anything. */
18647 if (it
->face_before_selective_p
)
18648 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18650 face
= FACE_FROM_ID (f
, it
->face_id
);
18652 if (FRAME_WINDOW_P (f
)
18653 && it
->glyph_row
->displays_text_p
18654 && face
->box
== FACE_NO_BOX
18655 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18657 && !it
->glyph_row
->reversed_p
)
18660 /* Set the glyph row flag indicating that the face of the last glyph
18661 in the text area has to be drawn to the end of the text area. */
18662 it
->glyph_row
->fill_line_p
= 1;
18664 /* If current character of IT is not ASCII, make sure we have the
18665 ASCII face. This will be automatically undone the next time
18666 get_next_display_element returns a multibyte character. Note
18667 that the character will always be single byte in unibyte
18669 if (!ASCII_CHAR_P (it
->c
))
18671 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18674 if (FRAME_WINDOW_P (f
))
18676 /* If the row is empty, add a space with the current face of IT,
18677 so that we know which face to draw. */
18678 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18680 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18681 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
18682 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18684 #ifdef HAVE_WINDOW_SYSTEM
18685 if (it
->glyph_row
->reversed_p
)
18687 /* Prepend a stretch glyph to the row, such that the
18688 rightmost glyph will be drawn flushed all the way to the
18689 right margin of the window. The stretch glyph that will
18690 occupy the empty space, if any, to the left of the
18692 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18693 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18694 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18696 int row_width
, stretch_ascent
, stretch_width
;
18697 struct text_pos saved_pos
;
18698 int saved_face_id
, saved_avoid_cursor
;
18700 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18701 row_width
+= g
->pixel_width
;
18702 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18703 if (stretch_width
> 0)
18706 (((it
->ascent
+ it
->descent
)
18707 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18708 saved_pos
= it
->position
;
18709 memset (&it
->position
, 0, sizeof it
->position
);
18710 saved_avoid_cursor
= it
->avoid_cursor_p
;
18711 it
->avoid_cursor_p
= 1;
18712 saved_face_id
= it
->face_id
;
18713 /* The last row's stretch glyph should get the default
18714 face, to avoid painting the rest of the window with
18715 the region face, if the region ends at ZV. */
18716 if (it
->glyph_row
->ends_at_zv_p
)
18717 it
->face_id
= default_face
->id
;
18719 it
->face_id
= face
->id
;
18720 append_stretch_glyph (it
, make_number (0), stretch_width
,
18721 it
->ascent
+ it
->descent
, stretch_ascent
);
18722 it
->position
= saved_pos
;
18723 it
->avoid_cursor_p
= saved_avoid_cursor
;
18724 it
->face_id
= saved_face_id
;
18727 #endif /* HAVE_WINDOW_SYSTEM */
18731 /* Save some values that must not be changed. */
18732 int saved_x
= it
->current_x
;
18733 struct text_pos saved_pos
;
18734 Lisp_Object saved_object
;
18735 enum display_element_type saved_what
= it
->what
;
18736 int saved_face_id
= it
->face_id
;
18738 saved_object
= it
->object
;
18739 saved_pos
= it
->position
;
18741 it
->what
= IT_CHARACTER
;
18742 memset (&it
->position
, 0, sizeof it
->position
);
18743 it
->object
= make_number (0);
18744 it
->c
= it
->char_to_display
= ' ';
18746 /* The last row's blank glyphs should get the default face, to
18747 avoid painting the rest of the window with the region face,
18748 if the region ends at ZV. */
18749 if (it
->glyph_row
->ends_at_zv_p
)
18750 it
->face_id
= default_face
->id
;
18752 it
->face_id
= face
->id
;
18754 PRODUCE_GLYPHS (it
);
18756 while (it
->current_x
<= it
->last_visible_x
)
18757 PRODUCE_GLYPHS (it
);
18759 /* Don't count these blanks really. It would let us insert a left
18760 truncation glyph below and make us set the cursor on them, maybe. */
18761 it
->current_x
= saved_x
;
18762 it
->object
= saved_object
;
18763 it
->position
= saved_pos
;
18764 it
->what
= saved_what
;
18765 it
->face_id
= saved_face_id
;
18770 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18771 trailing whitespace. */
18774 trailing_whitespace_p (ptrdiff_t charpos
)
18776 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
18779 while (bytepos
< ZV_BYTE
18780 && (c
= FETCH_CHAR (bytepos
),
18781 c
== ' ' || c
== '\t'))
18784 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18786 if (bytepos
!= PT_BYTE
)
18793 /* Highlight trailing whitespace, if any, in ROW. */
18796 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18798 int used
= row
->used
[TEXT_AREA
];
18802 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18803 struct glyph
*glyph
= start
+ used
- 1;
18805 if (row
->reversed_p
)
18807 /* Right-to-left rows need to be processed in the opposite
18808 direction, so swap the edge pointers. */
18810 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18813 /* Skip over glyphs inserted to display the cursor at the
18814 end of a line, for extending the face of the last glyph
18815 to the end of the line on terminals, and for truncation
18816 and continuation glyphs. */
18817 if (!row
->reversed_p
)
18819 while (glyph
>= start
18820 && glyph
->type
== CHAR_GLYPH
18821 && INTEGERP (glyph
->object
))
18826 while (glyph
<= start
18827 && glyph
->type
== CHAR_GLYPH
18828 && INTEGERP (glyph
->object
))
18832 /* If last glyph is a space or stretch, and it's trailing
18833 whitespace, set the face of all trailing whitespace glyphs in
18834 IT->glyph_row to `trailing-whitespace'. */
18835 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18836 && BUFFERP (glyph
->object
)
18837 && (glyph
->type
== STRETCH_GLYPH
18838 || (glyph
->type
== CHAR_GLYPH
18839 && glyph
->u
.ch
== ' '))
18840 && trailing_whitespace_p (glyph
->charpos
))
18842 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18846 if (!row
->reversed_p
)
18848 while (glyph
>= start
18849 && BUFFERP (glyph
->object
)
18850 && (glyph
->type
== STRETCH_GLYPH
18851 || (glyph
->type
== CHAR_GLYPH
18852 && glyph
->u
.ch
== ' ')))
18853 (glyph
--)->face_id
= face_id
;
18857 while (glyph
<= start
18858 && BUFFERP (glyph
->object
)
18859 && (glyph
->type
== STRETCH_GLYPH
18860 || (glyph
->type
== CHAR_GLYPH
18861 && glyph
->u
.ch
== ' ')))
18862 (glyph
++)->face_id
= face_id
;
18869 /* Value is non-zero if glyph row ROW should be
18870 used to hold the cursor. */
18873 cursor_row_p (struct glyph_row
*row
)
18877 if (PT
== CHARPOS (row
->end
.pos
)
18878 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18880 /* Suppose the row ends on a string.
18881 Unless the row is continued, that means it ends on a newline
18882 in the string. If it's anything other than a display string
18883 (e.g., a before-string from an overlay), we don't want the
18884 cursor there. (This heuristic seems to give the optimal
18885 behavior for the various types of multi-line strings.)
18886 One exception: if the string has `cursor' property on one of
18887 its characters, we _do_ want the cursor there. */
18888 if (CHARPOS (row
->end
.string_pos
) >= 0)
18890 if (row
->continued_p
)
18894 /* Check for `display' property. */
18895 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18896 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18897 struct glyph
*glyph
;
18900 for (glyph
= end
; glyph
>= beg
; --glyph
)
18901 if (STRINGP (glyph
->object
))
18904 = Fget_char_property (make_number (PT
),
18908 && display_prop_string_p (prop
, glyph
->object
));
18909 /* If there's a `cursor' property on one of the
18910 string's characters, this row is a cursor row,
18911 even though this is not a display string. */
18914 Lisp_Object s
= glyph
->object
;
18916 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
18918 ptrdiff_t gpos
= glyph
->charpos
;
18920 if (!NILP (Fget_char_property (make_number (gpos
),
18932 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18934 /* If the row ends in middle of a real character,
18935 and the line is continued, we want the cursor here.
18936 That's because CHARPOS (ROW->end.pos) would equal
18937 PT if PT is before the character. */
18938 if (!row
->ends_in_ellipsis_p
)
18939 result
= row
->continued_p
;
18941 /* If the row ends in an ellipsis, then
18942 CHARPOS (ROW->end.pos) will equal point after the
18943 invisible text. We want that position to be displayed
18944 after the ellipsis. */
18947 /* If the row ends at ZV, display the cursor at the end of that
18948 row instead of at the start of the row below. */
18949 else if (row
->ends_at_zv_p
)
18960 /* Push the property PROP so that it will be rendered at the current
18961 position in IT. Return 1 if PROP was successfully pushed, 0
18962 otherwise. Called from handle_line_prefix to handle the
18963 `line-prefix' and `wrap-prefix' properties. */
18966 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
18968 struct text_pos pos
=
18969 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
18971 eassert (it
->method
== GET_FROM_BUFFER
18972 || it
->method
== GET_FROM_DISPLAY_VECTOR
18973 || it
->method
== GET_FROM_STRING
);
18975 /* We need to save the current buffer/string position, so it will be
18976 restored by pop_it, because iterate_out_of_display_property
18977 depends on that being set correctly, but some situations leave
18978 it->position not yet set when this function is called. */
18979 push_it (it
, &pos
);
18981 if (STRINGP (prop
))
18983 if (SCHARS (prop
) == 0)
18990 it
->string_from_prefix_prop_p
= 1;
18991 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18992 it
->current
.overlay_string_index
= -1;
18993 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18994 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18995 it
->method
= GET_FROM_STRING
;
18996 it
->stop_charpos
= 0;
18998 it
->base_level_stop
= 0;
19000 /* Force paragraph direction to be that of the parent
19002 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19003 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19005 it
->paragraph_embedding
= L2R
;
19007 /* Set up the bidi iterator for this display string. */
19010 it
->bidi_it
.string
.lstring
= it
->string
;
19011 it
->bidi_it
.string
.s
= NULL
;
19012 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19013 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19014 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19015 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19016 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19019 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19021 it
->method
= GET_FROM_STRETCH
;
19024 #ifdef HAVE_WINDOW_SYSTEM
19025 else if (IMAGEP (prop
))
19027 it
->what
= IT_IMAGE
;
19028 it
->image_id
= lookup_image (it
->f
, prop
);
19029 it
->method
= GET_FROM_IMAGE
;
19031 #endif /* HAVE_WINDOW_SYSTEM */
19034 pop_it (it
); /* bogus display property, give up */
19041 /* Return the character-property PROP at the current position in IT. */
19044 get_it_property (struct it
*it
, Lisp_Object prop
)
19046 Lisp_Object position
;
19048 if (STRINGP (it
->object
))
19049 position
= make_number (IT_STRING_CHARPOS (*it
));
19050 else if (BUFFERP (it
->object
))
19051 position
= make_number (IT_CHARPOS (*it
));
19055 return Fget_char_property (position
, prop
, it
->object
);
19058 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19061 handle_line_prefix (struct it
*it
)
19063 Lisp_Object prefix
;
19065 if (it
->continuation_lines_width
> 0)
19067 prefix
= get_it_property (it
, Qwrap_prefix
);
19069 prefix
= Vwrap_prefix
;
19073 prefix
= get_it_property (it
, Qline_prefix
);
19075 prefix
= Vline_prefix
;
19077 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19079 /* If the prefix is wider than the window, and we try to wrap
19080 it, it would acquire its own wrap prefix, and so on till the
19081 iterator stack overflows. So, don't wrap the prefix. */
19082 it
->line_wrap
= TRUNCATE
;
19083 it
->avoid_cursor_p
= 1;
19089 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19090 only for R2L lines from display_line and display_string, when they
19091 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19092 the line/string needs to be continued on the next glyph row. */
19094 unproduce_glyphs (struct it
*it
, int n
)
19096 struct glyph
*glyph
, *end
;
19098 eassert (it
->glyph_row
);
19099 eassert (it
->glyph_row
->reversed_p
);
19100 eassert (it
->area
== TEXT_AREA
);
19101 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19103 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19104 n
= it
->glyph_row
->used
[TEXT_AREA
];
19105 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19106 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19107 for ( ; glyph
< end
; glyph
++)
19108 glyph
[-n
] = *glyph
;
19111 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19112 and ROW->maxpos. */
19114 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19115 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19116 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19118 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19119 lines' rows is implemented for bidi-reordered rows. */
19121 /* ROW->minpos is the value of min_pos, the minimal buffer position
19122 we have in ROW, or ROW->start.pos if that is smaller. */
19123 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19124 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19126 /* We didn't find buffer positions smaller than ROW->start, or
19127 didn't find _any_ valid buffer positions in any of the glyphs,
19128 so we must trust the iterator's computed positions. */
19129 row
->minpos
= row
->start
.pos
;
19132 max_pos
= CHARPOS (it
->current
.pos
);
19133 max_bpos
= BYTEPOS (it
->current
.pos
);
19136 /* Here are the various use-cases for ending the row, and the
19137 corresponding values for ROW->maxpos:
19139 Line ends in a newline from buffer eol_pos + 1
19140 Line is continued from buffer max_pos + 1
19141 Line is truncated on right it->current.pos
19142 Line ends in a newline from string max_pos + 1(*)
19143 (*) + 1 only when line ends in a forward scan
19144 Line is continued from string max_pos
19145 Line is continued from display vector max_pos
19146 Line is entirely from a string min_pos == max_pos
19147 Line is entirely from a display vector min_pos == max_pos
19148 Line that ends at ZV ZV
19150 If you discover other use-cases, please add them here as
19152 if (row
->ends_at_zv_p
)
19153 row
->maxpos
= it
->current
.pos
;
19154 else if (row
->used
[TEXT_AREA
])
19156 int seen_this_string
= 0;
19157 struct glyph_row
*r1
= row
- 1;
19159 /* Did we see the same display string on the previous row? */
19160 if (STRINGP (it
->object
)
19161 /* this is not the first row */
19162 && row
> it
->w
->desired_matrix
->rows
19163 /* previous row is not the header line */
19164 && !r1
->mode_line_p
19165 /* previous row also ends in a newline from a string */
19166 && r1
->ends_in_newline_from_string_p
)
19168 struct glyph
*start
, *end
;
19170 /* Search for the last glyph of the previous row that came
19171 from buffer or string. Depending on whether the row is
19172 L2R or R2L, we need to process it front to back or the
19173 other way round. */
19174 if (!r1
->reversed_p
)
19176 start
= r1
->glyphs
[TEXT_AREA
];
19177 end
= start
+ r1
->used
[TEXT_AREA
];
19178 /* Glyphs inserted by redisplay have an integer (zero)
19179 as their object. */
19181 && INTEGERP ((end
- 1)->object
)
19182 && (end
- 1)->charpos
<= 0)
19186 if (EQ ((end
- 1)->object
, it
->object
))
19187 seen_this_string
= 1;
19190 /* If all the glyphs of the previous row were inserted
19191 by redisplay, it means the previous row was
19192 produced from a single newline, which is only
19193 possible if that newline came from the same string
19194 as the one which produced this ROW. */
19195 seen_this_string
= 1;
19199 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19200 start
= end
+ r1
->used
[TEXT_AREA
];
19202 && INTEGERP ((end
+ 1)->object
)
19203 && (end
+ 1)->charpos
<= 0)
19207 if (EQ ((end
+ 1)->object
, it
->object
))
19208 seen_this_string
= 1;
19211 seen_this_string
= 1;
19214 /* Take note of each display string that covers a newline only
19215 once, the first time we see it. This is for when a display
19216 string includes more than one newline in it. */
19217 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
19219 /* If we were scanning the buffer forward when we displayed
19220 the string, we want to account for at least one buffer
19221 position that belongs to this row (position covered by
19222 the display string), so that cursor positioning will
19223 consider this row as a candidate when point is at the end
19224 of the visual line represented by this row. This is not
19225 required when scanning back, because max_pos will already
19226 have a much larger value. */
19227 if (CHARPOS (row
->end
.pos
) > max_pos
)
19228 INC_BOTH (max_pos
, max_bpos
);
19229 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19231 else if (CHARPOS (it
->eol_pos
) > 0)
19232 SET_TEXT_POS (row
->maxpos
,
19233 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
19234 else if (row
->continued_p
)
19236 /* If max_pos is different from IT's current position, it
19237 means IT->method does not belong to the display element
19238 at max_pos. However, it also means that the display
19239 element at max_pos was displayed in its entirety on this
19240 line, which is equivalent to saying that the next line
19241 starts at the next buffer position. */
19242 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
19243 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19246 INC_BOTH (max_pos
, max_bpos
);
19247 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19250 else if (row
->truncated_on_right_p
)
19251 /* display_line already called reseat_at_next_visible_line_start,
19252 which puts the iterator at the beginning of the next line, in
19253 the logical order. */
19254 row
->maxpos
= it
->current
.pos
;
19255 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
19256 /* A line that is entirely from a string/image/stretch... */
19257 row
->maxpos
= row
->minpos
;
19262 row
->maxpos
= it
->current
.pos
;
19265 /* Construct the glyph row IT->glyph_row in the desired matrix of
19266 IT->w from text at the current position of IT. See dispextern.h
19267 for an overview of struct it. Value is non-zero if
19268 IT->glyph_row displays text, as opposed to a line displaying ZV
19272 display_line (struct it
*it
)
19274 struct glyph_row
*row
= it
->glyph_row
;
19275 Lisp_Object overlay_arrow_string
;
19277 void *wrap_data
= NULL
;
19278 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
19279 int wrap_row_used
= -1;
19280 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
19281 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
19282 int wrap_row_extra_line_spacing
IF_LINT (= 0);
19283 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
19284 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
19286 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
19287 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
19289 /* We always start displaying at hpos zero even if hscrolled. */
19290 eassert (it
->hpos
== 0 && it
->current_x
== 0);
19292 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
19293 >= it
->w
->desired_matrix
->nrows
)
19295 it
->w
->nrows_scale_factor
++;
19296 fonts_changed_p
= 1;
19300 /* Is IT->w showing the region? */
19301 wset_region_showing (it
->w
, it
->region_beg_charpos
> 0 ? Qt
: Qnil
);
19303 /* Clear the result glyph row and enable it. */
19304 prepare_desired_row (row
);
19306 row
->y
= it
->current_y
;
19307 row
->start
= it
->start
;
19308 row
->continuation_lines_width
= it
->continuation_lines_width
;
19309 row
->displays_text_p
= 1;
19310 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
19311 it
->starts_in_middle_of_char_p
= 0;
19313 /* Arrange the overlays nicely for our purposes. Usually, we call
19314 display_line on only one line at a time, in which case this
19315 can't really hurt too much, or we call it on lines which appear
19316 one after another in the buffer, in which case all calls to
19317 recenter_overlay_lists but the first will be pretty cheap. */
19318 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
19320 /* Move over display elements that are not visible because we are
19321 hscrolled. This may stop at an x-position < IT->first_visible_x
19322 if the first glyph is partially visible or if we hit a line end. */
19323 if (it
->current_x
< it
->first_visible_x
)
19325 enum move_it_result move_result
;
19327 this_line_min_pos
= row
->start
.pos
;
19328 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
19329 MOVE_TO_POS
| MOVE_TO_X
);
19330 /* If we are under a large hscroll, move_it_in_display_line_to
19331 could hit the end of the line without reaching
19332 it->first_visible_x. Pretend that we did reach it. This is
19333 especially important on a TTY, where we will call
19334 extend_face_to_end_of_line, which needs to know how many
19335 blank glyphs to produce. */
19336 if (it
->current_x
< it
->first_visible_x
19337 && (move_result
== MOVE_NEWLINE_OR_CR
19338 || move_result
== MOVE_POS_MATCH_OR_ZV
))
19339 it
->current_x
= it
->first_visible_x
;
19341 /* Record the smallest positions seen while we moved over
19342 display elements that are not visible. This is needed by
19343 redisplay_internal for optimizing the case where the cursor
19344 stays inside the same line. The rest of this function only
19345 considers positions that are actually displayed, so
19346 RECORD_MAX_MIN_POS will not otherwise record positions that
19347 are hscrolled to the left of the left edge of the window. */
19348 min_pos
= CHARPOS (this_line_min_pos
);
19349 min_bpos
= BYTEPOS (this_line_min_pos
);
19353 /* We only do this when not calling `move_it_in_display_line_to'
19354 above, because move_it_in_display_line_to calls
19355 handle_line_prefix itself. */
19356 handle_line_prefix (it
);
19359 /* Get the initial row height. This is either the height of the
19360 text hscrolled, if there is any, or zero. */
19361 row
->ascent
= it
->max_ascent
;
19362 row
->height
= it
->max_ascent
+ it
->max_descent
;
19363 row
->phys_ascent
= it
->max_phys_ascent
;
19364 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19365 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19367 /* Utility macro to record max and min buffer positions seen until now. */
19368 #define RECORD_MAX_MIN_POS(IT) \
19371 int composition_p = !STRINGP ((IT)->string) \
19372 && ((IT)->what == IT_COMPOSITION); \
19373 ptrdiff_t current_pos = \
19374 composition_p ? (IT)->cmp_it.charpos \
19375 : IT_CHARPOS (*(IT)); \
19376 ptrdiff_t current_bpos = \
19377 composition_p ? CHAR_TO_BYTE (current_pos) \
19378 : IT_BYTEPOS (*(IT)); \
19379 if (current_pos < min_pos) \
19381 min_pos = current_pos; \
19382 min_bpos = current_bpos; \
19384 if (IT_CHARPOS (*it) > max_pos) \
19386 max_pos = IT_CHARPOS (*it); \
19387 max_bpos = IT_BYTEPOS (*it); \
19392 /* Loop generating characters. The loop is left with IT on the next
19393 character to display. */
19396 int n_glyphs_before
, hpos_before
, x_before
;
19398 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
19400 /* Retrieve the next thing to display. Value is zero if end of
19402 if (!get_next_display_element (it
))
19404 /* Maybe add a space at the end of this line that is used to
19405 display the cursor there under X. Set the charpos of the
19406 first glyph of blank lines not corresponding to any text
19408 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19409 row
->exact_window_width_line_p
= 1;
19410 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
19411 || row
->used
[TEXT_AREA
] == 0)
19413 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
19414 row
->displays_text_p
= 0;
19416 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
19417 && (!MINI_WINDOW_P (it
->w
)
19418 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
19419 row
->indicate_empty_line_p
= 1;
19422 it
->continuation_lines_width
= 0;
19423 row
->ends_at_zv_p
= 1;
19424 /* A row that displays right-to-left text must always have
19425 its last face extended all the way to the end of line,
19426 even if this row ends in ZV, because we still write to
19427 the screen left to right. We also need to extend the
19428 last face if the default face is remapped to some
19429 different face, otherwise the functions that clear
19430 portions of the screen will clear with the default face's
19431 background color. */
19432 if (row
->reversed_p
19433 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
19434 extend_face_to_end_of_line (it
);
19438 /* Now, get the metrics of what we want to display. This also
19439 generates glyphs in `row' (which is IT->glyph_row). */
19440 n_glyphs_before
= row
->used
[TEXT_AREA
];
19443 /* Remember the line height so far in case the next element doesn't
19444 fit on the line. */
19445 if (it
->line_wrap
!= TRUNCATE
)
19447 ascent
= it
->max_ascent
;
19448 descent
= it
->max_descent
;
19449 phys_ascent
= it
->max_phys_ascent
;
19450 phys_descent
= it
->max_phys_descent
;
19452 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
19454 if (IT_DISPLAYING_WHITESPACE (it
))
19458 SAVE_IT (wrap_it
, *it
, wrap_data
);
19460 wrap_row_used
= row
->used
[TEXT_AREA
];
19461 wrap_row_ascent
= row
->ascent
;
19462 wrap_row_height
= row
->height
;
19463 wrap_row_phys_ascent
= row
->phys_ascent
;
19464 wrap_row_phys_height
= row
->phys_height
;
19465 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
19466 wrap_row_min_pos
= min_pos
;
19467 wrap_row_min_bpos
= min_bpos
;
19468 wrap_row_max_pos
= max_pos
;
19469 wrap_row_max_bpos
= max_bpos
;
19475 PRODUCE_GLYPHS (it
);
19477 /* If this display element was in marginal areas, continue with
19479 if (it
->area
!= TEXT_AREA
)
19481 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19482 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19483 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19484 row
->phys_height
= max (row
->phys_height
,
19485 it
->max_phys_ascent
+ it
->max_phys_descent
);
19486 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19487 it
->max_extra_line_spacing
);
19488 set_iterator_to_next (it
, 1);
19492 /* Does the display element fit on the line? If we truncate
19493 lines, we should draw past the right edge of the window. If
19494 we don't truncate, we want to stop so that we can display the
19495 continuation glyph before the right margin. If lines are
19496 continued, there are two possible strategies for characters
19497 resulting in more than 1 glyph (e.g. tabs): Display as many
19498 glyphs as possible in this line and leave the rest for the
19499 continuation line, or display the whole element in the next
19500 line. Original redisplay did the former, so we do it also. */
19501 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
19502 hpos_before
= it
->hpos
;
19505 if (/* Not a newline. */
19507 /* Glyphs produced fit entirely in the line. */
19508 && it
->current_x
< it
->last_visible_x
)
19510 it
->hpos
+= nglyphs
;
19511 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19512 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19513 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19514 row
->phys_height
= max (row
->phys_height
,
19515 it
->max_phys_ascent
+ it
->max_phys_descent
);
19516 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19517 it
->max_extra_line_spacing
);
19518 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
19519 row
->x
= x
- it
->first_visible_x
;
19520 /* Record the maximum and minimum buffer positions seen so
19521 far in glyphs that will be displayed by this row. */
19523 RECORD_MAX_MIN_POS (it
);
19528 struct glyph
*glyph
;
19530 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
19532 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19533 new_x
= x
+ glyph
->pixel_width
;
19535 if (/* Lines are continued. */
19536 it
->line_wrap
!= TRUNCATE
19537 && (/* Glyph doesn't fit on the line. */
19538 new_x
> it
->last_visible_x
19539 /* Or it fits exactly on a window system frame. */
19540 || (new_x
== it
->last_visible_x
19541 && FRAME_WINDOW_P (it
->f
)
19542 && (row
->reversed_p
19543 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19544 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
19546 /* End of a continued line. */
19549 || (new_x
== it
->last_visible_x
19550 && FRAME_WINDOW_P (it
->f
)
19551 && (row
->reversed_p
19552 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19553 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
19555 /* Current glyph is the only one on the line or
19556 fits exactly on the line. We must continue
19557 the line because we can't draw the cursor
19558 after the glyph. */
19559 row
->continued_p
= 1;
19560 it
->current_x
= new_x
;
19561 it
->continuation_lines_width
+= new_x
;
19563 if (i
== nglyphs
- 1)
19565 /* If line-wrap is on, check if a previous
19566 wrap point was found. */
19567 if (wrap_row_used
> 0
19568 /* Even if there is a previous wrap
19569 point, continue the line here as
19570 usual, if (i) the previous character
19571 was a space or tab AND (ii) the
19572 current character is not. */
19574 || IT_DISPLAYING_WHITESPACE (it
)))
19577 /* Record the maximum and minimum buffer
19578 positions seen so far in glyphs that will be
19579 displayed by this row. */
19581 RECORD_MAX_MIN_POS (it
);
19582 set_iterator_to_next (it
, 1);
19583 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19585 if (!get_next_display_element (it
))
19587 row
->exact_window_width_line_p
= 1;
19588 it
->continuation_lines_width
= 0;
19589 row
->continued_p
= 0;
19590 row
->ends_at_zv_p
= 1;
19592 else if (ITERATOR_AT_END_OF_LINE_P (it
))
19594 row
->continued_p
= 0;
19595 row
->exact_window_width_line_p
= 1;
19599 else if (it
->bidi_p
)
19600 RECORD_MAX_MIN_POS (it
);
19602 else if (CHAR_GLYPH_PADDING_P (*glyph
)
19603 && !FRAME_WINDOW_P (it
->f
))
19605 /* A padding glyph that doesn't fit on this line.
19606 This means the whole character doesn't fit
19608 if (row
->reversed_p
)
19609 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19610 - n_glyphs_before
);
19611 row
->used
[TEXT_AREA
] = n_glyphs_before
;
19613 /* Fill the rest of the row with continuation
19614 glyphs like in 20.x. */
19615 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19616 < row
->glyphs
[1 + TEXT_AREA
])
19617 produce_special_glyphs (it
, IT_CONTINUATION
);
19619 row
->continued_p
= 1;
19620 it
->current_x
= x_before
;
19621 it
->continuation_lines_width
+= x_before
;
19623 /* Restore the height to what it was before the
19624 element not fitting on the line. */
19625 it
->max_ascent
= ascent
;
19626 it
->max_descent
= descent
;
19627 it
->max_phys_ascent
= phys_ascent
;
19628 it
->max_phys_descent
= phys_descent
;
19630 else if (wrap_row_used
> 0)
19633 if (row
->reversed_p
)
19634 unproduce_glyphs (it
,
19635 row
->used
[TEXT_AREA
] - wrap_row_used
);
19636 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19637 it
->continuation_lines_width
+= wrap_x
;
19638 row
->used
[TEXT_AREA
] = wrap_row_used
;
19639 row
->ascent
= wrap_row_ascent
;
19640 row
->height
= wrap_row_height
;
19641 row
->phys_ascent
= wrap_row_phys_ascent
;
19642 row
->phys_height
= wrap_row_phys_height
;
19643 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19644 min_pos
= wrap_row_min_pos
;
19645 min_bpos
= wrap_row_min_bpos
;
19646 max_pos
= wrap_row_max_pos
;
19647 max_bpos
= wrap_row_max_bpos
;
19648 row
->continued_p
= 1;
19649 row
->ends_at_zv_p
= 0;
19650 row
->exact_window_width_line_p
= 0;
19651 it
->continuation_lines_width
+= x
;
19653 /* Make sure that a non-default face is extended
19654 up to the right margin of the window. */
19655 extend_face_to_end_of_line (it
);
19657 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19659 /* A TAB that extends past the right edge of the
19660 window. This produces a single glyph on
19661 window system frames. We leave the glyph in
19662 this row and let it fill the row, but don't
19663 consume the TAB. */
19664 if ((row
->reversed_p
19665 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19666 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19667 produce_special_glyphs (it
, IT_CONTINUATION
);
19668 it
->continuation_lines_width
+= it
->last_visible_x
;
19669 row
->ends_in_middle_of_char_p
= 1;
19670 row
->continued_p
= 1;
19671 glyph
->pixel_width
= it
->last_visible_x
- x
;
19672 it
->starts_in_middle_of_char_p
= 1;
19676 /* Something other than a TAB that draws past
19677 the right edge of the window. Restore
19678 positions to values before the element. */
19679 if (row
->reversed_p
)
19680 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19681 - (n_glyphs_before
+ i
));
19682 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19684 /* Display continuation glyphs. */
19685 it
->current_x
= x_before
;
19686 it
->continuation_lines_width
+= x
;
19687 if (!FRAME_WINDOW_P (it
->f
)
19688 || (row
->reversed_p
19689 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19690 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19691 produce_special_glyphs (it
, IT_CONTINUATION
);
19692 row
->continued_p
= 1;
19694 extend_face_to_end_of_line (it
);
19696 if (nglyphs
> 1 && i
> 0)
19698 row
->ends_in_middle_of_char_p
= 1;
19699 it
->starts_in_middle_of_char_p
= 1;
19702 /* Restore the height to what it was before the
19703 element not fitting on the line. */
19704 it
->max_ascent
= ascent
;
19705 it
->max_descent
= descent
;
19706 it
->max_phys_ascent
= phys_ascent
;
19707 it
->max_phys_descent
= phys_descent
;
19712 else if (new_x
> it
->first_visible_x
)
19714 /* Increment number of glyphs actually displayed. */
19717 /* Record the maximum and minimum buffer positions
19718 seen so far in glyphs that will be displayed by
19721 RECORD_MAX_MIN_POS (it
);
19723 if (x
< it
->first_visible_x
)
19724 /* Glyph is partially visible, i.e. row starts at
19725 negative X position. */
19726 row
->x
= x
- it
->first_visible_x
;
19730 /* Glyph is completely off the left margin of the
19731 window. This should not happen because of the
19732 move_it_in_display_line at the start of this
19733 function, unless the text display area of the
19734 window is empty. */
19735 eassert (it
->first_visible_x
<= it
->last_visible_x
);
19738 /* Even if this display element produced no glyphs at all,
19739 we want to record its position. */
19740 if (it
->bidi_p
&& nglyphs
== 0)
19741 RECORD_MAX_MIN_POS (it
);
19743 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19744 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19745 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19746 row
->phys_height
= max (row
->phys_height
,
19747 it
->max_phys_ascent
+ it
->max_phys_descent
);
19748 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19749 it
->max_extra_line_spacing
);
19751 /* End of this display line if row is continued. */
19752 if (row
->continued_p
|| row
->ends_at_zv_p
)
19757 /* Is this a line end? If yes, we're also done, after making
19758 sure that a non-default face is extended up to the right
19759 margin of the window. */
19760 if (ITERATOR_AT_END_OF_LINE_P (it
))
19762 int used_before
= row
->used
[TEXT_AREA
];
19764 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19766 /* Add a space at the end of the line that is used to
19767 display the cursor there. */
19768 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19769 append_space_for_newline (it
, 0);
19771 /* Extend the face to the end of the line. */
19772 extend_face_to_end_of_line (it
);
19774 /* Make sure we have the position. */
19775 if (used_before
== 0)
19776 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19778 /* Record the position of the newline, for use in
19780 it
->eol_pos
= it
->current
.pos
;
19782 /* Consume the line end. This skips over invisible lines. */
19783 set_iterator_to_next (it
, 1);
19784 it
->continuation_lines_width
= 0;
19788 /* Proceed with next display element. Note that this skips
19789 over lines invisible because of selective display. */
19790 set_iterator_to_next (it
, 1);
19792 /* If we truncate lines, we are done when the last displayed
19793 glyphs reach past the right margin of the window. */
19794 if (it
->line_wrap
== TRUNCATE
19795 && (FRAME_WINDOW_P (it
->f
) && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19796 ? (it
->current_x
>= it
->last_visible_x
)
19797 : (it
->current_x
> it
->last_visible_x
)))
19799 /* Maybe add truncation glyphs. */
19800 if (!FRAME_WINDOW_P (it
->f
)
19801 || (row
->reversed_p
19802 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19803 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
19807 if (!row
->reversed_p
)
19809 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19810 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19815 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19816 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19818 /* Remove any padding glyphs at the front of ROW, to
19819 make room for the truncation glyphs we will be
19820 adding below. The loop below always inserts at
19821 least one truncation glyph, so also remove the
19822 last glyph added to ROW. */
19823 unproduce_glyphs (it
, i
+ 1);
19824 /* Adjust i for the loop below. */
19825 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19828 it
->current_x
= x_before
;
19829 if (!FRAME_WINDOW_P (it
->f
))
19831 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19833 row
->used
[TEXT_AREA
] = i
;
19834 produce_special_glyphs (it
, IT_TRUNCATION
);
19839 row
->used
[TEXT_AREA
] = i
;
19840 produce_special_glyphs (it
, IT_TRUNCATION
);
19843 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19845 /* Don't truncate if we can overflow newline into fringe. */
19846 if (!get_next_display_element (it
))
19848 it
->continuation_lines_width
= 0;
19849 row
->ends_at_zv_p
= 1;
19850 row
->exact_window_width_line_p
= 1;
19853 if (ITERATOR_AT_END_OF_LINE_P (it
))
19855 row
->exact_window_width_line_p
= 1;
19856 goto at_end_of_line
;
19858 it
->current_x
= x_before
;
19861 row
->truncated_on_right_p
= 1;
19862 it
->continuation_lines_width
= 0;
19863 reseat_at_next_visible_line_start (it
, 0);
19864 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19865 it
->hpos
= hpos_before
;
19871 bidi_unshelve_cache (wrap_data
, 1);
19873 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19874 at the left window margin. */
19875 if (it
->first_visible_x
19876 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19878 if (!FRAME_WINDOW_P (it
->f
)
19879 || (row
->reversed_p
19880 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19881 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
19882 insert_left_trunc_glyphs (it
);
19883 row
->truncated_on_left_p
= 1;
19886 /* Remember the position at which this line ends.
19888 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19889 cannot be before the call to find_row_edges below, since that is
19890 where these positions are determined. */
19891 row
->end
= it
->current
;
19894 row
->minpos
= row
->start
.pos
;
19895 row
->maxpos
= row
->end
.pos
;
19899 /* ROW->minpos and ROW->maxpos must be the smallest and
19900 `1 + the largest' buffer positions in ROW. But if ROW was
19901 bidi-reordered, these two positions can be anywhere in the
19902 row, so we must determine them now. */
19903 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19906 /* If the start of this line is the overlay arrow-position, then
19907 mark this glyph row as the one containing the overlay arrow.
19908 This is clearly a mess with variable size fonts. It would be
19909 better to let it be displayed like cursors under X. */
19910 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19911 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19912 !NILP (overlay_arrow_string
)))
19914 /* Overlay arrow in window redisplay is a fringe bitmap. */
19915 if (STRINGP (overlay_arrow_string
))
19917 struct glyph_row
*arrow_row
19918 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19919 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19920 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19921 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19922 struct glyph
*p2
, *end
;
19924 /* Copy the arrow glyphs. */
19925 while (glyph
< arrow_end
)
19928 /* Throw away padding glyphs. */
19930 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19931 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19937 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19942 eassert (INTEGERP (overlay_arrow_string
));
19943 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19945 overlay_arrow_seen
= 1;
19948 /* Highlight trailing whitespace. */
19949 if (!NILP (Vshow_trailing_whitespace
))
19950 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19952 /* Compute pixel dimensions of this line. */
19953 compute_line_metrics (it
);
19955 /* Implementation note: No changes in the glyphs of ROW or in their
19956 faces can be done past this point, because compute_line_metrics
19957 computes ROW's hash value and stores it within the glyph_row
19960 /* Record whether this row ends inside an ellipsis. */
19961 row
->ends_in_ellipsis_p
19962 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19963 && it
->ellipsis_p
);
19965 /* Save fringe bitmaps in this row. */
19966 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19967 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19968 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19969 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19971 it
->left_user_fringe_bitmap
= 0;
19972 it
->left_user_fringe_face_id
= 0;
19973 it
->right_user_fringe_bitmap
= 0;
19974 it
->right_user_fringe_face_id
= 0;
19976 /* Maybe set the cursor. */
19977 cvpos
= it
->w
->cursor
.vpos
;
19979 /* In bidi-reordered rows, keep checking for proper cursor
19980 position even if one has been found already, because buffer
19981 positions in such rows change non-linearly with ROW->VPOS,
19982 when a line is continued. One exception: when we are at ZV,
19983 display cursor on the first suitable glyph row, since all
19984 the empty rows after that also have their position set to ZV. */
19985 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19986 lines' rows is implemented for bidi-reordered rows. */
19988 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19989 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19990 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19991 && cursor_row_p (row
))
19992 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19994 /* Prepare for the next line. This line starts horizontally at (X
19995 HPOS) = (0 0). Vertical positions are incremented. As a
19996 convenience for the caller, IT->glyph_row is set to the next
19998 it
->current_x
= it
->hpos
= 0;
19999 it
->current_y
+= row
->height
;
20000 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20003 /* The next row should by default use the same value of the
20004 reversed_p flag as this one. set_iterator_to_next decides when
20005 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20006 the flag accordingly. */
20007 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20008 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20009 it
->start
= row
->end
;
20010 return row
->displays_text_p
;
20012 #undef RECORD_MAX_MIN_POS
20015 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20016 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20017 doc
: /* Return paragraph direction at point in BUFFER.
20018 Value is either `left-to-right' or `right-to-left'.
20019 If BUFFER is omitted or nil, it defaults to the current buffer.
20021 Paragraph direction determines how the text in the paragraph is displayed.
20022 In left-to-right paragraphs, text begins at the left margin of the window
20023 and the reading direction is generally left to right. In right-to-left
20024 paragraphs, text begins at the right margin and is read from right to left.
20026 See also `bidi-paragraph-direction'. */)
20027 (Lisp_Object buffer
)
20029 struct buffer
*buf
= current_buffer
;
20030 struct buffer
*old
= buf
;
20032 if (! NILP (buffer
))
20034 CHECK_BUFFER (buffer
);
20035 buf
= XBUFFER (buffer
);
20038 if (NILP (BVAR (buf
, bidi_display_reordering
))
20039 || NILP (BVAR (buf
, enable_multibyte_characters
))
20040 /* When we are loading loadup.el, the character property tables
20041 needed for bidi iteration are not yet available. */
20042 || !NILP (Vpurify_flag
))
20043 return Qleft_to_right
;
20044 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20045 return BVAR (buf
, bidi_paragraph_direction
);
20048 /* Determine the direction from buffer text. We could try to
20049 use current_matrix if it is up to date, but this seems fast
20050 enough as it is. */
20051 struct bidi_it itb
;
20052 ptrdiff_t pos
= BUF_PT (buf
);
20053 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20055 void *itb_data
= bidi_shelve_cache ();
20057 set_buffer_temp (buf
);
20058 /* bidi_paragraph_init finds the base direction of the paragraph
20059 by searching forward from paragraph start. We need the base
20060 direction of the current or _previous_ paragraph, so we need
20061 to make sure we are within that paragraph. To that end, find
20062 the previous non-empty line. */
20063 if (pos
>= ZV
&& pos
> BEGV
)
20066 bytepos
= CHAR_TO_BYTE (pos
);
20068 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20069 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20071 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20072 || c
== ' ' || c
== '\t' || c
== '\f')
20074 if (bytepos
<= BEGV_BYTE
)
20079 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20082 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20083 itb
.paragraph_dir
= NEUTRAL_DIR
;
20084 itb
.string
.s
= NULL
;
20085 itb
.string
.lstring
= Qnil
;
20086 itb
.string
.bufpos
= 0;
20087 itb
.string
.unibyte
= 0;
20088 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20089 bidi_unshelve_cache (itb_data
, 0);
20090 set_buffer_temp (old
);
20091 switch (itb
.paragraph_dir
)
20094 return Qleft_to_right
;
20097 return Qright_to_left
;
20107 /***********************************************************************
20109 ***********************************************************************/
20111 /* Redisplay the menu bar in the frame for window W.
20113 The menu bar of X frames that don't have X toolkit support is
20114 displayed in a special window W->frame->menu_bar_window.
20116 The menu bar of terminal frames is treated specially as far as
20117 glyph matrices are concerned. Menu bar lines are not part of
20118 windows, so the update is done directly on the frame matrix rows
20119 for the menu bar. */
20122 display_menu_bar (struct window
*w
)
20124 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20129 /* Don't do all this for graphical frames. */
20131 if (FRAME_W32_P (f
))
20134 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
20140 if (FRAME_NS_P (f
))
20142 #endif /* HAVE_NS */
20144 #ifdef USE_X_TOOLKIT
20145 eassert (!FRAME_WINDOW_P (f
));
20146 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
20147 it
.first_visible_x
= 0;
20148 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
20149 #else /* not USE_X_TOOLKIT */
20150 if (FRAME_WINDOW_P (f
))
20152 /* Menu bar lines are displayed in the desired matrix of the
20153 dummy window menu_bar_window. */
20154 struct window
*menu_w
;
20155 eassert (WINDOWP (f
->menu_bar_window
));
20156 menu_w
= XWINDOW (f
->menu_bar_window
);
20157 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
20159 it
.first_visible_x
= 0;
20160 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
20164 /* This is a TTY frame, i.e. character hpos/vpos are used as
20166 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
20168 it
.first_visible_x
= 0;
20169 it
.last_visible_x
= FRAME_COLS (f
);
20171 #endif /* not USE_X_TOOLKIT */
20173 /* FIXME: This should be controlled by a user option. See the
20174 comments in redisplay_tool_bar and display_mode_line about
20176 it
.paragraph_embedding
= L2R
;
20178 /* Clear all rows of the menu bar. */
20179 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
20181 struct glyph_row
*row
= it
.glyph_row
+ i
;
20182 clear_glyph_row (row
);
20183 row
->enabled_p
= 1;
20184 row
->full_width_p
= 1;
20187 /* Display all items of the menu bar. */
20188 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
20189 for (i
= 0; i
< ASIZE (items
); i
+= 4)
20191 Lisp_Object string
;
20193 /* Stop at nil string. */
20194 string
= AREF (items
, i
+ 1);
20198 /* Remember where item was displayed. */
20199 ASET (items
, i
+ 3, make_number (it
.hpos
));
20201 /* Display the item, pad with one space. */
20202 if (it
.current_x
< it
.last_visible_x
)
20203 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
20204 SCHARS (string
) + 1, 0, 0, -1);
20207 /* Fill out the line with spaces. */
20208 if (it
.current_x
< it
.last_visible_x
)
20209 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
20211 /* Compute the total height of the lines. */
20212 compute_line_metrics (&it
);
20217 /***********************************************************************
20219 ***********************************************************************/
20221 /* Redisplay mode lines in the window tree whose root is WINDOW. If
20222 FORCE is non-zero, redisplay mode lines unconditionally.
20223 Otherwise, redisplay only mode lines that are garbaged. Value is
20224 the number of windows whose mode lines were redisplayed. */
20227 redisplay_mode_lines (Lisp_Object window
, int force
)
20231 while (!NILP (window
))
20233 struct window
*w
= XWINDOW (window
);
20235 if (WINDOWP (w
->hchild
))
20236 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
20237 else if (WINDOWP (w
->vchild
))
20238 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
20240 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
20241 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
20243 struct text_pos lpoint
;
20244 struct buffer
*old
= current_buffer
;
20246 /* Set the window's buffer for the mode line display. */
20247 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
20248 set_buffer_internal_1 (XBUFFER (w
->buffer
));
20250 /* Point refers normally to the selected window. For any
20251 other window, set up appropriate value. */
20252 if (!EQ (window
, selected_window
))
20254 struct text_pos pt
;
20256 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
20257 if (CHARPOS (pt
) < BEGV
)
20258 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
20259 else if (CHARPOS (pt
) > (ZV
- 1))
20260 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
20262 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
20265 /* Display mode lines. */
20266 clear_glyph_matrix (w
->desired_matrix
);
20267 if (display_mode_lines (w
))
20270 w
->must_be_updated_p
= 1;
20273 /* Restore old settings. */
20274 set_buffer_internal_1 (old
);
20275 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
20285 /* Display the mode and/or header line of window W. Value is the
20286 sum number of mode lines and header lines displayed. */
20289 display_mode_lines (struct window
*w
)
20291 Lisp_Object old_selected_window
, old_selected_frame
;
20294 old_selected_frame
= selected_frame
;
20295 selected_frame
= w
->frame
;
20296 old_selected_window
= selected_window
;
20297 XSETWINDOW (selected_window
, w
);
20299 /* These will be set while the mode line specs are processed. */
20300 line_number_displayed
= 0;
20301 wset_column_number_displayed (w
, Qnil
);
20303 if (WINDOW_WANTS_MODELINE_P (w
))
20305 struct window
*sel_w
= XWINDOW (old_selected_window
);
20307 /* Select mode line face based on the real selected window. */
20308 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
20309 BVAR (current_buffer
, mode_line_format
));
20313 if (WINDOW_WANTS_HEADER_LINE_P (w
))
20315 display_mode_line (w
, HEADER_LINE_FACE_ID
,
20316 BVAR (current_buffer
, header_line_format
));
20320 selected_frame
= old_selected_frame
;
20321 selected_window
= old_selected_window
;
20326 /* Display mode or header line of window W. FACE_ID specifies which
20327 line to display; it is either MODE_LINE_FACE_ID or
20328 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
20329 display. Value is the pixel height of the mode/header line
20333 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
20337 ptrdiff_t count
= SPECPDL_INDEX ();
20339 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20340 /* Don't extend on a previously drawn mode-line.
20341 This may happen if called from pos_visible_p. */
20342 it
.glyph_row
->enabled_p
= 0;
20343 prepare_desired_row (it
.glyph_row
);
20345 it
.glyph_row
->mode_line_p
= 1;
20347 /* FIXME: This should be controlled by a user option. But
20348 supporting such an option is not trivial, since the mode line is
20349 made up of many separate strings. */
20350 it
.paragraph_embedding
= L2R
;
20352 record_unwind_protect (unwind_format_mode_line
,
20353 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
20355 mode_line_target
= MODE_LINE_DISPLAY
;
20357 /* Temporarily make frame's keyboard the current kboard so that
20358 kboard-local variables in the mode_line_format will get the right
20360 push_kboard (FRAME_KBOARD (it
.f
));
20361 record_unwind_save_match_data ();
20362 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20365 unbind_to (count
, Qnil
);
20367 /* Fill up with spaces. */
20368 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
20370 compute_line_metrics (&it
);
20371 it
.glyph_row
->full_width_p
= 1;
20372 it
.glyph_row
->continued_p
= 0;
20373 it
.glyph_row
->truncated_on_left_p
= 0;
20374 it
.glyph_row
->truncated_on_right_p
= 0;
20376 /* Make a 3D mode-line have a shadow at its right end. */
20377 face
= FACE_FROM_ID (it
.f
, face_id
);
20378 extend_face_to_end_of_line (&it
);
20379 if (face
->box
!= FACE_NO_BOX
)
20381 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
20382 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
20383 last
->right_box_line_p
= 1;
20386 return it
.glyph_row
->height
;
20389 /* Move element ELT in LIST to the front of LIST.
20390 Return the updated list. */
20393 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
20395 register Lisp_Object tail
, prev
;
20396 register Lisp_Object tem
;
20400 while (CONSP (tail
))
20406 /* Splice out the link TAIL. */
20408 list
= XCDR (tail
);
20410 Fsetcdr (prev
, XCDR (tail
));
20412 /* Now make it the first. */
20413 Fsetcdr (tail
, list
);
20418 tail
= XCDR (tail
);
20422 /* Not found--return unchanged LIST. */
20426 /* Contribute ELT to the mode line for window IT->w. How it
20427 translates into text depends on its data type.
20429 IT describes the display environment in which we display, as usual.
20431 DEPTH is the depth in recursion. It is used to prevent
20432 infinite recursion here.
20434 FIELD_WIDTH is the number of characters the display of ELT should
20435 occupy in the mode line, and PRECISION is the maximum number of
20436 characters to display from ELT's representation. See
20437 display_string for details.
20439 Returns the hpos of the end of the text generated by ELT.
20441 PROPS is a property list to add to any string we encounter.
20443 If RISKY is nonzero, remove (disregard) any properties in any string
20444 we encounter, and ignore :eval and :propertize.
20446 The global variable `mode_line_target' determines whether the
20447 output is passed to `store_mode_line_noprop',
20448 `store_mode_line_string', or `display_string'. */
20451 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
20452 Lisp_Object elt
, Lisp_Object props
, int risky
)
20454 int n
= 0, field
, prec
;
20459 elt
= build_string ("*too-deep*");
20463 switch (XTYPE (elt
))
20467 /* A string: output it and check for %-constructs within it. */
20469 ptrdiff_t offset
= 0;
20471 if (SCHARS (elt
) > 0
20472 && (!NILP (props
) || risky
))
20474 Lisp_Object oprops
, aelt
;
20475 oprops
= Ftext_properties_at (make_number (0), elt
);
20477 /* If the starting string's properties are not what
20478 we want, translate the string. Also, if the string
20479 is risky, do that anyway. */
20481 if (NILP (Fequal (props
, oprops
)) || risky
)
20483 /* If the starting string has properties,
20484 merge the specified ones onto the existing ones. */
20485 if (! NILP (oprops
) && !risky
)
20489 oprops
= Fcopy_sequence (oprops
);
20491 while (CONSP (tem
))
20493 oprops
= Fplist_put (oprops
, XCAR (tem
),
20494 XCAR (XCDR (tem
)));
20495 tem
= XCDR (XCDR (tem
));
20500 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
20501 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
20503 /* AELT is what we want. Move it to the front
20504 without consing. */
20506 mode_line_proptrans_alist
20507 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
20513 /* If AELT has the wrong props, it is useless.
20514 so get rid of it. */
20516 mode_line_proptrans_alist
20517 = Fdelq (aelt
, mode_line_proptrans_alist
);
20519 elt
= Fcopy_sequence (elt
);
20520 Fset_text_properties (make_number (0), Flength (elt
),
20522 /* Add this item to mode_line_proptrans_alist. */
20523 mode_line_proptrans_alist
20524 = Fcons (Fcons (elt
, props
),
20525 mode_line_proptrans_alist
);
20526 /* Truncate mode_line_proptrans_alist
20527 to at most 50 elements. */
20528 tem
= Fnthcdr (make_number (50),
20529 mode_line_proptrans_alist
);
20531 XSETCDR (tem
, Qnil
);
20540 prec
= precision
- n
;
20541 switch (mode_line_target
)
20543 case MODE_LINE_NOPROP
:
20544 case MODE_LINE_TITLE
:
20545 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
20547 case MODE_LINE_STRING
:
20548 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
20550 case MODE_LINE_DISPLAY
:
20551 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
20552 0, prec
, 0, STRING_MULTIBYTE (elt
));
20559 /* Handle the non-literal case. */
20561 while ((precision
<= 0 || n
< precision
)
20562 && SREF (elt
, offset
) != 0
20563 && (mode_line_target
!= MODE_LINE_DISPLAY
20564 || it
->current_x
< it
->last_visible_x
))
20566 ptrdiff_t last_offset
= offset
;
20568 /* Advance to end of string or next format specifier. */
20569 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
20572 if (offset
- 1 != last_offset
)
20574 ptrdiff_t nchars
, nbytes
;
20576 /* Output to end of string or up to '%'. Field width
20577 is length of string. Don't output more than
20578 PRECISION allows us. */
20581 prec
= c_string_width (SDATA (elt
) + last_offset
,
20582 offset
- last_offset
, precision
- n
,
20585 switch (mode_line_target
)
20587 case MODE_LINE_NOPROP
:
20588 case MODE_LINE_TITLE
:
20589 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
20591 case MODE_LINE_STRING
:
20593 ptrdiff_t bytepos
= last_offset
;
20594 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20595 ptrdiff_t endpos
= (precision
<= 0
20596 ? string_byte_to_char (elt
, offset
)
20597 : charpos
+ nchars
);
20599 n
+= store_mode_line_string (NULL
,
20600 Fsubstring (elt
, make_number (charpos
),
20601 make_number (endpos
)),
20605 case MODE_LINE_DISPLAY
:
20607 ptrdiff_t bytepos
= last_offset
;
20608 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
20610 if (precision
<= 0)
20611 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
20612 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
20614 STRING_MULTIBYTE (elt
));
20619 else /* c == '%' */
20621 ptrdiff_t percent_position
= offset
;
20623 /* Get the specified minimum width. Zero means
20626 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
20627 field
= field
* 10 + c
- '0';
20629 /* Don't pad beyond the total padding allowed. */
20630 if (field_width
- n
> 0 && field
> field_width
- n
)
20631 field
= field_width
- n
;
20633 /* Note that either PRECISION <= 0 or N < PRECISION. */
20634 prec
= precision
- n
;
20637 n
+= display_mode_element (it
, depth
, field
, prec
,
20638 Vglobal_mode_string
, props
,
20643 ptrdiff_t bytepos
, charpos
;
20645 Lisp_Object string
;
20647 bytepos
= percent_position
;
20648 charpos
= (STRING_MULTIBYTE (elt
)
20649 ? string_byte_to_char (elt
, bytepos
)
20651 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
20652 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
20654 switch (mode_line_target
)
20656 case MODE_LINE_NOPROP
:
20657 case MODE_LINE_TITLE
:
20658 n
+= store_mode_line_noprop (spec
, field
, prec
);
20660 case MODE_LINE_STRING
:
20662 Lisp_Object tem
= build_string (spec
);
20663 props
= Ftext_properties_at (make_number (charpos
), elt
);
20664 /* Should only keep face property in props */
20665 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
20668 case MODE_LINE_DISPLAY
:
20670 int nglyphs_before
, nwritten
;
20672 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20673 nwritten
= display_string (spec
, string
, elt
,
20678 /* Assign to the glyphs written above the
20679 string where the `%x' came from, position
20683 struct glyph
*glyph
20684 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
20688 for (i
= 0; i
< nwritten
; ++i
)
20690 glyph
[i
].object
= elt
;
20691 glyph
[i
].charpos
= charpos
;
20708 /* A symbol: process the value of the symbol recursively
20709 as if it appeared here directly. Avoid error if symbol void.
20710 Special case: if value of symbol is a string, output the string
20713 register Lisp_Object tem
;
20715 /* If the variable is not marked as risky to set
20716 then its contents are risky to use. */
20717 if (NILP (Fget (elt
, Qrisky_local_variable
)))
20720 tem
= Fboundp (elt
);
20723 tem
= Fsymbol_value (elt
);
20724 /* If value is a string, output that string literally:
20725 don't check for % within it. */
20729 if (!EQ (tem
, elt
))
20731 /* Give up right away for nil or t. */
20741 register Lisp_Object car
, tem
;
20743 /* A cons cell: five distinct cases.
20744 If first element is :eval or :propertize, do something special.
20745 If first element is a string or a cons, process all the elements
20746 and effectively concatenate them.
20747 If first element is a negative number, truncate displaying cdr to
20748 at most that many characters. If positive, pad (with spaces)
20749 to at least that many characters.
20750 If first element is a symbol, process the cadr or caddr recursively
20751 according to whether the symbol's value is non-nil or nil. */
20753 if (EQ (car
, QCeval
))
20755 /* An element of the form (:eval FORM) means evaluate FORM
20756 and use the result as mode line elements. */
20761 if (CONSP (XCDR (elt
)))
20764 spec
= safe_eval (XCAR (XCDR (elt
)));
20765 n
+= display_mode_element (it
, depth
, field_width
- n
,
20766 precision
- n
, spec
, props
,
20770 else if (EQ (car
, QCpropertize
))
20772 /* An element of the form (:propertize ELT PROPS...)
20773 means display ELT but applying properties PROPS. */
20778 if (CONSP (XCDR (elt
)))
20779 n
+= display_mode_element (it
, depth
, field_width
- n
,
20780 precision
- n
, XCAR (XCDR (elt
)),
20781 XCDR (XCDR (elt
)), risky
);
20783 else if (SYMBOLP (car
))
20785 tem
= Fboundp (car
);
20789 /* elt is now the cdr, and we know it is a cons cell.
20790 Use its car if CAR has a non-nil value. */
20793 tem
= Fsymbol_value (car
);
20800 /* Symbol's value is nil (or symbol is unbound)
20801 Get the cddr of the original list
20802 and if possible find the caddr and use that. */
20806 else if (!CONSP (elt
))
20811 else if (INTEGERP (car
))
20813 register int lim
= XINT (car
);
20817 /* Negative int means reduce maximum width. */
20818 if (precision
<= 0)
20821 precision
= min (precision
, -lim
);
20825 /* Padding specified. Don't let it be more than
20826 current maximum. */
20828 lim
= min (precision
, lim
);
20830 /* If that's more padding than already wanted, queue it.
20831 But don't reduce padding already specified even if
20832 that is beyond the current truncation point. */
20833 field_width
= max (lim
, field_width
);
20837 else if (STRINGP (car
) || CONSP (car
))
20839 Lisp_Object halftail
= elt
;
20843 && (precision
<= 0 || n
< precision
))
20845 n
+= display_mode_element (it
, depth
,
20846 /* Do padding only after the last
20847 element in the list. */
20848 (! CONSP (XCDR (elt
))
20851 precision
- n
, XCAR (elt
),
20855 if ((len
& 1) == 0)
20856 halftail
= XCDR (halftail
);
20857 /* Check for cycle. */
20858 if (EQ (halftail
, elt
))
20867 elt
= build_string ("*invalid*");
20871 /* Pad to FIELD_WIDTH. */
20872 if (field_width
> 0 && n
< field_width
)
20874 switch (mode_line_target
)
20876 case MODE_LINE_NOPROP
:
20877 case MODE_LINE_TITLE
:
20878 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20880 case MODE_LINE_STRING
:
20881 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20883 case MODE_LINE_DISPLAY
:
20884 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20893 /* Store a mode-line string element in mode_line_string_list.
20895 If STRING is non-null, display that C string. Otherwise, the Lisp
20896 string LISP_STRING is displayed.
20898 FIELD_WIDTH is the minimum number of output glyphs to produce.
20899 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20900 with spaces. FIELD_WIDTH <= 0 means don't pad.
20902 PRECISION is the maximum number of characters to output from
20903 STRING. PRECISION <= 0 means don't truncate the string.
20905 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20906 properties to the string.
20908 PROPS are the properties to add to the string.
20909 The mode_line_string_face face property is always added to the string.
20913 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20914 int field_width
, int precision
, Lisp_Object props
)
20919 if (string
!= NULL
)
20921 len
= strlen (string
);
20922 if (precision
> 0 && len
> precision
)
20924 lisp_string
= make_string (string
, len
);
20926 props
= mode_line_string_face_prop
;
20927 else if (!NILP (mode_line_string_face
))
20929 Lisp_Object face
= Fplist_get (props
, Qface
);
20930 props
= Fcopy_sequence (props
);
20932 face
= mode_line_string_face
;
20934 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20935 props
= Fplist_put (props
, Qface
, face
);
20937 Fadd_text_properties (make_number (0), make_number (len
),
20938 props
, lisp_string
);
20942 len
= XFASTINT (Flength (lisp_string
));
20943 if (precision
> 0 && len
> precision
)
20946 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20949 if (!NILP (mode_line_string_face
))
20953 props
= Ftext_properties_at (make_number (0), lisp_string
);
20954 face
= Fplist_get (props
, Qface
);
20956 face
= mode_line_string_face
;
20958 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20959 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20961 lisp_string
= Fcopy_sequence (lisp_string
);
20964 Fadd_text_properties (make_number (0), make_number (len
),
20965 props
, lisp_string
);
20970 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20974 if (field_width
> len
)
20976 field_width
-= len
;
20977 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20979 Fadd_text_properties (make_number (0), make_number (field_width
),
20980 props
, lisp_string
);
20981 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20989 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20991 doc
: /* Format a string out of a mode line format specification.
20992 First arg FORMAT specifies the mode line format (see `mode-line-format'
20993 for details) to use.
20995 By default, the format is evaluated for the currently selected window.
20997 Optional second arg FACE specifies the face property to put on all
20998 characters for which no face is specified. The value nil means the
20999 default face. The value t means whatever face the window's mode line
21000 currently uses (either `mode-line' or `mode-line-inactive',
21001 depending on whether the window is the selected window or not).
21002 An integer value means the value string has no text
21005 Optional third and fourth args WINDOW and BUFFER specify the window
21006 and buffer to use as the context for the formatting (defaults
21007 are the selected window and the WINDOW's buffer). */)
21008 (Lisp_Object format
, Lisp_Object face
,
21009 Lisp_Object window
, Lisp_Object buffer
)
21014 struct buffer
*old_buffer
= NULL
;
21016 int no_props
= INTEGERP (face
);
21017 ptrdiff_t count
= SPECPDL_INDEX ();
21019 int string_start
= 0;
21022 window
= selected_window
;
21023 CHECK_WINDOW (window
);
21024 w
= XWINDOW (window
);
21027 buffer
= w
->buffer
;
21028 CHECK_BUFFER (buffer
);
21030 /* Make formatting the modeline a non-op when noninteractive, otherwise
21031 there will be problems later caused by a partially initialized frame. */
21032 if (NILP (format
) || noninteractive
)
21033 return empty_unibyte_string
;
21038 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
21039 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
21040 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
21041 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
21042 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
21043 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
21044 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
21047 old_buffer
= current_buffer
;
21049 /* Save things including mode_line_proptrans_alist,
21050 and set that to nil so that we don't alter the outer value. */
21051 record_unwind_protect (unwind_format_mode_line
,
21052 format_mode_line_unwind_data
21053 (XFRAME (WINDOW_FRAME (XWINDOW (window
))),
21054 old_buffer
, selected_window
, 1));
21055 mode_line_proptrans_alist
= Qnil
;
21057 Fselect_window (window
, Qt
);
21058 set_buffer_internal_1 (XBUFFER (buffer
));
21060 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21064 mode_line_target
= MODE_LINE_NOPROP
;
21065 mode_line_string_face_prop
= Qnil
;
21066 mode_line_string_list
= Qnil
;
21067 string_start
= MODE_LINE_NOPROP_LEN (0);
21071 mode_line_target
= MODE_LINE_STRING
;
21072 mode_line_string_list
= Qnil
;
21073 mode_line_string_face
= face
;
21074 mode_line_string_face_prop
21075 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
21078 push_kboard (FRAME_KBOARD (it
.f
));
21079 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21084 len
= MODE_LINE_NOPROP_LEN (string_start
);
21085 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
21089 mode_line_string_list
= Fnreverse (mode_line_string_list
);
21090 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
21091 empty_unibyte_string
);
21094 unbind_to (count
, Qnil
);
21098 /* Write a null-terminated, right justified decimal representation of
21099 the positive integer D to BUF using a minimal field width WIDTH. */
21102 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
21104 register char *p
= buf
;
21112 *p
++ = d
% 10 + '0';
21117 for (width
-= (int) (p
- buf
); width
> 0; --width
)
21128 /* Write a null-terminated, right justified decimal and "human
21129 readable" representation of the nonnegative integer D to BUF using
21130 a minimal field width WIDTH. D should be smaller than 999.5e24. */
21132 static const char power_letter
[] =
21146 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
21148 /* We aim to represent the nonnegative integer D as
21149 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
21150 ptrdiff_t quotient
= d
;
21152 /* -1 means: do not use TENTHS. */
21156 /* Length of QUOTIENT.TENTHS as a string. */
21162 if (1000 <= quotient
)
21164 /* Scale to the appropriate EXPONENT. */
21167 remainder
= quotient
% 1000;
21171 while (1000 <= quotient
);
21173 /* Round to nearest and decide whether to use TENTHS or not. */
21176 tenths
= remainder
/ 100;
21177 if (50 <= remainder
% 100)
21184 if (quotient
== 10)
21192 if (500 <= remainder
)
21194 if (quotient
< 999)
21205 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
21206 if (tenths
== -1 && quotient
<= 99)
21213 p
= psuffix
= buf
+ max (width
, length
);
21215 /* Print EXPONENT. */
21216 *psuffix
++ = power_letter
[exponent
];
21219 /* Print TENTHS. */
21222 *--p
= '0' + tenths
;
21226 /* Print QUOTIENT. */
21229 int digit
= quotient
% 10;
21230 *--p
= '0' + digit
;
21232 while ((quotient
/= 10) != 0);
21234 /* Print leading spaces. */
21239 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
21240 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
21241 type of CODING_SYSTEM. Return updated pointer into BUF. */
21243 static unsigned char invalid_eol_type
[] = "(*invalid*)";
21246 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
21249 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
21250 const unsigned char *eol_str
;
21252 /* The EOL conversion we are using. */
21253 Lisp_Object eoltype
;
21255 val
= CODING_SYSTEM_SPEC (coding_system
);
21258 if (!VECTORP (val
)) /* Not yet decided. */
21260 *buf
++ = multibyte
? '-' : ' ';
21262 eoltype
= eol_mnemonic_undecided
;
21263 /* Don't mention EOL conversion if it isn't decided. */
21268 Lisp_Object eolvalue
;
21270 attrs
= AREF (val
, 0);
21271 eolvalue
= AREF (val
, 2);
21274 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
21279 /* The EOL conversion that is normal on this system. */
21281 if (NILP (eolvalue
)) /* Not yet decided. */
21282 eoltype
= eol_mnemonic_undecided
;
21283 else if (VECTORP (eolvalue
)) /* Not yet decided. */
21284 eoltype
= eol_mnemonic_undecided
;
21285 else /* eolvalue is Qunix, Qdos, or Qmac. */
21286 eoltype
= (EQ (eolvalue
, Qunix
)
21287 ? eol_mnemonic_unix
21288 : (EQ (eolvalue
, Qdos
) == 1
21289 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
21295 /* Mention the EOL conversion if it is not the usual one. */
21296 if (STRINGP (eoltype
))
21298 eol_str
= SDATA (eoltype
);
21299 eol_str_len
= SBYTES (eoltype
);
21301 else if (CHARACTERP (eoltype
))
21303 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
21304 int c
= XFASTINT (eoltype
);
21305 eol_str_len
= CHAR_STRING (c
, tmp
);
21310 eol_str
= invalid_eol_type
;
21311 eol_str_len
= sizeof (invalid_eol_type
) - 1;
21313 memcpy (buf
, eol_str
, eol_str_len
);
21314 buf
+= eol_str_len
;
21320 /* Return a string for the output of a mode line %-spec for window W,
21321 generated by character C. FIELD_WIDTH > 0 means pad the string
21322 returned with spaces to that value. Return a Lisp string in
21323 *STRING if the resulting string is taken from that Lisp string.
21325 Note we operate on the current buffer for most purposes,
21326 the exception being w->base_line_pos. */
21328 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
21330 static const char *
21331 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
21332 Lisp_Object
*string
)
21335 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21336 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
21337 struct buffer
*b
= current_buffer
;
21345 if (!NILP (BVAR (b
, read_only
)))
21347 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21352 /* This differs from %* only for a modified read-only buffer. */
21353 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21355 if (!NILP (BVAR (b
, read_only
)))
21360 /* This differs from %* in ignoring read-only-ness. */
21361 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
21373 if (command_loop_level
> 5)
21375 p
= decode_mode_spec_buf
;
21376 for (i
= 0; i
< command_loop_level
; i
++)
21379 return decode_mode_spec_buf
;
21387 if (command_loop_level
> 5)
21389 p
= decode_mode_spec_buf
;
21390 for (i
= 0; i
< command_loop_level
; i
++)
21393 return decode_mode_spec_buf
;
21400 /* Let lots_of_dashes be a string of infinite length. */
21401 if (mode_line_target
== MODE_LINE_NOPROP
||
21402 mode_line_target
== MODE_LINE_STRING
)
21404 if (field_width
<= 0
21405 || field_width
> sizeof (lots_of_dashes
))
21407 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
21408 decode_mode_spec_buf
[i
] = '-';
21409 decode_mode_spec_buf
[i
] = '\0';
21410 return decode_mode_spec_buf
;
21413 return lots_of_dashes
;
21417 obj
= BVAR (b
, name
);
21421 /* %c and %l are ignored in `frame-title-format'.
21422 (In redisplay_internal, the frame title is drawn _before_ the
21423 windows are updated, so the stuff which depends on actual
21424 window contents (such as %l) may fail to render properly, or
21425 even crash emacs.) */
21426 if (mode_line_target
== MODE_LINE_TITLE
)
21430 ptrdiff_t col
= current_column ();
21431 wset_column_number_displayed (w
, make_number (col
));
21432 pint2str (decode_mode_spec_buf
, field_width
, col
);
21433 return decode_mode_spec_buf
;
21437 #ifndef SYSTEM_MALLOC
21439 if (NILP (Vmemory_full
))
21442 return "!MEM FULL! ";
21449 /* %F displays the frame name. */
21450 if (!NILP (f
->title
))
21451 return SSDATA (f
->title
);
21452 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
21453 return SSDATA (f
->name
);
21457 obj
= BVAR (b
, filename
);
21462 ptrdiff_t size
= ZV
- BEGV
;
21463 pint2str (decode_mode_spec_buf
, field_width
, size
);
21464 return decode_mode_spec_buf
;
21469 ptrdiff_t size
= ZV
- BEGV
;
21470 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
21471 return decode_mode_spec_buf
;
21476 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
21477 ptrdiff_t topline
, nlines
, height
;
21480 /* %c and %l are ignored in `frame-title-format'. */
21481 if (mode_line_target
== MODE_LINE_TITLE
)
21484 startpos
= XMARKER (w
->start
)->charpos
;
21485 startpos_byte
= marker_byte_position (w
->start
);
21486 height
= WINDOW_TOTAL_LINES (w
);
21488 /* If we decided that this buffer isn't suitable for line numbers,
21489 don't forget that too fast. */
21490 if (EQ (w
->base_line_pos
, w
->buffer
))
21492 /* But do forget it, if the window shows a different buffer now. */
21493 else if (BUFFERP (w
->base_line_pos
))
21494 wset_base_line_pos (w
, Qnil
);
21496 /* If the buffer is very big, don't waste time. */
21497 if (INTEGERP (Vline_number_display_limit
)
21498 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
21500 wset_base_line_pos (w
, Qnil
);
21501 wset_base_line_number (w
, Qnil
);
21505 if (INTEGERP (w
->base_line_number
)
21506 && INTEGERP (w
->base_line_pos
)
21507 && XFASTINT (w
->base_line_pos
) <= startpos
)
21509 line
= XFASTINT (w
->base_line_number
);
21510 linepos
= XFASTINT (w
->base_line_pos
);
21511 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
21516 linepos
= BUF_BEGV (b
);
21517 linepos_byte
= BUF_BEGV_BYTE (b
);
21520 /* Count lines from base line to window start position. */
21521 nlines
= display_count_lines (linepos_byte
,
21525 topline
= nlines
+ line
;
21527 /* Determine a new base line, if the old one is too close
21528 or too far away, or if we did not have one.
21529 "Too close" means it's plausible a scroll-down would
21530 go back past it. */
21531 if (startpos
== BUF_BEGV (b
))
21533 wset_base_line_number (w
, make_number (topline
));
21534 wset_base_line_pos (w
, make_number (BUF_BEGV (b
)));
21536 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
21537 || linepos
== BUF_BEGV (b
))
21539 ptrdiff_t limit
= BUF_BEGV (b
);
21540 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
21541 ptrdiff_t position
;
21542 ptrdiff_t distance
=
21543 (height
* 2 + 30) * line_number_display_limit_width
;
21545 if (startpos
- distance
> limit
)
21547 limit
= startpos
- distance
;
21548 limit_byte
= CHAR_TO_BYTE (limit
);
21551 nlines
= display_count_lines (startpos_byte
,
21553 - (height
* 2 + 30),
21555 /* If we couldn't find the lines we wanted within
21556 line_number_display_limit_width chars per line,
21557 give up on line numbers for this window. */
21558 if (position
== limit_byte
&& limit
== startpos
- distance
)
21560 wset_base_line_pos (w
, w
->buffer
);
21561 wset_base_line_number (w
, Qnil
);
21565 wset_base_line_number (w
, make_number (topline
- nlines
));
21566 wset_base_line_pos (w
, make_number (BYTE_TO_CHAR (position
)));
21569 /* Now count lines from the start pos to point. */
21570 nlines
= display_count_lines (startpos_byte
,
21571 PT_BYTE
, PT
, &junk
);
21573 /* Record that we did display the line number. */
21574 line_number_displayed
= 1;
21576 /* Make the string to show. */
21577 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
21578 return decode_mode_spec_buf
;
21581 char* p
= decode_mode_spec_buf
;
21582 int pad
= field_width
- 2;
21588 return decode_mode_spec_buf
;
21594 obj
= BVAR (b
, mode_name
);
21598 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
21604 ptrdiff_t pos
= marker_position (w
->start
);
21605 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21607 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
21609 if (pos
<= BUF_BEGV (b
))
21614 else if (pos
<= BUF_BEGV (b
))
21618 if (total
> 1000000)
21619 /* Do it differently for a large value, to avoid overflow. */
21620 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21622 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21623 /* We can't normally display a 3-digit number,
21624 so get us a 2-digit number that is close. */
21627 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21628 return decode_mode_spec_buf
;
21632 /* Display percentage of size above the bottom of the screen. */
21635 ptrdiff_t toppos
= marker_position (w
->start
);
21636 ptrdiff_t botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
21637 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
21639 if (botpos
>= BUF_ZV (b
))
21641 if (toppos
<= BUF_BEGV (b
))
21648 if (total
> 1000000)
21649 /* Do it differently for a large value, to avoid overflow. */
21650 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21652 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21653 /* We can't normally display a 3-digit number,
21654 so get us a 2-digit number that is close. */
21657 if (toppos
<= BUF_BEGV (b
))
21658 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
21660 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
21661 return decode_mode_spec_buf
;
21666 /* status of process */
21667 obj
= Fget_buffer_process (Fcurrent_buffer ());
21669 return "no process";
21671 obj
= Fsymbol_name (Fprocess_status (obj
));
21677 ptrdiff_t count
= inhibit_garbage_collection ();
21678 Lisp_Object val
= call1 (intern ("file-remote-p"),
21679 BVAR (current_buffer
, directory
));
21680 unbind_to (count
, Qnil
);
21688 case 't': /* indicate TEXT or BINARY */
21692 /* coding-system (not including end-of-line format) */
21694 /* coding-system (including end-of-line type) */
21696 int eol_flag
= (c
== 'Z');
21697 char *p
= decode_mode_spec_buf
;
21699 if (! FRAME_WINDOW_P (f
))
21701 /* No need to mention EOL here--the terminal never needs
21702 to do EOL conversion. */
21703 p
= decode_mode_spec_coding (CODING_ID_NAME
21704 (FRAME_KEYBOARD_CODING (f
)->id
),
21706 p
= decode_mode_spec_coding (CODING_ID_NAME
21707 (FRAME_TERMINAL_CODING (f
)->id
),
21710 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
21713 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21714 #ifdef subprocesses
21715 obj
= Fget_buffer_process (Fcurrent_buffer ());
21716 if (PROCESSP (obj
))
21718 p
= decode_mode_spec_coding
21719 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
21720 p
= decode_mode_spec_coding
21721 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
21723 #endif /* subprocesses */
21726 return decode_mode_spec_buf
;
21733 return SSDATA (obj
);
21740 /* Count up to COUNT lines starting from START_BYTE.
21741 But don't go beyond LIMIT_BYTE.
21742 Return the number of lines thus found (always nonnegative).
21744 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
21747 display_count_lines (ptrdiff_t start_byte
,
21748 ptrdiff_t limit_byte
, ptrdiff_t count
,
21749 ptrdiff_t *byte_pos_ptr
)
21751 register unsigned char *cursor
;
21752 unsigned char *base
;
21754 register ptrdiff_t ceiling
;
21755 register unsigned char *ceiling_addr
;
21756 ptrdiff_t orig_count
= count
;
21758 /* If we are not in selective display mode,
21759 check only for newlines. */
21760 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
21761 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
21765 while (start_byte
< limit_byte
)
21767 ceiling
= BUFFER_CEILING_OF (start_byte
);
21768 ceiling
= min (limit_byte
- 1, ceiling
);
21769 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
21770 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
21773 if (selective_display
)
21774 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
21777 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
21780 if (cursor
!= ceiling_addr
)
21784 start_byte
+= cursor
- base
+ 1;
21785 *byte_pos_ptr
= start_byte
;
21789 if (++cursor
== ceiling_addr
)
21795 start_byte
+= cursor
- base
;
21800 while (start_byte
> limit_byte
)
21802 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
21803 ceiling
= max (limit_byte
, ceiling
);
21804 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
21805 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
21808 if (selective_display
)
21809 while (--cursor
!= ceiling_addr
21810 && *cursor
!= '\n' && *cursor
!= 015)
21813 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
21816 if (cursor
!= ceiling_addr
)
21820 start_byte
+= cursor
- base
+ 1;
21821 *byte_pos_ptr
= start_byte
;
21822 /* When scanning backwards, we should
21823 not count the newline posterior to which we stop. */
21824 return - orig_count
- 1;
21830 /* Here we add 1 to compensate for the last decrement
21831 of CURSOR, which took it past the valid range. */
21832 start_byte
+= cursor
- base
+ 1;
21836 *byte_pos_ptr
= limit_byte
;
21839 return - orig_count
+ count
;
21840 return orig_count
- count
;
21846 /***********************************************************************
21848 ***********************************************************************/
21850 /* Display a NUL-terminated string, starting with index START.
21852 If STRING is non-null, display that C string. Otherwise, the Lisp
21853 string LISP_STRING is displayed. There's a case that STRING is
21854 non-null and LISP_STRING is not nil. It means STRING is a string
21855 data of LISP_STRING. In that case, we display LISP_STRING while
21856 ignoring its text properties.
21858 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21859 FACE_STRING. Display STRING or LISP_STRING with the face at
21860 FACE_STRING_POS in FACE_STRING:
21862 Display the string in the environment given by IT, but use the
21863 standard display table, temporarily.
21865 FIELD_WIDTH is the minimum number of output glyphs to produce.
21866 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21867 with spaces. If STRING has more characters, more than FIELD_WIDTH
21868 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21870 PRECISION is the maximum number of characters to output from
21871 STRING. PRECISION < 0 means don't truncate the string.
21873 This is roughly equivalent to printf format specifiers:
21875 FIELD_WIDTH PRECISION PRINTF
21876 ----------------------------------------
21882 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21883 display them, and < 0 means obey the current buffer's value of
21884 enable_multibyte_characters.
21886 Value is the number of columns displayed. */
21889 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21890 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
21891 int field_width
, int precision
, int max_x
, int multibyte
)
21893 int hpos_at_start
= it
->hpos
;
21894 int saved_face_id
= it
->face_id
;
21895 struct glyph_row
*row
= it
->glyph_row
;
21896 ptrdiff_t it_charpos
;
21898 /* Initialize the iterator IT for iteration over STRING beginning
21899 with index START. */
21900 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21901 precision
, field_width
, multibyte
);
21902 if (string
&& STRINGP (lisp_string
))
21903 /* LISP_STRING is the one returned by decode_mode_spec. We should
21904 ignore its text properties. */
21905 it
->stop_charpos
= it
->end_charpos
;
21907 /* If displaying STRING, set up the face of the iterator from
21908 FACE_STRING, if that's given. */
21909 if (STRINGP (face_string
))
21915 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21916 0, it
->region_beg_charpos
,
21917 it
->region_end_charpos
,
21918 &endptr
, it
->base_face_id
, 0);
21919 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21920 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21923 /* Set max_x to the maximum allowed X position. Don't let it go
21924 beyond the right edge of the window. */
21926 max_x
= it
->last_visible_x
;
21928 max_x
= min (max_x
, it
->last_visible_x
);
21930 /* Skip over display elements that are not visible. because IT->w is
21932 if (it
->current_x
< it
->first_visible_x
)
21933 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21934 MOVE_TO_POS
| MOVE_TO_X
);
21936 row
->ascent
= it
->max_ascent
;
21937 row
->height
= it
->max_ascent
+ it
->max_descent
;
21938 row
->phys_ascent
= it
->max_phys_ascent
;
21939 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21940 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21942 if (STRINGP (it
->string
))
21943 it_charpos
= IT_STRING_CHARPOS (*it
);
21945 it_charpos
= IT_CHARPOS (*it
);
21947 /* This condition is for the case that we are called with current_x
21948 past last_visible_x. */
21949 while (it
->current_x
< max_x
)
21951 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21953 /* Get the next display element. */
21954 if (!get_next_display_element (it
))
21957 /* Produce glyphs. */
21958 x_before
= it
->current_x
;
21959 n_glyphs_before
= row
->used
[TEXT_AREA
];
21960 PRODUCE_GLYPHS (it
);
21962 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21965 while (i
< nglyphs
)
21967 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21969 if (it
->line_wrap
!= TRUNCATE
21970 && x
+ glyph
->pixel_width
> max_x
)
21972 /* End of continued line or max_x reached. */
21973 if (CHAR_GLYPH_PADDING_P (*glyph
))
21975 /* A wide character is unbreakable. */
21976 if (row
->reversed_p
)
21977 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21978 - n_glyphs_before
);
21979 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21980 it
->current_x
= x_before
;
21984 if (row
->reversed_p
)
21985 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21986 - (n_glyphs_before
+ i
));
21987 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21992 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21994 /* Glyph is at least partially visible. */
21996 if (x
< it
->first_visible_x
)
21997 row
->x
= x
- it
->first_visible_x
;
22001 /* Glyph is off the left margin of the display area.
22002 Should not happen. */
22006 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
22007 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
22008 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
22009 row
->phys_height
= max (row
->phys_height
,
22010 it
->max_phys_ascent
+ it
->max_phys_descent
);
22011 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
22012 it
->max_extra_line_spacing
);
22013 x
+= glyph
->pixel_width
;
22017 /* Stop if max_x reached. */
22021 /* Stop at line ends. */
22022 if (ITERATOR_AT_END_OF_LINE_P (it
))
22024 it
->continuation_lines_width
= 0;
22028 set_iterator_to_next (it
, 1);
22029 if (STRINGP (it
->string
))
22030 it_charpos
= IT_STRING_CHARPOS (*it
);
22032 it_charpos
= IT_CHARPOS (*it
);
22034 /* Stop if truncating at the right edge. */
22035 if (it
->line_wrap
== TRUNCATE
22036 && it
->current_x
>= it
->last_visible_x
)
22038 /* Add truncation mark, but don't do it if the line is
22039 truncated at a padding space. */
22040 if (it_charpos
< it
->string_nchars
)
22042 if (!FRAME_WINDOW_P (it
->f
))
22046 if (it
->current_x
> it
->last_visible_x
)
22048 if (!row
->reversed_p
)
22050 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
22051 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
22056 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
22057 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
22059 unproduce_glyphs (it
, ii
+ 1);
22060 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
22062 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
22064 row
->used
[TEXT_AREA
] = ii
;
22065 produce_special_glyphs (it
, IT_TRUNCATION
);
22068 produce_special_glyphs (it
, IT_TRUNCATION
);
22070 row
->truncated_on_right_p
= 1;
22076 /* Maybe insert a truncation at the left. */
22077 if (it
->first_visible_x
22080 if (!FRAME_WINDOW_P (it
->f
)
22081 || (row
->reversed_p
22082 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
22083 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
22084 insert_left_trunc_glyphs (it
);
22085 row
->truncated_on_left_p
= 1;
22088 it
->face_id
= saved_face_id
;
22090 /* Value is number of columns displayed. */
22091 return it
->hpos
- hpos_at_start
;
22096 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
22097 appears as an element of LIST or as the car of an element of LIST.
22098 If PROPVAL is a list, compare each element against LIST in that
22099 way, and return 1/2 if any element of PROPVAL is found in LIST.
22100 Otherwise return 0. This function cannot quit.
22101 The return value is 2 if the text is invisible but with an ellipsis
22102 and 1 if it's invisible and without an ellipsis. */
22105 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
22107 register Lisp_Object tail
, proptail
;
22109 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
22111 register Lisp_Object tem
;
22113 if (EQ (propval
, tem
))
22115 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
22116 return NILP (XCDR (tem
)) ? 1 : 2;
22119 if (CONSP (propval
))
22121 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
22123 Lisp_Object propelt
;
22124 propelt
= XCAR (proptail
);
22125 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
22127 register Lisp_Object tem
;
22129 if (EQ (propelt
, tem
))
22131 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
22132 return NILP (XCDR (tem
)) ? 1 : 2;
22140 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
22141 doc
: /* Non-nil if the property makes the text invisible.
22142 POS-OR-PROP can be a marker or number, in which case it is taken to be
22143 a position in the current buffer and the value of the `invisible' property
22144 is checked; or it can be some other value, which is then presumed to be the
22145 value of the `invisible' property of the text of interest.
22146 The non-nil value returned can be t for truly invisible text or something
22147 else if the text is replaced by an ellipsis. */)
22148 (Lisp_Object pos_or_prop
)
22151 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
22152 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
22154 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
22155 return (invis
== 0 ? Qnil
22157 : make_number (invis
));
22160 /* Calculate a width or height in pixels from a specification using
22161 the following elements:
22164 NUM - a (fractional) multiple of the default font width/height
22165 (NUM) - specifies exactly NUM pixels
22166 UNIT - a fixed number of pixels, see below.
22167 ELEMENT - size of a display element in pixels, see below.
22168 (NUM . SPEC) - equals NUM * SPEC
22169 (+ SPEC SPEC ...) - add pixel values
22170 (- SPEC SPEC ...) - subtract pixel values
22171 (- SPEC) - negate pixel value
22174 INT or FLOAT - a number constant
22175 SYMBOL - use symbol's (buffer local) variable binding.
22178 in - pixels per inch *)
22179 mm - pixels per 1/1000 meter *)
22180 cm - pixels per 1/100 meter *)
22181 width - width of current font in pixels.
22182 height - height of current font in pixels.
22184 *) using the ratio(s) defined in display-pixels-per-inch.
22188 left-fringe - left fringe width in pixels
22189 right-fringe - right fringe width in pixels
22191 left-margin - left margin width in pixels
22192 right-margin - right margin width in pixels
22194 scroll-bar - scroll-bar area width in pixels
22198 Pixels corresponding to 5 inches:
22201 Total width of non-text areas on left side of window (if scroll-bar is on left):
22202 '(space :width (+ left-fringe left-margin scroll-bar))
22204 Align to first text column (in header line):
22205 '(space :align-to 0)
22207 Align to middle of text area minus half the width of variable `my-image'
22208 containing a loaded image:
22209 '(space :align-to (0.5 . (- text my-image)))
22211 Width of left margin minus width of 1 character in the default font:
22212 '(space :width (- left-margin 1))
22214 Width of left margin minus width of 2 characters in the current font:
22215 '(space :width (- left-margin (2 . width)))
22217 Center 1 character over left-margin (in header line):
22218 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
22220 Different ways to express width of left fringe plus left margin minus one pixel:
22221 '(space :width (- (+ left-fringe left-margin) (1)))
22222 '(space :width (+ left-fringe left-margin (- (1))))
22223 '(space :width (+ left-fringe left-margin (-1)))
22227 #define NUMVAL(X) \
22228 ((INTEGERP (X) || FLOATP (X)) \
22233 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
22234 struct font
*font
, int width_p
, int *align_to
)
22238 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
22239 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
22242 return OK_PIXELS (0);
22244 eassert (FRAME_LIVE_P (it
->f
));
22246 if (SYMBOLP (prop
))
22248 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
22250 char *unit
= SSDATA (SYMBOL_NAME (prop
));
22252 if (unit
[0] == 'i' && unit
[1] == 'n')
22254 else if (unit
[0] == 'm' && unit
[1] == 'm')
22256 else if (unit
[0] == 'c' && unit
[1] == 'm')
22263 #ifdef HAVE_WINDOW_SYSTEM
22264 if (FRAME_WINDOW_P (it
->f
)
22266 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
22267 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
22269 return OK_PIXELS (ppi
/ pixels
);
22272 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
22273 || (CONSP (Vdisplay_pixels_per_inch
)
22275 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
22276 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
22278 return OK_PIXELS (ppi
/ pixels
);
22284 #ifdef HAVE_WINDOW_SYSTEM
22285 if (EQ (prop
, Qheight
))
22286 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
22287 if (EQ (prop
, Qwidth
))
22288 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
22290 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
22291 return OK_PIXELS (1);
22294 if (EQ (prop
, Qtext
))
22295 return OK_PIXELS (width_p
22296 ? window_box_width (it
->w
, TEXT_AREA
)
22297 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
22299 if (align_to
&& *align_to
< 0)
22302 if (EQ (prop
, Qleft
))
22303 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
22304 if (EQ (prop
, Qright
))
22305 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
22306 if (EQ (prop
, Qcenter
))
22307 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
22308 + window_box_width (it
->w
, TEXT_AREA
) / 2);
22309 if (EQ (prop
, Qleft_fringe
))
22310 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22311 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
22312 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
22313 if (EQ (prop
, Qright_fringe
))
22314 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22315 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22316 : window_box_right_offset (it
->w
, TEXT_AREA
));
22317 if (EQ (prop
, Qleft_margin
))
22318 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
22319 if (EQ (prop
, Qright_margin
))
22320 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
22321 if (EQ (prop
, Qscroll_bar
))
22322 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
22324 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
22325 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
22326 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
22331 if (EQ (prop
, Qleft_fringe
))
22332 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
22333 if (EQ (prop
, Qright_fringe
))
22334 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
22335 if (EQ (prop
, Qleft_margin
))
22336 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
22337 if (EQ (prop
, Qright_margin
))
22338 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
22339 if (EQ (prop
, Qscroll_bar
))
22340 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
22343 prop
= buffer_local_value_1 (prop
, it
->w
->buffer
);
22344 if (EQ (prop
, Qunbound
))
22348 if (INTEGERP (prop
) || FLOATP (prop
))
22350 int base_unit
= (width_p
22351 ? FRAME_COLUMN_WIDTH (it
->f
)
22352 : FRAME_LINE_HEIGHT (it
->f
));
22353 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
22358 Lisp_Object car
= XCAR (prop
);
22359 Lisp_Object cdr
= XCDR (prop
);
22363 #ifdef HAVE_WINDOW_SYSTEM
22364 if (FRAME_WINDOW_P (it
->f
)
22365 && valid_image_p (prop
))
22367 ptrdiff_t id
= lookup_image (it
->f
, prop
);
22368 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
22370 return OK_PIXELS (width_p
? img
->width
: img
->height
);
22373 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
22379 while (CONSP (cdr
))
22381 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
22382 font
, width_p
, align_to
))
22385 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
22390 if (EQ (car
, Qminus
))
22392 return OK_PIXELS (pixels
);
22395 car
= buffer_local_value_1 (car
, it
->w
->buffer
);
22396 if (EQ (car
, Qunbound
))
22400 if (INTEGERP (car
) || FLOATP (car
))
22403 pixels
= XFLOATINT (car
);
22405 return OK_PIXELS (pixels
);
22406 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
22407 font
, width_p
, align_to
))
22408 return OK_PIXELS (pixels
* fact
);
22419 /***********************************************************************
22421 ***********************************************************************/
22423 #ifdef HAVE_WINDOW_SYSTEM
22428 dump_glyph_string (struct glyph_string
*s
)
22430 fprintf (stderr
, "glyph string\n");
22431 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
22432 s
->x
, s
->y
, s
->width
, s
->height
);
22433 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
22434 fprintf (stderr
, " hl = %d\n", s
->hl
);
22435 fprintf (stderr
, " left overhang = %d, right = %d\n",
22436 s
->left_overhang
, s
->right_overhang
);
22437 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
22438 fprintf (stderr
, " extends to end of line = %d\n",
22439 s
->extends_to_end_of_line_p
);
22440 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
22441 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
22444 #endif /* GLYPH_DEBUG */
22446 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
22447 of XChar2b structures for S; it can't be allocated in
22448 init_glyph_string because it must be allocated via `alloca'. W
22449 is the window on which S is drawn. ROW and AREA are the glyph row
22450 and area within the row from which S is constructed. START is the
22451 index of the first glyph structure covered by S. HL is a
22452 face-override for drawing S. */
22455 #define OPTIONAL_HDC(hdc) HDC hdc,
22456 #define DECLARE_HDC(hdc) HDC hdc;
22457 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
22458 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
22461 #ifndef OPTIONAL_HDC
22462 #define OPTIONAL_HDC(hdc)
22463 #define DECLARE_HDC(hdc)
22464 #define ALLOCATE_HDC(hdc, f)
22465 #define RELEASE_HDC(hdc, f)
22469 init_glyph_string (struct glyph_string
*s
,
22471 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
22472 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
22474 memset (s
, 0, sizeof *s
);
22476 s
->f
= XFRAME (w
->frame
);
22480 s
->display
= FRAME_X_DISPLAY (s
->f
);
22481 s
->window
= FRAME_X_WINDOW (s
->f
);
22482 s
->char2b
= char2b
;
22486 s
->first_glyph
= row
->glyphs
[area
] + start
;
22487 s
->height
= row
->height
;
22488 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
22489 s
->ybase
= s
->y
+ row
->ascent
;
22493 /* Append the list of glyph strings with head H and tail T to the list
22494 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
22497 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22498 struct glyph_string
*h
, struct glyph_string
*t
)
22512 /* Prepend the list of glyph strings with head H and tail T to the
22513 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
22517 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22518 struct glyph_string
*h
, struct glyph_string
*t
)
22532 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
22533 Set *HEAD and *TAIL to the resulting list. */
22536 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
22537 struct glyph_string
*s
)
22539 s
->next
= s
->prev
= NULL
;
22540 append_glyph_string_lists (head
, tail
, s
, s
);
22544 /* Get face and two-byte form of character C in face FACE_ID on frame F.
22545 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
22546 make sure that X resources for the face returned are allocated.
22547 Value is a pointer to a realized face that is ready for display if
22548 DISPLAY_P is non-zero. */
22550 static struct face
*
22551 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
22552 XChar2b
*char2b
, int display_p
)
22554 struct face
*face
= FACE_FROM_ID (f
, face_id
);
22558 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
22560 if (code
!= FONT_INVALID_CODE
)
22561 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22563 STORE_XCHAR2B (char2b
, 0, 0);
22566 /* Make sure X resources of the face are allocated. */
22567 #ifdef HAVE_X_WINDOWS
22571 eassert (face
!= NULL
);
22572 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22579 /* Get face and two-byte form of character glyph GLYPH on frame F.
22580 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
22581 a pointer to a realized face that is ready for display. */
22583 static struct face
*
22584 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
22585 XChar2b
*char2b
, int *two_byte_p
)
22589 eassert (glyph
->type
== CHAR_GLYPH
);
22590 face
= FACE_FROM_ID (f
, glyph
->face_id
);
22599 if (CHAR_BYTE8_P (glyph
->u
.ch
))
22600 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
22602 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
22604 if (code
!= FONT_INVALID_CODE
)
22605 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22607 STORE_XCHAR2B (char2b
, 0, 0);
22610 /* Make sure X resources of the face are allocated. */
22611 eassert (face
!= NULL
);
22612 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22617 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22618 Return 1 if FONT has a glyph for C, otherwise return 0. */
22621 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
22625 if (CHAR_BYTE8_P (c
))
22626 code
= CHAR_TO_BYTE8 (c
);
22628 code
= font
->driver
->encode_char (font
, c
);
22630 if (code
== FONT_INVALID_CODE
)
22632 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22637 /* Fill glyph string S with composition components specified by S->cmp.
22639 BASE_FACE is the base face of the composition.
22640 S->cmp_from is the index of the first component for S.
22642 OVERLAPS non-zero means S should draw the foreground only, and use
22643 its physical height for clipping. See also draw_glyphs.
22645 Value is the index of a component not in S. */
22648 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22652 /* For all glyphs of this composition, starting at the offset
22653 S->cmp_from, until we reach the end of the definition or encounter a
22654 glyph that requires the different face, add it to S. */
22659 s
->for_overlaps
= overlaps
;
22662 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
22664 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
22666 /* TAB in a composition means display glyphs with padding space
22667 on the left or right. */
22670 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
22673 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
22680 s
->font
= s
->face
->font
;
22682 else if (s
->face
!= face
)
22690 if (s
->face
== NULL
)
22692 s
->face
= base_face
->ascii_face
;
22693 s
->font
= s
->face
->font
;
22696 /* All glyph strings for the same composition has the same width,
22697 i.e. the width set for the first component of the composition. */
22698 s
->width
= s
->first_glyph
->pixel_width
;
22700 /* If the specified font could not be loaded, use the frame's
22701 default font, but record the fact that we couldn't load it in
22702 the glyph string so that we can draw rectangles for the
22703 characters of the glyph string. */
22704 if (s
->font
== NULL
)
22706 s
->font_not_found_p
= 1;
22707 s
->font
= FRAME_FONT (s
->f
);
22710 /* Adjust base line for subscript/superscript text. */
22711 s
->ybase
+= s
->first_glyph
->voffset
;
22713 /* This glyph string must always be drawn with 16-bit functions. */
22720 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
22721 int start
, int end
, int overlaps
)
22723 struct glyph
*glyph
, *last
;
22724 Lisp_Object lgstring
;
22727 s
->for_overlaps
= overlaps
;
22728 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22729 last
= s
->row
->glyphs
[s
->area
] + end
;
22730 s
->cmp_id
= glyph
->u
.cmp
.id
;
22731 s
->cmp_from
= glyph
->slice
.cmp
.from
;
22732 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
22733 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22734 lgstring
= composition_gstring_from_id (s
->cmp_id
);
22735 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
22737 while (glyph
< last
22738 && glyph
->u
.cmp
.automatic
22739 && glyph
->u
.cmp
.id
== s
->cmp_id
22740 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
22741 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
22743 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
22745 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
22746 unsigned code
= LGLYPH_CODE (lglyph
);
22748 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
22750 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
22751 return glyph
- s
->row
->glyphs
[s
->area
];
22755 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22756 See the comment of fill_glyph_string for arguments.
22757 Value is the index of the first glyph not in S. */
22761 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
22762 int start
, int end
, int overlaps
)
22764 struct glyph
*glyph
, *last
;
22767 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
22768 s
->for_overlaps
= overlaps
;
22769 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22770 last
= s
->row
->glyphs
[s
->area
] + end
;
22771 voffset
= glyph
->voffset
;
22772 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22773 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
22775 s
->width
= glyph
->pixel_width
;
22777 while (glyph
< last
22778 && glyph
->type
== GLYPHLESS_GLYPH
22779 && glyph
->voffset
== voffset
22780 && glyph
->face_id
== face_id
)
22783 s
->width
+= glyph
->pixel_width
;
22786 s
->ybase
+= voffset
;
22787 return glyph
- s
->row
->glyphs
[s
->area
];
22791 /* Fill glyph string S from a sequence of character glyphs.
22793 FACE_ID is the face id of the string. START is the index of the
22794 first glyph to consider, END is the index of the last + 1.
22795 OVERLAPS non-zero means S should draw the foreground only, and use
22796 its physical height for clipping. See also draw_glyphs.
22798 Value is the index of the first glyph not in S. */
22801 fill_glyph_string (struct glyph_string
*s
, int face_id
,
22802 int start
, int end
, int overlaps
)
22804 struct glyph
*glyph
, *last
;
22806 int glyph_not_available_p
;
22808 eassert (s
->f
== XFRAME (s
->w
->frame
));
22809 eassert (s
->nchars
== 0);
22810 eassert (start
>= 0 && end
> start
);
22812 s
->for_overlaps
= overlaps
;
22813 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22814 last
= s
->row
->glyphs
[s
->area
] + end
;
22815 voffset
= glyph
->voffset
;
22816 s
->padding_p
= glyph
->padding_p
;
22817 glyph_not_available_p
= glyph
->glyph_not_available_p
;
22819 while (glyph
< last
22820 && glyph
->type
== CHAR_GLYPH
22821 && glyph
->voffset
== voffset
22822 /* Same face id implies same font, nowadays. */
22823 && glyph
->face_id
== face_id
22824 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
22828 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
22829 s
->char2b
+ s
->nchars
,
22831 s
->two_byte_p
= two_byte_p
;
22833 eassert (s
->nchars
<= end
- start
);
22834 s
->width
+= glyph
->pixel_width
;
22835 if (glyph
++->padding_p
!= s
->padding_p
)
22839 s
->font
= s
->face
->font
;
22841 /* If the specified font could not be loaded, use the frame's font,
22842 but record the fact that we couldn't load it in
22843 S->font_not_found_p so that we can draw rectangles for the
22844 characters of the glyph string. */
22845 if (s
->font
== NULL
|| glyph_not_available_p
)
22847 s
->font_not_found_p
= 1;
22848 s
->font
= FRAME_FONT (s
->f
);
22851 /* Adjust base line for subscript/superscript text. */
22852 s
->ybase
+= voffset
;
22854 eassert (s
->face
&& s
->face
->gc
);
22855 return glyph
- s
->row
->glyphs
[s
->area
];
22859 /* Fill glyph string S from image glyph S->first_glyph. */
22862 fill_image_glyph_string (struct glyph_string
*s
)
22864 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22865 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22867 s
->slice
= s
->first_glyph
->slice
.img
;
22868 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22869 s
->font
= s
->face
->font
;
22870 s
->width
= s
->first_glyph
->pixel_width
;
22872 /* Adjust base line for subscript/superscript text. */
22873 s
->ybase
+= s
->first_glyph
->voffset
;
22877 /* Fill glyph string S from a sequence of stretch glyphs.
22879 START is the index of the first glyph to consider,
22880 END is the index of the last + 1.
22882 Value is the index of the first glyph not in S. */
22885 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
22887 struct glyph
*glyph
, *last
;
22888 int voffset
, face_id
;
22890 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22892 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22893 last
= s
->row
->glyphs
[s
->area
] + end
;
22894 face_id
= glyph
->face_id
;
22895 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22896 s
->font
= s
->face
->font
;
22897 s
->width
= glyph
->pixel_width
;
22899 voffset
= glyph
->voffset
;
22903 && glyph
->type
== STRETCH_GLYPH
22904 && glyph
->voffset
== voffset
22905 && glyph
->face_id
== face_id
);
22907 s
->width
+= glyph
->pixel_width
;
22909 /* Adjust base line for subscript/superscript text. */
22910 s
->ybase
+= voffset
;
22912 /* The case that face->gc == 0 is handled when drawing the glyph
22913 string by calling PREPARE_FACE_FOR_DISPLAY. */
22915 return glyph
- s
->row
->glyphs
[s
->area
];
22918 static struct font_metrics
*
22919 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22921 static struct font_metrics metrics
;
22922 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22924 if (! font
|| code
== FONT_INVALID_CODE
)
22926 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
22931 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22932 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22933 assumed to be zero. */
22936 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22938 *left
= *right
= 0;
22940 if (glyph
->type
== CHAR_GLYPH
)
22944 struct font_metrics
*pcm
;
22946 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22947 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22949 if (pcm
->rbearing
> pcm
->width
)
22950 *right
= pcm
->rbearing
- pcm
->width
;
22951 if (pcm
->lbearing
< 0)
22952 *left
= -pcm
->lbearing
;
22955 else if (glyph
->type
== COMPOSITE_GLYPH
)
22957 if (! glyph
->u
.cmp
.automatic
)
22959 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22961 if (cmp
->rbearing
> cmp
->pixel_width
)
22962 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22963 if (cmp
->lbearing
< 0)
22964 *left
= - cmp
->lbearing
;
22968 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22969 struct font_metrics metrics
;
22971 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22972 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22973 if (metrics
.rbearing
> metrics
.width
)
22974 *right
= metrics
.rbearing
- metrics
.width
;
22975 if (metrics
.lbearing
< 0)
22976 *left
= - metrics
.lbearing
;
22982 /* Return the index of the first glyph preceding glyph string S that
22983 is overwritten by S because of S's left overhang. Value is -1
22984 if no glyphs are overwritten. */
22987 left_overwritten (struct glyph_string
*s
)
22991 if (s
->left_overhang
)
22994 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22995 int first
= s
->first_glyph
- glyphs
;
22997 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22998 x
-= glyphs
[i
].pixel_width
;
23009 /* Return the index of the first glyph preceding glyph string S that
23010 is overwriting S because of its right overhang. Value is -1 if no
23011 glyph in front of S overwrites S. */
23014 left_overwriting (struct glyph_string
*s
)
23017 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23018 int first
= s
->first_glyph
- glyphs
;
23022 for (i
= first
- 1; i
>= 0; --i
)
23025 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
23028 x
-= glyphs
[i
].pixel_width
;
23035 /* Return the index of the last glyph following glyph string S that is
23036 overwritten by S because of S's right overhang. Value is -1 if
23037 no such glyph is found. */
23040 right_overwritten (struct glyph_string
*s
)
23044 if (s
->right_overhang
)
23047 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23048 int first
= (s
->first_glyph
- glyphs
23049 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
23050 int end
= s
->row
->used
[s
->area
];
23052 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
23053 x
+= glyphs
[i
].pixel_width
;
23062 /* Return the index of the last glyph following glyph string S that
23063 overwrites S because of its left overhang. Value is negative
23064 if no such glyph is found. */
23067 right_overwriting (struct glyph_string
*s
)
23070 int end
= s
->row
->used
[s
->area
];
23071 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23072 int first
= (s
->first_glyph
- glyphs
23073 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
23077 for (i
= first
; i
< end
; ++i
)
23080 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
23083 x
+= glyphs
[i
].pixel_width
;
23090 /* Set background width of glyph string S. START is the index of the
23091 first glyph following S. LAST_X is the right-most x-position + 1
23092 in the drawing area. */
23095 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
23097 /* If the face of this glyph string has to be drawn to the end of
23098 the drawing area, set S->extends_to_end_of_line_p. */
23100 if (start
== s
->row
->used
[s
->area
]
23101 && s
->area
== TEXT_AREA
23102 && ((s
->row
->fill_line_p
23103 && (s
->hl
== DRAW_NORMAL_TEXT
23104 || s
->hl
== DRAW_IMAGE_RAISED
23105 || s
->hl
== DRAW_IMAGE_SUNKEN
))
23106 || s
->hl
== DRAW_MOUSE_FACE
))
23107 s
->extends_to_end_of_line_p
= 1;
23109 /* If S extends its face to the end of the line, set its
23110 background_width to the distance to the right edge of the drawing
23112 if (s
->extends_to_end_of_line_p
)
23113 s
->background_width
= last_x
- s
->x
+ 1;
23115 s
->background_width
= s
->width
;
23119 /* Compute overhangs and x-positions for glyph string S and its
23120 predecessors, or successors. X is the starting x-position for S.
23121 BACKWARD_P non-zero means process predecessors. */
23124 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
23130 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
23131 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
23141 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
23142 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
23152 /* The following macros are only called from draw_glyphs below.
23153 They reference the following parameters of that function directly:
23154 `w', `row', `area', and `overlap_p'
23155 as well as the following local variables:
23156 `s', `f', and `hdc' (in W32) */
23159 /* On W32, silently add local `hdc' variable to argument list of
23160 init_glyph_string. */
23161 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23162 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
23164 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
23165 init_glyph_string (s, char2b, w, row, area, start, hl)
23168 /* Add a glyph string for a stretch glyph to the list of strings
23169 between HEAD and TAIL. START is the index of the stretch glyph in
23170 row area AREA of glyph row ROW. END is the index of the last glyph
23171 in that glyph row area. X is the current output position assigned
23172 to the new glyph string constructed. HL overrides that face of the
23173 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23174 is the right-most x-position of the drawing area. */
23176 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
23177 and below -- keep them on one line. */
23178 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23181 s = alloca (sizeof *s); \
23182 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23183 START = fill_stretch_glyph_string (s, START, END); \
23184 append_glyph_string (&HEAD, &TAIL, s); \
23190 /* Add a glyph string for an image glyph to the list of strings
23191 between HEAD and TAIL. START is the index of the image glyph in
23192 row area AREA of glyph row ROW. END is the index of the last glyph
23193 in that glyph row area. X is the current output position assigned
23194 to the new glyph string constructed. HL overrides that face of the
23195 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
23196 is the right-most x-position of the drawing area. */
23198 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23201 s = alloca (sizeof *s); \
23202 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23203 fill_image_glyph_string (s); \
23204 append_glyph_string (&HEAD, &TAIL, s); \
23211 /* Add a glyph string for a sequence of character glyphs to the list
23212 of strings between HEAD and TAIL. START is the index of the first
23213 glyph in row area AREA of glyph row ROW that is part of the new
23214 glyph string. END is the index of the last glyph in that glyph row
23215 area. X is the current output position assigned to the new glyph
23216 string constructed. HL overrides that face of the glyph; e.g. it
23217 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
23218 right-most x-position of the drawing area. */
23220 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23226 face_id = (row)->glyphs[area][START].face_id; \
23228 s = alloca (sizeof *s); \
23229 char2b = alloca ((END - START) * sizeof *char2b); \
23230 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23231 append_glyph_string (&HEAD, &TAIL, s); \
23233 START = fill_glyph_string (s, face_id, START, END, overlaps); \
23238 /* Add a glyph string for a composite sequence to the list of strings
23239 between HEAD and TAIL. START is the index of the first glyph in
23240 row area AREA of glyph row ROW that is part of the new glyph
23241 string. END is the index of the last glyph in that glyph row area.
23242 X is the current output position assigned to the new glyph string
23243 constructed. HL overrides that face of the glyph; e.g. it is
23244 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
23245 x-position of the drawing area. */
23247 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23249 int face_id = (row)->glyphs[area][START].face_id; \
23250 struct face *base_face = FACE_FROM_ID (f, face_id); \
23251 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
23252 struct composition *cmp = composition_table[cmp_id]; \
23254 struct glyph_string *first_s = NULL; \
23257 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
23259 /* Make glyph_strings for each glyph sequence that is drawable by \
23260 the same face, and append them to HEAD/TAIL. */ \
23261 for (n = 0; n < cmp->glyph_len;) \
23263 s = alloca (sizeof *s); \
23264 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23265 append_glyph_string (&(HEAD), &(TAIL), s); \
23271 n = fill_composite_glyph_string (s, base_face, overlaps); \
23279 /* Add a glyph string for a glyph-string sequence to the list of strings
23280 between HEAD and TAIL. */
23282 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23286 Lisp_Object gstring; \
23288 face_id = (row)->glyphs[area][START].face_id; \
23289 gstring = (composition_gstring_from_id \
23290 ((row)->glyphs[area][START].u.cmp.id)); \
23291 s = alloca (sizeof *s); \
23292 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
23293 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
23294 append_glyph_string (&(HEAD), &(TAIL), s); \
23296 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
23300 /* Add a glyph string for a sequence of glyphless character's glyphs
23301 to the list of strings between HEAD and TAIL. The meanings of
23302 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
23304 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
23309 face_id = (row)->glyphs[area][START].face_id; \
23311 s = alloca (sizeof *s); \
23312 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
23313 append_glyph_string (&HEAD, &TAIL, s); \
23315 START = fill_glyphless_glyph_string (s, face_id, START, END, \
23321 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
23322 of AREA of glyph row ROW on window W between indices START and END.
23323 HL overrides the face for drawing glyph strings, e.g. it is
23324 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
23325 x-positions of the drawing area.
23327 This is an ugly monster macro construct because we must use alloca
23328 to allocate glyph strings (because draw_glyphs can be called
23329 asynchronously). */
23331 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
23334 HEAD = TAIL = NULL; \
23335 while (START < END) \
23337 struct glyph *first_glyph = (row)->glyphs[area] + START; \
23338 switch (first_glyph->type) \
23341 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
23345 case COMPOSITE_GLYPH: \
23346 if (first_glyph->u.cmp.automatic) \
23347 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
23350 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
23354 case STRETCH_GLYPH: \
23355 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
23359 case IMAGE_GLYPH: \
23360 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
23364 case GLYPHLESS_GLYPH: \
23365 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
23375 set_glyph_string_background_width (s, START, LAST_X); \
23382 /* Draw glyphs between START and END in AREA of ROW on window W,
23383 starting at x-position X. X is relative to AREA in W. HL is a
23384 face-override with the following meaning:
23386 DRAW_NORMAL_TEXT draw normally
23387 DRAW_CURSOR draw in cursor face
23388 DRAW_MOUSE_FACE draw in mouse face.
23389 DRAW_INVERSE_VIDEO draw in mode line face
23390 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
23391 DRAW_IMAGE_RAISED draw an image with a raised relief around it
23393 If OVERLAPS is non-zero, draw only the foreground of characters and
23394 clip to the physical height of ROW. Non-zero value also defines
23395 the overlapping part to be drawn:
23397 OVERLAPS_PRED overlap with preceding rows
23398 OVERLAPS_SUCC overlap with succeeding rows
23399 OVERLAPS_BOTH overlap with both preceding/succeeding rows
23400 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
23402 Value is the x-position reached, relative to AREA of W. */
23405 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
23406 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
23407 enum draw_glyphs_face hl
, int overlaps
)
23409 struct glyph_string
*head
, *tail
;
23410 struct glyph_string
*s
;
23411 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
23412 int i
, j
, x_reached
, last_x
, area_left
= 0;
23413 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23416 ALLOCATE_HDC (hdc
, f
);
23418 /* Let's rather be paranoid than getting a SEGV. */
23419 end
= min (end
, row
->used
[area
]);
23420 start
= max (0, start
);
23421 start
= min (end
, start
);
23423 /* Translate X to frame coordinates. Set last_x to the right
23424 end of the drawing area. */
23425 if (row
->full_width_p
)
23427 /* X is relative to the left edge of W, without scroll bars
23429 area_left
= WINDOW_LEFT_EDGE_X (w
);
23430 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
23434 area_left
= window_box_left (w
, area
);
23435 last_x
= area_left
+ window_box_width (w
, area
);
23439 /* Build a doubly-linked list of glyph_string structures between
23440 head and tail from what we have to draw. Note that the macro
23441 BUILD_GLYPH_STRINGS will modify its start parameter. That's
23442 the reason we use a separate variable `i'. */
23444 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
23446 x_reached
= tail
->x
+ tail
->background_width
;
23450 /* If there are any glyphs with lbearing < 0 or rbearing > width in
23451 the row, redraw some glyphs in front or following the glyph
23452 strings built above. */
23453 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
23455 struct glyph_string
*h
, *t
;
23456 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23457 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
23458 int check_mouse_face
= 0;
23461 /* If mouse highlighting is on, we may need to draw adjacent
23462 glyphs using mouse-face highlighting. */
23463 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
23465 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
23467 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23468 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23470 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
23472 check_mouse_face
= 1;
23473 mouse_beg_col
= (row
== mouse_beg_row
)
23474 ? hlinfo
->mouse_face_beg_col
: 0;
23475 mouse_end_col
= (row
== mouse_end_row
)
23476 ? hlinfo
->mouse_face_end_col
23477 : row
->used
[TEXT_AREA
];
23481 /* Compute overhangs for all glyph strings. */
23482 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
23483 for (s
= head
; s
; s
= s
->next
)
23484 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
23486 /* Prepend glyph strings for glyphs in front of the first glyph
23487 string that are overwritten because of the first glyph
23488 string's left overhang. The background of all strings
23489 prepended must be drawn because the first glyph string
23491 i
= left_overwritten (head
);
23494 enum draw_glyphs_face overlap_hl
;
23496 /* If this row contains mouse highlighting, attempt to draw
23497 the overlapped glyphs with the correct highlight. This
23498 code fails if the overlap encompasses more than one glyph
23499 and mouse-highlight spans only some of these glyphs.
23500 However, making it work perfectly involves a lot more
23501 code, and I don't know if the pathological case occurs in
23502 practice, so we'll stick to this for now. --- cyd */
23503 if (check_mouse_face
23504 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23505 overlap_hl
= DRAW_MOUSE_FACE
;
23507 overlap_hl
= DRAW_NORMAL_TEXT
;
23510 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
23511 overlap_hl
, dummy_x
, last_x
);
23513 compute_overhangs_and_x (t
, head
->x
, 1);
23514 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23518 /* Prepend glyph strings for glyphs in front of the first glyph
23519 string that overwrite that glyph string because of their
23520 right overhang. For these strings, only the foreground must
23521 be drawn, because it draws over the glyph string at `head'.
23522 The background must not be drawn because this would overwrite
23523 right overhangs of preceding glyphs for which no glyph
23525 i
= left_overwriting (head
);
23528 enum draw_glyphs_face overlap_hl
;
23530 if (check_mouse_face
23531 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23532 overlap_hl
= DRAW_MOUSE_FACE
;
23534 overlap_hl
= DRAW_NORMAL_TEXT
;
23537 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
23538 overlap_hl
, dummy_x
, last_x
);
23539 for (s
= h
; s
; s
= s
->next
)
23540 s
->background_filled_p
= 1;
23541 compute_overhangs_and_x (t
, head
->x
, 1);
23542 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23545 /* Append glyphs strings for glyphs following the last glyph
23546 string tail that are overwritten by tail. The background of
23547 these strings has to be drawn because tail's foreground draws
23549 i
= right_overwritten (tail
);
23552 enum draw_glyphs_face overlap_hl
;
23554 if (check_mouse_face
23555 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23556 overlap_hl
= DRAW_MOUSE_FACE
;
23558 overlap_hl
= DRAW_NORMAL_TEXT
;
23560 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23561 overlap_hl
, x
, last_x
);
23562 /* Because BUILD_GLYPH_STRINGS updates the first argument,
23563 we don't have `end = i;' here. */
23564 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23565 append_glyph_string_lists (&head
, &tail
, h
, t
);
23569 /* Append glyph strings for glyphs following the last glyph
23570 string tail that overwrite tail. The foreground of such
23571 glyphs has to be drawn because it writes into the background
23572 of tail. The background must not be drawn because it could
23573 paint over the foreground of following glyphs. */
23574 i
= right_overwriting (tail
);
23577 enum draw_glyphs_face overlap_hl
;
23578 if (check_mouse_face
23579 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23580 overlap_hl
= DRAW_MOUSE_FACE
;
23582 overlap_hl
= DRAW_NORMAL_TEXT
;
23585 i
++; /* We must include the Ith glyph. */
23586 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23587 overlap_hl
, x
, last_x
);
23588 for (s
= h
; s
; s
= s
->next
)
23589 s
->background_filled_p
= 1;
23590 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23591 append_glyph_string_lists (&head
, &tail
, h
, t
);
23593 if (clip_head
|| clip_tail
)
23594 for (s
= head
; s
; s
= s
->next
)
23596 s
->clip_head
= clip_head
;
23597 s
->clip_tail
= clip_tail
;
23601 /* Draw all strings. */
23602 for (s
= head
; s
; s
= s
->next
)
23603 FRAME_RIF (f
)->draw_glyph_string (s
);
23606 /* When focus a sole frame and move horizontally, this sets on_p to 0
23607 causing a failure to erase prev cursor position. */
23608 if (area
== TEXT_AREA
23609 && !row
->full_width_p
23610 /* When drawing overlapping rows, only the glyph strings'
23611 foreground is drawn, which doesn't erase a cursor
23615 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
23616 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
23617 : (tail
? tail
->x
+ tail
->background_width
: x
));
23621 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
23622 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
23626 /* Value is the x-position up to which drawn, relative to AREA of W.
23627 This doesn't include parts drawn because of overhangs. */
23628 if (row
->full_width_p
)
23629 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
23631 x_reached
-= area_left
;
23633 RELEASE_HDC (hdc
, f
);
23638 /* Expand row matrix if too narrow. Don't expand if area
23641 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23643 if (!fonts_changed_p \
23644 && (it->glyph_row->glyphs[area] \
23645 < it->glyph_row->glyphs[area + 1])) \
23647 it->w->ncols_scale_factor++; \
23648 fonts_changed_p = 1; \
23652 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23653 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23656 append_glyph (struct it
*it
)
23658 struct glyph
*glyph
;
23659 enum glyph_row_area area
= it
->area
;
23661 eassert (it
->glyph_row
);
23662 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
23664 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23665 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23667 /* If the glyph row is reversed, we need to prepend the glyph
23668 rather than append it. */
23669 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23673 /* Make room for the additional glyph. */
23674 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23676 glyph
= it
->glyph_row
->glyphs
[area
];
23678 glyph
->charpos
= CHARPOS (it
->position
);
23679 glyph
->object
= it
->object
;
23680 if (it
->pixel_width
> 0)
23682 glyph
->pixel_width
= it
->pixel_width
;
23683 glyph
->padding_p
= 0;
23687 /* Assure at least 1-pixel width. Otherwise, cursor can't
23688 be displayed correctly. */
23689 glyph
->pixel_width
= 1;
23690 glyph
->padding_p
= 1;
23692 glyph
->ascent
= it
->ascent
;
23693 glyph
->descent
= it
->descent
;
23694 glyph
->voffset
= it
->voffset
;
23695 glyph
->type
= CHAR_GLYPH
;
23696 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23697 glyph
->multibyte_p
= it
->multibyte_p
;
23698 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23699 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23700 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23701 || it
->phys_descent
> it
->descent
);
23702 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
23703 glyph
->face_id
= it
->face_id
;
23704 glyph
->u
.ch
= it
->char_to_display
;
23705 glyph
->slice
.img
= null_glyph_slice
;
23706 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23709 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23710 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23712 glyph
->bidi_type
= it
->bidi_it
.type
;
23716 glyph
->resolved_level
= 0;
23717 glyph
->bidi_type
= UNKNOWN_BT
;
23719 ++it
->glyph_row
->used
[area
];
23722 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23725 /* Store one glyph for the composition IT->cmp_it.id in
23726 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23730 append_composite_glyph (struct it
*it
)
23732 struct glyph
*glyph
;
23733 enum glyph_row_area area
= it
->area
;
23735 eassert (it
->glyph_row
);
23737 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23738 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23740 /* If the glyph row is reversed, we need to prepend the glyph
23741 rather than append it. */
23742 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
23746 /* Make room for the new glyph. */
23747 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
23749 glyph
= it
->glyph_row
->glyphs
[it
->area
];
23751 glyph
->charpos
= it
->cmp_it
.charpos
;
23752 glyph
->object
= it
->object
;
23753 glyph
->pixel_width
= it
->pixel_width
;
23754 glyph
->ascent
= it
->ascent
;
23755 glyph
->descent
= it
->descent
;
23756 glyph
->voffset
= it
->voffset
;
23757 glyph
->type
= COMPOSITE_GLYPH
;
23758 if (it
->cmp_it
.ch
< 0)
23760 glyph
->u
.cmp
.automatic
= 0;
23761 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23762 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
23766 glyph
->u
.cmp
.automatic
= 1;
23767 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23768 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
23769 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
23771 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23772 glyph
->multibyte_p
= it
->multibyte_p
;
23773 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23774 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23775 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23776 || it
->phys_descent
> it
->descent
);
23777 glyph
->padding_p
= 0;
23778 glyph
->glyph_not_available_p
= 0;
23779 glyph
->face_id
= it
->face_id
;
23780 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23783 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23784 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23786 glyph
->bidi_type
= it
->bidi_it
.type
;
23788 ++it
->glyph_row
->used
[area
];
23791 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23795 /* Change IT->ascent and IT->height according to the setting of
23799 take_vertical_position_into_account (struct it
*it
)
23803 if (it
->voffset
< 0)
23804 /* Increase the ascent so that we can display the text higher
23806 it
->ascent
-= it
->voffset
;
23808 /* Increase the descent so that we can display the text lower
23810 it
->descent
+= it
->voffset
;
23815 /* Produce glyphs/get display metrics for the image IT is loaded with.
23816 See the description of struct display_iterator in dispextern.h for
23817 an overview of struct display_iterator. */
23820 produce_image_glyph (struct it
*it
)
23824 int glyph_ascent
, crop
;
23825 struct glyph_slice slice
;
23827 eassert (it
->what
== IT_IMAGE
);
23829 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23831 /* Make sure X resources of the face is loaded. */
23832 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23834 if (it
->image_id
< 0)
23836 /* Fringe bitmap. */
23837 it
->ascent
= it
->phys_ascent
= 0;
23838 it
->descent
= it
->phys_descent
= 0;
23839 it
->pixel_width
= 0;
23844 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
23846 /* Make sure X resources of the image is loaded. */
23847 prepare_image_for_display (it
->f
, img
);
23849 slice
.x
= slice
.y
= 0;
23850 slice
.width
= img
->width
;
23851 slice
.height
= img
->height
;
23853 if (INTEGERP (it
->slice
.x
))
23854 slice
.x
= XINT (it
->slice
.x
);
23855 else if (FLOATP (it
->slice
.x
))
23856 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
23858 if (INTEGERP (it
->slice
.y
))
23859 slice
.y
= XINT (it
->slice
.y
);
23860 else if (FLOATP (it
->slice
.y
))
23861 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
23863 if (INTEGERP (it
->slice
.width
))
23864 slice
.width
= XINT (it
->slice
.width
);
23865 else if (FLOATP (it
->slice
.width
))
23866 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
23868 if (INTEGERP (it
->slice
.height
))
23869 slice
.height
= XINT (it
->slice
.height
);
23870 else if (FLOATP (it
->slice
.height
))
23871 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
23873 if (slice
.x
>= img
->width
)
23874 slice
.x
= img
->width
;
23875 if (slice
.y
>= img
->height
)
23876 slice
.y
= img
->height
;
23877 if (slice
.x
+ slice
.width
>= img
->width
)
23878 slice
.width
= img
->width
- slice
.x
;
23879 if (slice
.y
+ slice
.height
> img
->height
)
23880 slice
.height
= img
->height
- slice
.y
;
23882 if (slice
.width
== 0 || slice
.height
== 0)
23885 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
23887 it
->descent
= slice
.height
- glyph_ascent
;
23889 it
->descent
+= img
->vmargin
;
23890 if (slice
.y
+ slice
.height
== img
->height
)
23891 it
->descent
+= img
->vmargin
;
23892 it
->phys_descent
= it
->descent
;
23894 it
->pixel_width
= slice
.width
;
23896 it
->pixel_width
+= img
->hmargin
;
23897 if (slice
.x
+ slice
.width
== img
->width
)
23898 it
->pixel_width
+= img
->hmargin
;
23900 /* It's quite possible for images to have an ascent greater than
23901 their height, so don't get confused in that case. */
23902 if (it
->descent
< 0)
23907 if (face
->box
!= FACE_NO_BOX
)
23909 if (face
->box_line_width
> 0)
23912 it
->ascent
+= face
->box_line_width
;
23913 if (slice
.y
+ slice
.height
== img
->height
)
23914 it
->descent
+= face
->box_line_width
;
23917 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23918 it
->pixel_width
+= eabs (face
->box_line_width
);
23919 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23920 it
->pixel_width
+= eabs (face
->box_line_width
);
23923 take_vertical_position_into_account (it
);
23925 /* Automatically crop wide image glyphs at right edge so we can
23926 draw the cursor on same display row. */
23927 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23928 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23930 it
->pixel_width
-= crop
;
23931 slice
.width
-= crop
;
23936 struct glyph
*glyph
;
23937 enum glyph_row_area area
= it
->area
;
23939 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23940 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23942 glyph
->charpos
= CHARPOS (it
->position
);
23943 glyph
->object
= it
->object
;
23944 glyph
->pixel_width
= it
->pixel_width
;
23945 glyph
->ascent
= glyph_ascent
;
23946 glyph
->descent
= it
->descent
;
23947 glyph
->voffset
= it
->voffset
;
23948 glyph
->type
= IMAGE_GLYPH
;
23949 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23950 glyph
->multibyte_p
= it
->multibyte_p
;
23951 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23952 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23953 glyph
->overlaps_vertically_p
= 0;
23954 glyph
->padding_p
= 0;
23955 glyph
->glyph_not_available_p
= 0;
23956 glyph
->face_id
= it
->face_id
;
23957 glyph
->u
.img_id
= img
->id
;
23958 glyph
->slice
.img
= slice
;
23959 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23962 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23963 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23965 glyph
->bidi_type
= it
->bidi_it
.type
;
23967 ++it
->glyph_row
->used
[area
];
23970 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23975 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23976 of the glyph, WIDTH and HEIGHT are the width and height of the
23977 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23980 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23981 int width
, int height
, int ascent
)
23983 struct glyph
*glyph
;
23984 enum glyph_row_area area
= it
->area
;
23986 eassert (ascent
>= 0 && ascent
<= height
);
23988 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23989 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23991 /* If the glyph row is reversed, we need to prepend the glyph
23992 rather than append it. */
23993 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23997 /* Make room for the additional glyph. */
23998 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24000 glyph
= it
->glyph_row
->glyphs
[area
];
24002 glyph
->charpos
= CHARPOS (it
->position
);
24003 glyph
->object
= object
;
24004 glyph
->pixel_width
= width
;
24005 glyph
->ascent
= ascent
;
24006 glyph
->descent
= height
- ascent
;
24007 glyph
->voffset
= it
->voffset
;
24008 glyph
->type
= STRETCH_GLYPH
;
24009 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24010 glyph
->multibyte_p
= it
->multibyte_p
;
24011 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24012 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24013 glyph
->overlaps_vertically_p
= 0;
24014 glyph
->padding_p
= 0;
24015 glyph
->glyph_not_available_p
= 0;
24016 glyph
->face_id
= it
->face_id
;
24017 glyph
->u
.stretch
.ascent
= ascent
;
24018 glyph
->u
.stretch
.height
= height
;
24019 glyph
->slice
.img
= null_glyph_slice
;
24020 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24023 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24024 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24026 glyph
->bidi_type
= it
->bidi_it
.type
;
24030 glyph
->resolved_level
= 0;
24031 glyph
->bidi_type
= UNKNOWN_BT
;
24033 ++it
->glyph_row
->used
[area
];
24036 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24039 #endif /* HAVE_WINDOW_SYSTEM */
24041 /* Produce a stretch glyph for iterator IT. IT->object is the value
24042 of the glyph property displayed. The value must be a list
24043 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
24046 1. `:width WIDTH' specifies that the space should be WIDTH *
24047 canonical char width wide. WIDTH may be an integer or floating
24050 2. `:relative-width FACTOR' specifies that the width of the stretch
24051 should be computed from the width of the first character having the
24052 `glyph' property, and should be FACTOR times that width.
24054 3. `:align-to HPOS' specifies that the space should be wide enough
24055 to reach HPOS, a value in canonical character units.
24057 Exactly one of the above pairs must be present.
24059 4. `:height HEIGHT' specifies that the height of the stretch produced
24060 should be HEIGHT, measured in canonical character units.
24062 5. `:relative-height FACTOR' specifies that the height of the
24063 stretch should be FACTOR times the height of the characters having
24064 the glyph property.
24066 Either none or exactly one of 4 or 5 must be present.
24068 6. `:ascent ASCENT' specifies that ASCENT percent of the height
24069 of the stretch should be used for the ascent of the stretch.
24070 ASCENT must be in the range 0 <= ASCENT <= 100. */
24073 produce_stretch_glyph (struct it
*it
)
24075 /* (space :width WIDTH :height HEIGHT ...) */
24076 Lisp_Object prop
, plist
;
24077 int width
= 0, height
= 0, align_to
= -1;
24078 int zero_width_ok_p
= 0;
24080 struct font
*font
= NULL
;
24082 #ifdef HAVE_WINDOW_SYSTEM
24084 int zero_height_ok_p
= 0;
24086 if (FRAME_WINDOW_P (it
->f
))
24088 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24089 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24090 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24094 /* List should start with `space'. */
24095 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
24096 plist
= XCDR (it
->object
);
24098 /* Compute the width of the stretch. */
24099 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
24100 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
24102 /* Absolute width `:width WIDTH' specified and valid. */
24103 zero_width_ok_p
= 1;
24106 #ifdef HAVE_WINDOW_SYSTEM
24107 else if (FRAME_WINDOW_P (it
->f
)
24108 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
24110 /* Relative width `:relative-width FACTOR' specified and valid.
24111 Compute the width of the characters having the `glyph'
24114 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
24117 if (it
->multibyte_p
)
24118 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
24121 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
24122 if (! ASCII_CHAR_P (it2
.c
))
24123 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
24126 it2
.glyph_row
= NULL
;
24127 it2
.what
= IT_CHARACTER
;
24128 x_produce_glyphs (&it2
);
24129 width
= NUMVAL (prop
) * it2
.pixel_width
;
24131 #endif /* HAVE_WINDOW_SYSTEM */
24132 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
24133 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
24135 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
24136 align_to
= (align_to
< 0
24138 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
24139 else if (align_to
< 0)
24140 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
24141 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
24142 zero_width_ok_p
= 1;
24145 /* Nothing specified -> width defaults to canonical char width. */
24146 width
= FRAME_COLUMN_WIDTH (it
->f
);
24148 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
24151 #ifdef HAVE_WINDOW_SYSTEM
24152 /* Compute height. */
24153 if (FRAME_WINDOW_P (it
->f
))
24155 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
24156 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24159 zero_height_ok_p
= 1;
24161 else if (prop
= Fplist_get (plist
, QCrelative_height
),
24163 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
24165 height
= FONT_HEIGHT (font
);
24167 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
24170 /* Compute percentage of height used for ascent. If
24171 `:ascent ASCENT' is present and valid, use that. Otherwise,
24172 derive the ascent from the font in use. */
24173 if (prop
= Fplist_get (plist
, QCascent
),
24174 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
24175 ascent
= height
* NUMVAL (prop
) / 100.0;
24176 else if (!NILP (prop
)
24177 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
24178 ascent
= min (max (0, (int)tem
), height
);
24180 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
24183 #endif /* HAVE_WINDOW_SYSTEM */
24186 if (width
> 0 && it
->line_wrap
!= TRUNCATE
24187 && it
->current_x
+ width
> it
->last_visible_x
)
24189 width
= it
->last_visible_x
- it
->current_x
;
24190 #ifdef HAVE_WINDOW_SYSTEM
24191 /* Subtract one more pixel from the stretch width, but only on
24192 GUI frames, since on a TTY each glyph is one "pixel" wide. */
24193 width
-= FRAME_WINDOW_P (it
->f
);
24197 if (width
> 0 && height
> 0 && it
->glyph_row
)
24199 Lisp_Object o_object
= it
->object
;
24200 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
24203 if (!STRINGP (object
))
24204 object
= it
->w
->buffer
;
24205 #ifdef HAVE_WINDOW_SYSTEM
24206 if (FRAME_WINDOW_P (it
->f
))
24207 append_stretch_glyph (it
, object
, width
, height
, ascent
);
24211 it
->object
= object
;
24212 it
->char_to_display
= ' ';
24213 it
->pixel_width
= it
->len
= 1;
24215 tty_append_glyph (it
);
24216 it
->object
= o_object
;
24220 it
->pixel_width
= width
;
24221 #ifdef HAVE_WINDOW_SYSTEM
24222 if (FRAME_WINDOW_P (it
->f
))
24224 it
->ascent
= it
->phys_ascent
= ascent
;
24225 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
24226 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
24227 take_vertical_position_into_account (it
);
24231 it
->nglyphs
= width
;
24234 /* Get information about special display element WHAT in an
24235 environment described by IT. WHAT is one of IT_TRUNCATION or
24236 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
24237 non-null glyph_row member. This function ensures that fields like
24238 face_id, c, len of IT are left untouched. */
24241 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
24248 temp_it
.object
= make_number (0);
24249 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
24251 if (what
== IT_CONTINUATION
)
24253 /* Continuation glyph. For R2L lines, we mirror it by hand. */
24254 if (it
->bidi_it
.paragraph_dir
== R2L
)
24255 SET_GLYPH_FROM_CHAR (glyph
, '/');
24257 SET_GLYPH_FROM_CHAR (glyph
, '\\');
24259 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24261 /* FIXME: Should we mirror GC for R2L lines? */
24262 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24263 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24266 else if (what
== IT_TRUNCATION
)
24268 /* Truncation glyph. */
24269 SET_GLYPH_FROM_CHAR (glyph
, '$');
24271 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
24273 /* FIXME: Should we mirror GC for R2L lines? */
24274 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
24275 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
24281 #ifdef HAVE_WINDOW_SYSTEM
24282 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
24283 is turned off, we precede the truncation/continuation glyphs by a
24284 stretch glyph whose width is computed such that these special
24285 glyphs are aligned at the window margin, even when very different
24286 fonts are used in different glyph rows. */
24287 if (FRAME_WINDOW_P (temp_it
.f
)
24288 /* init_iterator calls this with it->glyph_row == NULL, and it
24289 wants only the pixel width of the truncation/continuation
24291 && temp_it
.glyph_row
24292 /* insert_left_trunc_glyphs calls us at the beginning of the
24293 row, and it has its own calculation of the stretch glyph
24295 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
24296 && (temp_it
.glyph_row
->reversed_p
24297 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
24298 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
24300 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
24302 if (stretch_width
> 0)
24304 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
24305 struct font
*font
=
24306 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
24307 int stretch_ascent
=
24308 (((temp_it
.ascent
+ temp_it
.descent
)
24309 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
24311 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
24312 temp_it
.ascent
+ temp_it
.descent
,
24319 temp_it
.what
= IT_CHARACTER
;
24321 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
24322 temp_it
.face_id
= GLYPH_FACE (glyph
);
24323 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
24325 PRODUCE_GLYPHS (&temp_it
);
24326 it
->pixel_width
= temp_it
.pixel_width
;
24327 it
->nglyphs
= temp_it
.pixel_width
;
24330 #ifdef HAVE_WINDOW_SYSTEM
24332 /* Calculate line-height and line-spacing properties.
24333 An integer value specifies explicit pixel value.
24334 A float value specifies relative value to current face height.
24335 A cons (float . face-name) specifies relative value to
24336 height of specified face font.
24338 Returns height in pixels, or nil. */
24342 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
24343 int boff
, int override
)
24345 Lisp_Object face_name
= Qnil
;
24346 int ascent
, descent
, height
;
24348 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
24353 face_name
= XCAR (val
);
24355 if (!NUMBERP (val
))
24356 val
= make_number (1);
24357 if (NILP (face_name
))
24359 height
= it
->ascent
+ it
->descent
;
24364 if (NILP (face_name
))
24366 font
= FRAME_FONT (it
->f
);
24367 boff
= FRAME_BASELINE_OFFSET (it
->f
);
24369 else if (EQ (face_name
, Qt
))
24378 face_id
= lookup_named_face (it
->f
, face_name
, 0);
24380 return make_number (-1);
24382 face
= FACE_FROM_ID (it
->f
, face_id
);
24385 return make_number (-1);
24386 boff
= font
->baseline_offset
;
24387 if (font
->vertical_centering
)
24388 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24391 ascent
= FONT_BASE (font
) + boff
;
24392 descent
= FONT_DESCENT (font
) - boff
;
24396 it
->override_ascent
= ascent
;
24397 it
->override_descent
= descent
;
24398 it
->override_boff
= boff
;
24401 height
= ascent
+ descent
;
24405 height
= (int)(XFLOAT_DATA (val
) * height
);
24406 else if (INTEGERP (val
))
24407 height
*= XINT (val
);
24409 return make_number (height
);
24413 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
24414 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
24415 and only if this is for a character for which no font was found.
24417 If the display method (it->glyphless_method) is
24418 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
24419 length of the acronym or the hexadecimal string, UPPER_XOFF and
24420 UPPER_YOFF are pixel offsets for the upper part of the string,
24421 LOWER_XOFF and LOWER_YOFF are for the lower part.
24423 For the other display methods, LEN through LOWER_YOFF are zero. */
24426 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
24427 short upper_xoff
, short upper_yoff
,
24428 short lower_xoff
, short lower_yoff
)
24430 struct glyph
*glyph
;
24431 enum glyph_row_area area
= it
->area
;
24433 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24434 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24436 /* If the glyph row is reversed, we need to prepend the glyph
24437 rather than append it. */
24438 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24442 /* Make room for the additional glyph. */
24443 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24445 glyph
= it
->glyph_row
->glyphs
[area
];
24447 glyph
->charpos
= CHARPOS (it
->position
);
24448 glyph
->object
= it
->object
;
24449 glyph
->pixel_width
= it
->pixel_width
;
24450 glyph
->ascent
= it
->ascent
;
24451 glyph
->descent
= it
->descent
;
24452 glyph
->voffset
= it
->voffset
;
24453 glyph
->type
= GLYPHLESS_GLYPH
;
24454 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
24455 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
24456 glyph
->u
.glyphless
.len
= len
;
24457 glyph
->u
.glyphless
.ch
= it
->c
;
24458 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
24459 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
24460 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
24461 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
24462 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24463 glyph
->multibyte_p
= it
->multibyte_p
;
24464 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24465 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24466 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24467 || it
->phys_descent
> it
->descent
);
24468 glyph
->padding_p
= 0;
24469 glyph
->glyph_not_available_p
= 0;
24470 glyph
->face_id
= face_id
;
24471 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24474 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24475 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24477 glyph
->bidi_type
= it
->bidi_it
.type
;
24479 ++it
->glyph_row
->used
[area
];
24482 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24486 /* Produce a glyph for a glyphless character for iterator IT.
24487 IT->glyphless_method specifies which method to use for displaying
24488 the character. See the description of enum
24489 glyphless_display_method in dispextern.h for the detail.
24491 FOR_NO_FONT is nonzero if and only if this is for a character for
24492 which no font was found. ACRONYM, if non-nil, is an acronym string
24493 for the character. */
24496 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
24501 int base_width
, base_height
, width
, height
;
24502 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
24505 /* Get the metrics of the base font. We always refer to the current
24507 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
24508 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24509 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
24510 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
24511 base_height
= it
->ascent
+ it
->descent
;
24512 base_width
= font
->average_width
;
24514 /* Get a face ID for the glyph by utilizing a cache (the same way as
24515 done for `escape-glyph' in get_next_display_element). */
24516 if (it
->f
== last_glyphless_glyph_frame
24517 && it
->face_id
== last_glyphless_glyph_face_id
)
24519 face_id
= last_glyphless_glyph_merged_face_id
;
24523 /* Merge the `glyphless-char' face into the current face. */
24524 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
24525 last_glyphless_glyph_frame
= it
->f
;
24526 last_glyphless_glyph_face_id
= it
->face_id
;
24527 last_glyphless_glyph_merged_face_id
= face_id
;
24530 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
24532 it
->pixel_width
= THIN_SPACE_WIDTH
;
24534 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24536 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
24538 width
= CHAR_WIDTH (it
->c
);
24541 else if (width
> 4)
24543 it
->pixel_width
= base_width
* width
;
24545 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24551 unsigned int code
[6];
24553 int ascent
, descent
;
24554 struct font_metrics metrics_upper
, metrics_lower
;
24556 face
= FACE_FROM_ID (it
->f
, face_id
);
24557 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24558 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24560 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
24562 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
24563 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
24564 if (CONSP (acronym
))
24565 acronym
= XCAR (acronym
);
24566 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
24570 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
24571 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
24574 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
24575 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
24576 upper_len
= (len
+ 1) / 2;
24577 font
->driver
->text_extents (font
, code
, upper_len
,
24579 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
24584 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
24585 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
24586 upper_xoff
= upper_yoff
= 2; /* the typical case */
24587 if (base_width
>= width
)
24589 /* Align the upper to the left, the lower to the right. */
24590 it
->pixel_width
= base_width
;
24591 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
24595 /* Center the shorter one. */
24596 it
->pixel_width
= width
;
24597 if (metrics_upper
.width
>= metrics_lower
.width
)
24598 lower_xoff
= (width
- metrics_lower
.width
) / 2;
24601 /* FIXME: This code doesn't look right. It formerly was
24602 missing the "lower_xoff = 0;", which couldn't have
24603 been right since it left lower_xoff uninitialized. */
24605 upper_xoff
= (width
- metrics_upper
.width
) / 2;
24609 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
24610 top, bottom, and between upper and lower strings. */
24611 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
24612 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
24613 /* Center vertically.
24614 H:base_height, D:base_descent
24615 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
24617 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
24618 descent = D - H/2 + h/2;
24619 lower_yoff = descent - 2 - ld;
24620 upper_yoff = lower_yoff - la - 1 - ud; */
24621 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
24622 descent
= it
->descent
- (base_height
- height
) / 2;
24623 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
24624 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
24625 - metrics_upper
.descent
);
24626 /* Don't make the height shorter than the base height. */
24627 if (height
> base_height
)
24629 it
->ascent
= ascent
;
24630 it
->descent
= descent
;
24634 it
->phys_ascent
= it
->ascent
;
24635 it
->phys_descent
= it
->descent
;
24637 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
24638 upper_xoff
, upper_yoff
,
24639 lower_xoff
, lower_yoff
);
24641 take_vertical_position_into_account (it
);
24646 Produce glyphs/get display metrics for the display element IT is
24647 loaded with. See the description of struct it in dispextern.h
24648 for an overview of struct it. */
24651 x_produce_glyphs (struct it
*it
)
24653 int extra_line_spacing
= it
->extra_line_spacing
;
24655 it
->glyph_not_available_p
= 0;
24657 if (it
->what
== IT_CHARACTER
)
24660 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24661 struct font
*font
= face
->font
;
24662 struct font_metrics
*pcm
= NULL
;
24663 int boff
; /* baseline offset */
24667 /* When no suitable font is found, display this character by
24668 the method specified in the first extra slot of
24669 Vglyphless_char_display. */
24670 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
24672 eassert (it
->what
== IT_GLYPHLESS
);
24673 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
24677 boff
= font
->baseline_offset
;
24678 if (font
->vertical_centering
)
24679 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24681 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
24687 if (it
->override_ascent
>= 0)
24689 it
->ascent
= it
->override_ascent
;
24690 it
->descent
= it
->override_descent
;
24691 boff
= it
->override_boff
;
24695 it
->ascent
= FONT_BASE (font
) + boff
;
24696 it
->descent
= FONT_DESCENT (font
) - boff
;
24699 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
24701 pcm
= get_per_char_metric (font
, &char2b
);
24702 if (pcm
->width
== 0
24703 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
24709 it
->phys_ascent
= pcm
->ascent
+ boff
;
24710 it
->phys_descent
= pcm
->descent
- boff
;
24711 it
->pixel_width
= pcm
->width
;
24715 it
->glyph_not_available_p
= 1;
24716 it
->phys_ascent
= it
->ascent
;
24717 it
->phys_descent
= it
->descent
;
24718 it
->pixel_width
= font
->space_width
;
24721 if (it
->constrain_row_ascent_descent_p
)
24723 if (it
->descent
> it
->max_descent
)
24725 it
->ascent
+= it
->descent
- it
->max_descent
;
24726 it
->descent
= it
->max_descent
;
24728 if (it
->ascent
> it
->max_ascent
)
24730 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24731 it
->ascent
= it
->max_ascent
;
24733 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24734 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24735 extra_line_spacing
= 0;
24738 /* If this is a space inside a region of text with
24739 `space-width' property, change its width. */
24740 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
24742 it
->pixel_width
*= XFLOATINT (it
->space_width
);
24744 /* If face has a box, add the box thickness to the character
24745 height. If character has a box line to the left and/or
24746 right, add the box line width to the character's width. */
24747 if (face
->box
!= FACE_NO_BOX
)
24749 int thick
= face
->box_line_width
;
24753 it
->ascent
+= thick
;
24754 it
->descent
+= thick
;
24759 if (it
->start_of_box_run_p
)
24760 it
->pixel_width
+= thick
;
24761 if (it
->end_of_box_run_p
)
24762 it
->pixel_width
+= thick
;
24765 /* If face has an overline, add the height of the overline
24766 (1 pixel) and a 1 pixel margin to the character height. */
24767 if (face
->overline_p
)
24768 it
->ascent
+= overline_margin
;
24770 if (it
->constrain_row_ascent_descent_p
)
24772 if (it
->ascent
> it
->max_ascent
)
24773 it
->ascent
= it
->max_ascent
;
24774 if (it
->descent
> it
->max_descent
)
24775 it
->descent
= it
->max_descent
;
24778 take_vertical_position_into_account (it
);
24780 /* If we have to actually produce glyphs, do it. */
24785 /* Translate a space with a `space-width' property
24786 into a stretch glyph. */
24787 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
24788 / FONT_HEIGHT (font
));
24789 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24790 it
->ascent
+ it
->descent
, ascent
);
24795 /* If characters with lbearing or rbearing are displayed
24796 in this line, record that fact in a flag of the
24797 glyph row. This is used to optimize X output code. */
24798 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
24799 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24801 if (! stretched_p
&& it
->pixel_width
== 0)
24802 /* We assure that all visible glyphs have at least 1-pixel
24804 it
->pixel_width
= 1;
24806 else if (it
->char_to_display
== '\n')
24808 /* A newline has no width, but we need the height of the
24809 line. But if previous part of the line sets a height,
24810 don't increase that height */
24812 Lisp_Object height
;
24813 Lisp_Object total_height
= Qnil
;
24815 it
->override_ascent
= -1;
24816 it
->pixel_width
= 0;
24819 height
= get_it_property (it
, Qline_height
);
24820 /* Split (line-height total-height) list */
24822 && CONSP (XCDR (height
))
24823 && NILP (XCDR (XCDR (height
))))
24825 total_height
= XCAR (XCDR (height
));
24826 height
= XCAR (height
);
24828 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
24830 if (it
->override_ascent
>= 0)
24832 it
->ascent
= it
->override_ascent
;
24833 it
->descent
= it
->override_descent
;
24834 boff
= it
->override_boff
;
24838 it
->ascent
= FONT_BASE (font
) + boff
;
24839 it
->descent
= FONT_DESCENT (font
) - boff
;
24842 if (EQ (height
, Qt
))
24844 if (it
->descent
> it
->max_descent
)
24846 it
->ascent
+= it
->descent
- it
->max_descent
;
24847 it
->descent
= it
->max_descent
;
24849 if (it
->ascent
> it
->max_ascent
)
24851 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24852 it
->ascent
= it
->max_ascent
;
24854 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24855 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24856 it
->constrain_row_ascent_descent_p
= 1;
24857 extra_line_spacing
= 0;
24861 Lisp_Object spacing
;
24863 it
->phys_ascent
= it
->ascent
;
24864 it
->phys_descent
= it
->descent
;
24866 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
24867 && face
->box
!= FACE_NO_BOX
24868 && face
->box_line_width
> 0)
24870 it
->ascent
+= face
->box_line_width
;
24871 it
->descent
+= face
->box_line_width
;
24874 && XINT (height
) > it
->ascent
+ it
->descent
)
24875 it
->ascent
= XINT (height
) - it
->descent
;
24877 if (!NILP (total_height
))
24878 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
24881 spacing
= get_it_property (it
, Qline_spacing
);
24882 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
24884 if (INTEGERP (spacing
))
24886 extra_line_spacing
= XINT (spacing
);
24887 if (!NILP (total_height
))
24888 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
24892 else /* i.e. (it->char_to_display == '\t') */
24894 if (font
->space_width
> 0)
24896 int tab_width
= it
->tab_width
* font
->space_width
;
24897 int x
= it
->current_x
+ it
->continuation_lines_width
;
24898 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
24900 /* If the distance from the current position to the next tab
24901 stop is less than a space character width, use the
24902 tab stop after that. */
24903 if (next_tab_x
- x
< font
->space_width
)
24904 next_tab_x
+= tab_width
;
24906 it
->pixel_width
= next_tab_x
- x
;
24908 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
24909 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
24913 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24914 it
->ascent
+ it
->descent
, it
->ascent
);
24919 it
->pixel_width
= 0;
24924 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
24926 /* A static composition.
24928 Note: A composition is represented as one glyph in the
24929 glyph matrix. There are no padding glyphs.
24931 Important note: pixel_width, ascent, and descent are the
24932 values of what is drawn by draw_glyphs (i.e. the values of
24933 the overall glyphs composed). */
24934 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24935 int boff
; /* baseline offset */
24936 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
24937 int glyph_len
= cmp
->glyph_len
;
24938 struct font
*font
= face
->font
;
24942 /* If we have not yet calculated pixel size data of glyphs of
24943 the composition for the current face font, calculate them
24944 now. Theoretically, we have to check all fonts for the
24945 glyphs, but that requires much time and memory space. So,
24946 here we check only the font of the first glyph. This may
24947 lead to incorrect display, but it's very rare, and C-l
24948 (recenter-top-bottom) can correct the display anyway. */
24949 if (! cmp
->font
|| cmp
->font
!= font
)
24951 /* Ascent and descent of the font of the first character
24952 of this composition (adjusted by baseline offset).
24953 Ascent and descent of overall glyphs should not be less
24954 than these, respectively. */
24955 int font_ascent
, font_descent
, font_height
;
24956 /* Bounding box of the overall glyphs. */
24957 int leftmost
, rightmost
, lowest
, highest
;
24958 int lbearing
, rbearing
;
24959 int i
, width
, ascent
, descent
;
24960 int left_padded
= 0, right_padded
= 0;
24961 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
24963 struct font_metrics
*pcm
;
24964 int font_not_found_p
;
24967 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
24968 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
24970 if (glyph_len
< cmp
->glyph_len
)
24972 for (i
= 0; i
< glyph_len
; i
++)
24974 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
24976 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24981 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
24982 : IT_CHARPOS (*it
));
24983 /* If no suitable font is found, use the default font. */
24984 font_not_found_p
= font
== NULL
;
24985 if (font_not_found_p
)
24987 face
= face
->ascii_face
;
24990 boff
= font
->baseline_offset
;
24991 if (font
->vertical_centering
)
24992 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24993 font_ascent
= FONT_BASE (font
) + boff
;
24994 font_descent
= FONT_DESCENT (font
) - boff
;
24995 font_height
= FONT_HEIGHT (font
);
25000 if (! font_not_found_p
)
25002 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
25004 pcm
= get_per_char_metric (font
, &char2b
);
25007 /* Initialize the bounding box. */
25010 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
25011 ascent
= pcm
->ascent
;
25012 descent
= pcm
->descent
;
25013 lbearing
= pcm
->lbearing
;
25014 rbearing
= pcm
->rbearing
;
25018 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
25019 ascent
= FONT_BASE (font
);
25020 descent
= FONT_DESCENT (font
);
25027 lowest
= - descent
+ boff
;
25028 highest
= ascent
+ boff
;
25030 if (! font_not_found_p
25031 && font
->default_ascent
25032 && CHAR_TABLE_P (Vuse_default_ascent
)
25033 && !NILP (Faref (Vuse_default_ascent
,
25034 make_number (it
->char_to_display
))))
25035 highest
= font
->default_ascent
+ boff
;
25037 /* Draw the first glyph at the normal position. It may be
25038 shifted to right later if some other glyphs are drawn
25040 cmp
->offsets
[i
* 2] = 0;
25041 cmp
->offsets
[i
* 2 + 1] = boff
;
25042 cmp
->lbearing
= lbearing
;
25043 cmp
->rbearing
= rbearing
;
25045 /* Set cmp->offsets for the remaining glyphs. */
25046 for (i
++; i
< glyph_len
; i
++)
25048 int left
, right
, btm
, top
;
25049 int ch
= COMPOSITION_GLYPH (cmp
, i
);
25051 struct face
*this_face
;
25055 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
25056 this_face
= FACE_FROM_ID (it
->f
, face_id
);
25057 font
= this_face
->font
;
25063 get_char_face_and_encoding (it
->f
, ch
, face_id
,
25065 pcm
= get_per_char_metric (font
, &char2b
);
25068 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
25071 width
= pcm
->width
;
25072 ascent
= pcm
->ascent
;
25073 descent
= pcm
->descent
;
25074 lbearing
= pcm
->lbearing
;
25075 rbearing
= pcm
->rbearing
;
25076 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
25078 /* Relative composition with or without
25079 alternate chars. */
25080 left
= (leftmost
+ rightmost
- width
) / 2;
25081 btm
= - descent
+ boff
;
25082 if (font
->relative_compose
25083 && (! CHAR_TABLE_P (Vignore_relative_composition
)
25084 || NILP (Faref (Vignore_relative_composition
,
25085 make_number (ch
)))))
25088 if (- descent
>= font
->relative_compose
)
25089 /* One extra pixel between two glyphs. */
25091 else if (ascent
<= 0)
25092 /* One extra pixel between two glyphs. */
25093 btm
= lowest
- 1 - ascent
- descent
;
25098 /* A composition rule is specified by an integer
25099 value that encodes global and new reference
25100 points (GREF and NREF). GREF and NREF are
25101 specified by numbers as below:
25103 0---1---2 -- ascent
25107 9--10--11 -- center
25109 ---3---4---5--- baseline
25111 6---7---8 -- descent
25113 int rule
= COMPOSITION_RULE (cmp
, i
);
25114 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
25116 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
25117 grefx
= gref
% 3, nrefx
= nref
% 3;
25118 grefy
= gref
/ 3, nrefy
= nref
/ 3;
25120 xoff
= font_height
* (xoff
- 128) / 256;
25122 yoff
= font_height
* (yoff
- 128) / 256;
25125 + grefx
* (rightmost
- leftmost
) / 2
25126 - nrefx
* width
/ 2
25129 btm
= ((grefy
== 0 ? highest
25131 : grefy
== 2 ? lowest
25132 : (highest
+ lowest
) / 2)
25133 - (nrefy
== 0 ? ascent
+ descent
25134 : nrefy
== 1 ? descent
- boff
25136 : (ascent
+ descent
) / 2)
25140 cmp
->offsets
[i
* 2] = left
;
25141 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
25143 /* Update the bounding box of the overall glyphs. */
25146 right
= left
+ width
;
25147 if (left
< leftmost
)
25149 if (right
> rightmost
)
25152 top
= btm
+ descent
+ ascent
;
25158 if (cmp
->lbearing
> left
+ lbearing
)
25159 cmp
->lbearing
= left
+ lbearing
;
25160 if (cmp
->rbearing
< left
+ rbearing
)
25161 cmp
->rbearing
= left
+ rbearing
;
25165 /* If there are glyphs whose x-offsets are negative,
25166 shift all glyphs to the right and make all x-offsets
25170 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25171 cmp
->offsets
[i
* 2] -= leftmost
;
25172 rightmost
-= leftmost
;
25173 cmp
->lbearing
-= leftmost
;
25174 cmp
->rbearing
-= leftmost
;
25177 if (left_padded
&& cmp
->lbearing
< 0)
25179 for (i
= 0; i
< cmp
->glyph_len
; i
++)
25180 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
25181 rightmost
-= cmp
->lbearing
;
25182 cmp
->rbearing
-= cmp
->lbearing
;
25185 if (right_padded
&& rightmost
< cmp
->rbearing
)
25187 rightmost
= cmp
->rbearing
;
25190 cmp
->pixel_width
= rightmost
;
25191 cmp
->ascent
= highest
;
25192 cmp
->descent
= - lowest
;
25193 if (cmp
->ascent
< font_ascent
)
25194 cmp
->ascent
= font_ascent
;
25195 if (cmp
->descent
< font_descent
)
25196 cmp
->descent
= font_descent
;
25200 && (cmp
->lbearing
< 0
25201 || cmp
->rbearing
> cmp
->pixel_width
))
25202 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25204 it
->pixel_width
= cmp
->pixel_width
;
25205 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
25206 it
->descent
= it
->phys_descent
= cmp
->descent
;
25207 if (face
->box
!= FACE_NO_BOX
)
25209 int thick
= face
->box_line_width
;
25213 it
->ascent
+= thick
;
25214 it
->descent
+= thick
;
25219 if (it
->start_of_box_run_p
)
25220 it
->pixel_width
+= thick
;
25221 if (it
->end_of_box_run_p
)
25222 it
->pixel_width
+= thick
;
25225 /* If face has an overline, add the height of the overline
25226 (1 pixel) and a 1 pixel margin to the character height. */
25227 if (face
->overline_p
)
25228 it
->ascent
+= overline_margin
;
25230 take_vertical_position_into_account (it
);
25231 if (it
->ascent
< 0)
25233 if (it
->descent
< 0)
25236 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
25237 append_composite_glyph (it
);
25239 else if (it
->what
== IT_COMPOSITION
)
25241 /* A dynamic (automatic) composition. */
25242 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25243 Lisp_Object gstring
;
25244 struct font_metrics metrics
;
25248 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
25250 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
25253 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
25254 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25255 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
25256 it
->descent
= it
->phys_descent
= metrics
.descent
;
25257 if (face
->box
!= FACE_NO_BOX
)
25259 int thick
= face
->box_line_width
;
25263 it
->ascent
+= thick
;
25264 it
->descent
+= thick
;
25269 if (it
->start_of_box_run_p
)
25270 it
->pixel_width
+= thick
;
25271 if (it
->end_of_box_run_p
)
25272 it
->pixel_width
+= thick
;
25274 /* If face has an overline, add the height of the overline
25275 (1 pixel) and a 1 pixel margin to the character height. */
25276 if (face
->overline_p
)
25277 it
->ascent
+= overline_margin
;
25278 take_vertical_position_into_account (it
);
25279 if (it
->ascent
< 0)
25281 if (it
->descent
< 0)
25285 append_composite_glyph (it
);
25287 else if (it
->what
== IT_GLYPHLESS
)
25288 produce_glyphless_glyph (it
, 0, Qnil
);
25289 else if (it
->what
== IT_IMAGE
)
25290 produce_image_glyph (it
);
25291 else if (it
->what
== IT_STRETCH
)
25292 produce_stretch_glyph (it
);
25295 /* Accumulate dimensions. Note: can't assume that it->descent > 0
25296 because this isn't true for images with `:ascent 100'. */
25297 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
25298 if (it
->area
== TEXT_AREA
)
25299 it
->current_x
+= it
->pixel_width
;
25301 if (extra_line_spacing
> 0)
25303 it
->descent
+= extra_line_spacing
;
25304 if (extra_line_spacing
> it
->max_extra_line_spacing
)
25305 it
->max_extra_line_spacing
= extra_line_spacing
;
25308 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
25309 it
->max_descent
= max (it
->max_descent
, it
->descent
);
25310 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
25311 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
25315 Output LEN glyphs starting at START at the nominal cursor position.
25316 Advance the nominal cursor over the text. The global variable
25317 updated_window contains the window being updated, updated_row is
25318 the glyph row being updated, and updated_area is the area of that
25319 row being updated. */
25322 x_write_glyphs (struct glyph
*start
, int len
)
25324 int x
, hpos
, chpos
= updated_window
->phys_cursor
.hpos
;
25326 eassert (updated_window
&& updated_row
);
25327 /* When the window is hscrolled, cursor hpos can legitimately be out
25328 of bounds, but we draw the cursor at the corresponding window
25329 margin in that case. */
25330 if (!updated_row
->reversed_p
&& chpos
< 0)
25332 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
25333 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
25337 /* Write glyphs. */
25339 hpos
= start
- updated_row
->glyphs
[updated_area
];
25340 x
= draw_glyphs (updated_window
, output_cursor
.x
,
25341 updated_row
, updated_area
,
25343 DRAW_NORMAL_TEXT
, 0);
25345 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
25346 if (updated_area
== TEXT_AREA
25347 && updated_window
->phys_cursor_on_p
25348 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
25350 && chpos
< hpos
+ len
)
25351 updated_window
->phys_cursor_on_p
= 0;
25355 /* Advance the output cursor. */
25356 output_cursor
.hpos
+= len
;
25357 output_cursor
.x
= x
;
25362 Insert LEN glyphs from START at the nominal cursor position. */
25365 x_insert_glyphs (struct glyph
*start
, int len
)
25369 int line_height
, shift_by_width
, shifted_region_width
;
25370 struct glyph_row
*row
;
25371 struct glyph
*glyph
;
25372 int frame_x
, frame_y
;
25375 eassert (updated_window
&& updated_row
);
25377 w
= updated_window
;
25378 f
= XFRAME (WINDOW_FRAME (w
));
25380 /* Get the height of the line we are in. */
25382 line_height
= row
->height
;
25384 /* Get the width of the glyphs to insert. */
25385 shift_by_width
= 0;
25386 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
25387 shift_by_width
+= glyph
->pixel_width
;
25389 /* Get the width of the region to shift right. */
25390 shifted_region_width
= (window_box_width (w
, updated_area
)
25395 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
25396 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
25398 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
25399 line_height
, shift_by_width
);
25401 /* Write the glyphs. */
25402 hpos
= start
- row
->glyphs
[updated_area
];
25403 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
25405 DRAW_NORMAL_TEXT
, 0);
25407 /* Advance the output cursor. */
25408 output_cursor
.hpos
+= len
;
25409 output_cursor
.x
+= shift_by_width
;
25415 Erase the current text line from the nominal cursor position
25416 (inclusive) to pixel column TO_X (exclusive). The idea is that
25417 everything from TO_X onward is already erased.
25419 TO_X is a pixel position relative to updated_area of
25420 updated_window. TO_X == -1 means clear to the end of this area. */
25423 x_clear_end_of_line (int to_x
)
25426 struct window
*w
= updated_window
;
25427 int max_x
, min_y
, max_y
;
25428 int from_x
, from_y
, to_y
;
25430 eassert (updated_window
&& updated_row
);
25431 f
= XFRAME (w
->frame
);
25433 if (updated_row
->full_width_p
)
25434 max_x
= WINDOW_TOTAL_WIDTH (w
);
25436 max_x
= window_box_width (w
, updated_area
);
25437 max_y
= window_text_bottom_y (w
);
25439 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
25440 of window. For TO_X > 0, truncate to end of drawing area. */
25446 to_x
= min (to_x
, max_x
);
25448 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
25450 /* Notice if the cursor will be cleared by this operation. */
25451 if (!updated_row
->full_width_p
)
25452 notice_overwritten_cursor (w
, updated_area
,
25453 output_cursor
.x
, -1,
25455 MATRIX_ROW_BOTTOM_Y (updated_row
));
25457 from_x
= output_cursor
.x
;
25459 /* Translate to frame coordinates. */
25460 if (updated_row
->full_width_p
)
25462 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
25463 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
25467 int area_left
= window_box_left (w
, updated_area
);
25468 from_x
+= area_left
;
25472 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
25473 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
25474 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
25476 /* Prevent inadvertently clearing to end of the X window. */
25477 if (to_x
> from_x
&& to_y
> from_y
)
25480 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
25481 to_x
- from_x
, to_y
- from_y
);
25486 #endif /* HAVE_WINDOW_SYSTEM */
25490 /***********************************************************************
25492 ***********************************************************************/
25494 /* Value is the internal representation of the specified cursor type
25495 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
25496 of the bar cursor. */
25498 static enum text_cursor_kinds
25499 get_specified_cursor_type (Lisp_Object arg
, int *width
)
25501 enum text_cursor_kinds type
;
25506 if (EQ (arg
, Qbox
))
25507 return FILLED_BOX_CURSOR
;
25509 if (EQ (arg
, Qhollow
))
25510 return HOLLOW_BOX_CURSOR
;
25512 if (EQ (arg
, Qbar
))
25519 && EQ (XCAR (arg
), Qbar
)
25520 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25522 *width
= XINT (XCDR (arg
));
25526 if (EQ (arg
, Qhbar
))
25529 return HBAR_CURSOR
;
25533 && EQ (XCAR (arg
), Qhbar
)
25534 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
25536 *width
= XINT (XCDR (arg
));
25537 return HBAR_CURSOR
;
25540 /* Treat anything unknown as "hollow box cursor".
25541 It was bad to signal an error; people have trouble fixing
25542 .Xdefaults with Emacs, when it has something bad in it. */
25543 type
= HOLLOW_BOX_CURSOR
;
25548 /* Set the default cursor types for specified frame. */
25550 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
25555 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
25556 FRAME_CURSOR_WIDTH (f
) = width
;
25558 /* By default, set up the blink-off state depending on the on-state. */
25560 tem
= Fassoc (arg
, Vblink_cursor_alist
);
25563 FRAME_BLINK_OFF_CURSOR (f
)
25564 = get_specified_cursor_type (XCDR (tem
), &width
);
25565 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
25568 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
25572 #ifdef HAVE_WINDOW_SYSTEM
25574 /* Return the cursor we want to be displayed in window W. Return
25575 width of bar/hbar cursor through WIDTH arg. Return with
25576 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
25577 (i.e. if the `system caret' should track this cursor).
25579 In a mini-buffer window, we want the cursor only to appear if we
25580 are reading input from this window. For the selected window, we
25581 want the cursor type given by the frame parameter or buffer local
25582 setting of cursor-type. If explicitly marked off, draw no cursor.
25583 In all other cases, we want a hollow box cursor. */
25585 static enum text_cursor_kinds
25586 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
25587 int *active_cursor
)
25589 struct frame
*f
= XFRAME (w
->frame
);
25590 struct buffer
*b
= XBUFFER (w
->buffer
);
25591 int cursor_type
= DEFAULT_CURSOR
;
25592 Lisp_Object alt_cursor
;
25593 int non_selected
= 0;
25595 *active_cursor
= 1;
25598 if (cursor_in_echo_area
25599 && FRAME_HAS_MINIBUF_P (f
)
25600 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
25602 if (w
== XWINDOW (echo_area_window
))
25604 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
25606 *width
= FRAME_CURSOR_WIDTH (f
);
25607 return FRAME_DESIRED_CURSOR (f
);
25610 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25613 *active_cursor
= 0;
25617 /* Detect a nonselected window or nonselected frame. */
25618 else if (w
!= XWINDOW (f
->selected_window
)
25619 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
25621 *active_cursor
= 0;
25623 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
25629 /* Never display a cursor in a window in which cursor-type is nil. */
25630 if (NILP (BVAR (b
, cursor_type
)))
25633 /* Get the normal cursor type for this window. */
25634 if (EQ (BVAR (b
, cursor_type
), Qt
))
25636 cursor_type
= FRAME_DESIRED_CURSOR (f
);
25637 *width
= FRAME_CURSOR_WIDTH (f
);
25640 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25642 /* Use cursor-in-non-selected-windows instead
25643 for non-selected window or frame. */
25646 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
25647 if (!EQ (Qt
, alt_cursor
))
25648 return get_specified_cursor_type (alt_cursor
, width
);
25649 /* t means modify the normal cursor type. */
25650 if (cursor_type
== FILLED_BOX_CURSOR
)
25651 cursor_type
= HOLLOW_BOX_CURSOR
;
25652 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
25654 return cursor_type
;
25657 /* Use normal cursor if not blinked off. */
25658 if (!w
->cursor_off_p
)
25660 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25662 if (cursor_type
== FILLED_BOX_CURSOR
)
25664 /* Using a block cursor on large images can be very annoying.
25665 So use a hollow cursor for "large" images.
25666 If image is not transparent (no mask), also use hollow cursor. */
25667 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25668 if (img
!= NULL
&& IMAGEP (img
->spec
))
25670 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
25671 where N = size of default frame font size.
25672 This should cover most of the "tiny" icons people may use. */
25674 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
25675 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
25676 cursor_type
= HOLLOW_BOX_CURSOR
;
25679 else if (cursor_type
!= NO_CURSOR
)
25681 /* Display current only supports BOX and HOLLOW cursors for images.
25682 So for now, unconditionally use a HOLLOW cursor when cursor is
25683 not a solid box cursor. */
25684 cursor_type
= HOLLOW_BOX_CURSOR
;
25687 return cursor_type
;
25690 /* Cursor is blinked off, so determine how to "toggle" it. */
25692 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
25693 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
25694 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
25696 /* Then see if frame has specified a specific blink off cursor type. */
25697 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
25699 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
25700 return FRAME_BLINK_OFF_CURSOR (f
);
25704 /* Some people liked having a permanently visible blinking cursor,
25705 while others had very strong opinions against it. So it was
25706 decided to remove it. KFS 2003-09-03 */
25708 /* Finally perform built-in cursor blinking:
25709 filled box <-> hollow box
25710 wide [h]bar <-> narrow [h]bar
25711 narrow [h]bar <-> no cursor
25712 other type <-> no cursor */
25714 if (cursor_type
== FILLED_BOX_CURSOR
)
25715 return HOLLOW_BOX_CURSOR
;
25717 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
25720 return cursor_type
;
25728 /* Notice when the text cursor of window W has been completely
25729 overwritten by a drawing operation that outputs glyphs in AREA
25730 starting at X0 and ending at X1 in the line starting at Y0 and
25731 ending at Y1. X coordinates are area-relative. X1 < 0 means all
25732 the rest of the line after X0 has been written. Y coordinates
25733 are window-relative. */
25736 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
25737 int x0
, int x1
, int y0
, int y1
)
25739 int cx0
, cx1
, cy0
, cy1
;
25740 struct glyph_row
*row
;
25742 if (!w
->phys_cursor_on_p
)
25744 if (area
!= TEXT_AREA
)
25747 if (w
->phys_cursor
.vpos
< 0
25748 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
25749 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
25750 !(row
->enabled_p
&& row
->displays_text_p
)))
25753 if (row
->cursor_in_fringe_p
)
25755 row
->cursor_in_fringe_p
= 0;
25756 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
25757 w
->phys_cursor_on_p
= 0;
25761 cx0
= w
->phys_cursor
.x
;
25762 cx1
= cx0
+ w
->phys_cursor_width
;
25763 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
25766 /* The cursor image will be completely removed from the
25767 screen if the output area intersects the cursor area in
25768 y-direction. When we draw in [y0 y1[, and some part of
25769 the cursor is at y < y0, that part must have been drawn
25770 before. When scrolling, the cursor is erased before
25771 actually scrolling, so we don't come here. When not
25772 scrolling, the rows above the old cursor row must have
25773 changed, and in this case these rows must have written
25774 over the cursor image.
25776 Likewise if part of the cursor is below y1, with the
25777 exception of the cursor being in the first blank row at
25778 the buffer and window end because update_text_area
25779 doesn't draw that row. (Except when it does, but
25780 that's handled in update_text_area.) */
25782 cy0
= w
->phys_cursor
.y
;
25783 cy1
= cy0
+ w
->phys_cursor_height
;
25784 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
25787 w
->phys_cursor_on_p
= 0;
25790 #endif /* HAVE_WINDOW_SYSTEM */
25793 /************************************************************************
25795 ************************************************************************/
25797 #ifdef HAVE_WINDOW_SYSTEM
25800 Fix the display of area AREA of overlapping row ROW in window W
25801 with respect to the overlapping part OVERLAPS. */
25804 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
25805 enum glyph_row_area area
, int overlaps
)
25812 for (i
= 0; i
< row
->used
[area
];)
25814 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
25816 int start
= i
, start_x
= x
;
25820 x
+= row
->glyphs
[area
][i
].pixel_width
;
25823 while (i
< row
->used
[area
]
25824 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
25826 draw_glyphs (w
, start_x
, row
, area
,
25828 DRAW_NORMAL_TEXT
, overlaps
);
25832 x
+= row
->glyphs
[area
][i
].pixel_width
;
25842 Draw the cursor glyph of window W in glyph row ROW. See the
25843 comment of draw_glyphs for the meaning of HL. */
25846 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
25847 enum draw_glyphs_face hl
)
25849 /* If cursor hpos is out of bounds, don't draw garbage. This can
25850 happen in mini-buffer windows when switching between echo area
25851 glyphs and mini-buffer. */
25852 if ((row
->reversed_p
25853 ? (w
->phys_cursor
.hpos
>= 0)
25854 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
25856 int on_p
= w
->phys_cursor_on_p
;
25858 int hpos
= w
->phys_cursor
.hpos
;
25860 /* When the window is hscrolled, cursor hpos can legitimately be
25861 out of bounds, but we draw the cursor at the corresponding
25862 window margin in that case. */
25863 if (!row
->reversed_p
&& hpos
< 0)
25865 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25866 hpos
= row
->used
[TEXT_AREA
] - 1;
25868 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
25870 w
->phys_cursor_on_p
= on_p
;
25872 if (hl
== DRAW_CURSOR
)
25873 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25874 /* When we erase the cursor, and ROW is overlapped by other
25875 rows, make sure that these overlapping parts of other rows
25877 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
25879 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25881 if (row
> w
->current_matrix
->rows
25882 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
25883 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
25884 OVERLAPS_ERASED_CURSOR
);
25886 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
25887 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
25888 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
25889 OVERLAPS_ERASED_CURSOR
);
25896 Erase the image of a cursor of window W from the screen. */
25899 erase_phys_cursor (struct window
*w
)
25901 struct frame
*f
= XFRAME (w
->frame
);
25902 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25903 int hpos
= w
->phys_cursor
.hpos
;
25904 int vpos
= w
->phys_cursor
.vpos
;
25905 int mouse_face_here_p
= 0;
25906 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
25907 struct glyph_row
*cursor_row
;
25908 struct glyph
*cursor_glyph
;
25909 enum draw_glyphs_face hl
;
25911 /* No cursor displayed or row invalidated => nothing to do on the
25913 if (w
->phys_cursor_type
== NO_CURSOR
)
25914 goto mark_cursor_off
;
25916 /* VPOS >= active_glyphs->nrows means that window has been resized.
25917 Don't bother to erase the cursor. */
25918 if (vpos
>= active_glyphs
->nrows
)
25919 goto mark_cursor_off
;
25921 /* If row containing cursor is marked invalid, there is nothing we
25923 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
25924 if (!cursor_row
->enabled_p
)
25925 goto mark_cursor_off
;
25927 /* If line spacing is > 0, old cursor may only be partially visible in
25928 window after split-window. So adjust visible height. */
25929 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
25930 window_text_bottom_y (w
) - cursor_row
->y
);
25932 /* If row is completely invisible, don't attempt to delete a cursor which
25933 isn't there. This can happen if cursor is at top of a window, and
25934 we switch to a buffer with a header line in that window. */
25935 if (cursor_row
->visible_height
<= 0)
25936 goto mark_cursor_off
;
25938 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
25939 if (cursor_row
->cursor_in_fringe_p
)
25941 cursor_row
->cursor_in_fringe_p
= 0;
25942 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
25943 goto mark_cursor_off
;
25946 /* This can happen when the new row is shorter than the old one.
25947 In this case, either draw_glyphs or clear_end_of_line
25948 should have cleared the cursor. Note that we wouldn't be
25949 able to erase the cursor in this case because we don't have a
25950 cursor glyph at hand. */
25951 if ((cursor_row
->reversed_p
25952 ? (w
->phys_cursor
.hpos
< 0)
25953 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
25954 goto mark_cursor_off
;
25956 /* When the window is hscrolled, cursor hpos can legitimately be out
25957 of bounds, but we draw the cursor at the corresponding window
25958 margin in that case. */
25959 if (!cursor_row
->reversed_p
&& hpos
< 0)
25961 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
25962 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
25964 /* If the cursor is in the mouse face area, redisplay that when
25965 we clear the cursor. */
25966 if (! NILP (hlinfo
->mouse_face_window
)
25967 && coords_in_mouse_face_p (w
, hpos
, vpos
)
25968 /* Don't redraw the cursor's spot in mouse face if it is at the
25969 end of a line (on a newline). The cursor appears there, but
25970 mouse highlighting does not. */
25971 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
25972 mouse_face_here_p
= 1;
25974 /* Maybe clear the display under the cursor. */
25975 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
25978 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
25981 cursor_glyph
= get_phys_cursor_glyph (w
);
25982 if (cursor_glyph
== NULL
)
25983 goto mark_cursor_off
;
25985 width
= cursor_glyph
->pixel_width
;
25986 left_x
= window_box_left_offset (w
, TEXT_AREA
);
25987 x
= w
->phys_cursor
.x
;
25989 width
-= left_x
- x
;
25990 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
25991 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
25992 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
25995 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
25998 /* Erase the cursor by redrawing the character underneath it. */
25999 if (mouse_face_here_p
)
26000 hl
= DRAW_MOUSE_FACE
;
26002 hl
= DRAW_NORMAL_TEXT
;
26003 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
26006 w
->phys_cursor_on_p
= 0;
26007 w
->phys_cursor_type
= NO_CURSOR
;
26012 Display or clear cursor of window W. If ON is zero, clear the
26013 cursor. If it is non-zero, display the cursor. If ON is nonzero,
26014 where to put the cursor is specified by HPOS, VPOS, X and Y. */
26017 display_and_set_cursor (struct window
*w
, int on
,
26018 int hpos
, int vpos
, int x
, int y
)
26020 struct frame
*f
= XFRAME (w
->frame
);
26021 int new_cursor_type
;
26022 int new_cursor_width
;
26024 struct glyph_row
*glyph_row
;
26025 struct glyph
*glyph
;
26027 /* This is pointless on invisible frames, and dangerous on garbaged
26028 windows and frames; in the latter case, the frame or window may
26029 be in the midst of changing its size, and x and y may be off the
26031 if (! FRAME_VISIBLE_P (f
)
26032 || FRAME_GARBAGED_P (f
)
26033 || vpos
>= w
->current_matrix
->nrows
26034 || hpos
>= w
->current_matrix
->matrix_w
)
26037 /* If cursor is off and we want it off, return quickly. */
26038 if (!on
&& !w
->phys_cursor_on_p
)
26041 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26042 /* If cursor row is not enabled, we don't really know where to
26043 display the cursor. */
26044 if (!glyph_row
->enabled_p
)
26046 w
->phys_cursor_on_p
= 0;
26051 if (!glyph_row
->exact_window_width_line_p
26052 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
26053 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
26055 eassert (input_blocked_p ());
26057 /* Set new_cursor_type to the cursor we want to be displayed. */
26058 new_cursor_type
= get_window_cursor_type (w
, glyph
,
26059 &new_cursor_width
, &active_cursor
);
26061 /* If cursor is currently being shown and we don't want it to be or
26062 it is in the wrong place, or the cursor type is not what we want,
26064 if (w
->phys_cursor_on_p
26066 || w
->phys_cursor
.x
!= x
26067 || w
->phys_cursor
.y
!= y
26068 || new_cursor_type
!= w
->phys_cursor_type
26069 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
26070 && new_cursor_width
!= w
->phys_cursor_width
)))
26071 erase_phys_cursor (w
);
26073 /* Don't check phys_cursor_on_p here because that flag is only set
26074 to zero in some cases where we know that the cursor has been
26075 completely erased, to avoid the extra work of erasing the cursor
26076 twice. In other words, phys_cursor_on_p can be 1 and the cursor
26077 still not be visible, or it has only been partly erased. */
26080 w
->phys_cursor_ascent
= glyph_row
->ascent
;
26081 w
->phys_cursor_height
= glyph_row
->height
;
26083 /* Set phys_cursor_.* before x_draw_.* is called because some
26084 of them may need the information. */
26085 w
->phys_cursor
.x
= x
;
26086 w
->phys_cursor
.y
= glyph_row
->y
;
26087 w
->phys_cursor
.hpos
= hpos
;
26088 w
->phys_cursor
.vpos
= vpos
;
26091 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
26092 new_cursor_type
, new_cursor_width
,
26093 on
, active_cursor
);
26097 /* Switch the display of W's cursor on or off, according to the value
26101 update_window_cursor (struct window
*w
, int on
)
26103 /* Don't update cursor in windows whose frame is in the process
26104 of being deleted. */
26105 if (w
->current_matrix
)
26107 int hpos
= w
->phys_cursor
.hpos
;
26108 int vpos
= w
->phys_cursor
.vpos
;
26109 struct glyph_row
*row
;
26111 if (vpos
>= w
->current_matrix
->nrows
26112 || hpos
>= w
->current_matrix
->matrix_w
)
26115 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26117 /* When the window is hscrolled, cursor hpos can legitimately be
26118 out of bounds, but we draw the cursor at the corresponding
26119 window margin in that case. */
26120 if (!row
->reversed_p
&& hpos
< 0)
26122 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26123 hpos
= row
->used
[TEXT_AREA
] - 1;
26126 display_and_set_cursor (w
, on
, hpos
, vpos
,
26127 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26133 /* Call update_window_cursor with parameter ON_P on all leaf windows
26134 in the window tree rooted at W. */
26137 update_cursor_in_window_tree (struct window
*w
, int on_p
)
26141 if (!NILP (w
->hchild
))
26142 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
26143 else if (!NILP (w
->vchild
))
26144 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
26146 update_window_cursor (w
, on_p
);
26148 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
26154 Display the cursor on window W, or clear it, according to ON_P.
26155 Don't change the cursor's position. */
26158 x_update_cursor (struct frame
*f
, int on_p
)
26160 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
26165 Clear the cursor of window W to background color, and mark the
26166 cursor as not shown. This is used when the text where the cursor
26167 is about to be rewritten. */
26170 x_clear_cursor (struct window
*w
)
26172 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
26173 update_window_cursor (w
, 0);
26176 #endif /* HAVE_WINDOW_SYSTEM */
26178 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
26181 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
26182 int start_hpos
, int end_hpos
,
26183 enum draw_glyphs_face draw
)
26185 #ifdef HAVE_WINDOW_SYSTEM
26186 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
26188 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
26192 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
26193 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
26197 /* Display the active region described by mouse_face_* according to DRAW. */
26200 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
26202 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
26203 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26205 if (/* If window is in the process of being destroyed, don't bother
26207 w
->current_matrix
!= NULL
26208 /* Don't update mouse highlight if hidden */
26209 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
26210 /* Recognize when we are called to operate on rows that don't exist
26211 anymore. This can happen when a window is split. */
26212 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
26214 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
26215 struct glyph_row
*row
, *first
, *last
;
26217 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
26218 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
26220 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
26222 int start_hpos
, end_hpos
, start_x
;
26224 /* For all but the first row, the highlight starts at column 0. */
26227 /* R2L rows have BEG and END in reversed order, but the
26228 screen drawing geometry is always left to right. So
26229 we need to mirror the beginning and end of the
26230 highlighted area in R2L rows. */
26231 if (!row
->reversed_p
)
26233 start_hpos
= hlinfo
->mouse_face_beg_col
;
26234 start_x
= hlinfo
->mouse_face_beg_x
;
26236 else if (row
== last
)
26238 start_hpos
= hlinfo
->mouse_face_end_col
;
26239 start_x
= hlinfo
->mouse_face_end_x
;
26247 else if (row
->reversed_p
&& row
== last
)
26249 start_hpos
= hlinfo
->mouse_face_end_col
;
26250 start_x
= hlinfo
->mouse_face_end_x
;
26260 if (!row
->reversed_p
)
26261 end_hpos
= hlinfo
->mouse_face_end_col
;
26262 else if (row
== first
)
26263 end_hpos
= hlinfo
->mouse_face_beg_col
;
26266 end_hpos
= row
->used
[TEXT_AREA
];
26267 if (draw
== DRAW_NORMAL_TEXT
)
26268 row
->fill_line_p
= 1; /* Clear to end of line */
26271 else if (row
->reversed_p
&& row
== first
)
26272 end_hpos
= hlinfo
->mouse_face_beg_col
;
26275 end_hpos
= row
->used
[TEXT_AREA
];
26276 if (draw
== DRAW_NORMAL_TEXT
)
26277 row
->fill_line_p
= 1; /* Clear to end of line */
26280 if (end_hpos
> start_hpos
)
26282 draw_row_with_mouse_face (w
, start_x
, row
,
26283 start_hpos
, end_hpos
, draw
);
26286 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
26290 #ifdef HAVE_WINDOW_SYSTEM
26291 /* When we've written over the cursor, arrange for it to
26292 be displayed again. */
26293 if (FRAME_WINDOW_P (f
)
26294 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
26296 int hpos
= w
->phys_cursor
.hpos
;
26298 /* When the window is hscrolled, cursor hpos can legitimately be
26299 out of bounds, but we draw the cursor at the corresponding
26300 window margin in that case. */
26301 if (!row
->reversed_p
&& hpos
< 0)
26303 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26304 hpos
= row
->used
[TEXT_AREA
] - 1;
26307 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
26308 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
26311 #endif /* HAVE_WINDOW_SYSTEM */
26314 #ifdef HAVE_WINDOW_SYSTEM
26315 /* Change the mouse cursor. */
26316 if (FRAME_WINDOW_P (f
))
26318 if (draw
== DRAW_NORMAL_TEXT
26319 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
26320 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
26321 else if (draw
== DRAW_MOUSE_FACE
)
26322 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
26324 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
26326 #endif /* HAVE_WINDOW_SYSTEM */
26330 Clear out the mouse-highlighted active region.
26331 Redraw it un-highlighted first. Value is non-zero if mouse
26332 face was actually drawn unhighlighted. */
26335 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
26339 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
26341 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
26345 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
26346 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
26347 hlinfo
->mouse_face_window
= Qnil
;
26348 hlinfo
->mouse_face_overlay
= Qnil
;
26352 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
26353 within the mouse face on that window. */
26355 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
26357 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26359 /* Quickly resolve the easy cases. */
26360 if (!(WINDOWP (hlinfo
->mouse_face_window
)
26361 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
26363 if (vpos
< hlinfo
->mouse_face_beg_row
26364 || vpos
> hlinfo
->mouse_face_end_row
)
26366 if (vpos
> hlinfo
->mouse_face_beg_row
26367 && vpos
< hlinfo
->mouse_face_end_row
)
26370 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
26372 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26374 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
26377 else if ((vpos
== hlinfo
->mouse_face_beg_row
26378 && hpos
>= hlinfo
->mouse_face_beg_col
)
26379 || (vpos
== hlinfo
->mouse_face_end_row
26380 && hpos
< hlinfo
->mouse_face_end_col
))
26385 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
26387 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
26390 else if ((vpos
== hlinfo
->mouse_face_beg_row
26391 && hpos
<= hlinfo
->mouse_face_beg_col
)
26392 || (vpos
== hlinfo
->mouse_face_end_row
26393 && hpos
> hlinfo
->mouse_face_end_col
))
26401 Non-zero if physical cursor of window W is within mouse face. */
26404 cursor_in_mouse_face_p (struct window
*w
)
26406 int hpos
= w
->phys_cursor
.hpos
;
26407 int vpos
= w
->phys_cursor
.vpos
;
26408 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
26410 /* When the window is hscrolled, cursor hpos can legitimately be out
26411 of bounds, but we draw the cursor at the corresponding window
26412 margin in that case. */
26413 if (!row
->reversed_p
&& hpos
< 0)
26415 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26416 hpos
= row
->used
[TEXT_AREA
] - 1;
26418 return coords_in_mouse_face_p (w
, hpos
, vpos
);
26423 /* Find the glyph rows START_ROW and END_ROW of window W that display
26424 characters between buffer positions START_CHARPOS and END_CHARPOS
26425 (excluding END_CHARPOS). DISP_STRING is a display string that
26426 covers these buffer positions. This is similar to
26427 row_containing_pos, but is more accurate when bidi reordering makes
26428 buffer positions change non-linearly with glyph rows. */
26430 rows_from_pos_range (struct window
*w
,
26431 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
26432 Lisp_Object disp_string
,
26433 struct glyph_row
**start
, struct glyph_row
**end
)
26435 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26436 int last_y
= window_text_bottom_y (w
);
26437 struct glyph_row
*row
;
26442 while (!first
->enabled_p
26443 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
26446 /* Find the START row. */
26448 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
26451 /* A row can potentially be the START row if the range of the
26452 characters it displays intersects the range
26453 [START_CHARPOS..END_CHARPOS). */
26454 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
26455 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
26456 /* See the commentary in row_containing_pos, for the
26457 explanation of the complicated way to check whether
26458 some position is beyond the end of the characters
26459 displayed by a row. */
26460 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26461 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26462 && !row
->ends_at_zv_p
26463 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
26464 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
26465 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
26466 && !row
->ends_at_zv_p
26467 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
26469 /* Found a candidate row. Now make sure at least one of the
26470 glyphs it displays has a charpos from the range
26471 [START_CHARPOS..END_CHARPOS).
26473 This is not obvious because bidi reordering could make
26474 buffer positions of a row be 1,2,3,102,101,100, and if we
26475 want to highlight characters in [50..60), we don't want
26476 this row, even though [50..60) does intersect [1..103),
26477 the range of character positions given by the row's start
26478 and end positions. */
26479 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
26480 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
26484 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26485 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26486 /* A glyph that comes from DISP_STRING is by
26487 definition to be highlighted. */
26488 || EQ (g
->object
, disp_string
))
26497 /* Find the END row. */
26499 /* If the last row is partially visible, start looking for END
26500 from that row, instead of starting from FIRST. */
26501 && !(row
->enabled_p
26502 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
26504 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
26506 struct glyph_row
*next
= row
+ 1;
26507 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
26509 if (!next
->enabled_p
26510 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
26511 /* The first row >= START whose range of displayed characters
26512 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
26513 is the row END + 1. */
26514 || (start_charpos
< next_start
26515 && end_charpos
< next_start
)
26516 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26517 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26518 && !next
->ends_at_zv_p
26519 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
26520 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26521 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26522 && !next
->ends_at_zv_p
26523 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
26530 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
26531 but none of the characters it displays are in the range, it is
26533 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
26534 struct glyph
*s
= g
;
26535 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
26539 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26540 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26541 /* If the buffer position of the first glyph in
26542 the row is equal to END_CHARPOS, it means
26543 the last character to be highlighted is the
26544 newline of ROW, and we must consider NEXT as
26546 || (((!next
->reversed_p
&& g
== s
)
26547 || (next
->reversed_p
&& g
== e
- 1))
26548 && (g
->charpos
== end_charpos
26549 /* Special case for when NEXT is an
26550 empty line at ZV. */
26551 || (g
->charpos
== -1
26552 && !row
->ends_at_zv_p
26553 && next_start
== end_charpos
)))))
26554 /* A glyph that comes from DISP_STRING is by
26555 definition to be highlighted. */
26556 || EQ (g
->object
, disp_string
))
26565 /* The first row that ends at ZV must be the last to be
26567 else if (next
->ends_at_zv_p
)
26576 /* This function sets the mouse_face_* elements of HLINFO, assuming
26577 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
26578 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
26579 for the overlay or run of text properties specifying the mouse
26580 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
26581 before-string and after-string that must also be highlighted.
26582 DISP_STRING, if non-nil, is a display string that may cover some
26583 or all of the highlighted text. */
26586 mouse_face_from_buffer_pos (Lisp_Object window
,
26587 Mouse_HLInfo
*hlinfo
,
26588 ptrdiff_t mouse_charpos
,
26589 ptrdiff_t start_charpos
,
26590 ptrdiff_t end_charpos
,
26591 Lisp_Object before_string
,
26592 Lisp_Object after_string
,
26593 Lisp_Object disp_string
)
26595 struct window
*w
= XWINDOW (window
);
26596 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26597 struct glyph_row
*r1
, *r2
;
26598 struct glyph
*glyph
, *end
;
26599 ptrdiff_t ignore
, pos
;
26602 eassert (NILP (disp_string
) || STRINGP (disp_string
));
26603 eassert (NILP (before_string
) || STRINGP (before_string
));
26604 eassert (NILP (after_string
) || STRINGP (after_string
));
26606 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
26607 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
26609 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26610 /* If the before-string or display-string contains newlines,
26611 rows_from_pos_range skips to its last row. Move back. */
26612 if (!NILP (before_string
) || !NILP (disp_string
))
26614 struct glyph_row
*prev
;
26615 while ((prev
= r1
- 1, prev
>= first
)
26616 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
26617 && prev
->used
[TEXT_AREA
] > 0)
26619 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
26620 glyph
= beg
+ prev
->used
[TEXT_AREA
];
26621 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
26623 || !(EQ (glyph
->object
, before_string
)
26624 || EQ (glyph
->object
, disp_string
)))
26631 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26632 hlinfo
->mouse_face_past_end
= 1;
26634 else if (!NILP (after_string
))
26636 /* If the after-string has newlines, advance to its last row. */
26637 struct glyph_row
*next
;
26638 struct glyph_row
*last
26639 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26641 for (next
= r2
+ 1;
26643 && next
->used
[TEXT_AREA
] > 0
26644 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
26648 /* The rest of the display engine assumes that mouse_face_beg_row is
26649 either above mouse_face_end_row or identical to it. But with
26650 bidi-reordered continued lines, the row for START_CHARPOS could
26651 be below the row for END_CHARPOS. If so, swap the rows and store
26652 them in correct order. */
26655 struct glyph_row
*tem
= r2
;
26661 hlinfo
->mouse_face_beg_y
= r1
->y
;
26662 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
26663 hlinfo
->mouse_face_end_y
= r2
->y
;
26664 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
26666 /* For a bidi-reordered row, the positions of BEFORE_STRING,
26667 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
26668 could be anywhere in the row and in any order. The strategy
26669 below is to find the leftmost and the rightmost glyph that
26670 belongs to either of these 3 strings, or whose position is
26671 between START_CHARPOS and END_CHARPOS, and highlight all the
26672 glyphs between those two. This may cover more than just the text
26673 between START_CHARPOS and END_CHARPOS if the range of characters
26674 strides the bidi level boundary, e.g. if the beginning is in R2L
26675 text while the end is in L2R text or vice versa. */
26676 if (!r1
->reversed_p
)
26678 /* This row is in a left to right paragraph. Scan it left to
26680 glyph
= r1
->glyphs
[TEXT_AREA
];
26681 end
= glyph
+ r1
->used
[TEXT_AREA
];
26684 /* Skip truncation glyphs at the start of the glyph row. */
26685 if (r1
->displays_text_p
)
26687 && INTEGERP (glyph
->object
)
26688 && glyph
->charpos
< 0;
26690 x
+= glyph
->pixel_width
;
26692 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26693 or DISP_STRING, and the first glyph from buffer whose
26694 position is between START_CHARPOS and END_CHARPOS. */
26696 && !INTEGERP (glyph
->object
)
26697 && !EQ (glyph
->object
, disp_string
)
26698 && !(BUFFERP (glyph
->object
)
26699 && (glyph
->charpos
>= start_charpos
26700 && glyph
->charpos
< end_charpos
));
26703 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26704 are present at buffer positions between START_CHARPOS and
26705 END_CHARPOS, or if they come from an overlay. */
26706 if (EQ (glyph
->object
, before_string
))
26708 pos
= string_buffer_position (before_string
,
26710 /* If pos == 0, it means before_string came from an
26711 overlay, not from a buffer position. */
26712 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26715 else if (EQ (glyph
->object
, after_string
))
26717 pos
= string_buffer_position (after_string
, end_charpos
);
26718 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26721 x
+= glyph
->pixel_width
;
26723 hlinfo
->mouse_face_beg_x
= x
;
26724 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26728 /* This row is in a right to left paragraph. Scan it right to
26732 end
= r1
->glyphs
[TEXT_AREA
] - 1;
26733 glyph
= end
+ r1
->used
[TEXT_AREA
];
26735 /* Skip truncation glyphs at the start of the glyph row. */
26736 if (r1
->displays_text_p
)
26738 && INTEGERP (glyph
->object
)
26739 && glyph
->charpos
< 0;
26743 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26744 or DISP_STRING, and the first glyph from buffer whose
26745 position is between START_CHARPOS and END_CHARPOS. */
26747 && !INTEGERP (glyph
->object
)
26748 && !EQ (glyph
->object
, disp_string
)
26749 && !(BUFFERP (glyph
->object
)
26750 && (glyph
->charpos
>= start_charpos
26751 && glyph
->charpos
< end_charpos
));
26754 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26755 are present at buffer positions between START_CHARPOS and
26756 END_CHARPOS, or if they come from an overlay. */
26757 if (EQ (glyph
->object
, before_string
))
26759 pos
= string_buffer_position (before_string
, start_charpos
);
26760 /* If pos == 0, it means before_string came from an
26761 overlay, not from a buffer position. */
26762 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26765 else if (EQ (glyph
->object
, after_string
))
26767 pos
= string_buffer_position (after_string
, end_charpos
);
26768 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26773 glyph
++; /* first glyph to the right of the highlighted area */
26774 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
26775 x
+= g
->pixel_width
;
26776 hlinfo
->mouse_face_beg_x
= x
;
26777 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26780 /* If the highlight ends in a different row, compute GLYPH and END
26781 for the end row. Otherwise, reuse the values computed above for
26782 the row where the highlight begins. */
26785 if (!r2
->reversed_p
)
26787 glyph
= r2
->glyphs
[TEXT_AREA
];
26788 end
= glyph
+ r2
->used
[TEXT_AREA
];
26793 end
= r2
->glyphs
[TEXT_AREA
] - 1;
26794 glyph
= end
+ r2
->used
[TEXT_AREA
];
26798 if (!r2
->reversed_p
)
26800 /* Skip truncation and continuation glyphs near the end of the
26801 row, and also blanks and stretch glyphs inserted by
26802 extend_face_to_end_of_line. */
26804 && INTEGERP ((end
- 1)->object
))
26806 /* Scan the rest of the glyph row from the end, looking for the
26807 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26808 DISP_STRING, or whose position is between START_CHARPOS
26812 && !INTEGERP (end
->object
)
26813 && !EQ (end
->object
, disp_string
)
26814 && !(BUFFERP (end
->object
)
26815 && (end
->charpos
>= start_charpos
26816 && end
->charpos
< end_charpos
));
26819 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26820 are present at buffer positions between START_CHARPOS and
26821 END_CHARPOS, or if they come from an overlay. */
26822 if (EQ (end
->object
, before_string
))
26824 pos
= string_buffer_position (before_string
, start_charpos
);
26825 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26828 else if (EQ (end
->object
, after_string
))
26830 pos
= string_buffer_position (after_string
, end_charpos
);
26831 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26835 /* Find the X coordinate of the last glyph to be highlighted. */
26836 for (; glyph
<= end
; ++glyph
)
26837 x
+= glyph
->pixel_width
;
26839 hlinfo
->mouse_face_end_x
= x
;
26840 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
26844 /* Skip truncation and continuation glyphs near the end of the
26845 row, and also blanks and stretch glyphs inserted by
26846 extend_face_to_end_of_line. */
26850 && INTEGERP (end
->object
))
26852 x
+= end
->pixel_width
;
26855 /* Scan the rest of the glyph row from the end, looking for the
26856 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26857 DISP_STRING, or whose position is between START_CHARPOS
26861 && !INTEGERP (end
->object
)
26862 && !EQ (end
->object
, disp_string
)
26863 && !(BUFFERP (end
->object
)
26864 && (end
->charpos
>= start_charpos
26865 && end
->charpos
< end_charpos
));
26868 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26869 are present at buffer positions between START_CHARPOS and
26870 END_CHARPOS, or if they come from an overlay. */
26871 if (EQ (end
->object
, before_string
))
26873 pos
= string_buffer_position (before_string
, start_charpos
);
26874 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26877 else if (EQ (end
->object
, after_string
))
26879 pos
= string_buffer_position (after_string
, end_charpos
);
26880 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26883 x
+= end
->pixel_width
;
26885 /* If we exited the above loop because we arrived at the last
26886 glyph of the row, and its buffer position is still not in
26887 range, it means the last character in range is the preceding
26888 newline. Bump the end column and x values to get past the
26891 && BUFFERP (end
->object
)
26892 && (end
->charpos
< start_charpos
26893 || end
->charpos
>= end_charpos
))
26895 x
+= end
->pixel_width
;
26898 hlinfo
->mouse_face_end_x
= x
;
26899 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
26902 hlinfo
->mouse_face_window
= window
;
26903 hlinfo
->mouse_face_face_id
26904 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
26906 !hlinfo
->mouse_face_hidden
, -1);
26907 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26910 /* The following function is not used anymore (replaced with
26911 mouse_face_from_string_pos), but I leave it here for the time
26912 being, in case someone would. */
26914 #if 0 /* not used */
26916 /* Find the position of the glyph for position POS in OBJECT in
26917 window W's current matrix, and return in *X, *Y the pixel
26918 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
26920 RIGHT_P non-zero means return the position of the right edge of the
26921 glyph, RIGHT_P zero means return the left edge position.
26923 If no glyph for POS exists in the matrix, return the position of
26924 the glyph with the next smaller position that is in the matrix, if
26925 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
26926 exists in the matrix, return the position of the glyph with the
26927 next larger position in OBJECT.
26929 Value is non-zero if a glyph was found. */
26932 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
26933 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
26935 int yb
= window_text_bottom_y (w
);
26936 struct glyph_row
*r
;
26937 struct glyph
*best_glyph
= NULL
;
26938 struct glyph_row
*best_row
= NULL
;
26941 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26942 r
->enabled_p
&& r
->y
< yb
;
26945 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
26946 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
26949 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26950 if (EQ (g
->object
, object
))
26952 if (g
->charpos
== pos
)
26959 else if (best_glyph
== NULL
26960 || ((eabs (g
->charpos
- pos
)
26961 < eabs (best_glyph
->charpos
- pos
))
26964 : g
->charpos
> pos
)))
26978 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
26982 *x
+= best_glyph
->pixel_width
;
26987 *vpos
= best_row
- w
->current_matrix
->rows
;
26990 return best_glyph
!= NULL
;
26992 #endif /* not used */
26994 /* Find the positions of the first and the last glyphs in window W's
26995 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
26996 (assumed to be a string), and return in HLINFO's mouse_face_*
26997 members the pixel and column/row coordinates of those glyphs. */
27000 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
27001 Lisp_Object object
,
27002 ptrdiff_t startpos
, ptrdiff_t endpos
)
27004 int yb
= window_text_bottom_y (w
);
27005 struct glyph_row
*r
;
27006 struct glyph
*g
, *e
;
27010 /* Find the glyph row with at least one position in the range
27011 [STARTPOS..ENDPOS], and the first glyph in that row whose
27012 position belongs to that range. */
27013 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27014 r
->enabled_p
&& r
->y
< yb
;
27017 if (!r
->reversed_p
)
27019 g
= r
->glyphs
[TEXT_AREA
];
27020 e
= g
+ r
->used
[TEXT_AREA
];
27021 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
27022 if (EQ (g
->object
, object
)
27023 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
27025 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
27026 hlinfo
->mouse_face_beg_y
= r
->y
;
27027 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
27028 hlinfo
->mouse_face_beg_x
= gx
;
27037 e
= r
->glyphs
[TEXT_AREA
];
27038 g
= e
+ r
->used
[TEXT_AREA
];
27039 for ( ; g
> e
; --g
)
27040 if (EQ ((g
-1)->object
, object
)
27041 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
27043 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
27044 hlinfo
->mouse_face_beg_y
= r
->y
;
27045 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
27046 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
27047 gx
+= g1
->pixel_width
;
27048 hlinfo
->mouse_face_beg_x
= gx
;
27060 /* Starting with the next row, look for the first row which does NOT
27061 include any glyphs whose positions are in the range. */
27062 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
27064 g
= r
->glyphs
[TEXT_AREA
];
27065 e
= g
+ r
->used
[TEXT_AREA
];
27067 for ( ; g
< e
; ++g
)
27068 if (EQ (g
->object
, object
)
27069 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
27078 /* The highlighted region ends on the previous row. */
27081 /* Set the end row and its vertical pixel coordinate. */
27082 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
27083 hlinfo
->mouse_face_end_y
= r
->y
;
27085 /* Compute and set the end column and the end column's horizontal
27086 pixel coordinate. */
27087 if (!r
->reversed_p
)
27089 g
= r
->glyphs
[TEXT_AREA
];
27090 e
= g
+ r
->used
[TEXT_AREA
];
27091 for ( ; e
> g
; --e
)
27092 if (EQ ((e
-1)->object
, object
)
27093 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
27095 hlinfo
->mouse_face_end_col
= e
- g
;
27097 for (gx
= r
->x
; g
< e
; ++g
)
27098 gx
+= g
->pixel_width
;
27099 hlinfo
->mouse_face_end_x
= gx
;
27103 e
= r
->glyphs
[TEXT_AREA
];
27104 g
= e
+ r
->used
[TEXT_AREA
];
27105 for (gx
= r
->x
; e
< g
; ++e
)
27107 if (EQ (e
->object
, object
)
27108 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
27110 gx
+= e
->pixel_width
;
27112 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
27113 hlinfo
->mouse_face_end_x
= gx
;
27117 #ifdef HAVE_WINDOW_SYSTEM
27119 /* See if position X, Y is within a hot-spot of an image. */
27122 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
27124 if (!CONSP (hot_spot
))
27127 if (EQ (XCAR (hot_spot
), Qrect
))
27129 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
27130 Lisp_Object rect
= XCDR (hot_spot
);
27134 if (!CONSP (XCAR (rect
)))
27136 if (!CONSP (XCDR (rect
)))
27138 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
27140 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
27142 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
27144 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
27148 else if (EQ (XCAR (hot_spot
), Qcircle
))
27150 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
27151 Lisp_Object circ
= XCDR (hot_spot
);
27152 Lisp_Object lr
, lx0
, ly0
;
27154 && CONSP (XCAR (circ
))
27155 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
27156 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
27157 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
27159 double r
= XFLOATINT (lr
);
27160 double dx
= XINT (lx0
) - x
;
27161 double dy
= XINT (ly0
) - y
;
27162 return (dx
* dx
+ dy
* dy
<= r
* r
);
27165 else if (EQ (XCAR (hot_spot
), Qpoly
))
27167 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
27168 if (VECTORP (XCDR (hot_spot
)))
27170 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
27171 Lisp_Object
*poly
= v
->contents
;
27172 ptrdiff_t n
= v
->header
.size
;
27175 Lisp_Object lx
, ly
;
27178 /* Need an even number of coordinates, and at least 3 edges. */
27179 if (n
< 6 || n
& 1)
27182 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
27183 If count is odd, we are inside polygon. Pixels on edges
27184 may or may not be included depending on actual geometry of the
27186 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
27187 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
27189 x0
= XINT (lx
), y0
= XINT (ly
);
27190 for (i
= 0; i
< n
; i
+= 2)
27192 int x1
= x0
, y1
= y0
;
27193 if ((lx
= poly
[i
], !INTEGERP (lx
))
27194 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
27196 x0
= XINT (lx
), y0
= XINT (ly
);
27198 /* Does this segment cross the X line? */
27206 if (y
> y0
&& y
> y1
)
27208 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
27218 find_hot_spot (Lisp_Object map
, int x
, int y
)
27220 while (CONSP (map
))
27222 if (CONSP (XCAR (map
))
27223 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
27231 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
27233 doc
: /* Lookup in image map MAP coordinates X and Y.
27234 An image map is an alist where each element has the format (AREA ID PLIST).
27235 An AREA is specified as either a rectangle, a circle, or a polygon:
27236 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
27237 pixel coordinates of the upper left and bottom right corners.
27238 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
27239 and the radius of the circle; r may be a float or integer.
27240 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
27241 vector describes one corner in the polygon.
27242 Returns the alist element for the first matching AREA in MAP. */)
27243 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
27251 return find_hot_spot (map
,
27252 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
27253 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
27257 /* Display frame CURSOR, optionally using shape defined by POINTER. */
27259 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
27261 /* Do not change cursor shape while dragging mouse. */
27262 if (!NILP (do_mouse_tracking
))
27265 if (!NILP (pointer
))
27267 if (EQ (pointer
, Qarrow
))
27268 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27269 else if (EQ (pointer
, Qhand
))
27270 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
27271 else if (EQ (pointer
, Qtext
))
27272 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27273 else if (EQ (pointer
, intern ("hdrag")))
27274 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27275 #ifdef HAVE_X_WINDOWS
27276 else if (EQ (pointer
, intern ("vdrag")))
27277 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27279 else if (EQ (pointer
, intern ("hourglass")))
27280 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
27281 else if (EQ (pointer
, Qmodeline
))
27282 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
27284 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27287 if (cursor
!= No_Cursor
)
27288 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
27291 #endif /* HAVE_WINDOW_SYSTEM */
27293 /* Take proper action when mouse has moved to the mode or header line
27294 or marginal area AREA of window W, x-position X and y-position Y.
27295 X is relative to the start of the text display area of W, so the
27296 width of bitmap areas and scroll bars must be subtracted to get a
27297 position relative to the start of the mode line. */
27300 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
27301 enum window_part area
)
27303 struct window
*w
= XWINDOW (window
);
27304 struct frame
*f
= XFRAME (w
->frame
);
27305 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27306 #ifdef HAVE_WINDOW_SYSTEM
27307 Display_Info
*dpyinfo
;
27309 Cursor cursor
= No_Cursor
;
27310 Lisp_Object pointer
= Qnil
;
27311 int dx
, dy
, width
, height
;
27313 Lisp_Object string
, object
= Qnil
;
27314 Lisp_Object pos
IF_LINT (= Qnil
), help
;
27316 Lisp_Object mouse_face
;
27317 int original_x_pixel
= x
;
27318 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
27319 struct glyph_row
*row
IF_LINT (= 0);
27321 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
27326 /* Kludge alert: mode_line_string takes X/Y in pixels, but
27327 returns them in row/column units! */
27328 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
27329 &object
, &dx
, &dy
, &width
, &height
);
27331 row
= (area
== ON_MODE_LINE
27332 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
27333 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
27335 /* Find the glyph under the mouse pointer. */
27336 if (row
->mode_line_p
&& row
->enabled_p
)
27338 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
27339 end
= glyph
+ row
->used
[TEXT_AREA
];
27341 for (x0
= original_x_pixel
;
27342 glyph
< end
&& x0
>= glyph
->pixel_width
;
27344 x0
-= glyph
->pixel_width
;
27352 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
27353 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
27354 returns them in row/column units! */
27355 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
27356 &object
, &dx
, &dy
, &width
, &height
);
27361 #ifdef HAVE_WINDOW_SYSTEM
27362 if (IMAGEP (object
))
27364 Lisp_Object image_map
, hotspot
;
27365 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
27367 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
27369 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27373 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
27374 If so, we could look for mouse-enter, mouse-leave
27375 properties in PLIST (and do something...). */
27376 hotspot
= XCDR (hotspot
);
27377 if (CONSP (hotspot
)
27378 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27380 pointer
= Fplist_get (plist
, Qpointer
);
27381 if (NILP (pointer
))
27383 help
= Fplist_get (plist
, Qhelp_echo
);
27386 help_echo_string
= help
;
27387 XSETWINDOW (help_echo_window
, w
);
27388 help_echo_object
= w
->buffer
;
27389 help_echo_pos
= charpos
;
27393 if (NILP (pointer
))
27394 pointer
= Fplist_get (XCDR (object
), QCpointer
);
27396 #endif /* HAVE_WINDOW_SYSTEM */
27398 if (STRINGP (string
))
27399 pos
= make_number (charpos
);
27401 /* Set the help text and mouse pointer. If the mouse is on a part
27402 of the mode line without any text (e.g. past the right edge of
27403 the mode line text), use the default help text and pointer. */
27404 if (STRINGP (string
) || area
== ON_MODE_LINE
)
27406 /* Arrange to display the help by setting the global variables
27407 help_echo_string, help_echo_object, and help_echo_pos. */
27410 if (STRINGP (string
))
27411 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
27415 help_echo_string
= help
;
27416 XSETWINDOW (help_echo_window
, w
);
27417 help_echo_object
= string
;
27418 help_echo_pos
= charpos
;
27420 else if (area
== ON_MODE_LINE
)
27422 Lisp_Object default_help
27423 = buffer_local_value_1 (Qmode_line_default_help_echo
,
27426 if (STRINGP (default_help
))
27428 help_echo_string
= default_help
;
27429 XSETWINDOW (help_echo_window
, w
);
27430 help_echo_object
= Qnil
;
27431 help_echo_pos
= -1;
27436 #ifdef HAVE_WINDOW_SYSTEM
27437 /* Change the mouse pointer according to what is under it. */
27438 if (FRAME_WINDOW_P (f
))
27440 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
27441 if (STRINGP (string
))
27443 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27445 if (NILP (pointer
))
27446 pointer
= Fget_text_property (pos
, Qpointer
, string
);
27448 /* Change the mouse pointer according to what is under X/Y. */
27450 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
27453 map
= Fget_text_property (pos
, Qlocal_map
, string
);
27454 if (!KEYMAPP (map
))
27455 map
= Fget_text_property (pos
, Qkeymap
, string
);
27456 if (!KEYMAPP (map
))
27457 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
27461 /* Default mode-line pointer. */
27462 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
27467 /* Change the mouse face according to what is under X/Y. */
27468 if (STRINGP (string
))
27470 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
27471 if (!NILP (mouse_face
)
27472 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27477 struct glyph
* tmp_glyph
;
27481 int total_pixel_width
;
27482 ptrdiff_t begpos
, endpos
, ignore
;
27486 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
27487 Qmouse_face
, string
, Qnil
);
27493 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
27495 endpos
= SCHARS (string
);
27499 /* Calculate the glyph position GPOS of GLYPH in the
27500 displayed string, relative to the beginning of the
27501 highlighted part of the string.
27503 Note: GPOS is different from CHARPOS. CHARPOS is the
27504 position of GLYPH in the internal string object. A mode
27505 line string format has structures which are converted to
27506 a flattened string by the Emacs Lisp interpreter. The
27507 internal string is an element of those structures. The
27508 displayed string is the flattened string. */
27509 tmp_glyph
= row_start_glyph
;
27510 while (tmp_glyph
< glyph
27511 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27512 && begpos
<= tmp_glyph
->charpos
27513 && tmp_glyph
->charpos
< endpos
)))
27515 gpos
= glyph
- tmp_glyph
;
27517 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
27518 the highlighted part of the displayed string to which
27519 GLYPH belongs. Note: GSEQ_LENGTH is different from
27520 SCHARS (STRING), because the latter returns the length of
27521 the internal string. */
27522 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
27524 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27525 && begpos
<= tmp_glyph
->charpos
27526 && tmp_glyph
->charpos
< endpos
));
27529 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
27531 /* Calculate the total pixel width of all the glyphs between
27532 the beginning of the highlighted area and GLYPH. */
27533 total_pixel_width
= 0;
27534 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
27535 total_pixel_width
+= tmp_glyph
->pixel_width
;
27537 /* Pre calculation of re-rendering position. Note: X is in
27538 column units here, after the call to mode_line_string or
27539 marginal_area_string. */
27541 vpos
= (area
== ON_MODE_LINE
27542 ? (w
->current_matrix
)->nrows
- 1
27545 /* If GLYPH's position is included in the region that is
27546 already drawn in mouse face, we have nothing to do. */
27547 if ( EQ (window
, hlinfo
->mouse_face_window
)
27548 && (!row
->reversed_p
27549 ? (hlinfo
->mouse_face_beg_col
<= hpos
27550 && hpos
< hlinfo
->mouse_face_end_col
)
27551 /* In R2L rows we swap BEG and END, see below. */
27552 : (hlinfo
->mouse_face_end_col
<= hpos
27553 && hpos
< hlinfo
->mouse_face_beg_col
))
27554 && hlinfo
->mouse_face_beg_row
== vpos
)
27557 if (clear_mouse_face (hlinfo
))
27558 cursor
= No_Cursor
;
27560 if (!row
->reversed_p
)
27562 hlinfo
->mouse_face_beg_col
= hpos
;
27563 hlinfo
->mouse_face_beg_x
= original_x_pixel
27564 - (total_pixel_width
+ dx
);
27565 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
27566 hlinfo
->mouse_face_end_x
= 0;
27570 /* In R2L rows, show_mouse_face expects BEG and END
27571 coordinates to be swapped. */
27572 hlinfo
->mouse_face_end_col
= hpos
;
27573 hlinfo
->mouse_face_end_x
= original_x_pixel
27574 - (total_pixel_width
+ dx
);
27575 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
27576 hlinfo
->mouse_face_beg_x
= 0;
27579 hlinfo
->mouse_face_beg_row
= vpos
;
27580 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
27581 hlinfo
->mouse_face_beg_y
= 0;
27582 hlinfo
->mouse_face_end_y
= 0;
27583 hlinfo
->mouse_face_past_end
= 0;
27584 hlinfo
->mouse_face_window
= window
;
27586 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
27592 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27594 if (NILP (pointer
))
27597 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27598 clear_mouse_face (hlinfo
);
27600 #ifdef HAVE_WINDOW_SYSTEM
27601 if (FRAME_WINDOW_P (f
))
27602 define_frame_cursor1 (f
, cursor
, pointer
);
27608 Take proper action when the mouse has moved to position X, Y on
27609 frame F as regards highlighting characters that have mouse-face
27610 properties. Also de-highlighting chars where the mouse was before.
27611 X and Y can be negative or out of range. */
27614 note_mouse_highlight (struct frame
*f
, int x
, int y
)
27616 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27617 enum window_part part
= ON_NOTHING
;
27618 Lisp_Object window
;
27620 Cursor cursor
= No_Cursor
;
27621 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
27624 /* When a menu is active, don't highlight because this looks odd. */
27625 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
27626 if (popup_activated ())
27630 if (NILP (Vmouse_highlight
)
27631 || !f
->glyphs_initialized_p
27632 || f
->pointer_invisible
)
27635 hlinfo
->mouse_face_mouse_x
= x
;
27636 hlinfo
->mouse_face_mouse_y
= y
;
27637 hlinfo
->mouse_face_mouse_frame
= f
;
27639 if (hlinfo
->mouse_face_defer
)
27642 if (gc_in_progress
)
27644 hlinfo
->mouse_face_deferred_gc
= 1;
27648 /* Which window is that in? */
27649 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
27651 /* If displaying active text in another window, clear that. */
27652 if (! EQ (window
, hlinfo
->mouse_face_window
)
27653 /* Also clear if we move out of text area in same window. */
27654 || (!NILP (hlinfo
->mouse_face_window
)
27657 && part
!= ON_MODE_LINE
27658 && part
!= ON_HEADER_LINE
))
27659 clear_mouse_face (hlinfo
);
27661 /* Not on a window -> return. */
27662 if (!WINDOWP (window
))
27665 /* Reset help_echo_string. It will get recomputed below. */
27666 help_echo_string
= Qnil
;
27668 /* Convert to window-relative pixel coordinates. */
27669 w
= XWINDOW (window
);
27670 frame_to_window_pixel_xy (w
, &x
, &y
);
27672 #ifdef HAVE_WINDOW_SYSTEM
27673 /* Handle tool-bar window differently since it doesn't display a
27675 if (EQ (window
, f
->tool_bar_window
))
27677 note_tool_bar_highlight (f
, x
, y
);
27682 /* Mouse is on the mode, header line or margin? */
27683 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
27684 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
27686 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
27690 #ifdef HAVE_WINDOW_SYSTEM
27691 if (part
== ON_VERTICAL_BORDER
)
27693 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27694 help_echo_string
= build_string ("drag-mouse-1: resize");
27696 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
27697 || part
== ON_SCROLL_BAR
)
27698 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27700 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27703 /* Are we in a window whose display is up to date?
27704 And verify the buffer's text has not changed. */
27705 b
= XBUFFER (w
->buffer
);
27706 if (part
== ON_TEXT
27707 && EQ (w
->window_end_valid
, w
->buffer
)
27708 && w
->last_modified
== BUF_MODIFF (b
)
27709 && w
->last_overlay_modified
== BUF_OVERLAY_MODIFF (b
))
27711 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
27713 struct glyph
*glyph
;
27714 Lisp_Object object
;
27715 Lisp_Object mouse_face
= Qnil
, position
;
27716 Lisp_Object
*overlay_vec
= NULL
;
27717 ptrdiff_t i
, noverlays
;
27718 struct buffer
*obuf
;
27719 ptrdiff_t obegv
, ozv
;
27722 /* Find the glyph under X/Y. */
27723 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
27725 #ifdef HAVE_WINDOW_SYSTEM
27726 /* Look for :pointer property on image. */
27727 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27729 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27730 if (img
!= NULL
&& IMAGEP (img
->spec
))
27732 Lisp_Object image_map
, hotspot
;
27733 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
27735 && (hotspot
= find_hot_spot (image_map
,
27736 glyph
->slice
.img
.x
+ dx
,
27737 glyph
->slice
.img
.y
+ dy
),
27739 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27743 /* Could check XCAR (hotspot) to see if we enter/leave
27745 If so, we could look for mouse-enter, mouse-leave
27746 properties in PLIST (and do something...). */
27747 hotspot
= XCDR (hotspot
);
27748 if (CONSP (hotspot
)
27749 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27751 pointer
= Fplist_get (plist
, Qpointer
);
27752 if (NILP (pointer
))
27754 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
27755 if (!NILP (help_echo_string
))
27757 help_echo_window
= window
;
27758 help_echo_object
= glyph
->object
;
27759 help_echo_pos
= glyph
->charpos
;
27763 if (NILP (pointer
))
27764 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
27767 #endif /* HAVE_WINDOW_SYSTEM */
27769 /* Clear mouse face if X/Y not over text. */
27771 || area
!= TEXT_AREA
27772 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
27773 /* Glyph's OBJECT is an integer for glyphs inserted by the
27774 display engine for its internal purposes, like truncation
27775 and continuation glyphs and blanks beyond the end of
27776 line's text on text terminals. If we are over such a
27777 glyph, we are not over any text. */
27778 || INTEGERP (glyph
->object
)
27779 /* R2L rows have a stretch glyph at their front, which
27780 stands for no text, whereas L2R rows have no glyphs at
27781 all beyond the end of text. Treat such stretch glyphs
27782 like we do with NULL glyphs in L2R rows. */
27783 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
27784 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
27785 && glyph
->type
== STRETCH_GLYPH
27786 && glyph
->avoid_cursor_p
))
27788 if (clear_mouse_face (hlinfo
))
27789 cursor
= No_Cursor
;
27790 #ifdef HAVE_WINDOW_SYSTEM
27791 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27793 if (area
!= TEXT_AREA
)
27794 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27796 pointer
= Vvoid_text_area_pointer
;
27802 pos
= glyph
->charpos
;
27803 object
= glyph
->object
;
27804 if (!STRINGP (object
) && !BUFFERP (object
))
27807 /* If we get an out-of-range value, return now; avoid an error. */
27808 if (BUFFERP (object
) && pos
> BUF_Z (b
))
27811 /* Make the window's buffer temporarily current for
27812 overlays_at and compute_char_face. */
27813 obuf
= current_buffer
;
27814 current_buffer
= b
;
27820 /* Is this char mouse-active or does it have help-echo? */
27821 position
= make_number (pos
);
27823 if (BUFFERP (object
))
27825 /* Put all the overlays we want in a vector in overlay_vec. */
27826 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
27827 /* Sort overlays into increasing priority order. */
27828 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
27833 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
27836 cursor
= No_Cursor
;
27838 /* Check mouse-face highlighting. */
27840 /* If there exists an overlay with mouse-face overlapping
27841 the one we are currently highlighting, we have to
27842 check if we enter the overlapping overlay, and then
27843 highlight only that. */
27844 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
27845 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
27847 /* Find the highest priority overlay with a mouse-face. */
27848 Lisp_Object overlay
= Qnil
;
27849 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
27851 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
27852 if (!NILP (mouse_face
))
27853 overlay
= overlay_vec
[i
];
27856 /* If we're highlighting the same overlay as before, there's
27857 no need to do that again. */
27858 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
27859 goto check_help_echo
;
27860 hlinfo
->mouse_face_overlay
= overlay
;
27862 /* Clear the display of the old active region, if any. */
27863 if (clear_mouse_face (hlinfo
))
27864 cursor
= No_Cursor
;
27866 /* If no overlay applies, get a text property. */
27867 if (NILP (overlay
))
27868 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
27870 /* Next, compute the bounds of the mouse highlighting and
27872 if (!NILP (mouse_face
) && STRINGP (object
))
27874 /* The mouse-highlighting comes from a display string
27875 with a mouse-face. */
27879 s
= Fprevious_single_property_change
27880 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
27881 e
= Fnext_single_property_change
27882 (position
, Qmouse_face
, object
, Qnil
);
27884 s
= make_number (0);
27886 e
= make_number (SCHARS (object
) - 1);
27887 mouse_face_from_string_pos (w
, hlinfo
, object
,
27888 XINT (s
), XINT (e
));
27889 hlinfo
->mouse_face_past_end
= 0;
27890 hlinfo
->mouse_face_window
= window
;
27891 hlinfo
->mouse_face_face_id
27892 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
27893 glyph
->face_id
, 1);
27894 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27895 cursor
= No_Cursor
;
27899 /* The mouse-highlighting, if any, comes from an overlay
27900 or text property in the buffer. */
27901 Lisp_Object buffer
IF_LINT (= Qnil
);
27902 Lisp_Object disp_string
IF_LINT (= Qnil
);
27904 if (STRINGP (object
))
27906 /* If we are on a display string with no mouse-face,
27907 check if the text under it has one. */
27908 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
27909 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
27910 pos
= string_buffer_position (object
, start
);
27913 mouse_face
= get_char_property_and_overlay
27914 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
27915 buffer
= w
->buffer
;
27916 disp_string
= object
;
27922 disp_string
= Qnil
;
27925 if (!NILP (mouse_face
))
27927 Lisp_Object before
, after
;
27928 Lisp_Object before_string
, after_string
;
27929 /* To correctly find the limits of mouse highlight
27930 in a bidi-reordered buffer, we must not use the
27931 optimization of limiting the search in
27932 previous-single-property-change and
27933 next-single-property-change, because
27934 rows_from_pos_range needs the real start and end
27935 positions to DTRT in this case. That's because
27936 the first row visible in a window does not
27937 necessarily display the character whose position
27938 is the smallest. */
27940 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27941 ? Fmarker_position (w
->start
)
27944 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27945 ? make_number (BUF_Z (XBUFFER (buffer
))
27946 - XFASTINT (w
->window_end_pos
))
27949 if (NILP (overlay
))
27951 /* Handle the text property case. */
27952 before
= Fprevious_single_property_change
27953 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
27954 after
= Fnext_single_property_change
27955 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
27956 before_string
= after_string
= Qnil
;
27960 /* Handle the overlay case. */
27961 before
= Foverlay_start (overlay
);
27962 after
= Foverlay_end (overlay
);
27963 before_string
= Foverlay_get (overlay
, Qbefore_string
);
27964 after_string
= Foverlay_get (overlay
, Qafter_string
);
27966 if (!STRINGP (before_string
)) before_string
= Qnil
;
27967 if (!STRINGP (after_string
)) after_string
= Qnil
;
27970 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
27973 : XFASTINT (before
),
27975 ? BUF_Z (XBUFFER (buffer
))
27976 : XFASTINT (after
),
27977 before_string
, after_string
,
27979 cursor
= No_Cursor
;
27986 /* Look for a `help-echo' property. */
27987 if (NILP (help_echo_string
)) {
27988 Lisp_Object help
, overlay
;
27990 /* Check overlays first. */
27991 help
= overlay
= Qnil
;
27992 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
27994 overlay
= overlay_vec
[i
];
27995 help
= Foverlay_get (overlay
, Qhelp_echo
);
28000 help_echo_string
= help
;
28001 help_echo_window
= window
;
28002 help_echo_object
= overlay
;
28003 help_echo_pos
= pos
;
28007 Lisp_Object obj
= glyph
->object
;
28008 ptrdiff_t charpos
= glyph
->charpos
;
28010 /* Try text properties. */
28013 && charpos
< SCHARS (obj
))
28015 help
= Fget_text_property (make_number (charpos
),
28019 /* If the string itself doesn't specify a help-echo,
28020 see if the buffer text ``under'' it does. */
28021 struct glyph_row
*r
28022 = MATRIX_ROW (w
->current_matrix
, vpos
);
28023 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
28024 ptrdiff_t p
= string_buffer_position (obj
, start
);
28027 help
= Fget_char_property (make_number (p
),
28028 Qhelp_echo
, w
->buffer
);
28037 else if (BUFFERP (obj
)
28040 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
28045 help_echo_string
= help
;
28046 help_echo_window
= window
;
28047 help_echo_object
= obj
;
28048 help_echo_pos
= charpos
;
28053 #ifdef HAVE_WINDOW_SYSTEM
28054 /* Look for a `pointer' property. */
28055 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
28057 /* Check overlays first. */
28058 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
28059 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
28061 if (NILP (pointer
))
28063 Lisp_Object obj
= glyph
->object
;
28064 ptrdiff_t charpos
= glyph
->charpos
;
28066 /* Try text properties. */
28069 && charpos
< SCHARS (obj
))
28071 pointer
= Fget_text_property (make_number (charpos
),
28073 if (NILP (pointer
))
28075 /* If the string itself doesn't specify a pointer,
28076 see if the buffer text ``under'' it does. */
28077 struct glyph_row
*r
28078 = MATRIX_ROW (w
->current_matrix
, vpos
);
28079 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
28080 ptrdiff_t p
= string_buffer_position (obj
, start
);
28082 pointer
= Fget_char_property (make_number (p
),
28083 Qpointer
, w
->buffer
);
28086 else if (BUFFERP (obj
)
28089 pointer
= Fget_text_property (make_number (charpos
),
28093 #endif /* HAVE_WINDOW_SYSTEM */
28097 current_buffer
= obuf
;
28102 #ifdef HAVE_WINDOW_SYSTEM
28103 if (FRAME_WINDOW_P (f
))
28104 define_frame_cursor1 (f
, cursor
, pointer
);
28106 /* This is here to prevent a compiler error, about "label at end of
28107 compound statement". */
28114 Clear any mouse-face on window W. This function is part of the
28115 redisplay interface, and is called from try_window_id and similar
28116 functions to ensure the mouse-highlight is off. */
28119 x_clear_window_mouse_face (struct window
*w
)
28121 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28122 Lisp_Object window
;
28125 XSETWINDOW (window
, w
);
28126 if (EQ (window
, hlinfo
->mouse_face_window
))
28127 clear_mouse_face (hlinfo
);
28133 Just discard the mouse face information for frame F, if any.
28134 This is used when the size of F is changed. */
28137 cancel_mouse_face (struct frame
*f
)
28139 Lisp_Object window
;
28140 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28142 window
= hlinfo
->mouse_face_window
;
28143 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
28145 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28146 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28147 hlinfo
->mouse_face_window
= Qnil
;
28153 /***********************************************************************
28155 ***********************************************************************/
28157 #ifdef HAVE_WINDOW_SYSTEM
28159 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
28160 which intersects rectangle R. R is in window-relative coordinates. */
28163 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
28164 enum glyph_row_area area
)
28166 struct glyph
*first
= row
->glyphs
[area
];
28167 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
28168 struct glyph
*last
;
28169 int first_x
, start_x
, x
;
28171 if (area
== TEXT_AREA
&& row
->fill_line_p
)
28172 /* If row extends face to end of line write the whole line. */
28173 draw_glyphs (w
, 0, row
, area
,
28174 0, row
->used
[area
],
28175 DRAW_NORMAL_TEXT
, 0);
28178 /* Set START_X to the window-relative start position for drawing glyphs of
28179 AREA. The first glyph of the text area can be partially visible.
28180 The first glyphs of other areas cannot. */
28181 start_x
= window_box_left_offset (w
, area
);
28183 if (area
== TEXT_AREA
)
28186 /* Find the first glyph that must be redrawn. */
28188 && x
+ first
->pixel_width
< r
->x
)
28190 x
+= first
->pixel_width
;
28194 /* Find the last one. */
28198 && x
< r
->x
+ r
->width
)
28200 x
+= last
->pixel_width
;
28206 draw_glyphs (w
, first_x
- start_x
, row
, area
,
28207 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
28208 DRAW_NORMAL_TEXT
, 0);
28213 /* Redraw the parts of the glyph row ROW on window W intersecting
28214 rectangle R. R is in window-relative coordinates. Value is
28215 non-zero if mouse-face was overwritten. */
28218 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
28220 eassert (row
->enabled_p
);
28222 if (row
->mode_line_p
|| w
->pseudo_window_p
)
28223 draw_glyphs (w
, 0, row
, TEXT_AREA
,
28224 0, row
->used
[TEXT_AREA
],
28225 DRAW_NORMAL_TEXT
, 0);
28228 if (row
->used
[LEFT_MARGIN_AREA
])
28229 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
28230 if (row
->used
[TEXT_AREA
])
28231 expose_area (w
, row
, r
, TEXT_AREA
);
28232 if (row
->used
[RIGHT_MARGIN_AREA
])
28233 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
28234 draw_row_fringe_bitmaps (w
, row
);
28237 return row
->mouse_face_p
;
28241 /* Redraw those parts of glyphs rows during expose event handling that
28242 overlap other rows. Redrawing of an exposed line writes over parts
28243 of lines overlapping that exposed line; this function fixes that.
28245 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
28246 row in W's current matrix that is exposed and overlaps other rows.
28247 LAST_OVERLAPPING_ROW is the last such row. */
28250 expose_overlaps (struct window
*w
,
28251 struct glyph_row
*first_overlapping_row
,
28252 struct glyph_row
*last_overlapping_row
,
28255 struct glyph_row
*row
;
28257 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
28258 if (row
->overlapping_p
)
28260 eassert (row
->enabled_p
&& !row
->mode_line_p
);
28263 if (row
->used
[LEFT_MARGIN_AREA
])
28264 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
28266 if (row
->used
[TEXT_AREA
])
28267 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
28269 if (row
->used
[RIGHT_MARGIN_AREA
])
28270 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
28276 /* Return non-zero if W's cursor intersects rectangle R. */
28279 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
28281 XRectangle cr
, result
;
28282 struct glyph
*cursor_glyph
;
28283 struct glyph_row
*row
;
28285 if (w
->phys_cursor
.vpos
>= 0
28286 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
28287 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
28289 && row
->cursor_in_fringe_p
)
28291 /* Cursor is in the fringe. */
28292 cr
.x
= window_box_right_offset (w
,
28293 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
28294 ? RIGHT_MARGIN_AREA
28297 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
28298 cr
.height
= row
->height
;
28299 return x_intersect_rectangles (&cr
, r
, &result
);
28302 cursor_glyph
= get_phys_cursor_glyph (w
);
28305 /* r is relative to W's box, but w->phys_cursor.x is relative
28306 to left edge of W's TEXT area. Adjust it. */
28307 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
28308 cr
.y
= w
->phys_cursor
.y
;
28309 cr
.width
= cursor_glyph
->pixel_width
;
28310 cr
.height
= w
->phys_cursor_height
;
28311 /* ++KFS: W32 version used W32-specific IntersectRect here, but
28312 I assume the effect is the same -- and this is portable. */
28313 return x_intersect_rectangles (&cr
, r
, &result
);
28315 /* If we don't understand the format, pretend we're not in the hot-spot. */
28321 Draw a vertical window border to the right of window W if W doesn't
28322 have vertical scroll bars. */
28325 x_draw_vertical_border (struct window
*w
)
28327 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28329 /* We could do better, if we knew what type of scroll-bar the adjacent
28330 windows (on either side) have... But we don't :-(
28331 However, I think this works ok. ++KFS 2003-04-25 */
28333 /* Redraw borders between horizontally adjacent windows. Don't
28334 do it for frames with vertical scroll bars because either the
28335 right scroll bar of a window, or the left scroll bar of its
28336 neighbor will suffice as a border. */
28337 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
28340 if (!WINDOW_RIGHTMOST_P (w
)
28341 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
28343 int x0
, x1
, y0
, y1
;
28345 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28348 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28351 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
28353 else if (!WINDOW_LEFTMOST_P (w
)
28354 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
28356 int x0
, x1
, y0
, y1
;
28358 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
28361 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
28364 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
28369 /* Redraw the part of window W intersection rectangle FR. Pixel
28370 coordinates in FR are frame-relative. Call this function with
28371 input blocked. Value is non-zero if the exposure overwrites
28375 expose_window (struct window
*w
, XRectangle
*fr
)
28377 struct frame
*f
= XFRAME (w
->frame
);
28379 int mouse_face_overwritten_p
= 0;
28381 /* If window is not yet fully initialized, do nothing. This can
28382 happen when toolkit scroll bars are used and a window is split.
28383 Reconfiguring the scroll bar will generate an expose for a newly
28385 if (w
->current_matrix
== NULL
)
28388 /* When we're currently updating the window, display and current
28389 matrix usually don't agree. Arrange for a thorough display
28391 if (w
== updated_window
)
28393 SET_FRAME_GARBAGED (f
);
28397 /* Frame-relative pixel rectangle of W. */
28398 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
28399 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
28400 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
28401 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
28403 if (x_intersect_rectangles (fr
, &wr
, &r
))
28405 int yb
= window_text_bottom_y (w
);
28406 struct glyph_row
*row
;
28407 int cursor_cleared_p
, phys_cursor_on_p
;
28408 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
28410 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
28411 r
.x
, r
.y
, r
.width
, r
.height
));
28413 /* Convert to window coordinates. */
28414 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
28415 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
28417 /* Turn off the cursor. */
28418 if (!w
->pseudo_window_p
28419 && phys_cursor_in_rect_p (w
, &r
))
28421 x_clear_cursor (w
);
28422 cursor_cleared_p
= 1;
28425 cursor_cleared_p
= 0;
28427 /* If the row containing the cursor extends face to end of line,
28428 then expose_area might overwrite the cursor outside the
28429 rectangle and thus notice_overwritten_cursor might clear
28430 w->phys_cursor_on_p. We remember the original value and
28431 check later if it is changed. */
28432 phys_cursor_on_p
= w
->phys_cursor_on_p
;
28434 /* Update lines intersecting rectangle R. */
28435 first_overlapping_row
= last_overlapping_row
= NULL
;
28436 for (row
= w
->current_matrix
->rows
;
28441 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
28443 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
28444 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
28445 || (r
.y
>= y0
&& r
.y
< y1
)
28446 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
28448 /* A header line may be overlapping, but there is no need
28449 to fix overlapping areas for them. KFS 2005-02-12 */
28450 if (row
->overlapping_p
&& !row
->mode_line_p
)
28452 if (first_overlapping_row
== NULL
)
28453 first_overlapping_row
= row
;
28454 last_overlapping_row
= row
;
28458 if (expose_line (w
, row
, &r
))
28459 mouse_face_overwritten_p
= 1;
28462 else if (row
->overlapping_p
)
28464 /* We must redraw a row overlapping the exposed area. */
28466 ? y0
+ row
->phys_height
> r
.y
28467 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
28469 if (first_overlapping_row
== NULL
)
28470 first_overlapping_row
= row
;
28471 last_overlapping_row
= row
;
28479 /* Display the mode line if there is one. */
28480 if (WINDOW_WANTS_MODELINE_P (w
)
28481 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
28483 && row
->y
< r
.y
+ r
.height
)
28485 if (expose_line (w
, row
, &r
))
28486 mouse_face_overwritten_p
= 1;
28489 if (!w
->pseudo_window_p
)
28491 /* Fix the display of overlapping rows. */
28492 if (first_overlapping_row
)
28493 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
28496 /* Draw border between windows. */
28497 x_draw_vertical_border (w
);
28499 /* Turn the cursor on again. */
28500 if (cursor_cleared_p
28501 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
28502 update_window_cursor (w
, 1);
28506 return mouse_face_overwritten_p
;
28511 /* Redraw (parts) of all windows in the window tree rooted at W that
28512 intersect R. R contains frame pixel coordinates. Value is
28513 non-zero if the exposure overwrites mouse-face. */
28516 expose_window_tree (struct window
*w
, XRectangle
*r
)
28518 struct frame
*f
= XFRAME (w
->frame
);
28519 int mouse_face_overwritten_p
= 0;
28521 while (w
&& !FRAME_GARBAGED_P (f
))
28523 if (!NILP (w
->hchild
))
28524 mouse_face_overwritten_p
28525 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
28526 else if (!NILP (w
->vchild
))
28527 mouse_face_overwritten_p
28528 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
28530 mouse_face_overwritten_p
|= expose_window (w
, r
);
28532 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
28535 return mouse_face_overwritten_p
;
28540 Redisplay an exposed area of frame F. X and Y are the upper-left
28541 corner of the exposed rectangle. W and H are width and height of
28542 the exposed area. All are pixel values. W or H zero means redraw
28543 the entire frame. */
28546 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
28549 int mouse_face_overwritten_p
= 0;
28551 TRACE ((stderr
, "expose_frame "));
28553 /* No need to redraw if frame will be redrawn soon. */
28554 if (FRAME_GARBAGED_P (f
))
28556 TRACE ((stderr
, " garbaged\n"));
28560 /* If basic faces haven't been realized yet, there is no point in
28561 trying to redraw anything. This can happen when we get an expose
28562 event while Emacs is starting, e.g. by moving another window. */
28563 if (FRAME_FACE_CACHE (f
) == NULL
28564 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
28566 TRACE ((stderr
, " no faces\n"));
28570 if (w
== 0 || h
== 0)
28573 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
28574 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
28584 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
28585 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
28587 if (WINDOWP (f
->tool_bar_window
))
28588 mouse_face_overwritten_p
28589 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
28591 #ifdef HAVE_X_WINDOWS
28593 #ifndef USE_X_TOOLKIT
28594 if (WINDOWP (f
->menu_bar_window
))
28595 mouse_face_overwritten_p
28596 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
28597 #endif /* not USE_X_TOOLKIT */
28601 /* Some window managers support a focus-follows-mouse style with
28602 delayed raising of frames. Imagine a partially obscured frame,
28603 and moving the mouse into partially obscured mouse-face on that
28604 frame. The visible part of the mouse-face will be highlighted,
28605 then the WM raises the obscured frame. With at least one WM, KDE
28606 2.1, Emacs is not getting any event for the raising of the frame
28607 (even tried with SubstructureRedirectMask), only Expose events.
28608 These expose events will draw text normally, i.e. not
28609 highlighted. Which means we must redo the highlight here.
28610 Subsume it under ``we love X''. --gerd 2001-08-15 */
28611 /* Included in Windows version because Windows most likely does not
28612 do the right thing if any third party tool offers
28613 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
28614 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
28616 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28617 if (f
== hlinfo
->mouse_face_mouse_frame
)
28619 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
28620 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
28621 clear_mouse_face (hlinfo
);
28622 note_mouse_highlight (f
, mouse_x
, mouse_y
);
28629 Determine the intersection of two rectangles R1 and R2. Return
28630 the intersection in *RESULT. Value is non-zero if RESULT is not
28634 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
28636 XRectangle
*left
, *right
;
28637 XRectangle
*upper
, *lower
;
28638 int intersection_p
= 0;
28640 /* Rearrange so that R1 is the left-most rectangle. */
28642 left
= r1
, right
= r2
;
28644 left
= r2
, right
= r1
;
28646 /* X0 of the intersection is right.x0, if this is inside R1,
28647 otherwise there is no intersection. */
28648 if (right
->x
<= left
->x
+ left
->width
)
28650 result
->x
= right
->x
;
28652 /* The right end of the intersection is the minimum of
28653 the right ends of left and right. */
28654 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
28657 /* Same game for Y. */
28659 upper
= r1
, lower
= r2
;
28661 upper
= r2
, lower
= r1
;
28663 /* The upper end of the intersection is lower.y0, if this is inside
28664 of upper. Otherwise, there is no intersection. */
28665 if (lower
->y
<= upper
->y
+ upper
->height
)
28667 result
->y
= lower
->y
;
28669 /* The lower end of the intersection is the minimum of the lower
28670 ends of upper and lower. */
28671 result
->height
= (min (lower
->y
+ lower
->height
,
28672 upper
->y
+ upper
->height
)
28674 intersection_p
= 1;
28678 return intersection_p
;
28681 #endif /* HAVE_WINDOW_SYSTEM */
28684 /***********************************************************************
28686 ***********************************************************************/
28689 syms_of_xdisp (void)
28691 Vwith_echo_area_save_vector
= Qnil
;
28692 staticpro (&Vwith_echo_area_save_vector
);
28694 Vmessage_stack
= Qnil
;
28695 staticpro (&Vmessage_stack
);
28697 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
28698 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
28700 message_dolog_marker1
= Fmake_marker ();
28701 staticpro (&message_dolog_marker1
);
28702 message_dolog_marker2
= Fmake_marker ();
28703 staticpro (&message_dolog_marker2
);
28704 message_dolog_marker3
= Fmake_marker ();
28705 staticpro (&message_dolog_marker3
);
28708 defsubr (&Sdump_frame_glyph_matrix
);
28709 defsubr (&Sdump_glyph_matrix
);
28710 defsubr (&Sdump_glyph_row
);
28711 defsubr (&Sdump_tool_bar_row
);
28712 defsubr (&Strace_redisplay
);
28713 defsubr (&Strace_to_stderr
);
28715 #ifdef HAVE_WINDOW_SYSTEM
28716 defsubr (&Stool_bar_lines_needed
);
28717 defsubr (&Slookup_image_map
);
28719 defsubr (&Sformat_mode_line
);
28720 defsubr (&Sinvisible_p
);
28721 defsubr (&Scurrent_bidi_paragraph_direction
);
28723 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
28724 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
28725 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
28726 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
28727 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
28728 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
28729 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
28730 DEFSYM (Qeval
, "eval");
28731 DEFSYM (QCdata
, ":data");
28732 DEFSYM (Qdisplay
, "display");
28733 DEFSYM (Qspace_width
, "space-width");
28734 DEFSYM (Qraise
, "raise");
28735 DEFSYM (Qslice
, "slice");
28736 DEFSYM (Qspace
, "space");
28737 DEFSYM (Qmargin
, "margin");
28738 DEFSYM (Qpointer
, "pointer");
28739 DEFSYM (Qleft_margin
, "left-margin");
28740 DEFSYM (Qright_margin
, "right-margin");
28741 DEFSYM (Qcenter
, "center");
28742 DEFSYM (Qline_height
, "line-height");
28743 DEFSYM (QCalign_to
, ":align-to");
28744 DEFSYM (QCrelative_width
, ":relative-width");
28745 DEFSYM (QCrelative_height
, ":relative-height");
28746 DEFSYM (QCeval
, ":eval");
28747 DEFSYM (QCpropertize
, ":propertize");
28748 DEFSYM (QCfile
, ":file");
28749 DEFSYM (Qfontified
, "fontified");
28750 DEFSYM (Qfontification_functions
, "fontification-functions");
28751 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
28752 DEFSYM (Qescape_glyph
, "escape-glyph");
28753 DEFSYM (Qnobreak_space
, "nobreak-space");
28754 DEFSYM (Qimage
, "image");
28755 DEFSYM (Qtext
, "text");
28756 DEFSYM (Qboth
, "both");
28757 DEFSYM (Qboth_horiz
, "both-horiz");
28758 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
28759 DEFSYM (QCmap
, ":map");
28760 DEFSYM (QCpointer
, ":pointer");
28761 DEFSYM (Qrect
, "rect");
28762 DEFSYM (Qcircle
, "circle");
28763 DEFSYM (Qpoly
, "poly");
28764 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
28765 DEFSYM (Qgrow_only
, "grow-only");
28766 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
28767 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
28768 DEFSYM (Qposition
, "position");
28769 DEFSYM (Qbuffer_position
, "buffer-position");
28770 DEFSYM (Qobject
, "object");
28771 DEFSYM (Qbar
, "bar");
28772 DEFSYM (Qhbar
, "hbar");
28773 DEFSYM (Qbox
, "box");
28774 DEFSYM (Qhollow
, "hollow");
28775 DEFSYM (Qhand
, "hand");
28776 DEFSYM (Qarrow
, "arrow");
28777 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
28779 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
28780 Fcons (intern_c_string ("void-variable"), Qnil
)),
28782 staticpro (&list_of_error
);
28784 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
28785 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
28786 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
28787 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
28789 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
28790 staticpro (&echo_buffer
[0]);
28791 staticpro (&echo_buffer
[1]);
28793 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
28794 staticpro (&echo_area_buffer
[0]);
28795 staticpro (&echo_area_buffer
[1]);
28797 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
28798 staticpro (&Vmessages_buffer_name
);
28800 mode_line_proptrans_alist
= Qnil
;
28801 staticpro (&mode_line_proptrans_alist
);
28802 mode_line_string_list
= Qnil
;
28803 staticpro (&mode_line_string_list
);
28804 mode_line_string_face
= Qnil
;
28805 staticpro (&mode_line_string_face
);
28806 mode_line_string_face_prop
= Qnil
;
28807 staticpro (&mode_line_string_face_prop
);
28808 Vmode_line_unwind_vector
= Qnil
;
28809 staticpro (&Vmode_line_unwind_vector
);
28811 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
28813 help_echo_string
= Qnil
;
28814 staticpro (&help_echo_string
);
28815 help_echo_object
= Qnil
;
28816 staticpro (&help_echo_object
);
28817 help_echo_window
= Qnil
;
28818 staticpro (&help_echo_window
);
28819 previous_help_echo_string
= Qnil
;
28820 staticpro (&previous_help_echo_string
);
28821 help_echo_pos
= -1;
28823 DEFSYM (Qright_to_left
, "right-to-left");
28824 DEFSYM (Qleft_to_right
, "left-to-right");
28826 #ifdef HAVE_WINDOW_SYSTEM
28827 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
28828 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
28829 For example, if a block cursor is over a tab, it will be drawn as
28830 wide as that tab on the display. */);
28831 x_stretch_cursor_p
= 0;
28834 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
28835 doc
: /* Non-nil means highlight trailing whitespace.
28836 The face used for trailing whitespace is `trailing-whitespace'. */);
28837 Vshow_trailing_whitespace
= Qnil
;
28839 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
28840 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
28841 If the value is t, Emacs highlights non-ASCII chars which have the
28842 same appearance as an ASCII space or hyphen, using the `nobreak-space'
28843 or `escape-glyph' face respectively.
28845 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
28846 U+2011 (non-breaking hyphen) are affected.
28848 Any other non-nil value means to display these characters as a escape
28849 glyph followed by an ordinary space or hyphen.
28851 A value of nil means no special handling of these characters. */);
28852 Vnobreak_char_display
= Qt
;
28854 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
28855 doc
: /* The pointer shape to show in void text areas.
28856 A value of nil means to show the text pointer. Other options are `arrow',
28857 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
28858 Vvoid_text_area_pointer
= Qarrow
;
28860 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
28861 doc
: /* Non-nil means don't actually do any redisplay.
28862 This is used for internal purposes. */);
28863 Vinhibit_redisplay
= Qnil
;
28865 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
28866 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
28867 Vglobal_mode_string
= Qnil
;
28869 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
28870 doc
: /* Marker for where to display an arrow on top of the buffer text.
28871 This must be the beginning of a line in order to work.
28872 See also `overlay-arrow-string'. */);
28873 Voverlay_arrow_position
= Qnil
;
28875 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
28876 doc
: /* String to display as an arrow in non-window frames.
28877 See also `overlay-arrow-position'. */);
28878 Voverlay_arrow_string
= build_pure_c_string ("=>");
28880 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
28881 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
28882 The symbols on this list are examined during redisplay to determine
28883 where to display overlay arrows. */);
28884 Voverlay_arrow_variable_list
28885 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
28887 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
28888 doc
: /* The number of lines to try scrolling a window by when point moves out.
28889 If that fails to bring point back on frame, point is centered instead.
28890 If this is zero, point is always centered after it moves off frame.
28891 If you want scrolling to always be a line at a time, you should set
28892 `scroll-conservatively' to a large value rather than set this to 1. */);
28894 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
28895 doc
: /* Scroll up to this many lines, to bring point back on screen.
28896 If point moves off-screen, redisplay will scroll by up to
28897 `scroll-conservatively' lines in order to bring point just barely
28898 onto the screen again. If that cannot be done, then redisplay
28899 recenters point as usual.
28901 If the value is greater than 100, redisplay will never recenter point,
28902 but will always scroll just enough text to bring point into view, even
28903 if you move far away.
28905 A value of zero means always recenter point if it moves off screen. */);
28906 scroll_conservatively
= 0;
28908 DEFVAR_INT ("scroll-margin", scroll_margin
,
28909 doc
: /* Number of lines of margin at the top and bottom of a window.
28910 Recenter the window whenever point gets within this many lines
28911 of the top or bottom of the window. */);
28914 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
28915 doc
: /* Pixels per inch value for non-window system displays.
28916 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
28917 Vdisplay_pixels_per_inch
= make_float (72.0);
28920 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
28923 DEFVAR_LISP ("truncate-partial-width-windows",
28924 Vtruncate_partial_width_windows
,
28925 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
28926 For an integer value, truncate lines in each window narrower than the
28927 full frame width, provided the window width is less than that integer;
28928 otherwise, respect the value of `truncate-lines'.
28930 For any other non-nil value, truncate lines in all windows that do
28931 not span the full frame width.
28933 A value of nil means to respect the value of `truncate-lines'.
28935 If `word-wrap' is enabled, you might want to reduce this. */);
28936 Vtruncate_partial_width_windows
= make_number (50);
28938 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
28939 doc
: /* Maximum buffer size for which line number should be displayed.
28940 If the buffer is bigger than this, the line number does not appear
28941 in the mode line. A value of nil means no limit. */);
28942 Vline_number_display_limit
= Qnil
;
28944 DEFVAR_INT ("line-number-display-limit-width",
28945 line_number_display_limit_width
,
28946 doc
: /* Maximum line width (in characters) for line number display.
28947 If the average length of the lines near point is bigger than this, then the
28948 line number may be omitted from the mode line. */);
28949 line_number_display_limit_width
= 200;
28951 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
28952 doc
: /* Non-nil means highlight region even in nonselected windows. */);
28953 highlight_nonselected_windows
= 0;
28955 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
28956 doc
: /* Non-nil if more than one frame is visible on this display.
28957 Minibuffer-only frames don't count, but iconified frames do.
28958 This variable is not guaranteed to be accurate except while processing
28959 `frame-title-format' and `icon-title-format'. */);
28961 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
28962 doc
: /* Template for displaying the title bar of visible frames.
28963 \(Assuming the window manager supports this feature.)
28965 This variable has the same structure as `mode-line-format', except that
28966 the %c and %l constructs are ignored. It is used only on frames for
28967 which no explicit name has been set \(see `modify-frame-parameters'). */);
28969 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
28970 doc
: /* Template for displaying the title bar of an iconified frame.
28971 \(Assuming the window manager supports this feature.)
28972 This variable has the same structure as `mode-line-format' (which see),
28973 and is used only on frames for which no explicit name has been set
28974 \(see `modify-frame-parameters'). */);
28976 = Vframe_title_format
28977 = listn (CONSTYPE_PURE
, 3,
28978 intern_c_string ("multiple-frames"),
28979 build_pure_c_string ("%b"),
28980 listn (CONSTYPE_PURE
, 4,
28981 empty_unibyte_string
,
28982 intern_c_string ("invocation-name"),
28983 build_pure_c_string ("@"),
28984 intern_c_string ("system-name")));
28986 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
28987 doc
: /* Maximum number of lines to keep in the message log buffer.
28988 If nil, disable message logging. If t, log messages but don't truncate
28989 the buffer when it becomes large. */);
28990 Vmessage_log_max
= make_number (1000);
28992 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
28993 doc
: /* Functions called before redisplay, if window sizes have changed.
28994 The value should be a list of functions that take one argument.
28995 Just before redisplay, for each frame, if any of its windows have changed
28996 size since the last redisplay, or have been split or deleted,
28997 all the functions in the list are called, with the frame as argument. */);
28998 Vwindow_size_change_functions
= Qnil
;
29000 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
29001 doc
: /* List of functions to call before redisplaying a window with scrolling.
29002 Each function is called with two arguments, the window and its new
29003 display-start position. Note that these functions are also called by
29004 `set-window-buffer'. Also note that the value of `window-end' is not
29005 valid when these functions are called.
29007 Warning: Do not use this feature to alter the way the window
29008 is scrolled. It is not designed for that, and such use probably won't
29010 Vwindow_scroll_functions
= Qnil
;
29012 DEFVAR_LISP ("window-text-change-functions",
29013 Vwindow_text_change_functions
,
29014 doc
: /* Functions to call in redisplay when text in the window might change. */);
29015 Vwindow_text_change_functions
= Qnil
;
29017 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
29018 doc
: /* Functions called when redisplay of a window reaches the end trigger.
29019 Each function is called with two arguments, the window and the end trigger value.
29020 See `set-window-redisplay-end-trigger'. */);
29021 Vredisplay_end_trigger_functions
= Qnil
;
29023 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
29024 doc
: /* Non-nil means autoselect window with mouse pointer.
29025 If nil, do not autoselect windows.
29026 A positive number means delay autoselection by that many seconds: a
29027 window is autoselected only after the mouse has remained in that
29028 window for the duration of the delay.
29029 A negative number has a similar effect, but causes windows to be
29030 autoselected only after the mouse has stopped moving. \(Because of
29031 the way Emacs compares mouse events, you will occasionally wait twice
29032 that time before the window gets selected.\)
29033 Any other value means to autoselect window instantaneously when the
29034 mouse pointer enters it.
29036 Autoselection selects the minibuffer only if it is active, and never
29037 unselects the minibuffer if it is active.
29039 When customizing this variable make sure that the actual value of
29040 `focus-follows-mouse' matches the behavior of your window manager. */);
29041 Vmouse_autoselect_window
= Qnil
;
29043 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
29044 doc
: /* Non-nil means automatically resize tool-bars.
29045 This dynamically changes the tool-bar's height to the minimum height
29046 that is needed to make all tool-bar items visible.
29047 If value is `grow-only', the tool-bar's height is only increased
29048 automatically; to decrease the tool-bar height, use \\[recenter]. */);
29049 Vauto_resize_tool_bars
= Qt
;
29051 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
29052 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
29053 auto_raise_tool_bar_buttons_p
= 1;
29055 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
29056 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
29057 make_cursor_line_fully_visible_p
= 1;
29059 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
29060 doc
: /* Border below tool-bar in pixels.
29061 If an integer, use it as the height of the border.
29062 If it is one of `internal-border-width' or `border-width', use the
29063 value of the corresponding frame parameter.
29064 Otherwise, no border is added below the tool-bar. */);
29065 Vtool_bar_border
= Qinternal_border_width
;
29067 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
29068 doc
: /* Margin around tool-bar buttons in pixels.
29069 If an integer, use that for both horizontal and vertical margins.
29070 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
29071 HORZ specifying the horizontal margin, and VERT specifying the
29072 vertical margin. */);
29073 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
29075 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
29076 doc
: /* Relief thickness of tool-bar buttons. */);
29077 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
29079 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
29080 doc
: /* Tool bar style to use.
29082 image - show images only
29083 text - show text only
29084 both - show both, text below image
29085 both-horiz - show text to the right of the image
29086 text-image-horiz - show text to the left of the image
29087 any other - use system default or image if no system default.
29089 This variable only affects the GTK+ toolkit version of Emacs. */);
29090 Vtool_bar_style
= Qnil
;
29092 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
29093 doc
: /* Maximum number of characters a label can have to be shown.
29094 The tool bar style must also show labels for this to have any effect, see
29095 `tool-bar-style'. */);
29096 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
29098 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
29099 doc
: /* List of functions to call to fontify regions of text.
29100 Each function is called with one argument POS. Functions must
29101 fontify a region starting at POS in the current buffer, and give
29102 fontified regions the property `fontified'. */);
29103 Vfontification_functions
= Qnil
;
29104 Fmake_variable_buffer_local (Qfontification_functions
);
29106 DEFVAR_BOOL ("unibyte-display-via-language-environment",
29107 unibyte_display_via_language_environment
,
29108 doc
: /* Non-nil means display unibyte text according to language environment.
29109 Specifically, this means that raw bytes in the range 160-255 decimal
29110 are displayed by converting them to the equivalent multibyte characters
29111 according to the current language environment. As a result, they are
29112 displayed according to the current fontset.
29114 Note that this variable affects only how these bytes are displayed,
29115 but does not change the fact they are interpreted as raw bytes. */);
29116 unibyte_display_via_language_environment
= 0;
29118 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
29119 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
29120 If a float, it specifies a fraction of the mini-window frame's height.
29121 If an integer, it specifies a number of lines. */);
29122 Vmax_mini_window_height
= make_float (0.25);
29124 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
29125 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
29126 A value of nil means don't automatically resize mini-windows.
29127 A value of t means resize them to fit the text displayed in them.
29128 A value of `grow-only', the default, means let mini-windows grow only;
29129 they return to their normal size when the minibuffer is closed, or the
29130 echo area becomes empty. */);
29131 Vresize_mini_windows
= Qgrow_only
;
29133 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
29134 doc
: /* Alist specifying how to blink the cursor off.
29135 Each element has the form (ON-STATE . OFF-STATE). Whenever the
29136 `cursor-type' frame-parameter or variable equals ON-STATE,
29137 comparing using `equal', Emacs uses OFF-STATE to specify
29138 how to blink it off. ON-STATE and OFF-STATE are values for
29139 the `cursor-type' frame parameter.
29141 If a frame's ON-STATE has no entry in this list,
29142 the frame's other specifications determine how to blink the cursor off. */);
29143 Vblink_cursor_alist
= Qnil
;
29145 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
29146 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
29147 If non-nil, windows are automatically scrolled horizontally to make
29148 point visible. */);
29149 automatic_hscrolling_p
= 1;
29150 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
29152 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
29153 doc
: /* How many columns away from the window edge point is allowed to get
29154 before automatic hscrolling will horizontally scroll the window. */);
29155 hscroll_margin
= 5;
29157 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
29158 doc
: /* How many columns to scroll the window when point gets too close to the edge.
29159 When point is less than `hscroll-margin' columns from the window
29160 edge, automatic hscrolling will scroll the window by the amount of columns
29161 determined by this variable. If its value is a positive integer, scroll that
29162 many columns. If it's a positive floating-point number, it specifies the
29163 fraction of the window's width to scroll. If it's nil or zero, point will be
29164 centered horizontally after the scroll. Any other value, including negative
29165 numbers, are treated as if the value were zero.
29167 Automatic hscrolling always moves point outside the scroll margin, so if
29168 point was more than scroll step columns inside the margin, the window will
29169 scroll more than the value given by the scroll step.
29171 Note that the lower bound for automatic hscrolling specified by `scroll-left'
29172 and `scroll-right' overrides this variable's effect. */);
29173 Vhscroll_step
= make_number (0);
29175 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
29176 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
29177 Bind this around calls to `message' to let it take effect. */);
29178 message_truncate_lines
= 0;
29180 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
29181 doc
: /* Normal hook run to update the menu bar definitions.
29182 Redisplay runs this hook before it redisplays the menu bar.
29183 This is used to update submenus such as Buffers,
29184 whose contents depend on various data. */);
29185 Vmenu_bar_update_hook
= Qnil
;
29187 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
29188 doc
: /* Frame for which we are updating a menu.
29189 The enable predicate for a menu binding should check this variable. */);
29190 Vmenu_updating_frame
= Qnil
;
29192 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
29193 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
29194 inhibit_menubar_update
= 0;
29196 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
29197 doc
: /* Prefix prepended to all continuation lines at display time.
29198 The value may be a string, an image, or a stretch-glyph; it is
29199 interpreted in the same way as the value of a `display' text property.
29201 This variable is overridden by any `wrap-prefix' text or overlay
29204 To add a prefix to non-continuation lines, use `line-prefix'. */);
29205 Vwrap_prefix
= Qnil
;
29206 DEFSYM (Qwrap_prefix
, "wrap-prefix");
29207 Fmake_variable_buffer_local (Qwrap_prefix
);
29209 DEFVAR_LISP ("line-prefix", Vline_prefix
,
29210 doc
: /* Prefix prepended to all non-continuation lines at display time.
29211 The value may be a string, an image, or a stretch-glyph; it is
29212 interpreted in the same way as the value of a `display' text property.
29214 This variable is overridden by any `line-prefix' text or overlay
29217 To add a prefix to continuation lines, use `wrap-prefix'. */);
29218 Vline_prefix
= Qnil
;
29219 DEFSYM (Qline_prefix
, "line-prefix");
29220 Fmake_variable_buffer_local (Qline_prefix
);
29222 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
29223 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
29224 inhibit_eval_during_redisplay
= 0;
29226 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
29227 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
29228 inhibit_free_realized_faces
= 0;
29231 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
29232 doc
: /* Inhibit try_window_id display optimization. */);
29233 inhibit_try_window_id
= 0;
29235 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
29236 doc
: /* Inhibit try_window_reusing display optimization. */);
29237 inhibit_try_window_reusing
= 0;
29239 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
29240 doc
: /* Inhibit try_cursor_movement display optimization. */);
29241 inhibit_try_cursor_movement
= 0;
29242 #endif /* GLYPH_DEBUG */
29244 DEFVAR_INT ("overline-margin", overline_margin
,
29245 doc
: /* Space between overline and text, in pixels.
29246 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
29247 margin to the character height. */);
29248 overline_margin
= 2;
29250 DEFVAR_INT ("underline-minimum-offset",
29251 underline_minimum_offset
,
29252 doc
: /* Minimum distance between baseline and underline.
29253 This can improve legibility of underlined text at small font sizes,
29254 particularly when using variable `x-use-underline-position-properties'
29255 with fonts that specify an UNDERLINE_POSITION relatively close to the
29256 baseline. The default value is 1. */);
29257 underline_minimum_offset
= 1;
29259 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
29260 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
29261 This feature only works when on a window system that can change
29262 cursor shapes. */);
29263 display_hourglass_p
= 1;
29265 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
29266 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
29267 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
29269 hourglass_atimer
= NULL
;
29270 hourglass_shown_p
= 0;
29272 DEFSYM (Qglyphless_char
, "glyphless-char");
29273 DEFSYM (Qhex_code
, "hex-code");
29274 DEFSYM (Qempty_box
, "empty-box");
29275 DEFSYM (Qthin_space
, "thin-space");
29276 DEFSYM (Qzero_width
, "zero-width");
29278 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
29279 /* Intern this now in case it isn't already done.
29280 Setting this variable twice is harmless.
29281 But don't staticpro it here--that is done in alloc.c. */
29282 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
29283 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
29285 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
29286 doc
: /* Char-table defining glyphless characters.
29287 Each element, if non-nil, should be one of the following:
29288 an ASCII acronym string: display this string in a box
29289 `hex-code': display the hexadecimal code of a character in a box
29290 `empty-box': display as an empty box
29291 `thin-space': display as 1-pixel width space
29292 `zero-width': don't display
29293 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
29294 display method for graphical terminals and text terminals respectively.
29295 GRAPHICAL and TEXT should each have one of the values listed above.
29297 The char-table has one extra slot to control the display of a character for
29298 which no font is found. This slot only takes effect on graphical terminals.
29299 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
29300 `thin-space'. The default is `empty-box'. */);
29301 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
29302 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
29305 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
29306 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
29307 Vdebug_on_message
= Qnil
;
29311 /* Initialize this module when Emacs starts. */
29316 current_header_line_height
= current_mode_line_height
= -1;
29318 CHARPOS (this_line_start_pos
) = 0;
29320 if (!noninteractive
)
29322 struct window
*m
= XWINDOW (minibuf_window
);
29323 Lisp_Object frame
= m
->frame
;
29324 struct frame
*f
= XFRAME (frame
);
29325 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
29326 struct window
*r
= XWINDOW (root
);
29329 echo_area_window
= minibuf_window
;
29331 wset_top_line (r
, make_number (FRAME_TOP_MARGIN (f
)));
29333 (r
, make_number (FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
)));
29334 wset_total_cols (r
, make_number (FRAME_COLS (f
)));
29335 wset_top_line (m
, make_number (FRAME_LINES (f
) - 1));
29336 wset_total_lines (m
, make_number (1));
29337 wset_total_cols (m
, make_number (FRAME_COLS (f
)));
29339 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
29340 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
29341 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
29343 /* The default ellipsis glyphs `...'. */
29344 for (i
= 0; i
< 3; ++i
)
29345 default_invis_vector
[i
] = make_number ('.');
29349 /* Allocate the buffer for frame titles.
29350 Also used for `format-mode-line'. */
29352 mode_line_noprop_buf
= xmalloc (size
);
29353 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
29354 mode_line_noprop_ptr
= mode_line_noprop_buf
;
29355 mode_line_target
= MODE_LINE_DISPLAY
;
29358 help_echo_showing_p
= 0;
29361 /* Platform-independent portion of hourglass implementation. */
29363 /* Cancel a currently active hourglass timer, and start a new one. */
29365 start_hourglass (void)
29367 #if defined (HAVE_WINDOW_SYSTEM)
29370 cancel_hourglass ();
29372 if (INTEGERP (Vhourglass_delay
)
29373 && XINT (Vhourglass_delay
) > 0)
29374 delay
= make_emacs_time (min (XINT (Vhourglass_delay
),
29375 TYPE_MAXIMUM (time_t)),
29377 else if (FLOATP (Vhourglass_delay
)
29378 && XFLOAT_DATA (Vhourglass_delay
) > 0)
29379 delay
= EMACS_TIME_FROM_DOUBLE (XFLOAT_DATA (Vhourglass_delay
));
29381 delay
= make_emacs_time (DEFAULT_HOURGLASS_DELAY
, 0);
29384 extern void w32_note_current_window (void);
29385 w32_note_current_window ();
29386 #endif /* HAVE_NTGUI */
29388 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
29389 show_hourglass
, NULL
);
29394 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
29397 cancel_hourglass (void)
29399 #if defined (HAVE_WINDOW_SYSTEM)
29400 if (hourglass_atimer
)
29402 cancel_atimer (hourglass_atimer
);
29403 hourglass_atimer
= NULL
;
29406 if (hourglass_shown_p
)